xref: /freebsd/usr.bin/truss/truss.h (revision ea825d02749f382c3f7e17f28247f20a48733eab)
1 /*
2  * Copyright 2001 Jamey Wood
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  *
13  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23  * SUCH DAMAGE.
24  *
25  * $FreeBSD$
26  */
27 
28 #include <sys/linker_set.h>
29 #include <sys/queue.h>
30 
31 #define	FOLLOWFORKS		0x00000001
32 #define	RELATIVETIMESTAMPS	0x00000002
33 #define	ABSOLUTETIMESTAMPS	0x00000004
34 #define	NOSIGS			0x00000008
35 #define	EXECVEARGS		0x00000010
36 #define	EXECVEENVS		0x00000020
37 #define	COUNTONLY		0x00000040
38 #define	DISPLAYTIDS		0x00000080
39 
40 struct procinfo;
41 struct syscall;
42 struct trussinfo;
43 
44 /*
45  * The lookup of normal system calls are optimized by using a fixed
46  * array for the first 1024 system calls that can be indexed directly.
47  * Unknown system calls with other IDs are stored in a linked list.
48  */
49 #define	SYSCALL_NORMAL_COUNT	1024
50 
51 struct extra_syscall {
52 	STAILQ_ENTRY(extra_syscall) entries;
53 	struct syscall *sc;
54 	u_int number;
55 };
56 
57 struct procabi {
58 	const char *type;
59 	enum sysdecode_abi abi;
60 	int (*fetch_args)(struct trussinfo *, u_int);
61 	int (*fetch_retval)(struct trussinfo *, long *, int *);
62 	STAILQ_HEAD(, extra_syscall) extra_syscalls;
63 	struct syscall *syscalls[SYSCALL_NORMAL_COUNT];
64 };
65 
66 #define	PROCABI(abi)	DATA_SET(procabi, abi)
67 
68 /*
69  * This is confusingly named.  It holds per-thread state about the
70  * currently executing system call.  syscall.h defines a struct
71  * syscall that holds metadata used to format system call arguments.
72  *
73  * NB: args[] stores the raw argument values (e.g. from registers)
74  * passed to the system call.  s_args[] stores a string representation
75  * of a system call's arguments.  These do not necessarily map one to
76  * one.  A system call description may omit individual arguments
77  * (padding) or combine adjacent arguments (e.g. when passing an off_t
78  * argument on a 32-bit system).  The nargs member contains the count
79  * of valid pointers in s_args[], not args[].
80  */
81 struct current_syscall {
82 	struct syscall *sc;
83 	unsigned int number;
84 	unsigned int nargs;
85 	unsigned long args[10];
86 	char *s_args[10];	/* the printable arguments */
87 };
88 
89 struct threadinfo
90 {
91 	LIST_ENTRY(threadinfo) entries;
92 	struct procinfo *proc;
93 	lwpid_t tid;
94 	int in_syscall;
95 	struct current_syscall cs;
96 	struct timespec before;
97 	struct timespec after;
98 };
99 
100 struct procinfo {
101 	LIST_ENTRY(procinfo) entries;
102 	pid_t pid;
103 	struct procabi *abi;
104 
105 	LIST_HEAD(, threadinfo) threadlist;
106 };
107 
108 struct trussinfo
109 {
110 	int flags;
111 	int strsize;
112 	FILE *outfile;
113 
114 	struct timespec start_time;
115 
116 	struct threadinfo *curthread;
117 
118 	LIST_HEAD(, procinfo) proclist;
119 };
120 
121 #define	timespecsubt(tvp, uvp, vvp)					\
122 	do {								\
123 		(vvp)->tv_sec = (tvp)->tv_sec - (uvp)->tv_sec;		\
124 		(vvp)->tv_nsec = (tvp)->tv_nsec - (uvp)->tv_nsec;	\
125 		if ((vvp)->tv_nsec < 0) {				\
126 			(vvp)->tv_sec--;				\
127 			(vvp)->tv_nsec += 1000000000;			\
128 		}							\
129 	} while (0)
130 
131 #define	timespecadd(tvp, uvp, vvp)					\
132 	do {								\
133 		(vvp)->tv_sec = (tvp)->tv_sec + (uvp)->tv_sec;		\
134 		(vvp)->tv_nsec = (tvp)->tv_nsec + (uvp)->tv_nsec;	\
135 		if ((vvp)->tv_nsec > 1000000000) {				\
136 			(vvp)->tv_sec++;				\
137 			(vvp)->tv_nsec -= 1000000000;			\
138 		}							\
139 	} while (0)
140