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