9efa0569700682635964f9ea72ba279616ad415c
[dragonfly.git] / usr.bin / truss / main.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  * $FreeBSD: src/usr.bin/truss/main.c,v 1.15.2.3 2002/05/16 23:41:23 peter Exp $
32  * $DragonFly: src/usr.bin/truss/main.c,v 1.5 2005/05/28 00:22:04 swildner Exp $
33  */
34
35 /*
36  * The main module for truss.  Suprisingly 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/ioctl.h>
43 #include <sys/pioctl.h>
44 #include <sys/ucred.h>
45 #include <sys/mount.h>
46
47 #include <err.h>
48 #include <errno.h>
49 #include <fcntl.h>
50 #include <signal.h>
51 #include <stdio.h>
52 #include <stdlib.h>
53 #include <string.h>
54 #include <unistd.h>
55
56 #include "truss.h"
57 #include "extern.h"
58
59 /*
60  * These should really be parameterized -- I don't like having globals,
61  * but this is the easiest way, right now, to deal with them.
62  */
63
64 int Procfd;
65
66 static inline void
67 usage(void)
68 {
69   fprintf(stderr, "%s\n%s\n",
70         "usage: truss [-S] [-o file] -p pid",
71         "       truss [-S] [-o file] command [args]");
72   exit(1);
73 }
74
75 /*
76  * WARNING! "FreeBSD a.out" must be first, or set_etype will not
77  * work correctly.
78  */
79 struct ex_types {
80   const char *type;
81   void (*enter_syscall)(struct trussinfo *, int);
82   int (*exit_syscall)(struct trussinfo *, int);
83 } ex_types[] = {
84 #ifdef __i386__
85   { "FreeBSD a.out", i386_syscall_entry, i386_syscall_exit },
86   { "FreeBSD ELF32", i386_syscall_entry, i386_syscall_exit },
87   { "Linux ELF32", i386_linux_syscall_entry, i386_linux_syscall_exit },
88 #endif
89   { 0, 0, 0 },
90 };
91
92 /*
93  * Set the execution type.  This is called after every exec, and when
94  * a process is first monitored.  The procfs pseudo-file "etype" has
95  * the execution module type -- see /proc/curproc/etype for an example.
96  */
97
98 static struct ex_types *
99 set_etype(struct trussinfo *trussinfo) {
100   struct ex_types *funcs;
101   char *etype;
102   char progt[32];
103   int fd;
104
105   asprintf(&etype, "%s/%d/etype", procfs_path, trussinfo->pid);
106   if (etype == NULL)
107     err(1, "Out of memory");
108   if ((fd = open(etype, O_RDONLY)) == -1) {
109     strcpy(progt, "FreeBSD a.out");
110   } else {
111     int len = read(fd, progt, sizeof(progt));
112     progt[len-1] = '\0';
113     close(fd);
114   }
115   free(etype);
116
117   for (funcs = ex_types; funcs->type; funcs++)
118     if (!strcmp(funcs->type, progt))
119       break;
120
121   if (funcs->type == NULL) {
122     funcs = &ex_types[0];
123     warn("Execution type %s is not supported -- using %s\n",
124       progt, funcs->type);
125   }
126   return funcs;
127 }
128
129 int
130 main(int ac, char **av) {
131   int c, i, mntsize;
132   char **command;
133   struct procfs_status pfs;
134   struct ex_types *funcs;
135   struct statfs *mntbuf;
136   int in_exec = 0;
137   char *fname = NULL;
138   int sigexit = 0;
139   struct trussinfo *trussinfo;
140
141   /* Initialize the trussinfo struct */
142   trussinfo = (struct trussinfo *)malloc(sizeof(struct trussinfo));
143   if (trussinfo == NULL)
144           errx(1, "malloc() failed");
145   bzero(trussinfo, sizeof(struct trussinfo));
146   trussinfo->outfile = stderr;
147
148   /* Check where procfs is mounted if it is mounted */
149   if ((mntsize = getmntinfo(&mntbuf, MNT_NOWAIT)) == 0)
150           err(1, "getmntinfo");
151   for (i = 0; i < mntsize; i++) {
152           if (strcasecmp(mntbuf[i].f_mntfromname, "procfs") == 0) {
153                   strlcpy(procfs_path, mntbuf[i].f_mntonname, sizeof(procfs_path));
154                   have_procfs = 1;
155                   break;
156           }
157   }
158   if (!have_procfs) {
159           errno = 2;
160           err(1, "You must have a mounted procfs to use truss");
161   }
162
163   while ((c = getopt(ac, av, "p:o:S")) != -1) {
164     switch (c) {
165     case 'p':   /* specified pid */
166       trussinfo->pid = atoi(optarg);
167       if (trussinfo->pid == getpid()) {
168               /* make sure truss doesn't trace itself */
169               fprintf(stderr, "truss: attempt to self trace: %d\n", trussinfo->pid);
170               exit(2);
171       }
172       break;
173     case 'o':   /* Specified output file */
174       fname = optarg;
175       break;
176     case 'S':   /* Don't trace signals */ 
177       trussinfo->flags |= NOSIGS;
178       break;
179     default:
180       usage();
181     }
182   }
183
184   ac -= optind; av += optind;
185   if ((trussinfo->pid == 0 && ac == 0) || (trussinfo->pid != 0 && ac != 0))
186     usage();
187
188   if (fname != NULL) { /* Use output file */
189     if ((trussinfo->outfile = fopen(fname, "w")) == NULL)
190       errx(1, "cannot open %s", fname);
191   }
192
193   /*
194    * If truss starts the process itself, it will ignore some signals --
195    * they should be passed off to the process, which may or may not
196    * exit.  If, however, we are examining an already-running process,
197    * then we restore the event mask on these same signals.
198    */
199
200   if (trussinfo->pid == 0) {    /* Start a command ourselves */
201     command = av;
202     trussinfo->pid = setup_and_wait(command);
203     signal(SIGINT, SIG_IGN);
204     signal(SIGTERM, SIG_IGN);
205     signal(SIGQUIT, SIG_IGN);
206   } else {
207     signal(SIGINT, restore_proc);
208     signal(SIGTERM, restore_proc);
209     signal(SIGQUIT, restore_proc);
210   }
211
212
213   /*
214    * At this point, if we started the process, it is stopped waiting to
215    * be woken up, either in exit() or in execve().
216    */
217
218   Procfd = start_tracing(
219       trussinfo->pid, S_EXEC | S_SCE | S_SCX | S_CORE | S_EXIT |
220                      ((trussinfo->flags & NOSIGS) ? 0 : S_SIG));
221   if (Procfd == -1)
222     return 0;
223
224   pfs.why = 0;
225
226   funcs = set_etype(trussinfo);
227   /*
228    * At this point, it's a simple loop, waiting for the process to
229    * stop, finding out why, printing out why, and then continuing it.
230    * All of the grunt work is done in the support routines.
231    */
232
233   do {
234     int val = 0;
235
236     if (ioctl(Procfd, PIOCWAIT, &pfs) == -1)
237       warn("PIOCWAIT top of loop");
238     else {
239       switch(i = pfs.why) {
240       case S_SCE:
241         funcs->enter_syscall(trussinfo, pfs.val);
242         break;
243       case S_SCX:
244         /*
245          * This is so we don't get two messages for an exec -- one
246          * for the S_EXEC, and one for the syscall exit.  It also,
247          * conveniently, ensures that the first message printed out
248          * isn't the return-from-syscall used to create the process.
249          */
250
251         if (in_exec) {
252           in_exec = 0;
253           break;
254         }
255         funcs->exit_syscall(trussinfo, pfs.val);
256         break;
257       case S_SIG:
258         fprintf(trussinfo->outfile, "SIGNAL %lu\n", pfs.val);
259         sigexit = pfs.val;
260         break;
261       case S_EXIT:
262         fprintf (trussinfo->outfile, "process exit, rval = %lu\n", pfs.val);
263         break;
264       case S_EXEC:
265         funcs = set_etype(trussinfo);
266         in_exec = 1;
267         break;
268       default:
269         fprintf (trussinfo->outfile, "Process stopped because of:  %d\n", i);
270         break;
271       }
272     }
273     if (ioctl(Procfd, PIOCCONT, val) == -1) {
274       if (kill(trussinfo->pid, 0) == -1 && errno == ESRCH)
275         break;
276       else
277         warn("PIOCCONT");
278     }
279   } while (pfs.why != S_EXIT);
280   fflush(trussinfo->outfile);
281   if (sigexit) {
282     if (sigexit == SIGQUIT)
283       exit(sigexit);
284     (void) signal(sigexit, SIG_DFL);
285     (void) kill(getpid(), sigexit);
286   }
287   return 0;
288 }