execve.cpp 39 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952
  1. /*
  2. * Copyright (c) 2018-2021, Andreas Kling <kling@serenityos.org>
  3. * Copyright (c) 2022, the SerenityOS developers.
  4. *
  5. * SPDX-License-Identifier: BSD-2-Clause
  6. */
  7. #include <AK/ScopeGuard.h>
  8. #include <AK/TemporaryChange.h>
  9. #include <Kernel/Debug.h>
  10. #include <Kernel/FileSystem/Custody.h>
  11. #include <Kernel/FileSystem/OpenFileDescription.h>
  12. #include <Kernel/Library/LockWeakPtr.h>
  13. #include <Kernel/Memory/AllocationStrategy.h>
  14. #include <Kernel/Memory/MemoryManager.h>
  15. #include <Kernel/Memory/PageDirectory.h>
  16. #include <Kernel/Memory/Region.h>
  17. #include <Kernel/Memory/SharedInodeVMObject.h>
  18. #include <Kernel/Panic.h>
  19. #include <Kernel/PerformanceManager.h>
  20. #include <Kernel/Process.h>
  21. #include <Kernel/Random.h>
  22. #include <Kernel/Scheduler.h>
  23. #include <Kernel/Time/TimeManagement.h>
  24. #include <LibC/limits.h>
  25. #include <LibELF/AuxiliaryVector.h>
  26. #include <LibELF/Image.h>
  27. #include <LibELF/Validation.h>
  28. namespace Kernel {
  29. extern Memory::Region* g_signal_trampoline_region;
  30. struct LoadResult {
  31. OwnPtr<Memory::AddressSpace> space;
  32. FlatPtr load_base { 0 };
  33. FlatPtr entry_eip { 0 };
  34. size_t size { 0 };
  35. LockWeakPtr<Memory::Region> tls_region;
  36. size_t tls_size { 0 };
  37. size_t tls_alignment { 0 };
  38. LockWeakPtr<Memory::Region> stack_region;
  39. };
  40. static constexpr size_t auxiliary_vector_size = 15;
  41. static Array<ELF::AuxiliaryValue, auxiliary_vector_size> generate_auxiliary_vector(FlatPtr load_base, FlatPtr entry_eip, UserID uid, UserID euid, GroupID gid, GroupID egid, StringView executable_path, Optional<Process::ScopedDescriptionAllocation> const& main_program_fd_allocation);
  42. static bool validate_stack_size(NonnullOwnPtrVector<KString> const& arguments, NonnullOwnPtrVector<KString>& environment)
  43. {
  44. size_t total_arguments_size = 0;
  45. size_t total_environment_size = 0;
  46. for (auto const& a : arguments)
  47. total_arguments_size += a.length() + 1;
  48. for (auto const& e : environment)
  49. total_environment_size += e.length() + 1;
  50. total_arguments_size += sizeof(char*) * (arguments.size() + 1);
  51. total_environment_size += sizeof(char*) * (environment.size() + 1);
  52. if (total_arguments_size > Process::max_arguments_size)
  53. return false;
  54. if (total_environment_size > Process::max_environment_size)
  55. return false;
  56. // FIXME: This doesn't account for the size of the auxiliary vector
  57. return true;
  58. }
  59. static ErrorOr<FlatPtr> make_userspace_context_for_main_thread([[maybe_unused]] ThreadRegisters& regs, Memory::Region& region, NonnullOwnPtrVector<KString> const& arguments,
  60. NonnullOwnPtrVector<KString> const& environment, Array<ELF::AuxiliaryValue, auxiliary_vector_size> auxiliary_values)
  61. {
  62. FlatPtr new_sp = region.range().end().get();
  63. // Add some bits of randomness to the user stack pointer.
  64. new_sp -= round_up_to_power_of_two(get_fast_random<u32>() % 4096, 16);
  65. auto push_on_new_stack = [&new_sp](FlatPtr value) {
  66. new_sp -= sizeof(FlatPtr);
  67. Userspace<FlatPtr*> stack_ptr = new_sp;
  68. auto result = copy_to_user(stack_ptr, &value);
  69. VERIFY(!result.is_error());
  70. };
  71. auto push_aux_value_on_new_stack = [&new_sp](auxv_t value) {
  72. new_sp -= sizeof(auxv_t);
  73. Userspace<auxv_t*> stack_ptr = new_sp;
  74. auto result = copy_to_user(stack_ptr, &value);
  75. VERIFY(!result.is_error());
  76. };
  77. auto push_string_on_new_stack = [&new_sp](StringView string) {
  78. new_sp -= round_up_to_power_of_two(string.length() + 1, sizeof(FlatPtr));
  79. Userspace<FlatPtr*> stack_ptr = new_sp;
  80. auto result = copy_to_user(stack_ptr, string.characters_without_null_termination(), string.length() + 1);
  81. VERIFY(!result.is_error());
  82. };
  83. Vector<FlatPtr> argv_entries;
  84. for (auto const& argument : arguments) {
  85. push_string_on_new_stack(argument.view());
  86. TRY(argv_entries.try_append(new_sp));
  87. }
  88. Vector<FlatPtr> env_entries;
  89. for (auto const& variable : environment) {
  90. push_string_on_new_stack(variable.view());
  91. TRY(env_entries.try_append(new_sp));
  92. }
  93. for (auto& value : auxiliary_values) {
  94. if (!value.optional_string.is_empty()) {
  95. push_string_on_new_stack(value.optional_string);
  96. value.auxv.a_un.a_ptr = (void*)new_sp;
  97. }
  98. if (value.auxv.a_type == ELF::AuxiliaryValue::Random) {
  99. u8 random_bytes[16] {};
  100. get_fast_random_bytes({ random_bytes, sizeof(random_bytes) });
  101. push_string_on_new_stack({ random_bytes, sizeof(random_bytes) });
  102. value.auxv.a_un.a_ptr = (void*)new_sp;
  103. }
  104. }
  105. for (ssize_t i = auxiliary_values.size() - 1; i >= 0; --i) {
  106. auto& value = auxiliary_values[i];
  107. push_aux_value_on_new_stack(value.auxv);
  108. }
  109. push_on_new_stack(0);
  110. for (ssize_t i = env_entries.size() - 1; i >= 0; --i)
  111. push_on_new_stack(env_entries[i]);
  112. FlatPtr envp = new_sp;
  113. push_on_new_stack(0);
  114. for (ssize_t i = argv_entries.size() - 1; i >= 0; --i)
  115. push_on_new_stack(argv_entries[i]);
  116. FlatPtr argv = new_sp;
  117. // NOTE: The stack needs to be 16-byte aligned.
  118. new_sp -= new_sp % 16;
  119. #if ARCH(I386)
  120. // GCC assumes that the return address has been pushed to the stack when it enters the function,
  121. // so we need to reserve an extra pointer's worth of bytes below this to make GCC's stack alignment
  122. // calculations work
  123. new_sp -= sizeof(void*);
  124. push_on_new_stack(envp);
  125. push_on_new_stack(argv);
  126. push_on_new_stack(argv_entries.size());
  127. #elif ARCH(X86_64)
  128. regs.rdi = argv_entries.size();
  129. regs.rsi = argv;
  130. regs.rdx = envp;
  131. #else
  132. # error Unknown architecture
  133. #endif
  134. VERIFY(new_sp % 16 == 0);
  135. // FIXME: The way we're setting up the stack and passing arguments to the entry point isn't ABI-compliant
  136. return new_sp;
  137. }
  138. struct RequiredLoadRange {
  139. FlatPtr start { 0 };
  140. FlatPtr end { 0 };
  141. };
  142. static ErrorOr<RequiredLoadRange> get_required_load_range(OpenFileDescription& program_description)
  143. {
  144. auto& inode = *(program_description.inode());
  145. auto vmobject = TRY(Memory::SharedInodeVMObject::try_create_with_inode(inode));
  146. size_t executable_size = inode.size();
  147. size_t rounded_executable_size = TRY(Memory::page_round_up(executable_size));
  148. auto region = TRY(MM.allocate_kernel_region_with_vmobject(*vmobject, rounded_executable_size, "ELF memory range calculation"sv, Memory::Region::Access::Read));
  149. auto elf_image = ELF::Image(region->vaddr().as_ptr(), executable_size);
  150. if (!elf_image.is_valid()) {
  151. return EINVAL;
  152. }
  153. RequiredLoadRange range {};
  154. elf_image.for_each_program_header([&range](auto const& pheader) {
  155. if (pheader.type() != PT_LOAD)
  156. return;
  157. auto region_start = (FlatPtr)pheader.vaddr().as_ptr();
  158. auto region_end = region_start + pheader.size_in_memory();
  159. if (range.start == 0 || region_start < range.start)
  160. range.start = region_start;
  161. if (range.end == 0 || region_end > range.end)
  162. range.end = region_end;
  163. });
  164. VERIFY(range.end > range.start);
  165. return range;
  166. };
  167. static ErrorOr<FlatPtr> get_load_offset(const ElfW(Ehdr) & main_program_header, OpenFileDescription& main_program_description, OpenFileDescription* interpreter_description)
  168. {
  169. constexpr FlatPtr load_range_start = 0x08000000;
  170. constexpr FlatPtr load_range_size = 65536 * PAGE_SIZE; // 2**16 * PAGE_SIZE = 256MB
  171. constexpr FlatPtr minimum_load_offset_randomization_size = 10 * MiB;
  172. auto random_load_offset_in_range([](auto start, auto size) {
  173. return Memory::page_round_down(start + get_good_random<FlatPtr>() % size);
  174. });
  175. if (main_program_header.e_type == ET_DYN) {
  176. return random_load_offset_in_range(load_range_start, load_range_size);
  177. }
  178. if (main_program_header.e_type != ET_EXEC)
  179. return EINVAL;
  180. auto main_program_load_range = TRY(get_required_load_range(main_program_description));
  181. RequiredLoadRange selected_range {};
  182. if (interpreter_description) {
  183. auto interpreter_load_range = TRY(get_required_load_range(*interpreter_description));
  184. auto interpreter_size_in_memory = interpreter_load_range.end - interpreter_load_range.start;
  185. auto interpreter_load_range_end = load_range_start + load_range_size - interpreter_size_in_memory;
  186. // No intersection
  187. if (main_program_load_range.end < load_range_start || main_program_load_range.start > interpreter_load_range_end)
  188. return random_load_offset_in_range(load_range_start, load_range_size);
  189. RequiredLoadRange first_available_part = { load_range_start, main_program_load_range.start };
  190. RequiredLoadRange second_available_part = { main_program_load_range.end, interpreter_load_range_end };
  191. // Select larger part
  192. if (first_available_part.end - first_available_part.start > second_available_part.end - second_available_part.start)
  193. selected_range = first_available_part;
  194. else
  195. selected_range = second_available_part;
  196. } else
  197. selected_range = main_program_load_range;
  198. // If main program is too big and leaves us without enough space for adequate loader randomization
  199. if (selected_range.end - selected_range.start < minimum_load_offset_randomization_size)
  200. return E2BIG;
  201. return random_load_offset_in_range(selected_range.start, selected_range.end - selected_range.start);
  202. }
  203. enum class ShouldAllocateTls {
  204. No,
  205. Yes,
  206. };
  207. enum class ShouldAllowSyscalls {
  208. No,
  209. Yes,
  210. };
  211. static ErrorOr<LoadResult> load_elf_object(NonnullOwnPtr<Memory::AddressSpace> new_space, OpenFileDescription& object_description,
  212. FlatPtr load_offset, ShouldAllocateTls should_allocate_tls, ShouldAllowSyscalls should_allow_syscalls)
  213. {
  214. auto& inode = *(object_description.inode());
  215. auto vmobject = TRY(Memory::SharedInodeVMObject::try_create_with_inode(inode));
  216. if (vmobject->writable_mappings()) {
  217. dbgln("Refusing to execute a write-mapped program");
  218. return ETXTBSY;
  219. }
  220. size_t executable_size = inode.size();
  221. size_t rounded_executable_size = TRY(Memory::page_round_up(executable_size));
  222. auto executable_region = TRY(MM.allocate_kernel_region_with_vmobject(*vmobject, rounded_executable_size, "ELF loading"sv, Memory::Region::Access::Read));
  223. auto elf_image = ELF::Image(executable_region->vaddr().as_ptr(), executable_size);
  224. if (!elf_image.is_valid())
  225. return ENOEXEC;
  226. Memory::Region* master_tls_region { nullptr };
  227. size_t master_tls_size = 0;
  228. size_t master_tls_alignment = 0;
  229. FlatPtr load_base_address = 0;
  230. auto elf_name = TRY(object_description.pseudo_path());
  231. VERIFY(!Processor::in_critical());
  232. Memory::MemoryManager::enter_address_space(*new_space);
  233. auto load_tls_section = [&](auto& program_header) -> ErrorOr<void> {
  234. VERIFY(should_allocate_tls == ShouldAllocateTls::Yes);
  235. VERIFY(program_header.size_in_memory());
  236. if (!elf_image.is_within_image(program_header.raw_data(), program_header.size_in_image())) {
  237. dbgln("Shenanigans! ELF PT_TLS header sneaks outside of executable.");
  238. return ENOEXEC;
  239. }
  240. auto region_name = TRY(KString::formatted("{} (master-tls)", elf_name));
  241. master_tls_region = TRY(new_space->allocate_region(Memory::RandomizeVirtualAddress::Yes, {}, program_header.size_in_memory(), PAGE_SIZE, region_name->view(), PROT_READ | PROT_WRITE, AllocationStrategy::Reserve));
  242. master_tls_size = program_header.size_in_memory();
  243. master_tls_alignment = program_header.alignment();
  244. TRY(copy_to_user(master_tls_region->vaddr().as_ptr(), program_header.raw_data(), program_header.size_in_image()));
  245. return {};
  246. };
  247. auto load_writable_section = [&](auto& program_header) -> ErrorOr<void> {
  248. // Writable section: create a copy in memory.
  249. VERIFY(program_header.alignment() % PAGE_SIZE == 0);
  250. if (!elf_image.is_within_image(program_header.raw_data(), program_header.size_in_image())) {
  251. dbgln("Shenanigans! Writable ELF PT_LOAD header sneaks outside of executable.");
  252. return ENOEXEC;
  253. }
  254. int prot = 0;
  255. if (program_header.is_readable())
  256. prot |= PROT_READ;
  257. if (program_header.is_writable())
  258. prot |= PROT_WRITE;
  259. auto region_name = TRY(KString::formatted("{} (data-{}{})", elf_name, program_header.is_readable() ? "r" : "", program_header.is_writable() ? "w" : ""));
  260. auto range_base = VirtualAddress { Memory::page_round_down(program_header.vaddr().offset(load_offset).get()) };
  261. size_t rounded_range_end = TRY(Memory::page_round_up(program_header.vaddr().offset(load_offset).offset(program_header.size_in_memory()).get()));
  262. auto range_end = VirtualAddress { rounded_range_end };
  263. auto region = TRY(new_space->allocate_region(Memory::RandomizeVirtualAddress::Yes, range_base, range_end.get() - range_base.get(), PAGE_SIZE, region_name->view(), prot, AllocationStrategy::Reserve));
  264. // It's not always the case with PIE executables (and very well shouldn't be) that the
  265. // virtual address in the program header matches the one we end up giving the process.
  266. // In order to copy the data image correctly into memory, we need to copy the data starting at
  267. // the right initial page offset into the pages allocated for the elf_alloc-XX section.
  268. // FIXME: There's an opportunity to munmap, or at least mprotect, the padding space between
  269. // the .text and .data PT_LOAD sections of the executable.
  270. // Accessing it would definitely be a bug.
  271. auto page_offset = program_header.vaddr();
  272. page_offset.mask(~PAGE_MASK);
  273. TRY(copy_to_user((u8*)region->vaddr().as_ptr() + page_offset.get(), program_header.raw_data(), program_header.size_in_image()));
  274. return {};
  275. };
  276. auto load_section = [&](auto& program_header) -> ErrorOr<void> {
  277. if (program_header.size_in_memory() == 0)
  278. return {};
  279. if (program_header.is_writable())
  280. return load_writable_section(program_header);
  281. // Non-writable section: map the executable itself in memory.
  282. VERIFY(program_header.alignment() % PAGE_SIZE == 0);
  283. int prot = 0;
  284. if (program_header.is_readable())
  285. prot |= PROT_READ;
  286. if (program_header.is_writable())
  287. prot |= PROT_WRITE;
  288. if (program_header.is_executable())
  289. prot |= PROT_EXEC;
  290. auto range_base = VirtualAddress { Memory::page_round_down(program_header.vaddr().offset(load_offset).get()) };
  291. size_t rounded_range_end = TRY(Memory::page_round_up(program_header.vaddr().offset(load_offset).offset(program_header.size_in_memory()).get()));
  292. auto range_end = VirtualAddress { rounded_range_end };
  293. auto region = TRY(new_space->allocate_region_with_vmobject(Memory::RandomizeVirtualAddress::Yes, range_base, range_end.get() - range_base.get(), program_header.alignment(), *vmobject, program_header.offset(), elf_name->view(), prot, true));
  294. if (should_allow_syscalls == ShouldAllowSyscalls::Yes)
  295. region->set_syscall_region(true);
  296. if (program_header.offset() == 0)
  297. load_base_address = (FlatPtr)region->vaddr().as_ptr();
  298. return {};
  299. };
  300. auto load_elf_program_header = [&](auto& program_header) -> ErrorOr<void> {
  301. if (program_header.type() == PT_TLS)
  302. return load_tls_section(program_header);
  303. if (program_header.type() == PT_LOAD)
  304. return load_section(program_header);
  305. // NOTE: We ignore other program header types.
  306. return {};
  307. };
  308. TRY([&] {
  309. ErrorOr<void> result;
  310. elf_image.for_each_program_header([&](ELF::Image::ProgramHeader const& program_header) {
  311. result = load_elf_program_header(program_header);
  312. return result.is_error() ? IterationDecision::Break : IterationDecision::Continue;
  313. });
  314. return result;
  315. }());
  316. if (!elf_image.entry().offset(load_offset).get()) {
  317. dbgln("do_exec: Failure loading program, entry pointer is invalid! {})", elf_image.entry().offset(load_offset));
  318. return ENOEXEC;
  319. }
  320. auto* stack_region = TRY(new_space->allocate_region(Memory::RandomizeVirtualAddress::Yes, {}, Thread::default_userspace_stack_size, PAGE_SIZE, "Stack (Main thread)"sv, PROT_READ | PROT_WRITE, AllocationStrategy::Reserve));
  321. stack_region->set_stack(true);
  322. return LoadResult {
  323. move(new_space),
  324. load_base_address,
  325. elf_image.entry().offset(load_offset).get(),
  326. executable_size,
  327. TRY(AK::try_make_weak_ptr_if_nonnull(master_tls_region)),
  328. master_tls_size,
  329. master_tls_alignment,
  330. TRY(stack_region->try_make_weak_ptr())
  331. };
  332. }
  333. ErrorOr<LoadResult>
  334. Process::load(NonnullLockRefPtr<OpenFileDescription> main_program_description,
  335. LockRefPtr<OpenFileDescription> interpreter_description, const ElfW(Ehdr) & main_program_header)
  336. {
  337. auto new_space = TRY(Memory::AddressSpace::try_create(nullptr));
  338. ScopeGuard space_guard([&]() {
  339. Memory::MemoryManager::enter_process_address_space(*this);
  340. });
  341. auto load_offset = TRY(get_load_offset(main_program_header, main_program_description, interpreter_description));
  342. if (interpreter_description.is_null()) {
  343. auto load_result = TRY(load_elf_object(move(new_space), main_program_description, load_offset, ShouldAllocateTls::Yes, ShouldAllowSyscalls::No));
  344. m_master_tls_region = load_result.tls_region;
  345. m_master_tls_size = load_result.tls_size;
  346. m_master_tls_alignment = load_result.tls_alignment;
  347. return load_result;
  348. }
  349. auto interpreter_load_result = TRY(load_elf_object(move(new_space), *interpreter_description, load_offset, ShouldAllocateTls::No, ShouldAllowSyscalls::Yes));
  350. // TLS allocation will be done in userspace by the loader
  351. VERIFY(!interpreter_load_result.tls_region);
  352. VERIFY(!interpreter_load_result.tls_alignment);
  353. VERIFY(!interpreter_load_result.tls_size);
  354. return interpreter_load_result;
  355. }
  356. void Process::clear_signal_handlers_for_exec()
  357. {
  358. // Comments are as they are presented in the POSIX specification, but slightly out of order.
  359. for (size_t signal = 0; signal < m_signal_action_data.size(); signal++) {
  360. // Except for SIGCHLD, signals set to be ignored by the calling process image shall be set to be ignored by the new process image.
  361. // If the SIGCHLD signal is set to be ignored by the calling process image, it is unspecified whether the SIGCHLD signal is set
  362. // to be ignored or to the default action in the new process image.
  363. if (signal != SIGCHLD && m_signal_action_data[signal].handler_or_sigaction.get() == reinterpret_cast<FlatPtr>(SIG_IGN)) {
  364. m_signal_action_data[signal] = {};
  365. m_signal_action_data[signal].handler_or_sigaction.set(reinterpret_cast<FlatPtr>(SIG_IGN));
  366. continue;
  367. }
  368. // Signals set to the default action in the calling process image shall be set to the default action in the new process image.
  369. // Signals set to be caught by the calling process image shall be set to the default action in the new process image.
  370. m_signal_action_data[signal] = {};
  371. }
  372. }
  373. ErrorOr<void> Process::do_exec(NonnullLockRefPtr<OpenFileDescription> main_program_description, NonnullOwnPtrVector<KString> arguments, NonnullOwnPtrVector<KString> environment,
  374. LockRefPtr<OpenFileDescription> interpreter_description, Thread*& new_main_thread, u32& prev_flags, const ElfW(Ehdr) & main_program_header)
  375. {
  376. VERIFY(is_user_process());
  377. VERIFY(!Processor::in_critical());
  378. // Although we *could* handle a pseudo_path here, trying to execute something that doesn't have
  379. // a custody (e.g. BlockDevice or RandomDevice) is pretty suspicious anyway.
  380. auto path = TRY(main_program_description->original_absolute_path());
  381. dbgln_if(EXEC_DEBUG, "do_exec: {}", path);
  382. // FIXME: How much stack space does process startup need?
  383. if (!validate_stack_size(arguments, environment))
  384. return E2BIG;
  385. auto last_part = path->view().find_last_split_view('/');
  386. auto new_process_name = TRY(KString::try_create(last_part));
  387. auto new_main_thread_name = TRY(new_process_name->try_clone());
  388. auto load_result = TRY(load(main_program_description, interpreter_description, main_program_header));
  389. // NOTE: We don't need the interpreter executable description after this point.
  390. // We destroy it here to prevent it from getting destroyed when we return from this function.
  391. // That's important because when we're returning from this function, we're in a very delicate
  392. // state where we can't block (e.g by trying to acquire a mutex in description teardown.)
  393. bool has_interpreter = interpreter_description;
  394. interpreter_description = nullptr;
  395. auto* signal_trampoline_region = TRY(load_result.space->allocate_region_with_vmobject(Memory::RandomizeVirtualAddress::Yes, {}, PAGE_SIZE, PAGE_SIZE, g_signal_trampoline_region->vmobject(), 0, "Signal trampoline"sv, PROT_READ | PROT_EXEC, true));
  396. signal_trampoline_region->set_syscall_region(true);
  397. // (For dynamically linked executable) Allocate an FD for passing the main executable to the dynamic loader.
  398. Optional<ScopedDescriptionAllocation> main_program_fd_allocation;
  399. if (has_interpreter)
  400. main_program_fd_allocation = TRY(allocate_fd());
  401. auto old_credentials = this->credentials();
  402. auto new_credentials = old_credentials;
  403. bool executable_is_setid = false;
  404. if (!(main_program_description->custody()->mount_flags() & MS_NOSUID)) {
  405. auto main_program_metadata = main_program_description->metadata();
  406. auto new_euid = old_credentials->euid();
  407. auto new_egid = old_credentials->egid();
  408. auto new_suid = old_credentials->suid();
  409. auto new_sgid = old_credentials->sgid();
  410. if (main_program_metadata.is_setuid()) {
  411. executable_is_setid = true;
  412. new_euid = main_program_metadata.uid;
  413. new_suid = main_program_metadata.uid;
  414. }
  415. if (main_program_metadata.is_setgid()) {
  416. executable_is_setid = true;
  417. new_egid = main_program_metadata.gid;
  418. new_sgid = main_program_metadata.gid;
  419. }
  420. if (executable_is_setid) {
  421. new_credentials = TRY(Credentials::create(
  422. old_credentials->uid(),
  423. old_credentials->gid(),
  424. new_euid,
  425. new_egid,
  426. new_suid,
  427. new_sgid,
  428. old_credentials->extra_gids()));
  429. }
  430. }
  431. // We commit to the new executable at this point. There is no turning back!
  432. // Prevent other processes from attaching to us with ptrace while we're doing this.
  433. MutexLocker ptrace_locker(ptrace_lock());
  434. // Disable profiling temporarily in case it's running on this process.
  435. auto was_profiling = m_profiling;
  436. TemporaryChange profiling_disabler(m_profiling, false);
  437. kill_threads_except_self();
  438. with_mutable_protected_data([&](auto& protected_data) {
  439. protected_data.credentials = move(new_credentials);
  440. protected_data.dumpable = !executable_is_setid;
  441. });
  442. // We make sure to enter the new address space before destroying the old one.
  443. // This ensures that the process always has a valid page directory.
  444. Memory::MemoryManager::enter_address_space(*load_result.space);
  445. m_space = load_result.space.release_nonnull();
  446. m_executable.with([&](auto& executable) { executable = main_program_description->custody(); });
  447. m_arguments = move(arguments);
  448. m_environment = move(environment);
  449. TRY(m_unveil_data.with([&](auto& unveil_data) -> ErrorOr<void> {
  450. unveil_data.state = VeilState::None;
  451. unveil_data.paths.clear();
  452. unveil_data.paths.set_metadata({ TRY(KString::try_create("/"sv)), UnveilAccess::None, false });
  453. return {};
  454. }));
  455. m_coredump_properties.for_each([](auto& property) {
  456. property = {};
  457. });
  458. auto* current_thread = Thread::current();
  459. current_thread->reset_signals_for_exec();
  460. clear_signal_handlers_for_exec();
  461. clear_futex_queues_on_exec();
  462. m_fds.with_exclusive([&](auto& fds) {
  463. fds.change_each([&](auto& file_description_metadata) {
  464. if (file_description_metadata.is_valid() && file_description_metadata.flags() & FD_CLOEXEC)
  465. file_description_metadata = {};
  466. });
  467. });
  468. if (main_program_fd_allocation.has_value()) {
  469. main_program_description->set_readable(true);
  470. m_fds.with_exclusive([&](auto& fds) { fds[main_program_fd_allocation->fd].set(move(main_program_description), FD_CLOEXEC); });
  471. }
  472. new_main_thread = nullptr;
  473. if (&current_thread->process() == this) {
  474. new_main_thread = current_thread;
  475. } else {
  476. for_each_thread([&](auto& thread) {
  477. new_main_thread = &thread;
  478. return IterationDecision::Break;
  479. });
  480. }
  481. VERIFY(new_main_thread);
  482. auto auxv = generate_auxiliary_vector(load_result.load_base, load_result.entry_eip, uid(), euid(), gid(), egid(), path->view(), main_program_fd_allocation);
  483. // NOTE: We create the new stack before disabling interrupts since it will zero-fault
  484. // and we don't want to deal with faults after this point.
  485. auto new_userspace_sp = TRY(make_userspace_context_for_main_thread(new_main_thread->regs(), *load_result.stack_region.unsafe_ptr(), m_arguments, m_environment, move(auxv)));
  486. m_name = move(new_process_name);
  487. new_main_thread->set_name(move(new_main_thread_name));
  488. if (wait_for_tracer_at_next_execve()) {
  489. // Make sure we release the ptrace lock here or the tracer will block forever.
  490. ptrace_locker.unlock();
  491. Thread::current()->send_urgent_signal_to_self(SIGSTOP);
  492. } else {
  493. // Unlock regardless before disabling interrupts.
  494. // Ensure we always unlock after checking ptrace status to avoid TOCTOU ptrace issues
  495. ptrace_locker.unlock();
  496. }
  497. // We enter a critical section here because we don't want to get interrupted between do_exec()
  498. // and Processor::assume_context() or the next context switch.
  499. // If we used an InterruptDisabler that sti()'d on exit, we might timer tick'd too soon in exec().
  500. Processor::enter_critical();
  501. prev_flags = cpu_flags();
  502. cli();
  503. // NOTE: Be careful to not trigger any page faults below!
  504. with_mutable_protected_data([&](auto& protected_data) {
  505. protected_data.promises = protected_data.execpromises.load();
  506. protected_data.has_promises = protected_data.has_execpromises.load();
  507. protected_data.execpromises = 0;
  508. protected_data.has_execpromises = false;
  509. protected_data.signal_trampoline = signal_trampoline_region->vaddr();
  510. // FIXME: PID/TID ISSUE
  511. protected_data.pid = new_main_thread->tid().value();
  512. });
  513. auto tsr_result = new_main_thread->make_thread_specific_region({});
  514. if (tsr_result.is_error()) {
  515. // FIXME: We cannot fail this late. Refactor this so the allocation happens before we commit to the new executable.
  516. VERIFY_NOT_REACHED();
  517. }
  518. new_main_thread->reset_fpu_state();
  519. auto& regs = new_main_thread->m_regs;
  520. regs.cs = GDT_SELECTOR_CODE3 | 3;
  521. #if ARCH(I386)
  522. regs.ds = GDT_SELECTOR_DATA3 | 3;
  523. regs.es = GDT_SELECTOR_DATA3 | 3;
  524. regs.ss = GDT_SELECTOR_DATA3 | 3;
  525. regs.fs = GDT_SELECTOR_DATA3 | 3;
  526. regs.gs = GDT_SELECTOR_TLS | 3;
  527. regs.eip = load_result.entry_eip;
  528. regs.esp = new_userspace_sp;
  529. #else
  530. regs.rip = load_result.entry_eip;
  531. regs.rsp = new_userspace_sp;
  532. #endif
  533. regs.cr3 = address_space().page_directory().cr3();
  534. {
  535. TemporaryChange profiling_disabler(m_profiling, was_profiling);
  536. PerformanceManager::add_process_exec_event(*this);
  537. }
  538. u32 lock_count_to_restore;
  539. [[maybe_unused]] auto rc = big_lock().force_unlock_exclusive_if_locked(lock_count_to_restore);
  540. VERIFY_INTERRUPTS_DISABLED();
  541. VERIFY(Processor::in_critical());
  542. return {};
  543. }
  544. static Array<ELF::AuxiliaryValue, auxiliary_vector_size> generate_auxiliary_vector(FlatPtr load_base, FlatPtr entry_eip, UserID uid, UserID euid, GroupID gid, GroupID egid, StringView executable_path, Optional<Process::ScopedDescriptionAllocation> const& main_program_fd_allocation)
  545. {
  546. return { {
  547. // PHDR/EXECFD
  548. // PH*
  549. { ELF::AuxiliaryValue::PageSize, PAGE_SIZE },
  550. { ELF::AuxiliaryValue::BaseAddress, (void*)load_base },
  551. { ELF::AuxiliaryValue::Entry, (void*)entry_eip },
  552. // NOTELF
  553. { ELF::AuxiliaryValue::Uid, (long)uid.value() },
  554. { ELF::AuxiliaryValue::EUid, (long)euid.value() },
  555. { ELF::AuxiliaryValue::Gid, (long)gid.value() },
  556. { ELF::AuxiliaryValue::EGid, (long)egid.value() },
  557. { ELF::AuxiliaryValue::Platform, Processor::platform_string() },
  558. // FIXME: This is platform specific
  559. { ELF::AuxiliaryValue::HwCap, (long)CPUID(1).edx() },
  560. { ELF::AuxiliaryValue::ClockTick, (long)TimeManagement::the().ticks_per_second() },
  561. // FIXME: Also take into account things like extended filesystem permissions? That's what linux does...
  562. { ELF::AuxiliaryValue::Secure, ((uid != euid) || (gid != egid)) ? 1 : 0 },
  563. { ELF::AuxiliaryValue::Random, nullptr },
  564. { ELF::AuxiliaryValue::ExecFilename, executable_path },
  565. main_program_fd_allocation.has_value() ? ELF::AuxiliaryValue { ELF::AuxiliaryValue::ExecFileDescriptor, main_program_fd_allocation->fd } : ELF::AuxiliaryValue { ELF::AuxiliaryValue::Ignore, 0L },
  566. { ELF::AuxiliaryValue::Null, 0L },
  567. } };
  568. }
  569. static ErrorOr<NonnullOwnPtrVector<KString>> find_shebang_interpreter_for_executable(char const first_page[], size_t nread)
  570. {
  571. int word_start = 2;
  572. size_t word_length = 0;
  573. if (nread > 2 && first_page[0] == '#' && first_page[1] == '!') {
  574. NonnullOwnPtrVector<KString> interpreter_words;
  575. for (size_t i = 2; i < nread; ++i) {
  576. if (first_page[i] == '\n') {
  577. break;
  578. }
  579. if (first_page[i] != ' ') {
  580. ++word_length;
  581. }
  582. if (first_page[i] == ' ') {
  583. if (word_length > 0) {
  584. auto word = TRY(KString::try_create(StringView { &first_page[word_start], word_length }));
  585. TRY(interpreter_words.try_append(move(word)));
  586. }
  587. word_length = 0;
  588. word_start = i + 1;
  589. }
  590. }
  591. if (word_length > 0) {
  592. auto word = TRY(KString::try_create(StringView { &first_page[word_start], word_length }));
  593. TRY(interpreter_words.try_append(move(word)));
  594. }
  595. if (!interpreter_words.is_empty())
  596. return interpreter_words;
  597. }
  598. return ENOEXEC;
  599. }
  600. ErrorOr<LockRefPtr<OpenFileDescription>> Process::find_elf_interpreter_for_executable(StringView path, ElfW(Ehdr) const& main_executable_header, size_t main_executable_header_size, size_t file_size)
  601. {
  602. // Not using ErrorOr here because we'll want to do the same thing in userspace in the RTLD
  603. StringBuilder interpreter_path_builder;
  604. if (!TRY(ELF::validate_program_headers(main_executable_header, file_size, { &main_executable_header, main_executable_header_size }, &interpreter_path_builder))) {
  605. dbgln("exec({}): File has invalid ELF Program headers", path);
  606. return ENOEXEC;
  607. }
  608. auto interpreter_path = interpreter_path_builder.string_view();
  609. if (!interpreter_path.is_empty()) {
  610. dbgln_if(EXEC_DEBUG, "exec({}): Using program interpreter {}", path, interpreter_path);
  611. auto interpreter_description = TRY(VirtualFileSystem::the().open(credentials(), interpreter_path, O_EXEC, 0, current_directory()));
  612. auto interp_metadata = interpreter_description->metadata();
  613. VERIFY(interpreter_description->inode());
  614. // Validate the program interpreter as a valid elf binary.
  615. // If your program interpreter is a #! file or something, it's time to stop playing games :)
  616. if (interp_metadata.size < (int)sizeof(ElfW(Ehdr)))
  617. return ENOEXEC;
  618. char first_page[PAGE_SIZE] = {};
  619. auto first_page_buffer = UserOrKernelBuffer::for_kernel_buffer((u8*)&first_page);
  620. auto nread = TRY(interpreter_description->read(first_page_buffer, sizeof(first_page)));
  621. if (nread < sizeof(ElfW(Ehdr)))
  622. return ENOEXEC;
  623. auto* elf_header = (ElfW(Ehdr)*)first_page;
  624. if (!ELF::validate_elf_header(*elf_header, interp_metadata.size)) {
  625. dbgln("exec({}): Interpreter ({}) has invalid ELF header", path, interpreter_path);
  626. return ENOEXEC;
  627. }
  628. // Not using ErrorOr here because we'll want to do the same thing in userspace in the RTLD
  629. StringBuilder interpreter_interpreter_path_builder;
  630. if (!TRY(ELF::validate_program_headers(*elf_header, interp_metadata.size, { first_page, nread }, &interpreter_interpreter_path_builder))) {
  631. dbgln("exec({}): Interpreter ({}) has invalid ELF Program headers", path, interpreter_path);
  632. return ENOEXEC;
  633. }
  634. auto interpreter_interpreter_path = interpreter_interpreter_path_builder.string_view();
  635. if (!interpreter_interpreter_path.is_empty()) {
  636. dbgln("exec({}): Interpreter ({}) has its own interpreter ({})! No thank you!", path, interpreter_path, interpreter_interpreter_path);
  637. return ELOOP;
  638. }
  639. return interpreter_description;
  640. }
  641. if (main_executable_header.e_type == ET_REL) {
  642. // We can't exec an ET_REL, that's just an object file from the compiler
  643. return ENOEXEC;
  644. }
  645. if (main_executable_header.e_type == ET_DYN) {
  646. // If it's ET_DYN with no PT_INTERP, then it's a dynamic executable responsible
  647. // for its own relocation (i.e. it's /usr/lib/Loader.so)
  648. if (path != "/usr/lib/Loader.so")
  649. dbgln("exec({}): WARNING - Dynamic ELF executable without a PT_INTERP header, and isn't /usr/lib/Loader.so", path);
  650. return nullptr;
  651. }
  652. // No interpreter, but, path refers to a valid elf image
  653. return nullptr;
  654. }
  655. ErrorOr<void> Process::exec(NonnullOwnPtr<KString> path, NonnullOwnPtrVector<KString> arguments, NonnullOwnPtrVector<KString> environment, Thread*& new_main_thread, u32& prev_flags, int recursion_depth)
  656. {
  657. if (recursion_depth > 2) {
  658. dbgln("exec({}): SHENANIGANS! recursed too far trying to find #! interpreter", path);
  659. return ELOOP;
  660. }
  661. // Open the file to check what kind of binary format it is
  662. // Currently supported formats:
  663. // - #! interpreted file
  664. // - ELF32
  665. // * ET_EXEC binary that just gets loaded
  666. // * ET_DYN binary that requires a program interpreter
  667. //
  668. auto description = TRY(VirtualFileSystem::the().open(credentials(), path->view(), O_EXEC, 0, current_directory()));
  669. auto metadata = description->metadata();
  670. if (!metadata.is_regular_file())
  671. return EACCES;
  672. // Always gonna need at least 3 bytes. these are for #!X
  673. if (metadata.size < 3)
  674. return ENOEXEC;
  675. VERIFY(description->inode());
  676. // Read the first page of the program into memory so we can validate the binfmt of it
  677. char first_page[PAGE_SIZE];
  678. auto first_page_buffer = UserOrKernelBuffer::for_kernel_buffer((u8*)&first_page);
  679. auto nread = TRY(description->read(first_page_buffer, sizeof(first_page)));
  680. // 1) #! interpreted file
  681. auto shebang_result = find_shebang_interpreter_for_executable(first_page, nread);
  682. if (!shebang_result.is_error()) {
  683. auto shebang_words = shebang_result.release_value();
  684. auto shebang_path = TRY(shebang_words.first().try_clone());
  685. arguments.ptr_at(0) = move(path);
  686. TRY(arguments.try_prepend(move(shebang_words)));
  687. return exec(move(shebang_path), move(arguments), move(environment), new_main_thread, prev_flags, ++recursion_depth);
  688. }
  689. // #2) ELF32 for i386
  690. if (nread < sizeof(ElfW(Ehdr)))
  691. return ENOEXEC;
  692. auto const* main_program_header = (ElfW(Ehdr)*)first_page;
  693. if (!ELF::validate_elf_header(*main_program_header, metadata.size)) {
  694. dbgln("exec({}): File has invalid ELF header", path);
  695. return ENOEXEC;
  696. }
  697. auto interpreter_description = TRY(find_elf_interpreter_for_executable(path->view(), *main_program_header, nread, metadata.size));
  698. return do_exec(move(description), move(arguments), move(environment), move(interpreter_description), new_main_thread, prev_flags, *main_program_header);
  699. }
  700. ErrorOr<FlatPtr> Process::sys$execve(Userspace<Syscall::SC_execve_params const*> user_params)
  701. {
  702. VERIFY_PROCESS_BIG_LOCK_ACQUIRED(this);
  703. TRY(require_promise(Pledge::exec));
  704. Thread* new_main_thread = nullptr;
  705. u32 prev_flags = 0;
  706. // NOTE: Be extremely careful with allocating any kernel memory in this function.
  707. // On success, the kernel stack will be lost.
  708. // The explicit block scope below is specifically placed to minimize the number
  709. // of stack locals in this function.
  710. {
  711. auto params = TRY(copy_typed_from_user(user_params));
  712. if (params.arguments.length > ARG_MAX || params.environment.length > ARG_MAX)
  713. return E2BIG;
  714. // NOTE: The caller is expected to always pass at least one argument by convention,
  715. // the program path that was passed as params.path.
  716. if (params.arguments.length == 0)
  717. return EINVAL;
  718. auto path = TRY(get_syscall_path_argument(params.path));
  719. auto copy_user_strings = [](auto const& list, auto& output) -> ErrorOr<void> {
  720. if (!list.length)
  721. return {};
  722. Checked<size_t> size = sizeof(*list.strings);
  723. size *= list.length;
  724. if (size.has_overflow())
  725. return EOVERFLOW;
  726. Vector<Syscall::StringArgument, 32> strings;
  727. TRY(strings.try_resize(list.length));
  728. TRY(copy_from_user(strings.data(), list.strings, size.value()));
  729. for (size_t i = 0; i < list.length; ++i) {
  730. auto string = TRY(try_copy_kstring_from_user(strings[i]));
  731. TRY(output.try_append(move(string)));
  732. }
  733. return {};
  734. };
  735. NonnullOwnPtrVector<KString> arguments;
  736. TRY(copy_user_strings(params.arguments, arguments));
  737. NonnullOwnPtrVector<KString> environment;
  738. TRY(copy_user_strings(params.environment, environment));
  739. TRY(exec(move(path), move(arguments), move(environment), new_main_thread, prev_flags));
  740. }
  741. // NOTE: If we're here, the exec has succeeded and we've got a new executable image!
  742. // We will not return normally from this function. Instead, the next time we
  743. // get scheduled, it'll be at the entry point of the new executable.
  744. VERIFY_INTERRUPTS_DISABLED();
  745. VERIFY(Processor::in_critical());
  746. auto* current_thread = Thread::current();
  747. if (current_thread == new_main_thread) {
  748. // We need to enter the scheduler lock before changing the state
  749. // and it will be released after the context switch into that
  750. // thread. We should also still be in our critical section
  751. VERIFY(!g_scheduler_lock.is_locked_by_current_processor());
  752. VERIFY(Processor::in_critical() == 1);
  753. g_scheduler_lock.lock();
  754. current_thread->set_state(Thread::State::Running);
  755. Processor::assume_context(*current_thread, prev_flags);
  756. VERIFY_NOT_REACHED();
  757. }
  758. // NOTE: This code path is taken in the non-syscall case, i.e when the kernel spawns
  759. // a userspace process directly (such as /bin/SystemServer on startup)
  760. if (prev_flags & 0x200)
  761. sti();
  762. Processor::leave_critical();
  763. return 0;
  764. }
  765. }