Merge branch 'ss/faq-ignore'

[thirdparty/git.git] / commit-graph.h

diff --git a/commit-graph.h b/commit-graph.h
index df9a3b20e4abc7d388acab1cc85546aafa8345a3..4212766a4f0507f52fb5d4f42edbf1b977fc5cae 100644 (file)
--- a/commit-graph.h
+++ b/commit-graph.h
@@ -5,13 +5,26 @@
 #include "repository.h"
 #include "string-list.h"
 #include "cache.h"
+#include "object-store.h"
+#include "oidset.h"
 
 #define GIT_TEST_COMMIT_GRAPH "GIT_TEST_COMMIT_GRAPH"
 #define GIT_TEST_COMMIT_GRAPH_DIE_ON_LOAD "GIT_TEST_COMMIT_GRAPH_DIE_ON_LOAD"
+#define GIT_TEST_COMMIT_GRAPH_CHANGED_PATHS "GIT_TEST_COMMIT_GRAPH_CHANGED_PATHS"
+
+/*
+ * This method is only used to enhance coverage of the commit-graph
+ * feature in the test suite with the GIT_TEST_COMMIT_GRAPH and
+ * GIT_TEST_COMMIT_GRAPH_CHANGED_PATHS environment variables. Do not
+ * call this method oustide of a builtin, and only if you know what
+ * you are doing!
+ */
+void git_test_write_commit_graph_or_die(void);
 
 struct commit;
+struct bloom_filter_settings;
 
-char *get_commit_graph_filename(const char *obj_dir);
+char *get_commit_graph_filename(struct object_directory *odb);
 int open_commit_graph(const char *graph_file, int *fd, struct stat *st);
 
 /*
@@ -38,8 +51,6 @@ struct tree *get_commit_tree_in_graph(struct repository *r,
                                      const struct commit *c);
 
 struct commit_graph {
-       int graph_fd;
-
        const unsigned char *data;
        size_t data_len;
 
@@ -48,7 +59,7 @@ struct commit_graph {
        uint32_t num_commits;
        struct object_id oid;
        char *filename;
-       const char *obj_dir;
+       struct object_directory *odb;
 
        uint32_t num_commits_in_base;
        struct commit_graph *base_graph;
@@ -58,12 +69,17 @@ struct commit_graph {
        const unsigned char *chunk_commit_data;
        const unsigned char *chunk_extra_edges;
        const unsigned char *chunk_base_graphs;
+       const unsigned char *chunk_bloom_indexes;
+       const unsigned char *chunk_bloom_data;
+
+       struct bloom_filter_settings *bloom_filter_settings;
 };
 
-struct commit_graph *load_commit_graph_one_fd_st(int fd, struct stat *st);
-struct commit_graph *read_commit_graph_one(struct repository *r, const char *obj_dir);
-struct commit_graph *parse_commit_graph(void *graph_map, int fd,
-                                       size_t graph_size);
+struct commit_graph *load_commit_graph_one_fd_st(int fd, struct stat *st,
+                                                struct object_directory *odb);
+struct commit_graph *read_commit_graph_one(struct repository *r,
+                                          struct object_directory *odb);
+struct commit_graph *parse_commit_graph(void *graph_map, size_t graph_size);
 
 /*
  * Return 1 if and only if the repository has a commit-graph
@@ -71,14 +87,26 @@ struct commit_graph *parse_commit_graph(void *graph_map, int fd,
  */
 int generation_numbers_enabled(struct repository *r);
 
-#define COMMIT_GRAPH_APPEND     (1 << 0)
-#define COMMIT_GRAPH_PROGRESS   (1 << 1)
-#define COMMIT_GRAPH_SPLIT      (1 << 2)
+enum commit_graph_write_flags {
+       COMMIT_GRAPH_WRITE_APPEND     = (1 << 0),
+       COMMIT_GRAPH_WRITE_PROGRESS   = (1 << 1),
+       COMMIT_GRAPH_WRITE_SPLIT      = (1 << 2),
+       /* Make sure that each OID in the input is a valid commit OID. */
+       COMMIT_GRAPH_WRITE_CHECK_OIDS = (1 << 3),
+       COMMIT_GRAPH_WRITE_BLOOM_FILTERS = (1 << 4),
+};
+
+enum commit_graph_split_flags {
+       COMMIT_GRAPH_SPLIT_UNSPECIFIED      = 0,
+       COMMIT_GRAPH_SPLIT_MERGE_PROHIBITED = 1,
+       COMMIT_GRAPH_SPLIT_REPLACE          = 2
+};
 
 struct split_commit_graph_opts {
        int size_multiple;
        int max_commits;
        timestamp_t expire_time;
+       enum commit_graph_split_flags flags;
 };
 
 /*
@@ -87,12 +115,13 @@ struct split_commit_graph_opts {
  * is not compatible with the commit-graph feature, then the
  * methods will return 0 without writing a commit-graph.
  */
-int write_commit_graph_reachable(const char *obj_dir, unsigned int flags,
+int write_commit_graph_reachable(struct object_directory *odb,
+                                enum commit_graph_write_flags flags,
                                 const struct split_commit_graph_opts *split_opts);
-int write_commit_graph(const char *obj_dir,
+int write_commit_graph(struct object_directory *odb,
                       struct string_list *pack_indexes,
-                      struct string_list *commit_hex,
-                      unsigned int flags,
+                      struct oidset *commits,
+                      enum commit_graph_write_flags flags,
                       const struct split_commit_graph_opts *split_opts);
 
 #define COMMIT_GRAPH_VERIFY_SHALLOW    (1 << 0)
@@ -102,4 +131,10 @@ int verify_commit_graph(struct repository *r, struct commit_graph *g, int flags)
 void close_commit_graph(struct raw_object_store *);
 void free_commit_graph(struct commit_graph *);
 
+/*
+ * Disable further use of the commit graph in this process when parsing a
+ * "struct commit".
+ */
+void disable_commit_graph(struct repository *r);
+
 #endif