<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="Task management implementation"><metaname="keywords"content="rust, rustlang, rust-lang, task"><title>os::task - Rust</title><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../SourceSerif4-Regular.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../FiraSans-Regular.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../FiraSans-Medium.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../SourceCodePro-Regular.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../SourceSerif4-Bold.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../SourceCodePro-Semibold.ttf.woff2"><linkrel="stylesheet"type="text/css"href="../../normalize.css"><linkrel="stylesheet"type="text/css"href="../../rustdoc.css"id="mainThemeStyle"><linkrel="stylesheet"type="text/css"href="../../ayu.css"disabled><linkrel="stylesheet"type="text/css"href="../../dark.css"disabled><linkrel="stylesheet"type="text/css"href="../../light.css"id="themeStyle"><scriptid="default-settings"></script><scriptsrc="../../storage.js"></script><scriptdefersrc="../../main.js"></script><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"></h2></nav><navclass="sidebar"><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 task</a></h2><divclass="sidebar-elems"><section><divclass="block"><ul><li><ahref="#modules">Modules</a></li><li><ahref="#structs">Structs</a></li><li><ahref="#constants">Constants</a></li><li><ahref="#functions">Functions</a></li></ul></div></section></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"><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"><divid="help-button"title="help"tabindex="-1"><buttontype="button">?</button></div><divid="settings-menu"tabindex="-1"><ahref="../../settings.html"title="settings"><imgwidth="22"height="22"alt="Change settings"src="../../wheel.svg"></a></div></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="#">task</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/task/mod.rs.html#1-121">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>Task management implementation</p>
<p>Everything about task management, like starting and switching tasks is
implemented here.</p>
<p>A single global instance of <ahref="manager/struct.TaskManager.html"title="TaskManager"><code>TaskManager</code></a> called <code>TASK_MANAGER</code> controls
<p>A single global instance of <ahref="processor/struct.Processor.html"title="Processor"><code>Processor</code></a> called <code>PROCESSOR</code> monitors running
task(s) for each core.</p>
<p>A single global instance of <ahref="pid/struct.PidAllocator.html"title="PidAllocator"><code>PidAllocator</code></a> called <code>PID_ALLOCATOR</code> allocates
</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="mod"href="manager/index.html"title="os::task::manager mod">manager</a><spantitle="Restricted Visibility"> 🔒</span></div><divclass="item-right docblock-short"><p>Implementation of <ahref="manager/struct.TaskManager.html"title="TaskManager"><code>TaskManager</code></a></p>
</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="mod"href="pid/index.html"title="os::task::pid mod">pid</a><spantitle="Restricted Visibility"> 🔒</span></div><divclass="item-right docblock-short"><p>Implementation of <ahref="pid/struct.PidAllocator.html"title="PidAllocator"><code>PidAllocator</code></a></p>
</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="mod"href="processor/index.html"title="os::task::processor mod">processor</a><spantitle="Restricted Visibility"> 🔒</span></div><divclass="item-right docblock-short"><p>Implementation of <ahref="processor/struct.Processor.html"title="Processor"><code>Processor</code></a> and Intersection of control flow</p>
</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="mod"href="switch/index.html"title="os::task::switch mod">switch</a><spantitle="Restricted Visibility"> 🔒</span></div><divclass="item-right docblock-short"><p>Wrap <code>switch.S</code> as a function</p>
</div></div></div><h2id="structs"class="small-section-header"><ahref="#structs">Structs</a></h2><divclass="item-table"><divclass="item-row"><divclass="item-left module-item"><aclass="struct"href="struct.INITPROC.html"title="os::task::INITPROC struct">INITPROC</a></div><divclass="item-right docblock-short"><p>Globle process that init user shell</p>
</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="struct"href="struct.TaskContext.html"title="os::task::TaskContext struct">TaskContext</a></div><divclass="item-right docblock-short"><p>task context structure containing some registers</p>
</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="struct"href="struct.TaskManager.html"title="os::task::TaskManager struct">TaskManager</a></div><divclass="item-right docblock-short"><p>A array of <code>TaskControlBlock</code> that is thread-safe</p>
</div></div></div><h2id="constants"class="small-section-header"><ahref="#constants">Constants</a></h2><divclass="item-table"><divclass="item-row"><divclass="item-left module-item"><aclass="constant"href="constant.IDLE_PID.html"title="os::task::IDLE_PID constant">IDLE_PID</a></div><divclass="item-right docblock-short"><p>pid of usertests app in make run TEST=1</p>
</div></div></div><h2id="functions"class="small-section-header"><ahref="#functions">Functions</a></h2><divclass="item-table"><divclass="item-row"><divclass="item-left module-item"><aclass="fn"href="fn.add_initproc.html"title="os::task::add_initproc fn">add_initproc</a></div><divclass="item-right docblock-short"><p>Add init process to the manager</p>
</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="fn"href="fn.current_trap_cx.html"title="os::task::current_trap_cx fn">current_trap_cx</a></div><divclass="item-right docblock-short"><p>Get the mutable reference to trap context of current task</p>
</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="fn"href="fn.current_user_token.html"title="os::task::current_user_token fn">current_user_token</a></div><divclass="item-right docblock-short"><p>Get token of the address space of current task</p>
</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="fn"href="fn.exit_current_and_run_next.html"title="os::task::exit_current_and_run_next fn">exit_current_and_run_next</a></div><divclass="item-right docblock-short"><p>Exit the current ‘Running’ task and run the next task in task list.</p>
</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="fn"href="fn.fetch_task.html"title="os::task::fetch_task fn">fetch_task</a></div><divclass="item-right docblock-short"><p>Interface offered to pop the first task</p>
</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="fn"href="fn.pid_alloc.html"title="os::task::pid_alloc fn">pid_alloc</a></div><divclass="item-right docblock-short"><p>Allocate a pid from PID_ALLOCATOR</p>
</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="fn"href="fn.run_tasks.html"title="os::task::run_tasks fn">run_tasks</a></div><divclass="item-right docblock-short"><p>The main part of process execution and scheduling
Loop <code>fetch_task</code> to get the process that needs to run, and switch the process through <code>__switch</code></p>
</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="fn"href="fn.schedule.html"title="os::task::schedule fn">schedule</a></div><divclass="item-right docblock-short"><p>Return to idle control flow for new scheduling</p>
</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="fn"href="fn.suspend_current_and_run_next.html"title="os::task::suspend_current_and_run_next fn">suspend_current_and_run_next</a></div><divclass="item-right docblock-short"><p>Suspend the current ‘Running’ task and run the next task in task list.</p>
</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="fn"href="fn.take_current_task.html"title="os::task::take_current_task fn">take_current_task</a></div><divclass="item-right docblock-short"><p>Take the current task,leaving a None in its place</p>
