SLEEP(9)

NAME
sleep, tsleep, wakeup - wait for events

SYNOPSIS
#include <sys/param.h>
#include <sys/systm.h>
#include <sys/proc.h>
#include <sys/errno.h>
int
tsleep(void *ident, int priority, char *wmesg, int timo);
void
wakeup(void *ident);
void
wakeup_one(void *ident);
int
sleep(void *ident, int priority);

DESCRIPTION
The functions tsleep() and wakeup() handle event-based process blocking. If a process must wait for an external event, it is put on sleep by tsleep. The parameter ident is an arbitrary address that uniquely identifies the event on which the process is being asleep. All processes sleeping on a single ident are woken up later by wakeup, often called from inside an interrupt routine, to indicate that the resource the process was blocking on is available now.

The parameter wmesg is a string describing the sleep condition for tools like ps(1). Due to the limited space of those programs to display arbitrary strings, this message should not be longer than 6 characters.

The wakeup_one() function is used to make the first process in the queue that is sleeping on the parameter ident runnable. This can prevent the system from becoming saturated when a large number of processes are sleeping on the same address, but only one of them can actually do any useful work when made runnable.

Tsleep is the general sleep call. Suspends the current process until a wakeup is performed on the specified identifier. The process will then be made runnable with the specified priority. Sleeps at most timo / hz seconds (0 means no timeout). If pri includes the PCATCH flag, signals are checked before and after sleeping, else signals are not checked. Returns 0 if awakened, EWOULDBLOCK if the timeout expires. If PCATCH is set and a signal needs to be delivered, ERESTART is returned if the current system call should be restarted if possible, and EINTR is returned if the system call should be interrupted by the signal (return EINTR).

Sleep is the traditional form. It doesn't let you specify a timeout nor a wmesg, hence its use is deprecated.

RETURN VALUES
See above.

SEE ALSO
ps(1)

HISTORY
The sleep/wakeup process synchronization mechanism is very old. It appeared in a very early version of Unix.

Tsleep appeared in 4.4BSD.

AUTHORS
This man page has been written by Joerg Wunsch.