strace.cpp 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914
  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. 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. format_builder.put_literal(" | ");
  265. 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. 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. format_builder.put_literal(BitflagDerivative::default_);
  278. else
  279. format_builder.put_literal("0");
  280. }
  281. }
  282. };
  283. }
  284. struct PointerArgument {
  285. const void* value;
  286. };
  287. namespace AK {
  288. template<>
  289. struct Formatter<PointerArgument> : StandardFormatter {
  290. Formatter() = default;
  291. explicit Formatter(StandardFormatter formatter)
  292. : StandardFormatter(formatter)
  293. {
  294. }
  295. void format(FormatBuilder& format_builder, PointerArgument const& value)
  296. {
  297. auto& builder = format_builder.builder();
  298. if (value.value == nullptr)
  299. builder.append("null");
  300. else
  301. builder.appendff("{}", value.value);
  302. }
  303. };
  304. }
  305. class FormattedSyscallBuilder {
  306. public:
  307. FormattedSyscallBuilder(StringView syscall_name)
  308. {
  309. m_builder.append(syscall_name);
  310. m_builder.append('(');
  311. }
  312. template<typename T>
  313. void add_argument(CheckedFormatString<T> format, T&& arg)
  314. {
  315. add_argument_separator();
  316. m_builder.appendff(format.view(), forward<T>(arg));
  317. }
  318. template<typename T>
  319. void add_argument(T&& arg)
  320. {
  321. add_argument("{}", forward<T>(arg));
  322. }
  323. void add_string_argument(Syscall::StringArgument const& string_argument)
  324. {
  325. if (string_argument.characters == nullptr)
  326. add_argument("null");
  327. else {
  328. auto string = copy_from_process(string_argument.characters, string_argument.length);
  329. add_argument("\"{}\"", StringView(string.data(), string.size()));
  330. }
  331. }
  332. template<typename... Ts>
  333. void add_arguments(Ts&&... args)
  334. {
  335. (add_argument(forward<Ts>(args)), ...);
  336. }
  337. template<typename T>
  338. void format_result_no_error(T res)
  339. {
  340. m_builder.appendff(") = {}\n", res);
  341. }
  342. void format_result(Integral auto res)
  343. {
  344. m_builder.append(") = ");
  345. if (res < 0)
  346. m_builder.appendff("{} {}", res, errno_name(-(int)res));
  347. else
  348. m_builder.appendff("{}", res);
  349. m_builder.append('\n');
  350. }
  351. void format_result(void* res)
  352. {
  353. m_builder.appendff(") = {}\n", res);
  354. }
  355. void format_result()
  356. {
  357. m_builder.append(")\n");
  358. }
  359. StringView string_view()
  360. {
  361. return m_builder.string_view();
  362. }
  363. private:
  364. void add_argument_separator()
  365. {
  366. if (!m_first_arg) {
  367. m_builder.append(", ");
  368. }
  369. m_first_arg = false;
  370. }
  371. StringBuilder m_builder;
  372. bool m_first_arg { true };
  373. };
  374. static void format_getrandom(FormattedSyscallBuilder& builder, void* buffer, size_t size, unsigned flags)
  375. {
  376. builder.add_arguments(buffer, size, flags);
  377. }
  378. static void format_realpath(FormattedSyscallBuilder& builder, Syscall::SC_realpath_params* params_p)
  379. {
  380. auto params = copy_from_process(params_p);
  381. builder.add_string_argument(params.path);
  382. if (params.buffer.size == 0)
  383. builder.add_argument("null");
  384. else {
  385. auto buffer = copy_from_process(params.buffer.data, params.buffer.size);
  386. builder.add_argument("\"{}\"", StringView { (const char*)buffer.data() });
  387. }
  388. }
  389. static void format_exit(FormattedSyscallBuilder& builder, int status)
  390. {
  391. builder.add_argument(status);
  392. }
  393. struct OpenOptions : BitflagBase {
  394. static constexpr auto options = {
  395. BITFLAG(O_RDWR), BITFLAG(O_RDONLY), BITFLAG(O_WRONLY),
  396. BITFLAG(O_EXEC), BITFLAG(O_CREAT), BITFLAG(O_EXCL), BITFLAG(O_NOCTTY),
  397. BITFLAG(O_TRUNC), BITFLAG(O_APPEND), BITFLAG(O_NONBLOCK), BITFLAG(O_DIRECTORY),
  398. BITFLAG(O_NOFOLLOW), BITFLAG(O_CLOEXEC), BITFLAG(O_DIRECT)
  399. };
  400. };
  401. static void format_open(FormattedSyscallBuilder& builder, Syscall::SC_open_params* params_p)
  402. {
  403. auto params = copy_from_process(params_p);
  404. if (params.dirfd == AT_FDCWD)
  405. builder.add_argument("AT_FDCWD");
  406. else
  407. builder.add_argument(params.dirfd);
  408. builder.add_string_argument(params.path);
  409. builder.add_argument(OpenOptions { params.options });
  410. if (params.options & O_CREAT)
  411. builder.add_argument("{:04o}", params.mode);
  412. }
  413. static void format_ioctl(FormattedSyscallBuilder& builder, int fd, unsigned request, void* arg)
  414. {
  415. builder.add_arguments(fd, ioctl_request_name(request));
  416. if (request == FIONBIO) {
  417. auto value = copy_from_process(reinterpret_cast<int*>(arg));
  418. builder.add_argument(value);
  419. } else
  420. builder.add_argument(PointerArgument { arg });
  421. }
  422. namespace AK {
  423. template<>
  424. struct Formatter<struct timespec> : StandardFormatter {
  425. void format(FormatBuilder& format_builder, struct timespec value)
  426. {
  427. auto& builder = format_builder.builder();
  428. builder.appendff("{{tv_sec={}, tv_nsec={}}}", value.tv_sec, value.tv_nsec);
  429. }
  430. };
  431. template<>
  432. struct Formatter<struct timeval> : StandardFormatter {
  433. void format(FormatBuilder& format_builder, struct timeval value)
  434. {
  435. auto& builder = format_builder.builder();
  436. builder.appendff("{{tv_sec={}, tv_usec={}}}", value.tv_sec, value.tv_usec);
  437. }
  438. };
  439. template<>
  440. struct Formatter<struct stat> : StandardFormatter {
  441. void format(FormatBuilder& format_builder, struct stat value)
  442. {
  443. auto& builder = format_builder.builder();
  444. builder.appendff(
  445. "{{st_dev={}, st_ino={}, st_mode={}, st_nlink={}, st_uid={}, st_gid={}, st_rdev={}, "
  446. "st_size={}, st_blksize={}, st_blocks={}, st_atim={}, st_mtim={}, st_ctim={}}}",
  447. value.st_dev, value.st_ino, value.st_mode, value.st_nlink, value.st_uid, value.st_gid, value.st_rdev,
  448. value.st_size, value.st_blksize, value.st_blocks, value.st_atim, value.st_mtim, value.st_ctim);
  449. }
  450. };
  451. }
  452. static void format_fstat(FormattedSyscallBuilder& builder, int fd, struct stat* buf_p)
  453. {
  454. auto buf = copy_from_process(buf_p);
  455. builder.add_arguments(fd, buf);
  456. }
  457. static void format_stat(FormattedSyscallBuilder& builder, Syscall::SC_stat_params* params_p)
  458. {
  459. auto params = copy_from_process(params_p);
  460. if (params.dirfd == AT_FDCWD)
  461. builder.add_argument("AT_FDCWD");
  462. else
  463. builder.add_argument(params.dirfd);
  464. builder.add_string_argument(params.path);
  465. builder.add_arguments(copy_from_process(params.statbuf), params.follow_symlinks);
  466. }
  467. static void format_lseek(FormattedSyscallBuilder& builder, int fd, off_t offset, int whence)
  468. {
  469. builder.add_arguments(fd, offset, whence_name(whence));
  470. }
  471. static void format_read(FormattedSyscallBuilder& builder, int fd, void* buf, size_t nbyte)
  472. {
  473. builder.add_arguments(fd, buf, nbyte);
  474. }
  475. static void format_write(FormattedSyscallBuilder& builder, int fd, void* buf, size_t nbyte)
  476. {
  477. builder.add_arguments(fd, buf, nbyte);
  478. }
  479. static void format_close(FormattedSyscallBuilder& builder, int fd)
  480. {
  481. builder.add_arguments(fd);
  482. }
  483. static void format_select(FormattedSyscallBuilder& builder, Syscall::SC_select_params* params_p)
  484. {
  485. // TODO: format fds and sigmask properly
  486. auto params = copy_from_process(params_p);
  487. builder.add_arguments(
  488. params.nfds,
  489. PointerArgument { params.readfds },
  490. PointerArgument { params.writefds },
  491. PointerArgument { params.exceptfds },
  492. copy_from_process(params.timeout),
  493. PointerArgument { params.sigmask });
  494. }
  495. namespace AK {
  496. template<>
  497. struct Formatter<struct sockaddr> : StandardFormatter {
  498. void format(FormatBuilder& format_builder, struct sockaddr address)
  499. {
  500. auto& builder = format_builder.builder();
  501. builder.append("{sa_family=");
  502. builder.append(domain_name(address.sa_family));
  503. if (address.sa_family == AF_INET) {
  504. auto* address_in = (const struct sockaddr_in*)&address;
  505. builder.appendff(
  506. ", sin_port={}, sin_addr={}",
  507. address_in->sin_port,
  508. IPv4Address(address_in->sin_addr.s_addr).to_string());
  509. } else if (address.sa_family == AF_UNIX) {
  510. auto* address_un = (const struct sockaddr_un*)&address;
  511. builder.appendff(
  512. ", sun_path={}",
  513. address_un->sun_path);
  514. }
  515. builder.append('}');
  516. }
  517. };
  518. }
  519. static void format_socket(FormattedSyscallBuilder& builder, int domain, int type, int protocol)
  520. {
  521. // TODO: show additional options in type
  522. builder.add_arguments(domain_name(domain), socket_type_name(type & SOCK_TYPE_MASK), protocol_name(protocol));
  523. }
  524. static void format_connect(FormattedSyscallBuilder& builder, int socket, const struct sockaddr* address_p, socklen_t address_len)
  525. {
  526. builder.add_arguments(socket, copy_from_process(address_p), address_len);
  527. }
  528. struct MsgOptions : BitflagBase {
  529. static constexpr auto options = {
  530. BITFLAG(MSG_TRUNC), BITFLAG(MSG_CTRUNC), BITFLAG(MSG_PEEK),
  531. BITFLAG(MSG_OOB), BITFLAG(MSG_DONTWAIT)
  532. // TODO: add MSG_WAITALL once its definition is added
  533. };
  534. };
  535. static void format_recvmsg(FormattedSyscallBuilder& builder, int socket, struct msghdr* message, int flags)
  536. {
  537. // TODO: format message
  538. builder.add_arguments(socket, message, MsgOptions { flags });
  539. }
  540. struct MmapFlags : BitflagBase {
  541. static constexpr auto options = {
  542. BITFLAG(MAP_SHARED), BITFLAG(MAP_PRIVATE), BITFLAG(MAP_FIXED), BITFLAG(MAP_ANONYMOUS),
  543. BITFLAG(MAP_RANDOMIZED), BITFLAG(MAP_STACK), BITFLAG(MAP_NORESERVE), BITFLAG(MAP_PURGEABLE)
  544. };
  545. static constexpr StringView default_ = "MAP_FILE";
  546. };
  547. struct MemoryProtectionFlags : BitflagBase {
  548. static constexpr auto options = {
  549. BITFLAG(PROT_READ), BITFLAG(PROT_WRITE), BITFLAG(PROT_EXEC)
  550. };
  551. static constexpr StringView default_ = "PROT_NONE";
  552. };
  553. static void format_mmap(FormattedSyscallBuilder& builder, Syscall::SC_mmap_params* params_p)
  554. {
  555. auto params = copy_from_process(params_p);
  556. builder.add_arguments(params.addr, params.size, MemoryProtectionFlags { params.prot }, MmapFlags { params.flags }, params.fd, params.offset, params.alignment);
  557. builder.add_string_argument(params.name);
  558. }
  559. static void format_munmap(FormattedSyscallBuilder& builder, void* addr, size_t size)
  560. {
  561. builder.add_arguments(addr, size);
  562. }
  563. static void format_mprotect(FormattedSyscallBuilder& builder, void* addr, size_t size, int prot)
  564. {
  565. builder.add_arguments(addr, size, MemoryProtectionFlags { prot });
  566. }
  567. static void format_set_mmap_name(FormattedSyscallBuilder& builder, Syscall::SC_set_mmap_name_params* params_p)
  568. {
  569. auto params = copy_from_process(params_p);
  570. builder.add_arguments(params.addr, params.size);
  571. builder.add_string_argument(params.name);
  572. }
  573. static void format_clock_gettime(FormattedSyscallBuilder& builder, clockid_t clockid, struct timespec* time)
  574. {
  575. builder.add_arguments(clockid_name(clockid), copy_from_process(time));
  576. }
  577. 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)
  578. {
  579. enum ResultType {
  580. Int,
  581. Ssize,
  582. VoidP,
  583. Void
  584. };
  585. ResultType result_type { Int };
  586. switch (syscall_function) {
  587. case SC_getrandom:
  588. format_getrandom(builder, (void*)arg1, (size_t)arg2, (unsigned)arg3);
  589. break;
  590. case SC_realpath:
  591. format_realpath(builder, (Syscall::SC_realpath_params*)arg1);
  592. break;
  593. case SC_exit:
  594. format_exit(builder, (int)arg1);
  595. result_type = Void;
  596. break;
  597. case SC_open:
  598. format_open(builder, (Syscall::SC_open_params*)arg1);
  599. break;
  600. case SC_ioctl:
  601. format_ioctl(builder, (int)arg1, (unsigned)arg2, (void*)arg3);
  602. break;
  603. case SC_fstat:
  604. format_fstat(builder, (int)arg1, (struct stat*)arg2);
  605. result_type = Ssize;
  606. break;
  607. case SC_stat:
  608. format_stat(builder, (Syscall::SC_stat_params*)arg1);
  609. break;
  610. case SC_lseek:
  611. format_lseek(builder, (int)arg1, (off_t)arg2, (int)arg3);
  612. break;
  613. case SC_read:
  614. format_read(builder, (int)arg1, (void*)arg2, (size_t)arg3);
  615. result_type = Ssize;
  616. break;
  617. case SC_write:
  618. format_write(builder, (int)arg1, (void*)arg2, (size_t)arg3);
  619. result_type = Ssize;
  620. break;
  621. case SC_close:
  622. format_close(builder, (int)arg1);
  623. break;
  624. case SC_select:
  625. format_select(builder, (Syscall::SC_select_params*)arg1);
  626. break;
  627. case SC_socket:
  628. format_socket(builder, (int)arg1, (int)arg2, (int)arg3);
  629. break;
  630. case SC_recvmsg:
  631. format_recvmsg(builder, (int)arg1, (struct msghdr*)arg2, (int)arg3);
  632. result_type = Ssize;
  633. break;
  634. case SC_connect:
  635. format_connect(builder, (int)arg1, (const struct sockaddr*)arg2, (socklen_t)arg3);
  636. break;
  637. case SC_mmap:
  638. format_mmap(builder, (Syscall::SC_mmap_params*)arg1);
  639. result_type = VoidP;
  640. break;
  641. case SC_munmap:
  642. format_munmap(builder, (void*)arg1, (size_t)arg2);
  643. break;
  644. case SC_mprotect:
  645. format_mprotect(builder, (void*)arg1, (size_t)arg2, (int)arg3);
  646. break;
  647. case SC_set_mmap_name:
  648. format_set_mmap_name(builder, (Syscall::SC_set_mmap_name_params*)arg1);
  649. break;
  650. case SC_clock_gettime:
  651. format_clock_gettime(builder, (clockid_t)arg1, (struct timespec*)arg2);
  652. break;
  653. case SC_getuid:
  654. case SC_geteuid:
  655. case SC_getgid:
  656. case SC_getegid:
  657. case SC_getpid:
  658. case SC_getppid:
  659. break;
  660. default:
  661. builder.add_arguments((void*)arg1, (void*)arg2, (void*)arg3);
  662. result_type = VoidP;
  663. }
  664. switch (result_type) {
  665. case Int:
  666. builder.format_result((int)res);
  667. break;
  668. case Ssize:
  669. builder.format_result((ssize_t)res);
  670. break;
  671. case VoidP:
  672. builder.format_result((void*)res);
  673. break;
  674. case Void:
  675. builder.format_result();
  676. break;
  677. }
  678. }
  679. int main(int argc, char** argv)
  680. {
  681. if (pledge("stdio wpath cpath proc exec ptrace sigaction", nullptr) < 0) {
  682. perror("pledge");
  683. return 1;
  684. }
  685. Vector<const char*> child_argv;
  686. const char* output_filename = nullptr;
  687. const char* exclude_syscalls_option = nullptr;
  688. const char* include_syscalls_option = nullptr;
  689. HashTable<StringView> exclude_syscalls;
  690. HashTable<StringView> include_syscalls;
  691. auto trace_file = Core::File::standard_error();
  692. Core::ArgsParser parser;
  693. parser.set_stop_on_first_non_option(true);
  694. parser.set_general_help(
  695. "Trace all syscalls and their result.");
  696. parser.add_option(g_pid, "Trace the given PID", "pid", 'p', "pid");
  697. parser.add_option(output_filename, "Filename to write output to", "output", 'o', "output");
  698. parser.add_option(exclude_syscalls_option, "Comma-delimited syscalls to exclude", "exclude", 'e', "exclude");
  699. parser.add_option(include_syscalls_option, "Comma-delimited syscalls to include", "include", 'i', "include");
  700. parser.add_positional_argument(child_argv, "Arguments to exec", "argument", Core::ArgsParser::Required::No);
  701. parser.parse(argc, argv);
  702. if (output_filename != nullptr) {
  703. auto open_result = Core::File::open(output_filename, Core::OpenMode::WriteOnly);
  704. if (open_result.is_error()) {
  705. outln(stderr, "Failed to open output file: {}", open_result.error());
  706. return 1;
  707. }
  708. trace_file = open_result.value();
  709. }
  710. auto parse_syscalls = [](const char* option, auto& hash_table) {
  711. if (option != nullptr) {
  712. for (auto syscall : StringView(option).split_view(','))
  713. hash_table.set(syscall);
  714. }
  715. };
  716. parse_syscalls(exclude_syscalls_option, exclude_syscalls);
  717. parse_syscalls(include_syscalls_option, include_syscalls);
  718. if (pledge("stdio proc exec ptrace sigaction", nullptr) < 0) {
  719. perror("pledge");
  720. return 1;
  721. }
  722. int status;
  723. if (g_pid == -1) {
  724. if (child_argv.is_empty()) {
  725. warnln("strace: Expected either a pid or some arguments");
  726. return 1;
  727. }
  728. child_argv.append(nullptr);
  729. int pid = fork();
  730. if (pid < 0) {
  731. perror("fork");
  732. return 1;
  733. }
  734. if (!pid) {
  735. if (ptrace(PT_TRACE_ME, 0, 0, 0) == -1) {
  736. perror("traceme");
  737. return 1;
  738. }
  739. int rc = execvp(child_argv.first(), const_cast<char**>(child_argv.data()));
  740. if (rc < 0) {
  741. perror("execvp");
  742. exit(1);
  743. }
  744. VERIFY_NOT_REACHED();
  745. }
  746. g_pid = pid;
  747. if (waitpid(pid, &status, WSTOPPED | WEXITED) != pid || !WIFSTOPPED(status)) {
  748. perror("waitpid");
  749. return 1;
  750. }
  751. }
  752. struct sigaction sa;
  753. memset(&sa, 0, sizeof(struct sigaction));
  754. sa.sa_handler = handle_sigint;
  755. sigaction(SIGINT, &sa, nullptr);
  756. if (ptrace(PT_ATTACH, g_pid, 0, 0) == -1) {
  757. perror("attach");
  758. return 1;
  759. }
  760. if (waitpid(g_pid, &status, WSTOPPED | WEXITED) != g_pid || !WIFSTOPPED(status)) {
  761. perror("waitpid");
  762. return 1;
  763. }
  764. for (;;) {
  765. if (ptrace(PT_SYSCALL, g_pid, 0, 0) == -1) {
  766. perror("syscall");
  767. return 1;
  768. }
  769. if (waitpid(g_pid, &status, WSTOPPED | WEXITED) != g_pid || !WIFSTOPPED(status)) {
  770. perror("wait_pid");
  771. return 1;
  772. }
  773. PtraceRegisters regs = {};
  774. if (ptrace(PT_GETREGS, g_pid, &regs, 0) == -1) {
  775. perror("getregs");
  776. return 1;
  777. }
  778. #if ARCH(I386)
  779. syscall_arg_t syscall_index = regs.eax;
  780. syscall_arg_t arg1 = regs.edx;
  781. syscall_arg_t arg2 = regs.ecx;
  782. syscall_arg_t arg3 = regs.ebx;
  783. #else
  784. syscall_arg_t syscall_index = regs.rax;
  785. syscall_arg_t arg1 = regs.rdx;
  786. syscall_arg_t arg2 = regs.rcx;
  787. syscall_arg_t arg3 = regs.rbx;
  788. #endif
  789. if (ptrace(PT_SYSCALL, g_pid, 0, 0) == -1) {
  790. perror("syscall");
  791. return 1;
  792. }
  793. if (waitpid(g_pid, &status, WSTOPPED | WEXITED) != g_pid || !WIFSTOPPED(status)) {
  794. perror("wait_pid");
  795. return 1;
  796. }
  797. if (ptrace(PT_GETREGS, g_pid, &regs, 0) == -1) {
  798. perror("getregs");
  799. return 1;
  800. }
  801. #if ARCH(I386)
  802. u32 res = regs.eax;
  803. #else
  804. u64 res = regs.rax;
  805. #endif
  806. auto syscall_function = (Syscall::Function)syscall_index;
  807. auto syscall_name = to_string(syscall_function);
  808. if (exclude_syscalls.contains(syscall_name))
  809. continue;
  810. if (!include_syscalls.is_empty() && !include_syscalls.contains(syscall_name))
  811. continue;
  812. FormattedSyscallBuilder builder(syscall_name);
  813. format_syscall(builder, syscall_function, arg1, arg2, arg3, res);
  814. if (!trace_file->write(builder.string_view())) {
  815. warnln("write: {}", trace_file->error_string());
  816. return 1;
  817. }
  818. }
  819. }