lib/libc/sys/ktrace.2

   1 .\" Copyright (c) 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 4. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)ktrace.2    8.1 (Berkeley) 6/4/93
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd October 9, 2011
  32 .Dt KTRACE 2
  33 .Os
  34 .Sh NAME
  35 .Nm ktrace
  36 .Nd process tracing
  37 .Sh LIBRARY
  38 .Lb libc
  39 .Sh SYNOPSIS
  40 .In sys/param.h
  41 .In sys/time.h
  42 .In sys/uio.h
  43 .In sys/ktrace.h
  44 .Ft int
  45 .Fn ktrace "const char *tracefile" "int ops" "int trpoints" "int pid"
  46 .Sh DESCRIPTION
  47 The
  48 .Fn ktrace
  49 system call enables or disables tracing of one or more processes.
  50 Users may only trace their own processes.
  51 Only the super-user can trace setuid or setgid programs.
  52 .Pp
  53 The
  54 .Fa tracefile
  55 argument
  56 gives the pathname of the file to be used for tracing.
  57 The file must exist and be a regular file writable by the calling process.
  58 All trace records are always appended to the file,
  59 so the file must be truncated to zero length to discard
  60 previous trace data.
  61 If tracing points are being disabled (see KTROP_CLEAR below),
  62 .Fa tracefile
  63 may be NULL.
  64 .Pp
  65 The
  66 .Fa ops
  67 argument specifies the requested ktrace operation.
  68 The defined operations are:
  69 .Bl -column KTRFLAG_DESCENDXXX -offset indent
  70 .It "KTROP_SET  Enable trace points specified in"
  71 .Fa trpoints .
  72 .It "KTROP_CLEAR        Disable trace points specified in
  73 .Fa trpoints .
  74 .It "KTROP_CLEARFILE    Stop all tracing."
  75 .It "KTRFLAG_DESCEND    The tracing change should apply to the"
  76 specified process and all its current children.
  77 .El
  78 .Pp
  79 The
  80 .Fa trpoints
  81 argument specifies the trace points of interest.
  82 The defined trace points are:
  83 .Bl -column KTRFAC_PROCCTORXXX -offset indent
  84 .It "KTRFAC_SYSCALL     Trace system calls."
  85 .It "KTRFAC_SYSRET      Trace return values from system calls."
  86 .It "KTRFAC_NAMEI       Trace name lookup operations."
  87 .It "KTRFAC_GENIO       Trace all I/O (note that this option can"
  88 generate much output).
  89 .It "KTRFAC_PSIG        Trace posted signals."
  90 .It "KTRFAC_CSW Trace context switch points."
  91 .It "KTRFAC_USER        Trace application-specific events."
  92 .It "KTRFAC_STRUCT      Trace certain data structures."
  93 .It "KTRFAC_SYSCTL      Trace sysctls."
  94 .It "KTRFAC_PROCCTOR    Trace process construction."
  95 .It "KTRFAC_PROCDTOR    Trace process destruction."
  96 .It "KTRFAC_INHERIT     Inherit tracing to future children."
  97 .El
  98 .Pp
  99 Each tracing event outputs a record composed of a generic header
 100 followed by a trace point specific structure.
 101 The generic header is:
 102 .Bd -literal
 103 struct ktr_header {
 104         int     ktr_len;                /* length of buf */
 105         short   ktr_type;               /* trace record type */
 106         pid_t   ktr_pid;                /* process id */
 107         char    ktr_comm[MAXCOMLEN+1];  /* command name */
 108         struct  timeval ktr_time;       /* timestamp */
 109         intptr_t        ktr_tid;        /* was ktr_buffer */
 110 };
 111 .Ed
 112 .Pp
 113 The
 114 .Va ktr_len
 115 field specifies the length of the
 116 .Va ktr_type
 117 data that follows this header.
 118 The
 119 .Va ktr_pid
 120 and
 121 .Va ktr_comm
 122 fields specify the process and command generating the record.
 123 The
 124 .Va ktr_time
 125 field gives the time (with microsecond resolution)
 126 that the record was generated.
 127 The
 128 .Va ktr_tid
 129 field holds a thread id.
 130 .Pp
 131 The generic header is followed by
 132 .Va ktr_len
 133 bytes of a
 134 .Va ktr_type
 135 record.
 136 The type specific records are defined in the
 137 .In sys/ktrace.h
 138 include file.
 139 .Sh SYSCTL TUNABLES
 140 The following
 141 .Xr sysctl 8
 142 tunables influence the behaviour of
 143 .Fn ktrace :
 144 .Bl -tag -width indent
 145 .It Va kern.ktrace.geniosize
 146 bounds the amount of data a traced I/O request will log
 147 to the trace file.
 148 .It Va kern.ktrace.request_pool
 149 bounds the number of trace events being logged at a time.
 150 .El
 151 .Pp
 152 Sysctl tunables that control process debuggability (as determined by
 153 .Xr p_candebug 9 )
 154 also affect the operation of
 155 .Fn ktrace .
 156 .Sh RETURN VALUES
 157 .Rv -std ktrace
 158 .Sh ERRORS
 159 The
 160 .Fn ktrace
 161 system call
 162 will fail if:
 163 .Bl -tag -width Er
 164 .It Bq Er ENOTDIR
 165 A component of the path prefix is not a directory.
 166 .It Bq Er ENAMETOOLONG
 167 A component of a pathname exceeded 255 characters,
 168 or an entire path name exceeded 1023 characters.
 169 .It Bq Er ENOENT
 170 The named tracefile does not exist.
 171 .It Bq Er EACCES
 172 Search permission is denied for a component of the path prefix.
 173 .It Bq Er ELOOP
 174 Too many symbolic links were encountered in translating the pathname.
 175 .It Bq Er EIO
 176 An I/O error occurred while reading from or writing to the file system.
 177 .It Bq Er ENOSYS
 178 The kernel was not compiled with
 179 .Nm
 180 support.
 181 .El
 182 .Pp
 183 A thread may be unable to log one or more tracing events due to a
 184 temporary shortage of resources.
 185 This condition is remembered by the kernel, and the next tracing request
 186 that succeeds will have the flag
 187 .Li KTR_DROP
 188 set in its
 189 .Va ktr_type
 190 field.
 191 .Sh SEE ALSO
 192 .Xr kdump 1 ,
 193 .Xr ktrace 1 ,
 194 .Xr utrace 2 ,
 195 .Xr sysctl 8 ,
 196 .Xr p_candebug 9
 197 .Sh HISTORY
 198 The
 199 .Fn ktrace
 200 system call first appeared in
 201 .Bx 4.4 .