xref: /freebsd/usr.bin/truss/syscall.h (revision b2d48be1bc7df45ddd13b143a160d0acb5a383c5)
1 /*
2  * See i386-fbsd.c for copyright and license terms.
3  *
4  * System call arguments come in several flavours:
5  * Hex -- values that should be printed in hex (addresses)
6  * Octal -- Same as above, but octal
7  * Int -- normal integer values (file descriptors, for example)
8  * LongHex -- long value that should be printed in hex
9  * Name -- pointer to a NULL-terminated string.
10  * BinString -- pointer to an array of chars, printed via strvisx().
11  * Ptr -- pointer to some unspecified structure.  Just print as hex for now.
12  * Stat -- a pointer to a stat buffer.  Prints a couple fields.
13  * StatFs -- a pointer to a statfs buffer.  Prints a few fields.
14  * Ioctl -- an ioctl command.  Woefully limited.
15  * Quad -- a double-word value.  e.g., lseek(int, offset_t, int)
16  * Signal -- a signal number.  Prints the signal name (SIGxxx)
17  * Sockaddr -- a pointer to a struct sockaddr.  Prints symbolic AF, and IP:Port
18  * StringArray -- a pointer to an array of string pointers.
19  * Timespec -- a pointer to a struct timespec.  Prints both elements.
20  * Timeval -- a pointer to a struct timeval.  Prints both elements.
21  * Timeval2 -- a pointer to two struct timevals.  Prints both elements of both.
22  * Itimerval -- a pointer to a struct itimerval.  Prints all elements.
23  * Pollfd -- a pointer to an array of struct pollfd.  Prints .fd and .events.
24  * Fd_set -- a pointer to an array of fd_set.  Prints the fds that are set.
25  * Sigaction -- a pointer to a struct sigaction.  Prints all elements.
26  * Sigset -- a pointer to a sigset_t.  Prints the signals that are set.
27  * Sigprocmask -- the first argument to sigprocmask().  Prints the name.
28  * Kevent -- a pointer to an array of struct kevents.  Prints all elements.
29  * Pathconf -- the 2nd argument of pathconf().
30  * Utrace -- utrace(2) buffer.
31  *
32  * In addition, the pointer types (String, Ptr) may have OUT masked in --
33  * this means that the data is set on *return* from the system call -- or
34  * IN (meaning that the data is passed *into* the system call).
35  */
36 /*
37  * $FreeBSD$
38  */
39 
40 enum Argtype { None = 1, Hex, Octal, Int, UInt, LongHex, Name, Ptr, Stat, Ioctl,
41 	Quad, Signal, Sockaddr, StringArray, Timespec, Timeval, Itimerval,
42 	Pollfd, Fd_set, Sigaction, Fcntl, Mprot, Mmapflags, Whence, Readlinkres,
43 	Sigset, Sigprocmask, StatFs, Kevent, Sockdomain, Socktype, Open,
44 	Fcntlflag, Rusage, BinString, Shutdown, Resource, Rlimit, Timeval2,
45 	Pathconf, Rforkflags, ExitStatus, Waitoptions, Idtype, Procctl,
46 	LinuxSockArgs, Umtxop, Atfd, Atflags, Timespec2, Accessmode, Long,
47 	Sysarch, ExecArgs, ExecEnv, PipeFds, QuadHex, Utrace, IntArray,
48 
49 	CloudABIAdvice, CloudABIClockID, ClouduABIFDSFlags,
50 	CloudABIFDStat, CloudABIFileStat, CloudABIFileType,
51 	CloudABIFSFlags, CloudABILookup, CloudABIMFlags, CloudABIMProt,
52 	CloudABIMSFlags, CloudABIOFlags, CloudABISDFlags,
53 	CloudABISignal, CloudABISockStat, CloudABISSFlags,
54 	CloudABITimestamp, CloudABIULFlags, CloudABIWhence };
55 
56 #define	ARG_MASK	0xff
57 #define	OUT	0x100
58 #define	IN	/*0x20*/0
59 
60 struct syscall_args {
61 	enum Argtype type;
62 	int offset;
63 };
64 
65 struct syscall {
66 	STAILQ_ENTRY(syscall) entries;
67 	const char *name;
68 	u_int ret_type;	/* 0, 1, or 2 return values */
69 	u_int nargs;	/* actual number of meaningful arguments */
70 			/* Hopefully, no syscalls with > 10 args */
71 	struct syscall_args args[10];
72 	struct timespec time; /* Time spent for this call */
73 	int ncalls;	/* Number of calls */
74 	int nerror;	/* Number of calls that returned with error */
75 };
76 
77 struct syscall *get_syscall(const char *, int nargs);
78 char *print_arg(struct syscall_args *, unsigned long*, long *, struct trussinfo *);
79 
80 /*
81  * Linux Socket defines
82  */
83 #define LINUX_SOCKET		1
84 #define LINUX_BIND		2
85 #define LINUX_CONNECT		3
86 #define LINUX_LISTEN		4
87 #define LINUX_ACCEPT		5
88 #define LINUX_GETSOCKNAME	6
89 #define LINUX_GETPEERNAME	7
90 #define LINUX_SOCKETPAIR	8
91 #define LINUX_SEND		9
92 #define LINUX_RECV		10
93 #define LINUX_SENDTO		11
94 #define LINUX_RECVFROM		12
95 #define LINUX_SHUTDOWN		13
96 #define LINUX_SETSOCKOPT	14
97 #define LINUX_GETSOCKOPT	15
98 #define LINUX_SENDMSG		16
99 #define LINUX_RECVMSG		17
100 
101 #define PAD_(t) (sizeof(register_t) <= sizeof(t) ? \
102     0 : sizeof(register_t) - sizeof(t))
103 
104 #if BYTE_ORDER == LITTLE_ENDIAN
105 #define PADL_(t)	0
106 #define PADR_(t)	PAD_(t)
107 #else
108 #define PADL_(t)	PAD_(t)
109 #define PADR_(t)	0
110 #endif
111 
112 typedef int     l_int;
113 typedef uint32_t    l_ulong;
114 
115 struct linux_socketcall_args {
116     char what_l_[PADL_(l_int)]; l_int what; char what_r_[PADR_(l_int)];
117     char args_l_[PADL_(l_ulong)]; l_ulong args; char args_r_[PADR_(l_ulong)];
118 };
119 
120 void init_syscalls(void);
121 void print_syscall(struct trussinfo *, const char *, int, char **);
122 void print_syscall_ret(struct trussinfo *, const char *, int, char **, int,
123     long *, struct syscall *);
124 void print_summary(struct trussinfo *trussinfo);
125