1 |
root |
1.1 |
=head1 NAME |
2 |
|
|
|
3 |
root |
1.2 |
BDB - Asynchronous Berkeley DB access |
4 |
root |
1.1 |
|
5 |
|
|
=head1 SYNOPSIS |
6 |
|
|
|
7 |
root |
1.2 |
use BDB; |
8 |
root |
1.1 |
|
9 |
|
|
=head1 DESCRIPTION |
10 |
|
|
|
11 |
root |
1.10 |
See the BerkeleyDB documentation (L<http://www.oracle.com/technology/documentation/berkeley-db/db/index.html>). |
12 |
root |
1.12 |
The BDB API is very similar to the C API (the translation has been very faithful). |
13 |
root |
1.10 |
|
14 |
|
|
See also the example sections in the document below and possibly the eg/ |
15 |
|
|
subdirectory of the BDB distribution. Last not least see the IO::AIO |
16 |
|
|
documentation, as that module uses almost the same asynchronous request |
17 |
|
|
model as this module. |
18 |
|
|
|
19 |
|
|
I know this is woefully inadequate documentation. Send a patch! |
20 |
root |
1.7 |
|
21 |
root |
1.1 |
|
22 |
|
|
=head1 REQUEST ANATOMY AND LIFETIME |
23 |
|
|
|
24 |
|
|
Every request method creates a request. which is a C data structure not |
25 |
|
|
directly visible to Perl. |
26 |
|
|
|
27 |
|
|
During their existance, bdb requests travel through the following states, |
28 |
|
|
in order: |
29 |
|
|
|
30 |
|
|
=over 4 |
31 |
|
|
|
32 |
|
|
=item ready |
33 |
|
|
|
34 |
|
|
Immediately after a request is created it is put into the ready state, |
35 |
|
|
waiting for a thread to execute it. |
36 |
|
|
|
37 |
|
|
=item execute |
38 |
|
|
|
39 |
|
|
A thread has accepted the request for processing and is currently |
40 |
|
|
executing it (e.g. blocking in read). |
41 |
|
|
|
42 |
|
|
=item pending |
43 |
|
|
|
44 |
|
|
The request has been executed and is waiting for result processing. |
45 |
|
|
|
46 |
|
|
While request submission and execution is fully asynchronous, result |
47 |
|
|
processing is not and relies on the perl interpreter calling C<poll_cb> |
48 |
|
|
(or another function with the same effect). |
49 |
|
|
|
50 |
|
|
=item result |
51 |
|
|
|
52 |
|
|
The request results are processed synchronously by C<poll_cb>. |
53 |
|
|
|
54 |
|
|
The C<poll_cb> function will process all outstanding aio requests by |
55 |
|
|
calling their callbacks, freeing memory associated with them and managing |
56 |
|
|
any groups they are contained in. |
57 |
|
|
|
58 |
|
|
=item done |
59 |
|
|
|
60 |
|
|
Request has reached the end of its lifetime and holds no resources anymore |
61 |
|
|
(except possibly for the Perl object, but its connection to the actual |
62 |
|
|
aio request is severed and calling its methods will either do nothing or |
63 |
|
|
result in a runtime error). |
64 |
|
|
|
65 |
|
|
=back |
66 |
|
|
|
67 |
|
|
=cut |
68 |
|
|
|
69 |
root |
1.2 |
package BDB; |
70 |
root |
1.1 |
|
71 |
|
|
no warnings; |
72 |
|
|
use strict 'vars'; |
73 |
|
|
|
74 |
|
|
use base 'Exporter'; |
75 |
|
|
|
76 |
|
|
BEGIN { |
77 |
root |
1.11 |
our $VERSION = '1.0'; |
78 |
root |
1.1 |
|
79 |
root |
1.3 |
our @BDB_REQ = qw( |
80 |
root |
1.6 |
db_env_open db_env_close db_env_txn_checkpoint db_env_lock_detect |
81 |
|
|
db_env_memp_sync db_env_memp_trickle |
82 |
|
|
db_open db_close db_compact db_sync db_put db_get db_pget db_del db_key_range |
83 |
root |
1.4 |
db_txn_commit db_txn_abort |
84 |
root |
1.5 |
db_c_close db_c_count db_c_put db_c_get db_c_pget db_c_del |
85 |
root |
1.6 |
db_sequence_open db_sequence_close |
86 |
|
|
db_sequence_get db_sequence_remove |
87 |
|
|
); |
88 |
|
|
our @EXPORT = (@BDB_REQ, qw(dbreq_pri dbreq_nice db_env_create db_create)); |
89 |
|
|
our @EXPORT_OK = qw( |
90 |
|
|
poll_fileno poll_cb poll_wait flush |
91 |
|
|
min_parallel max_parallel max_idle |
92 |
|
|
nreqs nready npending nthreads |
93 |
|
|
max_poll_time max_poll_reqs |
94 |
root |
1.3 |
); |
95 |
root |
1.1 |
|
96 |
|
|
require XSLoader; |
97 |
root |
1.2 |
XSLoader::load ("BDB", $VERSION); |
98 |
root |
1.1 |
} |
99 |
|
|
|
100 |
root |
1.10 |
=head2 BERKELEYDB FUNCTIONS |
101 |
|
|
|
102 |
|
|
All of these are functions. The create functions simply return a new |
103 |
|
|
object and never block. All the remaining functions all take an optional |
104 |
|
|
callback as last argument. If it is missing, then the fucntion will be |
105 |
|
|
executed synchronously. |
106 |
|
|
|
107 |
|
|
BDB functions that cannot block (mostly functions that manipulate |
108 |
|
|
settings) are method calls on the relevant objects, so the rule of thumb |
109 |
|
|
is: if its a method, its not blocking, if its a function, it takes a |
110 |
|
|
callback as last argument. |
111 |
|
|
|
112 |
|
|
In the following, C<$int> signifies an integer return value, |
113 |
|
|
C<octetstring> is a "binary string" (i.e. a perl string with no character |
114 |
|
|
indices >255), C<U32> is an unsigned 32 bit integer, C<int> is some |
115 |
|
|
integer, C<NV> is a floating point value. |
116 |
|
|
|
117 |
|
|
The C<SV *> types are generic perl scalars (for input and output of data |
118 |
|
|
values), and the C<SV *callback> is the optional callback function to call |
119 |
|
|
when the request is completed. |
120 |
|
|
|
121 |
root |
1.11 |
The various C<DB_ENV> etc. arguments are handles return by |
122 |
|
|
C<db_env_create>, C<db_create>, C<txn_begin> and so on. If they have an |
123 |
|
|
appended C<_ornull> this means they are optional and you can pass C<undef> |
124 |
|
|
for them, resulting a NULL pointer on the C level. |
125 |
root |
1.10 |
|
126 |
|
|
=head3 BDB functions |
127 |
|
|
|
128 |
|
|
Functions in the BDB namespace, exported by default: |
129 |
|
|
|
130 |
|
|
$env = db_env_create (U32 env_flags = 0) |
131 |
root |
1.14 |
flags: RPCCLIENT |
132 |
root |
1.10 |
|
133 |
|
|
db_env_open (DB_ENV *env, octetstring db_home, U32 open_flags, int mode, SV *callback = &PL_sv_undef) |
134 |
root |
1.14 |
open_flags: INIT_CDB INIT_LOCK INIT_LOG INIT_MPOOL INIT_REP INIT_TXN RECOVER RECOVER_FATAL USE_ENVIRON USE_ENVIRON_ROOT CREATE LOCKDOWN PRIVATE REGISTER SYSTEM_MEM |
135 |
root |
1.10 |
db_env_close (DB_ENV *env, U32 flags = 0, SV *callback = &PL_sv_undef) |
136 |
|
|
db_env_txn_checkpoint (DB_ENV *env, U32 kbyte = 0, U32 min = 0, U32 flags = 0, SV *callback = &PL_sv_undef) |
137 |
root |
1.14 |
flags: FORCE |
138 |
root |
1.10 |
db_env_lock_detect (DB_ENV *env, U32 flags = 0, U32 atype = DB_LOCK_DEFAULT, SV *dummy = 0, SV *callback = &PL_sv_undef) |
139 |
root |
1.14 |
atype: LOCK_DEFAULT LOCK_EXPIRE LOCK_MAXLOCKS LOCK_MAXWRITE LOCK_MINLOCKS LOCK_MINWRITE LOCK_OLDEST LOCK_RANDOM LOCK_YOUNGEST |
140 |
root |
1.10 |
db_env_memp_sync (DB_ENV *env, SV *dummy = 0, SV *callback = &PL_sv_undef) |
141 |
|
|
db_env_memp_trickle (DB_ENV *env, int percent, SV *dummy = 0, SV *callback = &PL_sv_undef) |
142 |
|
|
|
143 |
|
|
$db = db_create (DB_ENV *env = 0, U32 flags = 0) |
144 |
root |
1.14 |
flags: XA_CREATE |
145 |
root |
1.10 |
|
146 |
|
|
db_open (DB *db, DB_TXN_ornull *txnid, octetstring file, octetstring database, int type, U32 flags, int mode, SV *callback = &PL_sv_undef) |
147 |
root |
1.14 |
flags: AUTO_COMMIT CREATE EXCL MULTIVERSION NOMMAP RDONLY READ_UNCOMMITTED THREAD TRUNCATE |
148 |
root |
1.10 |
db_close (DB *db, U32 flags = 0, SV *callback = &PL_sv_undef) |
149 |
root |
1.14 |
flags: DB_NOSYNC |
150 |
root |
1.12 |
db_compact (DB *db, DB_TXN_ornull *txn = 0, SV *start = 0, SV *stop = 0, SV *unused1 = 0, U32 flags = DB_FREE_SPACE, SV *unused2 = 0, SV *callback = &PL_sv_undef) |
151 |
root |
1.14 |
flags: FREELIST_ONLY FREE_SPACE |
152 |
root |
1.10 |
db_sync (DB *db, U32 flags = 0, SV *callback = &PL_sv_undef) |
153 |
|
|
db_key_range (DB *db, DB_TXN_ornull *txn, SV *key, SV *key_range, U32 flags = 0, SV *callback = &PL_sv_undef) |
154 |
|
|
db_put (DB *db, DB_TXN_ornull *txn, SV *key, SV *data, U32 flags = 0, SV *callback = &PL_sv_undef) |
155 |
root |
1.14 |
flags: APPEND NODUPDATA NOOVERWRITE |
156 |
root |
1.10 |
db_get (DB *db, DB_TXN_ornull *txn, SV *key, SV *data, U32 flags = 0, SV *callback = &PL_sv_undef) |
157 |
root |
1.14 |
flags: CONSUME CONSUME_WAIT GET_BOTH SET_RECNO MULTIPLE READ_COMMITTED READ_UNCOMMITTED RMW |
158 |
root |
1.10 |
db_pget (DB *db, DB_TXN_ornull *txn, SV *key, SV *pkey, SV *data, U32 flags = 0, SV *callback = &PL_sv_undef) |
159 |
root |
1.14 |
flags: CONSUME CONSUME_WAIT GET_BOTH SET_RECNO MULTIPLE READ_COMMITTED READ_UNCOMMITTED RMW |
160 |
root |
1.10 |
db_del (DB *db, DB_TXN_ornull *txn, SV *key, U32 flags = 0, SV *callback = &PL_sv_undef) |
161 |
|
|
db_txn_commit (DB_TXN *txn, U32 flags = 0, SV *callback = &PL_sv_undef) |
162 |
root |
1.14 |
flags: TXN_NOSYNC TXN_SYNC |
163 |
root |
1.10 |
db_txn_abort (DB_TXN *txn, SV *callback = &PL_sv_undef) |
164 |
root |
1.14 |
|
165 |
root |
1.10 |
db_c_close (DBC *dbc, SV *callback = &PL_sv_undef) |
166 |
|
|
db_c_count (DBC *dbc, SV *count, U32 flags = 0, SV *callback = &PL_sv_undef) |
167 |
|
|
db_c_put (DBC *dbc, SV *key, SV *data, U32 flags = 0, SV *callback = &PL_sv_undef) |
168 |
root |
1.14 |
flags: AFTER BEFORE CURRENT KEYFIRST KEYLAST NODUPDATA |
169 |
root |
1.10 |
db_c_get (DBC *dbc, SV *key, SV *data, U32 flags = 0, SV *callback = &PL_sv_undef) |
170 |
root |
1.14 |
flags: CURRENT FIRST GET_BOTH GET_BOTH_RANGE GET_RECNO JOIN_ITEM LAST NEXT NEXT_DUP NEXT_NODUP PREV PREV_DUP PREV_NODUP SET SET_RANGE SET_RECNO READ_UNCOMMITTED MULTIPLE MULTIPLE_KEY RMW |
171 |
root |
1.10 |
db_c_pget (DBC *dbc, SV *key, SV *pkey, SV *data, U32 flags = 0, SV *callback = &PL_sv_undef) |
172 |
|
|
db_c_del (DBC *dbc, U32 flags = 0, SV *callback = &PL_sv_undef) |
173 |
|
|
|
174 |
|
|
db_sequence_open (DB_SEQUENCE *seq, DB_TXN_ornull *txnid, SV *key, U32 flags = 0, SV *callback = &PL_sv_undef) |
175 |
root |
1.14 |
flags: CREATE EXCL |
176 |
root |
1.10 |
db_sequence_close (DB_SEQUENCE *seq, U32 flags = 0, SV *callback = &PL_sv_undef) |
177 |
|
|
db_sequence_get (DB_SEQUENCE *seq, DB_TXN_ornull *txnid, int delta, SV *seq_value, U32 flags = DB_TXN_NOSYNC, SV *callback = &PL_sv_undef) |
178 |
root |
1.14 |
flags: TXN_NOSYNC |
179 |
root |
1.10 |
db_sequence_remove (DB_SEQUENCE *seq, DB_TXN_ornull *txnid = 0, U32 flags = 0, SV *callback = &PL_sv_undef) |
180 |
root |
1.14 |
flags: TXN_NOSYNC |
181 |
root |
1.10 |
|
182 |
|
|
=head3 DB_ENV/database environment methods |
183 |
|
|
|
184 |
|
|
Methods available on DB_ENV/$env handles: |
185 |
|
|
|
186 |
|
|
DESTROY (DB_ENV_ornull *env) |
187 |
|
|
CODE: |
188 |
|
|
if (env) |
189 |
|
|
env->close (env, 0); |
190 |
|
|
|
191 |
|
|
$int = $env->set_data_dir (const char *dir) |
192 |
|
|
$int = $env->set_tmp_dir (const char *dir) |
193 |
|
|
$int = $env->set_lg_dir (const char *dir) |
194 |
|
|
$int = $env->set_shm_key (long shm_key) |
195 |
|
|
$int = $env->set_cachesize (U32 gbytes, U32 bytes, int ncache = 0) |
196 |
|
|
$int = $env->set_flags (U32 flags, int onoff) |
197 |
|
|
$env->set_errfile (FILE *errfile = 0) |
198 |
|
|
$env->set_msgfile (FILE *msgfile = 0) |
199 |
|
|
$int = $env->set_verbose (U32 which, int onoff = 1) |
200 |
|
|
$int = $env->set_encrypt (const char *password, U32 flags = 0) |
201 |
|
|
$int = $env->set_timeout (NV timeout, U32 flags) |
202 |
|
|
$int = $env->set_mp_max_openfd (int maxopenfd); |
203 |
|
|
$int = $env->set_mp_max_write (int maxwrite, int maxwrite_sleep); |
204 |
|
|
$int = $env->set_mp_mmapsize (int mmapsize_mb) |
205 |
|
|
$int = $env->set_lk_detect (U32 detect = DB_LOCK_DEFAULT) |
206 |
|
|
$int = $env->set_lk_max_lockers (U32 max) |
207 |
|
|
$int = $env->set_lk_max_locks (U32 max) |
208 |
|
|
$int = $env->set_lk_max_objects (U32 max) |
209 |
|
|
$int = $env->set_lg_bsize (U32 max) |
210 |
|
|
$int = $env->set_lg_max (U32 max) |
211 |
|
|
|
212 |
|
|
$txn = $env->txn_begin (DB_TXN_ornull *parent = 0, U32 flags = 0) |
213 |
root |
1.14 |
flags: READ_COMMITTED READ_UNCOMMITTED TXN_NOSYNC TXN_NOWAIT TXN_SNAPSHOT TXN_SYNC TXN_WAIT TXN_WRITE_NOSYNC |
214 |
root |
1.10 |
|
215 |
root |
1.12 |
=head4 Example: |
216 |
root |
1.10 |
|
217 |
|
|
use AnyEvent; |
218 |
|
|
use BDB; |
219 |
|
|
|
220 |
|
|
our $FH; open $FH, "<&=" . BDB::poll_fileno; |
221 |
|
|
our $WATCHER = AnyEvent->io (fh => $FH, poll => 'r', cb => \&BDB::poll_cb); |
222 |
|
|
|
223 |
|
|
BDB::min_parallel 8; |
224 |
|
|
|
225 |
|
|
my $env = db_env_create; |
226 |
|
|
|
227 |
|
|
mkdir "bdtest", 0700; |
228 |
|
|
db_env_open |
229 |
|
|
$env, |
230 |
|
|
"bdtest", |
231 |
|
|
BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN | BDB::RECOVER | BDB::USE_ENVIRON | BDB::CREATE, |
232 |
|
|
0600; |
233 |
|
|
|
234 |
|
|
$env->set_flags (BDB::AUTO_COMMIT | BDB::TXN_NOSYNC, 1); |
235 |
|
|
|
236 |
|
|
|
237 |
|
|
=head3 DB/database methods |
238 |
|
|
|
239 |
|
|
Methods available on DB/$db handles: |
240 |
|
|
|
241 |
|
|
DESTROY (DB_ornull *db) |
242 |
|
|
CODE: |
243 |
|
|
if (db) |
244 |
|
|
{ |
245 |
|
|
SV *env = (SV *)db->app_private; |
246 |
|
|
db->close (db, 0); |
247 |
|
|
SvREFCNT_dec (env); |
248 |
|
|
} |
249 |
|
|
|
250 |
|
|
$int = $db->set_cachesize (U32 gbytes, U32 bytes, int ncache = 0) |
251 |
|
|
$int = $db->set_flags (U32 flags) |
252 |
root |
1.14 |
flags: CHKSUM ENCRYPT TXN_NOT_DURABLE |
253 |
|
|
Btree: DUP DUPSORT RECNUM REVSPLITOFF |
254 |
|
|
Hash: DUP DUPSORT |
255 |
|
|
Queue: INORDER |
256 |
|
|
Recno: RENUMBER SNAPSHOT |
257 |
|
|
|
258 |
root |
1.10 |
$int = $db->set_encrypt (const char *password, U32 flags) |
259 |
|
|
$int = $db->set_lorder (int lorder) |
260 |
|
|
$int = $db->set_bt_minkey (U32 minkey) |
261 |
|
|
$int = $db->set_re_delim (int delim) |
262 |
|
|
$int = $db->set_re_pad (int re_pad) |
263 |
|
|
$int = $db->set_re_source (char *source) |
264 |
|
|
$int = $db->set_re_len (U32 re_len) |
265 |
|
|
$int = $db->set_h_ffactor (U32 h_ffactor) |
266 |
|
|
$int = $db->set_h_nelem (U32 h_nelem) |
267 |
|
|
$int = $db->set_q_extentsize (U32 extentsize) |
268 |
|
|
|
269 |
|
|
$dbc = $db->cursor (DB_TXN_ornull *txn = 0, U32 flags = 0) |
270 |
root |
1.14 |
flags: READ_COMMITTED READ_UNCOMMITTED WRITECURSOR TXN_SNAPSHOT |
271 |
root |
1.10 |
$seq = $db->sequence (U32 flags = 0) |
272 |
|
|
|
273 |
root |
1.12 |
=head4 Example: |
274 |
root |
1.10 |
|
275 |
|
|
my $db = db_create $env; |
276 |
|
|
db_open $db, undef, "table", undef, BDB::BTREE, BDB::AUTO_COMMIT | BDB::CREATE | BDB::READ_UNCOMMITTED, 0600; |
277 |
|
|
|
278 |
|
|
for (1..1000) { |
279 |
|
|
db_put $db, undef, "key $_", "data $_"; |
280 |
|
|
|
281 |
|
|
db_key_range $db, undef, "key $_", my $keyrange; |
282 |
|
|
my ($lt, $eq, $gt) = @$keyrange; |
283 |
|
|
} |
284 |
|
|
|
285 |
|
|
db_del $db, undef, "key $_" for 1..1000; |
286 |
|
|
|
287 |
|
|
db_sync $db; |
288 |
|
|
|
289 |
|
|
|
290 |
|
|
=head3 DB_TXN/transaction methods |
291 |
|
|
|
292 |
|
|
Methods available on DB_TXN/$txn handles: |
293 |
|
|
|
294 |
|
|
DESTROY (DB_TXN_ornull *txn) |
295 |
|
|
CODE: |
296 |
|
|
if (txn) |
297 |
|
|
txn->abort (txn); |
298 |
|
|
|
299 |
|
|
$int = $txn->set_timeout (NV timeout, U32 flags) |
300 |
root |
1.14 |
flags: SET_LOCK_TIMEOUT SET_TXN_TIMEOUT |
301 |
root |
1.10 |
|
302 |
|
|
|
303 |
|
|
=head3 DBC/cursor methods |
304 |
|
|
|
305 |
|
|
Methods available on DBC/$dbc handles: |
306 |
|
|
|
307 |
|
|
DESTROY (DBC_ornull *dbc) |
308 |
|
|
CODE: |
309 |
|
|
if (dbc) |
310 |
|
|
dbc->c_close (dbc); |
311 |
|
|
|
312 |
root |
1.12 |
=head4 Example: |
313 |
root |
1.10 |
|
314 |
|
|
my $c = $db->cursor; |
315 |
|
|
|
316 |
|
|
for (;;) { |
317 |
|
|
db_c_get $c, my $key, my $data, BDB::NEXT; |
318 |
|
|
warn "<$!,$key,$data>"; |
319 |
|
|
last if $!; |
320 |
|
|
} |
321 |
|
|
|
322 |
|
|
db_c_close $c; |
323 |
|
|
|
324 |
root |
1.12 |
|
325 |
root |
1.10 |
=head3 DB_SEQUENCE/sequence methods |
326 |
|
|
|
327 |
|
|
Methods available on DB_SEQUENCE/$seq handles: |
328 |
|
|
|
329 |
|
|
DESTROY (DB_SEQUENCE_ornull *seq) |
330 |
|
|
CODE: |
331 |
|
|
if (seq) |
332 |
|
|
seq->close (seq, 0); |
333 |
|
|
|
334 |
|
|
$int = $seq->initial_value (db_seq_t value) |
335 |
|
|
$int = $seq->set_cachesize (U32 size) |
336 |
|
|
$int = $seq->set_flags (U32 flags) |
337 |
root |
1.14 |
flags: SEQ_DEC SEQ_INC SEQ_WRAP |
338 |
root |
1.10 |
$int = $seq->set_range (db_seq_t min, db_seq_t max) |
339 |
|
|
|
340 |
root |
1.12 |
=head4 Example: |
341 |
root |
1.10 |
|
342 |
|
|
my $seq = $db->sequence; |
343 |
|
|
|
344 |
|
|
db_sequence_open $seq, undef, "seq", BDB::CREATE; |
345 |
|
|
db_sequence_get $seq, undef, 1, my $value; |
346 |
|
|
|
347 |
|
|
|
348 |
root |
1.1 |
=head2 SUPPORT FUNCTIONS |
349 |
|
|
|
350 |
|
|
=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION |
351 |
|
|
|
352 |
|
|
=over 4 |
353 |
|
|
|
354 |
root |
1.2 |
=item $fileno = BDB::poll_fileno |
355 |
root |
1.1 |
|
356 |
|
|
Return the I<request result pipe file descriptor>. This filehandle must be |
357 |
|
|
polled for reading by some mechanism outside this module (e.g. Event or |
358 |
|
|
select, see below or the SYNOPSIS). If the pipe becomes readable you have |
359 |
|
|
to call C<poll_cb> to check the results. |
360 |
|
|
|
361 |
|
|
See C<poll_cb> for an example. |
362 |
|
|
|
363 |
root |
1.2 |
=item BDB::poll_cb |
364 |
root |
1.1 |
|
365 |
|
|
Process some outstanding events on the result pipe. You have to call this |
366 |
|
|
regularly. Returns the number of events processed. Returns immediately |
367 |
|
|
when no events are outstanding. The amount of events processed depends on |
368 |
root |
1.2 |
the settings of C<BDB::max_poll_req> and C<BDB::max_poll_time>. |
369 |
root |
1.1 |
|
370 |
|
|
If not all requests were processed for whatever reason, the filehandle |
371 |
|
|
will still be ready when C<poll_cb> returns. |
372 |
|
|
|
373 |
|
|
Example: Install an Event watcher that automatically calls |
374 |
root |
1.2 |
BDB::poll_cb with high priority: |
375 |
root |
1.1 |
|
376 |
root |
1.2 |
Event->io (fd => BDB::poll_fileno, |
377 |
root |
1.1 |
poll => 'r', async => 1, |
378 |
root |
1.2 |
cb => \&BDB::poll_cb); |
379 |
root |
1.1 |
|
380 |
root |
1.2 |
=item BDB::max_poll_reqs $nreqs |
381 |
root |
1.1 |
|
382 |
root |
1.2 |
=item BDB::max_poll_time $seconds |
383 |
root |
1.1 |
|
384 |
|
|
These set the maximum number of requests (default C<0>, meaning infinity) |
385 |
root |
1.2 |
that are being processed by C<BDB::poll_cb> in one call, respectively |
386 |
root |
1.1 |
the maximum amount of time (default C<0>, meaning infinity) spent in |
387 |
root |
1.2 |
C<BDB::poll_cb> to process requests (more correctly the mininum amount |
388 |
root |
1.1 |
of time C<poll_cb> is allowed to use). |
389 |
|
|
|
390 |
|
|
Setting C<max_poll_time> to a non-zero value creates an overhead of one |
391 |
|
|
syscall per request processed, which is not normally a problem unless your |
392 |
|
|
callbacks are really really fast or your OS is really really slow (I am |
393 |
|
|
not mentioning Solaris here). Using C<max_poll_reqs> incurs no overhead. |
394 |
|
|
|
395 |
|
|
Setting these is useful if you want to ensure some level of |
396 |
|
|
interactiveness when perl is not fast enough to process all requests in |
397 |
|
|
time. |
398 |
|
|
|
399 |
|
|
For interactive programs, values such as C<0.01> to C<0.1> should be fine. |
400 |
|
|
|
401 |
|
|
Example: Install an Event watcher that automatically calls |
402 |
root |
1.2 |
BDB::poll_cb with low priority, to ensure that other parts of the |
403 |
root |
1.1 |
program get the CPU sometimes even under high AIO load. |
404 |
|
|
|
405 |
|
|
# try not to spend much more than 0.1s in poll_cb |
406 |
root |
1.2 |
BDB::max_poll_time 0.1; |
407 |
root |
1.1 |
|
408 |
|
|
# use a low priority so other tasks have priority |
409 |
root |
1.2 |
Event->io (fd => BDB::poll_fileno, |
410 |
root |
1.1 |
poll => 'r', nice => 1, |
411 |
root |
1.2 |
cb => &BDB::poll_cb); |
412 |
root |
1.1 |
|
413 |
root |
1.2 |
=item BDB::poll_wait |
414 |
root |
1.1 |
|
415 |
|
|
If there are any outstanding requests and none of them in the result |
416 |
|
|
phase, wait till the result filehandle becomes ready for reading (simply |
417 |
|
|
does a C<select> on the filehandle. This is useful if you want to |
418 |
|
|
synchronously wait for some requests to finish). |
419 |
|
|
|
420 |
|
|
See C<nreqs> for an example. |
421 |
|
|
|
422 |
root |
1.2 |
=item BDB::poll |
423 |
root |
1.1 |
|
424 |
|
|
Waits until some requests have been handled. |
425 |
|
|
|
426 |
|
|
Returns the number of requests processed, but is otherwise strictly |
427 |
|
|
equivalent to: |
428 |
|
|
|
429 |
root |
1.2 |
BDB::poll_wait, BDB::poll_cb |
430 |
root |
1.1 |
|
431 |
root |
1.2 |
=item BDB::flush |
432 |
root |
1.1 |
|
433 |
|
|
Wait till all outstanding AIO requests have been handled. |
434 |
|
|
|
435 |
|
|
Strictly equivalent to: |
436 |
|
|
|
437 |
root |
1.2 |
BDB::poll_wait, BDB::poll_cb |
438 |
|
|
while BDB::nreqs; |
439 |
root |
1.1 |
|
440 |
root |
1.8 |
=back |
441 |
|
|
|
442 |
root |
1.1 |
=head3 CONTROLLING THE NUMBER OF THREADS |
443 |
|
|
|
444 |
root |
1.8 |
=over 4 |
445 |
|
|
|
446 |
root |
1.2 |
=item BDB::min_parallel $nthreads |
447 |
root |
1.1 |
|
448 |
|
|
Set the minimum number of AIO threads to C<$nthreads>. The current |
449 |
|
|
default is C<8>, which means eight asynchronous operations can execute |
450 |
|
|
concurrently at any one time (the number of outstanding requests, |
451 |
|
|
however, is unlimited). |
452 |
|
|
|
453 |
root |
1.2 |
BDB starts threads only on demand, when an AIO request is queued and |
454 |
root |
1.1 |
no free thread exists. Please note that queueing up a hundred requests can |
455 |
|
|
create demand for a hundred threads, even if it turns out that everything |
456 |
|
|
is in the cache and could have been processed faster by a single thread. |
457 |
|
|
|
458 |
|
|
It is recommended to keep the number of threads relatively low, as some |
459 |
|
|
Linux kernel versions will scale negatively with the number of threads |
460 |
|
|
(higher parallelity => MUCH higher latency). With current Linux 2.6 |
461 |
|
|
versions, 4-32 threads should be fine. |
462 |
|
|
|
463 |
|
|
Under most circumstances you don't need to call this function, as the |
464 |
|
|
module selects a default that is suitable for low to moderate load. |
465 |
|
|
|
466 |
root |
1.2 |
=item BDB::max_parallel $nthreads |
467 |
root |
1.1 |
|
468 |
|
|
Sets the maximum number of AIO threads to C<$nthreads>. If more than the |
469 |
|
|
specified number of threads are currently running, this function kills |
470 |
|
|
them. This function blocks until the limit is reached. |
471 |
|
|
|
472 |
|
|
While C<$nthreads> are zero, aio requests get queued but not executed |
473 |
|
|
until the number of threads has been increased again. |
474 |
|
|
|
475 |
|
|
This module automatically runs C<max_parallel 0> at program end, to ensure |
476 |
|
|
that all threads are killed and that there are no outstanding requests. |
477 |
|
|
|
478 |
|
|
Under normal circumstances you don't need to call this function. |
479 |
|
|
|
480 |
root |
1.2 |
=item BDB::max_idle $nthreads |
481 |
root |
1.1 |
|
482 |
|
|
Limit the number of threads (default: 4) that are allowed to idle (i.e., |
483 |
|
|
threads that did not get a request to process within 10 seconds). That |
484 |
|
|
means if a thread becomes idle while C<$nthreads> other threads are also |
485 |
|
|
idle, it will free its resources and exit. |
486 |
|
|
|
487 |
|
|
This is useful when you allow a large number of threads (e.g. 100 or 1000) |
488 |
|
|
to allow for extremely high load situations, but want to free resources |
489 |
|
|
under normal circumstances (1000 threads can easily consume 30MB of RAM). |
490 |
|
|
|
491 |
|
|
The default is probably ok in most situations, especially if thread |
492 |
|
|
creation is fast. If thread creation is very slow on your system you might |
493 |
|
|
want to use larger values. |
494 |
|
|
|
495 |
root |
1.2 |
=item $oldmaxreqs = BDB::max_outstanding $maxreqs |
496 |
root |
1.1 |
|
497 |
|
|
This is a very bad function to use in interactive programs because it |
498 |
|
|
blocks, and a bad way to reduce concurrency because it is inexact: Better |
499 |
|
|
use an C<aio_group> together with a feed callback. |
500 |
|
|
|
501 |
|
|
Sets the maximum number of outstanding requests to C<$nreqs>. If you |
502 |
|
|
to queue up more than this number of requests, the next call to the |
503 |
|
|
C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>) |
504 |
|
|
function will block until the limit is no longer exceeded. |
505 |
|
|
|
506 |
|
|
The default value is very large, so there is no practical limit on the |
507 |
|
|
number of outstanding requests. |
508 |
|
|
|
509 |
|
|
You can still queue as many requests as you want. Therefore, |
510 |
|
|
C<max_oustsanding> is mainly useful in simple scripts (with low values) or |
511 |
|
|
as a stop gap to shield against fatal memory overflow (with large values). |
512 |
|
|
|
513 |
root |
1.3 |
=item BDB::set_sync_prepare $cb |
514 |
|
|
|
515 |
|
|
Sets a callback that is called whenever a request is created without an |
516 |
|
|
explicit callback. It has to return two code references. The first is used |
517 |
|
|
as the request callback, and the second is called to wait until the first |
518 |
|
|
callback has been called. The default implementation works like this: |
519 |
|
|
|
520 |
|
|
sub { |
521 |
|
|
my $status; |
522 |
|
|
( |
523 |
|
|
sub { $status = $! }, |
524 |
|
|
sub { BDB::poll while !defined $status; $! = $status }, |
525 |
|
|
) |
526 |
|
|
} |
527 |
|
|
|
528 |
|
|
=back |
529 |
|
|
|
530 |
root |
1.1 |
=head3 STATISTICAL INFORMATION |
531 |
|
|
|
532 |
root |
1.3 |
=over 4 |
533 |
|
|
|
534 |
root |
1.2 |
=item BDB::nreqs |
535 |
root |
1.1 |
|
536 |
|
|
Returns the number of requests currently in the ready, execute or pending |
537 |
|
|
states (i.e. for which their callback has not been invoked yet). |
538 |
|
|
|
539 |
|
|
Example: wait till there are no outstanding requests anymore: |
540 |
|
|
|
541 |
root |
1.2 |
BDB::poll_wait, BDB::poll_cb |
542 |
|
|
while BDB::nreqs; |
543 |
root |
1.1 |
|
544 |
root |
1.2 |
=item BDB::nready |
545 |
root |
1.1 |
|
546 |
|
|
Returns the number of requests currently in the ready state (not yet |
547 |
|
|
executed). |
548 |
|
|
|
549 |
root |
1.2 |
=item BDB::npending |
550 |
root |
1.1 |
|
551 |
|
|
Returns the number of requests currently in the pending state (executed, |
552 |
|
|
but not yet processed by poll_cb). |
553 |
|
|
|
554 |
|
|
=back |
555 |
|
|
|
556 |
|
|
=cut |
557 |
|
|
|
558 |
root |
1.3 |
set_sync_prepare { |
559 |
|
|
my $status; |
560 |
|
|
( |
561 |
|
|
sub { |
562 |
|
|
$status = $!; |
563 |
|
|
}, |
564 |
|
|
sub { |
565 |
|
|
BDB::poll while !defined $status; |
566 |
|
|
$! = $status; |
567 |
|
|
}, |
568 |
|
|
) |
569 |
|
|
}; |
570 |
|
|
|
571 |
root |
1.1 |
min_parallel 8; |
572 |
|
|
|
573 |
|
|
END { flush } |
574 |
|
|
|
575 |
|
|
1; |
576 |
|
|
|
577 |
|
|
=head2 FORK BEHAVIOUR |
578 |
|
|
|
579 |
|
|
This module should do "the right thing" when the process using it forks: |
580 |
|
|
|
581 |
|
|
Before the fork, IO::AIO enters a quiescent state where no requests |
582 |
|
|
can be added in other threads and no results will be processed. After |
583 |
|
|
the fork the parent simply leaves the quiescent state and continues |
584 |
|
|
request/result processing, while the child frees the request/result queue |
585 |
|
|
(so that the requests started before the fork will only be handled in the |
586 |
|
|
parent). Threads will be started on demand until the limit set in the |
587 |
|
|
parent process has been reached again. |
588 |
|
|
|
589 |
|
|
In short: the parent will, after a short pause, continue as if fork had |
590 |
|
|
not been called, while the child will act as if IO::AIO has not been used |
591 |
|
|
yet. |
592 |
|
|
|
593 |
|
|
=head2 MEMORY USAGE |
594 |
|
|
|
595 |
|
|
Per-request usage: |
596 |
|
|
|
597 |
|
|
Each aio request uses - depending on your architecture - around 100-200 |
598 |
|
|
bytes of memory. In addition, stat requests need a stat buffer (possibly |
599 |
|
|
a few hundred bytes), readdir requires a result buffer and so on. Perl |
600 |
|
|
scalars and other data passed into aio requests will also be locked and |
601 |
|
|
will consume memory till the request has entered the done state. |
602 |
|
|
|
603 |
root |
1.13 |
This is not awfully much, so queuing lots of requests is not usually a |
604 |
root |
1.1 |
problem. |
605 |
|
|
|
606 |
|
|
Per-thread usage: |
607 |
|
|
|
608 |
|
|
In the execution phase, some aio requests require more memory for |
609 |
|
|
temporary buffers, and each thread requires a stack and other data |
610 |
|
|
structures (usually around 16k-128k, depending on the OS). |
611 |
|
|
|
612 |
|
|
=head1 KNOWN BUGS |
613 |
|
|
|
614 |
|
|
Known bugs will be fixed in the next release. |
615 |
|
|
|
616 |
|
|
=head1 SEE ALSO |
617 |
|
|
|
618 |
|
|
L<Coro::AIO>. |
619 |
|
|
|
620 |
|
|
=head1 AUTHOR |
621 |
|
|
|
622 |
|
|
Marc Lehmann <schmorp@schmorp.de> |
623 |
|
|
http://home.schmorp.de/ |
624 |
|
|
|
625 |
|
|
=cut |
626 |
|
|
|