andrey/rCore-Tutorial-v3
1
0
Fork 0
mirror of https://github.com/rcore-os/rCore-Tutorial-v3.git synced 2024-11-25 02:46:23 +04:00
Code Issues Projects Releases Wiki Activity
58adc56a1d
rCore-Tutorial-v3/ch6-dev/os/mm/index.html
chyyuu c18613b564 deploy: 39037a97ca
2022-06-23 17:29:35 +00:00

45 lines
13 KiB
HTML
Raw 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="Memory management implementation"><meta name="keywords" content="rust, rustlang, rust-lang, mm"><title>os::mm - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script src="../../crates.js"></script><script defer src="../../main.js"></script>
<noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc mod"><!--[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">&#9776;</button><a class="sidebar-logo" href="../../os/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div>
</a><h2 class="location"></h2>
</nav>
<nav class="sidebar"><a class="sidebar-logo" href="../../os/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div>
</a><h2 class="location"><a href="#">Module mm</a></h2><div class="sidebar-elems"><section><div class="block"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></div></section><div id="sidebar-vars" data-name="mm" data-ty="mod" data-relpath="./"></div><script defer src="./sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../os/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><div class="theme-picker hidden"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="22" height="22" alt="Pick another theme!" src="../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><div class="main-heading">
<h1 class="fqn"><span class="in-band">Module <a href="../index.html">os</a>::<wbr><a class="mod" href="#">mm</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/os/mm/mod.rs.html#1-29">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Memory management implementation</p>
<p>SV39 page-based virtual-memory architecture for RV64 systems, and
everything about memory management, like frame allocator, page table,
map area and memory set, is implemented here.</p>
<p>Every task or process has a memory_set to control its virtual memory.</p>
</div></details><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="address/index.html" title="os::mm::address mod">address</a><span title="Restricted Visibility">&nbsp;🔒</span> </div><div class="item-right docblock-short"><p>Implementation of physical and virtual address and page number.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="frame_allocator/index.html" title="os::mm::frame_allocator mod">frame_allocator</a><span title="Restricted Visibility">&nbsp;🔒</span> </div><div class="item-right docblock-short"><p>Implementation of <a href="frame_allocator/trait.FrameAllocator.html" title="FrameAllocator"><code>FrameAllocator</code></a> which
controls all the frames in the operating system.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="heap_allocator/index.html" title="os::mm::heap_allocator mod">heap_allocator</a><span title="Restricted Visibility">&nbsp;🔒</span> </div><div class="item-right docblock-short"><p>The global allocator</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="memory_set/index.html" title="os::mm::memory_set mod">memory_set</a><span title="Restricted Visibility">&nbsp;🔒</span> </div><div class="item-right docblock-short"><p>Implementation of <a href="memory_set/struct.MapArea.html" title="MapArea"><code>MapArea</code></a> and <a href="memory_set/struct.MemorySet.html" title="MemorySet"><code>MemorySet</code></a>.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="page_table/index.html" title="os::mm::page_table mod">page_table</a><span title="Restricted Visibility">&nbsp;🔒</span> </div><div class="item-right docblock-short"><p>Implementation of <a href="page_table/struct.PageTableEntry.html" title="PageTableEntry"><code>PageTableEntry</code></a> and <a href="page_table/struct.PageTable.html" title="PageTable"><code>PageTable</code></a>.</p>
</div></div></div><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.FrameTracker.html" title="os::mm::FrameTracker struct">FrameTracker</a></div><div class="item-right docblock-short"><p>manage a frame which has the same lifecycle as the tracker</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.KERNEL_SPACE.html" title="os::mm::KERNEL_SPACE struct">KERNEL_SPACE</a></div><div class="item-right docblock-short"><p>a memory set instance through lazy_static! managing kernel space</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.MapPermission.html" title="os::mm::MapPermission struct">MapPermission</a></div><div class="item-right docblock-short"><p>map permission corresponding to that in pte: <code>R W X U</code></p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.MemorySet.html" title="os::mm::MemorySet struct">MemorySet</a></div><div class="item-right docblock-short"><p>memory set structure, controls virtual-memory space</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.PageTable.html" title="os::mm::PageTable struct">PageTable</a></div><div class="item-right docblock-short"><p>Record root ppn and has the same lifetime as 1 and 2 level <code>PageTableEntry</code></p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.PageTableEntry.html" title="os::mm::PageTableEntry struct">PageTableEntry</a></div><div class="item-right docblock-short"><p>page table entry structure</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.PhysAddr.html" title="os::mm::PhysAddr struct">PhysAddr</a></div><div class="item-right docblock-short"><p>Definitions</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.PhysPageNum.html" title="os::mm::PhysPageNum struct">PhysPageNum</a></div><div class="item-right docblock-short"><p>phiscal page number</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.UserBuffer.html" title="os::mm::UserBuffer struct">UserBuffer</a></div><div class="item-right docblock-short"><p>Array of u8 slice that user communicate with os</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.UserBufferIterator.html" title="os::mm::UserBufferIterator struct">UserBufferIterator</a></div><div class="item-right docblock-short"><p>Iterator of <code>UserBuffer</code></p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.VirtAddr.html" title="os::mm::VirtAddr struct">VirtAddr</a></div><div class="item-right docblock-short"><p>virtual address</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.VirtPageNum.html" title="os::mm::VirtPageNum struct">VirtPageNum</a></div><div class="item-right docblock-short"><p>virtual page number</p>
</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.StepByOne.html" title="os::mm::StepByOne trait">StepByOne</a></div><div class="item-right docblock-short"><p>Add value by one</p>
</div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.frame_alloc.html" title="os::mm::frame_alloc fn">frame_alloc</a></div><div class="item-right docblock-short"><p>allocate a frame</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.frame_dealloc.html" title="os::mm::frame_dealloc fn">frame_dealloc</a></div><div class="item-right docblock-short"><p>deallocate a frame</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.init.html" title="os::mm::init fn">init</a></div><div class="item-right docblock-short"><p>initiate heap allocator, frame allocator and kernel space</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.kernel_token.html" title="os::mm::kernel_token fn">kernel_token</a></div><div class="item-right docblock-short"><p>Get kernelspace root ppn</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.remap_test.html" title="os::mm::remap_test fn">remap_test</a></div><div class="item-right docblock-short"><p>Check PageTable running correctly</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.translated_byte_buffer.html" title="os::mm::translated_byte_buffer fn">translated_byte_buffer</a></div><div class="item-right docblock-short"><p>Translate a pointer to a mutable u8 Vec through page table</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.translated_ref.html" title="os::mm::translated_ref fn">translated_ref</a></div><div class="item-right docblock-short"><p>Translate a generic through page table and return a reference</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.translated_refmut.html" title="os::mm::translated_refmut fn">translated_refmut</a></div><div class="item-right docblock-short"><p>Translate a generic through page table and return a mutable reference</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.translated_str.html" title="os::mm::translated_str fn">translated_str</a></div><div class="item-right docblock-short"><p>Translate a pointer to a mutable u8 Vec end with <code>\0</code> through page table to a <code>String</code></p>
</div></div></div></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="os" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.62.0-nightly (1f7fb6413 2022-04-10)" ></div>
</body></html>
Reference in New Issue View Git Blame Copy Permalink