original/man3/sem_wait.3

   1 '\" t
   2 .\" Hey Emacs! This file is -*- nroff -*- source.
   3 .\"
   4 .\" Copyright (C) 2006 Michael Kerrisk <mtk.manpages@gmail.com>
   5 .\"
   6 .\" Permission is granted to make and distribute verbatim copies of this
   7 .\" manual provided the copyright notice and this permission notice are
   8 .\" preserved on all copies.
   9 .\"
  10 .\" Permission is granted to copy and distribute modified versions of this
  11 .\" manual under the conditions for verbatim copying, provided that the
  12 .\" entire resulting derived work is distributed under the terms of a
  13 .\" permission notice identical to this one.
  14 .\"
  15 .\" Since the Linux kernel and libraries are constantly changing, this
  16 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  17 .\" responsibility for errors or omissions, or for damages resulting from
  18 .\" the use of the information contained herein.  The author(s) may not
  19 .\" have taken the same level of care in the production of this manual,
  20 .\" which is licensed free of charge, as they might when working
  21 .\" professionally.
  22 .\"
  23 .\" Formatted or processed versions of this manual, if unaccompanied by
  24 .\" the source, must acknowledge the copyright and authors of this work.
  25 .\"
  26 .TH SEM_WAIT 3 2012-02-12 "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\-lrt\fP or \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 CONFORMING TO
 144 POSIX.1-2001.
 145 .SH NOTES
 146 A signal handler always interrupts a blocked call to
 147 one of these functions, regardless of the use of the
 148 .BR sigaction (2)
 149 .B SA_RESTART
 150 flag.
 151 .\" sem_wait() is always interrupted on most other implementations,
 152 .\" but on FreeBSD 5.4 SA_RESTART does cause restarting.
 153 .SH EXAMPLE
 154 .PP
 155 The (somewhat trivial) program shown below operates on an
 156 unnamed semaphore.
 157 The program expects two command-line arguments.
 158 The first argument specifies a seconds value that is used to
 159 set an alarm timer to generate a
 160 .B SIGALRM
 161 signal.
 162 This handler performs a
 163 .BR sem_post (3)
 164 to increment the semaphore that is being waited on in
 165 .I main()
 166 using
 167 .BR sem_timedwait ().
 168 The second command-line argument specifies the length
 169 of the timeout, in seconds, for
 170 .BR sem_timedwait ().
 171 The following shows what happens on two different runs of the program:
 172
 173 .in +4n
 174 .nf
 175 .RB "$" " ./a.out 2 3"
 176 About to call sem_timedwait()
 177 sem_post() from handler
 178 sem_timedwait() succeeded
 179 .RB "$" " ./a.out 2 1"
 180 About to call sem_timedwait()
 181 sem_timedwait() timed out
 182 .fi
 183 .in
 184 .SS Program source
 185 \&
 186 .nf
 187 #include <unistd.h>
 188 #include <stdio.h>
 189 #include <stdlib.h>
 190 #include <semaphore.h>
 191 #include <time.h>
 192 #include <assert.h>
 193 #include <errno.h>
 194 #include <signal.h>
 195
 196 sem_t sem;
 197
 198 #define handle_error(msg) \\
 199     do { perror(msg); exit(EXIT_FAILURE); } while (0)
 200
 201 static void
 202 handler(int sig)
 203 {
 204     write(STDOUT_FILENO, "sem_post() from handler\\n", 24);
 205     if (sem_post(&sem) == \-1) {
 206         write(STDERR_FILENO, "sem_post() failed\\n", 18);
 207         _exit(EXIT_FAILURE);
 208     }
 209 }
 210
 211 int
 212 main(int argc, char *argv[])
 213 {
 214     struct sigaction sa;
 215     struct timespec ts;
 216     int s;
 217
 218     if (argc != 3) {
 219         fprintf(stderr, "Usage: %s <alarm\-secs> <wait\-secs>\\n",
 220                 argv[0]);
 221         exit(EXIT_FAILURE);
 222     }
 223
 224     if (sem_init(&sem, 0, 0) == \-1)
 225         handle_error("sem_init");
 226
 227     /* Establish SIGALRM handler; set alarm timer using argv[1] */
 228
 229     sa.sa_handler = handler;
 230     sigemptyset(&sa.sa_mask);
 231     sa.sa_flags = 0;
 232     if (sigaction(SIGALRM, &sa, NULL) == \-1)
 233         handle_error("sigaction");
 234
 235     alarm(atoi(argv[1]));
 236
 237     /* Calculate relative interval as current time plus
 238        number of seconds given argv[2] */
 239
 240     if (clock_gettime(CLOCK_REALTIME, &ts) == \-1)
 241         handle_error("clock_gettime");
 242
 243     ts.tv_sec += atoi(argv[2]);
 244
 245     printf("main() about to call sem_timedwait()\\n");
 246     while ((s = sem_timedwait(&sem, &ts)) == \-1 && errno == EINTR)
 247         continue;       /* Restart if interrupted by handler */
 248
 249     /* Check what happened */
 250
 251     if (s == \-1) {
 252         if (errno == ETIMEDOUT)
 253             printf("sem_timedwait() timed out\\n");
 254         else
 255             perror("sem_timedwait");
 256     } else
 257         printf("sem_timedwait() succeeded\\n");
 258
 259     exit((s == 0) ? EXIT_SUCCESS : EXIT_FAILURE);
 260 }
 261 .fi
 262 .SH "SEE ALSO"
 263 .BR clock_gettime (2),
 264 .BR sem_getvalue (3),
 265 .BR sem_post (3),
 266 .BR sem_overview (7),
 267 .BR time (7)