sem_waitのヘルプ・マニュアル
日本語 英語
sem_wait --help
man sem_wait
SEM_WAIT(3) Linux Programmer’s Manual SEM_WAIT(3)
名前
sem_wait, sem_timedwait, sem_trywait - セマフォをロックする
書式
#include
int sem_wait(sem_t *sem);
int sem_trywait(sem_t *sem);
int sem_timedwait(sem_t *sem, const struct timespec *abs_timeout);
-lrt または -pthread でリンクする。
glibc 向けの機能検査マクロの要件 (feature_test_macros(7) 参照):
sem_timedwait(): _POSIX_C_SOURCE >= 200112L || _XOPEN_SOURCE >= 600
説明
sem_wait() は sem が指すセマフォの値を 1 減らす (ロックする)。セマフォ
の値が 0 より大きい場合、減算が実行され、関数は直ちに復帰する。セマフォ
の現在値が 0 の場合には、減算を実行できるようになる (つまり、セマフォの
値が 0 より大きな値になる) まで、もしくはシグナルハンドラによって呼び出
しが中断されるまで、関数呼び出しは停止 (block) する。
sem_trywait() は sem_wait() と同じだが、セマフォ値の減算をすぐに実行で
きなかった場合に、停止 (block) するのではなくエラーで復帰する (errno に
EAGAIN がセットされる) 点が異なる。
sem_timedwait() は sem_wait() と同じだが、セマフォ値の減算をすぐに実行
できなかった場合に関数呼び出しが停止する時間の上限を abs_timeout で指定
する点が異なる。 abs_timeout 引き数は、タイムアウト時刻を指定する構造体
へのポインタである。この構造体には、タイムアウト時刻を時刻紀元 (Epoch;
1970 年 1 月 1 日 00:00:00) からの経過時間 (秒＋ナノ秒) で指定する。構
造体は以下のように定義されている:
struct timespec {
time_t tv_sec; /* Seconds */
long tv_nsec; /* Nanoseconds [0 .. 999999999] */
};
関数呼び出し時点ですでにタイムアウトに指定した時刻が過ぎており、かつ セ
マフォをすぐにロックできなかった場合は、 sem_timedwait() はタイムアウト
エラー (errno に ETIMEDOUT がセットされる) で失敗する。
セマフォ操作がすぐに実行できるときは、 abs_timeout がどんな値であっても
sem_timedwait() が失敗することは決してない。さらにいうと、この場合には
abs_timeout の正当性の検査は行われない。
返り値
成功すると、これらの関数は 0 を返す。エラーの場合、セマフォの値を変更せ
ずに、-1 を返し、 errno にエラーを示す値をセットする。
エラー
EINTR 呼び出しはシグナルハンドラにより中断された。 signal(7) 参照。
EINVAL sem は有効なセマフォでない。
sem_trywait() の場合には、上記に加えて以下のエラーも起こる。
EAGAIN 停止 (block) せずにロック操作を完了できなかった (つまり、セマフ
ォの現在の値が 0 であった)。
sem_timedwait() の場合、以下のエラーも起こる。
EINVAL abs_timeout.tv_nsecs の値が 0 未満、もしくは 1,000,000,000 以 上
である。
ETIMEDOUT
セマフォのロックに成功する前に時間切れとなった。 POSIX.1-2001.
注意
シ グナルハンドラは、 sigaction(2) の SA_RESTART フラグを使用しているか
どうかに関わらず、これらの関数の呼び出しが停止している場合、シグナル ハ
ンドラにより常に中断される。
例
以 下に示す (ちょっとした) プログラムは名前なしセマフォの操作を行う。プ
ログラムはコマンドライン引き数を 2 つ取る。最初の引き数には 、 SIGALRM
シ グナルを生成するためのアラームタイマーの設定に使われる値を秒単位で指
定する。このシグナルハンドラは、 main() 内で sem_timedwait() を使って待
っているセマフォを、 sem_post(3) を使って加算する。 2番目の引き数には、
sem_timedwait() に渡すタイムアウトまでの時間を秒単位で指定する。
$ ./a.out 2 3
About to call sem_timedwait()
sem_post() from handler
sem_getvalue() from handler; value = 1
sem_timedwait() succeeded
$ ./a.out 2 1
About to call sem_timedwait()
sem_timedwait() timed out
プログラムのソース
#include
#include
#include
#include
#include
#include
#include
#include
sem_t sem;
#define handle_error(msg) \
do { perror(msg); exit(EXIT_FAILURE); } while (0)
static void
handler(int sig)
{
write(STDOUT_FILENO, "sem_post() from handler\n", 24);
if (sem_post(&sem) == -1) {
write(STDERR_FILENO, "sem_post() failed\n", 18);
_exit(EXIT_FAILURE);
}
}
int
main(int argc, char *argv[])
{
struct sigaction sa;
struct timespec ts;
int s;
if (argc != 3) {
fprintf(stderr, "Usage: %s \n",
argv[0]);
exit(EXIT_FAILURE);
}
if (sem_init(&sem, 0, 0) == -1)
handle_error("sem_init");
/* Establish SIGALRM handler; set alarm timer using argv[1] */
sa.sa_handler = handler;
sigemptyset(&sa.sa_mask);
sa.sa_flags = 0;
if (sigaction(SIGALRM, &sa, NULL) == -1)
handle_error("sigaction");
alarm(atoi(argv[1]));
/* Calculate relative interval as current time plus
number of seconds given argv[2] */
if (clock_gettime(CLOCK_REALTIME, &ts) == -1)
handle_error("clock_gettime");
ts.tv_sec += atoi(argv[2]);
printf("main() about to call sem_timedwait()\n");
while ((s = sem_timedwait(&sem, &ts)) == -1 && errno == EINTR)
continue; /* Restart if interrupted by handler */
/* Check what happened */
if (s == -1) {
if (errno == ETIMEDOUT)
printf("sem_timedwait() timed out\n");
else
perror("sem_timedwait");
} else
printf("sem_timedwait() succeeded\n");
exit((s == 0) ? EXIT_SUCCESS : EXIT_FAILURE);
}
関連項目
clock_gettime(2), sem_getvalue(3), sem_post(3), sem_overview(7),
time(7)
Linux 2009-02-09 SEM_WAIT(3)
SEM_WAIT(3) Linux Programmer’s Manual SEM_WAIT(3)
NAME
sem_wait, sem_timedwait, sem_trywait - lock a semaphore
SYNOPSIS
#include
int sem_wait(sem_t *sem);
int sem_trywait(sem_t *sem);
int sem_timedwait(sem_t *sem, const struct timespec *abs_timeout);
Link with -lrt or -pthread.
Feature Test Macro Requirements for glibc (see feature_test_macros(7)):
sem_timedwait(): _POSIX_C_SOURCE >= 200112L || _XOPEN_SOURCE >= 600
DESCRIPTION
sem_wait() decrements (locks) the semaphore pointed to by sem. If the
semaphore’s value is greater than zero, then the decrement proceeds,
and the function returns, immediately. If the semaphore currently has
the value zero, then the call blocks until either it becomes possible
to perform the decrement (i.e., the semaphore value rises above zero),
or a signal handler interrupts the call.
sem_trywait() is the same as sem_wait(), except that if the decrement
cannot be immediately performed, then call returns an error (errno set
to EAGAIN) instead of blocking.
sem_timedwait() is the same as sem_wait(), except that abs_timeout
specifies a limit on the amount of time that the call should block if
the decrement cannot be immediately performed. The abs_timeout argu-
ment points to a structure that specifies an absolute timeout in sec-
onds and nanoseconds since the Epoch (00:00:00, 1 January 1970). This
structure is defined as follows:
struct timespec {
time_t tv_sec; /* Seconds */
long tv_nsec; /* Nanoseconds [0 .. 999999999] */
};
If the timeout has already expired by the time of the call, and the
semaphore could not be locked immediately, then sem_timedwait() fails
with a timeout error (errno set to ETIMEDOUT).
If the operation can be performed immediately, then sem_timedwait()
never fails with a timeout error, regardless of the value of abs_time-
out. Furthermore, the validity of abs_timeout is not checked in this
case.
RETURN VALUE
All of these functions return 0 on success; on error, the value of the
semaphore is left unchanged, -1 is returned, and errno is set to indi-
cate the error.
ERRORS
EINTR The call was interrupted by a signal handler; see signal(7).
EINVAL sem is not a valid semaphore.
The following additional error can occur for sem_trywait():
EAGAIN The operation could not be performed without blocking (i.e., the
semaphore currently has the value zero).
The following additional errors can occur for sem_timedwait():
EINVAL The value of abs_timeout.tv_nsecs is less than 0, or greater
than or equal to 1000 million.
ETIMEDOUT
The call timed out before the semaphore could be locked.
CONFORMING TO
POSIX.1-2001.
NOTES
A signal handler always interrupts a blocked call to one of these func-
tions, regardless of the use of the sigaction(2) SA_RESTART flag.
EXAMPLE
The (somewhat trivial) program shown below operates on an unnamed
semaphore. The program expects two command-line arguments. The first
argument specifies a seconds value that is used to set an alarm timer
to generate a SIGALRM signal. This handler performs a sem_post(3) to
increment the semaphore that is being waited on in main() using
sem_timedwait(). The second command-line argument specifies the length
of the timeout, in seconds, for sem_timedwait(). The following shows
what happens on two different runs of the program:
$ ./a.out 2 3
About to call sem_timedwait()
sem_post() from handler
sem_getvalue() from handler; value = 1
sem_timedwait() succeeded
$ ./a.out 2 1
About to call sem_timedwait()
sem_timedwait() timed out
Program source
#include
#include
#include
#include
#include
#include
#include
#include
sem_t sem;
#define handle_error(msg) \
do { perror(msg); exit(EXIT_FAILURE); } while (0)
static void
handler(int sig)
{
write(STDOUT_FILENO, "sem_post() from handler\n", 24);
if (sem_post(&sem) == -1) {
write(STDERR_FILENO, "sem_post() failed\n", 18);
_exit(EXIT_FAILURE);
}
}
int
main(int argc, char *argv[])
{
struct sigaction sa;
struct timespec ts;
int s;
if (argc != 3) {
fprintf(stderr, "Usage: %s \n",
argv[0]);
exit(EXIT_FAILURE);
}
if (sem_init(&sem, 0, 0) == -1)
handle_error("sem_init");
/* Establish SIGALRM handler; set alarm timer using argv[1] */
sa.sa_handler = handler;
sigemptyset(&sa.sa_mask);
sa.sa_flags = 0;
if (sigaction(SIGALRM, &sa, NULL) == -1)
handle_error("sigaction");
alarm(atoi(argv[1]));
/* Calculate relative interval as current time plus
number of seconds given argv[2] */
if (clock_gettime(CLOCK_REALTIME, &ts) == -1)
handle_error("clock_gettime");
ts.tv_sec += atoi(argv[2]);
printf("main() about to call sem_timedwait()\n");
while ((s = sem_timedwait(&sem, &ts)) == -1 && errno == EINTR)
continue; /* Restart if interrupted by handler */
/* Check what happened */
if (s == -1) {
if (errno == ETIMEDOUT)
printf("sem_timedwait() timed out\n");
else
perror("sem_timedwait");
} else
printf("sem_timedwait() succeeded\n");
exit((s == 0) ? EXIT_SUCCESS : EXIT_FAILURE);
}
SEE ALSO
clock_gettime(2), sem_getvalue(3), sem_post(3), sem_overview(7),
time(7)
COLOPHON
This page is part of release 3.22 of the Linux man-pages project. A
description of the project, and information about reporting bugs, can
be found at http://www.kernel.org/doc/man-pages/.
Linux 2009-02-09 SEM_WAIT(3)