ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/IO-AIO/README
(Generate patch)

Comparing IO-AIO/README (file contents):
Revision 1.2 by root, Sun Jul 10 18:16:49 2005 UTC vs.
Revision 1.12 by root, Tue Aug 23 00:05:00 2005 UTC

1NAME 1NAME
2 IO::AIO - Asynchronous Input/Output 2 IO::AIO - Asynchronous Input/Output
3 3
4SYNOPSIS 4SYNOPSIS
5 use IO::AIO; 5 use IO::AIO;
6
7 aio_open "/etc/passwd", O_RDONLY, 0, sub {
8 my ($fh) = @_;
9 ...
10 };
11
12 aio_unlink "/tmp/file", sub { };
13
14 aio_read $fh, 30000, 1024, $buffer, 0, sub {
15 $_[0] > 0 or die "read error: $!";
16 };
17
18 # Event
19 Event->io (fd => IO::AIO::poll_fileno,
20 poll => 'r',
21 cb => \&IO::AIO::poll_cb);
22
23 # Glib/Gtk2
24 add_watch Glib::IO IO::AIO::poll_fileno,
25 in => sub { IO::AIO::poll_cb; 1 };
26
27 # Tk
28 Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
29 readable => \&IO::AIO::poll_cb);
30
31 # Danga::Socket
32 Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
33 \&IO::AIO::poll_cb);
6 34
7DESCRIPTION 35DESCRIPTION
8 This module implements asynchronous I/O using whatever means your 36 This module implements asynchronous I/O using whatever means your
9 operating system supports. 37 operating system supports.
10 38
… …
17 currently, for example), and they would only support aio_read and 45 currently, for example), and they would only support aio_read and
18 aio_write, so the remaining functionality would have to be implemented 46 aio_write, so the remaining functionality would have to be implemented
19 using threads anyway. 47 using threads anyway.
20 48
21 Although the module will work with in the presence of other threads, it 49 Although the module will work with in the presence of other threads, it
22 is currently not reentrant, so use appropriate locking yourself. 50 is currently not reentrant, so use appropriate locking yourself, always
51 call "poll_cb" from within the same thread, or never call "poll_cb" (or
52 other "aio_" functions) recursively.
23 53
24 API NOTES 54FUNCTIONS
55 AIO FUNCTIONS
25 All the "aio_*" calls are more or less thin wrappers around the syscall 56 All the "aio_*" calls are more or less thin wrappers around the syscall
26 with the same name (sans "aio_"). The arguments are similar or 57 with the same name (sans "aio_"). The arguments are similar or
27 identical, and they all accept an additional $callback argument which 58 identical, and they all accept an additional (and optional) $callback
28 must be a code reference. This code reference will get called with the 59 argument which must be a code reference. This code reference will get
29 syscall return code (e.g. most syscalls return -1 on error, unlike perl, 60 called with the syscall return code (e.g. most syscalls return -1 on
30 which usually delivers "false") as it's sole argument when the given 61 error, unlike perl, which usually delivers "false") as it's sole
31 syscall has been executed asynchronously. 62 argument when the given syscall has been executed asynchronously.
32 63
33 All functions that expect a filehandle will also accept a file 64 All functions expecting a filehandle keep a copy of the filehandle
34 descriptor. 65 internally until the request has finished.
35 66
36 The filenames you pass to these routines *must* be absolute. The reason 67 The pathnames you pass to these routines *must* be absolute and encoded
37 is that at the time the request is being executed, the current working 68 in byte form. The reason for the former is that at the time the request
38 directory could have changed. Alternatively, you can make sure that you 69 is being executed, the current working directory could have changed.
39 never change the current working directory. 70 Alternatively, you can make sure that you never change the current
71 working directory.
40 72
41 IO::AIO::min_parallel $nthreads 73 To encode pathnames to byte form, either make sure you either: a) always
42 Set the minimum number of AIO threads to $nthreads. The default is 74 pass in filenames you got from outside (command line, readdir etc.), b)
43 1, which means a single asynchronous operation can be done at one 75 are ASCII or ISO 8859-1, c) use the Encode module and encode your
44 time (the number of outstanding operations, however, is unlimited). 76 pathnames to the locale (or other) encoding in effect in the user
45 77 environment, d) use Glib::filename_from_unicode on unicode filenames or
46 It is recommended to keep the number of threads low, as some linux 78 e) use something else.
47 kernel versions will scale negatively with the number of threads
48 (higher parallelity => MUCH higher latency).
49
50 Under normal circumstances you don't need to call this function, as
51 this module automatically starts a single async thread.
52
53 IO::AIO::max_parallel $nthreads
54 Sets the maximum number of AIO threads to $nthreads. If more than
55 the specified number of threads are currently running, kill them.
56 This function blocks until the limit is reached.
57
58 This module automatically runs "max_parallel 0" at program end, to
59 ensure that all threads are killed and that there are no outstanding
60 requests.
61
62 Under normal circumstances you don't need to call this function.
63
64 $fileno = IO::AIO::poll_fileno
65 Return the *request result pipe filehandle*. This filehandle must be
66 polled for reading by some mechanism outside this module (e.g. Event
67 or select, see below). If the pipe becomes readable you have to call
68 "poll_cb" to check the results.
69
70 See "poll_cb" for an example.
71
72 IO::AIO::poll_cb
73 Process all outstanding events on the result pipe. You have to call
74 this regularly. Returns the number of events processed. Returns
75 immediately when no events are outstanding.
76
77 You can use Event to multiplex, e.g.:
78
79 Event->io (fd => IO::AIO::poll_fileno,
80 poll => 'r', async => 1,
81 cb => \&IO::AIO::poll_cb);
82
83 IO::AIO::poll_wait
84 Wait till the result filehandle becomes ready for reading (simply
85 does a select on the filehandle. This is useful if you want to
86 synchronously wait for some requests to finish).
87
88 See "nreqs" for an example.
89
90 IO::AIO::nreqs
91 Returns the number of requests currently outstanding.
92
93 Example: wait till there are no outstanding requests anymore:
94
95 IO::AIO::poll_wait, IO::AIO::poll_cb
96 while IO::AIO::nreqs;
97 79
98 aio_open $pathname, $flags, $mode, $callback 80 aio_open $pathname, $flags, $mode, $callback
99 Asynchronously open or create a file and call the callback with a 81 Asynchronously open or create a file and call the callback with a
100 newly created filehandle for the file. 82 newly created filehandle for the file.
101 83
102 The pathname passed to "aio_open" must be absolute. See API NOTES, 84 The pathname passed to "aio_open" must be absolute. See API NOTES,
103 above, for an explanation. 85 above, for an explanation.
104 86
105 The $mode argument is a bitmask. See the "Fcntl" module for a list. 87 The $flags argument is a bitmask. See the "Fcntl" module for a list.
106 They are the same as used in "sysopen". 88 They are the same as used by "sysopen".
89
90 Likewise, $mode specifies the mode of the newly created file, if it
91 didn't exist and "O_CREAT" has been given, just like perl's
92 "sysopen", except that it is mandatory (i.e. use 0 if you don't
93 create new files, and 0666 or 0777 if you do).
107 94
108 Example: 95 Example:
109 96
110 aio_open "/etc/passwd", O_RDONLY, 0, sub { 97 aio_open "/etc/passwd", O_RDONLY, 0, sub {
111 if ($_[0]) { 98 if ($_[0]) {
… …
118 105
119 aio_close $fh, $callback 106 aio_close $fh, $callback
120 Asynchronously close a file and call the callback with the result 107 Asynchronously close a file and call the callback with the result
121 code. *WARNING:* although accepted, you should not pass in a perl 108 code. *WARNING:* although accepted, you should not pass in a perl
122 filehandle here, as perl will likely close the file descriptor 109 filehandle here, as perl will likely close the file descriptor
123 itself when the filehandle is destroyed. Normally, you can safely 110 another time when the filehandle is destroyed. Normally, you can
124 call perls "close" or just let filehandles go out of scope. 111 safely call perls "close" or just let filehandles go out of scope.
112
113 This is supposed to be a bug in the API, so that might change. It's
114 therefore best to avoid this function.
125 115
126 aio_read $fh,$offset,$length, $data,$dataoffset,$callback 116 aio_read $fh,$offset,$length, $data,$dataoffset,$callback
127 aio_write $fh,$offset,$length, $data,$dataoffset,$callback 117 aio_write $fh,$offset,$length, $data,$dataoffset,$callback
128 Reads or writes "length" bytes from the specified "fh" and "offset" 118 Reads or writes "length" bytes from the specified "fh" and "offset"
129 into the scalar given by "data" and offset "dataoffset" and calls 119 into the scalar given by "data" and offset "dataoffset" and calls
130 the callback without the actual number of bytes read (or -1 on 120 the callback without the actual number of bytes read (or -1 on
131 error, just like the syscall). 121 error, just like the syscall).
132 122
123 The $data scalar *MUST NOT* be modified in any way while the request
124 is outstanding. Modifying it can result in segfaults or WW3 (if the
125 necessary/optional hardware is installed).
126
133 Example: Read 15 bytes at offset 7 into scalar $buffer, strating at 127 Example: Read 15 bytes at offset 7 into scalar $buffer, starting at
134 offset 0 within the scalar: 128 offset 0 within the scalar:
135 129
136 aio_read $fh, 7, 15, $buffer, 0, sub { 130 aio_read $fh, 7, 15, $buffer, 0, sub {
137 $_[0] >= 0 or die "read error: $!"; 131 $_[0] > 0 or die "read error: $!";
138 print "read <$buffer>\n"; 132 print "read $_[0] bytes: <$buffer>\n";
139 }; 133 };
140 134
135 aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback
136 Tries to copy $length bytes from $in_fh to $out_fh. It starts
137 reading at byte offset $in_offset, and starts writing at the current
138 file offset of $out_fh. Because of that, it is not safe to issue
139 more than one "aio_sendfile" per $out_fh, as they will interfere
140 with each other.
141
142 This call tries to make use of a native "sendfile" syscall to
143 provide zero-copy operation. For this to work, $out_fh should refer
144 to a socket, and $in_fh should refer to mmap'able file.
145
146 If the native sendfile call fails or is not implemented, it will be
147 emulated, so you can call "aio_sendfile" on any type of filehandle
148 regardless of the limitations of the operating system.
149
150 Please note, however, that "aio_sendfile" can read more bytes from
151 $in_fh than are written, and there is no way to find out how many
152 bytes have been read from "aio_sendfile" alone, as "aio_sendfile"
153 only provides the number of bytes written to $out_fh. Only if the
154 result value equals $length one can assume that $length bytes have
155 been read.
156
141 aio_readahead $fh,$offset,$length, $callback 157 aio_readahead $fh,$offset,$length, $callback
142 Asynchronously reads the specified byte range into the page cache,
143 using the "readahead" syscall. If that syscall doesn't exist the
144 status will be -1 and $! is set to ENOSYS.
145
146 readahead() populates the page cache with data from a file so that 158 "aio_readahead" populates the page cache with data from a file so
147 subsequent reads from that file will not block on disk I/O. The 159 that subsequent reads from that file will not block on disk I/O. The
148 $offset argument specifies the starting point from which data is to 160 $offset argument specifies the starting point from which data is to
149 be read and $length specifies the number of bytes to be read. I/O is 161 be read and $length specifies the number of bytes to be read. I/O is
150 performed in whole pages, so that offset is effectively rounded down 162 performed in whole pages, so that offset is effectively rounded down
151 to a page boundary and bytes are read up to the next page boundary 163 to a page boundary and bytes are read up to the next page boundary
152 greater than or equal to (off-set+length). aio_readahead() does not 164 greater than or equal to (off-set+length). "aio_readahead" does not
153 read beyond the end of the file. The current file offset of the file 165 read beyond the end of the file. The current file offset of the file
154 is left unchanged. 166 is left unchanged.
167
168 If that syscall doesn't exist (likely if your OS isn't Linux) it
169 will be emulated by simply reading the data, which would have a
170 similar effect.
155 171
156 aio_stat $fh_or_path, $callback 172 aio_stat $fh_or_path, $callback
157 aio_lstat $fh, $callback 173 aio_lstat $fh, $callback
158 Works like perl's "stat" or "lstat" in void context. The callback 174 Works like perl's "stat" or "lstat" in void context. The callback
159 will be called after the stat and the results will be available 175 will be called after the stat and the results will be available
… …
176 192
177 aio_unlink $pathname, $callback 193 aio_unlink $pathname, $callback
178 Asynchronously unlink (delete) a file and call the callback with the 194 Asynchronously unlink (delete) a file and call the callback with the
179 result code. 195 result code.
180 196
197 aio_rmdir $pathname, $callback
198 Asynchronously rmdir (delete) a directory and call the callback with
199 the result code.
200
181 aio_fsync $fh, $callback 201 aio_fsync $fh, $callback
182 Asynchronously call fsync on the given filehandle and call the 202 Asynchronously call fsync on the given filehandle and call the
183 callback with the fsync result code. 203 callback with the fsync result code.
184 204
185 aio_fdatasync $fh, $callback 205 aio_fdatasync $fh, $callback
186 Asynchronously call fdatasync on the given filehandle and call the 206 Asynchronously call fdatasync on the given filehandle and call the
187 callback with the fdatasync result code. 207 callback with the fdatasync result code.
188 208
189BUGS 209 If this call isn't available because your OS lacks it or it couldn't
190 - could be optimized to use more semaphores instead of filehandles. 210 be detected, it will be emulated by calling "fsync" instead.
211
212 SUPPORT FUNCTIONS
213 $fileno = IO::AIO::poll_fileno
214 Return the *request result pipe file descriptor*. This filehandle
215 must be polled for reading by some mechanism outside this module
216 (e.g. Event or select, see below or the SYNOPSIS). If the pipe
217 becomes readable you have to call "poll_cb" to check the results.
218
219 See "poll_cb" for an example.
220
221 IO::AIO::poll_cb
222 Process all outstanding events on the result pipe. You have to call
223 this regularly. Returns the number of events processed. Returns
224 immediately when no events are outstanding.
225
226 Example: Install an Event watcher that automatically calls
227 IO::AIO::poll_cb with high priority:
228
229 Event->io (fd => IO::AIO::poll_fileno,
230 poll => 'r', async => 1,
231 cb => \&IO::AIO::poll_cb);
232
233 IO::AIO::poll_wait
234 Wait till the result filehandle becomes ready for reading (simply
235 does a "select" on the filehandle. This is useful if you want to
236 synchronously wait for some requests to finish).
237
238 See "nreqs" for an example.
239
240 IO::AIO::nreqs
241 Returns the number of requests currently outstanding (i.e. for which
242 their callback has not been invoked yet).
243
244 Example: wait till there are no outstanding requests anymore:
245
246 IO::AIO::poll_wait, IO::AIO::poll_cb
247 while IO::AIO::nreqs;
248
249 IO::AIO::flush
250 Wait till all outstanding AIO requests have been handled.
251
252 Strictly equivalent to:
253
254 IO::AIO::poll_wait, IO::AIO::poll_cb
255 while IO::AIO::nreqs;
256
257 IO::AIO::poll
258 Waits until some requests have been handled.
259
260 Strictly equivalent to:
261
262 IO::AIO::poll_wait, IO::AIO::poll_cb
263 if IO::AIO::nreqs;
264
265 IO::AIO::min_parallel $nthreads
266 Set the minimum number of AIO threads to $nthreads. The current
267 default is 4, which means four asynchronous operations can be done
268 at one time (the number of outstanding operations, however, is
269 unlimited).
270
271 IO::AIO starts threads only on demand, when an AIO request is queued
272 and no free thread exists.
273
274 It is recommended to keep the number of threads low, as some Linux
275 kernel versions will scale negatively with the number of threads
276 (higher parallelity => MUCH higher latency). With current Linux 2.6
277 versions, 4-32 threads should be fine.
278
279 Under most circumstances you don't need to call this function, as
280 the module selects a default that is suitable for low to moderate
281 load.
282
283 IO::AIO::max_parallel $nthreads
284 Sets the maximum number of AIO threads to $nthreads. If more than
285 the specified number of threads are currently running, this function
286 kills them. This function blocks until the limit is reached.
287
288 While $nthreads are zero, aio requests get queued but not executed
289 until the number of threads has been increased again.
290
291 This module automatically runs "max_parallel 0" at program end, to
292 ensure that all threads are killed and that there are no outstanding
293 requests.
294
295 Under normal circumstances you don't need to call this function.
296
297 $oldnreqs = IO::AIO::max_outstanding $nreqs
298 Sets the maximum number of outstanding requests to $nreqs. If you
299 try to queue up more than this number of requests, the caller will
300 block until some requests have been handled.
301
302 The default is very large, so normally there is no practical limit.
303 If you queue up many requests in a loop it often improves speed if
304 you set this to a relatively low number, such as 100.
305
306 Under normal circumstances you don't need to call this function.
307
308 FORK BEHAVIOUR
309 Before the fork, IO::AIO enters a quiescent state where no requests can
310 be added in other threads and no results will be processed. After the
311 fork the parent simply leaves the quiescent state and continues
312 request/result processing, while the child clears the request/result
313 queue (so the requests started before the fork will only be handled in
314 the parent). Threats will be started on demand until the limit ste in
315 the parent process has been reached again.
191 316
192SEE ALSO 317SEE ALSO
193 Coro, Linux::AIO. 318 Coro, Linux::AIO.
194 319
195AUTHOR 320AUTHOR

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines