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  * $FreeBSD: src/usr.bin/truss/alpha-fbsd.c,v 1.3.2.2 2001/10/29 20:12:56 des Exp $
  32  * $DragonFly: src/usr.bin/truss/Attic/alpha-fbsd.c,v 1.2 2003/06/17 04:29:33 dillon Exp $
  33  */
  34
  35 /*
  36  * FreeBSD/alpha-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  * This file is almost nothing more than a slightly-edited i386-fbsd.c.
  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 <err.h>
  54 #include <errno.h>
  55 #include <fcntl.h>
  56 #include <signal.h>
  57 #include <stdio.h>
  58 #include <stdlib.h>
  59 #include <string.h>
  60 #include <unistd.h>
  61
  62 #include "syscall.h"
  63
  64 static int fd = -1;
  65 static int cpid = -1;
  66 extern int Procfd;
  67
  68 extern FILE *outfile;
  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         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() {
  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 alpha/alpha/trap.c
 111  * is ever changed these functions need to keep up.
 112  */
 113
 114 void
 115 alpha_syscall_entry(int pid, int nargs) {
 116   char buf[32];
 117   struct reg regs = { { 0 } };
 118   int syscall;
 119   int i;
 120   unsigned int parm_offset;
 121   struct syscall *sc;
 122   int indir = 0;        /* indirect system call */
 123
 124   if (fd == -1 || pid != cpid) {
 125     sprintf(buf, "/proc/%d/regs", pid);
 126     fd = open(buf, O_RDWR);
 127     if (fd == -1) {
 128       fprintf(outfile, "-- CANNOT READ REGISTERS --\n");
 129       return;
 130     }
 131     cpid = pid;
 132   }
 133
 134   clear_fsc();
 135   lseek(fd, 0L, 0);
 136   i = read(fd, &regs, sizeof(regs));
 137   parm_offset = regs.r_regs[R_SP] + sizeof(int);
 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   syscall = regs.r_regs[R_V0];
 145   if (syscall == SYS_syscall || syscall == SYS___syscall) {
 146     indir = 1;
 147     syscall = regs.r_regs[R_A0];
 148   }
 149
 150   fsc.number = syscall;
 151   fsc.name =
 152     (syscall < 0 || syscall > nsyscalls) ? NULL : syscallnames[syscall];
 153   if (!fsc.name) {
 154     fprintf(outfile, "-- UNKNOWN SYSCALL %d --\n", syscall);
 155   }
 156
 157   if (nargs == 0)
 158     return;
 159
 160   fsc.args = malloc((1+nargs) * sizeof(unsigned long));
 161   switch (nargs) {
 162   default:
 163         /*
 164          * The OS doesn't seem to allow more than 10 words of
 165          * parameters (yay!).  So we shouldn't be here.
 166          */
 167         warn("More than 10 words (%d) of arguments!\n", nargs);
 168         break;
 169   case 10: case 9: case 8: case 7:
 170         /*
 171          * If there are 7-10 words of arguments, they are placed
 172          * on the stack, as is normal for other processors.
 173          * The fall-through for all of these is deliberate!!!
 174          */
 175         lseek(Procfd, regs.r_regs[R_SP], SEEK_SET);
 176         read(fd, &fsc.args[6], (nargs - 6) * sizeof(fsc.args[0]));
 177   case 6:       fsc.args[5] = regs.r_regs[R_A5];
 178   case 5:       fsc.args[4] = regs.r_regs[R_A4];
 179   case 4:       fsc.args[3] = regs.r_regs[R_A3];
 180   case 3:       fsc.args[2] = regs.r_regs[R_A2];
 181   case 2:       fsc.args[1] = regs.r_regs[R_A1];
 182   case 1:       fsc.args[0] = regs.r_regs[R_A0];
 183   case 0:
 184         break;
 185   }
 186
 187   if (indir) {
 188     memmove(&fsc.args[0], &fsc.args[1], (nargs-1) * sizeof(fsc.args[0]));
 189   }
 190
 191   sc = get_syscall(fsc.name);
 192   if (sc) {
 193     fsc.nargs = sc->nargs;
 194   } else {
 195 #if DEBUG
 196     fprintf(outfile, "unknown syscall %s -- setting args to %d\n",
 197            fsc.name, nargs);
 198 #endif
 199     fsc.nargs = nargs;
 200   }
 201
 202   fsc.s_args = malloc((1+fsc.nargs) * sizeof(char*));
 203   memset(fsc.s_args, 0, fsc.nargs * sizeof(char*));
 204   fsc.sc = sc;
 205
 206   /*
 207    * At this point, we set up the system call arguments.
 208    * We ignore any OUT ones, however -- those are arguments that
 209    * are set by the system call, and so are probably meaningless
 210    * now.  This doesn't currently support arguments that are
 211    * passed in *and* out, however.
 212    */
 213
 214   if (fsc.name) {
 215
 216 #if DEBUG
 217     fprintf(stderr, "syscall %s(", fsc.name);
 218 #endif
 219     for (i = 0; i < fsc.nargs; i++) {
 220 #if DEBUG
 221       fprintf(stderr, "0x%x%s",
 222              sc
 223              ? fsc.args[sc->args[i].offset]
 224              : fsc.args[i],
 225              i < (fsc.nargs -1) ? "," : "");
 226 #endif
 227       if (sc && !(sc->args[i].type & OUT)) {
 228         fsc.s_args[i] = print_arg(Procfd, &sc->args[i], fsc.args);
 229       }
 230     }
 231 #if DEBUG
 232     fprintf(stderr, ")\n");
 233 #endif
 234   }
 235
 236 #if DEBUG
 237   fprintf(outfile, "\n");
 238 #endif
 239
 240   /*
 241    * Some system calls should be printed out before they are done --
 242    * execve() and exit(), for example, never return.  Possibly change
 243    * this to work for any system call that doesn't have an OUT
 244    * parameter?
 245    */
 246
 247   if (!strcmp(fsc.name, "execve") || !strcmp(fsc.name, "exit")) {
 248     print_syscall(outfile, fsc.name, fsc.nargs, fsc.s_args);
 249   }
 250
 251   return;
 252 }
 253
 254 /*
 255  * And when the system call is done, we handle it here.
 256  * Currently, no attempt is made to ensure that the system calls
 257  * match -- this needs to be fixed (and is, in fact, why S_SCX includes
 258  * the sytem call number instead of, say, an error status).
 259  */
 260
 261 void
 262 alpha_syscall_exit(int pid, int syscall) {
 263   char buf[32];
 264   struct reg regs;
 265   int retval;
 266   int i;
 267   int errorp;
 268   struct syscall *sc;
 269
 270   if (fd == -1 || pid != cpid) {
 271     sprintf(buf, "/proc/%d/regs", pid);
 272     fd = open(buf, O_RDONLY);
 273     if (fd == -1) {
 274       fprintf(outfile, "-- CANNOT READ REGISTERS --\n");
 275       return;
 276     }
 277     cpid = pid;
 278   }
 279
 280   lseek(fd, 0L, 0);
 281   if (read(fd, &regs, sizeof(regs)) != sizeof(regs))
 282     return;
 283   retval = regs.r_regs[R_V0];
 284   errorp = !!(regs.r_regs[R_A3]);
 285
 286   /*
 287    * This code, while simpler than the initial versions I used, could
 288    * stand some significant cleaning.
 289    */
 290
 291   sc = fsc.sc;
 292   if (!sc) {
 293     for (i = 0; i < fsc.nargs; i++) {
 294       fsc.s_args[i] = malloc(12);
 295       sprintf(fsc.s_args[i], "0x%lx", fsc.args[i]);
 296     }
 297   } else {
 298     /*
 299      * Here, we only look for arguments that have OUT masked in --
 300      * otherwise, they were handled in the syscall_entry function.
 301      */
 302     for (i = 0; i < sc->nargs; i++) {
 303       char *temp;
 304       if (sc->args[i].type & OUT) {
 305         /*
 306          * If an error occurred, than don't bothe getting the data;
 307          * it may not be valid.
 308          */
 309         if (errorp) {
 310           temp = malloc(12);
 311           sprintf(temp, "0x%lx", fsc.args[sc->args[i].offset]);
 312         } else {
 313           temp = print_arg(Procfd, &sc->args[i], fsc.args);
 314         }
 315         fsc.s_args[i] = temp;
 316       }
 317     }
 318   }
 319
 320   /*
 321    * It would probably be a good idea to merge the error handling,
 322    * but that complicates things considerably.
 323    */
 324
 325   print_syscall_ret(outfile, fsc.name, fsc.nargs, fsc.s_args, errorp, retval);
 326   clear_fsc();
 327
 328   return;
 329 }