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