mirror of
https://github.com/rcore-os/rCore-Tutorial-v3.git
synced 2024-11-28 12:23:36 +04:00
18 lines
8.9 KiB
HTML
18 lines
8.9 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="The main module and entrypoint"><title>os - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Bold-a2c9cd1067f8b328.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-fa3bb1812debf86c.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="os" data-themes="" data-resource-suffix="" data-rustdoc-version="1.75.0-nightly (bf9a1c8a1 2023-10-08)" data-channel="nightly" data-search-js="search-5f5ec5419eadd0c9.js" data-settings-js="settings-74424d7eec62a23e.js" ><script src="../static.files/storage-fec3eaa3851e447d.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-c5bd66d33317d69f.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-5d8b3c7633ad77ba.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="logo-container" href="../os/index.html"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a></nav><nav class="sidebar"><a class="logo-container" href="../os/index.html"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2 class="location"><a href="#">Crate os</a></h2><div class="sidebar-elems"><ul class="block"><li class="version">Version 0.1.0</li><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#modules">Modules</a></li><li><a href="#macros">Macros</a></li><li><a href="#functions">Functions</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Crate <a class="mod" href="#">os</a><button id="copy-path" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/os/main.rs.html#1-80">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The main module and entrypoint</p>
|
||
<p>Various facilities of the kernels are implemented as submodules. The most
|
||
important ones are:</p>
|
||
<ul>
|
||
<li><a href="trap/index.html" title="mod os::trap"><code>trap</code></a>: Handles all cases of switching from userspace to the kernel</li>
|
||
<li><a href="task/index.html" title="mod os::task"><code>task</code></a>: Task management</li>
|
||
<li><a href="syscall/index.html" title="mod os::syscall"><code>syscall</code></a>: System call handling and implementation</li>
|
||
<li><a href="mm/index.html" title="mod os::mm"><code>mm</code></a>: Address map using SV39</li>
|
||
<li><a href="sync/index.html" title="mod os::sync"><code>sync</code></a>: Wrap a static data structure inside it so that we are able to access it without any <code>unsafe</code>.</li>
|
||
<li><a href="fs/index.html" title="mod os::fs"><code>fs</code></a>: Separate user from file system with some structures</li>
|
||
</ul>
|
||
<p>The operating system also starts in this module. Kernel code starts
|
||
executing from <code>entry.asm</code>, after which <a href="fn.rust_main.html" title="fn os::rust_main"><code>rust_main()</code></a> is called to
|
||
initialize various pieces of functionality. (See its source code for
|
||
details.)</p>
|
||
<p>We then call <a href="task/processor/fn.run_tasks.html" title="fn os::task::processor::run_tasks"><code>task::run_tasks()</code></a> and for the first time go to
|
||
userspace.</p>
|
||
</div></details><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="board/index.html" title="mod os::board">board</a><span title="Restricted Visibility"> 🔒</span> </div></li><li><div class="item-name"><a class="mod" href="config/index.html" title="mod os::config">config</a><span title="Restricted Visibility"> 🔒</span> </div><div class="desc docblock-short">Constants used in rCore</div></li><li><div class="item-name"><a class="mod" href="console/index.html" title="mod os::console">console</a><span title="Restricted Visibility"> 🔒</span> </div><div class="desc docblock-short">SBI console driver, for text output</div></li><li><div class="item-name"><a class="mod" href="drivers/index.html" title="mod os::drivers">drivers</a><span title="Restricted Visibility"> 🔒</span> </div></li><li><div class="item-name"><a class="mod" href="fs/index.html" title="mod os::fs">fs</a></div><div class="desc docblock-short">File system in os</div></li><li><div class="item-name"><a class="mod" href="lang_items/index.html" title="mod os::lang_items">lang_items</a></div><div class="desc docblock-short">The panic handler</div></li><li><div class="item-name"><a class="mod" href="mm/index.html" title="mod os::mm">mm</a></div><div class="desc docblock-short">Memory management implementation</div></li><li><div class="item-name"><a class="mod" href="sbi/index.html" title="mod os::sbi">sbi</a></div><div class="desc docblock-short">SBI call wrappers</div></li><li><div class="item-name"><a class="mod" href="sync/index.html" title="mod os::sync">sync</a></div><div class="desc docblock-short">Synchronization and interior mutability primitives</div></li><li><div class="item-name"><a class="mod" href="syscall/index.html" title="mod os::syscall">syscall</a></div><div class="desc docblock-short">Implementation of syscalls</div></li><li><div class="item-name"><a class="mod" href="task/index.html" title="mod os::task">task</a></div><div class="desc docblock-short">Task management implementation</div></li><li><div class="item-name"><a class="mod" href="timer/index.html" title="mod os::timer">timer</a></div><div class="desc docblock-short">RISC-V timer-related functionality</div></li><li><div class="item-name"><a class="mod" href="trap/index.html" title="mod os::trap">trap</a></div><div class="desc docblock-short">Trap handling functionality</div></li></ul><h2 id="macros" class="small-section-header"><a href="#macros">Macros</a></h2><ul class="item-table"><li><div class="item-name"><a class="macro" href="macro.print.html" title="macro os::print">print</a></div><div class="desc docblock-short">print string macro</div></li><li><div class="item-name"><a class="macro" href="macro.println.html" title="macro os::println">println</a></div><div class="desc docblock-short">println string macro</div></li></ul><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.clear_bss.html" title="fn os::clear_bss">clear_bss</a><span title="Restricted Visibility"> 🔒</span> </div><div class="desc docblock-short">clear BSS segment</div></li><li><div class="item-name"><a class="fn" href="fn.rust_main.html" title="fn os::rust_main">rust_main</a></div><div class="desc docblock-short">the rust entry-point of os</div></li></ul></section></div></main></body></html> |