ktrace.h revision 1.7 
1/*	$OpenBSD: ktrace.h,v 1.7 2002/03/14 01:27:14 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. All advertising materials mentioning features or use of this software
17 *    must display the following acknowledgement:
18 *	This product includes software developed by the University of
19 *	California, Berkeley and its contributors.
20 * 4. Neither the name of the University nor the names of its contributors
21 *    may be used to endorse or promote products derived from this software
22 *    without specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * SUCH DAMAGE.
35 *
36 *	@(#)ktrace.h	8.1 (Berkeley) 6/2/93
37 */
38
39/*
40 * operations to ktrace system call  (KTROP(op))
41 */
42#define KTROP_SET		0	/* set trace points */
43#define KTROP_CLEAR		1	/* clear trace points */
44#define KTROP_CLEARFILE		2	/* stop all tracing to file */
45#define	KTROP(o)		((o)&3)	/* macro to extract operation */
46/*
47 * flags (ORed in with operation)
48 */
49#define KTRFLAG_DESCEND		4	/* perform op on all children too */
50
51/*
52 * ktrace record header
53 */
54struct ktr_header {
55	int	ktr_len;		/* length of buf */
56	short	ktr_type;		/* trace record type */
57	pid_t	ktr_pid;		/* process id */
58	char	ktr_comm[MAXCOMLEN+1];	/* command name */
59	struct	timeval ktr_time;	/* timestamp */
60	caddr_t	ktr_buf;
61};
62
63/*
64 * Test for kernel trace point
65 */
66#define KTRPOINT(p, type)	\
67	(((p)->p_traceflag & ((1<<(type))|KTRFAC_ACTIVE)) == (1<<(type)))
68
69/*
70 * ktrace record types
71 */
72
73/*
74 * KTR_SYSCALL - system call record
75 */
76#define KTR_SYSCALL	1
77struct ktr_syscall {
78	int	ktr_code;		/* syscall number */
79	int	ktr_argsize;		/* size of arguments */
80	/*
81	 * followed by ktr_argsize/sizeof(register_t) "register_t"s
82	 */
83};
84
85/*
86 * KTR_SYSRET - return from system call record
87 */
88#define KTR_SYSRET	2
89struct ktr_sysret {
90	short	ktr_code;
91	short	ktr_eosys;
92	int	ktr_error;
93	int	ktr_retval;
94};
95
96/*
97 * KTR_NAMEI - namei record
98 */
99#define KTR_NAMEI	3
100	/* record contains pathname */
101
102/*
103 * KTR_GENIO - trace generic process i/o
104 */
105#define KTR_GENIO	4
106struct ktr_genio {
107	int	ktr_fd;
108	enum	uio_rw ktr_rw;
109	/*
110	 * followed by data successfully read/written
111	 */
112};
113
114/*
115 * KTR_PSIG - trace processed signal
116 */
117#define	KTR_PSIG	5
118struct ktr_psig {
119	int	signo;
120	sig_t	action;
121	int	mask;
122	int	code;
123	siginfo_t si;
124};
125
126/*
127 * KTR_CSW - trace context switches
128 */
129#define KTR_CSW		6
130struct ktr_csw {
131	int	out;	/* 1 if switch out, 0 if switch in */
132	int	user;	/* 1 if usermode (ivcsw), 0 if kernel (vcsw) */
133};
134
135/*
136 * KTR_EMUL - emulation change
137 */
138#define KTR_EMUL	7
139	/* record contains emulation name */
140
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_EMUL	(1<<KTR_EMUL)
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#ifndef	_KERNEL
161
162#include <sys/cdefs.h>
163
164__BEGIN_DECLS
165int	ktrace(const char *, int, int, pid_t);
166__END_DECLS
167
168#else
169
170void ktrcsw(struct proc *, int, int);
171void ktremul(struct proc *, char *);
172void ktrgenio(struct proc *, int, enum uio_rw, struct iovec *, int, int);
173void ktrnamei(struct proc *, char *);
174void ktrpsig(struct proc *, int, sig_t, int, int, siginfo_t *);
175void ktrsyscall(struct proc *, register_t, size_t, register_t []);
176void ktrsysret(struct proc *, register_t, int, register_t);
177
178void ktrsettracevnode(struct proc *, struct vnode *);
179
180#endif	/* !_KERNEL */
181