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