commit-graph.h

   1 #ifndef COMMIT_GRAPH_H
   2 #define COMMIT_GRAPH_H
   3
   4 #include "git-compat-util.h"
   5 #include "repository.h"
   6 #include "string-list.h"
   7 #include "cache.h"
   8 #include "object-store.h"
   9
  10 #define GIT_TEST_COMMIT_GRAPH "GIT_TEST_COMMIT_GRAPH"
  11 #define GIT_TEST_COMMIT_GRAPH_DIE_ON_LOAD "GIT_TEST_COMMIT_GRAPH_DIE_ON_LOAD"
  12 #define GIT_TEST_COMMIT_GRAPH_CHANGED_PATHS "GIT_TEST_COMMIT_GRAPH_CHANGED_PATHS"
  13
  14 struct commit;
  15 struct bloom_filter_settings;
  16
  17 char *get_commit_graph_filename(struct object_directory *odb);
  18 int open_commit_graph(const char *graph_file, int *fd, struct stat *st);
  19
  20 /*
  21  * Given a commit struct, try to fill the commit struct info, including:
  22  *  1. tree object
  23  *  2. date
  24  *  3. parents.
  25  *
  26  * Returns 1 if and only if the commit was found in the packed graph.
  27  *
  28  * See parse_commit_buffer() for the fallback after this call.
  29  */
  30 int parse_commit_in_graph(struct repository *r, struct commit *item);
  31
  32 /*
  33  * It is possible that we loaded commit contents from the commit buffer,
  34  * but we also want to ensure the commit-graph content is correctly
  35  * checked and filled. Fill the graph_pos and generation members of
  36  * the given commit.
  37  */
  38 void load_commit_graph_info(struct repository *r, struct commit *item);
  39
  40 struct tree *get_commit_tree_in_graph(struct repository *r,
  41                                       const struct commit *c);
  42
  43 struct commit_graph {
  44         int graph_fd;
  45
  46         const unsigned char *data;
  47         size_t data_len;
  48
  49         unsigned char hash_len;
  50         unsigned char num_chunks;
  51         uint32_t num_commits;
  52         struct object_id oid;
  53         char *filename;
  54         struct object_directory *odb;
  55
  56         uint32_t num_commits_in_base;
  57         struct commit_graph *base_graph;
  58
  59         const uint32_t *chunk_oid_fanout;
  60         const unsigned char *chunk_oid_lookup;
  61         const unsigned char *chunk_commit_data;
  62         const unsigned char *chunk_extra_edges;
  63         const unsigned char *chunk_base_graphs;
  64         const unsigned char *chunk_bloom_indexes;
  65         const unsigned char *chunk_bloom_data;
  66
  67         struct bloom_filter_settings *bloom_filter_settings;
  68 };
  69
  70 struct commit_graph *load_commit_graph_one_fd_st(int fd, struct stat *st,
  71                                                  struct object_directory *odb);
  72 struct commit_graph *read_commit_graph_one(struct repository *r,
  73                                            struct object_directory *odb);
  74 struct commit_graph *parse_commit_graph(void *graph_map, int fd,
  75                                         size_t graph_size);
  76
  77 /*
  78  * Return 1 if and only if the repository has a commit-graph
  79  * file and generation numbers are computed in that file.
  80  */
  81 int generation_numbers_enabled(struct repository *r);
  82
  83 enum commit_graph_write_flags {
  84         COMMIT_GRAPH_WRITE_APPEND     = (1 << 0),
  85         COMMIT_GRAPH_WRITE_PROGRESS   = (1 << 1),
  86         COMMIT_GRAPH_WRITE_SPLIT      = (1 << 2),
  87         /* Make sure that each OID in the input is a valid commit OID. */
  88         COMMIT_GRAPH_WRITE_CHECK_OIDS = (1 << 3),
  89         COMMIT_GRAPH_WRITE_BLOOM_FILTERS = (1 << 4),
  90 };
  91
  92 struct split_commit_graph_opts {
  93         int size_multiple;
  94         int max_commits;
  95         timestamp_t expire_time;
  96 };
  97
  98 /*
  99  * The write_commit_graph* methods return zero on success
 100  * and a negative value on failure. Note that if the repository
 101  * is not compatible with the commit-graph feature, then the
 102  * methods will return 0 without writing a commit-graph.
 103  */
 104 int write_commit_graph_reachable(struct object_directory *odb,
 105                                  enum commit_graph_write_flags flags,
 106                                  const struct split_commit_graph_opts *split_opts);
 107 int write_commit_graph(struct object_directory *odb,
 108                        struct string_list *pack_indexes,
 109                        struct string_list *commit_hex,
 110                        enum commit_graph_write_flags flags,
 111                        const struct split_commit_graph_opts *split_opts);
 112
 113 #define COMMIT_GRAPH_VERIFY_SHALLOW     (1 << 0)
 114
 115 int verify_commit_graph(struct repository *r, struct commit_graph *g, int flags);
 116
 117 void close_commit_graph(struct raw_object_store *);
 118 void free_commit_graph(struct commit_graph *);
 119
 120 /*
 121  * Disable further use of the commit graph in this process when parsing a
 122  * "struct commit".
 123  */
 124 void disable_commit_graph(struct repository *r);
 125
 126 #endif