Process.h 43 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038
  1. /*
  2. * Copyright (c) 2018-2023, Andreas Kling <kling@serenityos.org>
  3. *
  4. * SPDX-License-Identifier: BSD-2-Clause
  5. */
  6. #pragma once
  7. #include <AK/Concepts.h>
  8. #include <AK/HashMap.h>
  9. #include <AK/IntrusiveList.h>
  10. #include <AK/IntrusiveListRelaxedConst.h>
  11. #include <AK/OwnPtr.h>
  12. #include <AK/RefPtr.h>
  13. #include <AK/Userspace.h>
  14. #include <AK/Variant.h>
  15. #include <Kernel/API/POSIX/select.h>
  16. #include <Kernel/API/POSIX/sys/resource.h>
  17. #include <Kernel/API/Syscall.h>
  18. #include <Kernel/Assertions.h>
  19. #include <Kernel/AtomicEdgeAction.h>
  20. #include <Kernel/Credentials.h>
  21. #include <Kernel/FileSystem/InodeMetadata.h>
  22. #include <Kernel/FileSystem/OpenFileDescription.h>
  23. #include <Kernel/FileSystem/UnveilNode.h>
  24. #include <Kernel/Forward.h>
  25. #include <Kernel/FutexQueue.h>
  26. #include <Kernel/Jail.h>
  27. #include <Kernel/Library/LockWeakPtr.h>
  28. #include <Kernel/Library/LockWeakable.h>
  29. #include <Kernel/Locking/Mutex.h>
  30. #include <Kernel/Locking/MutexProtected.h>
  31. #include <Kernel/Memory/AddressSpace.h>
  32. #include <Kernel/PerformanceEventBuffer.h>
  33. #include <Kernel/ProcessGroup.h>
  34. #include <Kernel/StdLib.h>
  35. #include <Kernel/Thread.h>
  36. #include <Kernel/UnixTypes.h>
  37. #include <LibC/elf.h>
  38. namespace Kernel {
  39. MutexProtected<OwnPtr<KString>>& hostname();
  40. Time kgettimeofday();
  41. #define ENUMERATE_PLEDGE_PROMISES \
  42. __ENUMERATE_PLEDGE_PROMISE(stdio) \
  43. __ENUMERATE_PLEDGE_PROMISE(rpath) \
  44. __ENUMERATE_PLEDGE_PROMISE(wpath) \
  45. __ENUMERATE_PLEDGE_PROMISE(cpath) \
  46. __ENUMERATE_PLEDGE_PROMISE(dpath) \
  47. __ENUMERATE_PLEDGE_PROMISE(inet) \
  48. __ENUMERATE_PLEDGE_PROMISE(id) \
  49. __ENUMERATE_PLEDGE_PROMISE(proc) \
  50. __ENUMERATE_PLEDGE_PROMISE(ptrace) \
  51. __ENUMERATE_PLEDGE_PROMISE(exec) \
  52. __ENUMERATE_PLEDGE_PROMISE(unix) \
  53. __ENUMERATE_PLEDGE_PROMISE(recvfd) \
  54. __ENUMERATE_PLEDGE_PROMISE(sendfd) \
  55. __ENUMERATE_PLEDGE_PROMISE(fattr) \
  56. __ENUMERATE_PLEDGE_PROMISE(tty) \
  57. __ENUMERATE_PLEDGE_PROMISE(chown) \
  58. __ENUMERATE_PLEDGE_PROMISE(thread) \
  59. __ENUMERATE_PLEDGE_PROMISE(video) \
  60. __ENUMERATE_PLEDGE_PROMISE(accept) \
  61. __ENUMERATE_PLEDGE_PROMISE(settime) \
  62. __ENUMERATE_PLEDGE_PROMISE(sigaction) \
  63. __ENUMERATE_PLEDGE_PROMISE(setkeymap) \
  64. __ENUMERATE_PLEDGE_PROMISE(prot_exec) \
  65. __ENUMERATE_PLEDGE_PROMISE(map_fixed) \
  66. __ENUMERATE_PLEDGE_PROMISE(getkeymap) \
  67. __ENUMERATE_PLEDGE_PROMISE(jail) \
  68. __ENUMERATE_PLEDGE_PROMISE(no_error)
  69. enum class Pledge : u32 {
  70. #define __ENUMERATE_PLEDGE_PROMISE(x) x,
  71. ENUMERATE_PLEDGE_PROMISES
  72. #undef __ENUMERATE_PLEDGE_PROMISE
  73. };
  74. enum class VeilState {
  75. None,
  76. Dropped,
  77. Locked,
  78. LockedInherited,
  79. };
  80. static constexpr FlatPtr futex_key_private_flag = 0b1;
  81. union GlobalFutexKey {
  82. struct {
  83. Memory::VMObject const* vmobject;
  84. FlatPtr offset;
  85. } shared;
  86. struct {
  87. Memory::AddressSpace const* address_space;
  88. FlatPtr user_address;
  89. } private_;
  90. struct {
  91. FlatPtr parent;
  92. FlatPtr offset;
  93. } raw;
  94. };
  95. static_assert(sizeof(GlobalFutexKey) == (sizeof(FlatPtr) * 2));
  96. struct LoadResult;
  97. class ProcessList;
  98. class Process final
  99. : public ListedRefCounted<Process, LockType::Spinlock>
  100. , public LockWeakable<Process> {
  101. class ProtectedValues {
  102. public:
  103. ProcessID pid { 0 };
  104. ProcessID ppid { 0 };
  105. // FIXME: This should be a NonnullRefPtr
  106. RefPtr<Credentials> credentials;
  107. RefPtr<ProcessGroup> process_group;
  108. RefPtr<TTY> tty;
  109. bool dumpable { false };
  110. bool executable_is_setid { false };
  111. Atomic<bool> has_promises { false };
  112. Atomic<u32> promises { 0 };
  113. Atomic<bool> has_execpromises { false };
  114. Atomic<u32> execpromises { 0 };
  115. mode_t umask { 022 };
  116. VirtualAddress signal_trampoline;
  117. Atomic<u32> thread_count { 0 };
  118. u8 termination_status { 0 };
  119. u8 termination_signal { 0 };
  120. };
  121. public:
  122. AK_MAKE_NONCOPYABLE(Process);
  123. AK_MAKE_NONMOVABLE(Process);
  124. MAKE_ALIGNED_ALLOCATED(Process, PAGE_SIZE);
  125. friend class Thread;
  126. friend class Coredump;
  127. auto with_protected_data(auto&& callback) const
  128. {
  129. SpinlockLocker locker(m_protected_data_lock);
  130. return callback(m_protected_values_do_not_access_directly);
  131. }
  132. auto with_mutable_protected_data(auto&& callback)
  133. {
  134. SpinlockLocker locker(m_protected_data_lock);
  135. unprotect_data();
  136. auto guard = ScopeGuard([&] { protect_data(); });
  137. return callback(m_protected_values_do_not_access_directly);
  138. }
  139. enum class State : u8 {
  140. Running = 0,
  141. Dying,
  142. Dead
  143. };
  144. public:
  145. static Process& current()
  146. {
  147. auto* current_thread = Processor::current_thread();
  148. VERIFY(current_thread);
  149. return current_thread->process();
  150. }
  151. static bool has_current()
  152. {
  153. return Processor::current_thread() != nullptr;
  154. }
  155. template<typename EntryFunction>
  156. static void kernel_process_trampoline(void* data)
  157. {
  158. EntryFunction* func = reinterpret_cast<EntryFunction*>(data);
  159. (*func)();
  160. delete func;
  161. }
  162. enum class RegisterProcess {
  163. No,
  164. Yes
  165. };
  166. struct ProcessAndFirstThread {
  167. NonnullRefPtr<Process> process;
  168. NonnullRefPtr<Thread> first_thread;
  169. };
  170. template<typename EntryFunction>
  171. static ErrorOr<ProcessAndFirstThread> create_kernel_process(NonnullOwnPtr<KString> name, EntryFunction entry, u32 affinity = THREAD_AFFINITY_DEFAULT, RegisterProcess do_register = RegisterProcess::Yes)
  172. {
  173. auto* entry_func = new EntryFunction(move(entry));
  174. return create_kernel_process(move(name), &Process::kernel_process_trampoline<EntryFunction>, entry_func, affinity, do_register);
  175. }
  176. static ErrorOr<ProcessAndFirstThread> create_kernel_process(NonnullOwnPtr<KString> name, void (*entry)(void*), void* entry_data = nullptr, u32 affinity = THREAD_AFFINITY_DEFAULT, RegisterProcess do_register = RegisterProcess::Yes);
  177. static ErrorOr<ProcessAndFirstThread> create_user_process(StringView path, UserID, GroupID, Vector<NonnullOwnPtr<KString>> arguments, Vector<NonnullOwnPtr<KString>> environment, RefPtr<TTY>);
  178. static void register_new(Process&);
  179. ~Process();
  180. virtual void remove_from_secondary_lists();
  181. ErrorOr<NonnullRefPtr<Thread>> create_kernel_thread(void (*entry)(void*), void* entry_data, u32 priority, NonnullOwnPtr<KString> name, u32 affinity = THREAD_AFFINITY_DEFAULT, bool joinable = true);
  182. bool is_profiling() const { return m_profiling; }
  183. void set_profiling(bool profiling) { m_profiling = profiling; }
  184. bool should_generate_coredump() const { return m_should_generate_coredump; }
  185. void set_should_generate_coredump(bool b) { m_should_generate_coredump = b; }
  186. bool is_dying() const { return m_state.load(AK::MemoryOrder::memory_order_acquire) != State::Running; }
  187. bool is_dead() const { return m_state.load(AK::MemoryOrder::memory_order_acquire) == State::Dead; }
  188. bool is_stopped() const { return m_is_stopped; }
  189. bool set_stopped(bool stopped) { return m_is_stopped.exchange(stopped); }
  190. bool is_kernel_process() const { return m_is_kernel_process; }
  191. bool is_user_process() const { return !m_is_kernel_process; }
  192. static RefPtr<Process> from_pid_in_same_jail(ProcessID);
  193. static RefPtr<Process> from_pid_ignoring_jails(ProcessID);
  194. static SessionID get_sid_from_pgid(ProcessGroupID pgid);
  195. SpinlockProtected<NonnullOwnPtr<KString>, LockRank::None> const& name() const;
  196. void set_name(NonnullOwnPtr<KString>);
  197. ProcessID pid() const
  198. {
  199. return with_protected_data([](auto& protected_data) { return protected_data.pid; });
  200. }
  201. SessionID sid() const { return credentials()->sid(); }
  202. bool is_session_leader() const { return sid().value() == pid().value(); }
  203. ProcessGroupID pgid() const
  204. {
  205. return with_protected_data([](auto& protected_data) { return protected_data.process_group ? protected_data.process_group->pgid() : 0; });
  206. }
  207. bool is_group_leader() const { return pgid().value() == pid().value(); }
  208. ProcessID ppid() const
  209. {
  210. return with_protected_data([](auto& protected_data) { return protected_data.ppid; });
  211. }
  212. SpinlockProtected<RefPtr<Jail>, LockRank::Process> const& jail() { return m_attached_jail; }
  213. bool is_currently_in_jail() const
  214. {
  215. return m_attached_jail.with([&](auto& jail) -> bool { return !jail.is_null(); });
  216. }
  217. NonnullRefPtr<Credentials> credentials() const;
  218. bool is_dumpable() const
  219. {
  220. return with_protected_data([](auto& protected_data) { return protected_data.dumpable; });
  221. }
  222. mode_t umask() const
  223. {
  224. return with_protected_data([](auto& protected_data) { return protected_data.umask; });
  225. }
  226. // Breakable iteration functions
  227. template<IteratorFunction<Process&> Callback>
  228. static void for_each_ignoring_jails(Callback);
  229. static ErrorOr<void> for_each_in_same_jail(Function<ErrorOr<void>(Process&)>);
  230. ErrorOr<void> for_each_in_pgrp_in_same_jail(ProcessGroupID, Function<ErrorOr<void>(Process&)>);
  231. ErrorOr<void> for_each_child_in_same_jail(Function<ErrorOr<void>(Process&)>);
  232. template<IteratorFunction<Thread&> Callback>
  233. IterationDecision for_each_thread(Callback);
  234. template<IteratorFunction<Thread&> Callback>
  235. IterationDecision for_each_thread(Callback callback) const;
  236. ErrorOr<void> try_for_each_thread(Function<ErrorOr<void>(Thread const&)>) const;
  237. // Non-breakable iteration functions
  238. template<VoidFunction<Process&> Callback>
  239. static void for_each_ignoring_jails(Callback);
  240. template<VoidFunction<Thread&> Callback>
  241. IterationDecision for_each_thread(Callback);
  242. template<VoidFunction<Thread&> Callback>
  243. IterationDecision for_each_thread(Callback callback) const;
  244. void die();
  245. void finalize();
  246. ThreadTracer* tracer() { return m_tracer.ptr(); }
  247. bool is_traced() const { return !!m_tracer; }
  248. ErrorOr<void> start_tracing_from(ProcessID tracer);
  249. void stop_tracing();
  250. void tracer_trap(Thread&, RegisterState const&);
  251. ErrorOr<FlatPtr> sys$emuctl();
  252. ErrorOr<FlatPtr> sys$yield();
  253. ErrorOr<FlatPtr> sys$sync();
  254. ErrorOr<FlatPtr> sys$beep(int tone);
  255. ErrorOr<FlatPtr> sys$create_inode_watcher(u32 flags);
  256. ErrorOr<FlatPtr> sys$inode_watcher_add_watch(Userspace<Syscall::SC_inode_watcher_add_watch_params const*> user_params);
  257. ErrorOr<FlatPtr> sys$inode_watcher_remove_watch(int fd, int wd);
  258. ErrorOr<FlatPtr> sys$dbgputstr(Userspace<char const*>, size_t);
  259. ErrorOr<FlatPtr> sys$dump_backtrace();
  260. ErrorOr<FlatPtr> sys$gettid();
  261. ErrorOr<FlatPtr> sys$setsid();
  262. ErrorOr<FlatPtr> sys$getsid(pid_t);
  263. ErrorOr<FlatPtr> sys$setpgid(pid_t pid, pid_t pgid);
  264. ErrorOr<FlatPtr> sys$getpgrp();
  265. ErrorOr<FlatPtr> sys$getpgid(pid_t);
  266. ErrorOr<FlatPtr> sys$getuid();
  267. ErrorOr<FlatPtr> sys$getgid();
  268. ErrorOr<FlatPtr> sys$geteuid();
  269. ErrorOr<FlatPtr> sys$getegid();
  270. ErrorOr<FlatPtr> sys$getpid();
  271. ErrorOr<FlatPtr> sys$getppid();
  272. ErrorOr<FlatPtr> sys$getresuid(Userspace<UserID*>, Userspace<UserID*>, Userspace<UserID*>);
  273. ErrorOr<FlatPtr> sys$getresgid(Userspace<GroupID*>, Userspace<GroupID*>, Userspace<GroupID*>);
  274. ErrorOr<FlatPtr> sys$getrusage(int, Userspace<rusage*>);
  275. ErrorOr<FlatPtr> sys$umask(mode_t);
  276. ErrorOr<FlatPtr> sys$open(Userspace<Syscall::SC_open_params const*>);
  277. ErrorOr<FlatPtr> sys$close(int fd);
  278. ErrorOr<FlatPtr> sys$read(int fd, Userspace<u8*>, size_t);
  279. ErrorOr<FlatPtr> sys$pread(int fd, Userspace<u8*>, size_t, Userspace<off_t const*>);
  280. ErrorOr<FlatPtr> sys$readv(int fd, Userspace<const struct iovec*> iov, int iov_count);
  281. ErrorOr<FlatPtr> sys$write(int fd, Userspace<u8 const*>, size_t);
  282. ErrorOr<FlatPtr> sys$pwritev(int fd, Userspace<const struct iovec*> iov, int iov_count, Userspace<off_t const*>);
  283. ErrorOr<FlatPtr> sys$fstat(int fd, Userspace<stat*>);
  284. ErrorOr<FlatPtr> sys$stat(Userspace<Syscall::SC_stat_params const*>);
  285. ErrorOr<FlatPtr> sys$annotate_mapping(Userspace<void*>, int flags);
  286. ErrorOr<FlatPtr> sys$lseek(int fd, Userspace<off_t*>, int whence);
  287. ErrorOr<FlatPtr> sys$ftruncate(int fd, Userspace<off_t const*>);
  288. ErrorOr<FlatPtr> sys$futimens(Userspace<Syscall::SC_futimens_params const*>);
  289. ErrorOr<FlatPtr> sys$posix_fallocate(int fd, Userspace<off_t const*>, Userspace<off_t const*>);
  290. ErrorOr<FlatPtr> sys$kill(pid_t pid_or_pgid, int sig);
  291. [[noreturn]] void sys$exit(int status);
  292. ErrorOr<FlatPtr> sys$sigreturn(RegisterState& registers);
  293. ErrorOr<FlatPtr> sys$waitid(Userspace<Syscall::SC_waitid_params const*>);
  294. ErrorOr<FlatPtr> sys$mmap(Userspace<Syscall::SC_mmap_params const*>);
  295. ErrorOr<FlatPtr> sys$mremap(Userspace<Syscall::SC_mremap_params const*>);
  296. ErrorOr<FlatPtr> sys$munmap(Userspace<void*>, size_t);
  297. ErrorOr<FlatPtr> sys$set_mmap_name(Userspace<Syscall::SC_set_mmap_name_params const*>);
  298. ErrorOr<FlatPtr> sys$mprotect(Userspace<void*>, size_t, int prot);
  299. ErrorOr<FlatPtr> sys$madvise(Userspace<void*>, size_t, int advice);
  300. ErrorOr<FlatPtr> sys$msync(Userspace<void*>, size_t, int flags);
  301. ErrorOr<FlatPtr> sys$purge(int mode);
  302. ErrorOr<FlatPtr> sys$poll(Userspace<Syscall::SC_poll_params const*>);
  303. ErrorOr<FlatPtr> sys$get_dir_entries(int fd, Userspace<void*>, size_t);
  304. ErrorOr<FlatPtr> sys$getcwd(Userspace<char*>, size_t);
  305. ErrorOr<FlatPtr> sys$chdir(Userspace<char const*>, size_t);
  306. ErrorOr<FlatPtr> sys$fchdir(int fd);
  307. ErrorOr<FlatPtr> sys$adjtime(Userspace<timeval const*>, Userspace<timeval*>);
  308. ErrorOr<FlatPtr> sys$clock_gettime(clockid_t, Userspace<timespec*>);
  309. ErrorOr<FlatPtr> sys$clock_settime(clockid_t, Userspace<timespec const*>);
  310. ErrorOr<FlatPtr> sys$clock_nanosleep(Userspace<Syscall::SC_clock_nanosleep_params const*>);
  311. ErrorOr<FlatPtr> sys$clock_getres(Userspace<Syscall::SC_clock_getres_params const*>);
  312. ErrorOr<FlatPtr> sys$gethostname(Userspace<char*>, size_t);
  313. ErrorOr<FlatPtr> sys$sethostname(Userspace<char const*>, size_t);
  314. ErrorOr<FlatPtr> sys$uname(Userspace<utsname*>);
  315. ErrorOr<FlatPtr> sys$readlink(Userspace<Syscall::SC_readlink_params const*>);
  316. ErrorOr<FlatPtr> sys$fork(RegisterState&);
  317. ErrorOr<FlatPtr> sys$execve(Userspace<Syscall::SC_execve_params const*>);
  318. ErrorOr<FlatPtr> sys$dup2(int old_fd, int new_fd);
  319. ErrorOr<FlatPtr> sys$sigaction(int signum, Userspace<sigaction const*> act, Userspace<sigaction*> old_act);
  320. ErrorOr<FlatPtr> sys$sigaltstack(Userspace<stack_t const*> ss, Userspace<stack_t*> old_ss);
  321. ErrorOr<FlatPtr> sys$sigprocmask(int how, Userspace<sigset_t const*> set, Userspace<sigset_t*> old_set);
  322. ErrorOr<FlatPtr> sys$sigpending(Userspace<sigset_t*>);
  323. ErrorOr<FlatPtr> sys$sigsuspend(Userspace<sigset_t const*>);
  324. ErrorOr<FlatPtr> sys$sigtimedwait(Userspace<sigset_t const*>, Userspace<siginfo_t*>, Userspace<timespec const*>);
  325. ErrorOr<FlatPtr> sys$getgroups(size_t, Userspace<GroupID*>);
  326. ErrorOr<FlatPtr> sys$setgroups(size_t, Userspace<GroupID const*>);
  327. ErrorOr<FlatPtr> sys$pipe(Userspace<int*>, int flags);
  328. ErrorOr<FlatPtr> sys$killpg(pid_t pgrp, int sig);
  329. ErrorOr<FlatPtr> sys$seteuid(UserID);
  330. ErrorOr<FlatPtr> sys$setegid(GroupID);
  331. ErrorOr<FlatPtr> sys$setuid(UserID);
  332. ErrorOr<FlatPtr> sys$setgid(GroupID);
  333. ErrorOr<FlatPtr> sys$setreuid(UserID, UserID);
  334. ErrorOr<FlatPtr> sys$setresuid(UserID, UserID, UserID);
  335. ErrorOr<FlatPtr> sys$setregid(GroupID, GroupID);
  336. ErrorOr<FlatPtr> sys$setresgid(GroupID, GroupID, GroupID);
  337. ErrorOr<FlatPtr> sys$alarm(unsigned seconds);
  338. ErrorOr<FlatPtr> sys$faccessat(Userspace<Syscall::SC_faccessat_params const*>);
  339. ErrorOr<FlatPtr> sys$fcntl(int fd, int cmd, uintptr_t extra_arg);
  340. ErrorOr<FlatPtr> sys$ioctl(int fd, unsigned request, FlatPtr arg);
  341. ErrorOr<FlatPtr> sys$mkdir(int dirfd, Userspace<char const*> pathname, size_t path_length, mode_t mode);
  342. ErrorOr<FlatPtr> sys$times(Userspace<tms*>);
  343. ErrorOr<FlatPtr> sys$utime(Userspace<char const*> pathname, size_t path_length, Userspace<const struct utimbuf*>);
  344. ErrorOr<FlatPtr> sys$utimensat(Userspace<Syscall::SC_utimensat_params const*>);
  345. ErrorOr<FlatPtr> sys$link(Userspace<Syscall::SC_link_params const*>);
  346. ErrorOr<FlatPtr> sys$unlink(int dirfd, Userspace<char const*> pathname, size_t path_length, int flags);
  347. ErrorOr<FlatPtr> sys$symlink(Userspace<Syscall::SC_symlink_params const*>);
  348. ErrorOr<FlatPtr> sys$rmdir(Userspace<char const*> pathname, size_t path_length);
  349. ErrorOr<FlatPtr> sys$mount(Userspace<Syscall::SC_mount_params const*>);
  350. ErrorOr<FlatPtr> sys$umount(Userspace<char const*> mountpoint, size_t mountpoint_length);
  351. ErrorOr<FlatPtr> sys$chmod(Userspace<Syscall::SC_chmod_params const*>);
  352. ErrorOr<FlatPtr> sys$fchmod(int fd, mode_t);
  353. ErrorOr<FlatPtr> sys$chown(Userspace<Syscall::SC_chown_params const*>);
  354. ErrorOr<FlatPtr> sys$fchown(int fd, UserID, GroupID);
  355. ErrorOr<FlatPtr> sys$fsync(int fd);
  356. ErrorOr<FlatPtr> sys$socket(int domain, int type, int protocol);
  357. ErrorOr<FlatPtr> sys$bind(int sockfd, Userspace<sockaddr const*> addr, socklen_t);
  358. ErrorOr<FlatPtr> sys$listen(int sockfd, int backlog);
  359. ErrorOr<FlatPtr> sys$accept4(Userspace<Syscall::SC_accept4_params const*>);
  360. ErrorOr<FlatPtr> sys$connect(int sockfd, Userspace<sockaddr const*>, socklen_t);
  361. ErrorOr<FlatPtr> sys$shutdown(int sockfd, int how);
  362. ErrorOr<FlatPtr> sys$sendmsg(int sockfd, Userspace<const struct msghdr*>, int flags);
  363. ErrorOr<FlatPtr> sys$recvmsg(int sockfd, Userspace<struct msghdr*>, int flags);
  364. ErrorOr<FlatPtr> sys$getsockopt(Userspace<Syscall::SC_getsockopt_params const*>);
  365. ErrorOr<FlatPtr> sys$setsockopt(Userspace<Syscall::SC_setsockopt_params const*>);
  366. ErrorOr<FlatPtr> sys$getsockname(Userspace<Syscall::SC_getsockname_params const*>);
  367. ErrorOr<FlatPtr> sys$getpeername(Userspace<Syscall::SC_getpeername_params const*>);
  368. ErrorOr<FlatPtr> sys$socketpair(Userspace<Syscall::SC_socketpair_params const*>);
  369. ErrorOr<FlatPtr> sys$scheduler_set_parameters(Userspace<Syscall::SC_scheduler_parameters_params const*>);
  370. ErrorOr<FlatPtr> sys$scheduler_get_parameters(Userspace<Syscall::SC_scheduler_parameters_params*>);
  371. ErrorOr<FlatPtr> sys$create_thread(void* (*)(void*), Userspace<Syscall::SC_create_thread_params const*>);
  372. [[noreturn]] void sys$exit_thread(Userspace<void*>, Userspace<void*>, size_t);
  373. ErrorOr<FlatPtr> sys$join_thread(pid_t tid, Userspace<void**> exit_value);
  374. ErrorOr<FlatPtr> sys$detach_thread(pid_t tid);
  375. ErrorOr<FlatPtr> sys$set_thread_name(pid_t tid, Userspace<char const*> buffer, size_t buffer_size);
  376. ErrorOr<FlatPtr> sys$get_thread_name(pid_t tid, Userspace<char*> buffer, size_t buffer_size);
  377. ErrorOr<FlatPtr> sys$kill_thread(pid_t tid, int signal);
  378. ErrorOr<FlatPtr> sys$rename(Userspace<Syscall::SC_rename_params const*>);
  379. ErrorOr<FlatPtr> sys$mknod(Userspace<Syscall::SC_mknod_params const*>);
  380. ErrorOr<FlatPtr> sys$realpath(Userspace<Syscall::SC_realpath_params const*>);
  381. ErrorOr<FlatPtr> sys$getrandom(Userspace<void*>, size_t, unsigned int);
  382. ErrorOr<FlatPtr> sys$getkeymap(Userspace<Syscall::SC_getkeymap_params const*>);
  383. ErrorOr<FlatPtr> sys$setkeymap(Userspace<Syscall::SC_setkeymap_params const*>);
  384. ErrorOr<FlatPtr> sys$profiling_enable(pid_t, Userspace<u64 const*>);
  385. ErrorOr<FlatPtr> profiling_enable(pid_t, u64 event_mask);
  386. ErrorOr<FlatPtr> sys$profiling_disable(pid_t);
  387. ErrorOr<FlatPtr> sys$profiling_free_buffer(pid_t);
  388. ErrorOr<FlatPtr> sys$futex(Userspace<Syscall::SC_futex_params const*>);
  389. ErrorOr<FlatPtr> sys$pledge(Userspace<Syscall::SC_pledge_params const*>);
  390. ErrorOr<FlatPtr> sys$unveil(Userspace<Syscall::SC_unveil_params const*>);
  391. ErrorOr<FlatPtr> sys$perf_event(int type, FlatPtr arg1, FlatPtr arg2);
  392. ErrorOr<FlatPtr> sys$perf_register_string(Userspace<char const*>, size_t);
  393. ErrorOr<FlatPtr> sys$get_stack_bounds(Userspace<FlatPtr*> stack_base, Userspace<size_t*> stack_size);
  394. ErrorOr<FlatPtr> sys$ptrace(Userspace<Syscall::SC_ptrace_params const*>);
  395. ErrorOr<FlatPtr> sys$sendfd(int sockfd, int fd);
  396. ErrorOr<FlatPtr> sys$recvfd(int sockfd, int options);
  397. ErrorOr<FlatPtr> sys$sysconf(int name);
  398. ErrorOr<FlatPtr> sys$disown(ProcessID);
  399. ErrorOr<FlatPtr> sys$allocate_tls(Userspace<char const*> initial_data, size_t);
  400. ErrorOr<FlatPtr> sys$prctl(int option, FlatPtr arg1, FlatPtr arg2);
  401. ErrorOr<FlatPtr> sys$anon_create(size_t, int options);
  402. ErrorOr<FlatPtr> sys$statvfs(Userspace<Syscall::SC_statvfs_params const*> user_params);
  403. ErrorOr<FlatPtr> sys$fstatvfs(int fd, statvfs* buf);
  404. ErrorOr<FlatPtr> sys$map_time_page();
  405. ErrorOr<FlatPtr> sys$jail_create(Userspace<Syscall::SC_jail_create_params*> user_params);
  406. ErrorOr<FlatPtr> sys$jail_attach(Userspace<Syscall::SC_jail_attach_params const*> user_params);
  407. ErrorOr<FlatPtr> sys$get_root_session_id(pid_t force_sid);
  408. enum SockOrPeerName {
  409. SockName,
  410. PeerName,
  411. };
  412. template<SockOrPeerName, typename Params>
  413. ErrorOr<void> get_sock_or_peer_name(Params const&);
  414. static void initialize();
  415. [[noreturn]] void crash(int signal, Optional<RegisterState const&> regs, bool out_of_memory = false);
  416. [[nodiscard]] siginfo_t wait_info() const;
  417. RefPtr<TTY> tty();
  418. RefPtr<TTY const> tty() const;
  419. void set_tty(RefPtr<TTY>);
  420. clock_t m_ticks_in_user { 0 };
  421. clock_t m_ticks_in_kernel { 0 };
  422. clock_t m_ticks_in_user_for_dead_children { 0 };
  423. clock_t m_ticks_in_kernel_for_dead_children { 0 };
  424. NonnullRefPtr<Custody> current_directory();
  425. RefPtr<Custody> executable();
  426. RefPtr<Custody const> executable() const;
  427. static constexpr size_t max_arguments_size = Thread::default_userspace_stack_size / 8;
  428. static constexpr size_t max_environment_size = Thread::default_userspace_stack_size / 8;
  429. static constexpr size_t max_auxiliary_size = Thread::default_userspace_stack_size / 8;
  430. Vector<NonnullOwnPtr<KString>> const& arguments() const { return m_arguments; };
  431. Vector<NonnullOwnPtr<KString>> const& environment() const { return m_environment; };
  432. ErrorOr<void> exec(NonnullOwnPtr<KString> path, Vector<NonnullOwnPtr<KString>> arguments, Vector<NonnullOwnPtr<KString>> environment, Thread*& new_main_thread, InterruptsState& previous_interrupts_state, int recursion_depth = 0);
  433. ErrorOr<LoadResult> load(Memory::AddressSpace& new_space, NonnullRefPtr<OpenFileDescription> main_program_description, RefPtr<OpenFileDescription> interpreter_description, const ElfW(Ehdr) & main_program_header);
  434. void terminate_due_to_signal(u8 signal);
  435. ErrorOr<void> send_signal(u8 signal, Process* sender);
  436. u8 termination_signal() const
  437. {
  438. return with_protected_data([](auto& protected_data) -> u8 {
  439. return protected_data.termination_signal;
  440. });
  441. }
  442. u8 termination_status() const
  443. {
  444. return with_protected_data([](auto& protected_data) { return protected_data.termination_status; });
  445. }
  446. u16 thread_count() const
  447. {
  448. return with_protected_data([](auto& protected_data) {
  449. return protected_data.thread_count.load(AK::MemoryOrder::memory_order_relaxed);
  450. });
  451. }
  452. Mutex& big_lock() { return m_big_lock; }
  453. Mutex& ptrace_lock() { return m_ptrace_lock; }
  454. bool has_promises() const
  455. {
  456. return with_protected_data([](auto& protected_data) { return protected_data.has_promises.load(); });
  457. }
  458. bool has_promised(Pledge pledge) const
  459. {
  460. return with_protected_data([&](auto& protected_data) {
  461. return (protected_data.promises & (1U << (u32)pledge)) != 0;
  462. });
  463. }
  464. VeilState veil_state() const
  465. {
  466. return m_unveil_data.with([&](auto const& unveil_data) { return unveil_data.state; });
  467. }
  468. struct UnveilData {
  469. explicit UnveilData(UnveilNode&& p)
  470. : paths(move(p))
  471. {
  472. }
  473. VeilState state { VeilState::None };
  474. UnveilNode paths;
  475. };
  476. auto& unveil_data() { return m_unveil_data; }
  477. auto const& unveil_data() const { return m_unveil_data; }
  478. auto& exec_unveil_data() { return m_exec_unveil_data; }
  479. auto const& exec_unveil_data() const { return m_exec_unveil_data; }
  480. bool wait_for_tracer_at_next_execve() const
  481. {
  482. return m_wait_for_tracer_at_next_execve;
  483. }
  484. void set_wait_for_tracer_at_next_execve(bool val)
  485. {
  486. m_wait_for_tracer_at_next_execve = val;
  487. }
  488. ErrorOr<void> peek_user_data(Span<u8> destination, Userspace<u8 const*> address);
  489. ErrorOr<FlatPtr> peek_user_data(Userspace<FlatPtr const*> address);
  490. ErrorOr<void> poke_user_data(Userspace<FlatPtr*> address, FlatPtr data);
  491. void disowned_by_waiter(Process& process);
  492. void unblock_waiters(Thread::WaitBlocker::UnblockFlags, u8 signal = 0);
  493. Thread::WaitBlockerSet& wait_blocker_set() { return m_wait_blocker_set; }
  494. template<typename Callback>
  495. ErrorOr<void> for_each_coredump_property(Callback callback) const
  496. {
  497. return m_coredump_properties.with([&](auto const& coredump_properties) -> ErrorOr<void> {
  498. for (auto const& property : coredump_properties) {
  499. if (property.key && property.value)
  500. TRY(callback(*property.key, *property.value));
  501. }
  502. return {};
  503. });
  504. }
  505. ErrorOr<void> set_coredump_property(NonnullOwnPtr<KString> key, NonnullOwnPtr<KString> value);
  506. ErrorOr<void> try_set_coredump_property(StringView key, StringView value);
  507. Vector<NonnullRefPtr<Thread>> const& threads_for_coredump(Badge<Coredump>) const { return m_threads_for_coredump; }
  508. PerformanceEventBuffer* perf_events() { return m_perf_event_buffer; }
  509. PerformanceEventBuffer const* perf_events() const { return m_perf_event_buffer; }
  510. SpinlockProtected<OwnPtr<Memory::AddressSpace>, LockRank::None>& address_space() { return m_space; }
  511. SpinlockProtected<OwnPtr<Memory::AddressSpace>, LockRank::None> const& address_space() const { return m_space; }
  512. VirtualAddress signal_trampoline() const
  513. {
  514. return with_protected_data([](auto& protected_data) { return protected_data.signal_trampoline; });
  515. }
  516. ErrorOr<void> require_promise(Pledge);
  517. ErrorOr<void> require_no_promises() const;
  518. ErrorOr<void> validate_mmap_prot(int prot, bool map_stack, bool map_anonymous, Memory::Region const* region = nullptr) const;
  519. ErrorOr<void> validate_inode_mmap_prot(int prot, bool description_readable, bool description_writable, bool map_shared) const;
  520. private:
  521. friend class MemoryManager;
  522. friend class Scheduler;
  523. friend class Region;
  524. friend class PerformanceManager;
  525. bool add_thread(Thread&);
  526. bool remove_thread(Thread&);
  527. Process(NonnullOwnPtr<KString> name, NonnullRefPtr<Credentials>, ProcessID ppid, bool is_kernel_process, RefPtr<Custody> current_directory, RefPtr<Custody> executable, RefPtr<TTY> tty, UnveilNode unveil_tree, UnveilNode exec_unveil_tree);
  528. static ErrorOr<ProcessAndFirstThread> create(NonnullOwnPtr<KString> name, UserID, GroupID, ProcessID ppid, bool is_kernel_process, RefPtr<Custody> current_directory = nullptr, RefPtr<Custody> executable = nullptr, RefPtr<TTY> = nullptr, Process* fork_parent = nullptr);
  529. ErrorOr<NonnullRefPtr<Thread>> attach_resources(NonnullOwnPtr<Memory::AddressSpace>&&, Process* fork_parent);
  530. static ProcessID allocate_pid();
  531. void kill_threads_except_self();
  532. void kill_all_threads();
  533. ErrorOr<void> dump_core();
  534. ErrorOr<void> dump_perfcore();
  535. bool create_perf_events_buffer_if_needed();
  536. void delete_perf_events_buffer();
  537. ErrorOr<void> do_exec(NonnullRefPtr<OpenFileDescription> main_program_description, Vector<NonnullOwnPtr<KString>> arguments, Vector<NonnullOwnPtr<KString>> environment, RefPtr<OpenFileDescription> interpreter_description, Thread*& new_main_thread, InterruptsState& previous_interrupts_state, const ElfW(Ehdr) & main_program_header);
  538. ErrorOr<FlatPtr> do_write(OpenFileDescription&, UserOrKernelBuffer const&, size_t, Optional<off_t> = {});
  539. ErrorOr<FlatPtr> do_statvfs(FileSystem const& path, Custody const*, statvfs* buf);
  540. ErrorOr<RefPtr<OpenFileDescription>> find_elf_interpreter_for_executable(StringView path, ElfW(Ehdr) const& main_executable_header, size_t main_executable_header_size, size_t file_size);
  541. ErrorOr<void> do_kill(Process&, int signal);
  542. ErrorOr<void> do_killpg(ProcessGroupID pgrp, int signal);
  543. ErrorOr<void> do_killall(int signal);
  544. ErrorOr<void> do_killself(int signal);
  545. ErrorOr<siginfo_t> do_waitid(Variant<Empty, NonnullRefPtr<Process>, NonnullRefPtr<ProcessGroup>> waitee, int options);
  546. static ErrorOr<NonnullOwnPtr<KString>> get_syscall_path_argument(Userspace<char const*> user_path, size_t path_length);
  547. static ErrorOr<NonnullOwnPtr<KString>> get_syscall_path_argument(Syscall::StringArgument const&);
  548. bool has_tracee_thread(ProcessID tracer_pid);
  549. void clear_signal_handlers_for_exec();
  550. void clear_futex_queues_on_exec();
  551. ErrorOr<GlobalFutexKey> get_futex_key(FlatPtr user_address, bool shared);
  552. ErrorOr<void> remap_range_as_stack(FlatPtr address, size_t size);
  553. ErrorOr<FlatPtr> read_impl(int fd, Userspace<u8*> buffer, size_t size);
  554. public:
  555. ErrorOr<void> traverse_as_directory(FileSystemID, Function<ErrorOr<void>(FileSystem::DirectoryEntryView const&)> callback) const;
  556. ErrorOr<NonnullRefPtr<Inode>> lookup_as_directory(ProcFS&, StringView name) const;
  557. ErrorOr<void> procfs_get_fds_stats(KBufferBuilder& builder) const;
  558. ErrorOr<void> procfs_get_perf_events(KBufferBuilder& builder) const;
  559. ErrorOr<void> procfs_get_unveil_stats(KBufferBuilder& builder) const;
  560. ErrorOr<void> procfs_get_pledge_stats(KBufferBuilder& builder) const;
  561. ErrorOr<void> procfs_get_virtual_memory_stats(KBufferBuilder& builder) const;
  562. ErrorOr<void> procfs_get_binary_link(KBufferBuilder& builder) const;
  563. ErrorOr<void> procfs_get_current_work_directory_link(KBufferBuilder& builder) const;
  564. ErrorOr<void> procfs_get_command_line(KBufferBuilder& builder) const;
  565. mode_t binary_link_required_mode() const;
  566. ErrorOr<void> procfs_get_thread_stack(ThreadID thread_id, KBufferBuilder& builder) const;
  567. ErrorOr<void> traverse_stacks_directory(FileSystemID, Function<ErrorOr<void>(FileSystem::DirectoryEntryView const&)> callback) const;
  568. ErrorOr<NonnullRefPtr<Inode>> lookup_stacks_directory(ProcFS&, StringView name) const;
  569. ErrorOr<size_t> procfs_get_file_description_link(unsigned fd, KBufferBuilder& builder) const;
  570. ErrorOr<void> traverse_file_descriptions_directory(FileSystemID, Function<ErrorOr<void>(FileSystem::DirectoryEntryView const&)> callback) const;
  571. ErrorOr<NonnullRefPtr<Inode>> lookup_file_descriptions_directory(ProcFS&, StringView name) const;
  572. ErrorOr<NonnullRefPtr<Inode>> lookup_children_directory(ProcFS&, StringView name) const;
  573. ErrorOr<void> traverse_children_directory(FileSystemID, Function<ErrorOr<void>(FileSystem::DirectoryEntryView const&)> callback) const;
  574. ErrorOr<size_t> procfs_get_child_process_link(ProcessID child_pid, KBufferBuilder& builder) const;
  575. private:
  576. inline PerformanceEventBuffer* current_perf_events_buffer()
  577. {
  578. if (g_profiling_all_threads)
  579. return g_global_perf_events;
  580. if (m_profiling)
  581. return m_perf_event_buffer.ptr();
  582. return nullptr;
  583. }
  584. SpinlockProtected<NonnullOwnPtr<KString>, LockRank::None> m_name;
  585. SpinlockProtected<OwnPtr<Memory::AddressSpace>, LockRank::None> m_space;
  586. RecursiveSpinlock<LockRank::None> mutable m_protected_data_lock;
  587. AtomicEdgeAction<u32> m_protected_data_refs;
  588. void protect_data();
  589. void unprotect_data();
  590. OwnPtr<ThreadTracer> m_tracer;
  591. public:
  592. class OpenFileDescriptionAndFlags {
  593. public:
  594. bool is_valid() const { return !m_description.is_null(); }
  595. bool is_allocated() const { return m_is_allocated; }
  596. void allocate()
  597. {
  598. VERIFY(!m_is_allocated);
  599. VERIFY(!is_valid());
  600. m_is_allocated = true;
  601. }
  602. void deallocate()
  603. {
  604. VERIFY(m_is_allocated);
  605. VERIFY(!is_valid());
  606. m_is_allocated = false;
  607. }
  608. OpenFileDescription* description() { return m_description; }
  609. OpenFileDescription const* description() const { return m_description; }
  610. u32 flags() const { return m_flags; }
  611. void set_flags(u32 flags) { m_flags = flags; }
  612. void clear();
  613. void set(NonnullRefPtr<OpenFileDescription>, u32 flags = 0);
  614. private:
  615. RefPtr<OpenFileDescription> m_description;
  616. bool m_is_allocated { false };
  617. u32 m_flags { 0 };
  618. };
  619. class ScopedDescriptionAllocation;
  620. class OpenFileDescriptions {
  621. AK_MAKE_NONCOPYABLE(OpenFileDescriptions);
  622. AK_MAKE_NONMOVABLE(OpenFileDescriptions);
  623. friend class Process;
  624. public:
  625. OpenFileDescriptions() { }
  626. ALWAYS_INLINE OpenFileDescriptionAndFlags const& operator[](size_t i) const { return at(i); }
  627. ALWAYS_INLINE OpenFileDescriptionAndFlags& operator[](size_t i) { return at(i); }
  628. ErrorOr<void> try_clone(Kernel::Process::OpenFileDescriptions const& other)
  629. {
  630. TRY(try_resize(other.m_fds_metadatas.size()));
  631. for (size_t i = 0; i < other.m_fds_metadatas.size(); ++i) {
  632. m_fds_metadatas[i] = other.m_fds_metadatas[i];
  633. }
  634. return {};
  635. }
  636. OpenFileDescriptionAndFlags const& at(size_t i) const;
  637. OpenFileDescriptionAndFlags& at(size_t i);
  638. OpenFileDescriptionAndFlags const* get_if_valid(size_t i) const;
  639. OpenFileDescriptionAndFlags* get_if_valid(size_t i);
  640. void enumerate(Function<void(OpenFileDescriptionAndFlags const&)>) const;
  641. ErrorOr<void> try_enumerate(Function<ErrorOr<void>(OpenFileDescriptionAndFlags const&)>) const;
  642. void change_each(Function<void(OpenFileDescriptionAndFlags&)>);
  643. ErrorOr<ScopedDescriptionAllocation> allocate(int first_candidate_fd = 0);
  644. size_t open_count() const;
  645. ErrorOr<void> try_resize(size_t size) { return m_fds_metadatas.try_resize(size); }
  646. static constexpr size_t max_open()
  647. {
  648. return s_max_open_file_descriptors;
  649. }
  650. void clear()
  651. {
  652. m_fds_metadatas.clear();
  653. }
  654. ErrorOr<NonnullRefPtr<OpenFileDescription>> open_file_description(int fd) const;
  655. private:
  656. static constexpr size_t s_max_open_file_descriptors { FD_SETSIZE };
  657. Vector<OpenFileDescriptionAndFlags> m_fds_metadatas;
  658. };
  659. class ScopedDescriptionAllocation {
  660. AK_MAKE_NONCOPYABLE(ScopedDescriptionAllocation);
  661. public:
  662. ScopedDescriptionAllocation() = default;
  663. ScopedDescriptionAllocation(int tracked_fd, OpenFileDescriptionAndFlags* description)
  664. : fd(tracked_fd)
  665. , m_description(description)
  666. {
  667. }
  668. ScopedDescriptionAllocation(ScopedDescriptionAllocation&& other)
  669. : fd(other.fd)
  670. {
  671. // Take over the responsibility of tracking to deallocation.
  672. swap(m_description, other.m_description);
  673. }
  674. ScopedDescriptionAllocation& operator=(ScopedDescriptionAllocation&& other)
  675. {
  676. if (this != &other) {
  677. m_description = exchange(other.m_description, nullptr);
  678. fd = exchange(other.fd, -1);
  679. }
  680. return *this;
  681. }
  682. ~ScopedDescriptionAllocation()
  683. {
  684. if (m_description && m_description->is_allocated() && !m_description->is_valid()) {
  685. m_description->deallocate();
  686. }
  687. }
  688. int fd { -1 };
  689. private:
  690. OpenFileDescriptionAndFlags* m_description { nullptr };
  691. };
  692. MutexProtected<OpenFileDescriptions>& fds() { return m_fds; }
  693. MutexProtected<OpenFileDescriptions> const& fds() const { return m_fds; }
  694. ErrorOr<NonnullRefPtr<OpenFileDescription>> open_file_description(int fd)
  695. {
  696. return m_fds.with_shared([fd](auto& fds) { return fds.open_file_description(fd); });
  697. }
  698. ErrorOr<NonnullRefPtr<OpenFileDescription>> open_file_description(int fd) const
  699. {
  700. return m_fds.with_shared([fd](auto& fds) { return fds.open_file_description(fd); });
  701. }
  702. ErrorOr<ScopedDescriptionAllocation> allocate_fd()
  703. {
  704. return m_fds.with_exclusive([](auto& fds) { return fds.allocate(); });
  705. }
  706. private:
  707. ErrorOr<NonnullRefPtr<Custody>> custody_for_dirfd(int dirfd);
  708. SpinlockProtected<Thread::ListInProcess, LockRank::None>& thread_list() { return m_thread_list; }
  709. SpinlockProtected<Thread::ListInProcess, LockRank::None> const& thread_list() const { return m_thread_list; }
  710. ErrorOr<NonnullRefPtr<Thread>> get_thread_from_pid_or_tid(pid_t pid_or_tid, Syscall::SchedulerParametersMode mode);
  711. SpinlockProtected<Thread::ListInProcess, LockRank::None> m_thread_list {};
  712. MutexProtected<OpenFileDescriptions> m_fds;
  713. bool const m_is_kernel_process;
  714. Atomic<State> m_state { State::Running };
  715. bool m_profiling { false };
  716. Atomic<bool, AK::MemoryOrder::memory_order_relaxed> m_is_stopped { false };
  717. bool m_should_generate_coredump { false };
  718. SpinlockProtected<RefPtr<Custody>, LockRank::None> m_executable;
  719. SpinlockProtected<RefPtr<Custody>, LockRank::None> m_current_directory;
  720. Vector<NonnullOwnPtr<KString>> m_arguments;
  721. Vector<NonnullOwnPtr<KString>> m_environment;
  722. LockWeakPtr<Memory::Region> m_master_tls_region;
  723. IntrusiveListNode<Process> m_jail_process_list_node;
  724. IntrusiveListNode<Process> m_all_processes_list_node;
  725. public:
  726. using AllProcessesList = IntrusiveListRelaxedConst<&Process::m_all_processes_list_node>;
  727. using JailProcessList = IntrusiveListRelaxedConst<&Process::m_jail_process_list_node>;
  728. private:
  729. SpinlockProtected<RefPtr<ProcessList>, LockRank::None> m_jail_process_list;
  730. SpinlockProtected<RefPtr<Jail>, LockRank::Process> m_attached_jail {};
  731. size_t m_master_tls_size { 0 };
  732. size_t m_master_tls_alignment { 0 };
  733. Mutex m_big_lock { "Process"sv, Mutex::MutexBehavior::BigLock };
  734. Mutex m_ptrace_lock { "ptrace"sv };
  735. SpinlockProtected<RefPtr<Timer>, LockRank::None> m_alarm_timer;
  736. SpinlockProtected<UnveilData, LockRank::None> m_unveil_data;
  737. SpinlockProtected<UnveilData, LockRank::None> m_exec_unveil_data;
  738. OwnPtr<PerformanceEventBuffer> m_perf_event_buffer;
  739. // This member is used in the implementation of ptrace's PT_TRACEME flag.
  740. // If it is set to true, the process will stop at the next execve syscall
  741. // and wait for a tracer to attach.
  742. bool m_wait_for_tracer_at_next_execve { false };
  743. Thread::WaitBlockerSet m_wait_blocker_set;
  744. struct CoredumpProperty {
  745. OwnPtr<KString> key;
  746. OwnPtr<KString> value;
  747. };
  748. SpinlockProtected<Array<CoredumpProperty, 4>, LockRank::None> m_coredump_properties {};
  749. Vector<NonnullRefPtr<Thread>> m_threads_for_coredump;
  750. struct SignalActionData {
  751. VirtualAddress handler_or_sigaction;
  752. int flags { 0 };
  753. u32 mask { 0 };
  754. };
  755. Array<SignalActionData, NSIG> m_signal_action_data;
  756. static_assert(sizeof(ProtectedValues) < (PAGE_SIZE));
  757. alignas(4096) ProtectedValues m_protected_values_do_not_access_directly;
  758. u8 m_protected_values_padding[PAGE_SIZE - sizeof(ProtectedValues)];
  759. public:
  760. static SpinlockProtected<Process::AllProcessesList, LockRank::None>& all_instances();
  761. };
  762. class ProcessList : public RefCounted<ProcessList> {
  763. public:
  764. static ErrorOr<NonnullRefPtr<ProcessList>> create();
  765. SpinlockProtected<Process::JailProcessList, LockRank::None>& attached_processes() { return m_attached_processes; }
  766. SpinlockProtected<Process::JailProcessList, LockRank::None> const& attached_processes() const { return m_attached_processes; }
  767. private:
  768. ProcessList() = default;
  769. SpinlockProtected<Process::JailProcessList, LockRank::None> m_attached_processes;
  770. };
  771. // Note: Process object should be 2 pages of 4096 bytes each.
  772. // It's not expected that the Process object will expand further because the first
  773. // page is used for all unprotected values (which should be plenty of space for them).
  774. // The second page is being used exclusively for write-protected values.
  775. static_assert(AssertSize<Process, (PAGE_SIZE * 2)>());
  776. extern RecursiveSpinlock<LockRank::None> g_profiling_lock;
  777. template<IteratorFunction<Thread&> Callback>
  778. inline IterationDecision Process::for_each_thread(Callback callback)
  779. {
  780. return thread_list().with([&](auto& thread_list) -> IterationDecision {
  781. for (auto& thread : thread_list) {
  782. IterationDecision decision = callback(thread);
  783. if (decision != IterationDecision::Continue)
  784. return decision;
  785. }
  786. return IterationDecision::Continue;
  787. });
  788. }
  789. template<IteratorFunction<Process&> Callback>
  790. inline void Process::for_each_ignoring_jails(Callback callback)
  791. {
  792. Process::all_instances().with([&](auto const& list) {
  793. for (auto it = list.begin(); it != list.end();) {
  794. auto& process = *it;
  795. ++it;
  796. if (callback(process) == IterationDecision::Break)
  797. break;
  798. }
  799. });
  800. }
  801. template<IteratorFunction<Thread&> Callback>
  802. inline IterationDecision Process::for_each_thread(Callback callback) const
  803. {
  804. return thread_list().with([&](auto& thread_list) -> IterationDecision {
  805. for (auto& thread : thread_list) {
  806. IterationDecision decision = callback(thread);
  807. if (decision != IterationDecision::Continue)
  808. return decision;
  809. }
  810. return IterationDecision::Continue;
  811. });
  812. }
  813. template<VoidFunction<Thread&> Callback>
  814. inline IterationDecision Process::for_each_thread(Callback callback) const
  815. {
  816. thread_list().with([&](auto& thread_list) {
  817. for (auto& thread : thread_list)
  818. callback(thread);
  819. });
  820. return IterationDecision::Continue;
  821. }
  822. inline ErrorOr<void> Process::try_for_each_thread(Function<ErrorOr<void>(Thread const&)> callback) const
  823. {
  824. return thread_list().with([&](auto& thread_list) -> ErrorOr<void> {
  825. for (auto& thread : thread_list)
  826. TRY(callback(thread));
  827. return {};
  828. });
  829. }
  830. template<VoidFunction<Thread&> Callback>
  831. inline IterationDecision Process::for_each_thread(Callback callback)
  832. {
  833. thread_list().with([&](auto& thread_list) {
  834. for (auto& thread : thread_list)
  835. callback(thread);
  836. });
  837. return IterationDecision::Continue;
  838. }
  839. inline ProcessID Thread::pid() const
  840. {
  841. return m_process->pid();
  842. }
  843. }
  844. #define VERIFY_PROCESS_BIG_LOCK_ACQUIRED(process) \
  845. VERIFY(process->big_lock().is_exclusively_locked_by_current_thread())
  846. #define VERIFY_NO_PROCESS_BIG_LOCK(process) \
  847. VERIFY(!process->big_lock().is_exclusively_locked_by_current_thread())
  848. inline ErrorOr<NonnullOwnPtr<KString>> try_copy_kstring_from_user(Kernel::Syscall::StringArgument const& string)
  849. {
  850. Userspace<char const*> characters((FlatPtr)string.characters);
  851. return try_copy_kstring_from_user(characters, string.length);
  852. }
  853. template<>
  854. struct AK::Formatter<Kernel::Process> : AK::Formatter<FormatString> {
  855. ErrorOr<void> format(FormatBuilder& builder, Kernel::Process const& value)
  856. {
  857. return value.name().with([&](auto& process_name) {
  858. return AK::Formatter<FormatString>::format(builder, "{}({})"sv, process_name->view(), value.pid().value());
  859. });
  860. }
  861. };
  862. namespace AK {
  863. template<>
  864. struct Traits<Kernel::GlobalFutexKey> : public GenericTraits<Kernel::GlobalFutexKey> {
  865. static unsigned hash(Kernel::GlobalFutexKey const& futex_key) { return pair_int_hash(ptr_hash(futex_key.raw.parent), ptr_hash(futex_key.raw.offset)); }
  866. static bool equals(Kernel::GlobalFutexKey const& a, Kernel::GlobalFutexKey const& b) { return a.raw.parent == b.raw.parent && a.raw.offset == b.raw.offset; }
  867. };
  868. };