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$
  35  */
  36
  37 #ifndef _SYS_KTRACE_H_
  38 #define _SYS_KTRACE_H_
  39
  40 /*
  41  * operations to ktrace system call  (KTROP(op))
  42  */
  43 #define KTROP_SET               0       /* set trace points */
  44 #define KTROP_CLEAR             1       /* clear trace points */
  45 #define KTROP_CLEARFILE         2       /* stop all tracing to file */
  46 #define KTROP(o)                ((o)&3) /* macro to extract operation */
  47 /*
  48  * flags (ORed in with operation)
  49  */
  50 #define KTRFLAG_DESCEND         4       /* perform op on all children too */
  51
  52 /*
  53  * ktrace record header
  54  */
  55 struct ktr_header {
  56         int     ktr_len;                /* length of buf */
  57         short   ktr_type;               /* trace record type */
  58         pid_t   ktr_pid;                /* process id */
  59         char    ktr_comm[MAXCOMLEN+1];  /* command name */
  60         struct  timeval ktr_time;       /* timestamp */
  61         void    *ktr_buffer;
  62 };
  63
  64 /*
  65  * Test for kernel trace point (MP SAFE).
  66  *
  67  * KTRCHECK() just checks that the type is enabled and is only for
  68  * internal use in the ktrace subsystem.  KTRPOINT() checks against
  69  * ktrace recursion as well as checking that the type is enabled and
  70  * is the public interface.
  71  */
  72 #define KTRCHECK(td, type)      ((td)->td_proc->p_traceflag & (1 << type))
  73 #define KTRPOINT(td, type)      (KTRCHECK((td), (type)) && !(td)->td_inktrace)
  74
  75 /*
  76  * ktrace record types
  77  */
  78
  79 /*
  80  * KTR_SYSCALL - system call record
  81  */
  82 #define KTR_SYSCALL     1
  83 struct ktr_syscall {
  84         short   ktr_code;               /* syscall number */
  85         short   ktr_narg;               /* number of arguments */
  86         /*
  87          * followed by ktr_narg register_t
  88          */
  89         register_t      ktr_args[1];
  90 };
  91
  92 /*
  93  * KTR_SYSRET - return from system call record
  94  */
  95 #define KTR_SYSRET      2
  96 struct ktr_sysret {
  97         short   ktr_code;
  98         short   ktr_eosys;
  99         int     ktr_error;
 100         register_t      ktr_retval;
 101 };
 102
 103 /*
 104  * KTR_NAMEI - namei record
 105  */
 106 #define KTR_NAMEI       3
 107         /* record contains pathname */
 108
 109 /*
 110  * KTR_GENIO - trace generic process i/o
 111  */
 112 #define KTR_GENIO       4
 113 struct ktr_genio {
 114         int     ktr_fd;
 115         enum    uio_rw ktr_rw;
 116         /*
 117          * followed by data successfully read/written
 118          */
 119 };
 120
 121 /*
 122  * KTR_PSIG - trace processed signal
 123  */
 124 #define KTR_PSIG        5
 125 struct ktr_psig {
 126         int     signo;
 127         sig_t   action;
 128         int     code;
 129         sigset_t mask;
 130 };
 131
 132 /*
 133  * KTR_CSW - trace context switches
 134  */
 135 #define KTR_CSW         6
 136 struct ktr_csw {
 137         int     out;    /* 1 if switch out, 0 if switch in */
 138         int     user;   /* 1 if usermode (ivcsw), 0 if kernel (vcsw) */
 139 };
 140
 141 /*
 142  * KTR_USER - data comming from userland
 143  */
 144 #define KTR_USER_MAXLEN 2048    /* maximum length of passed data */
 145 #define KTR_USER        7
 146
 147 /*
 148  * kernel trace points (in p_traceflag)
 149  */
 150 #define KTRFAC_MASK     0x00ffffff
 151 #define KTRFAC_SYSCALL  (1<<KTR_SYSCALL)
 152 #define KTRFAC_SYSRET   (1<<KTR_SYSRET)
 153 #define KTRFAC_NAMEI    (1<<KTR_NAMEI)
 154 #define KTRFAC_GENIO    (1<<KTR_GENIO)
 155 #define KTRFAC_PSIG     (1<<KTR_PSIG)
 156 #define KTRFAC_CSW      (1<<KTR_CSW)
 157 #define KTRFAC_USER     (1<<KTR_USER)
 158 /*
 159  * trace flags (also in p_traceflags)
 160  */
 161 #define KTRFAC_ROOT     0x80000000      /* root set this trace */
 162 #define KTRFAC_INHERIT  0x40000000      /* pass trace flags to children */
 163
 164 #ifdef  _KERNEL
 165 extern struct mtx ktrace_mtx;
 166
 167 void    ktrnamei(char *);
 168 void    ktrcsw(int, int);
 169 void    ktrpsig(int, sig_t, sigset_t *, int);
 170 void    ktrgenio(int, enum uio_rw, struct uio *, int);
 171 void    ktrsyscall(int, int narg, register_t args[]);
 172 void    ktrsysret(int, int, register_t);
 173
 174 #else
 175
 176 #include <sys/cdefs.h>
 177
 178 __BEGIN_DECLS
 179 int     ktrace(const char *, int, int, pid_t);
 180 int     utrace(const void *, size_t);
 181 __END_DECLS
 182
 183 #endif
 184
 185 #endif