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: src/sys/sys/ktrace.h,v 1.19.2.3 2001/01/06 09:58:23 alfred Exp $ 35 * $DragonFly: src/sys/sys/ktrace.h,v 1.9 2007/05/07 15:43:29 dillon Exp $ 36 */ 37 38 #ifndef _SYS_KTRACE_H_ 39 #define _SYS_KTRACE_H_ 40 41 #ifndef _SYS_TYPES_H_ 42 #include <sys/types.h> 43 #endif 44 #ifndef _SYS_TIME_H_ 45 #include <sys/time.h> 46 #endif 47 #ifndef _SYS_UIO_H_ 48 #include <sys/uio.h> 49 #endif 50 #ifndef _SYS_SIGNAL_H_ 51 #include <sys/signal.h> 52 #endif 53 54 struct proc; 55 56 struct ktrace_node { 57 struct vnode *kn_vp; 58 int kn_refs; 59 }; 60 61 typedef struct ktrace_node *ktrace_node_t; 62 63 64 /* 65 * operations to ktrace system call (KTROP(op)) 66 */ 67 #define KTROP_SET 0 /* set trace points */ 68 #define KTROP_CLEAR 1 /* clear trace points */ 69 #define KTROP_CLEARFILE 2 /* stop all tracing to file */ 70 #define KTROP(o) ((o)&3) /* macro to extract operation */ 71 /* 72 * flags (ORed in with operation) 73 */ 74 #define KTRFLAG_DESCEND 4 /* perform op on all children too */ 75 76 /* 77 * ktrace record header 78 */ 79 struct ktr_header { 80 int ktr_len; /* length of buf */ 81 short ktr_type; /* trace record type */ 82 short ktr_flags; /* reserved for future use */ 83 pid_t ktr_pid; /* process id */ 84 lwpid_t ktr_tid; /* lwp id */ 85 char ktr_comm[MAXCOMLEN+1]; /* command name */ 86 struct timeval ktr_time; /* timestamp */ 87 caddr_t ktr_buf; 88 }; 89 90 #define KTRH_THREADED 0x0001 /* multiple threads present */ 91 92 /* 93 * Test for kernel trace point (MP SAFE) 94 */ 95 #define KTRPOINT(td, type) \ 96 ((td->td_proc) && (((td)->td_proc->p_traceflag & ((1<<(type))|KTRFAC_ACTIVE)) == (1<<(type)))) 97 98 /* 99 * ktrace record types 100 */ 101 102 /* 103 * KTR_SYSCALL - system call record 104 */ 105 #define KTR_SYSCALL 1 106 struct ktr_syscall { 107 short ktr_code; /* syscall number */ 108 short ktr_narg; /* number of arguments */ 109 /* 110 * followed by ktr_narg register_t 111 */ 112 register_t ktr_args[1]; 113 }; 114 115 /* 116 * KTR_SYSRET - return from system call record 117 */ 118 #define KTR_SYSRET 2 119 struct ktr_sysret { 120 short ktr_code; 121 short ktr_eosys; 122 int ktr_error; 123 register_t ktr_retval; 124 }; 125 126 /* 127 * KTR_NAMEI - namei record 128 */ 129 #define KTR_NAMEI 3 130 /* record contains pathname */ 131 132 /* 133 * KTR_GENIO - trace generic process i/o 134 */ 135 #define KTR_GENIO 4 136 struct ktr_genio { 137 int ktr_fd; 138 enum uio_rw ktr_rw; 139 /* 140 * followed by data successfully read/written 141 */ 142 }; 143 144 /* 145 * KTR_PSIG - trace processed signal 146 */ 147 #define KTR_PSIG 5 148 struct ktr_psig { 149 int signo; 150 sig_t action; 151 int code; 152 sigset_t mask; 153 }; 154 155 /* 156 * KTR_CSW - trace context switches 157 */ 158 #define KTR_CSW 6 159 struct ktr_csw { 160 int out; /* 1 if switch out, 0 if switch in */ 161 int user; /* 1 if usermode (ivcsw), 0 if kernel (vcsw) */ 162 }; 163 164 /* 165 * KTR_USER - data comming from userland 166 */ 167 #define KTR_USER_MAXLEN 2048 /* maximum length of passed data */ 168 #define KTR_USER 7 169 170 /* 171 * kernel trace points (in p_traceflag) 172 */ 173 #define KTRFAC_MASK 0x00ffffff 174 #define KTRFAC_SYSCALL (1<<KTR_SYSCALL) 175 #define KTRFAC_SYSRET (1<<KTR_SYSRET) 176 #define KTRFAC_NAMEI (1<<KTR_NAMEI) 177 #define KTRFAC_GENIO (1<<KTR_GENIO) 178 #define KTRFAC_PSIG (1<<KTR_PSIG) 179 #define KTRFAC_CSW (1<<KTR_CSW) 180 #define KTRFAC_USER (1<<KTR_USER) 181 /* 182 * trace flags (also in p_traceflags) 183 */ 184 #define KTRFAC_ROOT 0x80000000 /* root set this trace */ 185 #define KTRFAC_INHERIT 0x40000000 /* pass trace flags to children */ 186 #define KTRFAC_ACTIVE 0x20000000 /* ktrace logging in progress, ignore */ 187 188 #ifdef _KERNEL 189 void ktrnamei (struct proc *,char *); 190 void ktrcsw (struct proc *,int,int); 191 void ktrpsig (struct proc *, int, sig_t, sigset_t *, int); 192 void ktrgenio (struct proc *, int, enum uio_rw, struct uio *, int); 193 void ktrsyscall (struct proc *, int, int narg, register_t args[]); 194 void ktrsysret (struct proc *, int, int, register_t); 195 void ktrdestroy (struct ktrace_node **); 196 struct ktrace_node *ktrinherit (struct ktrace_node *); 197 198 #else 199 200 #include <sys/cdefs.h> 201 202 __BEGIN_DECLS 203 int ktrace (const char *, int, int, pid_t); 204 int utrace (const void *, size_t); 205 __END_DECLS 206 207 #endif 208 209 #endif 210