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.8 2006/05/21 03:43:47 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 pid_t ktr_pid; /* process id */ 83 char ktr_comm[MAXCOMLEN+1]; /* command name */ 84 struct timeval ktr_time; /* timestamp */ 85 caddr_t ktr_buf; 86 }; 87 88 /* 89 * Test for kernel trace point (MP SAFE) 90 */ 91 #define KTRPOINT(td, type) \ 92 ((td->td_proc) && (((td)->td_proc->p_traceflag & ((1<<(type))|KTRFAC_ACTIVE)) == (1<<(type)))) 93 94 /* 95 * ktrace record types 96 */ 97 98 /* 99 * KTR_SYSCALL - system call record 100 */ 101 #define KTR_SYSCALL 1 102 struct ktr_syscall { 103 short ktr_code; /* syscall number */ 104 short ktr_narg; /* number of arguments */ 105 /* 106 * followed by ktr_narg register_t 107 */ 108 register_t ktr_args[1]; 109 }; 110 111 /* 112 * KTR_SYSRET - return from system call record 113 */ 114 #define KTR_SYSRET 2 115 struct ktr_sysret { 116 short ktr_code; 117 short ktr_eosys; 118 int ktr_error; 119 register_t ktr_retval; 120 }; 121 122 /* 123 * KTR_NAMEI - namei record 124 */ 125 #define KTR_NAMEI 3 126 /* record contains pathname */ 127 128 /* 129 * KTR_GENIO - trace generic process i/o 130 */ 131 #define KTR_GENIO 4 132 struct ktr_genio { 133 int ktr_fd; 134 enum uio_rw ktr_rw; 135 /* 136 * followed by data successfully read/written 137 */ 138 }; 139 140 /* 141 * KTR_PSIG - trace processed signal 142 */ 143 #define KTR_PSIG 5 144 struct ktr_psig { 145 int signo; 146 sig_t action; 147 int code; 148 sigset_t mask; 149 }; 150 151 /* 152 * KTR_CSW - trace context switches 153 */ 154 #define KTR_CSW 6 155 struct ktr_csw { 156 int out; /* 1 if switch out, 0 if switch in */ 157 int user; /* 1 if usermode (ivcsw), 0 if kernel (vcsw) */ 158 }; 159 160 /* 161 * KTR_USER - data comming from userland 162 */ 163 #define KTR_USER_MAXLEN 2048 /* maximum length of passed data */ 164 #define KTR_USER 7 165 166 /* 167 * kernel trace points (in p_traceflag) 168 */ 169 #define KTRFAC_MASK 0x00ffffff 170 #define KTRFAC_SYSCALL (1<<KTR_SYSCALL) 171 #define KTRFAC_SYSRET (1<<KTR_SYSRET) 172 #define KTRFAC_NAMEI (1<<KTR_NAMEI) 173 #define KTRFAC_GENIO (1<<KTR_GENIO) 174 #define KTRFAC_PSIG (1<<KTR_PSIG) 175 #define KTRFAC_CSW (1<<KTR_CSW) 176 #define KTRFAC_USER (1<<KTR_USER) 177 /* 178 * trace flags (also in p_traceflags) 179 */ 180 #define KTRFAC_ROOT 0x80000000 /* root set this trace */ 181 #define KTRFAC_INHERIT 0x40000000 /* pass trace flags to children */ 182 #define KTRFAC_ACTIVE 0x20000000 /* ktrace logging in progress, ignore */ 183 184 #ifdef _KERNEL 185 void ktrnamei (struct proc *,char *); 186 void ktrcsw (struct proc *,int,int); 187 void ktrpsig (struct proc *, int, sig_t, sigset_t *, int); 188 void ktrgenio (struct proc *, int, enum uio_rw, struct uio *, int); 189 void ktrsyscall (struct proc *, int, int narg, register_t args[]); 190 void ktrsysret (struct proc *, int, int, register_t); 191 void ktrdestroy (struct ktrace_node **); 192 struct ktrace_node *ktrinherit (struct ktrace_node *); 193 194 #else 195 196 #include <sys/cdefs.h> 197 198 __BEGIN_DECLS 199 int ktrace (const char *, int, int, pid_t); 200 int utrace (const void *, size_t); 201 __END_DECLS 202 203 #endif 204 205 #endif 206