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.50 by root, Sat Jun 24 16:27:02 2006 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.8';
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 aio_rename aio_link aio_move);
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;
77 XSLoader::load IO::AIO, $VERSION; 81 XSLoader::load IO::AIO, $VERSION;
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
173=item aio_move $srcpath, $dstpath, $callback->($status)
174
175[EXPERIMENTAL]
176
177Try to move the I<file> (directories not supported as either source or destination)
178from C<$srcpath> to C<$dstpath> and call the callback with the C<0> (error) or C<-1> ok.
179
180This is a composite request that tries to rename(2) the file first. If
181rename files with C<EXDEV>, it creates the destination file with mode 0200
182and copies the contents of the source file into it using C<aio_sendfile>,
183followed by restoring atime, mtime, access mode and uid/gid, in that
184order, and unlinking the C<$srcpath>.
185
186If an error occurs, the partial destination file will be unlinked, if
187possible, except when setting atime, mtime, access mode and uid/gid, where
188errors are being ignored.
189
190=cut
191
192sub aio_move($$$) {
193 my ($src, $dst, $cb) = @_;
194
195 aio_rename $src, $dst, sub {
196 if ($_[0] && $! == Errno::EXDEV) {
197 aio_open $src, O_RDONLY, 0, sub {
198 if (my $src_fh = $_[0]) {
199 my @stat = stat $src_fh;
200
201 aio_open $dst, O_WRONLY, 0200, sub {
202 if (my $dst_fh = $_[0]) {
203 aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
204 close $src_fh;
205
206 if ($_[0] == $stat[7]) {
207 utime $stat[8], $stat[9], $dst;
208 chmod $stat[2] & 07777, $dst_fh;
209 chown $stat[4], $stat[5], $dst_fh;
210 close $dst_fh;
211
212 aio_unlink $src, sub {
213 $cb->($_[0]);
214 };
215 } else {
216 my $errno = $!;
217 aio_unlink $dst, sub {
218 $! = $errno;
219 $cb->(-1);
220 };
221 }
222 };
223 } else {
224 $cb->(-1);
225 }
226 },
227
228 } else {
229 $cb->(-1);
230 }
231 };
232 } else {
233 $cb->($_[0]);
234 }
235 };
236}
237
169=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback 238=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
170 239
171Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts 240Tries 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 241reading 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 242file 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 243than 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 256bytes 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 257provides 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 258value equals C<$length> one can assume that C<$length> bytes have been
190read. 259read.
191 260
192=item aio_readahead $fh,$offset,$length, $callback 261=item aio_readahead $fh,$offset,$length, $callback->($retval)
193 262
194C<aio_readahead> populates the page cache with data from a file so that 263C<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> 264subsequent 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 265argument 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 266C<$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. 270file. The current file offset of the file is left unchanged.
202 271
203If that syscall doesn't exist (likely if your OS isn't Linux) it will be 272If 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. 273emulated by simply reading the data, which would have a similar effect.
205 274
206=item aio_stat $fh_or_path, $callback 275=item aio_stat $fh_or_path, $callback->($status)
207 276
208=item aio_lstat $fh, $callback 277=item aio_lstat $fh, $callback->($status)
209 278
210Works like perl's C<stat> or C<lstat> in void context. The callback will 279Works 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 _> 280be called after the stat and the results will be available using C<stat _>
212or C<-s _> etc... 281or C<-s _> etc...
213 282
223 aio_stat "/etc/passwd", sub { 292 aio_stat "/etc/passwd", sub {
224 $_[0] and die "stat failed: $!"; 293 $_[0] and die "stat failed: $!";
225 print "size is ", -s _, "\n"; 294 print "size is ", -s _, "\n";
226 }; 295 };
227 296
228=item aio_unlink $pathname, $callback 297=item aio_unlink $pathname, $callback->($status)
229 298
230Asynchronously unlink (delete) a file and call the callback with the 299Asynchronously unlink (delete) a file and call the callback with the
231result code. 300result code.
232 301
302=item aio_link $srcpath, $dstpath, $callback->($status)
303
304Asynchronously create a new link to the existing object at C<$srcpath> at
305the path C<$dstpath> and call the callback with the result code.
306
307=item aio_symlink $srcpath, $dstpath, $callback->($status)
308
309Asynchronously create a new symbolic link to the existing object at C<$srcpath> at
310the path C<$dstpath> and call the callback with the result code.
311
312=item aio_rename $srcpath, $dstpath, $callback->($status)
313
314Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
315rename(2) and call the callback with the result code.
316
233=item aio_rmdir $pathname, $callback 317=item aio_rmdir $pathname, $callback->($status)
234 318
235Asynchronously rmdir (delete) a directory and call the callback with the 319Asynchronously rmdir (delete) a directory and call the callback with the
236result code. 320result code.
237 321
238=item aio_readdir $pathname $callback 322=item aio_readdir $pathname, $callback->($entries)
239 323
240Unlike the POSIX call of the same name, C<aio_readdir> reads an entire 324Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
241directory (i.e. opendir + readdir + closedir). The entries will not be 325directory (i.e. opendir + readdir + closedir). The entries will not be
242sorted, and will B<NOT> include the C<.> and C<..> entries. 326sorted, and will B<NOT> include the C<.> and C<..> entries.
243 327
244The callback a single argument which is either C<undef> or an array-ref 328The callback a single argument which is either C<undef> or an array-ref
245with the filenames. 329with the filenames.
246 330
331=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
332
333Scans a directory (similar to C<aio_readdir>) and tries to separate the
334entries of directory C<$path> into two sets of names, ones you can recurse
335into (directories), and ones you cannot recurse into (everything else).
336
337C<aio_scandir> is a composite request that consists of many
338aio-primitives. C<$maxreq> specifies the maximum number of outstanding
339aio requests that this function generates. If it is C<< <= 0 >>, then a
340suitable default will be chosen (currently 8).
341
342On error, the callback is called without arguments, otherwise it receives
343two array-refs with path-relative entry names.
344
345Example:
346
347 aio_scandir $dir, 0, sub {
348 my ($dirs, $nondirs) = @_;
349 print "real directories: @$dirs\n";
350 print "everything else: @$nondirs\n";
351 };
352
353Implementation notes.
354
355The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can.
356
357After reading the directory, the modification time, size etc. of the
358directory before and after the readdir is checked, and if they match, the
359link count will be used to decide how many entries are directories (if
360>= 2). Otherwise, no knowledge of the number of subdirectories will be
361assumed.
362
363Then entires will be sorted into likely directories (everything without a
364non-initial dot) and likely non-directories (everything else). Then every
365entry + C</.> will be C<stat>'ed, likely directories first. This is often
366faster because filesystems might detect the type of the entry without
367reading the inode data (e.g. ext2fs filetype feature). If that succeeds,
368it assumes that the entry is a directory or a symlink to directory (which
369will be checked seperately).
370
371If the known number of directories has been reached, the rest of the
372entries is assumed to be non-directories.
373
374=cut
375
376sub aio_scandir($$$) {
377 my ($path, $maxreq, $cb) = @_;
378
379 $maxreq = 8 if $maxreq <= 0;
380
381 # stat once
382 aio_stat $path, sub {
383 return $cb->() if $_[0];
384 my $hash1 = join ":", (stat _)[0,1,3,7,9];
385
386 # read the directory entries
387 aio_readdir $path, sub {
388 my $entries = shift
389 or return $cb->();
390
391 # stat the dir another time
392 aio_stat $path, sub {
393 my $hash2 = join ":", (stat _)[0,1,3,7,9];
394
395 my $ndirs;
396
397 # take the slow route if anything looks fishy
398 if ($hash1 ne $hash2) {
399 $ndirs = -1;
400 } else {
401 # if nlink == 2, we are finished
402 # on non-posix-fs's, we rely on nlink < 2
403 $ndirs = (stat _)[3] - 2
404 or return $cb->([], $entries);
405 }
406
407 # sort into likely dirs and likely nondirs
408 # dirs == files without ".", short entries first
409 $entries = [map $_->[0],
410 sort { $b->[1] cmp $a->[1] }
411 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
412 @$entries];
413
414 my (@dirs, @nondirs);
415
416 my ($statcb, $schedcb);
417 my $nreq = 0;
418
419 $schedcb = sub {
420 if (@$entries) {
421 if ($nreq < $maxreq) {
422 my $ent = pop @$entries;
423 $nreq++;
424 aio_stat "$path/$ent/.", sub { $statcb->($_[0], $ent) };
425 }
426 } elsif (!$nreq) {
427 # finished
428 undef $statcb;
429 undef $schedcb;
430 $cb->(\@dirs, \@nondirs) if $cb;
431 undef $cb;
432 }
433 };
434 $statcb = sub {
435 my ($status, $entry) = @_;
436
437 if ($status < 0) {
438 $nreq--;
439 push @nondirs, $entry;
440 &$schedcb;
441 } else {
442 # need to check for real directory
443 aio_lstat "$path/$entry", sub {
444 $nreq--;
445
446 if (-d _) {
447 push @dirs, $entry;
448
449 if (!--$ndirs) {
450 push @nondirs, @$entries;
451 $entries = [];
452 }
453 } else {
454 push @nondirs, $entry;
455 }
456
457 &$schedcb;
458 }
459 }
460 };
461
462 &$schedcb while @$entries && $nreq < $maxreq;
463 };
464 };
465 };
466}
467
247=item aio_fsync $fh, $callback 468=item aio_fsync $fh, $callback->($status)
248 469
249Asynchronously call fsync on the given filehandle and call the callback 470Asynchronously call fsync on the given filehandle and call the callback
250with the fsync result code. 471with the fsync result code.
251 472
252=item aio_fdatasync $fh, $callback 473=item aio_fdatasync $fh, $callback->($status)
253 474
254Asynchronously call fdatasync on the given filehandle and call the 475Asynchronously call fdatasync on the given filehandle and call the
255callback with the fdatasync result code. 476callback with the fdatasync result code.
256 477
257If this call isn't available because your OS lacks it or it couldn't be 478If 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