[PATCH] Rename/copy detection fix.
[git.git] / diffcore-rename.c
index 8aa8f84..e8de493 100644 (file)
@@ -20,7 +20,7 @@ static void diff_rename_pool_add(struct diff_rename_pool *pool,
                                 struct diff_filespec *s)
 {
        if (S_ISDIR(s->mode))
-               return;  /* rename/copy patch for tree does not make sense. */
+               return;  /* no trees, please */
 
        if (pool->alloc <= pool->nr) {
                pool->alloc = alloc_nr(pool->alloc);
@@ -68,37 +68,46 @@ static int estimate_similarity(struct diff_filespec *src,
         * else.
         */
        void *delta;
-       unsigned long delta_size;
+       unsigned long delta_size, base_size;
        int score;
 
+       /* We deal only with regular files.  Symlink renames are handled
+        * only when they are exact matches --- in other words, no edits
+        * after renaming.
+        */
+       if (!S_ISREG(src->mode) || !S_ISREG(dst->mode))
+               return 0;
+
        delta_size = ((src->size < dst->size) ?
                      (dst->size - src->size) : (src->size - dst->size));
-
-       /* We would not consider rename followed by more than
-        * minimum_score/MAX_SCORE edits; that is, delta_size must be smaller
-        * than (src->size + dst->size)/2 * minimum_score/MAX_SCORE,
-        * which means...
+       base_size = ((src->size < dst->size) ? src->size : dst->size);
+
+       /* We would not consider edits that change the file size so
+        * drastically.  delta_size must be smaller than
+        * (MAX_SCORE-minimum_score)/MAX_SCORE * min(src->size, dst->size).
+        * Note that base_size == 0 case is handled here already
+        * and the final score computation below would not have a
+        * divide-by-zero issue.
         */
-
-       if ((src->size+dst->size)*minimum_score < delta_size*MAX_SCORE*2)
+       if (base_size * (MAX_SCORE-minimum_score) < delta_size * MAX_SCORE)
                return 0;
 
        delta = diff_delta(src->data, src->size,
                           dst->data, dst->size,
                           &delta_size);
+       /*
+        * We currently punt here, but we may later end up parsing the
+        * delta to really assess the extent of damage.  A big consecutive
+        * remove would produce small delta_size that affects quite a
+        * big portion of the file.
+        */
        free(delta);
 
-       /* This "delta" is really xdiff with adler32 and all the
-        * overheads but it is a quick and dirty approximation.
-        *
-        * Now we will give some score to it.  100% edit gets
-        * 0 points and 0% edit gets MAX_SCORE points.  That is, every
-        * 1/MAX_SCORE edit gets 1 point penalty.  The amount of penalty is:
-        *
-        * (delta_size * 2 / (src->size + dst->size)) * MAX_SCORE
-        *
+       /*
+        * Now we will give some score to it.  100% edit gets 0 points
+        * and 0% edit gets MAX_SCORE points.
         */
-       score = MAX_SCORE-(MAX_SCORE*2*delta_size/(src->size+dst->size));
+       score = MAX_SCORE - (MAX_SCORE * delta_size / base_size); 
        if (score < 0) return 0;
        if (MAX_SCORE < score) return MAX_SCORE;
        return score;
@@ -110,27 +119,34 @@ static void record_rename_pair(struct diff_queue_struct *outq,
                               int rank,
                               int score)
 {
-       /* The rank is used to sort the final output, because there
-        * are certain dependencies.
+       /*
+        * These ranks are used to sort the final output, because there
+        * are certain dependencies:
         *
-        *  - rank #0 depends on deleted ones.
-        *  - rank #1 depends on kept files before they are modified.
-        *  - rank #2 depends on kept files after they are modified;
-        *    currently not used.
-        *
-        * Therefore, the final output order should be:
-        *
-        *  1. rank #0 rename/copy diffs.
+        *  1. rename/copy that depends on deleted ones.
         *  2. deletions in the original.
-        *  3. rank #1 rename/copy diffs.
-        *  4. additions and modifications in the original.
-        *  5. rank #2 rename/copy diffs; currently not used.
+        *  3. rename/copy that depends on the pre-edit image of kept files.
+        *  4. additions, modifications and no-modifications in the original.
+        *  5. rename/copy that depends on the post-edit image of kept files
+        *     (note that we currently do not detect such rename/copy).
+        *
+        * The downstream diffcore transformers are free to reorder
+        * the entries as long as they keep file pairs that has the
+        * same p->one->path in earlier rename_rank to appear before
+        * later ones.  This ordering is used by the diff_flush()
+        * logic to tell renames from copies, and also used by the
+        * diffcore_prune() logic to omit unnecessary
+        * "no-modification" entries.
         *
-        * To achieve this sort order, we give xform_work the number
-        * above.
+        * To the final output routine, and in the diff-raw format
+        * output, a rename/copy that is based on a path that has a
+        * later entry that shares the same p->one->path and is not a
+        * deletion is a copy.  Otherwise it is a rename.
         */
-       struct diff_file_pair *dp = diff_queue(outq, src, dst);
-       dp->xfrm_work = (rank * 2 + 1) | (score<<RENAME_SCORE_SHIFT);
+
+       struct diff_filepair *dp = diff_queue(outq, src, dst);
+       dp->rename_rank = rank * 2 + 1;
+       dp->score = score;
        dst->xfrm_flags |= RENAME_DST_MATCHED;
 }
 
@@ -140,7 +156,7 @@ static void debug_filespec(struct diff_filespec *s, int x, const char *one)
        fprintf(stderr, "queue[%d] %s (%s) %s %06o %s\n",
                x, one,
                s->path,
-               s->file_valid ? "valid" : "invalid",
+               DIFF_FILE_VALID(s) ? "valid" : "invalid",
                s->mode,
                s->sha1_valid ? sha1_to_hex(s->sha1) : "");
        fprintf(stderr, "queue[%d] %s size %lu flags %d\n",
@@ -148,14 +164,12 @@ static void debug_filespec(struct diff_filespec *s, int x, const char *one)
                s->size, s->xfrm_flags);
 }
 
-static void debug_filepair(const struct diff_file_pair *p, int i)
+static void debug_filepair(const struct diff_filepair *p, int i)
 {
        debug_filespec(p->one, i, "one");
        debug_filespec(p->two, i, "two");
-       fprintf(stderr, "pair flags %d, orig order %d, score %d\n",
-               (p->xfrm_work & ((1<<RENAME_SCORE_SHIFT) - 1)),
-               p->orig_order,
-               (p->xfrm_work >> RENAME_SCORE_SHIFT));
+       fprintf(stderr, "pair rank %d, orig order %d, score %d\n",
+               p->rename_rank, p->orig_order, p->score);
 }
 
 static void debug_queue(const char *msg, struct diff_queue_struct *q)
@@ -165,7 +179,7 @@ static void debug_queue(const char *msg, struct diff_queue_struct *q)
                fprintf(stderr, "%s\n", msg);
        fprintf(stderr, "q->nr = %d\n", q->nr);
        for (i = 0; i < q->nr; i++) {
-               struct diff_file_pair *p = q->queue[i];
+               struct diff_filepair *p = q->queue[i];
                debug_filepair(p, i);
        }
 }
@@ -180,10 +194,10 @@ static void debug_queue(const char *msg, struct diff_queue_struct *q)
  */
 static int rank_compare(const void *a_, const void *b_)
 {
-       const struct diff_file_pair *a = *(const struct diff_file_pair **)a_;
-       const struct diff_file_pair *b = *(const struct diff_file_pair **)b_;
-       int a_rank = a->xfrm_work & ((1<<RENAME_SCORE_SHIFT) - 1);
-       int b_rank = b->xfrm_work & ((1<<RENAME_SCORE_SHIFT) - 1);
+       const struct diff_filepair *a = *(const struct diff_filepair **)a_;
+       const struct diff_filepair *b = *(const struct diff_filepair **)b_;
+       int a_rank = a->rename_rank;
+       int b_rank = b->rename_rank;
 
        if (a_rank != b_rank)
                return a_rank - b_rank;
@@ -200,32 +214,27 @@ static int score_compare(const void *a_, const void *b_)
        return b->score - a->score;
 }
 
-static int needs_to_stay(struct diff_queue_struct *q, int i,
-                        struct diff_filespec *it)
+int diff_scoreopt_parse(const char *opt)
 {
-       /* If it will be used in later entry (either stay or used
-        * as the source of rename/copy), we need to copy, not rename.
+       int diglen, num, scale, i;
+       if (opt[0] != '-' || (opt[1] != 'M' && opt[1] != 'C'))
+               return -1; /* that is not a -M nor -C option */
+       diglen = strspn(opt+2, "0123456789");
+       if (diglen == 0 || strlen(opt+2) != diglen)
+               return 0; /* use default */
+       sscanf(opt+2, "%d", &num);
+       for (i = 0, scale = 1; i < diglen; i++)
+               scale *= 10;
+
+       /* user says num divided by scale and we say internally that
+        * is MAX_SCORE * num / scale.
         */
-       while (i < q->nr) {
-               struct diff_file_pair *p = q->queue[i++];
-               if (!p->two->file_valid)
-                       continue; /* removed is fine */
-               if (strcmp(p->one->path, it->path))
-                       continue; /* not relevant */
-
-               /* p has its src set to *it and it is not a delete;
-                * it will be used for in-place change or rename/copy,
-                * so we cannot rename it out.
-                */
-               return 1;
-       }
-       return 0;
+       return MAX_SCORE * num / scale;
 }
 
-void diff_detect_rename(struct diff_queue_struct *q,
-                       int detect_rename,
-                       int minimum_score)
+void diffcore_rename(int detect_rename, int minimum_score)
 {
+       struct diff_queue_struct *q = &diff_queued_diff;
        struct diff_queue_struct outq;
        struct diff_rename_pool created, deleted, stay;
        struct diff_rename_pool *(srcs[2]);
@@ -233,6 +242,8 @@ void diff_detect_rename(struct diff_queue_struct *q,
        int h, i, j;
        int num_create, num_src, dst_cnt, src_cnt;
 
+       if (!minimum_score)
+               minimum_score = DEFAULT_MINIMUM_SCORE;
        outq.queue = NULL;
        outq.nr = outq.alloc = 0;
 
@@ -243,21 +254,14 @@ void diff_detect_rename(struct diff_queue_struct *q,
        srcs[0] = &deleted;
        srcs[1] = &stay;
 
-       /* NEEDSWORK:
-        * (1) make sure we properly ignore but pass trees.
-        *
-        * (2) make sure we do right thing on the same path deleted
-        *     and created in the same patch.
-        */
-
        for (i = 0; i < q->nr; i++) {
-               struct diff_file_pair *p = q->queue[i];
-               if (!p->one->file_valid)
-                       if (!p->two->file_valid)
-                               continue; /* ignore nonsense */
+               struct diff_filepair *p = q->queue[i];
+               if (!DIFF_FILE_VALID(p->one))
+                       if (!DIFF_FILE_VALID(p->two))
+                               continue; /* unmerged */
                        else
                                diff_rename_pool_add(&created, p->two);
-               else if (!p->two->file_valid)
+               else if (!DIFF_FILE_VALID(p->two))
                        diff_rename_pool_add(&deleted, p->one);
                else if (1 < detect_rename) /* find copy, too */
                        diff_rename_pool_add(&stay, p->one);
@@ -321,7 +325,7 @@ void diff_detect_rename(struct diff_queue_struct *q,
                if (mx[i].dst->xfrm_flags & RENAME_DST_MATCHED)
                        continue; /* alreayd done, either exact or fuzzy. */
                if (mx[i].score < minimum_score)
-                       continue;
+                       break; /* there is not any more diffs applicable. */
                record_rename_pair(&outq,
                                  mx[i].src, mx[i].dst, mx[i].rank,
                                  mx[i].score);
@@ -338,30 +342,24 @@ void diff_detect_rename(struct diff_queue_struct *q,
         * downstream, so we assign the sort keys in this loop.
         *
         * See comments at the top of record_rename_pair for numbers used
-        * to assign xfrm_work.
-        *
-        * Note that we have not annotated the diff_file_pair with any comment
-        * so there is nothing other than p to free.
+        * to assign rename_rank.
         */
        for (i = 0; i < q->nr; i++) {
-               struct diff_file_pair *dp, *p = q->queue[i];
-               if (!p->one->file_valid) {
-                       if (p->two->file_valid) {
-                               /* creation */
-                               dp = diff_queue(&outq, p->one, p->two);
-                               dp->xfrm_work = 4;
-                       }
-                       /* otherwise it is a nonsense; just ignore it */
+               struct diff_filepair *dp, *p = q->queue[i];
+               if (!DIFF_FILE_VALID(p->one)) {
+                       /* creation or unmerged entries */
+                       dp = diff_queue(&outq, p->one, p->two);
+                       dp->rename_rank = 4;
                }
-               else if (!p->two->file_valid) {
+               else if (!DIFF_FILE_VALID(p->two)) {
                        /* deletion */
                        dp = diff_queue(&outq, p->one, p->two);
-                       dp->xfrm_work = 2;
+                       dp->rename_rank = 2;
                }
                else {
                        /* modification, or stay as is */
                        dp = diff_queue(&outq, p->one, p->two);
-                       dp->xfrm_work = 4;
+                       dp->rename_rank = 4;
                }
                free(p);
        }
@@ -378,15 +376,15 @@ void diff_detect_rename(struct diff_queue_struct *q,
 
        /* Copy it out to q, removing duplicates. */
        for (i = 0; i < outq.nr; i++) {
-               struct diff_file_pair *p = outq.queue[i];
-               if (!p->one->file_valid) {
-                       /* created */
+               struct diff_filepair *p = outq.queue[i];
+               if (!DIFF_FILE_VALID(p->one)) {
+                       /* created or unmerged */
                        if (p->two->xfrm_flags & RENAME_DST_MATCHED)
                                ; /* rename/copy created it already */
                        else
                                diff_queue(q, p->one, p->two);
                }
-               else if (!p->two->file_valid) {
+               else if (!DIFF_FILE_VALID(p->two)) {
                        /* deleted */
                        if (p->one->xfrm_flags & RENAME_SRC_GONE)
                                ; /* rename/copy deleted it already */
@@ -395,39 +393,21 @@ void diff_detect_rename(struct diff_queue_struct *q,
                }
                else if (strcmp(p->one->path, p->two->path)) {
                        /* rename or copy */
-                       struct diff_file_pair *dp =
+                       struct diff_filepair *dp =
                                diff_queue(q, p->one, p->two);
-                       int msglen = (strlen(p->one->path) +
-                                     strlen(p->two->path) + 100);
-                       int score = (p->xfrm_work >> RENAME_SCORE_SHIFT);
-                       dp->xfrm_msg = xmalloc(msglen);
+                       dp->score = p->score;
 
                        /* if we have a later entry that is a rename/copy
                         * that depends on p->one, then we copy here.
                         * otherwise we rename it.
                         */
-                       if (needs_to_stay(&outq, i+1, p->one)) {
-                               /* copy it */
-                               sprintf(dp->xfrm_msg,
-                                       "similarity index %d%%\n"
-                                       "copy from %s\n"
-                                       "copy to %s\n",
-                                       (int)(0.5 + score * 100 / MAX_SCORE),
-                                       p->one->path, p->two->path);
-                       }
-                       else {
-                               /* rename it, and mark it as gone. */
+                       if (!diff_needs_to_stay(&outq, i+1, p->one))
+                               /* this is the last one, so mark it as gone.
+                                */
                                p->one->xfrm_flags |= RENAME_SRC_GONE;
-                               sprintf(dp->xfrm_msg,
-                                       "similarity index %d%%\n"
-                                       "rename old %s\n"
-                                       "rename new %s\n",
-                                       (int)(0.5 + score * 100 / MAX_SCORE),
-                                       p->one->path, p->two->path);
-                       }
                }
                else
-                       /* otherwise it is a modified (or stayed) entry */
+                       /* otherwise it is a modified (or "stay") entry */
                        diff_queue(q, p->one, p->two);
                free(p);
        }