Files
2024-02-19 00:21:47 -05:00

158 lines
5.0 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta name="generator" content="HTML Tidy, see www.w3.org">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link type="text/css" rel="stylesheet" href="style.css"><!-- Generated by The Open Group's rhtm tool v1.2.1 -->
<!-- Copyright (c) 2001 The Open Group, All Rights Reserved -->
<title>&lt;sys/shm.h&gt;</title>
</head>
<body bgcolor="white">
<script type="text/javascript" language="JavaScript" src="../../jscript/dotcode.js">
</script>
<basefont size="3"> <a name="&lt;sys/shm.h&gt;"></a> <a name="tag_13_60"></a><!-- &lt;sys/shm.h&gt; -->
<!--header start-->
<center><font size="2">The Open Group Base Specifications Issue 6<br>
IEEE Std 1003.1-2001<br>
Copyright &copy; 2001 The IEEE and The Open Group, All Rights reserved.</font></center>
<!--header end-->
<hr size="2" noshade>
<h4><a name="tag_13_60_01"></a>NAME</h4>
<blockquote>sys/shm.h - XSI shared memory facility</blockquote>
<h4><a name="tag_13_60_02"></a>SYNOPSIS</h4>
<blockquote class="synopsis">
<div class="box"><tt><sup>[<a href="javascript:open_code('XSI')">XSI</a>]</sup> <img src="../../images/opt-start.gif" alt=
"[Option Start]" border="0"> #include &lt;sys/shm.h&gt; <img src="../../images/opt-end.gif" alt="[Option End]" border=
"0"></tt></div>
</blockquote>
<h4><a name="tag_13_60_03"></a>DESCRIPTION</h4>
<blockquote>
<p>The <i>&lt;sys/shm.h&gt;</i> header shall define the following symbolic constants:</p>
<dl compact>
<dt>SHM_RDONLY</dt>
<dd>Attach read-only (else read-write).</dd>
<dt>SHM_RND</dt>
<dd>Round attach address to SHMLBA.</dd>
</dl>
<p>The <i>&lt;sys/shm.h&gt;</i> header shall define the following symbolic value:</p>
<dl compact>
<dt>SHMLBA</dt>
<dd>Segment low boundary address multiple.</dd>
</dl>
<p>The following data types shall be defined through <b>typedef</b>:</p>
<dl compact>
<dt><b>shmatt_t</b></dt>
<dd>Unsigned integer used for the number of current attaches that must be able to store values at least as large as a type
<b>unsigned short</b>.</dd>
</dl>
<p>The <b>shmid_ds</b> structure shall contain the following members:</p>
<pre>
<tt>struct ipc_perm shm_perm </tt> Operation permission structure. <tt>
size_t shm_segsz </tt> Size of segment in bytes. <tt>
pid_t shm_lpid </tt> Process ID of last shared memory operation. <tt>
pid_t shm_cpid </tt> Process ID of creator. <tt>
shmatt_t shm_nattch</tt> Number of current attaches. <tt>
time_t shm_atime </tt> Time of last <i>shmat</i>
(). <tt>
time_t shm_dtime </tt> Time of last <i>shmdt</i>
(). <tt>
time_t shm_ctime </tt> Time of last change by <i>shmctl</i>
(). <tt>
</tt>
</pre>
<p>The <b>pid_t</b>, <b>time_t</b>, <b>key_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>The following shall be declared as functions and may also be defined as macros. Function prototypes shall be provided.</p>
<pre>
<tt>void *shmat(int, const void *, int);
int shmctl(int, int, struct shmid_ds *);
int shmdt(const void *);
int shmget(key_t, size_t, int);
</tt>
</pre>
<p>In addition, all of the symbols from <a href="../../basedefs/sys/ipc.h.html"><i>&lt;sys/ipc.h&gt;</i></a> shall be defined when
this header is included.</p>
</blockquote>
<hr>
<div class="box"><em>The following sections are informative.</em></div>
<h4><a name="tag_13_60_04"></a>APPLICATION USAGE</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_13_60_05"></a>RATIONALE</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_13_60_06"></a>FUTURE DIRECTIONS</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_13_60_07"></a>SEE ALSO</h4>
<blockquote>
<p><a href="../sys/ipc.h.html#tag_13_54"><i>&lt;sys/ipc.h&gt;</i></a> , <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/shmat.html"><i>shmat</i>()</a>, <a href="../../functions/shmctl.html"><i>shmctl</i>()</a>, <a href=
"../../functions/shmdt.html"><i>shmdt</i>()</a>, <a href="../../functions/shmget.html"><i>shmget</i>()</a></p>
</blockquote>
<h4><a name="tag_13_60_08"></a>CHANGE HISTORY</h4>
<blockquote>
<p>First released in Issue 2. Derived from System V Release 2.0.</p>
</blockquote>
<h4><a name="tag_13_60_09"></a>Issue 5</h4>
<blockquote>
<p>The type of <i>shm_segsz</i> is changed from <b>int</b> to <b>size_t</b>.</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>