strace.cpp 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946
  1. /*
  2. * Copyright (c) 2018-2021, Andreas Kling <kling@serenityos.org>
  3. *
  4. * SPDX-License-Identifier: BSD-2-Clause
  5. */
  6. #include <AK/Assertions.h>
  7. #include <AK/Format.h>
  8. #include <AK/IPv4Address.h>
  9. #include <AK/StdLibExtras.h>
  10. #include <AK/Types.h>
  11. #include <LibC/sys/arch/i386/regs.h>
  12. #include <LibCore/ArgsParser.h>
  13. #include <LibCore/File.h>
  14. #include <errno.h>
  15. #include <fcntl.h>
  16. #include <netinet/in.h>
  17. #include <signal.h>
  18. #include <stdio.h>
  19. #include <stdlib.h>
  20. #include <string.h>
  21. #include <sys/ioctl.h>
  22. #include <sys/mman.h>
  23. #include <sys/ptrace.h>
  24. #include <sys/socket.h>
  25. #include <sys/time.h>
  26. #include <sys/wait.h>
  27. #include <syscall.h>
  28. #include <unistd.h>
  29. #define HANDLE(VALUE) \
  30. case VALUE: \
  31. return #VALUE;
  32. #define VALUES_TO_NAMES(FUNC_NAME) \
  33. static String FUNC_NAME(int value) \
  34. { \
  35. switch (value) {
  36. #define END_VALUES_TO_NAMES() \
  37. } \
  38. return String::formatted("{}", value); \
  39. }
  40. VALUES_TO_NAMES(errno_name)
  41. HANDLE(EPERM)
  42. HANDLE(ENOENT)
  43. HANDLE(ESRCH)
  44. HANDLE(EINTR)
  45. HANDLE(EIO)
  46. HANDLE(ENXIO)
  47. HANDLE(E2BIG)
  48. HANDLE(ENOEXEC)
  49. HANDLE(EBADF)
  50. HANDLE(ECHILD)
  51. HANDLE(EAGAIN)
  52. HANDLE(ENOMEM)
  53. HANDLE(EACCES)
  54. HANDLE(EFAULT)
  55. HANDLE(ENOTBLK)
  56. HANDLE(EBUSY)
  57. HANDLE(EEXIST)
  58. HANDLE(EXDEV)
  59. HANDLE(ENODEV)
  60. HANDLE(ENOTDIR)
  61. HANDLE(EISDIR)
  62. HANDLE(EINVAL)
  63. HANDLE(ENFILE)
  64. HANDLE(EMFILE)
  65. HANDLE(ENOTTY)
  66. HANDLE(ETXTBSY)
  67. HANDLE(EFBIG)
  68. HANDLE(ENOSPC)
  69. HANDLE(ESPIPE)
  70. HANDLE(EROFS)
  71. HANDLE(EMLINK)
  72. HANDLE(EPIPE)
  73. HANDLE(ERANGE)
  74. HANDLE(ENAMETOOLONG)
  75. HANDLE(ELOOP)
  76. HANDLE(EOVERFLOW)
  77. HANDLE(EOPNOTSUPP)
  78. HANDLE(ENOSYS)
  79. HANDLE(ENOTIMPL)
  80. HANDLE(EAFNOSUPPORT)
  81. HANDLE(ENOTSOCK)
  82. HANDLE(EADDRINUSE)
  83. HANDLE(EWHYTHO)
  84. HANDLE(ENOTEMPTY)
  85. HANDLE(EDOM)
  86. HANDLE(ECONNREFUSED)
  87. HANDLE(EADDRNOTAVAIL)
  88. HANDLE(EISCONN)
  89. HANDLE(ECONNABORTED)
  90. HANDLE(EALREADY)
  91. HANDLE(ECONNRESET)
  92. HANDLE(EDESTADDRREQ)
  93. HANDLE(EHOSTUNREACH)
  94. HANDLE(EILSEQ)
  95. HANDLE(EMSGSIZE)
  96. HANDLE(ENETDOWN)
  97. HANDLE(ENETUNREACH)
  98. HANDLE(ENETRESET)
  99. HANDLE(ENOBUFS)
  100. HANDLE(ENOLCK)
  101. HANDLE(ENOMSG)
  102. HANDLE(ENOPROTOOPT)
  103. HANDLE(ENOTCONN)
  104. HANDLE(EPROTONOSUPPORT)
  105. HANDLE(EDEADLK)
  106. HANDLE(ETIMEDOUT)
  107. HANDLE(EPROTOTYPE)
  108. HANDLE(EINPROGRESS)
  109. HANDLE(ENOTHREAD)
  110. HANDLE(EPROTO)
  111. HANDLE(ENOTSUP)
  112. HANDLE(EPFNOSUPPORT)
  113. HANDLE(EDIRINTOSELF)
  114. HANDLE(EDQUOT)
  115. HANDLE(EMAXERRNO)
  116. END_VALUES_TO_NAMES()
  117. VALUES_TO_NAMES(whence_name)
  118. HANDLE(SEEK_SET)
  119. HANDLE(SEEK_CUR)
  120. HANDLE(SEEK_END)
  121. END_VALUES_TO_NAMES()
  122. VALUES_TO_NAMES(ioctl_request_name)
  123. HANDLE(TIOCGPGRP)
  124. HANDLE(TIOCSPGRP)
  125. HANDLE(TCGETS)
  126. HANDLE(TCSETS)
  127. HANDLE(TCSETSW)
  128. HANDLE(TCSETSF)
  129. HANDLE(TCFLSH)
  130. HANDLE(TIOCGWINSZ)
  131. HANDLE(TIOCSCTTY)
  132. HANDLE(TIOCSTI)
  133. HANDLE(TIOCNOTTY)
  134. HANDLE(TIOCSWINSZ)
  135. HANDLE(FB_IOCTL_GET_PROPERTIES)
  136. HANDLE(FB_IOCTL_GET_HEAD_PROPERTIES)
  137. HANDLE(FB_IOCTL_SET_HEAD_RESOLUTION)
  138. HANDLE(FB_IOCTL_SET_HEAD_VERTICAL_OFFSET_BUFFER)
  139. HANDLE(FB_IOCTL_GET_HEAD_VERTICAL_OFFSET_BUFFER)
  140. HANDLE(FB_IOCTL_FLUSH_HEAD_BUFFERS)
  141. HANDLE(FB_IOCTL_FLUSH_HEAD)
  142. HANDLE(KEYBOARD_IOCTL_GET_NUM_LOCK)
  143. HANDLE(KEYBOARD_IOCTL_SET_NUM_LOCK)
  144. HANDLE(KEYBOARD_IOCTL_GET_CAPS_LOCK)
  145. HANDLE(KEYBOARD_IOCTL_SET_CAPS_LOCK)
  146. HANDLE(SIOCSIFADDR)
  147. HANDLE(SIOCGIFADDR)
  148. HANDLE(SIOCGIFHWADDR)
  149. HANDLE(SIOCGIFNETMASK)
  150. HANDLE(SIOCSIFNETMASK)
  151. HANDLE(SIOCGIFBRDADDR)
  152. HANDLE(SIOCGIFMTU)
  153. HANDLE(SIOCGIFFLAGS)
  154. HANDLE(SIOCGIFCONF)
  155. HANDLE(SIOCADDRT)
  156. HANDLE(SIOCDELRT)
  157. HANDLE(SIOCSARP)
  158. HANDLE(SIOCDARP)
  159. HANDLE(FIBMAP)
  160. HANDLE(FIONBIO)
  161. HANDLE(FIONREAD)
  162. HANDLE(KCOV_SETBUFSIZE)
  163. HANDLE(KCOV_ENABLE)
  164. HANDLE(KCOV_DISABLE)
  165. HANDLE(SOUNDCARD_IOCTL_SET_SAMPLE_RATE)
  166. HANDLE(SOUNDCARD_IOCTL_GET_SAMPLE_RATE)
  167. HANDLE(STORAGE_DEVICE_GET_SIZE)
  168. HANDLE(STORAGE_DEVICE_GET_BLOCK_SIZE)
  169. END_VALUES_TO_NAMES()
  170. VALUES_TO_NAMES(domain_name)
  171. HANDLE(AF_UNSPEC)
  172. HANDLE(AF_UNIX)
  173. HANDLE(AF_INET)
  174. HANDLE(AF_INET6)
  175. END_VALUES_TO_NAMES()
  176. VALUES_TO_NAMES(socket_type_name)
  177. HANDLE(SOCK_STREAM)
  178. HANDLE(SOCK_DGRAM)
  179. HANDLE(SOCK_RAW)
  180. HANDLE(SOCK_RDM)
  181. HANDLE(SOCK_SEQPACKET)
  182. END_VALUES_TO_NAMES()
  183. VALUES_TO_NAMES(protocol_name)
  184. HANDLE(PF_UNSPEC)
  185. HANDLE(PF_UNIX)
  186. HANDLE(PF_INET)
  187. HANDLE(PF_INET6)
  188. END_VALUES_TO_NAMES()
  189. VALUES_TO_NAMES(clockid_name)
  190. HANDLE(CLOCK_REALTIME)
  191. HANDLE(CLOCK_MONOTONIC)
  192. HANDLE(CLOCK_REALTIME_COARSE)
  193. HANDLE(CLOCK_MONOTONIC_COARSE)
  194. END_VALUES_TO_NAMES()
  195. static int g_pid = -1;
  196. #if ARCH(I386)
  197. using syscall_arg_t = u32;
  198. #else
  199. using syscall_arg_t = u64;
  200. #endif
  201. static void handle_sigint(int)
  202. {
  203. if (g_pid == -1)
  204. return;
  205. if (ptrace(PT_DETACH, g_pid, 0, 0) == -1) {
  206. perror("detach");
  207. }
  208. }
  209. static void copy_from_process(const void* source_p, Bytes target)
  210. {
  211. auto source = static_cast<const char*>(source_p);
  212. size_t offset = 0;
  213. size_t left = target.size();
  214. while (left) {
  215. int value = ptrace(PT_PEEK, g_pid, const_cast<char*>(source) + offset, 0);
  216. size_t to_copy = min(sizeof(int), left);
  217. target.overwrite(offset, &value, to_copy);
  218. left -= to_copy;
  219. offset += to_copy;
  220. }
  221. }
  222. static ByteBuffer copy_from_process(const void* source, size_t length)
  223. {
  224. auto buffer = ByteBuffer::create_uninitialized(length).value();
  225. copy_from_process(source, buffer.bytes());
  226. return buffer;
  227. }
  228. template<typename T>
  229. static T copy_from_process(const T* source)
  230. {
  231. T value {};
  232. copy_from_process(source, Bytes { &value, sizeof(T) });
  233. return value;
  234. }
  235. struct BitflagOption {
  236. int value;
  237. StringView name;
  238. };
  239. #define BITFLAG(NAME) \
  240. BitflagOption { NAME, #NAME }
  241. struct BitflagBase {
  242. int flagset;
  243. // Derivatives must define 'options', like so:
  244. // static constexpr auto options = { BITFLAG(O_CREAT), BITFLAG(O_DIRECTORY) };
  245. };
  246. namespace AK {
  247. template<typename BitflagDerivative>
  248. requires(IsBaseOf<BitflagBase, BitflagDerivative>) && requires { BitflagDerivative::options; }
  249. struct Formatter<BitflagDerivative> : StandardFormatter {
  250. Formatter() = default;
  251. explicit Formatter(StandardFormatter formatter)
  252. : StandardFormatter(formatter)
  253. {
  254. }
  255. ErrorOr<void> format(FormatBuilder& format_builder, BitflagDerivative const& value)
  256. {
  257. bool had_any_output = false;
  258. int remaining = value.flagset;
  259. for (BitflagOption const& option : BitflagDerivative::options) {
  260. if ((remaining & option.value) != option.value)
  261. continue;
  262. remaining &= ~option.value;
  263. if (had_any_output)
  264. TRY(format_builder.put_literal(" | "));
  265. TRY(format_builder.put_literal(option.name));
  266. had_any_output = true;
  267. }
  268. if (remaining != 0) {
  269. // No more BitflagOptions are available. Any remaining flags are unrecognized.
  270. if (had_any_output)
  271. TRY(format_builder.put_literal(" | "));
  272. format_builder.builder().appendff("0x{:x} (?)", static_cast<unsigned>(remaining));
  273. had_any_output = true;
  274. }
  275. if (!had_any_output) {
  276. if constexpr (requires { BitflagDerivative::default_; })
  277. TRY(format_builder.put_literal(BitflagDerivative::default_));
  278. else
  279. TRY(format_builder.put_literal("0"));
  280. }
  281. return {};
  282. }
  283. };
  284. }
  285. struct PointerArgument {
  286. const void* value;
  287. };
  288. namespace AK {
  289. template<>
  290. struct Formatter<PointerArgument> : StandardFormatter {
  291. Formatter() = default;
  292. explicit Formatter(StandardFormatter formatter)
  293. : StandardFormatter(formatter)
  294. {
  295. }
  296. ErrorOr<void> format(FormatBuilder& format_builder, PointerArgument const& value)
  297. {
  298. auto& builder = format_builder.builder();
  299. if (value.value == nullptr)
  300. builder.append("null");
  301. else
  302. builder.appendff("{}", value.value);
  303. return {};
  304. }
  305. };
  306. }
  307. class FormattedSyscallBuilder {
  308. public:
  309. FormattedSyscallBuilder(StringView syscall_name)
  310. {
  311. m_builder.append(syscall_name);
  312. m_builder.append('(');
  313. }
  314. template<typename T>
  315. void add_argument(CheckedFormatString<T> format, T&& arg)
  316. {
  317. add_argument_separator();
  318. m_builder.appendff(format.view(), forward<T>(arg));
  319. }
  320. template<typename T>
  321. void add_argument(T&& arg)
  322. {
  323. add_argument("{}", forward<T>(arg));
  324. }
  325. void add_string_argument(Syscall::StringArgument const& string_argument, StringView trim_by = {})
  326. {
  327. if (string_argument.characters == nullptr)
  328. add_argument("null");
  329. else {
  330. auto string_buffer = copy_from_process(string_argument.characters, string_argument.length);
  331. auto view = StringView(string_buffer);
  332. if (!trim_by.is_empty())
  333. view = view.trim(trim_by);
  334. add_argument("\"{}\"", view);
  335. }
  336. }
  337. template<typename... Ts>
  338. void add_arguments(Ts&&... args)
  339. {
  340. (add_argument(forward<Ts>(args)), ...);
  341. }
  342. template<typename T>
  343. void format_result_no_error(T res)
  344. {
  345. m_builder.appendff(") = {}\n", res);
  346. }
  347. void format_result(Integral auto res)
  348. {
  349. m_builder.append(") = ");
  350. if (res < 0)
  351. m_builder.appendff("{} {}", res, errno_name(-(int)res));
  352. else
  353. m_builder.appendff("{}", res);
  354. m_builder.append('\n');
  355. }
  356. void format_result(void* res)
  357. {
  358. if (res == MAP_FAILED)
  359. m_builder.append(") = MAP_FAILED\n");
  360. else if (FlatPtr(res) > FlatPtr(-EMAXERRNO))
  361. m_builder.appendff(") = {} {}\n", res, errno_name(-static_cast<int>(FlatPtr(res))));
  362. else
  363. m_builder.appendff(") = {}\n", res);
  364. }
  365. void format_result()
  366. {
  367. m_builder.append(")\n");
  368. }
  369. StringView string_view()
  370. {
  371. return m_builder.string_view();
  372. }
  373. private:
  374. void add_argument_separator()
  375. {
  376. if (!m_first_arg) {
  377. m_builder.append(", ");
  378. }
  379. m_first_arg = false;
  380. }
  381. StringBuilder m_builder;
  382. bool m_first_arg { true };
  383. };
  384. static void format_getrandom(FormattedSyscallBuilder& builder, void* buffer, size_t size, unsigned flags)
  385. {
  386. builder.add_arguments(buffer, size, flags);
  387. }
  388. static void format_realpath(FormattedSyscallBuilder& builder, Syscall::SC_realpath_params* params_p)
  389. {
  390. auto params = copy_from_process(params_p);
  391. builder.add_string_argument(params.path);
  392. if (params.buffer.size == 0)
  393. builder.add_argument("null");
  394. else {
  395. auto buffer = copy_from_process(params.buffer.data, params.buffer.size);
  396. builder.add_argument("\"{}\"", StringView { (const char*)buffer.data() });
  397. }
  398. }
  399. static void format_exit(FormattedSyscallBuilder& builder, int status)
  400. {
  401. builder.add_argument(status);
  402. }
  403. struct OpenOptions : BitflagBase {
  404. static constexpr auto options = {
  405. BITFLAG(O_RDWR), BITFLAG(O_RDONLY), BITFLAG(O_WRONLY),
  406. BITFLAG(O_EXEC), BITFLAG(O_CREAT), BITFLAG(O_EXCL), BITFLAG(O_NOCTTY),
  407. BITFLAG(O_TRUNC), BITFLAG(O_APPEND), BITFLAG(O_NONBLOCK), BITFLAG(O_DIRECTORY),
  408. BITFLAG(O_NOFOLLOW), BITFLAG(O_CLOEXEC), BITFLAG(O_DIRECT)
  409. };
  410. };
  411. static void format_open(FormattedSyscallBuilder& builder, Syscall::SC_open_params* params_p)
  412. {
  413. auto params = copy_from_process(params_p);
  414. if (params.dirfd == AT_FDCWD)
  415. builder.add_argument("AT_FDCWD");
  416. else
  417. builder.add_argument(params.dirfd);
  418. builder.add_string_argument(params.path);
  419. builder.add_argument(OpenOptions { params.options });
  420. if (params.options & O_CREAT)
  421. builder.add_argument("{:04o}", params.mode);
  422. }
  423. static void format_ioctl(FormattedSyscallBuilder& builder, int fd, unsigned request, void* arg)
  424. {
  425. builder.add_arguments(fd, ioctl_request_name(request));
  426. if (request == FIONBIO) {
  427. auto value = copy_from_process(reinterpret_cast<int*>(arg));
  428. builder.add_argument(value);
  429. } else
  430. builder.add_argument(PointerArgument { arg });
  431. }
  432. namespace AK {
  433. template<>
  434. struct Formatter<struct timespec> : StandardFormatter {
  435. ErrorOr<void> format(FormatBuilder& format_builder, struct timespec value)
  436. {
  437. auto& builder = format_builder.builder();
  438. builder.appendff("{{tv_sec={}, tv_nsec={}}}", value.tv_sec, value.tv_nsec);
  439. return {};
  440. }
  441. };
  442. template<>
  443. struct Formatter<struct timeval> : StandardFormatter {
  444. ErrorOr<void> format(FormatBuilder& format_builder, struct timeval value)
  445. {
  446. auto& builder = format_builder.builder();
  447. builder.appendff("{{tv_sec={}, tv_usec={}}}", value.tv_sec, value.tv_usec);
  448. return {};
  449. }
  450. };
  451. template<>
  452. struct Formatter<struct stat> : StandardFormatter {
  453. ErrorOr<void> format(FormatBuilder& format_builder, struct stat value)
  454. {
  455. auto& builder = format_builder.builder();
  456. builder.appendff(
  457. "{{st_dev={}, st_ino={}, st_mode={}, st_nlink={}, st_uid={}, st_gid={}, st_rdev={}, "
  458. "st_size={}, st_blksize={}, st_blocks={}, st_atim={}, st_mtim={}, st_ctim={}}}",
  459. value.st_dev, value.st_ino, value.st_mode, value.st_nlink, value.st_uid, value.st_gid, value.st_rdev,
  460. value.st_size, value.st_blksize, value.st_blocks, value.st_atim, value.st_mtim, value.st_ctim);
  461. return {};
  462. }
  463. };
  464. }
  465. static void format_fstat(FormattedSyscallBuilder& builder, int fd, struct stat* buf_p)
  466. {
  467. auto buf = copy_from_process(buf_p);
  468. builder.add_arguments(fd, buf);
  469. }
  470. static void format_stat(FormattedSyscallBuilder& builder, Syscall::SC_stat_params* params_p)
  471. {
  472. auto params = copy_from_process(params_p);
  473. if (params.dirfd == AT_FDCWD)
  474. builder.add_argument("AT_FDCWD");
  475. else
  476. builder.add_argument(params.dirfd);
  477. builder.add_string_argument(params.path);
  478. builder.add_arguments(copy_from_process(params.statbuf), params.follow_symlinks);
  479. }
  480. static void format_lseek(FormattedSyscallBuilder& builder, int fd, off_t offset, int whence)
  481. {
  482. builder.add_arguments(fd, offset, whence_name(whence));
  483. }
  484. static void format_read(FormattedSyscallBuilder& builder, int fd, void* buf, size_t nbyte)
  485. {
  486. builder.add_arguments(fd, buf, nbyte);
  487. }
  488. static void format_write(FormattedSyscallBuilder& builder, int fd, void* buf, size_t nbyte)
  489. {
  490. builder.add_arguments(fd, buf, nbyte);
  491. }
  492. static void format_close(FormattedSyscallBuilder& builder, int fd)
  493. {
  494. builder.add_arguments(fd);
  495. }
  496. static void format_select(FormattedSyscallBuilder& builder, Syscall::SC_select_params* params_p)
  497. {
  498. // TODO: format fds and sigmask properly
  499. auto params = copy_from_process(params_p);
  500. builder.add_arguments(
  501. params.nfds,
  502. PointerArgument { params.readfds },
  503. PointerArgument { params.writefds },
  504. PointerArgument { params.exceptfds },
  505. copy_from_process(params.timeout),
  506. PointerArgument { params.sigmask });
  507. }
  508. namespace AK {
  509. template<>
  510. struct Formatter<struct sockaddr> : StandardFormatter {
  511. ErrorOr<void> format(FormatBuilder& format_builder, struct sockaddr address)
  512. {
  513. auto& builder = format_builder.builder();
  514. builder.append("{sa_family=");
  515. builder.append(domain_name(address.sa_family));
  516. if (address.sa_family == AF_INET) {
  517. auto* address_in = (const struct sockaddr_in*)&address;
  518. builder.appendff(
  519. ", sin_port={}, sin_addr={}",
  520. address_in->sin_port,
  521. IPv4Address(address_in->sin_addr.s_addr).to_string());
  522. } else if (address.sa_family == AF_UNIX) {
  523. auto* address_un = (const struct sockaddr_un*)&address;
  524. builder.appendff(
  525. ", sun_path={}",
  526. address_un->sun_path);
  527. }
  528. builder.append('}');
  529. return {};
  530. }
  531. };
  532. }
  533. static void format_socket(FormattedSyscallBuilder& builder, int domain, int type, int protocol)
  534. {
  535. // TODO: show additional options in type
  536. builder.add_arguments(domain_name(domain), socket_type_name(type & SOCK_TYPE_MASK), protocol_name(protocol));
  537. }
  538. static void format_connect(FormattedSyscallBuilder& builder, int socket, const struct sockaddr* address_p, socklen_t address_len)
  539. {
  540. builder.add_arguments(socket, copy_from_process(address_p), address_len);
  541. }
  542. struct MsgOptions : BitflagBase {
  543. static constexpr auto options = {
  544. BITFLAG(MSG_TRUNC), BITFLAG(MSG_CTRUNC), BITFLAG(MSG_PEEK),
  545. BITFLAG(MSG_OOB), BITFLAG(MSG_DONTROUTE), BITFLAG(MSG_WAITALL),
  546. BITFLAG(MSG_DONTWAIT)
  547. };
  548. };
  549. static void format_recvmsg(FormattedSyscallBuilder& builder, int socket, struct msghdr* message, int flags)
  550. {
  551. // TODO: format message
  552. builder.add_arguments(socket, message, MsgOptions { flags });
  553. }
  554. struct MmapFlags : BitflagBase {
  555. static constexpr auto options = {
  556. BITFLAG(MAP_SHARED), BITFLAG(MAP_PRIVATE), BITFLAG(MAP_FIXED), BITFLAG(MAP_ANONYMOUS),
  557. BITFLAG(MAP_RANDOMIZED), BITFLAG(MAP_STACK), BITFLAG(MAP_NORESERVE), BITFLAG(MAP_PURGEABLE)
  558. };
  559. static constexpr StringView default_ = "MAP_FILE";
  560. };
  561. struct MemoryProtectionFlags : BitflagBase {
  562. static constexpr auto options = {
  563. BITFLAG(PROT_READ), BITFLAG(PROT_WRITE), BITFLAG(PROT_EXEC)
  564. };
  565. static constexpr StringView default_ = "PROT_NONE";
  566. };
  567. static void format_mmap(FormattedSyscallBuilder& builder, Syscall::SC_mmap_params* params_p)
  568. {
  569. auto params = copy_from_process(params_p);
  570. builder.add_arguments(params.addr, params.size, MemoryProtectionFlags { params.prot }, MmapFlags { params.flags }, params.fd, params.offset, params.alignment);
  571. builder.add_string_argument(params.name);
  572. }
  573. static void format_munmap(FormattedSyscallBuilder& builder, void* addr, size_t size)
  574. {
  575. builder.add_arguments(addr, size);
  576. }
  577. static void format_mprotect(FormattedSyscallBuilder& builder, void* addr, size_t size, int prot)
  578. {
  579. builder.add_arguments(addr, size, MemoryProtectionFlags { prot });
  580. }
  581. static void format_set_mmap_name(FormattedSyscallBuilder& builder, Syscall::SC_set_mmap_name_params* params_p)
  582. {
  583. auto params = copy_from_process(params_p);
  584. builder.add_arguments(params.addr, params.size);
  585. builder.add_string_argument(params.name);
  586. }
  587. static void format_clock_gettime(FormattedSyscallBuilder& builder, clockid_t clockid, struct timespec* time)
  588. {
  589. builder.add_arguments(clockid_name(clockid), copy_from_process(time));
  590. }
  591. static void format_dbgputstr(FormattedSyscallBuilder& builder, char* characters, size_t size)
  592. {
  593. builder.add_string_argument({ characters, size }, "\0\n"sv);
  594. }
  595. static void format_get_process_name(FormattedSyscallBuilder& builder, char* buffer, size_t buffer_size)
  596. {
  597. builder.add_string_argument({ buffer, buffer_size });
  598. }
  599. static void format_syscall(FormattedSyscallBuilder& builder, Syscall::Function syscall_function, syscall_arg_t arg1, syscall_arg_t arg2, syscall_arg_t arg3, syscall_arg_t res)
  600. {
  601. enum ResultType {
  602. Int,
  603. Ssize,
  604. VoidP,
  605. Void
  606. };
  607. ResultType result_type { Int };
  608. switch (syscall_function) {
  609. case SC_getrandom:
  610. format_getrandom(builder, (void*)arg1, (size_t)arg2, (unsigned)arg3);
  611. break;
  612. case SC_realpath:
  613. format_realpath(builder, (Syscall::SC_realpath_params*)arg1);
  614. break;
  615. case SC_exit:
  616. format_exit(builder, (int)arg1);
  617. result_type = Void;
  618. break;
  619. case SC_open:
  620. format_open(builder, (Syscall::SC_open_params*)arg1);
  621. break;
  622. case SC_ioctl:
  623. format_ioctl(builder, (int)arg1, (unsigned)arg2, (void*)arg3);
  624. break;
  625. case SC_fstat:
  626. format_fstat(builder, (int)arg1, (struct stat*)arg2);
  627. result_type = Ssize;
  628. break;
  629. case SC_stat:
  630. format_stat(builder, (Syscall::SC_stat_params*)arg1);
  631. break;
  632. case SC_lseek:
  633. format_lseek(builder, (int)arg1, (off_t)arg2, (int)arg3);
  634. break;
  635. case SC_read:
  636. format_read(builder, (int)arg1, (void*)arg2, (size_t)arg3);
  637. result_type = Ssize;
  638. break;
  639. case SC_write:
  640. format_write(builder, (int)arg1, (void*)arg2, (size_t)arg3);
  641. result_type = Ssize;
  642. break;
  643. case SC_close:
  644. format_close(builder, (int)arg1);
  645. break;
  646. case SC_select:
  647. format_select(builder, (Syscall::SC_select_params*)arg1);
  648. break;
  649. case SC_socket:
  650. format_socket(builder, (int)arg1, (int)arg2, (int)arg3);
  651. break;
  652. case SC_recvmsg:
  653. format_recvmsg(builder, (int)arg1, (struct msghdr*)arg2, (int)arg3);
  654. result_type = Ssize;
  655. break;
  656. case SC_connect:
  657. format_connect(builder, (int)arg1, (const struct sockaddr*)arg2, (socklen_t)arg3);
  658. break;
  659. case SC_mmap:
  660. format_mmap(builder, (Syscall::SC_mmap_params*)arg1);
  661. result_type = VoidP;
  662. break;
  663. case SC_munmap:
  664. format_munmap(builder, (void*)arg1, (size_t)arg2);
  665. break;
  666. case SC_mprotect:
  667. format_mprotect(builder, (void*)arg1, (size_t)arg2, (int)arg3);
  668. break;
  669. case SC_set_mmap_name:
  670. format_set_mmap_name(builder, (Syscall::SC_set_mmap_name_params*)arg1);
  671. break;
  672. case SC_clock_gettime:
  673. format_clock_gettime(builder, (clockid_t)arg1, (struct timespec*)arg2);
  674. break;
  675. case SC_dbgputstr:
  676. format_dbgputstr(builder, (char*)arg1, (size_t)arg2);
  677. break;
  678. case SC_get_process_name:
  679. format_get_process_name(builder, (char*)arg1, (size_t)arg2);
  680. break;
  681. case SC_getuid:
  682. case SC_geteuid:
  683. case SC_getgid:
  684. case SC_getegid:
  685. case SC_getpid:
  686. case SC_getppid:
  687. case SC_gettid:
  688. break;
  689. default:
  690. builder.add_arguments((void*)arg1, (void*)arg2, (void*)arg3);
  691. result_type = VoidP;
  692. }
  693. switch (result_type) {
  694. case Int:
  695. builder.format_result((int)res);
  696. break;
  697. case Ssize:
  698. builder.format_result((ssize_t)res);
  699. break;
  700. case VoidP:
  701. builder.format_result((void*)res);
  702. break;
  703. case Void:
  704. builder.format_result();
  705. break;
  706. }
  707. }
  708. int main(int argc, char** argv)
  709. {
  710. if (pledge("stdio wpath cpath proc exec ptrace sigaction", nullptr) < 0) {
  711. perror("pledge");
  712. return 1;
  713. }
  714. Vector<const char*> child_argv;
  715. const char* output_filename = nullptr;
  716. const char* exclude_syscalls_option = nullptr;
  717. const char* include_syscalls_option = nullptr;
  718. HashTable<StringView> exclude_syscalls;
  719. HashTable<StringView> include_syscalls;
  720. auto trace_file = Core::File::standard_error();
  721. Core::ArgsParser parser;
  722. parser.set_stop_on_first_non_option(true);
  723. parser.set_general_help(
  724. "Trace all syscalls and their result.");
  725. parser.add_option(g_pid, "Trace the given PID", "pid", 'p', "pid");
  726. parser.add_option(output_filename, "Filename to write output to", "output", 'o', "output");
  727. parser.add_option(exclude_syscalls_option, "Comma-delimited syscalls to exclude", "exclude", 'e', "exclude");
  728. parser.add_option(include_syscalls_option, "Comma-delimited syscalls to include", "include", 'i', "include");
  729. parser.add_positional_argument(child_argv, "Arguments to exec", "argument", Core::ArgsParser::Required::No);
  730. parser.parse(argc, argv);
  731. if (output_filename != nullptr) {
  732. auto open_result = Core::File::open(output_filename, Core::OpenMode::WriteOnly);
  733. if (open_result.is_error()) {
  734. outln(stderr, "Failed to open output file: {}", open_result.error());
  735. return 1;
  736. }
  737. trace_file = open_result.value();
  738. }
  739. auto parse_syscalls = [](const char* option, auto& hash_table) {
  740. if (option != nullptr) {
  741. for (auto syscall : StringView(option).split_view(','))
  742. hash_table.set(syscall);
  743. }
  744. };
  745. parse_syscalls(exclude_syscalls_option, exclude_syscalls);
  746. parse_syscalls(include_syscalls_option, include_syscalls);
  747. if (pledge("stdio proc exec ptrace sigaction", nullptr) < 0) {
  748. perror("pledge");
  749. return 1;
  750. }
  751. int status;
  752. if (g_pid == -1) {
  753. if (child_argv.is_empty()) {
  754. warnln("strace: Expected either a pid or some arguments");
  755. return 1;
  756. }
  757. child_argv.append(nullptr);
  758. int pid = fork();
  759. if (pid < 0) {
  760. perror("fork");
  761. return 1;
  762. }
  763. if (!pid) {
  764. if (ptrace(PT_TRACE_ME, 0, 0, 0) == -1) {
  765. perror("traceme");
  766. return 1;
  767. }
  768. int rc = execvp(child_argv.first(), const_cast<char**>(child_argv.data()));
  769. if (rc < 0) {
  770. perror("execvp");
  771. exit(1);
  772. }
  773. VERIFY_NOT_REACHED();
  774. }
  775. g_pid = pid;
  776. if (waitpid(pid, &status, WSTOPPED | WEXITED) != pid || !WIFSTOPPED(status)) {
  777. perror("waitpid");
  778. return 1;
  779. }
  780. }
  781. struct sigaction sa;
  782. memset(&sa, 0, sizeof(struct sigaction));
  783. sa.sa_handler = handle_sigint;
  784. sigaction(SIGINT, &sa, nullptr);
  785. if (ptrace(PT_ATTACH, g_pid, 0, 0) == -1) {
  786. perror("attach");
  787. return 1;
  788. }
  789. if (waitpid(g_pid, &status, WSTOPPED | WEXITED) != g_pid || !WIFSTOPPED(status)) {
  790. perror("waitpid");
  791. return 1;
  792. }
  793. for (;;) {
  794. if (ptrace(PT_SYSCALL, g_pid, 0, 0) == -1) {
  795. perror("syscall");
  796. return 1;
  797. }
  798. if (waitpid(g_pid, &status, WSTOPPED | WEXITED) != g_pid || !WIFSTOPPED(status)) {
  799. perror("wait_pid");
  800. return 1;
  801. }
  802. PtraceRegisters regs = {};
  803. if (ptrace(PT_GETREGS, g_pid, &regs, 0) == -1) {
  804. perror("getregs");
  805. return 1;
  806. }
  807. #if ARCH(I386)
  808. syscall_arg_t syscall_index = regs.eax;
  809. syscall_arg_t arg1 = regs.edx;
  810. syscall_arg_t arg2 = regs.ecx;
  811. syscall_arg_t arg3 = regs.ebx;
  812. #else
  813. syscall_arg_t syscall_index = regs.rax;
  814. syscall_arg_t arg1 = regs.rdx;
  815. syscall_arg_t arg2 = regs.rcx;
  816. syscall_arg_t arg3 = regs.rbx;
  817. #endif
  818. if (ptrace(PT_SYSCALL, g_pid, 0, 0) == -1) {
  819. perror("syscall");
  820. return 1;
  821. }
  822. if (waitpid(g_pid, &status, WSTOPPED | WEXITED) != g_pid || !WIFSTOPPED(status)) {
  823. perror("wait_pid");
  824. return 1;
  825. }
  826. if (ptrace(PT_GETREGS, g_pid, &regs, 0) == -1) {
  827. perror("getregs");
  828. return 1;
  829. }
  830. #if ARCH(I386)
  831. u32 res = regs.eax;
  832. #else
  833. u64 res = regs.rax;
  834. #endif
  835. auto syscall_function = (Syscall::Function)syscall_index;
  836. auto syscall_name = to_string(syscall_function);
  837. if (exclude_syscalls.contains(syscall_name))
  838. continue;
  839. if (!include_syscalls.is_empty() && !include_syscalls.contains(syscall_name))
  840. continue;
  841. FormattedSyscallBuilder builder(syscall_name);
  842. format_syscall(builder, syscall_function, arg1, arg2, arg3, res);
  843. if (!trace_file->write(builder.string_view())) {
  844. warnln("write: {}", trace_file->error_string());
  845. return 1;
  846. }
  847. }
  848. }