man3/sem_wait.3

   1 .\" Copyright (C) 2006 Michael Kerrisk <mtk.manpages@gmail.com>
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .TH SEM_WAIT 3 2021-03-22 "Linux" "Linux Programmer's Manual"
  26 .SH NAME
  27 sem_wait, sem_timedwait, sem_trywait \- lock a semaphore
  28 .SH SYNOPSIS
  29 .nf
  30 .B #include <semaphore.h>
  31 .PP
  32 .BI "int sem_wait(sem_t *" sem );
  33 .BI "int sem_trywait(sem_t *" sem );
  34 .BI "int sem_timedwait(sem_t *restrict " sem ,
  35 .BI "                  const struct timespec *restrict " abs_timeout );
  36 .fi
  37 .PP
  38 Link with \fI\-pthread\fP.
  39 .PP
  40 .RS -4
  41 Feature Test Macro Requirements for glibc (see
  42 .BR feature_test_macros (7)):
  43 .RE
  44 .PP
  45 .BR sem_timedwait ():
  46 .nf
  47     _POSIX_C_SOURCE >= 200112L
  48 .fi
  49 .SH DESCRIPTION
  50 .BR sem_wait ()
  51 decrements (locks) the semaphore pointed to by
  52 .IR sem .
  53 If the semaphore's value is greater than zero,
  54 then the decrement proceeds, and the function returns, immediately.
  55 If the semaphore currently has the value zero,
  56 then the call blocks until either it becomes possible to perform
  57 the decrement (i.e., the semaphore value rises above zero),
  58 or a signal handler interrupts the call.
  59 .PP
  60 .BR sem_trywait ()
  61 is the same as
  62 .BR sem_wait (),
  63 except that if the decrement cannot be immediately performed,
  64 then call returns an error
  65 .RI ( errno
  66 set to
  67 .BR EAGAIN )
  68 instead of blocking.
  69 .PP
  70 .BR sem_timedwait ()
  71 is the same as
  72 .BR sem_wait (),
  73 except that
  74 .I abs_timeout
  75 specifies a limit on the amount of time that the call
  76 should block if the decrement cannot be immediately performed.
  77 The
  78 .I abs_timeout
  79 argument points to a structure that specifies an absolute timeout
  80 in seconds and nanoseconds since the Epoch, 1970-01-01 00:00:00 +0000 (UTC).
  81 This structure is defined as follows:
  82 .PP
  83 .in +4n
  84 .EX
  85 struct timespec {
  86     time_t tv_sec;      /* Seconds */
  87     long   tv_nsec;     /* Nanoseconds [0 .. 999999999] */
  88 };
  89 .EE
  90 .in
  91 .PP
  92 If the timeout has already expired by the time of the call,
  93 and the semaphore could not be locked immediately,
  94 then
  95 .BR sem_timedwait ()
  96 fails with a timeout error
  97 .RI ( errno
  98 set to
  99 .BR ETIMEDOUT ).
 100 .PP
 101 If the operation can be performed immediately, then
 102 .BR sem_timedwait ()
 103 never fails with a timeout error, regardless of the value of
 104 .IR abs_timeout .
 105 Furthermore, the validity of
 106 .I abs_timeout
 107 is not checked in this case.
 108 .SH RETURN VALUE
 109 All of these functions return 0 on success;
 110 on error, the value of the semaphore is left unchanged,
 111 \-1 is returned, and
 112 .I errno
 113 is set to indicate the error.
 114 .SH ERRORS
 115 .TP
 116 .B EINTR
 117 The call was interrupted by a signal handler; see
 118 .BR signal (7).
 119 .TP
 120 .B EINVAL
 121 .I sem
 122 is not a valid semaphore.
 123 .PP
 124 The following additional error can occur for
 125 .BR sem_trywait ():
 126 .TP
 127 .B EAGAIN
 128 The operation could not be performed without blocking (i.e., the
 129 semaphore currently has the value zero).
 130 .PP
 131 The following additional errors can occur for
 132 .BR sem_timedwait ():
 133 .TP
 134 .B EINVAL
 135 The value of
 136 .I abs_timeout.tv_nsecs
 137 is less than 0, or greater than or equal to 1000 million.
 138 .TP
 139 .B ETIMEDOUT
 140 The call timed out before the semaphore could be locked.
 141 .\" POSIX.1-2001 also allows EDEADLK -- "A deadlock condition
 142 .\" was detected", but this does not occur on Linux(?).
 143 .SH ATTRIBUTES
 144 For an explanation of the terms used in this section, see
 145 .BR attributes (7).
 146 .ad l
 147 .nh
 148 .TS
 149 allbox;
 150 lbx lb lb
 151 l l l.
 152 Interface       Attribute       Value
 153 T{
 154 .BR sem_wait (),
 155 .BR sem_trywait (),
 156 .BR sem_timedwait ()
 157 T}      Thread safety   MT-Safe
 158 .TE
 159 .hy
 160 .ad
 161 .sp 1
 162 .SH CONFORMING TO
 163 POSIX.1-2001, POSIX.1-2008.
 164 .SH EXAMPLES
 165 The (somewhat trivial) program shown below operates on an
 166 unnamed semaphore.
 167 The program expects two command-line arguments.
 168 The first argument specifies a seconds value that is used to
 169 set an alarm timer to generate a
 170 .B SIGALRM
 171 signal.
 172 This handler performs a
 173 .BR sem_post (3)
 174 to increment the semaphore that is being waited on in
 175 .I main()
 176 using
 177 .BR sem_timedwait ().
 178 The second command-line argument specifies the length
 179 of the timeout, in seconds, for
 180 .BR sem_timedwait ().
 181 The following shows what happens on two different runs of the program:
 182 .PP
 183 .in +4n
 184 .EX
 185 .RB "$" " ./a.out 2 3"
 186 About to call sem_timedwait()
 187 sem_post() from handler
 188 sem_timedwait() succeeded
 189 .RB "$" " ./a.out 2 1"
 190 About to call sem_timedwait()
 191 sem_timedwait() timed out
 192 .EE
 193 .in
 194 .SS Program source
 195 \&
 196 .EX
 197 #include <unistd.h>
 198 #include <stdio.h>
 199 #include <stdlib.h>
 200 #include <semaphore.h>
 201 #include <time.h>
 202 #include <assert.h>
 203 #include <errno.h>
 204 #include <signal.h>
 205
 206 sem_t sem;
 207
 208 #define handle_error(msg) \e
 209     do { perror(msg); exit(EXIT_FAILURE); } while (0)
 210
 211 static void
 212 handler(int sig)
 213 {
 214     write(STDOUT_FILENO, "sem_post() from handler\en", 24);
 215     if (sem_post(&sem) == \-1) {
 216         write(STDERR_FILENO, "sem_post() failed\en", 18);
 217         _exit(EXIT_FAILURE);
 218     }
 219 }
 220
 221 int
 222 main(int argc, char *argv[])
 223 {
 224     struct sigaction sa;
 225     struct timespec ts;
 226     int s;
 227
 228     if (argc != 3) {
 229         fprintf(stderr, "Usage: %s <alarm\-secs> <wait\-secs>\en",
 230                 argv[0]);
 231         exit(EXIT_FAILURE);
 232     }
 233
 234     if (sem_init(&sem, 0, 0) == \-1)
 235         handle_error("sem_init");
 236
 237     /* Establish SIGALRM handler; set alarm timer using argv[1]. */
 238
 239     sa.sa_handler = handler;
 240     sigemptyset(&sa.sa_mask);
 241     sa.sa_flags = 0;
 242     if (sigaction(SIGALRM, &sa, NULL) == \-1)
 243         handle_error("sigaction");
 244
 245     alarm(atoi(argv[1]));
 246
 247     /* Calculate relative interval as current time plus
 248        number of seconds given argv[2]. */
 249
 250     if (clock_gettime(CLOCK_REALTIME, &ts) == \-1)
 251         handle_error("clock_gettime");
 252
 253     ts.tv_sec += atoi(argv[2]);
 254
 255     printf("main() about to call sem_timedwait()\en");
 256     while ((s = sem_timedwait(&sem, &ts)) == \-1 && errno == EINTR)
 257         continue;       /* Restart if interrupted by handler. */
 258
 259     /* Check what happened. */
 260
 261     if (s == \-1) {
 262         if (errno == ETIMEDOUT)
 263             printf("sem_timedwait() timed out\en");
 264         else
 265             perror("sem_timedwait");
 266     } else
 267         printf("sem_timedwait() succeeded\en");
 268
 269     exit((s == 0) ? EXIT_SUCCESS : EXIT_FAILURE);
 270 }
 271 .EE
 272 .SH SEE ALSO
 273 .BR clock_gettime (2),
 274 .BR sem_getvalue (3),
 275 .BR sem_post (3),
 276 .BR sem_overview (7),
 277 .BR time (7)