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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
|
.\" $OpenBSD: semctl.2,v 1.15 2014/01/21 03:15:45 schwarze Exp $
.\" $NetBSD: semctl.2,v 1.2 1997/03/27 08:20:40 mikel Exp $
.\"
.\" Copyright (c) 1995 Frank van der Linden
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\" must display the following acknowledgement:
.\" This product includes software developed for the NetBSD Project
.\" by Frank van der Linden
.\" 4. The name of the author may not be used to endorse or promote products
.\" derived from this software without specific prior written permission
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"/
.Dd $Mdocdate: January 21 2014 $
.Dt SEMCTL 2
.Os
.Sh NAME
.Nm semctl
.Nd semaphore control operations
.Sh SYNOPSIS
.Fd #include <sys/types.h>
.Fd #include <sys/ipc.h>
.Fd #include <sys/sem.h>
.Ft int
.Fn semctl "int semid" "int semnum" "int cmd" "union semun arg"
.Sh DESCRIPTION
The
.Fn semctl
system call provides a number of control operations on the semaphore specified
by
.Fa semnum
and
.Fa semid .
The operation to be performed is specified in
.Fa cmd
(see below).
.Fa arg
is a union of the following fields:
.Bd -literal
int val; /* value for SETVAL */
struct semid_ds *buf; /* buffer for IPC_{STAT,SET} */
u_short *array; /* array for GETALL & SETALL */
.Ed
.Pp
The
.Bf -literal
semid_ds
.Ef
structure used in the
.Dv IPC_SET
and
.Dv IPC_STAT
commands is defined as follows in
.In sys/sem.h :
.Bd -literal
struct semid_ds {
struct ipc_perm sem_perm; /* operation permissions */
struct sem *sem_base; /* semaphore set */
u_short sem_nsems; /* number of sems in set */
time_t sem_otime; /* last operation time */
time_t sem_ctime; /* last change time */
};
.Ed
.Pp
The
.Bf -literal
ipc_perm
.Ef
structure used inside the
.Bf -literal
semid_ds
.Ef
structure is defined in
.In sys/ipc.h
and looks like this:
.Bd -literal
struct ipc_perm {
uid_t cuid; /* creator user id */
gid_t cgid; /* creator group id */
uid_t uid; /* user id */
gid_t gid; /* group id */
mode_t mode; /* r/w permission (see chmod(2)) */
u_short seq; /* sequence # (to generate unique msg/sem/shm id) */
key_t key; /* user specified msg/sem/shm key */
};
.Ed
.Pp
.Fn semctl
provides the following operations:
.Bl -tag -width IPC_RMIDX
.It Dv GETVAL
Return the value of the semaphore.
.It Dv SETVAL
Set the value of the semaphore to
.Va arg.val .
.It Dv GETPID
Return the pid of the last process that did an operation on this semaphore.
.It Dv GETNCNT
Return the number of processes waiting to acquire the semaphore.
.It Dv GETZCNT
Return the number of processes waiting for the value of the semaphore to
reach 0.
.It Dv GETALL
Return the values for all the semaphores associated with
.Fa semid .
.It Dv SETALL
Set the values for all the semaphores that are associated with the semaphore
identifier
.Fa semid
to the corresponding values in
.Va arg.array .
.It Dv IPC_STAT
Gather statistics about a semaphore and place the information in the
.Bf -literal
semid_ds
.Ef
structure pointed to by
.Fa arg.buf
(see above).
.It Dv IPC_SET
Set the value of the
.Va sem_perm.uid ,
.Va sem_perm.gid
and
.Va sem_perm.mode
fields in the structure associated with the semaphore.
The values are taken from the corresponding fields in the structure
pointed to by
.Fa arg.buf .
This operation can only be executed by the superuser, or a process that
has an effective user ID equal to either
.Va sem_perm.cuid
or
.Va sem_perm.uid
in the data structure associated with the message queue.
.It Dv IPC_RMID
Remove the semaphores associated with
.Fa semid
from the system and destroy the data structures associated with it.
Only the superuser or a process with an effective UID equal to the
.Va sem_perm.cuid
or
.Va sem_perm.uid
values in the data structure associated with the semaphore can do this.
.El
.Pp
The permission to read or change a message queue (see
.Xr semop 2 )
is determined by the
.Va sem_perm.mode
field in the same way as is
done with files (see
.Xr chmod 2 ) ,
but the effective UID can match either the
.Va sem_perm.cuid
field or the
.Va sem_perm.uid
field, and the
effective GID can match either
.Va sem_perm.cgid
or
.Va sem_perm.gid .
.Sh RETURN VALUES
For the
.Dv GETVAL ,
.Dv GETPID ,
.Dv GETNCNT ,
and
.Dv GETZCNT
operations,
.Fn semctl
returns one of the values described above if successful.
All other operations will make
.Fn semctl
return 0 if no errors occur.
Otherwise \-1 is returned and
.Va errno
set to reflect the error.
.Sh ERRORS
.Fn semctl
will fail if:
.Bl -tag -width Er
.It Bq Er EPERM
.Fa cmd
is equal to
.Dv IPC_SET
or
.Dv IPC_RMID
and the caller is not the superuser, nor does
the effective UID match either the
.Va sem_perm.uid
or
.Va sem_perm.cuid
fields of the data structure associated with the message queue.
.It Bq Er EACCES
The caller has no operation permission for this semaphore.
.It Bq Er EINVAL
.Fa semid
is not a valid message semaphore identifier.
.Pp
.Va cmd
is not a valid command.
.It Bq Er EFAULT
.Fa arg.buf
or
.Fa arg.array
specify an invalid address.
.It Bq Er ERANGE
.Fa cmd
is equal to
.Dv SETVAL
or
.Dv SETALL
and
.Va arg.val
or the values in
.Va arg.array
are greater than the system-imposed limit.
.El
.Sh SEE ALSO
.Xr semget 2 ,
.Xr semop 2
|
