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