sys/sys/ktrace.h

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