2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1988, 1993
5 * The Regents of the University of California. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the University nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * @(#)ktrace.h 8.1 (Berkeley) 6/2/93
35 #ifndef _SYS_KTRACE_H_
36 #define _SYS_KTRACE_H_
38 #include <sys/caprights.h>
41 * operations to ktrace system call (KTROP(op))
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 */
48 * flags (ORed in with operation)
50 #define KTRFLAG_DESCEND 4 /* perform op on all children too */
53 * ktrace record 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 intptr_t ktr_tid; /* was ktr_buffer */
65 * Test for kernel trace point (MP SAFE).
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.
72 #define KTRCHECK(td, type) ((td)->td_proc->p_traceflag & (1 << type))
73 #define KTRPOINT(td, type) (__predict_false(KTRCHECK((td), (type))))
74 #define KTRCHECKDRAIN(td) (!(STAILQ_EMPTY(&(td)->td_proc->p_ktr)))
75 #define KTRUSERRET(td) do { \
76 if (__predict_false(KTRCHECKDRAIN(td))) \
85 * KTR_SYSCALL - system call record
89 short ktr_code; /* syscall number */
90 short ktr_narg; /* number of arguments */
92 * followed by ktr_narg register_t
94 register_t ktr_args[1];
98 * KTR_SYSRET - return from system call record
105 register_t ktr_retval;
109 * KTR_NAMEI - namei record
112 /* record contains pathname */
115 * KTR_GENIO - trace generic process i/o
122 * followed by data successfully read/written
127 * KTR_PSIG - trace processed signal
138 * KTR_CSW - trace context switches
142 int out; /* 1 if switch out, 0 if switch in */
143 int user; /* 1 if usermode (ivcsw), 0 if kernel (vcsw) */
147 int out; /* 1 if switch out, 0 if switch in */
148 int user; /* 1 if usermode (ivcsw), 0 if kernel (vcsw) */
153 * KTR_USER - data coming from userland
155 #define KTR_USER_MAXLEN 2048 /* maximum length of passed data */
159 * KTR_STRUCT - misc. structs
163 * record contains null-terminated struct name followed by
171 * KTR_SYSCTL - name of a sysctl MIB
174 /* record contains null-terminated MIB name */
177 * KTR_PROCCTOR - trace process creation (multiple ABI support)
179 #define KTR_PROCCTOR 10
180 struct ktr_proc_ctor {
181 u_int sv_flags; /* struct sysentvec sv_flags copy */
185 * KTR_PROCDTOR - trace process destruction (multiple ABI support)
187 #define KTR_PROCDTOR 11
190 * KTR_CAPFAIL - trace capability check failures
192 #define KTR_CAPFAIL 12
193 enum ktr_cap_fail_type {
194 CAPFAIL_NOTCAPABLE, /* insufficient capabilities in cap_check() */
195 CAPFAIL_INCREASE, /* attempt to increase capabilities */
196 CAPFAIL_SYSCALL, /* disallowed system call */
197 CAPFAIL_LOOKUP, /* disallowed VFS lookup */
199 struct ktr_cap_fail {
200 enum ktr_cap_fail_type cap_type;
201 cap_rights_t cap_needed;
202 cap_rights_t cap_held;
206 * KTR_FAULT - page fault record
215 * KTR_FAULTEND - end of page fault record
217 #define KTR_FAULTEND 14
218 struct ktr_faultend {
223 * KTR_STRUCT_ARRAY - array of misc. structs
225 #define KTR_STRUCT_ARRAY 15
226 struct ktr_struct_array {
229 * Followed by null-terminated structure name and then payload
235 * KTR_DROP - If this bit is set in ktr_type, then at least one event
236 * between the previous record and this record was dropped.
238 #define KTR_DROP 0x8000
241 * kernel trace points (in p_traceflag)
243 #define KTRFAC_MASK 0x00ffffff
244 #define KTRFAC_SYSCALL (1<<KTR_SYSCALL)
245 #define KTRFAC_SYSRET (1<<KTR_SYSRET)
246 #define KTRFAC_NAMEI (1<<KTR_NAMEI)
247 #define KTRFAC_GENIO (1<<KTR_GENIO)
248 #define KTRFAC_PSIG (1<<KTR_PSIG)
249 #define KTRFAC_CSW (1<<KTR_CSW)
250 #define KTRFAC_USER (1<<KTR_USER)
251 #define KTRFAC_STRUCT (1<<KTR_STRUCT)
252 #define KTRFAC_SYSCTL (1<<KTR_SYSCTL)
253 #define KTRFAC_PROCCTOR (1<<KTR_PROCCTOR)
254 #define KTRFAC_PROCDTOR (1<<KTR_PROCDTOR)
255 #define KTRFAC_CAPFAIL (1<<KTR_CAPFAIL)
256 #define KTRFAC_FAULT (1<<KTR_FAULT)
257 #define KTRFAC_FAULTEND (1<<KTR_FAULTEND)
258 #define KTRFAC_STRUCT_ARRAY (1<<KTR_STRUCT_ARRAY)
261 * trace flags (also in p_traceflags)
263 #define KTRFAC_ROOT 0x80000000 /* root set this trace */
264 #define KTRFAC_INHERIT 0x40000000 /* pass trace flags to children */
265 #define KTRFAC_DROP 0x20000000 /* last event was dropped */
268 void ktrnamei(char *);
269 void ktrcsw(int, int, const char *);
270 void ktrpsig(int, sig_t, sigset_t *, int);
271 void ktrfault(vm_offset_t, int);
272 void ktrfaultend(int);
273 void ktrgenio(int, enum uio_rw, struct uio *, int);
274 void ktrsyscall(int, int narg, register_t args[]);
275 void ktrsysctl(int *name, u_int namelen);
276 void ktrsysret(int, int, register_t);
277 void ktrprocctor(struct proc *);
278 void ktrprocexec(struct proc *, struct ucred **, struct vnode **);
279 void ktrprocexit(struct thread *);
280 void ktrprocfork(struct proc *, struct proc *);
281 void ktruserret(struct thread *);
282 void ktrstruct(const char *, const void *, size_t);
283 void ktrstruct_error(const char *, const void *, size_t, int);
284 void ktrstructarray(const char *, enum uio_seg, const void *, int, size_t);
285 void ktrcapfail(enum ktr_cap_fail_type, const cap_rights_t *,
286 const cap_rights_t *);
287 #define ktrcaprights(s) \
288 ktrstruct("caprights", (s), sizeof(cap_rights_t))
289 #define ktritimerval(s) \
290 ktrstruct("itimerval", (s), sizeof(struct itimerval))
291 #define ktrsockaddr(s) \
292 ktrstruct("sockaddr", (s), ((struct sockaddr *)(s))->sa_len)
294 ktrstruct("stat", (s), sizeof(struct stat))
295 #define ktrstat_error(s, error) \
296 ktrstruct_error("stat", (s), sizeof(struct stat), error)
297 extern u_int ktr_geniosize;
300 #include <sys/cdefs.h>
303 int ktrace(const char *, int, int, pid_t);
304 int utrace(const void *, size_t);