rCore-Tutorial-v3/ch3/os/index.html
2024-05-10 13:16:10 +00:00

15 lines
7.8 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-b21aa549bf6d91ff.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.80.0-nightly (f705de596 2024-04-30)" data-channel="nightly" data-search-js="search-bf21c90c8c1d92b1.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-e32f0c247825364d.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-09095024cf37855e.css"></noscript><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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../os/index.html">os</a><span class="version">0.1.0</span></h2></div><div class="sidebar-elems"><ul class="block"><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><div class="sidebar-resizer"></div><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../os/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Type S or / to search, ? for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings">Settings</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">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../src/os/main.rs.html#1-67">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</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>
</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/fn.run_first_task.html" title="fn os::task::run_first_task"><code>task::run_first_task()</code></a> and for the first time go to
userspace.</p>
</div></details><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</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">&nbsp;🔒</span> </div><div class="desc docblock-short">Constants used in rCore for qemu</div></li><li><div class="item-name"><a class="mod" href="config/index.html" title="mod os::config">config</a><span title="Restricted Visibility">&nbsp;🔒</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">&nbsp;🔒</span> </div><div class="desc docblock-short">SBI console driver, for text output</div></li><li><div class="item-name"><a class="mod" href="lang_items/index.html" title="mod os::lang_items">lang_items</a><span title="Restricted Visibility">&nbsp;🔒</span> </div><div class="desc docblock-short">The panic handler</div></li><li><div class="item-name"><a class="mod" href="loader/index.html" title="mod os::loader">loader</a><span title="Restricted Visibility">&nbsp;🔒</span> </div><div class="desc docblock-short">Loading user applications into memory</div></li><li><div class="item-name"><a class="mod" href="sbi/index.html" title="mod os::sbi">sbi</a><span title="Restricted Visibility">&nbsp;🔒</span> </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><span title="Restricted Visibility">&nbsp;🔒</span> </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><span title="Restricted Visibility">&nbsp;🔒</span> </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="section-header">Macros<a href="#macros" class="anchor">§</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="section-header">Functions<a href="#functions" class="anchor">§</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">&nbsp;🔒</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>