xref: /netbsd-src/sys/dev/tprof/tprof.h (revision 82d56013d7b633d116a93943de88e08335357a7c)
1 /*	$NetBSD: tprof.h,v 1.6 2018/07/13 07:56:29 maxv 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 typedef struct tprof_backend_ops {
41 	uint64_t (*tbo_estimate_freq)(void);	/* samples per second */
42 	uint32_t (*tbo_ident)(void);
43 	int (*tbo_start)(const tprof_param_t *);
44 	void (*tbo_stop)(const tprof_param_t *);
45 } tprof_backend_ops_t;
46 
47 #define	TPROF_BACKEND_VERSION	3
48 int tprof_backend_register(const char *, const tprof_backend_ops_t *, int);
49 int tprof_backend_unregister(const char *);
50 
51 typedef struct {
52 	uintptr_t tfi_pc;	/* program counter */
53 	bool tfi_inkernel;	/* if tfi_pc is in the kernel address space */
54 } tprof_frame_info_t;
55 
56 void tprof_sample(void *, const tprof_frame_info_t *);
57 
58 #endif /* _DEV_TPROF_TPROF_H_ */
59