CodingGuidelines: once it is in, it is not worth the code churn
[git/git-svn.git] / commit.c
blobf4793316a21fe5f3ee1932f7e24cf4ab0920b04c
1 #include "cache.h"
2 #include "tag.h"
3 #include "commit.h"
4 #include "pkt-line.h"
5 #include "utf8.h"
6 #include "diff.h"
7 #include "revision.h"
8 #include "notes.h"
9 #include "gpg-interface.h"
10 #include "mergesort.h"
11 #include "commit-slab.h"
12 #include "prio-queue.h"
13 #include "sha1-lookup.h"
15 static struct commit_extra_header *read_commit_extra_header_lines(const char *buf, size_t len, const char **);
17 int save_commit_buffer = 1;
19 const char *commit_type = "commit";
20 static int commit_count;
22 static struct commit *check_commit(struct object *obj,
23 const unsigned char *sha1,
24 int quiet)
26 if (obj->type != OBJ_COMMIT) {
27 if (!quiet)
28 error("Object %s is a %s, not a commit",
29 sha1_to_hex(sha1), typename(obj->type));
30 return NULL;
32 return (struct commit *) obj;
35 struct commit *lookup_commit_reference_gently(const unsigned char *sha1,
36 int quiet)
38 struct object *obj = deref_tag(parse_object(sha1), NULL, 0);
40 if (!obj)
41 return NULL;
42 return check_commit(obj, sha1, quiet);
45 struct commit *lookup_commit_reference(const unsigned char *sha1)
47 return lookup_commit_reference_gently(sha1, 0);
50 struct commit *lookup_commit_or_die(const unsigned char *sha1, const char *ref_name)
52 struct commit *c = lookup_commit_reference(sha1);
53 if (!c)
54 die(_("could not parse %s"), ref_name);
55 if (hashcmp(sha1, c->object.sha1)) {
56 warning(_("%s %s is not a commit!"),
57 ref_name, sha1_to_hex(sha1));
59 return c;
62 struct commit *lookup_commit(const unsigned char *sha1)
64 struct object *obj = lookup_object(sha1);
65 if (!obj) {
66 struct commit *c = alloc_commit_node();
67 c->index = commit_count++;
68 return create_object(sha1, OBJ_COMMIT, c);
70 if (!obj->type)
71 obj->type = OBJ_COMMIT;
72 return check_commit(obj, sha1, 0);
75 struct commit *lookup_commit_reference_by_name(const char *name)
77 unsigned char sha1[20];
78 struct commit *commit;
80 if (get_sha1_committish(name, sha1))
81 return NULL;
82 commit = lookup_commit_reference(sha1);
83 if (parse_commit(commit))
84 return NULL;
85 return commit;
88 static unsigned long parse_commit_date(const char *buf, const char *tail)
90 const char *dateptr;
92 if (buf + 6 >= tail)
93 return 0;
94 if (memcmp(buf, "author", 6))
95 return 0;
96 while (buf < tail && *buf++ != '\n')
97 /* nada */;
98 if (buf + 9 >= tail)
99 return 0;
100 if (memcmp(buf, "committer", 9))
101 return 0;
102 while (buf < tail && *buf++ != '>')
103 /* nada */;
104 if (buf >= tail)
105 return 0;
106 dateptr = buf;
107 while (buf < tail && *buf++ != '\n')
108 /* nada */;
109 if (buf >= tail)
110 return 0;
111 /* dateptr < buf && buf[-1] == '\n', so strtoul will stop at buf-1 */
112 return strtoul(dateptr, NULL, 10);
115 static struct commit_graft **commit_graft;
116 static int commit_graft_alloc, commit_graft_nr;
118 static const unsigned char *commit_graft_sha1_access(size_t index, void *table)
120 struct commit_graft **commit_graft_table = table;
121 return commit_graft_table[index]->sha1;
124 static int commit_graft_pos(const unsigned char *sha1)
126 return sha1_pos(sha1, commit_graft, commit_graft_nr,
127 commit_graft_sha1_access);
130 int register_commit_graft(struct commit_graft *graft, int ignore_dups)
132 int pos = commit_graft_pos(graft->sha1);
134 if (0 <= pos) {
135 if (ignore_dups)
136 free(graft);
137 else {
138 free(commit_graft[pos]);
139 commit_graft[pos] = graft;
141 return 1;
143 pos = -pos - 1;
144 ALLOC_GROW(commit_graft, commit_graft_nr + 1, commit_graft_alloc);
145 commit_graft_nr++;
146 if (pos < commit_graft_nr)
147 memmove(commit_graft + pos + 1,
148 commit_graft + pos,
149 (commit_graft_nr - pos - 1) *
150 sizeof(*commit_graft));
151 commit_graft[pos] = graft;
152 return 0;
155 struct commit_graft *read_graft_line(char *buf, int len)
157 /* The format is just "Commit Parent1 Parent2 ...\n" */
158 int i;
159 struct commit_graft *graft = NULL;
161 while (len && isspace(buf[len-1]))
162 buf[--len] = '\0';
163 if (buf[0] == '#' || buf[0] == '\0')
164 return NULL;
165 if ((len + 1) % 41)
166 goto bad_graft_data;
167 i = (len + 1) / 41 - 1;
168 graft = xmalloc(sizeof(*graft) + 20 * i);
169 graft->nr_parent = i;
170 if (get_sha1_hex(buf, graft->sha1))
171 goto bad_graft_data;
172 for (i = 40; i < len; i += 41) {
173 if (buf[i] != ' ')
174 goto bad_graft_data;
175 if (get_sha1_hex(buf + i + 1, graft->parent[i/41]))
176 goto bad_graft_data;
178 return graft;
180 bad_graft_data:
181 error("bad graft data: %s", buf);
182 free(graft);
183 return NULL;
186 static int read_graft_file(const char *graft_file)
188 FILE *fp = fopen(graft_file, "r");
189 struct strbuf buf = STRBUF_INIT;
190 if (!fp)
191 return -1;
192 while (!strbuf_getwholeline(&buf, fp, '\n')) {
193 /* The format is just "Commit Parent1 Parent2 ...\n" */
194 struct commit_graft *graft = read_graft_line(buf.buf, buf.len);
195 if (!graft)
196 continue;
197 if (register_commit_graft(graft, 1))
198 error("duplicate graft data: %s", buf.buf);
200 fclose(fp);
201 strbuf_release(&buf);
202 return 0;
205 static void prepare_commit_graft(void)
207 static int commit_graft_prepared;
208 char *graft_file;
210 if (commit_graft_prepared)
211 return;
212 graft_file = get_graft_file();
213 read_graft_file(graft_file);
214 /* make sure shallows are read */
215 is_repository_shallow();
216 commit_graft_prepared = 1;
219 struct commit_graft *lookup_commit_graft(const unsigned char *sha1)
221 int pos;
222 prepare_commit_graft();
223 pos = commit_graft_pos(sha1);
224 if (pos < 0)
225 return NULL;
226 return commit_graft[pos];
229 int for_each_commit_graft(each_commit_graft_fn fn, void *cb_data)
231 int i, ret;
232 for (i = ret = 0; i < commit_graft_nr && !ret; i++)
233 ret = fn(commit_graft[i], cb_data);
234 return ret;
237 int unregister_shallow(const unsigned char *sha1)
239 int pos = commit_graft_pos(sha1);
240 if (pos < 0)
241 return -1;
242 if (pos + 1 < commit_graft_nr)
243 memmove(commit_graft + pos, commit_graft + pos + 1,
244 sizeof(struct commit_graft *)
245 * (commit_graft_nr - pos - 1));
246 commit_graft_nr--;
247 return 0;
250 int parse_commit_buffer(struct commit *item, const void *buffer, unsigned long size)
252 const char *tail = buffer;
253 const char *bufptr = buffer;
254 unsigned char parent[20];
255 struct commit_list **pptr;
256 struct commit_graft *graft;
258 if (item->object.parsed)
259 return 0;
260 item->object.parsed = 1;
261 tail += size;
262 if (tail <= bufptr + 46 || memcmp(bufptr, "tree ", 5) || bufptr[45] != '\n')
263 return error("bogus commit object %s", sha1_to_hex(item->object.sha1));
264 if (get_sha1_hex(bufptr + 5, parent) < 0)
265 return error("bad tree pointer in commit %s",
266 sha1_to_hex(item->object.sha1));
267 item->tree = lookup_tree(parent);
268 bufptr += 46; /* "tree " + "hex sha1" + "\n" */
269 pptr = &item->parents;
271 graft = lookup_commit_graft(item->object.sha1);
272 while (bufptr + 48 < tail && !memcmp(bufptr, "parent ", 7)) {
273 struct commit *new_parent;
275 if (tail <= bufptr + 48 ||
276 get_sha1_hex(bufptr + 7, parent) ||
277 bufptr[47] != '\n')
278 return error("bad parents in commit %s", sha1_to_hex(item->object.sha1));
279 bufptr += 48;
281 * The clone is shallow if nr_parent < 0, and we must
282 * not traverse its real parents even when we unhide them.
284 if (graft && (graft->nr_parent < 0 || grafts_replace_parents))
285 continue;
286 new_parent = lookup_commit(parent);
287 if (new_parent)
288 pptr = &commit_list_insert(new_parent, pptr)->next;
290 if (graft) {
291 int i;
292 struct commit *new_parent;
293 for (i = 0; i < graft->nr_parent; i++) {
294 new_parent = lookup_commit(graft->parent[i]);
295 if (!new_parent)
296 continue;
297 pptr = &commit_list_insert(new_parent, pptr)->next;
300 item->date = parse_commit_date(bufptr, tail);
302 return 0;
305 int parse_commit(struct commit *item)
307 enum object_type type;
308 void *buffer;
309 unsigned long size;
310 int ret;
312 if (!item)
313 return -1;
314 if (item->object.parsed)
315 return 0;
316 buffer = read_sha1_file(item->object.sha1, &type, &size);
317 if (!buffer)
318 return error("Could not read %s",
319 sha1_to_hex(item->object.sha1));
320 if (type != OBJ_COMMIT) {
321 free(buffer);
322 return error("Object %s not a commit",
323 sha1_to_hex(item->object.sha1));
325 ret = parse_commit_buffer(item, buffer, size);
326 if (save_commit_buffer && !ret) {
327 item->buffer = buffer;
328 return 0;
330 free(buffer);
331 return ret;
334 void parse_commit_or_die(struct commit *item)
336 if (parse_commit(item))
337 die("unable to parse commit %s",
338 item ? sha1_to_hex(item->object.sha1) : "(null)");
341 int find_commit_subject(const char *commit_buffer, const char **subject)
343 const char *eol;
344 const char *p = commit_buffer;
346 while (*p && (*p != '\n' || p[1] != '\n'))
347 p++;
348 if (*p) {
349 p += 2;
350 for (eol = p; *eol && *eol != '\n'; eol++)
351 ; /* do nothing */
352 } else
353 eol = p;
355 *subject = p;
357 return eol - p;
360 struct commit_list *commit_list_insert(struct commit *item, struct commit_list **list_p)
362 struct commit_list *new_list = xmalloc(sizeof(struct commit_list));
363 new_list->item = item;
364 new_list->next = *list_p;
365 *list_p = new_list;
366 return new_list;
369 unsigned commit_list_count(const struct commit_list *l)
371 unsigned c = 0;
372 for (; l; l = l->next )
373 c++;
374 return c;
377 struct commit_list *copy_commit_list(struct commit_list *list)
379 struct commit_list *head = NULL;
380 struct commit_list **pp = &head;
381 while (list) {
382 struct commit_list *new;
383 new = xmalloc(sizeof(struct commit_list));
384 new->item = list->item;
385 new->next = NULL;
386 *pp = new;
387 pp = &new->next;
388 list = list->next;
390 return head;
393 void free_commit_list(struct commit_list *list)
395 while (list) {
396 struct commit_list *temp = list;
397 list = temp->next;
398 free(temp);
402 struct commit_list * commit_list_insert_by_date(struct commit *item, struct commit_list **list)
404 struct commit_list **pp = list;
405 struct commit_list *p;
406 while ((p = *pp) != NULL) {
407 if (p->item->date < item->date) {
408 break;
410 pp = &p->next;
412 return commit_list_insert(item, pp);
415 static int commit_list_compare_by_date(const void *a, const void *b)
417 unsigned long a_date = ((const struct commit_list *)a)->item->date;
418 unsigned long b_date = ((const struct commit_list *)b)->item->date;
419 if (a_date < b_date)
420 return 1;
421 if (a_date > b_date)
422 return -1;
423 return 0;
426 static void *commit_list_get_next(const void *a)
428 return ((const struct commit_list *)a)->next;
431 static void commit_list_set_next(void *a, void *next)
433 ((struct commit_list *)a)->next = next;
436 void commit_list_sort_by_date(struct commit_list **list)
438 *list = llist_mergesort(*list, commit_list_get_next, commit_list_set_next,
439 commit_list_compare_by_date);
442 struct commit *pop_most_recent_commit(struct commit_list **list,
443 unsigned int mark)
445 struct commit *ret = (*list)->item;
446 struct commit_list *parents = ret->parents;
447 struct commit_list *old = *list;
449 *list = (*list)->next;
450 free(old);
452 while (parents) {
453 struct commit *commit = parents->item;
454 if (!parse_commit(commit) && !(commit->object.flags & mark)) {
455 commit->object.flags |= mark;
456 commit_list_insert_by_date(commit, list);
458 parents = parents->next;
460 return ret;
463 static void clear_commit_marks_1(struct commit_list **plist,
464 struct commit *commit, unsigned int mark)
466 while (commit) {
467 struct commit_list *parents;
469 if (!(mark & commit->object.flags))
470 return;
472 commit->object.flags &= ~mark;
474 parents = commit->parents;
475 if (!parents)
476 return;
478 while ((parents = parents->next))
479 commit_list_insert(parents->item, plist);
481 commit = commit->parents->item;
485 void clear_commit_marks_many(int nr, struct commit **commit, unsigned int mark)
487 struct commit_list *list = NULL;
489 while (nr--) {
490 commit_list_insert(*commit, &list);
491 commit++;
493 while (list)
494 clear_commit_marks_1(&list, pop_commit(&list), mark);
497 void clear_commit_marks(struct commit *commit, unsigned int mark)
499 clear_commit_marks_many(1, &commit, mark);
502 void clear_commit_marks_for_object_array(struct object_array *a, unsigned mark)
504 struct object *object;
505 struct commit *commit;
506 unsigned int i;
508 for (i = 0; i < a->nr; i++) {
509 object = a->objects[i].item;
510 commit = lookup_commit_reference_gently(object->sha1, 1);
511 if (commit)
512 clear_commit_marks(commit, mark);
516 struct commit *pop_commit(struct commit_list **stack)
518 struct commit_list *top = *stack;
519 struct commit *item = top ? top->item : NULL;
521 if (top) {
522 *stack = top->next;
523 free(top);
525 return item;
529 * Topological sort support
532 /* count number of children that have not been emitted */
533 define_commit_slab(indegree_slab, int);
535 /* record author-date for each commit object */
536 define_commit_slab(author_date_slab, unsigned long);
538 static void record_author_date(struct author_date_slab *author_date,
539 struct commit *commit)
541 const char *buf, *line_end, *ident_line;
542 char *buffer = NULL;
543 struct ident_split ident;
544 char *date_end;
545 unsigned long date;
547 if (!commit->buffer) {
548 unsigned long size;
549 enum object_type type;
550 buffer = read_sha1_file(commit->object.sha1, &type, &size);
551 if (!buffer)
552 return;
555 for (buf = commit->buffer ? commit->buffer : buffer;
556 buf;
557 buf = line_end + 1) {
558 line_end = strchrnul(buf, '\n');
559 ident_line = skip_prefix(buf, "author ");
560 if (!ident_line) {
561 if (!line_end[0] || line_end[1] == '\n')
562 return; /* end of header */
563 continue;
565 if (split_ident_line(&ident,
566 ident_line, line_end - ident_line) ||
567 !ident.date_begin || !ident.date_end)
568 goto fail_exit; /* malformed "author" line */
569 break;
572 date = strtoul(ident.date_begin, &date_end, 10);
573 if (date_end != ident.date_end)
574 goto fail_exit; /* malformed date */
575 *(author_date_slab_at(author_date, commit)) = date;
577 fail_exit:
578 free(buffer);
581 static int compare_commits_by_author_date(const void *a_, const void *b_,
582 void *cb_data)
584 const struct commit *a = a_, *b = b_;
585 struct author_date_slab *author_date = cb_data;
586 unsigned long a_date = *(author_date_slab_at(author_date, a));
587 unsigned long b_date = *(author_date_slab_at(author_date, b));
589 /* newer commits with larger date first */
590 if (a_date < b_date)
591 return 1;
592 else if (a_date > b_date)
593 return -1;
594 return 0;
597 int compare_commits_by_commit_date(const void *a_, const void *b_, void *unused)
599 const struct commit *a = a_, *b = b_;
600 /* newer commits with larger date first */
601 if (a->date < b->date)
602 return 1;
603 else if (a->date > b->date)
604 return -1;
605 return 0;
609 * Performs an in-place topological sort on the list supplied.
611 void sort_in_topological_order(struct commit_list **list, enum rev_sort_order sort_order)
613 struct commit_list *next, *orig = *list;
614 struct commit_list **pptr;
615 struct indegree_slab indegree;
616 struct prio_queue queue;
617 struct commit *commit;
618 struct author_date_slab author_date;
620 if (!orig)
621 return;
622 *list = NULL;
624 init_indegree_slab(&indegree);
625 memset(&queue, '\0', sizeof(queue));
627 switch (sort_order) {
628 default: /* REV_SORT_IN_GRAPH_ORDER */
629 queue.compare = NULL;
630 break;
631 case REV_SORT_BY_COMMIT_DATE:
632 queue.compare = compare_commits_by_commit_date;
633 break;
634 case REV_SORT_BY_AUTHOR_DATE:
635 init_author_date_slab(&author_date);
636 queue.compare = compare_commits_by_author_date;
637 queue.cb_data = &author_date;
638 break;
641 /* Mark them and clear the indegree */
642 for (next = orig; next; next = next->next) {
643 struct commit *commit = next->item;
644 *(indegree_slab_at(&indegree, commit)) = 1;
645 /* also record the author dates, if needed */
646 if (sort_order == REV_SORT_BY_AUTHOR_DATE)
647 record_author_date(&author_date, commit);
650 /* update the indegree */
651 for (next = orig; next; next = next->next) {
652 struct commit_list *parents = next->item->parents;
653 while (parents) {
654 struct commit *parent = parents->item;
655 int *pi = indegree_slab_at(&indegree, parent);
657 if (*pi)
658 (*pi)++;
659 parents = parents->next;
664 * find the tips
666 * tips are nodes not reachable from any other node in the list
668 * the tips serve as a starting set for the work queue.
670 for (next = orig; next; next = next->next) {
671 struct commit *commit = next->item;
673 if (*(indegree_slab_at(&indegree, commit)) == 1)
674 prio_queue_put(&queue, commit);
678 * This is unfortunate; the initial tips need to be shown
679 * in the order given from the revision traversal machinery.
681 if (sort_order == REV_SORT_IN_GRAPH_ORDER)
682 prio_queue_reverse(&queue);
684 /* We no longer need the commit list */
685 free_commit_list(orig);
687 pptr = list;
688 *list = NULL;
689 while ((commit = prio_queue_get(&queue)) != NULL) {
690 struct commit_list *parents;
692 for (parents = commit->parents; parents ; parents = parents->next) {
693 struct commit *parent = parents->item;
694 int *pi = indegree_slab_at(&indegree, parent);
696 if (!*pi)
697 continue;
700 * parents are only enqueued for emission
701 * when all their children have been emitted thereby
702 * guaranteeing topological order.
704 if (--(*pi) == 1)
705 prio_queue_put(&queue, parent);
708 * all children of commit have already been
709 * emitted. we can emit it now.
711 *(indegree_slab_at(&indegree, commit)) = 0;
713 pptr = &commit_list_insert(commit, pptr)->next;
716 clear_indegree_slab(&indegree);
717 clear_prio_queue(&queue);
718 if (sort_order == REV_SORT_BY_AUTHOR_DATE)
719 clear_author_date_slab(&author_date);
722 /* merge-base stuff */
724 /* Remember to update object flag allocation in object.h */
725 #define PARENT1 (1u<<16)
726 #define PARENT2 (1u<<17)
727 #define STALE (1u<<18)
728 #define RESULT (1u<<19)
730 static const unsigned all_flags = (PARENT1 | PARENT2 | STALE | RESULT);
732 static struct commit *interesting(struct commit_list *list)
734 while (list) {
735 struct commit *commit = list->item;
736 list = list->next;
737 if (commit->object.flags & STALE)
738 continue;
739 return commit;
741 return NULL;
744 /* all input commits in one and twos[] must have been parsed! */
745 static struct commit_list *paint_down_to_common(struct commit *one, int n, struct commit **twos)
747 struct commit_list *list = NULL;
748 struct commit_list *result = NULL;
749 int i;
751 one->object.flags |= PARENT1;
752 commit_list_insert_by_date(one, &list);
753 if (!n)
754 return list;
755 for (i = 0; i < n; i++) {
756 twos[i]->object.flags |= PARENT2;
757 commit_list_insert_by_date(twos[i], &list);
760 while (interesting(list)) {
761 struct commit *commit;
762 struct commit_list *parents;
763 struct commit_list *next;
764 int flags;
766 commit = list->item;
767 next = list->next;
768 free(list);
769 list = next;
771 flags = commit->object.flags & (PARENT1 | PARENT2 | STALE);
772 if (flags == (PARENT1 | PARENT2)) {
773 if (!(commit->object.flags & RESULT)) {
774 commit->object.flags |= RESULT;
775 commit_list_insert_by_date(commit, &result);
777 /* Mark parents of a found merge stale */
778 flags |= STALE;
780 parents = commit->parents;
781 while (parents) {
782 struct commit *p = parents->item;
783 parents = parents->next;
784 if ((p->object.flags & flags) == flags)
785 continue;
786 if (parse_commit(p))
787 return NULL;
788 p->object.flags |= flags;
789 commit_list_insert_by_date(p, &list);
793 free_commit_list(list);
794 return result;
797 static struct commit_list *merge_bases_many(struct commit *one, int n, struct commit **twos)
799 struct commit_list *list = NULL;
800 struct commit_list *result = NULL;
801 int i;
803 for (i = 0; i < n; i++) {
804 if (one == twos[i])
806 * We do not mark this even with RESULT so we do not
807 * have to clean it up.
809 return commit_list_insert(one, &result);
812 if (parse_commit(one))
813 return NULL;
814 for (i = 0; i < n; i++) {
815 if (parse_commit(twos[i]))
816 return NULL;
819 list = paint_down_to_common(one, n, twos);
821 while (list) {
822 struct commit_list *next = list->next;
823 if (!(list->item->object.flags & STALE))
824 commit_list_insert_by_date(list->item, &result);
825 free(list);
826 list = next;
828 return result;
831 struct commit_list *get_octopus_merge_bases(struct commit_list *in)
833 struct commit_list *i, *j, *k, *ret = NULL;
835 if (!in)
836 return ret;
838 commit_list_insert(in->item, &ret);
840 for (i = in->next; i; i = i->next) {
841 struct commit_list *new = NULL, *end = NULL;
843 for (j = ret; j; j = j->next) {
844 struct commit_list *bases;
845 bases = get_merge_bases(i->item, j->item, 1);
846 if (!new)
847 new = bases;
848 else
849 end->next = bases;
850 for (k = bases; k; k = k->next)
851 end = k;
853 ret = new;
855 return ret;
858 static int remove_redundant(struct commit **array, int cnt)
861 * Some commit in the array may be an ancestor of
862 * another commit. Move such commit to the end of
863 * the array, and return the number of commits that
864 * are independent from each other.
866 struct commit **work;
867 unsigned char *redundant;
868 int *filled_index;
869 int i, j, filled;
871 work = xcalloc(cnt, sizeof(*work));
872 redundant = xcalloc(cnt, 1);
873 filled_index = xmalloc(sizeof(*filled_index) * (cnt - 1));
875 for (i = 0; i < cnt; i++)
876 parse_commit(array[i]);
877 for (i = 0; i < cnt; i++) {
878 struct commit_list *common;
880 if (redundant[i])
881 continue;
882 for (j = filled = 0; j < cnt; j++) {
883 if (i == j || redundant[j])
884 continue;
885 filled_index[filled] = j;
886 work[filled++] = array[j];
888 common = paint_down_to_common(array[i], filled, work);
889 if (array[i]->object.flags & PARENT2)
890 redundant[i] = 1;
891 for (j = 0; j < filled; j++)
892 if (work[j]->object.flags & PARENT1)
893 redundant[filled_index[j]] = 1;
894 clear_commit_marks(array[i], all_flags);
895 for (j = 0; j < filled; j++)
896 clear_commit_marks(work[j], all_flags);
897 free_commit_list(common);
900 /* Now collect the result */
901 memcpy(work, array, sizeof(*array) * cnt);
902 for (i = filled = 0; i < cnt; i++)
903 if (!redundant[i])
904 array[filled++] = work[i];
905 for (j = filled, i = 0; i < cnt; i++)
906 if (redundant[i])
907 array[j++] = work[i];
908 free(work);
909 free(redundant);
910 free(filled_index);
911 return filled;
914 struct commit_list *get_merge_bases_many(struct commit *one,
915 int n,
916 struct commit **twos,
917 int cleanup)
919 struct commit_list *list;
920 struct commit **rslt;
921 struct commit_list *result;
922 int cnt, i;
924 result = merge_bases_many(one, n, twos);
925 for (i = 0; i < n; i++) {
926 if (one == twos[i])
927 return result;
929 if (!result || !result->next) {
930 if (cleanup) {
931 clear_commit_marks(one, all_flags);
932 clear_commit_marks_many(n, twos, all_flags);
934 return result;
937 /* There are more than one */
938 cnt = 0;
939 list = result;
940 while (list) {
941 list = list->next;
942 cnt++;
944 rslt = xcalloc(cnt, sizeof(*rslt));
945 for (list = result, i = 0; list; list = list->next)
946 rslt[i++] = list->item;
947 free_commit_list(result);
949 clear_commit_marks(one, all_flags);
950 clear_commit_marks_many(n, twos, all_flags);
952 cnt = remove_redundant(rslt, cnt);
953 result = NULL;
954 for (i = 0; i < cnt; i++)
955 commit_list_insert_by_date(rslt[i], &result);
956 free(rslt);
957 return result;
960 struct commit_list *get_merge_bases(struct commit *one, struct commit *two,
961 int cleanup)
963 return get_merge_bases_many(one, 1, &two, cleanup);
967 * Is "commit" a descendant of one of the elements on the "with_commit" list?
969 int is_descendant_of(struct commit *commit, struct commit_list *with_commit)
971 if (!with_commit)
972 return 1;
973 while (with_commit) {
974 struct commit *other;
976 other = with_commit->item;
977 with_commit = with_commit->next;
978 if (in_merge_bases(other, commit))
979 return 1;
981 return 0;
985 * Is "commit" an ancestor of one of the "references"?
987 int in_merge_bases_many(struct commit *commit, int nr_reference, struct commit **reference)
989 struct commit_list *bases;
990 int ret = 0, i;
992 if (parse_commit(commit))
993 return ret;
994 for (i = 0; i < nr_reference; i++)
995 if (parse_commit(reference[i]))
996 return ret;
998 bases = paint_down_to_common(commit, nr_reference, reference);
999 if (commit->object.flags & PARENT2)
1000 ret = 1;
1001 clear_commit_marks(commit, all_flags);
1002 clear_commit_marks_many(nr_reference, reference, all_flags);
1003 free_commit_list(bases);
1004 return ret;
1008 * Is "commit" an ancestor of (i.e. reachable from) the "reference"?
1010 int in_merge_bases(struct commit *commit, struct commit *reference)
1012 return in_merge_bases_many(commit, 1, &reference);
1015 struct commit_list *reduce_heads(struct commit_list *heads)
1017 struct commit_list *p;
1018 struct commit_list *result = NULL, **tail = &result;
1019 struct commit **array;
1020 int num_head, i;
1022 if (!heads)
1023 return NULL;
1025 /* Uniquify */
1026 for (p = heads; p; p = p->next)
1027 p->item->object.flags &= ~STALE;
1028 for (p = heads, num_head = 0; p; p = p->next) {
1029 if (p->item->object.flags & STALE)
1030 continue;
1031 p->item->object.flags |= STALE;
1032 num_head++;
1034 array = xcalloc(sizeof(*array), num_head);
1035 for (p = heads, i = 0; p; p = p->next) {
1036 if (p->item->object.flags & STALE) {
1037 array[i++] = p->item;
1038 p->item->object.flags &= ~STALE;
1041 num_head = remove_redundant(array, num_head);
1042 for (i = 0; i < num_head; i++)
1043 tail = &commit_list_insert(array[i], tail)->next;
1044 return result;
1047 static const char gpg_sig_header[] = "gpgsig";
1048 static const int gpg_sig_header_len = sizeof(gpg_sig_header) - 1;
1050 static int do_sign_commit(struct strbuf *buf, const char *keyid)
1052 struct strbuf sig = STRBUF_INIT;
1053 int inspos, copypos;
1055 /* find the end of the header */
1056 inspos = strstr(buf->buf, "\n\n") - buf->buf + 1;
1058 if (!keyid || !*keyid)
1059 keyid = get_signing_key();
1060 if (sign_buffer(buf, &sig, keyid)) {
1061 strbuf_release(&sig);
1062 return -1;
1065 for (copypos = 0; sig.buf[copypos]; ) {
1066 const char *bol = sig.buf + copypos;
1067 const char *eol = strchrnul(bol, '\n');
1068 int len = (eol - bol) + !!*eol;
1070 if (!copypos) {
1071 strbuf_insert(buf, inspos, gpg_sig_header, gpg_sig_header_len);
1072 inspos += gpg_sig_header_len;
1074 strbuf_insert(buf, inspos++, " ", 1);
1075 strbuf_insert(buf, inspos, bol, len);
1076 inspos += len;
1077 copypos += len;
1079 strbuf_release(&sig);
1080 return 0;
1083 int parse_signed_commit(const unsigned char *sha1,
1084 struct strbuf *payload, struct strbuf *signature)
1086 unsigned long size;
1087 enum object_type type;
1088 char *buffer = read_sha1_file(sha1, &type, &size);
1089 int in_signature, saw_signature = -1;
1090 char *line, *tail;
1092 if (!buffer || type != OBJ_COMMIT)
1093 goto cleanup;
1095 line = buffer;
1096 tail = buffer + size;
1097 in_signature = 0;
1098 saw_signature = 0;
1099 while (line < tail) {
1100 const char *sig = NULL;
1101 char *next = memchr(line, '\n', tail - line);
1103 next = next ? next + 1 : tail;
1104 if (in_signature && line[0] == ' ')
1105 sig = line + 1;
1106 else if (starts_with(line, gpg_sig_header) &&
1107 line[gpg_sig_header_len] == ' ')
1108 sig = line + gpg_sig_header_len + 1;
1109 if (sig) {
1110 strbuf_add(signature, sig, next - sig);
1111 saw_signature = 1;
1112 in_signature = 1;
1113 } else {
1114 if (*line == '\n')
1115 /* dump the whole remainder of the buffer */
1116 next = tail;
1117 strbuf_add(payload, line, next - line);
1118 in_signature = 0;
1120 line = next;
1122 cleanup:
1123 free(buffer);
1124 return saw_signature;
1127 static void handle_signed_tag(struct commit *parent, struct commit_extra_header ***tail)
1129 struct merge_remote_desc *desc;
1130 struct commit_extra_header *mergetag;
1131 char *buf;
1132 unsigned long size, len;
1133 enum object_type type;
1135 desc = merge_remote_util(parent);
1136 if (!desc || !desc->obj)
1137 return;
1138 buf = read_sha1_file(desc->obj->sha1, &type, &size);
1139 if (!buf || type != OBJ_TAG)
1140 goto free_return;
1141 len = parse_signature(buf, size);
1142 if (size == len)
1143 goto free_return;
1145 * We could verify this signature and either omit the tag when
1146 * it does not validate, but the integrator may not have the
1147 * public key of the signer of the tag he is merging, while a
1148 * later auditor may have it while auditing, so let's not run
1149 * verify-signed-buffer here for now...
1151 * if (verify_signed_buffer(buf, len, buf + len, size - len, ...))
1152 * warn("warning: signed tag unverified.");
1154 mergetag = xcalloc(1, sizeof(*mergetag));
1155 mergetag->key = xstrdup("mergetag");
1156 mergetag->value = buf;
1157 mergetag->len = size;
1159 **tail = mergetag;
1160 *tail = &mergetag->next;
1161 return;
1163 free_return:
1164 free(buf);
1167 static struct {
1168 char result;
1169 const char *check;
1170 } sigcheck_gpg_status[] = {
1171 { 'G', "\n[GNUPG:] GOODSIG " },
1172 { 'B', "\n[GNUPG:] BADSIG " },
1173 { 'U', "\n[GNUPG:] TRUST_NEVER" },
1174 { 'U', "\n[GNUPG:] TRUST_UNDEFINED" },
1177 static void parse_gpg_output(struct signature_check *sigc)
1179 const char *buf = sigc->gpg_status;
1180 int i;
1182 /* Iterate over all search strings */
1183 for (i = 0; i < ARRAY_SIZE(sigcheck_gpg_status); i++) {
1184 const char *found, *next;
1186 found = skip_prefix(buf, sigcheck_gpg_status[i].check + 1);
1187 if (!found) {
1188 found = strstr(buf, sigcheck_gpg_status[i].check);
1189 if (!found)
1190 continue;
1191 found += strlen(sigcheck_gpg_status[i].check);
1193 sigc->result = sigcheck_gpg_status[i].result;
1194 /* The trust messages are not followed by key/signer information */
1195 if (sigc->result != 'U') {
1196 sigc->key = xmemdupz(found, 16);
1197 found += 17;
1198 next = strchrnul(found, '\n');
1199 sigc->signer = xmemdupz(found, next - found);
1204 void check_commit_signature(const struct commit* commit, struct signature_check *sigc)
1206 struct strbuf payload = STRBUF_INIT;
1207 struct strbuf signature = STRBUF_INIT;
1208 struct strbuf gpg_output = STRBUF_INIT;
1209 struct strbuf gpg_status = STRBUF_INIT;
1210 int status;
1212 sigc->result = 'N';
1214 if (parse_signed_commit(commit->object.sha1,
1215 &payload, &signature) <= 0)
1216 goto out;
1217 status = verify_signed_buffer(payload.buf, payload.len,
1218 signature.buf, signature.len,
1219 &gpg_output, &gpg_status);
1220 if (status && !gpg_output.len)
1221 goto out;
1222 sigc->gpg_output = strbuf_detach(&gpg_output, NULL);
1223 sigc->gpg_status = strbuf_detach(&gpg_status, NULL);
1224 parse_gpg_output(sigc);
1226 out:
1227 strbuf_release(&gpg_status);
1228 strbuf_release(&gpg_output);
1229 strbuf_release(&payload);
1230 strbuf_release(&signature);
1235 void append_merge_tag_headers(struct commit_list *parents,
1236 struct commit_extra_header ***tail)
1238 while (parents) {
1239 struct commit *parent = parents->item;
1240 handle_signed_tag(parent, tail);
1241 parents = parents->next;
1245 static void add_extra_header(struct strbuf *buffer,
1246 struct commit_extra_header *extra)
1248 strbuf_addstr(buffer, extra->key);
1249 if (extra->len)
1250 strbuf_add_lines(buffer, " ", extra->value, extra->len);
1251 else
1252 strbuf_addch(buffer, '\n');
1255 struct commit_extra_header *read_commit_extra_headers(struct commit *commit,
1256 const char **exclude)
1258 struct commit_extra_header *extra = NULL;
1259 unsigned long size;
1260 enum object_type type;
1261 char *buffer = read_sha1_file(commit->object.sha1, &type, &size);
1262 if (buffer && type == OBJ_COMMIT)
1263 extra = read_commit_extra_header_lines(buffer, size, exclude);
1264 free(buffer);
1265 return extra;
1268 static inline int standard_header_field(const char *field, size_t len)
1270 return ((len == 4 && !memcmp(field, "tree ", 5)) ||
1271 (len == 6 && !memcmp(field, "parent ", 7)) ||
1272 (len == 6 && !memcmp(field, "author ", 7)) ||
1273 (len == 9 && !memcmp(field, "committer ", 10)) ||
1274 (len == 8 && !memcmp(field, "encoding ", 9)));
1277 static int excluded_header_field(const char *field, size_t len, const char **exclude)
1279 if (!exclude)
1280 return 0;
1282 while (*exclude) {
1283 size_t xlen = strlen(*exclude);
1284 if (len == xlen &&
1285 !memcmp(field, *exclude, xlen) && field[xlen] == ' ')
1286 return 1;
1287 exclude++;
1289 return 0;
1292 static struct commit_extra_header *read_commit_extra_header_lines(
1293 const char *buffer, size_t size,
1294 const char **exclude)
1296 struct commit_extra_header *extra = NULL, **tail = &extra, *it = NULL;
1297 const char *line, *next, *eof, *eob;
1298 struct strbuf buf = STRBUF_INIT;
1300 for (line = buffer, eob = line + size;
1301 line < eob && *line != '\n';
1302 line = next) {
1303 next = memchr(line, '\n', eob - line);
1304 next = next ? next + 1 : eob;
1305 if (*line == ' ') {
1306 /* continuation */
1307 if (it)
1308 strbuf_add(&buf, line + 1, next - (line + 1));
1309 continue;
1311 if (it)
1312 it->value = strbuf_detach(&buf, &it->len);
1313 strbuf_reset(&buf);
1314 it = NULL;
1316 eof = strchr(line, ' ');
1317 if (next <= eof)
1318 eof = next;
1320 if (standard_header_field(line, eof - line) ||
1321 excluded_header_field(line, eof - line, exclude))
1322 continue;
1324 it = xcalloc(1, sizeof(*it));
1325 it->key = xmemdupz(line, eof-line);
1326 *tail = it;
1327 tail = &it->next;
1328 if (eof + 1 < next)
1329 strbuf_add(&buf, eof + 1, next - (eof + 1));
1331 if (it)
1332 it->value = strbuf_detach(&buf, &it->len);
1333 return extra;
1336 void free_commit_extra_headers(struct commit_extra_header *extra)
1338 while (extra) {
1339 struct commit_extra_header *next = extra->next;
1340 free(extra->key);
1341 free(extra->value);
1342 free(extra);
1343 extra = next;
1347 int commit_tree(const struct strbuf *msg, const unsigned char *tree,
1348 struct commit_list *parents, unsigned char *ret,
1349 const char *author, const char *sign_commit)
1351 struct commit_extra_header *extra = NULL, **tail = &extra;
1352 int result;
1354 append_merge_tag_headers(parents, &tail);
1355 result = commit_tree_extended(msg, tree, parents, ret,
1356 author, sign_commit, extra);
1357 free_commit_extra_headers(extra);
1358 return result;
1361 static int find_invalid_utf8(const char *buf, int len)
1363 int offset = 0;
1364 static const unsigned int max_codepoint[] = {
1365 0x7f, 0x7ff, 0xffff, 0x10ffff
1368 while (len) {
1369 unsigned char c = *buf++;
1370 int bytes, bad_offset;
1371 unsigned int codepoint;
1372 unsigned int min_val, max_val;
1374 len--;
1375 offset++;
1377 /* Simple US-ASCII? No worries. */
1378 if (c < 0x80)
1379 continue;
1381 bad_offset = offset-1;
1384 * Count how many more high bits set: that's how
1385 * many more bytes this sequence should have.
1387 bytes = 0;
1388 while (c & 0x40) {
1389 c <<= 1;
1390 bytes++;
1394 * Must be between 1 and 3 more bytes. Longer sequences result in
1395 * codepoints beyond U+10FFFF, which are guaranteed never to exist.
1397 if (bytes < 1 || 3 < bytes)
1398 return bad_offset;
1400 /* Do we *have* that many bytes? */
1401 if (len < bytes)
1402 return bad_offset;
1405 * Place the encoded bits at the bottom of the value and compute the
1406 * valid range.
1408 codepoint = (c & 0x7f) >> bytes;
1409 min_val = max_codepoint[bytes-1] + 1;
1410 max_val = max_codepoint[bytes];
1412 offset += bytes;
1413 len -= bytes;
1415 /* And verify that they are good continuation bytes */
1416 do {
1417 codepoint <<= 6;
1418 codepoint |= *buf & 0x3f;
1419 if ((*buf++ & 0xc0) != 0x80)
1420 return bad_offset;
1421 } while (--bytes);
1423 /* Reject codepoints that are out of range for the sequence length. */
1424 if (codepoint < min_val || codepoint > max_val)
1425 return bad_offset;
1426 /* Surrogates are only for UTF-16 and cannot be encoded in UTF-8. */
1427 if ((codepoint & 0x1ff800) == 0xd800)
1428 return bad_offset;
1429 /* U+xxFFFE and U+xxFFFF are guaranteed non-characters. */
1430 if ((codepoint & 0xfffe) == 0xfffe)
1431 return bad_offset;
1432 /* So are anything in the range U+FDD0..U+FDEF. */
1433 if (codepoint >= 0xfdd0 && codepoint <= 0xfdef)
1434 return bad_offset;
1436 return -1;
1440 * This verifies that the buffer is in proper utf8 format.
1442 * If it isn't, it assumes any non-utf8 characters are Latin1,
1443 * and does the conversion.
1445 static int verify_utf8(struct strbuf *buf)
1447 int ok = 1;
1448 long pos = 0;
1450 for (;;) {
1451 int bad;
1452 unsigned char c;
1453 unsigned char replace[2];
1455 bad = find_invalid_utf8(buf->buf + pos, buf->len - pos);
1456 if (bad < 0)
1457 return ok;
1458 pos += bad;
1459 ok = 0;
1460 c = buf->buf[pos];
1461 strbuf_remove(buf, pos, 1);
1463 /* We know 'c' must be in the range 128-255 */
1464 replace[0] = 0xc0 + (c >> 6);
1465 replace[1] = 0x80 + (c & 0x3f);
1466 strbuf_insert(buf, pos, replace, 2);
1467 pos += 2;
1471 static const char commit_utf8_warn[] =
1472 "Warning: commit message did not conform to UTF-8.\n"
1473 "You may want to amend it after fixing the message, or set the config\n"
1474 "variable i18n.commitencoding to the encoding your project uses.\n";
1476 int commit_tree_extended(const struct strbuf *msg, const unsigned char *tree,
1477 struct commit_list *parents, unsigned char *ret,
1478 const char *author, const char *sign_commit,
1479 struct commit_extra_header *extra)
1481 int result;
1482 int encoding_is_utf8;
1483 struct strbuf buffer;
1485 assert_sha1_type(tree, OBJ_TREE);
1487 if (memchr(msg->buf, '\0', msg->len))
1488 return error("a NUL byte in commit log message not allowed.");
1490 /* Not having i18n.commitencoding is the same as having utf-8 */
1491 encoding_is_utf8 = is_encoding_utf8(git_commit_encoding);
1493 strbuf_init(&buffer, 8192); /* should avoid reallocs for the headers */
1494 strbuf_addf(&buffer, "tree %s\n", sha1_to_hex(tree));
1497 * NOTE! This ordering means that the same exact tree merged with a
1498 * different order of parents will be a _different_ changeset even
1499 * if everything else stays the same.
1501 while (parents) {
1502 struct commit_list *next = parents->next;
1503 struct commit *parent = parents->item;
1505 strbuf_addf(&buffer, "parent %s\n",
1506 sha1_to_hex(parent->object.sha1));
1507 free(parents);
1508 parents = next;
1511 /* Person/date information */
1512 if (!author)
1513 author = git_author_info(IDENT_STRICT);
1514 strbuf_addf(&buffer, "author %s\n", author);
1515 strbuf_addf(&buffer, "committer %s\n", git_committer_info(IDENT_STRICT));
1516 if (!encoding_is_utf8)
1517 strbuf_addf(&buffer, "encoding %s\n", git_commit_encoding);
1519 while (extra) {
1520 add_extra_header(&buffer, extra);
1521 extra = extra->next;
1523 strbuf_addch(&buffer, '\n');
1525 /* And add the comment */
1526 strbuf_addbuf(&buffer, msg);
1528 /* And check the encoding */
1529 if (encoding_is_utf8 && !verify_utf8(&buffer))
1530 fprintf(stderr, commit_utf8_warn);
1532 if (sign_commit && do_sign_commit(&buffer, sign_commit))
1533 return -1;
1535 result = write_sha1_file(buffer.buf, buffer.len, commit_type, ret);
1536 strbuf_release(&buffer);
1537 return result;
1540 struct commit *get_merge_parent(const char *name)
1542 struct object *obj;
1543 struct commit *commit;
1544 unsigned char sha1[20];
1545 if (get_sha1(name, sha1))
1546 return NULL;
1547 obj = parse_object(sha1);
1548 commit = (struct commit *)peel_to_type(name, 0, obj, OBJ_COMMIT);
1549 if (commit && !commit->util) {
1550 struct merge_remote_desc *desc;
1551 desc = xmalloc(sizeof(*desc));
1552 desc->obj = obj;
1553 desc->name = strdup(name);
1554 commit->util = desc;
1556 return commit;
1560 * Append a commit to the end of the commit_list.
1562 * next starts by pointing to the variable that holds the head of an
1563 * empty commit_list, and is updated to point to the "next" field of
1564 * the last item on the list as new commits are appended.
1566 * Usage example:
1568 * struct commit_list *list;
1569 * struct commit_list **next = &list;
1571 * next = commit_list_append(c1, next);
1572 * next = commit_list_append(c2, next);
1573 * assert(commit_list_count(list) == 2);
1574 * return list;
1576 struct commit_list **commit_list_append(struct commit *commit,
1577 struct commit_list **next)
1579 struct commit_list *new = xmalloc(sizeof(struct commit_list));
1580 new->item = commit;
1581 *next = new;
1582 new->next = NULL;
1583 return &new->next;
1586 void print_commit_list(struct commit_list *list,
1587 const char *format_cur,
1588 const char *format_last)
1590 for ( ; list; list = list->next) {
1591 const char *format = list->next ? format_cur : format_last;
1592 printf(format, sha1_to_hex(list->item->object.sha1));