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