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 | //! 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. The older file calls still take paths as pointer +
//! length (Linux: NUL-terminated); relative paths start at the cwd.
//!
//! | nr | name | arguments | note |
//! |-----|-------------|-------------------------------------|------|
//! | 0 | read | fd, buf, len | blocks: console until Enter, pipe until data/EOF |
//! | 1 | write | fd, buf, len | to a pipe without readers: EPIPE + SIGPIPE |
//! | 2 | open | path, path_len, flags | O_CREAT 0o100, O_TRUNC 0o1000, O_APPEND, O_CLOEXEC 0o2000000 |
//! | 3 | close | fd | |
//! | 4 | stat | path, path_len, *Stat | our own small `Stat {kind, size, mode}`; follows symlinks |
//! | 5 | fstat | fd, *Stat | |
//! | 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 | console: TTY_SET_RAW (ours), TIOCGPGRP, TIOCSPGRP, TIOCGWINSZ; /dev/fb0: FB_* (below) |
//! | 22 | pipe | *[u32; 2] | [read end, write end] |
//! | 24 | sched_yield | | |
//! | 32 | dup | fd | lowest free fd |
//! | 33 | dup2 | old, new | closes `new` first if open |
//! | 34 | pause | | sleeps until a signal; returns EINTR |
//! | 35 | sleep_ms | milliseconds | Linux's nr 35 is nanosleep(timespec); ours is simpler. EINTR on a signal |
//! | 39 | getpid | | |
//! | 41 | socket | domain, type, protocol | AF_INET (2) only; 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); UDP/ICMP: set default destination |
//! | 43 | accept | fd, *sockaddr_in or 0, *u32 len or 0 | blocks for a connection (SO_RCVTIMEO applies); returns the new fd |
//! | 44 | sendto | fd, buf, len, flags, *sockaddr_in or 0 | Linux has a 6th arg (addrlen); we only take 5, the address is always 16 bytes |
//! | 45 | recvfrom | fd, buf, len, flags, *sockaddr_in or 0 | blocks (SO_RCVTIMEO -> EAGAIN); 0 = TCP peer closed. No addrlen pointer |
//! | 49 | bind | fd, *sockaddr_in, len | sets the local port (address ignored: we have one) |
//! | 50 | listen | fd, backlog | TCP; backlog 1..4 |
//! | 54 | setsockopt | fd, level, name, *value, len | only SOL_SOCKET (1) / SO_RCVTIMEO (20) with a `struct timeval` |
//! | 56 | clone | flags, stack, ... | only fork-like flags: SIGCHLD + optional CLONE_VFORK (else ENOSYS) |
//! | 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 | |
//! | 61 | wait4 | pid, *status, options, *rusage | WNOHANG 1, WUNTRACED 2, WCONTINUED 8; rusage must be 0 |
//! | 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, F_SETFL 4, F_DUPFD_CLOEXEC 1030 |
//! | 79 | getcwd | buf, len | returns the length (no NUL) |
//! | 80 | chdir | path, path_len | |
//! | 83 | mkdir | path, path_len | |
//! | 84 | rmdir | path, path_len | only empty directories |
//! | 87 | unlink | path, path_len | files and symlinks (not what a symlink points to) |
//! | 89 | readlink | path, path_len, buf, len | a symlink's target; returns its length (cut to `len`, no NUL) |
//! | 109 | setpgid | pid, pgid | 0 = myself / a new group |
//! | 110 | getppid | | 0 if started by the kernel or orphaned |
//! | 111 | getpgrp | | |
//! | 121 | getpgid | pid | |
//! | 217 | getdents64 | fd, buf, len | Linux `struct linux_dirent64` records |
//! | 228 | clock_gettime | clock, *timespec | CLOCK_REALTIME/MONOTONIC both = time since boot (we have no RTC driver) |
//! | 231 | exit_group | code | = exit (one thread per process) |
//! | 292 | dup3 | old, new, flags | flags: O_CLOEXEC |
//! | 293 | pipe2 | *[u32; 2], flags | flags: O_CLOEXEC |
//! | 318 | getrandom | buf, len, flags | random bytes (virtio-rng); up to 64 KiB per call; flags ignored |
//! | 500 | spawn | path, path_len, 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 | 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`) |
//!
//! 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_SLEEP_MS: 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_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_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;
// 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_CREAT: u64 = 0o100;
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_DUPFD_CLOEXEC: u64 = 1030;
pub const FD_CLOEXEC: u64 = 1;
/// Terminal ioctls (Linux's numbers).
pub const TIOCGPGRP: u64 = 0x540F;
pub const TIOCSPGRP: u64 = 0x5410;
pub const TIOCGWINSZ: u64 = 0x5413;
/// 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 we understand.
pub const CLONE_VFORK: u64 = 0x4000;
/// ioctl request (ours): arg 1 = raw mode, 0 = cooked; returns the old mode.
pub const TTY_SET_RAW: u64 = 1;
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.
/// 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.
/// Read a path argument and make it absolute (relative to the cwd).
/// Copy a plain-data struct out to user memory.
/// Copy `N` u32s in from user memory (ioctl arguments).
/// fcntl: just the fd flags (close-on-exec) and duplication. Status flags:
/// everything is blocking, read/write (O_NONBLOCK isn't supported yet).
/// 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.
/// 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.
/// Only SO_RCVTIMEO: `struct timeval {i64 seconds, i64 microseconds}`;
/// zero means "block forever", like Linux.
/// `struct timespec {i64 seconds, i64 nanoseconds}` since boot.
// --- 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: only the fork-like uses (no threads yet): exit signal SIGCHLD
/// (or 0) in the low byte, optionally CLONE_VFORK, optionally a new stack.
/// mmap(addr, len, prot, flags, fd, offset). The new region is empty: pages
/// appear on first touch (demand paging, mm.rs).
|