man-pages/man3/sem_init.3.html
2021-03-31 01:06:50 +01:00

187 lines
4.5 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of SEM_INIT</TITLE>
</HEAD><BODY>
<H1>SEM_INIT</H1>
Section: Linux Programmer's Manual (3)<BR>Updated: 2017-09-15<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
sem_init - initialize an unnamed semaphore
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<PRE>
<B>#include &lt;<A HREF="file:///usr/include/semaphore.h">semaphore.h</A>&gt;</B>
<B>int sem_init(sem_t *</B><I>sem</I><B>, int </B><I>pshared</I><B>, unsigned int </B><I>value</I><B>);</B>
</PRE>
<P>
Link with <I>-pthread</I>.
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<B>sem_init</B>()
initializes the unnamed semaphore at the address pointed to by
<I>sem</I>.
The
<I>value</I>
argument specifies the initial value for the semaphore.
<P>
The
<I>pshared</I>
argument indicates whether this semaphore is to be shared
between the threads of a process, or between processes.
<P>
If
<I>pshared</I>
has the value 0,
then the semaphore is shared between the threads of a process,
and should be located at some address that is visible to all threads
(e.g., a global variable, or a variable allocated dynamically on
the heap).
<P>
If
<I>pshared</I>
is nonzero, then the semaphore is shared between processes,
and should be located in a region of shared memory (see
<B><A HREF="/cgi-bin/man/man2html?3+shm_open">shm_open</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?2+mmap">mmap</A></B>(2),
and
<B><A HREF="/cgi-bin/man/man2html?2+shmget">shmget</A></B>(2)).
(Since a child created by
<B><A HREF="/cgi-bin/man/man2html?2+fork">fork</A></B>(2)
inherits its parent's memory mappings, it can also access the semaphore.)
Any process that can access the shared memory region
can operate on the semaphore using
<B><A HREF="/cgi-bin/man/man2html?3+sem_post">sem_post</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+sem_wait">sem_wait</A></B>(3),
and so on.
<P>
Initializing a semaphore that has already been initialized
results in undefined behavior.
<A NAME="lbAE">&nbsp;</A>
<H2>RETURN VALUE</H2>
<B>sem_init</B>()
returns 0 on success;
on error, -1 is returned, and
<I>errno</I>
is set to indicate the error.
<A NAME="lbAF">&nbsp;</A>
<H2>ERRORS</H2>
<DL COMPACT>
<DT id="1"><B>EINVAL</B>
<DD>
<I>value</I>
exceeds
<B>SEM_VALUE_MAX</B>.
<DT id="2"><B>ENOSYS</B>
<DD>
<I>pshared</I>
is nonzero,
but the system does not support process-shared semaphores (see
<B><A HREF="/cgi-bin/man/man2html?7+sem_overview">sem_overview</A></B>(7)).
</DL>
<A NAME="lbAG">&nbsp;</A>
<H2>ATTRIBUTES</H2>
For an explanation of the terms used in this section, see
<B><A HREF="/cgi-bin/man/man2html?7+attributes">attributes</A></B>(7).
<TABLE BORDER>
<TR VALIGN=top><TD><B>Interface</B></TD><TD><B>Attribute</B></TD><TD><B>Value</B><BR></TD></TR>
<TR VALIGN=top><TD>
<B>sem_init</B>()
</TD><TD>Thread safety</TD><TD>MT-Safe<BR></TD></TR>
</TABLE>
<A NAME="lbAH">&nbsp;</A>
<H2>CONFORMING TO</H2>
POSIX.1-2001.
<A NAME="lbAI">&nbsp;</A>
<H2>NOTES</H2>
Bizarrely, POSIX.1-2001 does not specify the value that should
be returned by a successful call to
<B>sem_init</B>().
POSIX.1-2008 rectifies this, specifying the zero return on success.
<A NAME="lbAJ">&nbsp;</A>
<H2>SEE ALSO</H2>
<B><A HREF="/cgi-bin/man/man2html?3+sem_destroy">sem_destroy</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+sem_post">sem_post</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+sem_wait">sem_wait</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?7+sem_overview">sem_overview</A></B>(7)
<A NAME="lbAK">&nbsp;</A>
<H2>COLOPHON</H2>
This page is part of release 5.05 of the Linux
<I>man-pages</I>
project.
A description of the project,
information about reporting bugs,
and the latest version of this page,
can be found at
<A HREF="https://www.kernel.org/doc/man-pages/.">https://www.kernel.org/doc/man-pages/.</A>
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="3"><A HREF="#lbAB">NAME</A><DD>
<DT id="4"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="5"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="6"><A HREF="#lbAE">RETURN VALUE</A><DD>
<DT id="7"><A HREF="#lbAF">ERRORS</A><DD>
<DT id="8"><A HREF="#lbAG">ATTRIBUTES</A><DD>
<DT id="9"><A HREF="#lbAH">CONFORMING TO</A><DD>
<DT id="10"><A HREF="#lbAI">NOTES</A><DD>
<DT id="11"><A HREF="#lbAJ">SEE ALSO</A><DD>
<DT id="12"><A HREF="#lbAK">COLOPHON</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:56 GMT, March 31, 2021
</BODY>
</HTML>