Commit | Line | Data |
a20d9a3f |
1 | package DBM::Deep::Engine; |
2 | |
2120a181 |
3 | use 5.006_000; |
460b1067 |
4 | |
a20d9a3f |
5 | use strict; |
065b45be |
6 | use warnings FATAL => 'all'; |
a20d9a3f |
7 | |
75a6a379 |
8 | # Never import symbols into our namespace. We are a class, not a library. |
9 | # -RobK, 2008-05-27 |
10 | use Scalar::Util (); |
d6d8e27e |
11 | |
12 | #use Data::Dumper (); |
75a6a379 |
13 | |
21838116 |
14 | # File-wide notes: |
2120a181 |
15 | # * Every method in here assumes that the storage has been appropriately |
c3aafc14 |
16 | # safeguarded. This can be anything from flock() to some sort of manual |
17 | # mutex. But, it's the caller's responsability to make sure that this has |
18 | # been done. |
21838116 |
19 | |
8db25060 |
20 | # Setup file and tag signatures. These should never change. |
8db25060 |
21 | sub SIG_FILE () { 'DPDB' } |
460b1067 |
22 | sub SIG_HEADER () { 'h' } |
8db25060 |
23 | sub SIG_HASH () { 'H' } |
24 | sub SIG_ARRAY () { 'A' } |
8db25060 |
25 | sub SIG_NULL () { 'N' } |
26 | sub SIG_DATA () { 'D' } |
27 | sub SIG_INDEX () { 'I' } |
28 | sub SIG_BLIST () { 'B' } |
7b1e1aa1 |
29 | sub SIG_FREE () { 'F' } |
8db25060 |
30 | sub SIG_SIZE () { 1 } |
e9b0b5f0 |
31 | |
065b45be |
32 | our $STALE_SIZE = 2; |
8db25060 |
33 | |
2120a181 |
34 | # Please refer to the pack() documentation for further information |
35 | my %StP = ( |
e9b0b5f0 |
36 | 1 => 'C', # Unsigned char value (no order needed as it's just one byte) |
2120a181 |
37 | 2 => 'n', # Unsigned short in "network" (big-endian) order |
38 | 4 => 'N', # Unsigned long in "network" (big-endian) order |
39 | 8 => 'Q', # Usigned quad (no order specified, presumably machine-dependent) |
40 | ); |
065b45be |
41 | sub StP { $StP{$_[1]} } |
83371fe3 |
42 | |
00d9bd0b |
43 | # Import these after the SIG_* definitions because those definitions are used |
44 | # in the headers of these classes. -RobK, 2008-06-20 |
45 | use DBM::Deep::Engine::Sector::BucketList; |
46 | use DBM::Deep::Engine::Sector::FileHeader; |
47 | use DBM::Deep::Engine::Sector::Index; |
48 | use DBM::Deep::Engine::Sector::Null; |
49 | use DBM::Deep::Engine::Sector::Reference; |
50 | use DBM::Deep::Engine::Sector::Scalar; |
51 | use DBM::Deep::Iterator; |
52 | |
c3aafc14 |
53 | ################################################################################ |
c3aafc14 |
54 | |
612969fb |
55 | sub new { |
56 | my $class = shift; |
57 | my ($args) = @_; |
58 | |
f1879fdc |
59 | $args->{storage} = DBM::Deep::File->new( $args ) |
60 | unless exists $args->{storage}; |
61 | |
612969fb |
62 | my $self = bless { |
2120a181 |
63 | byte_size => 4, |
64 | |
65 | digest => undef, |
66 | hash_size => 16, # In bytes |
67 | hash_chars => 256, # Number of chars the algorithm uses per byte |
612969fb |
68 | max_buckets => 16, |
e9b0b5f0 |
69 | num_txns => 1, # The HEAD |
2120a181 |
70 | trans_id => 0, # Default to the HEAD |
460b1067 |
71 | |
e9b0b5f0 |
72 | data_sector_size => 64, # Size in bytes of each data sector |
73 | |
2120a181 |
74 | entries => {}, # This is the list of entries for transactions |
83371fe3 |
75 | storage => undef, |
612969fb |
76 | }, $class; |
77 | |
e9b0b5f0 |
78 | # Never allow byte_size to be set directly. |
79 | delete $args->{byte_size}; |
e0098e7f |
80 | if ( defined $args->{pack_size} ) { |
81 | if ( lc $args->{pack_size} eq 'small' ) { |
2120a181 |
82 | $args->{byte_size} = 2; |
e0098e7f |
83 | } |
84 | elsif ( lc $args->{pack_size} eq 'medium' ) { |
2120a181 |
85 | $args->{byte_size} = 4; |
e0098e7f |
86 | } |
87 | elsif ( lc $args->{pack_size} eq 'large' ) { |
2120a181 |
88 | $args->{byte_size} = 8; |
e0098e7f |
89 | } |
90 | else { |
2120a181 |
91 | DBM::Deep->_throw_error( "Unknown pack_size value: '$args->{pack_size}'" ); |
e0098e7f |
92 | } |
93 | } |
94 | |
fde3db1a |
95 | # Grab the parameters we want to use |
96 | foreach my $param ( keys %$self ) { |
97 | next unless exists $args->{$param}; |
3e9498a1 |
98 | $self->{$param} = $args->{$param}; |
fde3db1a |
99 | } |
100 | |
e9b0b5f0 |
101 | my %validations = ( |
102 | max_buckets => { floor => 16, ceil => 256 }, |
103 | num_txns => { floor => 1, ceil => 255 }, |
104 | data_sector_size => { floor => 32, ceil => 256 }, |
105 | ); |
106 | |
107 | while ( my ($attr, $c) = each %validations ) { |
108 | if ( !defined $self->{$attr} |
109 | || !length $self->{$attr} |
110 | || $self->{$attr} =~ /\D/ |
111 | || $self->{$attr} < $c->{floor} |
112 | ) { |
113 | $self->{$attr} = '(undef)' if !defined $self->{$attr}; |
114 | warn "Floor of $attr is $c->{floor}. Setting it to $c->{floor} from '$self->{$attr}'\n"; |
115 | $self->{$attr} = $c->{floor}; |
116 | } |
117 | elsif ( $self->{$attr} > $c->{ceil} ) { |
118 | warn "Ceiling of $attr is $c->{ceil}. Setting it to $c->{ceil} from '$self->{$attr}'\n"; |
119 | $self->{$attr} = $c->{ceil}; |
120 | } |
e0098e7f |
121 | } |
122 | |
2120a181 |
123 | if ( !$self->{digest} ) { |
124 | require Digest::MD5; |
125 | $self->{digest} = \&Digest::MD5::md5; |
126 | } |
127 | |
260a80b4 |
128 | return $self; |
129 | } |
130 | |
2120a181 |
131 | ################################################################################ |
460b1067 |
132 | |
2120a181 |
133 | sub read_value { |
c3aafc14 |
134 | my $self = shift; |
2120a181 |
135 | my ($obj, $key) = @_; |
136 | |
137 | # This will be a Reference sector |
138 | my $sector = $self->_load_sector( $obj->_base_offset ) |
139 | or return; |
140 | |
141 | if ( $sector->staleness != $obj->_staleness ) { |
142 | return; |
143 | } |
144 | |
145 | my $key_md5 = $self->_apply_digest( $key ); |
146 | |
147 | my $value_sector = $sector->get_data_for({ |
148 | key_md5 => $key_md5, |
149 | allow_head => 1, |
150 | }); |
151 | |
152 | unless ( $value_sector ) { |
153 | $value_sector = DBM::Deep::Engine::Sector::Null->new({ |
154 | engine => $self, |
155 | data => undef, |
156 | }); |
157 | |
158 | $sector->write_data({ |
159 | key_md5 => $key_md5, |
160 | key => $key, |
161 | value => $value_sector, |
162 | }); |
163 | } |
164 | |
165 | return $value_sector->data; |
c3aafc14 |
166 | } |
167 | |
2120a181 |
168 | sub get_classname { |
260a80b4 |
169 | my $self = shift; |
2120a181 |
170 | my ($obj) = @_; |
260a80b4 |
171 | |
2120a181 |
172 | # This will be a Reference sector |
173 | my $sector = $self->_load_sector( $obj->_base_offset ) |
174 | or DBM::Deep->_throw_error( "How did get_classname fail (no sector for '$obj')?!" ); |
612969fb |
175 | |
2120a181 |
176 | if ( $sector->staleness != $obj->_staleness ) { |
177 | return; |
178 | } |
ea2f6d67 |
179 | |
2120a181 |
180 | return $sector->get_classname; |
1bf65be7 |
181 | } |
182 | |
1cff45d7 |
183 | sub make_reference { |
184 | my $self = shift; |
185 | my ($obj, $old_key, $new_key) = @_; |
186 | |
187 | # This will be a Reference sector |
188 | my $sector = $self->_load_sector( $obj->_base_offset ) |
00d9bd0b |
189 | or DBM::Deep->_throw_error( "How did make_reference fail (no sector for '$obj')?!" ); |
1cff45d7 |
190 | |
191 | if ( $sector->staleness != $obj->_staleness ) { |
192 | return; |
193 | } |
194 | |
195 | my $old_md5 = $self->_apply_digest( $old_key ); |
196 | |
197 | my $value_sector = $sector->get_data_for({ |
198 | key_md5 => $old_md5, |
199 | allow_head => 1, |
200 | }); |
201 | |
202 | unless ( $value_sector ) { |
203 | $value_sector = DBM::Deep::Engine::Sector::Null->new({ |
204 | engine => $self, |
205 | data => undef, |
206 | }); |
207 | |
208 | $sector->write_data({ |
209 | key_md5 => $old_md5, |
210 | key => $old_key, |
211 | value => $value_sector, |
212 | }); |
213 | } |
214 | |
215 | if ( $value_sector->isa( 'DBM::Deep::Engine::Sector::Reference' ) ) { |
216 | $sector->write_data({ |
217 | key => $new_key, |
218 | key_md5 => $self->_apply_digest( $new_key ), |
219 | value => $value_sector, |
220 | }); |
221 | $value_sector->increment_refcount; |
222 | } |
223 | else { |
224 | $sector->write_data({ |
225 | key => $new_key, |
226 | key_md5 => $self->_apply_digest( $new_key ), |
227 | value => $value_sector->clone, |
228 | }); |
229 | } |
230 | } |
231 | |
2120a181 |
232 | sub key_exists { |
0d0f3d5d |
233 | my $self = shift; |
2120a181 |
234 | my ($obj, $key) = @_; |
0d0f3d5d |
235 | |
2120a181 |
236 | # This will be a Reference sector |
237 | my $sector = $self->_load_sector( $obj->_base_offset ) |
238 | or return ''; |
0d0f3d5d |
239 | |
2120a181 |
240 | if ( $sector->staleness != $obj->_staleness ) { |
241 | return ''; |
242 | } |
0d0f3d5d |
243 | |
2120a181 |
244 | my $data = $sector->get_data_for({ |
245 | key_md5 => $self->_apply_digest( $key ), |
246 | allow_head => 1, |
247 | }); |
20b7f047 |
248 | |
2120a181 |
249 | # exists() returns 1 or '' for true/false. |
250 | return $data ? 1 : ''; |
0d0f3d5d |
251 | } |
252 | |
2120a181 |
253 | sub delete_key { |
e064ccd1 |
254 | my $self = shift; |
2120a181 |
255 | my ($obj, $key) = @_; |
e064ccd1 |
256 | |
2120a181 |
257 | my $sector = $self->_load_sector( $obj->_base_offset ) |
258 | or return; |
460b1067 |
259 | |
2120a181 |
260 | if ( $sector->staleness != $obj->_staleness ) { |
261 | return; |
262 | } |
263 | |
264 | return $sector->delete_key({ |
265 | key_md5 => $self->_apply_digest( $key ), |
266 | allow_head => 0, |
267 | }); |
268 | } |
269 | |
270 | sub write_value { |
271 | my $self = shift; |
272 | my ($obj, $key, $value) = @_; |
273 | |
274 | my $r = Scalar::Util::reftype( $value ) || ''; |
275 | { |
276 | last if $r eq ''; |
277 | last if $r eq 'HASH'; |
278 | last if $r eq 'ARRAY'; |
e064ccd1 |
279 | |
2120a181 |
280 | DBM::Deep->_throw_error( |
281 | "Storage of references of type '$r' is not supported." |
282 | ); |
460b1067 |
283 | } |
260a80b4 |
284 | |
1cff45d7 |
285 | # This will be a Reference sector |
286 | my $sector = $self->_load_sector( $obj->_base_offset ) |
00d9bd0b |
287 | or DBM::Deep->_throw_error( "1: Cannot write to a deleted spot in DBM::Deep." ); |
1cff45d7 |
288 | |
289 | if ( $sector->staleness != $obj->_staleness ) { |
00d9bd0b |
290 | DBM::Deep->_throw_error( "2: Cannot write to a deleted spot in DBM::Deep." ); |
1cff45d7 |
291 | } |
292 | |
2120a181 |
293 | my ($class, $type); |
294 | if ( !defined $value ) { |
295 | $class = 'DBM::Deep::Engine::Sector::Null'; |
296 | } |
297 | elsif ( $r eq 'ARRAY' || $r eq 'HASH' ) { |
75a6a379 |
298 | my $tmpvar; |
299 | if ( $r eq 'ARRAY' ) { |
300 | $tmpvar = tied @$value; |
301 | } elsif ( $r eq 'HASH' ) { |
302 | $tmpvar = tied %$value; |
303 | } |
5ef7542f |
304 | |
edd45134 |
305 | if ( $tmpvar ) { |
306 | my $is_dbm_deep = eval { local $SIG{'__DIE__'}; $tmpvar->isa( 'DBM::Deep' ); }; |
307 | |
308 | unless ( $is_dbm_deep ) { |
309 | DBM::Deep->_throw_error( "Cannot store something that is tied." ); |
310 | } |
311 | |
d6d8e27e |
312 | unless ( $tmpvar->_engine->storage == $self->storage ) { |
75a6a379 |
313 | DBM::Deep->_throw_error( "Cannot store values across DBM::Deep files. Please use export() instead." ); |
5ef7542f |
314 | } |
5ef7542f |
315 | |
d6d8e27e |
316 | # First, verify if we're storing the same thing to this spot. If we are, then |
317 | # this should be a no-op. -EJS, 2008-05-19 |
318 | my $loc = $sector->get_data_location_for({ |
319 | key_md5 => $self->_apply_digest( $key ), |
320 | allow_head => 1, |
321 | }); |
322 | |
323 | if ( defined($loc) && $loc == $tmpvar->_base_offset ) { |
1cff45d7 |
324 | return 1; |
325 | } |
326 | |
edd45134 |
327 | #XXX Can this use $loc? |
d6d8e27e |
328 | my $value_sector = $self->_load_sector( $tmpvar->_base_offset ); |
329 | $sector->write_data({ |
330 | key => $key, |
331 | key_md5 => $self->_apply_digest( $key ), |
332 | value => $value_sector, |
333 | }); |
334 | $value_sector->increment_refcount; |
335 | |
336 | return 1; |
1cff45d7 |
337 | } |
edd45134 |
338 | |
2120a181 |
339 | $class = 'DBM::Deep::Engine::Sector::Reference'; |
340 | $type = substr( $r, 0, 1 ); |
341 | } |
342 | else { |
1cff45d7 |
343 | if ( tied($value) ) { |
344 | DBM::Deep->_throw_error( "Cannot store something that is tied." ); |
345 | } |
2120a181 |
346 | $class = 'DBM::Deep::Engine::Sector::Scalar'; |
460b1067 |
347 | } |
9b2370e0 |
348 | |
2120a181 |
349 | # Create this after loading the reference sector in case something bad happens. |
350 | # This way, we won't allocate value sector(s) needlessly. |
351 | my $value_sector = $class->new({ |
352 | engine => $self, |
353 | data => $value, |
354 | type => $type, |
355 | }); |
75a6a379 |
356 | |
2120a181 |
357 | $sector->write_data({ |
358 | key => $key, |
359 | key_md5 => $self->_apply_digest( $key ), |
360 | value => $value_sector, |
361 | }); |
362 | |
363 | # This code is to make sure we write all the values in the $value to the disk |
364 | # and to make sure all changes to $value after the assignment are reflected |
365 | # on disk. This may be counter-intuitive at first, but it is correct dwimmery. |
366 | # NOTE - simply tying $value won't perform a STORE on each value. Hence, the |
367 | # copy to a temp value. |
368 | if ( $r eq 'ARRAY' ) { |
369 | my @temp = @$value; |
370 | tie @$value, 'DBM::Deep', { |
371 | base_offset => $value_sector->offset, |
372 | staleness => $value_sector->staleness, |
373 | storage => $self->storage, |
374 | engine => $self, |
375 | }; |
376 | @$value = @temp; |
377 | bless $value, 'DBM::Deep::Array' unless Scalar::Util::blessed( $value ); |
e064ccd1 |
378 | } |
2120a181 |
379 | elsif ( $r eq 'HASH' ) { |
380 | my %temp = %$value; |
381 | tie %$value, 'DBM::Deep', { |
382 | base_offset => $value_sector->offset, |
383 | staleness => $value_sector->staleness, |
384 | storage => $self->storage, |
385 | engine => $self, |
386 | }; |
e064ccd1 |
387 | |
2120a181 |
388 | %$value = %temp; |
389 | bless $value, 'DBM::Deep::Hash' unless Scalar::Util::blessed( $value ); |
390 | } |
460b1067 |
391 | |
2120a181 |
392 | return 1; |
e064ccd1 |
393 | } |
394 | |
2120a181 |
395 | # XXX Add staleness here |
396 | sub get_next_key { |
460b1067 |
397 | my $self = shift; |
2120a181 |
398 | my ($obj, $prev_key) = @_; |
70b55428 |
399 | |
2120a181 |
400 | # XXX Need to add logic about resetting the iterator if any key in the reference has changed |
401 | unless ( $prev_key ) { |
402 | $obj->{iterator} = DBM::Deep::Iterator->new({ |
403 | base_offset => $obj->_base_offset, |
404 | engine => $self, |
405 | }); |
406 | } |
118ba343 |
407 | |
2120a181 |
408 | return $obj->{iterator}->get_next_key( $obj ); |
409 | } |
118ba343 |
410 | |
2120a181 |
411 | ################################################################################ |
260a80b4 |
412 | |
2120a181 |
413 | sub setup_fh { |
414 | my $self = shift; |
415 | my ($obj) = @_; |
359a01ac |
416 | |
00d9bd0b |
417 | return 1 if $obj->_base_offset; |
118ba343 |
418 | |
badf847c |
419 | my $header = $self->_load_header; |
118ba343 |
420 | |
00d9bd0b |
421 | # Creating a new file |
422 | if ( $header->is_new ) { |
423 | # 1) Create Array/Hash entry |
424 | my $sector = DBM::Deep::Engine::Sector::Reference->new({ |
425 | engine => $self, |
426 | type => $obj->_type, |
427 | }); |
428 | $obj->{base_offset} = $sector->offset; |
429 | $obj->{staleness} = $sector->staleness; |
118ba343 |
430 | |
00d9bd0b |
431 | $self->flush; |
432 | } |
433 | # Reading from an existing file |
434 | else { |
435 | $obj->{base_offset} = $header->size; |
436 | my $sector = DBM::Deep::Engine::Sector::Reference->new({ |
437 | engine => $self, |
438 | offset => $obj->_base_offset, |
439 | }); |
440 | unless ( $sector ) { |
441 | DBM::Deep->_throw_error("Corrupted file, no master index record"); |
118ba343 |
442 | } |
2120a181 |
443 | |
00d9bd0b |
444 | unless ($obj->_type eq $sector->type) { |
445 | DBM::Deep->_throw_error("File type mismatch"); |
118ba343 |
446 | } |
f1879fdc |
447 | |
00d9bd0b |
448 | $obj->{staleness} = $sector->staleness; |
118ba343 |
449 | } |
2120a181 |
450 | |
00d9bd0b |
451 | $self->storage->set_inode; |
452 | |
2120a181 |
453 | return 1; |
454 | } |
455 | |
456 | sub begin_work { |
457 | my $self = shift; |
458 | my ($obj) = @_; |
459 | |
460 | if ( $self->trans_id ) { |
461 | DBM::Deep->_throw_error( "Cannot begin_work within an active transaction" ); |
462 | } |
463 | |
464 | my @slots = $self->read_txn_slots; |
e9b0b5f0 |
465 | my $found; |
466 | for my $i ( 0 .. $#slots ) { |
2120a181 |
467 | next if $slots[$i]; |
e9b0b5f0 |
468 | |
2120a181 |
469 | $slots[$i] = 1; |
e9b0b5f0 |
470 | $self->set_trans_id( $i + 1 ); |
471 | $found = 1; |
2120a181 |
472 | last; |
473 | } |
e9b0b5f0 |
474 | unless ( $found ) { |
475 | DBM::Deep->_throw_error( "Cannot allocate transaction ID" ); |
476 | } |
2120a181 |
477 | $self->write_txn_slots( @slots ); |
478 | |
479 | if ( !$self->trans_id ) { |
480 | DBM::Deep->_throw_error( "Cannot begin_work - no available transactions" ); |
481 | } |
482 | |
483 | return; |
484 | } |
485 | |
486 | sub rollback { |
487 | my $self = shift; |
488 | my ($obj) = @_; |
489 | |
490 | if ( !$self->trans_id ) { |
491 | DBM::Deep->_throw_error( "Cannot rollback without an active transaction" ); |
492 | } |
493 | |
db2eb673 |
494 | foreach my $entry ( @{ $self->get_entries } ) { |
495 | my ($sector, $idx) = split ':', $entry; |
496 | $self->_load_sector( $sector )->rollback( $idx ); |
497 | } |
498 | |
2120a181 |
499 | $self->clear_entries; |
70b55428 |
500 | |
2120a181 |
501 | my @slots = $self->read_txn_slots; |
e9b0b5f0 |
502 | $slots[$self->trans_id-1] = 0; |
2120a181 |
503 | $self->write_txn_slots( @slots ); |
504 | $self->inc_txn_staleness_counter( $self->trans_id ); |
505 | $self->set_trans_id( 0 ); |
6fde4ed2 |
506 | |
70b55428 |
507 | return 1; |
508 | } |
509 | |
2120a181 |
510 | sub commit { |
16d1ad9b |
511 | my $self = shift; |
2120a181 |
512 | my ($obj) = @_; |
513 | |
514 | if ( !$self->trans_id ) { |
515 | DBM::Deep->_throw_error( "Cannot commit without an active transaction" ); |
516 | } |
517 | |
db2eb673 |
518 | foreach my $entry ( @{ $self->get_entries } ) { |
519 | my ($sector, $idx) = split ':', $entry; |
520 | $self->_load_sector( $sector )->commit( $idx ); |
521 | } |
522 | |
2120a181 |
523 | $self->clear_entries; |
524 | |
525 | my @slots = $self->read_txn_slots; |
e9b0b5f0 |
526 | $slots[$self->trans_id-1] = 0; |
2120a181 |
527 | $self->write_txn_slots( @slots ); |
528 | $self->inc_txn_staleness_counter( $self->trans_id ); |
529 | $self->set_trans_id( 0 ); |
530 | |
531 | return 1; |
16d1ad9b |
532 | } |
533 | |
2120a181 |
534 | sub read_txn_slots { |
d4b1166e |
535 | my $self = shift; |
d7f031fc |
536 | return $self->_load_header->read_txn_slots(@_); |
2120a181 |
537 | } |
20f7b20c |
538 | |
2120a181 |
539 | sub write_txn_slots { |
540 | my $self = shift; |
d7f031fc |
541 | return $self->_load_header->write_txn_slots(@_); |
2120a181 |
542 | } |
543 | |
544 | sub get_running_txn_ids { |
545 | my $self = shift; |
546 | my @transactions = $self->read_txn_slots; |
e9b0b5f0 |
547 | my @trans_ids = map { $_+1} grep { $transactions[$_] } 0 .. $#transactions; |
2120a181 |
548 | } |
549 | |
550 | sub get_txn_staleness_counter { |
551 | my $self = shift; |
d7f031fc |
552 | return $self->_load_header->get_txn_staleness_counter(@_); |
d4b1166e |
553 | } |
554 | |
2120a181 |
555 | sub inc_txn_staleness_counter { |
d4b1166e |
556 | my $self = shift; |
d7f031fc |
557 | return $self->_load_header->inc_txn_staleness_counter(@_); |
2120a181 |
558 | } |
20f7b20c |
559 | |
2120a181 |
560 | sub get_entries { |
561 | my $self = shift; |
562 | return [ keys %{ $self->{entries}{$self->trans_id} ||= {} } ]; |
d4b1166e |
563 | } |
564 | |
2120a181 |
565 | sub add_entry { |
ea2f6d67 |
566 | my $self = shift; |
db2eb673 |
567 | my ($trans_id, $loc, $idx) = @_; |
ea2f6d67 |
568 | |
97d40a0a |
569 | return unless $trans_id; |
570 | |
2120a181 |
571 | $self->{entries}{$trans_id} ||= {}; |
db2eb673 |
572 | $self->{entries}{$trans_id}{"$loc:$idx"} = undef; |
2120a181 |
573 | } |
ea2f6d67 |
574 | |
2120a181 |
575 | # If the buckets are being relocated because of a reindexing, the entries |
576 | # mechanism needs to be made aware of it. |
577 | sub reindex_entry { |
578 | my $self = shift; |
db2eb673 |
579 | my ($old_loc, $old_idx, $new_loc, $new_idx) = @_; |
2120a181 |
580 | |
581 | TRANS: |
582 | while ( my ($trans_id, $locs) = each %{ $self->{entries} } ) { |
db2eb673 |
583 | if ( exists $locs->{"$old_loc:$old_idx"} ) { |
584 | delete $locs->{"$old_loc:$old_idx"}; |
585 | $locs->{"$new_loc:$new_idx"} = undef; |
695c88b1 |
586 | next TRANS; |
2120a181 |
587 | } |
ea2f6d67 |
588 | } |
ea2f6d67 |
589 | } |
590 | |
2120a181 |
591 | sub clear_entries { |
d4b1166e |
592 | my $self = shift; |
2120a181 |
593 | delete $self->{entries}{$self->trans_id}; |
594 | } |
eea0d863 |
595 | |
2120a181 |
596 | ################################################################################ |
eea0d863 |
597 | |
2120a181 |
598 | sub _apply_digest { |
75be6413 |
599 | my $self = shift; |
2120a181 |
600 | return $self->{digest}->(@_); |
601 | } |
16d1ad9b |
602 | |
2120a181 |
603 | sub _add_free_blist_sector { shift->_add_free_sector( 0, @_ ) } |
badf847c |
604 | sub _add_free_data_sector { shift->_add_free_sector( 1, @_ ) } |
2120a181 |
605 | sub _add_free_index_sector { shift->_add_free_sector( 2, @_ ) } |
badf847c |
606 | sub _add_free_sector { shift->_load_header->add_free_sector( @_ ) } |
75be6413 |
607 | |
badf847c |
608 | sub _request_blist_sector { shift->_request_sector( 0, @_ ) } |
609 | sub _request_data_sector { shift->_request_sector( 1, @_ ) } |
610 | sub _request_index_sector { shift->_request_sector( 2, @_ ) } |
611 | sub _request_sector { shift->_load_header->request_sector( @_ ) } |
75be6413 |
612 | |
badf847c |
613 | ################################################################################ |
75be6413 |
614 | |
badf847c |
615 | { |
616 | my %t = ( |
617 | SIG_ARRAY => 'Reference', |
618 | SIG_HASH => 'Reference', |
619 | SIG_BLIST => 'BucketList', |
620 | SIG_INDEX => 'Index', |
621 | SIG_NULL => 'Null', |
622 | SIG_DATA => 'Scalar', |
623 | ); |
75be6413 |
624 | |
badf847c |
625 | my %class_for; |
626 | while ( my ($k,$v) = each %t ) { |
627 | $class_for{ DBM::Deep::Engine->$k } = "DBM::Deep::Engine::Sector::$v"; |
628 | } |
75be6413 |
629 | |
badf847c |
630 | sub load_sector { |
631 | my $self = shift; |
632 | my ($offset) = @_; |
75be6413 |
633 | |
badf847c |
634 | my $data = $self->get_data( $offset ) |
635 | or return;#die "Cannot read from '$offset'\n"; |
636 | my $type = substr( $$data, 0, 1 ); |
637 | my $class = $class_for{ $type }; |
638 | return $class->new({ |
639 | engine => $self, |
640 | type => $type, |
641 | offset => $offset, |
642 | }); |
643 | } |
644 | *_load_sector = \&load_sector; |
75be6413 |
645 | |
badf847c |
646 | sub load_header { |
647 | my $self = shift; |
75be6413 |
648 | |
badf847c |
649 | #XXX Does this mean we make too many objects? -RobK, 2008-06-23 |
650 | return DBM::Deep::Engine::Sector::FileHeader->new({ |
651 | engine => $self, |
652 | offset => 0, |
653 | }); |
654 | } |
655 | *_load_header = \&load_header; |
7b1e1aa1 |
656 | |
badf847c |
657 | sub get_data { |
658 | my $self = shift; |
659 | my ($offset, $size) = @_; |
660 | return unless defined $offset; |
75be6413 |
661 | |
badf847c |
662 | unless ( exists $self->sector_cache->{$offset} ) { |
663 | # Don't worry about the header sector. It will manage itself. |
664 | return unless $offset; |
2603d86e |
665 | |
badf847c |
666 | if ( !defined $size ) { |
667 | my $type = $self->storage->read_at( $offset, 1 ) |
668 | or die "($offset): Cannot read from '$offset' to find the type\n"; |
75be6413 |
669 | |
badf847c |
670 | if ( $type eq $self->SIG_FREE ) { |
671 | return; |
672 | } |
7b1e1aa1 |
673 | |
badf847c |
674 | my $class = $class_for{$type} |
675 | or die "($offset): Cannot find class for '$type'\n"; |
676 | $size = $class->size( $self ) |
677 | or die "($offset): '$class' doesn't return a size\n"; |
678 | $self->sector_cache->{$offset} = $type . $self->storage->read_at( undef, $size - 1 ); |
679 | } |
680 | else { |
681 | $self->sector_cache->{$offset} = $self->storage->read_at( $offset, $size ) |
682 | or return; |
683 | } |
684 | } |
7b1e1aa1 |
685 | |
badf847c |
686 | return \$self->sector_cache->{$offset}; |
7b1e1aa1 |
687 | } |
75be6413 |
688 | } |
689 | |
00d9bd0b |
690 | sub sector_cache { |
691 | my $self = shift; |
692 | return $self->{sector_cache} ||= {}; |
693 | } |
694 | |
695 | sub clear_sector_cache { |
696 | my $self = shift; |
697 | $self->{sector_cache} = {}; |
698 | } |
699 | |
a8d2331c |
700 | sub dirty_sectors { |
701 | my $self = shift; |
702 | return $self->{dirty_sectors} ||= {}; |
703 | } |
704 | |
00d9bd0b |
705 | sub clear_dirty_sectors { |
706 | my $self = shift; |
707 | $self->{dirty_sectors} = {}; |
708 | } |
709 | |
a8d2331c |
710 | sub add_dirty_sector { |
711 | my $self = shift; |
badf847c |
712 | my ($offset) = @_; |
a8d2331c |
713 | |
badf847c |
714 | $self->dirty_sectors->{ $offset } = undef; |
a8d2331c |
715 | } |
716 | |
a8d2331c |
717 | sub flush { |
718 | my $self = shift; |
719 | |
00d9bd0b |
720 | my $sectors = $self->dirty_sectors; |
721 | for my $offset (sort { $a <=> $b } keys %{ $sectors }) { |
badf847c |
722 | $self->storage->print_at( $offset, $self->sector_cache->{$offset} ); |
a8d2331c |
723 | } |
724 | |
d451590f |
725 | # Why do we need to have the storage flush? Shouldn't autoflush take care of things? |
726 | # -RobK, 2008-06-26 |
727 | $self->storage->flush; |
728 | |
a8d2331c |
729 | $self->clear_dirty_sectors; |
00d9bd0b |
730 | |
731 | $self->clear_sector_cache; |
a8d2331c |
732 | } |
733 | |
734 | ################################################################################ |
735 | |
f1879fdc |
736 | sub lock_exclusive { |
737 | my $self = shift; |
738 | my ($obj) = @_; |
739 | return $self->storage->lock_exclusive( $obj ); |
740 | } |
741 | |
742 | sub lock_shared { |
743 | my $self = shift; |
744 | my ($obj) = @_; |
745 | return $self->storage->lock_shared( $obj ); |
746 | } |
747 | |
748 | sub unlock { |
749 | my $self = shift; |
750 | my ($obj) = @_; |
a8d2331c |
751 | |
752 | my $rv = $self->storage->unlock( $obj ); |
753 | |
754 | $self->flush if $rv; |
755 | |
756 | return $rv; |
f1879fdc |
757 | } |
758 | |
759 | ################################################################################ |
760 | |
2120a181 |
761 | sub storage { $_[0]{storage} } |
762 | sub byte_size { $_[0]{byte_size} } |
763 | sub hash_size { $_[0]{hash_size} } |
764 | sub hash_chars { $_[0]{hash_chars} } |
765 | sub num_txns { $_[0]{num_txns} } |
766 | sub max_buckets { $_[0]{max_buckets} } |
767 | sub blank_md5 { chr(0) x $_[0]->hash_size } |
e9b0b5f0 |
768 | sub data_sector_size { $_[0]{data_sector_size} } |
769 | |
770 | # This is a calculated value |
771 | sub txn_bitfield_len { |
772 | my $self = shift; |
773 | unless ( exists $self->{txn_bitfield_len} ) { |
774 | my $temp = ($self->num_txns) / 8; |
775 | if ( $temp > int( $temp ) ) { |
776 | $temp = int( $temp ) + 1; |
777 | } |
778 | $self->{txn_bitfield_len} = $temp; |
779 | } |
780 | return $self->{txn_bitfield_len}; |
781 | } |
8db25060 |
782 | |
2120a181 |
783 | sub trans_id { $_[0]{trans_id} } |
784 | sub set_trans_id { $_[0]{trans_id} = $_[1] } |
8db25060 |
785 | |
2120a181 |
786 | sub trans_loc { $_[0]{trans_loc} } |
787 | sub set_trans_loc { $_[0]{trans_loc} = $_[1] } |
788 | |
789 | sub chains_loc { $_[0]{chains_loc} } |
790 | sub set_chains_loc { $_[0]{chains_loc} = $_[1] } |
791 | |
c57b19c6 |
792 | sub cache { $_[0]{cache} ||= {} } |
793 | sub clear_cache { %{$_[0]->cache} = () } |
794 | |
888453b9 |
795 | sub _dump_file { |
796 | my $self = shift; |
00d9bd0b |
797 | $self->flush; |
888453b9 |
798 | |
799 | # Read the header |
00d9bd0b |
800 | my $header_sector = DBM::Deep::Engine::Sector::FileHeader->new({ |
801 | engine => $self, |
802 | }); |
888453b9 |
803 | |
804 | my %types = ( |
805 | 0 => 'B', |
806 | 1 => 'D', |
807 | 2 => 'I', |
808 | ); |
809 | |
810 | my %sizes = ( |
811 | 'D' => $self->data_sector_size, |
812 | 'B' => DBM::Deep::Engine::Sector::BucketList->new({engine=>$self,offset=>1})->size, |
813 | 'I' => DBM::Deep::Engine::Sector::Index->new({engine=>$self,offset=>1})->size, |
814 | ); |
815 | |
816 | my $return = ""; |
c57b19c6 |
817 | |
a8d2331c |
818 | # Filesize |
819 | $return .= "Size: " . (-s $self->storage->{fh}) . $/; |
820 | |
c57b19c6 |
821 | # Header values |
822 | $return .= "NumTxns: " . $self->num_txns . $/; |
823 | |
888453b9 |
824 | # Read the free sector chains |
825 | my %sectors; |
826 | foreach my $multiple ( 0 .. 2 ) { |
827 | $return .= "Chains($types{$multiple}):"; |
828 | my $old_loc = $self->chains_loc + $multiple * $self->byte_size; |
829 | while ( 1 ) { |
830 | my $loc = unpack( |
831 | $StP{$self->byte_size}, |
832 | $self->storage->read_at( $old_loc, $self->byte_size ), |
833 | ); |
834 | |
835 | # We're now out of free sectors of this kind. |
836 | unless ( $loc ) { |
837 | last; |
838 | } |
839 | |
840 | $sectors{ $types{$multiple} }{ $loc } = undef; |
841 | $old_loc = $loc + SIG_SIZE + $STALE_SIZE; |
842 | $return .= " $loc"; |
843 | } |
844 | $return .= $/; |
845 | } |
846 | |
00d9bd0b |
847 | my $spot = $header_sector->size; |
888453b9 |
848 | SECTOR: |
849 | while ( $spot < $self->storage->{end} ) { |
850 | # Read each sector in order. |
851 | my $sector = $self->_load_sector( $spot ); |
852 | if ( !$sector ) { |
853 | # Find it in the free-sectors that were found already |
854 | foreach my $type ( keys %sectors ) { |
855 | if ( exists $sectors{$type}{$spot} ) { |
856 | my $size = $sizes{$type}; |
857 | $return .= sprintf "%08d: %s %04d\n", $spot, 'F' . $type, $size; |
858 | $spot += $size; |
859 | next SECTOR; |
860 | } |
861 | } |
862 | |
863 | die "********\n$return\nDidn't find free sector for $spot in chains\n********\n"; |
864 | } |
865 | else { |
866 | $return .= sprintf "%08d: %s %04d", $spot, $sector->type, $sector->size; |
867 | if ( $sector->type eq 'D' ) { |
868 | $return .= ' ' . $sector->data; |
869 | } |
870 | elsif ( $sector->type eq 'A' || $sector->type eq 'H' ) { |
871 | $return .= ' REF: ' . $sector->get_refcount; |
872 | } |
873 | elsif ( $sector->type eq 'B' ) { |
874 | foreach my $bucket ( $sector->chopped_up ) { |
875 | $return .= "\n "; |
876 | $return .= sprintf "%08d", unpack($StP{$self->byte_size}, |
877 | substr( $bucket->[-1], $self->hash_size, $self->byte_size), |
878 | ); |
c57b19c6 |
879 | my $l = unpack( $StP{$self->byte_size}, |
880 | substr( $bucket->[-1], |
881 | $self->hash_size + $self->byte_size, |
882 | $self->byte_size, |
883 | ), |
884 | ); |
885 | $return .= sprintf " %08d", $l; |
886 | foreach my $txn ( 0 .. $self->num_txns - 2 ) { |
888453b9 |
887 | my $l = unpack( $StP{$self->byte_size}, |
888 | substr( $bucket->[-1], |
c57b19c6 |
889 | $self->hash_size + 2 * $self->byte_size + $txn * ($self->byte_size + $STALE_SIZE), |
888453b9 |
890 | $self->byte_size, |
891 | ), |
892 | ); |
893 | $return .= sprintf " %08d", $l; |
894 | } |
895 | } |
896 | } |
897 | $return .= $/; |
898 | |
899 | $spot += $sector->size; |
900 | } |
901 | } |
902 | |
903 | return $return; |
904 | } |
905 | |
a20d9a3f |
906 | 1; |
907 | __END__ |