bsd/sys/ktrace.h

   1 /*
   2  * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
   7  *
   8  * This file contains Original Code and/or Modifications of Original Code
   9  * as defined in and that are subject to the Apple Public Source License
  10  * Version 2.0 (the 'License'). You may not use this file except in
  11  * compliance with the License. Please obtain a copy of the License at
  12  * http://www.opensource.apple.com/apsl/ and read it before using this
  13  * file.
  14  *
  15  * The Original Code and all software distributed under the License are
  16  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  17  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  18  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  20  * Please see the License for the specific language governing rights and
  21  * limitations under the License.
  22  *
  23  * @APPLE_LICENSE_HEADER_END@
  24  */
  25 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
  26 /*
  27  * Copyright (c) 1988, 1993
  28  *      The Regents of the University of California.  All rights reserved.
  29  *
  30  * Redistribution and use in source and binary forms, with or without
  31  * modification, are permitted provided that the following conditions
  32  * are met:
  33  * 1. Redistributions of source code must retain the above copyright
  34  *    notice, this list of conditions and the following disclaimer.
  35  * 2. Redistributions in binary form must reproduce the above copyright
  36  *    notice, this list of conditions and the following disclaimer in the
  37  *    documentation and/or other materials provided with the distribution.
  38  * 3. All advertising materials mentioning features or use of this software
  39  *    must display the following acknowledgement:
  40  *      This product includes software developed by the University of
  41  *      California, Berkeley and its contributors.
  42  * 4. Neither the name of the University nor the names of its contributors
  43  *    may be used to endorse or promote products derived from this software
  44  *    without specific prior written permission.
  45  *
  46  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  47  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  48  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  49  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  50  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  51  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  52  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  53  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  54  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  55  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  56  * SUCH DAMAGE.
  57  *
  58  *      @(#)ktrace.h    8.1 (Berkeley) 6/2/93
  59  * $FreeBSD: src/sys/sys/ktrace.h,v 1.19.2.3 2001/01/06 09:58:23 alfred Exp $
  60  */
  61
  62 #ifndef _SYS_KTRACE_H_
  63 #define _SYS_KTRACE_H_
  64
  65 #include <sys/appleapiopts.h>
  66
  67 #if defined(MACH_KERNEL_PRIVATE)
  68
  69 #ifdef __APPLE_API_PRIVATE
  70 void ktrsyscall(void *, int, int, void *, int);
  71 void ktrsysret(void *, int, int, int, int);
  72 #endif /* __APPLE_API_PRIVATE */
  73
  74 #else
  75
  76 #ifdef __APPLE_API_UNSTABLE
  77 /*
  78  * operations to ktrace system call  (KTROP(op))
  79  */
  80 #define KTROP_SET               0       /* set trace points */
  81 #define KTROP_CLEAR             1       /* clear trace points */
  82 #define KTROP_CLEARFILE         2       /* stop all tracing to file */
  83 #define KTROP(o)                ((o)&3) /* macro to extract operation */
  84 /*
  85  * flags (ORed in with operation)
  86  */
  87 #define KTRFLAG_DESCEND         4       /* perform op on all children too */
  88
  89 /*
  90  * ktrace record header
  91  */
  92 struct ktr_header {
  93         int     ktr_len;                /* length of buf */
  94         short   ktr_type;               /* trace record type */
  95         pid_t   ktr_pid;                /* process id */
  96         char    ktr_comm[MAXCOMLEN+1];  /* command name */
  97         struct  timeval ktr_time;       /* timestamp */
  98         caddr_t ktr_buf;
  99 };
 100
 101 /*
 102  * Test for kernel trace point
 103  */
 104 #define KTRPOINT(p, type)       \
 105         (((p)->p_traceflag & ((1<<(type))|KTRFAC_ACTIVE)) == (1<<(type)))
 106
 107 /*
 108  * ktrace record types
 109  */
 110
 111 /*
 112  * KTR_SYSCALL - system call record
 113  */
 114 #define KTR_SYSCALL     1
 115 struct ktr_syscall {
 116         short   ktr_code;               /* syscall number */
 117         short   ktr_narg;               /* number of arguments */
 118         /*
 119          * followed by ktr_narg register_t
 120          */
 121         register_t      ktr_args[1];
 122 };
 123
 124 /*
 125  * KTR_SYSRET - return from system call record
 126  */
 127 #define KTR_SYSRET      2
 128 struct ktr_sysret {
 129         short   ktr_code;
 130         short   ktr_eosys;
 131         int     ktr_error;
 132         register_t      ktr_retval;
 133 };
 134
 135 /*
 136  * KTR_NAMEI - namei record
 137  */
 138 #define KTR_NAMEI       3
 139         /* record contains pathname */
 140
 141 /*
 142  * KTR_GENIO - trace generic process i/o
 143  */
 144 #define KTR_GENIO       4
 145 struct ktr_genio {
 146         int     ktr_fd;
 147         enum    uio_rw ktr_rw;
 148         /*
 149          * followed by data successfully read/written
 150          */
 151 };
 152
 153 /*
 154  * KTR_PSIG - trace processed signal
 155  */
 156 #define KTR_PSIG        5
 157 struct ktr_psig {
 158         int     signo;
 159         sig_t   action;
 160         int     code;
 161         sigset_t mask;
 162 };
 163
 164 /*
 165  * KTR_CSW - trace context switches
 166  */
 167 #define KTR_CSW         6
 168 struct ktr_csw {
 169         int     out;    /* 1 if switch out, 0 if switch in */
 170         int     user;   /* 1 if usermode (ivcsw), 0 if kernel (vcsw) */
 171 };
 172
 173 /*
 174  * KTR_USER - data comming from userland
 175  */
 176 #define KTR_USER_MAXLEN 2048    /* maximum length of passed data */
 177 #define KTR_USER        7
 178
 179 /*
 180  * kernel trace points (in p_traceflag)
 181  */
 182 #define KTRFAC_MASK     0x00ffffff
 183 #define KTRFAC_SYSCALL  (1<<KTR_SYSCALL)
 184 #define KTRFAC_SYSRET   (1<<KTR_SYSRET)
 185 #define KTRFAC_NAMEI    (1<<KTR_NAMEI)
 186 #define KTRFAC_GENIO    (1<<KTR_GENIO)
 187 #define KTRFAC_PSIG     (1<<KTR_PSIG)
 188 #define KTRFAC_CSW      (1<<KTR_CSW)
 189 #define KTRFAC_USER     (1<<KTR_USER)
 190 /*
 191  * trace flags (also in p_traceflags)
 192  */
 193 #define KTRFAC_ROOT     0x80000000      /* root set this trace */
 194 #define KTRFAC_INHERIT  0x40000000      /* pass trace flags to children */
 195 #define KTRFAC_ACTIVE   0x20000000      /* ktrace logging in progress, ignore */
 196
 197
 198 #ifdef  KERNEL
 199 #ifdef __APPLE_API_PRIVATE
 200 void    ktrnamei __P((struct vnode *,char *));
 201 void    ktrcsw __P((struct vnode *, int, int, int));
 202 void    ktrpsig __P((struct vnode *, int, sig_t, sigset_t *, int, int));
 203 void    ktrgenio __P((struct vnode *, int, enum uio_rw,
 204             struct uio *, int, int));
 205 void    ktrsyscall __P((struct proc *, int, int, register_t args[], int));
 206 void    ktrsysret __P((struct proc *, int, int, register_t, int));
 207 #endif /* __APPLE_API_PRIVATE */
 208 #else
 209
 210 #include <sys/cdefs.h>
 211
 212 __BEGIN_DECLS
 213 int     ktrace __P((const char *, int, int, pid_t));
 214 int     utrace __P((const void *, size_t));
 215 __END_DECLS
 216
 217 #endif  /* !KERNEL */
 218
 219 #endif /* __APPLE_API_UNSTABLE */
 220 #endif /* !MACH_KERNEL_PRIVATE */
 221 #endif /* !_SYS_KTRACE_H_ */
 222