System.cpp 51 KB

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