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