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