… | |
… | |
63 | use base 'Exporter'; |
63 | use base 'Exporter'; |
64 | |
64 | |
65 | use Fcntl (); |
65 | use Fcntl (); |
66 | |
66 | |
67 | BEGIN { |
67 | BEGIN { |
68 | $VERSION = 1.1; |
68 | $VERSION = 1.2; |
69 | |
69 | |
70 | @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 |
71 | aio_fsync aio_fdatasync aio_readahead); |
71 | aio_rmdir aio_symlink aio_fsync aio_fdatasync aio_readahead); |
72 | @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); |
73 | |
73 | |
74 | require XSLoader; |
74 | require XSLoader; |
75 | XSLoader::load IO::AIO, $VERSION; |
75 | XSLoader::load IO::AIO, $VERSION; |
76 | } |
76 | } |
… | |
… | |
88 | syscall has been executed asynchronously. |
88 | syscall has been executed asynchronously. |
89 | |
89 | |
90 | All functions expecting a filehandle keep a copy of the filehandle |
90 | All functions expecting a filehandle keep a copy of the filehandle |
91 | internally until the request has finished. |
91 | internally until the request has finished. |
92 | |
92 | |
93 | The filenames you pass to these routines I<must> be absolute. The reason |
93 | The pathnames you pass to these routines I<must> be absolute and |
94 | for this is that at the time the request is being executed, the current |
94 | encoded in byte form. The reason for the former is that at the time the |
95 | working directory could have changed. Alternatively, you can make sure |
95 | request is being executed, the current working directory could have |
96 | that you never change the current working directory. |
96 | changed. Alternatively, you can make sure that you never change the |
|
|
97 | current working directory. |
|
|
98 | |
|
|
99 | To encode pathnames to byte form, either make sure you either: a) |
|
|
100 | always pass in filenames you got from outside (command line, readdir |
|
|
101 | etc.), b) are ASCII or ISO 8859-1, c) use the Encode module and encode |
|
|
102 | your pathnames to the locale (or other) encoding in effect in the user |
|
|
103 | environment, d) use Glib::filename_from_unicode on unicode filenames or e) |
|
|
104 | use something else. |
97 | |
105 | |
98 | =over 4 |
106 | =over 4 |
99 | |
107 | |
100 | =item aio_open $pathname, $flags, $mode, $callback |
108 | =item aio_open $pathname, $flags, $mode, $callback |
101 | |
109 | |
… | |
… | |
152 | print "read $_[0] bytes: <$buffer>\n"; |
160 | print "read $_[0] bytes: <$buffer>\n"; |
153 | }; |
161 | }; |
154 | |
162 | |
155 | =item aio_readahead $fh,$offset,$length, $callback |
163 | =item aio_readahead $fh,$offset,$length, $callback |
156 | |
164 | |
157 | Asynchronously reads the specified byte range into the page cache, using |
|
|
158 | the C<readahead> syscall. If that syscall doesn't exist (likely if your OS |
|
|
159 | isn't Linux) the status will be C<-1> and C<$!> is set to C<ENOSYS>. |
|
|
160 | |
|
|
161 | C<aio_readahead> populates the page cache with data from a file so that |
165 | C<aio_readahead> populates the page cache with data from a file so that |
162 | subsequent reads from that file will not block on disk I/O. The C<$offset> |
166 | subsequent reads from that file will not block on disk I/O. The C<$offset> |
163 | argument specifies the starting point from which data is to be read and |
167 | argument specifies the starting point from which data is to be read and |
164 | C<$length> specifies the number of bytes to be read. I/O is performed in |
168 | C<$length> specifies the number of bytes to be read. I/O is performed in |
165 | whole pages, so that offset is effectively rounded down to a page boundary |
169 | whole pages, so that offset is effectively rounded down to a page boundary |
166 | and bytes are read up to the next page boundary greater than or equal to |
170 | and bytes are read up to the next page boundary greater than or equal to |
167 | (off-set+length). C<aio_readahead> does not read beyond the end of the |
171 | (off-set+length). C<aio_readahead> does not read beyond the end of the |
168 | file. The current file offset of the file is left unchanged. |
172 | file. The current file offset of the file is left unchanged. |
169 | |
173 | |
|
|
174 | If that syscall doesn't exist (likely if your OS isn't Linux) it will be |
|
|
175 | emulated by simply reading the data, which would have a similar effect. |
|
|
176 | |
170 | =item aio_stat $fh_or_path, $callback |
177 | =item aio_stat $fh_or_path, $callback |
171 | |
178 | |
172 | =item aio_lstat $fh, $callback |
179 | =item aio_lstat $fh, $callback |
173 | |
180 | |
174 | Works like perl's C<stat> or C<lstat> in void context. The callback will |
181 | Works like perl's C<stat> or C<lstat> in void context. The callback will |
… | |
… | |
192 | =item aio_unlink $pathname, $callback |
199 | =item aio_unlink $pathname, $callback |
193 | |
200 | |
194 | Asynchronously unlink (delete) a file and call the callback with the |
201 | Asynchronously unlink (delete) a file and call the callback with the |
195 | result code. |
202 | result code. |
196 | |
203 | |
|
|
204 | =item aio_rmdir $pathname, $callback |
|
|
205 | |
|
|
206 | Asynchronously rmdir (delete) a directory and call the callback with the |
|
|
207 | result code. |
|
|
208 | |
197 | =item aio_fsync $fh, $callback |
209 | =item aio_fsync $fh, $callback |
198 | |
210 | |
199 | Asynchronously call fsync on the given filehandle and call the callback |
211 | Asynchronously call fsync on the given filehandle and call the callback |
200 | with the fsync result code. |
212 | with the fsync result code. |
201 | |
213 | |
202 | =item aio_fdatasync $fh, $callback |
214 | =item aio_fdatasync $fh, $callback |
203 | |
215 | |
204 | Asynchronously call fdatasync on the given filehandle and call the |
216 | Asynchronously call fdatasync on the given filehandle and call the |
205 | callback with the fdatasync result code. Might set C<$!> to C<ENOSYS> if |
217 | callback with the fdatasync result code. |
206 | C<fdatasync> is not available. |
218 | |
|
|
219 | If this call isn't available because your OS lacks it or it couldn't be |
|
|
220 | detected, it will be emulated by calling C<fsync> instead. |
207 | |
221 | |
208 | =back |
222 | =back |
209 | |
223 | |
210 | =head2 SUPPORT FUNCTIONS |
224 | =head2 SUPPORT FUNCTIONS |
211 | |
225 | |
… | |
… | |
317 | |
331 | |
318 | # try to generate nice filehandles |
332 | # try to generate nice filehandles |
319 | my $sym = "IO::AIO::fd#$_[0]"; |
333 | my $sym = "IO::AIO::fd#$_[0]"; |
320 | local *$sym; |
334 | local *$sym; |
321 | |
335 | |
322 | open *$sym, "+<&$_[0]" # usually under any unix |
336 | open *$sym, "+<&=$_[0]" # usually works under any unix |
323 | or open *$sym, "<&$_[0]" # cygwin needs this |
337 | or open *$sym, "<&=$_[0]" # cygwin needs this |
324 | or open *$sym, ">&$_[0]" # cygwin needs this |
338 | or open *$sym, ">&=$_[0]" # or this |
325 | or return undef; |
339 | or return undef; |
326 | |
340 | |
327 | *$sym |
341 | *$sym |
328 | } |
342 | } |
329 | |
343 | |
… | |
… | |
333 | max_parallel 0; |
347 | max_parallel 0; |
334 | } |
348 | } |
335 | |
349 | |
336 | 1; |
350 | 1; |
337 | |
351 | |
|
|
352 | =head2 FORK BEHAVIOUR |
|
|
353 | |
|
|
354 | IO::AIO handles all outstanding AIO requests before the fork, destroys all |
|
|
355 | AIO threads, and recreates them in both the parent and the child after the |
|
|
356 | fork. |
|
|
357 | |
|
|
358 | |
338 | =head1 SEE ALSO |
359 | =head1 SEE ALSO |
339 | |
360 | |
340 | L<Coro>, L<Linux::AIO>. |
361 | L<Coro>, L<Linux::AIO>. |
341 | |
362 | |
342 | =head1 AUTHOR |
363 | =head1 AUTHOR |