xref: /dragonfly/sys/sys/ktrace.h (revision af79c6e5)
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  * $DragonFly: src/sys/sys/ktrace.h,v 1.4 2003/08/20 07:31:21 rob Exp $
36  */
37 
38 #ifndef _SYS_KTRACE_H_
39 #define _SYS_KTRACE_H_
40 
41 /*
42  * operations to ktrace system call  (KTROP(op))
43  */
44 #define KTROP_SET		0	/* set trace points */
45 #define KTROP_CLEAR		1	/* clear trace points */
46 #define KTROP_CLEARFILE		2	/* stop all tracing to file */
47 #define	KTROP(o)		((o)&3)	/* macro to extract operation */
48 /*
49  * flags (ORed in with operation)
50  */
51 #define KTRFLAG_DESCEND		4	/* perform op on all children too */
52 
53 /*
54  * ktrace record header
55  */
56 struct ktr_header {
57 	int	ktr_len;		/* length of buf */
58 	short	ktr_type;		/* trace record type */
59 	pid_t	ktr_pid;		/* process id */
60 	char	ktr_comm[MAXCOMLEN+1];	/* command name */
61 	struct	timeval ktr_time;	/* timestamp */
62 	caddr_t	ktr_buf;
63 };
64 
65 /*
66  * Test for kernel trace point (MP SAFE)
67  */
68 #define KTRPOINT(td, type)	\
69 	((td->td_proc) && (((td)->td_proc->p_traceflag & ((1<<(type))|KTRFAC_ACTIVE)) == (1<<(type))))
70 
71 /*
72  * ktrace record types
73  */
74 
75 /*
76  * KTR_SYSCALL - system call record
77  */
78 #define KTR_SYSCALL	1
79 struct ktr_syscall {
80 	short	ktr_code;		/* syscall number */
81 	short	ktr_narg;		/* number of arguments */
82 	/*
83 	 * followed by ktr_narg register_t
84 	 */
85 	register_t	ktr_args[1];
86 };
87 
88 /*
89  * KTR_SYSRET - return from system call record
90  */
91 #define KTR_SYSRET	2
92 struct ktr_sysret {
93 	short	ktr_code;
94 	short	ktr_eosys;
95 	int	ktr_error;
96 	register_t	ktr_retval;
97 };
98 
99 /*
100  * KTR_NAMEI - namei record
101  */
102 #define KTR_NAMEI	3
103 	/* record contains pathname */
104 
105 /*
106  * KTR_GENIO - trace generic process i/o
107  */
108 #define KTR_GENIO	4
109 struct ktr_genio {
110 	int	ktr_fd;
111 	enum	uio_rw ktr_rw;
112 	/*
113 	 * followed by data successfully read/written
114 	 */
115 };
116 
117 /*
118  * KTR_PSIG - trace processed signal
119  */
120 #define	KTR_PSIG	5
121 struct ktr_psig {
122 	int	signo;
123 	sig_t	action;
124 	int	code;
125 	sigset_t mask;
126 };
127 
128 /*
129  * KTR_CSW - trace context switches
130  */
131 #define KTR_CSW		6
132 struct ktr_csw {
133 	int	out;	/* 1 if switch out, 0 if switch in */
134 	int	user;	/* 1 if usermode (ivcsw), 0 if kernel (vcsw) */
135 };
136 
137 /*
138  * KTR_USER - data comming from userland
139  */
140 #define	KTR_USER_MAXLEN	2048	/* maximum length of passed data */
141 #define KTR_USER	7
142 
143 /*
144  * kernel trace points (in p_traceflag)
145  */
146 #define KTRFAC_MASK	0x00ffffff
147 #define KTRFAC_SYSCALL	(1<<KTR_SYSCALL)
148 #define KTRFAC_SYSRET	(1<<KTR_SYSRET)
149 #define KTRFAC_NAMEI	(1<<KTR_NAMEI)
150 #define KTRFAC_GENIO	(1<<KTR_GENIO)
151 #define	KTRFAC_PSIG	(1<<KTR_PSIG)
152 #define KTRFAC_CSW	(1<<KTR_CSW)
153 #define KTRFAC_USER	(1<<KTR_USER)
154 /*
155  * trace flags (also in p_traceflags)
156  */
157 #define KTRFAC_ROOT	0x80000000	/* root set this trace */
158 #define KTRFAC_INHERIT	0x40000000	/* pass trace flags to children */
159 #define KTRFAC_ACTIVE	0x20000000	/* ktrace logging in progress, ignore */
160 
161 #ifdef	_KERNEL
162 void	ktrnamei (struct vnode *,char *);
163 void	ktrcsw (struct vnode *,int,int);
164 void	ktrpsig (struct vnode *, int, sig_t, sigset_t *, int);
165 void	ktrgenio (struct vnode *, int, enum uio_rw, struct uio *, int);
166 void	ktrsyscall (struct vnode *, int, int narg, register_t args[]);
167 void	ktrsysret (struct vnode *, int, int, register_t);
168 
169 #else
170 
171 #include <sys/cdefs.h>
172 
173 __BEGIN_DECLS
174 int	ktrace (const char *, int, int, pid_t);
175 int	utrace (const void *, size_t);
176 __END_DECLS
177 
178 #endif
179 
180 #endif
181