mman.h.html

IEEE 1003.1-2003, Single Unix Specification v3

<img src="../../images/opt-end.gif" alt="[Option End]" border="0"> 

<p><sup>[<a href="javascript:open_code('TYM')">TYM</a>]</sup> <img src="../../images/opt-start.gif" alt="[Option Start]" border=
"0"> The following flags shall be defined for <a href=
"../../functions/posix_typed_mem_open.html"><i>posix_typed_mem_open</i>()</a>:</p>

<dl compact>
<dt>POSIX_TYPED_MEM_ALLOCATE</dt>

<dd><br>
Allocate on <a href="../../functions/mmap.html"><i>mmap</i>()</a>.</dd>

<dt>POSIX_TYPED_MEM_ALLOCATE_CONTIG</dt>

<dd><br>
Allocate contiguously on <a href="../../functions/mmap.html"><i>mmap</i>()</a>.</dd>

<dt>POSIX_TYPED_MEM_MAP_ALLOCATABLE</dt>

<dd><br>
Map on <a href="../../functions/mmap.html"><i>mmap</i>()</a>, without affecting allocatability.</dd>
</dl>

<img src="../../images/opt-end.gif" alt="[Option End]" border="0"> 

<p>The <b>mode_t</b>, <b>off_t</b>, and <b>size_t</b> types shall be defined as described in <a href=
"../sys/types.h.html#tag_13_67"><i>&lt;sys/types.h&gt;</i></a> .</p>

<p><sup>[<a href="javascript:open_code('TYM')">TYM</a>]</sup> <img src="../../images/opt-start.gif" alt="[Option Start]" border=
"0"> The <i>&lt;sys/mman.h&gt;</i> header shall define the structure <b>posix_typed_mem_info</b>, which includes at least the
following member:</p>

<pre>
<tt>size_t  posix_tmi_length </tt> Maximum length which may be allocated <tt>
                         </tt> from a typed memory object. <tt>
</tt>
</pre>

<img src="../../images/opt-end.gif" alt="[Option End]" border="0"> 

<p>The following shall be declared as functions and may also be defined as macros. Function prototypes shall be provided.</p>

<pre>
<tt><sup>[<a href="javascript:open_code('MR')">MR</a>]</sup><img src="../../images/opt-start.gif" alt="[Option Start]" border="0">
int    mlock(const void *, size_t);
<img src="../../images/opt-end.gif" alt="[Option End]" border="0">
<sup>[<a href="javascript:open_code('ML')">ML</a>]</sup><img src="../../images/opt-start.gif" alt="[Option Start]" border="0">
int    mlockall(int);
<img src="../../images/opt-end.gif" alt="[Option End]" border="0">
<sup>[<a href="javascript:open_code('MC3')">MC3</a>]</sup><img src="../../images/opt-start.gif" alt="[Option Start]" border="0">
void  *mmap(void *, size_t, int, int, int, off_t);
<img src="../../images/opt-end.gif" alt="[Option End]" border="0">
<sup>[<a href="javascript:open_code('MPR')">MPR</a>]</sup><img src="../../images/opt-start.gif" alt="[Option Start]" border="0">
int    mprotect(void *, size_t, int);
<img src="../../images/opt-end.gif" alt="[Option End]" border="0">
<sup>[<a href="javascript:open_code('MF')">MF|SIO</a>]</sup><img src="../../images/opt-start.gif" alt="[Option Start]" border="0">
int    msync(void *, size_t, int);
<img src="../../images/opt-end.gif" alt="[Option End]" border="0">
<sup>[<a href="javascript:open_code('MR')">MR</a>]</sup><img src="../../images/opt-start.gif" alt="[Option Start]" border="0">
int    munlock(const void *, size_t);
<img src="../../images/opt-end.gif" alt="[Option End]" border="0">
<sup>[<a href="javascript:open_code('ML')">ML</a>]</sup><img src="../../images/opt-start.gif" alt="[Option Start]" border="0">
int    munlockall(void);
<img src="../../images/opt-end.gif" alt="[Option End]" border="0">
<sup>[<a href="javascript:open_code('MC3')">MC3</a>]</sup><img src="../../images/opt-start.gif" alt="[Option Start]" border="0">
int    munmap(void *, size_t);
<img src="../../images/opt-end.gif" alt="[Option End]" border="0">
<sup>[<a href="javascript:open_code('ADV')">ADV</a>]</sup><img src="../../images/opt-start.gif" alt="[Option Start]" border="0">
int    posix_madvise(void *, size_t, int);
<img src="../../images/opt-end.gif" alt="[Option End]" border="0">
<sup>[<a href="javascript:open_code('TYM')">TYM</a>]</sup><img src="../../images/opt-start.gif" alt="[Option Start]" border="0">
int    posix_mem_offset(const void *restrict, size_t, off_t *restrict,
           size_t *restrict, int *restrict);
int    posix_typed_mem_get_info(int, struct posix_typed_mem_info *);
int    posix_typed_mem_open(const char *, int, int);
<img src="../../images/opt-end.gif" alt="[Option End]" border="0">
<sup>[<a href="javascript:open_code('SHM')">SHM</a>]</sup><img src="../../images/opt-start.gif" alt="[Option Start]" border="0">
int    shm_open(const char *, int, mode_t);
int    shm_unlink(const char *);
<img src="../../images/opt-end.gif" alt="[Option End]" border="0">
</tt>
</pre>
</blockquote>

<hr>
<div class="box"><em>The following sections are informative.</em></div>

