commit-graph verify: detect inability to read the graph
[git/git.git] / commit.h
CommitLineData
6eb8ae00
DB
1#ifndef COMMIT_H
2#define COMMIT_H
3
4#include "object.h"
5#include "tree.h"
674d1727 6#include "strbuf.h"
ca135e7a 7#include "decorate.h"
ffb6d7d5 8#include "gpg-interface.h"
a9080475 9#include "string-list.h"
cf394719 10#include "pretty.h"
5284fc5c 11#include "commit-slab.h"
6eb8ae00 12
177722b3 13#define COMMIT_NOT_FROM_GRAPH 0xFFFFFFFF
83073cc9
DS
14#define GENERATION_NUMBER_INFINITY 0xFFFFFFFF
15#define GENERATION_NUMBER_MAX 0x3FFFFFFF
16#define GENERATION_NUMBER_ZERO 0
177722b3 17
6eb8ae00
DB
18struct commit_list {
19 struct commit *item;
20 struct commit_list *next;
21};
22
9d2c9701
NTND
23/*
24 * The size of this struct matters in full repo walk operations like
25 * 'git clone' or 'git gc'. Consider using commit-slab to attach data
26 * to a commit instead of adding new fields here.
27 */
6eb8ae00
DB
28struct commit {
29 struct object object;
dddbad72 30 timestamp_t date;
6eb8ae00 31 struct commit_list *parents;
7b8a21db
DS
32
33 /*
34 * If the commit is loaded from the commit-graph file, then this
35 * member may be NULL. Only access it through get_commit_tree()
36 * or get_commit_tree_oid().
37 */
891435d5 38 struct tree *maybe_tree;
177722b3 39 uint32_t graph_pos;
83073cc9 40 uint32_t generation;
25f859fd 41 unsigned int index;
6eb8ae00
DB
42};
43
60ab26de 44extern int save_commit_buffer;
6eb8ae00
DB
45extern const char *commit_type;
46
ca135e7a 47/* While we can decorate any object with a name, it's only used for commits.. */
ca135e7a
LT
48struct name_decoration {
49 struct name_decoration *next;
eb3005e2 50 int type;
2e3dfb21 51 char name[FLEX_ARRAY];
ca135e7a
LT
52};
53
662174d2
JK
54enum decoration_type {
55 DECORATION_NONE = 0,
56 DECORATION_REF_LOCAL,
57 DECORATION_REF_REMOTE,
58 DECORATION_REF_TAG,
59 DECORATION_REF_STASH,
60 DECORATION_REF_HEAD,
61 DECORATION_GRAFTED,
62};
63
64void add_name_decoration(enum decoration_type type, const char *name, struct object *obj);
2608c249 65const struct name_decoration *get_name_decoration(const struct object *obj);
662174d2 66
bacf1687 67struct commit *lookup_commit(struct repository *r, const struct object_id *oid);
1f6c72fe
SB
68struct commit *lookup_commit_reference(struct repository *r,
69 const struct object_id *oid);
d9a05e74 70struct commit *lookup_commit_reference_gently(struct repository *r,
21e1ee8f 71 const struct object_id *oid,
f76412ed 72 int quiet);
a6fa5992 73struct commit *lookup_commit_reference_by_name(const char *name);
6eb8ae00 74
baf18fc2 75/*
bc83266a 76 * Look up object named by "oid", dereference tag as necessary,
77 * get a commit and return it. If "oid" does not dereference to
baf18fc2
NTND
78 * a commit, use ref_name to report an error and die.
79 */
bc83266a 80struct commit *lookup_commit_or_die(const struct object_id *oid, const char *ref_name);
baf18fc2 81
fd8030c7 82int parse_commit_buffer(struct repository *r, struct commit *item, const void *buffer, unsigned long size, int check_graph);
9e5252ab
SB
83int repo_parse_commit_internal(struct repository *r, struct commit *item,
84 int quiet_on_missing, int use_commit_graph);
85int repo_parse_commit_gently(struct repository *r,
86 struct commit *item,
87 int quiet_on_missing);
88static inline int repo_parse_commit(struct repository *r, struct commit *item)
9cc2b07a 89{
9e5252ab 90 return repo_parse_commit_gently(r, item, 0);
9cc2b07a 91}
9e5252ab
SB
92#ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
93#define parse_commit_internal(item, quiet, use) repo_parse_commit_internal(the_repository, item, quiet, use)
94#define parse_commit_gently(item, quiet) repo_parse_commit_gently(the_repository, item, quiet)
95#define parse_commit(item) repo_parse_commit(the_repository, item)
96#endif
97
7059dccc 98void parse_commit_or_die(struct commit *item);
6eb8ae00 99
65ea9d4b
SB
100struct buffer_slab;
101struct buffer_slab *allocate_commit_buffer_slab(void);
102void free_commit_buffer_slab(struct buffer_slab *bs);
103
66c2827e
JK
104/*
105 * Associate an object buffer with the commit. The ownership of the
106 * memory is handed over to the commit, and must be free()-able.
107 */
1a40fc45 108void set_commit_buffer(struct repository *r, struct commit *, void *buffer, unsigned long size);
66c2827e 109
152ff1cc
JK
110/*
111 * Get any cached object buffer associated with the commit. Returns NULL
112 * if none. The resulting memory should not be freed.
113 */
4ff7e5c9 114const void *get_cached_commit_buffer(struct repository *, const struct commit *, unsigned long *size);
152ff1cc
JK
115
116/*
117 * Get the commit's object contents, either from cache or by reading the object
118 * from disk. The resulting memory should not be modified, and must be given
119 * to unuse_commit_buffer when the caller is done.
120 */
07de3fd8
SB
121const void *repo_get_commit_buffer(struct repository *r,
122 const struct commit *,
123 unsigned long *size);
124#ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
125#define get_commit_buffer(c, s) repo_get_commit_buffer(the_repository, c, s)
126#endif
152ff1cc
JK
127
128/*
129 * Tell the commit subsytem that we are done with a particular commit buffer.
130 * The commit and buffer should be the input and return value, respectively,
131 * from an earlier call to get_commit_buffer. The buffer may or may not be
132 * freed by this call; callers should not access the memory afterwards.
133 */
70315373
SB
134void repo_unuse_commit_buffer(struct repository *r,
135 const struct commit *,
136 const void *buffer);
137#ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
138#define unuse_commit_buffer(c, b) repo_unuse_commit_buffer(the_repository, c, b)
139#endif
152ff1cc 140
0fb370da
JK
141/*
142 * Free any cached object buffer associated with the commit.
143 */
6a7895fd 144void free_commit_buffer(struct parsed_object_pool *pool, struct commit *);
0fb370da 145
5bb03de1
DS
146struct tree *get_commit_tree(const struct commit *);
147struct object_id *get_commit_tree_oid(const struct commit *);
148
14ba97f8
SB
149/*
150 * Release memory related to a commit, including the parent list and
151 * any cached object buffer.
152 */
6a7895fd 153void release_commit_memory(struct parsed_object_pool *pool, struct commit *c);
14ba97f8 154
0fb370da
JK
155/*
156 * Disassociate any cached object buffer from the commit, but do not free it.
157 * The buffer (or NULL, if none) is returned.
158 */
8597ea3a 159const void *detach_commit_buffer(struct commit *, unsigned long *sizep);
0fb370da 160
11af2aae
CC
161/* Find beginning and length of commit subject. */
162int find_commit_subject(const char *commit_buffer, const char **subject);
163
47e44ed1
TF
164struct commit_list *commit_list_insert(struct commit *item,
165 struct commit_list **list);
89b5f1d9
RS
166struct commit_list **commit_list_append(struct commit *commit,
167 struct commit_list **next);
65319475 168unsigned commit_list_count(const struct commit_list *l);
47e44ed1
TF
169struct commit_list *commit_list_insert_by_date(struct commit *item,
170 struct commit_list **list);
171void commit_list_sort_by_date(struct commit_list **list);
dd97f850 172
53d00b39
TR
173/* Shallow copy of the input list */
174struct commit_list *copy_commit_list(struct commit_list *list);
175
6eb8ae00
DB
176void free_commit_list(struct commit_list *list);
177
6d167fd7
RS
178struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
179
28e9cf65 180extern int has_non_ascii(const char *text);
b000c59b
JK
181extern const char *logmsg_reencode(const struct commit *commit,
182 char **commit_encoding,
183 const char *output_encoding);
424510ed
SB
184const char *repo_logmsg_reencode(struct repository *r,
185 const struct commit *commit,
186 char **commit_encoding,
187 const char *output_encoding);
188#ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
189#define logmsg_reencode(c, enc, out) repo_logmsg_reencode(the_repository, c, enc, out)
190#endif
191
77356122 192extern const char *skip_blank_lines(const char *msg);
e3bc7a3b 193
dd97f850
DB
194/** Removes the first commit from a list sorted by date, and adds all
195 * of its parents.
196 **/
a6080a0a 197struct commit *pop_most_recent_commit(struct commit_list **list,
58e28af6 198 unsigned int mark);
dd97f850 199
a3437b8c
JS
200struct commit *pop_commit(struct commit_list **stack);
201
f8f9c73c 202void clear_commit_marks(struct commit *commit, unsigned int mark);
e895cb51 203void clear_commit_marks_many(int nr, struct commit **commit, unsigned int mark);
f8f9c73c 204
08f704f2
JH
205
206enum rev_sort_order {
207 REV_SORT_IN_GRAPH_ORDER = 0,
81c6b38b
JH
208 REV_SORT_BY_COMMIT_DATE,
209 REV_SORT_BY_AUTHOR_DATE
08f704f2
JH
210};
211
ab580ace
JS
212/*
213 * Performs an in-place topological sort of list supplied.
214 *
ab580ace
JS
215 * invariant of resulting list is:
216 * a reachable from b => ord(b) < ord(a)
08f704f2
JH
217 * sort_order further specifies:
218 * REV_SORT_IN_GRAPH_ORDER: try to show a commit on a single-parent
219 * chain together.
220 * REV_SORT_BY_COMMIT_DATE: show eligible commits in committer-date order.
ab580ace 221 */
08f704f2 222void sort_in_topological_order(struct commit_list **, enum rev_sort_order);
5040f17e
JH
223
224struct commit_graft {
7683e2e6 225 struct object_id oid;
ed09aef0 226 int nr_parent; /* < 0 if shallow commit */
7683e2e6 227 struct object_id parent[FLEX_ARRAY]; /* more */
5040f17e 228};
09d46644 229typedef int (*each_commit_graft_fn)(const struct commit_graft *, void *);
5040f17e 230
9a934032 231struct commit_graft *read_graft_line(struct strbuf *line);
a3b78e83 232int register_commit_graft(struct repository *r, struct commit_graft *, int);
20fd6d57 233void prepare_commit_graft(struct repository *r);
b9dbddf6 234struct commit_graft *lookup_commit_graft(struct repository *r, const struct object_id *oid);
5040f17e 235
103148aa
PK
236struct commit *get_fork_point(const char *refname, struct commit *commit);
237
41ccfdd9 238/* largest positive number a signed 32-bit integer can contain */
4dcb167f
NTND
239#define INFINITE_DEPTH 0x7fffffff
240
910650d2 241struct oid_array;
58babfff 242struct ref;
eee4502b 243extern int register_shallow(struct repository *r, const struct object_id *oid);
e92b848c 244extern int unregister_shallow(const struct object_id *oid);
09d46644 245extern int for_each_commit_graft(each_commit_graft_fn, void *);
eee4502b 246extern int is_repository_shallow(struct repository *r);
ed09aef0 247extern struct commit_list *get_shallow_commits(struct object_array *heads,
f53514bc 248 int depth, int shallow_flag, int not_shallow_flag);
3d9ff4d7
NTND
249extern struct commit_list *get_shallow_commits_by_rev_list(
250 int ac, const char **av, int shallow_flag, int not_shallow_flag);
eee4502b 251extern void set_alternate_shallow_file(struct repository *r, const char *path, int override);
1a30f5a2 252extern int write_shallow_commits(struct strbuf *out, int use_pack_protocol,
910650d2 253 const struct oid_array *extra);
3125fe52 254extern void setup_alternate_shallow(struct lock_file *shallow_lock,
1a30f5a2 255 const char **alternate_shallow_file,
910650d2 256 const struct oid_array *extra);
257extern const char *setup_temporary_shallow(const struct oid_array *extra);
ad491366 258extern void advertise_shallow_grafts(int);
ed09aef0 259
58babfff 260struct shallow_info {
910650d2 261 struct oid_array *shallow;
58babfff
NTND
262 int *ours, nr_ours;
263 int *theirs, nr_theirs;
910650d2 264 struct oid_array *ref;
0a1bc12b
NTND
265
266 /* for receive-pack */
267 uint32_t **used_shallow;
268 int *need_reachability_test;
269 int *reachable;
270 int *shallow_ref;
271 struct commit **commits;
272 int nr_commits;
58babfff
NTND
273};
274
910650d2 275extern void prepare_shallow_info(struct shallow_info *, struct oid_array *);
58babfff
NTND
276extern void clear_shallow_info(struct shallow_info *);
277extern void remove_nonexistent_theirs_shallow(struct shallow_info *);
8e277383
NTND
278extern void assign_shallow_commits_to_refs(struct shallow_info *info,
279 uint32_t **used,
280 int *ref_status);
0a1bc12b 281extern int delayed_reachability_test(struct shallow_info *si, int c);
2588f6ed
JS
282#define PRUNE_SHOW_ONLY 1
283#define PRUNE_QUICK 2
284extern void prune_shallow(unsigned options);
6aa30857 285extern struct trace_key trace_shallow;
ed09aef0 286
b4bd4668 287extern int interactive_add(int argc, const char **argv, const char *prefix, int patch);
46b5139c 288extern int run_add_interactive(const char *revision, const char *patch_mode,
480ca644 289 const struct pathspec *pathspec);
58680165 290
5231c633
JH
291struct commit_extra_header {
292 struct commit_extra_header *next;
293 char *key;
294 char *value;
295 size_t len;
296};
297
298extern void append_merge_tag_headers(struct commit_list *parents,
299 struct commit_extra_header ***tail);
300
3ffefb54 301extern int commit_tree(const char *msg, size_t msg_len,
5078f344
PO
302 const struct object_id *tree,
303 struct commit_list *parents, struct object_id *ret,
ba3c69a9 304 const char *author, const char *sign_commit);
5231c633 305
3ffefb54 306extern int commit_tree_extended(const char *msg, size_t msg_len,
5078f344
PO
307 const struct object_id *tree,
308 struct commit_list *parents,
309 struct object_id *ret, const char *author,
310 const char *sign_commit,
5231c633
JH
311 struct commit_extra_header *);
312
c871a1d1 313extern struct commit_extra_header *read_commit_extra_headers(struct commit *, const char **);
ed7a42a0 314
5231c633 315extern void free_commit_extra_headers(struct commit_extra_header *extra);
40d52ff7 316
fe6eb7f2
JK
317/*
318 * Search the commit object contents given by "msg" for the header "key".
319 * Returns a pointer to the start of the header contents, or NULL. The length
320 * of the header, up to the first newline, is returned via out_len.
321 *
322 * Note that some headers (like mergetag) may be multi-line. It is the caller's
323 * responsibility to parse further in this case!
324 */
325extern const char *find_commit_header(const char *msg, const char *key,
326 size_t *out_len);
327
8c384589 328/* Find the end of the log message, the right place for a new trailer. */
66e83d9b 329extern size_t ignore_non_trailer(const char *buf, size_t len);
8c384589 330
fef461ea 331typedef int (*each_mergetag_fn)(struct commit *commit, struct commit_extra_header *extra,
063da62b
CC
332 void *cb_data);
333
fef461ea 334extern int for_each_mergetag(each_mergetag_fn fn, struct commit *commit, void *data);
063da62b 335
ae8e4c9c
JH
336struct merge_remote_desc {
337 struct object *obj; /* the named object, could be a tag */
5447a76a 338 char name[FLEX_ARRAY];
ae8e4c9c 339};
e2e5ac23 340extern struct merge_remote_desc *merge_remote_util(struct commit *);
beb518c9
RS
341extern void set_merge_remote_desc(struct commit *commit,
342 const char *name, struct object *obj);
ae8e4c9c
JH
343
344/*
345 * Given "name" from the command line to merge, find the commit object
346 * and return it, while storing merge_remote_desc in its ->util field,
347 * to allow callers to tell if we are told to merge a tag.
348 */
349struct commit *get_merge_parent(const char *name);
350
218aa3a6 351extern int parse_signed_commit(const struct commit *commit,
0c37f1fc 352 struct strbuf *message, struct strbuf *signature);
0b05ab6f
CC
353extern int remove_signature(struct strbuf *buf);
354
ffb6d7d5 355/*
eb307ae7
SG
356 * Check the signature of the given commit. The result of the check is stored
357 * in sig->check_result, 'G' for a good signature, 'U' for a good signature
358 * from an untrusted signer, 'B' for a bad signature and 'N' for no signature
359 * at all. This may allocate memory for sig->gpg_output, sig->gpg_status,
360 * sig->signer and sig->key.
ffb6d7d5 361 */
434060ec 362extern int check_commit_signature(const struct commit *commit, struct signature_check *sigc);
ffb6d7d5 363
5284fc5c
DS
364/* record author-date for each commit object */
365struct author_date_slab;
366void record_author_date(struct author_date_slab *author_date,
367 struct commit *commit);
368
369int compare_commits_by_author_date(const void *a_, const void *b_, void *unused);
6d2035ee 370
edc4d47d
JK
371/*
372 * Verify a single commit with check_commit_signature() and die() if it is not
373 * a good signature. This isn't really suitable for general use, but is a
374 * helper to implement consistent logic for pull/merge --verify-signatures.
375 */
376void verify_merge_signature(struct commit *commit, int verbose);
377
727377ff 378int compare_commits_by_commit_date(const void *a_, const void *b_, void *unused);
3afc679b 379int compare_commits_by_gen_then_commit_date(const void *a_, const void *b_, void *unused);
727377ff 380
15048f8a
BP
381LAST_ARG_MUST_BE_NULL
382extern int run_commit_hook(int editor_is_used, const char *index_file, const char *name, ...);
383
6eb8ae00 384#endif /* COMMIT_H */