ci: ignore rubygems warning in the "Documentation" job
[git/debian.git] / commit.c
blob434ec030d6b2a0074c46c376c6322c92fd5c8a39
1 #include "cache.h"
2 #include "tag.h"
3 #include "commit.h"
4 #include "commit-graph.h"
5 #include "repository.h"
6 #include "object-store.h"
7 #include "pkt-line.h"
8 #include "utf8.h"
9 #include "diff.h"
10 #include "revision.h"
11 #include "notes.h"
12 #include "alloc.h"
13 #include "gpg-interface.h"
14 #include "mergesort.h"
15 #include "commit-slab.h"
16 #include "prio-queue.h"
17 #include "sha1-lookup.h"
18 #include "wt-status.h"
19 #include "advice.h"
20 #include "refs.h"
21 #include "commit-reach.h"
22 #include "run-command.h"
24 static struct commit_extra_header *read_commit_extra_header_lines(const char *buf, size_t len, const char **);
26 int save_commit_buffer = 1;
28 const char *commit_type = "commit";
30 struct commit *lookup_commit_reference_gently(struct repository *r,
31 const struct object_id *oid, int quiet)
33 struct object *obj = deref_tag(r,
34 parse_object(r, oid),
35 NULL, 0);
37 if (!obj)
38 return NULL;
39 return object_as_type(r, obj, OBJ_COMMIT, quiet);
42 struct commit *lookup_commit_reference(struct repository *r, const struct object_id *oid)
44 return lookup_commit_reference_gently(r, oid, 0);
47 struct commit *lookup_commit_or_die(const struct object_id *oid, const char *ref_name)
49 struct commit *c = lookup_commit_reference(the_repository, oid);
50 if (!c)
51 die(_("could not parse %s"), ref_name);
52 if (!oideq(oid, &c->object.oid)) {
53 warning(_("%s %s is not a commit!"),
54 ref_name, oid_to_hex(oid));
56 return c;
59 struct commit *lookup_commit(struct repository *r, const struct object_id *oid)
61 struct object *obj = lookup_object(r, oid);
62 if (!obj)
63 return create_object(r, oid, alloc_commit_node(r));
64 return object_as_type(r, obj, OBJ_COMMIT, 0);
67 struct commit *lookup_commit_reference_by_name(const char *name)
69 struct object_id oid;
70 struct commit *commit;
72 if (get_oid_committish(name, &oid))
73 return NULL;
74 commit = lookup_commit_reference(the_repository, &oid);
75 if (parse_commit(commit))
76 return NULL;
77 return commit;
80 static timestamp_t parse_commit_date(const char *buf, const char *tail)
82 const char *dateptr;
84 if (buf + 6 >= tail)
85 return 0;
86 if (memcmp(buf, "author", 6))
87 return 0;
88 while (buf < tail && *buf++ != '\n')
89 /* nada */;
90 if (buf + 9 >= tail)
91 return 0;
92 if (memcmp(buf, "committer", 9))
93 return 0;
94 while (buf < tail && *buf++ != '>')
95 /* nada */;
96 if (buf >= tail)
97 return 0;
98 dateptr = buf;
99 while (buf < tail && *buf++ != '\n')
100 /* nada */;
101 if (buf >= tail)
102 return 0;
103 /* dateptr < buf && buf[-1] == '\n', so parsing will stop at buf-1 */
104 return parse_timestamp(dateptr, NULL, 10);
107 static const unsigned char *commit_graft_sha1_access(size_t index, void *table)
109 struct commit_graft **commit_graft_table = table;
110 return commit_graft_table[index]->oid.hash;
113 static int commit_graft_pos(struct repository *r, const unsigned char *sha1)
115 return sha1_pos(sha1, r->parsed_objects->grafts,
116 r->parsed_objects->grafts_nr,
117 commit_graft_sha1_access);
120 int register_commit_graft(struct repository *r, struct commit_graft *graft,
121 int ignore_dups)
123 int pos = commit_graft_pos(r, graft->oid.hash);
125 if (0 <= pos) {
126 if (ignore_dups)
127 free(graft);
128 else {
129 free(r->parsed_objects->grafts[pos]);
130 r->parsed_objects->grafts[pos] = graft;
132 return 1;
134 pos = -pos - 1;
135 ALLOC_GROW(r->parsed_objects->grafts,
136 r->parsed_objects->grafts_nr + 1,
137 r->parsed_objects->grafts_alloc);
138 r->parsed_objects->grafts_nr++;
139 if (pos < r->parsed_objects->grafts_nr)
140 memmove(r->parsed_objects->grafts + pos + 1,
141 r->parsed_objects->grafts + pos,
142 (r->parsed_objects->grafts_nr - pos - 1) *
143 sizeof(*r->parsed_objects->grafts));
144 r->parsed_objects->grafts[pos] = graft;
145 return 0;
148 struct commit_graft *read_graft_line(struct strbuf *line)
150 /* The format is just "Commit Parent1 Parent2 ...\n" */
151 int i, phase;
152 const char *tail = NULL;
153 struct commit_graft *graft = NULL;
154 struct object_id dummy_oid, *oid;
156 strbuf_rtrim(line);
157 if (!line->len || line->buf[0] == '#')
158 return NULL;
160 * phase 0 verifies line, counts hashes in line and allocates graft
161 * phase 1 fills graft
163 for (phase = 0; phase < 2; phase++) {
164 oid = graft ? &graft->oid : &dummy_oid;
165 if (parse_oid_hex(line->buf, oid, &tail))
166 goto bad_graft_data;
167 for (i = 0; *tail != '\0'; i++) {
168 oid = graft ? &graft->parent[i] : &dummy_oid;
169 if (!isspace(*tail++) || parse_oid_hex(tail, oid, &tail))
170 goto bad_graft_data;
172 if (!graft) {
173 graft = xmalloc(st_add(sizeof(*graft),
174 st_mult(sizeof(struct object_id), i)));
175 graft->nr_parent = i;
178 return graft;
180 bad_graft_data:
181 error("bad graft data: %s", line->buf);
182 assert(!graft);
183 return NULL;
186 static int read_graft_file(struct repository *r, const char *graft_file)
188 FILE *fp = fopen_or_warn(graft_file, "r");
189 struct strbuf buf = STRBUF_INIT;
190 if (!fp)
191 return -1;
192 if (advice_graft_file_deprecated)
193 advise(_("Support for <GIT_DIR>/info/grafts is deprecated\n"
194 "and will be removed in a future Git version.\n"
195 "\n"
196 "Please use \"git replace --convert-graft-file\"\n"
197 "to convert the grafts into replace refs.\n"
198 "\n"
199 "Turn this message off by running\n"
200 "\"git config advice.graftFileDeprecated false\""));
201 while (!strbuf_getwholeline(&buf, fp, '\n')) {
202 /* The format is just "Commit Parent1 Parent2 ...\n" */
203 struct commit_graft *graft = read_graft_line(&buf);
204 if (!graft)
205 continue;
206 if (register_commit_graft(r, graft, 1))
207 error("duplicate graft data: %s", buf.buf);
209 fclose(fp);
210 strbuf_release(&buf);
211 return 0;
214 void prepare_commit_graft(struct repository *r)
216 char *graft_file;
218 if (r->parsed_objects->commit_graft_prepared)
219 return;
220 if (!startup_info->have_repository)
221 return;
223 graft_file = get_graft_file(r);
224 read_graft_file(r, graft_file);
225 /* make sure shallows are read */
226 is_repository_shallow(r);
227 r->parsed_objects->commit_graft_prepared = 1;
230 struct commit_graft *lookup_commit_graft(struct repository *r, const struct object_id *oid)
232 int pos;
233 prepare_commit_graft(r);
234 pos = commit_graft_pos(r, oid->hash);
235 if (pos < 0)
236 return NULL;
237 return r->parsed_objects->grafts[pos];
240 int for_each_commit_graft(each_commit_graft_fn fn, void *cb_data)
242 int i, ret;
243 for (i = ret = 0; i < the_repository->parsed_objects->grafts_nr && !ret; i++)
244 ret = fn(the_repository->parsed_objects->grafts[i], cb_data);
245 return ret;
248 int unregister_shallow(const struct object_id *oid)
250 int pos = commit_graft_pos(the_repository, oid->hash);
251 if (pos < 0)
252 return -1;
253 if (pos + 1 < the_repository->parsed_objects->grafts_nr)
254 MOVE_ARRAY(the_repository->parsed_objects->grafts + pos,
255 the_repository->parsed_objects->grafts + pos + 1,
256 the_repository->parsed_objects->grafts_nr - pos - 1);
257 the_repository->parsed_objects->grafts_nr--;
258 return 0;
261 struct commit_buffer {
262 void *buffer;
263 unsigned long size;
265 define_commit_slab(buffer_slab, struct commit_buffer);
267 struct buffer_slab *allocate_commit_buffer_slab(void)
269 struct buffer_slab *bs = xmalloc(sizeof(*bs));
270 init_buffer_slab(bs);
271 return bs;
274 void free_commit_buffer_slab(struct buffer_slab *bs)
276 clear_buffer_slab(bs);
277 free(bs);
280 void set_commit_buffer(struct repository *r, struct commit *commit, void *buffer, unsigned long size)
282 struct commit_buffer *v = buffer_slab_at(
283 r->parsed_objects->buffer_slab, commit);
284 v->buffer = buffer;
285 v->size = size;
288 const void *get_cached_commit_buffer(struct repository *r, const struct commit *commit, unsigned long *sizep)
290 struct commit_buffer *v = buffer_slab_peek(
291 r->parsed_objects->buffer_slab, commit);
292 if (!v) {
293 if (sizep)
294 *sizep = 0;
295 return NULL;
297 if (sizep)
298 *sizep = v->size;
299 return v->buffer;
302 const void *repo_get_commit_buffer(struct repository *r,
303 const struct commit *commit,
304 unsigned long *sizep)
306 const void *ret = get_cached_commit_buffer(r, commit, sizep);
307 if (!ret) {
308 enum object_type type;
309 unsigned long size;
310 ret = repo_read_object_file(r, &commit->object.oid, &type, &size);
311 if (!ret)
312 die("cannot read commit object %s",
313 oid_to_hex(&commit->object.oid));
314 if (type != OBJ_COMMIT)
315 die("expected commit for %s, got %s",
316 oid_to_hex(&commit->object.oid), type_name(type));
317 if (sizep)
318 *sizep = size;
320 return ret;
323 void repo_unuse_commit_buffer(struct repository *r,
324 const struct commit *commit,
325 const void *buffer)
327 struct commit_buffer *v = buffer_slab_peek(
328 r->parsed_objects->buffer_slab, commit);
329 if (!(v && v->buffer == buffer))
330 free((void *)buffer);
333 void free_commit_buffer(struct parsed_object_pool *pool, struct commit *commit)
335 struct commit_buffer *v = buffer_slab_peek(
336 pool->buffer_slab, commit);
337 if (v) {
338 FREE_AND_NULL(v->buffer);
339 v->size = 0;
343 static inline void set_commit_tree(struct commit *c, struct tree *t)
345 c->maybe_tree = t;
348 struct tree *repo_get_commit_tree(struct repository *r,
349 const struct commit *commit)
351 if (commit->maybe_tree || !commit->object.parsed)
352 return commit->maybe_tree;
354 if (commit->graph_pos != COMMIT_NOT_FROM_GRAPH)
355 return get_commit_tree_in_graph(r, commit);
357 return NULL;
360 struct object_id *get_commit_tree_oid(const struct commit *commit)
362 struct tree *tree = get_commit_tree(commit);
363 return tree ? &tree->object.oid : NULL;
366 void release_commit_memory(struct parsed_object_pool *pool, struct commit *c)
368 set_commit_tree(c, NULL);
369 free_commit_buffer(pool, c);
370 c->index = 0;
371 free_commit_list(c->parents);
373 c->object.parsed = 0;
376 const void *detach_commit_buffer(struct commit *commit, unsigned long *sizep)
378 struct commit_buffer *v = buffer_slab_peek(
379 the_repository->parsed_objects->buffer_slab, commit);
380 void *ret;
382 if (!v) {
383 if (sizep)
384 *sizep = 0;
385 return NULL;
387 ret = v->buffer;
388 if (sizep)
389 *sizep = v->size;
391 v->buffer = NULL;
392 v->size = 0;
393 return ret;
396 int parse_commit_buffer(struct repository *r, struct commit *item, const void *buffer, unsigned long size, int check_graph)
398 const char *tail = buffer;
399 const char *bufptr = buffer;
400 struct object_id parent;
401 struct commit_list **pptr;
402 struct commit_graft *graft;
403 const int tree_entry_len = the_hash_algo->hexsz + 5;
404 const int parent_entry_len = the_hash_algo->hexsz + 7;
405 struct tree *tree;
407 if (item->object.parsed)
408 return 0;
410 if (item->parents) {
412 * Presumably this is leftover from an earlier failed parse;
413 * clear it out in preparation for us re-parsing (we'll hit the
414 * same error, but that's good, since it lets our caller know
415 * the result cannot be trusted.
417 free_commit_list(item->parents);
418 item->parents = NULL;
421 tail += size;
422 if (tail <= bufptr + tree_entry_len + 1 || memcmp(bufptr, "tree ", 5) ||
423 bufptr[tree_entry_len] != '\n')
424 return error("bogus commit object %s", oid_to_hex(&item->object.oid));
425 if (get_oid_hex(bufptr + 5, &parent) < 0)
426 return error("bad tree pointer in commit %s",
427 oid_to_hex(&item->object.oid));
428 tree = lookup_tree(r, &parent);
429 if (!tree)
430 return error("bad tree pointer %s in commit %s",
431 oid_to_hex(&parent),
432 oid_to_hex(&item->object.oid));
433 set_commit_tree(item, tree);
434 bufptr += tree_entry_len + 1; /* "tree " + "hex sha1" + "\n" */
435 pptr = &item->parents;
437 graft = lookup_commit_graft(r, &item->object.oid);
438 while (bufptr + parent_entry_len < tail && !memcmp(bufptr, "parent ", 7)) {
439 struct commit *new_parent;
441 if (tail <= bufptr + parent_entry_len + 1 ||
442 get_oid_hex(bufptr + 7, &parent) ||
443 bufptr[parent_entry_len] != '\n')
444 return error("bad parents in commit %s", oid_to_hex(&item->object.oid));
445 bufptr += parent_entry_len + 1;
447 * The clone is shallow if nr_parent < 0, and we must
448 * not traverse its real parents even when we unhide them.
450 if (graft && (graft->nr_parent < 0 || grafts_replace_parents))
451 continue;
452 new_parent = lookup_commit(r, &parent);
453 if (!new_parent)
454 return error("bad parent %s in commit %s",
455 oid_to_hex(&parent),
456 oid_to_hex(&item->object.oid));
457 pptr = &commit_list_insert(new_parent, pptr)->next;
459 if (graft) {
460 int i;
461 struct commit *new_parent;
462 for (i = 0; i < graft->nr_parent; i++) {
463 new_parent = lookup_commit(r,
464 &graft->parent[i]);
465 if (!new_parent)
466 return error("bad graft parent %s in commit %s",
467 oid_to_hex(&graft->parent[i]),
468 oid_to_hex(&item->object.oid));
469 pptr = &commit_list_insert(new_parent, pptr)->next;
472 item->date = parse_commit_date(bufptr, tail);
474 if (check_graph)
475 load_commit_graph_info(r, item);
477 item->object.parsed = 1;
478 return 0;
481 int repo_parse_commit_internal(struct repository *r,
482 struct commit *item,
483 int quiet_on_missing,
484 int use_commit_graph)
486 enum object_type type;
487 void *buffer;
488 unsigned long size;
489 int ret;
491 if (!item)
492 return -1;
493 if (item->object.parsed)
494 return 0;
495 if (use_commit_graph && parse_commit_in_graph(r, item))
496 return 0;
497 buffer = repo_read_object_file(r, &item->object.oid, &type, &size);
498 if (!buffer)
499 return quiet_on_missing ? -1 :
500 error("Could not read %s",
501 oid_to_hex(&item->object.oid));
502 if (type != OBJ_COMMIT) {
503 free(buffer);
504 return error("Object %s not a commit",
505 oid_to_hex(&item->object.oid));
508 ret = parse_commit_buffer(r, item, buffer, size, 0);
509 if (save_commit_buffer && !ret) {
510 set_commit_buffer(r, item, buffer, size);
511 return 0;
513 free(buffer);
514 return ret;
517 int repo_parse_commit_gently(struct repository *r,
518 struct commit *item, int quiet_on_missing)
520 return repo_parse_commit_internal(r, item, quiet_on_missing, 1);
523 void parse_commit_or_die(struct commit *item)
525 if (parse_commit(item))
526 die("unable to parse commit %s",
527 item ? oid_to_hex(&item->object.oid) : "(null)");
530 int find_commit_subject(const char *commit_buffer, const char **subject)
532 const char *eol;
533 const char *p = commit_buffer;
535 while (*p && (*p != '\n' || p[1] != '\n'))
536 p++;
537 if (*p) {
538 p = skip_blank_lines(p + 2);
539 eol = strchrnul(p, '\n');
540 } else
541 eol = p;
543 *subject = p;
545 return eol - p;
548 struct commit_list *commit_list_insert(struct commit *item, struct commit_list **list_p)
550 struct commit_list *new_list = xmalloc(sizeof(struct commit_list));
551 new_list->item = item;
552 new_list->next = *list_p;
553 *list_p = new_list;
554 return new_list;
557 unsigned commit_list_count(const struct commit_list *l)
559 unsigned c = 0;
560 for (; l; l = l->next )
561 c++;
562 return c;
565 struct commit_list *copy_commit_list(struct commit_list *list)
567 struct commit_list *head = NULL;
568 struct commit_list **pp = &head;
569 while (list) {
570 pp = commit_list_append(list->item, pp);
571 list = list->next;
573 return head;
576 void free_commit_list(struct commit_list *list)
578 while (list)
579 pop_commit(&list);
582 struct commit_list * commit_list_insert_by_date(struct commit *item, struct commit_list **list)
584 struct commit_list **pp = list;
585 struct commit_list *p;
586 while ((p = *pp) != NULL) {
587 if (p->item->date < item->date) {
588 break;
590 pp = &p->next;
592 return commit_list_insert(item, pp);
595 static int commit_list_compare_by_date(const void *a, const void *b)
597 timestamp_t a_date = ((const struct commit_list *)a)->item->date;
598 timestamp_t b_date = ((const struct commit_list *)b)->item->date;
599 if (a_date < b_date)
600 return 1;
601 if (a_date > b_date)
602 return -1;
603 return 0;
606 static void *commit_list_get_next(const void *a)
608 return ((const struct commit_list *)a)->next;
611 static void commit_list_set_next(void *a, void *next)
613 ((struct commit_list *)a)->next = next;
616 void commit_list_sort_by_date(struct commit_list **list)
618 *list = llist_mergesort(*list, commit_list_get_next, commit_list_set_next,
619 commit_list_compare_by_date);
622 struct commit *pop_most_recent_commit(struct commit_list **list,
623 unsigned int mark)
625 struct commit *ret = pop_commit(list);
626 struct commit_list *parents = ret->parents;
628 while (parents) {
629 struct commit *commit = parents->item;
630 if (!parse_commit(commit) && !(commit->object.flags & mark)) {
631 commit->object.flags |= mark;
632 commit_list_insert_by_date(commit, list);
634 parents = parents->next;
636 return ret;
639 static void clear_commit_marks_1(struct commit_list **plist,
640 struct commit *commit, unsigned int mark)
642 while (commit) {
643 struct commit_list *parents;
645 if (!(mark & commit->object.flags))
646 return;
648 commit->object.flags &= ~mark;
650 parents = commit->parents;
651 if (!parents)
652 return;
654 while ((parents = parents->next))
655 commit_list_insert(parents->item, plist);
657 commit = commit->parents->item;
661 void clear_commit_marks_many(int nr, struct commit **commit, unsigned int mark)
663 struct commit_list *list = NULL;
665 while (nr--) {
666 clear_commit_marks_1(&list, *commit, mark);
667 commit++;
669 while (list)
670 clear_commit_marks_1(&list, pop_commit(&list), mark);
673 void clear_commit_marks(struct commit *commit, unsigned int mark)
675 clear_commit_marks_many(1, &commit, mark);
678 struct commit *pop_commit(struct commit_list **stack)
680 struct commit_list *top = *stack;
681 struct commit *item = top ? top->item : NULL;
683 if (top) {
684 *stack = top->next;
685 free(top);
687 return item;
691 * Topological sort support
694 /* count number of children that have not been emitted */
695 define_commit_slab(indegree_slab, int);
697 define_commit_slab(author_date_slab, timestamp_t);
699 void record_author_date(struct author_date_slab *author_date,
700 struct commit *commit)
702 const char *buffer = get_commit_buffer(commit, NULL);
703 struct ident_split ident;
704 const char *ident_line;
705 size_t ident_len;
706 char *date_end;
707 timestamp_t date;
709 ident_line = find_commit_header(buffer, "author", &ident_len);
710 if (!ident_line)
711 goto fail_exit; /* no author line */
712 if (split_ident_line(&ident, ident_line, ident_len) ||
713 !ident.date_begin || !ident.date_end)
714 goto fail_exit; /* malformed "author" line */
716 date = parse_timestamp(ident.date_begin, &date_end, 10);
717 if (date_end != ident.date_end)
718 goto fail_exit; /* malformed date */
719 *(author_date_slab_at(author_date, commit)) = date;
721 fail_exit:
722 unuse_commit_buffer(commit, buffer);
725 int compare_commits_by_author_date(const void *a_, const void *b_,
726 void *cb_data)
728 const struct commit *a = a_, *b = b_;
729 struct author_date_slab *author_date = cb_data;
730 timestamp_t a_date = *(author_date_slab_at(author_date, a));
731 timestamp_t b_date = *(author_date_slab_at(author_date, b));
733 /* newer commits with larger date first */
734 if (a_date < b_date)
735 return 1;
736 else if (a_date > b_date)
737 return -1;
738 return 0;
741 int compare_commits_by_gen_then_commit_date(const void *a_, const void *b_, void *unused)
743 const struct commit *a = a_, *b = b_;
745 /* newer commits first */
746 if (a->generation < b->generation)
747 return 1;
748 else if (a->generation > b->generation)
749 return -1;
751 /* use date as a heuristic when generations are equal */
752 if (a->date < b->date)
753 return 1;
754 else if (a->date > b->date)
755 return -1;
756 return 0;
759 int compare_commits_by_commit_date(const void *a_, const void *b_, void *unused)
761 const struct commit *a = a_, *b = b_;
762 /* newer commits with larger date first */
763 if (a->date < b->date)
764 return 1;
765 else if (a->date > b->date)
766 return -1;
767 return 0;
771 * Performs an in-place topological sort on the list supplied.
773 void sort_in_topological_order(struct commit_list **list, enum rev_sort_order sort_order)
775 struct commit_list *next, *orig = *list;
776 struct commit_list **pptr;
777 struct indegree_slab indegree;
778 struct prio_queue queue;
779 struct commit *commit;
780 struct author_date_slab author_date;
782 if (!orig)
783 return;
784 *list = NULL;
786 init_indegree_slab(&indegree);
787 memset(&queue, '\0', sizeof(queue));
789 switch (sort_order) {
790 default: /* REV_SORT_IN_GRAPH_ORDER */
791 queue.compare = NULL;
792 break;
793 case REV_SORT_BY_COMMIT_DATE:
794 queue.compare = compare_commits_by_commit_date;
795 break;
796 case REV_SORT_BY_AUTHOR_DATE:
797 init_author_date_slab(&author_date);
798 queue.compare = compare_commits_by_author_date;
799 queue.cb_data = &author_date;
800 break;
803 /* Mark them and clear the indegree */
804 for (next = orig; next; next = next->next) {
805 struct commit *commit = next->item;
806 *(indegree_slab_at(&indegree, commit)) = 1;
807 /* also record the author dates, if needed */
808 if (sort_order == REV_SORT_BY_AUTHOR_DATE)
809 record_author_date(&author_date, commit);
812 /* update the indegree */
813 for (next = orig; next; next = next->next) {
814 struct commit_list *parents = next->item->parents;
815 while (parents) {
816 struct commit *parent = parents->item;
817 int *pi = indegree_slab_at(&indegree, parent);
819 if (*pi)
820 (*pi)++;
821 parents = parents->next;
826 * find the tips
828 * tips are nodes not reachable from any other node in the list
830 * the tips serve as a starting set for the work queue.
832 for (next = orig; next; next = next->next) {
833 struct commit *commit = next->item;
835 if (*(indegree_slab_at(&indegree, commit)) == 1)
836 prio_queue_put(&queue, commit);
840 * This is unfortunate; the initial tips need to be shown
841 * in the order given from the revision traversal machinery.
843 if (sort_order == REV_SORT_IN_GRAPH_ORDER)
844 prio_queue_reverse(&queue);
846 /* We no longer need the commit list */
847 free_commit_list(orig);
849 pptr = list;
850 *list = NULL;
851 while ((commit = prio_queue_get(&queue)) != NULL) {
852 struct commit_list *parents;
854 for (parents = commit->parents; parents ; parents = parents->next) {
855 struct commit *parent = parents->item;
856 int *pi = indegree_slab_at(&indegree, parent);
858 if (!*pi)
859 continue;
862 * parents are only enqueued for emission
863 * when all their children have been emitted thereby
864 * guaranteeing topological order.
866 if (--(*pi) == 1)
867 prio_queue_put(&queue, parent);
870 * all children of commit have already been
871 * emitted. we can emit it now.
873 *(indegree_slab_at(&indegree, commit)) = 0;
875 pptr = &commit_list_insert(commit, pptr)->next;
878 clear_indegree_slab(&indegree);
879 clear_prio_queue(&queue);
880 if (sort_order == REV_SORT_BY_AUTHOR_DATE)
881 clear_author_date_slab(&author_date);
884 struct rev_collect {
885 struct commit **commit;
886 int nr;
887 int alloc;
888 unsigned int initial : 1;
891 static void add_one_commit(struct object_id *oid, struct rev_collect *revs)
893 struct commit *commit;
895 if (is_null_oid(oid))
896 return;
898 commit = lookup_commit(the_repository, oid);
899 if (!commit ||
900 (commit->object.flags & TMP_MARK) ||
901 parse_commit(commit))
902 return;
904 ALLOC_GROW(revs->commit, revs->nr + 1, revs->alloc);
905 revs->commit[revs->nr++] = commit;
906 commit->object.flags |= TMP_MARK;
909 static int collect_one_reflog_ent(struct object_id *ooid, struct object_id *noid,
910 const char *ident, timestamp_t timestamp,
911 int tz, const char *message, void *cbdata)
913 struct rev_collect *revs = cbdata;
915 if (revs->initial) {
916 revs->initial = 0;
917 add_one_commit(ooid, revs);
919 add_one_commit(noid, revs);
920 return 0;
923 struct commit *get_fork_point(const char *refname, struct commit *commit)
925 struct object_id oid;
926 struct rev_collect revs;
927 struct commit_list *bases;
928 int i;
929 struct commit *ret = NULL;
931 memset(&revs, 0, sizeof(revs));
932 revs.initial = 1;
933 for_each_reflog_ent(refname, collect_one_reflog_ent, &revs);
935 if (!revs.nr && !get_oid(refname, &oid))
936 add_one_commit(&oid, &revs);
938 for (i = 0; i < revs.nr; i++)
939 revs.commit[i]->object.flags &= ~TMP_MARK;
941 bases = get_merge_bases_many(commit, revs.nr, revs.commit);
944 * There should be one and only one merge base, when we found
945 * a common ancestor among reflog entries.
947 if (!bases || bases->next)
948 goto cleanup_return;
950 /* And the found one must be one of the reflog entries */
951 for (i = 0; i < revs.nr; i++)
952 if (&bases->item->object == &revs.commit[i]->object)
953 break; /* found */
954 if (revs.nr <= i)
955 goto cleanup_return;
957 ret = bases->item;
959 cleanup_return:
960 free_commit_list(bases);
961 return ret;
964 static const char gpg_sig_header[] = "gpgsig";
965 static const int gpg_sig_header_len = sizeof(gpg_sig_header) - 1;
967 static int do_sign_commit(struct strbuf *buf, const char *keyid)
969 struct strbuf sig = STRBUF_INIT;
970 int inspos, copypos;
971 const char *eoh;
973 /* find the end of the header */
974 eoh = strstr(buf->buf, "\n\n");
975 if (!eoh)
976 inspos = buf->len;
977 else
978 inspos = eoh - buf->buf + 1;
980 if (!keyid || !*keyid)
981 keyid = get_signing_key();
982 if (sign_buffer(buf, &sig, keyid)) {
983 strbuf_release(&sig);
984 return -1;
987 for (copypos = 0; sig.buf[copypos]; ) {
988 const char *bol = sig.buf + copypos;
989 const char *eol = strchrnul(bol, '\n');
990 int len = (eol - bol) + !!*eol;
992 if (!copypos) {
993 strbuf_insert(buf, inspos, gpg_sig_header, gpg_sig_header_len);
994 inspos += gpg_sig_header_len;
996 strbuf_insert(buf, inspos++, " ", 1);
997 strbuf_insert(buf, inspos, bol, len);
998 inspos += len;
999 copypos += len;
1001 strbuf_release(&sig);
1002 return 0;
1005 int parse_signed_commit(const struct commit *commit,
1006 struct strbuf *payload, struct strbuf *signature)
1009 unsigned long size;
1010 const char *buffer = get_commit_buffer(commit, &size);
1011 int in_signature, saw_signature = -1;
1012 const char *line, *tail;
1014 line = buffer;
1015 tail = buffer + size;
1016 in_signature = 0;
1017 saw_signature = 0;
1018 while (line < tail) {
1019 const char *sig = NULL;
1020 const char *next = memchr(line, '\n', tail - line);
1022 next = next ? next + 1 : tail;
1023 if (in_signature && line[0] == ' ')
1024 sig = line + 1;
1025 else if (starts_with(line, gpg_sig_header) &&
1026 line[gpg_sig_header_len] == ' ')
1027 sig = line + gpg_sig_header_len + 1;
1028 if (sig) {
1029 strbuf_add(signature, sig, next - sig);
1030 saw_signature = 1;
1031 in_signature = 1;
1032 } else {
1033 if (*line == '\n')
1034 /* dump the whole remainder of the buffer */
1035 next = tail;
1036 strbuf_add(payload, line, next - line);
1037 in_signature = 0;
1039 line = next;
1041 unuse_commit_buffer(commit, buffer);
1042 return saw_signature;
1045 int remove_signature(struct strbuf *buf)
1047 const char *line = buf->buf;
1048 const char *tail = buf->buf + buf->len;
1049 int in_signature = 0;
1050 const char *sig_start = NULL;
1051 const char *sig_end = NULL;
1053 while (line < tail) {
1054 const char *next = memchr(line, '\n', tail - line);
1055 next = next ? next + 1 : tail;
1057 if (in_signature && line[0] == ' ')
1058 sig_end = next;
1059 else if (starts_with(line, gpg_sig_header) &&
1060 line[gpg_sig_header_len] == ' ') {
1061 sig_start = line;
1062 sig_end = next;
1063 in_signature = 1;
1064 } else {
1065 if (*line == '\n')
1066 /* dump the whole remainder of the buffer */
1067 next = tail;
1068 in_signature = 0;
1070 line = next;
1073 if (sig_start)
1074 strbuf_remove(buf, sig_start - buf->buf, sig_end - sig_start);
1076 return sig_start != NULL;
1079 static void handle_signed_tag(struct commit *parent, struct commit_extra_header ***tail)
1081 struct merge_remote_desc *desc;
1082 struct commit_extra_header *mergetag;
1083 char *buf;
1084 unsigned long size, len;
1085 enum object_type type;
1087 desc = merge_remote_util(parent);
1088 if (!desc || !desc->obj)
1089 return;
1090 buf = read_object_file(&desc->obj->oid, &type, &size);
1091 if (!buf || type != OBJ_TAG)
1092 goto free_return;
1093 len = parse_signature(buf, size);
1094 if (size == len)
1095 goto free_return;
1097 * We could verify this signature and either omit the tag when
1098 * it does not validate, but the integrator may not have the
1099 * public key of the signer of the tag he is merging, while a
1100 * later auditor may have it while auditing, so let's not run
1101 * verify-signed-buffer here for now...
1103 * if (verify_signed_buffer(buf, len, buf + len, size - len, ...))
1104 * warn("warning: signed tag unverified.");
1106 mergetag = xcalloc(1, sizeof(*mergetag));
1107 mergetag->key = xstrdup("mergetag");
1108 mergetag->value = buf;
1109 mergetag->len = size;
1111 **tail = mergetag;
1112 *tail = &mergetag->next;
1113 return;
1115 free_return:
1116 free(buf);
1119 int check_commit_signature(const struct commit *commit, struct signature_check *sigc)
1121 struct strbuf payload = STRBUF_INIT;
1122 struct strbuf signature = STRBUF_INIT;
1123 int ret = 1;
1125 sigc->result = 'N';
1127 if (parse_signed_commit(commit, &payload, &signature) <= 0)
1128 goto out;
1129 ret = check_signature(payload.buf, payload.len, signature.buf,
1130 signature.len, sigc);
1132 out:
1133 strbuf_release(&payload);
1134 strbuf_release(&signature);
1136 return ret;
1139 void verify_merge_signature(struct commit *commit, int verbosity)
1141 char hex[GIT_MAX_HEXSZ + 1];
1142 struct signature_check signature_check;
1143 memset(&signature_check, 0, sizeof(signature_check));
1145 check_commit_signature(commit, &signature_check);
1147 find_unique_abbrev_r(hex, &commit->object.oid, DEFAULT_ABBREV);
1148 switch (signature_check.result) {
1149 case 'G':
1150 break;
1151 case 'U':
1152 die(_("Commit %s has an untrusted GPG signature, "
1153 "allegedly by %s."), hex, signature_check.signer);
1154 case 'B':
1155 die(_("Commit %s has a bad GPG signature "
1156 "allegedly by %s."), hex, signature_check.signer);
1157 default: /* 'N' */
1158 die(_("Commit %s does not have a GPG signature."), hex);
1160 if (verbosity >= 0 && signature_check.result == 'G')
1161 printf(_("Commit %s has a good GPG signature by %s\n"),
1162 hex, signature_check.signer);
1164 signature_check_clear(&signature_check);
1167 void append_merge_tag_headers(struct commit_list *parents,
1168 struct commit_extra_header ***tail)
1170 while (parents) {
1171 struct commit *parent = parents->item;
1172 handle_signed_tag(parent, tail);
1173 parents = parents->next;
1177 static void add_extra_header(struct strbuf *buffer,
1178 struct commit_extra_header *extra)
1180 strbuf_addstr(buffer, extra->key);
1181 if (extra->len)
1182 strbuf_add_lines(buffer, " ", extra->value, extra->len);
1183 else
1184 strbuf_addch(buffer, '\n');
1187 struct commit_extra_header *read_commit_extra_headers(struct commit *commit,
1188 const char **exclude)
1190 struct commit_extra_header *extra = NULL;
1191 unsigned long size;
1192 const char *buffer = get_commit_buffer(commit, &size);
1193 extra = read_commit_extra_header_lines(buffer, size, exclude);
1194 unuse_commit_buffer(commit, buffer);
1195 return extra;
1198 int for_each_mergetag(each_mergetag_fn fn, struct commit *commit, void *data)
1200 struct commit_extra_header *extra, *to_free;
1201 int res = 0;
1203 to_free = read_commit_extra_headers(commit, NULL);
1204 for (extra = to_free; !res && extra; extra = extra->next) {
1205 if (strcmp(extra->key, "mergetag"))
1206 continue; /* not a merge tag */
1207 res = fn(commit, extra, data);
1209 free_commit_extra_headers(to_free);
1210 return res;
1213 static inline int standard_header_field(const char *field, size_t len)
1215 return ((len == 4 && !memcmp(field, "tree", 4)) ||
1216 (len == 6 && !memcmp(field, "parent", 6)) ||
1217 (len == 6 && !memcmp(field, "author", 6)) ||
1218 (len == 9 && !memcmp(field, "committer", 9)) ||
1219 (len == 8 && !memcmp(field, "encoding", 8)));
1222 static int excluded_header_field(const char *field, size_t len, const char **exclude)
1224 if (!exclude)
1225 return 0;
1227 while (*exclude) {
1228 size_t xlen = strlen(*exclude);
1229 if (len == xlen && !memcmp(field, *exclude, xlen))
1230 return 1;
1231 exclude++;
1233 return 0;
1236 static struct commit_extra_header *read_commit_extra_header_lines(
1237 const char *buffer, size_t size,
1238 const char **exclude)
1240 struct commit_extra_header *extra = NULL, **tail = &extra, *it = NULL;
1241 const char *line, *next, *eof, *eob;
1242 struct strbuf buf = STRBUF_INIT;
1244 for (line = buffer, eob = line + size;
1245 line < eob && *line != '\n';
1246 line = next) {
1247 next = memchr(line, '\n', eob - line);
1248 next = next ? next + 1 : eob;
1249 if (*line == ' ') {
1250 /* continuation */
1251 if (it)
1252 strbuf_add(&buf, line + 1, next - (line + 1));
1253 continue;
1255 if (it)
1256 it->value = strbuf_detach(&buf, &it->len);
1257 strbuf_reset(&buf);
1258 it = NULL;
1260 eof = memchr(line, ' ', next - line);
1261 if (!eof)
1262 eof = next;
1263 else if (standard_header_field(line, eof - line) ||
1264 excluded_header_field(line, eof - line, exclude))
1265 continue;
1267 it = xcalloc(1, sizeof(*it));
1268 it->key = xmemdupz(line, eof-line);
1269 *tail = it;
1270 tail = &it->next;
1271 if (eof + 1 < next)
1272 strbuf_add(&buf, eof + 1, next - (eof + 1));
1274 if (it)
1275 it->value = strbuf_detach(&buf, &it->len);
1276 return extra;
1279 void free_commit_extra_headers(struct commit_extra_header *extra)
1281 while (extra) {
1282 struct commit_extra_header *next = extra->next;
1283 free(extra->key);
1284 free(extra->value);
1285 free(extra);
1286 extra = next;
1290 int commit_tree(const char *msg, size_t msg_len, const struct object_id *tree,
1291 struct commit_list *parents, struct object_id *ret,
1292 const char *author, const char *sign_commit)
1294 struct commit_extra_header *extra = NULL, **tail = &extra;
1295 int result;
1297 append_merge_tag_headers(parents, &tail);
1298 result = commit_tree_extended(msg, msg_len, tree, parents, ret,
1299 author, sign_commit, extra);
1300 free_commit_extra_headers(extra);
1301 return result;
1304 static int find_invalid_utf8(const char *buf, int len)
1306 int offset = 0;
1307 static const unsigned int max_codepoint[] = {
1308 0x7f, 0x7ff, 0xffff, 0x10ffff
1311 while (len) {
1312 unsigned char c = *buf++;
1313 int bytes, bad_offset;
1314 unsigned int codepoint;
1315 unsigned int min_val, max_val;
1317 len--;
1318 offset++;
1320 /* Simple US-ASCII? No worries. */
1321 if (c < 0x80)
1322 continue;
1324 bad_offset = offset-1;
1327 * Count how many more high bits set: that's how
1328 * many more bytes this sequence should have.
1330 bytes = 0;
1331 while (c & 0x40) {
1332 c <<= 1;
1333 bytes++;
1337 * Must be between 1 and 3 more bytes. Longer sequences result in
1338 * codepoints beyond U+10FFFF, which are guaranteed never to exist.
1340 if (bytes < 1 || 3 < bytes)
1341 return bad_offset;
1343 /* Do we *have* that many bytes? */
1344 if (len < bytes)
1345 return bad_offset;
1348 * Place the encoded bits at the bottom of the value and compute the
1349 * valid range.
1351 codepoint = (c & 0x7f) >> bytes;
1352 min_val = max_codepoint[bytes-1] + 1;
1353 max_val = max_codepoint[bytes];
1355 offset += bytes;
1356 len -= bytes;
1358 /* And verify that they are good continuation bytes */
1359 do {
1360 codepoint <<= 6;
1361 codepoint |= *buf & 0x3f;
1362 if ((*buf++ & 0xc0) != 0x80)
1363 return bad_offset;
1364 } while (--bytes);
1366 /* Reject codepoints that are out of range for the sequence length. */
1367 if (codepoint < min_val || codepoint > max_val)
1368 return bad_offset;
1369 /* Surrogates are only for UTF-16 and cannot be encoded in UTF-8. */
1370 if ((codepoint & 0x1ff800) == 0xd800)
1371 return bad_offset;
1372 /* U+xxFFFE and U+xxFFFF are guaranteed non-characters. */
1373 if ((codepoint & 0xfffe) == 0xfffe)
1374 return bad_offset;
1375 /* So are anything in the range U+FDD0..U+FDEF. */
1376 if (codepoint >= 0xfdd0 && codepoint <= 0xfdef)
1377 return bad_offset;
1379 return -1;
1383 * This verifies that the buffer is in proper utf8 format.
1385 * If it isn't, it assumes any non-utf8 characters are Latin1,
1386 * and does the conversion.
1388 static int verify_utf8(struct strbuf *buf)
1390 int ok = 1;
1391 long pos = 0;
1393 for (;;) {
1394 int bad;
1395 unsigned char c;
1396 unsigned char replace[2];
1398 bad = find_invalid_utf8(buf->buf + pos, buf->len - pos);
1399 if (bad < 0)
1400 return ok;
1401 pos += bad;
1402 ok = 0;
1403 c = buf->buf[pos];
1404 strbuf_remove(buf, pos, 1);
1406 /* We know 'c' must be in the range 128-255 */
1407 replace[0] = 0xc0 + (c >> 6);
1408 replace[1] = 0x80 + (c & 0x3f);
1409 strbuf_insert(buf, pos, replace, 2);
1410 pos += 2;
1414 static const char commit_utf8_warn[] =
1415 N_("Warning: commit message did not conform to UTF-8.\n"
1416 "You may want to amend it after fixing the message, or set the config\n"
1417 "variable i18n.commitencoding to the encoding your project uses.\n");
1419 int commit_tree_extended(const char *msg, size_t msg_len,
1420 const struct object_id *tree,
1421 struct commit_list *parents, struct object_id *ret,
1422 const char *author, const char *sign_commit,
1423 struct commit_extra_header *extra)
1425 int result;
1426 int encoding_is_utf8;
1427 struct strbuf buffer;
1429 assert_oid_type(tree, OBJ_TREE);
1431 if (memchr(msg, '\0', msg_len))
1432 return error("a NUL byte in commit log message not allowed.");
1434 /* Not having i18n.commitencoding is the same as having utf-8 */
1435 encoding_is_utf8 = is_encoding_utf8(git_commit_encoding);
1437 strbuf_init(&buffer, 8192); /* should avoid reallocs for the headers */
1438 strbuf_addf(&buffer, "tree %s\n", oid_to_hex(tree));
1441 * NOTE! This ordering means that the same exact tree merged with a
1442 * different order of parents will be a _different_ changeset even
1443 * if everything else stays the same.
1445 while (parents) {
1446 struct commit *parent = pop_commit(&parents);
1447 strbuf_addf(&buffer, "parent %s\n",
1448 oid_to_hex(&parent->object.oid));
1451 /* Person/date information */
1452 if (!author)
1453 author = git_author_info(IDENT_STRICT);
1454 strbuf_addf(&buffer, "author %s\n", author);
1455 strbuf_addf(&buffer, "committer %s\n", git_committer_info(IDENT_STRICT));
1456 if (!encoding_is_utf8)
1457 strbuf_addf(&buffer, "encoding %s\n", git_commit_encoding);
1459 while (extra) {
1460 add_extra_header(&buffer, extra);
1461 extra = extra->next;
1463 strbuf_addch(&buffer, '\n');
1465 /* And add the comment */
1466 strbuf_add(&buffer, msg, msg_len);
1468 /* And check the encoding */
1469 if (encoding_is_utf8 && !verify_utf8(&buffer))
1470 fprintf(stderr, _(commit_utf8_warn));
1472 if (sign_commit && do_sign_commit(&buffer, sign_commit)) {
1473 result = -1;
1474 goto out;
1477 result = write_object_file(buffer.buf, buffer.len, commit_type, ret);
1478 out:
1479 strbuf_release(&buffer);
1480 return result;
1483 define_commit_slab(merge_desc_slab, struct merge_remote_desc *);
1484 static struct merge_desc_slab merge_desc_slab = COMMIT_SLAB_INIT(1, merge_desc_slab);
1486 struct merge_remote_desc *merge_remote_util(struct commit *commit)
1488 return *merge_desc_slab_at(&merge_desc_slab, commit);
1491 void set_merge_remote_desc(struct commit *commit,
1492 const char *name, struct object *obj)
1494 struct merge_remote_desc *desc;
1495 FLEX_ALLOC_STR(desc, name, name);
1496 desc->obj = obj;
1497 *merge_desc_slab_at(&merge_desc_slab, commit) = desc;
1500 struct commit *get_merge_parent(const char *name)
1502 struct object *obj;
1503 struct commit *commit;
1504 struct object_id oid;
1505 if (get_oid(name, &oid))
1506 return NULL;
1507 obj = parse_object(the_repository, &oid);
1508 commit = (struct commit *)peel_to_type(name, 0, obj, OBJ_COMMIT);
1509 if (commit && !merge_remote_util(commit))
1510 set_merge_remote_desc(commit, name, obj);
1511 return commit;
1515 * Append a commit to the end of the commit_list.
1517 * next starts by pointing to the variable that holds the head of an
1518 * empty commit_list, and is updated to point to the "next" field of
1519 * the last item on the list as new commits are appended.
1521 * Usage example:
1523 * struct commit_list *list;
1524 * struct commit_list **next = &list;
1526 * next = commit_list_append(c1, next);
1527 * next = commit_list_append(c2, next);
1528 * assert(commit_list_count(list) == 2);
1529 * return list;
1531 struct commit_list **commit_list_append(struct commit *commit,
1532 struct commit_list **next)
1534 struct commit_list *new_commit = xmalloc(sizeof(struct commit_list));
1535 new_commit->item = commit;
1536 *next = new_commit;
1537 new_commit->next = NULL;
1538 return &new_commit->next;
1541 const char *find_commit_header(const char *msg, const char *key, size_t *out_len)
1543 int key_len = strlen(key);
1544 const char *line = msg;
1546 while (line) {
1547 const char *eol = strchrnul(line, '\n');
1549 if (line == eol)
1550 return NULL;
1552 if (eol - line > key_len &&
1553 !strncmp(line, key, key_len) &&
1554 line[key_len] == ' ') {
1555 *out_len = eol - line - key_len - 1;
1556 return line + key_len + 1;
1558 line = *eol ? eol + 1 : NULL;
1560 return NULL;
1564 * Inspect the given string and determine the true "end" of the log message, in
1565 * order to find where to put a new Signed-off-by: line. Ignored are
1566 * trailing comment lines and blank lines. To support "git commit -s
1567 * --amend" on an existing commit, we also ignore "Conflicts:". To
1568 * support "git commit -v", we truncate at cut lines.
1570 * Returns the number of bytes from the tail to ignore, to be fed as
1571 * the second parameter to append_signoff().
1573 size_t ignore_non_trailer(const char *buf, size_t len)
1575 size_t boc = 0;
1576 size_t bol = 0;
1577 int in_old_conflicts_block = 0;
1578 size_t cutoff = wt_status_locate_end(buf, len);
1580 while (bol < cutoff) {
1581 const char *next_line = memchr(buf + bol, '\n', len - bol);
1583 if (!next_line)
1584 next_line = buf + len;
1585 else
1586 next_line++;
1588 if (buf[bol] == comment_line_char || buf[bol] == '\n') {
1589 /* is this the first of the run of comments? */
1590 if (!boc)
1591 boc = bol;
1592 /* otherwise, it is just continuing */
1593 } else if (starts_with(buf + bol, "Conflicts:\n")) {
1594 in_old_conflicts_block = 1;
1595 if (!boc)
1596 boc = bol;
1597 } else if (in_old_conflicts_block && buf[bol] == '\t') {
1598 ; /* a pathname in the conflicts block */
1599 } else if (boc) {
1600 /* the previous was not trailing comment */
1601 boc = 0;
1602 in_old_conflicts_block = 0;
1604 bol = next_line - buf;
1606 return boc ? len - boc : len - cutoff;
1609 int run_commit_hook(int editor_is_used, const char *index_file,
1610 const char *name, ...)
1612 struct argv_array hook_env = ARGV_ARRAY_INIT;
1613 va_list args;
1614 int ret;
1616 argv_array_pushf(&hook_env, "GIT_INDEX_FILE=%s", index_file);
1619 * Let the hook know that no editor will be launched.
1621 if (!editor_is_used)
1622 argv_array_push(&hook_env, "GIT_EDITOR=:");
1624 va_start(args, name);
1625 ret = run_hook_ve(hook_env.argv,name, args);
1626 va_end(args);
1627 argv_array_clear(&hook_env);
1629 return ret;