bsd/sys/ktrace.h

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