Syscall.h 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517
  1. /*
  2. * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
  3. * All rights reserved.
  4. *
  5. * Redistribution and use in source and binary forms, with or without
  6. * modification, are permitted provided that the following conditions are met:
  7. *
  8. * 1. Redistributions of source code must retain the above copyright notice, this
  9. * list of conditions and the following disclaimer.
  10. *
  11. * 2. Redistributions in binary form must reproduce the above copyright notice,
  12. * this list of conditions and the following disclaimer in the documentation
  13. * and/or other materials provided with the distribution.
  14. *
  15. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  16. * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  18. * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  19. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  21. * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  22. * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  23. * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  24. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25. */
  26. #pragma once
  27. #include <AK/Types.h>
  28. #ifdef __serenity__
  29. # include <LibC/fd_set.h>
  30. #endif
  31. constexpr int syscall_vector = 0x82;
  32. extern "C" {
  33. struct pollfd;
  34. struct timeval;
  35. struct timespec;
  36. struct sockaddr;
  37. struct siginfo;
  38. typedef u32 socklen_t;
  39. }
  40. namespace Kernel {
  41. #define ENUMERATE_SYSCALLS \
  42. __ENUMERATE_SYSCALL(sleep) \
  43. __ENUMERATE_SYSCALL(yield) \
  44. __ENUMERATE_SYSCALL(open) \
  45. __ENUMERATE_SYSCALL(close) \
  46. __ENUMERATE_SYSCALL(read) \
  47. __ENUMERATE_SYSCALL(lseek) \
  48. __ENUMERATE_SYSCALL(kill) \
  49. __ENUMERATE_SYSCALL(getuid) \
  50. __ENUMERATE_SYSCALL(exit) \
  51. __ENUMERATE_SYSCALL(geteuid) \
  52. __ENUMERATE_SYSCALL(getegid) \
  53. __ENUMERATE_SYSCALL(getgid) \
  54. __ENUMERATE_SYSCALL(getpid) \
  55. __ENUMERATE_SYSCALL(getppid) \
  56. __ENUMERATE_SYSCALL(getresuid) \
  57. __ENUMERATE_SYSCALL(getresgid) \
  58. __ENUMERATE_SYSCALL(waitid) \
  59. __ENUMERATE_SYSCALL(mmap) \
  60. __ENUMERATE_SYSCALL(munmap) \
  61. __ENUMERATE_SYSCALL(get_dir_entries) \
  62. __ENUMERATE_SYSCALL(getcwd) \
  63. __ENUMERATE_SYSCALL(gettimeofday) \
  64. __ENUMERATE_SYSCALL(gethostname) \
  65. __ENUMERATE_SYSCALL(sethostname) \
  66. __ENUMERATE_SYSCALL(chdir) \
  67. __ENUMERATE_SYSCALL(uname) \
  68. __ENUMERATE_SYSCALL(set_mmap_name) \
  69. __ENUMERATE_SYSCALL(readlink) \
  70. __ENUMERATE_SYSCALL(write) \
  71. __ENUMERATE_SYSCALL(ttyname_r) \
  72. __ENUMERATE_SYSCALL(stat) \
  73. __ENUMERATE_SYSCALL(getsid) \
  74. __ENUMERATE_SYSCALL(setsid) \
  75. __ENUMERATE_SYSCALL(getpgid) \
  76. __ENUMERATE_SYSCALL(setpgid) \
  77. __ENUMERATE_SYSCALL(getpgrp) \
  78. __ENUMERATE_SYSCALL(fork) \
  79. __ENUMERATE_SYSCALL(execve) \
  80. __ENUMERATE_SYSCALL(dup) \
  81. __ENUMERATE_SYSCALL(dup2) \
  82. __ENUMERATE_SYSCALL(sigaction) \
  83. __ENUMERATE_SYSCALL(umask) \
  84. __ENUMERATE_SYSCALL(getgroups) \
  85. __ENUMERATE_SYSCALL(setgroups) \
  86. __ENUMERATE_SYSCALL(sigreturn) \
  87. __ENUMERATE_SYSCALL(sigprocmask) \
  88. __ENUMERATE_SYSCALL(sigpending) \
  89. __ENUMERATE_SYSCALL(pipe) \
  90. __ENUMERATE_SYSCALL(killpg) \
  91. __ENUMERATE_SYSCALL(seteuid) \
  92. __ENUMERATE_SYSCALL(setegid) \
  93. __ENUMERATE_SYSCALL(setuid) \
  94. __ENUMERATE_SYSCALL(setgid) \
  95. __ENUMERATE_SYSCALL(setresuid) \
  96. __ENUMERATE_SYSCALL(setresgid) \
  97. __ENUMERATE_SYSCALL(alarm) \
  98. __ENUMERATE_SYSCALL(fstat) \
  99. __ENUMERATE_SYSCALL(access) \
  100. __ENUMERATE_SYSCALL(fcntl) \
  101. __ENUMERATE_SYSCALL(ioctl) \
  102. __ENUMERATE_SYSCALL(mkdir) \
  103. __ENUMERATE_SYSCALL(times) \
  104. __ENUMERATE_SYSCALL(utime) \
  105. __ENUMERATE_SYSCALL(sync) \
  106. __ENUMERATE_SYSCALL(ptsname_r) \
  107. __ENUMERATE_SYSCALL(select) \
  108. __ENUMERATE_SYSCALL(unlink) \
  109. __ENUMERATE_SYSCALL(poll) \
  110. __ENUMERATE_SYSCALL(rmdir) \
  111. __ENUMERATE_SYSCALL(chmod) \
  112. __ENUMERATE_SYSCALL(usleep) \
  113. __ENUMERATE_SYSCALL(socket) \
  114. __ENUMERATE_SYSCALL(bind) \
  115. __ENUMERATE_SYSCALL(accept) \
  116. __ENUMERATE_SYSCALL(listen) \
  117. __ENUMERATE_SYSCALL(connect) \
  118. __ENUMERATE_SYSCALL(shbuf_create) \
  119. __ENUMERATE_SYSCALL(shbuf_allow_pid) \
  120. __ENUMERATE_SYSCALL(shbuf_get) \
  121. __ENUMERATE_SYSCALL(shbuf_release) \
  122. __ENUMERATE_SYSCALL(link) \
  123. __ENUMERATE_SYSCALL(chown) \
  124. __ENUMERATE_SYSCALL(fchmod) \
  125. __ENUMERATE_SYSCALL(symlink) \
  126. __ENUMERATE_SYSCALL(shbuf_seal) \
  127. __ENUMERATE_SYSCALL(sendto) \
  128. __ENUMERATE_SYSCALL(recvfrom) \
  129. __ENUMERATE_SYSCALL(getsockopt) \
  130. __ENUMERATE_SYSCALL(setsockopt) \
  131. __ENUMERATE_SYSCALL(create_thread) \
  132. __ENUMERATE_SYSCALL(gettid) \
  133. __ENUMERATE_SYSCALL(donate) \
  134. __ENUMERATE_SYSCALL(rename) \
  135. __ENUMERATE_SYSCALL(ftruncate) \
  136. __ENUMERATE_SYSCALL(exit_thread) \
  137. __ENUMERATE_SYSCALL(mknod) \
  138. __ENUMERATE_SYSCALL(writev) \
  139. __ENUMERATE_SYSCALL(beep) \
  140. __ENUMERATE_SYSCALL(getsockname) \
  141. __ENUMERATE_SYSCALL(getpeername) \
  142. __ENUMERATE_SYSCALL(sched_setparam) \
  143. __ENUMERATE_SYSCALL(sched_getparam) \
  144. __ENUMERATE_SYSCALL(fchown) \
  145. __ENUMERATE_SYSCALL(halt) \
  146. __ENUMERATE_SYSCALL(reboot) \
  147. __ENUMERATE_SYSCALL(mount) \
  148. __ENUMERATE_SYSCALL(umount) \
  149. __ENUMERATE_SYSCALL(dump_backtrace) \
  150. __ENUMERATE_SYSCALL(dbgputch) \
  151. __ENUMERATE_SYSCALL(dbgputstr) \
  152. __ENUMERATE_SYSCALL(watch_file) \
  153. __ENUMERATE_SYSCALL(shbuf_allow_all) \
  154. __ENUMERATE_SYSCALL(set_process_icon) \
  155. __ENUMERATE_SYSCALL(mprotect) \
  156. __ENUMERATE_SYSCALL(realpath) \
  157. __ENUMERATE_SYSCALL(get_process_name) \
  158. __ENUMERATE_SYSCALL(fchdir) \
  159. __ENUMERATE_SYSCALL(getrandom) \
  160. __ENUMERATE_SYSCALL(setkeymap) \
  161. __ENUMERATE_SYSCALL(clock_gettime) \
  162. __ENUMERATE_SYSCALL(clock_settime) \
  163. __ENUMERATE_SYSCALL(clock_nanosleep) \
  164. __ENUMERATE_SYSCALL(join_thread) \
  165. __ENUMERATE_SYSCALL(module_load) \
  166. __ENUMERATE_SYSCALL(module_unload) \
  167. __ENUMERATE_SYSCALL(detach_thread) \
  168. __ENUMERATE_SYSCALL(set_thread_name) \
  169. __ENUMERATE_SYSCALL(get_thread_name) \
  170. __ENUMERATE_SYSCALL(madvise) \
  171. __ENUMERATE_SYSCALL(purge) \
  172. __ENUMERATE_SYSCALL(shbuf_set_volatile) \
  173. __ENUMERATE_SYSCALL(profiling_enable) \
  174. __ENUMERATE_SYSCALL(profiling_disable) \
  175. __ENUMERATE_SYSCALL(futex) \
  176. __ENUMERATE_SYSCALL(set_thread_boost) \
  177. __ENUMERATE_SYSCALL(set_process_boost) \
  178. __ENUMERATE_SYSCALL(chroot) \
  179. __ENUMERATE_SYSCALL(pledge) \
  180. __ENUMERATE_SYSCALL(unveil) \
  181. __ENUMERATE_SYSCALL(perf_event) \
  182. __ENUMERATE_SYSCALL(shutdown) \
  183. __ENUMERATE_SYSCALL(get_stack_bounds) \
  184. __ENUMERATE_SYSCALL(ptrace) \
  185. __ENUMERATE_SYSCALL(minherit) \
  186. __ENUMERATE_SYSCALL(sendfd) \
  187. __ENUMERATE_SYSCALL(recvfd) \
  188. __ENUMERATE_SYSCALL(sysconf) \
  189. __ENUMERATE_SYSCALL(set_process_name)
  190. namespace Syscall {
  191. enum Function {
  192. #undef __ENUMERATE_SYSCALL
  193. #undef __ENUMERATE_REMOVED_SYSCALL
  194. #define __ENUMERATE_REMOVED_SYSCALL(x) SC_##x,
  195. #define __ENUMERATE_SYSCALL(x) SC_##x,
  196. ENUMERATE_SYSCALLS
  197. #undef __ENUMERATE_SYSCALL
  198. #undef __ENUMERATE_REMOVED_SYSCALL
  199. __Count
  200. };
  201. inline constexpr const char* to_string(Function function)
  202. {
  203. switch (function) {
  204. #undef __ENUMERATE_SYSCALL
  205. #undef __ENUMERATE_REMOVED_SYSCALL
  206. #define __ENUMERATE_REMOVED_SYSCALL(x) \
  207. case SC_##x: \
  208. return #x " (removed)";
  209. #define __ENUMERATE_SYSCALL(x) \
  210. case SC_##x: \
  211. return #x;
  212. ENUMERATE_SYSCALLS
  213. #undef __ENUMERATE_SYSCALL
  214. #undef __ENUMERATE_REMOVED_SYSCALL
  215. default:
  216. break;
  217. }
  218. return "Unknown";
  219. }
  220. #ifdef __serenity__
  221. struct StringArgument {
  222. const char* characters { nullptr };
  223. size_t length { 0 };
  224. };
  225. template<typename DataType, typename SizeType>
  226. struct MutableBufferArgument {
  227. DataType* data { nullptr };
  228. SizeType size { 0 };
  229. };
  230. template<typename DataType, typename SizeType>
  231. struct ImmutableBufferArgument {
  232. const DataType* data { nullptr };
  233. SizeType size { 0 };
  234. };
  235. struct StringListArgument {
  236. StringArgument* strings { nullptr };
  237. size_t length { 0 };
  238. };
  239. struct SC_mmap_params {
  240. uint32_t addr;
  241. uint32_t size;
  242. uint32_t alignment;
  243. int32_t prot;
  244. int32_t flags;
  245. int32_t fd;
  246. int32_t offset; // FIXME: 64-bit off_t?
  247. StringArgument name;
  248. };
  249. struct SC_open_params {
  250. int dirfd;
  251. StringArgument path;
  252. int options;
  253. u16 mode;
  254. };
  255. struct SC_select_params {
  256. int nfds;
  257. fd_set* readfds;
  258. fd_set* writefds;
  259. fd_set* exceptfds;
  260. const struct timespec* timeout;
  261. const u32* sigmask;
  262. };
  263. struct SC_poll_params {
  264. struct pollfd* fds;
  265. unsigned nfds;
  266. const struct timespec* timeout;
  267. const u32* sigmask;
  268. };
  269. struct SC_clock_nanosleep_params {
  270. int clock_id;
  271. int flags;
  272. const struct timespec* requested_sleep;
  273. struct timespec* remaining_sleep;
  274. };
  275. struct SC_sendto_params {
  276. int sockfd;
  277. ImmutableBufferArgument<void, size_t> data;
  278. int flags;
  279. const sockaddr* addr;
  280. socklen_t addr_length;
  281. };
  282. struct SC_recvfrom_params {
  283. int sockfd;
  284. MutableBufferArgument<void, size_t> buffer;
  285. int flags;
  286. sockaddr* addr;
  287. socklen_t* addr_length;
  288. };
  289. struct SC_getsockopt_params {
  290. int sockfd;
  291. int level;
  292. int option;
  293. void* value;
  294. socklen_t* value_size;
  295. };
  296. struct SC_setsockopt_params {
  297. int sockfd;
  298. int level;
  299. int option;
  300. const void* value;
  301. socklen_t value_size;
  302. };
  303. struct SC_getsockname_params {
  304. int sockfd;
  305. sockaddr* addr;
  306. socklen_t* addrlen;
  307. };
  308. struct SC_getpeername_params {
  309. int sockfd;
  310. sockaddr* addr;
  311. socklen_t* addrlen;
  312. };
  313. struct SC_futex_params {
  314. i32* userspace_address;
  315. int futex_op;
  316. i32 val;
  317. const timespec* timeout;
  318. };
  319. struct SC_setkeymap_params {
  320. const u32* map;
  321. const u32* shift_map;
  322. const u32* alt_map;
  323. const u32* altgr_map;
  324. };
  325. struct SC_create_thread_params {
  326. unsigned int m_detach_state = 0; // JOINABLE or DETACHED
  327. int m_schedule_priority = 30; // THREAD_PRIORITY_NORMAL
  328. // FIXME: Implment guard pages in create_thread (unreadable pages at "overflow" end of stack)
  329. // "If an implementation rounds up the value of guardsize to a multiple of {PAGESIZE},
  330. // a call to pthread_attr_getguardsize() specifying attr shall store in the guardsize
  331. // parameter the guard size specified by the previous pthread_attr_setguardsize() function call"
  332. // ... ok, if you say so posix. Guess we get to lie to people about guard page size
  333. unsigned int m_guard_page_size = 0; // Rounded up to PAGE_SIZE
  334. unsigned int m_reported_guard_page_size = 0; // The lie we tell callers
  335. unsigned int m_stack_size = 4 * MB; // Default PTHREAD_STACK_MIN
  336. void* m_stack_location = nullptr; // nullptr means any, o.w. process virtual address
  337. };
  338. struct SC_realpath_params {
  339. StringArgument path;
  340. MutableBufferArgument<char, size_t> buffer;
  341. };
  342. struct SC_set_mmap_name_params {
  343. void* addr;
  344. size_t size;
  345. StringArgument name;
  346. };
  347. struct SC_execve_params {
  348. StringArgument path;
  349. StringListArgument arguments;
  350. StringListArgument environment;
  351. };
  352. struct SC_readlink_params {
  353. StringArgument path;
  354. MutableBufferArgument<char, size_t> buffer;
  355. };
  356. struct SC_link_params {
  357. StringArgument old_path;
  358. StringArgument new_path;
  359. };
  360. struct SC_chown_params {
  361. StringArgument path;
  362. u32 uid;
  363. u32 gid;
  364. };
  365. struct SC_mknod_params {
  366. StringArgument path;
  367. u16 mode;
  368. u32 dev;
  369. };
  370. struct SC_symlink_params {
  371. StringArgument target;
  372. StringArgument linkpath;
  373. };
  374. struct SC_rename_params {
  375. StringArgument old_path;
  376. StringArgument new_path;
  377. };
  378. struct SC_mount_params {
  379. int source_fd;
  380. StringArgument target;
  381. StringArgument fs_type;
  382. int flags;
  383. };
  384. struct SC_pledge_params {
  385. StringArgument promises;
  386. StringArgument execpromises;
  387. };
  388. struct SC_unveil_params {
  389. StringArgument path;
  390. StringArgument permissions;
  391. };
  392. struct SC_waitid_params {
  393. int idtype;
  394. int id;
  395. struct siginfo* infop;
  396. int options;
  397. };
  398. struct SC_stat_params {
  399. StringArgument path;
  400. struct stat* statbuf;
  401. bool follow_symlinks;
  402. };
  403. struct SC_ptrace_params {
  404. int request;
  405. pid_t pid;
  406. u8* addr;
  407. int data;
  408. };
  409. struct SC_ptrace_peek_params {
  410. u32* address;
  411. u32* out_data;
  412. };
  413. void initialize();
  414. int sync();
  415. inline u32 invoke(Function function)
  416. {
  417. u32 result;
  418. asm volatile("int $0x82"
  419. : "=a"(result)
  420. : "a"(function)
  421. : "memory");
  422. return result;
  423. }
  424. template<typename T1>
  425. inline u32 invoke(Function function, T1 arg1)
  426. {
  427. u32 result;
  428. asm volatile("int $0x82"
  429. : "=a"(result)
  430. : "a"(function), "d"((u32)arg1)
  431. : "memory");
  432. return result;
  433. }
  434. template<typename T1, typename T2>
  435. inline u32 invoke(Function function, T1 arg1, T2 arg2)
  436. {
  437. u32 result;
  438. asm volatile("int $0x82"
  439. : "=a"(result)
  440. : "a"(function), "d"((u32)arg1), "c"((u32)arg2)
  441. : "memory");
  442. return result;
  443. }
  444. template<typename T1, typename T2, typename T3>
  445. inline u32 invoke(Function function, T1 arg1, T2 arg2, T3 arg3)
  446. {
  447. u32 result;
  448. asm volatile("int $0x82"
  449. : "=a"(result)
  450. : "a"(function), "d"((u32)arg1), "c"((u32)arg2), "b"((u32)arg3)
  451. : "memory");
  452. return result;
  453. }
  454. #endif
  455. }
  456. #undef __ENUMERATE_SYSCALL
  457. #define __ENUMERATE_SYSCALL(x) using Syscall::SC_##x;
  458. #define __ENUMERATE_REMOVED_SYSCALL(x)
  459. ENUMERATE_SYSCALLS
  460. #undef __ENUMERATE_SYSCALL
  461. #undef __ENUMERATE_REMOVED_SYSCALL
  462. #define syscall Syscall::invoke
  463. }
  464. using namespace Kernel;