xref: /onnv-gate/usr/src/uts/common/sys/ftrace.h (revision 0:68f95e015346)
1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright (c) 1998 by Sun Microsystems, Inc.
24*0Sstevel@tonic-gate  * All rights reserved.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate #ifndef	_SYS_FTRACE_H
28*0Sstevel@tonic-gate #define	_SYS_FTRACE_H
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
31*0Sstevel@tonic-gate 
32*0Sstevel@tonic-gate #ifdef	__cplusplus
33*0Sstevel@tonic-gate extern "C" {
34*0Sstevel@tonic-gate #endif
35*0Sstevel@tonic-gate 
36*0Sstevel@tonic-gate /*
37*0Sstevel@tonic-gate  * Constants used by both asm and non-asm code.
38*0Sstevel@tonic-gate  */
39*0Sstevel@tonic-gate 
40*0Sstevel@tonic-gate /*
41*0Sstevel@tonic-gate  * Flags determining the state of tracing -
42*0Sstevel@tonic-gate  *   both for the "ftrace_state" variable, and for the per-CPU variable
43*0Sstevel@tonic-gate  *   "cpu[N]->cpu_ftrace_state".
44*0Sstevel@tonic-gate  */
45*0Sstevel@tonic-gate #define	FTRACE_READY	0x00000001
46*0Sstevel@tonic-gate #define	FTRACE_ENABLED	0x00000002
47*0Sstevel@tonic-gate 
48*0Sstevel@tonic-gate #if !defined(_ASM)
49*0Sstevel@tonic-gate 
50*0Sstevel@tonic-gate #include <sys/thread.h>
51*0Sstevel@tonic-gate #include <sys/cpuvar.h>
52*0Sstevel@tonic-gate #include <sys/types.h>
53*0Sstevel@tonic-gate 
54*0Sstevel@tonic-gate /*
55*0Sstevel@tonic-gate  * The record of a single event.
56*0Sstevel@tonic-gate  *
57*0Sstevel@tonic-gate  * Should fit nicely into a standard cache line.
58*0Sstevel@tonic-gate  * Here, the 32-bit version is 32 bytes, and the 64-bit version is 64 bytes.
59*0Sstevel@tonic-gate  */
60*0Sstevel@tonic-gate typedef struct ftrace_record {
61*0Sstevel@tonic-gate 	char		*ftr_event;
62*0Sstevel@tonic-gate 	kthread_t	*ftr_thread;
63*0Sstevel@tonic-gate 	uint64_t	ftr_tick;
64*0Sstevel@tonic-gate 	caddr_t		ftr_caller;
65*0Sstevel@tonic-gate 	ulong_t		ftr_data1;
66*0Sstevel@tonic-gate 	ulong_t		ftr_data2;
67*0Sstevel@tonic-gate 	ulong_t		ftr_data3;
68*0Sstevel@tonic-gate #ifdef	_LP64
69*0Sstevel@tonic-gate 	ulong_t		__pad;
70*0Sstevel@tonic-gate #endif
71*0Sstevel@tonic-gate } ftrace_record_t;
72*0Sstevel@tonic-gate 
73*0Sstevel@tonic-gate /*
74*0Sstevel@tonic-gate  * Default per-CPU event ring buffer size.
75*0Sstevel@tonic-gate  */
76*0Sstevel@tonic-gate #define	FTRACE_NENT 1024
77*0Sstevel@tonic-gate 
78*0Sstevel@tonic-gate #ifdef _KERNEL
79*0Sstevel@tonic-gate 
80*0Sstevel@tonic-gate /*
81*0Sstevel@tonic-gate  * Tunable parameters in /etc/system.
82*0Sstevel@tonic-gate  */
83*0Sstevel@tonic-gate extern int ftrace_atboot;	/* Whether to start fast tracing on boot. */
84*0Sstevel@tonic-gate extern int ftrace_nent;		/* Size of the per-CPU event ring buffer. */
85*0Sstevel@tonic-gate 
86*0Sstevel@tonic-gate extern int		ftrace_cpu_setup(cpu_setup_t, int, void *);
87*0Sstevel@tonic-gate extern void		ftrace_init(void);
88*0Sstevel@tonic-gate extern int		ftrace_start(void);
89*0Sstevel@tonic-gate extern int		ftrace_stop(void);
90*0Sstevel@tonic-gate extern void		ftrace_0(char *);
91*0Sstevel@tonic-gate extern void		ftrace_1(char *, ulong_t);
92*0Sstevel@tonic-gate extern void		ftrace_2(char *, ulong_t, ulong_t);
93*0Sstevel@tonic-gate extern void		ftrace_3(char *, ulong_t, ulong_t, ulong_t);
94*0Sstevel@tonic-gate 
95*0Sstevel@tonic-gate #define	FTRACE_0(fmt)						\
96*0Sstevel@tonic-gate 	{							\
97*0Sstevel@tonic-gate 		if (CPU->cpu_ftrace.ftd_state & FTRACE_ENABLED)	\
98*0Sstevel@tonic-gate 			ftrace_0(fmt);				\
99*0Sstevel@tonic-gate 	}
100*0Sstevel@tonic-gate #define	FTRACE_1(fmt, d1) 					\
101*0Sstevel@tonic-gate 	{							\
102*0Sstevel@tonic-gate 		if (CPU->cpu_ftrace.ftd_state & FTRACE_ENABLED)	\
103*0Sstevel@tonic-gate 			ftrace_1(fmt, d1);			\
104*0Sstevel@tonic-gate 	}
105*0Sstevel@tonic-gate #define	FTRACE_2(fmt, d1, d2) 					\
106*0Sstevel@tonic-gate 	{							\
107*0Sstevel@tonic-gate 		if (CPU->cpu_ftrace.ftd_state & FTRACE_ENABLED)	\
108*0Sstevel@tonic-gate 			ftrace_2(fmt, d1, d2);			\
109*0Sstevel@tonic-gate 	}
110*0Sstevel@tonic-gate #define	FTRACE_3(fmt, d1, d2, d3) 				\
111*0Sstevel@tonic-gate 	{							\
112*0Sstevel@tonic-gate 		if (CPU->cpu_ftrace.ftd_state & FTRACE_ENABLED)	\
113*0Sstevel@tonic-gate 			ftrace_3(fmt, d1, d2, d3);		\
114*0Sstevel@tonic-gate 	}
115*0Sstevel@tonic-gate #define	FTRACE_START()	ftrace_start()
116*0Sstevel@tonic-gate #define	FTRACE_STOP()	ftrace_stop()
117*0Sstevel@tonic-gate 
118*0Sstevel@tonic-gate #endif	/* _KERNEL */
119*0Sstevel@tonic-gate 
120*0Sstevel@tonic-gate #endif	/* !defined(_ASM) */
121*0Sstevel@tonic-gate 
122*0Sstevel@tonic-gate #ifdef	__cplusplus
123*0Sstevel@tonic-gate }
124*0Sstevel@tonic-gate #endif
125*0Sstevel@tonic-gate 
126*0Sstevel@tonic-gate #endif	/* _SYS_FTRACE_H */
127