usr.bin/truss/powerpc64-fbsd.c

   1 /*
   2  * Copyright 2006 Peter Grehan <grehan@freebsd.org>
   3  * Copyright 2005 Orlando Bassotto <orlando@break.net>
   4  * Copyright 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 powerpc64_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   cpid = trussinfo->curthread->tid;
 122
 123   clear_fsc();
 124   if (ptrace(PT_GETREGS, cpid, (caddr_t)&regs, 0) < 0) {
 125     fprintf(trussinfo->outfile, "-- CANNOT READ REGISTERS --\n");
 126     return;
 127   }
 128
 129   /*
 130    * FreeBSD has two special kinds of system call redirctions --
 131    * SYS_syscall, and SYS___syscall.  The former is the old syscall()
 132    * routine, basically; the latter is for quad-aligned arguments.
 133    */
 134   regargs = NARGREG;
 135   syscall_num = regs.fixreg[0];
 136   args = &regs.fixreg[3];
 137   if (syscall_num == SYS_syscall || syscall_num == SYS___syscall) {
 138     args = &regs.fixreg[4];
 139     regargs -= 1;
 140     syscall_num = regs.fixreg[3];
 141   }
 142
 143   fsc.number = syscall_num;
 144   fsc.name =
 145     (syscall_num < 0 || syscall_num >= nsyscalls) ? NULL : syscallnames[syscall_num];
 146   if (!fsc.name) {
 147     fprintf(trussinfo->outfile, "-- UNKNOWN SYSCALL %d --\n", syscall_num);
 148   }
 149
 150   if (fsc.name && (trussinfo->flags & FOLLOWFORKS)
 151    && ((!strcmp(fsc.name, "fork")
 152     || !strcmp(fsc.name, "rfork")
 153     || !strcmp(fsc.name, "vfork"))))
 154   {
 155     trussinfo->curthread->in_fork = 1;
 156   }
 157
 158   if (nargs == 0)
 159     return;
 160
 161   fsc.args = malloc((1+nargs) * sizeof(unsigned long));
 162
 163   if (nargs > regargs) {
 164     struct ptrace_io_desc iorequest;
 165     memmove(&fsc.args[0], args, regargs * sizeof(fsc.args[0]));
 166
 167     iorequest.piod_op = PIOD_READ_D;
 168     iorequest.piod_offs = (void *)(regs.fixreg[1] + 48);
 169     iorequest.piod_addr = &fsc.args[regargs];
 170     iorequest.piod_len = (nargs - regargs) * sizeof(fsc.args[0]);
 171     ptrace(PT_IO, cpid, (caddr_t)&iorequest, 0);
 172     if (iorequest.piod_len == 0)
 173        return;
 174   } else {
 175     memmove(&fsc.args[0], args, nargs * sizeof(fsc.args[0]));
 176   }
 177
 178   sc = get_syscall(fsc.name);
 179   if (sc) {
 180     fsc.nargs = sc->nargs;
 181   } else {
 182 #if DEBUG
 183     fprintf(trussinfo->outfile, "unknown syscall %s -- setting args to %d\n",
 184            fsc.name, nargs);
 185 #endif
 186     fsc.nargs = nargs;
 187   }
 188
 189   fsc.s_args = calloc(1, (1+fsc.nargs) * sizeof(char*));
 190   fsc.sc = sc;
 191
 192   /*
 193    * At this point, we set up the system call arguments.
 194    * We ignore any OUT ones, however -- those are arguments that
 195    * are set by the system call, and so are probably meaningless
 196    * now.  This doesn't currently support arguments that are
 197    * passed in *and* out, however.
 198    */
 199
 200   if (fsc.name) {
 201
 202 #if DEBUG
 203     fprintf(stderr, "syscall %s(", fsc.name);
 204 #endif
 205     for (i = 0; i < fsc.nargs; i++) {
 206 #if DEBUG
 207       fprintf(stderr, "0x%x%s",
 208               sc
 209               ? fsc.args[sc->args[i].offset]
 210               : fsc.args[i],
 211               i < (fsc.nargs - 1) ? "," : "");
 212 #endif
 213       if (sc && !(sc->args[i].type & OUT)) {
 214         fsc.s_args[i] = print_arg(&sc->args[i], fsc.args, 0, trussinfo);
 215       }
 216     }
 217 #if DEBUG
 218     fprintf(stderr, ")\n");
 219 #endif
 220   }
 221
 222 #if DEBUG
 223   fprintf(trussinfo->outfile, "\n");
 224 #endif
 225
 226   if (fsc.name && (!strcmp(fsc.name, "execve") || !strcmp(fsc.name, "exit"))) {
 227
 228     /* XXX
 229      * This could be done in a more general
 230      * manner but it still wouldn't be very pretty.
 231      */
 232     if (!strcmp(fsc.name, "execve")) {
 233         if ((trussinfo->flags & EXECVEARGS) == 0)
 234           if (fsc.s_args[1]) {
 235             free(fsc.s_args[1]);
 236             fsc.s_args[1] = NULL;
 237           }
 238         if ((trussinfo->flags & EXECVEENVS) == 0)
 239           if (fsc.s_args[2]) {
 240             free(fsc.s_args[2]);
 241             fsc.s_args[2] = NULL;
 242           }
 243     }
 244   }
 245
 246   return;
 247 }
 248
 249 /*
 250  * And when the system call is done, we handle it here.
 251  * Currently, no attempt is made to ensure that the system calls
 252  * match -- this needs to be fixed (and is, in fact, why S_SCX includes
 253  * the system call number instead of, say, an error status).
 254  */
 255
 256 long
 257 powerpc64_syscall_exit(struct trussinfo *trussinfo, int syscall_num __unused)
 258 {
 259   struct reg regs;
 260   long retval;
 261   int i;
 262   int errorp;
 263   struct syscall *sc;
 264
 265   if (fsc.name == NULL)
 266         return (-1);
 267
 268   cpid = trussinfo->curthread->tid;
 269
 270   if (ptrace(PT_GETREGS, cpid, (caddr_t)&regs, 0) < 0) {
 271     fprintf(trussinfo->outfile, "\n");
 272     return (-1);
 273   }
 274   retval = regs.fixreg[3];
 275   errorp = !!(regs.cr & 0x10000000);
 276
 277   /*
 278    * This code, while simpler than the initial versions I used, could
 279    * stand some significant cleaning.
 280    */
 281
 282   sc = fsc.sc;
 283   if (!sc) {
 284     for (i = 0; i < fsc.nargs; i++)
 285       asprintf(&fsc.s_args[i], "0x%lx", fsc.args[i]);
 286   } else {
 287     /*
 288      * Here, we only look for arguments that have OUT masked in --
 289      * otherwise, they were handled in the syscall_entry function.
 290      */
 291     for (i = 0; i < sc->nargs; i++) {
 292       char *temp;
 293       if (sc->args[i].type & OUT) {
 294         /*
 295          * If an error occurred, than don't bothe getting the data;
 296          * it may not be valid.
 297          */
 298         if (errorp)
 299           asprintf(&temp, "0x%lx", fsc.args[sc->args[i].offset]);
 300         else
 301           temp = print_arg(&sc->args[i], fsc.args, retval, trussinfo);
 302         fsc.s_args[i] = temp;
 303       }
 304     }
 305   }
 306
 307   if (fsc.name != NULL &&
 308       (!strcmp(fsc.name, "execve") || !strcmp(fsc.name, "exit"))) {
 309         trussinfo->curthread->in_syscall = 1;
 310   }
 311
 312
 313   /*
 314    * It would probably be a good idea to merge the error handling,
 315    * but that complicates things considerably.
 316    */
 317
 318   print_syscall_ret(trussinfo, fsc.name, fsc.nargs, fsc.s_args, errorp,
 319                     retval, fsc.sc);
 320   clear_fsc();
 321
 322   return (retval);
 323 }