commit.h

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