1 package DBM::Deep::10002;
8 our $VERSION = q(1.0002);
10 use Fcntl qw( :flock );
14 use FileHandle::Fmode ();
17 #use DBM::Deep::10002::Engine;
18 #use DBM::Deep::10002::File;
21 # Setup constants for users to pass to new()
23 sub TYPE_HASH () { DBM::Deep::10002::Engine->SIG_HASH }
24 sub TYPE_ARRAY () { DBM::Deep::10002::Engine->SIG_ARRAY }
26 # This is used in all the children of this class in their TIE<type> methods.
33 $proto->_throw_error( "Odd number of parameters to " . (caller(1))[2] );
38 unless ( eval { local $SIG{'__DIE__'}; %{$_[0]} || 1 } ) {
39 $proto->_throw_error( "Not a hashref in args to " . (caller(1))[2] );
44 $args = { file => shift };
52 # Class constructor method for Perl OO interface.
53 # Calls tie() and returns blessed reference to tied hash or array,
54 # providing a hybrid OO/tie interface.
57 my $args = $class->_get_args( @_ );
60 # Check if we want a tied hash or array.
63 if (defined($args->{type}) && $args->{type} eq TYPE_ARRAY) {
64 $class = 'DBM::Deep::10002::Array';
65 #require DBM::Deep::10002::Array;
66 tie @$self, $class, %$args;
69 $class = 'DBM::Deep::10002::Hash';
70 #require DBM::Deep::10002::Hash;
71 tie %$self, $class, %$args;
74 return bless $self, $class;
77 # This initializer is called from the various TIE* methods. new() calls tie(),
78 # which allows for a single point of entry.
83 $args->{storage} = DBM::Deep::10002::File->new( $args )
84 unless exists $args->{storage};
86 # locking implicitly enables autoflush
87 if ($args->{locking}) { $args->{autoflush} = 1; }
89 # These are the defaults to be optionally overridden below
99 $args->{engine} = DBM::Deep::10002::Engine->new( { %{$args}, obj => $self } )
100 unless exists $args->{engine};
102 # Grab the parameters we want to use
103 foreach my $param ( keys %$self ) {
104 next unless exists $args->{$param};
105 $self->{$param} = $args->{$param};
109 local $SIG{'__DIE__'};
112 $self->_engine->setup_fh( $self );
113 $self->_storage->set_inode;
117 eval { local $SIG{'__DIE__'}; $self->unlock; };
126 #require DBM::Deep::10002::Hash;
127 return DBM::Deep::10002::Hash->TIEHASH( @_ );
132 #require DBM::Deep::10002::Array;
133 return DBM::Deep::10002::Array->TIEARRAY( @_ );
137 my $self = shift->_get_self;
138 return $self->_storage->lock( $self, @_ );
142 my $self = shift->_get_self;
143 return $self->_storage->unlock( $self, @_ );
147 my $self = shift->_get_self;
148 my ($spot, $value) = @_;
153 elsif ( eval { local $SIG{__DIE__}; $value->isa( 'DBM::Deep::10002' ) } ) {
154 ${$spot} = $value->_repr;
155 $value->_copy_node( ${$spot} );
158 my $r = Scalar::Util::reftype( $value );
159 my $c = Scalar::Util::blessed( $value );
160 if ( $r eq 'ARRAY' ) {
161 ${$spot} = [ @{$value} ];
164 ${$spot} = { %{$value} };
166 ${$spot} = bless ${$spot}, $c
174 # die "Must be implemented in a child class\n";
178 # die "Must be implemented in a child class\n";
183 # Recursively export into standard Perl hashes and arrays.
185 my $self = shift->_get_self;
187 my $temp = $self->_repr;
190 $self->_copy_node( $temp );
193 my $classname = $self->_engine->get_classname( $self );
194 if ( defined $classname ) {
195 bless $temp, $classname;
203 # Recursively import Perl hash/array structure
205 if (!ref($_[0])) { return; } # Perl calls import() on use -- ignore
207 my $self = shift->_get_self;
210 # struct is not a reference, so just import based on our type
212 $struct = $self->_repr( @_ );
215 #XXX This isn't the best solution. Better would be to use Data::Walker,
216 #XXX but that's a lot more thinking than I want to do right now.
218 local $SIG{'__DIE__'};
219 $self->_import( Clone::clone( $struct ) );
220 }; if ( my $e = $@ ) {
227 #XXX Need to keep track of who has a fh to this file in order to
228 #XXX close them all prior to optimize on Win32/cygwin
231 # Rebuild entire database into new file, then move
232 # it back on top of original.
234 my $self = shift->_get_self;
236 #XXX Need to create a new test for this
237 # if ($self->_storage->{links} > 1) {
238 # $self->_throw_error("Cannot optimize: reference count is greater than 1");
241 #XXX Do we have to lock the tempfile?
243 my $db_temp = DBM::Deep::10002->new(
244 file => $self->_storage->{file} . '.tmp',
245 type => $self->_type,
247 # Bring over all the parameters that we need to bring over
248 num_txns => $self->_engine->num_txns,
249 byte_size => $self->_engine->byte_size,
250 max_buckets => $self->_engine->max_buckets,
254 $self->_copy_node( $db_temp );
258 # Attempt to copy user, group and permissions over to new file
260 my @stats = stat($self->_fh);
261 my $perms = $stats[2] & 07777;
264 chown( $uid, $gid, $self->_storage->{file} . '.tmp' );
265 chmod( $perms, $self->_storage->{file} . '.tmp' );
267 # q.v. perlport for more information on this variable
268 if ( $^O eq 'MSWin32' || $^O eq 'cygwin' ) {
270 # Potential race condition when optmizing on Win32 with locking.
271 # The Windows filesystem requires that the filehandle be closed
272 # before it is overwritten with rename(). This could be redone
276 $self->_storage->close;
279 if (!rename $self->_storage->{file} . '.tmp', $self->_storage->{file}) {
280 unlink $self->_storage->{file} . '.tmp';
282 $self->_throw_error("Optimize failed: Cannot copy temp file over original: $!");
286 $self->_storage->close;
288 $self->_storage->open;
290 $self->_engine->setup_fh( $self );
298 # Make copy of object and return
300 my $self = shift->_get_self;
302 return DBM::Deep::10002->new(
303 type => $self->_type,
304 base_offset => $self->_base_offset,
305 staleness => $self->_staleness,
306 storage => $self->_storage,
307 engine => $self->_engine,
311 #XXX Migrate this to the engine, where it really belongs and go through some
312 # API - stop poking in the innards of someone else..
314 my %is_legal_filter = map {
317 store_key store_value
318 fetch_key fetch_value
323 # Setup filter function for storing or fetching the key or value
325 my $self = shift->_get_self;
329 if ( $is_legal_filter{$type} ) {
330 $self->_storage->{"filter_$type"} = $func;
339 my $self = shift->_get_self;
340 return $self->_engine->begin_work( $self, @_ );
344 my $self = shift->_get_self;
345 return $self->_engine->rollback( $self, @_ );
349 my $self = shift->_get_self;
350 return $self->_engine->commit( $self, @_ );
358 my $self = $_[0]->_get_self;
359 return $self->{engine};
363 my $self = $_[0]->_get_self;
364 return $self->{storage};
368 my $self = $_[0]->_get_self;
369 return $self->{type};
373 my $self = $_[0]->_get_self;
374 return $self->{base_offset};
378 my $self = $_[0]->_get_self;
379 return $self->{staleness};
383 my $self = $_[0]->_get_self;
384 return $self->_storage->{fh};
392 die "DBM::Deep::10002: $_[1]\n";
395 my @caller = caller( ++$n );
396 next if $caller[0] =~ m/^DBM::Deep::10002/;
398 die "DBM::Deep::10002: $_[1] at $0 line $caller[2]\n";
405 # Store single hash key/value or array element in database.
407 my $self = shift->_get_self;
408 my ($key, $value) = @_;
410 if ( !FileHandle::Fmode::is_W( $self->_fh ) ) {
411 $self->_throw_error( 'Cannot write to a readonly filehandle' );
415 # Request exclusive lock for writing
417 $self->lock( LOCK_EX );
419 # User may be storing a complex value, in which case we do not want it run
420 # through the filtering system.
421 if ( !ref($value) && $self->_storage->{filter_store_value} ) {
422 $value = $self->_storage->{filter_store_value}->( $value );
425 $self->_engine->write_value( $self, $key, $value);
434 # Fetch single value or element given plain key or array index
436 my $self = shift->_get_self;
440 # Request shared lock for reading
442 $self->lock( LOCK_SH );
444 my $result = $self->_engine->read_value( $self, $key);
448 # Filters only apply to scalar values, so the ref check is making
449 # sure the fetched bucket is a scalar, not a child hash or array.
450 return ($result && !ref($result) && $self->_storage->{filter_fetch_value})
451 ? $self->_storage->{filter_fetch_value}->($result)
457 # Delete single key/value pair or element given plain key or array index
459 my $self = shift->_get_self;
462 if ( !FileHandle::Fmode::is_W( $self->_fh ) ) {
463 $self->_throw_error( 'Cannot write to a readonly filehandle' );
467 # Request exclusive lock for writing
469 $self->lock( LOCK_EX );
474 my $value = $self->_engine->delete_key( $self, $key);
476 if (defined $value && !ref($value) && $self->_storage->{filter_fetch_value}) {
477 $value = $self->_storage->{filter_fetch_value}->($value);
487 # Check if a single key or element exists given plain key or array index
489 my $self = shift->_get_self;
493 # Request shared lock for reading
495 $self->lock( LOCK_SH );
497 my $result = $self->_engine->key_exists( $self, $key );
506 # Clear all keys from hash, or all elements from array.
508 my $self = shift->_get_self;
510 if ( !FileHandle::Fmode::is_W( $self->_fh ) ) {
511 $self->_throw_error( 'Cannot write to a readonly filehandle' );
515 # Request exclusive lock for writing
517 $self->lock( LOCK_EX );
519 #XXX Rewrite this dreck to do it in the engine as a tight loop vs.
520 # iterating over keys - such a WASTE - is this required for transactional
521 # clearning?! Surely that can be detected in the engine ...
522 if ( $self->_type eq TYPE_HASH ) {
523 my $key = $self->first_key;
525 # Retrieve the key before deleting because we depend on next_key
526 my $next_key = $self->next_key( $key );
527 $self->_engine->delete_key( $self, $key, $key );
532 my $size = $self->FETCHSIZE;
533 for my $key ( 0 .. $size - 1 ) {
534 $self->_engine->delete_key( $self, $key, $key );
536 $self->STORESIZE( 0 );
545 # Public method aliases
547 sub put { (shift)->STORE( @_ ) }
548 sub store { (shift)->STORE( @_ ) }
549 sub get { (shift)->FETCH( @_ ) }
550 sub fetch { (shift)->FETCH( @_ ) }
551 sub delete { (shift)->DELETE( @_ ) }
552 sub exists { (shift)->EXISTS( @_ ) }
553 sub clear { (shift)->CLEAR( @_ ) }
555 package DBM::Deep::10002::Array;
562 our $VERSION = q(1.0002);
564 # This is to allow DBM::Deep::10002::Array to handle negative indices on
565 # its own. Otherwise, Perl would intercept the call to negative
566 # indices for us. This was causing bugs for negative index handling.
567 our $NEGATIVE_INDICES = 1;
569 use base 'DBM::Deep::10002';
574 eval { local $SIG{'__DIE__'}; tied( @{$_[0]} ) } || $_[0]
577 sub _repr { shift;[ @_ ] }
583 $self->push( @$struct );
590 my $args = $class->_get_args( @_ );
592 $args->{type} = $class->TYPE_ARRAY;
594 return $class->_init($args);
598 my $self = shift->_get_self;
601 $self->lock( $self->LOCK_SH );
603 if ( !defined $key ) {
604 DBM::Deep::10002->_throw_error( "Cannot use an undefined array index." );
606 elsif ( $key =~ /^-?\d+$/ ) {
608 $key += $self->FETCHSIZE;
609 unless ( $key >= 0 ) {
615 elsif ( $key ne 'length' ) {
617 DBM::Deep::10002->_throw_error( "Cannot use '$key' as an array index." );
620 my $rv = $self->SUPER::FETCH( $key );
628 my $self = shift->_get_self;
629 my ($key, $value) = @_;
631 $self->lock( $self->LOCK_EX );
635 if ( !defined $key ) {
636 DBM::Deep::10002->_throw_error( "Cannot use an undefined array index." );
638 elsif ( $key =~ /^-?\d+$/ ) {
641 $size = $self->FETCHSIZE;
642 if ( $key + $size < 0 ) {
643 die( "Modification of non-creatable array value attempted, subscript $key" );
648 elsif ( $key ne 'length' ) {
650 DBM::Deep::10002->_throw_error( "Cannot use '$key' as an array index." );
653 my $rv = $self->SUPER::STORE( $key, $value );
655 if ( $idx_is_numeric ) {
656 $size = $self->FETCHSIZE unless defined $size;
657 if ( $key >= $size ) {
658 $self->STORESIZE( $key + 1 );
668 my $self = shift->_get_self;
671 $self->lock( $self->LOCK_SH );
673 if ( !defined $key ) {
674 DBM::Deep::10002->_throw_error( "Cannot use an undefined array index." );
676 elsif ( $key =~ /^-?\d+$/ ) {
678 $key += $self->FETCHSIZE;
679 unless ( $key >= 0 ) {
685 elsif ( $key ne 'length' ) {
687 DBM::Deep::10002->_throw_error( "Cannot use '$key' as an array index." );
690 my $rv = $self->SUPER::EXISTS( $key );
698 my $self = shift->_get_self;
701 $self->lock( $self->LOCK_EX );
703 my $size = $self->FETCHSIZE;
704 if ( !defined $key ) {
705 DBM::Deep::10002->_throw_error( "Cannot use an undefined array index." );
707 elsif ( $key =~ /^-?\d+$/ ) {
710 unless ( $key >= 0 ) {
716 elsif ( $key ne 'length' ) {
718 DBM::Deep::10002->_throw_error( "Cannot use '$key' as an array index." );
721 my $rv = $self->SUPER::DELETE( $key );
723 if ($rv && $key == $size - 1) {
724 $self->STORESIZE( $key );
732 # Now that we have a real Reference sector, we should store arrayzize there. However,
733 # arraysize needs to be transactionally-aware, so a simple location to store it isn't
736 my $self = shift->_get_self;
738 $self->lock( $self->LOCK_SH );
740 my $SAVE_FILTER = $self->_storage->{filter_fetch_value};
741 $self->_storage->{filter_fetch_value} = undef;
743 my $size = $self->FETCH('length') || 0;
745 $self->_storage->{filter_fetch_value} = $SAVE_FILTER;
753 my $self = shift->_get_self;
754 my ($new_length) = @_;
756 $self->lock( $self->LOCK_EX );
758 my $SAVE_FILTER = $self->_storage->{filter_store_value};
759 $self->_storage->{filter_store_value} = undef;
761 my $result = $self->STORE('length', $new_length, 'length');
763 $self->_storage->{filter_store_value} = $SAVE_FILTER;
771 my $self = shift->_get_self;
773 $self->lock( $self->LOCK_EX );
775 my $length = $self->FETCHSIZE();
778 my $content = $self->FETCH( $length - 1 );
779 $self->DELETE( $length - 1 );
792 my $self = shift->_get_self;
794 $self->lock( $self->LOCK_EX );
796 my $length = $self->FETCHSIZE();
798 while (my $content = shift @_) {
799 $self->STORE( $length, $content );
808 # XXX This really needs to be something more direct within the file, not a
809 # fetch and re-store. -RobK, 2007-09-20
812 my ($old_key, $new_key) = @_;
814 my $val = $self->FETCH( $old_key );
815 if ( eval { local $SIG{'__DIE__'}; $val->isa( 'DBM::Deep::10002::Hash' ) } ) {
816 $self->STORE( $new_key, { %$val } );
818 elsif ( eval { local $SIG{'__DIE__'}; $val->isa( 'DBM::Deep::10002::Array' ) } ) {
819 $self->STORE( $new_key, [ @$val ] );
822 $self->STORE( $new_key, $val );
827 my $self = shift->_get_self;
829 $self->lock( $self->LOCK_EX );
831 my $length = $self->FETCHSIZE();
834 my $content = $self->FETCH( 0 );
836 for (my $i = 0; $i < $length - 1; $i++) {
837 $self->_move_value( $i+1, $i );
839 $self->DELETE( $length - 1 );
852 my $self = shift->_get_self;
853 my @new_elements = @_;
855 $self->lock( $self->LOCK_EX );
857 my $length = $self->FETCHSIZE();
858 my $new_size = scalar @new_elements;
861 for (my $i = $length - 1; $i >= 0; $i--) {
862 $self->_move_value( $i, $i+$new_size );
866 for (my $i = 0; $i < $new_size; $i++) {
867 $self->STORE( $i, $new_elements[$i] );
872 return $length + $new_size;
876 my $self = shift->_get_self;
878 $self->lock( $self->LOCK_EX );
880 my $length = $self->FETCHSIZE();
883 # Calculate offset and length of splice
886 $offset = 0 unless defined $offset;
887 if ($offset < 0) { $offset += $length; }
890 if (scalar @_) { $splice_length = shift; }
891 else { $splice_length = $length - $offset; }
892 if ($splice_length < 0) { $splice_length += ($length - $offset); }
895 # Setup array with new elements, and copy out old elements for return
897 my @new_elements = @_;
898 my $new_size = scalar @new_elements;
900 my @old_elements = map {
902 } $offset .. ($offset + $splice_length - 1);
905 # Adjust array length, and shift elements to accomodate new section.
907 if ( $new_size != $splice_length ) {
908 if ($new_size > $splice_length) {
909 for (my $i = $length - 1; $i >= $offset + $splice_length; $i--) {
910 $self->_move_value( $i, $i + ($new_size - $splice_length) );
914 for (my $i = $offset + $splice_length; $i < $length; $i++) {
915 $self->_move_value( $i, $i + ($new_size - $splice_length) );
917 for (my $i = 0; $i < $splice_length - $new_size; $i++) {
918 $self->DELETE( $length - 1 );
925 # Insert new elements into array
927 for (my $i = $offset; $i < $offset + $new_size; $i++) {
928 $self->STORE( $i, shift @new_elements );
934 # Return deleted section, or last element in scalar context.
936 return wantarray ? @old_elements : $old_elements[-1];
939 # We don't need to populate it, yet.
940 # It will be useful, though, when we split out HASH and ARRAY
943 # Perl will call EXTEND() when the array is likely to grow.
944 # We don't care, but include it because it gets called at times.
952 my $length = $self->length();
953 for (my $index = 0; $index < $length; $index++) {
954 my $value = $self->get($index);
955 $self->_copy_value( \$db_temp->[$index], $value );
962 # Public method aliases
964 sub length { (shift)->FETCHSIZE(@_) }
965 sub pop { (shift)->POP(@_) }
966 sub push { (shift)->PUSH(@_) }
967 sub unshift { (shift)->UNSHIFT(@_) }
968 sub splice { (shift)->SPLICE(@_) }
970 # This must be last otherwise we have to qualify all other calls to shift
971 # as calls to CORE::shift
972 sub shift { (CORE::shift)->SHIFT(@_) }
974 package DBM::Deep::10002::Hash;
981 our $VERSION = q(1.0002);
983 use base 'DBM::Deep::10002';
986 eval { local $SIG{'__DIE__'}; tied( %{$_[0]} ) } || $_[0]
989 #XXX Need to add a check here for @_ % 2
990 sub _repr { shift;return { @_ } }
996 foreach my $key (keys %$struct) {
997 $self->put($key, $struct->{$key});
1005 # Tied hash constructor method, called by Perl's tie() function.
1008 my $args = $class->_get_args( @_ );
1010 $args->{type} = $class->TYPE_HASH;
1012 return $class->_init($args);
1016 my $self = shift->_get_self;
1017 DBM::Deep::10002->_throw_error( "Cannot use an undefined hash key." ) unless defined $_[0];
1018 my $key = ($self->_storage->{filter_store_key})
1019 ? $self->_storage->{filter_store_key}->($_[0])
1022 return $self->SUPER::FETCH( $key, $_[0] );
1026 my $self = shift->_get_self;
1027 DBM::Deep::10002->_throw_error( "Cannot use an undefined hash key." ) unless defined $_[0];
1028 my $key = ($self->_storage->{filter_store_key})
1029 ? $self->_storage->{filter_store_key}->($_[0])
1033 return $self->SUPER::STORE( $key, $value, $_[0] );
1037 my $self = shift->_get_self;
1038 DBM::Deep::10002->_throw_error( "Cannot use an undefined hash key." ) unless defined $_[0];
1039 my $key = ($self->_storage->{filter_store_key})
1040 ? $self->_storage->{filter_store_key}->($_[0])
1043 return $self->SUPER::EXISTS( $key );
1047 my $self = shift->_get_self;
1048 DBM::Deep::10002->_throw_error( "Cannot use an undefined hash key." ) unless defined $_[0];
1049 my $key = ($self->_storage->{filter_store_key})
1050 ? $self->_storage->{filter_store_key}->($_[0])
1053 return $self->SUPER::DELETE( $key, $_[0] );
1058 # Locate and return first key (in no particular order)
1060 my $self = shift->_get_self;
1063 # Request shared lock for reading
1065 $self->lock( $self->LOCK_SH );
1067 my $result = $self->_engine->get_next_key( $self );
1071 return ($result && $self->_storage->{filter_fetch_key})
1072 ? $self->_storage->{filter_fetch_key}->($result)
1078 # Return next key (in no particular order), given previous one
1080 my $self = shift->_get_self;
1082 my $prev_key = ($self->_storage->{filter_store_key})
1083 ? $self->_storage->{filter_store_key}->($_[0])
1087 # Request shared lock for reading
1089 $self->lock( $self->LOCK_SH );
1091 my $result = $self->_engine->get_next_key( $self, $prev_key );
1095 return ($result && $self->_storage->{filter_fetch_key})
1096 ? $self->_storage->{filter_fetch_key}->($result)
1101 # Public method aliases
1103 sub first_key { (shift)->FIRSTKEY(@_) }
1104 sub next_key { (shift)->NEXTKEY(@_) }
1110 my $key = $self->first_key();
1112 my $value = $self->get($key);
1113 $self->_copy_value( \$db_temp->{$key}, $value );
1114 $key = $self->next_key($key);
1120 package DBM::Deep::10002::File;
1127 our $VERSION = q(1.0002);
1129 use Fcntl qw( :DEFAULT :flock :seek );
1144 #XXX Migrate this to the engine, where it really belongs.
1145 filter_store_key => undef,
1146 filter_store_value => undef,
1147 filter_fetch_key => undef,
1148 filter_fetch_value => undef,
1151 # Grab the parameters we want to use
1152 foreach my $param ( keys %$self ) {
1153 next unless exists $args->{$param};
1154 $self->{$param} = $args->{$param};
1157 if ( $self->{fh} && !$self->{file_offset} ) {
1158 $self->{file_offset} = tell( $self->{fh} );
1161 $self->open unless $self->{fh};
1169 # Adding O_BINARY should remove the need for the binmode below. However,
1170 # I'm not going to remove it because I don't have the Win32 chops to be
1171 # absolutely certain everything will be ok.
1172 my $flags = O_CREAT | O_BINARY;
1174 if ( !-e $self->{file} || -w _ ) {
1182 sysopen( $fh, $self->{file}, $flags )
1183 or die "DBM::Deep::10002: Cannot sysopen file '$self->{file}': $!\n";
1186 # Even though we use O_BINARY, better be safe than sorry.
1189 if ($self->{autoflush}) {
1190 my $old = select $fh;
1201 if ( $self->{fh} ) {
1203 $self->{fh} = undef;
1212 unless ( defined $self->{inode} ) {
1213 my @stats = stat($self->{fh});
1214 $self->{inode} = $stats[1];
1215 $self->{end} = $stats[7];
1227 my $fh = $self->{fh};
1228 if ( defined $loc ) {
1229 seek( $fh, $loc + $self->{file_offset}, SEEK_SET );
1239 my ($loc, $size) = @_;
1243 my $fh = $self->{fh};
1244 if ( defined $loc ) {
1245 seek( $fh, $loc + $self->{file_offset}, SEEK_SET );
1249 read( $fh, $buffer, $size);
1256 return unless $self;
1267 #XXX Do I need to reset $self->{end} here? I need a testcase
1268 my $loc = $self->{end};
1269 $self->{end} += $size;
1275 # If db locking is set, flock() the db file. If called multiple
1276 # times before unlock(), then the same number of unlocks() must
1277 # be called before the lock is released.
1281 my ($obj, $type) = @_;
1283 $type = LOCK_EX unless defined $type;
1285 if (!defined($self->{fh})) { return; }
1287 if ($self->{locking}) {
1288 if (!$self->{locked}) {
1289 flock($self->{fh}, $type);
1291 # refresh end counter in case file has changed size
1292 my @stats = stat($self->{fh});
1293 $self->{end} = $stats[7];
1295 # double-check file inode, in case another process
1296 # has optimize()d our file while we were waiting.
1297 if (defined($self->{inode}) && $stats[1] != $self->{inode}) {
1301 #XXX This needs work
1302 $obj->{engine}->setup_fh( $obj );
1304 flock($self->{fh}, $type); # re-lock
1306 # This may not be necessary after re-opening
1307 $self->{end} = (stat($self->{fh}))[7]; # re-end
1319 # If db locking is set, unlock the db file. See note in lock()
1320 # regarding calling lock() multiple times.
1325 if (!defined($self->{fh})) { return; }
1327 if ($self->{locking} && $self->{locked} > 0) {
1329 if (!$self->{locked}) { flock($self->{fh}, LOCK_UN); }
1340 # Flush the filehandle
1341 my $old_fh = select $self->{fh};
1342 my $old_af = $|; $| = 1; $| = $old_af;
1348 package DBM::Deep::10002::Engine;
1355 our $VERSION = q(1.0002);
1357 use Scalar::Util ();
1360 # * Every method in here assumes that the storage has been appropriately
1361 # safeguarded. This can be anything from flock() to some sort of manual
1362 # mutex. But, it's the caller's responsability to make sure that this has
1365 # Setup file and tag signatures. These should never change.
1366 sub SIG_FILE () { 'DPDB' }
1367 sub SIG_HEADER () { 'h' }
1368 sub SIG_HASH () { 'H' }
1369 sub SIG_ARRAY () { 'A' }
1370 sub SIG_NULL () { 'N' }
1371 sub SIG_DATA () { 'D' }
1372 sub SIG_INDEX () { 'I' }
1373 sub SIG_BLIST () { 'B' }
1374 sub SIG_FREE () { 'F' }
1375 sub SIG_SIZE () { 1 }
1379 # Please refer to the pack() documentation for further information
1381 1 => 'C', # Unsigned char value (no order needed as it's just one byte)
1382 2 => 'n', # Unsigned short in "network" (big-endian) order
1383 4 => 'N', # Unsigned long in "network" (big-endian) order
1384 8 => 'Q', # Usigned quad (no order specified, presumably machine-dependent)
1387 ################################################################################
1397 hash_size => 16, # In bytes
1398 hash_chars => 256, # Number of chars the algorithm uses per byte
1400 num_txns => 1, # The HEAD
1401 trans_id => 0, # Default to the HEAD
1403 data_sector_size => 64, # Size in bytes of each data sector
1405 entries => {}, # This is the list of entries for transactions
1409 # Never allow byte_size to be set directly.
1410 delete $args->{byte_size};
1411 if ( defined $args->{pack_size} ) {
1412 if ( lc $args->{pack_size} eq 'small' ) {
1413 $args->{byte_size} = 2;
1415 elsif ( lc $args->{pack_size} eq 'medium' ) {
1416 $args->{byte_size} = 4;
1418 elsif ( lc $args->{pack_size} eq 'large' ) {
1419 $args->{byte_size} = 8;
1422 DBM::Deep::10002->_throw_error( "Unknown pack_size value: '$args->{pack_size}'" );
1426 # Grab the parameters we want to use
1427 foreach my $param ( keys %$self ) {
1428 next unless exists $args->{$param};
1429 $self->{$param} = $args->{$param};
1433 max_buckets => { floor => 16, ceil => 256 },
1434 num_txns => { floor => 1, ceil => 255 },
1435 data_sector_size => { floor => 32, ceil => 256 },
1438 while ( my ($attr, $c) = each %validations ) {
1439 if ( !defined $self->{$attr}
1440 || !length $self->{$attr}
1441 || $self->{$attr} =~ /\D/
1442 || $self->{$attr} < $c->{floor}
1444 $self->{$attr} = '(undef)' if !defined $self->{$attr};
1445 warn "Floor of $attr is $c->{floor}. Setting it to $c->{floor} from '$self->{$attr}'\n";
1446 $self->{$attr} = $c->{floor};
1448 elsif ( $self->{$attr} > $c->{ceil} ) {
1449 warn "Ceiling of $attr is $c->{ceil}. Setting it to $c->{ceil} from '$self->{$attr}'\n";
1450 $self->{$attr} = $c->{ceil};
1454 if ( !$self->{digest} ) {
1455 require Digest::MD5;
1456 $self->{digest} = \&Digest::MD5::md5;
1462 ################################################################################
1466 my ($obj, $key) = @_;
1468 # This will be a Reference sector
1469 my $sector = $self->_load_sector( $obj->_base_offset )
1472 if ( $sector->staleness != $obj->_staleness ) {
1476 my $key_md5 = $self->_apply_digest( $key );
1478 my $value_sector = $sector->get_data_for({
1479 key_md5 => $key_md5,
1483 unless ( $value_sector ) {
1484 $value_sector = DBM::Deep::10002::Engine::Sector::Null->new({
1489 $sector->write_data({
1490 key_md5 => $key_md5,
1492 value => $value_sector,
1496 return $value_sector->data;
1503 # This will be a Reference sector
1504 my $sector = $self->_load_sector( $obj->_base_offset )
1505 or DBM::Deep::10002->_throw_error( "How did get_classname fail (no sector for '$obj')?!" );
1507 if ( $sector->staleness != $obj->_staleness ) {
1511 return $sector->get_classname;
1516 my ($obj, $key) = @_;
1518 # This will be a Reference sector
1519 my $sector = $self->_load_sector( $obj->_base_offset )
1522 if ( $sector->staleness != $obj->_staleness ) {
1526 my $data = $sector->get_data_for({
1527 key_md5 => $self->_apply_digest( $key ),
1531 # exists() returns 1 or '' for true/false.
1532 return $data ? 1 : '';
1537 my ($obj, $key) = @_;
1539 my $sector = $self->_load_sector( $obj->_base_offset )
1542 if ( $sector->staleness != $obj->_staleness ) {
1546 return $sector->delete_key({
1547 key_md5 => $self->_apply_digest( $key ),
1554 my ($obj, $key, $value) = @_;
1556 my $r = Scalar::Util::reftype( $value ) || '';
1559 last if $r eq 'HASH';
1560 last if $r eq 'ARRAY';
1562 DBM::Deep::10002->_throw_error(
1563 "Storage of references of type '$r' is not supported."
1568 if ( !defined $value ) {
1569 $class = 'DBM::Deep::10002::Engine::Sector::Null';
1571 elsif ( $r eq 'ARRAY' || $r eq 'HASH' ) {
1572 if ( $r eq 'ARRAY' && tied(@$value) ) {
1573 DBM::Deep::10002->_throw_error( "Cannot store something that is tied." );
1575 if ( $r eq 'HASH' && tied(%$value) ) {
1576 DBM::Deep::10002->_throw_error( "Cannot store something that is tied." );
1578 $class = 'DBM::Deep::10002::Engine::Sector::Reference';
1579 $type = substr( $r, 0, 1 );
1582 $class = 'DBM::Deep::10002::Engine::Sector::Scalar';
1585 # This will be a Reference sector
1586 my $sector = $self->_load_sector( $obj->_base_offset )
1587 or DBM::Deep::10002->_throw_error( "Cannot write to a deleted spot in DBM::Deep::10002." );
1589 if ( $sector->staleness != $obj->_staleness ) {
1590 DBM::Deep::10002->_throw_error( "Cannot write to a deleted spot in DBM::Deep::10002.n" );
1593 # Create this after loading the reference sector in case something bad happens.
1594 # This way, we won't allocate value sector(s) needlessly.
1595 my $value_sector = $class->new({
1601 $sector->write_data({
1603 key_md5 => $self->_apply_digest( $key ),
1604 value => $value_sector,
1607 # This code is to make sure we write all the values in the $value to the disk
1608 # and to make sure all changes to $value after the assignment are reflected
1609 # on disk. This may be counter-intuitive at first, but it is correct dwimmery.
1610 # NOTE - simply tying $value won't perform a STORE on each value. Hence, the
1611 # copy to a temp value.
1612 if ( $r eq 'ARRAY' ) {
1614 tie @$value, 'DBM::Deep::10002', {
1615 base_offset => $value_sector->offset,
1616 staleness => $value_sector->staleness,
1617 storage => $self->storage,
1621 bless $value, 'DBM::Deep::10002::Array' unless Scalar::Util::blessed( $value );
1623 elsif ( $r eq 'HASH' ) {
1625 tie %$value, 'DBM::Deep::10002', {
1626 base_offset => $value_sector->offset,
1627 staleness => $value_sector->staleness,
1628 storage => $self->storage,
1633 bless $value, 'DBM::Deep::10002::Hash' unless Scalar::Util::blessed( $value );
1639 # XXX Add staleness here
1642 my ($obj, $prev_key) = @_;
1644 # XXX Need to add logic about resetting the iterator if any key in the reference has changed
1645 unless ( $prev_key ) {
1646 $obj->{iterator} = DBM::Deep::10002::Iterator->new({
1647 base_offset => $obj->_base_offset,
1652 return $obj->{iterator}->get_next_key( $obj );
1655 ################################################################################
1661 # We're opening the file.
1662 unless ( $obj->_base_offset ) {
1663 my $bytes_read = $self->_read_file_header;
1665 # Creating a new file
1666 unless ( $bytes_read ) {
1667 $self->_write_file_header;
1669 # 1) Create Array/Hash entry
1670 my $initial_reference = DBM::Deep::10002::Engine::Sector::Reference->new({
1672 type => $obj->_type,
1674 $obj->{base_offset} = $initial_reference->offset;
1675 $obj->{staleness} = $initial_reference->staleness;
1677 $self->storage->flush;
1679 # Reading from an existing file
1681 $obj->{base_offset} = $bytes_read;
1682 my $initial_reference = DBM::Deep::10002::Engine::Sector::Reference->new({
1684 offset => $obj->_base_offset,
1686 unless ( $initial_reference ) {
1687 DBM::Deep::10002->_throw_error("Corrupted file, no master index record");
1690 unless ($obj->_type eq $initial_reference->type) {
1691 DBM::Deep::10002->_throw_error("File type mismatch");
1694 $obj->{staleness} = $initial_reference->staleness;
1705 if ( $self->trans_id ) {
1706 DBM::Deep::10002->_throw_error( "Cannot begin_work within an active transaction" );
1709 my @slots = $self->read_txn_slots;
1711 for my $i ( 0 .. $#slots ) {
1715 $self->set_trans_id( $i + 1 );
1720 DBM::Deep::10002->_throw_error( "Cannot allocate transaction ID" );
1722 $self->write_txn_slots( @slots );
1724 if ( !$self->trans_id ) {
1725 DBM::Deep::10002->_throw_error( "Cannot begin_work - no available transactions" );
1735 if ( !$self->trans_id ) {
1736 DBM::Deep::10002->_throw_error( "Cannot rollback without an active transaction" );
1739 # Each entry is the file location for a bucket that has a modification for
1740 # this transaction. The entries need to be expunged.
1741 foreach my $entry (@{ $self->get_entries } ) {
1742 # Remove the entry here
1743 my $read_loc = $entry
1747 + ($self->trans_id - 1) * ( $self->byte_size + $STALE_SIZE );
1749 my $data_loc = $self->storage->read_at( $read_loc, $self->byte_size );
1750 $data_loc = unpack( $StP{$self->byte_size}, $data_loc );
1751 $self->storage->print_at( $read_loc, pack( $StP{$self->byte_size}, 0 ) );
1753 if ( $data_loc > 1 ) {
1754 $self->_load_sector( $data_loc )->free;
1758 $self->clear_entries;
1760 my @slots = $self->read_txn_slots;
1761 $slots[$self->trans_id-1] = 0;
1762 $self->write_txn_slots( @slots );
1763 $self->inc_txn_staleness_counter( $self->trans_id );
1764 $self->set_trans_id( 0 );
1773 if ( !$self->trans_id ) {
1774 DBM::Deep::10002->_throw_error( "Cannot commit without an active transaction" );
1777 foreach my $entry (@{ $self->get_entries } ) {
1778 # Overwrite the entry in head with the entry in trans_id
1783 my $head_loc = $self->storage->read_at( $base, $self->byte_size );
1784 $head_loc = unpack( $StP{$self->byte_size}, $head_loc );
1786 my $spot = $base + $self->byte_size + ($self->trans_id - 1) * ( $self->byte_size + $STALE_SIZE );
1787 my $trans_loc = $self->storage->read_at(
1788 $spot, $self->byte_size,
1791 $self->storage->print_at( $base, $trans_loc );
1792 $self->storage->print_at(
1794 pack( $StP{$self->byte_size} . ' ' . $StP{$STALE_SIZE}, (0) x 2 ),
1797 if ( $head_loc > 1 ) {
1798 $self->_load_sector( $head_loc )->free;
1802 $self->clear_entries;
1804 my @slots = $self->read_txn_slots;
1805 $slots[$self->trans_id-1] = 0;
1806 $self->write_txn_slots( @slots );
1807 $self->inc_txn_staleness_counter( $self->trans_id );
1808 $self->set_trans_id( 0 );
1813 sub read_txn_slots {
1815 my $bl = $self->txn_bitfield_len;
1816 my $num_bits = $bl * 8;
1817 return split '', unpack( 'b'.$num_bits,
1818 $self->storage->read_at(
1819 $self->trans_loc, $bl,
1824 sub write_txn_slots {
1826 my $num_bits = $self->txn_bitfield_len * 8;
1827 $self->storage->print_at( $self->trans_loc,
1828 pack( 'b'.$num_bits, join('', @_) ),
1832 sub get_running_txn_ids {
1834 my @transactions = $self->read_txn_slots;
1835 my @trans_ids = map { $_+1} grep { $transactions[$_] } 0 .. $#transactions;
1838 sub get_txn_staleness_counter {
1840 my ($trans_id) = @_;
1842 # Hardcode staleness of 0 for the HEAD
1843 return 0 unless $trans_id;
1845 return unpack( $StP{$STALE_SIZE},
1846 $self->storage->read_at(
1847 $self->trans_loc + 4 + $STALE_SIZE * ($trans_id - 1),
1853 sub inc_txn_staleness_counter {
1855 my ($trans_id) = @_;
1857 # Hardcode staleness of 0 for the HEAD
1858 return unless $trans_id;
1860 $self->storage->print_at(
1861 $self->trans_loc + 4 + $STALE_SIZE * ($trans_id - 1),
1862 pack( $StP{$STALE_SIZE}, $self->get_txn_staleness_counter( $trans_id ) + 1 ),
1868 return [ keys %{ $self->{entries}{$self->trans_id} ||= {} } ];
1873 my ($trans_id, $loc) = @_;
1875 $self->{entries}{$trans_id} ||= {};
1876 $self->{entries}{$trans_id}{$loc} = undef;
1879 # If the buckets are being relocated because of a reindexing, the entries
1880 # mechanism needs to be made aware of it.
1883 my ($old_loc, $new_loc) = @_;
1886 while ( my ($trans_id, $locs) = each %{ $self->{entries} } ) {
1887 foreach my $orig_loc ( keys %{ $locs } ) {
1888 if ( $orig_loc == $old_loc ) {
1889 delete $locs->{orig_loc};
1890 $locs->{$new_loc} = undef;
1899 delete $self->{entries}{$self->trans_id};
1902 ################################################################################
1905 my $header_fixed = length( SIG_FILE ) + 1 + 4 + 4;
1906 my $this_file_version = 2;
1908 sub _write_file_header {
1911 my $nt = $self->num_txns;
1912 my $bl = $self->txn_bitfield_len;
1914 my $header_var = 1 + 1 + 1 + 1 + $bl + $STALE_SIZE * ($nt - 1) + 3 * $self->byte_size;
1916 my $loc = $self->storage->request_space( $header_fixed + $header_var );
1918 $self->storage->print_at( $loc,
1921 pack('N', $this_file_version), # At this point, we're at 9 bytes
1922 pack('N', $header_var), # header size
1923 # --- Above is $header_fixed. Below is $header_var
1924 pack('C', $self->byte_size),
1926 # These shenanigans are to allow a 256 within a C
1927 pack('C', $self->max_buckets - 1),
1928 pack('C', $self->data_sector_size - 1),
1931 pack('C' . $bl, 0 ), # Transaction activeness bitfield
1932 pack($StP{$STALE_SIZE}.($nt-1), 0 x ($nt-1) ), # Transaction staleness counters
1933 pack($StP{$self->byte_size}, 0), # Start of free chain (blist size)
1934 pack($StP{$self->byte_size}, 0), # Start of free chain (data size)
1935 pack($StP{$self->byte_size}, 0), # Start of free chain (index size)
1938 #XXX Set these less fragilely
1939 $self->set_trans_loc( $header_fixed + 4 );
1940 $self->set_chains_loc( $header_fixed + 4 + $bl + $STALE_SIZE * ($nt-1) );
1945 sub _read_file_header {
1948 my $buffer = $self->storage->read_at( 0, $header_fixed );
1949 return unless length($buffer);
1951 my ($file_signature, $sig_header, $file_version, $size) = unpack(
1955 unless ( $file_signature eq SIG_FILE ) {
1956 $self->storage->close;
1957 DBM::Deep::10002->_throw_error( "Signature not found -- file is not a Deep DB" );
1960 unless ( $sig_header eq SIG_HEADER ) {
1961 $self->storage->close;
1962 DBM::Deep::10002->_throw_error( "Pre-1.00 file version found" );
1965 unless ( $file_version == $this_file_version ) {
1966 $self->storage->close;
1967 DBM::Deep::10002->_throw_error(
1968 "Wrong file version found - " . $file_version .
1969 " - expected " . $this_file_version
1973 my $buffer2 = $self->storage->read_at( undef, $size );
1974 my @values = unpack( 'C C C C', $buffer2 );
1976 if ( @values != 4 || grep { !defined } @values ) {
1977 $self->storage->close;
1978 DBM::Deep::10002->_throw_error("Corrupted file - bad header");
1981 #XXX Add warnings if values weren't set right
1982 @{$self}{qw(byte_size max_buckets data_sector_size num_txns)} = @values;
1984 # These shenangians are to allow a 256 within a C
1985 $self->{max_buckets} += 1;
1986 $self->{data_sector_size} += 1;
1988 my $bl = $self->txn_bitfield_len;
1990 my $header_var = scalar(@values) + $bl + $STALE_SIZE * ($self->num_txns - 1) + 3 * $self->byte_size;
1991 unless ( $size == $header_var ) {
1992 $self->storage->close;
1993 DBM::Deep::10002->_throw_error( "Unexpected size found ($size <-> $header_var)." );
1996 $self->set_trans_loc( $header_fixed + scalar(@values) );
1997 $self->set_chains_loc( $header_fixed + scalar(@values) + $bl + $STALE_SIZE * ($self->num_txns - 1) );
1999 return length($buffer) + length($buffer2);
2007 # Add a catch for offset of 0 or 1
2008 return if $offset <= 1;
2010 my $type = $self->storage->read_at( $offset, 1 );
2011 return if $type eq chr(0);
2013 if ( $type eq $self->SIG_ARRAY || $type eq $self->SIG_HASH ) {
2014 return DBM::Deep::10002::Engine::Sector::Reference->new({
2020 # XXX Don't we need key_md5 here?
2021 elsif ( $type eq $self->SIG_BLIST ) {
2022 return DBM::Deep::10002::Engine::Sector::BucketList->new({
2028 elsif ( $type eq $self->SIG_INDEX ) {
2029 return DBM::Deep::10002::Engine::Sector::Index->new({
2035 elsif ( $type eq $self->SIG_NULL ) {
2036 return DBM::Deep::10002::Engine::Sector::Null->new({
2042 elsif ( $type eq $self->SIG_DATA ) {
2043 return DBM::Deep::10002::Engine::Sector::Scalar->new({
2049 # This was deleted from under us, so just return and let the caller figure it out.
2050 elsif ( $type eq $self->SIG_FREE ) {
2054 DBM::Deep::10002->_throw_error( "'$offset': Don't know what to do with type '$type'" );
2059 return $self->{digest}->(@_);
2062 sub _add_free_blist_sector { shift->_add_free_sector( 0, @_ ) }
2063 sub _add_free_data_sector { shift->_add_free_sector( 1, @_ ) }
2064 sub _add_free_index_sector { shift->_add_free_sector( 2, @_ ) }
2066 sub _add_free_sector {
2068 my ($multiple, $offset, $size) = @_;
2070 my $chains_offset = $multiple * $self->byte_size;
2072 my $storage = $self->storage;
2074 # Increment staleness.
2075 # XXX Can this increment+modulo be done by "&= 0x1" ?
2076 my $staleness = unpack( $StP{$STALE_SIZE}, $storage->read_at( $offset + SIG_SIZE, $STALE_SIZE ) );
2077 $staleness = ($staleness + 1 ) % ( 2 ** ( 8 * $STALE_SIZE ) );
2078 $storage->print_at( $offset + SIG_SIZE, pack( $StP{$STALE_SIZE}, $staleness ) );
2080 my $old_head = $storage->read_at( $self->chains_loc + $chains_offset, $self->byte_size );
2082 $storage->print_at( $self->chains_loc + $chains_offset,
2083 pack( $StP{$self->byte_size}, $offset ),
2086 # Record the old head in the new sector after the signature and staleness counter
2087 $storage->print_at( $offset + SIG_SIZE + $STALE_SIZE, $old_head );
2090 sub _request_blist_sector { shift->_request_sector( 0, @_ ) }
2091 sub _request_data_sector { shift->_request_sector( 1, @_ ) }
2092 sub _request_index_sector { shift->_request_sector( 2, @_ ) }
2094 sub _request_sector {
2096 my ($multiple, $size) = @_;
2098 my $chains_offset = $multiple * $self->byte_size;
2100 my $old_head = $self->storage->read_at( $self->chains_loc + $chains_offset, $self->byte_size );
2101 my $loc = unpack( $StP{$self->byte_size}, $old_head );
2103 # We don't have any free sectors of the right size, so allocate a new one.
2105 my $offset = $self->storage->request_space( $size );
2107 # Zero out the new sector. This also guarantees correct increases
2109 $self->storage->print_at( $offset, chr(0) x $size );
2114 # Read the new head after the signature and the staleness counter
2115 my $new_head = $self->storage->read_at( $loc + SIG_SIZE + $STALE_SIZE, $self->byte_size );
2116 $self->storage->print_at( $self->chains_loc + $chains_offset, $new_head );
2117 $self->storage->print_at(
2118 $loc + SIG_SIZE + $STALE_SIZE,
2119 pack( $StP{$self->byte_size}, 0 ),
2125 ################################################################################
2127 sub storage { $_[0]{storage} }
2128 sub byte_size { $_[0]{byte_size} }
2129 sub hash_size { $_[0]{hash_size} }
2130 sub hash_chars { $_[0]{hash_chars} }
2131 sub num_txns { $_[0]{num_txns} }
2132 sub max_buckets { $_[0]{max_buckets} }
2133 sub blank_md5 { chr(0) x $_[0]->hash_size }
2134 sub data_sector_size { $_[0]{data_sector_size} }
2136 # This is a calculated value
2137 sub txn_bitfield_len {
2139 unless ( exists $self->{txn_bitfield_len} ) {
2140 my $temp = ($self->num_txns) / 8;
2141 if ( $temp > int( $temp ) ) {
2142 $temp = int( $temp ) + 1;
2144 $self->{txn_bitfield_len} = $temp;
2146 return $self->{txn_bitfield_len};
2149 sub trans_id { $_[0]{trans_id} }
2150 sub set_trans_id { $_[0]{trans_id} = $_[1] }
2152 sub trans_loc { $_[0]{trans_loc} }
2153 sub set_trans_loc { $_[0]{trans_loc} = $_[1] }
2155 sub chains_loc { $_[0]{chains_loc} }
2156 sub set_chains_loc { $_[0]{chains_loc} = $_[1] }
2158 ################################################################################
2160 package DBM::Deep::10002::Iterator;
2168 engine => $args->{engine},
2169 base_offset => $args->{base_offset},
2172 Scalar::Util::weaken( $self->{engine} );
2177 sub reset { $_[0]{breadcrumbs} = [] }
2179 sub get_sector_iterator {
2183 my $sector = $self->{engine}->_load_sector( $loc )
2186 if ( $sector->isa( 'DBM::Deep::10002::Engine::Sector::Index' ) ) {
2187 return DBM::Deep::10002::Iterator::Index->new({
2192 elsif ( $sector->isa( 'DBM::Deep::10002::Engine::Sector::BucketList' ) ) {
2193 return DBM::Deep::10002::Iterator::BucketList->new({
2199 DBM::Deep::10002->_throw_error( "get_sector_iterator(): Why did $loc make a $sector?" );
2206 my $crumbs = $self->{breadcrumbs};
2207 my $e = $self->{engine};
2209 unless ( @$crumbs ) {
2210 # This will be a Reference sector
2211 my $sector = $e->_load_sector( $self->{base_offset} )
2212 # If no sector is found, thist must have been deleted from under us.
2215 if ( $sector->staleness != $obj->_staleness ) {
2219 my $loc = $sector->get_blist_loc
2222 push @$crumbs, $self->get_sector_iterator( $loc );
2227 unless ( @$crumbs ) {
2232 my $iterator = $crumbs->[-1];
2234 # This level is done.
2235 if ( $iterator->at_end ) {
2240 if ( $iterator->isa( 'DBM::Deep::10002::Iterator::Index' ) ) {
2241 # If we don't have any more, it will be caught at the
2243 if ( my $next = $iterator->get_next_iterator ) {
2244 push @$crumbs, $next;
2249 unless ( $iterator->isa( 'DBM::Deep::10002::Iterator::BucketList' ) ) {
2250 DBM::Deep::10002->_throw_error(
2251 "Should have a bucketlist iterator here - instead have $iterator"
2255 # At this point, we have a BucketList iterator
2256 my $key = $iterator->get_next_key;
2257 if ( defined $key ) {
2260 #XXX else { $iterator->set_to_end() } ?
2262 # We hit the end of the bucketlist iterator, so redo
2266 DBM::Deep::10002->_throw_error( "get_next_key(): How did we get here?" );
2269 package DBM::Deep::10002::Iterator::Index;
2272 my $self = bless $_[1] => $_[0];
2273 $self->{curr_index} = 0;
2279 return $self->{curr_index} >= $self->{iterator}{engine}->hash_chars;
2282 sub get_next_iterator {
2287 return if $self->at_end;
2288 $loc = $self->{sector}->get_entry( $self->{curr_index}++ );
2291 return $self->{iterator}->get_sector_iterator( $loc );
2294 package DBM::Deep::10002::Iterator::BucketList;
2297 my $self = bless $_[1] => $_[0];
2298 $self->{curr_index} = 0;
2304 return $self->{curr_index} >= $self->{iterator}{engine}->max_buckets;
2310 return if $self->at_end;
2312 my $idx = $self->{curr_index}++;
2314 my $data_loc = $self->{sector}->get_data_location_for({
2319 #XXX Do we want to add corruption checks here?
2320 return $self->{sector}->get_key_for( $idx )->data;
2323 package DBM::Deep::10002::Engine::Sector;
2326 my $self = bless $_[1], $_[0];
2327 Scalar::Util::weaken( $self->{engine} );
2333 #sub clone { DBM::Deep::10002->_throw_error( "Must be implemented in the child class" ); }
2335 sub engine { $_[0]{engine} }
2336 sub offset { $_[0]{offset} }
2337 sub type { $_[0]{type} }
2341 return $self->engine->SIG_SIZE + $STALE_SIZE;
2347 my $e = $self->engine;
2349 $e->storage->print_at( $self->offset, $e->SIG_FREE );
2350 # Skip staleness counter
2351 $e->storage->print_at( $self->offset + $self->base_size,
2352 chr(0) x ($self->size - $self->base_size),
2355 my $free_meth = $self->free_meth;
2356 $e->$free_meth( $self->offset, $self->size );
2361 package DBM::Deep::10002::Engine::Sector::Data;
2363 our @ISA = qw( DBM::Deep::10002::Engine::Sector );
2366 sub size { $_[0]{engine}->data_sector_size }
2367 sub free_meth { return '_add_free_data_sector' }
2371 return ref($self)->new({
2372 engine => $self->engine,
2373 type => $self->type,
2374 data => $self->data,
2378 package DBM::Deep::10002::Engine::Sector::Scalar;
2380 our @ISA = qw( DBM::Deep::10002::Engine::Sector::Data );
2385 my $chain_loc = $self->chain_loc;
2387 $self->SUPER::free();
2390 $self->engine->_load_sector( $chain_loc )->free;
2396 sub type { $_[0]{engine}->SIG_DATA }
2400 my $engine = $self->engine;
2402 unless ( $self->offset ) {
2403 my $data_section = $self->size - $self->base_size - $engine->byte_size - 1;
2405 $self->{offset} = $engine->_request_data_sector( $self->size );
2407 my $data = delete $self->{data};
2408 my $dlen = length $data;
2410 my $curr_offset = $self->offset;
2411 while ( $continue ) {
2413 my $next_offset = 0;
2415 my ($leftover, $this_len, $chunk);
2416 if ( $dlen > $data_section ) {
2418 $this_len = $data_section;
2419 $chunk = substr( $data, 0, $this_len );
2421 $dlen -= $data_section;
2422 $next_offset = $engine->_request_data_sector( $self->size );
2423 $data = substr( $data, $this_len );
2426 $leftover = $data_section - $dlen;
2433 $engine->storage->print_at( $curr_offset, $self->type ); # Sector type
2435 $engine->storage->print_at( $curr_offset + $self->base_size,
2436 pack( $StP{$engine->byte_size}, $next_offset ), # Chain loc
2437 pack( $StP{1}, $this_len ), # Data length
2438 $chunk, # Data to be stored in this sector
2439 chr(0) x $leftover, # Zero-fill the rest
2442 $curr_offset = $next_offset;
2452 my $buffer = $self->engine->storage->read_at(
2453 $self->offset + $self->base_size + $self->engine->byte_size, 1
2456 return unpack( $StP{1}, $buffer );
2462 $StP{$self->engine->byte_size},
2463 $self->engine->storage->read_at(
2464 $self->offset + $self->base_size,
2465 $self->engine->byte_size,
2475 my $chain_loc = $self->chain_loc;
2477 $data .= $self->engine->storage->read_at(
2478 $self->offset + $self->base_size + $self->engine->byte_size + 1, $self->data_length,
2481 last unless $chain_loc;
2483 $self = $self->engine->_load_sector( $chain_loc );
2489 package DBM::Deep::10002::Engine::Sector::Null;
2491 our @ISA = qw( DBM::Deep::10002::Engine::Sector::Data );
2493 sub type { $_[0]{engine}->SIG_NULL }
2494 sub data_length { 0 }
2500 my $engine = $self->engine;
2502 unless ( $self->offset ) {
2503 my $leftover = $self->size - $self->base_size - 1 * $engine->byte_size - 1;
2505 $self->{offset} = $engine->_request_data_sector( $self->size );
2506 $engine->storage->print_at( $self->offset, $self->type ); # Sector type
2507 # Skip staleness counter
2508 $engine->storage->print_at( $self->offset + $self->base_size,
2509 pack( $StP{$engine->byte_size}, 0 ), # Chain loc
2510 pack( $StP{1}, $self->data_length ), # Data length
2511 chr(0) x $leftover, # Zero-fill the rest
2518 package DBM::Deep::10002::Engine::Sector::Reference;
2520 our @ISA = qw( DBM::Deep::10002::Engine::Sector::Data );
2525 my $e = $self->engine;
2527 unless ( $self->offset ) {
2528 my $classname = Scalar::Util::blessed( delete $self->{data} );
2529 my $leftover = $self->size - $self->base_size - 2 * $e->byte_size;
2531 my $class_offset = 0;
2532 if ( defined $classname ) {
2533 my $class_sector = DBM::Deep::10002::Engine::Sector::Scalar->new({
2537 $class_offset = $class_sector->offset;
2540 $self->{offset} = $e->_request_data_sector( $self->size );
2541 $e->storage->print_at( $self->offset, $self->type ); # Sector type
2542 # Skip staleness counter
2543 $e->storage->print_at( $self->offset + $self->base_size,
2544 pack( $StP{$e->byte_size}, 0 ), # Index/BList loc
2545 pack( $StP{$e->byte_size}, $class_offset ), # Classname loc
2546 chr(0) x $leftover, # Zero-fill the rest
2550 $self->{type} = $e->storage->read_at( $self->offset, 1 );
2553 $self->{staleness} = unpack(
2555 $e->storage->read_at( $self->offset + $e->SIG_SIZE, $STALE_SIZE ),
2564 my $blist_loc = $self->get_blist_loc;
2565 $self->engine->_load_sector( $blist_loc )->free if $blist_loc;
2567 my $class_loc = $self->get_class_offset;
2568 $self->engine->_load_sector( $class_loc )->free if $class_loc;
2570 $self->SUPER::free();
2573 sub staleness { $_[0]{staleness} }
2579 # Assume that the head is not allowed unless otherwise specified.
2580 $args->{allow_head} = 0 unless exists $args->{allow_head};
2582 # Assume we don't create a new blist location unless otherwise specified.
2583 $args->{create} = 0 unless exists $args->{create};
2585 my $blist = $self->get_bucket_list({
2586 key_md5 => $args->{key_md5},
2587 key => $args->{key},
2588 create => $args->{create},
2590 return unless $blist && $blist->{found};
2592 # At this point, $blist knows where the md5 is. What it -doesn't- know yet
2593 # is whether or not this transaction has this key. That's part of the next
2595 my $location = $blist->get_data_location_for({
2596 allow_head => $args->{allow_head},
2599 return $self->engine->_load_sector( $location );
2606 my $blist = $self->get_bucket_list({
2607 key_md5 => $args->{key_md5},
2608 key => $args->{key},
2610 }) or DBM::Deep::10002->_throw_error( "How did write_data fail (no blist)?!" );
2612 # Handle any transactional bookkeeping.
2613 if ( $self->engine->trans_id ) {
2614 if ( ! $blist->has_md5 ) {
2615 $blist->mark_deleted({
2621 my @trans_ids = $self->engine->get_running_txn_ids;
2622 if ( $blist->has_md5 ) {
2624 my $old_value = $blist->get_data_for;
2625 foreach my $other_trans_id ( @trans_ids ) {
2626 next if $blist->get_data_location_for({
2627 trans_id => $other_trans_id,
2631 trans_id => $other_trans_id,
2632 key => $args->{key},
2633 key_md5 => $args->{key_md5},
2634 value => $old_value->clone,
2641 foreach my $other_trans_id ( @trans_ids ) {
2642 #XXX This doesn't seem to possible to ever happen . . .
2643 next if $blist->get_data_location_for({ trans_id => $other_trans_id, allow_head => 0 });
2644 $blist->mark_deleted({
2645 trans_id => $other_trans_id,
2652 #XXX Is this safe to do transactionally?
2653 # Free the place we're about to write to.
2654 if ( $blist->get_data_location_for({ allow_head => 0 }) ) {
2655 $blist->get_data_for({ allow_head => 0 })->free;
2659 key => $args->{key},
2660 key_md5 => $args->{key_md5},
2661 value => $args->{value},
2669 # XXX What should happen if this fails?
2670 my $blist = $self->get_bucket_list({
2671 key_md5 => $args->{key_md5},
2672 }) or DBM::Deep::10002->_throw_error( "How did delete_key fail (no blist)?!" );
2674 # Save the location so that we can free the data
2675 my $location = $blist->get_data_location_for({
2678 my $old_value = $location && $self->engine->_load_sector( $location );
2680 my @trans_ids = $self->engine->get_running_txn_ids;
2682 if ( $self->engine->trans_id == 0 ) {
2684 foreach my $other_trans_id ( @trans_ids ) {
2685 next if $blist->get_data_location_for({ trans_id => $other_trans_id, allow_head => 0 });
2687 trans_id => $other_trans_id,
2688 key => $args->{key},
2689 key_md5 => $args->{key_md5},
2690 value => $old_value->clone,
2698 $blist->mark_deleted( $args );
2701 $data = $old_value->data;
2706 $data = $blist->delete_md5( $args );
2715 my $e = $self->engine;
2716 my $blist_loc = $e->storage->read_at( $self->offset + $self->base_size, $e->byte_size );
2717 return unpack( $StP{$e->byte_size}, $blist_loc );
2720 sub get_bucket_list {
2725 # XXX Add in check here for recycling?
2727 my $engine = $self->engine;
2729 my $blist_loc = $self->get_blist_loc;
2731 # There's no index or blist yet
2732 unless ( $blist_loc ) {
2733 return unless $args->{create};
2735 my $blist = DBM::Deep::10002::Engine::Sector::BucketList->new({
2737 key_md5 => $args->{key_md5},
2740 $engine->storage->print_at( $self->offset + $self->base_size,
2741 pack( $StP{$engine->byte_size}, $blist->offset ),
2747 my $sector = $engine->_load_sector( $blist_loc )
2748 or DBM::Deep::10002->_throw_error( "Cannot read sector at $blist_loc in get_bucket_list()" );
2750 my $last_sector = undef;
2751 while ( $sector->isa( 'DBM::Deep::10002::Engine::Sector::Index' ) ) {
2752 $blist_loc = $sector->get_entry( ord( substr( $args->{key_md5}, $i++, 1 ) ) );
2753 $last_sector = $sector;
2755 $sector = $engine->_load_sector( $blist_loc )
2756 or DBM::Deep::10002->_throw_error( "Cannot read sector at $blist_loc in get_bucket_list()" );
2764 # This means we went through the Index sector(s) and found an empty slot
2765 unless ( $sector ) {
2766 return unless $args->{create};
2768 DBM::Deep::10002->_throw_error( "No last_sector when attempting to build a new entry" )
2769 unless $last_sector;
2771 my $blist = DBM::Deep::10002::Engine::Sector::BucketList->new({
2773 key_md5 => $args->{key_md5},
2776 $last_sector->set_entry( ord( substr( $args->{key_md5}, $i - 1, 1 ) ) => $blist->offset );
2781 $sector->find_md5( $args->{key_md5} );
2783 # See whether or not we need to reindex the bucketlist
2784 if ( !$sector->has_md5 && $args->{create} && $sector->{idx} == -1 ) {
2785 my $new_index = DBM::Deep::10002::Engine::Sector::Index->new({
2790 #XXX q.v. the comments for this function.
2791 foreach my $entry ( $sector->chopped_up ) {
2792 my ($spot, $md5) = @{$entry};
2793 my $idx = ord( substr( $md5, $i, 1 ) );
2795 # XXX This is inefficient
2796 my $blist = $blist_cache{$idx}
2797 ||= DBM::Deep::10002::Engine::Sector::BucketList->new({
2801 $new_index->set_entry( $idx => $blist->offset );
2803 my $new_spot = $blist->write_at_next_open( $md5 );
2804 $engine->reindex_entry( $spot => $new_spot );
2807 # Handle the new item separately.
2809 my $idx = ord( substr( $args->{key_md5}, $i, 1 ) );
2810 my $blist = $blist_cache{$idx}
2811 ||= DBM::Deep::10002::Engine::Sector::BucketList->new({
2815 $new_index->set_entry( $idx => $blist->offset );
2818 $blist->find_md5( $args->{key_md5} );
2820 key => $args->{key},
2821 key_md5 => $args->{key_md5},
2822 value => DBM::Deep::10002::Engine::Sector::Null->new({
2829 if ( $last_sector ) {
2830 $last_sector->set_entry(
2831 ord( substr( $args->{key_md5}, $i - 1, 1 ) ),
2835 $engine->storage->print_at( $self->offset + $self->base_size,
2836 pack( $StP{$engine->byte_size}, $new_index->offset ),
2842 $sector = $blist_cache{ ord( substr( $args->{key_md5}, $i, 1 ) ) };
2843 $sector->find_md5( $args->{key_md5} );
2849 sub get_class_offset {
2852 my $e = $self->engine;
2854 $StP{$e->byte_size},
2855 $e->storage->read_at(
2856 $self->offset + $self->base_size + 1 * $e->byte_size, $e->byte_size,
2864 my $class_offset = $self->get_class_offset;
2866 return unless $class_offset;
2868 return $self->engine->_load_sector( $class_offset )->data;
2871 #XXX Add singleton handling here
2875 my $new_obj = DBM::Deep::10002->new({
2876 type => $self->type,
2877 base_offset => $self->offset,
2878 staleness => $self->staleness,
2879 storage => $self->engine->storage,
2880 engine => $self->engine,
2883 if ( $self->engine->storage->{autobless} ) {
2884 my $classname = $self->get_classname;
2885 if ( defined $classname ) {
2886 bless $new_obj, $classname;
2893 package DBM::Deep::10002::Engine::Sector::BucketList;
2895 our @ISA = qw( DBM::Deep::10002::Engine::Sector );
2900 my $engine = $self->engine;
2902 unless ( $self->offset ) {
2903 my $leftover = $self->size - $self->base_size;
2905 $self->{offset} = $engine->_request_blist_sector( $self->size );
2906 $engine->storage->print_at( $self->offset, $engine->SIG_BLIST ); # Sector type
2907 # Skip staleness counter
2908 $engine->storage->print_at( $self->offset + $self->base_size,
2909 chr(0) x $leftover, # Zero-fill the data
2913 if ( $self->{key_md5} ) {
2922 unless ( $self->{size} ) {
2923 my $e = $self->engine;
2924 # Base + numbuckets * bucketsize
2925 $self->{size} = $self->base_size + $e->max_buckets * $self->bucket_size;
2927 return $self->{size};
2930 sub free_meth { return '_add_free_blist_sector' }
2934 unless ( $self->{bucket_size} ) {
2935 my $e = $self->engine;
2936 # Key + head (location) + transactions (location + staleness-counter)
2937 my $location_size = $e->byte_size + $e->byte_size + ($e->num_txns - 1) * ($e->byte_size + $STALE_SIZE);
2938 $self->{bucket_size} = $e->hash_size + $location_size;
2940 return $self->{bucket_size};
2943 # XXX This is such a poor hack. I need to rethink this code.
2947 my $e = $self->engine;
2950 foreach my $idx ( 0 .. $e->max_buckets - 1 ) {
2951 my $spot = $self->offset + $self->base_size + $idx * $self->bucket_size;
2952 my $md5 = $e->storage->read_at( $spot, $e->hash_size );
2954 #XXX If we're chopping, why would we ever have the blank_md5?
2955 last if $md5 eq $e->blank_md5;
2957 my $rest = $e->storage->read_at( undef, $self->bucket_size - $e->hash_size );
2958 push @buckets, [ $spot, $md5 . $rest ];
2964 sub write_at_next_open {
2968 #XXX This is such a hack!
2969 $self->{_next_open} = 0 unless exists $self->{_next_open};
2971 my $spot = $self->offset + $self->base_size + $self->{_next_open}++ * $self->bucket_size;
2972 $self->engine->storage->print_at( $spot, $entry );
2979 unless ( exists $self->{found} ) {
2982 return $self->{found};
2988 $self->{found} = undef;
2992 $self->{key_md5} = shift;
2995 # If we don't have an MD5, then what are we supposed to do?
2996 unless ( exists $self->{key_md5} ) {
2997 DBM::Deep::10002->_throw_error( "Cannot find_md5 without a key_md5 set" );
3000 my $e = $self->engine;
3001 foreach my $idx ( 0 .. $e->max_buckets - 1 ) {
3002 my $potential = $e->storage->read_at(
3003 $self->offset + $self->base_size + $idx * $self->bucket_size, $e->hash_size,
3006 if ( $potential eq $e->blank_md5 ) {
3007 $self->{idx} = $idx;
3011 if ( $potential eq $self->{key_md5} ) {
3013 $self->{idx} = $idx;
3025 DBM::Deep::10002->_throw_error( "write_md5: no key" ) unless exists $args->{key};
3026 DBM::Deep::10002->_throw_error( "write_md5: no key_md5" ) unless exists $args->{key_md5};
3027 DBM::Deep::10002->_throw_error( "write_md5: no value" ) unless exists $args->{value};
3029 my $engine = $self->engine;
3031 $args->{trans_id} = $engine->trans_id unless exists $args->{trans_id};
3033 my $spot = $self->offset + $self->base_size + $self->{idx} * $self->bucket_size;
3034 $engine->add_entry( $args->{trans_id}, $spot );
3036 unless ($self->{found}) {
3037 my $key_sector = DBM::Deep::10002::Engine::Sector::Scalar->new({
3039 data => $args->{key},
3042 $engine->storage->print_at( $spot,
3044 pack( $StP{$engine->byte_size}, $key_sector->offset ),
3049 + $engine->hash_size
3050 + $engine->byte_size;
3052 if ( $args->{trans_id} ) {
3053 $loc += $engine->byte_size + ($args->{trans_id} - 1) * ( $engine->byte_size + $STALE_SIZE );
3055 $engine->storage->print_at( $loc,
3056 pack( $StP{$engine->byte_size}, $args->{value}->offset ),
3057 pack( $StP{$STALE_SIZE}, $engine->get_txn_staleness_counter( $args->{trans_id} ) ),
3061 $engine->storage->print_at( $loc,
3062 pack( $StP{$engine->byte_size}, $args->{value}->offset ),
3072 my $engine = $self->engine;
3074 $args->{trans_id} = $engine->trans_id unless exists $args->{trans_id};
3076 my $spot = $self->offset + $self->base_size + $self->{idx} * $self->bucket_size;
3077 $engine->add_entry( $args->{trans_id}, $spot );
3080 + $engine->hash_size
3081 + $engine->byte_size;
3083 if ( $args->{trans_id} ) {
3084 $loc += $engine->byte_size + ($args->{trans_id} - 1) * ( $engine->byte_size + $STALE_SIZE );
3086 $engine->storage->print_at( $loc,
3087 pack( $StP{$engine->byte_size}, 1 ), # 1 is the marker for deleted
3088 pack( $StP{$STALE_SIZE}, $engine->get_txn_staleness_counter( $args->{trans_id} ) ),
3092 $engine->storage->print_at( $loc,
3093 pack( $StP{$engine->byte_size}, 1 ), # 1 is the marker for deleted
3103 my $engine = $self->engine;
3104 return undef unless $self->{found};
3106 # Save the location so that we can free the data
3107 my $location = $self->get_data_location_for({
3110 my $key_sector = $self->get_key_for;
3112 my $spot = $self->offset + $self->base_size + $self->{idx} * $self->bucket_size;
3113 $engine->storage->print_at( $spot,
3114 $engine->storage->read_at(
3115 $spot + $self->bucket_size,
3116 $self->bucket_size * ( $engine->max_buckets - $self->{idx} - 1 ),
3118 chr(0) x $self->bucket_size,
3123 my $data_sector = $self->engine->_load_sector( $location );
3124 my $data = $data_sector->data;
3130 sub get_data_location_for {
3135 $args->{allow_head} = 0 unless exists $args->{allow_head};
3136 $args->{trans_id} = $self->engine->trans_id unless exists $args->{trans_id};
3137 $args->{idx} = $self->{idx} unless exists $args->{idx};
3139 my $e = $self->engine;
3141 my $spot = $self->offset + $self->base_size
3142 + $args->{idx} * $self->bucket_size
3146 if ( $args->{trans_id} ) {
3147 $spot += $e->byte_size + ($args->{trans_id} - 1) * ( $e->byte_size + $STALE_SIZE );
3150 my $buffer = $e->storage->read_at(
3152 $e->byte_size + $STALE_SIZE,
3154 my ($loc, $staleness) = unpack( $StP{$e->byte_size} . ' ' . $StP{$STALE_SIZE}, $buffer );
3156 if ( $args->{trans_id} ) {
3157 # We have found an entry that is old, so get rid of it
3158 if ( $staleness != (my $s = $e->get_txn_staleness_counter( $args->{trans_id} ) ) ) {
3159 $e->storage->print_at(
3161 pack( $StP{$e->byte_size} . ' ' . $StP{$STALE_SIZE}, (0) x 2 ),
3167 # If we're in a transaction and we never wrote to this location, try the
3169 if ( $args->{trans_id} && !$loc && $args->{allow_head} ) {
3170 return $self->get_data_location_for({
3173 idx => $args->{idx},
3176 return $loc <= 1 ? 0 : $loc;
3184 return unless $self->{found};
3185 my $location = $self->get_data_location_for({
3186 allow_head => $args->{allow_head},
3188 return $self->engine->_load_sector( $location );
3194 $idx = $self->{idx} unless defined $idx;
3196 if ( $idx >= $self->engine->max_buckets ) {
3197 DBM::Deep::10002->_throw_error( "get_key_for(): Attempting to retrieve $idx" );
3200 my $location = $self->engine->storage->read_at(
3201 $self->offset + $self->base_size + $idx * $self->bucket_size + $self->engine->hash_size,
3202 $self->engine->byte_size,
3204 $location = unpack( $StP{$self->engine->byte_size}, $location );
3205 DBM::Deep::10002->_throw_error( "get_key_for: No location?" ) unless $location;
3207 return $self->engine->_load_sector( $location );
3210 package DBM::Deep::10002::Engine::Sector::Index;
3212 our @ISA = qw( DBM::Deep::10002::Engine::Sector );
3217 my $engine = $self->engine;
3219 unless ( $self->offset ) {
3220 my $leftover = $self->size - $self->base_size;
3222 $self->{offset} = $engine->_request_index_sector( $self->size );
3223 $engine->storage->print_at( $self->offset, $engine->SIG_INDEX ); # Sector type
3224 # Skip staleness counter
3225 $engine->storage->print_at( $self->offset + $self->base_size,
3226 chr(0) x $leftover, # Zero-fill the rest
3236 unless ( $self->{size} ) {
3237 my $e = $self->engine;
3238 $self->{size} = $self->base_size + $e->byte_size * $e->hash_chars;
3240 return $self->{size};
3243 sub free_meth { return '_add_free_index_sector' }
3247 my $e = $self->engine;
3249 for my $i ( 0 .. $e->hash_chars - 1 ) {
3250 my $l = $self->get_entry( $i ) or next;
3251 $e->_load_sector( $l )->free;
3254 $self->SUPER::free();
3260 return $self->offset + $self->base_size + $idx * $self->engine->byte_size;
3267 my $e = $self->engine;
3269 DBM::Deep::10002->_throw_error( "get_entry: Out of range ($idx)" )
3270 if $idx < 0 || $idx >= $e->hash_chars;
3273 $StP{$e->byte_size},
3274 $e->storage->read_at( $self->_loc_for( $idx ), $e->byte_size ),
3280 my ($idx, $loc) = @_;
3282 my $e = $self->engine;
3284 DBM::Deep::10002->_throw_error( "set_entry: Out of range ($idx)" )
3285 if $idx < 0 || $idx >= $e->hash_chars;
3287 $self->engine->storage->print_at(
3288 $self->_loc_for( $idx ),
3289 pack( $StP{$e->byte_size}, $loc ),