ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/BDB/BDB.pm
(Generate patch)

Comparing BDB/BDB.pm (file contents):
Revision 1.21 by root, Fri Dec 7 13:38:52 2007 UTC vs.
Revision 1.48 by root, Tue Jul 29 03:33:16 2008 UTC

24 db_put $db, undef, "key", "data", 0, sub { 24 db_put $db, undef, "key", "data", 0, sub {
25 db_del $db, undef, "key"; 25 db_del $db, undef, "key";
26 }; 26 };
27 db_sync $db; 27 db_sync $db;
28 28
29 # automatic result processing with AnyEvent: 29 # when you also use Coro, management is easy:
30 our $FH; open $FH, "<&=" . BDB::poll_fileno; 30 use Coro::BDB;
31 our $WATCHER = AnyEvent->io (fh => $FH, poll => 'r', cb => \&BDB::poll_cb); 31
32 # automatic event loop intergration with AnyEvent:
33 use AnyEvent::BDB;
32 34
33 # automatic result processing with EV: 35 # automatic result processing with EV:
34 my $WATCHER = EV::io BDB::poll_fileno, EV::READ, \&BDB::poll_cb; 36 my $WATCHER = EV::io BDB::poll_fileno, EV::READ, \&BDB::poll_cb;
35 37
36 # with Glib: 38 # with Glib:
106no warnings; 108no warnings;
107use strict 'vars'; 109use strict 'vars';
108 110
109use base 'Exporter'; 111use base 'Exporter';
110 112
113our $VERSION;
114
111BEGIN { 115BEGIN {
112 our $VERSION = '1.3'; 116 $VERSION = '1.71';
113 117
114 our @BDB_REQ = qw( 118 our @BDB_REQ = qw(
115 db_env_open db_env_close db_env_txn_checkpoint db_env_lock_detect 119 db_env_open db_env_close db_env_txn_checkpoint db_env_lock_detect
116 db_env_memp_sync db_env_memp_trickle 120 db_env_memp_sync db_env_memp_trickle db_env_dbrename db_env_dbremove
117 db_open db_close db_compact db_sync db_put db_get db_pget db_del db_key_range 121 db_open db_close db_compact db_sync db_upgrade
122 db_put db_exists db_get db_pget db_del db_key_range
118 db_txn_commit db_txn_abort db_txn_finish 123 db_txn_commit db_txn_abort db_txn_finish
119 db_c_close db_c_count db_c_put db_c_get db_c_pget db_c_del 124 db_c_close db_c_count db_c_put db_c_get db_c_pget db_c_del
120 db_sequence_open db_sequence_close 125 db_sequence_open db_sequence_close
121 db_sequence_get db_sequence_remove 126 db_sequence_get db_sequence_remove
122 ); 127 );
130 135
131 require XSLoader; 136 require XSLoader;
132 XSLoader::load ("BDB", $VERSION); 137 XSLoader::load ("BDB", $VERSION);
133} 138}
134 139
140=head2 WIN32 FILENAMES/DATABASE NAME MESS
141
142Perl on Win32 supports only ASCII filenames (the reason is that it abuses
143an internal flag to store wether a filename is Unicode or ANSI, but that
144flag is used for somethign else in the perl core, so there is no way to
145detect wether a filename is ANSI or Unicode-encoded). The BDB module
146tries to work around this issue by assuming that the filename is an ANSI
147filename and BDB was built for unicode support.
148
135=head2 BERKELEYDB FUNCTIONS 149=head2 BERKELEYDB FUNCTIONS
136 150
137All of these are functions. The create functions simply return a new 151All of these are functions. The create functions simply return a new
138object and never block. All the remaining functions all take an optional 152object and never block. All the remaining functions take an optional
139callback as last argument. If it is missing, then the fucntion will be 153callback as last argument. If it is missing, then the function will be
140executed synchronously. 154executed synchronously. In both cases, C<$!> will reflect the return value
155of the function.
141 156
142BDB functions that cannot block (mostly functions that manipulate 157BDB functions that cannot block (mostly functions that manipulate
143settings) are method calls on the relevant objects, so the rule of thumb 158settings) are method calls on the relevant objects, so the rule of thumb
144is: if its a method, its not blocking, if its a function, it takes a 159is: if it's a method, it's not blocking, if it's a function, it takes a
145callback as last argument. 160callback as last argument.
146 161
147In the following, C<$int> signifies an integer return value, 162In the following, C<$int> signifies an integer return value,
148C<octetstring> is a "binary string" (i.e. a perl string with no character 163C<bdb_filename> is a "filename" (octets on unix, madness on windows),
149indices >255), C<U32> is an unsigned 32 bit integer, C<int> is some 164C<U32> is an unsigned 32 bit integer, C<int> is some integer, C<NV> is a
150integer, C<NV> is a floating point value. 165floating point value.
151 166
152The C<SV *> types are generic perl scalars (for input and output of data 167Most C<SV *> types are generic perl scalars (for input and output of data
153values), and the C<SV *callback> is the optional callback function to call 168values).
154when the request is completed.
155 169
156The various C<DB_ENV> etc. arguments are handles return by 170The various C<DB_ENV> etc. arguments are handles return by
157C<db_env_create>, C<db_create>, C<txn_begin> and so on. If they have an 171C<db_env_create>, C<db_create>, C<txn_begin> and so on. If they have an
158appended C<_ornull> this means they are optional and you can pass C<undef> 172appended C<_ornull> this means they are optional and you can pass C<undef>
159for them, resulting a NULL pointer on the C level. 173for them, resulting a NULL pointer on the C level.
160 174
175The C<SV *callback> is the optional callback function to call when the
176request is completed. This last callback argument is special: the callback
177is simply the last argument passed. If there are "optional" arguments
178before the callback they can be left out. The callback itself can be left
179out or specified as C<undef>, in which case the function will be executed
180synchronously.
181
182For example, C<db_env_txn_checkpoint> usually is called with all integer
183arguments zero. These can be left out, so all of these specify a call
184to C<< DB_ENV->txn_checkpoint >>, to be executed asynchronously with a
185callback to be called:
186
187 db_env_txn_checkpoint $db_env, 0, 0, 0, sub { };
188 db_env_txn_checkpoint $db_env, 0, 0, sub { };
189 db_env_txn_checkpoint $db_env, sub { };
190
191While these all specify a call to C<< DB_ENV->txn_checkpoint >> to be
192executed synchronously:
193
194 db_env_txn_checkpoint $db_env, 0, 0, 0, undef;
195 db_env_txn_checkpoint $db_env, 0, 0, 0;
196 db_env_txn_checkpoint $db_env, 0;
197
161=head3 BDB functions 198=head3 BDB functions
162 199
163Functions in the BDB namespace, exported by default: 200Functions in the BDB namespace, exported by default:
164 201
165 $env = db_env_create (U32 env_flags = 0) 202 $env = db_env_create (U32 env_flags = 0)
166 flags: RPCCLIENT 203 flags: RPCCLIENT
167 204
168 db_env_open (DB_ENV *env, octetstring db_home, U32 open_flags, int mode, SV *callback = &PL_sv_undef) 205 db_env_open (DB_ENV *env, bdb_filename db_home, U32 open_flags, int mode, SV *callback = &PL_sv_undef)
169 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 206 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
170 db_env_close (DB_ENV *env, U32 flags = 0, SV *callback = &PL_sv_undef) 207 db_env_close (DB_ENV *env, U32 flags = 0, SV *callback = &PL_sv_undef)
171 db_env_txn_checkpoint (DB_ENV *env, U32 kbyte = 0, U32 min = 0, U32 flags = 0, SV *callback = &PL_sv_undef) 208 db_env_txn_checkpoint (DB_ENV *env, U32 kbyte = 0, U32 min = 0, U32 flags = 0, SV *callback = &PL_sv_undef)
172 flags: FORCE 209 flags: FORCE
173 db_env_lock_detect (DB_ENV *env, U32 flags = 0, U32 atype = DB_LOCK_DEFAULT, SV *dummy = 0, SV *callback = &PL_sv_undef) 210 db_env_lock_detect (DB_ENV *env, U32 flags = 0, U32 atype = DB_LOCK_DEFAULT, SV *dummy = 0, SV *callback = &PL_sv_undef)
174 atype: LOCK_DEFAULT LOCK_EXPIRE LOCK_MAXLOCKS LOCK_MAXWRITE LOCK_MINLOCKS LOCK_MINWRITE LOCK_OLDEST LOCK_RANDOM LOCK_YOUNGEST 211 atype: LOCK_DEFAULT LOCK_EXPIRE LOCK_MAXLOCKS LOCK_MAXWRITE LOCK_MINLOCKS LOCK_MINWRITE LOCK_OLDEST LOCK_RANDOM LOCK_YOUNGEST
175 db_env_memp_sync (DB_ENV *env, SV *dummy = 0, SV *callback = &PL_sv_undef) 212 db_env_memp_sync (DB_ENV *env, SV *dummy = 0, SV *callback = &PL_sv_undef)
176 db_env_memp_trickle (DB_ENV *env, int percent, SV *dummy = 0, SV *callback = &PL_sv_undef) 213 db_env_memp_trickle (DB_ENV *env, int percent, SV *dummy = 0, SV *callback = &PL_sv_undef)
214 db_env_dbremove (DB_ENV *env, DB_TXN_ornull *txnid, bdb_filename file, bdb_filename database, U32 flags = 0, SV *callback = &PL_sv_undef)
215 db_env_dbrename (DB_ENV *env, DB_TXN_ornull *txnid, bdb_filename file, bdb_filename database, bdb_filename newname, U32 flags = 0, SV *callback = &PL_sv_undef)
177 216
178 $db = db_create (DB_ENV *env = 0, U32 flags = 0) 217 $db = db_create (DB_ENV *env = 0, U32 flags = 0)
179 flags: XA_CREATE 218 flags: XA_CREATE
180 219
181 db_open (DB *db, DB_TXN_ornull *txnid, octetstring file, octetstring database, int type, U32 flags, int mode, SV *callback = &PL_sv_undef) 220 db_open (DB *db, DB_TXN_ornull *txnid, bdb_filename file, bdb_filename database, int type, U32 flags, int mode, SV *callback = &PL_sv_undef)
182 flags: AUTO_COMMIT CREATE EXCL MULTIVERSION NOMMAP RDONLY READ_UNCOMMITTED THREAD TRUNCATE 221 flags: AUTO_COMMIT CREATE EXCL MULTIVERSION NOMMAP RDONLY READ_UNCOMMITTED THREAD TRUNCATE
183 db_close (DB *db, U32 flags = 0, SV *callback = &PL_sv_undef) 222 db_close (DB *db, U32 flags = 0, SV *callback = &PL_sv_undef)
184 flags: DB_NOSYNC 223 flags: DB_NOSYNC
224 db_upgrade (DB *db, bdb_filename file, U32 flags = 0, SV *callback = &PL_sv_undef)
185 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) 225 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)
186 flags: FREELIST_ONLY FREE_SPACE 226 flags: FREELIST_ONLY FREE_SPACE
187 db_sync (DB *db, U32 flags = 0, SV *callback = &PL_sv_undef) 227 db_sync (DB *db, U32 flags = 0, SV *callback = &PL_sv_undef)
188 db_key_range (DB *db, DB_TXN_ornull *txn, SV *key, SV *key_range, U32 flags = 0, SV *callback = &PL_sv_undef) 228 db_key_range (DB *db, DB_TXN_ornull *txn, SV *key, SV *key_range, U32 flags = 0, SV *callback = &PL_sv_undef)
189 db_put (DB *db, DB_TXN_ornull *txn, SV *key, SV *data, U32 flags = 0, SV *callback = &PL_sv_undef) 229 db_put (DB *db, DB_TXN_ornull *txn, SV *key, SV *data, U32 flags = 0, SV *callback = &PL_sv_undef)
190 flags: APPEND NODUPDATA NOOVERWRITE 230 flags: APPEND NODUPDATA NOOVERWRITE
231 db_exists (DB *db, DB_TXN_ornull *txn, SV *key, U32 flags = 0, SV *callback = 0) (v4.6)
191 db_get (DB *db, DB_TXN_ornull *txn, SV *key, SV *data, U32 flags = 0, SV *callback = &PL_sv_undef) 232 db_get (DB *db, DB_TXN_ornull *txn, SV *key, SV *data, U32 flags = 0, SV *callback = &PL_sv_undef)
192 flags: CONSUME CONSUME_WAIT GET_BOTH SET_RECNO MULTIPLE READ_COMMITTED READ_UNCOMMITTED RMW 233 flags: CONSUME CONSUME_WAIT GET_BOTH SET_RECNO MULTIPLE READ_COMMITTED READ_UNCOMMITTED RMW
193 db_pget (DB *db, DB_TXN_ornull *txn, SV *key, SV *pkey, SV *data, U32 flags = 0, SV *callback = &PL_sv_undef) 234 db_pget (DB *db, DB_TXN_ornull *txn, SV *key, SV *pkey, SV *data, U32 flags = 0, SV *callback = &PL_sv_undef)
194 flags: CONSUME CONSUME_WAIT GET_BOTH SET_RECNO MULTIPLE READ_COMMITTED READ_UNCOMMITTED RMW 235 flags: CONSUME CONSUME_WAIT GET_BOTH SET_RECNO MULTIPLE READ_COMMITTED READ_UNCOMMITTED RMW
195 db_del (DB *db, DB_TXN_ornull *txn, SV *key, U32 flags = 0, SV *callback = &PL_sv_undef) 236 db_del (DB *db, DB_TXN_ornull *txn, SV *key, U32 flags = 0, SV *callback = &PL_sv_undef)
262 $int = $env->set_data_dir (const char *dir) 303 $int = $env->set_data_dir (const char *dir)
263 $int = $env->set_tmp_dir (const char *dir) 304 $int = $env->set_tmp_dir (const char *dir)
264 $int = $env->set_lg_dir (const char *dir) 305 $int = $env->set_lg_dir (const char *dir)
265 $int = $env->set_shm_key (long shm_key) 306 $int = $env->set_shm_key (long shm_key)
266 $int = $env->set_cachesize (U32 gbytes, U32 bytes, int ncache = 0) 307 $int = $env->set_cachesize (U32 gbytes, U32 bytes, int ncache = 0)
267 $int = $env->set_flags (U32 flags, int onoff) 308 $int = $env->set_flags (U32 flags, int onoff = 1)
309 $int = $env->log_set_config (U32 flags, int onoff = 1) (v4.7)
310 $int = $env->set_intermediate_dir_mode (const char *modestring) (v4.7)
268 $env->set_errfile (FILE *errfile = 0) 311 $env->set_errfile (FILE *errfile = 0)
269 $env->set_msgfile (FILE *msgfile = 0) 312 $env->set_msgfile (FILE *msgfile = 0)
270 $int = $env->set_verbose (U32 which, int onoff = 1) 313 $int = $env->set_verbose (U32 which, int onoff = 1)
271 $int = $env->set_encrypt (const char *password, U32 flags = 0) 314 $int = $env->set_encrypt (const char *password, U32 flags = 0)
272 $int = $env->set_timeout (NV timeout_seconds, U32 flags = SET_TXN_TIMEOUT) 315 $int = $env->set_timeout (NV timeout_seconds, U32 flags = SET_TXN_TIMEOUT)
284 $int = $env->mutex_set_max (U32 max) 327 $int = $env->mutex_set_max (U32 max)
285 $int = $env->mutex_set_align (U32 align) 328 $int = $env->mutex_set_align (U32 align)
286 329
287 $txn = $env->txn_begin (DB_TXN_ornull *parent = 0, U32 flags = 0) 330 $txn = $env->txn_begin (DB_TXN_ornull *parent = 0, U32 flags = 0)
288 flags: READ_COMMITTED READ_UNCOMMITTED TXN_NOSYNC TXN_NOWAIT TXN_SNAPSHOT TXN_SYNC TXN_WAIT TXN_WRITE_NOSYNC 331 flags: READ_COMMITTED READ_UNCOMMITTED TXN_NOSYNC TXN_NOWAIT TXN_SNAPSHOT TXN_SYNC TXN_WAIT TXN_WRITE_NOSYNC
332 $txn = $env->cdsgroup_begin; (v4.5)
289 333
290=head4 Example: 334=head4 Example:
291 335
292 use AnyEvent; 336 use AnyEvent;
293 use BDB; 337 use BDB;
385 DESTROY (DBC_ornull *dbc) 429 DESTROY (DBC_ornull *dbc)
386 CODE: 430 CODE:
387 if (dbc) 431 if (dbc)
388 dbc->c_close (dbc); 432 dbc->c_close (dbc);
389 433
434 $int = $cursor->set_priority ($priority = PRIORITY_*) (v4.6)
435
390=head4 Example: 436=head4 Example:
391 437
392 my $c = $db->cursor; 438 my $c = $db->cursor;
393 439
394 for (;;) { 440 for (;;) {
427 473
428=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION 474=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
429 475
430=over 4 476=over 4
431 477
478=item $msg = BDB::strerror [$errno]
479
480Returns the string corresponding to the given errno value. If no argument
481is given, use C<$!>.
482
483Note that the BDB module also patches the C<$!> variable directly, so you
484should be able to get a bdb error string by simply stringifying C<$!>.
485
432=item $fileno = BDB::poll_fileno 486=item $fileno = BDB::poll_fileno
433 487
434Return the I<request result pipe file descriptor>. This filehandle must be 488Return the I<request result pipe file descriptor>. This filehandle must be
435polled for reading by some mechanism outside this module (e.g. Event or 489polled for reading by some mechanism outside this module (e.g. Event or
436select, see below or the SYNOPSIS). If the pipe becomes readable you have 490select, see below or the SYNOPSIS). If the pipe becomes readable you have
512 BDB::poll_wait, BDB::poll_cb 566 BDB::poll_wait, BDB::poll_cb
513 while BDB::nreqs; 567 while BDB::nreqs;
514 568
515=back 569=back
516 570
571=head3 VERSION CHECKING
572
573BerkeleyDB comes in various versions, many of them have minor
574incompatibilities. This means that traditional "at least version x.x"
575checks are often not sufficient.
576
577Example: set the log_autoremove option in a way compatible with <v4.7 and
578v4.7. Note the use of & on the constants to avoid triggering a compiletime
579bug when the symbol isn't available.
580
581 $DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
582 $DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
583
584=over 4
585
586=item BDB::VERSION
587
588The C<BDB::VERSION> function, when called without arguments, returns the
589Berkeley DB version as a v-string (usually with 3 components). You should
590use C<lt> and C<ge> operators exclusively to make comparisons.
591
592Example: check for at least version 4.7.
593
594 BDB::VERSION ge v4.7 or die;
595
596=item BDB::VERSION min-version
597
598Returns true if the BDB version is at least the given version (specified
599as a v-string), false otherwise.
600
601Example: check for at least version 4.5.
602
603 BDB::VERSION v4.7 or die;
604
605=item BDB::VERSION min-version, max-version
606
607Returns true of the BDB version is at least version C<min-version> (specify C<undef> or C<v0> for any minimum version)
608and less then C<max-version>.
609
610Example: check wether version is strictly less then v4.7.
611
612 BDB::VERSION v0, v4.7
613 or die "version 4.7 is not yet supported";
614
615=back
616
617=cut
618
619sub VERSION {
620 # I was dumb enough to override the VERSION method here, so let's try
621 # to fix it up.
622
623 if ($_[0] eq __PACKAGE__) {
624 $VERSION
625 } else {
626 if (@_ > 0) {
627 return undef if VERSION_v lt $_[0];
628 if (@_ > 1) {
629 return undef if VERSION_v ge $_[1];
630 }
631 }
632
633 VERSION_v
634 }
635}
636
517=head3 CONTROLLING THE NUMBER OF THREADS 637=head3 CONTROLLING THE NUMBER OF THREADS
518 638
519=over 4 639=over 4
520 640
521=item BDB::min_parallel $nthreads 641=item BDB::min_parallel $nthreads
587 707
588=item BDB::set_sync_prepare $cb 708=item BDB::set_sync_prepare $cb
589 709
590Sets a callback that is called whenever a request is created without an 710Sets a callback that is called whenever a request is created without an
591explicit callback. It has to return two code references. The first is used 711explicit callback. It has to return two code references. The first is used
592as the request callback, and the second is called to wait until the first 712as the request callback (it should save the return status), and the second
713is called to wait until the first callback has been called (it must set
714C<$!> to the return status).
715
716This mechanism can be used to include BDB into other event mechanisms,
717such as L<AnyEvent::BDB> or L<Coro::BDB>.
718
593callback has been called. The default implementation works like this: 719The default implementation works like this:
594 720
595 sub { 721 sub {
596 my $status; 722 my $status;
597 ( 723 (
598 sub { $status = $! }, 724 sub { $status = $! },
599 sub { BDB::poll while !defined $status; $! = $status }, 725 sub { BDB::poll while !defined $status; $! = $status },
600 ) 726 )
601 } 727 }
728
729It simply blocks the process till the request has finished and then sets
730C<$!> to the return value. This means that if you don't use a callback,
731BDB will simply fall back to synchronous operations.
602 732
603=back 733=back
604 734
605=head3 STATISTICAL INFORMATION 735=head3 STATISTICAL INFORMATION
606 736
663 793
664In short: the parent will, after a short pause, continue as if fork had 794In short: the parent will, after a short pause, continue as if fork had
665not been called, while the child will act as if BDB has not been used 795not been called, while the child will act as if BDB has not been used
666yet. 796yet.
667 797
798Win32 note: there is no fork on win32, and perls emulation of it is too
799broken to be supported, so do not use BDB in a windows pseudo-fork, better
800yet, switch to a more capable platform.
801
668=head2 MEMORY USAGE 802=head2 MEMORY USAGE
669 803
670Per-request usage: 804Per-request usage:
671 805
672Each aio request uses - depending on your architecture - around 100-200 806Each aio request uses - depending on your architecture - around 100-200
693 TXN_DEADLOCK flag will be set on the transaction. See C<db_txn_finish>, 827 TXN_DEADLOCK flag will be set on the transaction. See C<db_txn_finish>,
694 above. 828 above.
695 829
696=head1 SEE ALSO 830=head1 SEE ALSO
697 831
698L<Coro::BDB>, L<IO::AIO>. 832L<AnyEvent::BDB> (event loop integration), L<Coro::BDB> (more natural
833syntax), L<IO::AIO> (nice to have).
699 834
700=head1 AUTHOR 835=head1 AUTHOR
701 836
702 Marc Lehmann <schmorp@schmorp.de> 837 Marc Lehmann <schmorp@schmorp.de>
703 http://home.schmorp.de/ 838 http://home.schmorp.de/

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines