gitfaq: files in .gitignore are tracked

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

diff --git a/commit-graph.h b/commit-graph.h
index 9db40b4d3aadb75b4dcea5027d07d373bdf169e1..4212766a4f0507f52fb5d4f42edbf1b977fc5cae 100644 (file)
--- a/commit-graph.h
+++ b/commit-graph.h
@@ -5,12 +5,27 @@
 #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);
 
 /*
  * Given a commit struct, try to fill the commit struct info, including:
@@ -36,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;
 
@@ -45,14 +58,28 @@ struct commit_graph {
        unsigned char num_chunks;
        uint32_t num_commits;
        struct object_id oid;
+       char *filename;
+       struct object_directory *odb;
+
+       uint32_t num_commits_in_base;
+       struct commit_graph *base_graph;
 
        const uint32_t *chunk_oid_fanout;
        const unsigned char *chunk_oid_lookup;
        const unsigned char *chunk_commit_data;
-       const unsigned char *chunk_large_edges;
+       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(const char *graph_file);
+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
@@ -60,16 +87,54 @@ struct commit_graph *load_commit_graph_one(const char *graph_file);
  */
 int generation_numbers_enabled(struct repository *r);
 
-void write_commit_graph_reachable(const char *obj_dir, int append,
-                                 int report_progress);
-void write_commit_graph(const char *obj_dir,
-                       struct string_list *pack_indexes,
-                       struct string_list *commit_hex,
-                       int append, int report_progress);
+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;
+};
+
+/*
+ * The write_commit_graph* methods return zero on success
+ * and a negative value on failure. Note that if the repository
+ * is not compatible with the commit-graph feature, then the
+ * methods will return 0 without writing a commit-graph.
+ */
+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(struct object_directory *odb,
+                      struct string_list *pack_indexes,
+                      struct oidset *commits,
+                      enum commit_graph_write_flags flags,
+                      const struct split_commit_graph_opts *split_opts);
 
-int verify_commit_graph(struct repository *r, struct commit_graph *g);
+#define COMMIT_GRAPH_VERIFY_SHALLOW    (1 << 0)
 
-void close_commit_graph(struct repository *);
+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