FilesExpand file tree

 master

/

reftable-table.h

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

116 lines (93 loc) · 3.5 KB

 master

/

reftable-table.h

Copy path

Top

File metadata and controls

• Code
• Blame

116 lines (93 loc) · 3.5 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

/*

* Copyright 2020 Google LLC

*

* Use of this source code is governed by a BSD-style

* license that can be found in the LICENSE file or at

* https://developers.google.com/open-source/licenses/bsd

*/

#ifndef REFTABLE_TABLE_H

#define REFTABLE_TABLE_H

#include "reftable-system.h"

#include "reftable-iterator.h"

#include "reftable-block.h"

#include "reftable-blocksource.h"

/*

* Reading single tables

*

* The follow routines are for reading single files. For an

* application-level interface, skip ahead to struct

* reftable_merged_table and struct reftable_stack.

*/

/* Metadata for a block type. */

struct reftable_table_offsets {

int is_present;

uint64_t offset;

uint64_t index_offset;

};

/* The table struct is a handle to an open reftable file. */

struct reftable_table {

/* for convenience, associate a name with the instance. */

char *name;

struct reftable_block_source source;

/* Size of the file, excluding the footer. */

uint64_t size;

/* The hash function used for ref records. */

enum reftable_hash hash_id;

uint32_t block_size;

uint64_t min_update_index;

uint64_t max_update_index;

/* Length of the OID keys in the 'o' section */

int object_id_len;

int version;

struct reftable_table_offsets ref_offsets;

struct reftable_table_offsets obj_offsets;

struct reftable_table_offsets log_offsets;

uint64_t refcount;

};

/* reftable_table_new opens a reftable for reading. If successful,

* returns 0 code and sets pp. The name is used for creating a

* stack. Typically, it is the basename of the file. The block source

* `src` is owned by the table, and is closed on calling

* reftable_table_destroy(). On error, the block source `src` is

* closed as well.

*/

int reftable_table_new(struct reftable_table **out,

struct reftable_block_source *src, const char *name);

/*

* Manage the reference count of the reftable table. A newly initialized

* table starts with a refcount of 1 and will be deleted once the refcount has

* reached 0.

*

* This is required because tables may have longer lifetimes than the stack

* they belong to. The stack may for example be reloaded while the old tables

* are still being accessed by an iterator.

*/

void reftable_table_incref(struct reftable_table *table);

void reftable_table_decref(struct reftable_table *table);

/* Initialize a reftable iterator for reading refs. */

int reftable_table_init_ref_iterator(struct reftable_table *t,

struct reftable_iterator *it);

/* Initialize a reftable iterator for reading logs. */

int reftable_table_init_log_iterator(struct reftable_table *t,

struct reftable_iterator *it);

/* returns the hash ID used in this table. */

enum reftable_hash reftable_table_hash_id(struct reftable_table *t);

/* return an iterator for the refs pointing to `oid`. */

int reftable_table_refs_for(struct reftable_table *t,

struct reftable_iterator *it, uint8_t *oid);

/* return the max_update_index for a table */

uint64_t reftable_table_max_update_index(struct reftable_table *t);

/* return the min_update_index for a table */

uint64_t reftable_table_min_update_index(struct reftable_table *t);

/*

* An iterator that iterates through the blocks contained in a given table.

*/

struct reftable_table_iterator {

void *iter_arg;

};

int reftable_table_iterator_init(struct reftable_table_iterator *it,

struct reftable_table *t);

void reftable_table_iterator_release(struct reftable_table_iterator *it);

int reftable_table_iterator_next(struct reftable_table_iterator *it,

const struct reftable_block **out);

#endif