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