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