original/man3/sem_wait.3

   1 '\" t
   2 .\" Copyright (C) 2006 Michael Kerrisk <mtk.manpages@gmail.com>
   3 .\"
   4 .\" %%%LICENSE_START(VERBATIM)
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\" %%%LICENSE_END
  25 .\"
  26 .TH SEM_WAIT 3 2014-02-26 "Linux" "Linux Programmer's Manual"
  27 .SH NAME
  28 sem_wait, sem_timedwait, sem_trywait \- lock a semaphore
  29 .SH SYNOPSIS
  30 .nf
  31 .B #include <semaphore.h>
  32 .sp
  33 .BI "int sem_wait(sem_t *" sem );
  34 .sp
  35 .BI "int sem_trywait(sem_t *" sem );
  36 .sp
  37 .BI "int sem_timedwait(sem_t *" sem ", const struct timespec *" abs_timeout );
  38 .fi
  39 .sp
  40 Link with \fI\-pthread\fP.
  41 .sp
  42 .in -4n
  43 Feature Test Macro Requirements for glibc (see
  44 .BR feature_test_macros (7)):
  45 .in
  46 .sp
  47 .BR sem_timedwait ():
  48 _POSIX_C_SOURCE\ >=\ 200112L || _XOPEN_SOURCE\ >=\ 600
  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
  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
  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
  83 .nf
  84 .in +4n
  85 struct timespec {
  86     time_t tv_sec;      /* Seconds */
  87     long   tv_nsec;     /* Nanoseconds [0 .. 999999999] */
  88 };
  89 .in
  90 .fi
  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
 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 .SS Multithreading (see pthreads(7))
 145 The
 146 .BR sem_wait (),
 147 .BR sem_trywait (),
 148 and
 149 .BR sem_timedwait ()
 150 functions are thread-safe.
 151 .SH CONFORMING TO
 152 POSIX.1-2001.
 153 .SH NOTES
 154 A signal handler always interrupts a blocked call to
 155 one of these functions, regardless of the use of the
 156 .BR sigaction (2)
 157 .B SA_RESTART
 158 flag.
 159 .\" sem_wait() is always interrupted on most other implementations,
 160 .\" but on FreeBSD 5.4 SA_RESTART does cause restarting.
 161 .SH EXAMPLE
 162 .PP
 163 The (somewhat trivial) program shown below operates on an
 164 unnamed semaphore.
 165 The program expects two command-line arguments.
 166 The first argument specifies a seconds value that is used to
 167 set an alarm timer to generate a
 168 .B SIGALRM
 169 signal.
 170 This handler performs a
 171 .BR sem_post (3)
 172 to increment the semaphore that is being waited on in
 173 .I main()
 174 using
 175 .BR sem_timedwait ().
 176 The second command-line argument specifies the length
 177 of the timeout, in seconds, for
 178 .BR sem_timedwait ().
 179 The following shows what happens on two different runs of the program:
 180
 181 .in +4n
 182 .nf
 183 .RB "$" " ./a.out 2 3"
 184 About to call sem_timedwait()
 185 sem_post() from handler
 186 sem_timedwait() succeeded
 187 .RB "$" " ./a.out 2 1"
 188 About to call sem_timedwait()
 189 sem_timedwait() timed out
 190 .fi
 191 .in
 192 .SS Program source
 193 \&
 194 .nf
 195 #include <unistd.h>
 196 #include <stdio.h>
 197 #include <stdlib.h>
 198 #include <semaphore.h>
 199 #include <time.h>
 200 #include <assert.h>
 201 #include <errno.h>
 202 #include <signal.h>
 203
 204 sem_t sem;
 205
 206 #define handle_error(msg) \\
 207     do { perror(msg); exit(EXIT_FAILURE); } while (0)
 208
 209 static void
 210 handler(int sig)
 211 {
 212     write(STDOUT_FILENO, "sem_post() from handler\\n", 24);
 213     if (sem_post(&sem) == \-1) {
 214         write(STDERR_FILENO, "sem_post() failed\\n", 18);
 215         _exit(EXIT_FAILURE);
 216     }
 217 }
 218
 219 int
 220 main(int argc, char *argv[])
 221 {
 222     struct sigaction sa;
 223     struct timespec ts;
 224     int s;
 225
 226     if (argc != 3) {
 227         fprintf(stderr, "Usage: %s <alarm\-secs> <wait\-secs>\\n",
 228                 argv[0]);
 229         exit(EXIT_FAILURE);
 230     }
 231
 232     if (sem_init(&sem, 0, 0) == \-1)
 233         handle_error("sem_init");
 234
 235     /* Establish SIGALRM handler; set alarm timer using argv[1] */
 236
 237     sa.sa_handler = handler;
 238     sigemptyset(&sa.sa_mask);
 239     sa.sa_flags = 0;
 240     if (sigaction(SIGALRM, &sa, NULL) == \-1)
 241         handle_error("sigaction");
 242
 243     alarm(atoi(argv[1]));
 244
 245     /* Calculate relative interval as current time plus
 246        number of seconds given argv[2] */
 247
 248     if (clock_gettime(CLOCK_REALTIME, &ts) == \-1)
 249         handle_error("clock_gettime");
 250
 251     ts.tv_sec += atoi(argv[2]);
 252
 253     printf("main() about to call sem_timedwait()\\n");
 254     while ((s = sem_timedwait(&sem, &ts)) == \-1 && errno == EINTR)
 255         continue;       /* Restart if interrupted by handler */
 256
 257     /* Check what happened */
 258
 259     if (s == \-1) {
 260         if (errno == ETIMEDOUT)
 261             printf("sem_timedwait() timed out\\n");
 262         else
 263             perror("sem_timedwait");
 264     } else
 265         printf("sem_timedwait() succeeded\\n");
 266
 267     exit((s == 0) ? EXIT_SUCCESS : EXIT_FAILURE);
 268 }
 269 .fi
 270 .SH SEE ALSO
 271 .BR clock_gettime (2),
 272 .BR sem_getvalue (3),
 273 .BR sem_post (3),
 274 .BR sem_overview (7),
 275 .BR time (7)
 276 .SH COLOPHON
 277 This page is part of release 3.79 of the Linux
 278 .I man-pages
 279 project.
 280 A description of the project,
 281 information about reporting bugs,
 282 and the latest version of this page,
 283 can be found at
 284 \%http://www.kernel.org/doc/man\-pages/.