2 .\" Copyright (c) 2004 The DragonFly Project. All rights reserved.
4 .\" This code is derived from software contributed to The DragonFly Project
5 .\" by Hiten Pandya <hmp@backplane.com>.
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
11 .\" 1. Redistributions of source code must retain the above copyright
12 .\" notice, this list of conditions and the following disclaimer.
13 .\" 2. Redistributions in binary form must reproduce the above copyright
14 .\" notice, this list of conditions and the following disclaimer in
15 .\" the documentation and/or other materials provided with the
17 .\" 3. Neither the name of The DragonFly Project nor the names of its
18 .\" contributors may be used to endorse or promote products derived
19 .\" from this software without specific, prior written permission.
21 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 .\" Copyright (c) 1996 Joerg Wunsch
36 .\" All rights reserved.
38 .\" Redistribution and use in source and binary forms, with or without
39 .\" modification, are permitted provided that the following conditions
41 .\" 1. Redistributions of source code must retain the above copyright
42 .\" notice, this list of conditions and the following disclaimer.
43 .\" 2. Redistributions in binary form must reproduce the above copyright
44 .\" notice, this list of conditions and the following disclaimer in the
45 .\" documentation and/or other materials provided with the distribution.
47 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
48 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
49 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
50 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
51 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
52 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
53 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
54 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
55 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
56 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
58 .\" $FreeBSD: src/share/man/man9/sleep.9,v 1.18.2.5 2001/12/17 11:30:19 ru Exp $
59 .\" $DragonFly: src/share/man/man9/sleep.9,v 1.11 2008/03/05 17:20:23 swildner Exp $
71 .Nd wait/sleep/block for events
78 .Fn tsleep "void *ident" "int flag" "const char *wmesg" "int timo"
80 .Fn ssleep "void *ident" "struct spinlock *spin" "int flag" "const char *wmesg" "int timo"
82 .Fn lksleep "void *ident" "struct lock *lock" "int flag" "const char *wmesg" "int timo"
84 .Fn zsleep "void *ident" "struct lwkt_serialize *slz" "int flag" "const char *wmesg" "int timo"
86 .Fn wakeup "void *ident"
88 .Fn wakeup_one "void *ident"
97 handle event-based process blocking.
98 If a process must wait for an
99 external event, it is put on sleep by
107 is an arbitrary address that uniquely identifies the event on which
108 the process is being asleep.
109 All processes sleeping on a single
111 are woken up later by
113 often called from inside an interrupt routine, to indicate that the
114 resource the process/thread was blocking on is available now.
118 is a string describing the sleep condition for tools like
120 Due to the limited space of those programs to display arbitrary strings,
121 this message should not be longer than 6 characters.
125 function is used to make the first process/thread in the queue that is
126 sleeping on the parameter
129 This can prevent the system from becoming saturated
130 when a large number of processes/threads are sleeping on the same address,
131 but only one of them can actually do any useful work when made
136 function is general in its use and suspends the current process/thread until a
137 wakeup is performed on the specified identifier.
138 The process/thread will then be made runnable.
139 The process/thread will sleep at most
141 \&/ hz seconds (0 means no timeout).
146 flag, signals are checked before and after sleeping, else signals are
153 while at the same time releasing the exclusive (write) spinlock
155 before sleeping and reacquiring it before
158 This is an atomic operation, which guarantees that a
168 while at the same time releasing the exclusive lockmgr lock
170 before sleeping and reacquiring it before
173 This is an atomic operation, which guarantees that a
183 while at the same time releasing the serializer
185 before sleeping and reacquiring it before
188 This is an atomic operation, which guarantees that a
193 .Sh IMPLEMENTATION NOTES
200 ignores priority information because it is not required by the
205 flag set are assumed to be disk-waits, otherwise they are
212 if awakened, otherwise an appropriate error code is returned.
215 .It Bq Er EWOULDBLOCK
218 A signal needs to be delivered and the system call should
219 be restarted if possible.
225 The system call needs to be interrupted by the signal.
236 The sleep/wakeup process synchronization mechanism is very old.
237 It appeared in a very early version of Unix.
244 This manual page was written by
249 .An Hiten Pandya Aq hmp@dragonflybsd.org