usr.bin/truss/i386-fbsd.c

   1 /*
   2  * Copryight 1997 Sean Eric Fagan
   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 acknowledgement:
  14  *      This product includes software developed by Sean Eric Fagan
  15  * 4. Neither the name of the author may be used to endorse or promote
  16  *    products derived from this software without specific prior written
  17  *    permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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  * $FreeBSD: src/usr.bin/truss/i386-fbsd.c,v 1.7.2.2 2001/10/29 20:12:56 des Exp $
  32  * $DragonFly: src/usr.bin/truss/i386-fbsd.c,v 1.2 2003/06/17 04:29:33 dillon Exp $
  33  */
  34
  35 /*
  36  * FreeBSD/386-specific system call handling.  This is probably the most
  37  * complex part of the entire truss program, although I've got lots of
  38  * it handled relatively cleanly now.  The system call names are generated
  39  * automatically, thanks to /usr/src/sys/kern/syscalls.master.  The
  40  * names used for the various structures are confusing, I sadly admit.
  41  */
  42
  43 #include <sys/types.h>
  44 #include <sys/ioctl.h>
  45 #include <sys/pioctl.h>
  46 #include <sys/syscall.h>
  47
  48 #include <machine/reg.h>
  49 #include <machine/psl.h>
  50
  51 #include <errno.h>
  52 #include <fcntl.h>
  53 #include <signal.h>
  54 #include <stdio.h>
  55 #include <stdlib.h>
  56 #include <string.h>
  57 #include <unistd.h>
  58
  59 #include "syscall.h"
  60
  61 static int fd = -1;
  62 static int cpid = -1;
  63 extern int Procfd;
  64
  65 extern FILE *outfile;
  66 #include "syscalls.h"
  67
  68 static int nsyscalls = sizeof(syscallnames) / sizeof(syscallnames[0]);
  69
  70 /*
  71  * This is what this particular file uses to keep track of a system call.
  72  * It is probably not quite sufficient -- I can probably use the same
  73  * structure for the various syscall personalities, and I also probably
  74  * need to nest system calls (for signal handlers).
  75  *
  76  * 'struct syscall' describes the system call; it may be NULL, however,
  77  * if we don't know about this particular system call yet.
  78  */
  79 static struct freebsd_syscall {
  80         struct syscall *sc;
  81         char *name;
  82         int number;
  83         unsigned long *args;
  84         int nargs;      /* number of arguments -- *not* number of words! */
  85         char **s_args;  /* the printable arguments */
  86 } fsc;
  87
  88 /* Clear up and free parts of the fsc structure. */
  89 static inline void
  90 clear_fsc() {
  91   if (fsc.args) {
  92     free(fsc.args);
  93   }
  94   if (fsc.s_args) {
  95     int i;
  96     for (i = 0; i < fsc.nargs; i++)
  97       if (fsc.s_args[i])
  98         free(fsc.s_args[i]);
  99     free(fsc.s_args);
 100   }
 101   memset(&fsc, 0, sizeof(fsc));
 102 }
 103
 104 /*
 105  * Called when a process has entered a system call.  nargs is the
 106  * number of words, not number of arguments (a necessary distinction
 107  * in some cases).  Note that if the STOPEVENT() code in i386/i386/trap.c
 108  * is ever changed these functions need to keep up.
 109  */
 110
 111 void
 112 i386_syscall_entry(int pid, int nargs) {
 113   char buf[32];
 114   struct reg regs = { 0 };
 115   int syscall;
 116   int i;
 117   unsigned int parm_offset;
 118   struct syscall *sc;
 119
 120   if (fd == -1 || pid != cpid) {
 121     sprintf(buf, "/proc/%d/regs", pid);
 122     fd = open(buf, O_RDWR);
 123     if (fd == -1) {
 124       fprintf(outfile, "-- CANNOT READ REGISTERS --\n");
 125       return;
 126     }
 127     cpid = pid;
 128   }
 129
 130   clear_fsc();
 131   lseek(fd, 0L, 0);
 132   i = read(fd, &regs, sizeof(regs));
 133   parm_offset = regs.r_esp + sizeof(int);
 134
 135   /*
 136    * FreeBSD has two special kinds of system call redirctions --
 137    * SYS_syscall, and SYS___syscall.  The former is the old syscall()
 138    * routine, basicly; the latter is for quad-aligned arguments.
 139    */
 140   syscall = regs.r_eax;
 141   switch (syscall) {
 142   case SYS_syscall:
 143     lseek(Procfd, parm_offset, SEEK_SET);
 144     read(Procfd, &syscall, sizeof(int));
 145     parm_offset += sizeof(int);
 146     break;
 147   case SYS___syscall:
 148     lseek(Procfd, parm_offset, SEEK_SET);
 149     read(Procfd, &syscall, sizeof(int));
 150     parm_offset += sizeof(quad_t);
 151     break;
 152   }
 153
 154   fsc.number = syscall;
 155   fsc.name =
 156     (syscall < 0 || syscall > nsyscalls) ? NULL : syscallnames[syscall];
 157   if (!fsc.name) {
 158     fprintf(outfile, "-- UNKNOWN SYSCALL %d --\n", syscall);
 159   }
 160
 161   if (nargs == 0)
 162     return;
 163
 164   fsc.args = malloc((1+nargs) * sizeof(unsigned long));
 165   lseek(Procfd, parm_offset, SEEK_SET);
 166   if (read(Procfd, fsc.args, nargs * sizeof(unsigned long)) == -1)
 167     return;
 168
 169   sc = get_syscall(fsc.name);
 170   if (sc) {
 171     fsc.nargs = sc->nargs;
 172   } else {
 173 #if DEBUG
 174     fprintf(outfile, "unknown syscall %s -- setting args to %d\n",
 175            fsc.name, nargs);
 176 #endif
 177     fsc.nargs = nargs;
 178   }
 179
 180   fsc.s_args = malloc((1+fsc.nargs) * sizeof(char*));
 181   memset(fsc.s_args, 0, fsc.nargs * sizeof(char*));
 182   fsc.sc = sc;
 183
 184   /*
 185    * At this point, we set up the system call arguments.
 186    * We ignore any OUT ones, however -- those are arguments that
 187    * are set by the system call, and so are probably meaningless
 188    * now.  This doesn't currently support arguments that are
 189    * passed in *and* out, however.
 190    */
 191
 192   if (fsc.name) {
 193
 194 #if DEBUG
 195     fprintf(stderr, "syscall %s(", fsc.name);
 196 #endif
 197     for (i = 0; i < fsc.nargs; i++) {
 198 #if DEBUG
 199       fprintf(stderr, "0x%x%s",
 200              sc
 201              ? fsc.args[sc->args[i].offset]
 202              : fsc.args[i],
 203              i < (fsc.nargs -1) ? "," : "");
 204 #endif
 205       if (sc && !(sc->args[i].type & OUT)) {
 206         fsc.s_args[i] = print_arg(Procfd, &sc->args[i], fsc.args);
 207       }
 208     }
 209 #if DEBUG
 210     fprintf(stderr, ")\n");
 211 #endif
 212   }
 213
 214 #if DEBUG
 215   fprintf(outfile, "\n");
 216 #endif
 217
 218   /*
 219    * Some system calls should be printed out before they are done --
 220    * execve() and exit(), for example, never return.  Possibly change
 221    * this to work for any system call that doesn't have an OUT
 222    * parameter?
 223    */
 224
 225   if (!strcmp(fsc.name, "execve") || !strcmp(fsc.name, "exit")) {
 226     print_syscall(outfile, fsc.name, fsc.nargs, fsc.s_args);
 227   }
 228
 229   return;
 230 }
 231
 232 /*
 233  * And when the system call is done, we handle it here.
 234  * Currently, no attempt is made to ensure that the system calls
 235  * match -- this needs to be fixed (and is, in fact, why S_SCX includes
 236  * the sytem call number instead of, say, an error status).
 237  */
 238
 239 void
 240 i386_syscall_exit(int pid, int syscall) {
 241   char buf[32];
 242   struct reg regs;
 243   int retval;
 244   int i;
 245   int errorp;
 246   struct syscall *sc;
 247
 248   if (fd == -1 || pid != cpid) {
 249     sprintf(buf, "/proc/%d/regs", pid);
 250     fd = open(buf, O_RDONLY);
 251     if (fd == -1) {
 252       fprintf(outfile, "-- CANNOT READ REGISTERS --\n");
 253       return;
 254     }
 255     cpid = pid;
 256   }
 257
 258   lseek(fd, 0L, 0);
 259   if (read(fd, &regs, sizeof(regs)) != sizeof(regs))
 260     return;
 261   retval = regs.r_eax;
 262   errorp = !!(regs.r_eflags & PSL_C);
 263
 264   /*
 265    * This code, while simpler than the initial versions I used, could
 266    * stand some significant cleaning.
 267    */
 268
 269   sc = fsc.sc;
 270   if (!sc) {
 271     for (i = 0; i < fsc.nargs; i++) {
 272       fsc.s_args[i] = malloc(12);
 273       sprintf(fsc.s_args[i], "0x%lx", fsc.args[i]);
 274     }
 275   } else {
 276     /*
 277      * Here, we only look for arguments that have OUT masked in --
 278      * otherwise, they were handled in the syscall_entry function.
 279      */
 280     for (i = 0; i < sc->nargs; i++) {
 281       char *temp;
 282       if (sc->args[i].type & OUT) {
 283         /*
 284          * If an error occurred, than don't bothe getting the data;
 285          * it may not be valid.
 286          */
 287         if (errorp) {
 288           temp = malloc(12);
 289           sprintf(temp, "0x%lx", fsc.args[sc->args[i].offset]);
 290         } else {
 291           temp = print_arg(Procfd, &sc->args[i], fsc.args);
 292         }
 293         fsc.s_args[i] = temp;
 294       }
 295     }
 296   }
 297
 298   /*
 299    * It would probably be a good idea to merge the error handling,
 300    * but that complicates things considerably.
 301    */
 302
 303   print_syscall_ret(outfile, fsc.name, fsc.nargs, fsc.s_args, errorp, retval);
 304   clear_fsc();
 305
 306   return;
 307 }