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 * 3. 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
30 * $FreeBSD: src/sys/sys/ktrace.h,v 1.19.2.3 2001/01/06 09:58:23 alfred Exp $
31 * $DragonFly: src/sys/sys/ktrace.h,v 1.10 2008/04/14 12:01:53 dillon Exp $
34 #ifndef _SYS_KTRACE_H_
35 #define _SYS_KTRACE_H_
38 #include <sys/types.h>
46 #ifndef _SYS_SIGNAL_H_
47 #include <sys/signal.h>
57 typedef struct ktrace_node *ktrace_node_t;
61 * operations to ktrace system call (KTROP(op))
63 #define KTROP_SET 0 /* set trace points */
64 #define KTROP_CLEAR 1 /* clear trace points */
65 #define KTROP_CLEARFILE 2 /* stop all tracing to file */
66 #define KTROP(o) ((o)&3) /* macro to extract operation */
68 * flags (ORed in with operation)
70 #define KTRFLAG_DESCEND 4 /* perform op on all children too */
73 * ktrace record header
76 int ktr_len; /* length of buf */
77 short ktr_type; /* trace record type */
78 short ktr_flags; /* reserved for future use */
79 pid_t ktr_pid; /* process id */
80 lwpid_t ktr_tid; /* lwp id */
81 char ktr_comm[MAXCOMLEN+1]; /* command name */
82 struct timeval ktr_time; /* timestamp */
86 #define KTRH_THREADED 0x0001 /* multiple threads present */
88 #define KTRH_CPUID_ENCODE(cpuid) (((cpuid) & 0xFF) << 8)
89 #define KTRH_CPUID_DECODE(flags) (((flags) >> 8) & 0xFF)
92 * Test for kernel trace point (MP SAFE)
94 #define KTRPOINT(td, type) \
95 ((td)->td_proc && ((td)->td_proc->p_traceflag & (1<<(type))) && \
96 (((td)->td_proc->p_traceflag | (td)->td_lwp->lwp_traceflag) & \
101 * ktrace record types
105 * KTR_SYSCALL - system call record
107 #define KTR_SYSCALL 1
109 short ktr_code; /* syscall number */
110 short ktr_narg; /* number of arguments */
112 * Followed by ktr_narg register_t (can be more than 8)
114 register_t ktr_args[8];
118 * KTR_SYSRET - return from system call record
125 register_t ktr_retval;
129 * KTR_NAMEI - namei record
132 /* record contains pathname */
135 * KTR_GENIO - trace generic process i/o
142 * followed by data successfully read/written
147 * KTR_PSIG - trace processed signal
158 * KTR_CSW - trace context switches
162 int out; /* 1 if switch out, 0 if switch in */
163 int user; /* 1 if usermode (ivcsw), 0 if kernel (vcsw) */
167 * KTR_USER - data comming from userland
169 #define KTR_USER_MAXLEN 2048 /* maximum length of passed data */
173 * kernel trace points (in p_traceflag)
175 #define KTRFAC_MASK 0x00ffffff
176 #define KTRFAC_SYSCALL (1<<KTR_SYSCALL)
177 #define KTRFAC_SYSRET (1<<KTR_SYSRET)
178 #define KTRFAC_NAMEI (1<<KTR_NAMEI)
179 #define KTRFAC_GENIO (1<<KTR_GENIO)
180 #define KTRFAC_PSIG (1<<KTR_PSIG)
181 #define KTRFAC_CSW (1<<KTR_CSW)
182 #define KTRFAC_USER (1<<KTR_USER)
184 * trace flags (also in p_traceflags)
186 #define KTRFAC_ROOT 0x80000000 /* root set this trace */
187 #define KTRFAC_INHERIT 0x40000000 /* pass trace flags to children */
188 #define KTRFAC_ACTIVE 0x20000000 /* ktrace logging in progress, ignore */
191 void ktrnamei (struct lwp *,char *);
192 void ktrcsw (struct lwp *,int,int);
193 void ktrpsig (struct lwp *, int, sig_t, sigset_t *, int);
194 void ktrgenio (struct lwp *, int, enum uio_rw, struct uio *, int);
195 void ktrsyscall (struct lwp *, int, int narg, register_t args[]);
196 void ktrsysret (struct lwp *, int, int, register_t);
197 void ktrdestroy (struct ktrace_node **);
198 struct ktrace_node *ktrinherit (struct ktrace_node *);
202 #include <sys/cdefs.h>
205 int ktrace (const char *, int, int, pid_t);
206 int utrace (const void *, size_t);