FreeBSD/Linux Kernel Cross Reference
sys/sys/ktrace.h
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: releng/5.2/sys/sys/ktrace.h 116101 2003-06-09 17:38:32Z jhb $
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 void *ktr_buffer;
62 };
63
64 /*
65 * Test for kernel trace point (MP SAFE).
66 *
67 * KTRCHECK() just checks that the type is enabled and is only for
68 * internal use in the ktrace subsystem. KTRPOINT() checks against
69 * ktrace recursion as well as checking that the type is enabled and
70 * is the public interface.
71 */
72 #define KTRCHECK(td, type) ((td)->td_proc->p_traceflag & (1 << type))
73 #define KTRPOINT(td, type) \
74 (KTRCHECK((td), (type)) && !((td)->td_pflags & TDP_INKTRACE))
75
76 /*
77 * ktrace record types
78 */
79
80 /*
81 * KTR_SYSCALL - system call record
82 */
83 #define KTR_SYSCALL 1
84 struct ktr_syscall {
85 short ktr_code; /* syscall number */
86 short ktr_narg; /* number of arguments */
87 /*
88 * followed by ktr_narg register_t
89 */
90 register_t ktr_args[1];
91 };
92
93 /*
94 * KTR_SYSRET - return from system call record
95 */
96 #define KTR_SYSRET 2
97 struct ktr_sysret {
98 short ktr_code;
99 short ktr_eosys;
100 int ktr_error;
101 register_t ktr_retval;
102 };
103
104 /*
105 * KTR_NAMEI - namei record
106 */
107 #define KTR_NAMEI 3
108 /* record contains pathname */
109
110 /*
111 * KTR_GENIO - trace generic process i/o
112 */
113 #define KTR_GENIO 4
114 struct ktr_genio {
115 int ktr_fd;
116 enum uio_rw ktr_rw;
117 /*
118 * followed by data successfully read/written
119 */
120 };
121
122 /*
123 * KTR_PSIG - trace processed signal
124 */
125 #define KTR_PSIG 5
126 struct ktr_psig {
127 int signo;
128 sig_t action;
129 int code;
130 sigset_t mask;
131 };
132
133 /*
134 * KTR_CSW - trace context switches
135 */
136 #define KTR_CSW 6
137 struct ktr_csw {
138 int out; /* 1 if switch out, 0 if switch in */
139 int user; /* 1 if usermode (ivcsw), 0 if kernel (vcsw) */
140 };
141
142 /*
143 * KTR_USER - data comming from userland
144 */
145 #define KTR_USER_MAXLEN 2048 /* maximum length of passed data */
146 #define KTR_USER 7
147
148 /*
149 * KTR_DROP - If this bit is set in ktr_type, then at least one event
150 * between the previous record and this record was dropped.
151 */
152 #define KTR_DROP 0x8000
153
154 /*
155 * kernel trace points (in p_traceflag)
156 */
157 #define KTRFAC_MASK 0x00ffffff
158 #define KTRFAC_SYSCALL (1<<KTR_SYSCALL)
159 #define KTRFAC_SYSRET (1<<KTR_SYSRET)
160 #define KTRFAC_NAMEI (1<<KTR_NAMEI)
161 #define KTRFAC_GENIO (1<<KTR_GENIO)
162 #define KTRFAC_PSIG (1<<KTR_PSIG)
163 #define KTRFAC_CSW (1<<KTR_CSW)
164 #define KTRFAC_USER (1<<KTR_USER)
165 /*
166 * trace flags (also in p_traceflags)
167 */
168 #define KTRFAC_ROOT 0x80000000 /* root set this trace */
169 #define KTRFAC_INHERIT 0x40000000 /* pass trace flags to children */
170 #define KTRFAC_DROP 0x20000000 /* last event was dropped */
171
172 #ifdef _KERNEL
173 extern struct mtx ktrace_mtx;
174
175 void ktrnamei(char *);
176 void ktrcsw(int, int);
177 void ktrpsig(int, sig_t, sigset_t *, int);
178 void ktrgenio(int, enum uio_rw, struct uio *, int);
179 void ktrsyscall(int, int narg, register_t args[]);
180 void ktrsysret(int, int, register_t);
181
182 #else
183
184 #include <sys/cdefs.h>
185
186 __BEGIN_DECLS
187 int ktrace(const char *, int, int, pid_t);
188 int utrace(const void *, size_t);
189 __END_DECLS
190
191 #endif
192
193 #endif
Cache object: 55ae290f559f8427d10bd89f4ddcb079
|