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

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.38 by root, Sun Aug 28 10:51:33 2005 UTC vs.
Revision 1.42 by root, Mon Dec 26 18:15:23 2005 UTC

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
20 # AnyEvent
21 open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!";
22 my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb });
19 23
20 # Event 24 # Event
21 Event->io (fd => IO::AIO::poll_fileno, 25 Event->io (fd => IO::AIO::poll_fileno,
22 poll => 'r', 26 poll => 'r',
23 cb => \&IO::AIO::poll_cb); 27 cb => \&IO::AIO::poll_cb);
63use base 'Exporter'; 67use base 'Exporter';
64 68
65use Fcntl (); 69use Fcntl ();
66 70
67BEGIN { 71BEGIN {
68 $VERSION = 1.6; 72 $VERSION = '1.61';
69 73
70 @EXPORT = qw(aio_sendfile aio_read aio_write aio_open aio_close stat 74 @EXPORT = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat
71 aio_aio_lstat aio_unlink aio_rmdir aio_readdir aio_symlink 75 aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink
72 aio_fsync aio_fdatasync aio_readahead); 76 aio_fsync aio_fdatasync aio_readahead);
73 @EXPORT_OK = qw(poll_fileno poll_cb min_parallel max_parallel 77 @EXPORT_OK = qw(poll_fileno poll_cb min_parallel max_parallel
74 max_outstanding nreqs); 78 max_outstanding nreqs);
75 79
76 require XSLoader; 80 require XSLoader;
105environment, d) use Glib::filename_from_unicode on unicode filenames or e) 109environment, d) use Glib::filename_from_unicode on unicode filenames or e)
106use something else. 110use something else.
107 111
108=over 4 112=over 4
109 113
110=item aio_open $pathname, $flags, $mode, $callback 114=item aio_open $pathname, $flags, $mode, $callback->($fh)
111 115
112Asynchronously open or create a file and call the callback with a newly 116Asynchronously open or create a file and call the callback with a newly
113created filehandle for the file. 117created filehandle for the file.
114 118
115The pathname passed to C<aio_open> must be absolute. See API NOTES, above, 119The pathname passed to C<aio_open> must be absolute. See API NOTES, above,
132 } else { 136 } else {
133 die "open failed: $!\n"; 137 die "open failed: $!\n";
134 } 138 }
135 }; 139 };
136 140
137=item aio_close $fh, $callback 141=item aio_close $fh, $callback->($status)
138 142
139Asynchronously close a file and call the callback with the result 143Asynchronously close a file and call the callback with the result
140code. I<WARNING:> although accepted, you should not pass in a perl 144code. I<WARNING:> although accepted, you should not pass in a perl
141filehandle here, as perl will likely close the file descriptor another 145filehandle here, as perl will likely close the file descriptor another
142time when the filehandle is destroyed. Normally, you can safely call perls 146time when the filehandle is destroyed. Normally, you can safely call perls
143C<close> or just let filehandles go out of scope. 147C<close> or just let filehandles go out of scope.
144 148
145This is supposed to be a bug in the API, so that might change. It's 149This is supposed to be a bug in the API, so that might change. It's
146therefore best to avoid this function. 150therefore best to avoid this function.
147 151
148=item aio_read $fh,$offset,$length, $data,$dataoffset,$callback 152=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
149 153
150=item aio_write $fh,$offset,$length, $data,$dataoffset,$callback 154=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
151 155
152Reads or writes C<length> bytes from the specified C<fh> and C<offset> 156Reads or writes C<length> bytes from the specified C<fh> and C<offset>
153into the scalar given by C<data> and offset C<dataoffset> and calls the 157into the scalar given by C<data> and offset C<dataoffset> and calls the
154callback without the actual number of bytes read (or -1 on error, just 158callback without the actual number of bytes read (or -1 on error, just
155like the syscall). 159like the syscall).
164 aio_read $fh, 7, 15, $buffer, 0, sub { 168 aio_read $fh, 7, 15, $buffer, 0, sub {
165 $_[0] > 0 or die "read error: $!"; 169 $_[0] > 0 or die "read error: $!";
166 print "read $_[0] bytes: <$buffer>\n"; 170 print "read $_[0] bytes: <$buffer>\n";
167 }; 171 };
168 172
169=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback 173=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
170 174
171Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts 175Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts
172reading at byte offset C<$in_offset>, and starts writing at the current 176reading at byte offset C<$in_offset>, and starts writing at the current
173file offset of C<$out_fh>. Because of that, it is not safe to issue more 177file offset of C<$out_fh>. Because of that, it is not safe to issue more
174than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each 178than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each
187bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only 191bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only
188provides the number of bytes written to C<$out_fh>. Only if the result 192provides the number of bytes written to C<$out_fh>. Only if the result
189value equals C<$length> one can assume that C<$length> bytes have been 193value equals C<$length> one can assume that C<$length> bytes have been
190read. 194read.
191 195
192=item aio_readahead $fh,$offset,$length, $callback 196=item aio_readahead $fh,$offset,$length, $callback->($retval)
193 197
194C<aio_readahead> populates the page cache with data from a file so that 198C<aio_readahead> populates the page cache with data from a file so that
195subsequent reads from that file will not block on disk I/O. The C<$offset> 199subsequent reads from that file will not block on disk I/O. The C<$offset>
196argument specifies the starting point from which data is to be read and 200argument specifies the starting point from which data is to be read and
197C<$length> specifies the number of bytes to be read. I/O is performed in 201C<$length> specifies the number of bytes to be read. I/O is performed in
201file. The current file offset of the file is left unchanged. 205file. The current file offset of the file is left unchanged.
202 206
203If that syscall doesn't exist (likely if your OS isn't Linux) it will be 207If that syscall doesn't exist (likely if your OS isn't Linux) it will be
204emulated by simply reading the data, which would have a similar effect. 208emulated by simply reading the data, which would have a similar effect.
205 209
206=item aio_stat $fh_or_path, $callback 210=item aio_stat $fh_or_path, $callback->($status)
207 211
208=item aio_lstat $fh, $callback 212=item aio_lstat $fh, $callback->($status)
209 213
210Works like perl's C<stat> or C<lstat> in void context. The callback will 214Works like perl's C<stat> or C<lstat> in void context. The callback will
211be called after the stat and the results will be available using C<stat _> 215be called after the stat and the results will be available using C<stat _>
212or C<-s _> etc... 216or C<-s _> etc...
213 217
223 aio_stat "/etc/passwd", sub { 227 aio_stat "/etc/passwd", sub {
224 $_[0] and die "stat failed: $!"; 228 $_[0] and die "stat failed: $!";
225 print "size is ", -s _, "\n"; 229 print "size is ", -s _, "\n";
226 }; 230 };
227 231
228=item aio_unlink $pathname, $callback 232=item aio_unlink $pathname, $callback->($status)
229 233
230Asynchronously unlink (delete) a file and call the callback with the 234Asynchronously unlink (delete) a file and call the callback with the
231result code. 235result code.
232 236
233=item aio_rmdir $pathname, $callback 237=item aio_rmdir $pathname, $callback->($status)
234 238
235Asynchronously rmdir (delete) a directory and call the callback with the 239Asynchronously rmdir (delete) a directory and call the callback with the
236result code. 240result code.
237 241
238=item aio_readdir $pathname $callback 242=item aio_readdir $pathname $callback->($entries)
239 243
240Unlike the POSIX call of the same name, C<aio_readdir> reads an entire 244Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
241directory (i.e. opendir + readdir + closedir). The entries will not be 245directory (i.e. opendir + readdir + closedir). The entries will not be
242sorted, and will B<NOT> include the C<.> and C<..> entries. 246sorted, and will B<NOT> include the C<.> and C<..> entries.
243 247
244The callback a single argument which is either C<undef> or an array-ref 248The callback a single argument which is either C<undef> or an array-ref
245with the filenames. 249with the filenames.
246 250
251=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
252
253Scans a directory (similar to C<aio_readdir>) and tries to separate the
254entries of directory C<$path> into two sets of names, ones you can recurse
255into (directories), and ones you cannot recurse into (everything else).
256
257C<aio_scandir> is a composite request that consists of many
258aio-primitives. C<$maxreq> specifies the maximum number of outstanding
259aio requests that this function generates. If it is C<< <= 0 >>, then a
260suitable default will be chosen (currently 8).
261
262On error, the callback is called without arguments, otherwise it receives
263two array-refs with path-relative entry names.
264
265Example:
266
267 aio_scandir $dir, 0, sub {
268 my ($dirs, $nondirs) = @_;
269 print "real directories: @$dirs\n";
270 print "everything else: @$nondirs\n";
271 };
272
273Implementation notes.
274
275The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can.
276
277After reading the directory, the modification time, size etc. of the
278directory before and after the readdir is checked, and if they match, the
279link count will be used to decide how many entries are directories (if
280>= 2). Otherwise, no knowledge of the number of subdirectories will be
281assumed.
282
283Then entires will be sorted into likely directories (everything without a
284non-initial dot) and likely non-directories (everything else). Then every
285entry + C</.> will be C<stat>'ed, likely directories first. This is often
286faster because filesystems might detect the type of the entry without
287reading the inode data (e.g. ext2s filetype feature). If that succeeds,
288it assumes that the entry is a directory or a symlink to directory (which
289will be checked seperately).
290
291If the known number of directories has been reached, the rest of the
292entries is assumed to be non-directories.
293
294=cut
295
296sub aio_scandir($$$) {
297 my ($path, $maxreq, $cb) = @_;
298
299 $maxreq = 8 if $maxreq <= 0;
300
301 # stat once
302 aio_stat $path, sub {
303 $cb->() if $_[0];
304 my $hash1 = join ":", (stat _)[0,1,3,7,9];
305
306 # read the directory entries
307 aio_readdir $path, sub {
308 my $entries = shift
309 or return $cb->();
310
311 # stat the dir another time
312 aio_stat $path, sub {
313 my $hash2 = join ":", (stat _)[0,1,3,7,9];
314
315 my $ndirs;
316
317 # take the slow route if anything looks fishy
318 if ($hash1 ne $hash2) {
319 $ndirs = -1;
320 } else {
321 # if nlink == 2, we are finished
322 # on non-posix-fs's, we rely on nlink < 2
323 $ndirs = (stat _)[3] - 2
324 or $cb->([], $entries);
325 }
326
327 # sort into likely dirs and likely nondirs
328 # dirs == files without ".", short entries first
329 $entries = [map $_->[0],
330 sort { $b->[1] cmp $a->[1] }
331 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
332 @$entries];
333
334 my (@dirs, @nondirs);
335
336 my ($statcb, $schedcb);
337 my $nreq = 0;
338
339 $schedcb = sub {
340 if (@$entries) {
341 if ($nreq < $maxreq) {
342 my $ent = pop @$entries;
343 $nreq++;
344 aio_stat "$path/$ent/.", sub { $statcb->($_[0], $ent) };
345 }
346 } elsif (!$nreq) {
347 # finished
348 undef $statcb;
349 undef $schedcb;
350 $cb->(\@dirs, \@nondirs);
351 undef $cb;
352 }
353 };
354 $statcb = sub {
355 my ($status, $entry) = @_;
356
357 if ($status < 0) {
358 $nreq--;
359 push @nondirs, $entry;
360 &$schedcb;
361 } else {
362 # need to check for real directory
363 aio_lstat "$path/$entry", sub {
364 $nreq--;
365
366 if (-d _) {
367 push @dirs, $entry;
368
369 if (!--$ndirs) {
370 push @nondirs, @$entries;
371 $entries = [];
372 }
373 } else {
374 push @nondirs, $entry;
375 }
376
377 &$schedcb;
378 }
379 }
380 };
381
382 &$schedcb while @$entries && $nreq < $maxreq;
383 };
384 };
385 };
386}
387
247=item aio_fsync $fh, $callback 388=item aio_fsync $fh, $callback->($status)
248 389
249Asynchronously call fsync on the given filehandle and call the callback 390Asynchronously call fsync on the given filehandle and call the callback
250with the fsync result code. 391with the fsync result code.
251 392
252=item aio_fdatasync $fh, $callback 393=item aio_fdatasync $fh, $callback->($status)
253 394
254Asynchronously call fdatasync on the given filehandle and call the 395Asynchronously call fdatasync on the given filehandle and call the
255callback with the fdatasync result code. 396callback with the fdatasync result code.
256 397
257If this call isn't available because your OS lacks it or it couldn't be 398If this call isn't available because your OS lacks it or it couldn't be

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines