1#ifndef COMMIT_H 2#define COMMIT_H 3 4#include "object.h" 5#include "tree.h" 6#include "strbuf.h" 7#include "decorate.h" 8#include "gpg-interface.h" 9#include "string-list.h" 10#include "pretty.h" 11 12#define COMMIT_NOT_FROM_GRAPH 0xFFFFFFFF 13#define GENERATION_NUMBER_INFINITY 0xFFFFFFFF 14#define GENERATION_NUMBER_MAX 0x3FFFFFFF 15#define GENERATION_NUMBER_ZERO 0 16 17struct commit_list { 18 struct commit *item; 19 struct commit_list *next; 20}; 21 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 */ 27struct commit { 28 struct object object; 29 timestamp_t date; 30 struct commit_list *parents; 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 */ 37 struct tree *maybe_tree; 38 uint32_t graph_pos; 39 uint32_t generation; 40 unsigned int index; 41}; 42 43extern int save_commit_buffer; 44extern const char *commit_type; 45 46/* While we can decorate any object with a name, it's only used for commits.. */ 47struct name_decoration { 48 struct name_decoration *next; 49 int type; 50 char name[FLEX_ARRAY]; 51}; 52 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); 64const struct name_decoration *get_name_decoration(const struct object *obj); 65 66struct commit *lookup_commit(struct repository *r, const struct object_id *oid); 67#define lookup_commit_reference(r, o) \ 68 lookup_commit_reference_##r(o) 69struct commit *lookup_commit_reference_the_repository(const struct object_id *oid); 70#define lookup_commit_reference_gently(r, o, q) \ 71 lookup_commit_reference_gently_##r(o, q) 72struct commit *lookup_commit_reference_gently_the_repository( 73 const struct object_id *oid, 74 int quiet); 75struct commit *lookup_commit_reference_by_name(const char *name); 76 77/* 78 * Look up object named by "oid", dereference tag as necessary, 79 * get a commit and return it. If "oid" does not dereference to 80 * a commit, use ref_name to report an error and die. 81 */ 82struct commit *lookup_commit_or_die(const struct object_id *oid, const char *ref_name); 83 84int parse_commit_buffer(struct repository *r, struct commit *item, const void *buffer, unsigned long size, int check_graph); 85int parse_commit_gently(struct commit *item, int quiet_on_missing); 86static inline int parse_commit(struct commit *item) 87{ 88 return parse_commit_gently(item, 0); 89} 90void parse_commit_or_die(struct commit *item); 91 92struct buffer_slab; 93struct buffer_slab *allocate_commit_buffer_slab(void); 94void free_commit_buffer_slab(struct buffer_slab *bs); 95 96/* 97 * Associate an object buffer with the commit. The ownership of the 98 * memory is handed over to the commit, and must be free()-able. 99 */ 100void set_commit_buffer(struct repository *r, struct commit *, void *buffer, unsigned long size); 101 102/* 103 * Get any cached object buffer associated with the commit. Returns NULL 104 * if none. The resulting memory should not be freed. 105 */ 106const void *get_cached_commit_buffer(struct repository *, const struct commit *, unsigned long *size); 107 108/* 109 * Get the commit's object contents, either from cache or by reading the object 110 * from disk. The resulting memory should not be modified, and must be given 111 * to unuse_commit_buffer when the caller is done. 112 */ 113const void *get_commit_buffer(const struct commit *, unsigned long *size); 114 115/* 116 * Tell the commit subsytem that we are done with a particular commit buffer. 117 * The commit and buffer should be the input and return value, respectively, 118 * from an earlier call to get_commit_buffer. The buffer may or may not be 119 * freed by this call; callers should not access the memory afterwards. 120 */ 121void unuse_commit_buffer(const struct commit *, const void *buffer); 122 123/* 124 * Free any cached object buffer associated with the commit. 125 */ 126void free_commit_buffer(struct commit *); 127 128struct tree *get_commit_tree(const struct commit *); 129struct object_id *get_commit_tree_oid(const struct commit *); 130 131/* 132 * Release memory related to a commit, including the parent list and 133 * any cached object buffer. 134 */ 135void release_commit_memory(struct commit *c); 136 137/* 138 * Disassociate any cached object buffer from the commit, but do not free it. 139 * The buffer (or NULL, if none) is returned. 140 */ 141const void *detach_commit_buffer(struct commit *, unsigned long *sizep); 142 143/* Find beginning and length of commit subject. */ 144int find_commit_subject(const char *commit_buffer, const char **subject); 145 146struct commit_list *commit_list_insert(struct commit *item, 147 struct commit_list **list); 148struct commit_list **commit_list_append(struct commit *commit, 149 struct commit_list **next); 150unsigned commit_list_count(const struct commit_list *l); 151struct commit_list *commit_list_insert_by_date(struct commit *item, 152 struct commit_list **list); 153void commit_list_sort_by_date(struct commit_list **list); 154 155/* Shallow copy of the input list */ 156struct commit_list *copy_commit_list(struct commit_list *list); 157 158void free_commit_list(struct commit_list *list); 159 160struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */ 161 162extern int has_non_ascii(const char *text); 163extern const char *logmsg_reencode(const struct commit *commit, 164 char **commit_encoding, 165 const char *output_encoding); 166extern const char *skip_blank_lines(const char *msg); 167 168/** Removes the first commit from a list sorted by date, and adds all 169 * of its parents. 170 **/ 171struct commit *pop_most_recent_commit(struct commit_list **list, 172 unsigned int mark); 173 174struct commit *pop_commit(struct commit_list **stack); 175 176void clear_commit_marks(struct commit *commit, unsigned int mark); 177void clear_commit_marks_many(int nr, struct commit **commit, unsigned int mark); 178 179 180enum rev_sort_order { 181 REV_SORT_IN_GRAPH_ORDER = 0, 182 REV_SORT_BY_COMMIT_DATE, 183 REV_SORT_BY_AUTHOR_DATE 184}; 185 186/* 187 * Performs an in-place topological sort of list supplied. 188 * 189 * invariant of resulting list is: 190 * a reachable from b => ord(b) < ord(a) 191 * sort_order further specifies: 192 * REV_SORT_IN_GRAPH_ORDER: try to show a commit on a single-parent 193 * chain together. 194 * REV_SORT_BY_COMMIT_DATE: show eligible commits in committer-date order. 195 */ 196void sort_in_topological_order(struct commit_list **, enum rev_sort_order); 197 198struct commit_graft { 199 struct object_id oid; 200 int nr_parent; /* < 0 if shallow commit */ 201 struct object_id parent[FLEX_ARRAY]; /* more */ 202}; 203typedef int (*each_commit_graft_fn)(const struct commit_graft *, void *); 204 205struct commit_graft *read_graft_line(struct strbuf *line); 206int register_commit_graft(struct repository *r, struct commit_graft *, int); 207struct commit_graft *lookup_commit_graft(struct repository *r, const struct object_id *oid); 208 209extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2); 210extern struct commit_list *get_merge_bases_many(struct commit *one, int n, struct commit **twos); 211extern struct commit_list *get_octopus_merge_bases(struct commit_list *in); 212 213/* To be used only when object flags after this call no longer matter */ 214extern struct commit_list *get_merge_bases_many_dirty(struct commit *one, int n, struct commit **twos); 215 216/* largest positive number a signed 32-bit integer can contain */ 217#define INFINITE_DEPTH 0x7fffffff 218 219struct oid_array; 220struct ref; 221extern int register_shallow(struct repository *r, const struct object_id *oid); 222extern int unregister_shallow(const struct object_id *oid); 223extern int for_each_commit_graft(each_commit_graft_fn, void *); 224extern int is_repository_shallow(struct repository *r); 225extern struct commit_list *get_shallow_commits(struct object_array *heads, 226 int depth, int shallow_flag, int not_shallow_flag); 227extern struct commit_list *get_shallow_commits_by_rev_list( 228 int ac, const char **av, int shallow_flag, int not_shallow_flag); 229extern void set_alternate_shallow_file(struct repository *r, const char *path, int override); 230extern int write_shallow_commits(struct strbuf *out, int use_pack_protocol, 231 const struct oid_array *extra); 232extern void setup_alternate_shallow(struct lock_file *shallow_lock, 233 const char **alternate_shallow_file, 234 const struct oid_array *extra); 235extern const char *setup_temporary_shallow(const struct oid_array *extra); 236extern void advertise_shallow_grafts(int); 237 238struct shallow_info { 239 struct oid_array *shallow; 240 int *ours, nr_ours; 241 int *theirs, nr_theirs; 242 struct oid_array *ref; 243 244 /* for receive-pack */ 245 uint32_t **used_shallow; 246 int *need_reachability_test; 247 int *reachable; 248 int *shallow_ref; 249 struct commit **commits; 250 int nr_commits; 251}; 252 253extern void prepare_shallow_info(struct shallow_info *, struct oid_array *); 254extern void clear_shallow_info(struct shallow_info *); 255extern void remove_nonexistent_theirs_shallow(struct shallow_info *); 256extern void assign_shallow_commits_to_refs(struct shallow_info *info, 257 uint32_t **used, 258 int *ref_status); 259extern int delayed_reachability_test(struct shallow_info *si, int c); 260extern void prune_shallow(int show_only); 261extern struct trace_key trace_shallow; 262 263int is_descendant_of(struct commit *, struct commit_list *); 264int in_merge_bases(struct commit *, struct commit *); 265int in_merge_bases_many(struct commit *, int, struct commit **); 266 267extern int interactive_add(int argc, const char **argv, const char *prefix, int patch); 268extern int run_add_interactive(const char *revision, const char *patch_mode, 269 const struct pathspec *pathspec); 270 271/* 272 * Takes a list of commits and returns a new list where those 273 * have been removed that can be reached from other commits in 274 * the list. It is useful for, e.g., reducing the commits 275 * randomly thrown at the git-merge command and removing 276 * redundant commits that the user shouldn't have given to it. 277 * 278 * This function destroys the STALE bit of the commit objects' 279 * flags. 280 */ 281extern struct commit_list *reduce_heads(struct commit_list *heads); 282 283/* 284 * Like `reduce_heads()`, except it replaces the list. Use this 285 * instead of `foo = reduce_heads(foo);` to avoid memory leaks. 286 */ 287extern void reduce_heads_replace(struct commit_list **heads); 288 289struct commit_extra_header { 290 struct commit_extra_header *next; 291 char *key; 292 char *value; 293 size_t len; 294}; 295 296extern void append_merge_tag_headers(struct commit_list *parents, 297 struct commit_extra_header ***tail); 298 299extern int commit_tree(const char *msg, size_t msg_len, 300 const struct object_id *tree, 301 struct commit_list *parents, struct object_id *ret, 302 const char *author, const char *sign_commit); 303 304extern int commit_tree_extended(const char *msg, size_t msg_len, 305 const struct object_id *tree, 306 struct commit_list *parents, 307 struct object_id *ret, const char *author, 308 const char *sign_commit, 309 struct commit_extra_header *); 310 311extern struct commit_extra_header *read_commit_extra_headers(struct commit *, const char **); 312 313extern void free_commit_extra_headers(struct commit_extra_header *extra); 314 315/* 316 * Search the commit object contents given by "msg" for the header "key". 317 * Returns a pointer to the start of the header contents, or NULL. The length 318 * of the header, up to the first newline, is returned via out_len. 319 * 320 * Note that some headers (like mergetag) may be multi-line. It is the caller's 321 * responsibility to parse further in this case! 322 */ 323extern const char *find_commit_header(const char *msg, const char *key, 324 size_t *out_len); 325 326/* Find the end of the log message, the right place for a new trailer. */ 327extern int ignore_non_trailer(const char *buf, size_t len); 328 329typedef int (*each_mergetag_fn)(struct commit *commit, struct commit_extra_header *extra, 330 void *cb_data); 331 332extern int for_each_mergetag(each_mergetag_fn fn, struct commit *commit, void *data); 333 334struct merge_remote_desc { 335 struct object *obj; /* the named object, could be a tag */ 336 char name[FLEX_ARRAY]; 337}; 338extern struct merge_remote_desc *merge_remote_util(struct commit *); 339extern void set_merge_remote_desc(struct commit *commit, 340 const char *name, struct object *obj); 341 342/* 343 * Given "name" from the command line to merge, find the commit object 344 * and return it, while storing merge_remote_desc in its ->util field, 345 * to allow callers to tell if we are told to merge a tag. 346 */ 347struct commit *get_merge_parent(const char *name); 348 349extern int parse_signed_commit(const struct commit *commit, 350 struct strbuf *message, struct strbuf *signature); 351extern int remove_signature(struct strbuf *buf); 352 353/* 354 * Check the signature of the given commit. The result of the check is stored 355 * in sig->check_result, 'G' for a good signature, 'U' for a good signature 356 * from an untrusted signer, 'B' for a bad signature and 'N' for no signature 357 * at all. This may allocate memory for sig->gpg_output, sig->gpg_status, 358 * sig->signer and sig->key. 359 */ 360extern int check_commit_signature(const struct commit *commit, struct signature_check *sigc); 361 362int compare_commits_by_commit_date(const void *a_, const void *b_, void *unused); 363int compare_commits_by_gen_then_commit_date(const void *a_, const void *b_, void *unused); 364 365LAST_ARG_MUST_BE_NULL 366extern int run_commit_hook(int editor_is_used, const char *index_file, const char *name, ...); 367 368#endif /* COMMIT_H */