]> granicus.if.org Git - strace/blob - defs.h
2003-01-13 Roland McGrath <roland@redhat.com>
[strace] / defs.h
1 /*
2  * Copyright (c) 1991, 1992 Paul Kranenburg <pk@cs.few.eur.nl>
3  * Copyright (c) 1993 Branko Lankester <branko@hacktic.nl>
4  * Copyright (c) 1993, 1994, 1995, 1996 Rick Sladkey <jrs@world.std.com>
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. The name of the author may not be used to endorse or promote products
16  *    derived from this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  *
29  *      $Id$
30  */
31
32 #ifdef linux
33 #include <features.h>
34 #endif
35
36 #ifdef HAVE_CONFIG_H
37 #include "config.h"
38 #endif
39
40 /* configuration section */
41 #ifndef MAX_QUALS
42 #if defined(LINUX) && defined(MIPS)
43 #define MAX_QUALS       5000    /* maximum number of syscalls, signals, etc. */
44 #else
45 #define MAX_QUALS       2048    /* maximum number of syscalls, signals, etc. */
46 #endif
47 #endif
48 #ifndef DEFAULT_STRLEN
49 #define DEFAULT_STRLEN  32      /* default maximum # of bytes printed in
50                                   `printstr', change with `-s' switch */
51 #endif
52 #ifndef DEFAULT_ACOLUMN
53 #define DEFAULT_ACOLUMN 40      /* default alignment column for results */
54 #endif
55 #ifndef MAX_ARGS
56 #define MAX_ARGS        32      /* maximum number of args to a syscall */
57 #endif
58 #ifndef DEFAULT_SORTBY
59 #define DEFAULT_SORTBY "time"   /* default sorting method for call profiling */
60 #endif
61
62 #include <sys/types.h>
63 #include <unistd.h>
64 #include <stdlib.h>
65 #include <stdio.h>
66 #include <ctype.h>
67 #include <string.h>
68 #include <time.h>
69 #include <sys/time.h>
70 #include <errno.h>
71
72 #ifdef STDC_HEADERS
73 #include <stddef.h>
74 #endif /* STDC_HEADERS */
75
76 #ifdef HAVE_SIGINFO_T
77 #include <signal.h>
78 #endif
79
80 #if defined(LINUX)
81 #  if defined(SPARC)
82 #     define LINUXSPARC
83 #  endif
84 #  if defined(ALPHA)
85 #     define LINUX_64BIT
86 #  endif
87 #  if defined(X86_64)
88 #     define LINUX_X86_64
89 #  endif
90 #endif
91
92 #if defined(SVR4) || defined(FREEBSD)
93 #define USE_PROCFS
94 #else
95 #undef USE_PROCFS
96 #endif
97
98 #ifdef FREEBSD
99 #ifndef I386
100 #error "FreeBSD support is only for i386 arch right now."
101 #endif
102 #include <machine/psl.h>
103 #include <machine/reg.h>
104 #include <sys/syscall.h>
105 #endif
106
107 #ifdef USE_PROCFS
108 #include <sys/procfs.h>
109 #ifdef HAVE_MP_PROCFS
110 #include <sys/uio.h>
111 #endif
112 #ifdef FREEBSD
113 #include <sys/pioctl.h>
114 #endif /* FREEBSD */
115 #else /* !USE_PROCFS */
116 #if (defined(LINUXSPARC) || defined (LINUX_X86_64)) && defined(__GLIBC__)
117 #include <sys/ptrace.h>
118 #else
119 /* Work around awkward prototype in ptrace.h. */
120 #define ptrace xptrace
121 #include <sys/ptrace.h>
122 #undef ptrace
123 #ifdef POWERPC
124 #define __KERNEL__
125 #include <asm/ptrace.h>
126 #undef __KERNEL__
127 #endif
128 #ifdef __STDC__
129 #ifdef LINUX
130 extern long ptrace(int, int, char *, long);
131 #else /* !LINUX */
132 extern int ptrace(int, int, char *, int, ...);
133 #endif /* !LINUX */
134 #else /* !__STDC__ */
135 extern int ptrace();
136 #endif /* !__STDC__ */
137 #endif /* !LINUXSPARC */
138 #endif /* !SVR4 */
139
140 #ifdef LINUX
141 #if !defined(__GLIBC__)
142 #define PTRACE_PEEKUSER PTRACE_PEEKUSR
143 #define PTRACE_POKEUSER PTRACE_POKEUSR
144 #endif
145 #ifdef ALPHA
146 #  define REG_R0 0
147 #  define REG_A0 16
148 #  define REG_A3 19
149 #  define REG_FP 30
150 #  define REG_PC 64
151 #endif /* ALPHA */
152 #ifdef MIPS
153 #  define REG_V0 2
154 #  define REG_A0 4
155 #  define REG_A3 7
156 #  define REG_SP 29
157 #  define REG_EPC 64
158 #endif /* MIPS */
159 #ifdef HPPA
160 #  define PT_GR20 (20*4)
161 #  define PT_GR26 (26*4)
162 #  define PT_GR28 (28*4)
163 #  define PT_IAOQ0 (106*4)
164 #  define PT_IAOQ1 (107*4)
165 #endif /* HPPA */
166 #endif /* LINUX */
167
168 #define SUPPORTED_PERSONALITIES 1
169 #define DEFAULT_PERSONALITY 0
170
171 #ifdef LINUXSPARC
172 #include <linux/a.out.h>
173 #include <asm/psr.h>
174 #undef  SUPPORTED_PERSONALITIES
175 #define SUPPORTED_PERSONALITIES 2
176 #endif /* LINUXSPARC */
177
178 #ifdef X86_64
179 #undef SUPPORTED_PERSONALITIES
180 #define SUPPORTED_PERSONALITIES 2
181 #endif
182
183 #ifdef SVR4
184 #ifdef HAVE_MP_PROCFS
185 extern int mp_ioctl (int f, int c, void *a, int s);
186 #define IOCTL(f,c,a)    mp_ioctl (f, c, a, sizeof *a)
187 #define IOCTL_STATUS(t) \
188          pread (t->pfd_stat, &t->status, sizeof t->status, 0)
189 #define IOCTL_WSTOP(t)                                          \
190         (IOCTL (t->pfd, PCWSTOP, (char *)NULL) < 0 ? -1 :               \
191          IOCTL_STATUS (t))
192 #define PR_WHY          pr_lwp.pr_why
193 #define PR_WHAT         pr_lwp.pr_what
194 #define PR_REG          pr_lwp.pr_context.uc_mcontext.gregs
195 #define PR_FLAGS        pr_lwp.pr_flags
196 #define PR_SYSCALL      pr_lwp.pr_syscall
197 #define PR_INFO         pr_lwp.pr_info
198 #define PIOCSTIP        PCSTOP
199 #define PIOCSET         PCSET
200 #define PIOCRESET       PCRESET
201 #define PIOCSTRACE      PCSTRACE
202 #define PIOCSFAULT      PCSFAULT
203 #define PIOCWSTOP       PCWSTOP
204 #define PIOCSTOP        PCSTOP
205 #define PIOCSENTRY      PCSENTRY
206 #define PIOCSEXIT       PCSEXIT
207 #define PIOCRUN         PCRUN
208 #else
209 #define IOCTL           ioctl
210 #define IOCTL_STATUS(t) ioctl (t->pfd, PIOCSTATUS, &t->status)
211 #define IOCTL_WSTOP(t)  ioctl (t->pfd, PIOCWSTOP, &t->status)
212 #define PR_WHY          pr_why
213 #define PR_WHAT         pr_what
214 #define PR_REG          pr_reg
215 #define PR_FLAGS        pr_flags
216 #define PR_SYSCALL      pr_syscall
217 #define PR_INFO         pr_info
218 #endif
219 #endif
220 #ifdef FREEBSD
221 #define IOCTL           ioctl
222 #define IOCTL_STATUS(t) ioctl (t->pfd, PIOCSTATUS, &t->status)
223 #define IOCTL_WSTOP(t)  ioctl (t->pfd, PIOCWAIT, &t->status)
224 #define PIOCRUN         PIOCCONT
225 #define PIOCWSTOP       PIOCWAIT
226 #define PR_WHY          why
227 #define PR_WHAT         val
228 #define PR_FLAGS        state
229 /* from /usr/src/sys/miscfs/procfs/procfs_vnops.c,
230    status.state = 0 for running, 1 for stopped */
231 #define PR_ASLEEP       1
232 #define PR_SYSENTRY     S_SCE
233 #define PR_SYSEXIT      S_SCX
234 #define PR_SIGNALLED    S_SIG
235 #define PR_FAULTED      S_CORE
236 #endif
237
238 /* Trace Control Block */
239 struct tcb {
240         short flags;            /* See below for TCB_ values */
241         int pid;                /* Process Id of this entry */
242         long scno;              /* System call number */
243         int u_nargs;            /* System call arguments */
244         long u_arg[MAX_ARGS];   /* System call arguments */
245         int u_error;            /* Error code */
246         long u_rval;            /* (first) return value */
247 #ifdef HAVE_LONG_LONG
248         long long u_lrval;      /* long long return value */
249 #endif
250         FILE *outf;             /* Output file for this process */
251         const char *auxstr;     /* Auxiliary info from syscall (see RVAL_STR) */
252         struct timeval stime;   /* System time usage as of last process wait */
253         struct timeval dtime;   /* Delta for system time usage */
254         struct timeval etime;   /* Syscall entry time */
255                                 /* Support for tracing forked processes */
256         struct tcb *parent;     /* Parent of this process */
257         int nchildren;          /* # of traced children */
258         int waitpid;            /* pid(s) this process is waiting for */
259 #ifdef LINUX
260         int nclone_threads;     /* # of nchildren with CLONE_THREAD */
261         int nclone_detached;    /* # of nchildren with CLONE_DETACHED */
262         int nclone_waiting;     /* clone threads in wait4 (TCB_SUSPENDED) */
263 #endif
264                                 /* (1st arg of wait4()) */
265         long baddr;             /* `Breakpoint' address */
266         long inst[2];           /* Instructions on above */
267         int pfd;                /* proc file descriptor */
268 #ifdef SVR4
269 #ifdef HAVE_MP_PROCFS
270         int pfd_stat;
271         int pfd_as;
272         pstatus_t status;
273 #else
274         prstatus_t status;      /* procfs status structure */
275 #endif
276 #endif
277 #ifdef FREEBSD
278         struct procfs_status status;
279         int pfd_reg;
280         int pfd_status;
281 #endif
282 };
283
284 /* TCB flags */
285 #define TCB_STARTUP     00001   /* We have just begun ptracing this process */
286 #define TCB_INUSE       00002   /* This table entry is in use */
287 #define TCB_INSYSCALL   00004   /* A system call is in progress */
288 #define TCB_ATTACHED    00010   /* Process is not our own child */
289 #define TCB_EXITING     00020   /* As far as we know, this process is exiting */
290 #define TCB_SUSPENDED   00040   /* Process has done a wait(4), that can
291                                    not be allowed to complete just now */
292 #define TCB_BPTSET      00100   /* "Breakpoint" set after fork(2) */
293 #define TCB_SIGTRAPPED  00200   /* Process wanted to block SIGTRAP */
294 #define TCB_FOLLOWFORK  00400   /* Process should have forks followed */
295 #define TCB_REPRINT     01000   /* We should reprint this syscall on exit */
296 #ifdef LINUX
297 # if defined(ALPHA) || defined(SPARC) || defined(POWERPC) || defined(IA64) || defined(HPPA) || defined(SH)
298 #  define TCB_WAITEXECVE 02000  /* ignore SIGTRAP after exceve */
299 # endif
300 # define TCB_CLONE_DETACHED 04000 /* CLONE_DETACHED set in creating syscall */
301 # define TCB_CLONE_THREAD  010000 /* CLONE_THREAD set in creating syscall */
302 # define TCB_GROUP_EXITING 020000 /* TCB_EXITING was exit_group, not _exit */
303 # include <sys/syscall.h>
304 # ifndef __NR_exit_group
305 # /* Hack: Most headers around are too old to have __NR_exit_group.  */
306 #  ifdef ALPHA
307 #   define __NR_exit_group 405
308 #  elif defined I386
309 #   define __NR_exit_group 252
310 #  elif defined IA64
311 #   define __NR_exit_group 1236
312 #  elif defined POWERPC
313 #   define __NR_exit_group 234
314 #  elif defined S390 || defined S390X
315 #   define __NR_exit_group 248
316 #  elif defined SPARC
317 #   define __NR_exit_group 188
318 #  endif /* ALPHA et al */
319 # endif /* !__NR_exit_group */
320 #endif /* LINUX */
321
322 /* qualifier flags */
323 #define QUAL_TRACE      0001    /* this system call should be traced */
324 #define QUAL_ABBREV     0002    /* abbreviate the structures of this syscall */
325 #define QUAL_VERBOSE    0004    /* decode the structures of this syscall */
326 #define QUAL_RAW        0010    /* print all args in hex for this syscall */
327 #define QUAL_SIGNAL     0020    /* report events with this signal */
328 #define QUAL_FAULT      0040    /* report events with this fault */
329 #define QUAL_READ       0100    /* dump data read on this file descriptor */
330 #define QUAL_WRITE      0200    /* dump data written to this file descriptor */
331
332 #define entering(tcp)   (!((tcp)->flags & TCB_INSYSCALL))
333 #define exiting(tcp)    ((tcp)->flags & TCB_INSYSCALL)
334 #define syserror(tcp)   ((tcp)->u_error != 0)
335 #define verbose(tcp)    (qual_flags[(tcp)->scno] & QUAL_VERBOSE)
336 #define abbrev(tcp)     (qual_flags[(tcp)->scno] & QUAL_ABBREV)
337
338 struct xlat {
339         int val;
340         char *str;
341 };
342
343 /* Format of syscall return values */
344 #define RVAL_DECIMAL    000     /* decimal format */
345 #define RVAL_HEX        001     /* hex format */
346 #define RVAL_OCTAL      002     /* octal format */
347 #define RVAL_UDECIMAL   003     /* unsigned decimal format */
348 #define RVAL_LDECIMAL   004     /* long decimal format */
349 #define RVAL_LHEX       005     /* long hex format */
350 #define RVAL_LOCTAL     006     /* long octal format */
351 #define RVAL_LUDECIMAL  007     /* long unsigned decimal format */
352 #define RVAL_MASK       007     /* mask for these values */
353
354 #define RVAL_STR        010     /* Print `auxstr' field after return val */
355 #define RVAL_NONE       020     /* Print nothing */
356
357 #ifndef offsetof
358 #define offsetof(type, member)  (((char *) &(((type *) NULL)->member)) - \
359                                  ((char *) (type *) NULL))
360 #endif /* !offsetof */
361
362 /* get offset of member within a user struct */
363 #define uoff(member)    offsetof(struct user, member)
364
365 #define TRACE_FILE      001     /* Trace file-related syscalls. */
366 #define TRACE_IPC       002     /* Trace IPC-related syscalls. */
367 #define TRACE_NETWORK   004     /* Trace network-related syscalls. */
368 #define TRACE_PROCESS   010     /* Trace process-related syscalls. */
369 #define TRACE_SIGNAL    020     /* Trace signal-related syscalls. */
370
371 extern struct tcb **tcbtab;
372 extern int qual_flags[];
373 extern int debug, followfork, followvfork;
374 extern int rflag, tflag, dtime, cflag, xflag, qflag;
375 extern int acolumn;
376 extern char *outfname;
377 extern unsigned int nprocs, tcbtabsize;
378 extern int max_strlen;
379 extern struct tcb *tcp_last;
380
381 #ifdef __STDC__
382 #define P(args) args
383 #else
384 #define P(args) ()
385 #endif
386
387 extern int set_personality P((int personality));
388 extern char *xlookup P((struct xlat *, int));
389 extern struct tcb *alloctcb P((int));
390 extern struct tcb *pid2tcb P((int));
391 extern void droptcb P((struct tcb *));
392
393 extern void set_sortby P((char *));
394 extern void set_overhead P((int));
395 extern void qualify P((char *));
396 extern void newoutf P((struct tcb *));
397 extern int get_scno P((struct tcb *));
398 extern int trace_syscall P((struct tcb *));
399 extern void printxval P((struct xlat *, int, char *));
400 extern int printargs P((struct tcb *));
401 extern int addflags P((struct xlat *, int));
402 extern int printflags P((struct xlat *, int));
403 extern int umoven P((struct tcb *, long, int, char *));
404 extern int umovestr P((struct tcb *, long, int, char *));
405 extern int upeek P((int, long, long *));
406 extern void dumpiov P((struct tcb *, int, long));
407 extern void dumpstr P((struct tcb *, long, int));
408 extern void string_quote P((char *str));
409 extern void printstr P((struct tcb *, long, int));
410 extern void printnum P((struct tcb *, long, char *));
411 extern void printpath P((struct tcb *, long));
412 extern void printpathn P((struct tcb *, long, int));
413 extern void printtv P((struct tcb *, long));
414 #ifdef HAVE_SIGINFO_T
415 extern void printsiginfo P((siginfo_t *, int));
416 #endif
417 extern void printsock P((struct tcb *, long, int));
418 extern void print_sock_optmgmt P((struct tcb *, long, int));
419 extern void printrusage P((struct tcb *, long));
420 extern int clearbpt P((struct tcb *));
421 extern int setbpt P((struct tcb *));
422 extern int sigishandled P((struct tcb *, int));
423 extern void printcall P((struct tcb *));
424 extern char *signame P((int));
425 extern void printsignal P((int));
426 extern void printleader P((struct tcb *));
427 extern void printtrailer P((struct tcb *));
428 extern void tabto P((int));
429 extern void call_summary P((FILE *));
430 extern void fake_execve P((struct tcb *, char *, char *[], char *[]));
431 extern void printtv32 P((struct tcb*, long));
432 extern void tprint_iov P((struct tcb *, int, long));
433
434 #ifdef LINUX
435 extern int internal_clone P((struct tcb *));
436 #endif
437 extern int internal_fork P((struct tcb *));
438 extern int internal_exec P((struct tcb *));
439 extern int internal_wait P((struct tcb *));
440 extern int internal_exit P((struct tcb *));
441
442 extern char *ioctl_lookup P((long));
443 extern int ioctl_decode P((struct tcb *, long, long));
444 extern int term_ioctl P((struct tcb *, long, long));
445 extern int sock_ioctl P((struct tcb *, long, long));
446 extern int proc_ioctl P((struct tcb *, int, int));
447 extern int stream_ioctl P((struct tcb *, int, int));
448
449 extern void tv_tv P((struct timeval *, int, int));
450 extern int tv_nz P((struct timeval *));
451 extern int tv_cmp P((struct timeval *, struct timeval *));
452 extern double tv_float P((struct timeval *));
453 extern void tv_add P((struct timeval *, struct timeval *, struct timeval *));
454 extern void tv_sub P((struct timeval *, struct timeval *, struct timeval *));
455 extern void tv_mul P((struct timeval *, struct timeval *, int));
456 extern void tv_div P((struct timeval *, struct timeval *, int));
457
458 #ifdef SUNOS4
459 extern int fixvfork P((struct tcb *));
460 #endif
461 #if !(defined(LINUX) && !defined(SPARC))
462 extern long getrval2 P((struct tcb *));
463 #endif
464 #ifdef USE_PROCFS
465 extern int proc_open P((struct tcb *tcp, int attaching));
466 #endif
467
468 #define umove(pid, addr, objp)  \
469         umoven((pid), (addr), sizeof *(objp), (char *) (objp))
470
471 #ifdef __STDC__
472 #ifdef __GNUC__
473 extern void tprintf(const char *fmt, ...)
474         __attribute__ ((format (printf, 1, 2)));
475 #else
476 extern void tprintf(const char *fmt, ...);
477 #endif
478 #else
479 extern void tprintf();
480 #endif
481
482 #ifndef HAVE_STRERROR
483 const char *strerror P((int));
484 #endif
485 #ifndef HAVE_STRSIGNAL
486 const char *strsignal P((int));
487 #endif
488
489 extern int current_personality;
490
491 struct sysent {
492         int     nargs;
493         int     sys_flags;
494         int     (*sys_func)();
495         char    *sys_name;
496 };
497
498 extern struct sysent *sysent;
499 extern int nsyscalls;
500
501 extern char **errnoent;
502 extern int nerrnos;
503
504 struct ioctlent {
505         char *doth;
506         char *symbol;
507         unsigned long code;
508 };
509
510 extern struct ioctlent *ioctlent;
511 extern int nioctlent;
512
513 extern char **signalent;
514 extern int nsignals;
515
516 extern struct ioctlent *ioctlent;
517 extern int nioctlents;
518 extern char **signalent;
519 extern int nsignals;
520
521 extern struct ioctlent ioctlent0[];
522 extern int nioctlents0;
523 extern char *signalent0[];
524 extern int nsignals0;
525
526 #if SUPPORTED_PERSONALITIES >= 2
527 extern struct ioctlent ioctlent1[];
528 extern int nioctlents1;
529 extern char *signalent1[];
530 extern int nsignals1;
531 #endif /* SUPPORTED_PERSONALITIES >= 2 */
532
533 #if SUPPORTED_PERSONALITIES >= 3
534 extern struct ioctlent ioctlent2[];
535 extern int nioctlents2;
536 extern char *signalent2[];
537 extern int nsignals2;
538 #endif /* SUPPORTED_PERSONALITIES >= 3 */
539
540 #if FREEBSD
541 /* ARRGH!  off_t args are aligned on 64 bit boundaries! */
542 #define ALIGN64(tcp,arg)                                                \
543 do {                                                                    \
544         if (arg % 2)                                                    \
545             memmove (&tcp->u_arg[arg], &tcp->u_arg[arg + 1],            \
546                      (tcp->u_nargs - arg - 1) * sizeof tcp->u_arg[0]);  \
547 } while (0)
548 #elif defined(LINUX) && defined(POWERPC) && !defined(__powerpc64__)
549 #define ALIGN64(tcp,arg)                                                \
550 do {                                                                    \
551         if (!(arg % 2))                                                 \
552             memmove (&tcp->u_arg[arg], &tcp->u_arg[arg + 1],            \
553                      (tcp->u_nargs - arg - 1) * sizeof tcp->u_arg[0]);  \
554 } while (0)
555 #else
556 #define ALIGN64(tcp,arg) do { } while (0)
557 #endif
558
559 #if HAVE_LONG_LONG
560
561 /* _l refers to the lower numbered u_arg,
562  * _h refers to the higher numbered u_arg
563  */
564
565 #if HAVE_LITTLE_ENDIAN_LONG_LONG
566 #define LONG_LONG(_l,_h) \
567     ((long long)((unsigned long long)(unsigned)(_l) | ((unsigned long long)(_h)<<32)))
568 #else
569 #define LONG_LONG(_l,_h) \
570     ((long long)((unsigned long long)(unsigned)(_h) | ((unsigned long long)(_l)<<32)))
571 #endif
572 #endif
573
574 #ifdef IA64
575 extern long ia32;
576 #endif
577
578 extern int not_failing_only;