sys/dev/filemon/filemon.c

   1 /*-
   2  * Copyright (c) 2011, David E. O'Brien.
   3  * Copyright (c) 2009-2011, Juniper Networks, Inc.
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY JUNIPER NETWORKS AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED. IN NO EVENT SHALL JUNIPER NETWORKS OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  */
  27
  28 #include <sys/cdefs.h>
  29 __FBSDID("$FreeBSD$");
  30
  31 #include "opt_compat.h"
  32
  33 #include <sys/param.h>
  34 #include <sys/file.h>
  35 #include <sys/systm.h>
  36 #include <sys/buf.h>
  37 #include <sys/condvar.h>
  38 #include <sys/conf.h>
  39 #include <sys/fcntl.h>
  40 #include <sys/ioccom.h>
  41 #include <sys/kernel.h>
  42 #include <sys/malloc.h>
  43 #include <sys/module.h>
  44 #include <sys/mutex.h>
  45 #include <sys/poll.h>
  46 #include <sys/proc.h>
  47 #include <sys/queue.h>
  48 #include <sys/syscall.h>
  49 #include <sys/sysent.h>
  50 #include <sys/sysproto.h>
  51 #include <sys/uio.h>
  52
  53 #if __FreeBSD_version >= 900041
  54 #include <sys/capability.h>
  55 #endif
  56
  57 #include "filemon.h"
  58
  59 #if defined(COMPAT_IA32) || defined(COMPAT_FREEBSD32) || defined(COMPAT_ARCH32)
  60 #include <compat/freebsd32/freebsd32_syscall.h>
  61 #include <compat/freebsd32/freebsd32_proto.h>
  62
  63 extern struct sysentvec ia32_freebsd_sysvec;
  64 #endif
  65
  66 extern struct sysentvec elf32_freebsd_sysvec;
  67 extern struct sysentvec elf64_freebsd_sysvec;
  68
  69 static d_close_t        filemon_close;
  70 static d_ioctl_t        filemon_ioctl;
  71 static d_open_t         filemon_open;
  72 static int              filemon_unload(void);
  73 static void             filemon_load(void *);
  74
  75 static struct cdevsw filemon_cdevsw = {
  76         .d_version      = D_VERSION,
  77         .d_close        = filemon_close,
  78         .d_ioctl        = filemon_ioctl,
  79         .d_open         = filemon_open,
  80         .d_name         = "filemon",
  81 };
  82
  83 MALLOC_DECLARE(M_FILEMON);
  84 MALLOC_DEFINE(M_FILEMON, "filemon", "File access monitor");
  85
  86 struct filemon {
  87         TAILQ_ENTRY(filemon) link;      /* Link into the in-use list. */
  88         struct mtx      mtx;            /* Lock mutex for this filemon. */
  89         struct cv       cv;             /* Lock condition variable for this
  90                                            filemon. */
  91         struct file     *fp;            /* Output file pointer. */
  92         struct thread   *locker;        /* Ptr to the thread locking this
  93                                            filemon. */
  94         pid_t           pid;            /* The process ID being monitored. */
  95         char            fname1[MAXPATHLEN]; /* Temporary filename buffer. */
  96         char            fname2[MAXPATHLEN]; /* Temporary filename buffer. */
  97         char            msgbufr[1024];  /* Output message buffer. */
  98 };
  99
 100 static TAILQ_HEAD(, filemon) filemons_inuse = TAILQ_HEAD_INITIALIZER(filemons_inuse);
 101 static TAILQ_HEAD(, filemon) filemons_free = TAILQ_HEAD_INITIALIZER(filemons_free);
 102 static int n_readers = 0;
 103 static struct mtx access_mtx;
 104 static struct cv access_cv;
 105 static struct thread *access_owner = NULL;
 106 static struct thread *access_requester = NULL;
 107
 108 static struct cdev *filemon_dev;
 109
 110 #include "filemon_lock.c"
 111 #include "filemon_wrapper.c"
 112
 113 static void
 114 filemon_dtr(void *data)
 115 {
 116         struct filemon *filemon = data;
 117
 118         if (filemon != NULL) {
 119                 struct file *fp = filemon->fp;
 120
 121                 /* Get exclusive write access. */
 122                 filemon_lock_write();
 123
 124                 /* Remove from the in-use list. */
 125                 TAILQ_REMOVE(&filemons_inuse, filemon, link);
 126
 127                 filemon->fp = NULL;
 128                 filemon->pid = -1;
 129
 130                 /* Add to the free list. */
 131                 TAILQ_INSERT_TAIL(&filemons_free, filemon, link);
 132
 133                 /* Give up write access. */
 134                 filemon_unlock_write();
 135
 136                 if (fp != NULL)
 137                         fdrop(fp, curthread);
 138         }
 139 }
 140
 141 #if __FreeBSD_version < 900041
 142 #define FGET_WRITE(a1, a2, a3) fget_write((a1), (a2), (a3))
 143 #else
 144 #define FGET_WRITE(a1, a2, a3) fget_write((a1), (a2), CAP_WRITE | CAP_SEEK, (a3))
 145 #endif
 146
 147 static int
 148 filemon_ioctl(struct cdev *dev, u_long cmd, caddr_t data, int flag __unused,
 149     struct thread *td)
 150 {
 151         int error = 0;
 152         struct filemon *filemon;
 153         struct proc *p;
 154
 155         devfs_get_cdevpriv((void **) &filemon);
 156
 157         switch (cmd) {
 158         /* Set the output file descriptor. */
 159         case FILEMON_SET_FD:
 160                 if ((error = FGET_WRITE(td, *(int *)data, &filemon->fp)) == 0)
 161                         /* Write the file header. */
 162                         filemon_comment(filemon);
 163                 break;
 164
 165         /* Set the monitored process ID. */
 166         case FILEMON_SET_PID:
 167                 p = pfind(*((pid_t *)data));
 168                 if (p == NULL)
 169                         return (EINVAL);
 170                 error = p_candebug(curthread, p);
 171                 if (error == 0)
 172                         filemon->pid = p->p_pid;
 173                 PROC_UNLOCK(p);
 174                 break;
 175
 176         default:
 177                 error = EINVAL;
 178                 break;
 179         }
 180
 181         return (error);
 182 }
 183
 184 static int
 185 filemon_open(struct cdev *dev, int oflags __unused, int devtype __unused,
 186     struct thread *td __unused)
 187 {
 188         struct filemon *filemon;
 189
 190         /* Get exclusive write access. */
 191         filemon_lock_write();
 192
 193         if ((filemon = TAILQ_FIRST(&filemons_free)) != NULL)
 194                 TAILQ_REMOVE(&filemons_free, filemon, link);
 195
 196         /* Give up write access. */
 197         filemon_unlock_write();
 198
 199         if (filemon == NULL) {
 200                 filemon = malloc(sizeof(struct filemon), M_FILEMON,
 201                     M_WAITOK | M_ZERO);
 202
 203                 filemon->fp = NULL;
 204
 205                 mtx_init(&filemon->mtx, "filemon", "filemon", MTX_DEF);
 206                 cv_init(&filemon->cv, "filemon");
 207         }
 208
 209         filemon->pid = curproc->p_pid;
 210
 211         devfs_set_cdevpriv(filemon, filemon_dtr);
 212
 213         /* Get exclusive write access. */
 214         filemon_lock_write();
 215
 216         /* Add to the in-use list. */
 217         TAILQ_INSERT_TAIL(&filemons_inuse, filemon, link);
 218
 219         /* Give up write access. */
 220         filemon_unlock_write();
 221
 222         return (0);
 223 }
 224
 225 static int
 226 filemon_close(struct cdev *dev __unused, int flag __unused, int fmt __unused,
 227     struct thread *td __unused)
 228 {
 229
 230         return (0);
 231 }
 232
 233 static void
 234 filemon_load(void *dummy __unused)
 235 {
 236         mtx_init(&access_mtx, "filemon", "filemon", MTX_DEF);
 237         cv_init(&access_cv, "filemon");
 238
 239         /* Install the syscall wrappers. */
 240         filemon_wrapper_install();
 241
 242         filemon_dev = make_dev(&filemon_cdevsw, 0, UID_ROOT, GID_WHEEL, 0666,
 243             "filemon");
 244 }
 245
 246 static int
 247 filemon_unload(void)
 248 {
 249         struct filemon *filemon;
 250         int error = 0;
 251
 252         /* Get exclusive write access. */
 253         filemon_lock_write();
 254
 255         if (TAILQ_FIRST(&filemons_inuse) != NULL)
 256                 error = EBUSY;
 257         else {
 258                 destroy_dev(filemon_dev);
 259
 260                 /* Deinstall the syscall wrappers. */
 261                 filemon_wrapper_deinstall();
 262         }
 263
 264         /* Give up write access. */
 265         filemon_unlock_write();
 266
 267         if (error == 0) {
 268                 /* free() filemon structs free list. */
 269                 filemon_lock_write();
 270                 while ((filemon = TAILQ_FIRST(&filemons_free)) != NULL) {
 271                         TAILQ_REMOVE(&filemons_free, filemon, link);
 272                         mtx_destroy(&filemon->mtx);
 273                         cv_destroy(&filemon->cv);
 274                         free(filemon, M_FILEMON);
 275                 }
 276                 filemon_unlock_write();
 277
 278                 mtx_destroy(&access_mtx);
 279                 cv_destroy(&access_cv);
 280         }
 281
 282         return (error);
 283 }
 284
 285 static int
 286 filemon_modevent(module_t mod __unused, int type, void *data)
 287 {
 288         int error = 0;
 289
 290         switch (type) {
 291         case MOD_LOAD:
 292                 filemon_load(data);
 293                 break;
 294
 295         case MOD_UNLOAD:
 296                 error = filemon_unload();
 297                 break;
 298
 299         case MOD_SHUTDOWN:
 300                 break;
 301
 302         default:
 303                 error = EOPNOTSUPP;
 304                 break;
 305
 306         }
 307
 308         return (error);
 309 }
 310
 311 DEV_MODULE(filemon, filemon_modevent, NULL);
 312 MODULE_VERSION(filemon, 1);