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
  32 #ifndef lint
  33 static const char rcsid[] =
  34   "$FreeBSD$";
  35 #endif /* not lint */
  36
  37 /*
  38  * FreeBSD/i386-specific system call handling.  This is probably the most
  39  * complex part of the entire truss program, although I've got lots of
  40  * it handled relatively cleanly now.  The system call names are generated
  41  * automatically, thanks to /usr/src/sys/kern/syscalls.master.  The
  42  * names used for the various structures are confusing, I sadly admit.
  43  */
  44
  45 #include <sys/types.h>
  46 #include <sys/syscall.h>
  47 #include <sys/ptrace.h>
  48
  49 #include <machine/reg.h>
  50 #include <machine/psl.h>
  51
  52 #include <errno.h>
  53 #include <fcntl.h>
  54 #include <signal.h>
  55 #include <stdio.h>
  56 #include <stdlib.h>
  57 #include <string.h>
  58 #include <time.h>
  59 #include <unistd.h>
  60
  61 #include "truss.h"
  62 #include "syscall.h"
  63 #include "extern.h"
  64
  65 static int cpid = -1;
  66
  67 #include "syscalls.h"
  68
  69 static int nsyscalls = sizeof(syscallnames) / sizeof(syscallnames[0]);
  70
  71 /*
  72  * This is what this particular file uses to keep track of a system call.
  73  * It is probably not quite sufficient -- I can probably use the same
  74  * structure for the various syscall personalities, and I also probably
  75  * need to nest system calls (for signal handlers).
  76  *
  77  * 'struct syscall' describes the system call; it may be NULL, however,
  78  * if we don't know about this particular system call yet.
  79  */
  80 static struct freebsd_syscall {
  81         struct syscall *sc;
  82         const char *name;
  83         int number;
  84         unsigned long *args;
  85         int nargs;      /* number of arguments -- *not* number of words! */
  86         char **s_args;  /* the printable arguments */
  87 } fsc;
  88
  89 /* Clear up and free parts of the fsc structure. */
  90 static __inline void
  91 clear_fsc(void) {
  92   if (fsc.args) {
  93     free(fsc.args);
  94   }
  95   if (fsc.s_args) {
  96     int i;
  97     for (i = 0; i < fsc.nargs; i++)
  98       if (fsc.s_args[i])
  99         free(fsc.s_args[i]);
 100     free(fsc.s_args);
 101   }
 102   memset(&fsc, 0, sizeof(fsc));
 103 }
 104
 105 /*
 106  * Called when a process has entered a system call.  nargs is the
 107  * number of words, not number of arguments (a necessary distinction
 108  * in some cases).  Note that if the STOPEVENT() code in i386/i386/trap.c
 109  * is ever changed these functions need to keep up.
 110  */
 111
 112 void
 113 i386_syscall_entry(struct trussinfo *trussinfo, int nargs) {
 114   struct reg regs;
 115   int syscall_num;
 116   int i;
 117   unsigned int parm_offset;
 118   struct syscall *sc = NULL;
 119   struct ptrace_io_desc iorequest;
 120   cpid = trussinfo->curthread->tid;
 121
 122   clear_fsc();
 123
 124   if (ptrace(PT_GETREGS, cpid, (caddr_t)&regs, 0) < 0)
 125   {
 126     fprintf(trussinfo->outfile, "-- CANNOT READ REGISTERS --\n");
 127     return;
 128   }
 129   parm_offset = regs.r_esp + sizeof(int);
 130
 131   /*
 132    * FreeBSD has two special kinds of system call redirctions --
 133    * SYS_syscall, and SYS___syscall.  The former is the old syscall()
 134    * routine, basicly; the latter is for quad-aligned arguments.
 135    */
 136   syscall_num = regs.r_eax;
 137   switch (syscall_num) {
 138   case SYS_syscall:
 139     syscall_num = ptrace(PT_READ_D, cpid, (caddr_t)parm_offset, 0);
 140     parm_offset += sizeof(int);
 141     break;
 142   case SYS___syscall:
 143     syscall_num = ptrace(PT_READ_D, cpid, (caddr_t)parm_offset, 0);
 144     parm_offset += sizeof(quad_t);
 145     break;
 146   }
 147
 148   fsc.number = syscall_num;
 149   fsc.name =
 150     (syscall_num < 0 || syscall_num > nsyscalls) ? NULL : syscallnames[syscall_num];
 151   if (!fsc.name) {
 152     fprintf(trussinfo->outfile, "-- UNKNOWN SYSCALL %d --\n", syscall_num);
 153   }
 154
 155   if (fsc.name && (trussinfo->flags & FOLLOWFORKS)
 156    && ((!strcmp(fsc.name, "fork")
 157     || !strcmp(fsc.name, "rfork")
 158     || !strcmp(fsc.name, "vfork"))))
 159   {
 160     trussinfo->curthread->in_fork = 1;
 161   }
 162
 163   if (nargs == 0)
 164     return;
 165
 166   fsc.args = malloc((1+nargs) * sizeof(unsigned long));
 167   iorequest.piod_op = PIOD_READ_D;
 168   iorequest.piod_offs = (void *)parm_offset;
 169   iorequest.piod_addr = fsc.args;
 170   iorequest.piod_len = (1+nargs) * sizeof(unsigned long);
 171   ptrace(PT_IO, cpid, (caddr_t)&iorequest, 0);
 172   if (iorequest.piod_len == 0)
 173     return;
 174
 175   if (fsc.name)
 176         sc = get_syscall(fsc.name);
 177   if (sc) {
 178     fsc.nargs = sc->nargs;
 179   } else {
 180 #if DEBUG
 181     fprintf(trussinfo->outfile, "unknown syscall %s -- setting args to %d\n",
 182            fsc.name, nargs);
 183 #endif
 184     fsc.nargs = nargs;
 185   }
 186
 187   fsc.s_args = malloc((1+fsc.nargs) * sizeof(char*));
 188   memset(fsc.s_args, 0, fsc.nargs * sizeof(char*));
 189   fsc.sc = sc;
 190
 191   /*
 192    * At this point, we set up the system call arguments.
 193    * We ignore any OUT ones, however -- those are arguments that
 194    * are set by the system call, and so are probably meaningless
 195    * now.  This doesn't currently support arguments that are
 196    * passed in *and* out, however.
 197    */
 198
 199   if (fsc.name) {
 200
 201 #if DEBUG
 202     fprintf(stderr, "syscall %s(", fsc.name);
 203 #endif
 204     for (i = 0; i < fsc.nargs; i++) {
 205 #if DEBUG
 206       fprintf(stderr, "0x%x%s",
 207               sc
 208               ? fsc.args[sc->args[i].offset]
 209               : fsc.args[i],
 210               i < (fsc.nargs - 1) ? "," : "");
 211 #endif
 212       if (sc && !(sc->args[i].type & OUT)) {
 213         fsc.s_args[i] = print_arg(&sc->args[i], fsc.args, 0, trussinfo);
 214       }
 215     }
 216 #if DEBUG
 217     fprintf(stderr, ")\n");
 218 #endif
 219   }
 220
 221 #if DEBUG
 222   fprintf(trussinfo->outfile, "\n");
 223 #endif
 224
 225   if (fsc.name != NULL &&
 226       (!strcmp(fsc.name, "execve") || !strcmp(fsc.name, "exit"))) {
 227
 228     /* XXX
 229      * This could be done in a more general
 230      * manner but it still wouldn't be very pretty.
 231      */
 232     if (!strcmp(fsc.name, "execve")) {
 233         if ((trussinfo->flags & EXECVEARGS) == 0)
 234           if (fsc.s_args[1]) {
 235             free(fsc.s_args[1]);
 236             fsc.s_args[1] = NULL;
 237           }
 238         if ((trussinfo->flags & EXECVEENVS) == 0)
 239           if (fsc.s_args[2]) {
 240             free(fsc.s_args[2]);
 241             fsc.s_args[2] = NULL;
 242           }
 243     }
 244
 245   }
 246
 247   return;
 248 }
 249
 250 /*
 251  * And when the system call is done, we handle it here.
 252  * Currently, no attempt is made to ensure that the system calls
 253  * match -- this needs to be fixed (and is, in fact, why S_SCX includes
 254  * the sytem call number instead of, say, an error status).
 255  */
 256
 257 long
 258 i386_syscall_exit(struct trussinfo *trussinfo, int syscall_num __unused)
 259 {
 260   struct reg regs;
 261   long retval;
 262   int i;
 263   int errorp;
 264   struct syscall *sc;
 265
 266   if (fsc.name == NULL)
 267     return (-1);
 268   cpid = trussinfo->curthread->tid;
 269
 270   if (ptrace(PT_GETREGS, cpid, (caddr_t)&regs, 0) < 0)
 271   {
 272     fprintf(trussinfo->outfile, "-- CANNOT READ REGISTERS --\n");
 273     return (-1);
 274   }
 275
 276   retval = regs.r_eax;
 277   errorp = !!(regs.r_eflags & PSL_C);
 278
 279   /*
 280    * This code, while simpler than the initial versions I used, could
 281    * stand some significant cleaning.
 282    */
 283
 284   sc = fsc.sc;
 285   if (!sc) {
 286     for (i = 0; i < fsc.nargs; i++)
 287       asprintf(&fsc.s_args[i], "0x%lx", fsc.args[i]);
 288   } else {
 289     /*
 290      * Here, we only look for arguments that have OUT masked in --
 291      * otherwise, they were handled in the syscall_entry function.
 292      */
 293     for (i = 0; i < sc->nargs; i++) {
 294       char *temp;
 295       if (sc->args[i].type & OUT) {
 296         /*
 297          * If an error occurred, then don't bother getting the data;
 298          * it may not be valid.
 299          */
 300         if (errorp)
 301           asprintf(&temp, "0x%lx", fsc.args[sc->args[i].offset]);
 302         else
 303           temp = print_arg(&sc->args[i], fsc.args, retval, trussinfo);
 304         fsc.s_args[i] = temp;
 305       }
 306     }
 307   }
 308
 309   /*
 310    * The pipe syscall returns its fds in two registers and has assembly glue
 311    * to provide the libc API, so it cannot be handled like regular syscalls.
 312    * The nargs check is so we don't have to do yet another strcmp on every
 313    * syscall.
 314    */
 315   if (!errorp && fsc.nargs == 0 && fsc.name && strcmp(fsc.name, "pipe") == 0) {
 316       fsc.nargs = 1;
 317       fsc.s_args = malloc((1+fsc.nargs) * sizeof(char*));
 318       asprintf(&fsc.s_args[0], "[%d,%d]", (int)retval, regs.r_edx);
 319       retval = 0;
 320   }
 321
 322   if (fsc.name != NULL &&
 323       (!strcmp(fsc.name, "execve") || !strcmp(fsc.name, "exit"))) {
 324         trussinfo->curthread->in_syscall = 1;
 325   }
 326
 327   /*
 328    * It would probably be a good idea to merge the error handling,
 329    * but that complicates things considerably.
 330    */
 331
 332   print_syscall_ret(trussinfo, fsc.name, fsc.nargs, fsc.s_args, errorp, retval);
 333   clear_fsc();
 334
 335   return (retval);
 336 }