1 package DBM::Deep::Engine2;
3 use base 'DBM::Deep::Engine';
10 our $VERSION = q(0.99_03);
12 use Fcntl qw( :DEFAULT :flock );
16 # * Every method in here assumes that the _storage has been appropriately
17 # safeguarded. This can be anything from flock() to some sort of manual
18 # mutex. But, it's the caller's responsability to make sure that this has
21 # Setup file and tag signatures. These should never change.
22 sub SIG_FILE () { 'DPDB' }
23 sub SIG_HEADER () { 'h' }
24 sub SIG_INTERNAL () { 'i' }
25 sub SIG_HASH () { 'H' }
26 sub SIG_ARRAY () { 'A' }
27 sub SIG_NULL () { 'N' }
28 sub SIG_DATA () { 'D' }
29 sub SIG_INDEX () { 'I' }
30 sub SIG_BLIST () { 'B' }
31 sub SIG_FREE () { 'F' }
32 sub SIG_KEYS () { 'K' }
35 # This is the transaction ID for the HEAD
40 my ($trans_id, $base_offset, $key) = @_;
42 my ($_val_offset, $_is_del) = $self->_find_value_offset({
43 offset => $base_offset,
44 trans_id => $trans_id,
47 die "Attempt to use a deleted value" if $_is_del;
48 die "Internal error!" if !$_val_offset;
50 my ($key_tag) = $self->_find_key_offset({
51 offset => $_val_offset,
52 key_md5 => $self->_apply_digest( $key ),
56 my ($val_offset, $is_del) = $self->_find_value_offset({
57 offset => $key_tag->{start},
58 trans_id => $trans_id,
62 die "Internal error!" if !$val_offset;
64 return $self->_read_value({
65 keyloc => $key_tag->{start},
66 offset => $val_offset,
73 my ($trans_id, $base_offset, $key) = @_;
75 my ($_val_offset, $_is_del) = $self->_find_value_offset({
76 offset => $base_offset,
77 trans_id => $trans_id,
80 die "Attempt to use a deleted value" if $_is_del;
81 die "Internal error!" if !$_val_offset;
83 my ($key_tag) = $self->_find_key_offset({
84 offset => $_val_offset,
85 key_md5 => $self->_apply_digest( $key ),
87 return '' if !$key_tag->{start};
89 my ($val_offset, $is_del) = $self->_find_value_offset({
90 offset => $key_tag->{start},
91 trans_id => $trans_id,
94 die "Internal error!" if !$_val_offset;
103 my ($trans_id, $base_offset) = @_;
105 my ($_val_offset, $_is_del) = $self->_find_value_offset({
106 offset => $base_offset,
107 trans_id => $trans_id,
110 die "Attempt to use a deleted value" if $_is_del;
111 die "Internal error!" if !$_val_offset;
113 # If the previous key was not specifed, start at the top and
114 # return the first one found.
118 prev_md5 => $self->_apply_digest($_[2]),
124 prev_md5 => chr(0) x $self->{hash_size},
130 print "get_next_key: $_val_offset\n" if $::DEBUG;
131 return $self->traverse_index( $temp, $_val_offset, 0 );
136 my ($trans_id, $base_offset, $key) = @_;
138 my ($_val_offset, $_is_del) = $self->_find_value_offset({
139 offset => $base_offset,
140 trans_id => $trans_id,
143 die "Attempt to use a deleted value" if $_is_del;
144 die "Internal error!" if !$_val_offset;
146 my ($key_tag, $bucket_tag) = $self->_find_key_offset({
147 offset => $_val_offset,
148 key_md5 => $self->_apply_digest( $key ),
150 return if !$key_tag->{start};
152 my $value = $self->read_value( $trans_id, $base_offset, $key );
154 $self->_mark_as_deleted({
156 trans_id => $trans_id,
160 if ( my @transactions = $self->_storage->current_transactions ) {
161 foreach my $other_trans_id ( @transactions ) {
162 next if $self->_has_keyloc_entry({
164 trans_id => $other_trans_id,
166 $self->write_value( $other_trans_id, $base_offset, $key, $value );
170 $self->_mark_as_deleted({
172 trans_id => $trans_id,
174 # $self->_remove_key_offset({
175 # offset => $_val_offset,
176 # key_md5 => $self->_apply_digest( $key ),
185 my ($trans_id, $base_offset, $key, $value) = @_;
187 # This verifies that only supported values will be stored.
189 my $r = Scalar::Util::reftype( $value );
192 last if $r eq 'HASH';
193 last if $r eq 'ARRAY';
196 "Storage of references of type '$r' is not supported."
200 my ($_val_offset, $_is_del) = $self->_find_value_offset({
201 offset => $base_offset,
202 trans_id => $trans_id,
205 die "Attempt to use a deleted value" if $_is_del;
206 die "Internal error!" if !$_val_offset;
208 my ($key_tag, $bucket_tag) = $self->_find_key_offset({
209 offset => $_val_offset,
210 key_md5 => $self->_apply_digest( $key ),
213 die "Cannot find/create new key offset!" if !$key_tag->{start};
216 if ( $key_tag->{is_new} ) {
217 # Must mark the HEAD as deleted because it doesn't exist
218 $self->_mark_as_deleted({
225 # If the HEAD isn't new, then we must take other transactions
226 # into account. If it is, then there can be no other transactions.
227 if ( !$key_tag->{is_new} ) {
228 my $old_value = $self->read_value( $trans_id, $base_offset, $key );
229 if ( my @transactions = $self->_storage->current_transactions ) {
230 foreach my $other_trans_id ( @transactions ) {
231 next if $self->_has_keyloc_entry({
233 trans_id => $other_trans_id,
235 $self->write_value( $other_trans_id, $base_offset, $key, $old_value );
241 my $value_loc = $self->_storage->request_space(
242 $self->_length_needed( $value, $key ),
245 $self->_add_key_offset({
247 trans_id => $trans_id,
251 $self->_write_value( $key_tag->{start}, $value_loc, $key, $value, $key );
256 sub _find_value_offset {
260 my $key_tag = $self->load_tag( $args->{offset} );
263 for ( my $i = 0; $i < $self->{max_buckets}; $i++ ) {
264 my ($loc, $trans_id, $is_deleted) = unpack(
265 "$self->{long_pack} C C",
266 substr( $key_tag->{content}, $i * $self->{key_size}, $self->{key_size} ),
269 if ( $trans_id == HEAD ) {
270 @head = ($loc, $is_deleted);
273 next if $loc && $args->{trans_id} != $trans_id;
274 return( $loc, $is_deleted );
277 return @head if $args->{allow_head};
281 sub _find_key_offset {
285 my $bucket_tag = $self->load_tag( $args->{offset} )
286 or $self->_throw_error( "INTERNAL ERROR - Cannot find tag" );
288 #XXX What happens when $ch >= $self->{hash_size} ??
289 for (my $ch = 0; $bucket_tag->{signature} ne SIG_BLIST; $ch++) {
290 my $num = ord substr($args->{key_md5}, $ch, 1);
292 my $ref_loc = $bucket_tag->{offset} + ($num * $self->{long_size});
293 $bucket_tag = $self->index_lookup( $bucket_tag, $num );
296 return if !$args->{create};
298 my $loc = $self->_storage->request_space(
299 $self->tag_size( $self->{bucket_list_size} ),
302 $self->_storage->print_at( $ref_loc, pack($self->{long_pack}, $loc) );
304 $bucket_tag = $self->write_tag(
306 chr(0)x$self->{bucket_list_size},
309 $bucket_tag->{ref_loc} = $ref_loc;
310 $bucket_tag->{ch} = $ch;
311 $bucket_tag->{is_new} = 1;
316 $bucket_tag->{ch} = $ch;
317 $bucket_tag->{ref_loc} = $ref_loc;
320 # Need to create a new keytag, too
321 if ( $bucket_tag->{is_new} ) {
322 my $keytag_loc = $self->_storage->request_space(
323 $self->tag_size( $self->{keyloc_size} ),
326 substr( $bucket_tag->{content}, 0, $self->{key_size} ) =
327 $args->{key_md5} . pack( "$self->{long_pack}", $keytag_loc );
329 $self->_storage->print_at( $bucket_tag->{offset}, $bucket_tag->{content} );
331 my $key_tag = $self->write_tag(
332 $keytag_loc, SIG_KEYS,
333 chr(0)x$self->{keyloc_size},
336 return( $key_tag, $bucket_tag );
339 my ($key, $subloc, $index);
341 for ( my $i = 0; $i < $self->{max_buckets}; $i++ ) {
342 ($key, $subloc) = $self->_get_key_subloc(
343 $bucket_tag->{content}, $i,
346 next BUCKET if $subloc && $key ne $args->{key_md5};
348 # Keep track of where we are, in case we need to create a new
354 # If we have a subloc to return or we don't want to create a new
355 # entry, we need to return now.
356 $args->{create} ||= 0;
357 return ($self->load_tag( $subloc ), $bucket_tag) if $subloc || !$args->{create};
359 my $keytag_loc = $self->_storage->request_space(
360 $self->tag_size( $self->{keyloc_size} ),
363 # There's space left in this bucket
364 if ( defined $index ) {
365 substr( $bucket_tag->{content}, $index * $self->{key_size}, $self->{key_size} ) =
366 $args->{key_md5} . pack( "$self->{long_pack}", $keytag_loc );
368 $self->_storage->print_at( $bucket_tag->{offset}, $bucket_tag->{content} );
370 # We need to split the index
372 $self->split_index( $bucket_tag, $args->{key_md5}, $keytag_loc );
375 my $key_tag = $self->write_tag(
376 $keytag_loc, SIG_KEYS,
377 chr(0)x$self->{keyloc_size},
380 return( $key_tag, $bucket_tag );
390 return $self->read_from_loc( $args->{keyloc}, $args->{offset}, $args->{key} );
393 sub _mark_as_deleted {
398 for ( my $i = 0; $i < $self->{max_buckets}; $i++ ) {
399 my ($loc, $trans_id, $is_deleted) = unpack(
400 "$self->{long_pack} C C",
401 substr( $args->{tag}{content}, $i * $self->{key_size}, $self->{key_size} ),
404 last unless $loc || $is_deleted;
406 if ( $trans_id == $args->{trans_id} ) {
407 substr( $args->{tag}{content}, $i * $self->{key_size}, $self->{key_size} ) = pack(
408 "$self->{long_pack} C C",
417 $self->_storage->print_at(
418 $args->{tag}{offset}, $args->{tag}{content},
425 sub _has_keyloc_entry {
429 for ( my $i = 0; $i < $self->{max_buckets}; $i++ ) {
430 my ($loc, $trans_id, $is_deleted) = unpack(
431 "$self->{long_pack} C C",
432 substr( $args->{tag}{content}, $i * $self->{key_size}, $self->{key_size} ),
435 return 1 if $trans_id == $args->{trans_id};
441 sub _remove_key_offset {
446 for ( my $i = 0; $i < $self->{max_buckets}; $i++ ) {
447 my ($loc, $trans_id, $is_deleted) = unpack(
448 "$self->{long_pack} C C",
449 substr( $args->{tag}{content}, $i * $self->{key_size}, $self->{key_size} ),
452 if ( $trans_id == $args->{trans_id} ) {
453 substr( $args->{tag}{content}, $i * $self->{key_size}, $self->{key_size} ) = '';
454 $args->{tag}{content} .= chr(0) x $self->{key_size};
461 $self->_storage->print_at(
462 $args->{tag}{offset}, $args->{tag}{content},
469 sub _add_key_offset {
474 for ( my $i = 0; $i < $self->{max_buckets}; $i++ ) {
475 my ($loc, $trans_id, $is_deleted) = unpack(
476 "$self->{long_pack} C C",
477 substr( $args->{tag}{content}, $i * $self->{key_size}, $self->{key_size} ),
480 if ( $trans_id == $args->{trans_id} || (!$loc && !$is_deleted) ) {
481 substr( $args->{tag}{content}, $i * $self->{key_size}, $self->{key_size} ) = pack(
482 "$self->{long_pack} C C",
483 $args->{loc}, $args->{trans_id}, 0,
491 $self->_storage->print_at(
492 $args->{tag}{offset}, $args->{tag}{content},
496 die "Why didn't _add_key_offset() change something?!\n";
506 # Need to remove use of $fh here
507 my $fh = $self->_storage->{fh};
510 #XXX The duplication of calculate_sizes needs to go away
511 unless ( $obj->{base_offset} ) {
512 my $bytes_read = $self->read_file_header;
514 $self->calculate_sizes;
517 # File is empty -- write header and master index
520 $self->_storage->audit( "# Database created on" );
522 $self->write_file_header;
524 $obj->{base_offset} = $self->_storage->request_space(
525 $self->tag_size( $self->{keyloc_size} ),
528 my $value_spot = $self->_storage->request_space(
529 $self->tag_size( $self->{index_size} ),
533 $obj->{base_offset}, SIG_KEYS,
534 pack( "$self->{long_pack} C C", $value_spot, HEAD, 0 ),
535 chr(0) x ($self->{index_size} - $self->{key_size}),
539 $value_spot, $obj->_type,
540 chr(0)x$self->{index_size},
543 # Flush the filehandle
544 my $old_fh = select $fh;
545 my $old_af = $|; $| = 1; $| = $old_af;
549 $obj->{base_offset} = $bytes_read;
551 my ($_val_offset, $_is_del) = $self->_find_value_offset({
552 offset => $obj->{base_offset},
556 die "Attempt to use a deleted value" if $_is_del;
557 die "Internal error!" if !$_val_offset;
560 # Get our type from master index header
562 my $tag = $self->load_tag($_val_offset);
565 $self->_throw_error("Corrupted file, no master index record");
568 unless ($obj->_type eq $tag->{signature}) {
570 $self->_throw_error("File type mismatch");
575 $self->calculate_sizes;
578 #XXX We have to make sure we don't mess up when autoflush isn't turned on
579 $self->_storage->set_inode;