The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/sys/ktrace.h

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

    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  * 4. 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: releng/8.1/sys/sys/ktrace.h 199583 2009-11-20 15:27:52Z jhb $
   31  */
   32 
   33 #ifndef _SYS_KTRACE_H_
   34 #define _SYS_KTRACE_H_
   35 
   36 /*
   37  * operations to ktrace system call  (KTROP(op))
   38  */
   39 #define KTROP_SET               0       /* set trace points */
   40 #define KTROP_CLEAR             1       /* clear trace points */
   41 #define KTROP_CLEARFILE         2       /* stop all tracing to file */
   42 #define KTROP(o)                ((o)&3) /* macro to extract operation */
   43 /*
   44  * flags (ORed in with operation)
   45  */
   46 #define KTRFLAG_DESCEND         4       /* perform op on all children too */
   47 
   48 /*
   49  * ktrace record header
   50  */
   51 struct ktr_header {
   52         int     ktr_len;                /* length of buf */
   53         short   ktr_type;               /* trace record type */
   54         pid_t   ktr_pid;                /* process id */
   55         char    ktr_comm[MAXCOMLEN+1];  /* command name */
   56         struct  timeval ktr_time;       /* timestamp */
   57         intptr_t        ktr_tid;        /* was ktr_buffer */
   58 };
   59 
   60 /*
   61  * Test for kernel trace point (MP SAFE).
   62  *
   63  * KTRCHECK() just checks that the type is enabled and is only for
   64  * internal use in the ktrace subsystem.  KTRPOINT() checks against
   65  * ktrace recursion as well as checking that the type is enabled and
   66  * is the public interface.
   67  */
   68 #define KTRCHECK(td, type)      ((td)->td_proc->p_traceflag & (1 << type))
   69 #define KTRPOINT(td, type)                                              \
   70         (KTRCHECK((td), (type)) && !((td)->td_pflags & TDP_INKTRACE))
   71 #define KTRCHECKDRAIN(td)       (!(STAILQ_EMPTY(&(td)->td_proc->p_ktr)))
   72 #define KTRUSERRET(td) do {                                             \
   73         if (KTRCHECKDRAIN(td))                                          \
   74                 ktruserret(td);                                         \
   75 } while (0)
   76 #define KTRPROCEXIT(td) do {                                            \
   77         if (KTRCHECKDRAIN(td))                                          \
   78                 ktrprocexit(td);                                        \
   79 } while (0)
   80 
   81 /*
   82  * ktrace record types
   83  */
   84 
   85 /*
   86  * KTR_SYSCALL - system call record
   87  */
   88 #define KTR_SYSCALL     1
   89 struct ktr_syscall {
   90         short   ktr_code;               /* syscall number */
   91         short   ktr_narg;               /* number of arguments */
   92         /*
   93          * followed by ktr_narg register_t
   94          */
   95         register_t      ktr_args[1];
   96 };
   97 
   98 /*
   99  * KTR_SYSRET - return from system call record
  100  */
  101 #define KTR_SYSRET      2
  102 struct ktr_sysret {
  103         short   ktr_code;
  104         short   ktr_eosys;
  105         int     ktr_error;
  106         register_t      ktr_retval;
  107 };
  108 
  109 /*
  110  * KTR_NAMEI - namei record
  111  */
  112 #define KTR_NAMEI       3
  113         /* record contains pathname */
  114 
  115 /*
  116  * KTR_GENIO - trace generic process i/o
  117  */
  118 #define KTR_GENIO       4
  119 struct ktr_genio {
  120         int     ktr_fd;
  121         enum    uio_rw ktr_rw;
  122         /*
  123          * followed by data successfully read/written
  124          */
  125 };
  126 
  127 /*
  128  * KTR_PSIG - trace processed signal
  129  */
  130 #define KTR_PSIG        5
  131 struct ktr_psig {
  132         int     signo;
  133         sig_t   action;
  134         int     code;
  135         sigset_t mask;
  136 };
  137 
  138 /*
  139  * KTR_CSW - trace context switches
  140  */
  141 #define KTR_CSW         6
  142 struct ktr_csw {
  143         int     out;    /* 1 if switch out, 0 if switch in */
  144         int     user;   /* 1 if usermode (ivcsw), 0 if kernel (vcsw) */
  145 };
  146 
  147 /*
  148  * KTR_USER - data coming from userland
  149  */
  150 #define KTR_USER_MAXLEN 2048    /* maximum length of passed data */
  151 #define KTR_USER        7
  152 
  153 /*
  154  * KTR_STRUCT - misc. structs
  155  */
  156 #define KTR_STRUCT      8
  157 struct sockaddr;
  158 struct stat;
  159 
  160 /*
  161  * KTR_SYSCTL - name of a sysctl MIB
  162  */
  163 #define KTR_SYSCTL      9
  164         /* record contains null-terminated MIB name */
  165 
  166 /*
  167  * KTR_DROP - If this bit is set in ktr_type, then at least one event
  168  * between the previous record and this record was dropped.
  169  */
  170 #define KTR_DROP        0x8000
  171 
  172 /*
  173  * kernel trace points (in p_traceflag)
  174  */
  175 #define KTRFAC_MASK     0x00ffffff
  176 #define KTRFAC_SYSCALL  (1<<KTR_SYSCALL)
  177 #define KTRFAC_SYSRET   (1<<KTR_SYSRET)
  178 #define KTRFAC_NAMEI    (1<<KTR_NAMEI)
  179 #define KTRFAC_GENIO    (1<<KTR_GENIO)
  180 #define KTRFAC_PSIG     (1<<KTR_PSIG)
  181 #define KTRFAC_CSW      (1<<KTR_CSW)
  182 #define KTRFAC_USER     (1<<KTR_USER)
  183 #define KTRFAC_STRUCT   (1<<KTR_STRUCT)
  184 #define KTRFAC_SYSCTL   (1<<KTR_SYSCTL)
  185 
  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_DROP     0x20000000      /* last event was dropped */
  192 
  193 #ifdef  _KERNEL
  194 extern struct mtx ktrace_mtx;
  195 
  196 void    ktrnamei(char *);
  197 void    ktrcsw(int, int);
  198 void    ktrpsig(int, sig_t, sigset_t *, int);
  199 void    ktrgenio(int, enum uio_rw, struct uio *, int);
  200 void    ktrsyscall(int, int narg, register_t args[]);
  201 void    ktrsysctl(int *name, u_int namelen);
  202 void    ktrsysret(int, int, register_t);
  203 void    ktrprocexit(struct thread *);
  204 void    ktruserret(struct thread *);
  205 void    ktrstruct(const char *, size_t, void *, size_t);
  206 #define ktrsockaddr(s) \
  207         ktrstruct("sockaddr", 8, (s), ((struct sockaddr *)(s))->sa_len)
  208 #define ktrstat(s) \
  209         ktrstruct("stat", 4, (s), sizeof(struct stat))
  210 
  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
  221 
  222 #endif

Cache object: 02646628f48cc22041fdee837b3a7247


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.