rust-kernel
Rustbelt: a hobby x86_64 kernel written in Rust
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 | //! System calls via the `syscall` instruction.
//!
//! ABI (like Linux x86_64): number in rax, arguments in rdi, rsi, rdx, r10,
//! r8, r9; result in rax; negative results are `-errno`. The `syscall`
//! instruction itself clobbers rcx (return address) and r11 (saved
//! RFLAGS); every other register is preserved for the caller.
//!
//! Numbers are Linux's where Linux has the same call, so `strace` output and
//! man pages mostly apply. The process calls added in stage 14 (fork,
//! execve, wait4, mmap, signals, dup, pipe2, fcntl, process groups) follow
//! Linux exactly -- C strings, structs, flags -- so a C library can use
//! them as they are, and so do stage 15's (poll/epoll, futex, threads,
//! ttys, nanosleep, readv/writev...). Since stage 15.1 the file calls do
//! too: paths are NUL-terminated C strings (at most PATH_MAX = 4096 bytes
//! with the NUL; a bad pointer is EFAULT, never a crash), stat fills
//! Linux's 144-byte `struct stat`, and the `*at()` versions take a
//! directory fd or AT_FDCWD (-100). Relative paths start at the cwd.
//! `mode` arguments are stored where the filesystem can (stage 16: ramfs,
//! ext2) but never checked -- everyone is root -- and uid/gid are always 0. Every blocking call honours O_NONBLOCK (-> EAGAIN).
//!
//! | nr | name | arguments | note |
//! |-----|-------------|-------------------------------------|------|
//! | 0 | read | fd, buf, len | blocks: tty until a line (canonical) or a byte (raw), pipe until data/EOF |
//! | 1 | write | fd, buf, len | to a pipe without readers: EPIPE + SIGPIPE; a full pipe blocks |
//! | 2 | open | path, flags, mode | = openat(AT_FDCWD, ...). O_RDONLY/WRONLY/RDWR 0/1/2, O_CREAT 0o100, O_EXCL 0o200, O_NOCTTY 0o400, O_TRUNC 0o1000, O_APPEND, O_NONBLOCK 0o4000, O_DIRECTORY 0o200000, O_NOFOLLOW 0o400000, O_CLOEXEC 0o2000000 |
//! | 3 | close | fd | |
//! | 4 | stat | path, *stat | Linux `struct stat`; follows symlinks. st_ino is a hash of the path |
//! | 5 | fstat | fd, *stat | |
//! | 6 | lstat | path, *stat | doesn't follow a final symlink |
//! | 7 | poll | *pollfd, n, timeout_ms | -1 = forever; pipes, sockets, ttys, files, epoll fds |
//! | 8 | lseek | fd, offset, whence | SEEK_SET/CUR/END = 0/1/2 |
//! | 9 | mmap | addr, len, prot, flags, fd, offset | MAP_PRIVATE/SHARED, MAP_ANONYMOUS, MAP_FIXED; files: private only |
//! | 10 | mprotect | addr, len, prot | PROT_READ 1, PROT_WRITE 2, PROT_EXEC 4 |
//! | 11 | munmap | addr, len | |
//! | 12 | brk | addr | returns the (new) end of the heap; brk(0) = current |
//! | 13 | rt_sigaction | sig, *new, *old, 8 | kernel `struct sigaction`; handlers need SA_RESTORER |
//! | 14 | rt_sigprocmask | how, *set, *old, 8 | SIG_BLOCK 0 / SIG_UNBLOCK 1 / SIG_SETMASK 2 |
//! | 15 | rt_sigreturn | | only from a signal handler's restorer |
//! | 16 | ioctl | fd, request, arg | any fd: FIONBIO; ttys: TCGETS/TCSETS(W/F), TIOCGPGRP/SPGRP, TIOCSCTTY, TIOCNOTTY, TIOCGWINSZ/SWINSZ, TIOCGPTN, TIOCSPTLCK, TTY_SET_RAW 1 (ours); /dev/fb0: FB_* (below) |
//! | 17 | pread64 | fd, buf, len, offset | regular files; leaves the file position alone |
//! | 18 | pwrite64 | fd, buf, len, offset | |
//! | 19 | readv | fd, *iovec, n | `struct iovec {base, len}`, up to 1024 |
//! | 20 | writev | fd, *iovec, n | |
//! | 21 | access | path, mode | = faccessat(AT_FDCWD, ...): 0 if it exists (we have no permissions) |
//! | 22 | pipe | *[u32; 2] | [read end, write end] |
//! | 23 | select | n, *rd, *wr, *ex, *timeval | fd bitmaps (n <= 1024) |
//! | 24 | sched_yield | | |
//! | 28 | madvise | addr, len, advice | hints accepted; MADV_DONTNEED 4 / MADV_FREE 8 drop private pages (they read back as zeros) |
//! | 32 | dup | fd | lowest free fd |
//! | 33 | dup2 | old, new | closes `new` first if open |
//! | 34 | pause | | sleeps until a signal; returns EINTR |
//! | 35 | nanosleep | *timespec, *remaining | EINTR on a signal (remaining time written back) |
//! | 39 | getpid | | |
//! | 41 | socket | domain, type, protocol | AF_INET (2), stage 18: AF_UNIX (1) STREAM/DGRAM/SEQPACKET (src/net/unix.rs); type may add SOCK_NONBLOCK/SOCK_CLOEXEC; SOCK_STREAM (1) = TCP, SOCK_DGRAM (2) = UDP, SOCK_DGRAM + IPPROTO_ICMP (1) = ping socket |
//! | 42 | connect | fd, *sockaddr_in, len | TCP: handshake, blocks (10 s timeout; nonblocking: EINPROGRESS); UDP/ICMP: set default destination. 127.x = loopback |
//! | 43 | accept | fd, *sockaddr_in or 0, *u32 len or 0 | blocks for a connection (SO_RCVTIMEO applies); returns the new fd. Like Linux, *len is read and updated |
//! | 44 | sendto | fd, buf, len, flags, *sockaddr_in or 0, addrlen | INET: flags and addrlen are ignored (a sockaddr_in is always 16 bytes), so MSG_NOSIGNAL is too; AF_UNIX (stage 18) honors them |
//! | 45 | recvfrom | fd, buf, len, flags, *sockaddr_in or 0, *addrlen | blocks (SO_RCVTIMEO -> EAGAIN); 0 = TCP peer closed. The address is cut to *addrlen |
//! | 46 | sendmsg | fd, *msghdr, flags | stage 18: iovecs + name; AF_UNIX: SCM_RIGHTS (<= 253 fds), SCM_CREDENTIALS, MSG_NOSIGNAL/DONTWAIT |
//! | 47 | recvmsg | fd, *msghdr, flags | stage 18: AF_UNIX control data (MSG_CTRUNC, MSG_CMSG_CLOEXEC), MSG_PEEK/WAITALL/TRUNC/DONTWAIT |
//! | 49 | bind | fd, *sockaddr_in, len | sets the local port (address ignored: we have one); AF_UNIX: a socket file, an abstract name, or autobind |
//! | 50 | listen | fd, backlog | TCP; backlog 1..4 |
//! | 54 | setsockopt | fd, level, name, *value, len | stage 17 (src/syscall_ext.rs): SO_RCVTIMEO is real; SO_REUSEADDR & co. stored; others ENOPROTOOPT |
//! | 56 | clone | flags, stack, *ptid, *ctid, tls | fork-like (SIGCHLD [+ CLONE_VFORK]) or a thread: CLONE_VM|FS|FILES|SIGHAND|THREAD|SYSVSEM [+ SETTLS, PARENT_SETTID, CHILD_CLEARTID] |
//! | 57 | fork | | copy-on-write; parent gets the pid, child 0 |
//! | 58 | vfork | | fork + the parent waits until the child execs or exits |
//! | 59 | execve | path, argv, envp (C strings) | Linux's stack layout: argc, argv, envp, auxv |
//! | 60 | exit | code | ends this *thread* only (exit_group ends the process) |
//! | 61 | wait4 | pid, *status, options, *rusage | WNOHANG 1, WUNTRACED 2, WCONTINUED 8; *rusage (if not 0) is zero-filled: we don't count usage |
//! | 62 | kill | pid, sig | pid 0 = my group, -1 = all, < -1 = group -pid |
//! | 63 | uname | *utsname | Linux's `struct utsname` (6 x 65-byte strings) |
//! | 72 | fcntl | fd, cmd, arg | F_DUPFD 0, F_GETFD 1, F_SETFD 2, F_GETFL 3 (access mode, O_APPEND, O_NONBLOCK), F_SETFL 4 (O_NONBLOCK, O_APPEND), F_GETLK 5 / F_SETLK 6 / F_SETLKW 7 (record locks, fs/lock.rs), F_DUPFD_CLOEXEC 1030 |
//! | 74 | fsync | fd | fdatasync 75 too: writes already went to the disk, so just checks the fd |
//! | 76 | truncate | path, len | cut or zero-extend a file; ftruncate 77 = the same on an fd open for writing |
//! | 79 | getcwd | buf, len | like Linux: writes a NUL, returns the length including it |
//! | 80 | chdir | path | |
//! | 81 | fchdir | fd | a directory opened with open() |
//! | 82 | rename | old, new | = renameat(AT_FDCWD, old, AT_FDCWD, new); see `fs::rename` for the limits |
//! | 83 | mkdir | path, mode | = mkdirat(AT_FDCWD, ...) |
//! | 84 | rmdir | path | only empty directories |
//! | 87 | unlink | path | files and symlinks (not what a symlink points to) |
//! | 89 | readlink | path, buf, len | a symlink's target; returns its length (cut to `len`, no NUL); /proc/self/exe = my program |
//! | 90 | chmod | path, mode | ramfs and ext2 keep it; FAT: EPERM; btrfs: EROFS. fchmod 91 = on an fd |
//! | 95 | umask | mask | returns the old one; open(O_CREAT)/mkdir take these bits away from `mode` |
//! | 97 | getrlimit | resource, *rlimit | {soft, hard}; setrlimit 160 too. RLIMIT_NOFILE is enforced (<= 64) |
//! | 102 | getuid | | stage 17 (src/syscall_ext.rs): real per-process ids, root (0) by default |
//! | 109 | setpgid | pid, pgid | 0 = myself / a new group |
//! | 110 | getppid | | 0 if started by the kernel or orphaned |
//! | 111 | getpgrp | | |
//! | 112 | setsid | | new session + group, no controlling tty |
//! | 121 | getpgid | pid | |
//! | 124 | getsid | pid | |
//! | 127 | rt_sigpending | *set, 8 | blocked signals that are waiting |
//! | 128 | rt_sigtimedwait | *set, *siginfo, *timespec, 8 | take a signal without a handler; EAGAIN on timeout |
//! | 129 | rt_sigqueueinfo | tgid, sig, *siginfo | sigqueue(); real-time signals (32..64) queue up. rt_tgsigqueueinfo 297: to one thread |
//! | 130 | rt_sigsuspend | *mask, 8 | sleep with `mask` until a handler ran; EINTR |
//! | 131 | sigaltstack | *new, *old | `stack_t` {sp, flags, size}; SS_DISABLE 2, SS_AUTODISARM; SA_ONSTACK handlers run there |
//! | 157 | prctl | option, ... | PR_SET/GET_NAME 15/16, PDEATHSIG 1/2, DUMPABLE 3/4, NO_NEW_PRIVS 38/39; others EINVAL |
//! | 158 | arch_prctl | code, addr | ARCH_SET_FS 0x1002 / ARCH_GET_FS 0x1003: the TLS pointer |
//! | 186 | gettid | | thread id (= pid for the first thread) |
//! | 200 | tkill | tid, sig | |
//! | 202 | futex | *u32, op, val, *timespec, *u32, val3 | FUTEX_WAIT 0, WAKE 1, WAIT_BITSET 9, WAKE_BITSET 10 (+ PRIVATE 128) |
//! | 204 | sched_getaffinity | tid, len, *mask | every online CPU; returns 8 (bytes written). sched_setaffinity 203: accepted, not enforced |
//! | 213 | epoll_create | size | = epoll_create1(0) |
//! | 217 | getdents64 | fd, buf, len | Linux `struct linux_dirent64` records |
//! | 218 | set_tid_address | *u32 | cleared + futex-woken when this thread exits; returns the tid |
//! | 228 | clock_gettime | clock, *timespec | REALTIME 0 (CMOS clock at boot + uptime), MONOTONIC 1 (since boot); stage 17: CPU time 2/3 |
//! | 230 | clock_nanosleep | clock, flags, *timespec, *remaining | REALTIME, MONOTONIC or BOOTTIME 7; TIMER_ABSTIME 1 = sleep until that time |
//! | 231 | exit_group | code | ends every thread of the process |
//! | 232 | epoll_wait | epfd, *epoll_event, max, timeout_ms | level-triggered; EPOLLONESHOT supported |
//! | 233 | epoll_ctl | epfd, op, fd, *epoll_event | ADD 1, DEL 2, MOD 3 |
//! | 234 | tgkill | tgid, tid, sig | a signal for one thread |
//! | 257 | openat | dirfd, path, flags, mode | O_NOFOLLOW on a symlink: ELOOP; O_EXCL: EEXIST; O_DIRECTORY on a file: ENOTDIR; a directory for writing: EISDIR |
//! | 258 | mkdirat | dirfd, path, mode | |
//! | 262 | newfstatat | dirfd, path, *stat, flags | AT_SYMLINK_NOFOLLOW 0x100, AT_EMPTY_PATH 0x1000 (= fstat(dirfd)) |
//! | 263 | unlinkat | dirfd, path, flags | AT_REMOVEDIR 0x200 = rmdir |
//! | 264 | renameat | olddirfd, old, newdirfd, new | renameat2 316 too: flags 0 or RENAME_NOREPLACE (else EINVAL) |
//! | 267 | readlinkat | dirfd, path, buf, len | |
//! | 268 | fchmodat | dirfd, path, mode | fchmodat2 452: + flags (AT_SYMLINK_NOFOLLOW on a symlink: EOPNOTSUPP) |
//! | 269 | faccessat | dirfd, path, mode | faccessat2 439 too (its flags are ignored) |
//! | 273 | set_robust_list | *head, 24 | robust mutexes: marked FUTEX_OWNER_DIED when the thread dies. get_robust_list 274 |
//! | 270 | pselect6 | n, *rd, *wr, *ex, *timespec, *{*mask, 8} | |
//! | 271 | ppoll | *pollfd, n, *timespec, *mask, 8 | sets the mask while waiting |
//! | 280 | utimensat | dirfd, path or 0, *[timespec; 2], flags | UTIME_NOW / UTIME_OMIT; FAT ignores times; btrfs: EROFS |
//! | 281 | epoll_pwait | epfd, *events, max, timeout, *mask, 8 | |
//! | 288 | accept4 | fd, *addr, *len, flags | flags: SOCK_NONBLOCK, SOCK_CLOEXEC |
//! | 291 | epoll_create1 | flags | EPOLL_CLOEXEC |
//! | 292 | dup3 | old, new, flags | flags: O_CLOEXEC |
//! | 293 | pipe2 | *[u32; 2], flags | flags: O_CLOEXEC |
//! | 302 | prlimit64 | pid, resource, *new, *old | get and/or set another process's limits (0 = me) |
//! | 318 | getrandom | buf, len, flags | random bytes (virtio-rng); up to 64 KiB per call; flags ignored |
//! | 500 | spawn | path, argv, argv_len, *SpawnOptions | ours: new process running a program (fork+exec in one step, like posix_spawn) |
//! | 501 | mounts | buf, len | ours: "path fstype\n" per mount (Linux: read /proc/mounts) |
//! | 502 | rb_sysinfo | *SysInfo | ours: CPUs, threads, memory, per-CPU busy time (Linux: /proc/stat etc.) |
//! | 503 | resolve | name, name_len, *[[u8; 4]], max | ours: DNS lookup (A records), returns the count. Linux does DNS in libc |
//! | 504 | netinfo | *NetInfo | ours: MAC, IP, gateway, DNS, packet counters (Linux: netlink/ioctls) |
//! | 505 | trace_me | on | ours: print my syscalls from now on (survives execve; `run --trace`) |
//!
//! Stage 17's calls (link/symlink, chown, statfs/statx, sysinfo 99, times,
//! getrusage, clock_getres, socket names/options, timers, ids, priority,
//! host names, flock, preadv/pwritev, sendfile) live in `syscall_ext.rs`,
//! which has its own table; unknown numbers fall through to it.
//!
//! spawn's `argv` is all arguments separated by NUL bytes ("ls\0-l\0/bin");
//! empty means just [program name]. `SpawnOptions` (or a null pointer for
//! the defaults) picks the child's stdin/stdout/stderr from the caller's fds
//! (-1 = same as mine) and flags (SPAWN_TRACE = print its syscalls).
//!
//! The framebuffer ioctls (on an fd of /dev/fb0; numbers in Linux's 'F'
//! range, but the structs are our own -- Linux's fb_var_screeninfo has 40
//! fields):
//!
//! FB_GET_INFO 0x4600 *FbInfo {width, height, stride_bytes, bpp} (u32s)
//! FB_FLUSH 0x46f0 *[x, y, w, h] or 0 = what `write` changed: show it
//! FB_FILL 0x46f1 *[x, y, w, h, 0x00RRGGBB]: fill (not flushed)
//! FB_SET_CONSOLE 0x46f2 *[x, y, w, h] or 0 = full screen: move the text
//! console there; returns columns << 16 | rows
//!
//! What happens on `syscall` (the CPU does steps 1-3 in one instruction):
//! 1. rcx = user RIP (next instruction), r11 = user RFLAGS
//! 2. RFLAGS &= !SFMASK (we mask IF -> interrupts off)
//! 3. CS/SS = kernel selectors from STAR, RIP = LSTAR (`syscall_entry`), CPL = 0
//! ...but RSP is still the *user* stack! The CPU doesn't switch stacks for
//! `syscall` (unlike interrupts, which use TSS.RSP0). So `syscall_entry`
//! must do it first: stash the user RSP, load this thread's kernel stack,
//! save all registers as a `TrapFrame` (trap.rs), re-enable interrupts and
//! call `syscall_dispatch` in Rust. The way back is trap.rs's common exit,
//! `iretq` (stage 13 used the faster `sysretq`, but that can't restore
//! rcx/r11, which a signal handler's return needs).
//!
//! **Several CPUs.** The "kernel stack of the running thread" differs per
//! CPU, but at the entry we have no free register to compute which CPU we
//! are on. The trick every x86_64 kernel uses: the GS segment base. Each CPU
//! keeps a pointer to its own `smp::PerCpu` block in the KERNEL_GS_BASE MSR;
//! `swapgs` swaps that with the (user's) GS base, so for a few instructions
//! `gs:[0]` is *this CPU's* kernel stack and `gs:[8]` a scratch slot. We
//! swap back right after switching stacks, so the thread can be moved to
//! another CPU later without any GS confusion.
//!
//! Why not `int 0x80`? It also works (and is simpler: the CPU switches stacks
//! via TSS.RSP0 for us), but `syscall` is what Linux and every modern x86_64
//! OS use, and it's faster.
use crateErrno;
use crate;
use crate;
use crateTrapFrame;
use crate::;
use ;
use global_asm;
use Ordering;
pub const SYS_READ: u64 = 0;
pub const SYS_WRITE: u64 = 1;
pub const SYS_OPEN: u64 = 2;
pub const SYS_CLOSE: u64 = 3;
pub const SYS_STAT: u64 = 4;
pub const SYS_FSTAT: u64 = 5;
pub const SYS_LSEEK: u64 = 8;
pub const SYS_IOCTL: u64 = 16;
pub const SYS_PIPE: u64 = 22;
pub const SYS_SCHED_YIELD: u64 = 24;
pub const SYS_NANOSLEEP: u64 = 35;
pub const SYS_GETPID: u64 = 39;
pub const SYS_EXIT: u64 = 60;
pub const SYS_UNAME: u64 = 63;
pub const SYS_GETCWD: u64 = 79;
pub const SYS_CHDIR: u64 = 80;
pub const SYS_MKDIR: u64 = 83;
pub const SYS_RMDIR: u64 = 84;
pub const SYS_UNLINK: u64 = 87;
pub const SYS_READLINK: u64 = 89;
pub const SYS_SOCKET: u64 = 41;
pub const SYS_CONNECT: u64 = 42;
pub const SYS_ACCEPT: u64 = 43;
pub const SYS_ACCEPT4: u64 = 288;
pub const SYS_SENDTO: u64 = 44;
pub const SYS_RECVFROM: u64 = 45;
pub const SYS_BIND: u64 = 49;
pub const SYS_LISTEN: u64 = 50;
pub const SYS_SETSOCKOPT: u64 = 54;
pub const SYS_GETDENTS64: u64 = 217;
pub const SYS_GETRANDOM: u64 = 318;
pub const SYS_CLOCK_GETTIME: u64 = 228;
pub const SYS_SPAWN: u64 = 500;
pub const SYS_MOUNTS: u64 = 501;
pub const SYS_RB_SYSINFO: u64 = 502;
pub const SYS_RESOLVE: u64 = 503;
pub const SYS_NETINFO: u64 = 504;
pub const SYS_MMAP: u64 = 9;
pub const SYS_MPROTECT: u64 = 10;
pub const SYS_MUNMAP: u64 = 11;
pub const SYS_BRK: u64 = 12;
pub const SYS_RT_SIGACTION: u64 = 13;
pub const SYS_RT_SIGPROCMASK: u64 = 14;
pub const SYS_RT_SIGRETURN: u64 = 15;
pub const SYS_DUP: u64 = 32;
pub const SYS_DUP2: u64 = 33;
pub const SYS_PAUSE: u64 = 34;
pub const SYS_CLONE: u64 = 56;
pub const SYS_FORK: u64 = 57;
pub const SYS_VFORK: u64 = 58;
pub const SYS_EXECVE: u64 = 59;
pub const SYS_WAIT4: u64 = 61;
pub const SYS_KILL: u64 = 62;
pub const SYS_FCNTL: u64 = 72;
pub const SYS_SETPGID: u64 = 109;
pub const SYS_GETPPID: u64 = 110;
pub const SYS_GETPGRP: u64 = 111;
pub const SYS_GETPGID: u64 = 121;
pub const SYS_EXIT_GROUP: u64 = 231;
pub const SYS_DUP3: u64 = 292;
pub const SYS_PIPE2: u64 = 293;
pub const SYS_TRACE_ME: u64 = 505;
// stage 15
pub const SYS_POLL: u64 = 7;
pub const SYS_PREAD64: u64 = 17;
pub const SYS_PWRITE64: u64 = 18;
pub const SYS_READV: u64 = 19;
pub const SYS_WRITEV: u64 = 20;
pub const SYS_SELECT: u64 = 23;
pub const SYS_SETSID: u64 = 112;
pub const SYS_GETSID: u64 = 124;
pub const SYS_ARCH_PRCTL: u64 = 158;
pub const SYS_GETTID: u64 = 186;
pub const SYS_TKILL: u64 = 200;
pub const SYS_FUTEX: u64 = 202;
pub const SYS_EPOLL_CREATE: u64 = 213;
pub const SYS_SET_TID_ADDRESS: u64 = 218;
pub const SYS_EPOLL_WAIT: u64 = 232;
pub const SYS_EPOLL_CTL: u64 = 233;
pub const SYS_TGKILL: u64 = 234;
pub const SYS_PSELECT6: u64 = 270;
pub const SYS_PPOLL: u64 = 271;
pub const SYS_EPOLL_PWAIT: u64 = 281;
pub const SYS_EPOLL_CREATE1: u64 = 291;
// Stage 15.1: the rest of Linux's path calls, and a few musl needs early.
pub const SYS_LSTAT: u64 = 6;
pub const SYS_ACCESS: u64 = 21;
pub const SYS_RENAME: u64 = 82;
pub const SYS_FCHDIR: u64 = 81;
pub const SYS_GETUID: u64 = 102;
pub const SYS_GETGID: u64 = 104;
pub const SYS_GETEUID: u64 = 107;
pub const SYS_GETEGID: u64 = 108;
pub const SYS_CLOCK_NANOSLEEP: u64 = 230;
pub const SYS_OPENAT: u64 = 257;
pub const SYS_MKDIRAT: u64 = 258;
pub const SYS_NEWFSTATAT: u64 = 262;
pub const SYS_UNLINKAT: u64 = 263;
pub const SYS_RENAMEAT: u64 = 264;
pub const SYS_READLINKAT: u64 = 267;
pub const SYS_FACCESSAT: u64 = 269;
pub const SYS_RENAMEAT2: u64 = 316;
pub const SYS_FACCESSAT2: u64 = 439;
// Stage 16: what a C library (musl) calls besides open/read/write.
pub const SYS_MADVISE: u64 = 28;
pub const SYS_FSYNC: u64 = 74;
pub const SYS_FDATASYNC: u64 = 75;
pub const SYS_TRUNCATE: u64 = 76;
pub const SYS_FTRUNCATE: u64 = 77;
pub const SYS_CHMOD: u64 = 90;
pub const SYS_FCHMOD: u64 = 91;
pub const SYS_UMASK: u64 = 95;
pub const SYS_GETRLIMIT: u64 = 97;
pub const SYS_RT_SIGPENDING: u64 = 127;
pub const SYS_RT_SIGTIMEDWAIT: u64 = 128;
pub const SYS_RT_SIGQUEUEINFO: u64 = 129;
pub const SYS_RT_SIGSUSPEND: u64 = 130;
pub const SYS_SIGALTSTACK: u64 = 131;
pub const SYS_PRCTL: u64 = 157;
pub const SYS_SETRLIMIT: u64 = 160;
pub const SYS_FCHMODAT: u64 = 268;
pub const SYS_SET_ROBUST_LIST: u64 = 273;
pub const SYS_GET_ROBUST_LIST: u64 = 274;
pub const SYS_UTIMENSAT: u64 = 280;
pub const SYS_RT_TGSIGQUEUEINFO: u64 = 297;
pub const SYS_PRLIMIT64: u64 = 302;
pub const SYS_FCHMODAT2: u64 = 452;
pub const SYS_SCHED_SETAFFINITY: u64 = 203;
pub const SYS_SCHED_GETAFFINITY: u64 = 204;
// Socket constants (Linux's values).
pub const AF_INET: u64 = 2;
pub const SOCK_STREAM: u64 = 1;
pub const SOCK_DGRAM: u64 = 2;
pub const IPPROTO_ICMP: u64 = 1;
pub const SOL_SOCKET: u64 = 1;
pub const SO_RCVTIMEO: u64 = 20;
pub const O_ACCMODE: u64 = 3; // O_RDONLY 0, O_WRONLY 1, O_RDWR 2
pub const O_CREAT: u64 = 0o100;
pub const O_EXCL: u64 = 0o200;
pub const O_DIRECTORY: u64 = 0o200000;
pub const O_NOFOLLOW: u64 = 0o400000;
/// The *at() calls: "relative to the cwd" instead of a directory fd, and flags.
pub const AT_FDCWD: i64 = -100;
pub const AT_SYMLINK_NOFOLLOW: u64 = 0x100;
pub const AT_REMOVEDIR: u64 = 0x200;
pub const AT_EMPTY_PATH: u64 = 0x1000;
/// Longest path, counting the NUL (Linux's PATH_MAX).
pub const PATH_MAX: usize = 4096;
pub const O_NOCTTY: u64 = 0o400;
pub const O_TRUNC: u64 = 0o1000;
pub const O_APPEND: u64 = 0o2000;
pub const O_NONBLOCK: u64 = 0o4000;
pub const O_CLOEXEC: u64 = 0o2000000;
/// fcntl commands.
pub const F_DUPFD: u64 = 0;
pub const F_GETFD: u64 = 1;
pub const F_SETFD: u64 = 2;
pub const F_GETFL: u64 = 3;
pub const F_SETFL: u64 = 4;
pub const F_GETLK: u64 = 5;
pub const F_SETLK: u64 = 6;
pub const F_SETLKW: u64 = 7;
pub const F_DUPFD_CLOEXEC: u64 = 1030;
/// struct flock's l_type.
pub const F_RDLCK: i16 = 0;
pub const F_WRLCK: i16 = 1;
pub const F_UNLCK: i16 = 2;
/// utimensat: "set this time to now" / "leave this time alone" (tv_nsec).
pub const UTIME_NOW: i64 = - 1;
pub const UTIME_OMIT: i64 = - 2;
/// prctl options we know.
pub const PR_SET_PDEATHSIG: u64 = 1;
pub const PR_GET_PDEATHSIG: u64 = 2;
pub const PR_GET_DUMPABLE: u64 = 3;
pub const PR_SET_DUMPABLE: u64 = 4;
pub const PR_SET_NAME: u64 = 15;
pub const PR_GET_NAME: u64 = 16;
pub const PR_SET_CHILD_SUBREAPER: u64 = 36;
pub const PR_GET_CHILD_SUBREAPER: u64 = 37;
pub const PR_SET_NO_NEW_PRIVS: u64 = 38;
pub const PR_GET_NO_NEW_PRIVS: u64 = 39;
/// madvise advice values.
pub const MADV_DONTNEED: u64 = 4;
pub const MADV_FREE: u64 = 8;
pub const FD_CLOEXEC: u64 = 1;
/// ioctl(FIONBIO, *int): O_NONBLOCK on/off, for any file.
pub const FIONBIO: u64 = 0x5421;
/// mmap flags.
pub const MAP_SHARED: u64 = 0x01;
pub const MAP_PRIVATE: u64 = 0x02;
pub const MAP_FIXED: u64 = 0x10;
pub const MAP_ANONYMOUS: u64 = 0x20;
/// clone flags (Linux's values).
pub const CLONE_VM: u64 = 0x100; // share the address space
pub const CLONE_FS: u64 = 0x200; // share cwd/umask
pub const CLONE_FILES: u64 = 0x400; // share the fd table
pub const CLONE_SIGHAND: u64 = 0x800; // share signal handlers
pub const CLONE_VFORK: u64 = 0x4000; // parent waits until the child execs/exits
pub const CLONE_THREAD: u64 = 0x10000; // same process: a thread
pub const CLONE_SYSVSEM: u64 = 0x40000;
pub const CLONE_SETTLS: u64 = 0x80000; // new thread's FS base = tls argument
pub const CLONE_PARENT_SETTID: u64 = 0x100000; // write the tid to *ptid
pub const CLONE_CHILD_CLEARTID: u64 = 0x200000; // at exit: *ctid = 0 + futex wake
pub const CLONE_DETACHED: u64 = 0x400000;
pub const CLONE_CHILD_SETTID: u64 = 0x1000000; // write the tid to *ctid
/// arch_prctl codes.
pub const ARCH_SET_FS: u64 = 0x1002;
pub const ARCH_GET_FS: u64 = 0x1003;
pub const SPAWN_TRACE: u64 = 1;
/// Framebuffer ioctls (see the table at the top).
pub const FB_GET_INFO: u64 = 0x4600;
pub const FB_FLUSH: u64 = 0x46f0;
pub const FB_FILL: u64 = 0x46f1;
pub const FB_SET_CONSOLE: u64 = 0x46f2;
/// Name of a syscall number (for tracing).
/// spawn's options, as laid out in user memory.
/// Called by the scheduler when switching threads: the kernel stack that
/// `syscall` on this CPU should use from now on.
/// Program the MSRs that make `syscall` work (on the calling CPU; every CPU
/// runs this once).
unsafe extern "C"
global_asm!;
/// Rust side of every system call. Arguments are in the saved registers
/// (rdi, rsi, rdx, r10, r8, r9 = a1..a6), the number in `error` (= rax at
/// entry); the result goes into the saved rax.
extern "C"
/// One syscall in strace style: `open("/mnt/disk0/readme.txt", 0) = 3`.
/// Strings and buffers are read back from user memory (after the call, so
/// `read` shows what it got), shortened to 40 bytes.
/// A syscall's name for the trace; unknown ones by number (`syscall_130`),
/// so a missing call is easy to look up in Linux's table.
pub
/// The calling thread.
pub
/// Read a `struct timespec {i64 seconds, i64 nanoseconds}` as microseconds
/// (rounded up, so a timeout never ends early).
/// Turn a user pointer + length into a slice, after checking that the user
/// may really access that memory. Never trust pointers from user space!
/// Like `user_slice`, but the user must be allowed to *write* the memory.
// --- Paths (stage 15.1: Linux's C-string ABI) --------------------------------------
//
// A path argument is a pointer to a NUL-terminated string, like in C (up
// to stage 15 we took a pointer and a length, which no libc does). We copy
// it in page by page with `user_cstr`, so a bad pointer, or a string that
// runs into an unmapped page, is EFAULT rather than a kernel crash, and at
// most PATH_MAX bytes (with the NUL): longer is ENAMETOOLONG.
//
// The *at() variants take a directory fd first: a relative path starts
// there instead of at the cwd (AT_FDCWD = "the cwd", what the old calls
// mean). musl uses them for stat (newfstatat), opendir is open with
// O_DIRECTORY, and so on.
/// The directory a relative path in an *at() call starts from.
pub
/// A path string (already copied in) made absolute, relative to `dirfd`.
pub
/// Copy in a path argument and make it absolute, relative to `dirfd`.
pub
/// Copy in a path argument, relative to the cwd.
pub
/// open / openat(dirfd, path, flags, mode). Everything is readable and
/// writable whatever O_RDONLY/O_WRONLY say, and `mode` is ignored (new
/// files get the file system's default permissions).
/// open("/proc/self/fd/N") (stage 18), as on Linux: a file with a path is
/// opened again (its own offset, the new flags); a pipe, terminal or
/// device gives the same open file again, like dup(N); sockets can't be
/// opened (ENXIO).
/// newfstatat(dirfd, path, *stat, flags): stat, lstat (AT_SYMLINK_NOFOLLOW:
/// a symlink itself, not what it points to) and, with AT_EMPTY_PATH and
/// path "", fstat(dirfd). Writes Linux's `struct stat`.
/// The `struct stat` newfstatat (and statx, stage 17) report.
pub
/// fstat's `struct stat`: files opened by path report what stat() of the
/// path does. Others (pipes, sockets, consoles): the open file's address
/// as the inode number, unique while it's open.
pub
/// access / faccessat(dirfd, path, mode): "does it exist?" There are no
/// permissions to check yet (we're root), so existing is enough.
/// mkdir / mkdirat(dirfd, path, mode); `mode` is ignored.
/// open(O_CREAT) / mkdir (stage 16): the new file gets `mode` minus the
/// umask bits, where the filesystem keeps modes (ramfs, ext2). Elsewhere
/// (FAT, read-only btrfs) it's quietly skipped -- the file exists, which
/// is what the caller asked for.
pub
/// unlink / rmdir / unlinkat(dirfd, path, flags): AT_REMOVEDIR = rmdir.
/// rename / renameat / renameat2. Stage 17: RENAME_NOREPLACE (1) works
/// (EEXIST if the new name is taken); RENAME_EXCHANGE (2) and
/// RENAME_WHITEOUT (4) are EINVAL, as on file systems that lack them.
/// See `fs::rename` for what we can and can't move.
/// fchdir(fd): cd to a directory we have open.
/// readlink / readlinkat(dirfd, path, buf, size): the link's target, *no*
/// NUL added (like Linux); returns its length (cut to `size`).
/// Copy a plain-data struct out to user memory.
/// Copy `N` u32s in from user memory (ioctl arguments).
/// fcntl: the fd flags (close-on-exec), duplication, and the one status
/// flag we have: O_NONBLOCK (it belongs to the open file, so it's shared
/// with dup'ed fds). Everything is opened read/write.
/// getcwd: like Linux, the path with a NUL; returns the length + 1.
/// spawn(path, argv blob, blob length, *options): our own call (500).
/// ioctl: FIONBIO for any file; the rest is up to the file (terminals:
/// tty.rs; the framebuffer: below).
/// The /dev/fb0 ioctls (table at the top of this file).
/// getrandom(buf, len, flags): Linux 318. We always have "enough entropy"
/// (the host's), so the flags (GRND_NONBLOCK, GRND_RANDOM) change nothing.
/// Linux's `struct utsname`: six NUL-terminated strings of 65 bytes each.
/// What `sysinfo` fills in (ours; the user side is in user/ulib.rs).
/// The mount table as text, one "path fstype" line per mount.
// --- Networking (net/socket.rs does the real work) -----------------------------
/// Linux's `struct sockaddr_in`: family, port and address in network byte
/// order (big-endian), 8 bytes of padding.
pub
/// Write a peer's address like Linux: `*len_ptr` (a u32) says how much
/// room there is; we write at most that much and set it to the real size
/// (16). No `len_ptr` (only our own older programs do that): all 16 bytes.
pub
/// Run `f` on the socket behind `fd` (ENOTSOCK if it's another kind of
/// file). We hold our own Arc to it, so the fd may be closed meanwhile.
pub
/// accept(fd, *addr, *len) and accept4(..., flags: SOCK_NONBLOCK|SOCK_CLOEXEC).
/// clock_gettime(clock, *timespec): CLOCK_REALTIME (0, wall-clock time
/// since 1970, from the CMOS clock at boot) or the MONOTONIC family (1,
/// 4 RAW, 6 COARSE, 7 BOOTTIME: time since boot). CPU-time clocks: EINVAL.
// --- Processes, memory, signals (stage 14) --------------------------------------
/// A NUL-terminated string from user memory (at most `max` bytes).
/// A NULL-terminated array of C strings (execve's argv and envp).
/// clone(flags, stack, *ptid, *ctid, tls): a new thread (CLONE_THREAD)
/// or a new process (fork-like flags).
///
/// A thread shares everything with its process -- memory, fds, signal
/// handlers -- so CLONE_THREAD needs CLONE_VM and CLONE_SIGHAND, like
/// Linux. (CLONE_FILES / CLONE_FS are accepted and implied: our threads
/// always share the fd table and cwd.) pthread_create passes them all plus
/// SETTLS (its thread block), PARENT_SETTID and CHILD_CLEARTID (so
/// pthread_join can sleep on a futex until the thread is gone).
/// arch_prctl(ARCH_SET_FS, addr) / (ARCH_GET_FS, *addr): the FS segment
/// base, which libc points at the thread's own data (thread-local storage:
/// `fs:[0]` is "this thread's block" on x86_64). Saved per thread and
/// reloaded by the scheduler on every switch.
/// tgkill(tgid, tid, sig) / tkill(tid, sig): a signal for one thread
/// (pthread_kill, raise). sig 0 = just check it exists.
/// nanosleep(*req, *rem). Our timer ticks every ~55 ms, so sleeps are
/// rounded up to that. Cut short by a signal: the time left goes to *rem.
/// clock_nanosleep(clock, flags, *req, *rem): nanosleep on a chosen clock;
/// with TIMER_ABSTIME (1), `req` is a time on that clock to sleep until.
/// Sleep `us` microseconds; if a signal cuts it short, the time left goes
/// to `*rem` (a timespec) unless that's 0.
/// pread64 / pwrite64: at `offset`, without moving the file offset.
/// The `struct iovec {void *base; size_t len;}` array of readv/writev.
pub
/// readv: one read into a kernel buffer, then spread over the buffers
/// (so a pipe or terminal sees a single read, like Linux).
/// writev: gather the buffers and write them in one go (so the pieces of
/// one printf can't be interleaved with another thread's output).
/// wait4(pid, *status, options, *rusage). We don't count CPU time per
/// process yet, so a `struct rusage` (144 bytes) comes back all zeros.
/// mmap(addr, len, prot, flags, fd, offset). The new region is empty: pages
/// appear on first touch (demand paging, mm.rs).
// --- Stage 16: libc batch 1 -------------------------------------------------
/// madvise(addr, len, advice): hints about how memory will be used. Most
/// are just hints (we accept and ignore them); MADV_DONTNEED and MADV_FREE
/// really give private pages back (they read as zeros afterwards).
/// MADV_REMOVE / MADV_WIPEONFORK and unknown values: EINVAL (we can't do
/// them, and saying "done" would be a lie a program might rely on).
/// fsync / fdatasync: our filesystems write through to the disk on every
/// write (there's no page cache yet), so there's nothing left to flush.
/// Pipes, sockets and ttys can't be synced: EINVAL, like Linux.
/// Longest file truncate/ftruncate may make (bigger: EFBIG). 4 GiB - 1 is
/// FAT's limit, and far more than our RAM, so ramfs can't be asked to
/// allocate something silly either.
const MAX_TRUNCATE: u64 = u32MAX as u64;
/// truncate(path, len): cut a file to `len` bytes, or grow it with zeros.
/// ftruncate(fd, len): the same through an fd, which must be open for writing.
/// fchmodat(dirfd, path, mode) and fchmodat2 (same + flags). chmod 90 is
/// fchmodat(AT_FDCWD, ...). FAT has no permissions (EPERM), btrfs is
/// read-only here (EROFS). Symlinks have no mode of their own: with
/// AT_SYMLINK_NOFOLLOW on one, EOPNOTSUPP (as Linux).
/// fchmod(fd, mode): files and directories opened by path; others EINVAL.
/// utimensat(dirfd, path, *[timespec; 2], flags): set the access and
/// modification times. NULL times = both "now"; a tv_nsec of UTIME_NOW /
/// UTIME_OMIT = now / leave alone. A NULL path means the file `dirfd` is
/// open on (that's how musl does futimens). The change time becomes now.
/// FAT accepts and forgets them (it only has a modification date in a
/// format we don't write); btrfs: EROFS.
/// prlimit64(pid, resource, *new, *old), and getrlimit / setrlimit on
/// myself. `struct rlimit` is {u64 soft, u64 hard}; RLIM_INFINITY = !0.
/// What the kernel enforces: RLIMIT_NOFILE (the fd table size, at most 64).
/// The rest are remembered and inherited (fork), so programs that check
/// them see sensible, consistent numbers.
/// prctl(option, ...): a grab bag of per-process settings. We know:
/// PR_SET_NAME / PR_GET_NAME (the thread's 16-byte name, `comm`; for the
/// main thread also what `ps` shows), PR_SET/GET_PDEATHSIG (a signal to
/// get when my parent dies), PR_SET/GET_DUMPABLE, PR_SET/GET_NO_NEW_PRIVS,
/// PR_SET/GET_CHILD_SUBREAPER (adopt orphaned descendants, process.rs).
/// Everything else: EINVAL, which is what Linux says to unknown options.
/// Size of `struct robust_list_head` (list, futex_offset, list_op_pending).
pub const ROBUST_LIST_HEAD_SIZE: u64 = 24;
/// set_robust_list(head, len): where this thread's list of held robust
/// mutexes lives. When the thread dies, the kernel walks it and marks each
/// one FUTEX_OWNER_DIED (process.rs, `exit_robust_list`), so the next
/// locker learns the owner died instead of waiting forever.
/// get_robust_list(tid, *head, *len): 0 = myself.
/// sigaltstack(*new, *old): `stack_t` = {void *ss_sp; int ss_flags; size_t
/// ss_size} (24 bytes with padding). Handlers installed with SA_ONSTACK
/// run on this stack -- how a program can still handle SIGSEGV after
/// overflowing its normal stack. `user_sp`: the caller's stack pointer
/// (to tell whether it's running on the alternate stack right now).
/// rt_sigpending(*set, size): which signals are waiting because they're
/// blocked.
/// rt_sigsuspend(*mask, 8): swap in `mask` and sleep until a signal is
/// handled (always "fails" with EINTR); the old mask comes back after the
/// handler, so there's no window where a signal can slip by unnoticed.
/// rt_sigtimedwait(*set, *siginfo, *timeout, 8): wait for one of `set`
/// (normally blocked) and *take* it -- no handler runs; the signal number
/// is returned and its siginfo copied out. Timeout NULL = forever, {0, 0}
/// = just look; expired: EAGAIN. Another signal with a handler: EINTR.
/// Timing is rounded up to timer ticks (~55 ms).
/// The thread's blocked set right now.
/// rt_sigqueueinfo(tgid, sig, *siginfo) / rt_tgsigqueueinfo(tgid, tid,
/// sig, *siginfo): send a signal with my own siginfo (sigqueue() puts a
/// value in it). Real-time signals (32..64) queue up: sending one 3 times
/// delivers it 3 times, each with its own value. Pretending to be the
/// kernel or kill() (si_code >= 0, or SI_TKILL) is only allowed toward
/// myself: EPERM. A full queue: EAGAIN.
/// fcntl(F_GETLK / F_SETLK / F_SETLKW, *flock): POSIX record locks (see
/// fs/lock.rs). `struct flock` = {i16 l_type, i16 l_whence, i64 l_start,
/// i64 l_len, i32 l_pid} (32 bytes with padding).
/// sched_getaffinity(tid, len, *mask) / sched_setaffinity: which CPUs a
/// thread may run on. Ours run on any CPU, so "get" reports every online
/// CPU (that's how musl's sysconf(_SC_NPROCESSORS_ONLN) and `nproc` count
/// them) and "set" only checks the mask names at least one online CPU (we
/// don't pin threads). Like the raw Linux call, "get" returns the number
/// of bytes written (8: one 64-bit word of CPU bits), not 0.
|