5819910a5b22d92877be516f8a19fa6b26911c0f
   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
   9#define GIT_TEST_COMMIT_GRAPH "GIT_TEST_COMMIT_GRAPH"
  10#define GIT_TEST_COMMIT_GRAPH_DIE_ON_LOAD "GIT_TEST_COMMIT_GRAPH_DIE_ON_LOAD"
  11
  12struct commit;
  13
  14char *get_commit_graph_filename(const char *obj_dir);
  15int open_commit_graph(const char *graph_file, int *fd, struct stat *st);
  16
  17/*
  18 * Given a commit struct, try to fill the commit struct info, including:
  19 *  1. tree object
  20 *  2. date
  21 *  3. parents.
  22 *
  23 * Returns 1 if and only if the commit was found in the packed graph.
  24 *
  25 * See parse_commit_buffer() for the fallback after this call.
  26 */
  27int parse_commit_in_graph(struct repository *r, struct commit *item);
  28
  29/*
  30 * It is possible that we loaded commit contents from the commit buffer,
  31 * but we also want to ensure the commit-graph content is correctly
  32 * checked and filled. Fill the graph_pos and generation members of
  33 * the given commit.
  34 */
  35void load_commit_graph_info(struct repository *r, struct commit *item);
  36
  37struct tree *get_commit_tree_in_graph(struct repository *r,
  38                                      const struct commit *c);
  39
  40struct commit_graph {
  41        int graph_fd;
  42
  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
  51        uint32_t num_commits_in_base;
  52        struct commit_graph *base_graph;
  53
  54        const uint32_t *chunk_oid_fanout;
  55        const unsigned char *chunk_oid_lookup;
  56        const unsigned char *chunk_commit_data;
  57        const unsigned char *chunk_extra_edges;
  58};
  59
  60struct commit_graph *load_commit_graph_one_fd_st(int fd, struct stat *st);
  61
  62struct commit_graph *parse_commit_graph(void *graph_map, int fd,
  63                                        size_t graph_size);
  64
  65/*
  66 * Return 1 if and only if the repository has a commit-graph
  67 * file and generation numbers are computed in that file.
  68 */
  69int generation_numbers_enabled(struct repository *r);
  70
  71#define COMMIT_GRAPH_APPEND     (1 << 0)
  72#define COMMIT_GRAPH_PROGRESS   (1 << 1)
  73
  74/*
  75 * The write_commit_graph* methods return zero on success
  76 * and a negative value on failure. Note that if the repository
  77 * is not compatible with the commit-graph feature, then the
  78 * methods will return 0 without writing a commit-graph.
  79 */
  80int write_commit_graph_reachable(const char *obj_dir, unsigned int flags);
  81int write_commit_graph(const char *obj_dir,
  82                       struct string_list *pack_indexes,
  83                       struct string_list *commit_hex,
  84                       unsigned int flags);
  85
  86int verify_commit_graph(struct repository *r, struct commit_graph *g);
  87
  88void close_commit_graph(struct raw_object_store *);
  89void free_commit_graph(struct commit_graph *);
  90
  91#endif