ktrace.h revision 1.19
1/* $OpenBSD: ktrace.h,v 1.19 2014/03/26 05:23:42 guenther Exp $ */ 2/* $NetBSD: ktrace.h,v 1.12 1996/02/04 02:12:29 christos Exp $ */ 3 4/* 5 * Copyright (c) 1988, 1993 6 * The Regents of the University of California. All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 3. Neither the name of the University nor the names of its contributors 17 * may be used to endorse or promote products derived from this software 18 * without specific prior written permission. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30 * SUCH DAMAGE. 31 * 32 * @(#)ktrace.h 8.1 (Berkeley) 6/2/93 33 */ 34 35/* 36 * operations to ktrace system call (KTROP(op)) 37 */ 38#define KTROP_SET 0 /* set trace points */ 39#define KTROP_CLEAR 1 /* clear trace points */ 40#define KTROP_CLEARFILE 2 /* stop all tracing to file */ 41#define KTROP(o) ((o)&3) /* macro to extract operation */ 42/* 43 * flags (ORed in with operation) 44 */ 45#define KTRFLAG_DESCEND 4 /* perform op on all children too */ 46 47/* 48 * ktrace record header 49 */ 50struct ktr_header { 51 uint ktr_type; /* trace record type */ 52 pid_t ktr_pid; /* process id */ 53 pid_t ktr_tid; /* thread id */ 54 struct timespec ktr_time; /* timestamp */ 55 char ktr_comm[MAXCOMLEN+1]; /* command name */ 56 size_t ktr_len; /* length of buf */ 57}; 58 59/* 60 * Test for kernel trace point 61 */ 62#define KTRPOINT(p, type) \ 63 ((p)->p_p->ps_traceflag & (1<<(type)) && ((p)->p_flag & P_INKTR) == 0) 64 65/* 66 * ktrace record types 67 */ 68 69 /* 70 * KTR_START - start of trace record, one per ktrace(KTROP_SET) syscall 71 */ 72#define KTR_START 0x4b545200 /* "KTR" */ 73 74/* 75 * KTR_SYSCALL - system call record 76 */ 77#define KTR_SYSCALL 1 78struct ktr_syscall { 79 int ktr_code; /* syscall number */ 80 int ktr_argsize; /* size of arguments */ 81 /* 82 * followed by ktr_argsize/sizeof(register_t) "register_t"s 83 */ 84}; 85 86/* 87 * KTR_SYSRET - return from system call record 88 */ 89#define KTR_SYSRET 2 90struct ktr_sysret { 91 short ktr_code; 92 short ktr_eosys; 93 int ktr_error; 94 register_t ktr_retval; 95}; 96 97/* 98 * KTR_NAMEI - namei record 99 */ 100#define KTR_NAMEI 3 101 /* record contains pathname */ 102 103/* 104 * KTR_GENIO - trace generic process i/o 105 */ 106#define KTR_GENIO 4 107struct ktr_genio { 108 int ktr_fd; 109 enum uio_rw ktr_rw; 110 /* 111 * followed by data successfully read/written 112 */ 113}; 114 115/* 116 * KTR_PSIG - trace processed signal 117 */ 118#define KTR_PSIG 5 119struct ktr_psig { 120 int signo; 121 sig_t action; 122 int mask; 123 int code; 124 siginfo_t si; 125}; 126 127/* 128 * KTR_CSW - trace context switches 129 */ 130#define KTR_CSW 6 131struct ktr_csw { 132 int out; /* 1 if switch out, 0 if switch in */ 133 int user; /* 1 if usermode (ivcsw), 0 if kernel (vcsw) */ 134}; 135 136/* 137 * KTR_EMUL - emulation change 138 */ 139#define KTR_EMUL 7 140 /* record contains emulation name */ 141 142/* 143 * KTR_STRUCT - misc. structs 144 */ 145#define KTR_STRUCT 8 146 /* 147 * record contains null-terminated struct name followed by 148 * struct contents 149 */ 150struct sockaddr; 151struct stat; 152 153/* 154 * KTR_USER - user record 155 */ 156#define KTR_USER 9 157#define KTR_USER_MAXIDLEN 20 158#define KTR_USER_MAXLEN 2048 /* maximum length of passed data */ 159struct ktr_user { 160 char ktr_id[KTR_USER_MAXIDLEN]; /* string id of caller */ 161 /* 162 * Followed by ktr_len - sizeof(struct ktr_user) of user data. 163 */ 164}; 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_EMUL (1<<KTR_EMUL) 177#define KTRFAC_STRUCT (1<<KTR_STRUCT) 178#define KTRFAC_USER (1<<KTR_USER) 179 180/* 181 * trace flags (also in p_traceflags) 182 */ 183#define KTRFAC_ROOT 0x80000000 /* root set this trace */ 184#define KTRFAC_INHERIT 0x40000000 /* pass trace flags to children */ 185 186#ifndef _KERNEL 187 188#include <sys/cdefs.h> 189 190__BEGIN_DECLS 191int ktrace(const char *, int, int, pid_t); 192int utrace(const char *, const void *, size_t); 193__END_DECLS 194 195#else 196 197void ktrcsw(struct proc *, int, int); 198void ktremul(struct proc *); 199void ktrgenio(struct proc *, int, enum uio_rw, struct iovec *, ssize_t); 200void ktrnamei(struct proc *, char *); 201void ktrpsig(struct proc *, int, sig_t, int, int, siginfo_t *); 202void ktrsyscall(struct proc *, register_t, size_t, register_t []); 203void ktrsysret(struct proc *, register_t, int, register_t); 204void ktr_kuser(const char *, void *, size_t); 205int ktruser(struct proc *, const char *, const void *, size_t); 206 207void ktrcleartrace(struct process *); 208void ktrsettrace(struct process *, int, struct vnode *, struct ucred *); 209 210void ktrstruct(struct proc *, const char *, const void *, size_t); 211#define ktrsockaddr(p, s, l) \ 212 ktrstruct((p), "sockaddr", (s), (l)) 213#define ktrstat(p, s) \ 214 ktrstruct((p), "stat", (s), sizeof(struct stat)) 215#define ktrabstimespec(p, s) \ 216 ktrstruct((p), "abstimespec", (s), sizeof(struct timespec)) 217#define ktrreltimespec(p, s) \ 218 ktrstruct((p), "reltimespec", (s), sizeof(struct timespec)) 219#define ktrabstimeval(p, s) \ 220 ktrstruct((p), "abstimeval", (s), sizeof(struct timeval)) 221#define ktrreltimeval(p, s) \ 222 ktrstruct((p), "reltimeval", (s), sizeof(struct timeval)) 223#define ktrsigaction(p, s) \ 224 ktrstruct((p), "sigaction", (s), sizeof(struct sigaction)) 225#define ktrrlimit(p, s) \ 226 ktrstruct((p), "rlimit", (s), sizeof(struct rlimit)) 227#define ktrrusage(p, s) \ 228 ktrstruct((p), "rusage", (s), sizeof(struct rusage)) 229#define ktrfdset(p, s, l) \ 230 ktrstruct((p), "fdset", (s), l) 231 232#endif /* !_KERNEL */ 233