share/man/man4/filemon.4

   1 .\" Copyright (c) 2012
   2 .\"     David E. O'Brien <obrien@FreeBSD.org>.  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 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgment:
  14 .\"     This product includes software developed by David E. O'Brien and
  15 .\"     contributors.
  16 .\" 4. Neither the name of the author nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANT ABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\" $FreeBSD$
  33 .\"
  34 .Dd June 21, 2016
  35 .Dt FILEMON 4
  36 .Os
  37 .Sh NAME
  38 .Nm filemon
  39 .Nd the filemon device
  40 .Sh SYNOPSIS
  41 .In dev/filemon/filemon.h
  42 .Sh DESCRIPTION
  43 The
  44 .Nm
  45 device allows a process to collect file operations data of its children.
  46 The device
  47 .Pa /dev/filemon
  48 responds to two
  49 .Xr ioctl 2
  50 calls.
  51 .Pp
  52 .Nm
  53 is not intended to be a security auditing tool.
  54 Many system calls are not tracked and binaries of foreign ABI will not be fully
  55 audited.
  56 It is intended for auditing of processes for the purpose of determining its
  57 dependencies in an efficient and easily parsable format.
  58 An example of this is
  59 .Xr make 1
  60 which uses this module with
  61 .Sy .MAKE.MODE=meta
  62 to handle incremental builds more smartly.
  63 .Pp
  64 System calls are denoted using the following single letters:
  65 .Pp
  66 .Bl -tag -width indent -compact
  67 .It Ql A
  68 .Xr openat 2 .
  69 The next log entry may be lacking an absolute path or be inaccurate.
  70 .It Ql C
  71 .Xr chdir 2
  72 .It Ql D
  73 .Xr unlink 2
  74 .It Ql E
  75 .Xr exec 2
  76 .It Ql F
  77 .Xr fork 2 ,
  78 .Xr vfork 2
  79 .It Ql L
  80 .Xr link 2 ,
  81 .Xr linkat 2 ,
  82 .Xr symlink 2 ,
  83 .Xr symlinkat 2
  84 .It Ql M
  85 .Xr rename 2
  86 .It Ql R
  87 .Xr open 2
  88 or
  89 .Xr openat 2
  90 for read
  91 .It Ql W
  92 .Xr open 2
  93 or
  94 .Xr openat 2
  95 for write
  96 .It Ql X
  97 .Xr _exit 2
  98 .El
  99 .Pp
 100 Note that
 101 .Ql R
 102 following
 103 .Ql W
 104 records can represent a single
 105 .Xr open 2
 106 for R/W,
 107 or two separate
 108 .Xr open 2
 109 calls, one for
 110 .Ql R
 111 and one for
 112 .Ql W .
 113 Note that only successful system calls are captured.
 114 .Sh IOCTLS
 115 User mode programs communicate with the
 116 .Nm
 117 driver through a number of ioctls which are described below.
 118 Each takes a single argument.
 119 .Bl -tag -width ".Dv FILEMON_SET_PID"
 120 .It Dv FILEMON_SET_FD
 121 Write the internal tracing buffer to the supplied open file descriptor.
 122 .It Dv FILEMON_SET_PID
 123 Child process ID to trace.
 124 This should normally be done under the control of a parent in the child after
 125 .Xr fork 2
 126 but before anything else.
 127 See the example below.
 128 .El
 129 .Sh RETURN VALUES
 130 .\" .Rv -std ioctl
 131 The
 132 .Fn ioctl
 133 function returns the value 0 if successful;
 134 otherwise the value \-1 is returned and the global variable
 135 .Va errno
 136 is set to indicate the error.
 137 .Sh ERRORS
 138 The
 139 .Fn ioctl
 140 system call
 141 with
 142 .Dv FILEMON_SET_FD
 143 will fail if:
 144 .Bl -tag -width Er
 145 .It Bq Er EEXIST
 146 The
 147 .Nm
 148 handle is already associated with a file descriptor.
 149 .El
 150 .Pp
 151 The
 152 .Fn ioctl
 153 system call
 154 with
 155 .Dv FILEMON_SET_PID
 156 will fail if:
 157 .Bl -tag -width Er
 158 .It Bq Er ESRCH
 159 No process having the specified process ID exists.
 160 .It Bq Er EBUSY
 161 The process ID specified is already being traced and was not the current
 162 process.
 163 .El
 164 .Pp
 165 The
 166 .Fn close
 167 system call on the filemon file descriptor may fail with the errors from
 168 .Xr write 2
 169 if any error is encountered while writing the log.
 170 It may also fail if:
 171 .Bl -tag -width Er
 172 .It Bq Er EFAULT
 173 An invalid address was used for a traced system call argument, resulting in
 174 no log entry for the system call.
 175 .It Bq Er ENAMETOOLONG
 176 An argument for a traced system call was too long, resulting in
 177 no log entry for the system call.
 178 .El
 179 .Sh FILES
 180 .Bl -tag -width ".Pa /dev/filemon"
 181 .It Pa /dev/filemon
 182 .El
 183 .Sh EXAMPLES
 184 .Bd -literal
 185 #include <sys/types.h>
 186 #include <sys/stat.h>
 187 #include <sys/wait.h>
 188 #include <sys/ioctl.h>
 189 #include <dev/filemon/filemon.h>
 190 #include <fcntl.h>
 191 #include <err.h>
 192 #include <unistd.h>
 193
 194 static void
 195 open_filemon(void)
 196 {
 197         pid_t child;
 198         int fm_fd, fm_log;
 199
 200         if ((fm_fd = open("/dev/filemon", O_RDWR | O_CLOEXEC)) == -1)
 201                 err(1, "open(\e"/dev/filemon\e", O_RDWR)");
 202         if ((fm_log = open("filemon.out",
 203             O_CREAT | O_WRONLY | O_TRUNC | O_CLOEXEC, DEFFILEMODE)) == -1)
 204                 err(1, "open(filemon.out)");
 205
 206         if (ioctl(fm_fd, FILEMON_SET_FD, &fm_log) == -1)
 207                 err(1, "Cannot set filemon log file descriptor");
 208
 209         if ((child = fork()) == 0) {
 210                 child = getpid();
 211                 if (ioctl(fm_fd, FILEMON_SET_PID, &child) == -1)
 212                         err(1, "Cannot set filemon PID");
 213                 /* Do something here. */
 214         } else {
 215                 wait(&child);
 216                 close(fm_fd);
 217         }
 218 }
 219 .Ed
 220 .Pp
 221 Creates a file named
 222 .Pa filemon.out
 223 and configures the
 224 .Nm
 225 device to write the
 226 .Nm
 227 buffer contents to it.
 228 .Sh SEE ALSO
 229 .Xr dtrace 1 ,
 230 .Xr ktrace 1 ,
 231 .Xr script 1 ,
 232 .Xr truss 1 ,
 233 .Xr ioctl 2
 234 .Sh HISTORY
 235 A
 236 .Nm
 237 device appeared in
 238 .Fx 9.1 .
 239 .Sh BUGS
 240 Unloading the module may panic the system, thus requires using
 241 .Ic kldunload -f .