<noscript><linkrel="stylesheet"href="../../noscript.css"></noscript><linkrel="alternate icon"type="image/png"href="../../favicon-16x16.png"><linkrel="alternate icon"type="image/png"href="../../favicon-32x32.png"><linkrel="icon"type="image/svg+xml"href="../../favicon.svg"></head><bodyclass="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="mobile-topbar"><buttonclass="sidebar-menu-toggle">☰</button><aclass="sidebar-logo"href="../../os/index.html"><divclass="logo-container"><imgclass="rust-logo"src="../../rust-logo.svg"alt="logo"></div>
</a><h2class="location"><ahref="#">Module mm</a></h2><divclass="sidebar-elems"><section><divclass="block"><ul><li><ahref="#modules">Modules</a></li><li><ahref="#structs">Structs</a></li><li><ahref="#traits">Traits</a></li><li><ahref="#functions">Functions</a></li></ul></div></section><divid="sidebar-vars"data-name="mm"data-ty="mod"data-relpath="./"></div><scriptdefersrc="./sidebar-items.js"></script></div></nav><main><divclass="width-limiter"><divclass="sub-container"><aclass="sub-logo-container"href="../../os/index.html"><imgclass="rust-logo"src="../../rust-logo.svg"alt="logo"></a><navclass="sub"><divclass="theme-picker hidden"><buttonid="theme-picker"aria-label="Pick another theme!"aria-haspopup="menu"title="themes"><imgwidth="22"height="22"alt="Pick another theme!"src="../../brush.svg"></button><divid="theme-choices"role="menu"></div></div><formclass="search-form"><divclass="search-container"><span></span><inputclass="search-input"name="search"autocomplete="off"spellcheck="false"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"><buttontype="button"id="help-button"title="help">?</button><aid="settings-menu"href="../../settings.html"title="settings"><imgwidth="22"height="22"alt="Change settings"src="../../wheel.svg"></a></div></form></nav></div><sectionid="main-content"class="content"><divclass="main-heading">
<h1class="fqn"><spanclass="in-band">Module <ahref="../index.html">os</a>::<wbr><aclass="mod"href="#">mm</a><buttonid="copy-path"onclick="copy_path(this)"title="Copy item path to clipboard"><imgsrc="../../clipboard.svg"width="19"height="18"alt="Copy item path"></button></span></h1><spanclass="out-of-band"><aclass="srclink"href="../../src/os/mm/mod.rs.html#1-29">source</a> · <aid="toggle-all-docs"href="javascript:void(0)"title="collapse all docs">[<spanclass="inner">−</span>]</a></span></div><detailsclass="rustdoc-toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="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>
<divclass="item-table"><divclass="item-row"><divclass="item-left module-item"><aclass="mod"href="address/index.html"title="os::mm::address mod">address</a><spantitle="Restricted Visibility"> 🔒</span></div><divclass="item-right docblock-short"><p>Implementation of physical and virtual address and page number.</p>
</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="mod"href="frame_allocator/index.html"title="os::mm::frame_allocator mod">frame_allocator</a><spantitle="Restricted Visibility"> 🔒</span></div><divclass="item-right docblock-short"><p>Implementation of <ahref="frame_allocator/trait.FrameAllocator.html"title="FrameAllocator"><code>FrameAllocator</code></a> which
controls all the frames in the operating system.</p>
</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="mod"href="heap_allocator/index.html"title="os::mm::heap_allocator mod">heap_allocator</a><spantitle="Restricted Visibility"> 🔒</span></div><divclass="item-right docblock-short"><p>The global allocator</p>
</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="mod"href="memory_set/index.html"title="os::mm::memory_set mod">memory_set</a><spantitle="Restricted Visibility"> 🔒</span></div><divclass="item-right docblock-short"><p>Implementation of <ahref="memory_set/struct.MapArea.html"title="MapArea"><code>MapArea</code></a> and <ahref="memory_set/struct.MemorySet.html"title="MemorySet"><code>MemorySet</code></a>.</p>
</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="mod"href="page_table/index.html"title="os::mm::page_table mod">page_table</a><spantitle="Restricted Visibility"> 🔒</span></div><divclass="item-right docblock-short"><p>Implementation of <ahref="page_table/struct.PageTableEntry.html"title="PageTableEntry"><code>PageTableEntry</code></a> and <ahref="page_table/struct.PageTable.html"title="PageTable"><code>PageTable</code></a>.</p>
<divclass="item-table"><divclass="item-row"><divclass="item-left module-item"><aclass="struct"href="struct.FrameTracker.html"title="os::mm::FrameTracker struct">FrameTracker</a></div><divclass="item-right docblock-short"><p>manage a frame which has the same lifecycle as the tracker</p>
</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="struct"href="struct.KERNEL_SPACE.html"title="os::mm::KERNEL_SPACE struct">KERNEL_SPACE</a></div><divclass="item-right docblock-short"><p>a memory set instance through lazy_static! managing kernel space</p>
</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="struct"href="struct.MapPermission.html"title="os::mm::MapPermission struct">MapPermission</a></div><divclass="item-right docblock-short"><p>map permission corresponding to that in pte: <code>R W X U</code></p>
</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="struct"href="struct.MemorySet.html"title="os::mm::MemorySet struct">MemorySet</a></div><divclass="item-right docblock-short"><p>memory set structure, controls virtual-memory space</p>
</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="struct"href="struct.PageTable.html"title="os::mm::PageTable struct">PageTable</a></div><divclass="item-right docblock-short"><p>Record root ppn and has the same lifetime as 1 and 2 level <code>PageTableEntry</code></p>
</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="struct"href="struct.UserBuffer.html"title="os::mm::UserBuffer struct">UserBuffer</a></div><divclass="item-right docblock-short"><p>Array of u8 slice that user communicate with os</p>
</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="struct"href="struct.UserBufferIterator.html"title="os::mm::UserBufferIterator struct">UserBufferIterator</a></div><divclass="item-right docblock-short"><p>Iterator of <code>UserBuffer</code></p>
<divclass="item-table"><divclass="item-row"><divclass="item-left module-item"><aclass="trait"href="trait.StepByOne.html"title="os::mm::StepByOne trait">StepByOne</a></div><divclass="item-right docblock-short"><p>Add value by one</p>
</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="fn"href="fn.translated_byte_buffer.html"title="os::mm::translated_byte_buffer fn">translated_byte_buffer</a></div><divclass="item-right docblock-short"><p>Translate a pointer to a mutable u8 Vec through page table</p>
</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="fn"href="fn.translated_ref.html"title="os::mm::translated_ref fn">translated_ref</a></div><divclass="item-right docblock-short"><p>Translate a generic through page table and return a reference</p>
</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="fn"href="fn.translated_refmut.html"title="os::mm::translated_refmut fn">translated_refmut</a></div><divclass="item-right docblock-short"><p>Translate a generic through page table and return a mutable reference</p>
</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="fn"href="fn.translated_str.html"title="os::mm::translated_str fn">translated_str</a></div><divclass="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>
