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 0xFFFFFFFF
  15 #define GENERATION_NUMBER_MAX 0x3FFFFFFF
  16 #define GENERATION_NUMBER_ZERO 0
  17
  18 struct commit_list {
  19         struct commit *item;
  20         struct commit_list *next;
  21 };
  22
  23 /*
  24  * The size of this struct matters in full repo walk operations like
  25  * 'git clone' or 'git gc'. Consider using commit-slab to attach data
  26  * to a commit instead of adding new fields here.
  27  */
  28 struct commit {
  29         struct object object;
  30         timestamp_t date;
  31         struct commit_list *parents;
  32
  33         /*
  34          * If the commit is loaded from the commit-graph file, then this
  35          * member may be NULL. Only access it through get_commit_tree()
  36          * or get_commit_tree_oid().
  37          */
  38         struct tree *maybe_tree;
  39         uint32_t graph_pos;
  40         uint32_t generation;
  41         unsigned int index;
  42 };
  43
  44 extern int save_commit_buffer;
  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 struct commit *lookup_commit(struct repository *r, const struct object_id *oid);
  68 struct commit *lookup_commit_reference(struct repository *r,
  69                                        const struct object_id *oid);
  70 struct commit *lookup_commit_reference_gently(struct repository *r,
  71                                               const struct object_id *oid,
  72                                               int quiet);
  73 struct commit *lookup_commit_reference_by_name(const char *name);
  74
  75 /*
  76  * Look up object named by "oid", dereference tag as necessary,
  77  * get a commit and return it. If "oid" does not dereference to
  78  * a commit, use ref_name to report an error and die.
  79  */
  80 struct commit *lookup_commit_or_die(const struct object_id *oid, const char *ref_name);
  81
  82 int parse_commit_buffer(struct repository *r, struct commit *item, const void *buffer, unsigned long size, int check_graph);
  83 int repo_parse_commit_internal(struct repository *r, struct commit *item,
  84                                int quiet_on_missing, int use_commit_graph);
  85 int repo_parse_commit_gently(struct repository *r,
  86                              struct commit *item,
  87                              int quiet_on_missing);
  88 static inline int repo_parse_commit(struct repository *r, struct commit *item)
  89 {
  90         return repo_parse_commit_gently(r, item, 0);
  91 }
  92
  93 static inline int parse_commit_no_graph(struct commit *commit)
  94 {
  95         return repo_parse_commit_internal(the_repository, commit, 0, 0);
  96 }
  97
  98 #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
  99 #define parse_commit_internal(item, quiet, use) repo_parse_commit_internal(the_repository, item, quiet, use)
 100 #define parse_commit_gently(item, quiet) repo_parse_commit_gently(the_repository, item, quiet)
 101 #define parse_commit(item) repo_parse_commit(the_repository, item)
 102 #endif
 103
 104 void parse_commit_or_die(struct commit *item);
 105
 106 struct buffer_slab;
 107 struct buffer_slab *allocate_commit_buffer_slab(void);
 108 void free_commit_buffer_slab(struct buffer_slab *bs);
 109
 110 /*
 111  * Associate an object buffer with the commit. The ownership of the
 112  * memory is handed over to the commit, and must be free()-able.
 113  */
 114 void set_commit_buffer(struct repository *r, struct commit *, void *buffer, unsigned long size);
 115
 116 /*
 117  * Get any cached object buffer associated with the commit. Returns NULL
 118  * if none. The resulting memory should not be freed.
 119  */
 120 const void *get_cached_commit_buffer(struct repository *, const struct commit *, unsigned long *size);
 121
 122 /*
 123  * Get the commit's object contents, either from cache or by reading the object
 124  * from disk. The resulting memory should not be modified, and must be given
 125  * to unuse_commit_buffer when the caller is done.
 126  */
 127 const void *repo_get_commit_buffer(struct repository *r,
 128                                    const struct commit *,
 129                                    unsigned long *size);
 130 #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
 131 #define get_commit_buffer(c, s) repo_get_commit_buffer(the_repository, c, s)
 132 #endif
 133
 134 /*
 135  * Tell the commit subsytem that we are done with a particular commit buffer.
 136  * The commit and buffer should be the input and return value, respectively,
 137  * from an earlier call to get_commit_buffer.  The buffer may or may not be
 138  * freed by this call; callers should not access the memory afterwards.
 139  */
 140 void repo_unuse_commit_buffer(struct repository *r,
 141                               const struct commit *,
 142                               const void *buffer);
 143 #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
 144 #define unuse_commit_buffer(c, b) repo_unuse_commit_buffer(the_repository, c, b)
 145 #endif
 146
 147 /*
 148  * Free any cached object buffer associated with the commit.
 149  */
 150 void free_commit_buffer(struct parsed_object_pool *pool, struct commit *);
 151
 152 struct tree *get_commit_tree(const struct commit *);
 153 struct object_id *get_commit_tree_oid(const struct commit *);
 154
 155 /*
 156  * Release memory related to a commit, including the parent list and
 157  * any cached object buffer.
 158  */
 159 void release_commit_memory(struct parsed_object_pool *pool, struct commit *c);
 160
 161 /*
 162  * Disassociate any cached object buffer from the commit, but do not free it.
 163  * The buffer (or NULL, if none) is returned.
 164  */
 165 const void *detach_commit_buffer(struct commit *, unsigned long *sizep);
 166
 167 /* Find beginning and length of commit subject. */
 168 int find_commit_subject(const char *commit_buffer, const char **subject);
 169
 170 struct commit_list *commit_list_insert(struct commit *item,
 171                                         struct commit_list **list);
 172 struct commit_list **commit_list_append(struct commit *commit,
 173                                         struct commit_list **next);
 174 unsigned commit_list_count(const struct commit_list *l);
 175 struct commit_list *commit_list_insert_by_date(struct commit *item,
 176                                     struct commit_list **list);
 177 void commit_list_sort_by_date(struct commit_list **list);
 178
 179 /* Shallow copy of the input list */
 180 struct commit_list *copy_commit_list(struct commit_list *list);
 181
 182 void free_commit_list(struct commit_list *list);
 183
 184 struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
 185
 186 extern int has_non_ascii(const char *text);
 187 extern const char *logmsg_reencode(const struct commit *commit,
 188                                    char **commit_encoding,
 189                                    const char *output_encoding);
 190 const char *repo_logmsg_reencode(struct repository *r,
 191                                  const struct commit *commit,
 192                                  char **commit_encoding,
 193                                  const char *output_encoding);
 194 #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
 195 #define logmsg_reencode(c, enc, out) repo_logmsg_reencode(the_repository, c, enc, out)
 196 #endif
 197
 198 extern 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 int register_commit_graft(struct repository *r, struct commit_graft *, int);
 239 void prepare_commit_graft(struct repository *r);
 240 struct commit_graft *lookup_commit_graft(struct repository *r, const struct object_id *oid);
 241
 242 struct commit *get_fork_point(const char *refname, struct commit *commit);
 243
 244 /* largest positive number a signed 32-bit integer can contain */
 245 #define INFINITE_DEPTH 0x7fffffff
 246
 247 struct oid_array;
 248 struct ref;
 249 extern int register_shallow(struct repository *r, const struct object_id *oid);
 250 extern int unregister_shallow(const struct object_id *oid);
 251 extern int for_each_commit_graft(each_commit_graft_fn, void *);
 252 extern int is_repository_shallow(struct repository *r);
 253 extern struct commit_list *get_shallow_commits(struct object_array *heads,
 254                 int depth, int shallow_flag, int not_shallow_flag);
 255 extern struct commit_list *get_shallow_commits_by_rev_list(
 256                 int ac, const char **av, int shallow_flag, int not_shallow_flag);
 257 extern void set_alternate_shallow_file(struct repository *r, const char *path, int override);
 258 extern int write_shallow_commits(struct strbuf *out, int use_pack_protocol,
 259                                  const struct oid_array *extra);
 260 extern void setup_alternate_shallow(struct lock_file *shallow_lock,
 261                                     const char **alternate_shallow_file,
 262                                     const struct oid_array *extra);
 263 extern const char *setup_temporary_shallow(const struct oid_array *extra);
 264 extern void advertise_shallow_grafts(int);
 265
 266 /*
 267  * Initialize with prepare_shallow_info() or zero-initialize (equivalent to
 268  * prepare_shallow_info with a NULL oid_array).
 269  */
 270 struct shallow_info {
 271         struct oid_array *shallow;
 272         int *ours, nr_ours;
 273         int *theirs, nr_theirs;
 274         struct oid_array *ref;
 275
 276         /* for receive-pack */
 277         uint32_t **used_shallow;
 278         int *need_reachability_test;
 279         int *reachable;
 280         int *shallow_ref;
 281         struct commit **commits;
 282         int nr_commits;
 283 };
 284
 285 extern void prepare_shallow_info(struct shallow_info *, struct oid_array *);
 286 extern void clear_shallow_info(struct shallow_info *);
 287 extern void remove_nonexistent_theirs_shallow(struct shallow_info *);
 288 extern void assign_shallow_commits_to_refs(struct shallow_info *info,
 289                                            uint32_t **used,
 290                                            int *ref_status);
 291 extern int delayed_reachability_test(struct shallow_info *si, int c);
 292 #define PRUNE_SHOW_ONLY 1
 293 #define PRUNE_QUICK 2
 294 extern void prune_shallow(unsigned options);
 295 extern struct trace_key trace_shallow;
 296
 297 extern int interactive_add(int argc, const char **argv, const char *prefix, int patch);
 298 extern int run_add_interactive(const char *revision, const char *patch_mode,
 299                                const struct pathspec *pathspec);
 300
 301 struct commit_extra_header {
 302         struct commit_extra_header *next;
 303         char *key;
 304         char *value;
 305         size_t len;
 306 };
 307
 308 extern void append_merge_tag_headers(struct commit_list *parents,
 309                                      struct commit_extra_header ***tail);
 310
 311 extern int commit_tree(const char *msg, size_t msg_len,
 312                        const struct object_id *tree,
 313                        struct commit_list *parents, struct object_id *ret,
 314                        const char *author, const char *sign_commit);
 315
 316 extern int commit_tree_extended(const char *msg, size_t msg_len,
 317                                 const struct object_id *tree,
 318                                 struct commit_list *parents,
 319                                 struct object_id *ret, const char *author,
 320                                 const char *sign_commit,
 321                                 struct commit_extra_header *);
 322
 323 extern struct commit_extra_header *read_commit_extra_headers(struct commit *, const char **);
 324
 325 extern void free_commit_extra_headers(struct commit_extra_header *extra);
 326
 327 /*
 328  * Search the commit object contents given by "msg" for the header "key".
 329  * Returns a pointer to the start of the header contents, or NULL. The length
 330  * of the header, up to the first newline, is returned via out_len.
 331  *
 332  * Note that some headers (like mergetag) may be multi-line. It is the caller's
 333  * responsibility to parse further in this case!
 334  */
 335 extern const char *find_commit_header(const char *msg, const char *key,
 336                                       size_t *out_len);
 337
 338 /* Find the end of the log message, the right place for a new trailer. */
 339 extern size_t ignore_non_trailer(const char *buf, size_t len);
 340
 341 typedef int (*each_mergetag_fn)(struct commit *commit, struct commit_extra_header *extra,
 342                                  void *cb_data);
 343
 344 extern int for_each_mergetag(each_mergetag_fn fn, struct commit *commit, void *data);
 345
 346 struct merge_remote_desc {
 347         struct object *obj; /* the named object, could be a tag */
 348         char name[FLEX_ARRAY];
 349 };
 350 extern struct merge_remote_desc *merge_remote_util(struct commit *);
 351 extern void set_merge_remote_desc(struct commit *commit,
 352                                   const char *name, struct object *obj);
 353
 354 /*
 355  * Given "name" from the command line to merge, find the commit object
 356  * and return it, while storing merge_remote_desc in its ->util field,
 357  * to allow callers to tell if we are told to merge a tag.
 358  */
 359 struct commit *get_merge_parent(const char *name);
 360
 361 extern int parse_signed_commit(const struct commit *commit,
 362                                struct strbuf *message, struct strbuf *signature);
 363 extern int remove_signature(struct strbuf *buf);
 364
 365 /*
 366  * Check the signature of the given commit. The result of the check is stored
 367  * in sig->check_result, 'G' for a good signature, 'U' for a good signature
 368  * from an untrusted signer, 'B' for a bad signature and 'N' for no signature
 369  * at all.  This may allocate memory for sig->gpg_output, sig->gpg_status,
 370  * sig->signer and sig->key.
 371  */
 372 extern int check_commit_signature(const struct commit *commit, struct signature_check *sigc);
 373
 374 /* record author-date for each commit object */
 375 struct author_date_slab;
 376 void record_author_date(struct author_date_slab *author_date,
 377                         struct commit *commit);
 378
 379 int compare_commits_by_author_date(const void *a_, const void *b_, void *unused);
 380
 381 /*
 382  * Verify a single commit with check_commit_signature() and die() if it is not
 383  * a good signature. This isn't really suitable for general use, but is a
 384  * helper to implement consistent logic for pull/merge --verify-signatures.
 385  */
 386 void verify_merge_signature(struct commit *commit, int verbose);
 387
 388 int compare_commits_by_commit_date(const void *a_, const void *b_, void *unused);
 389 int compare_commits_by_gen_then_commit_date(const void *a_, const void *b_, void *unused);
 390
 391 LAST_ARG_MUST_BE_NULL
 392 extern int run_commit_hook(int editor_is_used, const char *index_file, const char *name, ...);
 393
 394 #endif /* COMMIT_H */