File: sem_init.3p

package info (click to toggle)
manpages-posix 2013a-2
  • links: PTS
  • area: non-free
  • in suites: buster, stretch
  • size: 9,464 kB
  • ctags: 5
  • sloc: makefile: 45; sh: 34
file content (146 lines) | stat: -rw-r--r-- 3,820 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
'\" et
.TH SEM_INIT "3P" 2013 "IEEE/The Open Group" "POSIX Programmer's Manual"
.SH PROLOG
This manual page is part of the POSIX Programmer's Manual.
The Linux implementation of this interface may differ (consult
the corresponding Linux manual page for details of Linux behavior),
or the interface may not be implemented on Linux.

.SH NAME
sem_init
\(em initialize an unnamed semaphore
.SH SYNOPSIS
.LP
.nf
#include <semaphore.h>
.P
int sem_init(sem_t *\fIsem\fP, int \fIpshared\fP, unsigned \fIvalue\fP);
.fi
.SH DESCRIPTION
The
\fIsem_init\fR()
function shall initialize the unnamed semaphore referred to by
.IR sem .
The value of the initialized semaphore shall be
.IR value .
Following a successful call to
\fIsem_init\fR(),
the semaphore may be used in subsequent calls to
\fIsem_wait\fR(),
\fIsem_timedwait\fR(),
\fIsem_trywait\fR(),
\fIsem_post\fR(),
and
\fIsem_destroy\fR().
This semaphore shall remain usable until the semaphore is destroyed.
.P
If the
.IR pshared
argument has a non-zero value, then the semaphore is shared between
processes; in this case, any process that can access the semaphore
.IR sem
can use
.IR sem
for performing
\fIsem_wait\fR(),
\fIsem_timedwait\fR(),
\fIsem_trywait\fR(),
\fIsem_post\fR(),
and
\fIsem_destroy\fR()
operations.
.P
Only
.IR sem
itself may be used for performing synchronization. The result of
referring to copies of
.IR sem
in calls to
\fIsem_wait\fR(),
\fIsem_timedwait\fR(),
\fIsem_trywait\fR(),
\fIsem_post\fR(),
and
\fIsem_destroy\fR()
is undefined.
.P
If the
.IR pshared
argument is zero, then the semaphore is shared between threads of the
process; any thread in this process can use
.IR sem
for performing
\fIsem_wait\fR(),
\fIsem_timedwait\fR(),
\fIsem_trywait\fR(),
\fIsem_post\fR(),
and
\fIsem_destroy\fR()
operations. The use of the semaphore by threads other than those
created in the same process is undefined.
.P
Attempting to initialize an already initialized semaphore results in
undefined behavior.
.SH "RETURN VALUE"
Upon successful completion, the
\fIsem_init\fR()
function shall initialize the semaphore in
.IR sem
and return 0. Otherwise, it shall return \(mi1 and set
.IR errno
to indicate the error.
.SH ERRORS
The
\fIsem_init\fR()
function shall fail if:
.TP
.BR EINVAL
The
.IR value
argument exceeds
{SEM_VALUE_MAX}.
.TP
.BR ENOSPC
A resource required to initialize the semaphore has been exhausted, or
the limit on semaphores (\c
{SEM_NSEMS_MAX})
has been reached.
.TP
.BR EPERM
The process lacks appropriate privileges to initialize the
semaphore.
.LP
.IR "The following sections are informative."
.SH EXAMPLES
None.
.SH "APPLICATION USAGE"
None.
.SH RATIONALE
None.
.SH "FUTURE DIRECTIONS"
None.
.SH "SEE ALSO"
.IR "\fIsem_destroy\fR\^(\|)",
.IR "\fIsem_post\fR\^(\|)",
.IR "\fIsem_timedwait\fR\^(\|)",
.IR "\fIsem_trywait\fR\^(\|)"
.P
The Base Definitions volume of POSIX.1\(hy2008,
.IR "\fB<semaphore.h>\fP"
.SH COPYRIGHT
Portions of this text are reprinted and reproduced in electronic form
from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
-- Portable Operating System Interface (POSIX), The Open Group Base
Specifications Issue 7, Copyright (C) 2013 by the Institute of
Electrical and Electronics Engineers, Inc and The Open Group.
(This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the
event of any discrepancy between this version and the original IEEE and
The Open Group Standard, the original IEEE and The Open Group Standard
is the referee document. The original Standard can be obtained online at
http://www.unix.org/online.html .

Any typographical or formatting errors that appear
in this page are most likely
to have been introduced during the conversion of the source files to
man page format. To report such errors, see
https://www.kernel.org/doc/man-pages/reporting_bugs.html .