2 * Copyright (c) 1988, 1993
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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 * 4. Neither the name of the University nor the names of its contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * @(#)ktrace.h 8.1 (Berkeley) 6/2/93
33 #ifndef _SYS_KTRACE_H_
34 #define _SYS_KTRACE_H_
36 #include <sys/caprights.h>
39 * operations to ktrace system call (KTROP(op))
41 #define KTROP_SET 0 /* set trace points */
42 #define KTROP_CLEAR 1 /* clear trace points */
43 #define KTROP_CLEARFILE 2 /* stop all tracing to file */
44 #define KTROP(o) ((o)&3) /* macro to extract operation */
46 * flags (ORed in with operation)
48 #define KTRFLAG_DESCEND 4 /* perform op on all children too */
51 * ktrace record header
54 int ktr_len; /* length of buf */
55 short ktr_type; /* trace record type */
56 pid_t ktr_pid; /* process id */
57 char ktr_comm[MAXCOMLEN + 1];/* command name */
58 struct timeval ktr_time; /* timestamp */
59 intptr_t ktr_tid; /* was ktr_buffer */
63 * Test for kernel trace point (MP SAFE).
65 * KTRCHECK() just checks that the type is enabled and is only for
66 * internal use in the ktrace subsystem. KTRPOINT() checks against
67 * ktrace recursion as well as checking that the type is enabled and
68 * is the public interface.
70 #define KTRCHECK(td, type) ((td)->td_proc->p_traceflag & (1 << type))
71 #define KTRPOINT(td, type) \
72 (KTRCHECK((td), (type)) && !((td)->td_pflags & TDP_INKTRACE))
73 #define KTRCHECKDRAIN(td) (!(STAILQ_EMPTY(&(td)->td_proc->p_ktr)))
74 #define KTRUSERRET(td) do { \
75 if (KTRCHECKDRAIN(td)) \
84 * KTR_SYSCALL - system call record
88 short ktr_code; /* syscall number */
89 short ktr_narg; /* number of arguments */
91 * followed by ktr_narg register_t
93 register_t ktr_args[1];
97 * KTR_SYSRET - return from system call record
104 register_t ktr_retval;
108 * KTR_NAMEI - namei record
111 /* record contains pathname */
114 * KTR_GENIO - trace generic process i/o
121 * followed by data successfully read/written
126 * KTR_PSIG - trace processed signal
137 * KTR_CSW - trace context switches
141 int out; /* 1 if switch out, 0 if switch in */
142 int user; /* 1 if usermode (ivcsw), 0 if kernel (vcsw) */
146 int out; /* 1 if switch out, 0 if switch in */
147 int user; /* 1 if usermode (ivcsw), 0 if kernel (vcsw) */
152 * KTR_USER - data coming from userland
154 #define KTR_USER_MAXLEN 2048 /* maximum length of passed data */
158 * KTR_STRUCT - misc. structs
162 * record contains null-terminated struct name followed by
170 * KTR_SYSCTL - name of a sysctl MIB
173 /* record contains null-terminated MIB name */
176 * KTR_PROCCTOR - trace process creation (multiple ABI support)
178 #define KTR_PROCCTOR 10
179 struct ktr_proc_ctor {
180 u_int sv_flags; /* struct sysentvec sv_flags copy */
184 * KTR_PROCDTOR - trace process destruction (multiple ABI support)
186 #define KTR_PROCDTOR 11
189 * KTR_CAPFAIL - trace capability check failures
191 #define KTR_CAPFAIL 12
192 enum ktr_cap_fail_type {
193 CAPFAIL_NOTCAPABLE, /* insufficient capabilities in cap_check() */
194 CAPFAIL_INCREASE, /* attempt to increase capabilities */
195 CAPFAIL_SYSCALL, /* disallowed system call */
196 CAPFAIL_LOOKUP, /* disallowed VFS lookup */
198 struct ktr_cap_fail {
199 enum ktr_cap_fail_type cap_type;
200 cap_rights_t cap_needed;
201 cap_rights_t cap_held;
205 * KTR_FAULT - page fault record
214 * KTR_FAULTEND - end of page fault record
216 #define KTR_FAULTEND 14
217 struct ktr_faultend {
222 * KTR_DROP - If this bit is set in ktr_type, then at least one event
223 * between the previous record and this record was dropped.
225 #define KTR_DROP 0x8000
228 * kernel trace points (in p_traceflag)
230 #define KTRFAC_MASK 0x00ffffff
231 #define KTRFAC_SYSCALL (1<<KTR_SYSCALL)
232 #define KTRFAC_SYSRET (1<<KTR_SYSRET)
233 #define KTRFAC_NAMEI (1<<KTR_NAMEI)
234 #define KTRFAC_GENIO (1<<KTR_GENIO)
235 #define KTRFAC_PSIG (1<<KTR_PSIG)
236 #define KTRFAC_CSW (1<<KTR_CSW)
237 #define KTRFAC_USER (1<<KTR_USER)
238 #define KTRFAC_STRUCT (1<<KTR_STRUCT)
239 #define KTRFAC_SYSCTL (1<<KTR_SYSCTL)
240 #define KTRFAC_PROCCTOR (1<<KTR_PROCCTOR)
241 #define KTRFAC_PROCDTOR (1<<KTR_PROCDTOR)
242 #define KTRFAC_CAPFAIL (1<<KTR_CAPFAIL)
243 #define KTRFAC_FAULT (1<<KTR_FAULT)
244 #define KTRFAC_FAULTEND (1<<KTR_FAULTEND)
247 * trace flags (also in p_traceflags)
249 #define KTRFAC_ROOT 0x80000000 /* root set this trace */
250 #define KTRFAC_INHERIT 0x40000000 /* pass trace flags to children */
251 #define KTRFAC_DROP 0x20000000 /* last event was dropped */
254 void ktrnamei(char *);
255 void ktrcsw(int, int, const char *);
256 void ktrpsig(int, sig_t, sigset_t *, int);
257 void ktrfault(vm_offset_t, int);
258 void ktrfaultend(int);
259 void ktrgenio(int, enum uio_rw, struct uio *, int);
260 void ktrsyscall(int, int narg, register_t args[]);
261 void ktrsysctl(int *name, u_int namelen);
262 void ktrsysret(int, int, register_t);
263 void ktrprocctor(struct proc *);
264 void ktrprocexec(struct proc *, struct ucred **, struct vnode **);
265 void ktrprocexit(struct thread *);
266 void ktrprocfork(struct proc *, struct proc *);
267 void ktruserret(struct thread *);
268 void ktrstruct(const char *, void *, size_t);
269 void ktrcapfail(enum ktr_cap_fail_type, const cap_rights_t *,
270 const cap_rights_t *);
271 #define ktrcaprights(s) \
272 ktrstruct("caprights", (s), sizeof(cap_rights_t))
273 #define ktrsockaddr(s) \
274 ktrstruct("sockaddr", (s), ((struct sockaddr *)(s))->sa_len)
276 ktrstruct("stat", (s), sizeof(struct stat))
280 #include <sys/cdefs.h>
283 int ktrace(const char *, int, int, pid_t);
284 int utrace(const void *, size_t);