xref: /netbsd-src/sys/dev/tprof/tprof.h (revision caba1a6f4751146dacb61d492a3ac7cedc54f91f)
1 /*	$NetBSD: tprof.h,v 1.7 2022/12/01 00:32:52 ryo Exp $	*/
2 
3 /*-
4  * Copyright (c)2008,2009,2010 YAMAMOTO Takashi,
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #ifndef _DEV_TPROF_TPROF_H_
30 #define _DEV_TPROF_TPROF_H_
31 
32 /*
33  * definitions used by backend drivers
34  */
35 
36 #include <sys/types.h>
37 
38 #include <dev/tprof/tprof_types.h>
39 
40 struct tprof_backend_softc_counter {
41 	tprof_param_t ctr_param;
42 	u_int ctr_bitwidth;
43 	uint64_t ctr_counter_val;
44 	uint64_t ctr_counter_reset_val;
45 };
46 
47 typedef struct tprof_backend_softc {
48 	u_int sc_ncounters;
49 	tprof_countermask_t sc_ctr_running_mask;/* start/stop */
50 	tprof_countermask_t sc_ctr_configured_mask;	/* configured */
51 	tprof_countermask_t sc_ctr_ovf_mask;	/* overflow intr required */
52 	tprof_countermask_t sc_ctr_prof_mask;	/* profiled */
53 	percpu_t *sc_ctr_offset_percpu;
54 	size_t sc_ctr_offset_percpu_size;
55 	struct tprof_backend_softc_counter sc_count[TPROF_MAXCOUNTERS];
56 } tprof_backend_softc_t;
57 
58 typedef struct tprof_backend_ops {
59 	uint32_t (*tbo_ident)(void);
60 	u_int (*tbo_ncounters)(void);
61 	u_int (*tbo_counter_bitwidth)(u_int);
62 	uint64_t (*tbo_counter_read)(u_int);
63 	uint64_t (*tbo_counter_estimate_freq)(u_int);
64 	int (*tbo_valid_event)(u_int, const tprof_param_t *);
65 	void (*tbo_configure_event)(u_int, const tprof_param_t *);
66 	void (*tbo_start)(tprof_countermask_t);
67 	void (*tbo_stop)(tprof_countermask_t);
68 	int (*tbo_establish)(tprof_backend_softc_t *);
69 	void (*tbo_disestablish)(tprof_backend_softc_t *);
70 } tprof_backend_ops_t;
71 
72 #define	TPROF_BACKEND_VERSION	4
73 int tprof_backend_register(const char *, const tprof_backend_ops_t *, int);
74 int tprof_backend_unregister(const char *);
75 
76 typedef struct {
77 	uintptr_t tfi_pc;	/* program counter */
78 	u_int tfi_counter;	/* counter. 0..(TPROF_MAXCOUNTERS-1) */
79 	bool tfi_inkernel;	/* if tfi_pc is in the kernel address space */
80 } tprof_frame_info_t;
81 
82 void tprof_sample(void *, const tprof_frame_info_t *);
83 
84 #endif /* _DEV_TPROF_TPROF_H_ */
85