… | |
… | |
59 | use base 'Exporter'; |
59 | use base 'Exporter'; |
60 | |
60 | |
61 | use Fcntl (); |
61 | use Fcntl (); |
62 | |
62 | |
63 | BEGIN { |
63 | BEGIN { |
64 | $VERSION = 0.5; |
64 | $VERSION = 0.9; |
65 | |
65 | |
66 | @EXPORT = qw(aio_read aio_write aio_open aio_close aio_stat aio_lstat aio_unlink |
66 | @EXPORT = qw(aio_read aio_write aio_open aio_close aio_stat aio_lstat aio_unlink |
67 | aio_fsync aio_fdatasync aio_readahead); |
67 | aio_fsync aio_fdatasync aio_readahead); |
68 | @EXPORT_OK = qw(poll_fileno poll_cb min_parallel max_parallel max_outstanding nreqs); |
68 | @EXPORT_OK = qw(poll_fileno poll_cb min_parallel max_parallel max_outstanding nreqs); |
69 | |
69 | |
… | |
… | |
84 | syscall has been executed asynchronously. |
84 | syscall has been executed asynchronously. |
85 | |
85 | |
86 | All functions that expect a filehandle will also accept a file descriptor. |
86 | All functions that expect a filehandle will also accept a file descriptor. |
87 | |
87 | |
88 | The filenames you pass to these routines I<must> be absolute. The reason |
88 | The filenames you pass to these routines I<must> be absolute. The reason |
89 | is that at the time the request is being executed, the current working |
89 | for this is that at the time the request is being executed, the current |
90 | directory could have changed. Alternatively, you can make sure that you |
90 | working directory could have changed. Alternatively, you can make sure |
91 | never change the current working directory. |
91 | that you never change the current working directory. |
92 | |
92 | |
93 | =over 4 |
93 | =over 4 |
94 | |
94 | |
95 | =item aio_open $pathname, $flags, $mode, $callback |
95 | =item aio_open $pathname, $flags, $mode, $callback |
96 | |
96 | |
… | |
… | |
98 | created filehandle for the file. |
98 | created filehandle for the file. |
99 | |
99 | |
100 | The pathname passed to C<aio_open> must be absolute. See API NOTES, above, |
100 | The pathname passed to C<aio_open> must be absolute. See API NOTES, above, |
101 | for an explanation. |
101 | for an explanation. |
102 | |
102 | |
103 | The C<$mode> argument is a bitmask. See the C<Fcntl> module for a |
103 | The C<$flags> argument is a bitmask. See the C<Fcntl> module for a |
104 | list. They are the same as used in C<sysopen>. |
104 | list. They are the same as used by C<sysopen>. |
|
|
105 | |
|
|
106 | Likewise, C<$mode> specifies the mode of the newly created file, if it |
|
|
107 | didn't exist and C<O_CREAT> has been given, just like perl's C<sysopen>, |
|
|
108 | except that it is mandatory (i.e. use C<0> if you don't create new files, |
|
|
109 | and C<0666> or C<0777> if you do). |
105 | |
110 | |
106 | Example: |
111 | Example: |
107 | |
112 | |
108 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
113 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
109 | if ($_[0]) { |
114 | if ($_[0]) { |
… | |
… | |
116 | |
121 | |
117 | =item aio_close $fh, $callback |
122 | =item aio_close $fh, $callback |
118 | |
123 | |
119 | Asynchronously close a file and call the callback with the result |
124 | Asynchronously close a file and call the callback with the result |
120 | code. I<WARNING:> although accepted, you should not pass in a perl |
125 | code. I<WARNING:> although accepted, you should not pass in a perl |
121 | filehandle here, as perl will likely close the file descriptor itself when |
126 | filehandle here, as perl will likely close the file descriptor another |
122 | the filehandle is destroyed. Normally, you can safely call perls C<close> |
127 | time when the filehandle is destroyed. Normally, you can safely call perls |
123 | or just let filehandles go out of scope. |
128 | C<close> or just let filehandles go out of scope. |
|
|
129 | |
|
|
130 | This is supposed to be a bug in the API, so that might change. It's |
|
|
131 | therefore best to avoid this function. |
124 | |
132 | |
125 | =item aio_read $fh,$offset,$length, $data,$dataoffset,$callback |
133 | =item aio_read $fh,$offset,$length, $data,$dataoffset,$callback |
126 | |
134 | |
127 | =item aio_write $fh,$offset,$length, $data,$dataoffset,$callback |
135 | =item aio_write $fh,$offset,$length, $data,$dataoffset,$callback |
128 | |
136 | |
… | |
… | |
141 | |
149 | |
142 | =item aio_readahead $fh,$offset,$length, $callback |
150 | =item aio_readahead $fh,$offset,$length, $callback |
143 | |
151 | |
144 | Asynchronously reads the specified byte range into the page cache, using |
152 | Asynchronously reads the specified byte range into the page cache, using |
145 | the C<readahead> syscall. If that syscall doesn't exist (likely if your OS |
153 | the C<readahead> syscall. If that syscall doesn't exist (likely if your OS |
146 | isn't Linux) the status will be C<-1> and C<$!> is set to ENOSYS. |
154 | isn't Linux) the status will be C<-1> and C<$!> is set to C<ENOSYS>. |
147 | |
155 | |
148 | readahead() populates the page cache with data from a file so that |
156 | C<aio_readahead> populates the page cache with data from a file so that |
149 | subsequent reads from that file will not block on disk I/O. The C<$offset> |
157 | subsequent reads from that file will not block on disk I/O. The C<$offset> |
150 | argument specifies the starting point from which data is to be read and |
158 | argument specifies the starting point from which data is to be read and |
151 | C<$length> specifies the number of bytes to be read. I/O is performed in |
159 | C<$length> specifies the number of bytes to be read. I/O is performed in |
152 | whole pages, so that offset is effectively rounded down to a page boundary |
160 | whole pages, so that offset is effectively rounded down to a page boundary |
153 | and bytes are read up to the next page boundary greater than or equal to |
161 | and bytes are read up to the next page boundary greater than or equal to |
154 | (off-set+length). aio_readahead() does not read beyond the end of the |
162 | (off-set+length). C<aio_readahead> does not read beyond the end of the |
155 | file. The current file offset of the file is left unchanged. |
163 | file. The current file offset of the file is left unchanged. |
156 | |
164 | |
157 | =item aio_stat $fh_or_path, $callback |
165 | =item aio_stat $fh_or_path, $callback |
158 | |
166 | |
159 | =item aio_lstat $fh, $callback |
167 | =item aio_lstat $fh, $callback |
… | |
… | |
187 | with the fsync result code. |
195 | with the fsync result code. |
188 | |
196 | |
189 | =item aio_fdatasync $fh, $callback |
197 | =item aio_fdatasync $fh, $callback |
190 | |
198 | |
191 | Asynchronously call fdatasync on the given filehandle and call the |
199 | Asynchronously call fdatasync on the given filehandle and call the |
192 | callback with the fdatasync result code. |
200 | callback with the fdatasync result code. Might set C<$!> to C<ENOSYS> if |
|
|
201 | C<fdatasync> is not available. |
193 | |
202 | |
194 | =back |
203 | =back |
195 | |
204 | |
196 | =head2 SUPPORT FUNCTIONS |
205 | =head2 SUPPORT FUNCTIONS |
197 | |
206 | |
198 | =over 4 |
207 | =over 4 |
199 | |
208 | |
200 | =item $fileno = IO::AIO::poll_fileno |
209 | =item $fileno = IO::AIO::poll_fileno |
201 | |
210 | |
202 | Return the I<request result pipe filehandle>. This filehandle must be |
211 | Return the I<request result pipe file descriptor>. This filehandle must be |
203 | polled for reading by some mechanism outside this module (e.g. Event |
212 | polled for reading by some mechanism outside this module (e.g. Event or |
204 | or select, see below). If the pipe becomes readable you have to call |
213 | select, see below or the SYNOPSIS). If the pipe becomes readable you have |
205 | C<poll_cb> to check the results. |
214 | to call C<poll_cb> to check the results. |
206 | |
215 | |
207 | See C<poll_cb> for an example. |
216 | See C<poll_cb> for an example. |
208 | |
217 | |
209 | =item IO::AIO::poll_cb |
218 | =item IO::AIO::poll_cb |
210 | |
219 | |
211 | Process all outstanding events on the result pipe. You have to call this |
220 | Process all outstanding events on the result pipe. You have to call this |
212 | regularly. Returns the number of events processed. Returns immediately |
221 | regularly. Returns the number of events processed. Returns immediately |
213 | when no events are outstanding. |
222 | when no events are outstanding. |
214 | |
223 | |
215 | You can use Event to multiplex, e.g.: |
224 | Example: Install an Event watcher that automatically calls |
|
|
225 | IO::AIO::poll_cb with high priority: |
216 | |
226 | |
217 | Event->io (fd => IO::AIO::poll_fileno, |
227 | Event->io (fd => IO::AIO::poll_fileno, |
218 | poll => 'r', async => 1, |
228 | poll => 'r', async => 1, |
219 | cb => \&IO::AIO::poll_cb); |
229 | cb => \&IO::AIO::poll_cb); |
220 | |
230 | |
221 | =item IO::AIO::poll_wait |
231 | =item IO::AIO::poll_wait |
222 | |
232 | |
223 | Wait till the result filehandle becomes ready for reading (simply does a |
233 | Wait till the result filehandle becomes ready for reading (simply does a |
224 | select on the filehandle. This is useful if you want to synchronously wait |
234 | C<select> on the filehandle. This is useful if you want to synchronously wait |
225 | for some requests to finish). |
235 | for some requests to finish). |
226 | |
236 | |
227 | See C<nreqs> for an example. |
237 | See C<nreqs> for an example. |
228 | |
238 | |
229 | =item IO::AIO::nreqs |
239 | =item IO::AIO::nreqs |
230 | |
240 | |
231 | Returns the number of requests currently outstanding. |
241 | Returns the number of requests currently outstanding (i.e. for which their |
|
|
242 | callback has not been invoked yet). |
232 | |
243 | |
233 | Example: wait till there are no outstanding requests anymore: |
244 | Example: wait till there are no outstanding requests anymore: |
234 | |
245 | |
235 | IO::AIO::poll_wait, IO::AIO::poll_cb |
246 | IO::AIO::poll_wait, IO::AIO::poll_cb |
236 | while IO::AIO::nreqs; |
247 | while IO::AIO::nreqs; |