usr.bin/truss/powerpc-fbsd.c

   1 /*
   2  * Copyright 2006 Peter Grehan <grehan@freebsd.org>
   3  * Copryight 2005 Orlando Bassotto <orlando@break.net>
   4  * Copryight 1998 Sean Eric Fagan
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  */
  27
  28 #ifndef lint
  29 static const char rcsid[] =
  30   "$FreeBSD$";
  31 #endif /* not lint */
  32
  33 /*
  34  * FreeBSD/powerpc-specific system call handling.  This is probably the most
  35  * complex part of the entire truss program, although I've got lots of
  36  * it handled relatively cleanly now.  The system call names are generated
  37  * automatically, thanks to /usr/src/sys/kern/syscalls.master.  The
  38  * names used for the various structures are confusing, I sadly admit.
  39  *
  40  * This file is almost nothing more than a slightly-edited i386-fbsd.c.
  41  */
  42
  43 #include <sys/types.h>
  44 #include <sys/ptrace.h>
  45 #include <sys/syscall.h>
  46
  47 #include <machine/reg.h>
  48 #include <machine/frame.h>
  49
  50 #include <err.h>
  51 #include <errno.h>
  52 #include <fcntl.h>
  53 #include <signal.h>
  54 #include <stdio.h>
  55 #include <stdlib.h>
  56 #include <string.h>
  57 #include <time.h>
  58 #include <unistd.h>
  59
  60 #include "truss.h"
  61 #include "syscall.h"
  62 #include "extern.h"
  63
  64 static int cpid = -1;
  65
  66 #include "syscalls.h"
  67
  68 static int nsyscalls = sizeof(syscallnames) / sizeof(syscallnames[0]);
  69
  70 /*
  71  * This is what this particular file uses to keep track of a system call.
  72  * It is probably not quite sufficient -- I can probably use the same
  73  * structure for the various syscall personalities, and I also probably
  74  * need to nest system calls (for signal handlers).
  75  *
  76  * 'struct syscall' describes the system call; it may be NULL, however,
  77  * if we don't know about this particular system call yet.
  78  */
  79 static struct freebsd_syscall {
  80         struct syscall *sc;
  81         const char *name;
  82         int number;
  83         unsigned long *args;
  84         int nargs;      /* number of arguments -- *not* number of words! */
  85         char **s_args;  /* the printable arguments */
  86 } fsc;
  87
  88 /* Clear up and free parts of the fsc structure. */
  89 static __inline void
  90 clear_fsc(void) {
  91   if (fsc.args) {
  92     free(fsc.args);
  93   }
  94   if (fsc.s_args) {
  95     int i;
  96     for (i = 0; i < fsc.nargs; i++)
  97       if (fsc.s_args[i])
  98         free(fsc.s_args[i]);
  99     free(fsc.s_args);
 100   }
 101   memset(&fsc, 0, sizeof(fsc));
 102 }
 103
 104 /*
 105  * Called when a process has entered a system call.  nargs is the
 106  * number of words, not number of arguments (a necessary distinction
 107  * in some cases).  Note that if the STOPEVENT() code in powerpc/powerpc/trap.c
 108  * is ever changed these functions need to keep up.
 109  */
 110
 111 void
 112 powerpc_syscall_entry(struct trussinfo *trussinfo, int nargs) {
 113   char buf[32];
 114   struct reg regs;
 115   void *args;
 116   int syscall_num;
 117   int i;
 118   unsigned int regargs;
 119   struct syscall *sc;
 120
 121   /* Account for a 64-bit argument with corresponding alignment. */
 122   nargs += 2;
 123
 124   cpid = trussinfo->curthread->tid;
 125
 126   clear_fsc();
 127   if (ptrace(PT_GETREGS, cpid, (caddr_t)&regs, 0) < 0) {
 128     fprintf(trussinfo->outfile, "-- CANNOT READ REGISTERS --\n");
 129     return;
 130   }
 131
 132   /*
 133    * FreeBSD has two special kinds of system call redirctions --
 134    * SYS_syscall, and SYS___syscall.  The former is the old syscall()
 135    * routine, basicly; the latter is for quad-aligned arguments.
 136    */
 137   regargs = NARGREG;
 138   syscall_num = regs.fixreg[0];
 139   args = &regs.fixreg[3];
 140   if (syscall_num == SYS_syscall) {
 141     args = &regs.fixreg[4];
 142     regargs -= 1;
 143     syscall_num = regs.fixreg[3];
 144   } else if (syscall_num == SYS___syscall) {
 145     args = &regs.fixreg[5];
 146     regargs -= 2;
 147     syscall_num = regs.fixreg[4];
 148   }
 149
 150   fsc.number = syscall_num;
 151   fsc.name =
 152     (syscall_num < 0 || syscall_num >= nsyscalls) ? NULL : syscallnames[syscall_num];
 153   if (!fsc.name) {
 154     fprintf(trussinfo->outfile, "-- UNKNOWN SYSCALL %d --\n", syscall_num);
 155   }
 156
 157   if (fsc.name && (trussinfo->flags & FOLLOWFORKS)
 158    && ((!strcmp(fsc.name, "fork")
 159     || !strcmp(fsc.name, "rfork")
 160     || !strcmp(fsc.name, "vfork"))))
 161   {
 162     trussinfo->curthread->in_fork = 1;
 163   }
 164
 165   if (nargs == 0)
 166     return;
 167
 168   fsc.args = malloc((1+nargs) * sizeof(unsigned long));
 169
 170   if (nargs > regargs) {
 171     struct ptrace_io_desc iorequest;
 172     memmove(&fsc.args[0], args, regargs * sizeof(fsc.args[0]));
 173
 174     iorequest.piod_op = PIOD_READ_D;
 175     iorequest.piod_offs = (void *)(regs.fixreg[1] + 8);
 176     iorequest.piod_addr = &fsc.args[regargs];
 177     iorequest.piod_len = (nargs - regargs) * sizeof(fsc.args[0]);
 178     ptrace(PT_IO, cpid, (caddr_t)&iorequest, 0);
 179     if (iorequest.piod_len == 0)
 180        return;
 181   } else {
 182     memmove(&fsc.args[0], args, nargs * sizeof(fsc.args[0]));
 183   }
 184
 185   sc = get_syscall(fsc.name);
 186   if (sc) {
 187     fsc.nargs = sc->nargs;
 188   } else {
 189 #if DEBUG
 190     fprintf(trussinfo->outfile, "unknown syscall %s -- setting args to %d\n",
 191            fsc.name, nargs);
 192 #endif
 193     fsc.nargs = nargs;
 194   }
 195
 196   fsc.s_args = calloc(1, (1+fsc.nargs) * sizeof(char*));
 197   fsc.sc = sc;
 198
 199   /*
 200    * At this point, we set up the system call arguments.
 201    * We ignore any OUT ones, however -- those are arguments that
 202    * are set by the system call, and so are probably meaningless
 203    * now.  This doesn't currently support arguments that are
 204    * passed in *and* out, however.
 205    */
 206
 207   if (fsc.name) {
 208
 209 #if DEBUG
 210     fprintf(stderr, "syscall %s(", fsc.name);
 211 #endif
 212     for (i = 0; i < fsc.nargs; i++) {
 213 #if DEBUG
 214       fprintf(stderr, "0x%x%s",
 215               sc
 216               ? fsc.args[sc->args[i].offset]
 217               : fsc.args[i],
 218               i < (fsc.nargs - 1) ? "," : "");
 219 #endif
 220       if (sc && !(sc->args[i].type & OUT)) {
 221         fsc.s_args[i] = print_arg(&sc->args[i], fsc.args, 0, trussinfo);
 222       }
 223     }
 224 #if DEBUG
 225     fprintf(stderr, ")\n");
 226 #endif
 227   }
 228
 229 #if DEBUG
 230   fprintf(trussinfo->outfile, "\n");
 231 #endif
 232
 233   if (fsc.name && (!strcmp(fsc.name, "execve") || !strcmp(fsc.name, "exit"))) {
 234
 235     /* XXX
 236      * This could be done in a more general
 237      * manner but it still wouldn't be very pretty.
 238      */
 239     if (!strcmp(fsc.name, "execve")) {
 240         if ((trussinfo->flags & EXECVEARGS) == 0)
 241           if (fsc.s_args[1]) {
 242             free(fsc.s_args[1]);
 243             fsc.s_args[1] = NULL;
 244           }
 245         if ((trussinfo->flags & EXECVEENVS) == 0)
 246           if (fsc.s_args[2]) {
 247             free(fsc.s_args[2]);
 248             fsc.s_args[2] = NULL;
 249           }
 250     }
 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 long
 264 powerpc_syscall_exit(struct trussinfo *trussinfo, int syscall_num __unused)
 265 {
 266   struct reg regs;
 267   long retval;
 268   int i;
 269   int errorp;
 270   struct syscall *sc;
 271
 272   if (fsc.name == NULL)
 273         return (-1);
 274
 275   cpid = trussinfo->curthread->tid;
 276
 277   if (ptrace(PT_GETREGS, cpid, (caddr_t)&regs, 0) < 0) {
 278     fprintf(trussinfo->outfile, "\n");
 279     return (-1);
 280   }
 281   retval = regs.fixreg[3];
 282   errorp = !!(regs.cr & 0x10000000);
 283
 284   /*
 285    * This code, while simpler than the initial versions I used, could
 286    * stand some significant cleaning.
 287    */
 288
 289   sc = fsc.sc;
 290   if (!sc) {
 291     for (i = 0; i < fsc.nargs; i++)
 292       asprintf(&fsc.s_args[i], "0x%lx", fsc.args[i]);
 293   } else {
 294     /*
 295      * On 32-bit big-endian, the low word of a 64-bit return is
 296      * in the greater address. Switch to this. XXX note that
 297      * print_syscall_ret can't handle 64-bit return values (llseek)
 298      */
 299     if (sc->ret_type == 2)
 300       retval = regs.fixreg[4];
 301
 302     /*
 303      * Here, we only look for arguments that have OUT masked in --
 304      * otherwise, they were handled in the syscall_entry function.
 305      */
 306     for (i = 0; i < sc->nargs; i++) {
 307       char *temp;
 308       if (sc->args[i].type & OUT) {
 309         /*
 310          * If an error occurred, than don't bothe getting the data;
 311          * it may not be valid.
 312          */
 313         if (errorp)
 314           asprintf(&temp, "0x%lx", fsc.args[sc->args[i].offset]);
 315         else
 316           temp = print_arg(&sc->args[i], fsc.args, retval, trussinfo);
 317         fsc.s_args[i] = temp;
 318       }
 319     }
 320   }
 321
 322   if (fsc.name != NULL &&
 323       (!strcmp(fsc.name, "execve") || !strcmp(fsc.name, "exit"))) {
 324         trussinfo->curthread->in_syscall = 1;
 325   }
 326
 327
 328   /*
 329    * It would probably be a good idea to merge the error handling,
 330    * but that complicates things considerably.
 331    */
 332
 333   print_syscall_ret(trussinfo, fsc.name, fsc.nargs, fsc.s_args, errorp,
 334                     retval, fsc.sc);
 335   clear_fsc();
 336
 337   return (retval);
 338 }