os/kernel/pmem_8c.html

324 lines
14 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.18"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MyOS Kernel: kernel/pmem.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">MyOS Kernel
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.18 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('pmem_8c.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">pmem.c File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;cpu/arch_consts.h&quot;</code><br />
<code>#include &quot;<a class="el" href="halt_8h_source.html">cpu/halt.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="vga__err_8h_source.html">vga_err.h</a>&quot;</code><br />
<code>#include &lt;grub/multiboot2.h&gt;</code><br />
<code>#include &lt;klog.h&gt;</code><br />
<code>#include &lt;stdint.h&gt;</code><br />
<code>#include &lt;stdlib.h&gt;</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:aca4e97eba3a74444d35f0e7c77927941"><td class="memItemLeft" align="right" valign="top"><a id="aca4e97eba3a74444d35f0e7c77927941"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pmem_8c.html#aca4e97eba3a74444d35f0e7c77927941">BMAP_LEN</a>&#160;&#160;&#160;(NUM_FRAMES/8)</td></tr>
<tr class="memdesc:aca4e97eba3a74444d35f0e7c77927941"><td class="mdescLeft">&#160;</td><td class="mdescRight">The size of the physical memory manager's bitmap. <br /></td></tr>
<tr class="separator:aca4e97eba3a74444d35f0e7c77927941"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a93795a6c0110c3e7ebfec6e443ac5b47"><td class="memItemLeft" align="right" valign="top">static char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pmem_8c.html#a93795a6c0110c3e7ebfec6e443ac5b47">get_bmap_bit</a> (int index)</td></tr>
<tr class="separator:a93795a6c0110c3e7ebfec6e443ac5b47"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a11ed75ad6967efb05a974760be595f28"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pmem_8c.html#a11ed75ad6967efb05a974760be595f28">set_bmap_bit</a> (int index)</td></tr>
<tr class="separator:a11ed75ad6967efb05a974760be595f28"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab5b67f20de16b28be3a3d7a6bd81c65b"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pmem_8c.html#ab5b67f20de16b28be3a3d7a6bd81c65b">clear_bmap_bit</a> (int index)</td></tr>
<tr class="separator:ab5b67f20de16b28be3a3d7a6bd81c65b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a26e65460b81ea0f98525b78008ffc68a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pmem_8c.html#a26e65460b81ea0f98525b78008ffc68a">pmem_init</a> (struct multiboot_boot_header_tag *tags)</td></tr>
<tr class="separator:a26e65460b81ea0f98525b78008ffc68a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b873206647239e8d86cb97a81b9e390"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pmem_8c.html#a8b873206647239e8d86cb97a81b9e390">pmem_alloc</a> (int num_pages)</td></tr>
<tr class="separator:a8b873206647239e8d86cb97a81b9e390"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac844821dd2844e8fa803f927311f1051"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pmem_8c.html#ac844821dd2844e8fa803f927311f1051">pmem_free</a> (int start_page, int num_pages)</td></tr>
<tr class="separator:ac844821dd2844e8fa803f927311f1051"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a6aae539dedee94e981912da495a36707"><td class="memItemLeft" align="right" valign="top"><a id="a6aae539dedee94e981912da495a36707"></a>
static char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pmem_8c.html#a6aae539dedee94e981912da495a36707">bmap</a> [<a class="el" href="pmem_8c.html#aca4e97eba3a74444d35f0e7c77927941">BMAP_LEN</a>]</td></tr>
<tr class="memdesc:a6aae539dedee94e981912da495a36707"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bitmap of allocated/non-present page frames. <br /></td></tr>
<tr class="separator:a6aae539dedee94e981912da495a36707"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ab5b67f20de16b28be3a3d7a6bd81c65b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab5b67f20de16b28be3a3d7a6bd81c65b">&#9670;&nbsp;</a></span>clear_bmap_bit()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void clear_bmap_bit </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>index</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Clear a bit in the heap bitmap </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>The bit to clear </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a93795a6c0110c3e7ebfec6e443ac5b47"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a93795a6c0110c3e7ebfec6e443ac5b47">&#9670;&nbsp;</a></span>get_bmap_bit()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static char get_bmap_bit </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>index</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a bit in the bitmap </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>The bit to get </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the bit </dd></dl>
</div>
</div>
<a id="a8b873206647239e8d86cb97a81b9e390"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b873206647239e8d86cb97a81b9e390">&#9670;&nbsp;</a></span>pmem_alloc()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* pmem_alloc </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>num_pages</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Allocate physical frames </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">num_pages</td><td>The number of frames to allocate </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the physical address of the allocated frames </dd></dl>
</div>
</div>
<a id="ac844821dd2844e8fa803f927311f1051"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac844821dd2844e8fa803f927311f1051">&#9670;&nbsp;</a></span>pmem_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void pmem_free </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>start_page</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>num_pages</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free allocated physical frames </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">start_page</td><td>The frame to start freeing at. </td></tr>
<tr><td class="paramname">num_pages</td><td>The number of frames to free </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a26e65460b81ea0f98525b78008ffc68a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a26e65460b81ea0f98525b78008ffc68a">&#9670;&nbsp;</a></span>pmem_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void pmem_init </td>
<td>(</td>
<td class="paramtype">struct multiboot_boot_header_tag *&#160;</td>
<td class="paramname"><em>tags</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the physical memory manager </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">tags</td><td>The multiboot header </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a11ed75ad6967efb05a974760be595f28"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a11ed75ad6967efb05a974760be595f28">&#9670;&nbsp;</a></span>set_bmap_bit()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void set_bmap_bit </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>index</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a bit in the heap bitmap </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>The bit to set </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_dc43877d82dd332f9fb2071fcca799d6.html">kernel</a></li><li class="navelem"><a class="el" href="pmem_8c.html">pmem.c</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.18 </li>
</ul>
</div>
</body>
</html>