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 void parse_commit_or_die(struct commit *item);
 113
 114 struct buffer_slab;
 115 struct buffer_slab *allocate_commit_buffer_slab(void);
 116 void free_commit_buffer_slab(struct buffer_slab *bs);
 117
 118 /*
 119  * Associate an object buffer with the commit. The ownership of the
 120  * memory is handed over to the commit, and must be free()-able.
 121  */
 122 void set_commit_buffer(struct repository *r, struct commit *, void *buffer, unsigned long size);
 123
 124 /*
 125  * Get any cached object buffer associated with the commit. Returns NULL
 126  * if none. The resulting memory should not be freed.
 127  */
 128 const void *get_cached_commit_buffer(struct repository *, const struct commit *, unsigned long *size);
 129
 130 /*
 131  * Get the commit's object contents, either from cache or by reading the object
 132  * from disk. The resulting memory should not be modified, and must be given
 133  * to unuse_commit_buffer when the caller is done.
 134  */
 135 const void *repo_get_commit_buffer(struct repository *r,
 136                                    const struct commit *,
 137                                    unsigned long *size);
 138
 139 /*
 140  * Tell the commit subsystem that we are done with a particular commit buffer.
 141  * The commit and buffer should be the input and return value, respectively,
 142  * from an earlier call to get_commit_buffer.  The buffer may or may not be
 143  * freed by this call; callers should not access the memory afterwards.
 144  */
 145 void repo_unuse_commit_buffer(struct repository *r,
 146                               const struct commit *,
 147                               const void *buffer);
 148
 149 /*
 150  * Free any cached object buffer associated with the commit.
 151  */
 152 void free_commit_buffer(struct parsed_object_pool *pool, struct commit *);
 153
 154 struct tree *repo_get_commit_tree(struct repository *, const struct commit *);
 155 struct object_id *get_commit_tree_oid(const struct commit *);
 156
 157 /*
 158  * Release memory related to a commit, including the parent list and
 159  * any cached object buffer.
 160  */
 161 void release_commit_memory(struct parsed_object_pool *pool, struct commit *c);
 162
 163 /*
 164  * Disassociate any cached object buffer from the commit, but do not free it.
 165  * The buffer (or NULL, if none) is returned.
 166  */
 167 const void *detach_commit_buffer(struct commit *, unsigned long *sizep);
 168
 169 /* Find beginning and length of commit subject. */
 170 int find_commit_subject(const char *commit_buffer, const char **subject);
 171
 172 /* Return length of the commit subject from commit log message. */
 173 size_t commit_subject_length(const char *body);
 174
 175 struct commit_list *commit_list_insert(struct commit *item,
 176                                         struct commit_list **list);
 177 int commit_list_contains(struct commit *item,
 178                          struct commit_list *list);
 179 struct commit_list **commit_list_append(struct commit *commit,
 180                                         struct commit_list **next);
 181 unsigned commit_list_count(const struct commit_list *l);
 182 struct commit_list *commit_list_insert_by_date(struct commit *item,
 183                                     struct commit_list **list);
 184 void commit_list_sort_by_date(struct commit_list **list);
 185
 186 /* Shallow copy of the input list */
 187 struct commit_list *copy_commit_list(struct commit_list *list);
 188
 189 /* Modify list in-place to reverse it, returning new head; list will be tail */
 190 struct commit_list *reverse_commit_list(struct commit_list *list);
 191
 192 void free_commit_list(struct commit_list *list);
 193
 194 struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
 195
 196 int has_non_ascii(const char *text);
 197 const char *repo_logmsg_reencode(struct repository *r,
 198                                  const struct commit *commit,
 199                                  char **commit_encoding,
 200                                  const char *output_encoding);
 201
 202 const char *skip_blank_lines(const char *msg);
 203
 204 /** Removes the first commit from a list sorted by date, and adds all
 205  * of its parents.
 206  **/
 207 struct commit *pop_most_recent_commit(struct commit_list **list,
 208                                       unsigned int mark);
 209
 210 struct commit *pop_commit(struct commit_list **stack);
 211
 212 void clear_commit_marks(struct commit *commit, unsigned int mark);
 213 void clear_commit_marks_many(int nr, struct commit **commit, unsigned int mark);
 214
 215
 216 enum rev_sort_order {
 217         REV_SORT_IN_GRAPH_ORDER = 0,
 218         REV_SORT_BY_COMMIT_DATE,
 219         REV_SORT_BY_AUTHOR_DATE
 220 };
 221
 222 /*
 223  * Performs an in-place topological sort of list supplied.
 224  *
 225  *   invariant of resulting list is:
 226  *      a reachable from b => ord(b) < ord(a)
 227  *   sort_order further specifies:
 228  *   REV_SORT_IN_GRAPH_ORDER: try to show a commit on a single-parent
 229  *                            chain together.
 230  *   REV_SORT_BY_COMMIT_DATE: show eligible commits in committer-date order.
 231  */
 232 void sort_in_topological_order(struct commit_list **, enum rev_sort_order);
 233
 234 struct commit_graft {
 235         struct object_id oid;
 236         int nr_parent; /* < 0 if shallow commit */
 237         struct object_id parent[FLEX_ARRAY]; /* more */
 238 };
 239 typedef int (*each_commit_graft_fn)(const struct commit_graft *, void *);
 240
 241 struct commit_graft *read_graft_line(struct strbuf *line);
 242 /* commit_graft_pos returns an index into r->parsed_objects->grafts. */
 243 int commit_graft_pos(struct repository *r, const struct object_id *oid);
 244 int register_commit_graft(struct repository *r, struct commit_graft *, int);
 245 void prepare_commit_graft(struct repository *r);
 246 struct commit_graft *lookup_commit_graft(struct repository *r, const struct object_id *oid);
 247 void reset_commit_grafts(struct repository *r);
 248
 249 struct commit *get_fork_point(const char *refname, struct commit *commit);
 250
 251 /* largest positive number a signed 32-bit integer can contain */
 252 #define INFINITE_DEPTH 0x7fffffff
 253
 254 struct oid_array;
 255 struct ref;
 256 int for_each_commit_graft(each_commit_graft_fn, void *);
 257
 258 int interactive_add(const char **argv, const char *prefix, int patch);
 259
 260 struct commit_extra_header {
 261         struct commit_extra_header *next;
 262         char *key;
 263         char *value;
 264         size_t len;
 265 };
 266
 267 void append_merge_tag_headers(struct commit_list *parents,
 268                               struct commit_extra_header ***tail);
 269
 270 int commit_tree(const char *msg, size_t msg_len,
 271                 const struct object_id *tree,
 272                 struct commit_list *parents, struct object_id *ret,
 273                 const char *author, const char *sign_commit);
 274
 275 int commit_tree_extended(const char *msg, size_t msg_len,
 276                          const struct object_id *tree,
 277                          struct commit_list *parents, struct object_id *ret,
 278                          const char *author, const char *committer,
 279                          const char *sign_commit, struct commit_extra_header *);
 280
 281 struct commit_extra_header *read_commit_extra_headers(struct commit *, const char **);
 282
 283 void free_commit_extra_headers(struct commit_extra_header *extra);
 284
 285 /*
 286  * Search the commit object contents given by "msg" for the header "key".
 287  * Reads up to "len" bytes of "msg".
 288  * Returns a pointer to the start of the header contents, or NULL. The length
 289  * of the header, up to the first newline, is returned via out_len.
 290  *
 291  * Note that some headers (like mergetag) may be multi-line. It is the caller's
 292  * responsibility to parse further in this case!
 293  */
 294 const char *find_header_mem(const char *msg, size_t len,
 295                         const char *key,
 296                         size_t *out_len);
 297
 298 const char *find_commit_header(const char *msg, const char *key,
 299                                size_t *out_len);
 300
 301 /* Find the end of the log message, the right place for a new trailer. */
 302 size_t ignore_non_trailer(const char *buf, size_t len);
 303
 304 typedef int (*each_mergetag_fn)(struct commit *commit, struct commit_extra_header *extra,
 305                                 void *cb_data);
 306
 307 int for_each_mergetag(each_mergetag_fn fn, struct commit *commit, void *data);
 308
 309 struct merge_remote_desc {
 310         struct object *obj; /* the named object, could be a tag */
 311         char name[FLEX_ARRAY];
 312 };
 313 struct merge_remote_desc *merge_remote_util(struct commit *);
 314 void set_merge_remote_desc(struct commit *commit,
 315                            const char *name, struct object *obj);
 316
 317 /*
 318  * Given "name" from the command line to merge, find the commit object
 319  * and return it, while storing merge_remote_desc in its ->util field,
 320  * to allow callers to tell if we are told to merge a tag.
 321  */
 322 struct commit *get_merge_parent(const char *name);
 323
 324 int parse_signed_commit(const struct commit *commit,
 325                         struct strbuf *message, struct strbuf *signature,
 326                         const struct git_hash_algo *algop);
 327 int remove_signature(struct strbuf *buf);
 328
 329 /*
 330  * Check the signature of the given commit. The result of the check is stored
 331  * in sig->check_result, 'G' for a good signature, 'U' for a good signature
 332  * from an untrusted signer, 'B' for a bad signature and 'N' for no signature
 333  * at all.  This may allocate memory for sig->gpg_output, sig->gpg_status,
 334  * sig->signer and sig->key.
 335  */
 336 int check_commit_signature(const struct commit *commit, struct signature_check *sigc);
 337
 338 /* record author-date for each commit object */
 339 struct author_date_slab;
 340 void record_author_date(struct author_date_slab *author_date,
 341                         struct commit *commit);
 342
 343 int compare_commits_by_author_date(const void *a_, const void *b_, void *unused);
 344
 345 /*
 346  * Verify a single commit with check_commit_signature() and die() if it is not
 347  * a good signature. This isn't really suitable for general use, but is a
 348  * helper to implement consistent logic for pull/merge --verify-signatures.
 349  *
 350  * The check_trust parameter is meant for backward-compatibility.  The GPG
 351  * interface verifies key trust with a default trust level that is below the
 352  * default trust level for merge operations.  Its value should be non-zero if
 353  * the user hasn't set a minimum trust level explicitly in their configuration.
 354  *
 355  * If the user has set a minimum trust level, then that value should be obeyed
 356  * and check_trust should be zero, even if the configured trust level is below
 357  * the default trust level for merges.
 358  */
 359 void verify_merge_signature(struct commit *commit, int verbose,
 360                             int check_trust);
 361
 362 int compare_commits_by_commit_date(const void *a_, const void *b_, void *unused);
 363 int compare_commits_by_gen_then_commit_date(const void *a_, const void *b_, void *unused);
 364
 365 LAST_ARG_MUST_BE_NULL
 366 int run_commit_hook(int editor_is_used, const char *index_file,
 367                     int *invoked_hook, const char *name, ...);
 368
 369 /* Sign a commit or tag buffer, storing the result in a header. */
 370 int sign_with_header(struct strbuf *buf, const char *keyid);
 371 /* Parse the signature out of a header. */
 372 int parse_buffer_signed_by_header(const char *buffer,
 373                                   unsigned long size,
 374                                   struct strbuf *payload,
 375                                   struct strbuf *signature,
 376                                   const struct git_hash_algo *algop);
 377
 378 #endif /* COMMIT_H */