System.h 9.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250
  1. /*
  2. * Copyright (c) 2021, Andreas Kling <kling@serenityos.org>
  3. * Copyright (c) 2021-2022, Kenneth Myhra <kennethmyhra@serenityos.org>
  4. * Copyright (c) 2021, Sam Atkins <atkinssj@serenityos.org>
  5. *
  6. * SPDX-License-Identifier: BSD-2-Clause
  7. */
  8. #pragma once
  9. #include <AK/Error.h>
  10. #include <AK/Noncopyable.h>
  11. #include <AK/OwnPtr.h>
  12. #include <AK/StringView.h>
  13. #include <AK/Vector.h>
  14. #include <dirent.h>
  15. #include <fcntl.h>
  16. #include <grp.h>
  17. #include <netdb.h>
  18. #include <poll.h>
  19. #include <pwd.h>
  20. #include <signal.h>
  21. #include <spawn.h>
  22. #include <sys/ioctl.h>
  23. #include <sys/socket.h>
  24. #include <sys/stat.h>
  25. #include <sys/time.h>
  26. #include <sys/utsname.h>
  27. #include <sys/wait.h>
  28. #include <termios.h>
  29. #include <time.h>
  30. #include <utime.h>
  31. #if !defined(AK_OS_BSD_GENERIC) && !defined(AK_OS_ANDROID)
  32. # include <shadow.h>
  33. #endif
  34. namespace Core::System {
  35. #ifdef AK_OS_SERENITY
  36. ErrorOr<void> beep();
  37. ErrorOr<void> pledge(StringView promises, StringView execpromises = {});
  38. ErrorOr<void> unveil(StringView path, StringView permissions);
  39. ErrorOr<void> unveil_after_exec(StringView path, StringView permissions);
  40. ErrorOr<void> sendfd(int sockfd, int fd);
  41. ErrorOr<int> recvfd(int sockfd, int options);
  42. ErrorOr<void> ptrace_peekbuf(pid_t tid, void const* tracee_addr, Bytes destination_buf);
  43. ErrorOr<void> mount(int source_fd, StringView target, StringView fs_type, int flags);
  44. ErrorOr<void> umount(StringView mount_point);
  45. ErrorOr<long> ptrace(int request, pid_t tid, void* address, void* data);
  46. ErrorOr<void> disown(pid_t pid);
  47. ErrorOr<void> profiling_enable(pid_t, u64 event_mask);
  48. ErrorOr<void> profiling_disable(pid_t);
  49. ErrorOr<void> profiling_free_buffer(pid_t);
  50. #else
  51. inline ErrorOr<void> unveil(StringView, StringView)
  52. {
  53. return {};
  54. }
  55. inline ErrorOr<void> pledge(StringView, StringView = {}) { return {}; }
  56. #endif
  57. template<size_t N>
  58. ALWAYS_INLINE ErrorOr<void> pledge(char const (&promises)[N])
  59. {
  60. return pledge(StringView { promises, N - 1 });
  61. }
  62. template<size_t NPromises, size_t NExecPromises>
  63. ALWAYS_INLINE ErrorOr<void> pledge(char const (&promises)[NPromises], char const (&execpromises)[NExecPromises])
  64. {
  65. return pledge(StringView { promises, NPromises - 1 }, StringView { execpromises, NExecPromises - 1 });
  66. }
  67. template<size_t NPath, size_t NPermissions>
  68. ALWAYS_INLINE ErrorOr<void> unveil(char const (&path)[NPath], char const (&permissions)[NPermissions])
  69. {
  70. return unveil(StringView { path, NPath - 1 }, StringView { permissions, NPermissions - 1 });
  71. }
  72. ALWAYS_INLINE ErrorOr<void> unveil(nullptr_t, nullptr_t)
  73. {
  74. return unveil(StringView {}, StringView {});
  75. }
  76. #if !defined(AK_OS_BSD_GENERIC) && !defined(AK_OS_ANDROID)
  77. ErrorOr<Optional<struct spwd>> getspent();
  78. ErrorOr<Optional<struct spwd>> getspnam(StringView name);
  79. #endif
  80. #ifndef AK_OS_MACOS
  81. ErrorOr<int> accept4(int sockfd, struct sockaddr*, socklen_t*, int flags);
  82. #endif
  83. ErrorOr<void> sigaction(int signal, struct sigaction const* action, struct sigaction* old_action);
  84. #if defined(AK_OS_BSD_GENERIC)
  85. ErrorOr<sig_t> signal(int signal, sig_t handler);
  86. #else
  87. ErrorOr<sighandler_t> signal(int signal, sighandler_t handler);
  88. #endif
  89. ErrorOr<struct stat> fstat(int fd);
  90. ErrorOr<int> fcntl(int fd, int command, ...);
  91. ErrorOr<void*> mmap(void* address, size_t, int protection, int flags, int fd, off_t, size_t alignment = 0, StringView name = {});
  92. ErrorOr<void> munmap(void* address, size_t);
  93. ErrorOr<int> anon_create(size_t size, int options);
  94. ErrorOr<int> open(StringView path, int options, mode_t mode = 0);
  95. ErrorOr<int> openat(int fd, StringView path, int options, mode_t mode = 0);
  96. ErrorOr<void> close(int fd);
  97. ErrorOr<void> ftruncate(int fd, off_t length);
  98. ErrorOr<struct stat> stat(StringView path);
  99. ErrorOr<struct stat> lstat(StringView path);
  100. ErrorOr<ssize_t> read(int fd, Bytes buffer);
  101. ErrorOr<ssize_t> write(int fd, ReadonlyBytes buffer);
  102. ErrorOr<void> kill(pid_t, int signal);
  103. ErrorOr<void> killpg(int pgrp, int signal);
  104. ErrorOr<int> dup(int source_fd);
  105. ErrorOr<int> dup2(int source_fd, int destination_fd);
  106. ErrorOr<DeprecatedString> ptsname(int fd);
  107. ErrorOr<DeprecatedString> gethostname();
  108. ErrorOr<void> sethostname(StringView);
  109. ErrorOr<DeprecatedString> getcwd();
  110. ErrorOr<void> ioctl(int fd, unsigned request, ...);
  111. ErrorOr<struct termios> tcgetattr(int fd);
  112. ErrorOr<void> tcsetattr(int fd, int optional_actions, struct termios const&);
  113. ErrorOr<int> tcsetpgrp(int fd, pid_t pgrp);
  114. ErrorOr<void> chmod(StringView pathname, mode_t mode);
  115. ErrorOr<void> lchown(StringView pathname, uid_t uid, gid_t gid);
  116. ErrorOr<void> chown(StringView pathname, uid_t uid, gid_t gid);
  117. ErrorOr<Optional<struct passwd>> getpwent(Span<char> buffer);
  118. ErrorOr<Optional<struct passwd>> getpwnam(StringView name);
  119. ErrorOr<Optional<struct group>> getgrnam(StringView name);
  120. ErrorOr<Optional<struct passwd>> getpwuid(uid_t);
  121. ErrorOr<Optional<struct group>> getgrent(Span<char> buffer);
  122. ErrorOr<Optional<struct group>> getgrgid(gid_t);
  123. ErrorOr<void> clock_settime(clockid_t clock_id, struct timespec* ts);
  124. ErrorOr<pid_t> posix_spawn(StringView path, posix_spawn_file_actions_t const* file_actions, posix_spawnattr_t const* attr, char* const arguments[], char* const envp[]);
  125. ErrorOr<pid_t> posix_spawnp(StringView path, posix_spawn_file_actions_t* const file_actions, posix_spawnattr_t* const attr, char* const arguments[], char* const envp[]);
  126. ErrorOr<off_t> lseek(int fd, off_t, int whence);
  127. ErrorOr<void> endgrent();
  128. struct WaitPidResult {
  129. pid_t pid;
  130. int status;
  131. };
  132. ErrorOr<WaitPidResult> waitpid(pid_t waitee, int options = 0);
  133. ErrorOr<void> setuid(uid_t);
  134. ErrorOr<void> seteuid(uid_t);
  135. ErrorOr<void> setgid(gid_t);
  136. ErrorOr<void> setegid(gid_t);
  137. ErrorOr<void> setpgid(pid_t pid, pid_t pgid);
  138. ErrorOr<pid_t> setsid();
  139. ErrorOr<pid_t> getsid(pid_t pid = 0);
  140. ErrorOr<void> drop_privileges();
  141. ErrorOr<bool> isatty(int fd);
  142. ErrorOr<void> link(StringView old_path, StringView new_path);
  143. ErrorOr<void> symlink(StringView target, StringView link_path);
  144. ErrorOr<void> mkdir(StringView path, mode_t);
  145. ErrorOr<void> chdir(StringView path);
  146. ErrorOr<void> rmdir(StringView path);
  147. ErrorOr<pid_t> fork();
  148. ErrorOr<int> mkstemp(Span<char> pattern);
  149. ErrorOr<void> fchmod(int fd, mode_t mode);
  150. ErrorOr<void> fchown(int fd, uid_t, gid_t);
  151. ErrorOr<void> rename(StringView old_path, StringView new_path);
  152. ErrorOr<void> unlink(StringView path);
  153. ErrorOr<void> utime(StringView path, Optional<struct utimbuf>);
  154. ErrorOr<struct utsname> uname();
  155. ErrorOr<Array<int, 2>> pipe2(int flags);
  156. #ifndef AK_OS_ANDROID
  157. ErrorOr<void> adjtime(const struct timeval* delta, struct timeval* old_delta);
  158. #endif
  159. enum class SearchInPath {
  160. No,
  161. Yes,
  162. };
  163. #ifdef AK_OS_SERENITY
  164. ErrorOr<void> exec_command(Vector<StringView>& command, bool preserve_env);
  165. #endif
  166. ErrorOr<void> exec(StringView filename, ReadonlySpan<StringView> arguments, SearchInPath, Optional<ReadonlySpan<StringView>> environment = {});
  167. #ifdef AK_OS_SERENITY
  168. ErrorOr<void> join_jail(u64 jail_index);
  169. ErrorOr<u64> create_jail(StringView jail_name);
  170. #endif
  171. ErrorOr<int> socket(int domain, int type, int protocol);
  172. ErrorOr<void> bind(int sockfd, struct sockaddr const*, socklen_t);
  173. ErrorOr<void> listen(int sockfd, int backlog);
  174. ErrorOr<int> accept(int sockfd, struct sockaddr*, socklen_t*);
  175. ErrorOr<void> connect(int sockfd, struct sockaddr const*, socklen_t);
  176. ErrorOr<void> shutdown(int sockfd, int how);
  177. ErrorOr<ssize_t> send(int sockfd, void const*, size_t, int flags);
  178. ErrorOr<ssize_t> sendmsg(int sockfd, const struct msghdr*, int flags);
  179. ErrorOr<ssize_t> sendto(int sockfd, void const*, size_t, int flags, struct sockaddr const*, socklen_t);
  180. ErrorOr<ssize_t> recv(int sockfd, void*, size_t, int flags);
  181. ErrorOr<ssize_t> recvmsg(int sockfd, struct msghdr*, int flags);
  182. ErrorOr<ssize_t> recvfrom(int sockfd, void*, size_t, int flags, struct sockaddr*, socklen_t*);
  183. ErrorOr<void> getsockopt(int sockfd, int level, int option, void* value, socklen_t* value_size);
  184. ErrorOr<void> setsockopt(int sockfd, int level, int option, void const* value, socklen_t value_size);
  185. ErrorOr<void> getsockname(int sockfd, struct sockaddr*, socklen_t*);
  186. ErrorOr<void> getpeername(int sockfd, struct sockaddr*, socklen_t*);
  187. ErrorOr<void> socketpair(int domain, int type, int protocol, int sv[2]);
  188. ErrorOr<Vector<gid_t>> getgroups();
  189. ErrorOr<void> setgroups(ReadonlySpan<gid_t>);
  190. ErrorOr<void> mknod(StringView pathname, mode_t mode, dev_t dev);
  191. ErrorOr<void> mkfifo(StringView pathname, mode_t mode);
  192. ErrorOr<void> setenv(StringView, StringView, bool);
  193. ErrorOr<void> putenv(StringView);
  194. ErrorOr<int> posix_openpt(int flags);
  195. ErrorOr<void> grantpt(int fildes);
  196. ErrorOr<void> unlockpt(int fildes);
  197. ErrorOr<void> access(StringView pathname, int mode);
  198. ErrorOr<DeprecatedString> readlink(StringView pathname);
  199. ErrorOr<int> poll(Span<struct pollfd>, int timeout);
  200. class AddressInfoVector {
  201. AK_MAKE_NONCOPYABLE(AddressInfoVector);
  202. public:
  203. AddressInfoVector(AddressInfoVector&&) = default;
  204. ~AddressInfoVector() = default;
  205. ReadonlySpan<struct addrinfo> addresses() const { return m_addresses; }
  206. private:
  207. friend ErrorOr<AddressInfoVector> getaddrinfo(char const* nodename, char const* servname, struct addrinfo const& hints);
  208. AddressInfoVector(Vector<struct addrinfo>&& addresses, struct addrinfo* ptr)
  209. : m_addresses(move(addresses))
  210. , m_ptr(adopt_own_if_nonnull(ptr))
  211. {
  212. }
  213. struct AddrInfoDeleter {
  214. void operator()(struct addrinfo* ptr) { ::freeaddrinfo(ptr); }
  215. };
  216. Vector<struct addrinfo> m_addresses {};
  217. OwnPtr<struct addrinfo, AddrInfoDeleter> m_ptr {};
  218. };
  219. ErrorOr<AddressInfoVector> getaddrinfo(char const* nodename, char const* servname, struct addrinfo const& hints);
  220. #ifdef AK_OS_SERENITY
  221. ErrorOr<void> posix_fallocate(int fd, off_t offset, off_t length);
  222. #endif
  223. }