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