… | |
… | |
12 | }; |
12 | }; |
13 | |
13 | |
14 | aio_unlink "/tmp/file", sub { }; |
14 | aio_unlink "/tmp/file", sub { }; |
15 | |
15 | |
16 | aio_read $fh, 30000, 1024, $buffer, 0, sub { |
16 | aio_read $fh, 30000, 1024, $buffer, 0, sub { |
17 | $_[0] >= 0 or die "read error: $!"; |
17 | $_[0] > 0 or die "read error: $!"; |
18 | }; |
18 | }; |
19 | |
19 | |
20 | # Event |
20 | # Event |
21 | Event->io (fd => IO::AIO::poll_fileno, |
21 | Event->io (fd => IO::AIO::poll_fileno, |
22 | poll => 'r', |
22 | poll => 'r', |
23 | cb => \&IO::AIO::poll_cb); |
23 | cb => \&IO::AIO::poll_cb); |
24 | |
24 | |
25 | # Glib/Gtk2 |
25 | # Glib/Gtk2 |
26 | add_watch Glib::IO IO::AIO::poll_fileno, |
26 | add_watch Glib::IO IO::AIO::poll_fileno, |
27 | \&IO::AIO::poll_cb; |
27 | in => sub { IO::AIO::poll_cb; 1 }; |
28 | |
28 | |
29 | # Tk |
29 | # Tk |
30 | Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "", |
30 | Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "", |
31 | readable => \&IO::AIO::poll_cb); |
31 | readable => \&IO::AIO::poll_cb); |
|
|
32 | |
|
|
33 | # Danga::Socket |
|
|
34 | Danga::Socket->AddOtherFds (IO::AIO::poll_fileno => |
|
|
35 | \&IO::AIO::poll_cb); |
|
|
36 | |
32 | |
37 | |
33 | =head1 DESCRIPTION |
38 | =head1 DESCRIPTION |
34 | |
39 | |
35 | This module implements asynchronous I/O using whatever means your |
40 | This module implements asynchronous I/O using whatever means your |
36 | operating system supports. |
41 | operating system supports. |
… | |
… | |
43 | not well-supported (Linux doesn't allow them on normal files currently, |
48 | not well-supported (Linux doesn't allow them on normal files currently, |
44 | for example), and they would only support aio_read and aio_write, so the |
49 | for example), and they would only support aio_read and aio_write, so the |
45 | remaining functionality would have to be implemented using threads anyway. |
50 | remaining functionality would have to be implemented using threads anyway. |
46 | |
51 | |
47 | Although the module will work with in the presence of other threads, it is |
52 | Although the module will work with in the presence of other threads, it is |
48 | currently not reentrant, so use appropriate locking yourself. |
53 | currently not reentrant, so use appropriate locking yourself, always call |
|
|
54 | C<poll_cb> from within the same thread, or never call C<poll_cb> (or other |
|
|
55 | C<aio_> functions) recursively. |
49 | |
56 | |
50 | =cut |
57 | =cut |
51 | |
58 | |
52 | package IO::AIO; |
59 | package IO::AIO; |
53 | |
60 | |
|
|
61 | no warnings; |
|
|
62 | |
54 | use base 'Exporter'; |
63 | use base 'Exporter'; |
55 | |
64 | |
56 | use Fcntl (); |
65 | use Fcntl (); |
57 | |
66 | |
58 | BEGIN { |
67 | BEGIN { |
59 | $VERSION = 0.2; |
68 | $VERSION = 1.1; |
60 | |
69 | |
61 | @EXPORT = qw(aio_read aio_write aio_open aio_close aio_stat aio_lstat aio_unlink |
70 | @EXPORT = qw(aio_read aio_write aio_open aio_close aio_stat aio_lstat aio_unlink |
62 | aio_fsync aio_fdatasync aio_readahead); |
71 | aio_fsync aio_fdatasync aio_readahead); |
63 | @EXPORT_OK = qw(poll_fileno poll_cb min_parallel max_parallel max_outstanding nreqs); |
72 | @EXPORT_OK = qw(poll_fileno poll_cb min_parallel max_parallel max_outstanding nreqs); |
64 | |
73 | |
… | |
… | |
70 | |
79 | |
71 | =head2 AIO FUNCTIONS |
80 | =head2 AIO FUNCTIONS |
72 | |
81 | |
73 | All the C<aio_*> calls are more or less thin wrappers around the syscall |
82 | All the C<aio_*> calls are more or less thin wrappers around the syscall |
74 | with the same name (sans C<aio_>). The arguments are similar or identical, |
83 | with the same name (sans C<aio_>). The arguments are similar or identical, |
75 | and they all accept an additional C<$callback> argument which must be |
84 | and they all accept an additional (and optional) C<$callback> argument |
76 | a code reference. This code reference will get called with the syscall |
85 | which must be a code reference. This code reference will get called with |
77 | return code (e.g. most syscalls return C<-1> on error, unlike perl, which |
86 | the syscall return code (e.g. most syscalls return C<-1> on error, unlike |
78 | usually delivers "false") as it's sole argument when the given syscall has |
87 | perl, which usually delivers "false") as it's sole argument when the given |
79 | been executed asynchronously. |
88 | syscall has been executed asynchronously. |
80 | |
89 | |
81 | All functions that expect a filehandle will also accept a file descriptor. |
90 | All functions expecting a filehandle keep a copy of the filehandle |
|
|
91 | internally until the request has finished. |
82 | |
92 | |
83 | The filenames you pass to these routines I<must> be absolute. The reason |
93 | The filenames you pass to these routines I<must> be absolute. The reason |
84 | is that at the time the request is being executed, the current working |
94 | for this is that at the time the request is being executed, the current |
85 | directory could have changed. Alternatively, you can make sure that you |
95 | working directory could have changed. Alternatively, you can make sure |
86 | never change the current working directory. |
96 | that you never change the current working directory. |
87 | |
97 | |
88 | =over 4 |
98 | =over 4 |
89 | |
99 | |
90 | =item aio_open $pathname, $flags, $mode, $callback |
100 | =item aio_open $pathname, $flags, $mode, $callback |
91 | |
101 | |
… | |
… | |
93 | created filehandle for the file. |
103 | created filehandle for the file. |
94 | |
104 | |
95 | The pathname passed to C<aio_open> must be absolute. See API NOTES, above, |
105 | The pathname passed to C<aio_open> must be absolute. See API NOTES, above, |
96 | for an explanation. |
106 | for an explanation. |
97 | |
107 | |
98 | The C<$mode> argument is a bitmask. See the C<Fcntl> module for a |
108 | The C<$flags> argument is a bitmask. See the C<Fcntl> module for a |
99 | list. They are the same as used in C<sysopen>. |
109 | list. They are the same as used by C<sysopen>. |
|
|
110 | |
|
|
111 | Likewise, C<$mode> specifies the mode of the newly created file, if it |
|
|
112 | didn't exist and C<O_CREAT> has been given, just like perl's C<sysopen>, |
|
|
113 | except that it is mandatory (i.e. use C<0> if you don't create new files, |
|
|
114 | and C<0666> or C<0777> if you do). |
100 | |
115 | |
101 | Example: |
116 | Example: |
102 | |
117 | |
103 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
118 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
104 | if ($_[0]) { |
119 | if ($_[0]) { |
… | |
… | |
111 | |
126 | |
112 | =item aio_close $fh, $callback |
127 | =item aio_close $fh, $callback |
113 | |
128 | |
114 | Asynchronously close a file and call the callback with the result |
129 | Asynchronously close a file and call the callback with the result |
115 | code. I<WARNING:> although accepted, you should not pass in a perl |
130 | code. I<WARNING:> although accepted, you should not pass in a perl |
116 | filehandle here, as perl will likely close the file descriptor itself when |
131 | filehandle here, as perl will likely close the file descriptor another |
117 | the filehandle is destroyed. Normally, you can safely call perls C<close> |
132 | time when the filehandle is destroyed. Normally, you can safely call perls |
118 | or just let filehandles go out of scope. |
133 | C<close> or just let filehandles go out of scope. |
|
|
134 | |
|
|
135 | This is supposed to be a bug in the API, so that might change. It's |
|
|
136 | therefore best to avoid this function. |
119 | |
137 | |
120 | =item aio_read $fh,$offset,$length, $data,$dataoffset,$callback |
138 | =item aio_read $fh,$offset,$length, $data,$dataoffset,$callback |
121 | |
139 | |
122 | =item aio_write $fh,$offset,$length, $data,$dataoffset,$callback |
140 | =item aio_write $fh,$offset,$length, $data,$dataoffset,$callback |
123 | |
141 | |
124 | Reads or writes C<length> bytes from the specified C<fh> and C<offset> |
142 | Reads or writes C<length> bytes from the specified C<fh> and C<offset> |
125 | into the scalar given by C<data> and offset C<dataoffset> and calls the |
143 | into the scalar given by C<data> and offset C<dataoffset> and calls the |
126 | callback without the actual number of bytes read (or -1 on error, just |
144 | callback without the actual number of bytes read (or -1 on error, just |
127 | like the syscall). |
145 | like the syscall). |
128 | |
146 | |
129 | Example: Read 15 bytes at offset 7 into scalar C<$buffer>, strating at |
147 | Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at |
130 | offset C<0> within the scalar: |
148 | offset C<0> within the scalar: |
131 | |
149 | |
132 | aio_read $fh, 7, 15, $buffer, 0, sub { |
150 | aio_read $fh, 7, 15, $buffer, 0, sub { |
133 | $_[0] >= 0 or die "read error: $!"; |
151 | $_[0] > 0 or die "read error: $!"; |
134 | print "read <$buffer>\n"; |
152 | print "read $_[0] bytes: <$buffer>\n"; |
135 | }; |
153 | }; |
136 | |
154 | |
137 | =item aio_readahead $fh,$offset,$length, $callback |
155 | =item aio_readahead $fh,$offset,$length, $callback |
138 | |
156 | |
139 | Asynchronously reads the specified byte range into the page cache, using |
157 | Asynchronously reads the specified byte range into the page cache, using |
140 | the C<readahead> syscall. If that syscall doesn't exist the status will be |
158 | the C<readahead> syscall. If that syscall doesn't exist (likely if your OS |
141 | C<-1> and C<$!> is set to ENOSYS. |
159 | isn't Linux) the status will be C<-1> and C<$!> is set to C<ENOSYS>. |
142 | |
160 | |
143 | readahead() populates the page cache with data from a file so that |
161 | C<aio_readahead> populates the page cache with data from a file so that |
144 | subsequent reads from that file will not block on disk I/O. The C<$offset> |
162 | subsequent reads from that file will not block on disk I/O. The C<$offset> |
145 | argument specifies the starting point from which data is to be read and |
163 | argument specifies the starting point from which data is to be read and |
146 | C<$length> specifies the number of bytes to be read. I/O is performed in |
164 | C<$length> specifies the number of bytes to be read. I/O is performed in |
147 | whole pages, so that offset is effectively rounded down to a page boundary |
165 | whole pages, so that offset is effectively rounded down to a page boundary |
148 | and bytes are read up to the next page boundary greater than or equal to |
166 | and bytes are read up to the next page boundary greater than or equal to |
149 | (off-set+length). aio_readahead() does not read beyond the end of the |
167 | (off-set+length). C<aio_readahead> does not read beyond the end of the |
150 | file. The current file offset of the file is left unchanged. |
168 | file. The current file offset of the file is left unchanged. |
151 | |
169 | |
152 | =item aio_stat $fh_or_path, $callback |
170 | =item aio_stat $fh_or_path, $callback |
153 | |
171 | |
154 | =item aio_lstat $fh, $callback |
172 | =item aio_lstat $fh, $callback |
… | |
… | |
182 | with the fsync result code. |
200 | with the fsync result code. |
183 | |
201 | |
184 | =item aio_fdatasync $fh, $callback |
202 | =item aio_fdatasync $fh, $callback |
185 | |
203 | |
186 | Asynchronously call fdatasync on the given filehandle and call the |
204 | Asynchronously call fdatasync on the given filehandle and call the |
187 | callback with the fdatasync result code. |
205 | callback with the fdatasync result code. Might set C<$!> to C<ENOSYS> if |
|
|
206 | C<fdatasync> is not available. |
188 | |
207 | |
189 | =back |
208 | =back |
190 | |
209 | |
191 | =head2 SUPPORT FUNCTIONS |
210 | =head2 SUPPORT FUNCTIONS |
192 | |
211 | |
193 | =over 4 |
212 | =over 4 |
194 | |
213 | |
195 | =item $fileno = IO::AIO::poll_fileno |
214 | =item $fileno = IO::AIO::poll_fileno |
196 | |
215 | |
197 | Return the I<request result pipe filehandle>. This filehandle must be |
216 | Return the I<request result pipe file descriptor>. This filehandle must be |
198 | polled for reading by some mechanism outside this module (e.g. Event |
217 | polled for reading by some mechanism outside this module (e.g. Event or |
199 | or select, see below). If the pipe becomes readable you have to call |
218 | select, see below or the SYNOPSIS). If the pipe becomes readable you have |
200 | C<poll_cb> to check the results. |
219 | to call C<poll_cb> to check the results. |
201 | |
220 | |
202 | See C<poll_cb> for an example. |
221 | See C<poll_cb> for an example. |
203 | |
222 | |
204 | =item IO::AIO::poll_cb |
223 | =item IO::AIO::poll_cb |
205 | |
224 | |
206 | Process all outstanding events on the result pipe. You have to call this |
225 | Process all outstanding events on the result pipe. You have to call this |
207 | regularly. Returns the number of events processed. Returns immediately |
226 | regularly. Returns the number of events processed. Returns immediately |
208 | when no events are outstanding. |
227 | when no events are outstanding. |
209 | |
228 | |
210 | You can use Event to multiplex, e.g.: |
229 | Example: Install an Event watcher that automatically calls |
|
|
230 | IO::AIO::poll_cb with high priority: |
211 | |
231 | |
212 | Event->io (fd => IO::AIO::poll_fileno, |
232 | Event->io (fd => IO::AIO::poll_fileno, |
213 | poll => 'r', async => 1, |
233 | poll => 'r', async => 1, |
214 | cb => \&IO::AIO::poll_cb); |
234 | cb => \&IO::AIO::poll_cb); |
215 | |
235 | |
216 | =item IO::AIO::poll_wait |
236 | =item IO::AIO::poll_wait |
217 | |
237 | |
218 | Wait till the result filehandle becomes ready for reading (simply does a |
238 | Wait till the result filehandle becomes ready for reading (simply does a |
219 | select on the filehandle. This is useful if you want to synchronously wait |
239 | C<select> on the filehandle. This is useful if you want to synchronously wait |
220 | for some requests to finish). |
240 | for some requests to finish). |
221 | |
241 | |
222 | See C<nreqs> for an example. |
242 | See C<nreqs> for an example. |
223 | |
243 | |
224 | =item IO::AIO::nreqs |
244 | =item IO::AIO::nreqs |
225 | |
245 | |
226 | Returns the number of requests currently outstanding. |
246 | Returns the number of requests currently outstanding (i.e. for which their |
|
|
247 | callback has not been invoked yet). |
227 | |
248 | |
228 | Example: wait till there are no outstanding requests anymore: |
249 | Example: wait till there are no outstanding requests anymore: |
229 | |
250 | |
230 | IO::AIO::poll_wait, IO::AIO::poll_cb |
251 | IO::AIO::poll_wait, IO::AIO::poll_cb |
231 | while IO::AIO::nreqs; |
252 | while IO::AIO::nreqs; |
|
|
253 | |
|
|
254 | =item IO::AIO::flush |
|
|
255 | |
|
|
256 | Wait till all outstanding AIO requests have been handled. |
|
|
257 | |
|
|
258 | Strictly equivalent to: |
|
|
259 | |
|
|
260 | IO::AIO::poll_wait, IO::AIO::poll_cb |
|
|
261 | while IO::AIO::nreqs; |
|
|
262 | |
|
|
263 | =item IO::AIO::poll |
|
|
264 | |
|
|
265 | Waits until some requests have been handled. |
|
|
266 | |
|
|
267 | Strictly equivalent to: |
|
|
268 | |
|
|
269 | IO::AIO::poll_wait, IO::AIO::poll_cb |
|
|
270 | if IO::AIO::nreqs; |
232 | |
271 | |
233 | =item IO::AIO::min_parallel $nthreads |
272 | =item IO::AIO::min_parallel $nthreads |
234 | |
273 | |
235 | Set the minimum number of AIO threads to C<$nthreads>. The default is |
274 | Set the minimum number of AIO threads to C<$nthreads>. The default is |
236 | C<1>, which means a single asynchronous operation can be done at one time |
275 | C<1>, which means a single asynchronous operation can be done at one time |
… | |
… | |
274 | |
313 | |
275 | # support function to convert a fd into a perl filehandle |
314 | # support function to convert a fd into a perl filehandle |
276 | sub _fd2fh { |
315 | sub _fd2fh { |
277 | return undef if $_[0] < 0; |
316 | return undef if $_[0] < 0; |
278 | |
317 | |
279 | # try to be perl5.6-compatible |
318 | # try to generate nice filehandles |
280 | local *AIO_FH; |
319 | my $sym = "IO::AIO::fd#$_[0]"; |
281 | open AIO_FH, "+<&=$_[0]" |
320 | local *$sym; |
|
|
321 | |
|
|
322 | open *$sym, "+<&$_[0]" # usually under any unix |
|
|
323 | or open *$sym, "<&$_[0]" # cygwin needs this |
|
|
324 | or open *$sym, ">&$_[0]" # cygwin needs this |
282 | or return undef; |
325 | or return undef; |
283 | |
326 | |
284 | *AIO_FH |
327 | *$sym |
285 | } |
328 | } |
286 | |
329 | |
287 | min_parallel 4; |
330 | min_parallel 4; |
288 | |
331 | |
289 | END { |
332 | END { |