usr.bin/truss/main.c

   1 /*-
   2  * Copyright 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 #include <sys/cdefs.h>
  33 __FBSDID("$FreeBSD$");
  34
  35 /*
  36  * The main module for truss.  Surprisingly simple, but, then, the other
  37  * files handle the bulk of the work.  And, of course, the kernel has to
  38  * do a lot of the work :).
  39  */
  40
  41 #include <sys/param.h>
  42 #include <sys/types.h>
  43 #include <sys/time.h>
  44 #include <sys/resource.h>
  45 #include <sys/sysctl.h>
  46 #include <sys/wait.h>
  47
  48 #include <err.h>
  49 #include <errno.h>
  50 #include <fcntl.h>
  51 #include <signal.h>
  52 #include <stdio.h>
  53 #include <stdlib.h>
  54 #include <string.h>
  55 #include <time.h>
  56 #include <unistd.h>
  57
  58 #include "truss.h"
  59 #include "extern.h"
  60 #include "syscall.h"
  61
  62 #define MAXARGS 6
  63
  64 static void
  65 usage(void)
  66 {
  67         fprintf(stderr, "%s\n%s\n",
  68             "usage: truss [-cfaedDS] [-o file] [-s strsize] -p pid",
  69             "       truss [-cfaedDS] [-o file] [-s strsize] command [args]");
  70         exit(1);
  71 }
  72
  73 /*
  74  * WARNING! "FreeBSD a.out" must be first, or set_etype will not
  75  * work correctly.
  76  */
  77 static struct ex_types {
  78         const char *type;
  79         void (*enter_syscall)(struct trussinfo *, int);
  80         long (*exit_syscall)(struct trussinfo *, int);
  81 } ex_types[] = {
  82 #ifdef __arm__
  83         { "FreeBSD ELF32", arm_syscall_entry, arm_syscall_exit },
  84 #endif
  85 #ifdef __amd64__
  86         { "FreeBSD ELF64", amd64_syscall_entry, amd64_syscall_exit },
  87         { "FreeBSD ELF32", amd64_fbsd32_syscall_entry, amd64_fbsd32_syscall_exit },
  88         { "Linux ELF32", amd64_linux32_syscall_entry, amd64_linux32_syscall_exit },
  89 #endif
  90 #ifdef __i386__
  91         { "FreeBSD a.out", i386_syscall_entry, i386_syscall_exit },
  92         { "FreeBSD ELF", i386_syscall_entry, i386_syscall_exit },
  93         { "FreeBSD ELF32", i386_syscall_entry, i386_syscall_exit },
  94         { "Linux ELF", i386_linux_syscall_entry, i386_linux_syscall_exit },
  95 #endif
  96 #ifdef __powerpc__
  97         { "FreeBSD ELF", powerpc_syscall_entry, powerpc_syscall_exit },
  98         { "FreeBSD ELF32", powerpc_syscall_entry, powerpc_syscall_exit },
  99 #ifdef __powerpc64__
 100         { "FreeBSD ELF64", powerpc64_syscall_entry, powerpc64_syscall_exit },
 101 #endif
 102 #endif
 103 #ifdef __sparc64__
 104         { "FreeBSD ELF64", sparc64_syscall_entry, sparc64_syscall_exit },
 105 #endif
 106 #ifdef __mips__
 107         { "FreeBSD ELF", mips_syscall_entry, mips_syscall_exit },
 108         { "FreeBSD ELF32", mips_syscall_entry, mips_syscall_exit },
 109         { "FreeBSD ELF64", mips_syscall_entry, mips_syscall_exit }, // XXX
 110 #endif
 111         { 0, 0, 0 },
 112 };
 113
 114 /*
 115  * Set the execution type.  This is called after every exec, and when
 116  * a process is first monitored.
 117  */
 118
 119 static struct ex_types *
 120 set_etype(struct trussinfo *trussinfo)
 121 {
 122         struct ex_types *funcs;
 123         size_t len;
 124         int error;
 125         int mib[4];
 126         char progt[32];
 127
 128         len = sizeof(progt);
 129         mib[0] = CTL_KERN;
 130         mib[1] = KERN_PROC;
 131         mib[2] = KERN_PROC_SV_NAME;
 132         mib[3] = trussinfo->pid;
 133         error = sysctl(mib, 4, progt, &len, NULL, 0);
 134         if (error != 0)
 135                 err(2, "can not get etype");
 136
 137         for (funcs = ex_types; funcs->type; funcs++)
 138                 if (strcmp(funcs->type, progt) == 0)
 139                         break;
 140
 141         if (funcs->type == NULL) {
 142                 funcs = &ex_types[0];
 143                 warn("execution type %s is not supported -- using %s",
 144                     progt, funcs->type);
 145         }
 146         return (funcs);
 147 }
 148
 149 char *
 150 strsig(int sig)
 151 {
 152         char *ret;
 153
 154         ret = NULL;
 155         if (sig > 0 && sig < NSIG) {
 156                 asprintf(&ret, "SIG%s", sys_signame[sig]);
 157                 if (ret == NULL)
 158                         return (NULL);
 159         }
 160         return (ret);
 161 }
 162
 163 int
 164 main(int ac, char **av)
 165 {
 166         struct timespec timediff;
 167         struct sigaction sa;
 168         struct ex_types *funcs;
 169         struct trussinfo *trussinfo;
 170         char *fname;
 171         char *signame;
 172         char **command;
 173         pid_t childpid;
 174         int c, initial_open, status;
 175
 176         fname = NULL;
 177         initial_open = 1;
 178
 179         /* Initialize the trussinfo struct */
 180         trussinfo = (struct trussinfo *)calloc(1, sizeof(struct trussinfo));
 181         if (trussinfo == NULL)
 182                 errx(1, "calloc() failed");
 183
 184         trussinfo->outfile = stderr;
 185         trussinfo->strsize = 32;
 186         trussinfo->pr_why = S_NONE;
 187         trussinfo->curthread = NULL;
 188         SLIST_INIT(&trussinfo->threadlist);
 189         while ((c = getopt(ac, av, "p:o:facedDs:S")) != -1) {
 190                 switch (c) {
 191                 case 'p':       /* specified pid */
 192                         trussinfo->pid = atoi(optarg);
 193                         /* make sure i don't trace me */
 194                         if (trussinfo->pid == getpid()) {
 195                                 fprintf(stderr, "attempt to grab self.\n");
 196                                 exit(2);
 197                         }
 198                         break;
 199                 case 'f': /* Follow fork()'s */
 200                         trussinfo->flags |= FOLLOWFORKS;
 201                         break;
 202                 case 'a': /* Print execve() argument strings. */
 203                         trussinfo->flags |= EXECVEARGS;
 204                         break;
 205                 case 'c': /* Count number of system calls and time. */
 206                         trussinfo->flags |= COUNTONLY;
 207                         break;
 208                 case 'e': /* Print execve() environment strings. */
 209                         trussinfo->flags |= EXECVEENVS;
 210                         break;
 211                 case 'd': /* Absolute timestamps */
 212                         trussinfo->flags |= ABSOLUTETIMESTAMPS;
 213                         break;
 214                 case 'D': /* Relative timestamps */
 215                         trussinfo->flags |= RELATIVETIMESTAMPS;
 216                         break;
 217                 case 'o':       /* Specified output file */
 218                         fname = optarg;
 219                         break;
 220                 case 's':       /* Specified string size */
 221                         trussinfo->strsize = atoi(optarg);
 222                         break;
 223                 case 'S':       /* Don't trace signals */
 224                         trussinfo->flags |= NOSIGS;
 225                         break;
 226                 default:
 227                         usage();
 228                 }
 229         }
 230
 231         ac -= optind; av += optind;
 232         if ((trussinfo->pid == 0 && ac == 0) ||
 233             (trussinfo->pid != 0 && ac != 0))
 234                 usage();
 235
 236         if (fname != NULL) { /* Use output file */
 237                 /*
 238                  * Set close-on-exec ('e'), so that the output file is not
 239                  * shared with the traced process.
 240                  */
 241                 if ((trussinfo->outfile = fopen(fname, "we")) == NULL)
 242                         err(1, "cannot open %s", fname);
 243         }
 244
 245         /*
 246          * If truss starts the process itself, it will ignore some signals --
 247          * they should be passed off to the process, which may or may not
 248          * exit.  If, however, we are examining an already-running process,
 249          * then we restore the event mask on these same signals.
 250          */
 251
 252         if (trussinfo->pid == 0) {      /* Start a command ourselves */
 253                 command = av;
 254                 trussinfo->pid = setup_and_wait(command);
 255                 signal(SIGINT, SIG_IGN);
 256                 signal(SIGTERM, SIG_IGN);
 257                 signal(SIGQUIT, SIG_IGN);
 258         } else {
 259                 sa.sa_handler = restore_proc;
 260                 sa.sa_flags = 0;
 261                 sigemptyset(&sa.sa_mask);
 262                 sigaction(SIGINT, &sa, NULL);
 263                 sigaction(SIGQUIT, &sa, NULL);
 264                 sigaction(SIGTERM, &sa, NULL);
 265                 start_tracing(trussinfo->pid);
 266         }
 267
 268
 269         /*
 270          * At this point, if we started the process, it is stopped waiting to
 271          * be woken up, either in exit() or in execve().
 272          */
 273
 274 START_TRACE:
 275         funcs = set_etype(trussinfo);
 276
 277         initial_open = 0;
 278         /*
 279          * At this point, it's a simple loop, waiting for the process to
 280          * stop, finding out why, printing out why, and then continuing it.
 281          * All of the grunt work is done in the support routines.
 282          */
 283
 284         clock_gettime(CLOCK_REALTIME, &trussinfo->start_time);
 285
 286         do {
 287                 waitevent(trussinfo);
 288
 289                 switch (trussinfo->pr_why) {
 290                 case S_SCE:
 291                         funcs->enter_syscall(trussinfo, MAXARGS);
 292                         clock_gettime(CLOCK_REALTIME,
 293                             &trussinfo->curthread->before);
 294                         break;
 295                 case S_SCX:
 296                         clock_gettime(CLOCK_REALTIME,
 297                             &trussinfo->curthread->after);
 298
 299                         if (trussinfo->curthread->in_fork &&
 300                             (trussinfo->flags & FOLLOWFORKS)) {
 301                                 trussinfo->curthread->in_fork = 0;
 302                                 childpid = funcs->exit_syscall(trussinfo,
 303                                     trussinfo->pr_data);
 304
 305                                 /*
 306                                  * Fork a new copy of ourself to trace
 307                                  * the child of the original traced
 308                                  * process.
 309                                  */
 310                                 if (fork() == 0) {
 311                                         trussinfo->pid = childpid;
 312                                         start_tracing(trussinfo->pid);
 313                                         goto START_TRACE;
 314                                 }
 315                                 break;
 316                         }
 317                         funcs->exit_syscall(trussinfo, MAXARGS);
 318                         break;
 319                 case S_SIG:
 320                         if (trussinfo->flags & NOSIGS)
 321                                 break;
 322                         if (trussinfo->flags & FOLLOWFORKS)
 323                                 fprintf(trussinfo->outfile, "%5d: ",
 324                                     trussinfo->pid);
 325                         if (trussinfo->flags & ABSOLUTETIMESTAMPS) {
 326                                 timespecsubt(&trussinfo->curthread->after,
 327                                     &trussinfo->start_time, &timediff);
 328                                 fprintf(trussinfo->outfile, "%ld.%09ld ",
 329                                     (long)timediff.tv_sec,
 330                                     timediff.tv_nsec);
 331                         }
 332                         if (trussinfo->flags & RELATIVETIMESTAMPS) {
 333                                 timespecsubt(&trussinfo->curthread->after,
 334                                     &trussinfo->curthread->before, &timediff);
 335                                 fprintf(trussinfo->outfile, "%ld.%09ld ",
 336                                     (long)timediff.tv_sec,
 337                                     timediff.tv_nsec);
 338                         }
 339                         signame = strsig(trussinfo->pr_data);
 340                         fprintf(trussinfo->outfile,
 341                             "SIGNAL %u (%s)\n", trussinfo->pr_data,
 342                             signame == NULL ? "?" : signame);
 343                         free(signame);
 344                         break;
 345                 case S_EXIT:
 346                         if (trussinfo->flags & COUNTONLY)
 347                                 break;
 348                         if (trussinfo->flags & FOLLOWFORKS)
 349                                 fprintf(trussinfo->outfile, "%5d: ",
 350                                     trussinfo->pid);
 351                         if (trussinfo->flags & ABSOLUTETIMESTAMPS) {
 352                                 timespecsubt(&trussinfo->curthread->after,
 353                                     &trussinfo->start_time, &timediff);
 354                                 fprintf(trussinfo->outfile, "%ld.%09ld ",
 355                                     (long)timediff.tv_sec,
 356                                     timediff.tv_nsec);
 357                         }
 358                         if (trussinfo->flags & RELATIVETIMESTAMPS) {
 359                                 timespecsubt(&trussinfo->curthread->after,
 360                                     &trussinfo->curthread->before, &timediff);
 361                                 fprintf(trussinfo->outfile, "%ld.%09ld ",
 362                                     (long)timediff.tv_sec, timediff.tv_nsec);
 363                         }
 364                         fprintf(trussinfo->outfile,
 365                             "process exit, rval = %u\n", trussinfo->pr_data);
 366                         break;
 367                 default:
 368                         break;
 369                 }
 370         } while (trussinfo->pr_why != S_EXIT &&
 371             trussinfo->pr_why != S_DETACHED);
 372
 373         if (trussinfo->flags & FOLLOWFORKS) {
 374                 do {
 375                         childpid = wait(&status);
 376                 } while (childpid != -1);
 377         }
 378
 379         if (trussinfo->flags & COUNTONLY)
 380                 print_summary(trussinfo);
 381
 382         fflush(trussinfo->outfile);
 383
 384         return (0);
 385 }