Fix off-by-one error in git-merge
[gitweb.git] / merge-base.c
index 0b99598f305593de5d48e6cbafcbdea359349c45..286bf0e8d1522ac4cf01f75343da40ddff6bf6e8 100644 (file)
 #include "cache.h"
 #include "commit.h"
 
-static struct commit *process_list(struct commit_list **list_p, int this_mark,
-                                  int other_mark)
+#define PARENT1 1
+#define PARENT2 2
+#define UNINTERESTING 4
+
+static struct commit *interesting(struct commit_list *list)
 {
-       struct commit_list *parent, *temp;
-       struct commit_list *posn = *list_p;
-       *list_p = NULL;
-       while (posn) {
-               parse_commit(posn->item);
-               if (posn->item->object.flags & this_mark) {
-                       /*
-                         printf("%d already seen %s %x\n",
-                         this_mark
-                         sha1_to_hex(posn->parent->sha1),
-                         posn->parent->flags);
-                       */
-                       /* do nothing; this indicates that this side
-                        * split and reformed, and we only need to
-                        * mark it once.
-                        */
-               } else if (posn->item->object.flags & other_mark) {
-                       return posn->item;
-               } else {
-                       /*
-                         printf("%d based on %s\n",
-                         this_mark,
-                         sha1_to_hex(posn->parent->sha1));
-                       */
-                       posn->item->object.flags |= this_mark;
-                       
-                       parent = posn->item->parents;
-                       while (parent) {
-                               temp = malloc(sizeof(struct commit_list));
-                               temp->next = *list_p;
-                               temp->item = parent->item;
-                               *list_p = temp;
-                               parent = parent->next;
-                       }
-               }
-               posn = posn->next;
+       while (list) {
+               struct commit *commit = list->item;
+               list = list->next;
+               if (commit->object.flags & UNINTERESTING)
+                       continue;
+               return commit;
        }
        return NULL;
 }
 
-struct commit *common_ancestor(struct commit *rev1, struct commit *rev2)
+/*
+ * A pathological example of how this thing works.
+ *
+ * Suppose we had this commit graph, where chronologically
+ * the timestamp on the commit are A <= B <= C <= D <= E <= F
+ * and we are trying to figure out the merge base for E and F
+ * commits.
+ *
+ *                  F
+ *                 / \
+ *            E   A   D
+ *             \ /   /  
+ *              B   /
+ *               \ /
+ *                C
+ *
+ * First we push E and F to list to be processed.  E gets bit 1
+ * and F gets bit 2.  The list becomes:
+ *
+ *     list=F(2) E(1), result=empty
+ *
+ * Then we pop F, the newest commit, from the list.  Its flag is 2.
+ * We scan its parents, mark them reachable from the side that F is
+ * reachable from, and push them to the list:
+ *
+ *     list=E(1) D(2) A(2), result=empty
+ *
+ * Next pop E and do the same.
+ *
+ *     list=D(2) B(1) A(2), result=empty
+ *
+ * Next pop D and do the same.
+ *
+ *     list=C(2) B(1) A(2), result=empty
+ *
+ * Next pop C and do the same.
+ *
+ *     list=B(1) A(2), result=empty
+ *
+ * Now it is B's turn.  We mark its parent, C, reachable from B's side,
+ * and push it to the list:
+ *
+ *     list=C(3) A(2), result=empty
+ *
+ * Now pop C and notice it has flags==3.  It is placed on the result list,
+ * and the list now contains:
+ *
+ *     list=A(2), result=C(3)
+ *
+ * We pop A and do the same.
+ * 
+ *     list=B(3), result=C(3)
+ *
+ * Next, we pop B and something very interesting happens.  It has flags==3
+ * so it is also placed on the result list, and its parents are marked
+ * uninteresting, retroactively, and placed back on the list:
+ *
+ *    list=C(7), result=C(7) B(3)
+ * 
+ * Now, list does not have any interesting commit.  So we find the newest
+ * commit from the result list that is not marked uninteresting.  Which is
+ * commit B.
+ */
+
+static int show_all = 0;
+
+static int merge_base(struct commit *rev1, struct commit *rev2)
 {
-       struct commit_list *rev1list = malloc(sizeof(struct commit_list));
-       struct commit_list *rev2list = malloc(sizeof(struct commit_list));
+       struct commit_list *list = NULL;
+       struct commit_list *result = NULL;
+
+       if (rev1 == rev2) {
+               printf("%s\n", sha1_to_hex(rev1->object.sha1));
+               return 0;
+       }
+
+       parse_commit(rev1);
+       parse_commit(rev2);
 
-       rev1list->item = rev1;
-       rev1list->next = NULL;
+       rev1->object.flags |= 1;
+       rev2->object.flags |= 2;
+       insert_by_date(rev1, &list);
+       insert_by_date(rev2, &list);
 
-       rev2list->item = rev2;
-       rev2list->next = NULL;
+       while (interesting(list)) {
+               struct commit *commit = list->item;
+               struct commit_list *tmp = list, *parents;
+               int flags = commit->object.flags & 7;
 
-       while (rev1list || rev2list) {
-               struct commit *ret;
-               ret = process_list(&rev1list, 0x1, 0x2);
-               if (ret) {
-                       /* XXXX free lists */
-                       return ret;
+               list = list->next;
+               free(tmp);
+               if (flags == 3) {
+                       insert_by_date(commit, &result);
+
+                       /* Mark parents of a found merge uninteresting */
+                       flags |= UNINTERESTING;
                }
-               ret = process_list(&rev2list, 0x2, 0x1);
-               if (ret) {
-                       /* XXXX free lists */
-                       return ret;
+               parents = commit->parents;
+               while (parents) {
+                       struct commit *p = parents->item;
+                       parents = parents->next;
+                       if ((p->object.flags & flags) == flags)
+                               continue;
+                       parse_commit(p);
+                       p->object.flags |= flags;
+                       insert_by_date(p, &list);
                }
        }
-       return NULL;
+
+       if (!result)
+               return 1;
+
+       while (result) {
+               struct commit *commit = result->item;
+               result = result->next;
+               if (commit->object.flags & UNINTERESTING)
+                       continue;
+               printf("%s\n", sha1_to_hex(commit->object.sha1));
+               if (!show_all)
+                       return 0;
+               commit->object.flags |= UNINTERESTING;
+       }
+       return 0;
 }
 
+static const char merge_base_usage[] =
+"git-merge-base [--all] <commit-id> <commit-id>";
+
 int main(int argc, char **argv)
 {
-       struct commit *rev1, *rev2, *ret;
+       struct commit *rev1, *rev2;
        unsigned char rev1key[20], rev2key[20];
 
-       if (argc != 3 ||
-           get_sha1_hex(argv[1], rev1key) ||
-           get_sha1_hex(argv[2], rev2key)) {
-               usage("merge-base <commit-id> <commit-id>");
+       while (1 < argc && argv[1][0] == '-') {
+               char *arg = argv[1];
+               if (!strcmp(arg, "-a") || !strcmp(arg, "--all"))
+                       show_all = 1;
+               else
+                       usage(merge_base_usage);
+               argc--; argv++;
        }
-       rev1 = lookup_commit(rev1key);
-       rev2 = lookup_commit(rev2key);
-       ret = common_ancestor(rev1, rev2);
-       if (ret) {
-               printf("%s\n", sha1_to_hex(ret->object.sha1));
-               return 0;
-       } else {
+       if (argc != 3 ||
+           get_sha1(argv[1], rev1key) ||
+           get_sha1(argv[2], rev2key))
+               usage(merge_base_usage);
+       rev1 = lookup_commit_reference(rev1key);
+       rev2 = lookup_commit_reference(rev2key);
+       if (!rev1 || !rev2)
                return 1;
-       }
-       
+       return merge_base(rev1, rev2);
 }