usr.bin/truss/ia64-fbsd.c

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