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 | //! VFS (virtual file system): the layer every concrete file system plugs into.
//!
//! Modelled (very loosely) on Linux:
//!
//! * [`Inode`] -- one file or directory *inside some file system*. Knows how to
//! read/write its bytes at an offset and (for directories) look up, create,
//! list and remove children. ramfs, FAT32, ext2, exFAT and (read-only)
//! btrfs implement it.
//! * [`FileSystem`] -- a mounted instance (e.g. "the FAT32 volume on vda1");
//! gives you its root inode.
//! * the **mount table** -- which file system is attached at which path ("/",
//! "/tmp", "/mnt/disk0"). `lookup("/tmp/x")` finds the longest matching
//! mount point and walks the rest of the path from that file system's root.
//! * [`file::File`] -- an *open* file (what a file descriptor points to): an
//! inode plus a current offset, or the console, or a pipe. The per-process
//! fd table holds `Arc<dyn File>`s, so syscalls don't care what's behind it.
//!
//! Paths: every path is first turned into a clean absolute path by
//! [`normalize`] (relative paths are joined to the process's current
//! directory; ".", ".." and "//" are resolved by plain string processing).
//! That makes ".." work across mount points for free. Real kernels track
//! parent dentries instead.
//!
//! Symlinks (ext2 has them): [`lookup`] follows them. When a path component
//! is a symlink, its target is joined to the directory the link is in, the
//! rest of the path is appended, and the lookup starts over (at most 8
//! times, then ELOOP). Since ".." is handled as text, `link/..` is the
//! directory holding `link`, not the parent of the link's target. Linux does
//! the latter; ours is simpler and fine for a hobby kernel.
use crateErrno;
use ;
use Mutex;
/// One entry of a directory listing.
/// A file or directory inside a file system.
///
/// Default method bodies return the error a "wrong kind" of inode would give
/// (e.g. `lookup` on a file -> ENOTDIR), so implementations only override
/// what makes sense for them.
/// Downcast an inode to a file system's own type (stage 17).
/// What statfs/fstatfs report about a file system (stage 17).
pub const RAMFS_MAGIC: u64 = 0x8584_58f6;
pub const TMPFS_MAGIC: u64 = 0x0102_1994;
pub const EXT2_MAGIC: u64 = 0xEF53;
pub const MSDOS_MAGIC: u64 = 0x4d44;
pub const EXFAT_MAGIC: u64 = 0x2011_BAB0;
pub const BTRFS_MAGIC: u64 = 0x9123_683E;
/// The wall-clock time as [seconds, nanoseconds] since 1970 (file times).
/// `Inode::mode` of a file whose mode was set to exactly 0 with chmod
/// (plain 0 means "this file system has no permissions").
pub const MODE_SET: u32 = 1 << 31;
/// A mounted file system.
/// The mount table. Lookups take the lock only briefly (never while doing
/// I/O), so it's fine as a spinlock. Not used from interrupt handlers.
static MOUNTS: = new;
/// Attach `fs` at `path` (absolute, like "/" or "/tmp").
/// (mount path, fs type) of every mount, for printing.
/// Does mount point `mount` contain `path`? ("/tmp" contains "/tmp/x" but
/// not "/tmpfoo"; "/" contains everything.)
/// Turn `path` into a clean absolute path. Relative paths start at `cwd`
/// (which must be absolute). "." is dropped, ".." removes the previous
/// component (".." of "/" is "/", like Unix).
/// normalize("/home", "../etc//motd") == "/etc/motd"
/// Resolve an absolute path to an inode, following symlinks.
/// Like [`lookup`] (or `lookup_nofollow`), but also say where the inode
/// really is: the path with every symlink on the way replaced by its
/// target (stage 18). stat uses it for st_dev (a link on one file system
/// can point into another), and Unix sockets for their key.
/// Like [`lookup`], but if the *last* component is a symlink, return the
/// link itself (for `readlink`, and for deleting a link, not its target).
/// The target of the symlink at absolute `path`.
/// How many symlinks one lookup may follow (Linux allows 40).
const MAX_SYMLINKS: usize = 8;
/// Split a normalized path into (parent directory inode, last component).
/// Create a file or directory at absolute `path` (parent must exist).
/// Delete the file (`want_dir` false, like `unlink`) or empty directory
/// (`want_dir` true, like `rmdir`) at absolute `path`.
/// The mount point `path` (absolute, normalized) lives under.
/// The file system `path` lives on and its place in the mount table
/// (stage 17: statfs, and st_dev = place + 1 so that inode numbers of
/// different file systems never look like the same file).
/// st_dev for a path: which mounted file system (see `fs_of`).
/// symlink(target, path): a new symlink at absolute `path` holding
/// `target` exactly as given (it's resolved when the link is followed).
/// link(old, new): a second name for the file at `old` (`follow`: if `old`
/// is a symlink, link what it points to, like linkat's AT_SYMLINK_FOLLOW).
/// Hard-link the inode `src` (found at `src_path`) as `new`.
/// rename(old, new), and renameat2's RENAME_NOREPLACE (`noreplace`: fail
/// with EEXIST instead of replacing `new`).
///
/// ramfs, ext2 and FAT move the directory entry itself (stage 17,
/// `Inode::rename_entry`): any file, symlink or directory, full or not,
/// and hard links stay links. Other file systems (exFAT) get the long way
/// round, enough for "save to a temp file, rename it over the real one":
/// - a file: copy its bytes to `new` (replacing a file there), then
/// delete `old`;
/// - an empty directory: create `new` (or reuse an empty one), delete `old`;
/// - anything else (a non-empty directory, a symlink), or across file
/// systems: EXDEV, which tells `mv` to copy and delete itself, like
/// Linux does across file systems.
/// Neither is atomic like Linux's: a crash in the middle can leave both.
/// Read a whole file into memory (used to load programs).
/// Boot-time file system setup: a ramfs as "/", with a few files, and a
/// second, empty ramfs mounted at "/tmp" (to exercise the mount table).
/// Try to mount every registered partition (and unpartitioned disk) at
/// /mnt/disk0, /mnt/disk1, ... Returns log lines.
///
/// Which driver? Like Linux's `mount` without `-t`, we look for each file
/// system's *magic number*: ext2 has 0xEF53 at byte 56 of its superblock
/// (which starts at byte 1024); exFAT says "EXFAT " at byte 3 of its boot
/// sector; btrfs has "_BHRfS_M" at byte 64 of its superblock (at 64 KiB);
/// anything else is tried as FAT (fatfs checks the boot sector itself).
/// A disk whose driver refuses it (say, a btrfs with sha256 checksums)
/// gets a log line saying why, and no /mnt/diskN.
|