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 | //! Processes: a thread + an address space (`Mm`) + a file descriptor table
//! (+ arguments, environment, a current directory, a parent, a process
//! group and signal state).
//!
//! **How Unix makes processes: fork + exec.** There's no "start program X"
//! call. Instead:
//! * `fork()` duplicates the calling process. Both copies return from the
//! same fork call: the parent gets the child's pid, the child gets 0.
//! The child has a copy of everything: memory, open files, cwd, signal
//! handlers.
//! * `execve(path, argv, envp)` replaces the *running* program with
//! another one: new code, new memory, same process (pid, open files,
//! cwd, parent).
//! Why split it? Because between the two the child is still running the
//! *parent's* code, and can set itself up with all the normal syscalls:
//! `dup2` a pipe onto stdout, `chdir`, `setpgid`, reset signal handlers,
//! close files. No "spawn options" structure has to anticipate every
//! possible setup: a shell does `cmd > file` as fork, open, dup2, exec.
//! Copying all memory just to throw it away at exec would be slow; that's
//! what copy-on-write (mm.rs) is for: fork only copies page tables.
//!
//! `spawn` (our syscall 500 from stage 9, and `spawn_path` for the kernel)
//! stays as a convenience: new process + exec in one step, like
//! `posix_spawn`.
//!
//! **Exit and wait.** A process's exit status is stored in it, its parent
//! gets SIGCHLD and is woken; `wait4` returns the status and removes the
//! child from the process table ("reaps" it -- until then it's a *zombie*).
//! If the parent exits first, the children become orphans (parent =
//! ORPHAN) and remove themselves when they exit; Unix hands them to
//! `init` instead. Since stage 16 we do too when there's someone to hand
//! them to: an ancestor that called prctl(PR_SET_CHILD_SUBREAPER), or a
//! pid 1 named "init" (see `adopter`).
//!
//! **Process groups** (job control): every process is in a group, named by
//! the pid of its first member. A shell puts each pipeline in its own group
//! and tells the terminal which group is in the *foreground*; Ctrl+C then
//! sends SIGINT to that whole group -- every program of the pipeline, but
//! not the shell (tty.rs).
//!
//! **Threads** (stage 15). A process can run several threads: each is a
//! `Task` with its own registers, kernel stack, thread id, TLS pointer and
//! signal mask, but they all share the process's memory, files and signal
//! handlers. `clone(CLONE_VM | CLONE_THREAD | ...)` makes one (that's what
//! pthread_create does). The first thread's id equals the pid. `exit` ends
//! one thread; `exit_group` (what C's exit() calls) ends them all. The
//! process itself ends when its last thread does.
//!
//! **Memory lifetime.** A process's frames and page tables are freed when
//! the last `Arc<Process>` goes away (dropping its `Mm`). That's always
//! after its threads are gone: each holds an Arc (through its Task) until
//! the scheduler frees it, which happens only once the CPU has switched to
//! another thread and address space. So no CPU can still be using the page
//! tables.
use crate;
use crateErrno;
use crateFpuState;
use crate;
use crateMm;
use crate;
use crate;
use crateTrapFrame;
use crateserial_println;
use ;
use ;
use Mutex;
use without_interrupts;
pub use crate;
/// `parent` of a process whose parent exited first.
pub const ORPHAN: u64 = u64MAX;
/// Max open files per process.
pub const MAX_FDS: usize = 64;
/// Max total size of a program's arguments + environment strings.
pub const MAX_ARGS_SIZE: usize = 64 * 1024;
/// Max processes at once: fork() fails with EAGAIN beyond that, which is
/// what stops a fork bomb from eating all memory.
pub const MAX_PROCESSES: usize = 64;
/// Max threads in one process (clone fails with EAGAIN beyond that).
pub const MAX_THREADS: usize = 64;
/// Environment of processes the kernel starts.
pub const DEFAULT_ENV: = ;
/// Open files: fd number -> file, plus "close on exec" flags.
/// One thread of a process (what Linux calls a "task"). The scheduler's
/// kernel thread that runs it holds an `Arc<Task>` (thread.rs).
/// One APIC timer tick (apic.rs programs ~100 a second), in microseconds:
/// the unit of CPU-time accounting (stage 17).
pub const CPU_TICK_US: u64 = 10_000;
/// CPU time, Linux style (stage 17): every timer tick is charged to
/// whatever thread it interrupted, as "user" time if the CPU was running
/// the program and "system" time if it was in the kernel for it. That's
/// what Linux does without fine-grained accounting too: a sample, not a
/// stopwatch. Children's times are added to `child_*` when they're reaped
/// with wait4, which is what times() and getrusage(RUSAGE_CHILDREN) show.
/// User and group ids (stage 17). Linux keeps three of each: real (who
/// you are), effective (what permission checks use) and saved (what a
/// setuid program may switch back to), plus "fs" ids and the
/// supplementary groups. We store them all and report them truthfully,
/// but nothing checks them yet: permissions aren't enforced.
/// How many supplementary groups a process can have (Linux allows 65536;
/// 32 is plenty here).
pub const NGROUPS_MAX: usize = 32;
/// A thread name as prctl(PR_GET_NAME) returns it: at most 15 bytes, then NULs.
// --- Resource limits (stage 16) ------------------------------------------
//
// Linux's RLIMIT_* numbers. Each limit has a soft value (what's enforced)
// and a hard one (the ceiling the soft one may be raised to). We enforce
// RLIMIT_NOFILE (the fd table); the others report what the kernel really
// does (STACK = the fixed stack size, NPROC = the process table) or are
// remembered without being enforced.
pub const RLIMIT_CPU: usize = 0;
pub const RLIMIT_FSIZE: usize = 1;
pub const RLIMIT_DATA: usize = 2;
pub const RLIMIT_STACK: usize = 3;
pub const RLIMIT_CORE: usize = 4;
pub const RLIMIT_NPROC: usize = 6;
pub const RLIMIT_NOFILE: usize = 7;
pub const RLIMIT_MEMLOCK: usize = 8;
pub const RLIMIT_SIGPENDING: usize = 11;
pub const RLIMIT_MSGQUEUE: usize = 12;
pub const RLIMIT_NLIMITS: usize = 16;
pub const RLIM_NLIMITS: usize = RLIMIT_NLIMITS;
pub const RLIM_INFINITY: u64 = u64MAX;
/// What a process the kernel starts gets (Linux's usual defaults, with our
/// real numbers where the kernel has a fixed limit).
/// The most a hard limit can be raised to (EPERM above): where the kernel
/// has a fixed size, that.
static NEXT_PID: AtomicU64 = new;
/// All processes that haven't been reaped yet, by pid. Locked with
/// interrupts off only (exit_current takes it with interrupts off). Lock
/// order: this table before any process's `signals`.
static PROCESSES: = new;
/// vfork parents wait here.
static VFORK_WAIT: WaitQueue = new;
/// Everything needed to start a process besides the program itself.
/// Load the program at `path` (absolute) from the VFS and start it.
/// Start ELF program `elf_image` from the kernel (console stdio, no args).
/// Load `elf_image` into a new address space and start it. `path` is
/// where it came from (AT_EXECFN); the process is named after its last part.
/// Put the process in the table and start its first thread (tid = pid).
/// Start a thread `tid` of `process` that enters user mode with `start`.
/// `fpu`: its FPU/SSE registers (a copy of the creator's, or clean).
/// `altstack`: its sigaltstack (fork keeps the caller's); `comm`: its name.
/// First code of every user thread (still ring 0, but already running
/// with the process's CR3 and kernel stack): enter user mode with the
/// prepared registers.
/// Random bytes for AT_RANDOM (virtio-rng; the TSC if there's none).
// Auxiliary vector keys (Linux's AT_* values, `man getauxval`).
const AT_NULL: u64 = 0;
const AT_PHDR: u64 = 3;
const AT_PHENT: u64 = 4;
const AT_PHNUM: u64 = 5;
const AT_PAGESZ: u64 = 6;
const AT_BASE: u64 = 7;
const AT_FLAGS: u64 = 8;
const AT_ENTRY: u64 = 9;
const AT_UID: u64 = 11;
const AT_EUID: u64 = 12;
const AT_GID: u64 = 13;
const AT_EGID: u64 = 14;
const AT_PLATFORM: u64 = 15;
const AT_HWCAP: u64 = 16;
const AT_CLKTCK: u64 = 17;
const AT_SECURE: u64 = 23;
const AT_RANDOM: u64 = 25;
const AT_EXECFN: u64 = 31;
/// Load a program into the empty address space `mm` and build its initial
/// stack the way Linux does, so a C library's `_start` finds everything
/// where it expects it. Returns the registers to start with.
///
/// The stack, from USER_STACK_TOP downwards:
///
/// strings: execfn, environment, arguments, "x86_64", 16 random bytes,
/// (a copy of the program headers if no segment contains them)
/// (padding to 16 bytes)
/// auxv: pairs of [key, value] ..., [AT_NULL, 0]
/// envp: pointers to the environment strings ..., NULL
/// argv: pointers to the argument strings ..., NULL
/// argc <- rsp (16-byte aligned)
/// Look up a live (or not yet reaped) process.
/// How many processes are in the table (running or not yet reaped).
/// Every process in the table.
/// The (not exited) members of process group `pgid`.
/// End the whole current process: every thread of it (exit_group, a
/// fatal signal). The first status given wins.
!
/// The old name: end the current process.
!
/// End the calling thread (the exit syscall). If it's the last one, the
/// process ends too -- with `status`, unless exit_group already set one.
!
// --- Robust futex lists (set_robust_list, stage 16) ------------------------
//
// A "robust" mutex survives its owner dying. The lock word holds the
// owner's thread id; each thread keeps a linked list of the robust locks it
// holds, in its own memory, and tells the kernel where the list starts:
//
// struct robust_list_head {
// struct robust_list *next; // first entry (the head itself = empty)
// long futex_offset; // entry address + this = the lock word
// struct robust_list *list_op_pending; // lock being taken/released now
// };
//
// When the thread exits, the kernel walks the list. Every lock word that
// still has the thread's id gets FUTEX_OWNER_DIED set (and the id cleared),
// and if somebody waits (FUTEX_WAITERS) one waiter is woken -- so the next
// pthread_mutex_lock returns EOWNERDEAD instead of hanging forever.
pub const ROBUST_LIST_HEAD_SIZE: u64 = 24;
const FUTEX_WAITERS: u32 = 0x8000_0000;
const FUTEX_OWNER_DIED: u32 = 0x4000_0000;
const FUTEX_TID_MASK: u32 = 0x3fff_ffff;
/// Linux's limit on list entries (a loop in a corrupted list can't hang us).
const ROBUST_LIST_LIMIT: usize = 2048;
/// Mark one lock word "owner died" if `tid` holds it.
/// Walk the exiting thread's robust list (see above).
/// The last thread of `process` is exiting: close everything, become a
/// zombie, tell the parent.
/// Who adopts the running children of `dying` (stage 16)? Like Linux: the
/// nearest living ancestor that said prctl(PR_SET_CHILD_SUBREAPER), else
/// pid 1 -- but only if pid 1 is a real `init` (named "init", or a
/// subreaper), because one that never calls wait(-1) would collect
/// zombies forever. Today pid 1 is usually our own shell, which only waits
/// for its jobs, so most orphans get None: they reap themselves on exit
/// (parent = ORPHAN), which frees their memory just the same.
/// Block (the calling thread) until `process` has ended and its thread is
/// gone, then remove it from the process table. Used by the kernel (tests,
/// the shell supervisor). Once the caller drops its own `Arc`, all of the
/// process's memory is free again.
/// Wait for the (exited) process's threads to be freed, then remove the
/// process from the table.
// wait4 options.
pub const WNOHANG: u64 = 1;
pub const WUNTRACED: u64 = 2;
pub const WCONTINUED: u64 = 8;
/// Linux's "wait for threads too" flags: accepted, nothing to do here.
const WALL_FLAGS: u64 = 0x2000_0000 | 0x4000_0000 | 0x8000_0000;
/// Kernel-side wait for one child (the tests use it): EAGAIN with WNOHANG
/// while it runs.
/// What wait4 found.
/// wait4(pid, *status, options): wait for a child to exit (or, with
/// WUNTRACED / WCONTINUED, to stop / continue). `pid` > 0: that child;
/// -1: any child; 0: any child in my process group; < -1: any child in
/// group -pid. Returns (pid, status), or pid 0 with WNOHANG and no news.
/// fork (and vfork / basic clone): a new process, a copy of `parent`, that
/// starts by returning from the same syscall with rax = 0. `stack`: a new
/// stack pointer for the child (clone), or 0 = the same.
/// clone(CLONE_THREAD ...): a new thread in process `p`, starting like the
/// caller returning from clone with rax = 0, on stack `stack`, with TLS
/// pointer `tls` (if Some). Returns its tid, which is also written to the
/// user addresses in `set_tid` (CLONE_PARENT_SETTID / CHILD_SETTID) before
/// the thread can run.
/// execve in a process with several threads: the others must go first
/// (the new program starts with one thread). Linux calls this de_thread.
/// execve, after the arguments have been copied in: replace the current
/// program. `frame` gets the new program's registers.
/// setpgid(pid, pgid): move process `pid` (0 = me; myself or a child of
/// mine) into group `pgid` (0 = a new group named after it). The group
/// must exist unless it's the new one.
/// setsid(): start a new session (and process group) led by `p`, with no
/// controlling terminal yet (the next terminal it opens becomes one, see
/// tty.rs). A process-group leader can't: its group would straddle two
/// sessions -- which is why getty forks first.
/// Send `sig` from the kernel to group `pgid` (Ctrl+C, Ctrl+Z).
|