Skip site navigation (1)Skip section navigation (2)
Date:      Wed, 19 Sep 2012 20:11:48 +0000 (UTC)
From:      "David E. O'Brien" <obrien@FreeBSD.org>
To:        src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-stable@freebsd.org, svn-src-stable-8@freebsd.org
Subject:   svn commit: r240707 - in stable/8: share/man/man4 sys/dev/filemon sys/modules sys/modules/filemon tools/regression/filemon
Message-ID:  <201209192011.q8JKBmt7061527@svn.freebsd.org>

next in thread | raw e-mail | index | archive | help
Author: obrien
Date: Wed Sep 19 20:11:47 2012
New Revision: 240707
URL: http://svn.freebsd.org/changeset/base/240707

Log:
  MF9: r237795
       MFC: r236592 r236593 r236594 r236620 r236621 r236622 r236637 r237794:
            filemon(4)

Added:
  stable/8/share/man/man4/filemon.4
     - copied unchanged from r237795, stable/9/share/man/man4/filemon.4
  stable/8/sys/dev/filemon/
     - copied from r237795, stable/9/sys/dev/filemon/
  stable/8/sys/modules/filemon/
     - copied from r237795, stable/9/sys/modules/filemon/
  stable/8/tools/regression/filemon/
     - copied from r237795, stable/9/tools/regression/filemon/
Modified:
  stable/8/share/man/man4/Makefile
  stable/8/sys/modules/Makefile
Directory Properties:
  stable/8/   (props changed)
  stable/8/share/   (props changed)
  stable/8/share/man/   (props changed)
  stable/8/share/man/man4/   (props changed)
  stable/8/sys/   (props changed)
  stable/8/sys/dev/   (props changed)
  stable/8/sys/modules/   (props changed)
  stable/8/tools/   (props changed)

Modified: stable/8/share/man/man4/Makefile
==============================================================================
--- stable/8/share/man/man4/Makefile	Wed Sep 19 19:59:15 2012	(r240706)
+++ stable/8/share/man/man4/Makefile	Wed Sep 19 20:11:47 2012	(r240707)
@@ -118,6 +118,7 @@ MAN=	aac.4 \
 	fatm.4 \
 	fd.4 \
 	fdc.4 \
+	filemon.4 \
 	firewire.4 \
 	fpa.4 \
 	fwe.4 \

