xref: /dragonfly/sys/sys/ktrace.h (revision 984263bc)
1 /*
2  * Copyright (c) 1988, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *	This product includes software developed by the University of
16  *	California, Berkeley and its contributors.
17  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  *	@(#)ktrace.h	8.1 (Berkeley) 6/2/93
34  * $FreeBSD: src/sys/sys/ktrace.h,v 1.19.2.3 2001/01/06 09:58:23 alfred Exp $
35  */
36 
37 #ifndef _SYS_KTRACE_H_
38 #define _SYS_KTRACE_H_
39 
40 /*
41  * operations to ktrace system call  (KTROP(op))
42  */
43 #define KTROP_SET		0	/* set trace points */
44 #define KTROP_CLEAR		1	/* clear trace points */
45 #define KTROP_CLEARFILE		2	/* stop all tracing to file */
46 #define	KTROP(o)		((o)&3)	/* macro to extract operation */
47 /*
48  * flags (ORed in with operation)
49  */
50 #define KTRFLAG_DESCEND		4	/* perform op on all children too */
51 
52 /*
53  * ktrace record header
54  */
55 struct ktr_header {
56 	int	ktr_len;		/* length of buf */
57 	short	ktr_type;		/* trace record type */
58 	pid_t	ktr_pid;		/* process id */
59 	char	ktr_comm[MAXCOMLEN+1];	/* command name */
60 	struct	timeval ktr_time;	/* timestamp */
61 	caddr_t	ktr_buf;
62 };
63 
64 /*
65  * Test for kernel trace point (MP SAFE)
66  */
67 #define KTRPOINT(p, type)	\
68 	(((p)->p_traceflag & ((1<<(type))|KTRFAC_ACTIVE)) == (1<<(type)))
69 
70 /*
71  * ktrace record types
72  */
73 
74 /*
75  * KTR_SYSCALL - system call record
76  */
77 #define KTR_SYSCALL	1
78 struct ktr_syscall {
79 	short	ktr_code;		/* syscall number */
80 	short	ktr_narg;		/* number of arguments */
81 	/*
82 	 * followed by ktr_narg register_t
83 	 */
84 	register_t	ktr_args[1];
85 };
86 
87 /*
88  * KTR_SYSRET - return from system call record
89  */
90 #define KTR_SYSRET	2
91 struct ktr_sysret {
92 	short	ktr_code;
93 	short	ktr_eosys;
94 	int	ktr_error;
95 	register_t	ktr_retval;
96 };
97 
98 /*
99  * KTR_NAMEI - namei record
100  */
101 #define KTR_NAMEI	3
102 	/* record contains pathname */
103 
104 /*
105  * KTR_GENIO - trace generic process i/o
106  */
107 #define KTR_GENIO	4
108 struct ktr_genio {
109 	int	ktr_fd;
110 	enum	uio_rw ktr_rw;
111 	/*
112 	 * followed by data successfully read/written
113 	 */
114 };
115 
116 /*
117  * KTR_PSIG - trace processed signal
118  */
119 #define	KTR_PSIG	5
120 struct ktr_psig {
121 	int	signo;
122 	sig_t	action;
123 	int	code;
124 	sigset_t mask;
125 };
126 
127 /*
128  * KTR_CSW - trace context switches
129  */
130 #define KTR_CSW		6
131 struct ktr_csw {
132 	int	out;	/* 1 if switch out, 0 if switch in */
133 	int	user;	/* 1 if usermode (ivcsw), 0 if kernel (vcsw) */
134 };
135 
136 /*
137  * KTR_USER - data comming from userland
138  */
139 #define	KTR_USER_MAXLEN	2048	/* maximum length of passed data */
140 #define KTR_USER	7
141 
142 /*
143  * kernel trace points (in p_traceflag)
144  */
145 #define KTRFAC_MASK	0x00ffffff
146 #define KTRFAC_SYSCALL	(1<<KTR_SYSCALL)
147 #define KTRFAC_SYSRET	(1<<KTR_SYSRET)
148 #define KTRFAC_NAMEI	(1<<KTR_NAMEI)
149 #define KTRFAC_GENIO	(1<<KTR_GENIO)
150 #define	KTRFAC_PSIG	(1<<KTR_PSIG)
151 #define KTRFAC_CSW	(1<<KTR_CSW)
152 #define KTRFAC_USER	(1<<KTR_USER)
153 /*
154  * trace flags (also in p_traceflags)
155  */
156 #define KTRFAC_ROOT	0x80000000	/* root set this trace */
157 #define KTRFAC_INHERIT	0x40000000	/* pass trace flags to children */
158 #define KTRFAC_ACTIVE	0x20000000	/* ktrace logging in progress, ignore */
159 
160 #ifdef	_KERNEL
161 void	ktrnamei __P((struct vnode *,char *));
162 void	ktrcsw __P((struct vnode *,int,int));
163 void	ktrpsig __P((struct vnode *, int, sig_t, sigset_t *, int));
164 void	ktrgenio __P((struct vnode *, int, enum uio_rw, struct uio *, int));
165 void	ktrsyscall __P((struct vnode *, int, int narg, register_t args[]));
166 void	ktrsysret __P((struct vnode *, int, int, register_t));
167 
168 #else
169 
170 #include <sys/cdefs.h>
171 
172 __BEGIN_DECLS
173 int	ktrace __P((const char *, int, int, pid_t));
174 int	utrace __P((const void *, size_t));
175 __END_DECLS
176 
177 #endif
178 
179 #endif
180