2 Copyright 2020 Google LLC
4 Use of this source code is governed by a BSD-style
5 license that can be found in the LICENSE file or at
6 https://developers.google.com/open-source/licenses/bsd
13 #include "constants.h"
17 #include "reftable-error.h"
18 #include "reftable-generic.h"
21 uint64_t block_source_size(struct reftable_block_source
*source
)
23 return source
->ops
->size(source
->arg
);
26 int block_source_read_block(struct reftable_block_source
*source
,
27 struct reftable_block
*dest
, uint64_t off
,
30 int result
= source
->ops
->read_block(source
->arg
, dest
, off
, size
);
31 dest
->source
= *source
;
35 void block_source_close(struct reftable_block_source
*source
)
41 source
->ops
->close(source
->arg
);
45 static struct reftable_reader_offsets
*
46 reader_offsets_for(struct reftable_reader
*r
, uint8_t typ
)
50 return &r
->ref_offsets
;
52 return &r
->log_offsets
;
54 return &r
->obj_offsets
;
59 static int reader_get_block(struct reftable_reader
*r
,
60 struct reftable_block
*dest
, uint64_t off
,
66 if (off
+ sz
> r
->size
) {
70 return block_source_read_block(&r
->source
, dest
, off
, sz
);
73 uint32_t reftable_reader_hash_id(struct reftable_reader
*r
)
78 const char *reader_name(struct reftable_reader
*r
)
83 static int parse_footer(struct reftable_reader
*r
, uint8_t *footer
,
87 uint8_t first_block_typ
;
89 uint32_t computed_crc
;
92 if (memcmp(f
, "REFT", 4)) {
93 err
= REFTABLE_FORMAT_ERROR
;
98 if (memcmp(footer
, header
, header_size(r
->version
))) {
99 err
= REFTABLE_FORMAT_ERROR
;
104 r
->block_size
= get_be24(f
);
107 r
->min_update_index
= get_be64(f
);
109 r
->max_update_index
= get_be64(f
);
112 if (r
->version
== 1) {
113 r
->hash_id
= GIT_SHA1_FORMAT_ID
;
115 r
->hash_id
= get_be32(f
);
116 switch (r
->hash_id
) {
117 case GIT_SHA1_FORMAT_ID
:
119 case GIT_SHA256_FORMAT_ID
:
122 err
= REFTABLE_FORMAT_ERROR
;
128 r
->ref_offsets
.index_offset
= get_be64(f
);
131 r
->obj_offsets
.offset
= get_be64(f
);
134 r
->object_id_len
= r
->obj_offsets
.offset
& ((1 << 5) - 1);
135 r
->obj_offsets
.offset
>>= 5;
137 r
->obj_offsets
.index_offset
= get_be64(f
);
139 r
->log_offsets
.offset
= get_be64(f
);
141 r
->log_offsets
.index_offset
= get_be64(f
);
144 computed_crc
= crc32(0, footer
, f
- footer
);
145 file_crc
= get_be32(f
);
147 if (computed_crc
!= file_crc
) {
148 err
= REFTABLE_FORMAT_ERROR
;
152 first_block_typ
= header
[header_size(r
->version
)];
153 r
->ref_offsets
.is_present
= (first_block_typ
== BLOCK_TYPE_REF
);
154 r
->ref_offsets
.offset
= 0;
155 r
->log_offsets
.is_present
= (first_block_typ
== BLOCK_TYPE_LOG
||
156 r
->log_offsets
.offset
> 0);
157 r
->obj_offsets
.is_present
= r
->obj_offsets
.offset
> 0;
158 if (r
->obj_offsets
.is_present
&& !r
->object_id_len
) {
159 err
= REFTABLE_FORMAT_ERROR
;
168 int init_reader(struct reftable_reader
*r
, struct reftable_block_source
*source
,
171 struct reftable_block footer
= { NULL
};
172 struct reftable_block header
= { NULL
};
174 uint64_t file_size
= block_source_size(source
);
176 /* Need +1 to read type of first block. */
177 uint32_t read_size
= header_size(2) + 1; /* read v2 because it's larger. */
178 memset(r
, 0, sizeof(struct reftable_reader
));
180 if (read_size
> file_size
) {
181 err
= REFTABLE_FORMAT_ERROR
;
185 err
= block_source_read_block(source
, &header
, 0, read_size
);
186 if (err
!= read_size
) {
187 err
= REFTABLE_IO_ERROR
;
191 if (memcmp(header
.data
, "REFT", 4)) {
192 err
= REFTABLE_FORMAT_ERROR
;
195 r
->version
= header
.data
[4];
196 if (r
->version
!= 1 && r
->version
!= 2) {
197 err
= REFTABLE_FORMAT_ERROR
;
201 r
->size
= file_size
- footer_size(r
->version
);
203 r
->name
= xstrdup(name
);
206 err
= block_source_read_block(source
, &footer
, r
->size
,
207 footer_size(r
->version
));
208 if (err
!= footer_size(r
->version
)) {
209 err
= REFTABLE_IO_ERROR
;
213 err
= parse_footer(r
, footer
.data
, header
.data
);
215 reftable_block_done(&footer
);
216 reftable_block_done(&header
);
221 struct reftable_reader
*r
;
224 struct block_iter bi
;
227 #define TABLE_ITER_INIT \
229 .bi = {.last_key = STRBUF_INIT } \
232 static void table_iter_copy_from(struct table_iter
*dest
,
233 struct table_iter
*src
)
236 dest
->typ
= src
->typ
;
237 dest
->block_off
= src
->block_off
;
238 dest
->is_finished
= src
->is_finished
;
239 block_iter_copy_from(&dest
->bi
, &src
->bi
);
242 static int table_iter_next_in_block(struct table_iter
*ti
,
243 struct reftable_record
*rec
)
245 int res
= block_iter_next(&ti
->bi
, rec
);
246 if (res
== 0 && reftable_record_type(rec
) == BLOCK_TYPE_REF
) {
247 rec
->u
.ref
.update_index
+= ti
->r
->min_update_index
;
253 static void table_iter_block_done(struct table_iter
*ti
)
258 reftable_block_done(&ti
->bi
.br
->block
);
259 FREE_AND_NULL(ti
->bi
.br
);
261 ti
->bi
.last_key
.len
= 0;
265 static int32_t extract_block_size(uint8_t *data
, uint8_t *typ
, uint64_t off
,
271 data
+= header_size(version
);
275 if (reftable_is_block_type(*typ
)) {
276 result
= get_be24(data
+ 1);
281 int reader_init_block_reader(struct reftable_reader
*r
, struct block_reader
*br
,
282 uint64_t next_off
, uint8_t want_typ
)
284 int32_t guess_block_size
= r
->block_size
? r
->block_size
:
286 struct reftable_block block
= { NULL
};
287 uint8_t block_typ
= 0;
289 uint32_t header_off
= next_off
? 0 : header_size(r
->version
);
290 int32_t block_size
= 0;
292 if (next_off
>= r
->size
)
295 err
= reader_get_block(r
, &block
, next_off
, guess_block_size
);
299 block_size
= extract_block_size(block
.data
, &block_typ
, next_off
,
301 if (block_size
< 0) {
305 if (want_typ
!= BLOCK_TYPE_ANY
&& block_typ
!= want_typ
) {
310 if (block_size
> guess_block_size
) {
311 reftable_block_done(&block
);
312 err
= reader_get_block(r
, &block
, next_off
, block_size
);
318 err
= block_reader_init(br
, &block
, header_off
, r
->block_size
,
319 hash_size(r
->hash_id
));
321 reftable_block_done(&block
);
326 static int table_iter_next_block(struct table_iter
*dest
,
327 struct table_iter
*src
)
329 uint64_t next_block_off
= src
->block_off
+ src
->bi
.br
->full_block_size
;
330 struct block_reader br
= { 0 };
334 dest
->typ
= src
->typ
;
335 dest
->block_off
= next_block_off
;
337 err
= reader_init_block_reader(src
->r
, &br
, next_block_off
, src
->typ
);
339 dest
->is_finished
= 1;
345 struct block_reader
*brp
=
346 reftable_malloc(sizeof(struct block_reader
));
349 dest
->is_finished
= 0;
350 block_reader_start(brp
, &dest
->bi
);
355 static int table_iter_next(struct table_iter
*ti
, struct reftable_record
*rec
)
357 if (reftable_record_type(rec
) != ti
->typ
)
358 return REFTABLE_API_ERROR
;
361 struct table_iter next
= TABLE_ITER_INIT
;
363 if (ti
->is_finished
) {
367 err
= table_iter_next_in_block(ti
, rec
);
372 err
= table_iter_next_block(&next
, ti
);
376 table_iter_block_done(ti
);
380 table_iter_copy_from(ti
, &next
);
381 block_iter_close(&next
.bi
);
385 static int table_iter_next_void(void *ti
, struct reftable_record
*rec
)
387 return table_iter_next(ti
, rec
);
390 static void table_iter_close(void *p
)
392 struct table_iter
*ti
= p
;
393 table_iter_block_done(ti
);
394 block_iter_close(&ti
->bi
);
397 static struct reftable_iterator_vtable table_iter_vtable
= {
398 .next
= &table_iter_next_void
,
399 .close
= &table_iter_close
,
402 static void iterator_from_table_iter(struct reftable_iterator
*it
,
403 struct table_iter
*ti
)
407 it
->ops
= &table_iter_vtable
;
410 static int reader_table_iter_at(struct reftable_reader
*r
,
411 struct table_iter
*ti
, uint64_t off
,
414 struct block_reader br
= { 0 };
415 struct block_reader
*brp
= NULL
;
417 int err
= reader_init_block_reader(r
, &br
, off
, typ
);
421 brp
= reftable_malloc(sizeof(struct block_reader
));
424 ti
->typ
= block_reader_type(brp
);
426 block_reader_start(brp
, &ti
->bi
);
430 static int reader_start(struct reftable_reader
*r
, struct table_iter
*ti
,
431 uint8_t typ
, int index
)
433 struct reftable_reader_offsets
*offs
= reader_offsets_for(r
, typ
);
434 uint64_t off
= offs
->offset
;
436 off
= offs
->index_offset
;
440 typ
= BLOCK_TYPE_INDEX
;
443 return reader_table_iter_at(r
, ti
, off
, typ
);
446 static int reader_seek_linear(struct reftable_reader
*r
, struct table_iter
*ti
,
447 struct reftable_record
*want
)
449 struct reftable_record rec
=
450 reftable_new_record(reftable_record_type(want
));
451 struct strbuf want_key
= STRBUF_INIT
;
452 struct strbuf got_key
= STRBUF_INIT
;
453 struct table_iter next
= TABLE_ITER_INIT
;
456 reftable_record_key(want
, &want_key
);
459 err
= table_iter_next_block(&next
, ti
);
467 err
= block_reader_first_key(next
.bi
.br
, &got_key
);
471 if (strbuf_cmp(&got_key
, &want_key
) > 0) {
472 table_iter_block_done(&next
);
476 table_iter_block_done(ti
);
477 table_iter_copy_from(ti
, &next
);
480 err
= block_iter_seek(&ti
->bi
, &want_key
);
486 block_iter_close(&next
.bi
);
487 reftable_record_release(&rec
);
488 strbuf_release(&want_key
);
489 strbuf_release(&got_key
);
493 static int reader_seek_indexed(struct reftable_reader
*r
,
494 struct reftable_iterator
*it
,
495 struct reftable_record
*rec
)
497 struct reftable_record want_index
= {
498 .type
= BLOCK_TYPE_INDEX
, .u
.idx
= { .last_key
= STRBUF_INIT
}
500 struct reftable_record index_result
= {
501 .type
= BLOCK_TYPE_INDEX
,
502 .u
.idx
= { .last_key
= STRBUF_INIT
},
504 struct table_iter index_iter
= TABLE_ITER_INIT
;
505 struct table_iter next
= TABLE_ITER_INIT
;
508 reftable_record_key(rec
, &want_index
.u
.idx
.last_key
);
509 err
= reader_start(r
, &index_iter
, reftable_record_type(rec
), 1);
513 err
= reader_seek_linear(r
, &index_iter
, &want_index
);
515 err
= table_iter_next(&index_iter
, &index_result
);
516 table_iter_block_done(&index_iter
);
520 err
= reader_table_iter_at(r
, &next
, index_result
.u
.idx
.offset
,
525 err
= block_iter_seek(&next
.bi
, &want_index
.u
.idx
.last_key
);
529 if (next
.typ
== reftable_record_type(rec
)) {
534 if (next
.typ
!= BLOCK_TYPE_INDEX
) {
535 err
= REFTABLE_FORMAT_ERROR
;
539 table_iter_copy_from(&index_iter
, &next
);
543 struct table_iter empty
= TABLE_ITER_INIT
;
544 struct table_iter
*malloced
=
545 reftable_calloc(sizeof(struct table_iter
));
547 table_iter_copy_from(malloced
, &next
);
548 iterator_from_table_iter(it
, malloced
);
551 block_iter_close(&next
.bi
);
552 table_iter_close(&index_iter
);
553 reftable_record_release(&want_index
);
554 reftable_record_release(&index_result
);
558 static int reader_seek_internal(struct reftable_reader
*r
,
559 struct reftable_iterator
*it
,
560 struct reftable_record
*rec
)
562 struct reftable_reader_offsets
*offs
=
563 reader_offsets_for(r
, reftable_record_type(rec
));
564 uint64_t idx
= offs
->index_offset
;
565 struct table_iter ti
= TABLE_ITER_INIT
;
568 return reader_seek_indexed(r
, it
, rec
);
570 err
= reader_start(r
, &ti
, reftable_record_type(rec
), 0);
573 err
= reader_seek_linear(r
, &ti
, rec
);
577 struct table_iter
*p
=
578 reftable_malloc(sizeof(struct table_iter
));
580 iterator_from_table_iter(it
, p
);
586 static int reader_seek(struct reftable_reader
*r
, struct reftable_iterator
*it
,
587 struct reftable_record
*rec
)
589 uint8_t typ
= reftable_record_type(rec
);
591 struct reftable_reader_offsets
*offs
= reader_offsets_for(r
, typ
);
592 if (!offs
->is_present
) {
593 iterator_set_empty(it
);
597 return reader_seek_internal(r
, it
, rec
);
600 int reftable_reader_seek_ref(struct reftable_reader
*r
,
601 struct reftable_iterator
*it
, const char *name
)
603 struct reftable_record rec
= {
604 .type
= BLOCK_TYPE_REF
,
606 .refname
= (char *)name
,
609 return reader_seek(r
, it
, &rec
);
612 int reftable_reader_seek_log_at(struct reftable_reader
*r
,
613 struct reftable_iterator
*it
, const char *name
,
614 uint64_t update_index
)
616 struct reftable_record rec
= { .type
= BLOCK_TYPE_LOG
,
618 .refname
= (char *)name
,
619 .update_index
= update_index
,
621 return reader_seek(r
, it
, &rec
);
624 int reftable_reader_seek_log(struct reftable_reader
*r
,
625 struct reftable_iterator
*it
, const char *name
)
627 uint64_t max
= ~((uint64_t)0);
628 return reftable_reader_seek_log_at(r
, it
, name
, max
);
631 void reader_close(struct reftable_reader
*r
)
633 block_source_close(&r
->source
);
634 FREE_AND_NULL(r
->name
);
637 int reftable_new_reader(struct reftable_reader
**p
,
638 struct reftable_block_source
*src
, char const *name
)
640 struct reftable_reader
*rd
=
641 reftable_calloc(sizeof(struct reftable_reader
));
642 int err
= init_reader(rd
, src
, name
);
646 block_source_close(src
);
652 void reftable_reader_free(struct reftable_reader
*r
)
660 static int reftable_reader_refs_for_indexed(struct reftable_reader
*r
,
661 struct reftable_iterator
*it
,
664 struct reftable_record want
= {
665 .type
= BLOCK_TYPE_OBJ
,
668 .hash_prefix_len
= r
->object_id_len
,
671 struct reftable_iterator oit
= { NULL
};
672 struct reftable_record got
= {
673 .type
= BLOCK_TYPE_OBJ
,
677 struct indexed_table_ref_iter
*itr
= NULL
;
679 /* Look through the reverse index. */
680 err
= reader_seek(r
, &oit
, &want
);
684 /* read out the reftable_obj_record */
685 err
= iterator_next(&oit
, &got
);
689 if (err
> 0 || memcmp(want
.u
.obj
.hash_prefix
, got
.u
.obj
.hash_prefix
,
691 /* didn't find it; return empty iterator */
692 iterator_set_empty(it
);
697 err
= new_indexed_table_ref_iter(&itr
, r
, oid
, hash_size(r
->hash_id
),
699 got
.u
.obj
.offset_len
);
702 got
.u
.obj
.offsets
= NULL
;
703 iterator_from_indexed_table_ref_iter(it
, itr
);
706 reftable_iterator_destroy(&oit
);
707 reftable_record_release(&got
);
711 static int reftable_reader_refs_for_unindexed(struct reftable_reader
*r
,
712 struct reftable_iterator
*it
,
715 struct table_iter ti_empty
= TABLE_ITER_INIT
;
716 struct table_iter
*ti
= reftable_calloc(sizeof(struct table_iter
));
717 struct filtering_ref_iterator
*filter
= NULL
;
718 struct filtering_ref_iterator empty
= FILTERING_REF_ITERATOR_INIT
;
719 int oid_len
= hash_size(r
->hash_id
);
723 err
= reader_start(r
, ti
, BLOCK_TYPE_REF
, 0);
729 filter
= reftable_malloc(sizeof(struct filtering_ref_iterator
));
732 strbuf_add(&filter
->oid
, oid
, oid_len
);
733 reftable_table_from_reader(&filter
->tab
, r
);
734 filter
->double_check
= 0;
735 iterator_from_table_iter(&filter
->it
, ti
);
737 iterator_from_filtering_ref_iterator(it
, filter
);
741 int reftable_reader_refs_for(struct reftable_reader
*r
,
742 struct reftable_iterator
*it
, uint8_t *oid
)
744 if (r
->obj_offsets
.is_present
)
745 return reftable_reader_refs_for_indexed(r
, it
, oid
);
746 return reftable_reader_refs_for_unindexed(r
, it
, oid
);
749 uint64_t reftable_reader_max_update_index(struct reftable_reader
*r
)
751 return r
->max_update_index
;
754 uint64_t reftable_reader_min_update_index(struct reftable_reader
*r
)
756 return r
->min_update_index
;
759 /* generic table interface. */
761 static int reftable_reader_seek_void(void *tab
, struct reftable_iterator
*it
,
762 struct reftable_record
*rec
)
764 return reader_seek(tab
, it
, rec
);
767 static uint32_t reftable_reader_hash_id_void(void *tab
)
769 return reftable_reader_hash_id(tab
);
772 static uint64_t reftable_reader_min_update_index_void(void *tab
)
774 return reftable_reader_min_update_index(tab
);
777 static uint64_t reftable_reader_max_update_index_void(void *tab
)
779 return reftable_reader_max_update_index(tab
);
782 static struct reftable_table_vtable reader_vtable
= {
783 .seek_record
= reftable_reader_seek_void
,
784 .hash_id
= reftable_reader_hash_id_void
,
785 .min_update_index
= reftable_reader_min_update_index_void
,
786 .max_update_index
= reftable_reader_max_update_index_void
,
789 void reftable_table_from_reader(struct reftable_table
*tab
,
790 struct reftable_reader
*reader
)
793 tab
->ops
= &reader_vtable
;
794 tab
->table_arg
= reader
;
798 int reftable_reader_print_file(const char *tablename
)
800 struct reftable_block_source src
= { NULL
};
801 int err
= reftable_block_source_from_file(&src
, tablename
);
802 struct reftable_reader
*r
= NULL
;
803 struct reftable_table tab
= { NULL
};
807 err
= reftable_new_reader(&r
, &src
, tablename
);
811 reftable_table_from_reader(&tab
, r
);
812 err
= reftable_table_print(&tab
);
814 reftable_reader_free(r
);