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 struct commit *lookup_commit_reference_by_name_gently(const char *name,
  85                                                       int quiet);
  86
  87 /*
  88  * Look up object named by "oid", dereference tag as necessary,
  89  * get a commit and return it. If "oid" does not dereference to
  90  * a commit, use ref_name to report an error and die.
  91  */
  92 struct commit *lookup_commit_or_die(const struct object_id *oid, const char *ref_name);
  93
  94 int parse_commit_buffer(struct repository *r, struct commit *item, const void *buffer, unsigned long size, int check_graph);
  95 int repo_parse_commit_internal(struct repository *r, struct commit *item,
  96                                int quiet_on_missing, int use_commit_graph);
  97 int repo_parse_commit_gently(struct repository *r,
  98                              struct commit *item,
  99                              int quiet_on_missing);
 100 static inline int repo_parse_commit(struct repository *r, struct commit *item)
 101 {
 102         return repo_parse_commit_gently(r, item, 0);
 103 }
 104
 105 static inline int repo_parse_commit_no_graph(struct repository *r,
 106                                              struct commit *commit)
 107 {
 108         return repo_parse_commit_internal(r, commit, 0, 0);
 109 }
 110
 111 void parse_commit_or_die(struct commit *item);
 112
 113 void unparse_commit(struct repository *r, const struct object_id *oid);
 114
 115 struct buffer_slab;
 116 struct buffer_slab *allocate_commit_buffer_slab(void);
 117 void free_commit_buffer_slab(struct buffer_slab *bs);
 118
 119 /*
 120  * Associate an object buffer with the commit. The ownership of the
 121  * memory is handed over to the commit, and must be free()-able.
 122  */
 123 void set_commit_buffer(struct repository *r, struct commit *, void *buffer, unsigned long size);
 124
 125 /*
 126  * Get any cached object buffer associated with the commit. Returns NULL
 127  * if none. The resulting memory should not be freed.
 128  */
 129 const void *get_cached_commit_buffer(struct repository *, const struct commit *, unsigned long *size);
 130
 131 /*
 132  * Get the commit's object contents, either from cache or by reading the object
 133  * from disk. The resulting memory should not be modified, and must be given
 134  * to repo_unuse_commit_buffer when the caller is done.
 135  */
 136 const void *repo_get_commit_buffer(struct repository *r,
 137                                    const struct commit *,
 138                                    unsigned long *size);
 139
 140 /*
 141  * Tell the commit subsystem that we are done with a particular commit buffer.
 142  * The commit and buffer should be the input and return value, respectively,
 143  * from an earlier call to repo_get_commit_buffer.  The buffer may or may not be
 144  * freed by this call; callers should not access the memory afterwards.
 145  */
 146 void repo_unuse_commit_buffer(struct repository *r,
 147                               const struct commit *,
 148                               const void *buffer);
 149
 150 /*
 151  * Free any cached object buffer associated with the commit.
 152  */
 153 void free_commit_buffer(struct parsed_object_pool *pool, struct commit *);
 154
 155 struct tree *repo_get_commit_tree(struct repository *, const struct commit *);
 156 struct object_id *get_commit_tree_oid(const struct commit *);
 157
 158 /*
 159  * Release memory related to a commit, including the parent list and
 160  * any cached object buffer.
 161  */
 162 void release_commit_memory(struct parsed_object_pool *pool, struct commit *c);
 163
 164 /*
 165  * Disassociate any cached object buffer from the commit, but do not free it.
 166  * The buffer (or NULL, if none) is returned.
 167  */
 168 const void *detach_commit_buffer(struct commit *, unsigned long *sizep);
 169
 170 /* Find beginning and length of commit subject. */
 171 int find_commit_subject(const char *commit_buffer, const char **subject);
 172
 173 /* Return length of the commit subject from commit log message. */
 174 size_t commit_subject_length(const char *body);
 175
 176 struct commit_list *commit_list_insert(struct commit *item,
 177                                         struct commit_list **list);
 178 int commit_list_contains(struct commit *item,
 179                          struct commit_list *list);
 180 struct commit_list **commit_list_append(struct commit *commit,
 181                                         struct commit_list **next);
 182 unsigned commit_list_count(const struct commit_list *l);
 183 struct commit_list *commit_list_insert_by_date(struct commit *item,
 184                                     struct commit_list **list);
 185 void commit_list_sort_by_date(struct commit_list **list);
 186
 187 /* Shallow copy of the input list */
 188 struct commit_list *copy_commit_list(const struct commit_list *list);
 189
 190 /* Modify list in-place to reverse it, returning new head; list will be tail */
 191 struct commit_list *reverse_commit_list(struct commit_list *list);
 192
 193 void free_commit_list(struct commit_list *list);
 194
 195 struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
 196
 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
 248 struct commit *get_fork_point(const char *refname, struct commit *commit);
 249
 250 /* largest positive number a signed 32-bit integer can contain */
 251 #define INFINITE_DEPTH 0x7fffffff
 252
 253 struct oid_array;
 254 struct ref;
 255 int for_each_commit_graft(each_commit_graft_fn, void *);
 256
 257 int interactive_add(const char **argv, const char *prefix, int patch);
 258
 259 struct commit_extra_header {
 260         struct commit_extra_header *next;
 261         char *key;
 262         char *value;
 263         size_t len;
 264 };
 265
 266 void append_merge_tag_headers(const struct commit_list *parents,
 267                               struct commit_extra_header ***tail);
 268
 269 int commit_tree(const char *msg, size_t msg_len,
 270                 const struct object_id *tree,
 271                 const struct commit_list *parents, struct object_id *ret,
 272                 const char *author, const char *sign_commit);
 273
 274 int commit_tree_extended(const char *msg, size_t msg_len,
 275                          const struct object_id *tree,
 276                          const struct commit_list *parents, struct object_id *ret,
 277                          const char *author, const char *committer,
 278                          const char *sign_commit, const struct commit_extra_header *);
 279
 280 struct commit_extra_header *read_commit_extra_headers(struct commit *, const char **);
 281
 282 void free_commit_extra_headers(struct commit_extra_header *extra);
 283
 284 /*
 285  * Search the commit object contents given by "msg" for the header "key".
 286  * Returns a pointer to the start of the header contents, or NULL. The length
 287  * of the header, up to the first newline, is returned via out_len.
 288  *
 289  * Note that some headers (like mergetag) may be multi-line. It is the caller's
 290  * responsibility to parse further in this case!
 291  */
 292 const char *find_commit_header(const char *msg, const char *key,
 293                                size_t *out_len);
 294
 295 /* Find the number of bytes to ignore from the end of a log message. */
 296 size_t ignored_log_message_bytes(const char *buf, size_t len);
 297
 298 typedef int (*each_mergetag_fn)(struct commit *commit, struct commit_extra_header *extra,
 299                                 void *cb_data);
 300
 301 int for_each_mergetag(each_mergetag_fn fn, struct commit *commit, void *data);
 302
 303 struct merge_remote_desc {
 304         struct object *obj; /* the named object, could be a tag */
 305         char name[FLEX_ARRAY];
 306 };
 307 struct merge_remote_desc *merge_remote_util(const struct commit *);
 308 void set_merge_remote_desc(struct commit *commit,
 309                            const char *name, struct object *obj);
 310
 311 /*
 312  * Given "name" from the command line to merge, find the commit object
 313  * and return it, while storing merge_remote_desc in its ->util field,
 314  * to allow callers to tell if we are told to merge a tag.
 315  */
 316 struct commit *get_merge_parent(const char *name);
 317
 318 int parse_signed_commit(const struct commit *commit,
 319                         struct strbuf *message, struct strbuf *signature,
 320                         const struct git_hash_algo *algop);
 321 int remove_signature(struct strbuf *buf);
 322
 323 /*
 324  * Check the signature of the given commit. The result of the check is stored
 325  * in sig->check_result, 'G' for a good signature, 'U' for a good signature
 326  * from an untrusted signer, 'B' for a bad signature and 'N' for no signature
 327  * at all.  This may allocate memory for sig->gpg_output, sig->gpg_status,
 328  * sig->signer and sig->key.
 329  */
 330 int check_commit_signature(const struct commit *commit, struct signature_check *sigc);
 331
 332 /* record author-date for each commit object */
 333 struct author_date_slab;
 334 void record_author_date(struct author_date_slab *author_date,
 335                         struct commit *commit);
 336
 337 int compare_commits_by_author_date(const void *a_, const void *b_, void *unused);
 338
 339 /*
 340  * Verify a single commit with check_commit_signature() and die() if it is not
 341  * a good signature. This isn't really suitable for general use, but is a
 342  * helper to implement consistent logic for pull/merge --verify-signatures.
 343  *
 344  * The check_trust parameter is meant for backward-compatibility.  The GPG
 345  * interface verifies key trust with a default trust level that is below the
 346  * default trust level for merge operations.  Its value should be non-zero if
 347  * the user hasn't set a minimum trust level explicitly in their configuration.
 348  *
 349  * If the user has set a minimum trust level, then that value should be obeyed
 350  * and check_trust should be zero, even if the configured trust level is below
 351  * the default trust level for merges.
 352  */
 353 void verify_merge_signature(struct commit *commit, int verbose,
 354                             int check_trust);
 355
 356 int compare_commits_by_commit_date(const void *a_, const void *b_, void *unused);
 357 int compare_commits_by_gen_then_commit_date(const void *a_, const void *b_, void *unused);
 358
 359 LAST_ARG_MUST_BE_NULL
 360 int run_commit_hook(int editor_is_used, const char *index_file,
 361                     int *invoked_hook, const char *name, ...);
 362
 363 /* Sign a commit or tag buffer, storing the result in a header. */
 364 int sign_with_header(struct strbuf *buf, const char *keyid);
 365 /* Parse the signature out of a header. */
 366 int parse_buffer_signed_by_header(const char *buffer,
 367                                   unsigned long size,
 368                                   struct strbuf *payload,
 369                                   struct strbuf *signature,
 370                                   const struct git_hash_algo *algop);
 371 int add_header_signature(struct strbuf *buf, struct strbuf *sig, const struct git_hash_algo *algo);
 372
 373 #endif /* COMMIT_H */