bsd/sys/ktrace.h

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