<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Apache Portable Runtime: MMAP (Memory Map) Routines</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="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">Apache Portable Runtime
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- 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="#nested-classes">Data Structures</a> |
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">MMAP (Memory Map) Routines<div class="ingroups"><a class="el" href="group___a_p_r.html">Apache Portability Runtime library</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structapr__mmap__t.html">apr_mmap_t</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gac231fdf15d2d29802e0abbc5d0cf25b8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__mmap.html#gac231fdf15d2d29802e0abbc5d0cf25b8">APR_MMAP_READ</a>   1</td></tr>
<tr class="separator:gac231fdf15d2d29802e0abbc5d0cf25b8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac2eb7f697d8bf190e630b85f967c8273"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__mmap.html#gac2eb7f697d8bf190e630b85f967c8273">APR_MMAP_WRITE</a>   2</td></tr>
<tr class="separator:gac2eb7f697d8bf190e630b85f967c8273"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga19d1916e7b64bfb1a969648fe7b0846a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__mmap.html#ga19d1916e7b64bfb1a969648fe7b0846a">APR_MMAP_THRESHOLD</a>   1</td></tr>
<tr class="separator:ga19d1916e7b64bfb1a969648fe7b0846a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga548e49b3c9e8265ad8ccf70994f4fe25"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__mmap.html#ga548e49b3c9e8265ad8ccf70994f4fe25">APR_MMAP_LIMIT</a>   (4*1024*1024)</td></tr>
<tr class="separator:ga548e49b3c9e8265ad8ccf70994f4fe25"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4f469432098e986567576fd4c4ce5adc"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__mmap.html#ga4f469432098e986567576fd4c4ce5adc">APR_MMAP_CANDIDATE</a>(filelength)   ((filelength >= <a class="el" href="group__apr__mmap.html#ga19d1916e7b64bfb1a969648fe7b0846a">APR_MMAP_THRESHOLD</a>) && (filelength < <a class="el" href="group__apr__mmap.html#ga548e49b3c9e8265ad8ccf70994f4fe25">APR_MMAP_LIMIT</a>))</td></tr>
<tr class="separator:ga4f469432098e986567576fd4c4ce5adc"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga766b01a3e1e0438d06dc88d76f826f80"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structapr__mmap__t.html">apr_mmap_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__mmap.html#ga766b01a3e1e0438d06dc88d76f826f80">apr_mmap_t</a></td></tr>
<tr class="separator:ga766b01a3e1e0438d06dc88d76f826f80"><td class="memSeparator" colspan="2"> </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:gac6b103139be2e859741ec94cc6ad34cc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__mmap.html#gac6b103139be2e859741ec94cc6ad34cc">apr_mmap_create</a> (<a class="el" href="structapr__mmap__t.html">apr_mmap_t</a> **newmmap, <a class="el" href="group__apr__file__io.html#gaa46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> *file, apr_off_t offset, apr_size_t size, apr_int32_t flag, <a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *cntxt)</td></tr>
<tr class="separator:gac6b103139be2e859741ec94cc6ad34cc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9fcdbf8090e924a4e8f2b301519bb4c8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__mmap.html#ga9fcdbf8090e924a4e8f2b301519bb4c8">apr_mmap_dup</a> (<a class="el" href="structapr__mmap__t.html">apr_mmap_t</a> **new_mmap, <a class="el" href="structapr__mmap__t.html">apr_mmap_t</a> *old_mmap, <a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p)</td></tr>
<tr class="separator:ga9fcdbf8090e924a4e8f2b301519bb4c8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4b67a2d22a07707897cc1183a1682040"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__mmap.html#ga4b67a2d22a07707897cc1183a1682040">apr_mmap_delete</a> (<a class="el" href="structapr__mmap__t.html">apr_mmap_t</a> *mm)</td></tr>
<tr class="separator:ga4b67a2d22a07707897cc1183a1682040"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4c1d31bd9e911744bd5edb97e17210ec"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__mmap.html#ga4c1d31bd9e911744bd5edb97e17210ec">apr_mmap_offset</a> (void **addr, <a class="el" href="structapr__mmap__t.html">apr_mmap_t</a> *mm, apr_off_t offset)</td></tr>
<tr class="separator:ga4c1d31bd9e911744bd5edb97e17210ec"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ga4f469432098e986567576fd4c4ce5adc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4f469432098e986567576fd4c4ce5adc">◆ </a></span>APR_MMAP_CANDIDATE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_MMAP_CANDIDATE</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">filelength</td><td>)</td>
<td>   ((filelength >= <a class="el" href="group__apr__mmap.html#ga19d1916e7b64bfb1a969648fe7b0846a">APR_MMAP_THRESHOLD</a>) && (filelength < <a class="el" href="group__apr__mmap.html#ga548e49b3c9e8265ad8ccf70994f4fe25">APR_MMAP_LIMIT</a>))</td>
</tr>
</table>
</div><div class="memdoc">
<p>Can this file be MMaped </p>
</div>
</div>
<a id="ga548e49b3c9e8265ad8ccf70994f4fe25"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga548e49b3c9e8265ad8ccf70994f4fe25">◆ </a></span>APR_MMAP_LIMIT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_MMAP_LIMIT   (4*1024*1024)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum size of MMap region </p>
</div>
</div>
<a id="gac231fdf15d2d29802e0abbc5d0cf25b8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac231fdf15d2d29802e0abbc5d0cf25b8">◆ </a></span>APR_MMAP_READ</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_MMAP_READ   1</td>
</tr>
</table>
</div><div class="memdoc">
<p>MMap opened for reading </p>
</div>
</div>
<a id="ga19d1916e7b64bfb1a969648fe7b0846a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga19d1916e7b64bfb1a969648fe7b0846a">◆ </a></span>APR_MMAP_THRESHOLD</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_MMAP_THRESHOLD   1</td>
</tr>
</table>
</div><div class="memdoc">
<p>Files have to be at least this big before they're mmap()d. This is to deal with systems where the expense of doing an mmap() and an munmap() outweighs the benefit for small files. It shouldn't be set lower than 1. </p>
</div>
</div>
<a id="gac2eb7f697d8bf190e630b85f967c8273"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac2eb7f697d8bf190e630b85f967c8273">◆ </a></span>APR_MMAP_WRITE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_MMAP_WRITE   2</td>
</tr>
</table>
</div><div class="memdoc">
<p>MMap opened for writing </p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga766b01a3e1e0438d06dc88d76f826f80"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga766b01a3e1e0438d06dc88d76f826f80">◆ </a></span>apr_mmap_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structapr__mmap__t.html">apr_mmap_t</a> <a class="el" href="structapr__mmap__t.html">apr_mmap_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structapr__mmap__t.html">apr_mmap_t</a> </dd></dl>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="gac6b103139be2e859741ec94cc6ad34cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac6b103139be2e859741ec94cc6ad34cc">◆ </a></span>apr_mmap_create()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_mmap_create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structapr__mmap__t.html">apr_mmap_t</a> ** </td>
<td class="paramname"><em>newmmap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__apr__file__io.html#gaa46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> * </td>
<td class="paramname"><em>file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_off_t </td>
<td class="paramname"><em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_size_t </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_int32_t </td>
<td class="paramname"><em>flag</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> * </td>
<td class="paramname"><em>cntxt</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new mmap'ed file out of an existing APR file. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">newmmap</td><td>The newly created mmap'ed file. </td></tr>
<tr><td class="paramname">file</td><td>The file to turn into an mmap. </td></tr>
<tr><td class="paramname">offset</td><td>The offset into the file to start the data pointer at. </td></tr>
<tr><td class="paramname">size</td><td>The size of the file </td></tr>
<tr><td class="paramname">flag</td><td>bit-wise or of: <pre>
APR_MMAP_READ MMap opened for reading
APR_MMAP_WRITE MMap opened for writing
</pre> </td></tr>
<tr><td class="paramname">cntxt</td><td>The pool to use when creating the mmap. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga4b67a2d22a07707897cc1183a1682040"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4b67a2d22a07707897cc1183a1682040">◆ </a></span>apr_mmap_delete()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_mmap_delete </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structapr__mmap__t.html">apr_mmap_t</a> * </td>
<td class="paramname"><em>mm</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove a mmap'ed. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mm</td><td>The mmap'ed file. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga9fcdbf8090e924a4e8f2b301519bb4c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9fcdbf8090e924a4e8f2b301519bb4c8">◆ </a></span>apr_mmap_dup()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_mmap_dup </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structapr__mmap__t.html">apr_mmap_t</a> ** </td>
<td class="paramname"><em>new_mmap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structapr__mmap__t.html">apr_mmap_t</a> * </td>
<td class="paramname"><em>old_mmap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> * </td>
<td class="paramname"><em>p</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Duplicate the specified MMAP. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">new_mmap</td><td>The structure to duplicate into. </td></tr>
<tr><td class="paramname">old_mmap</td><td>The mmap to duplicate. </td></tr>
<tr><td class="paramname">p</td><td>The pool to use for new_mmap. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga4c1d31bd9e911744bd5edb97e17210ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4c1d31bd9e911744bd5edb97e17210ec">◆ </a></span>apr_mmap_offset()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_mmap_offset </td>
<td>(</td>
<td class="paramtype">void ** </td>
<td class="paramname"><em>addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structapr__mmap__t.html">apr_mmap_t</a> * </td>
<td class="paramname"><em>mm</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_off_t </td>
<td class="paramname"><em>offset</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Move the pointer into the mmap'ed file to the specified offset. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">addr</td><td>The pointer to the offset specified. </td></tr>
<tr><td class="paramname">mm</td><td>The mmap'ed file. </td></tr>
<tr><td class="paramname">offset</td><td>The offset to move to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
