… | |
… | |
2 | IO::AIO - Asynchronous Input/Output |
2 | IO::AIO - Asynchronous Input/Output |
3 | |
3 | |
4 | SYNOPSIS |
4 | SYNOPSIS |
5 | use IO::AIO; |
5 | use IO::AIO; |
6 | |
6 | |
7 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
7 | aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub { |
8 | my ($fh) = @_; |
8 | my $fh = shift |
|
|
9 | or die "/etc/passwd: $!"; |
9 | ... |
10 | ... |
10 | }; |
11 | }; |
11 | |
12 | |
12 | aio_unlink "/tmp/file", sub { }; |
13 | aio_unlink "/tmp/file", sub { }; |
13 | |
14 | |
14 | aio_read $fh, 30000, 1024, $buffer, 0, sub { |
15 | aio_read $fh, 30000, 1024, $buffer, 0, sub { |
15 | $_[0] > 0 or die "read error: $!"; |
16 | $_[0] > 0 or die "read error: $!"; |
16 | }; |
17 | }; |
17 | |
18 | |
18 | # Event |
19 | # version 2+ has request and group objects |
19 | Event->io (fd => IO::AIO::poll_fileno, |
20 | use IO::AIO 2; |
20 | poll => 'r', |
|
|
21 | cb => \&IO::AIO::poll_cb); |
|
|
22 | |
21 | |
23 | # Glib/Gtk2 |
22 | aioreq_pri 4; # give next request a very high priority |
24 | add_watch Glib::IO IO::AIO::poll_fileno, |
23 | my $req = aio_unlink "/tmp/file", sub { }; |
25 | in => sub { IO::AIO::poll_cb; 1 }; |
24 | $req->cancel; # cancel request if still in queue |
26 | |
25 | |
27 | # Tk |
26 | my $grp = aio_group sub { print "all stats done\n" }; |
28 | Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "", |
27 | add $grp aio_stat "..." for ...; |
29 | readable => \&IO::AIO::poll_cb); |
|
|
30 | |
|
|
31 | # Danga::Socket |
|
|
32 | Danga::Socket->AddOtherFds (IO::AIO::poll_fileno => |
|
|
33 | \&IO::AIO::poll_cb); |
|
|
34 | |
28 | |
35 | DESCRIPTION |
29 | DESCRIPTION |
36 | This module implements asynchronous I/O using whatever means your |
30 | This module implements asynchronous I/O using whatever means your |
37 | operating system supports. |
31 | operating system supports. It is implemented as an interface to "libeio" |
|
|
32 | (<http://software.schmorp.de/pkg/libeio.html>). |
38 | |
33 | |
|
|
34 | Asynchronous means that operations that can normally block your program |
|
|
35 | (e.g. reading from disk) will be done asynchronously: the operation will |
|
|
36 | still block, but you can do something else in the meantime. This is |
|
|
37 | extremely useful for programs that need to stay interactive even when |
|
|
38 | doing heavy I/O (GUI programs, high performance network servers etc.), |
|
|
39 | but can also be used to easily do operations in parallel that are |
|
|
40 | normally done sequentially, e.g. stat'ing many files, which is much |
|
|
41 | faster on a RAID volume or over NFS when you do a number of stat |
|
|
42 | operations concurrently. |
|
|
43 | |
|
|
44 | While most of this works on all types of file descriptors (for example |
|
|
45 | sockets), using these functions on file descriptors that support |
|
|
46 | nonblocking operation (again, sockets, pipes etc.) is very inefficient. |
|
|
47 | Use an event loop for that (such as the EV module): IO::AIO will |
|
|
48 | naturally fit into such an event loop itself. |
|
|
49 | |
39 | Currently, a number of threads are started that execute your read/writes |
50 | In this version, a number of threads are started that execute your |
40 | and signal their completion. You don't need thread support in your libc |
51 | requests and signal their completion. You don't need thread support in |
41 | or perl, and the threads created by this module will not be visible to |
52 | perl, and the threads created by this module will not be visible to |
42 | the pthreads library. In the future, this module might make use of the |
53 | perl. In the future, this module might make use of the native aio |
43 | native aio functions available on many operating systems. However, they |
54 | functions available on many operating systems. However, they are often |
44 | are often not well-supported (Linux doesn't allow them on normal files |
55 | not well-supported or restricted (GNU/Linux doesn't allow them on normal |
45 | currently, for example), and they would only support aio_read and |
56 | files currently, for example), and they would only support aio_read and |
46 | aio_write, so the remaining functionality would have to be implemented |
57 | aio_write, so the remaining functionality would have to be implemented |
47 | using threads anyway. |
58 | using threads anyway. |
48 | |
59 | |
49 | Although the module will work with in the presence of other threads, it |
60 | Although the module will work in the presence of other (Perl-) threads, |
50 | is currently not reentrant, so use appropriate locking yourself, always |
61 | it is currently not reentrant in any way, so use appropriate locking |
51 | call "poll_cb" from within the same thread, or never call "poll_cb" (or |
62 | yourself, always call "poll_cb" from within the same thread, or never |
52 | other "aio_" functions) recursively. |
63 | call "poll_cb" (or other "aio_" functions) recursively. |
|
|
64 | |
|
|
65 | EXAMPLE |
|
|
66 | This is a simple example that uses the EV module and loads /etc/passwd |
|
|
67 | asynchronously: |
|
|
68 | |
|
|
69 | use Fcntl; |
|
|
70 | use EV; |
|
|
71 | use IO::AIO; |
|
|
72 | |
|
|
73 | # register the IO::AIO callback with EV |
|
|
74 | my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; |
|
|
75 | |
|
|
76 | # queue the request to open /etc/passwd |
|
|
77 | aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub { |
|
|
78 | my $fh = shift |
|
|
79 | or die "error while opening: $!"; |
|
|
80 | |
|
|
81 | # stat'ing filehandles is generally non-blocking |
|
|
82 | my $size = -s $fh; |
|
|
83 | |
|
|
84 | # queue a request to read the file |
|
|
85 | my $contents; |
|
|
86 | aio_read $fh, 0, $size, $contents, 0, sub { |
|
|
87 | $_[0] == $size |
|
|
88 | or die "short read: $!"; |
|
|
89 | |
|
|
90 | close $fh; |
|
|
91 | |
|
|
92 | # file contents now in $contents |
|
|
93 | print $contents; |
|
|
94 | |
|
|
95 | # exit event loop and program |
|
|
96 | EV::unloop; |
|
|
97 | }; |
|
|
98 | }; |
|
|
99 | |
|
|
100 | # possibly queue up other requests, or open GUI windows, |
|
|
101 | # check for sockets etc. etc. |
|
|
102 | |
|
|
103 | # process events as long as there are some: |
|
|
104 | EV::loop; |
|
|
105 | |
|
|
106 | REQUEST ANATOMY AND LIFETIME |
|
|
107 | Every "aio_*" function creates a request. which is a C data structure |
|
|
108 | not directly visible to Perl. |
|
|
109 | |
|
|
110 | If called in non-void context, every request function returns a Perl |
|
|
111 | object representing the request. In void context, nothing is returned, |
|
|
112 | which saves a bit of memory. |
|
|
113 | |
|
|
114 | The perl object is a fairly standard ref-to-hash object. The hash |
|
|
115 | contents are not used by IO::AIO so you are free to store anything you |
|
|
116 | like in it. |
|
|
117 | |
|
|
118 | During their existance, aio requests travel through the following |
|
|
119 | states, in order: |
|
|
120 | |
|
|
121 | ready |
|
|
122 | Immediately after a request is created it is put into the ready |
|
|
123 | state, waiting for a thread to execute it. |
|
|
124 | |
|
|
125 | execute |
|
|
126 | A thread has accepted the request for processing and is currently |
|
|
127 | executing it (e.g. blocking in read). |
|
|
128 | |
|
|
129 | pending |
|
|
130 | The request has been executed and is waiting for result processing. |
|
|
131 | |
|
|
132 | While request submission and execution is fully asynchronous, result |
|
|
133 | processing is not and relies on the perl interpreter calling |
|
|
134 | "poll_cb" (or another function with the same effect). |
|
|
135 | |
|
|
136 | result |
|
|
137 | The request results are processed synchronously by "poll_cb". |
|
|
138 | |
|
|
139 | The "poll_cb" function will process all outstanding aio requests by |
|
|
140 | calling their callbacks, freeing memory associated with them and |
|
|
141 | managing any groups they are contained in. |
|
|
142 | |
|
|
143 | done |
|
|
144 | Request has reached the end of its lifetime and holds no resources |
|
|
145 | anymore (except possibly for the Perl object, but its connection to |
|
|
146 | the actual aio request is severed and calling its methods will |
|
|
147 | either do nothing or result in a runtime error). |
53 | |
148 | |
54 | FUNCTIONS |
149 | FUNCTIONS |
|
|
150 | QUICK OVERVIEW |
|
|
151 | This section simply lists the prototypes of the most important functions |
|
|
152 | for quick reference. See the following sections for function-by-function |
|
|
153 | documentation. |
|
|
154 | |
|
|
155 | aio_open $pathname, $flags, $mode, $callback->($fh) |
|
|
156 | aio_close $fh, $callback->($status) |
|
|
157 | aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
|
|
158 | aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
|
|
159 | aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) |
|
|
160 | aio_readahead $fh,$offset,$length, $callback->($retval) |
|
|
161 | aio_stat $fh_or_path, $callback->($status) |
|
|
162 | aio_lstat $fh, $callback->($status) |
|
|
163 | aio_statvfs $fh_or_path, $callback->($statvfs) |
|
|
164 | aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
|
|
165 | aio_chown $fh_or_path, $uid, $gid, $callback->($status) |
|
|
166 | aio_truncate $fh_or_path, $offset, $callback->($status) |
|
|
167 | aio_chmod $fh_or_path, $mode, $callback->($status) |
|
|
168 | aio_unlink $pathname, $callback->($status) |
|
|
169 | aio_mknod $path, $mode, $dev, $callback->($status) |
|
|
170 | aio_link $srcpath, $dstpath, $callback->($status) |
|
|
171 | aio_symlink $srcpath, $dstpath, $callback->($status) |
|
|
172 | aio_readlink $path, $callback->($link) |
|
|
173 | aio_rename $srcpath, $dstpath, $callback->($status) |
|
|
174 | aio_mkdir $pathname, $mode, $callback->($status) |
|
|
175 | aio_rmdir $pathname, $callback->($status) |
|
|
176 | aio_readdir $pathname, $callback->($entries) |
|
|
177 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
|
|
178 | IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST |
|
|
179 | IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN |
|
|
180 | aio_load $path, $data, $callback->($status) |
|
|
181 | aio_copy $srcpath, $dstpath, $callback->($status) |
|
|
182 | aio_move $srcpath, $dstpath, $callback->($status) |
|
|
183 | aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
|
|
184 | aio_rmtree $path, $callback->($status) |
|
|
185 | aio_sync $callback->($status) |
|
|
186 | aio_fsync $fh, $callback->($status) |
|
|
187 | aio_fdatasync $fh, $callback->($status) |
|
|
188 | aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
|
|
189 | aio_pathsync $path, $callback->($status) |
|
|
190 | aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
|
|
191 | aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
|
|
192 | aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) |
|
|
193 | aio_mlockall $flags, $callback->($status) |
|
|
194 | aio_group $callback->(...) |
|
|
195 | aio_nop $callback->() |
|
|
196 | |
|
|
197 | $prev_pri = aioreq_pri [$pri] |
|
|
198 | aioreq_nice $pri_adjust |
|
|
199 | |
|
|
200 | IO::AIO::poll_wait |
|
|
201 | IO::AIO::poll_cb |
|
|
202 | IO::AIO::poll |
|
|
203 | IO::AIO::flush |
|
|
204 | IO::AIO::max_poll_reqs $nreqs |
|
|
205 | IO::AIO::max_poll_time $seconds |
|
|
206 | IO::AIO::min_parallel $nthreads |
|
|
207 | IO::AIO::max_parallel $nthreads |
|
|
208 | IO::AIO::max_idle $nthreads |
|
|
209 | IO::AIO::max_outstanding $maxreqs |
|
|
210 | IO::AIO::nreqs |
|
|
211 | IO::AIO::nready |
|
|
212 | IO::AIO::npending |
|
|
213 | |
|
|
214 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
|
|
215 | IO::AIO::fadvise $fh, $offset, $len, $advice |
|
|
216 | IO::AIO::madvise $scalar, $offset, $length, $advice |
|
|
217 | IO::AIO::mprotect $scalar, $offset, $length, $protect |
|
|
218 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
|
|
219 | IO::AIO::munlockall |
|
|
220 | |
55 | AIO FUNCTIONS |
221 | AIO REQUEST FUNCTIONS |
56 | All the "aio_*" calls are more or less thin wrappers around the syscall |
222 | All the "aio_*" calls are more or less thin wrappers around the syscall |
57 | with the same name (sans "aio_"). The arguments are similar or |
223 | with the same name (sans "aio_"). The arguments are similar or |
58 | identical, and they all accept an additional (and optional) $callback |
224 | identical, and they all accept an additional (and optional) $callback |
59 | argument which must be a code reference. This code reference will get |
225 | argument which must be a code reference. This code reference will get |
60 | called with the syscall return code (e.g. most syscalls return -1 on |
226 | called with the syscall return code (e.g. most syscalls return -1 on |
61 | error, unlike perl, which usually delivers "false") as it's sole |
227 | error, unlike perl, which usually delivers "false") as its sole argument |
62 | argument when the given syscall has been executed asynchronously. |
228 | after the given syscall has been executed asynchronously. |
63 | |
229 | |
64 | All functions that expect a filehandle will also accept a file |
230 | All functions expecting a filehandle keep a copy of the filehandle |
65 | descriptor. |
231 | internally until the request has finished. |
66 | |
232 | |
|
|
233 | All functions return request objects of type IO::AIO::REQ that allow |
|
|
234 | further manipulation of those requests while they are in-flight. |
|
|
235 | |
67 | The filenames you pass to these routines *must* be absolute. The reason |
236 | The pathnames you pass to these routines *must* be absolute and encoded |
68 | for this is that at the time the request is being executed, the current |
237 | as octets. The reason for the former is that at the time the request is |
69 | working directory could have changed. Alternatively, you can make sure |
238 | being executed, the current working directory could have changed. |
70 | that you never change the current working directory. |
239 | Alternatively, you can make sure that you never change the current |
|
|
240 | working directory anywhere in the program and then use relative paths. |
71 | |
241 | |
|
|
242 | To encode pathnames as octets, either make sure you either: a) always |
|
|
243 | pass in filenames you got from outside (command line, readdir etc.) |
|
|
244 | without tinkering, b) are ASCII or ISO 8859-1, c) use the Encode module |
|
|
245 | and encode your pathnames to the locale (or other) encoding in effect in |
|
|
246 | the user environment, d) use Glib::filename_from_unicode on unicode |
|
|
247 | filenames or e) use something else to ensure your scalar has the correct |
|
|
248 | contents. |
|
|
249 | |
|
|
250 | This works, btw. independent of the internal UTF-8 bit, which IO::AIO |
|
|
251 | handles correctly whether it is set or not. |
|
|
252 | |
|
|
253 | $prev_pri = aioreq_pri [$pri] |
|
|
254 | Returns the priority value that would be used for the next request |
|
|
255 | and, if $pri is given, sets the priority for the next aio request. |
|
|
256 | |
|
|
257 | The default priority is 0, the minimum and maximum priorities are -4 |
|
|
258 | and 4, respectively. Requests with higher priority will be serviced |
|
|
259 | first. |
|
|
260 | |
|
|
261 | The priority will be reset to 0 after each call to one of the |
|
|
262 | "aio_*" functions. |
|
|
263 | |
|
|
264 | Example: open a file with low priority, then read something from it |
|
|
265 | with higher priority so the read request is serviced before other |
|
|
266 | low priority open requests (potentially spamming the cache): |
|
|
267 | |
|
|
268 | aioreq_pri -3; |
|
|
269 | aio_open ..., sub { |
|
|
270 | return unless $_[0]; |
|
|
271 | |
|
|
272 | aioreq_pri -2; |
|
|
273 | aio_read $_[0], ..., sub { |
|
|
274 | ... |
|
|
275 | }; |
|
|
276 | }; |
|
|
277 | |
|
|
278 | aioreq_nice $pri_adjust |
|
|
279 | Similar to "aioreq_pri", but subtracts the given value from the |
|
|
280 | current priority, so the effect is cumulative. |
|
|
281 | |
72 | aio_open $pathname, $flags, $mode, $callback |
282 | aio_open $pathname, $flags, $mode, $callback->($fh) |
73 | Asynchronously open or create a file and call the callback with a |
283 | Asynchronously open or create a file and call the callback with a |
74 | newly created filehandle for the file. |
284 | newly created filehandle for the file. |
75 | |
285 | |
76 | The pathname passed to "aio_open" must be absolute. See API NOTES, |
286 | The pathname passed to "aio_open" must be absolute. See API NOTES, |
77 | above, for an explanation. |
287 | above, for an explanation. |
… | |
… | |
80 | They are the same as used by "sysopen". |
290 | They are the same as used by "sysopen". |
81 | |
291 | |
82 | Likewise, $mode specifies the mode of the newly created file, if it |
292 | Likewise, $mode specifies the mode of the newly created file, if it |
83 | didn't exist and "O_CREAT" has been given, just like perl's |
293 | didn't exist and "O_CREAT" has been given, just like perl's |
84 | "sysopen", except that it is mandatory (i.e. use 0 if you don't |
294 | "sysopen", except that it is mandatory (i.e. use 0 if you don't |
85 | create new files, and 0666 or 0777 if you do). |
295 | create new files, and 0666 or 0777 if you do). Note that the $mode |
|
|
296 | will be modified by the umask in effect then the request is being |
|
|
297 | executed, so better never change the umask. |
86 | |
298 | |
87 | Example: |
299 | Example: |
88 | |
300 | |
89 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
301 | aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub { |
90 | if ($_[0]) { |
302 | if ($_[0]) { |
91 | print "open successful, fh is $_[0]\n"; |
303 | print "open successful, fh is $_[0]\n"; |
92 | ... |
304 | ... |
93 | } else { |
305 | } else { |
94 | die "open failed: $!\n"; |
306 | die "open failed: $!\n"; |
95 | } |
307 | } |
96 | }; |
308 | }; |
97 | |
309 | |
98 | aio_close $fh, $callback |
310 | aio_close $fh, $callback->($status) |
99 | Asynchronously close a file and call the callback with the result |
311 | Asynchronously close a file and call the callback with the result |
100 | code. *WARNING:* although accepted, you should not pass in a perl |
312 | code. |
101 | filehandle here, as perl will likely close the file descriptor |
|
|
102 | another time when the filehandle is destroyed. Normally, you can |
|
|
103 | safely call perls "close" or just let filehandles go out of scope. |
|
|
104 | |
313 | |
105 | This is supposed to be a bug in the API, so that might change. It's |
314 | Unfortunately, you can't do this to perl. Perl *insists* very |
106 | therefore best to avoid this function. |
315 | strongly on closing the file descriptor associated with the |
|
|
316 | filehandle itself. |
107 | |
317 | |
|
|
318 | Therefore, "aio_close" will not close the filehandle - instead it |
|
|
319 | will use dup2 to overwrite the file descriptor with the write-end of |
|
|
320 | a pipe (the pipe fd will be created on demand and will be cached). |
|
|
321 | |
|
|
322 | Or in other words: the file descriptor will be closed, but it will |
|
|
323 | not be free for reuse until the perl filehandle is closed. |
|
|
324 | |
108 | aio_read $fh,$offset,$length, $data,$dataoffset,$callback |
325 | aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
109 | aio_write $fh,$offset,$length, $data,$dataoffset,$callback |
326 | aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
110 | Reads or writes "length" bytes from the specified "fh" and "offset" |
327 | Reads or writes $length bytes from or to the specified $fh and |
111 | into the scalar given by "data" and offset "dataoffset" and calls |
328 | $offset into the scalar given by $data and offset $dataoffset and |
112 | the callback without the actual number of bytes read (or -1 on |
329 | calls the callback without the actual number of bytes read (or -1 on |
113 | error, just like the syscall). |
330 | error, just like the syscall). |
|
|
331 | |
|
|
332 | "aio_read" will, like "sysread", shrink or grow the $data scalar to |
|
|
333 | offset plus the actual number of bytes read. |
|
|
334 | |
|
|
335 | If $offset is undefined, then the current file descriptor offset |
|
|
336 | will be used (and updated), otherwise the file descriptor offset |
|
|
337 | will not be changed by these calls. |
|
|
338 | |
|
|
339 | If $length is undefined in "aio_write", use the remaining length of |
|
|
340 | $data. |
|
|
341 | |
|
|
342 | If $dataoffset is less than zero, it will be counted from the end of |
|
|
343 | $data. |
|
|
344 | |
|
|
345 | The $data scalar *MUST NOT* be modified in any way while the request |
|
|
346 | is outstanding. Modifying it can result in segfaults or World War |
|
|
347 | III (if the necessary/optional hardware is installed). |
114 | |
348 | |
115 | Example: Read 15 bytes at offset 7 into scalar $buffer, starting at |
349 | Example: Read 15 bytes at offset 7 into scalar $buffer, starting at |
116 | offset 0 within the scalar: |
350 | offset 0 within the scalar: |
117 | |
351 | |
118 | aio_read $fh, 7, 15, $buffer, 0, sub { |
352 | aio_read $fh, 7, 15, $buffer, 0, sub { |
119 | $_[0] > 0 or die "read error: $!"; |
353 | $_[0] > 0 or die "read error: $!"; |
120 | print "read $_[0] bytes: <$buffer>\n"; |
354 | print "read $_[0] bytes: <$buffer>\n"; |
121 | }; |
355 | }; |
122 | |
356 | |
|
|
357 | aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) |
|
|
358 | Tries to copy $length bytes from $in_fh to $out_fh. It starts |
|
|
359 | reading at byte offset $in_offset, and starts writing at the current |
|
|
360 | file offset of $out_fh. Because of that, it is not safe to issue |
|
|
361 | more than one "aio_sendfile" per $out_fh, as they will interfere |
|
|
362 | with each other. |
|
|
363 | |
|
|
364 | This call tries to make use of a native "sendfile" syscall to |
|
|
365 | provide zero-copy operation. For this to work, $out_fh should refer |
|
|
366 | to a socket, and $in_fh should refer to an mmap'able file. |
|
|
367 | |
|
|
368 | If a native sendfile cannot be found or it fails with "ENOSYS", |
|
|
369 | "ENOTSUP", "EOPNOTSUPP", "EAFNOSUPPORT", "EPROTOTYPE" or "ENOTSOCK", |
|
|
370 | it will be emulated, so you can call "aio_sendfile" on any type of |
|
|
371 | filehandle regardless of the limitations of the operating system. |
|
|
372 | |
|
|
373 | Please note, however, that "aio_sendfile" can read more bytes from |
|
|
374 | $in_fh than are written, and there is no way to find out how many |
|
|
375 | bytes have been read from "aio_sendfile" alone, as "aio_sendfile" |
|
|
376 | only provides the number of bytes written to $out_fh. Only if the |
|
|
377 | result value equals $length one can assume that $length bytes have |
|
|
378 | been read. |
|
|
379 | |
123 | aio_readahead $fh,$offset,$length, $callback |
380 | aio_readahead $fh,$offset,$length, $callback->($retval) |
124 | Asynchronously reads the specified byte range into the page cache, |
|
|
125 | using the "readahead" syscall. If that syscall doesn't exist (likely |
|
|
126 | if your OS isn't Linux) the status will be -1 and $! is set to |
|
|
127 | "ENOSYS". |
|
|
128 | |
|
|
129 | "aio_readahead" populates the page cache with data from a file so |
381 | "aio_readahead" populates the page cache with data from a file so |
130 | that subsequent reads from that file will not block on disk I/O. The |
382 | that subsequent reads from that file will not block on disk I/O. The |
131 | $offset argument specifies the starting point from which data is to |
383 | $offset argument specifies the starting point from which data is to |
132 | be read and $length specifies the number of bytes to be read. I/O is |
384 | be read and $length specifies the number of bytes to be read. I/O is |
133 | performed in whole pages, so that offset is effectively rounded down |
385 | performed in whole pages, so that offset is effectively rounded down |
134 | to a page boundary and bytes are read up to the next page boundary |
386 | to a page boundary and bytes are read up to the next page boundary |
135 | greater than or equal to (off-set+length). "aio_readahead" does not |
387 | greater than or equal to (off-set+length). "aio_readahead" does not |
136 | read beyond the end of the file. The current file offset of the file |
388 | read beyond the end of the file. The current file offset of the file |
137 | is left unchanged. |
389 | is left unchanged. |
138 | |
390 | |
|
|
391 | If that syscall doesn't exist (likely if your OS isn't Linux) it |
|
|
392 | will be emulated by simply reading the data, which would have a |
|
|
393 | similar effect. |
|
|
394 | |
139 | aio_stat $fh_or_path, $callback |
395 | aio_stat $fh_or_path, $callback->($status) |
140 | aio_lstat $fh, $callback |
396 | aio_lstat $fh, $callback->($status) |
141 | Works like perl's "stat" or "lstat" in void context. The callback |
397 | Works like perl's "stat" or "lstat" in void context. The callback |
142 | will be called after the stat and the results will be available |
398 | will be called after the stat and the results will be available |
143 | using "stat _" or "-s _" etc... |
399 | using "stat _" or "-s _" etc... |
144 | |
400 | |
145 | The pathname passed to "aio_stat" must be absolute. See API NOTES, |
401 | The pathname passed to "aio_stat" must be absolute. See API NOTES, |
… | |
… | |
155 | aio_stat "/etc/passwd", sub { |
411 | aio_stat "/etc/passwd", sub { |
156 | $_[0] and die "stat failed: $!"; |
412 | $_[0] and die "stat failed: $!"; |
157 | print "size is ", -s _, "\n"; |
413 | print "size is ", -s _, "\n"; |
158 | }; |
414 | }; |
159 | |
415 | |
|
|
416 | aio_statvfs $fh_or_path, $callback->($statvfs) |
|
|
417 | Works like the POSIX "statvfs" or "fstatvfs" syscalls, depending on |
|
|
418 | whether a file handle or path was passed. |
|
|
419 | |
|
|
420 | On success, the callback is passed a hash reference with the |
|
|
421 | following members: "bsize", "frsize", "blocks", "bfree", "bavail", |
|
|
422 | "files", "ffree", "favail", "fsid", "flag" and "namemax". On |
|
|
423 | failure, "undef" is passed. |
|
|
424 | |
|
|
425 | The following POSIX IO::AIO::ST_* constants are defined: "ST_RDONLY" |
|
|
426 | and "ST_NOSUID". |
|
|
427 | |
|
|
428 | The following non-POSIX IO::AIO::ST_* flag masks are defined to |
|
|
429 | their correct value when available, or to 0 on systems that do not |
|
|
430 | support them: "ST_NODEV", "ST_NOEXEC", "ST_SYNCHRONOUS", |
|
|
431 | "ST_MANDLOCK", "ST_WRITE", "ST_APPEND", "ST_IMMUTABLE", |
|
|
432 | "ST_NOATIME", "ST_NODIRATIME" and "ST_RELATIME". |
|
|
433 | |
|
|
434 | Example: stat "/wd" and dump out the data if successful. |
|
|
435 | |
|
|
436 | aio_statvfs "/wd", sub { |
|
|
437 | my $f = $_[0] |
|
|
438 | or die "statvfs: $!"; |
|
|
439 | |
|
|
440 | use Data::Dumper; |
|
|
441 | say Dumper $f; |
|
|
442 | }; |
|
|
443 | |
|
|
444 | # result: |
|
|
445 | { |
|
|
446 | bsize => 1024, |
|
|
447 | bfree => 4333064312, |
|
|
448 | blocks => 10253828096, |
|
|
449 | files => 2050765568, |
|
|
450 | flag => 4096, |
|
|
451 | favail => 2042092649, |
|
|
452 | bavail => 4333064312, |
|
|
453 | ffree => 2042092649, |
|
|
454 | namemax => 255, |
|
|
455 | frsize => 1024, |
|
|
456 | fsid => 1810 |
|
|
457 | } |
|
|
458 | |
|
|
459 | aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
|
|
460 | Works like perl's "utime" function (including the special case of |
|
|
461 | $atime and $mtime being undef). Fractional times are supported if |
|
|
462 | the underlying syscalls support them. |
|
|
463 | |
|
|
464 | When called with a pathname, uses utimes(2) if available, otherwise |
|
|
465 | utime(2). If called on a file descriptor, uses futimes(2) if |
|
|
466 | available, otherwise returns ENOSYS, so this is not portable. |
|
|
467 | |
|
|
468 | Examples: |
|
|
469 | |
|
|
470 | # set atime and mtime to current time (basically touch(1)): |
|
|
471 | aio_utime "path", undef, undef; |
|
|
472 | # set atime to current time and mtime to beginning of the epoch: |
|
|
473 | aio_utime "path", time, undef; # undef==0 |
|
|
474 | |
|
|
475 | aio_chown $fh_or_path, $uid, $gid, $callback->($status) |
|
|
476 | Works like perl's "chown" function, except that "undef" for either |
|
|
477 | $uid or $gid is being interpreted as "do not change" (but -1 can |
|
|
478 | also be used). |
|
|
479 | |
|
|
480 | Examples: |
|
|
481 | |
|
|
482 | # same as "chown root path" in the shell: |
|
|
483 | aio_chown "path", 0, -1; |
|
|
484 | # same as above: |
|
|
485 | aio_chown "path", 0, undef; |
|
|
486 | |
|
|
487 | aio_truncate $fh_or_path, $offset, $callback->($status) |
|
|
488 | Works like truncate(2) or ftruncate(2). |
|
|
489 | |
|
|
490 | aio_chmod $fh_or_path, $mode, $callback->($status) |
|
|
491 | Works like perl's "chmod" function. |
|
|
492 | |
160 | aio_unlink $pathname, $callback |
493 | aio_unlink $pathname, $callback->($status) |
161 | Asynchronously unlink (delete) a file and call the callback with the |
494 | Asynchronously unlink (delete) a file and call the callback with the |
162 | result code. |
495 | result code. |
163 | |
496 | |
|
|
497 | aio_mknod $path, $mode, $dev, $callback->($status) |
|
|
498 | [EXPERIMENTAL] |
|
|
499 | |
|
|
500 | Asynchronously create a device node (or fifo). See mknod(2). |
|
|
501 | |
|
|
502 | The only (POSIX-) portable way of calling this function is: |
|
|
503 | |
|
|
504 | aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... |
|
|
505 | |
|
|
506 | aio_link $srcpath, $dstpath, $callback->($status) |
|
|
507 | Asynchronously create a new link to the existing object at $srcpath |
|
|
508 | at the path $dstpath and call the callback with the result code. |
|
|
509 | |
|
|
510 | aio_symlink $srcpath, $dstpath, $callback->($status) |
|
|
511 | Asynchronously create a new symbolic link to the existing object at |
|
|
512 | $srcpath at the path $dstpath and call the callback with the result |
|
|
513 | code. |
|
|
514 | |
|
|
515 | aio_readlink $path, $callback->($link) |
|
|
516 | Asynchronously read the symlink specified by $path and pass it to |
|
|
517 | the callback. If an error occurs, nothing or undef gets passed to |
|
|
518 | the callback. |
|
|
519 | |
|
|
520 | aio_rename $srcpath, $dstpath, $callback->($status) |
|
|
521 | Asynchronously rename the object at $srcpath to $dstpath, just as |
|
|
522 | rename(2) and call the callback with the result code. |
|
|
523 | |
|
|
524 | aio_mkdir $pathname, $mode, $callback->($status) |
|
|
525 | Asynchronously mkdir (create) a directory and call the callback with |
|
|
526 | the result code. $mode will be modified by the umask at the time the |
|
|
527 | request is executed, so do not change your umask. |
|
|
528 | |
|
|
529 | aio_rmdir $pathname, $callback->($status) |
|
|
530 | Asynchronously rmdir (delete) a directory and call the callback with |
|
|
531 | the result code. |
|
|
532 | |
|
|
533 | aio_readdir $pathname, $callback->($entries) |
|
|
534 | Unlike the POSIX call of the same name, "aio_readdir" reads an |
|
|
535 | entire directory (i.e. opendir + readdir + closedir). The entries |
|
|
536 | will not be sorted, and will NOT include the "." and ".." entries. |
|
|
537 | |
|
|
538 | The callback is passed a single argument which is either "undef" or |
|
|
539 | an array-ref with the filenames. |
|
|
540 | |
|
|
541 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
|
|
542 | Quite similar to "aio_readdir", but the $flags argument allows to |
|
|
543 | tune behaviour and output format. In case of an error, $entries will |
|
|
544 | be "undef". |
|
|
545 | |
|
|
546 | The flags are a combination of the following constants, ORed |
|
|
547 | together (the flags will also be passed to the callback, possibly |
|
|
548 | modified): |
|
|
549 | |
|
|
550 | IO::AIO::READDIR_DENTS |
|
|
551 | When this flag is off, then the callback gets an arrayref with |
|
|
552 | of names only (as with "aio_readdir"), otherwise it gets an |
|
|
553 | arrayref with "[$name, $type, $inode]" arrayrefs, each |
|
|
554 | describing a single directory entry in more detail. |
|
|
555 | |
|
|
556 | $name is the name of the entry. |
|
|
557 | |
|
|
558 | $type is one of the "IO::AIO::DT_xxx" constants: |
|
|
559 | |
|
|
560 | "IO::AIO::DT_UNKNOWN", "IO::AIO::DT_FIFO", "IO::AIO::DT_CHR", |
|
|
561 | "IO::AIO::DT_DIR", "IO::AIO::DT_BLK", "IO::AIO::DT_REG", |
|
|
562 | "IO::AIO::DT_LNK", "IO::AIO::DT_SOCK", "IO::AIO::DT_WHT". |
|
|
563 | |
|
|
564 | "IO::AIO::DT_UNKNOWN" means just that: readdir does not know. If |
|
|
565 | you need to know, you have to run stat yourself. Also, for speed |
|
|
566 | reasons, the $type scalars are read-only: you can not modify |
|
|
567 | them. |
|
|
568 | |
|
|
569 | $inode is the inode number (which might not be exact on systems |
|
|
570 | with 64 bit inode numbers and 32 bit perls). This field has |
|
|
571 | unspecified content on systems that do not deliver the inode |
|
|
572 | information. |
|
|
573 | |
|
|
574 | IO::AIO::READDIR_DIRS_FIRST |
|
|
575 | When this flag is set, then the names will be returned in an |
|
|
576 | order where likely directories come first. This is useful when |
|
|
577 | you need to quickly find directories, or you want to find all |
|
|
578 | directories while avoiding to stat() each entry. |
|
|
579 | |
|
|
580 | If the system returns type information in readdir, then this is |
|
|
581 | used to find directories directly. Otherwise, likely directories |
|
|
582 | are files beginning with ".", or otherwise files with no dots, |
|
|
583 | of which files with short names are tried first. |
|
|
584 | |
|
|
585 | IO::AIO::READDIR_STAT_ORDER |
|
|
586 | When this flag is set, then the names will be returned in an |
|
|
587 | order suitable for stat()'ing each one. That is, when you plan |
|
|
588 | to stat() all files in the given directory, then the returned |
|
|
589 | order will likely be fastest. |
|
|
590 | |
|
|
591 | If both this flag and "IO::AIO::READDIR_DIRS_FIRST" are |
|
|
592 | specified, then the likely dirs come first, resulting in a less |
|
|
593 | optimal stat order. |
|
|
594 | |
|
|
595 | IO::AIO::READDIR_FOUND_UNKNOWN |
|
|
596 | This flag should not be set when calling "aio_readdirx". |
|
|
597 | Instead, it is being set by "aio_readdirx", when any of the |
|
|
598 | $type's found were "IO::AIO::DT_UNKNOWN". The absense of this |
|
|
599 | flag therefore indicates that all $type's are known, which can |
|
|
600 | be used to speed up some algorithms. |
|
|
601 | |
|
|
602 | aio_load $path, $data, $callback->($status) |
|
|
603 | This is a composite request that tries to fully load the given file |
|
|
604 | into memory. Status is the same as with aio_read. |
|
|
605 | |
|
|
606 | aio_copy $srcpath, $dstpath, $callback->($status) |
|
|
607 | Try to copy the *file* (directories not supported as either source |
|
|
608 | or destination) from $srcpath to $dstpath and call the callback with |
|
|
609 | a status of 0 (ok) or -1 (error, see $!). |
|
|
610 | |
|
|
611 | This is a composite request that creates the destination file with |
|
|
612 | mode 0200 and copies the contents of the source file into it using |
|
|
613 | "aio_sendfile", followed by restoring atime, mtime, access mode and |
|
|
614 | uid/gid, in that order. |
|
|
615 | |
|
|
616 | If an error occurs, the partial destination file will be unlinked, |
|
|
617 | if possible, except when setting atime, mtime, access mode and |
|
|
618 | uid/gid, where errors are being ignored. |
|
|
619 | |
|
|
620 | aio_move $srcpath, $dstpath, $callback->($status) |
|
|
621 | Try to move the *file* (directories not supported as either source |
|
|
622 | or destination) from $srcpath to $dstpath and call the callback with |
|
|
623 | a status of 0 (ok) or -1 (error, see $!). |
|
|
624 | |
|
|
625 | This is a composite request that tries to rename(2) the file first; |
|
|
626 | if rename fails with "EXDEV", it copies the file with "aio_copy" |
|
|
627 | and, if that is successful, unlinks the $srcpath. |
|
|
628 | |
|
|
629 | aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
|
|
630 | Scans a directory (similar to "aio_readdir") but additionally tries |
|
|
631 | to efficiently separate the entries of directory $path into two sets |
|
|
632 | of names, directories you can recurse into (directories), and ones |
|
|
633 | you cannot recurse into (everything else, including symlinks to |
|
|
634 | directories). |
|
|
635 | |
|
|
636 | "aio_scandir" is a composite request that creates of many sub |
|
|
637 | requests_ $maxreq specifies the maximum number of outstanding aio |
|
|
638 | requests that this function generates. If it is "<= 0", then a |
|
|
639 | suitable default will be chosen (currently 4). |
|
|
640 | |
|
|
641 | On error, the callback is called without arguments, otherwise it |
|
|
642 | receives two array-refs with path-relative entry names. |
|
|
643 | |
|
|
644 | Example: |
|
|
645 | |
|
|
646 | aio_scandir $dir, 0, sub { |
|
|
647 | my ($dirs, $nondirs) = @_; |
|
|
648 | print "real directories: @$dirs\n"; |
|
|
649 | print "everything else: @$nondirs\n"; |
|
|
650 | }; |
|
|
651 | |
|
|
652 | Implementation notes. |
|
|
653 | |
|
|
654 | The "aio_readdir" cannot be avoided, but "stat()"'ing every entry |
|
|
655 | can. |
|
|
656 | |
|
|
657 | If readdir returns file type information, then this is used directly |
|
|
658 | to find directories. |
|
|
659 | |
|
|
660 | Otherwise, after reading the directory, the modification time, size |
|
|
661 | etc. of the directory before and after the readdir is checked, and |
|
|
662 | if they match (and isn't the current time), the link count will be |
|
|
663 | used to decide how many entries are directories (if >= 2). |
|
|
664 | Otherwise, no knowledge of the number of subdirectories will be |
|
|
665 | assumed. |
|
|
666 | |
|
|
667 | Then entries will be sorted into likely directories a non-initial |
|
|
668 | dot currently) and likely non-directories (see "aio_readdirx"). Then |
|
|
669 | every entry plus an appended "/." will be "stat"'ed, likely |
|
|
670 | directories first, in order of their inode numbers. If that |
|
|
671 | succeeds, it assumes that the entry is a directory or a symlink to |
|
|
672 | directory (which will be checked seperately). This is often faster |
|
|
673 | than stat'ing the entry itself because filesystems might detect the |
|
|
674 | type of the entry without reading the inode data (e.g. ext2fs |
|
|
675 | filetype feature), even on systems that cannot return the filetype |
|
|
676 | information on readdir. |
|
|
677 | |
|
|
678 | If the known number of directories (link count - 2) has been |
|
|
679 | reached, the rest of the entries is assumed to be non-directories. |
|
|
680 | |
|
|
681 | This only works with certainty on POSIX (= UNIX) filesystems, which |
|
|
682 | fortunately are the vast majority of filesystems around. |
|
|
683 | |
|
|
684 | It will also likely work on non-POSIX filesystems with reduced |
|
|
685 | efficiency as those tend to return 0 or 1 as link counts, which |
|
|
686 | disables the directory counting heuristic. |
|
|
687 | |
|
|
688 | aio_rmtree $path, $callback->($status) |
|
|
689 | Delete a directory tree starting (and including) $path, return the |
|
|
690 | status of the final "rmdir" only. This is a composite request that |
|
|
691 | uses "aio_scandir" to recurse into and rmdir directories, and unlink |
|
|
692 | everything else. |
|
|
693 | |
|
|
694 | aio_sync $callback->($status) |
|
|
695 | Asynchronously call sync and call the callback when finished. |
|
|
696 | |
164 | aio_fsync $fh, $callback |
697 | aio_fsync $fh, $callback->($status) |
165 | Asynchronously call fsync on the given filehandle and call the |
698 | Asynchronously call fsync on the given filehandle and call the |
166 | callback with the fsync result code. |
699 | callback with the fsync result code. |
167 | |
700 | |
168 | aio_fdatasync $fh, $callback |
701 | aio_fdatasync $fh, $callback->($status) |
169 | Asynchronously call fdatasync on the given filehandle and call the |
702 | Asynchronously call fdatasync on the given filehandle and call the |
170 | callback with the fdatasync result code. Might set $! to "ENOSYS" if |
703 | callback with the fdatasync result code. |
171 | "fdatasync" is not available. |
704 | |
|
|
705 | If this call isn't available because your OS lacks it or it couldn't |
|
|
706 | be detected, it will be emulated by calling "fsync" instead. |
|
|
707 | |
|
|
708 | aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
|
|
709 | Sync the data portion of the file specified by $offset and $length |
|
|
710 | to disk (but NOT the metadata), by calling the Linux-specific |
|
|
711 | sync_file_range call. If sync_file_range is not available or it |
|
|
712 | returns ENOSYS, then fdatasync or fsync is being substituted. |
|
|
713 | |
|
|
714 | $flags can be a combination of |
|
|
715 | "IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE", |
|
|
716 | "IO::AIO::SYNC_FILE_RANGE_WRITE" and |
|
|
717 | "IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER": refer to the sync_file_range |
|
|
718 | manpage for details. |
|
|
719 | |
|
|
720 | aio_pathsync $path, $callback->($status) |
|
|
721 | This request tries to open, fsync and close the given path. This is |
|
|
722 | a composite request intended to sync directories after directory |
|
|
723 | operations (E.g. rename). This might not work on all operating |
|
|
724 | systems or have any specific effect, but usually it makes sure that |
|
|
725 | directory changes get written to disc. It works for anything that |
|
|
726 | can be opened for read-only, not just directories. |
|
|
727 | |
|
|
728 | Future versions of this function might fall back to other methods |
|
|
729 | when "fsync" on the directory fails (such as calling "sync"). |
|
|
730 | |
|
|
731 | Passes 0 when everything went ok, and -1 on error. |
|
|
732 | |
|
|
733 | aio_msync $scalar, $offset = 0, $length = undef, flags = 0, |
|
|
734 | $callback->($status) |
|
|
735 | This is a rather advanced IO::AIO call, which only works on |
|
|
736 | mmap(2)ed scalars (see the "IO::AIO::mmap" function, although it |
|
|
737 | also works on data scalars managed by the Sys::Mmap or Mmap modules, |
|
|
738 | note that the scalar must only be modified in-place while an aio |
|
|
739 | operation is pending on it). |
|
|
740 | |
|
|
741 | It calls the "msync" function of your OS, if available, with the |
|
|
742 | memory area starting at $offset in the string and ending $length |
|
|
743 | bytes later. If $length is negative, counts from the end, and if |
|
|
744 | $length is "undef", then it goes till the end of the string. The |
|
|
745 | flags can be a combination of "IO::AIO::MS_ASYNC", |
|
|
746 | "IO::AIO::MS_INVALIDATE" and "IO::AIO::MS_SYNC". |
|
|
747 | |
|
|
748 | aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, |
|
|
749 | $callback->($status) |
|
|
750 | This is a rather advanced IO::AIO call, which works best on |
|
|
751 | mmap(2)ed scalars. |
|
|
752 | |
|
|
753 | It touches (reads or writes) all memory pages in the specified range |
|
|
754 | inside the scalar. All caveats and parameters are the same as for |
|
|
755 | "aio_msync", above, except for flags, which must be either 0 (which |
|
|
756 | reads all pages and ensures they are instantiated) or |
|
|
757 | "IO::AIO::MT_MODIFY", which modifies the memory page s(by reading |
|
|
758 | and writing an octet from it, which dirties the page). |
|
|
759 | |
|
|
760 | aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) |
|
|
761 | This is a rather advanced IO::AIO call, which works best on |
|
|
762 | mmap(2)ed scalars. |
|
|
763 | |
|
|
764 | It reads in all the pages of the underlying storage into memory (if |
|
|
765 | any) and locks them, so they are not getting swapped/paged out or |
|
|
766 | removed. |
|
|
767 | |
|
|
768 | If $length is undefined, then the scalar will be locked till the |
|
|
769 | end. |
|
|
770 | |
|
|
771 | On systems that do not implement "mlock", this function returns -1 |
|
|
772 | and sets errno to "ENOSYS". |
|
|
773 | |
|
|
774 | Note that the corresponding "munlock" is synchronous and is |
|
|
775 | documented under "MISCELLANEOUS FUNCTIONS". |
|
|
776 | |
|
|
777 | Example: open a file, mmap and mlock it - both will be undone when |
|
|
778 | $data gets destroyed. |
|
|
779 | |
|
|
780 | open my $fh, "<", $path or die "$path: $!"; |
|
|
781 | my $data; |
|
|
782 | IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh; |
|
|
783 | aio_mlock $data; # mlock in background |
|
|
784 | |
|
|
785 | aio_mlockall $flags, $callback->($status) |
|
|
786 | Calls the "mlockall" function with the given $flags (a combination |
|
|
787 | of "IO::AIO::MCL_CURRENT" and "IO::AIO::MCL_FUTURE"). |
|
|
788 | |
|
|
789 | On systems that do not implement "mlockall", this function returns |
|
|
790 | -1 and sets errno to "ENOSYS". |
|
|
791 | |
|
|
792 | Note that the corresponding "munlockall" is synchronous and is |
|
|
793 | documented under "MISCELLANEOUS FUNCTIONS". |
|
|
794 | |
|
|
795 | Example: asynchronously lock all current and future pages into |
|
|
796 | memory. |
|
|
797 | |
|
|
798 | aio_mlockall IO::AIO::MCL_FUTURE; |
|
|
799 | |
|
|
800 | aio_group $callback->(...) |
|
|
801 | This is a very special aio request: Instead of doing something, it |
|
|
802 | is a container for other aio requests, which is useful if you want |
|
|
803 | to bundle many requests into a single, composite, request with a |
|
|
804 | definite callback and the ability to cancel the whole request with |
|
|
805 | its subrequests. |
|
|
806 | |
|
|
807 | Returns an object of class IO::AIO::GRP. See its documentation below |
|
|
808 | for more info. |
|
|
809 | |
|
|
810 | Example: |
|
|
811 | |
|
|
812 | my $grp = aio_group sub { |
|
|
813 | print "all stats done\n"; |
|
|
814 | }; |
|
|
815 | |
|
|
816 | add $grp |
|
|
817 | (aio_stat ...), |
|
|
818 | (aio_stat ...), |
|
|
819 | ...; |
|
|
820 | |
|
|
821 | aio_nop $callback->() |
|
|
822 | This is a special request - it does nothing in itself and is only |
|
|
823 | used for side effects, such as when you want to add a dummy request |
|
|
824 | to a group so that finishing the requests in the group depends on |
|
|
825 | executing the given code. |
|
|
826 | |
|
|
827 | While this request does nothing, it still goes through the execution |
|
|
828 | phase and still requires a worker thread. Thus, the callback will |
|
|
829 | not be executed immediately but only after other requests in the |
|
|
830 | queue have entered their execution phase. This can be used to |
|
|
831 | measure request latency. |
|
|
832 | |
|
|
833 | IO::AIO::aio_busy $fractional_seconds, $callback->() *NOT EXPORTED* |
|
|
834 | Mainly used for debugging and benchmarking, this aio request puts |
|
|
835 | one of the request workers to sleep for the given time. |
|
|
836 | |
|
|
837 | While it is theoretically handy to have simple I/O scheduling |
|
|
838 | requests like sleep and file handle readable/writable, the overhead |
|
|
839 | this creates is immense (it blocks a thread for a long time) so do |
|
|
840 | not use this function except to put your application under |
|
|
841 | artificial I/O pressure. |
|
|
842 | |
|
|
843 | IO::AIO::REQ CLASS |
|
|
844 | All non-aggregate "aio_*" functions return an object of this class when |
|
|
845 | called in non-void context. |
|
|
846 | |
|
|
847 | cancel $req |
|
|
848 | Cancels the request, if possible. Has the effect of skipping |
|
|
849 | execution when entering the execute state and skipping calling the |
|
|
850 | callback when entering the the result state, but will leave the |
|
|
851 | request otherwise untouched (with the exception of readdir). That |
|
|
852 | means that requests that currently execute will not be stopped and |
|
|
853 | resources held by the request will not be freed prematurely. |
|
|
854 | |
|
|
855 | cb $req $callback->(...) |
|
|
856 | Replace (or simply set) the callback registered to the request. |
|
|
857 | |
|
|
858 | IO::AIO::GRP CLASS |
|
|
859 | This class is a subclass of IO::AIO::REQ, so all its methods apply to |
|
|
860 | objects of this class, too. |
|
|
861 | |
|
|
862 | A IO::AIO::GRP object is a special request that can contain multiple |
|
|
863 | other aio requests. |
|
|
864 | |
|
|
865 | You create one by calling the "aio_group" constructing function with a |
|
|
866 | callback that will be called when all contained requests have entered |
|
|
867 | the "done" state: |
|
|
868 | |
|
|
869 | my $grp = aio_group sub { |
|
|
870 | print "all requests are done\n"; |
|
|
871 | }; |
|
|
872 | |
|
|
873 | You add requests by calling the "add" method with one or more |
|
|
874 | "IO::AIO::REQ" objects: |
|
|
875 | |
|
|
876 | $grp->add (aio_unlink "..."); |
|
|
877 | |
|
|
878 | add $grp aio_stat "...", sub { |
|
|
879 | $_[0] or return $grp->result ("error"); |
|
|
880 | |
|
|
881 | # add another request dynamically, if first succeeded |
|
|
882 | add $grp aio_open "...", sub { |
|
|
883 | $grp->result ("ok"); |
|
|
884 | }; |
|
|
885 | }; |
|
|
886 | |
|
|
887 | This makes it very easy to create composite requests (see the source of |
|
|
888 | "aio_move" for an application) that work and feel like simple requests. |
|
|
889 | |
|
|
890 | * The IO::AIO::GRP objects will be cleaned up during calls to |
|
|
891 | "IO::AIO::poll_cb", just like any other request. |
|
|
892 | |
|
|
893 | * They can be canceled like any other request. Canceling will cancel |
|
|
894 | not only the request itself, but also all requests it contains. |
|
|
895 | |
|
|
896 | * They can also can also be added to other IO::AIO::GRP objects. |
|
|
897 | |
|
|
898 | * You must not add requests to a group from within the group callback |
|
|
899 | (or any later time). |
|
|
900 | |
|
|
901 | Their lifetime, simplified, looks like this: when they are empty, they |
|
|
902 | will finish very quickly. If they contain only requests that are in the |
|
|
903 | "done" state, they will also finish. Otherwise they will continue to |
|
|
904 | exist. |
|
|
905 | |
|
|
906 | That means after creating a group you have some time to add requests |
|
|
907 | (precisely before the callback has been invoked, which is only done |
|
|
908 | within the "poll_cb"). And in the callbacks of those requests, you can |
|
|
909 | add further requests to the group. And only when all those requests have |
|
|
910 | finished will the the group itself finish. |
|
|
911 | |
|
|
912 | add $grp ... |
|
|
913 | $grp->add (...) |
|
|
914 | Add one or more requests to the group. Any type of IO::AIO::REQ can |
|
|
915 | be added, including other groups, as long as you do not create |
|
|
916 | circular dependencies. |
|
|
917 | |
|
|
918 | Returns all its arguments. |
|
|
919 | |
|
|
920 | $grp->cancel_subs |
|
|
921 | Cancel all subrequests and clears any feeder, but not the group |
|
|
922 | request itself. Useful when you queued a lot of events but got a |
|
|
923 | result early. |
|
|
924 | |
|
|
925 | The group request will finish normally (you cannot add requests to |
|
|
926 | the group). |
|
|
927 | |
|
|
928 | $grp->result (...) |
|
|
929 | Set the result value(s) that will be passed to the group callback |
|
|
930 | when all subrequests have finished and set the groups errno to the |
|
|
931 | current value of errno (just like calling "errno" without an error |
|
|
932 | number). By default, no argument will be passed and errno is zero. |
|
|
933 | |
|
|
934 | $grp->errno ([$errno]) |
|
|
935 | Sets the group errno value to $errno, or the current value of errno |
|
|
936 | when the argument is missing. |
|
|
937 | |
|
|
938 | Every aio request has an associated errno value that is restored |
|
|
939 | when the callback is invoked. This method lets you change this value |
|
|
940 | from its default (0). |
|
|
941 | |
|
|
942 | Calling "result" will also set errno, so make sure you either set $! |
|
|
943 | before the call to "result", or call c<errno> after it. |
|
|
944 | |
|
|
945 | feed $grp $callback->($grp) |
|
|
946 | Sets a feeder/generator on this group: every group can have an |
|
|
947 | attached generator that generates requests if idle. The idea behind |
|
|
948 | this is that, although you could just queue as many requests as you |
|
|
949 | want in a group, this might starve other requests for a potentially |
|
|
950 | long time. For example, "aio_scandir" might generate hundreds of |
|
|
951 | thousands "aio_stat" requests, delaying any later requests for a |
|
|
952 | long time. |
|
|
953 | |
|
|
954 | To avoid this, and allow incremental generation of requests, you can |
|
|
955 | instead a group and set a feeder on it that generates those |
|
|
956 | requests. The feed callback will be called whenever there are few |
|
|
957 | enough (see "limit", below) requests active in the group itself and |
|
|
958 | is expected to queue more requests. |
|
|
959 | |
|
|
960 | The feed callback can queue as many requests as it likes (i.e. "add" |
|
|
961 | does not impose any limits). |
|
|
962 | |
|
|
963 | If the feed does not queue more requests when called, it will be |
|
|
964 | automatically removed from the group. |
|
|
965 | |
|
|
966 | If the feed limit is 0 when this method is called, it will be set to |
|
|
967 | 2 automatically. |
|
|
968 | |
|
|
969 | Example: |
|
|
970 | |
|
|
971 | # stat all files in @files, but only ever use four aio requests concurrently: |
|
|
972 | |
|
|
973 | my $grp = aio_group sub { print "finished\n" }; |
|
|
974 | limit $grp 4; |
|
|
975 | feed $grp sub { |
|
|
976 | my $file = pop @files |
|
|
977 | or return; |
|
|
978 | |
|
|
979 | add $grp aio_stat $file, sub { ... }; |
|
|
980 | }; |
|
|
981 | |
|
|
982 | limit $grp $num |
|
|
983 | Sets the feeder limit for the group: The feeder will be called |
|
|
984 | whenever the group contains less than this many requests. |
|
|
985 | |
|
|
986 | Setting the limit to 0 will pause the feeding process. |
|
|
987 | |
|
|
988 | The default value for the limit is 0, but note that setting a feeder |
|
|
989 | automatically bumps it up to 2. |
172 | |
990 | |
173 | SUPPORT FUNCTIONS |
991 | SUPPORT FUNCTIONS |
|
|
992 | EVENT PROCESSING AND EVENT LOOP INTEGRATION |
174 | $fileno = IO::AIO::poll_fileno |
993 | $fileno = IO::AIO::poll_fileno |
175 | Return the *request result pipe file descriptor*. This filehandle |
994 | Return the *request result pipe file descriptor*. This filehandle |
176 | must be polled for reading by some mechanism outside this module |
995 | must be polled for reading by some mechanism outside this module |
177 | (e.g. Event or select, see below or the SYNOPSIS). If the pipe |
996 | (e.g. EV, Glib, select and so on, see below or the SYNOPSIS). If the |
178 | becomes readable you have to call "poll_cb" to check the results. |
997 | pipe becomes readable you have to call "poll_cb" to check the |
|
|
998 | results. |
179 | |
999 | |
180 | See "poll_cb" for an example. |
1000 | See "poll_cb" for an example. |
181 | |
1001 | |
182 | IO::AIO::poll_cb |
1002 | IO::AIO::poll_cb |
183 | Process all outstanding events on the result pipe. You have to call |
1003 | Process some outstanding events on the result pipe. You have to call |
184 | this regularly. Returns the number of events processed. Returns |
1004 | this regularly. Returns 0 if all events could be processed, or -1 if |
185 | immediately when no events are outstanding. |
1005 | it returned earlier for whatever reason. Returns immediately when no |
|
|
1006 | events are outstanding. The amount of events processed depends on |
|
|
1007 | the settings of "IO::AIO::max_poll_req" and |
|
|
1008 | "IO::AIO::max_poll_time". |
|
|
1009 | |
|
|
1010 | If not all requests were processed for whatever reason, the |
|
|
1011 | filehandle will still be ready when "poll_cb" returns, so normally |
|
|
1012 | you don't have to do anything special to have it called later. |
186 | |
1013 | |
187 | Example: Install an Event watcher that automatically calls |
1014 | Example: Install an Event watcher that automatically calls |
188 | IO::AIO::poll_cb with high priority: |
1015 | IO::AIO::poll_cb with high priority (more examples can be found in |
|
|
1016 | the SYNOPSIS section, at the top of this document): |
189 | |
1017 | |
190 | Event->io (fd => IO::AIO::poll_fileno, |
1018 | Event->io (fd => IO::AIO::poll_fileno, |
191 | poll => 'r', async => 1, |
1019 | poll => 'r', async => 1, |
192 | cb => \&IO::AIO::poll_cb); |
1020 | cb => \&IO::AIO::poll_cb); |
193 | |
1021 | |
194 | IO::AIO::poll_wait |
1022 | IO::AIO::poll_wait |
|
|
1023 | If there are any outstanding requests and none of them in the result |
195 | Wait till the result filehandle becomes ready for reading (simply |
1024 | phase, wait till the result filehandle becomes ready for reading |
196 | does a "select" on the filehandle. This is useful if you want to |
1025 | (simply does a "select" on the filehandle. This is useful if you |
197 | synchronously wait for some requests to finish). |
1026 | want to synchronously wait for some requests to finish). |
198 | |
1027 | |
199 | See "nreqs" for an example. |
1028 | See "nreqs" for an example. |
200 | |
1029 | |
|
|
1030 | IO::AIO::poll |
|
|
1031 | Waits until some requests have been handled. |
|
|
1032 | |
|
|
1033 | Returns the number of requests processed, but is otherwise strictly |
|
|
1034 | equivalent to: |
|
|
1035 | |
|
|
1036 | IO::AIO::poll_wait, IO::AIO::poll_cb |
|
|
1037 | |
201 | IO::AIO::nreqs |
1038 | IO::AIO::flush |
202 | Returns the number of requests currently outstanding (i.e. for which |
1039 | Wait till all outstanding AIO requests have been handled. |
203 | their callback has not been invoked yet). |
|
|
204 | |
1040 | |
205 | Example: wait till there are no outstanding requests anymore: |
1041 | Strictly equivalent to: |
206 | |
1042 | |
207 | IO::AIO::poll_wait, IO::AIO::poll_cb |
1043 | IO::AIO::poll_wait, IO::AIO::poll_cb |
208 | while IO::AIO::nreqs; |
1044 | while IO::AIO::nreqs; |
209 | |
1045 | |
210 | IO::AIO::flush |
1046 | IO::AIO::max_poll_reqs $nreqs |
211 | Wait till all outstanding AIO requests have been handled. |
1047 | IO::AIO::max_poll_time $seconds |
|
|
1048 | These set the maximum number of requests (default 0, meaning |
|
|
1049 | infinity) that are being processed by "IO::AIO::poll_cb" in one |
|
|
1050 | call, respectively the maximum amount of time (default 0, meaning |
|
|
1051 | infinity) spent in "IO::AIO::poll_cb" to process requests (more |
|
|
1052 | correctly the mininum amount of time "poll_cb" is allowed to use). |
212 | |
1053 | |
213 | Strictly equivalent to: |
1054 | Setting "max_poll_time" to a non-zero value creates an overhead of |
|
|
1055 | one syscall per request processed, which is not normally a problem |
|
|
1056 | unless your callbacks are really really fast or your OS is really |
|
|
1057 | really slow (I am not mentioning Solaris here). Using |
|
|
1058 | "max_poll_reqs" incurs no overhead. |
214 | |
1059 | |
215 | IO::AIO::poll_wait, IO::AIO::poll_cb |
1060 | Setting these is useful if you want to ensure some level of |
216 | while IO::AIO::nreqs; |
1061 | interactiveness when perl is not fast enough to process all requests |
|
|
1062 | in time. |
217 | |
1063 | |
218 | IO::AIO::poll |
1064 | For interactive programs, values such as 0.01 to 0.1 should be fine. |
219 | Waits until some requests have been handled. |
|
|
220 | |
1065 | |
221 | Strictly equivalent to: |
1066 | Example: Install an Event watcher that automatically calls |
|
|
1067 | IO::AIO::poll_cb with low priority, to ensure that other parts of |
|
|
1068 | the program get the CPU sometimes even under high AIO load. |
222 | |
1069 | |
223 | IO::AIO::poll_wait, IO::AIO::poll_cb |
1070 | # try not to spend much more than 0.1s in poll_cb |
224 | if IO::AIO::nreqs; |
1071 | IO::AIO::max_poll_time 0.1; |
225 | |
1072 | |
|
|
1073 | # use a low priority so other tasks have priority |
|
|
1074 | Event->io (fd => IO::AIO::poll_fileno, |
|
|
1075 | poll => 'r', nice => 1, |
|
|
1076 | cb => &IO::AIO::poll_cb); |
|
|
1077 | |
|
|
1078 | CONTROLLING THE NUMBER OF THREADS |
226 | IO::AIO::min_parallel $nthreads |
1079 | IO::AIO::min_parallel $nthreads |
227 | Set the minimum number of AIO threads to $nthreads. The default is |
1080 | Set the minimum number of AIO threads to $nthreads. The current |
228 | 1, which means a single asynchronous operation can be done at one |
1081 | default is 8, which means eight asynchronous operations can execute |
229 | time (the number of outstanding operations, however, is unlimited). |
1082 | concurrently at any one time (the number of outstanding requests, |
|
|
1083 | however, is unlimited). |
230 | |
1084 | |
|
|
1085 | IO::AIO starts threads only on demand, when an AIO request is queued |
|
|
1086 | and no free thread exists. Please note that queueing up a hundred |
|
|
1087 | requests can create demand for a hundred threads, even if it turns |
|
|
1088 | out that everything is in the cache and could have been processed |
|
|
1089 | faster by a single thread. |
|
|
1090 | |
231 | It is recommended to keep the number of threads low, as some Linux |
1091 | It is recommended to keep the number of threads relatively low, as |
232 | kernel versions will scale negatively with the number of threads |
1092 | some Linux kernel versions will scale negatively with the number of |
233 | (higher parallelity => MUCH higher latency). With current Linux 2.6 |
1093 | threads (higher parallelity => MUCH higher latency). With current |
234 | versions, 4-32 threads should be fine. |
1094 | Linux 2.6 versions, 4-32 threads should be fine. |
235 | |
1095 | |
236 | Under normal circumstances you don't need to call this function, as |
1096 | Under most circumstances you don't need to call this function, as |
237 | this module automatically starts some threads (the exact number |
1097 | the module selects a default that is suitable for low to moderate |
238 | might change, and is currently 4). |
1098 | load. |
239 | |
1099 | |
240 | IO::AIO::max_parallel $nthreads |
1100 | IO::AIO::max_parallel $nthreads |
241 | Sets the maximum number of AIO threads to $nthreads. If more than |
1101 | Sets the maximum number of AIO threads to $nthreads. If more than |
242 | the specified number of threads are currently running, kill them. |
1102 | the specified number of threads are currently running, this function |
243 | This function blocks until the limit is reached. |
1103 | kills them. This function blocks until the limit is reached. |
|
|
1104 | |
|
|
1105 | While $nthreads are zero, aio requests get queued but not executed |
|
|
1106 | until the number of threads has been increased again. |
244 | |
1107 | |
245 | This module automatically runs "max_parallel 0" at program end, to |
1108 | This module automatically runs "max_parallel 0" at program end, to |
246 | ensure that all threads are killed and that there are no outstanding |
1109 | ensure that all threads are killed and that there are no outstanding |
247 | requests. |
1110 | requests. |
248 | |
1111 | |
249 | Under normal circumstances you don't need to call this function. |
1112 | Under normal circumstances you don't need to call this function. |
250 | |
1113 | |
|
|
1114 | IO::AIO::max_idle $nthreads |
|
|
1115 | Limit the number of threads (default: 4) that are allowed to idle |
|
|
1116 | (i.e., threads that did not get a request to process within 10 |
|
|
1117 | seconds). That means if a thread becomes idle while $nthreads other |
|
|
1118 | threads are also idle, it will free its resources and exit. |
|
|
1119 | |
|
|
1120 | This is useful when you allow a large number of threads (e.g. 100 or |
|
|
1121 | 1000) to allow for extremely high load situations, but want to free |
|
|
1122 | resources under normal circumstances (1000 threads can easily |
|
|
1123 | consume 30MB of RAM). |
|
|
1124 | |
|
|
1125 | The default is probably ok in most situations, especially if thread |
|
|
1126 | creation is fast. If thread creation is very slow on your system you |
|
|
1127 | might want to use larger values. |
|
|
1128 | |
251 | $oldnreqs = IO::AIO::max_outstanding $nreqs |
1129 | IO::AIO::max_outstanding $maxreqs |
|
|
1130 | This is a very bad function to use in interactive programs because |
|
|
1131 | it blocks, and a bad way to reduce concurrency because it is |
|
|
1132 | inexact: Better use an "aio_group" together with a feed callback. |
|
|
1133 | |
252 | Sets the maximum number of outstanding requests to $nreqs. If you |
1134 | Sets the maximum number of outstanding requests to $nreqs. If you do |
253 | try to queue up more than this number of requests, the caller will |
1135 | queue up more than this number of requests, the next call to the |
254 | block until some requests have been handled. |
1136 | "poll_cb" (and "poll_some" and other functions calling "poll_cb") |
|
|
1137 | function will block until the limit is no longer exceeded. |
255 | |
1138 | |
256 | The default is very large, so normally there is no practical limit. |
1139 | The default value is very large, so there is no practical limit on |
257 | If you queue up many requests in a loop it it often improves speed |
1140 | the number of outstanding requests. |
258 | if you set this to a relatively low number, such as 100. |
|
|
259 | |
1141 | |
260 | Under normal circumstances you don't need to call this function. |
1142 | You can still queue as many requests as you want. Therefore, |
|
|
1143 | "max_outstanding" is mainly useful in simple scripts (with low |
|
|
1144 | values) or as a stop gap to shield against fatal memory overflow |
|
|
1145 | (with large values). |
|
|
1146 | |
|
|
1147 | STATISTICAL INFORMATION |
|
|
1148 | IO::AIO::nreqs |
|
|
1149 | Returns the number of requests currently in the ready, execute or |
|
|
1150 | pending states (i.e. for which their callback has not been invoked |
|
|
1151 | yet). |
|
|
1152 | |
|
|
1153 | Example: wait till there are no outstanding requests anymore: |
|
|
1154 | |
|
|
1155 | IO::AIO::poll_wait, IO::AIO::poll_cb |
|
|
1156 | while IO::AIO::nreqs; |
|
|
1157 | |
|
|
1158 | IO::AIO::nready |
|
|
1159 | Returns the number of requests currently in the ready state (not yet |
|
|
1160 | executed). |
|
|
1161 | |
|
|
1162 | IO::AIO::npending |
|
|
1163 | Returns the number of requests currently in the pending state |
|
|
1164 | (executed, but not yet processed by poll_cb). |
|
|
1165 | |
|
|
1166 | MISCELLANEOUS FUNCTIONS |
|
|
1167 | IO::AIO implements some functions that might be useful, but are not |
|
|
1168 | asynchronous. |
|
|
1169 | |
|
|
1170 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
|
|
1171 | Calls the "eio_sendfile_sync" function, which is like |
|
|
1172 | "aio_sendfile", but is blocking (this makes most sense if you know |
|
|
1173 | the input data is likely cached already and the output filehandle is |
|
|
1174 | set to non-blocking operations). |
|
|
1175 | |
|
|
1176 | Returns the number of bytes copied, or -1 on error. |
|
|
1177 | |
|
|
1178 | IO::AIO::fadvise $fh, $offset, $len, $advice |
|
|
1179 | Simply calls the "posix_fadvise" function (see its manpage for |
|
|
1180 | details). The following advice constants are avaiable: |
|
|
1181 | "IO::AIO::FADV_NORMAL", "IO::AIO::FADV_SEQUENTIAL", |
|
|
1182 | "IO::AIO::FADV_RANDOM", "IO::AIO::FADV_NOREUSE", |
|
|
1183 | "IO::AIO::FADV_WILLNEED", "IO::AIO::FADV_DONTNEED". |
|
|
1184 | |
|
|
1185 | On systems that do not implement "posix_fadvise", this function |
|
|
1186 | returns ENOSYS, otherwise the return value of "posix_fadvise". |
|
|
1187 | |
|
|
1188 | IO::AIO::madvise $scalar, $offset, $len, $advice |
|
|
1189 | Simply calls the "posix_madvise" function (see its manpage for |
|
|
1190 | details). The following advice constants are avaiable: |
|
|
1191 | "IO::AIO::MADV_NORMAL", "IO::AIO::MADV_SEQUENTIAL", |
|
|
1192 | "IO::AIO::MADV_RANDOM", "IO::AIO::MADV_WILLNEED", |
|
|
1193 | "IO::AIO::MADV_DONTNEED". |
|
|
1194 | |
|
|
1195 | On systems that do not implement "posix_madvise", this function |
|
|
1196 | returns ENOSYS, otherwise the return value of "posix_madvise". |
|
|
1197 | |
|
|
1198 | IO::AIO::mprotect $scalar, $offset, $len, $protect |
|
|
1199 | Simply calls the "mprotect" function on the preferably AIO::mmap'ed |
|
|
1200 | $scalar (see its manpage for details). The following protect |
|
|
1201 | constants are avaiable: "IO::AIO::PROT_NONE", "IO::AIO::PROT_READ", |
|
|
1202 | "IO::AIO::PROT_WRITE", "IO::AIO::PROT_EXEC". |
|
|
1203 | |
|
|
1204 | On systems that do not implement "mprotect", this function returns |
|
|
1205 | ENOSYS, otherwise the return value of "mprotect". |
|
|
1206 | |
|
|
1207 | IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] |
|
|
1208 | Memory-maps a file (or anonymous memory range) and attaches it to |
|
|
1209 | the given $scalar, which will act like a string scalar. |
|
|
1210 | |
|
|
1211 | The only operations allowed on the scalar are "substr"/"vec" that |
|
|
1212 | don't change the string length, and most read-only operations such |
|
|
1213 | as copying it or searching it with regexes and so on. |
|
|
1214 | |
|
|
1215 | Anything else is unsafe and will, at best, result in memory leaks. |
|
|
1216 | |
|
|
1217 | The memory map associated with the $scalar is automatically removed |
|
|
1218 | when the $scalar is destroyed, or when the "IO::AIO::mmap" or |
|
|
1219 | "IO::AIO::munmap" functions are called. |
|
|
1220 | |
|
|
1221 | This calls the "mmap"(2) function internally. See your system's |
|
|
1222 | manual page for details on the $length, $prot and $flags parameters. |
|
|
1223 | |
|
|
1224 | The $length must be larger than zero and smaller than the actual |
|
|
1225 | filesize. |
|
|
1226 | |
|
|
1227 | $prot is a combination of "IO::AIO::PROT_NONE", |
|
|
1228 | "IO::AIO::PROT_EXEC", "IO::AIO::PROT_READ" and/or |
|
|
1229 | "IO::AIO::PROT_WRITE", |
|
|
1230 | |
|
|
1231 | $flags can be a combination of "IO::AIO::MAP_SHARED" or |
|
|
1232 | "IO::AIO::MAP_PRIVATE", or a number of system-specific flags (when |
|
|
1233 | not available, the are defined as 0): "IO::AIO::MAP_ANONYMOUS" |
|
|
1234 | (which is set to "MAP_ANON" if your system only provides this |
|
|
1235 | constant), "IO::AIO::MAP_HUGETLB", "IO::AIO::MAP_LOCKED", |
|
|
1236 | "IO::AIO::MAP_NORESERVE", "IO::AIO::MAP_POPULATE" or |
|
|
1237 | "IO::AIO::MAP_NONBLOCK" |
|
|
1238 | |
|
|
1239 | If $fh is "undef", then a file descriptor of -1 is passed. |
|
|
1240 | |
|
|
1241 | $offset is the offset from the start of the file - it generally must |
|
|
1242 | be a multiple of "IO::AIO::PAGESIZE" and defaults to 0. |
|
|
1243 | |
|
|
1244 | Example: |
|
|
1245 | |
|
|
1246 | use Digest::MD5; |
|
|
1247 | use IO::AIO; |
|
|
1248 | |
|
|
1249 | open my $fh, "<verybigfile" |
|
|
1250 | or die "$!"; |
|
|
1251 | |
|
|
1252 | IO::AIO::mmap my $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh |
|
|
1253 | or die "verybigfile: $!"; |
|
|
1254 | |
|
|
1255 | my $fast_md5 = md5 $data; |
|
|
1256 | |
|
|
1257 | IO::AIO::munmap $scalar |
|
|
1258 | Removes a previous mmap and undefines the $scalar. |
|
|
1259 | |
|
|
1260 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
|
|
1261 | Calls the "munlock" function, undoing the effects of a previous |
|
|
1262 | "aio_mlock" call (see its description for details). |
|
|
1263 | |
|
|
1264 | IO::AIO::munlockall |
|
|
1265 | Calls the "munlockall" function. |
|
|
1266 | |
|
|
1267 | On systems that do not implement "munlockall", this function returns |
|
|
1268 | ENOSYS, otherwise the return value of "munlockall". |
|
|
1269 | |
|
|
1270 | EVENT LOOP INTEGRATION |
|
|
1271 | It is recommended to use AnyEvent::AIO to integrate IO::AIO |
|
|
1272 | automatically into many event loops: |
|
|
1273 | |
|
|
1274 | # AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...) |
|
|
1275 | use AnyEvent::AIO; |
|
|
1276 | |
|
|
1277 | You can also integrate IO::AIO manually into many event loops, here are |
|
|
1278 | some examples of how to do this: |
|
|
1279 | |
|
|
1280 | # EV integration |
|
|
1281 | my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; |
|
|
1282 | |
|
|
1283 | # Event integration |
|
|
1284 | Event->io (fd => IO::AIO::poll_fileno, |
|
|
1285 | poll => 'r', |
|
|
1286 | cb => \&IO::AIO::poll_cb); |
|
|
1287 | |
|
|
1288 | # Glib/Gtk2 integration |
|
|
1289 | add_watch Glib::IO IO::AIO::poll_fileno, |
|
|
1290 | in => sub { IO::AIO::poll_cb; 1 }; |
|
|
1291 | |
|
|
1292 | # Tk integration |
|
|
1293 | Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "", |
|
|
1294 | readable => \&IO::AIO::poll_cb); |
|
|
1295 | |
|
|
1296 | # Danga::Socket integration |
|
|
1297 | Danga::Socket->AddOtherFds (IO::AIO::poll_fileno => |
|
|
1298 | \&IO::AIO::poll_cb); |
|
|
1299 | |
|
|
1300 | FORK BEHAVIOUR |
|
|
1301 | This module should do "the right thing" when the process using it forks: |
|
|
1302 | |
|
|
1303 | Before the fork, IO::AIO enters a quiescent state where no requests can |
|
|
1304 | be added in other threads and no results will be processed. After the |
|
|
1305 | fork the parent simply leaves the quiescent state and continues |
|
|
1306 | request/result processing, while the child frees the request/result |
|
|
1307 | queue (so that the requests started before the fork will only be handled |
|
|
1308 | in the parent). Threads will be started on demand until the limit set in |
|
|
1309 | the parent process has been reached again. |
|
|
1310 | |
|
|
1311 | In short: the parent will, after a short pause, continue as if fork had |
|
|
1312 | not been called, while the child will act as if IO::AIO has not been |
|
|
1313 | used yet. |
|
|
1314 | |
|
|
1315 | MEMORY USAGE |
|
|
1316 | Per-request usage: |
|
|
1317 | |
|
|
1318 | Each aio request uses - depending on your architecture - around 100-200 |
|
|
1319 | bytes of memory. In addition, stat requests need a stat buffer (possibly |
|
|
1320 | a few hundred bytes), readdir requires a result buffer and so on. Perl |
|
|
1321 | scalars and other data passed into aio requests will also be locked and |
|
|
1322 | will consume memory till the request has entered the done state. |
|
|
1323 | |
|
|
1324 | This is not awfully much, so queuing lots of requests is not usually a |
|
|
1325 | problem. |
|
|
1326 | |
|
|
1327 | Per-thread usage: |
|
|
1328 | |
|
|
1329 | In the execution phase, some aio requests require more memory for |
|
|
1330 | temporary buffers, and each thread requires a stack and other data |
|
|
1331 | structures (usually around 16k-128k, depending on the OS). |
|
|
1332 | |
|
|
1333 | KNOWN BUGS |
|
|
1334 | Known bugs will be fixed in the next release. |
261 | |
1335 | |
262 | SEE ALSO |
1336 | SEE ALSO |
263 | Coro, Linux::AIO. |
1337 | AnyEvent::AIO for easy integration into event loops, Coro::AIO for a |
|
|
1338 | more natural syntax. |
264 | |
1339 | |
265 | AUTHOR |
1340 | AUTHOR |
266 | Marc Lehmann <schmorp@schmorp.de> |
1341 | Marc Lehmann <schmorp@schmorp.de> |
267 | http://home.schmorp.de/ |
1342 | http://home.schmorp.de/ |
268 | |
1343 | |