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