sys/sys/ktrace.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1988, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. Neither the name of the University nor the names of its contributors
  16  *    may be used to endorse or promote products derived from this software
  17  *    without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  *
  31  *      @(#)ktrace.h    8.1 (Berkeley) 6/2/93
  32  */
  33
  34 #ifndef _SYS_KTRACE_H_
  35 #define _SYS_KTRACE_H_
  36
  37 #include <sys/caprights.h>
  38 #include <sys/signal.h>
  39 #include <sys/_uio.h>
  40
  41 /*
  42  * operations to ktrace system call  (KTROP(op))
  43  */
  44 #define KTROP_SET               0       /* set trace points */
  45 #define KTROP_CLEAR             1       /* clear trace points */
  46 #define KTROP_CLEARFILE         2       /* stop all tracing to file */
  47 #define KTROP(o)                ((o)&3) /* macro to extract operation */
  48 /*
  49  * flags (ORed in with operation)
  50  */
  51 #define KTRFLAG_DESCEND         4       /* perform op on all children too */
  52
  53 /*
  54  * ktrace record header
  55  */
  56 struct ktr_header_v0 {
  57         int     ktr_len;                /* length of buf */
  58         short   ktr_type;               /* trace record type */
  59         pid_t   ktr_pid;                /* process id */
  60         char    ktr_comm[MAXCOMLEN + 1];/* command name */
  61         struct  timeval ktr_time;       /* timestamp */
  62         long    ktr_tid;                /* thread id */
  63 };
  64
  65 struct ktr_header {
  66         int     ktr_len;                /* length of buf */
  67         short   ktr_type;               /* trace record type */
  68         short   ktr_version;            /* ktr_header version */
  69         pid_t   ktr_pid;                /* process id */
  70         char    ktr_comm[MAXCOMLEN + 1];/* command name */
  71         struct  timespec ktr_time;      /* timestamp */
  72         /* XXX: make ktr_tid an lwpid_t on next ABI break */
  73         long    ktr_tid;                /* thread id */
  74         int     ktr_cpu;                /* cpu id */
  75 };
  76
  77 #define KTR_VERSION0    0
  78 #define KTR_VERSION1    1
  79 #define KTR_OFFSET_V0   sizeof(struct ktr_header_v0) - \
  80                             sizeof(struct ktr_header)
  81 /*
  82  * Test for kernel trace point (MP SAFE).
  83  *
  84  * KTRCHECK() just checks that the type is enabled and is only for
  85  * internal use in the ktrace subsystem.  KTRPOINT() checks against
  86  * ktrace recursion as well as checking that the type is enabled and
  87  * is the public interface.
  88  */
  89 #define KTRCHECK(td, type)      ((td)->td_proc->p_traceflag & (1 << type))
  90 #define KTRPOINT(td, type)  (__predict_false(KTRCHECK((td), (type))))
  91 #define KTRCHECKDRAIN(td)       (!(STAILQ_EMPTY(&(td)->td_proc->p_ktr)))
  92 #define KTRUSERRET(td) do {                                             \
  93         if (__predict_false(KTRCHECKDRAIN(td)))                         \
  94                 ktruserret(td);                                         \
  95 } while (0)
  96
  97 /*
  98  * ktrace record types
  99  */
 100
 101 /*
 102  * KTR_SYSCALL - system call record
 103  */
 104 #define KTR_SYSCALL     1
 105 struct ktr_syscall {
 106         short   ktr_code;               /* syscall number */
 107         short   ktr_narg;               /* number of arguments */
 108         /*
 109          * followed by ktr_narg register_t
 110          */
 111         register_t      ktr_args[1];
 112 };
 113
 114 /*
 115  * KTR_SYSRET - return from system call record
 116  */
 117 #define KTR_SYSRET      2
 118 struct ktr_sysret {
 119         short   ktr_code;
 120         short   ktr_eosys;
 121         int     ktr_error;
 122         register_t      ktr_retval;
 123 };
 124
 125 /*
 126  * KTR_NAMEI - namei record
 127  */
 128 #define KTR_NAMEI       3
 129         /* record contains pathname */
 130
 131 /*
 132  * KTR_GENIO - trace generic process i/o
 133  */
 134 #define KTR_GENIO       4
 135 struct ktr_genio {
 136         int     ktr_fd;
 137         enum    uio_rw ktr_rw;
 138         /*
 139          * followed by data successfully read/written
 140          */
 141 };
 142
 143 /*
 144  * KTR_PSIG - trace processed signal
 145  */
 146 #define KTR_PSIG        5
 147 struct ktr_psig {
 148         int     signo;
 149         sig_t   action;
 150         int     code;
 151         sigset_t mask;
 152 };
 153
 154 /*
 155  * KTR_CSW - trace context switches
 156  */
 157 #define KTR_CSW         6
 158 struct ktr_csw_old {
 159         int     out;    /* 1 if switch out, 0 if switch in */
 160         int     user;   /* 1 if usermode (ivcsw), 0 if kernel (vcsw) */
 161 };
 162
 163 struct ktr_csw {
 164         int     out;    /* 1 if switch out, 0 if switch in */
 165         int     user;   /* 1 if usermode (ivcsw), 0 if kernel (vcsw) */
 166         char    wmesg[8];
 167 };
 168
 169 /*
 170  * KTR_USER - data coming from userland
 171  */
 172 #define KTR_USER_MAXLEN 2048    /* maximum length of passed data */
 173 #define KTR_USER        7
 174
 175 /*
 176  * KTR_STRUCT - misc. structs
 177  */
 178 #define KTR_STRUCT      8
 179         /*
 180          * record contains null-terminated struct name followed by
 181          * struct contents
 182          */
 183 struct sockaddr;
 184 struct stat;
 185 struct sysentvec;
 186
 187 /*
 188  * KTR_SYSCTL - name of a sysctl MIB
 189  */
 190 #define KTR_SYSCTL      9
 191         /* record contains null-terminated MIB name */
 192
 193 /*
 194  * KTR_PROCCTOR - trace process creation (multiple ABI support)
 195  */
 196 #define KTR_PROCCTOR    10
 197 struct ktr_proc_ctor {
 198         u_int   sv_flags;       /* struct sysentvec sv_flags copy */
 199 };
 200
 201 /*
 202  * KTR_PROCDTOR - trace process destruction (multiple ABI support)
 203  */
 204 #define KTR_PROCDTOR    11
 205
 206 /*
 207  * KTR_CAPFAIL - trace capability check failures
 208  */
 209 #define KTR_CAPFAIL     12
 210 enum ktr_cap_fail_type {
 211         CAPFAIL_NOTCAPABLE,     /* insufficient capabilities in cap_check() */
 212         CAPFAIL_INCREASE,       /* attempt to increase capabilities */
 213         CAPFAIL_SYSCALL,        /* disallowed system call */
 214         CAPFAIL_LOOKUP,         /* disallowed VFS lookup */
 215 };
 216 struct ktr_cap_fail {
 217         enum ktr_cap_fail_type cap_type;
 218         cap_rights_t    cap_needed;
 219         cap_rights_t    cap_held;
 220 };
 221
 222 /*
 223  * KTR_FAULT - page fault record
 224  */
 225 #define KTR_FAULT       13
 226 struct ktr_fault {
 227         vm_offset_t vaddr;
 228         int type;
 229 };
 230
 231 /*
 232  * KTR_FAULTEND - end of page fault record
 233  */
 234 #define KTR_FAULTEND    14
 235 struct ktr_faultend {
 236         int result;
 237 };
 238
 239 /*
 240  * KTR_STRUCT_ARRAY - array of misc. structs
 241  */
 242 #define KTR_STRUCT_ARRAY 15
 243 struct ktr_struct_array {
 244         size_t struct_size;
 245         /*
 246          * Followed by null-terminated structure name and then payload
 247          * contents.
 248          */
 249 };
 250
 251 /*
 252  * KTR_DROP - If this bit is set in ktr_type, then at least one event
 253  * between the previous record and this record was dropped.
 254  */
 255 #define KTR_DROP        0x8000
 256 /*
 257  * KTR_VERSIONED - If this bit is set in ktr_type, then the kernel
 258  * exposes the new struct ktr_header (versioned), otherwise the old
 259  * struct ktr_header_v0 is exposed.
 260  */
 261 #define KTR_VERSIONED   0x4000
 262 #define KTR_TYPE        (KTR_DROP | KTR_VERSIONED)
 263
 264 /*
 265  * kernel trace points (in p_traceflag)
 266  */
 267 #define KTRFAC_MASK     0x00ffffff
 268 #define KTRFAC_SYSCALL  (1<<KTR_SYSCALL)
 269 #define KTRFAC_SYSRET   (1<<KTR_SYSRET)
 270 #define KTRFAC_NAMEI    (1<<KTR_NAMEI)
 271 #define KTRFAC_GENIO    (1<<KTR_GENIO)
 272 #define KTRFAC_PSIG     (1<<KTR_PSIG)
 273 #define KTRFAC_CSW      (1<<KTR_CSW)
 274 #define KTRFAC_USER     (1<<KTR_USER)
 275 #define KTRFAC_STRUCT   (1<<KTR_STRUCT)
 276 #define KTRFAC_SYSCTL   (1<<KTR_SYSCTL)
 277 #define KTRFAC_PROCCTOR (1<<KTR_PROCCTOR)
 278 #define KTRFAC_PROCDTOR (1<<KTR_PROCDTOR)
 279 #define KTRFAC_CAPFAIL  (1<<KTR_CAPFAIL)
 280 #define KTRFAC_FAULT    (1<<KTR_FAULT)
 281 #define KTRFAC_FAULTEND (1<<KTR_FAULTEND)
 282 #define KTRFAC_STRUCT_ARRAY (1<<KTR_STRUCT_ARRAY)
 283
 284 /*
 285  * trace flags (also in p_traceflags)
 286  */
 287 #define KTRFAC_ROOT     0x80000000      /* root set this trace */
 288 #define KTRFAC_INHERIT  0x40000000      /* pass trace flags to children */
 289 #define KTRFAC_DROP     0x20000000      /* last event was dropped */
 290
 291 #ifdef  _KERNEL
 292 struct ktr_io_params;
 293
 294 #ifdef  KTRACE
 295 struct vnode *ktr_get_tracevp(struct proc *, bool);
 296 #else
 297 static inline struct vnode *
 298 ktr_get_tracevp(struct proc *p, bool ref)
 299 {
 300
 301         return (NULL);
 302 }
 303 #endif
 304 void    ktr_io_params_free(struct ktr_io_params *);
 305 void    ktrnamei(const char *);
 306 void    ktrcsw(int, int, const char *);
 307 void    ktrpsig(int, sig_t, sigset_t *, int);
 308 void    ktrfault(vm_offset_t, int);
 309 void    ktrfaultend(int);
 310 void    ktrgenio(int, enum uio_rw, struct uio *, int);
 311 void    ktrsyscall(int, int narg, syscallarg_t args[]);
 312 void    ktrsysctl(int *name, u_int namelen);
 313 void    ktrsysret(int, int, register_t);
 314 void    ktrprocctor(struct proc *);
 315 struct ktr_io_params *ktrprocexec(struct proc *);
 316 void    ktrprocexit(struct thread *);
 317 void    ktrprocfork(struct proc *, struct proc *);
 318 void    ktruserret(struct thread *);
 319 void    ktrstruct(const char *, const void *, size_t);
 320 void    ktrstruct_error(const char *, const void *, size_t, int);
 321 void    ktrstructarray(const char *, enum uio_seg, const void *, int, size_t);
 322 void    ktrcapfail(enum ktr_cap_fail_type, const cap_rights_t *,
 323             const cap_rights_t *);
 324 #define ktrcaprights(s) \
 325         ktrstruct("caprights", (s), sizeof(cap_rights_t))
 326 #define ktritimerval(s) \
 327         ktrstruct("itimerval", (s), sizeof(struct itimerval))
 328 #define ktrsockaddr(s) \
 329         ktrstruct("sockaddr", (s), ((struct sockaddr *)(s))->sa_len)
 330 #define ktrstat(s) \
 331         ktrstruct("stat", (s), sizeof(struct stat))
 332 #define ktrstat_error(s, error) \
 333         ktrstruct_error("stat", (s), sizeof(struct stat), error)
 334 #define ktrcpuset(s, l) \
 335         ktrstruct("cpuset_t", (s), l)
 336 extern u_int ktr_geniosize;
 337 #ifdef  KTRACE
 338 extern int ktr_filesize_limit_signal;
 339 #else
 340 #define ktr_filesize_limit_signal 0
 341 #endif
 342 #else
 343
 344 #include <sys/cdefs.h>
 345
 346 __BEGIN_DECLS
 347 int     ktrace(const char *, int, int, pid_t);
 348 int     utrace(const void *, size_t);
 349 __END_DECLS
 350
 351 #endif
 352
 353 #endif