<h4><a name="tag_13_55_04"></a>APPLICATION USAGE</h4>

<blockquote>
<p>None.</p>
</blockquote>

<h4><a name="tag_13_55_05"></a>RATIONALE</h4>

<blockquote>
<p>None.</p>
</blockquote>

<h4><a name="tag_13_55_06"></a>FUTURE DIRECTIONS</h4>

<blockquote>
<p>None.</p>
</blockquote>

<h4><a name="tag_13_55_07"></a>SEE ALSO</h4>

<blockquote>
<p><a href="../sys/types.h.html#tag_13_67"><i>&lt;sys/types.h&gt;</i></a> , the System Interfaces volume of
IEEE&nbsp;Std&nbsp;1003.1-2001, <a href="../../functions/mlock.html"><i>mlock</i>()</a>, <a href=
"../../functions/mlockall.html"><i>mlockall</i>()</a>, <a href="../../functions/mmap.html"><i>mmap</i>()</a>, <a href=
"../../functions/mprotect.html"><i>mprotect</i>()</a>, <a href="../../functions/msync.html"><i>msync</i>()</a>, <a href=
"../../functions/munlock.html"><i>munlock</i>()</a>, <a href="../../functions/munlockall.html"><i>munlockall</i>()</a>, <a href=
"../../functions/munmap.html"><i>munmap</i>()</a>, <a href="../../functions/posix_mem_offset.html"><i>posix_mem_offset</i>()</a>,
<a href="../../functions/posix_typed_mem_get_info.html"><i>posix_typed_mem_get_info</i>()</a>, <a href=
"../../functions/posix_typed_mem_open.html"><i>posix_typed_mem_open</i>()</a>, <a href=
"../../functions/shm_open.html"><i>shm_open</i>()</a>, <a href="../../functions/shm_unlink.html"><i>shm_unlink</i>()</a></p>
</blockquote>

<h4><a name="tag_13_55_08"></a>CHANGE HISTORY</h4>

<blockquote>
<p>First released in Issue 4, Version 2.</p>
</blockquote>

<h4><a name="tag_13_55_09"></a>Issue 5</h4>

<blockquote>
<p>Updated for alignment with the POSIX Realtime Extension.</p>
</blockquote>

<h4><a name="tag_13_55_10"></a>Issue 6</h4>

<blockquote>
<p>The <i>&lt;sys/mman.h&gt;</i> header is marked as dependent on support for either the Memory Mapped Files, Process Memory
Locking, or Shared Memory Objects options.</p>

<p>The following changes are made for alignment with IEEE&nbsp;Std&nbsp;1003.1j-2000:</p>

<ul>
<li>
<p>The TYM margin code is added to the list of margin codes for the <i>&lt;sys/mman.h&gt;</i> header line, as well as for other
lines.</p>
</li>

<li>
<p>The POSIX_TYPED_MEM_ALLOCATE, POSIX_TYPED_MEM_ALLOCATE_CONTIG, and POSIX_TYPED_MEM_MAP_ALLOCATABLE flags are added.</p>
</li>

<li>
<p>The <b>posix_tmi_length</b> structure is added.</p>
</li>

<li>
<p>The <a href="../../functions/posix_mem_offset.html"><i>posix_mem_offset</i>()</a>, <a href=
"../../functions/posix_typed_mem_get_info.html"><i>posix_typed_mem_get_info</i>()</a>, and <a href=
"../../functions/posix_typed_mem_open.html"><i>posix_typed_mem_open</i>()</a> functions are added.</p>
</li>
</ul>

<p>The <b>restrict</b> keyword is added to the prototype for <a href=
"../../functions/posix_mem_offset.html"><i>posix_mem_offset</i>()</a>.</p>

<p>IEEE PASC Interpretation 1003.1 #102 is applied, adding the prototype for <a href=
"../../functions/posix_madvise.html"><i>posix_madvise</i>()</a>.</p>

<p>IEEE&nbsp;Std 1003.1-2001/Cor&nbsp;1-2002, item XBD/TC1/D6/16 is applied, correcting margin code and shading errors for the <a
href="../../functions/mlock.html"><i>mlock</i>()</a> and <a href="../../functions/munlock.html"><i>munlock</i>()</a> functions.</p>

<p>IEEE&nbsp;Std 1003.1-2001/Cor&nbsp;1-2002, item XSH/TC1/D6/34 is applied, changing the margin code for the <a href=
"../../functions/mmap.html"><i>mmap</i>()</a> function from MF|SHM to MC3 (notation for MF|SHM|TYM).</p>

<p>IEEE&nbsp;Std 1003.1-2001/Cor&nbsp;1-2002, item XSH/TC1/D6/36 is applied, changing the margin code for the <a href=
"../../functions/munmap.html"><i>munmap</i>()</a> function from MF|SHM to MC3 (notation for MF|SHM|TYM).</p>
</blockquote>

<div class="box"><em>End of informative text.</em></div>

<hr>
<hr size="2" noshade>
<center><font size="2"><!--footer start-->
UNIX &reg; is a registered Trademark of The Open Group.<br>
POSIX &reg; is a registered Trademark of The IEEE.<br>
[ <a href="../../mindex.html">Main Index</a> | <a href="../../basedefs/contents.html">XBD</a> | <a href=
"../../utilities/contents.html">XCU</a> | <a href="../../functions/contents.html">XSH</a> | <a href=
"../../xrat/contents.html">XRAT</a> ]</font></center>

<!--footer end-->
<hr size="2" noshade>
</body>
</html>