System.cpp 50 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694
  1. /*
  2. * Copyright (c) 2021-2022, Andreas Kling <kling@serenityos.org>
  3. * Copyright (c) 2021-2022, Kenneth Myhra <kennethmyhra@serenityos.org>
  4. * Copyright (c) 2021-2023, Sam Atkins <atkinssj@serenityos.org>
  5. * Copyright (c) 2022, Matthias Zimmerman <matthias291999@gmail.com>
  6. *
  7. * SPDX-License-Identifier: BSD-2-Clause
  8. */
  9. #include <AK/DeprecatedString.h>
  10. #include <AK/FixedArray.h>
  11. #include <AK/ScopedValueRollback.h>
  12. #include <AK/StdLibExtras.h>
  13. #include <AK/String.h>
  14. #include <AK/Vector.h>
  15. #include <LibCore/SessionManagement.h>
  16. #include <LibCore/System.h>
  17. #include <limits.h>
  18. #include <stdarg.h>
  19. #include <stdlib.h>
  20. #include <sys/ioctl.h>
  21. #include <sys/mman.h>
  22. #include <sys/time.h>
  23. #include <termios.h>
  24. #include <unistd.h>
  25. #ifdef AK_OS_SERENITY
  26. # include <Kernel/API/Unveil.h>
  27. # include <LibCore/Account.h>
  28. # include <LibSystem/syscall.h>
  29. # include <serenity.h>
  30. # include <sys/ptrace.h>
  31. #endif
  32. #if defined(AK_OS_LINUX) && !defined(MFD_CLOEXEC)
  33. # include <linux/memfd.h>
  34. # include <sys/syscall.h>
  35. static int memfd_create(char const* name, unsigned int flags)
  36. {
  37. return syscall(SYS_memfd_create, name, flags);
  38. }
  39. #endif
  40. #if defined(AK_OS_MACOS)
  41. # include <sys/mman.h>
  42. #endif
  43. #define HANDLE_SYSCALL_RETURN_VALUE(syscall_name, rc, success_value) \
  44. if ((rc) < 0) { \
  45. return Error::from_syscall(syscall_name##sv, rc); \
  46. } \
  47. return success_value;
  48. // clang-format off
  49. template<typename T>
  50. concept SupportsReentrantGetpwent = requires(T passwd, T* ptr)
  51. {
  52. getpwent_r(&passwd, nullptr, 0, &ptr);
  53. };
  54. // clang-format on
  55. // Note: This has to be in the global namespace for the extern declaration to trick the compiler
  56. // into finding a declaration of getpwent_r when it doesn't actually exist.
  57. static ErrorOr<Optional<struct passwd>> getpwent_impl(Span<char> buffer)
  58. {
  59. if constexpr (SupportsReentrantGetpwent<struct passwd>) {
  60. struct passwd passwd;
  61. struct passwd* ptr = nullptr;
  62. extern int getpwent_r(struct passwd*, char*, size_t, struct passwd**);
  63. auto result = getpwent_r(&passwd, buffer.data(), buffer.size(), &ptr);
  64. if (result == 0 && ptr)
  65. return passwd;
  66. if (result != 0 && result != ENOENT)
  67. return Error::from_errno(result);
  68. } else {
  69. errno = 0;
  70. if (auto const* passwd = ::getpwent())
  71. return *passwd;
  72. if (errno)
  73. return Error::from_errno(errno);
  74. }
  75. return Optional<struct passwd> {};
  76. }
  77. // clang-format off
  78. template<typename T>
  79. concept SupportsReentrantGetgrent = requires(T group, T* ptr)
  80. {
  81. getgrent_r(&group, nullptr, 0, &ptr);
  82. };
  83. // clang-format on
  84. // Note: This has to be in the global namespace for the extern declaration to trick the compiler
  85. // into finding a declaration of getgrent_r when it doesn't actually exist.
  86. static ErrorOr<Optional<struct group>> getgrent_impl(Span<char> buffer)
  87. {
  88. if constexpr (SupportsReentrantGetgrent<struct group>) {
  89. struct group group;
  90. struct group* ptr = nullptr;
  91. extern int getgrent_r(struct group*, char*, size_t, struct group**);
  92. auto result = getgrent_r(&group, buffer.data(), buffer.size(), &ptr);
  93. if (result == 0 && ptr)
  94. return group;
  95. if (result != 0 && result != ENOENT)
  96. return Error::from_errno(result);
  97. } else {
  98. errno = 0;
  99. if (auto const* group = ::getgrent())
  100. return *group;
  101. if (errno)
  102. return Error::from_errno(errno);
  103. }
  104. return Optional<struct group> {};
  105. }
  106. namespace Core::System {
  107. #ifndef HOST_NAME_MAX
  108. # ifdef AK_OS_MACOS
  109. # define HOST_NAME_MAX 255
  110. # else
  111. # define HOST_NAME_MAX 64
  112. # endif
  113. #endif
  114. #ifdef AK_OS_SERENITY
  115. ErrorOr<void> beep(Optional<size_t> tone)
  116. {
  117. auto rc = ::sysbeep(tone.value_or(440));
  118. if (rc < 0)
  119. return Error::from_syscall("beep"sv, -errno);
  120. return {};
  121. }
  122. ErrorOr<void> pledge(StringView promises, StringView execpromises)
  123. {
  124. Syscall::SC_pledge_params params {
  125. { promises.characters_without_null_termination(), promises.length() },
  126. { execpromises.characters_without_null_termination(), execpromises.length() },
  127. };
  128. int rc = syscall(SC_pledge, &params);
  129. HANDLE_SYSCALL_RETURN_VALUE("pledge", rc, {});
  130. }
  131. static ErrorOr<void> unveil_dynamic_loader()
  132. {
  133. static bool dynamic_loader_unveiled { false };
  134. if (dynamic_loader_unveiled)
  135. return {};
  136. // FIXME: Try to find a way to not hardcode the dynamic loader path.
  137. constexpr auto dynamic_loader_path = "/usr/lib/Loader.so"sv;
  138. constexpr auto dynamic_loader_permissions = "x"sv;
  139. Syscall::SC_unveil_params params {
  140. static_cast<int>(UnveilFlags::CurrentProgram),
  141. { dynamic_loader_path.characters_without_null_termination(), dynamic_loader_path.length() },
  142. { dynamic_loader_permissions.characters_without_null_termination(), dynamic_loader_permissions.length() },
  143. };
  144. int rc = syscall(SC_unveil, &params);
  145. if (rc < 0) {
  146. return Error::from_syscall("unveil (DynamicLoader @ /usr/lib/Loader.so)"sv, rc);
  147. }
  148. dynamic_loader_unveiled = true;
  149. return {};
  150. }
  151. ErrorOr<void> unveil(StringView path, StringView permissions)
  152. {
  153. auto const parsed_path = TRY(Core::SessionManagement::parse_path_with_sid(path));
  154. if (permissions.contains('x'))
  155. TRY(unveil_dynamic_loader());
  156. Syscall::SC_unveil_params params {
  157. static_cast<int>(UnveilFlags::CurrentProgram),
  158. { parsed_path.characters(), parsed_path.length() },
  159. { permissions.characters_without_null_termination(), permissions.length() },
  160. };
  161. int rc = syscall(SC_unveil, &params);
  162. HANDLE_SYSCALL_RETURN_VALUE("unveil", rc, {});
  163. }
  164. ErrorOr<void> unveil_after_exec(StringView path, StringView permissions)
  165. {
  166. auto const parsed_path = TRY(Core::SessionManagement::parse_path_with_sid(path));
  167. Syscall::SC_unveil_params params {
  168. static_cast<int>(UnveilFlags::AfterExec),
  169. { parsed_path.characters(), parsed_path.length() },
  170. { permissions.characters_without_null_termination(), permissions.length() },
  171. };
  172. int rc = syscall(SC_unveil, &params);
  173. HANDLE_SYSCALL_RETURN_VALUE("unveil", rc, {});
  174. }
  175. ErrorOr<void> sendfd(int sockfd, int fd)
  176. {
  177. if (::sendfd(sockfd, fd) < 0)
  178. return Error::from_syscall("sendfd"sv, -errno);
  179. return {};
  180. }
  181. ErrorOr<int> recvfd(int sockfd, int options)
  182. {
  183. auto fd = ::recvfd(sockfd, options);
  184. if (fd < 0)
  185. return Error::from_syscall("recvfd"sv, -errno);
  186. return fd;
  187. }
  188. ErrorOr<void> ptrace_peekbuf(pid_t tid, void const* tracee_addr, Bytes destination_buf)
  189. {
  190. Syscall::SC_ptrace_buf_params buf_params {
  191. { destination_buf.data(), destination_buf.size() }
  192. };
  193. Syscall::SC_ptrace_params params {
  194. PT_PEEKBUF,
  195. tid,
  196. const_cast<void*>(tracee_addr),
  197. (FlatPtr)&buf_params,
  198. };
  199. int rc = syscall(SC_ptrace, &params);
  200. HANDLE_SYSCALL_RETURN_VALUE("ptrace_peekbuf", rc, {});
  201. }
  202. ErrorOr<void> bindmount(int source_fd, StringView target, int flags)
  203. {
  204. if (target.is_null())
  205. return Error::from_errno(EFAULT);
  206. Syscall::SC_bindmount_params params {
  207. { target.characters_without_null_termination(), target.length() },
  208. source_fd,
  209. flags,
  210. };
  211. int rc = syscall(SC_bindmount, &params);
  212. HANDLE_SYSCALL_RETURN_VALUE("bindmount", rc, {});
  213. }
  214. ErrorOr<void> remount(StringView target, int flags)
  215. {
  216. if (target.is_null())
  217. return Error::from_errno(EFAULT);
  218. Syscall::SC_remount_params params {
  219. { target.characters_without_null_termination(), target.length() },
  220. flags
  221. };
  222. int rc = syscall(SC_remount, &params);
  223. HANDLE_SYSCALL_RETURN_VALUE("remount", rc, {});
  224. }
  225. ErrorOr<void> mount(int source_fd, StringView target, StringView fs_type, int flags)
  226. {
  227. if (target.is_null() || fs_type.is_null())
  228. return Error::from_errno(EFAULT);
  229. Syscall::SC_mount_params params {
  230. { target.characters_without_null_termination(), target.length() },
  231. { fs_type.characters_without_null_termination(), fs_type.length() },
  232. source_fd,
  233. flags
  234. };
  235. int rc = syscall(SC_mount, &params);
  236. HANDLE_SYSCALL_RETURN_VALUE("mount", rc, {});
  237. }
  238. ErrorOr<void> umount(StringView mount_point)
  239. {
  240. if (mount_point.is_null())
  241. return Error::from_errno(EFAULT);
  242. int rc = syscall(SC_umount, mount_point.characters_without_null_termination(), mount_point.length());
  243. HANDLE_SYSCALL_RETURN_VALUE("umount", rc, {});
  244. }
  245. ErrorOr<long> ptrace(int request, pid_t tid, void* address, void* data)
  246. {
  247. auto rc = ::ptrace(request, tid, address, data);
  248. if (rc < 0)
  249. return Error::from_syscall("ptrace"sv, -errno);
  250. return rc;
  251. }
  252. ErrorOr<void> disown(pid_t pid)
  253. {
  254. int rc = ::disown(pid);
  255. HANDLE_SYSCALL_RETURN_VALUE("disown", rc, {});
  256. }
  257. ErrorOr<void> profiling_enable(pid_t pid, u64 event_mask)
  258. {
  259. int rc = ::profiling_enable(pid, event_mask);
  260. HANDLE_SYSCALL_RETURN_VALUE("profiling_enable", rc, {});
  261. }
  262. ErrorOr<void> profiling_disable(pid_t pid)
  263. {
  264. int rc = ::profiling_disable(pid);
  265. HANDLE_SYSCALL_RETURN_VALUE("profiling_disable", rc, {});
  266. }
  267. ErrorOr<void> profiling_free_buffer(pid_t pid)
  268. {
  269. int rc = ::profiling_free_buffer(pid);
  270. HANDLE_SYSCALL_RETURN_VALUE("profiling_free_buffer", rc, {});
  271. }
  272. #endif
  273. #if !defined(AK_OS_BSD_GENERIC) && !defined(AK_OS_ANDROID)
  274. ErrorOr<Optional<struct spwd>> getspent()
  275. {
  276. errno = 0;
  277. if (auto* spwd = ::getspent())
  278. return *spwd;
  279. if (errno)
  280. return Error::from_syscall("getspent"sv, -errno);
  281. return Optional<struct spwd> {};
  282. }
  283. ErrorOr<Optional<struct spwd>> getspnam(StringView name)
  284. {
  285. errno = 0;
  286. ::setspent();
  287. while (auto* spwd = ::getspent()) {
  288. if (spwd->sp_namp == name)
  289. return *spwd;
  290. }
  291. if (errno)
  292. return Error::from_syscall("getspnam"sv, -errno);
  293. return Optional<struct spwd> {};
  294. }
  295. #endif
  296. #ifndef AK_OS_MACOS
  297. ErrorOr<int> accept4(int sockfd, sockaddr* address, socklen_t* address_length, int flags)
  298. {
  299. auto fd = ::accept4(sockfd, address, address_length, flags);
  300. if (fd < 0)
  301. return Error::from_syscall("accept4"sv, -errno);
  302. return fd;
  303. }
  304. #endif
  305. ErrorOr<void> sigaction(int signal, struct sigaction const* action, struct sigaction* old_action)
  306. {
  307. if (::sigaction(signal, action, old_action) < 0)
  308. return Error::from_syscall("sigaction"sv, -errno);
  309. return {};
  310. }
  311. #if defined(AK_OS_SOLARIS)
  312. ErrorOr<SIG_TYP> signal(int signal, SIG_TYP handler)
  313. #elif defined(AK_OS_BSD_GENERIC)
  314. ErrorOr<sig_t> signal(int signal, sig_t handler)
  315. #else
  316. ErrorOr<sighandler_t> signal(int signal, sighandler_t handler)
  317. #endif
  318. {
  319. auto old_handler = ::signal(signal, handler);
  320. if (old_handler == SIG_ERR)
  321. return Error::from_syscall("signal"sv, -errno);
  322. return old_handler;
  323. }
  324. ErrorOr<struct stat> fstat(int fd)
  325. {
  326. struct stat st = {};
  327. if (::fstat(fd, &st) < 0)
  328. return Error::from_syscall("fstat"sv, -errno);
  329. return st;
  330. }
  331. ErrorOr<struct stat> fstatat(int fd, StringView path, int flags)
  332. {
  333. if (!path.characters_without_null_termination())
  334. return Error::from_syscall("fstatat"sv, -EFAULT);
  335. struct stat st = {};
  336. #ifdef AK_OS_SERENITY
  337. Syscall::SC_stat_params params { { path.characters_without_null_termination(), path.length() }, &st, fd, !(flags & AT_SYMLINK_NOFOLLOW) };
  338. int rc = syscall(SC_stat, &params);
  339. #else
  340. DeprecatedString path_string = path;
  341. int rc = ::fstatat(fd, path_string.characters(), &st, flags);
  342. #endif
  343. HANDLE_SYSCALL_RETURN_VALUE("fstatat", rc, st);
  344. }
  345. ErrorOr<int> fcntl(int fd, int command, ...)
  346. {
  347. va_list ap;
  348. va_start(ap, command);
  349. uintptr_t extra_arg = va_arg(ap, uintptr_t);
  350. int rc = ::fcntl(fd, command, extra_arg);
  351. va_end(ap);
  352. if (rc < 0)
  353. return Error::from_syscall("fcntl"sv, -errno);
  354. return rc;
  355. }
  356. ErrorOr<void*> mmap(void* address, size_t size, int protection, int flags, int fd, off_t offset, [[maybe_unused]] size_t alignment, [[maybe_unused]] StringView name)
  357. {
  358. #ifdef AK_OS_SERENITY
  359. Syscall::SC_mmap_params params { address, size, alignment, protection, flags, fd, offset, { name.characters_without_null_termination(), name.length() } };
  360. ptrdiff_t rc = syscall(SC_mmap, &params);
  361. if (rc < 0 && rc > -EMAXERRNO)
  362. return Error::from_syscall("mmap"sv, rc);
  363. return reinterpret_cast<void*>(rc);
  364. #else
  365. // NOTE: Regular POSIX mmap() doesn't support custom alignment requests.
  366. VERIFY(!alignment);
  367. auto* ptr = ::mmap(address, size, protection, flags, fd, offset);
  368. if (ptr == MAP_FAILED)
  369. return Error::from_syscall("mmap"sv, -errno);
  370. return ptr;
  371. #endif
  372. }
  373. ErrorOr<void> munmap(void* address, size_t size)
  374. {
  375. if (::munmap(address, size) < 0)
  376. return Error::from_syscall("munmap"sv, -errno);
  377. return {};
  378. }
  379. ErrorOr<int> anon_create([[maybe_unused]] size_t size, [[maybe_unused]] int options)
  380. {
  381. int fd = -1;
  382. #if defined(AK_OS_SERENITY)
  383. fd = ::anon_create(round_up_to_power_of_two(size, PAGE_SIZE), options);
  384. #elif defined(AK_OS_LINUX) || defined(AK_OS_FREEBSD)
  385. // FIXME: Support more options on Linux.
  386. auto linux_options = ((options & O_CLOEXEC) > 0) ? MFD_CLOEXEC : 0;
  387. fd = memfd_create("", linux_options);
  388. if (fd < 0)
  389. return Error::from_errno(errno);
  390. if (::ftruncate(fd, size) < 0) {
  391. auto saved_errno = errno;
  392. TRY(close(fd));
  393. return Error::from_errno(saved_errno);
  394. }
  395. #elif defined(AK_OS_BSD_GENERIC) || defined(AK_OS_EMSCRIPTEN)
  396. struct timespec time;
  397. clock_gettime(CLOCK_REALTIME, &time);
  398. auto name = DeprecatedString::formatted("/shm-{}{}", (unsigned long)time.tv_sec, (unsigned long)time.tv_nsec);
  399. fd = shm_open(name.characters(), O_RDWR | O_CREAT | options, 0600);
  400. if (shm_unlink(name.characters()) == -1) {
  401. auto saved_errno = errno;
  402. TRY(close(fd));
  403. return Error::from_errno(saved_errno);
  404. }
  405. if (fd < 0)
  406. return Error::from_errno(errno);
  407. if (::ftruncate(fd, size) < 0) {
  408. auto saved_errno = errno;
  409. TRY(close(fd));
  410. return Error::from_errno(saved_errno);
  411. }
  412. void* addr = ::mmap(NULL, size, PROT_WRITE, MAP_SHARED, fd, 0);
  413. if (addr == MAP_FAILED) {
  414. auto saved_errno = errno;
  415. TRY(close(fd));
  416. return Error::from_errno(saved_errno);
  417. }
  418. #endif
  419. if (fd < 0)
  420. return Error::from_errno(errno);
  421. return fd;
  422. }
  423. ErrorOr<int> open(StringView path, int options, mode_t mode)
  424. {
  425. return openat(AT_FDCWD, path, options, mode);
  426. }
  427. ErrorOr<int> openat(int fd, StringView path, int options, mode_t mode)
  428. {
  429. if (!path.characters_without_null_termination())
  430. return Error::from_syscall("open"sv, -EFAULT);
  431. #ifdef AK_OS_SERENITY
  432. Syscall::SC_open_params params { fd, { path.characters_without_null_termination(), path.length() }, options, mode };
  433. int rc = syscall(SC_open, &params);
  434. HANDLE_SYSCALL_RETURN_VALUE("open", rc, rc);
  435. #else
  436. // NOTE: We have to ensure that the path is null-terminated.
  437. DeprecatedString path_string = path;
  438. int rc = ::openat(fd, path_string.characters(), options, mode);
  439. if (rc < 0)
  440. return Error::from_syscall("open"sv, -errno);
  441. return rc;
  442. #endif
  443. }
  444. ErrorOr<void> close(int fd)
  445. {
  446. if (::close(fd) < 0)
  447. return Error::from_syscall("close"sv, -errno);
  448. return {};
  449. }
  450. ErrorOr<void> ftruncate(int fd, off_t length)
  451. {
  452. if (::ftruncate(fd, length) < 0)
  453. return Error::from_syscall("ftruncate"sv, -errno);
  454. return {};
  455. }
  456. ErrorOr<struct stat> stat(StringView path)
  457. {
  458. if (!path.characters_without_null_termination())
  459. return Error::from_syscall("stat"sv, -EFAULT);
  460. struct stat st = {};
  461. #ifdef AK_OS_SERENITY
  462. Syscall::SC_stat_params params { { path.characters_without_null_termination(), path.length() }, &st, AT_FDCWD, true };
  463. int rc = syscall(SC_stat, &params);
  464. HANDLE_SYSCALL_RETURN_VALUE("stat", rc, st);
  465. #else
  466. DeprecatedString path_string = path;
  467. if (::stat(path_string.characters(), &st) < 0)
  468. return Error::from_syscall("stat"sv, -errno);
  469. return st;
  470. #endif
  471. }
  472. ErrorOr<struct stat> lstat(StringView path)
  473. {
  474. if (!path.characters_without_null_termination())
  475. return Error::from_syscall("lstat"sv, -EFAULT);
  476. struct stat st = {};
  477. #ifdef AK_OS_SERENITY
  478. Syscall::SC_stat_params params { { path.characters_without_null_termination(), path.length() }, &st, AT_FDCWD, false };
  479. int rc = syscall(SC_stat, &params);
  480. HANDLE_SYSCALL_RETURN_VALUE("lstat", rc, st);
  481. #else
  482. DeprecatedString path_string = path;
  483. if (::lstat(path_string.characters(), &st) < 0)
  484. return Error::from_syscall("lstat"sv, -errno);
  485. return st;
  486. #endif
  487. }
  488. ErrorOr<ssize_t> read(int fd, Bytes buffer)
  489. {
  490. ssize_t rc = ::read(fd, buffer.data(), buffer.size());
  491. if (rc < 0)
  492. return Error::from_syscall("read"sv, -errno);
  493. return rc;
  494. }
  495. ErrorOr<ssize_t> write(int fd, ReadonlyBytes buffer)
  496. {
  497. ssize_t rc = ::write(fd, buffer.data(), buffer.size());
  498. if (rc < 0)
  499. return Error::from_syscall("write"sv, -errno);
  500. return rc;
  501. }
  502. ErrorOr<void> kill(pid_t pid, int signal)
  503. {
  504. if (::kill(pid, signal) < 0)
  505. return Error::from_syscall("kill"sv, -errno);
  506. return {};
  507. }
  508. ErrorOr<void> killpg(int pgrp, int signal)
  509. {
  510. if (::killpg(pgrp, signal) < 0)
  511. return Error::from_syscall("killpg"sv, -errno);
  512. return {};
  513. }
  514. ErrorOr<int> dup(int source_fd)
  515. {
  516. int fd = ::dup(source_fd);
  517. if (fd < 0)
  518. return Error::from_syscall("dup"sv, -errno);
  519. return fd;
  520. }
  521. ErrorOr<int> dup2(int source_fd, int destination_fd)
  522. {
  523. int fd = ::dup2(source_fd, destination_fd);
  524. if (fd < 0)
  525. return Error::from_syscall("dup2"sv, -errno);
  526. return fd;
  527. }
  528. ErrorOr<DeprecatedString> ptsname(int fd)
  529. {
  530. auto* name = ::ptsname(fd);
  531. if (!name)
  532. return Error::from_syscall("ptsname"sv, -errno);
  533. return DeprecatedString(name);
  534. }
  535. ErrorOr<DeprecatedString> gethostname()
  536. {
  537. char hostname[HOST_NAME_MAX];
  538. int rc = ::gethostname(hostname, sizeof(hostname));
  539. if (rc < 0)
  540. return Error::from_syscall("gethostname"sv, -errno);
  541. return DeprecatedString(&hostname[0]);
  542. }
  543. ErrorOr<void> sethostname(StringView hostname)
  544. {
  545. #if defined(AK_OS_SOLARIS)
  546. int rc = ::sethostname(const_cast<char*>(hostname.characters_without_null_termination()), hostname.length());
  547. #else
  548. int rc = ::sethostname(hostname.characters_without_null_termination(), hostname.length());
  549. #endif
  550. if (rc < 0)
  551. return Error::from_syscall("sethostname"sv, -errno);
  552. return {};
  553. }
  554. ErrorOr<DeprecatedString> getcwd()
  555. {
  556. auto* cwd = ::getcwd(nullptr, 0);
  557. if (!cwd)
  558. return Error::from_syscall("getcwd"sv, -errno);
  559. DeprecatedString string_cwd(cwd);
  560. free(cwd);
  561. return string_cwd;
  562. }
  563. ErrorOr<void> ioctl(int fd, unsigned request, ...)
  564. {
  565. va_list ap;
  566. va_start(ap, request);
  567. FlatPtr arg = va_arg(ap, FlatPtr);
  568. va_end(ap);
  569. if (::ioctl(fd, request, arg) < 0)
  570. return Error::from_syscall("ioctl"sv, -errno);
  571. return {};
  572. }
  573. ErrorOr<struct termios> tcgetattr(int fd)
  574. {
  575. struct termios ios = {};
  576. if (::tcgetattr(fd, &ios) < 0)
  577. return Error::from_syscall("tcgetattr"sv, -errno);
  578. return ios;
  579. }
  580. ErrorOr<void> tcsetattr(int fd, int optional_actions, struct termios const& ios)
  581. {
  582. if (::tcsetattr(fd, optional_actions, &ios) < 0)
  583. return Error::from_syscall("tcsetattr"sv, -errno);
  584. return {};
  585. }
  586. ErrorOr<int> tcsetpgrp(int fd, pid_t pgrp)
  587. {
  588. int rc = ::tcsetpgrp(fd, pgrp);
  589. if (rc < 0)
  590. return Error::from_syscall("tcsetpgrp"sv, -errno);
  591. return { rc };
  592. }
  593. ErrorOr<void> chmod(StringView pathname, mode_t mode)
  594. {
  595. if (!pathname.characters_without_null_termination())
  596. return Error::from_syscall("chmod"sv, -EFAULT);
  597. #ifdef AK_OS_SERENITY
  598. Syscall::SC_chmod_params params {
  599. AT_FDCWD,
  600. { pathname.characters_without_null_termination(), pathname.length() },
  601. mode,
  602. true
  603. };
  604. int rc = syscall(SC_chmod, &params);
  605. HANDLE_SYSCALL_RETURN_VALUE("chmod", rc, {});
  606. #else
  607. DeprecatedString path = pathname;
  608. if (::chmod(path.characters(), mode) < 0)
  609. return Error::from_syscall("chmod"sv, -errno);
  610. return {};
  611. #endif
  612. }
  613. ErrorOr<void> fchmod(int fd, mode_t mode)
  614. {
  615. if (::fchmod(fd, mode) < 0)
  616. return Error::from_syscall("fchmod"sv, -errno);
  617. return {};
  618. }
  619. ErrorOr<void> fchown(int fd, uid_t uid, gid_t gid)
  620. {
  621. if (::fchown(fd, uid, gid) < 0)
  622. return Error::from_syscall("fchown"sv, -errno);
  623. return {};
  624. }
  625. ErrorOr<void> lchown(StringView pathname, uid_t uid, gid_t gid)
  626. {
  627. if (!pathname.characters_without_null_termination())
  628. return Error::from_syscall("chown"sv, -EFAULT);
  629. #ifdef AK_OS_SERENITY
  630. Syscall::SC_chown_params params = { { pathname.characters_without_null_termination(), pathname.length() }, uid, gid, AT_FDCWD, false };
  631. int rc = syscall(SC_chown, &params);
  632. HANDLE_SYSCALL_RETURN_VALUE("chown", rc, {});
  633. #else
  634. DeprecatedString path = pathname;
  635. if (::chown(path.characters(), uid, gid) < 0)
  636. return Error::from_syscall("chown"sv, -errno);
  637. return {};
  638. #endif
  639. }
  640. ErrorOr<void> chown(StringView pathname, uid_t uid, gid_t gid)
  641. {
  642. if (!pathname.characters_without_null_termination())
  643. return Error::from_syscall("chown"sv, -EFAULT);
  644. #ifdef AK_OS_SERENITY
  645. Syscall::SC_chown_params params = { { pathname.characters_without_null_termination(), pathname.length() }, uid, gid, AT_FDCWD, true };
  646. int rc = syscall(SC_chown, &params);
  647. HANDLE_SYSCALL_RETURN_VALUE("chown", rc, {});
  648. #else
  649. DeprecatedString path = pathname;
  650. if (::lchown(path.characters(), uid, gid) < 0)
  651. return Error::from_syscall("lchown"sv, -errno);
  652. return {};
  653. #endif
  654. }
  655. ErrorOr<Optional<struct passwd>> getpwent(Span<char> buffer)
  656. {
  657. return getpwent_impl(buffer);
  658. }
  659. ErrorOr<Optional<struct passwd>> getpwuid(uid_t uid)
  660. {
  661. errno = 0;
  662. if (auto* pwd = ::getpwuid(uid))
  663. return *pwd;
  664. if (errno)
  665. return Error::from_syscall("getpwuid"sv, -errno);
  666. return Optional<struct passwd> {};
  667. }
  668. ErrorOr<Optional<struct group>> getgrent(Span<char> buffer)
  669. {
  670. return getgrent_impl(buffer);
  671. }
  672. ErrorOr<Optional<struct group>> getgrgid(gid_t gid)
  673. {
  674. errno = 0;
  675. if (auto* grp = ::getgrgid(gid))
  676. return *grp;
  677. if (errno)
  678. return Error::from_syscall("getgrgid"sv, -errno);
  679. return Optional<struct group> {};
  680. }
  681. ErrorOr<Optional<struct passwd>> getpwnam(StringView name)
  682. {
  683. errno = 0;
  684. ::setpwent();
  685. if (errno)
  686. return Error::from_syscall("getpwnam"sv, -errno);
  687. while (auto* pw = ::getpwent()) {
  688. if (errno)
  689. return Error::from_syscall("getpwnam"sv, -errno);
  690. if (pw->pw_name == name)
  691. return *pw;
  692. }
  693. if (errno)
  694. return Error::from_syscall("getpwnam"sv, -errno);
  695. else
  696. return Optional<struct passwd> {};
  697. }
  698. ErrorOr<Optional<struct group>> getgrnam(StringView name)
  699. {
  700. errno = 0;
  701. ::setgrent();
  702. if (errno)
  703. return Error::from_syscall("getgrnam"sv, -errno);
  704. while (auto* gr = ::getgrent()) {
  705. if (errno)
  706. return Error::from_syscall("getgrnam"sv, -errno);
  707. if (gr->gr_name == name)
  708. return *gr;
  709. }
  710. if (errno)
  711. return Error::from_syscall("getgrnam"sv, -errno);
  712. else
  713. return Optional<struct group> {};
  714. }
  715. ErrorOr<void> clock_settime(clockid_t clock_id, struct timespec* ts)
  716. {
  717. #ifdef AK_OS_SERENITY
  718. int rc = syscall(SC_clock_settime, clock_id, ts);
  719. HANDLE_SYSCALL_RETURN_VALUE("clocksettime", rc, {});
  720. #else
  721. if (::clock_settime(clock_id, ts) < 0)
  722. return Error::from_syscall("clocksettime"sv, -errno);
  723. return {};
  724. #endif
  725. }
  726. static ALWAYS_INLINE ErrorOr<pid_t> posix_spawn_wrapper(StringView path, posix_spawn_file_actions_t const* file_actions, posix_spawnattr_t const* attr, char* const arguments[], char* const envp[], StringView function_name, decltype(::posix_spawn) spawn_function)
  727. {
  728. pid_t child_pid;
  729. if ((errno = spawn_function(&child_pid, path.to_deprecated_string().characters(), file_actions, attr, arguments, envp)))
  730. return Error::from_syscall(function_name, -errno);
  731. return child_pid;
  732. }
  733. 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[])
  734. {
  735. return posix_spawn_wrapper(path, file_actions, attr, arguments, envp, "posix_spawn"sv, ::posix_spawn);
  736. }
  737. 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[])
  738. {
  739. return posix_spawn_wrapper(path, file_actions, attr, arguments, envp, "posix_spawnp"sv, ::posix_spawnp);
  740. }
  741. ErrorOr<off_t> lseek(int fd, off_t offset, int whence)
  742. {
  743. off_t rc = ::lseek(fd, offset, whence);
  744. if (rc < 0)
  745. return Error::from_syscall("lseek"sv, -errno);
  746. return rc;
  747. }
  748. ErrorOr<void> endgrent()
  749. {
  750. int old_errno = 0;
  751. swap(old_errno, errno);
  752. ::endgrent();
  753. if (errno != 0)
  754. return Error::from_syscall("endgrent"sv, -errno);
  755. errno = old_errno;
  756. return {};
  757. }
  758. ErrorOr<WaitPidResult> waitpid(pid_t waitee, int options)
  759. {
  760. int wstatus;
  761. pid_t pid = ::waitpid(waitee, &wstatus, options);
  762. if (pid < 0)
  763. return Error::from_syscall("waitpid"sv, -errno);
  764. return WaitPidResult { pid, wstatus };
  765. }
  766. ErrorOr<void> setuid(uid_t uid)
  767. {
  768. if (::setuid(uid) < 0)
  769. return Error::from_syscall("setuid"sv, -errno);
  770. return {};
  771. }
  772. ErrorOr<void> seteuid(uid_t uid)
  773. {
  774. if (::seteuid(uid) < 0)
  775. return Error::from_syscall("seteuid"sv, -errno);
  776. return {};
  777. }
  778. ErrorOr<void> setgid(gid_t gid)
  779. {
  780. if (::setgid(gid) < 0)
  781. return Error::from_syscall("setgid"sv, -errno);
  782. return {};
  783. }
  784. ErrorOr<void> setegid(gid_t gid)
  785. {
  786. if (::setegid(gid) < 0)
  787. return Error::from_syscall("setegid"sv, -errno);
  788. return {};
  789. }
  790. ErrorOr<void> setpgid(pid_t pid, pid_t pgid)
  791. {
  792. if (::setpgid(pid, pgid) < 0)
  793. return Error::from_syscall("setpgid"sv, -errno);
  794. return {};
  795. }
  796. ErrorOr<pid_t> setsid()
  797. {
  798. int rc = ::setsid();
  799. if (rc < 0)
  800. return Error::from_syscall("setsid"sv, -errno);
  801. return rc;
  802. }
  803. ErrorOr<pid_t> getsid(pid_t pid)
  804. {
  805. int rc = ::getsid(pid);
  806. if (rc < 0)
  807. return Error::from_syscall("getsid"sv, -errno);
  808. return rc;
  809. }
  810. ErrorOr<void> drop_privileges()
  811. {
  812. auto gid_result = setgid(getgid());
  813. auto uid_result = setuid(getuid());
  814. if (gid_result.is_error() || uid_result.is_error())
  815. return Error::from_string_literal("Failed to drop privileges");
  816. return {};
  817. }
  818. ErrorOr<bool> isatty(int fd)
  819. {
  820. int rc = ::isatty(fd);
  821. if (rc < 0)
  822. return Error::from_syscall("isatty"sv, -errno);
  823. return rc == 1;
  824. }
  825. ErrorOr<void> link(StringView old_path, StringView new_path)
  826. {
  827. #ifdef AK_OS_SERENITY
  828. Syscall::SC_link_params params {
  829. .old_path = { old_path.characters_without_null_termination(), old_path.length() },
  830. .new_path = { new_path.characters_without_null_termination(), new_path.length() },
  831. };
  832. int rc = syscall(SC_link, &params);
  833. HANDLE_SYSCALL_RETURN_VALUE("link", rc, {});
  834. #else
  835. DeprecatedString old_path_string = old_path;
  836. DeprecatedString new_path_string = new_path;
  837. if (::link(old_path_string.characters(), new_path_string.characters()) < 0)
  838. return Error::from_syscall("link"sv, -errno);
  839. return {};
  840. #endif
  841. }
  842. ErrorOr<void> symlink(StringView target, StringView link_path)
  843. {
  844. #ifdef AK_OS_SERENITY
  845. Syscall::SC_symlink_params params {
  846. .target = { target.characters_without_null_termination(), target.length() },
  847. .linkpath = { link_path.characters_without_null_termination(), link_path.length() },
  848. .dirfd = AT_FDCWD,
  849. };
  850. int rc = syscall(SC_symlink, &params);
  851. HANDLE_SYSCALL_RETURN_VALUE("symlink", rc, {});
  852. #else
  853. DeprecatedString target_string = target;
  854. DeprecatedString link_path_string = link_path;
  855. if (::symlink(target_string.characters(), link_path_string.characters()) < 0)
  856. return Error::from_syscall("symlink"sv, -errno);
  857. return {};
  858. #endif
  859. }
  860. ErrorOr<void> mkdir(StringView path, mode_t mode)
  861. {
  862. if (path.is_null())
  863. return Error::from_errno(EFAULT);
  864. #ifdef AK_OS_SERENITY
  865. int rc = syscall(SC_mkdir, AT_FDCWD, path.characters_without_null_termination(), path.length(), mode);
  866. HANDLE_SYSCALL_RETURN_VALUE("mkdir", rc, {});
  867. #else
  868. DeprecatedString path_string = path;
  869. if (::mkdir(path_string.characters(), mode) < 0)
  870. return Error::from_syscall("mkdir"sv, -errno);
  871. return {};
  872. #endif
  873. }
  874. ErrorOr<void> chdir(StringView path)
  875. {
  876. if (path.is_null())
  877. return Error::from_errno(EFAULT);
  878. #ifdef AK_OS_SERENITY
  879. int rc = syscall(SC_chdir, path.characters_without_null_termination(), path.length());
  880. HANDLE_SYSCALL_RETURN_VALUE("chdir", rc, {});
  881. #else
  882. DeprecatedString path_string = path;
  883. if (::chdir(path_string.characters()) < 0)
  884. return Error::from_syscall("chdir"sv, -errno);
  885. return {};
  886. #endif
  887. }
  888. ErrorOr<void> rmdir(StringView path)
  889. {
  890. if (path.is_null())
  891. return Error::from_errno(EFAULT);
  892. #ifdef AK_OS_SERENITY
  893. int rc = syscall(SC_rmdir, path.characters_without_null_termination(), path.length());
  894. HANDLE_SYSCALL_RETURN_VALUE("rmdir", rc, {});
  895. #else
  896. DeprecatedString path_string = path;
  897. if (::rmdir(path_string.characters()) < 0)
  898. return Error::from_syscall("rmdir"sv, -errno);
  899. return {};
  900. #endif
  901. }
  902. ErrorOr<pid_t> fork()
  903. {
  904. pid_t pid = ::fork();
  905. if (pid < 0)
  906. return Error::from_syscall("fork"sv, -errno);
  907. return pid;
  908. }
  909. ErrorOr<int> mkstemp(Span<char> pattern)
  910. {
  911. int fd = ::mkstemp(pattern.data());
  912. if (fd < 0)
  913. return Error::from_syscall("mkstemp"sv, -errno);
  914. return fd;
  915. }
  916. ErrorOr<String> mkdtemp(Span<char> pattern)
  917. {
  918. auto* path = ::mkdtemp(pattern.data());
  919. if (path == nullptr) {
  920. return Error::from_errno(errno);
  921. }
  922. return String::from_utf8({ path, strlen(path) });
  923. }
  924. ErrorOr<void> rename(StringView old_path, StringView new_path)
  925. {
  926. if (old_path.is_null() || new_path.is_null())
  927. return Error::from_errno(EFAULT);
  928. #ifdef AK_OS_SERENITY
  929. Syscall::SC_rename_params params {
  930. .olddirfd = AT_FDCWD,
  931. .old_path = { old_path.characters_without_null_termination(), old_path.length() },
  932. .newdirfd = AT_FDCWD,
  933. .new_path = { new_path.characters_without_null_termination(), new_path.length() },
  934. };
  935. int rc = syscall(SC_rename, &params);
  936. HANDLE_SYSCALL_RETURN_VALUE("rename", rc, {});
  937. #else
  938. DeprecatedString old_path_string = old_path;
  939. DeprecatedString new_path_string = new_path;
  940. if (::rename(old_path_string.characters(), new_path_string.characters()) < 0)
  941. return Error::from_syscall("rename"sv, -errno);
  942. return {};
  943. #endif
  944. }
  945. ErrorOr<void> unlink(StringView path)
  946. {
  947. if (path.is_null())
  948. return Error::from_errno(EFAULT);
  949. #ifdef AK_OS_SERENITY
  950. int rc = syscall(SC_unlink, AT_FDCWD, path.characters_without_null_termination(), path.length(), 0);
  951. HANDLE_SYSCALL_RETURN_VALUE("unlink", rc, {});
  952. #else
  953. DeprecatedString path_string = path;
  954. if (::unlink(path_string.characters()) < 0)
  955. return Error::from_syscall("unlink"sv, -errno);
  956. return {};
  957. #endif
  958. }
  959. ErrorOr<void> utime(StringView path, Optional<struct utimbuf> maybe_buf)
  960. {
  961. if (path.is_null())
  962. return Error::from_errno(EFAULT);
  963. struct utimbuf* buf = nullptr;
  964. if (maybe_buf.has_value())
  965. buf = &maybe_buf.value();
  966. #ifdef AK_OS_SERENITY
  967. int rc = syscall(SC_utime, path.characters_without_null_termination(), path.length(), buf);
  968. HANDLE_SYSCALL_RETURN_VALUE("utime", rc, {});
  969. #else
  970. DeprecatedString path_string = path;
  971. if (::utime(path_string.characters(), buf) < 0)
  972. return Error::from_syscall("utime"sv, -errno);
  973. return {};
  974. #endif
  975. }
  976. ErrorOr<void> utimensat(int fd, StringView path, struct timespec const times[2], int flag)
  977. {
  978. if (path.is_null())
  979. return Error::from_errno(EFAULT);
  980. #ifdef AK_OS_SERENITY
  981. // POSIX allows AT_SYMLINK_NOFOLLOW flag or no flags.
  982. if (flag & ~AT_SYMLINK_NOFOLLOW)
  983. return Error::from_errno(EINVAL);
  984. // Return early without error since both changes are to be omitted.
  985. if (times && times[0].tv_nsec == UTIME_OMIT && times[1].tv_nsec == UTIME_OMIT)
  986. return {};
  987. // According to POSIX, when times is a nullptr, it's equivalent to setting
  988. // both last access time and last modification time to the current time.
  989. // Setting the times argument to nullptr if it matches this case prevents
  990. // the need to copy it in the kernel.
  991. if (times && times[0].tv_nsec == UTIME_NOW && times[1].tv_nsec == UTIME_NOW)
  992. times = nullptr;
  993. if (times) {
  994. for (int i = 0; i < 2; ++i) {
  995. if ((times[i].tv_nsec != UTIME_NOW && times[i].tv_nsec != UTIME_OMIT)
  996. && (times[i].tv_nsec < 0 || times[i].tv_nsec >= 1'000'000'000L)) {
  997. return Error::from_errno(EINVAL);
  998. }
  999. }
  1000. }
  1001. Syscall::SC_utimensat_params params {
  1002. .dirfd = fd,
  1003. .path = { path.characters_without_null_termination(), path.length() },
  1004. .times = times,
  1005. .flag = flag,
  1006. };
  1007. int rc = syscall(SC_utimensat, &params);
  1008. HANDLE_SYSCALL_RETURN_VALUE("utimensat", rc, {});
  1009. #else
  1010. auto builder = TRY(StringBuilder::create());
  1011. TRY(builder.try_append(path));
  1012. TRY(builder.try_append('\0'));
  1013. // Note the explicit null terminators above.
  1014. if (::utimensat(fd, builder.string_view().characters_without_null_termination(), times, flag) < 0)
  1015. return Error::from_syscall("utimensat"sv, -errno);
  1016. return {};
  1017. #endif
  1018. }
  1019. ErrorOr<struct utsname> uname()
  1020. {
  1021. struct utsname uts;
  1022. #ifdef AK_OS_SERENITY
  1023. int rc = syscall(SC_uname, &uts);
  1024. HANDLE_SYSCALL_RETURN_VALUE("uname", rc, uts);
  1025. #else
  1026. if (::uname(&uts) < 0)
  1027. return Error::from_syscall("uname"sv, -errno);
  1028. #endif
  1029. return uts;
  1030. }
  1031. #ifndef AK_OS_ANDROID
  1032. ErrorOr<void> adjtime(const struct timeval* delta, struct timeval* old_delta)
  1033. {
  1034. # ifdef AK_OS_SERENITY
  1035. int rc = syscall(SC_adjtime, delta, old_delta);
  1036. HANDLE_SYSCALL_RETURN_VALUE("adjtime", rc, {});
  1037. # else
  1038. if (::adjtime(delta, old_delta) < 0)
  1039. return Error::from_syscall("adjtime"sv, -errno);
  1040. return {};
  1041. # endif
  1042. }
  1043. #endif
  1044. #ifdef AK_OS_SERENITY
  1045. ErrorOr<void> exec_command(Vector<StringView>& command, bool preserve_env)
  1046. {
  1047. Vector<StringView> exec_environment;
  1048. for (size_t i = 0; environ[i]; ++i) {
  1049. StringView env_view { environ[i], strlen(environ[i]) };
  1050. auto maybe_needle = env_view.find('=');
  1051. if (!maybe_needle.has_value())
  1052. continue;
  1053. // FIXME: Allow a custom selection of variables once ArgsParser supports options with optional parameters.
  1054. if (!preserve_env && env_view.substring_view(0, maybe_needle.value()) != "TERM"sv)
  1055. continue;
  1056. exec_environment.append(env_view);
  1057. }
  1058. TRY(Core::System::exec(command.at(0), command, Core::System::SearchInPath::Yes, exec_environment));
  1059. return {};
  1060. }
  1061. ErrorOr<void> join_jail(u64 jail_index)
  1062. {
  1063. Syscall::SC_jail_attach_params params { jail_index };
  1064. int rc = syscall(SC_jail_attach, &params);
  1065. HANDLE_SYSCALL_RETURN_VALUE("jail_attach", rc, {});
  1066. }
  1067. ErrorOr<u64> create_jail(StringView jail_name, JailIsolationFlags flags)
  1068. {
  1069. Syscall::SC_jail_create_params params { 0, { jail_name.characters_without_null_termination(), jail_name.length() }, static_cast<int>(flags) };
  1070. int rc = syscall(SC_jail_create, &params);
  1071. HANDLE_SYSCALL_RETURN_VALUE("jail_create", rc, static_cast<u64>(params.index));
  1072. }
  1073. #endif
  1074. ErrorOr<void> exec(StringView filename, ReadonlySpan<StringView> arguments, SearchInPath search_in_path, Optional<ReadonlySpan<StringView>> environment)
  1075. {
  1076. #ifdef AK_OS_SERENITY
  1077. Syscall::SC_execve_params params;
  1078. auto argument_strings = TRY(FixedArray<Syscall::StringArgument>::create(arguments.size()));
  1079. for (size_t i = 0; i < arguments.size(); ++i) {
  1080. argument_strings[i] = { arguments[i].characters_without_null_termination(), arguments[i].length() };
  1081. }
  1082. params.arguments.strings = argument_strings.data();
  1083. params.arguments.length = argument_strings.size();
  1084. size_t env_count = 0;
  1085. if (environment.has_value()) {
  1086. env_count = environment->size();
  1087. } else {
  1088. for (size_t i = 0; environ[i]; ++i)
  1089. ++env_count;
  1090. }
  1091. auto environment_strings = TRY(FixedArray<Syscall::StringArgument>::create(env_count));
  1092. if (environment.has_value()) {
  1093. for (size_t i = 0; i < env_count; ++i) {
  1094. environment_strings[i] = { environment->at(i).characters_without_null_termination(), environment->at(i).length() };
  1095. }
  1096. } else {
  1097. for (size_t i = 0; i < env_count; ++i) {
  1098. environment_strings[i] = { environ[i], strlen(environ[i]) };
  1099. }
  1100. }
  1101. params.environment.strings = environment_strings.data();
  1102. params.environment.length = environment_strings.size();
  1103. auto run_exec = [](Syscall::SC_execve_params& params) -> ErrorOr<void> {
  1104. int rc = syscall(Syscall::SC_execve, &params);
  1105. if (rc < 0)
  1106. return Error::from_syscall("exec"sv, rc);
  1107. return {};
  1108. };
  1109. StringView exec_filename;
  1110. String resolved_executable_path;
  1111. if (search_in_path == SearchInPath::Yes) {
  1112. auto executable_or_error = resolve_executable_from_environment(filename);
  1113. if (executable_or_error.is_error())
  1114. return executable_or_error.release_error();
  1115. resolved_executable_path = executable_or_error.release_value();
  1116. exec_filename = resolved_executable_path;
  1117. } else {
  1118. exec_filename = filename;
  1119. }
  1120. params.path = { exec_filename.characters_without_null_termination(), exec_filename.length() };
  1121. TRY(run_exec(params));
  1122. VERIFY_NOT_REACHED();
  1123. #else
  1124. DeprecatedString filename_string { filename };
  1125. auto argument_strings = TRY(FixedArray<DeprecatedString>::create(arguments.size()));
  1126. auto argv = TRY(FixedArray<char*>::create(arguments.size() + 1));
  1127. for (size_t i = 0; i < arguments.size(); ++i) {
  1128. argument_strings[i] = arguments[i].to_deprecated_string();
  1129. argv[i] = const_cast<char*>(argument_strings[i].characters());
  1130. }
  1131. argv[arguments.size()] = nullptr;
  1132. int rc = 0;
  1133. if (environment.has_value()) {
  1134. auto environment_strings = TRY(FixedArray<DeprecatedString>::create(environment->size()));
  1135. auto envp = TRY(FixedArray<char*>::create(environment->size() + 1));
  1136. for (size_t i = 0; i < environment->size(); ++i) {
  1137. environment_strings[i] = environment->at(i).to_deprecated_string();
  1138. envp[i] = const_cast<char*>(environment_strings[i].characters());
  1139. }
  1140. envp[environment->size()] = nullptr;
  1141. if (search_in_path == SearchInPath::Yes && !filename.contains('/')) {
  1142. # if defined(AK_OS_MACOS) || defined(AK_OS_FREEBSD) || defined(AK_OS_SOLARIS)
  1143. // These BSDs don't support execvpe(), so we'll have to manually search the PATH.
  1144. ScopedValueRollback errno_rollback(errno);
  1145. auto executable_or_error = resolve_executable_from_environment(filename_string);
  1146. if (executable_or_error.is_error()) {
  1147. errno_rollback.set_override_rollback_value(executable_or_error.error().code());
  1148. return executable_or_error.release_error();
  1149. }
  1150. DeprecatedString executable = executable_or_error.release_value().to_deprecated_string();
  1151. rc = ::execve(executable.characters(), argv.data(), envp.data());
  1152. # else
  1153. rc = ::execvpe(filename_string.characters(), argv.data(), envp.data());
  1154. # endif
  1155. } else {
  1156. rc = ::execve(filename_string.characters(), argv.data(), envp.data());
  1157. }
  1158. } else {
  1159. if (search_in_path == SearchInPath::Yes)
  1160. rc = ::execvp(filename_string.characters(), argv.data());
  1161. else
  1162. rc = ::execv(filename_string.characters(), argv.data());
  1163. }
  1164. if (rc < 0)
  1165. return Error::from_syscall("exec"sv, rc);
  1166. VERIFY_NOT_REACHED();
  1167. #endif
  1168. }
  1169. ErrorOr<int> socket(int domain, int type, int protocol)
  1170. {
  1171. auto fd = ::socket(domain, type, protocol);
  1172. if (fd < 0)
  1173. return Error::from_syscall("socket"sv, -errno);
  1174. return fd;
  1175. }
  1176. ErrorOr<void> bind(int sockfd, struct sockaddr const* address, socklen_t address_length)
  1177. {
  1178. if (::bind(sockfd, address, address_length) < 0)
  1179. return Error::from_syscall("bind"sv, -errno);
  1180. return {};
  1181. }
  1182. ErrorOr<void> listen(int sockfd, int backlog)
  1183. {
  1184. if (::listen(sockfd, backlog) < 0)
  1185. return Error::from_syscall("listen"sv, -errno);
  1186. return {};
  1187. }
  1188. ErrorOr<int> accept(int sockfd, struct sockaddr* address, socklen_t* address_length)
  1189. {
  1190. auto fd = ::accept(sockfd, address, address_length);
  1191. if (fd < 0)
  1192. return Error::from_syscall("accept"sv, -errno);
  1193. return fd;
  1194. }
  1195. ErrorOr<void> connect(int sockfd, struct sockaddr const* address, socklen_t address_length)
  1196. {
  1197. if (::connect(sockfd, address, address_length) < 0)
  1198. return Error::from_syscall("connect"sv, -errno);
  1199. return {};
  1200. }
  1201. ErrorOr<void> shutdown(int sockfd, int how)
  1202. {
  1203. if (::shutdown(sockfd, how) < 0)
  1204. return Error::from_syscall("shutdown"sv, -errno);
  1205. return {};
  1206. }
  1207. ErrorOr<ssize_t> send(int sockfd, void const* buffer, size_t buffer_length, int flags)
  1208. {
  1209. auto sent = ::send(sockfd, buffer, buffer_length, flags);
  1210. if (sent < 0)
  1211. return Error::from_syscall("send"sv, -errno);
  1212. return sent;
  1213. }
  1214. ErrorOr<ssize_t> sendmsg(int sockfd, const struct msghdr* message, int flags)
  1215. {
  1216. auto sent = ::sendmsg(sockfd, message, flags);
  1217. if (sent < 0)
  1218. return Error::from_syscall("sendmsg"sv, -errno);
  1219. return sent;
  1220. }
  1221. ErrorOr<ssize_t> sendto(int sockfd, void const* source, size_t source_length, int flags, struct sockaddr const* destination, socklen_t destination_length)
  1222. {
  1223. auto sent = ::sendto(sockfd, source, source_length, flags, destination, destination_length);
  1224. if (sent < 0)
  1225. return Error::from_syscall("sendto"sv, -errno);
  1226. return sent;
  1227. }
  1228. ErrorOr<ssize_t> recv(int sockfd, void* buffer, size_t length, int flags)
  1229. {
  1230. auto received = ::recv(sockfd, buffer, length, flags);
  1231. if (received < 0)
  1232. return Error::from_syscall("recv"sv, -errno);
  1233. return received;
  1234. }
  1235. ErrorOr<ssize_t> recvmsg(int sockfd, struct msghdr* message, int flags)
  1236. {
  1237. auto received = ::recvmsg(sockfd, message, flags);
  1238. if (received < 0)
  1239. return Error::from_syscall("recvmsg"sv, -errno);
  1240. return received;
  1241. }
  1242. ErrorOr<ssize_t> recvfrom(int sockfd, void* buffer, size_t buffer_length, int flags, struct sockaddr* address, socklen_t* address_length)
  1243. {
  1244. auto received = ::recvfrom(sockfd, buffer, buffer_length, flags, address, address_length);
  1245. if (received < 0)
  1246. return Error::from_syscall("recvfrom"sv, -errno);
  1247. return received;
  1248. }
  1249. ErrorOr<AddressInfoVector> getaddrinfo(char const* nodename, char const* servname, struct addrinfo const& hints)
  1250. {
  1251. struct addrinfo* results = nullptr;
  1252. int const rc = ::getaddrinfo(nodename, servname, &hints, &results);
  1253. if (rc != 0) {
  1254. if (rc == EAI_SYSTEM) {
  1255. return Error::from_syscall("getaddrinfo"sv, -errno);
  1256. }
  1257. auto const* error_string = gai_strerror(rc);
  1258. return Error::from_string_view({ error_string, strlen(error_string) });
  1259. }
  1260. Vector<struct addrinfo> addresses;
  1261. for (auto* result = results; result != nullptr; result = result->ai_next)
  1262. TRY(addresses.try_append(*result));
  1263. return AddressInfoVector { move(addresses), results };
  1264. }
  1265. ErrorOr<void> getsockopt(int sockfd, int level, int option, void* value, socklen_t* value_size)
  1266. {
  1267. if (::getsockopt(sockfd, level, option, value, value_size) < 0)
  1268. return Error::from_syscall("getsockopt"sv, -errno);
  1269. return {};
  1270. }
  1271. ErrorOr<void> setsockopt(int sockfd, int level, int option, void const* value, socklen_t value_size)
  1272. {
  1273. if (::setsockopt(sockfd, level, option, value, value_size) < 0)
  1274. return Error::from_syscall("setsockopt"sv, -errno);
  1275. return {};
  1276. }
  1277. ErrorOr<void> getsockname(int sockfd, struct sockaddr* address, socklen_t* address_length)
  1278. {
  1279. if (::getsockname(sockfd, address, address_length) < 0)
  1280. return Error::from_syscall("getsockname"sv, -errno);
  1281. return {};
  1282. }
  1283. ErrorOr<void> getpeername(int sockfd, struct sockaddr* address, socklen_t* address_length)
  1284. {
  1285. if (::getpeername(sockfd, address, address_length) < 0)
  1286. return Error::from_syscall("getpeername"sv, -errno);
  1287. return {};
  1288. }
  1289. ErrorOr<void> socketpair(int domain, int type, int protocol, int sv[2])
  1290. {
  1291. if (::socketpair(domain, type, protocol, sv) < 0)
  1292. return Error::from_syscall("socketpair"sv, -errno);
  1293. return {};
  1294. }
  1295. ErrorOr<Array<int, 2>> pipe2([[maybe_unused]] int flags)
  1296. {
  1297. Array<int, 2> fds;
  1298. #if defined(__unix__)
  1299. if (::pipe2(fds.data(), flags) < 0)
  1300. return Error::from_syscall("pipe2"sv, -errno);
  1301. #else
  1302. if (::pipe(fds.data()) < 0)
  1303. return Error::from_syscall("pipe2"sv, -errno);
  1304. #endif
  1305. return fds;
  1306. }
  1307. ErrorOr<Vector<gid_t>> getgroups()
  1308. {
  1309. int count = ::getgroups(0, nullptr);
  1310. if (count < 0)
  1311. return Error::from_syscall("getgroups"sv, -errno);
  1312. if (count == 0)
  1313. return Vector<gid_t> {};
  1314. Vector<gid_t> groups;
  1315. TRY(groups.try_resize(count));
  1316. if (::getgroups(count, groups.data()) < 0)
  1317. return Error::from_syscall("getgroups"sv, -errno);
  1318. return groups;
  1319. }
  1320. ErrorOr<void> setgroups(ReadonlySpan<gid_t> gids)
  1321. {
  1322. if (::setgroups(gids.size(), gids.data()) < 0)
  1323. return Error::from_syscall("setgroups"sv, -errno);
  1324. return {};
  1325. }
  1326. ErrorOr<void> mknod(StringView pathname, mode_t mode, dev_t dev)
  1327. {
  1328. if (pathname.is_null())
  1329. return Error::from_syscall("mknod"sv, -EFAULT);
  1330. #ifdef AK_OS_SERENITY
  1331. Syscall::SC_mknod_params params { { pathname.characters_without_null_termination(), pathname.length() }, mode, dev };
  1332. int rc = syscall(SC_mknod, &params);
  1333. HANDLE_SYSCALL_RETURN_VALUE("mknod", rc, {});
  1334. #else
  1335. DeprecatedString path_string = pathname;
  1336. if (::mknod(path_string.characters(), mode, dev) < 0)
  1337. return Error::from_syscall("mknod"sv, -errno);
  1338. return {};
  1339. #endif
  1340. }
  1341. ErrorOr<void> mkfifo(StringView pathname, mode_t mode)
  1342. {
  1343. return mknod(pathname, mode | S_IFIFO, 0);
  1344. }
  1345. ErrorOr<void> setenv(StringView name, StringView value, bool overwrite)
  1346. {
  1347. auto builder = TRY(StringBuilder::create());
  1348. TRY(builder.try_append(name));
  1349. TRY(builder.try_append('\0'));
  1350. TRY(builder.try_append(value));
  1351. TRY(builder.try_append('\0'));
  1352. // Note the explicit null terminators above.
  1353. auto c_name = builder.string_view().characters_without_null_termination();
  1354. auto c_value = c_name + name.length() + 1;
  1355. auto rc = ::setenv(c_name, c_value, overwrite);
  1356. if (rc < 0)
  1357. return Error::from_errno(errno);
  1358. return {};
  1359. }
  1360. ErrorOr<void> putenv(StringView env)
  1361. {
  1362. #ifdef AK_OS_SERENITY
  1363. auto rc = serenity_putenv(env.characters_without_null_termination(), env.length());
  1364. #else
  1365. // Leak somewhat unavoidable here due to the putenv API.
  1366. auto leaked_new_env = strndup(env.characters_without_null_termination(), env.length());
  1367. auto rc = ::putenv(leaked_new_env);
  1368. #endif
  1369. if (rc < 0)
  1370. return Error::from_errno(errno);
  1371. return {};
  1372. }
  1373. ErrorOr<int> posix_openpt(int flags)
  1374. {
  1375. int const rc = ::posix_openpt(flags);
  1376. if (rc < 0)
  1377. return Error::from_syscall("posix_openpt"sv, -errno);
  1378. return rc;
  1379. }
  1380. ErrorOr<void> grantpt(int fildes)
  1381. {
  1382. auto const rc = ::grantpt(fildes);
  1383. if (rc < 0)
  1384. return Error::from_syscall("grantpt"sv, -errno);
  1385. return {};
  1386. }
  1387. ErrorOr<void> unlockpt(int fildes)
  1388. {
  1389. auto const rc = ::unlockpt(fildes);
  1390. if (rc < 0)
  1391. return Error::from_syscall("unlockpt"sv, -errno);
  1392. return {};
  1393. }
  1394. ErrorOr<void> access(StringView pathname, int mode, int flags)
  1395. {
  1396. if (pathname.is_null())
  1397. return Error::from_syscall("access"sv, -EFAULT);
  1398. #ifdef AK_OS_SERENITY
  1399. Syscall::SC_faccessat_params params {
  1400. .dirfd = AT_FDCWD,
  1401. .pathname = { pathname.characters_without_null_termination(), pathname.length() },
  1402. .mode = mode,
  1403. .flags = flags,
  1404. };
  1405. int rc = ::syscall(Syscall::SC_faccessat, &params);
  1406. HANDLE_SYSCALL_RETURN_VALUE("access", rc, {});
  1407. #else
  1408. DeprecatedString path_string = pathname;
  1409. (void)flags;
  1410. if (::access(path_string.characters(), mode) < 0)
  1411. return Error::from_syscall("access"sv, -errno);
  1412. return {};
  1413. #endif
  1414. }
  1415. ErrorOr<DeprecatedString> readlink(StringView pathname)
  1416. {
  1417. // FIXME: Try again with a larger buffer.
  1418. char data[PATH_MAX];
  1419. #ifdef AK_OS_SERENITY
  1420. Syscall::SC_readlink_params small_params {
  1421. .path = { pathname.characters_without_null_termination(), pathname.length() },
  1422. .buffer = { data, sizeof(data) },
  1423. .dirfd = AT_FDCWD,
  1424. };
  1425. int rc = syscall(SC_readlink, &small_params);
  1426. HANDLE_SYSCALL_RETURN_VALUE("readlink", rc, DeprecatedString(data, rc));
  1427. #else
  1428. DeprecatedString path_string = pathname;
  1429. int rc = ::readlink(path_string.characters(), data, sizeof(data));
  1430. if (rc == -1)
  1431. return Error::from_syscall("readlink"sv, -errno);
  1432. return DeprecatedString(data, rc);
  1433. #endif
  1434. }
  1435. ErrorOr<int> poll(Span<struct pollfd> poll_fds, int timeout)
  1436. {
  1437. auto const rc = ::poll(poll_fds.data(), poll_fds.size(), timeout);
  1438. if (rc < 0)
  1439. return Error::from_syscall("poll"sv, -errno);
  1440. return { rc };
  1441. }
  1442. #ifdef AK_OS_SERENITY
  1443. ErrorOr<void> posix_fallocate(int fd, off_t offset, off_t length)
  1444. {
  1445. int rc = ::posix_fallocate(fd, offset, length);
  1446. if (rc != 0)
  1447. return Error::from_syscall("posix_fallocate"sv, -rc);
  1448. return {};
  1449. }
  1450. #endif
  1451. // This constant is copied from LibFileSystem. We cannot use or even include it directly,
  1452. // because that would cause a dependency of LibCore on LibFileSystem, effectively rendering
  1453. // the distinction between these libraries moot.
  1454. static constexpr StringView INTERNAL_DEFAULT_PATH_SV = "/usr/local/sbin:/usr/local/bin:/usr/bin:/bin"sv;
  1455. ErrorOr<String> resolve_executable_from_environment(StringView filename, int flags)
  1456. {
  1457. if (filename.is_empty())
  1458. return Error::from_errno(ENOENT);
  1459. // Paths that aren't just a file name generally count as already resolved.
  1460. if (filename.contains('/')) {
  1461. TRY(Core::System::access(filename, X_OK, flags));
  1462. return TRY(String::from_utf8(filename));
  1463. }
  1464. auto const* path_str = ::getenv("PATH");
  1465. StringView path;
  1466. if (path_str)
  1467. path = { path_str, strlen(path_str) };
  1468. if (path.is_empty())
  1469. path = INTERNAL_DEFAULT_PATH_SV;
  1470. auto directories = path.split_view(':');
  1471. for (auto directory : directories) {
  1472. auto file = TRY(String::formatted("{}/{}", directory, filename));
  1473. if (!Core::System::access(file, X_OK, flags).is_error())
  1474. return file;
  1475. }
  1476. return Error::from_errno(ENOENT);
  1477. }
  1478. }