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. Neither the name of the University nor the names of its contributors
  14  *    may be used to endorse or promote products derived from this software
  15  *    without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  *      @(#)ktrace.h    8.1 (Berkeley) 6/2/93
  30  * $FreeBSD: src/sys/sys/ktrace.h,v 1.19.2.3 2001/01/06 09:58:23 alfred Exp $
  31  */
  32
  33 #ifndef _SYS_KTRACE_H_
  34 #define _SYS_KTRACE_H_
  35
  36 #ifndef _SYS_TYPES_H_
  37 #include <sys/types.h>
  38 #endif
  39 #ifndef _SYS_TIME_H_
  40 #include <sys/time.h>
  41 #endif
  42 #ifndef _SYS_SIGNAL_H_
  43 #include <sys/signal.h>
  44 #endif
  45
  46 struct proc;
  47
  48 struct ktrace_node {
  49         struct vnode    *kn_vp;
  50         int             kn_refs;
  51 };
  52
  53 typedef struct ktrace_node *ktrace_node_t;
  54
  55
  56 /*
  57  * operations to ktrace system call  (KTROP(op))
  58  */
  59 #define KTROP_SET               0       /* set trace points */
  60 #define KTROP_CLEAR             1       /* clear trace points */
  61 #define KTROP_CLEARFILE         2       /* stop all tracing to file */
  62 #define KTROP(o)                ((o)&3) /* macro to extract operation */
  63 /*
  64  * flags (ORed in with operation)
  65  */
  66 #define KTRFLAG_DESCEND         4       /* perform op on all children too */
  67
  68 /*
  69  * ktrace record header
  70  */
  71 struct ktr_header {
  72         int     ktr_len;                /* length of buf */
  73         short   ktr_type;               /* trace record type */
  74         short   ktr_flags;              /* reserved for future use */
  75         pid_t   ktr_pid;                /* process id */
  76         lwpid_t ktr_tid;                /* lwp id */
  77         char    ktr_comm[MAXCOMLEN+1];  /* command name */
  78         struct  timeval ktr_time;       /* timestamp */
  79         caddr_t ktr_buf;
  80 };
  81
  82 #define KTRH_THREADED   0x0001          /* multiple threads present */
  83
  84 #define KTRH_CPUID_ENCODE(cpuid)        (((cpuid) & 0xFF) << 8)
  85 #define KTRH_CPUID_DECODE(flags)        (((flags) >> 8) & 0xFF)
  86
  87 /*
  88  * Test for kernel trace point (MP SAFE)
  89  */
  90 #define KTRPOINT(td, type)                                              \
  91                         ((td)->td_proc &&                               \
  92                          ((td)->td_proc->p_traceflag & (1<<(type))) &&  \
  93                         (((td)->td_proc->p_traceflag |                  \
  94                           (td)->td_lwp->lwp_traceflag) &                \
  95                          KTRFAC_ACTIVE) == 0)
  96
  97 #define KTRPOINTP(p, td, type)                                          \
  98         __predict_false((((p)->p_traceflag & (1<<(type))) &&            \
  99                         ((p->p_traceflag |                              \
 100                           (td)->td_lwp->lwp_traceflag) &                \
 101                          KTRFAC_ACTIVE) == 0))
 102
 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 (can be more than 8)
 117          */
 118         register_t      ktr_args[8];
 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 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
 143 #include <sys/_uio.h>           /* enum uio_rw, struct uio */
 144 struct ktr_genio {
 145         int     ktr_fd;
 146         enum    uio_rw ktr_rw;
 147         /*
 148          * followed by data successfully read/written
 149          */
 150 };
 151 #endif
 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  * KTR_SYSCTL - name of a sysctl MIB
 181  */
 182 #define KTR_SYSCTL      9
 183         /* record contains null-terminated MIB name */
 184
 185 /*
 186  * kernel trace points (in p_traceflag)
 187  */
 188 #define KTRFAC_MASK     0x00ffffff
 189 #define KTRFAC_SYSCALL  (1<<KTR_SYSCALL)
 190 #define KTRFAC_SYSRET   (1<<KTR_SYSRET)
 191 #define KTRFAC_NAMEI    (1<<KTR_NAMEI)
 192 #define KTRFAC_GENIO    (1<<KTR_GENIO)
 193 #define KTRFAC_PSIG     (1<<KTR_PSIG)
 194 #define KTRFAC_CSW      (1<<KTR_CSW)
 195 #define KTRFAC_USER     (1<<KTR_USER)
 196 #define KTRFAC_SYSCTL   (1<<KTR_SYSCTL)
 197
 198 /*
 199  * trace flags (also in p_traceflags)
 200  */
 201 #define KTRFAC_ROOT     0x80000000      /* root set this trace */
 202 #define KTRFAC_INHERIT  0x40000000      /* pass trace flags to children */
 203 #define KTRFAC_ACTIVE   0x20000000      /* ktrace logging in progress, ignore */
 204
 205 #ifdef  _KERNEL
 206 void    ktrnamei(struct lwp *, char *);
 207 void    ktrcsw(struct lwp *, int, int);
 208 void    ktrpsig(struct lwp *, int, sig_t, sigset_t *, int);
 209 void    ktrgenio(struct lwp *, int, enum uio_rw, struct uio *, int);
 210 void    ktrsyscall(struct lwp *, int, int, union sysunion *);
 211 void    ktrsysctl(struct lwp *, int *, u_int);
 212 void    ktrsysret(struct lwp *, int, int, register_t);
 213 void    ktrdestroy(struct ktrace_node **);
 214 struct ktrace_node *ktrinherit(struct ktrace_node *);
 215
 216 #else
 217
 218 #include <sys/cdefs.h>
 219
 220 __BEGIN_DECLS
 221 int     ktrace(const char *, int, int, pid_t);
 222 int     utrace(const void *, size_t);
 223 __END_DECLS
 224
 225 #endif
 226
 227 #endif