xref: /freebsd/lib/libsysdecode/sysdecode.h (revision ddfc6f84f24215b418af19260e9156219f6df03e)
1 /*-
2  * Copyright (c) 2015 John H. Baldwin <jhb@FreeBSD.org>
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 
26 #ifndef __SYSDECODE_H__
27 #define	__SYSDECODE_H__
28 
29 #include <sys/types.h>
30 #include <stdbool.h>
31 #include <stdio.h>
32 
33 enum sysdecode_abi {
34 	SYSDECODE_ABI_UNKNOWN = 0,
35 	SYSDECODE_ABI_FREEBSD,
36 	SYSDECODE_ABI_FREEBSD32,
37 	SYSDECODE_ABI_LINUX,
38 	SYSDECODE_ABI_LINUX32,
39 };
40 
41 int	sysdecode_abi_to_freebsd_errno(enum sysdecode_abi _abi, int _error);
42 bool	sysdecode_access_mode(FILE *_fp, int _mode, int *_rem);
43 const char *sysdecode_acltype(int _type);
44 const char *sysdecode_atfd(int _fd);
45 bool	sysdecode_atflags(FILE *_fp, int _flags, int *_rem);
46 bool	sysdecode_cap_fcntlrights(FILE *_fp, uint32_t _rights, uint32_t *_rem);
47 void	sysdecode_cap_rights(FILE *_fp, cap_rights_t *_rightsp);
48 bool	sysdecode_close_range_flags(FILE *_fp, int _flags, int *_rem);
49 const char *sysdecode_cmsg_type(int _cmsg_level, int _cmsg_type);
50 const char *sysdecode_extattrnamespace(int _namespace);
51 const char *sysdecode_fadvice(int _advice);
52 void	sysdecode_fcntl_arg(FILE *_fp, int _cmd, uintptr_t _arg, int _base);
53 bool	sysdecode_fcntl_arg_p(int _cmd);
54 const char *sysdecode_fcntl_cmd(int _cmd);
55 bool	sysdecode_fcntl_fileflags(FILE *_fp, int _flags, int *_rem);
56 bool	sysdecode_fileflags(FILE *_fp, fflags_t _flags, fflags_t *_rem);
57 bool	sysdecode_filemode(FILE *_fp, int _mode, int *_rem);
58 bool	sysdecode_flock_operation(FILE *_fp, int _operation, int *_rem);
59 int	sysdecode_freebsd_to_abi_errno(enum sysdecode_abi _abi, int _error);
60 const char *sysdecode_getfsstat_mode(int _mode);
61 const char *sysdecode_getrusage_who(int _who);
62 const char *sysdecode_idtype(int _idtype);
63 const char *sysdecode_ioctlname(unsigned long _val);
64 const char *sysdecode_ipproto(int _protocol);
65 void	sysdecode_kevent_fflags(FILE *_fp, short _filter, int _fflags,
66 	    int _base);
67 const char *sysdecode_itimer(int _which);
68 const char *sysdecode_kevent_filter(int _filter);
69 bool	sysdecode_kevent_flags(FILE *_fp, int _flags, int *_rem);
70 const char *sysdecode_kldsym_cmd(int _cmd);
71 const char *sysdecode_kldunload_flags(int _flags);
72 const char *sysdecode_lio_listio_mode(int _mode);
73 const char *sysdecode_madvice(int _advice);
74 const char *sysdecode_minherit_inherit(int _inherit);
75 const char *sysdecode_msgctl_cmd(int _cmd);
76 bool	sysdecode_mlockall_flags(FILE *_fp, int _flags, int *_rem);
77 bool	sysdecode_mmap_flags(FILE *_fp, int _flags, int *_rem);
78 bool	sysdecode_mmap_prot(FILE *_fp, int _prot, int *_rem);
79 bool	sysdecode_mount_flags(FILE *_fp, int _flags, int *_rem);
80 bool	sysdecode_msg_flags(FILE *_fp, int _flags, int *_rem);
81 bool	sysdecode_msync_flags(FILE *_fp, int _flags, int *_rem);
82 const char *sysdecode_nfssvc_flags(int _flags);
83 bool	sysdecode_open_flags(FILE *_fp, int _flags, int *_rem);
84 const char *sysdecode_pathconf_name(int _name);
85 bool	sysdecode_pipe2_flags(FILE *_fp, int _flags, int *_rem);
86 bool	sysdecode_pollfd_events(FILE *fp, int flags, int *rem);
87 const char *sysdecode_prio_which(int _which);
88 const char *sysdecode_procctl_cmd(int _cmd);
89 const char *sysdecode_ptrace_request(int _request);
90 bool	sysdecode_quotactl_cmd(FILE *_fp, int _cmd);
91 bool	sysdecode_reboot_howto(FILE *_fp, int _howto, int *_rem);
92 bool	sysdecode_rfork_flags(FILE *_fp, int _flags, int *_rem);
93 const char *sysdecode_rlimit(int _resource);
94 const char *sysdecode_rtprio_function(int _function);
95 const char *sysdecode_scheduler_policy(int _policy);
96 bool	sysdecode_sctp_nxt_flags(FILE *_fp, int _flags, int *_rem);
97 const char *sysdecode_sctp_pr_policy(int _policy);
98 bool	sysdecode_sctp_rcv_flags(FILE *_fp, int _flags, int *_rem);
99 void	sysdecode_sctp_sinfo_flags(FILE *_fp, int _sinfo_flags);
100 bool	sysdecode_sctp_snd_flags(FILE *_fp, int _flags, int *_rem);
101 const char *sysdecode_semctl_cmd(int _cmd);
102 bool	sysdecode_semget_flags(FILE *_fp, int _flag, int *_rem);
103 bool	sysdecode_sendfile_flags(FILE *_fp, int _flags, int *_rem);
104 bool	sysdecode_shmat_flags(FILE *_fp, int _flags, int *_rem);
105 const char *sysdecode_shmctl_cmd(int _cmd);
106 const char *sysdecode_shutdown_how(int _how);
107 const char *sysdecode_sigbus_code(int _si_code);
108 const char *sysdecode_sigchld_code(int _si_code);
109 const char *sysdecode_sigcode(int _sig, int _si_code);
110 const char *sysdecode_sigfpe_code(int _si_code);
111 const char *sysdecode_sigill_code(int _si_code);
112 const char *sysdecode_signal(int _sig);
113 const char *sysdecode_sigprocmask_how(int _how);
114 const char *sysdecode_sigsegv_code(int _si_code);
115 const char *sysdecode_sigtrap_code(int _si_code);
116 const char *sysdecode_sockaddr_family(int _sa_family);
117 const char *sysdecode_socketdomain(int _domain);
118 const char *sysdecode_socket_protocol(int _domain, int _protocol);
119 bool	sysdecode_socket_type(FILE *_fp, int _type, int *_rem);
120 const char *sysdecode_sockopt_level(int _level);
121 const char *sysdecode_sockopt_name(int _level, int _optname);
122 const char *sysdecode_syscallname(enum sysdecode_abi _abi, unsigned int _code);
123 const char *sysdecode_sysarch_number(int _number);
124 bool	sysdecode_thr_create_flags(FILE *_fp, int _flags, int *_rem);
125 bool	sysdecode_umtx_cvwait_flags(FILE *_fp, u_long _flags, u_long *_rem);
126 const char *sysdecode_umtx_op(int _op);
127 bool	sysdecode_umtx_op_flags(FILE *_fp, int op, int *_rem);
128 bool	sysdecode_umtx_rwlock_flags(FILE *_fp, u_long _flags, u_long *_rem);
129 int	sysdecode_utrace(FILE *_fp, void *_buf, size_t _len);
130 bool	sysdecode_vmprot(FILE *_fp, int _type, int *_rem);
131 const char *sysdecode_vmresult(int _result);
132 bool	sysdecode_wait4_options(FILE *_fp, int _options, int *_rem);
133 bool	sysdecode_wait6_options(FILE *_fp, int _options, int *_rem);
134 const char *sysdecode_whence(int _whence);
135 bool	sysdecode_shmflags(FILE *_fp, int _flags, int *_rem);
136 
137 #if defined(__i386__) || defined(__amd64__) || defined(__aarch64__)
138 
139 #define	SYSDECODE_HAVE_LINUX
140 
141 bool	sysdecode_linux_atflags(FILE *_fp, int _flag, int *_rem);
142 void	sysdecode_linux_clockid(FILE *_fp, clockid_t _which);
143 bool	sysdecode_linux_clock_flags(FILE *_fp, int _flags, int *_rem);
144 bool	sysdecode_linux_clone_flags(FILE *_fp, int _flags, int *_rem);
145 bool	sysdecode_linux_open_flags(FILE *_fp, int _flags, int *_rem);
146 const char *sysdecode_linux_signal(int _sig);
147 const char *sysdecode_linux_sigprocmask_how(int _how);
148 
149 #endif /* __i386__ || __amd64__ || __aarch64__ */
150 
151 #endif /* !__SYSDECODE_H__ */
152