lib/libc/sys/semop.2

   1 .\"
   2 .\" Copyright (c) 1995 David Hovemeyer <daveho@infocom.com>
   3 .\"
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD: src/lib/libc/sys/semop.2,v 1.7.2.6 2001/12/14 18:34:01 ru Exp $
  27 .\"
  28 .Dd September 22, 1995
  29 .Dt SEMOP 2
  30 .Os
  31 .Sh NAME
  32 .Nm semop
  33 .Nd atomic array of operations on a semaphore set
  34 .Sh LIBRARY
  35 .Lb libc
  36 .Sh SYNOPSIS
  37 .In sys/types.h
  38 .In sys/ipc.h
  39 .In sys/sem.h
  40 .Ft int
  41 .Fn semop "int semid" "struct sembuf array[]" "unsigned nops"
  42 .Sh DESCRIPTION
  43 .Fn Semop
  44 atomically performs the array of operations indicated by
  45 .Fa array
  46 on the semaphore set indicated by
  47 .Fa semid .
  48 The length of
  49 .Fa array
  50 is indicated by
  51 .Fa nops .
  52 Each operation is encoded in a
  53 .Fa "struct sembuf" ,
  54 which is defined as follows:
  55 .Bd -literal
  56 .\"
  57 .\" From <sys/sem.h>
  58 .\"
  59 struct sembuf {
  60         u_short sem_num;        /* semaphore # */
  61         short   sem_op;         /* semaphore operation */
  62         short   sem_flg;        /* operation flags */
  63 };
  64 .Ed
  65 .Pp
  66 For each element in
  67 .Fa array ,
  68 .Fa sem_op
  69 and
  70 .Fa sem_flg
  71 determine an operation to be performed on semaphore number
  72 .Fa sem_num
  73 in the set.  The values SEM_UNDO and IPC_NOWAIT may be
  74 .Em OR Ns 'ed
  75 into the
  76 .Fa sem_flg
  77 member in order to modify the behavior of the given operation.
  78 .Pp
  79 The operation performed depends as follows on the value of
  80 .Fa sem_op :
  81 .\"
  82 .\" This section is based on the description of semop() in
  83 .\" Stevens, _Advanced Programming in the UNIX Environment_.
  84 .\"
  85 .Bl -bullet
  86 .It
  87 When
  88 .Fa sem_op
  89 is positive, the semaphore's value is incremented by
  90 .Fa sem_op Ns 's
  91 value.  If SEM_UNDO is specified, the semaphore's adjust on exit
  92 value is decremented by
  93 .Fa sem_op Ns 's
  94 value.  A positive value for
  95 .Fa sem_op
  96 generally corresponds to a process releasing a resource
  97 associated with the semaphore.
  98 .It
  99 The behavior when
 100 .Fa sem_op
 101 is negative depends on the current value of the semaphore:
 102 .Bl -bullet
 103 .It
 104 If the current value of the semaphore is greater than or equal to
 105 the absolute value of
 106 .Fa sem_op ,
 107 then the value is decremented by the absolute value of
 108 .Fa sem_op .
 109 If SEM_UNDO is specified, the semaphore's adjust on exit
 110 value is incremented by the absolute value of
 111 .Fa sem_op .
 112 .It
 113 If the current value of the semaphore is less than
 114 .Fa sem_op Ns 's
 115 value, one of the following happens:
 116 .\" XXX a *second* sublist?
 117 .Bl -bullet
 118 .It
 119 If IPC_NOWAIT was specified, then
 120 .Fn semop
 121 returns immediately with a return value of
 122 .Er EAGAIN .
 123 .It
 124 If some other process has removed the semaphore with the IPC_RMID
 125 option of
 126 .Fn semctl ,
 127 then
 128 .Fn semop
 129 returns immediately with a return value of
 130 .Er EINVAL .
 131 .It
 132 Otherwise, the calling process is put to sleep until the semaphore's
 133 value is greater than or equal to the absolute value of
 134 .Fa sem_op .
 135 When this condition becomes true, the semaphore's value is decremented
 136 by the absolute value of
 137 .Fa sem_op ,
 138 and the semaphore's adjust on exit value is incremented by the
 139 absolute value of
 140 .Fa sem_op .
 141 .El
 142 .Pp
 143 A negative value for
 144 .Fa sem_op
 145 generally means that a process is waiting for a resource to become
 146 available.
 147 .El
 148 .It
 149 When
 150 .Fa sem_op
 151 is zero, the process waits for the semaphore's value to become zero.
 152 If it is already zero, the call to
 153 .Fn semop
 154 can return immediately.  Otherwise, the calling process is put to
 155 sleep until the semaphore's value becomes zero.
 156 .El
 157 .Pp
 158 For each semaphore a process has in use, the kernel maintains an
 159 `adjust on exit' value, as alluded to earlier.  When a process
 160 exits, either voluntarily or involuntarily, the adjust on exit value
 161 for each semaphore is added to the semaphore's value.  This can
 162 be used to insure that a resource is released if a process terminates
 163 unexpectedly.
 164 .Sh RETURN VALUES
 165 .Rv -std semop
 166 .Sh ERRORS
 167 .Fn Semop
 168 will fail if:
 169 .Bl -tag -width Er
 170 .It Bq Er EINVAL
 171 No semaphore set corresponds to
 172 .Fa semid .
 173 .It Bq Er EACCES
 174 Permission denied due to mismatch between operation and mode of
 175 semaphore set.
 176 .It Bq Er EAGAIN
 177 The semaphore's value was less than
 178 .Fa sem_op ,
 179 and IPC_NOWAIT was specified.
 180 .It Bq Er E2BIG
 181 Too many operations were specified.
 182 .It Bq Er EFBIG
 183 .\"
 184 .\" I'd have thought this would be EINVAL, but the source says
 185 .\" EFBIG.
 186 .\"
 187 .Fa sem_num
 188 was not in the range of valid semaphores for the set.
 189 .El
 190 .Sh SEE ALSO
 191 .Xr semctl 2 ,
 192 .Xr semget 2