commit.h

   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 #include "commit-slab.h"
  12
  13 #define COMMIT_NOT_FROM_GRAPH 0xFFFFFFFF
  14 #define GENERATION_NUMBER_INFINITY ((1ULL << 63) - 1)
  15 #define GENERATION_NUMBER_V1_MAX 0x3FFFFFFF
  16 #define GENERATION_NUMBER_ZERO 0
  17 #define GENERATION_NUMBER_V2_OFFSET_MAX ((1ULL << 31) - 1)
  18
  19 struct commit_list {
  20         struct commit *item;
  21         struct commit_list *next;
  22 };
  23
  24 /*
  25  * The size of this struct matters in full repo walk operations like
  26  * 'git clone' or 'git gc'. Consider using commit-slab to attach data
  27  * to a commit instead of adding new fields here.
  28  */
  29 struct commit {
  30         struct object object;
  31         timestamp_t date;
  32         struct commit_list *parents;
  33
  34         /*
  35          * If the commit is loaded from the commit-graph file, then this
  36          * member may be NULL. Only access it through repo_get_commit_tree()
  37          * or get_commit_tree_oid().
  38          */
  39         struct tree *maybe_tree;
  40         unsigned int index;
  41 };
  42
  43 extern int save_commit_buffer;
  44 extern int no_graft_file_deprecated_advice;
  45 extern const char *commit_type;
  46
  47 /* While we can decorate any object with a name, it's only used for commits.. */
  48 struct name_decoration {
  49         struct name_decoration *next;
  50         int type;
  51         char name[FLEX_ARRAY];
  52 };
  53
  54 enum 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
  64 void add_name_decoration(enum decoration_type type, const char *name, struct object *obj);
  65 const struct name_decoration *get_name_decoration(const struct object *obj);
  66
  67 /*
  68  * Look up commit named by "oid" respecting replacement objects.
  69  * Returns NULL if "oid" is not a commit or does not exist.
  70  */
  71 struct commit *lookup_commit_object(struct repository *r, const struct object_id *oid);
  72
  73 /*
  74  * Look up commit named by "oid" without replacement objects or
  75  * checking for object existence. Returns the requested commit if it
  76  * is found in the object cache, NULL if "oid" is in the object cache
  77  * but is not a commit and a newly allocated unparsed commit object if
  78  * "oid" is not in the object cache.
  79  */
  80 struct commit *lookup_commit(struct repository *r, const struct object_id *oid);
  81 struct commit *lookup_commit_reference(struct repository *r,
  82                                        const struct object_id *oid);
  83 struct commit *lookup_commit_reference_gently(struct repository *r,
  84                                               const struct object_id *oid,
  85                                               int quiet);
  86 struct commit *lookup_commit_reference_by_name(const char *name);
  87
  88 /*
  89  * Look up object named by "oid", dereference tag as necessary,
  90  * get a commit and return it. If "oid" does not dereference to
  91  * a commit, use ref_name to report an error and die.
  92  */
  93 struct commit *lookup_commit_or_die(const struct object_id *oid, const char *ref_name);
  94
  95 int parse_commit_buffer(struct repository *r, struct commit *item, const void *buffer, unsigned long size, int check_graph);
  96 int repo_parse_commit_internal(struct repository *r, struct commit *item,
  97                                int quiet_on_missing, int use_commit_graph);
  98 int repo_parse_commit_gently(struct repository *r,
  99                              struct commit *item,
 100                              int quiet_on_missing);
 101 static inline int repo_parse_commit(struct repository *r, struct commit *item)
 102 {
 103         return repo_parse_commit_gently(r, item, 0);
 104 }
 105
 106 static inline int repo_parse_commit_no_graph(struct repository *r,
 107                                              struct commit *commit)
 108 {
 109         return repo_parse_commit_internal(r, commit, 0, 0);
 110 }
 111
 112 #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
 113 #define parse_commit_internal(item, quiet, use) repo_parse_commit_internal(the_repository, item, quiet, use)
 114 #define parse_commit(item) repo_parse_commit(the_repository, item)
 115 #endif
 116
 117 void parse_commit_or_die(struct commit *item);
 118
 119 struct buffer_slab;
 120 struct buffer_slab *allocate_commit_buffer_slab(void);
 121 void free_commit_buffer_slab(struct buffer_slab *bs);
 122
 123 /*
 124  * Associate an object buffer with the commit. The ownership of the
 125  * memory is handed over to the commit, and must be free()-able.
 126  */
 127 void set_commit_buffer(struct repository *r, struct commit *, void *buffer, unsigned long size);
 128
 129 /*
 130  * Get any cached object buffer associated with the commit. Returns NULL
 131  * if none. The resulting memory should not be freed.
 132  */
 133 const void *get_cached_commit_buffer(struct repository *, const struct commit *, unsigned long *size);
 134
 135 /*
 136  * Get the commit's object contents, either from cache or by reading the object
 137  * from disk. The resulting memory should not be modified, and must be given
 138  * to unuse_commit_buffer when the caller is done.
 139  */
 140 const void *repo_get_commit_buffer(struct repository *r,
 141                                    const struct commit *,
 142                                    unsigned long *size);
 143 #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
 144 #define get_commit_buffer(c, s) repo_get_commit_buffer(the_repository, c, s)
 145 #endif
 146
 147 /*
 148  * Tell the commit subsystem that we are done with a particular commit buffer.
 149  * The commit and buffer should be the input and return value, respectively,
 150  * from an earlier call to get_commit_buffer.  The buffer may or may not be
 151  * freed by this call; callers should not access the memory afterwards.
 152  */
 153 void repo_unuse_commit_buffer(struct repository *r,
 154                               const struct commit *,
 155                               const void *buffer);
 156 #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
 157 #define unuse_commit_buffer(c, b) repo_unuse_commit_buffer(the_repository, c, b)
 158 #endif
 159
 160 /*
 161  * Free any cached object buffer associated with the commit.
 162  */
 163 void free_commit_buffer(struct parsed_object_pool *pool, struct commit *);
 164
 165 struct tree *repo_get_commit_tree(struct repository *, const struct commit *);
 166 #define get_commit_tree(c) repo_get_commit_tree(the_repository, c)
 167 struct object_id *get_commit_tree_oid(const struct commit *);
 168
 169 /*
 170  * Release memory related to a commit, including the parent list and
 171  * any cached object buffer.
 172  */
 173 void release_commit_memory(struct parsed_object_pool *pool, struct commit *c);
 174
 175 /*
 176  * Disassociate any cached object buffer from the commit, but do not free it.
 177  * The buffer (or NULL, if none) is returned.
 178  */
 179 const void *detach_commit_buffer(struct commit *, unsigned long *sizep);
 180
 181 /* Find beginning and length of commit subject. */
 182 int find_commit_subject(const char *commit_buffer, const char **subject);
 183
 184 /* Return length of the commit subject from commit log message. */
 185 size_t commit_subject_length(const char *body);
 186
 187 struct commit_list *commit_list_insert(struct commit *item,
 188                                         struct commit_list **list);
 189 int commit_list_contains(struct commit *item,
 190                          struct commit_list *list);
 191 struct commit_list **commit_list_append(struct commit *commit,
 192                                         struct commit_list **next);
 193 unsigned commit_list_count(const struct commit_list *l);
 194 struct commit_list *commit_list_insert_by_date(struct commit *item,
 195                                     struct commit_list **list);
 196 void commit_list_sort_by_date(struct commit_list **list);
 197
 198 /* Shallow copy of the input list */
 199 struct commit_list *copy_commit_list(struct commit_list *list);
 200
 201 /* Modify list in-place to reverse it, returning new head; list will be tail */
 202 struct commit_list *reverse_commit_list(struct commit_list *list);
 203
 204 void free_commit_list(struct commit_list *list);
 205
 206 struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
 207
 208 int has_non_ascii(const char *text);
 209 const char *logmsg_reencode(const struct commit *commit,
 210                             char **commit_encoding,
 211                             const char *output_encoding);
 212 const char *repo_logmsg_reencode(struct repository *r,
 213                                  const struct commit *commit,
 214                                  char **commit_encoding,
 215                                  const char *output_encoding);
 216 #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
 217 #define logmsg_reencode(c, enc, out) repo_logmsg_reencode(the_repository, c, enc, out)
 218 #endif
 219
 220 const char *skip_blank_lines(const char *msg);
 221
 222 /** Removes the first commit from a list sorted by date, and adds all
 223  * of its parents.
 224  **/
 225 struct commit *pop_most_recent_commit(struct commit_list **list,
 226                                       unsigned int mark);
 227
 228 struct commit *pop_commit(struct commit_list **stack);
 229
 230 void clear_commit_marks(struct commit *commit, unsigned int mark);
 231 void clear_commit_marks_many(int nr, struct commit **commit, unsigned int mark);
 232
 233
 234 enum rev_sort_order {
 235         REV_SORT_IN_GRAPH_ORDER = 0,
 236         REV_SORT_BY_COMMIT_DATE,
 237         REV_SORT_BY_AUTHOR_DATE
 238 };
 239
 240 /*
 241  * Performs an in-place topological sort of list supplied.
 242  *
 243  *   invariant of resulting list is:
 244  *      a reachable from b => ord(b) < ord(a)
 245  *   sort_order further specifies:
 246  *   REV_SORT_IN_GRAPH_ORDER: try to show a commit on a single-parent
 247  *                            chain together.
 248  *   REV_SORT_BY_COMMIT_DATE: show eligible commits in committer-date order.
 249  */
 250 void sort_in_topological_order(struct commit_list **, enum rev_sort_order);
 251
 252 struct commit_graft {
 253         struct object_id oid;
 254         int nr_parent; /* < 0 if shallow commit */
 255         struct object_id parent[FLEX_ARRAY]; /* more */
 256 };
 257 typedef int (*each_commit_graft_fn)(const struct commit_graft *, void *);
 258
 259 struct commit_graft *read_graft_line(struct strbuf *line);
 260 /* commit_graft_pos returns an index into r->parsed_objects->grafts. */
 261 int commit_graft_pos(struct repository *r, const struct object_id *oid);
 262 int register_commit_graft(struct repository *r, struct commit_graft *, int);
 263 void prepare_commit_graft(struct repository *r);
 264 struct commit_graft *lookup_commit_graft(struct repository *r, const struct object_id *oid);
 265 void reset_commit_grafts(struct repository *r);
 266
 267 struct commit *get_fork_point(const char *refname, struct commit *commit);
 268
 269 /* largest positive number a signed 32-bit integer can contain */
 270 #define INFINITE_DEPTH 0x7fffffff
 271
 272 struct oid_array;
 273 struct ref;
 274 int for_each_commit_graft(each_commit_graft_fn, void *);
 275
 276 int interactive_add(const char **argv, const char *prefix, int patch);
 277
 278 struct commit_extra_header {
 279         struct commit_extra_header *next;
 280         char *key;
 281         char *value;
 282         size_t len;
 283 };
 284
 285 void append_merge_tag_headers(struct commit_list *parents,
 286                               struct commit_extra_header ***tail);
 287
 288 int commit_tree(const char *msg, size_t msg_len,
 289                 const struct object_id *tree,
 290                 struct commit_list *parents, struct object_id *ret,
 291                 const char *author, const char *sign_commit);
 292
 293 int commit_tree_extended(const char *msg, size_t msg_len,
 294                          const struct object_id *tree,
 295                          struct commit_list *parents, struct object_id *ret,
 296                          const char *author, const char *committer,
 297                          const char *sign_commit, struct commit_extra_header *);
 298
 299 struct commit_extra_header *read_commit_extra_headers(struct commit *, const char **);
 300
 301 void free_commit_extra_headers(struct commit_extra_header *extra);
 302
 303 /*
 304  * Search the commit object contents given by "msg" for the header "key".
 305  * Reads up to "len" bytes of "msg".
 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  */
 312 const char *find_header_mem(const char *msg, size_t len,
 313                         const char *key,
 314                         size_t *out_len);
 315
 316 const char *find_commit_header(const char *msg, const char *key,
 317                                size_t *out_len);
 318
 319 /* Find the end of the log message, the right place for a new trailer. */
 320 size_t ignore_non_trailer(const char *buf, size_t len);
 321
 322 typedef int (*each_mergetag_fn)(struct commit *commit, struct commit_extra_header *extra,
 323                                 void *cb_data);
 324
 325 int for_each_mergetag(each_mergetag_fn fn, struct commit *commit, void *data);
 326
 327 struct merge_remote_desc {
 328         struct object *obj; /* the named object, could be a tag */
 329         char name[FLEX_ARRAY];
 330 };
 331 struct merge_remote_desc *merge_remote_util(struct commit *);
 332 void set_merge_remote_desc(struct commit *commit,
 333                            const char *name, struct object *obj);
 334
 335 /*
 336  * Given "name" from the command line to merge, find the commit object
 337  * and return it, while storing merge_remote_desc in its ->util field,
 338  * to allow callers to tell if we are told to merge a tag.
 339  */
 340 struct commit *get_merge_parent(const char *name);
 341
 342 int parse_signed_commit(const struct commit *commit,
 343                         struct strbuf *message, struct strbuf *signature,
 344                         const struct git_hash_algo *algop);
 345 int remove_signature(struct strbuf *buf);
 346
 347 /*
 348  * Check the signature of the given commit. The result of the check is stored
 349  * in sig->check_result, 'G' for a good signature, 'U' for a good signature
 350  * from an untrusted signer, 'B' for a bad signature and 'N' for no signature
 351  * at all.  This may allocate memory for sig->gpg_output, sig->gpg_status,
 352  * sig->signer and sig->key.
 353  */
 354 int check_commit_signature(const struct commit *commit, struct signature_check *sigc);
 355
 356 /* record author-date for each commit object */
 357 struct author_date_slab;
 358 void record_author_date(struct author_date_slab *author_date,
 359                         struct commit *commit);
 360
 361 int compare_commits_by_author_date(const void *a_, const void *b_, void *unused);
 362
 363 /*
 364  * Verify a single commit with check_commit_signature() and die() if it is not
 365  * a good signature. This isn't really suitable for general use, but is a
 366  * helper to implement consistent logic for pull/merge --verify-signatures.
 367  *
 368  * The check_trust parameter is meant for backward-compatibility.  The GPG
 369  * interface verifies key trust with a default trust level that is below the
 370  * default trust level for merge operations.  Its value should be non-zero if
 371  * the user hasn't set a minimum trust level explicitly in their configuration.
 372  *
 373  * If the user has set a minimum trust level, then that value should be obeyed
 374  * and check_trust should be zero, even if the configured trust level is below
 375  * the default trust level for merges.
 376  */
 377 void verify_merge_signature(struct commit *commit, int verbose,
 378                             int check_trust);
 379
 380 int compare_commits_by_commit_date(const void *a_, const void *b_, void *unused);
 381 int compare_commits_by_gen_then_commit_date(const void *a_, const void *b_, void *unused);
 382
 383 LAST_ARG_MUST_BE_NULL
 384 int run_commit_hook(int editor_is_used, const char *index_file,
 385                     int *invoked_hook, const char *name, ...);
 386
 387 /* Sign a commit or tag buffer, storing the result in a header. */
 388 int sign_with_header(struct strbuf *buf, const char *keyid);
 389 /* Parse the signature out of a header. */
 390 int parse_buffer_signed_by_header(const char *buffer,
 391                                   unsigned long size,
 392                                   struct strbuf *payload,
 393                                   struct strbuf *signature,
 394                                   const struct git_hash_algo *algop);
 395
 396 #endif /* COMMIT_H */