bsd/sys/ktrace.h

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