Copied: stable/8/share/man/man4/filemon.4 (from r237795, stable/9/share/man/man4/filemon.4)
==============================================================================
--- /dev/null	00:00:00 1970	(empty, because file is newly added)
+++ stable/8/share/man/man4/filemon.4	Wed Sep 19 20:11:47 2012	(r240707, copy of r237795, stable/9/share/man/man4/filemon.4)
@@ -0,0 +1,176 @@
+.\" Copyright (c) 2012
+.\"	David E. O'Brien <obrien@FreeBSD.org>.  All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"	This product includes software developed by David E. O'Brien and
+.\"	contributors.
+.\" 4. Neither the name of the author nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" $FreeBSD$
+.\"
+.Dd May 30, 2012
+.Dt FILEMON 4
+.Os
+.Sh NAME
+.Nm filemon
+.Nd the filemon device
+.Sh SYNOPSIS
+.In dev/filemon/filemon.h
+.Sh DESCRIPTION
+The
+.Nm
+device allows a process to collect file operations data of its children.
+The device
+.Pa /dev/filemon
+responds to two
+.Xr ioctl 2
+calls.
+.Pp
+System calls are denoted using the following single letters:
+.Pp
+.Bl -tag -width indent -compact
+.It Ql C
+.Xr chdir 2
+.It Ql D
+.Xr unlink 2
+.It Ql E
+.Xr exec 2
+.It Ql F
+.Xr fork 2 ,
+.Xr vfork 2
+.It Ql L
+.Xr link 2 ,
+.Xr linkat 2 ,
+.Xr symlink 2 ,
+.Xr symlinkat 2
+.It Ql M
+.Xr rename 2
+.It Ql R
+.Xr open 2
+for read
+.It Ql S
+.Xr stat 2
+.It Ql W
+.Xr open 2
+for write
+.It Ql X
+.Xr _exit 2
+.El
+.Pp
+Note that
+.Ql R
+following
+.Ql W
+records can represent a single
+.Xr open 2
+for R/W,
+or two seperate
+.Xr open 2
+calls, one for
+.Ql R
+and one for
+.Ql W .
+.Sh IOCTLS
+User mode programs communicate with the
+.Nm
+driver through a number of ioctls which are described below.
+Each takes a single argument.
+.Bl -tag -width ".Dv FILEMON_SET_PID"
+.It Dv FILEMON_SET_FD
+Write the internal tracing buffer to the supplied open file descriptor.
+.It Dv FILEMON_SET_PID
+Child process ID to trace.
+.El
+.Sh RETURN VALUES
+.\" .Rv -std ioctl
+The
+.Fn ioctl
+function returns the value 0 if successful;
+otherwise the value \-1 is returned and the global variable
+.Va errno
+is set to indicate the error.
+.Sh FILES
+.Bl -tag -width ".Pa /dev/filemon"
+.It Pa /dev/filemon
+.El
+.Sh EXAMPLES
+.Bd -literal
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <sys/wait.h>
+#include <sys/ioctl.h>
+#include <dev/filemon/filemon.h>
+#include <fcntl.h>
+#include <err.h>
+
+static void
+open_filemon(void)
+{
+	pid_t child;
+	int fm_fd, fm_log;
+
+	if ((fm_fd = open("/dev/filemon", O_RDWR)) == -1)
+		err(1, "open(\e"/dev/filemon\e", O_RDWR)");
+	if ((fm_log = open("filemon.out",
+	    O_CREAT | O_WRONLY | O_TRUNC, DEFFILEMODE)) == -1)
+		err(1, "open(filemon.out)");
+
+	if (ioctl(fm_fd, FILEMON_SET_FD, &fm_log) == -1)
+		err(1, "Cannot set filemon log file descriptor");
+	/* Set up these two fd's to close on exec. */
+	(void)fcntl(fm_fd, F_SETFD, FD_CLOEXEC);
+	(void)fcntl(fm_log, F_SETFD, FD_CLOEXEC);
+
+	if ((child = fork()) == 0) {
+		child = getpid();
+		if (ioctl(fm_fd, FILEMON_SET_PID, &child) == -1)
+			err(1, "Cannot set filemon PID");
+		/* Do something here. */
+		return 0;
+	} else {
+		wait(&child);
+		close(fm_fd);
+	}
+	return 0;
+}
+.Ed
+.Pp
+Creates a file named
+.Pa filemon.out
+and configures the
+.Nm
+device to write the
+.Nm
+buffer contents to it.
+.Sh SEE ALSO
+.Xr dtrace 1 ,
+.Xr ktrace 1 ,
+.Xr truss 1
+.Sh HISTORY
+A
+.Nm
+device appeared in
+.Fx 9.1 .

Modified: stable/8/sys/modules/Makefile
==============================================================================
--- stable/8/sys/modules/Makefile	Wed Sep 19 19:59:15 2012	(r240706)
+++ stable/8/sys/modules/Makefile	Wed Sep 19 20:11:47 2012	(r240707)
@@ -2,7 +2,8 @@
 
 .include <bsd.own.mk>
 
-SUBDIR=	${_3dfx} \
+SUBDIR=	\
+	${_3dfx} \
 	${_3dfx_linux} \
 	${_aac} \
 	accf_data \
@@ -96,6 +97,7 @@ SUBDIR=	${_3dfx} \
 	fdc \
 	fdescfs \
 	${_fe} \
+	${_filemon} \
 	firewire \
 	firmware \
 	fxp \
@@ -336,6 +338,10 @@ SUBDIR=	${_3dfx} \
 	${_zfs} \
 	zlib \
 
+.if ${MACHINE_ARCH} == "i386" || ${MACHINE_ARCH} == "amd64"
+_filemon=	filemon
+.endif
+
 .if ${MACHINE_ARCH} != "powerpc" && ${MACHINE_ARCH} != "arm" && \
 	${MACHINE_ARCH} != "mips"
 _syscons=	syscons



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201209192011.q8JKBmt7061527>