usr.bin/truss/sparc64-fbsd.c

   1 /*
   2  * Copyright 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 #include <machine/tstate.h>
  54
  55 #include <err.h>
  56 #include <errno.h>
  57 #include <fcntl.h>
  58 #include <signal.h>
  59 #include <stddef.h>
  60 #include <stdio.h>
  61 #include <stdlib.h>
  62 #include <string.h>
  63 #include <time.h>
  64 #include <unistd.h>
  65
  66 #include "truss.h"
  67 #include "syscall.h"
  68 #include "extern.h"
  69
  70 #include "syscalls.h"
  71
  72 static int nsyscalls = sizeof(syscallnames) / sizeof(syscallnames[0]);
  73
  74 /*
  75  * This is what this particular file uses to keep track of a system call.
  76  * It is probably not quite sufficient -- I can probably use the same
  77  * structure for the various syscall personalities, and I also probably
  78  * need to nest system calls (for signal handlers).
  79  *
  80  * 'struct syscall' describes the system call; it may be NULL, however,
  81  * if we don't know about this particular system call yet.
  82  */
  83 struct freebsd_syscall {
  84         struct syscall *sc;
  85         const char *name;
  86         int number;
  87         unsigned long *args;
  88         int nargs;      /* number of arguments -- *not* number of words! */
  89         char **s_args;  /* the printable arguments */
  90 };
  91
  92 static struct freebsd_syscall *
  93 alloc_fsc(void)
  94 {
  95
  96         return (malloc(sizeof(struct freebsd_syscall)));
  97 }
  98
  99 /* Clear up and free parts of the fsc structure. */
 100 static void
 101 free_fsc(struct freebsd_syscall *fsc)
 102 {
 103         int i;
 104
 105         free(fsc->args);
 106         if (fsc->s_args) {
 107                 for (i = 0; i < fsc->nargs; i++)
 108                         free(fsc->s_args[i]);
 109                 free(fsc->s_args);
 110         }
 111         free(fsc);
 112 }
 113
 114 /*
 115  * Called when a process has entered a system call.  nargs is the
 116  * number of words, not number of arguments (a necessary distinction
 117  * in some cases).  Note that if the STOPEVENT() code in sparc64/sparc64/trap.c
 118  * is ever changed these functions need to keep up.
 119  */
 120
 121 void
 122 sparc64_syscall_entry(struct trussinfo *trussinfo, int nargs)
 123 {
 124         struct ptrace_io_desc iorequest;
 125         struct reg regs;
 126         struct freebsd_syscall *fsc;
 127         struct syscall *sc;
 128         lwpid_t tid;
 129         int i, syscall_num;
 130         int indir;      /* indirect system call */
 131
 132         tid = trussinfo->curthread->tid;
 133
 134         if (ptrace(PT_GETREGS, tid, (caddr_t)&regs, 0) < 0) {
 135                 fprintf(trussinfo->outfile, "-- CANNOT READ REGISTERS --\n");
 136                 return;
 137         }
 138
 139         /*
 140          * FreeBSD has two special kinds of system call redirctions --
 141          * SYS_syscall, and SYS___syscall.  The former is the old syscall()
 142          * routine, basically; the latter is for quad-aligned arguments.
 143          */
 144         indir = 0;
 145         syscall_num = regs.r_global[1];
 146         if (syscall_num == SYS_syscall || syscall_num == SYS___syscall) {
 147                 indir = 1;
 148                 syscall_num = regs.r_out[0];
 149         }
 150
 151         fsc = alloc_fsc();
 152         if (fsc == NULL)
 153                 return;
 154         fsc->number = syscall_num;
 155         fsc->name = (syscall_num < 0 || syscall_num >= nsyscalls) ?
 156             NULL : syscallnames[syscall_num];
 157         if (!fsc->name) {
 158                 fprintf(trussinfo->outfile, "-- UNKNOWN SYSCALL %d --\n",
 159                     syscall_num);
 160         }
 161
 162         if (fsc->name && (trussinfo->flags & FOLLOWFORKS) &&
 163             (strcmp(fsc->name, "fork") == 0 ||
 164             strcmp(fsc->name, "rfork") == 0 ||
 165             strcmp(fsc->name, "vfork") == 0))
 166                 trussinfo->curthread->in_fork = 1;
 167
 168         if (nargs == 0)
 169                 return;
 170
 171         fsc->args = malloc((1 + nargs) * sizeof(unsigned long));
 172         switch (nargs) {
 173         default:
 174                 /*
 175                  * The OS doesn't seem to allow more than 10 words of
 176                  * parameters (yay!).   So we shouldn't be here.
 177                  */
 178                 warn("More than 10 words (%d) of arguments!\n", nargs);
 179                 break;
 180         case 10:
 181         case 9:
 182         case 8:
 183         case 7:
 184                 /*
 185                  * If there are 7-10 words of arguments, they are placed
 186                  * on the stack, as is normal for other processors.
 187                  * The fall-through for all of these is deliberate!!!
 188                  */
 189                 iorequest.piod_op = PIOD_READ_D;
 190                 iorequest.piod_offs = (void *)(regs.r_out[6] + SPOFF +
 191                     offsetof(struct frame, fr_pad[6]));
 192                 iorequest.piod_addr = &fsc->args[6];
 193                 iorequest.piod_len = (nargs - 6) * sizeof(fsc->args[0]);
 194                 ptrace(PT_IO, tid, (caddr_t)&iorequest, 0);
 195                 if (iorequest.piod_len == 0)
 196                         return;
 197         case 6: fsc->args[5] = regs.r_out[5];
 198         case 5: fsc->args[4] = regs.r_out[4];
 199         case 4: fsc->args[3] = regs.r_out[3];
 200         case 3: fsc->args[2] = regs.r_out[2];
 201         case 2: fsc->args[1] = regs.r_out[1];
 202         case 1: fsc->args[0] = regs.r_out[0];
 203         case 0:
 204                 break;
 205         }
 206
 207         if (indir)
 208                 memmove(&fsc->args[0], &fsc->args[1], (nargs - 1) *
 209                     sizeof(fsc->args[0]));
 210
 211         sc = get_syscall(fsc->name);
 212         if (sc)
 213                 fsc->nargs = sc->nargs;
 214         else {
 215 #if DEBUG
 216                 fprintf(trussinfo->outfile, "unknown syscall %s -- setting "
 217                     "args to %d\n", fsc->name, nargs);
 218 #endif
 219                 fsc->nargs = nargs;
 220         }
 221
 222         fsc->s_args = calloc(1, (1 + fsc->nargs) * sizeof(char *));
 223         fsc->sc = sc;
 224
 225         /*
 226          * At this point, we set up the system call arguments.
 227          * We ignore any OUT ones, however -- those are arguments that
 228          * are set by the system call, and so are probably meaningless
 229          * now. This doesn't currently support arguments that are
 230          * passed in *and* out, however.
 231          */
 232
 233         if (fsc->name) {
 234 #if DEBUG
 235                 fprintf(stderr, "syscall %s(", fsc->name);
 236 #endif
 237                 for (i = 0; i < fsc->nargs; i++) {
 238 #if DEBUG
 239                         fprintf(stderr, "0x%x%s", sc ?
 240                             fsc->args[sc->args[i].offset] : fsc->args[i],
 241                             i < (fsc->nargs - 1) ? "," : "");
 242 #endif
 243                         if (sc && !(sc->args[i].type & OUT)) {
 244                                 fsc->s_args[i] = print_arg(&sc->args[i],
 245                                     fsc->args, 0, trussinfo);
 246                         }
 247                 }
 248 #if DEBUG
 249                 fprintf(stderr, ")\n");
 250 #endif
 251         }
 252
 253 #if DEBUG
 254         fprintf(trussinfo->outfile, "\n");
 255 #endif
 256
 257         if (fsc->name != NULL && (strcmp(fsc->name, "execve") == 0 ||
 258             strcmp(fsc->name, "exit") == 0)) {
 259                 /*
 260                  * XXX
 261                  * This could be done in a more general
 262                  * manner but it still wouldn't be very pretty.
 263                  */
 264                 if (strcmp(fsc->name, "execve") == 0) {
 265                         if ((trussinfo->flags & EXECVEARGS) == 0) {
 266                                 if (fsc->s_args[1]) {
 267                                         free(fsc->s_args[1]);
 268                                         fsc->s_args[1] = NULL;
 269                                 }
 270                         }
 271                         if ((trussinfo->flags & EXECVEENVS) == 0) {
 272                                 if (fsc->s_args[2]) {
 273                                         free(fsc->s_args[2]);
 274                                         fsc->s_args[2] = NULL;
 275                                 }
 276                         }
 277                 }
 278         }
 279         trussinfo->curthread->fsc = fsc;
 280 }
 281
 282 /*
 283  * And when the system call is done, we handle it here.
 284  * Currently, no attempt is made to ensure that the system calls
 285  * match -- this needs to be fixed (and is, in fact, why S_SCX includes
 286  * the system call number instead of, say, an error status).
 287  */
 288
 289 long
 290 sparc64_syscall_exit(struct trussinfo *trussinfo, int syscall_num __unused)
 291 {
 292         struct reg regs;
 293         struct freebsd_syscall *fsc;
 294         struct syscall *sc;
 295         lwpid_t tid;
 296         long retval;
 297         int errorp, i;
 298
 299         if (trussinfo->curthread->fsc == NULL)
 300                 return (-1);
 301
 302         tid = trussinfo->curthread->tid;
 303
 304         if (ptrace(PT_GETREGS, tid, (caddr_t)&regs, 0) < 0) {
 305                 fprintf(trussinfo->outfile, "\n");
 306                 return (-1);
 307         }
 308
 309         retval = regs.r_out[0];
 310         errorp = !!(regs.r_tstate & TSTATE_XCC_C);
 311
 312         /*
 313          * This code, while simpler than the initial versions I used, could
 314          * stand some significant cleaning.
 315          */
 316
 317         fsc = trussinfo->curthread->fsc;
 318         sc = fsc->sc;
 319         if (!sc) {
 320                 for (i = 0; i < fsc->nargs; i++)
 321                         asprintf(&fsc->s_args[i], "0x%lx", fsc->args[i]);
 322         } else {
 323                 /*
 324                  * Here, we only look for arguments that have OUT masked in --
 325                  * otherwise, they were handled in the syscall_entry function.
 326                  */
 327                 for (i = 0; i < sc->nargs; i++) {
 328                         char *temp;
 329                         if (sc->args[i].type & OUT) {
 330                                 /*
 331                                  * If an error occurred, then don't bother
 332                                  * getting the data; it may not be valid.
 333                                  */
 334                                 if (errorp) {
 335                                         asprintf(&temp, "0x%lx",
 336                                             fsc->args[sc->args[i].offset]);
 337                                 } else {
 338                                         temp = print_arg(&sc->args[i],
 339                                             fsc->args, retval, trussinfo);
 340                                 }
 341                                 fsc->s_args[i] = temp;
 342                         }
 343                 }
 344         }
 345
 346         if (fsc->name != NULL && (strcmp(fsc->name, "execve") == 0 ||
 347             strcmp(fsc->name, "exit") == 0))
 348                 trussinfo->curthread->in_syscall = 1;
 349
 350         /*
 351          * It would probably be a good idea to merge the error handling,
 352          * but that complicates things considerably.
 353          */
 354
 355         print_syscall_ret(trussinfo, fsc->name, fsc->nargs, fsc->s_args, errorp,
 356             retval, fsc->sc);
 357         free_fsc(fsc);
 358
 359         return (retval);
 360 }