Note that select behaves like sleep(3) when no descriptors are being checked.
[dragonfly.git] / lib / libc / sys / select.2
1 .\" Copyright (c) 1983, 1991, 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\"    must display the following acknowledgement:
14 .\"     This product includes software developed by the University of
15 .\"     California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\"     @(#)select.2    8.2 (Berkeley) 3/25/94
33 .\" $FreeBSD: src/lib/libc/sys/select.2,v 1.14.2.5 2001/12/14 18:34:01 ru Exp $
34 .\" $DragonFly: src/lib/libc/sys/select.2,v 1.3 2005/08/03 12:44:23 corecode Exp $
35 .\"
36 .Dd March 25, 1994
37 .Dt SELECT 2
38 .Os
39 .Sh NAME
40 .Nm select
41 .Nd synchronous I/O multiplexing
42 .Sh LIBRARY
43 .Lb libc
44 .Sh SYNOPSIS
45 .In sys/types.h
46 .In sys/time.h
47 .In unistd.h
48 .Ft int
49 .Fn select "int nfds" "fd_set *readfds" "fd_set *writefds" "fd_set *exceptfds" "struct timeval *timeout"
50 .Fn FD_SET fd &fdset
51 .Fn FD_CLR fd &fdset
52 .Fn FD_ISSET fd &fdset
53 .Fn FD_ZERO &fdset
54 .Sh DESCRIPTION
55 .Fn Select
56 examines the I/O descriptor sets whose addresses are passed in
57 .Fa readfds ,
58 .Fa writefds ,
59 and
60 .Fa exceptfds
61 to see if some of their descriptors
62 are ready for reading, are ready for writing, or have an exceptional
63 condition pending, respectively.
64 The only exceptional condition detectable is out-of-band
65 data received on a socket.
66 The first
67 .Fa nfds
68 descriptors are checked in each set;
69 i.e., the descriptors from 0 through
70 .Fa nfds Ns No -1
71 in the descriptor sets are examined.
72 On return,
73 .Fn select
74 replaces the given descriptor sets
75 with subsets consisting of those descriptors that are ready
76 for the requested operation.
77 .Fn Select
78 returns the total number of ready descriptors in all the sets.
79 .Pp
80 The descriptor sets are stored as bit fields in arrays of integers.
81 The following macros are provided for manipulating such descriptor sets:
82 .Fn FD_ZERO &fdset
83 initializes a descriptor set
84 .Fa fdset
85 to the null set.
86 .Fn FD_SET fd &fdset
87 includes a particular descriptor
88 .Fa fd
89 in
90 .Fa fdset .
91 .Fn FD_CLR fd &fdset
92 removes
93 .Fa fd
94 from
95 .Fa fdset .
96 .Fn FD_ISSET fd &fdset
97 is non-zero if
98 .Fa fd
99 is a member of
100 .Fa fdset ,
101 zero otherwise.
102 The behavior of these macros is undefined if
103 a descriptor value is less than zero or greater than or equal to
104 .Dv FD_SETSIZE ,
105 which is normally at least equal
106 to the maximum number of descriptors supported by the system.
107 .Pp
108 If
109 .Fa timeout
110 is a non-nil pointer, it specifies the maximum interval to wait for the
111 selection to complete.  System activity can lengthen the interval by
112 an indeterminate amount.
113 .Pp
114 If
115 .Fa timeout
116 is a nil pointer, the select blocks indefinitely.
117 .Pp
118 To effect a poll, the
119 .Fa timeout
120 argument should be non-nil, pointing to a zero-valued timeval structure.
121 .Pp
122 Any of
123 .Fa readfds ,
124 .Fa writefds ,
125 and
126 .Fa exceptfds
127 may be given as nil pointers if no descriptors are of interest.
128 .Pp
129 Even if no descriptors are of interest, the timeout works as described,
130 effectively making
131 .Fn select
132 behave like
133 .Xr sleep 3 .
134 .Sh RETURN VALUES
135 .Fn Select
136 returns the number of ready descriptors that are contained in
137 the descriptor sets,
138 or -1 if an error occurred.
139 If the time limit expires,
140 .Fn select
141 returns 0.
142 If
143 .Fn select
144 returns with an error,
145 including one due to an interrupted call,
146 the descriptor sets will be unmodified.
147 .Sh ERRORS
148 An error return from
149 .Fn select
150 indicates:
151 .Bl -tag -width Er
152 .It Bq Er EBADF
153 One of the descriptor sets specified an invalid descriptor.
154 .It Bq Er EINTR
155 A signal was delivered before the time limit expired and
156 before any of the selected events occurred.
157 .It Bq Er EINVAL
158 The specified time limit is invalid.  One of its components is
159 negative or too large.
160 .It Bq Er EINVAL
161 .Fa nfds
162 was invalid.
163 .El
164 .Sh SEE ALSO
165 .Xr accept 2 ,
166 .Xr connect 2 ,
167 .Xr getdtablesize 2 ,
168 .Xr gettimeofday 2 ,
169 .Xr read 2 ,
170 .Xr recv 2 ,
171 .Xr send 2 ,
172 .Xr write 2 ,
173 .Xr clocks 7
174 .Sh NOTES
175 The default size of
176 .Dv FD_SETSIZE
177 is currently 1024.
178 In order to accommodate programs which might potentially
179 use a larger number of open files with
180 .Fn select ,
181 it is possible
182 to increase this size by having the program define
183 .Dv FD_SETSIZE
184 before the inclusion of any header which includes
185 .Aq Pa sys/types.h .
186 .Pp
187 If
188 .Fa nfds
189 is greater than the number of open files,
190 .Fn select
191 is not guaranteed to examine the unused file descriptors.   For historical
192 reasons,
193 .Fn select
194 will always examine the first 256 descriptors.
195 .Sh BUGS
196 .St -susv2
197 allows systems to modify the original timeout in place.
198 Thus, it is unwise to assume that the timeout value will be unmodified
199 by the
200 .Fn select
201 call.
202 .Sh HISTORY
203 The
204 .Fn select
205 function call appeared in
206 .Bx 4.2 .