6/usr.bin/truss/alpha-fbsd.c

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