=head1 NAME IO::AIO - Asynchronous Input/Output =head1 SYNOPSIS use IO::AIO; aio_open "/etc/passwd", O_RDONLY, 0, sub { my ($fh) = @_; ... }; aio_unlink "/tmp/file", sub { }; aio_read $fh, 30000, 1024, $buffer, 0, sub { $_[0] > 0 or die "read error: $!"; }; # Event Event->io (fd => IO::AIO::poll_fileno, poll => 'r', cb => \&IO::AIO::poll_cb); # Glib/Gtk2 add_watch Glib::IO IO::AIO::poll_fileno, in => sub { IO::AIO::poll_cb; 1 }; # Tk Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "", readable => \&IO::AIO::poll_cb); # Danga::Socket Danga::Socket->AddOtherFds (IO::AIO::poll_fileno => \&IO::AIO::poll_cb); =head1 DESCRIPTION This module implements asynchronous I/O using whatever means your operating system supports. Currently, a number of threads are started that execute your read/writes and signal their completion. You don't need thread support in your libc or perl, and the threads created by this module will not be visible to the pthreads library. In the future, this module might make use of the native aio functions available on many operating systems. However, they are often not well-supported (Linux doesn't allow them on normal files currently, for example), and they would only support aio_read and aio_write, so the remaining functionality would have to be implemented using threads anyway. Although the module will work with in the presence of other threads, it is currently not reentrant, so use appropriate locking yourself, always call C from within the same thread, or never call C (or other C functions) recursively. =cut package IO::AIO; no warnings; use base 'Exporter'; use Fcntl (); BEGIN { $VERSION = 1.1; @EXPORT = qw(aio_read aio_write aio_open aio_close aio_stat aio_lstat aio_unlink aio_fsync aio_fdatasync aio_readahead); @EXPORT_OK = qw(poll_fileno poll_cb min_parallel max_parallel max_outstanding nreqs); require XSLoader; XSLoader::load IO::AIO, $VERSION; } =head1 FUNCTIONS =head2 AIO FUNCTIONS All the C calls are more or less thin wrappers around the syscall with the same name (sans C). The arguments are similar or identical, and they all accept an additional (and optional) C<$callback> argument which must be a code reference. This code reference will get called with the syscall return code (e.g. most syscalls return C<-1> on error, unlike perl, which usually delivers "false") as it's sole argument when the given syscall has been executed asynchronously. All functions expecting a filehandle keep a copy of the filehandle internally until the request has finished. The filenames you pass to these routines I be absolute. The reason for this is that at the time the request is being executed, the current working directory could have changed. Alternatively, you can make sure that you never change the current working directory. =over 4 =item aio_open $pathname, $flags, $mode, $callback Asynchronously open or create a file and call the callback with a newly created filehandle for the file. The pathname passed to C must be absolute. See API NOTES, above, for an explanation. The C<$flags> argument is a bitmask. See the C module for a list. They are the same as used by C. Likewise, C<$mode> specifies the mode of the newly created file, if it didn't exist and C has been given, just like perl's C, except that it is mandatory (i.e. use C<0> if you don't create new files, and C<0666> or C<0777> if you do). Example: aio_open "/etc/passwd", O_RDONLY, 0, sub { if ($_[0]) { print "open successful, fh is $_[0]\n"; ... } else { die "open failed: $!\n"; } }; =item aio_close $fh, $callback Asynchronously close a file and call the callback with the result code. I although accepted, you should not pass in a perl filehandle here, as perl will likely close the file descriptor another time when the filehandle is destroyed. Normally, you can safely call perls C or just let filehandles go out of scope. This is supposed to be a bug in the API, so that might change. It's therefore best to avoid this function. =item aio_read $fh,$offset,$length, $data,$dataoffset,$callback =item aio_write $fh,$offset,$length, $data,$dataoffset,$callback Reads or writes C bytes from the specified C and C into the scalar given by C and offset C and calls the callback without the actual number of bytes read (or -1 on error, just like the syscall). Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at offset C<0> within the scalar: aio_read $fh, 7, 15, $buffer, 0, sub { $_[0] > 0 or die "read error: $!"; print "read $_[0] bytes: <$buffer>\n"; }; =item aio_readahead $fh,$offset,$length, $callback Asynchronously reads the specified byte range into the page cache, using the C syscall. If that syscall doesn't exist (likely if your OS isn't Linux) the status will be C<-1> and C<$!> is set to C. C populates the page cache with data from a file so that subsequent reads from that file will not block on disk I/O. The C<$offset> argument specifies the starting point from which data is to be read and C<$length> specifies the number of bytes to be read. I/O is performed in whole pages, so that offset is effectively rounded down to a page boundary and bytes are read up to the next page boundary greater than or equal to (off-set+length). C does not read beyond the end of the file. The current file offset of the file is left unchanged. =item aio_stat $fh_or_path, $callback =item aio_lstat $fh, $callback Works like perl's C or C in void context. The callback will be called after the stat and the results will be available using C or C<-s _> etc... The pathname passed to C must be absolute. See API NOTES, above, for an explanation. Currently, the stats are always 64-bit-stats, i.e. instead of returning an error when stat'ing a large file, the results will be silently truncated unless perl itself is compiled with large file support. Example: Print the length of F: aio_stat "/etc/passwd", sub { $_[0] and die "stat failed: $!"; print "size is ", -s _, "\n"; }; =item aio_unlink $pathname, $callback Asynchronously unlink (delete) a file and call the callback with the result code. =item aio_fsync $fh, $callback Asynchronously call fsync on the given filehandle and call the callback with the fsync result code. =item aio_fdatasync $fh, $callback Asynchronously call fdatasync on the given filehandle and call the callback with the fdatasync result code. Might set C<$!> to C if C is not available. =back =head2 SUPPORT FUNCTIONS =over 4 =item $fileno = IO::AIO::poll_fileno Return the I. This filehandle must be polled for reading by some mechanism outside this module (e.g. Event or select, see below or the SYNOPSIS). If the pipe becomes readable you have to call C to check the results. See C for an example. =item IO::AIO::poll_cb Process all outstanding events on the result pipe. You have to call this regularly. Returns the number of events processed. Returns immediately when no events are outstanding. Example: Install an Event watcher that automatically calls IO::AIO::poll_cb with high priority: Event->io (fd => IO::AIO::poll_fileno, poll => 'r', async => 1, cb => \&IO::AIO::poll_cb); =item IO::AIO::poll_wait Wait till the result filehandle becomes ready for reading (simply does a C