2  * Copyright (C) 2005 Junio C Hamano
 
  10 /* Table of rename/copy destinations */
 
  12 static struct diff_rename_dst {
 
  13         struct diff_filespec *two;
 
  14         struct diff_filepair *pair;
 
  16 static int rename_dst_nr, rename_dst_alloc;
 
  18 static struct diff_rename_dst *locate_rename_dst(struct diff_filespec *two,
 
  25         while (last > first) {
 
  26                 int next = (last + first) >> 1;
 
  27                 struct diff_rename_dst *dst = &(rename_dst[next]);
 
  28                 int cmp = strcmp(two->path, dst->two->path);
 
  40         /* insert to make it at "first" */
 
  41         if (rename_dst_alloc <= rename_dst_nr) {
 
  42                 rename_dst_alloc = alloc_nr(rename_dst_alloc);
 
  43                 rename_dst = xrealloc(rename_dst,
 
  44                                       rename_dst_alloc * sizeof(*rename_dst));
 
  47         if (first < rename_dst_nr)
 
  48                 memmove(rename_dst + first + 1, rename_dst + first,
 
  49                         (rename_dst_nr - first - 1) * sizeof(*rename_dst));
 
  50         rename_dst[first].two = alloc_filespec(two->path);
 
  51         fill_filespec(rename_dst[first].two, two->sha1, two->mode);
 
  52         rename_dst[first].pair = NULL;
 
  53         return &(rename_dst[first]);
 
  56 /* Table of rename/copy src files */
 
  57 static struct diff_rename_src {
 
  58         struct diff_filepair *p;
 
  59         unsigned short score; /* to remember the break score */
 
  61 static int rename_src_nr, rename_src_alloc;
 
  63 static struct diff_rename_src *register_rename_src(struct diff_filepair *p)
 
  66         struct diff_filespec *one = p->one;
 
  67         unsigned short score = p->score;
 
  71         while (last > first) {
 
  72                 int next = (last + first) >> 1;
 
  73                 struct diff_rename_src *src = &(rename_src[next]);
 
  74                 int cmp = strcmp(one->path, src->p->one->path);
 
  84         /* insert to make it at "first" */
 
  85         if (rename_src_alloc <= rename_src_nr) {
 
  86                 rename_src_alloc = alloc_nr(rename_src_alloc);
 
  87                 rename_src = xrealloc(rename_src,
 
  88                                       rename_src_alloc * sizeof(*rename_src));
 
  91         if (first < rename_src_nr)
 
  92                 memmove(rename_src + first + 1, rename_src + first,
 
  93                         (rename_src_nr - first - 1) * sizeof(*rename_src));
 
  94         rename_src[first].p = p;
 
  95         rename_src[first].score = score;
 
  96         return &(rename_src[first]);
 
  99 static int basename_same(struct diff_filespec *src, struct diff_filespec *dst)
 
 101         int src_len = strlen(src->path), dst_len = strlen(dst->path);
 
 102         while (src_len && dst_len) {
 
 103                 char c1 = src->path[--src_len];
 
 104                 char c2 = dst->path[--dst_len];
 
 110         return (!src_len || src->path[src_len - 1] == '/') &&
 
 111                 (!dst_len || dst->path[dst_len - 1] == '/');
 
 115         int src; /* index in rename_src */
 
 116         int dst; /* index in rename_dst */
 
 117         unsigned short score;
 
 121 static int estimate_similarity(struct diff_filespec *src,
 
 122                                struct diff_filespec *dst,
 
 125         /* src points at a file that existed in the original tree (or
 
 126          * optionally a file in the destination tree) and dst points
 
 127          * at a newly created file.  They may be quite similar, in which
 
 128          * case we want to say src is renamed to dst or src is copied into
 
 129          * dst, and then some edit has been applied to dst.
 
 131          * Compare them and return how similar they are, representing
 
 132          * the score as an integer between 0 and MAX_SCORE.
 
 134          * When there is an exact match, it is considered a better
 
 135          * match than anything else; the destination does not even
 
 136          * call into this function in that case.
 
 138         unsigned long max_size, delta_size, base_size, src_copied, literal_added;
 
 139         unsigned long delta_limit;
 
 142         /* We deal only with regular files.  Symlink renames are handled
 
 143          * only when they are exact matches --- in other words, no edits
 
 146         if (!S_ISREG(src->mode) || !S_ISREG(dst->mode))
 
 150          * Need to check that source and destination sizes are
 
 151          * filled in before comparing them.
 
 153          * If we already have "cnt_data" filled in, we know it's
 
 154          * all good (avoid checking the size for zero, as that
 
 155          * is a possible size - we really should have a flag to
 
 156          * say whether the size is valid or not!)
 
 158         if (!src->cnt_data && diff_populate_filespec(src, 1))
 
 160         if (!dst->cnt_data && diff_populate_filespec(dst, 1))
 
 163         max_size = ((src->size > dst->size) ? src->size : dst->size);
 
 164         base_size = ((src->size < dst->size) ? src->size : dst->size);
 
 165         delta_size = max_size - base_size;
 
 167         /* We would not consider edits that change the file size so
 
 168          * drastically.  delta_size must be smaller than
 
 169          * (MAX_SCORE-minimum_score)/MAX_SCORE * min(src->size, dst->size).
 
 171          * Note that base_size == 0 case is handled here already
 
 172          * and the final score computation below would not have a
 
 173          * divide-by-zero issue.
 
 175         if (max_size * (MAX_SCORE-minimum_score) < delta_size * MAX_SCORE)
 
 178         if (!src->cnt_data && diff_populate_filespec(src, 0))
 
 180         if (!dst->cnt_data && diff_populate_filespec(dst, 0))
 
 183         delta_limit = (unsigned long)
 
 184                 (base_size * (MAX_SCORE-minimum_score) / MAX_SCORE);
 
 185         if (diffcore_count_changes(src, dst,
 
 186                                    &src->cnt_data, &dst->cnt_data,
 
 188                                    &src_copied, &literal_added))
 
 191         /* How similar are they?
 
 192          * what percentage of material in dst are from source?
 
 195                 score = 0; /* should not happen */
 
 197                 score = (int)(src_copied * MAX_SCORE / max_size);
 
 201 static void record_rename_pair(int dst_index, int src_index, int score)
 
 203         struct diff_filespec *src, *dst;
 
 204         struct diff_filepair *dp;
 
 206         if (rename_dst[dst_index].pair)
 
 207                 die("internal error: dst already matched.");
 
 209         src = rename_src[src_index].p->one;
 
 213         dst = rename_dst[dst_index].two;
 
 216         dp = diff_queue(NULL, src, dst);
 
 217         dp->renamed_pair = 1;
 
 218         if (!strcmp(src->path, dst->path))
 
 219                 dp->score = rename_src[src_index].score;
 
 222         rename_dst[dst_index].pair = dp;
 
 226  * We sort the rename similarity matrix with the score, in descending
 
 227  * order (the most similar first).
 
 229 static int score_compare(const void *a_, const void *b_)
 
 231         const struct diff_score *a = a_, *b = b_;
 
 233         /* sink the unused ones to the bottom */
 
 235                 return (0 <= b->dst);
 
 239         if (a->score == b->score)
 
 240                 return b->name_score - a->name_score;
 
 242         return b->score - a->score;
 
 245 struct file_similarity {
 
 247         struct diff_filespec *filespec;
 
 248         struct file_similarity *next;
 
 251 static int find_identical_files(struct file_similarity *src,
 
 252                                 struct file_similarity *dst,
 
 253                                 struct diff_options *options)
 
 258          * Walk over all the destinations ...
 
 261                 struct diff_filespec *target = dst->filespec;
 
 262                 struct file_similarity *p, *best;
 
 263                 int i = 100, best_score = -1;
 
 266                  * .. to find the best source match
 
 269                 for (p = src; p; p = p->next) {
 
 271                         struct diff_filespec *source = p->filespec;
 
 273                         /* False hash collision? */
 
 274                         if (hashcmp(source->sha1, target->sha1))
 
 276                         /* Non-regular files? If so, the modes must match! */
 
 277                         if (!S_ISREG(source->mode) || !S_ISREG(target->mode)) {
 
 278                                 if (source->mode != target->mode)
 
 281                         /* Give higher scores to sources that haven't been used already */
 
 282                         score = !source->rename_used;
 
 283                         if (source->rename_used && options->detect_rename != DIFF_DETECT_COPY)
 
 285                         score += basename_same(source, target);
 
 286                         if (score > best_score) {
 
 293                         /* Too many identical alternatives? Pick one */
 
 298                         record_rename_pair(dst->index, best->index, MAX_SCORE);
 
 301         } while ((dst = dst->next) != NULL);
 
 305 static void free_similarity_list(struct file_similarity *p)
 
 308                 struct file_similarity *entry = p;
 
 314 static int find_same_files(void *ptr, void *data)
 
 317         struct file_similarity *p = ptr;
 
 318         struct file_similarity *src = NULL, *dst = NULL;
 
 319         struct diff_options *options = data;
 
 321         /* Split the hash list up into sources and destinations */
 
 323                 struct file_similarity *entry = p;
 
 325                 if (entry->src_dst < 0) {
 
 335          * If we have both sources *and* destinations, see if
 
 336          * we can match them up
 
 338         ret = (src && dst) ? find_identical_files(src, dst, options) : 0;
 
 340         /* Free the hashes and return the number of renames found */
 
 341         free_similarity_list(src);
 
 342         free_similarity_list(dst);
 
 346 static unsigned int hash_filespec(struct diff_filespec *filespec)
 
 349         if (!filespec->sha1_valid) {
 
 350                 if (diff_populate_filespec(filespec, 0))
 
 352                 hash_sha1_file(filespec->data, filespec->size, "blob", filespec->sha1);
 
 354         memcpy(&hash, filespec->sha1, sizeof(hash));
 
 358 static void insert_file_table(struct hash_table *table, int src_dst, int index, struct diff_filespec *filespec)
 
 362         struct file_similarity *entry = xmalloc(sizeof(*entry));
 
 364         entry->src_dst = src_dst;
 
 365         entry->index = index;
 
 366         entry->filespec = filespec;
 
 369         hash = hash_filespec(filespec);
 
 370         pos = insert_hash(hash, entry, table);
 
 372         /* We already had an entry there? */
 
 380  * Find exact renames first.
 
 382  * The first round matches up the up-to-date entries,
 
 383  * and then during the second round we try to match
 
 384  * cache-dirty entries as well.
 
 386 static int find_exact_renames(struct diff_options *options)
 
 389         struct hash_table file_table;
 
 391         init_hash(&file_table);
 
 392         for (i = 0; i < rename_src_nr; i++)
 
 393                 insert_file_table(&file_table, -1, i, rename_src[i].p->one);
 
 395         for (i = 0; i < rename_dst_nr; i++)
 
 396                 insert_file_table(&file_table, 1, i, rename_dst[i].two);
 
 398         /* Find the renames */
 
 399         i = for_each_hash(&file_table, find_same_files, options);
 
 401         /* .. and free the hash data structure */
 
 402         free_hash(&file_table);
 
 407 #define NUM_CANDIDATE_PER_DST 4
 
 408 static void record_if_better(struct diff_score m[], struct diff_score *o)
 
 412         /* find the worst one */
 
 414         for (i = 1; i < NUM_CANDIDATE_PER_DST; i++)
 
 415                 if (score_compare(&m[i], &m[worst]) > 0)
 
 418         /* is it better than the worst one? */
 
 419         if (score_compare(&m[worst], o) > 0)
 
 425  * 0 if we are under the limit;
 
 426  * 1 if we need to disable inexact rename detection;
 
 427  * 2 if we would be under the limit if we were given -C instead of -C -C.
 
 429 static int too_many_rename_candidates(int num_create,
 
 430                                       struct diff_options *options)
 
 432         int rename_limit = options->rename_limit;
 
 433         int num_src = rename_src_nr;
 
 436         options->needed_rename_limit = 0;
 
 439          * This basically does a test for the rename matrix not
 
 440          * growing larger than a "rename_limit" square matrix, ie:
 
 442          *    num_create * num_src > rename_limit * rename_limit
 
 444          * but handles the potential overflow case specially (and we
 
 445          * assume at least 32-bit integers)
 
 447         if (rename_limit <= 0 || rename_limit > 32767)
 
 448                 rename_limit = 32767;
 
 449         if ((num_create <= rename_limit || num_src <= rename_limit) &&
 
 450             (num_create * num_src <= rename_limit * rename_limit))
 
 453         options->needed_rename_limit =
 
 454                 num_src > num_create ? num_src : num_create;
 
 456         /* Are we running under -C -C? */
 
 457         if (!DIFF_OPT_TST(options, FIND_COPIES_HARDER))
 
 460         /* Would we bust the limit if we were running under -C? */
 
 461         for (num_src = i = 0; i < rename_src_nr; i++) {
 
 462                 if (diff_unmodified_pair(rename_src[i].p))
 
 466         if ((num_create <= rename_limit || num_src <= rename_limit) &&
 
 467             (num_create * num_src <= rename_limit * rename_limit))
 
 472 static int find_renames(struct diff_score *mx, int dst_cnt, int minimum_score, int copies)
 
 476         for (i = 0; i < dst_cnt * NUM_CANDIDATE_PER_DST; i++) {
 
 477                 struct diff_rename_dst *dst;
 
 479                 if ((mx[i].dst < 0) ||
 
 480                     (mx[i].score < minimum_score))
 
 481                         break; /* there is no more usable pair. */
 
 482                 dst = &rename_dst[mx[i].dst];
 
 484                         continue; /* already done, either exact or fuzzy. */
 
 485                 if (!copies && rename_src[mx[i].src].p->one->rename_used)
 
 487                 record_rename_pair(mx[i].dst, mx[i].src, mx[i].score);
 
 493 void diffcore_rename(struct diff_options *options)
 
 495         int detect_rename = options->detect_rename;
 
 496         int minimum_score = options->rename_score;
 
 497         struct diff_queue_struct *q = &diff_queued_diff;
 
 498         struct diff_queue_struct outq;
 
 499         struct diff_score *mx;
 
 500         int i, j, rename_count, skip_unmodified = 0;
 
 501         int num_create, dst_cnt;
 
 502         struct progress *progress = NULL;
 
 505                 minimum_score = DEFAULT_RENAME_SCORE;
 
 507         for (i = 0; i < q->nr; i++) {
 
 508                 struct diff_filepair *p = q->queue[i];
 
 509                 if (!DIFF_FILE_VALID(p->one)) {
 
 510                         if (!DIFF_FILE_VALID(p->two))
 
 511                                 continue; /* unmerged */
 
 512                         else if (options->single_follow &&
 
 513                                  strcmp(options->single_follow, p->two->path))
 
 514                                 continue; /* not interested */
 
 516                                 locate_rename_dst(p->two, 1);
 
 518                 else if (!DIFF_PAIR_UNMERGED(p) && !DIFF_FILE_VALID(p->two)) {
 
 520                          * If the source is a broken "delete", and
 
 521                          * they did not really want to get broken,
 
 522                          * that means the source actually stays.
 
 523                          * So we increment the "rename_used" score
 
 524                          * by one, to indicate ourselves as a user
 
 526                         if (p->broken_pair && !p->score)
 
 527                                 p->one->rename_used++;
 
 528                         register_rename_src(p);
 
 530                 else if (detect_rename == DIFF_DETECT_COPY) {
 
 532                          * Increment the "rename_used" score by
 
 533                          * one, to indicate ourselves as a user.
 
 535                         p->one->rename_used++;
 
 536                         register_rename_src(p);
 
 539         if (rename_dst_nr == 0 || rename_src_nr == 0)
 
 540                 goto cleanup; /* nothing to do */
 
 543          * We really want to cull the candidates list early
 
 544          * with cheap tests in order to avoid doing deltas.
 
 546         rename_count = find_exact_renames(options);
 
 548         /* Did we only want exact renames? */
 
 549         if (minimum_score == MAX_SCORE)
 
 553          * Calculate how many renames are left (but all the source
 
 554          * files still remain as options for rename/copies!)
 
 556         num_create = (rename_dst_nr - rename_count);
 
 562         switch (too_many_rename_candidates(num_create, options)) {
 
 566                 options->degraded_cc_to_c = 1;
 
 573         if (options->show_rename_progress) {
 
 574                 progress = start_progress_delay(
 
 575                                 "Performing inexact rename detection",
 
 576                                 rename_dst_nr * rename_src_nr, 50, 1);
 
 579         mx = xcalloc(num_create * NUM_CANDIDATE_PER_DST, sizeof(*mx));
 
 580         for (dst_cnt = i = 0; i < rename_dst_nr; i++) {
 
 581                 struct diff_filespec *two = rename_dst[i].two;
 
 582                 struct diff_score *m;
 
 584                 if (rename_dst[i].pair)
 
 585                         continue; /* dealt with exact match already. */
 
 587                 m = &mx[dst_cnt * NUM_CANDIDATE_PER_DST];
 
 588                 for (j = 0; j < NUM_CANDIDATE_PER_DST; j++)
 
 591                 for (j = 0; j < rename_src_nr; j++) {
 
 592                         struct diff_filespec *one = rename_src[j].p->one;
 
 593                         struct diff_score this_src;
 
 595                         if (skip_unmodified &&
 
 596                             diff_unmodified_pair(rename_src[j].p))
 
 599                         this_src.score = estimate_similarity(one, two,
 
 601                         this_src.name_score = basename_same(one, two);
 
 604                         record_if_better(m, &this_src);
 
 606                          * Once we run estimate_similarity,
 
 607                          * We do not need the text anymore.
 
 609                         diff_free_filespec_blob(one);
 
 610                         diff_free_filespec_blob(two);
 
 613                 display_progress(progress, (i+1)*rename_src_nr);
 
 615         stop_progress(&progress);
 
 617         /* cost matrix sorted by most to least similar pair */
 
 618         qsort(mx, dst_cnt * NUM_CANDIDATE_PER_DST, sizeof(*mx), score_compare);
 
 620         rename_count += find_renames(mx, dst_cnt, minimum_score, 0);
 
 621         if (detect_rename == DIFF_DETECT_COPY)
 
 622                 rename_count += find_renames(mx, dst_cnt, minimum_score, 1);
 
 626         /* At this point, we have found some renames and copies and they
 
 627          * are recorded in rename_dst.  The original list is still in *q.
 
 629         DIFF_QUEUE_CLEAR(&outq);
 
 630         for (i = 0; i < q->nr; i++) {
 
 631                 struct diff_filepair *p = q->queue[i];
 
 632                 struct diff_filepair *pair_to_free = NULL;
 
 634                 if (DIFF_PAIR_UNMERGED(p)) {
 
 637                 else if (!DIFF_FILE_VALID(p->one) && DIFF_FILE_VALID(p->two)) {
 
 641                          * We would output this create record if it has
 
 642                          * not been turned into a rename/copy already.
 
 644                         struct diff_rename_dst *dst =
 
 645                                 locate_rename_dst(p->two, 0);
 
 646                         if (dst && dst->pair) {
 
 647                                 diff_q(&outq, dst->pair);
 
 651                                 /* no matching rename/copy source, so
 
 652                                  * record this as a creation.
 
 656                 else if (DIFF_FILE_VALID(p->one) && !DIFF_FILE_VALID(p->two)) {
 
 660                          * We would output this delete record if:
 
 662                          * (1) this is a broken delete and the counterpart
 
 663                          *     broken create remains in the output; or
 
 664                          * (2) this is not a broken delete, and rename_dst
 
 665                          *     does not have a rename/copy to move p->one->path
 
 668                          * Otherwise, the counterpart broken create
 
 669                          * has been turned into a rename-edit; or
 
 670                          * delete did not have a matching create to
 
 673                         if (DIFF_PAIR_BROKEN(p)) {
 
 675                                 struct diff_rename_dst *dst =
 
 676                                         locate_rename_dst(p->one, 0);
 
 677                                 if (dst && dst->pair)
 
 678                                         /* counterpart is now rename/copy */
 
 682                                 if (p->one->rename_used)
 
 683                                         /* this path remains */
 
 692                 else if (!diff_unmodified_pair(p))
 
 693                         /* all the usual ones need to be kept */
 
 696                         /* no need to keep unmodified pairs */
 
 700                         diff_free_filepair(pair_to_free);
 
 702         diff_debug_queue("done copying original", &outq);
 
 706         diff_debug_queue("done collapsing", q);
 
 708         for (i = 0; i < rename_dst_nr; i++)
 
 709                 free_filespec(rename_dst[i].two);
 
 713         rename_dst_nr = rename_dst_alloc = 0;
 
 716         rename_src_nr = rename_src_alloc = 0;