builtin / blame.con commit Merge branch 'cc/cherry-pick-series' (8c7da86)
   1/*
   2 * Blame
   3 *
   4 * Copyright (c) 2006, Junio C Hamano
   5 */
   6
   7#include "cache.h"
   8#include "builtin.h"
   9#include "blob.h"
  10#include "commit.h"
  11#include "tag.h"
  12#include "tree-walk.h"
  13#include "diff.h"
  14#include "diffcore.h"
  15#include "revision.h"
  16#include "quote.h"
  17#include "xdiff-interface.h"
  18#include "cache-tree.h"
  19#include "string-list.h"
  20#include "mailmap.h"
  21#include "parse-options.h"
  22#include "utf8.h"
  23
  24static char blame_usage[] = "git blame [options] [rev-opts] [rev] [--] file";
  25
  26static const char *blame_opt_usage[] = {
  27        blame_usage,
  28        "",
  29        "[rev-opts] are documented in git-rev-list(1)",
  30        NULL
  31};
  32
  33static int longest_file;
  34static int longest_author;
  35static int max_orig_digits;
  36static int max_digits;
  37static int max_score_digits;
  38static int show_root;
  39static int reverse;
  40static int blank_boundary;
  41static int incremental;
  42static int xdl_opts;
  43
  44static enum date_mode blame_date_mode = DATE_ISO8601;
  45static size_t blame_date_width;
  46
  47static struct string_list mailmap;
  48
  49#ifndef DEBUG
  50#define DEBUG 0
  51#endif
  52
  53/* stats */
  54static int num_read_blob;
  55static int num_get_patch;
  56static int num_commits;
  57
  58#define PICKAXE_BLAME_MOVE              01
  59#define PICKAXE_BLAME_COPY              02
  60#define PICKAXE_BLAME_COPY_HARDER       04
  61#define PICKAXE_BLAME_COPY_HARDEST      010
  62
  63/*
  64 * blame for a blame_entry with score lower than these thresholds
  65 * is not passed to the parent using move/copy logic.
  66 */
  67static unsigned blame_move_score;
  68static unsigned blame_copy_score;
  69#define BLAME_DEFAULT_MOVE_SCORE        20
  70#define BLAME_DEFAULT_COPY_SCORE        40
  71
  72/* bits #0..7 in revision.h, #8..11 used for merge_bases() in commit.c */
  73#define METAINFO_SHOWN          (1u<<12)
  74#define MORE_THAN_ONE_PATH      (1u<<13)
  75
  76/*
  77 * One blob in a commit that is being suspected
  78 */
  79struct origin {
  80        int refcnt;
  81        struct origin *previous;
  82        struct commit *commit;
  83        mmfile_t file;
  84        unsigned char blob_sha1[20];
  85        char path[FLEX_ARRAY];
  86};
  87
  88/*
  89 * Given an origin, prepare mmfile_t structure to be used by the
  90 * diff machinery
  91 */
  92static void fill_origin_blob(struct origin *o, mmfile_t *file)
  93{
  94        if (!o->file.ptr) {
  95                enum object_type type;
  96                num_read_blob++;
  97                file->ptr = read_sha1_file(o->blob_sha1, &type,
  98                                           (unsigned long *)(&(file->size)));
  99                if (!file->ptr)
 100                        die("Cannot read blob %s for path %s",
 101                            sha1_to_hex(o->blob_sha1),
 102                            o->path);
 103                o->file = *file;
 104        }
 105        else
 106                *file = o->file;
 107}
 108
 109/*
 110 * Origin is refcounted and usually we keep the blob contents to be
 111 * reused.
 112 */
 113static inline struct origin *origin_incref(struct origin *o)
 114{
 115        if (o)
 116                o->refcnt++;
 117        return o;
 118}
 119
 120static void origin_decref(struct origin *o)
 121{
 122        if (o && --o->refcnt <= 0) {
 123                if (o->previous)
 124                        origin_decref(o->previous);
 125                free(o->file.ptr);
 126                free(o);
 127        }
 128}
 129
 130static void drop_origin_blob(struct origin *o)
 131{
 132        if (o->file.ptr) {
 133                free(o->file.ptr);
 134                o->file.ptr = NULL;
 135        }
 136}
 137
 138/*
 139 * Each group of lines is described by a blame_entry; it can be split
 140 * as we pass blame to the parents.  They form a linked list in the
 141 * scoreboard structure, sorted by the target line number.
 142 */
 143struct blame_entry {
 144        struct blame_entry *prev;
 145        struct blame_entry *next;
 146
 147        /* the first line of this group in the final image;
 148         * internally all line numbers are 0 based.
 149         */
 150        int lno;
 151
 152        /* how many lines this group has */
 153        int num_lines;
 154
 155        /* the commit that introduced this group into the final image */
 156        struct origin *suspect;
 157
 158        /* true if the suspect is truly guilty; false while we have not
 159         * checked if the group came from one of its parents.
 160         */
 161        char guilty;
 162
 163        /* true if the entry has been scanned for copies in the current parent
 164         */
 165        char scanned;
 166
 167        /* the line number of the first line of this group in the
 168         * suspect's file; internally all line numbers are 0 based.
 169         */
 170        int s_lno;
 171
 172        /* how significant this entry is -- cached to avoid
 173         * scanning the lines over and over.
 174         */
 175        unsigned score;
 176};
 177
 178/*
 179 * The current state of the blame assignment.
 180 */
 181struct scoreboard {
 182        /* the final commit (i.e. where we started digging from) */
 183        struct commit *final;
 184        struct rev_info *revs;
 185        const char *path;
 186
 187        /*
 188         * The contents in the final image.
 189         * Used by many functions to obtain contents of the nth line,
 190         * indexed with scoreboard.lineno[blame_entry.lno].
 191         */
 192        const char *final_buf;
 193        unsigned long final_buf_size;
 194
 195        /* linked list of blames */
 196        struct blame_entry *ent;
 197
 198        /* look-up a line in the final buffer */
 199        int num_lines;
 200        int *lineno;
 201};
 202
 203static inline int same_suspect(struct origin *a, struct origin *b)
 204{
 205        if (a == b)
 206                return 1;
 207        if (a->commit != b->commit)
 208                return 0;
 209        return !strcmp(a->path, b->path);
 210}
 211
 212static void sanity_check_refcnt(struct scoreboard *);
 213
 214/*
 215 * If two blame entries that are next to each other came from
 216 * contiguous lines in the same origin (i.e. <commit, path> pair),
 217 * merge them together.
 218 */
 219static void coalesce(struct scoreboard *sb)
 220{
 221        struct blame_entry *ent, *next;
 222
 223        for (ent = sb->ent; ent && (next = ent->next); ent = next) {
 224                if (same_suspect(ent->suspect, next->suspect) &&
 225                    ent->guilty == next->guilty &&
 226                    ent->s_lno + ent->num_lines == next->s_lno) {
 227                        ent->num_lines += next->num_lines;
 228                        ent->next = next->next;
 229                        if (ent->next)
 230                                ent->next->prev = ent;
 231                        origin_decref(next->suspect);
 232                        free(next);
 233                        ent->score = 0;
 234                        next = ent; /* again */
 235                }
 236        }
 237
 238        if (DEBUG) /* sanity */
 239                sanity_check_refcnt(sb);
 240}
 241
 242/*
 243 * Given a commit and a path in it, create a new origin structure.
 244 * The callers that add blame to the scoreboard should use
 245 * get_origin() to obtain shared, refcounted copy instead of calling
 246 * this function directly.
 247 */
 248static struct origin *make_origin(struct commit *commit, const char *path)
 249{
 250        struct origin *o;
 251        o = xcalloc(1, sizeof(*o) + strlen(path) + 1);
 252        o->commit = commit;
 253        o->refcnt = 1;
 254        strcpy(o->path, path);
 255        return o;
 256}
 257
 258/*
 259 * Locate an existing origin or create a new one.
 260 */
 261static struct origin *get_origin(struct scoreboard *sb,
 262                                 struct commit *commit,
 263                                 const char *path)
 264{
 265        struct blame_entry *e;
 266
 267        for (e = sb->ent; e; e = e->next) {
 268                if (e->suspect->commit == commit &&
 269                    !strcmp(e->suspect->path, path))
 270                        return origin_incref(e->suspect);
 271        }
 272        return make_origin(commit, path);
 273}
 274
 275/*
 276 * Fill the blob_sha1 field of an origin if it hasn't, so that later
 277 * call to fill_origin_blob() can use it to locate the data.  blob_sha1
 278 * for an origin is also used to pass the blame for the entire file to
 279 * the parent to detect the case where a child's blob is identical to
 280 * that of its parent's.
 281 */
 282static int fill_blob_sha1(struct origin *origin)
 283{
 284        unsigned mode;
 285
 286        if (!is_null_sha1(origin->blob_sha1))
 287                return 0;
 288        if (get_tree_entry(origin->commit->object.sha1,
 289                           origin->path,
 290                           origin->blob_sha1, &mode))
 291                goto error_out;
 292        if (sha1_object_info(origin->blob_sha1, NULL) != OBJ_BLOB)
 293                goto error_out;
 294        return 0;
 295 error_out:
 296        hashclr(origin->blob_sha1);
 297        return -1;
 298}
 299
 300/*
 301 * We have an origin -- check if the same path exists in the
 302 * parent and return an origin structure to represent it.
 303 */
 304static struct origin *find_origin(struct scoreboard *sb,
 305                                  struct commit *parent,
 306                                  struct origin *origin)
 307{
 308        struct origin *porigin = NULL;
 309        struct diff_options diff_opts;
 310        const char *paths[2];
 311
 312        if (parent->util) {
 313                /*
 314                 * Each commit object can cache one origin in that
 315                 * commit.  This is a freestanding copy of origin and
 316                 * not refcounted.
 317                 */
 318                struct origin *cached = parent->util;
 319                if (!strcmp(cached->path, origin->path)) {
 320                        /*
 321                         * The same path between origin and its parent
 322                         * without renaming -- the most common case.
 323                         */
 324                        porigin = get_origin(sb, parent, cached->path);
 325
 326                        /*
 327                         * If the origin was newly created (i.e. get_origin
 328                         * would call make_origin if none is found in the
 329                         * scoreboard), it does not know the blob_sha1,
 330                         * so copy it.  Otherwise porigin was in the
 331                         * scoreboard and already knows blob_sha1.
 332                         */
 333                        if (porigin->refcnt == 1)
 334                                hashcpy(porigin->blob_sha1, cached->blob_sha1);
 335                        return porigin;
 336                }
 337                /* otherwise it was not very useful; free it */
 338                free(parent->util);
 339                parent->util = NULL;
 340        }
 341
 342        /* See if the origin->path is different between parent
 343         * and origin first.  Most of the time they are the
 344         * same and diff-tree is fairly efficient about this.
 345         */
 346        diff_setup(&diff_opts);
 347        DIFF_OPT_SET(&diff_opts, RECURSIVE);
 348        diff_opts.detect_rename = 0;
 349        diff_opts.output_format = DIFF_FORMAT_NO_OUTPUT;
 350        paths[0] = origin->path;
 351        paths[1] = NULL;
 352
 353        diff_tree_setup_paths(paths, &diff_opts);
 354        if (diff_setup_done(&diff_opts) < 0)
 355                die("diff-setup");
 356
 357        if (is_null_sha1(origin->commit->object.sha1))
 358                do_diff_cache(parent->tree->object.sha1, &diff_opts);
 359        else
 360                diff_tree_sha1(parent->tree->object.sha1,
 361                               origin->commit->tree->object.sha1,
 362                               "", &diff_opts);
 363        diffcore_std(&diff_opts);
 364
 365        if (!diff_queued_diff.nr) {
 366                /* The path is the same as parent */
 367                porigin = get_origin(sb, parent, origin->path);
 368                hashcpy(porigin->blob_sha1, origin->blob_sha1);
 369        } else {
 370                /*
 371                 * Since origin->path is a pathspec, if the parent
 372                 * commit had it as a directory, we will see a whole
 373                 * bunch of deletion of files in the directory that we
 374                 * do not care about.
 375                 */
 376                int i;
 377                struct diff_filepair *p = NULL;
 378                for (i = 0; i < diff_queued_diff.nr; i++) {
 379                        const char *name;
 380                        p = diff_queued_diff.queue[i];
 381                        name = p->one->path ? p->one->path : p->two->path;
 382                        if (!strcmp(name, origin->path))
 383                                break;
 384                }
 385                if (!p)
 386                        die("internal error in blame::find_origin");
 387                switch (p->status) {
 388                default:
 389                        die("internal error in blame::find_origin (%c)",
 390                            p->status);
 391                case 'M':
 392                        porigin = get_origin(sb, parent, origin->path);
 393                        hashcpy(porigin->blob_sha1, p->one->sha1);
 394                        break;
 395                case 'A':
 396                case 'T':
 397                        /* Did not exist in parent, or type changed */
 398                        break;
 399                }
 400        }
 401        diff_flush(&diff_opts);
 402        diff_tree_release_paths(&diff_opts);
 403        if (porigin) {
 404                /*
 405                 * Create a freestanding copy that is not part of
 406                 * the refcounted origin found in the scoreboard, and
 407                 * cache it in the commit.
 408                 */
 409                struct origin *cached;
 410
 411                cached = make_origin(porigin->commit, porigin->path);
 412                hashcpy(cached->blob_sha1, porigin->blob_sha1);
 413                parent->util = cached;
 414        }
 415        return porigin;
 416}
 417
 418/*
 419 * We have an origin -- find the path that corresponds to it in its
 420 * parent and return an origin structure to represent it.
 421 */
 422static struct origin *find_rename(struct scoreboard *sb,
 423                                  struct commit *parent,
 424                                  struct origin *origin)
 425{
 426        struct origin *porigin = NULL;
 427        struct diff_options diff_opts;
 428        int i;
 429        const char *paths[2];
 430
 431        diff_setup(&diff_opts);
 432        DIFF_OPT_SET(&diff_opts, RECURSIVE);
 433        diff_opts.detect_rename = DIFF_DETECT_RENAME;
 434        diff_opts.output_format = DIFF_FORMAT_NO_OUTPUT;
 435        diff_opts.single_follow = origin->path;
 436        paths[0] = NULL;
 437        diff_tree_setup_paths(paths, &diff_opts);
 438        if (diff_setup_done(&diff_opts) < 0)
 439                die("diff-setup");
 440
 441        if (is_null_sha1(origin->commit->object.sha1))
 442                do_diff_cache(parent->tree->object.sha1, &diff_opts);
 443        else
 444                diff_tree_sha1(parent->tree->object.sha1,
 445                               origin->commit->tree->object.sha1,
 446                               "", &diff_opts);
 447        diffcore_std(&diff_opts);
 448
 449        for (i = 0; i < diff_queued_diff.nr; i++) {
 450                struct diff_filepair *p = diff_queued_diff.queue[i];
 451                if ((p->status == 'R' || p->status == 'C') &&
 452                    !strcmp(p->two->path, origin->path)) {
 453                        porigin = get_origin(sb, parent, p->one->path);
 454                        hashcpy(porigin->blob_sha1, p->one->sha1);
 455                        break;
 456                }
 457        }
 458        diff_flush(&diff_opts);
 459        diff_tree_release_paths(&diff_opts);
 460        return porigin;
 461}
 462
 463/*
 464 * Link in a new blame entry to the scoreboard.  Entries that cover the
 465 * same line range have been removed from the scoreboard previously.
 466 */
 467static void add_blame_entry(struct scoreboard *sb, struct blame_entry *e)
 468{
 469        struct blame_entry *ent, *prev = NULL;
 470
 471        origin_incref(e->suspect);
 472
 473        for (ent = sb->ent; ent && ent->lno < e->lno; ent = ent->next)
 474                prev = ent;
 475
 476        /* prev, if not NULL, is the last one that is below e */
 477        e->prev = prev;
 478        if (prev) {
 479                e->next = prev->next;
 480                prev->next = e;
 481        }
 482        else {
 483                e->next = sb->ent;
 484                sb->ent = e;
 485        }
 486        if (e->next)
 487                e->next->prev = e;
 488}
 489
 490/*
 491 * src typically is on-stack; we want to copy the information in it to
 492 * a malloced blame_entry that is already on the linked list of the
 493 * scoreboard.  The origin of dst loses a refcnt while the origin of src
 494 * gains one.
 495 */
 496static void dup_entry(struct blame_entry *dst, struct blame_entry *src)
 497{
 498        struct blame_entry *p, *n;
 499
 500        p = dst->prev;
 501        n = dst->next;
 502        origin_incref(src->suspect);
 503        origin_decref(dst->suspect);
 504        memcpy(dst, src, sizeof(*src));
 505        dst->prev = p;
 506        dst->next = n;
 507        dst->score = 0;
 508}
 509
 510static const char *nth_line(struct scoreboard *sb, int lno)
 511{
 512        return sb->final_buf + sb->lineno[lno];
 513}
 514
 515/*
 516 * It is known that lines between tlno to same came from parent, and e
 517 * has an overlap with that range.  it also is known that parent's
 518 * line plno corresponds to e's line tlno.
 519 *
 520 *                <---- e ----->
 521 *                   <------>
 522 *                   <------------>
 523 *             <------------>
 524 *             <------------------>
 525 *
 526 * Split e into potentially three parts; before this chunk, the chunk
 527 * to be blamed for the parent, and after that portion.
 528 */
 529static void split_overlap(struct blame_entry *split,
 530                          struct blame_entry *e,
 531                          int tlno, int plno, int same,
 532                          struct origin *parent)
 533{
 534        int chunk_end_lno;
 535        memset(split, 0, sizeof(struct blame_entry [3]));
 536
 537        if (e->s_lno < tlno) {
 538                /* there is a pre-chunk part not blamed on parent */
 539                split[0].suspect = origin_incref(e->suspect);
 540                split[0].lno = e->lno;
 541                split[0].s_lno = e->s_lno;
 542                split[0].num_lines = tlno - e->s_lno;
 543                split[1].lno = e->lno + tlno - e->s_lno;
 544                split[1].s_lno = plno;
 545        }
 546        else {
 547                split[1].lno = e->lno;
 548                split[1].s_lno = plno + (e->s_lno - tlno);
 549        }
 550
 551        if (same < e->s_lno + e->num_lines) {
 552                /* there is a post-chunk part not blamed on parent */
 553                split[2].suspect = origin_incref(e->suspect);
 554                split[2].lno = e->lno + (same - e->s_lno);
 555                split[2].s_lno = e->s_lno + (same - e->s_lno);
 556                split[2].num_lines = e->s_lno + e->num_lines - same;
 557                chunk_end_lno = split[2].lno;
 558        }
 559        else
 560                chunk_end_lno = e->lno + e->num_lines;
 561        split[1].num_lines = chunk_end_lno - split[1].lno;
 562
 563        /*
 564         * if it turns out there is nothing to blame the parent for,
 565         * forget about the splitting.  !split[1].suspect signals this.
 566         */
 567        if (split[1].num_lines < 1)
 568                return;
 569        split[1].suspect = origin_incref(parent);
 570}
 571
 572/*
 573 * split_overlap() divided an existing blame e into up to three parts
 574 * in split.  Adjust the linked list of blames in the scoreboard to
 575 * reflect the split.
 576 */
 577static void split_blame(struct scoreboard *sb,
 578                        struct blame_entry *split,
 579                        struct blame_entry *e)
 580{
 581        struct blame_entry *new_entry;
 582
 583        if (split[0].suspect && split[2].suspect) {
 584                /* The first part (reuse storage for the existing entry e) */
 585                dup_entry(e, &split[0]);
 586
 587                /* The last part -- me */
 588                new_entry = xmalloc(sizeof(*new_entry));
 589                memcpy(new_entry, &(split[2]), sizeof(struct blame_entry));
 590                add_blame_entry(sb, new_entry);
 591
 592                /* ... and the middle part -- parent */
 593                new_entry = xmalloc(sizeof(*new_entry));
 594                memcpy(new_entry, &(split[1]), sizeof(struct blame_entry));
 595                add_blame_entry(sb, new_entry);
 596        }
 597        else if (!split[0].suspect && !split[2].suspect)
 598                /*
 599                 * The parent covers the entire area; reuse storage for
 600                 * e and replace it with the parent.
 601                 */
 602                dup_entry(e, &split[1]);
 603        else if (split[0].suspect) {
 604                /* me and then parent */
 605                dup_entry(e, &split[0]);
 606
 607                new_entry = xmalloc(sizeof(*new_entry));
 608                memcpy(new_entry, &(split[1]), sizeof(struct blame_entry));
 609                add_blame_entry(sb, new_entry);
 610        }
 611        else {
 612                /* parent and then me */
 613                dup_entry(e, &split[1]);
 614
 615                new_entry = xmalloc(sizeof(*new_entry));
 616                memcpy(new_entry, &(split[2]), sizeof(struct blame_entry));
 617                add_blame_entry(sb, new_entry);
 618        }
 619
 620        if (DEBUG) { /* sanity */
 621                struct blame_entry *ent;
 622                int lno = sb->ent->lno, corrupt = 0;
 623
 624                for (ent = sb->ent; ent; ent = ent->next) {
 625                        if (lno != ent->lno)
 626                                corrupt = 1;
 627                        if (ent->s_lno < 0)
 628                                corrupt = 1;
 629                        lno += ent->num_lines;
 630                }
 631                if (corrupt) {
 632                        lno = sb->ent->lno;
 633                        for (ent = sb->ent; ent; ent = ent->next) {
 634                                printf("L %8d l %8d n %8d\n",
 635                                       lno, ent->lno, ent->num_lines);
 636                                lno = ent->lno + ent->num_lines;
 637                        }
 638                        die("oops");
 639                }
 640        }
 641}
 642
 643/*
 644 * After splitting the blame, the origins used by the
 645 * on-stack blame_entry should lose one refcnt each.
 646 */
 647static void decref_split(struct blame_entry *split)
 648{
 649        int i;
 650
 651        for (i = 0; i < 3; i++)
 652                origin_decref(split[i].suspect);
 653}
 654
 655/*
 656 * Helper for blame_chunk().  blame_entry e is known to overlap with
 657 * the patch hunk; split it and pass blame to the parent.
 658 */
 659static void blame_overlap(struct scoreboard *sb, struct blame_entry *e,
 660                          int tlno, int plno, int same,
 661                          struct origin *parent)
 662{
 663        struct blame_entry split[3];
 664
 665        split_overlap(split, e, tlno, plno, same, parent);
 666        if (split[1].suspect)
 667                split_blame(sb, split, e);
 668        decref_split(split);
 669}
 670
 671/*
 672 * Find the line number of the last line the target is suspected for.
 673 */
 674static int find_last_in_target(struct scoreboard *sb, struct origin *target)
 675{
 676        struct blame_entry *e;
 677        int last_in_target = -1;
 678
 679        for (e = sb->ent; e; e = e->next) {
 680                if (e->guilty || !same_suspect(e->suspect, target))
 681                        continue;
 682                if (last_in_target < e->s_lno + e->num_lines)
 683                        last_in_target = e->s_lno + e->num_lines;
 684        }
 685        return last_in_target;
 686}
 687
 688/*
 689 * Process one hunk from the patch between the current suspect for
 690 * blame_entry e and its parent.  Find and split the overlap, and
 691 * pass blame to the overlapping part to the parent.
 692 */
 693static void blame_chunk(struct scoreboard *sb,
 694                        int tlno, int plno, int same,
 695                        struct origin *target, struct origin *parent)
 696{
 697        struct blame_entry *e;
 698
 699        for (e = sb->ent; e; e = e->next) {
 700                if (e->guilty || !same_suspect(e->suspect, target))
 701                        continue;
 702                if (same <= e->s_lno)
 703                        continue;
 704                if (tlno < e->s_lno + e->num_lines)
 705                        blame_overlap(sb, e, tlno, plno, same, parent);
 706        }
 707}
 708
 709struct blame_chunk_cb_data {
 710        struct scoreboard *sb;
 711        struct origin *target;
 712        struct origin *parent;
 713        long plno;
 714        long tlno;
 715};
 716
 717static void blame_chunk_cb(void *data, long same, long p_next, long t_next)
 718{
 719        struct blame_chunk_cb_data *d = data;
 720        blame_chunk(d->sb, d->tlno, d->plno, same, d->target, d->parent);
 721        d->plno = p_next;
 722        d->tlno = t_next;
 723}
 724
 725/*
 726 * We are looking at the origin 'target' and aiming to pass blame
 727 * for the lines it is suspected to its parent.  Run diff to find
 728 * which lines came from parent and pass blame for them.
 729 */
 730static int pass_blame_to_parent(struct scoreboard *sb,
 731                                struct origin *target,
 732                                struct origin *parent)
 733{
 734        int last_in_target;
 735        mmfile_t file_p, file_o;
 736        struct blame_chunk_cb_data d;
 737        xpparam_t xpp;
 738        xdemitconf_t xecfg;
 739        memset(&d, 0, sizeof(d));
 740        d.sb = sb; d.target = target; d.parent = parent;
 741        last_in_target = find_last_in_target(sb, target);
 742        if (last_in_target < 0)
 743                return 1; /* nothing remains for this target */
 744
 745        fill_origin_blob(parent, &file_p);
 746        fill_origin_blob(target, &file_o);
 747        num_get_patch++;
 748
 749        memset(&xpp, 0, sizeof(xpp));
 750        xpp.flags = xdl_opts;
 751        memset(&xecfg, 0, sizeof(xecfg));
 752        xecfg.ctxlen = 0;
 753        xdi_diff_hunks(&file_p, &file_o, blame_chunk_cb, &d, &xpp, &xecfg);
 754        /* The rest (i.e. anything after tlno) are the same as the parent */
 755        blame_chunk(sb, d.tlno, d.plno, last_in_target, target, parent);
 756
 757        return 0;
 758}
 759
 760/*
 761 * The lines in blame_entry after splitting blames many times can become
 762 * very small and trivial, and at some point it becomes pointless to
 763 * blame the parents.  E.g. "\t\t}\n\t}\n\n" appears everywhere in any
 764 * ordinary C program, and it is not worth to say it was copied from
 765 * totally unrelated file in the parent.
 766 *
 767 * Compute how trivial the lines in the blame_entry are.
 768 */
 769static unsigned ent_score(struct scoreboard *sb, struct blame_entry *e)
 770{
 771        unsigned score;
 772        const char *cp, *ep;
 773
 774        if (e->score)
 775                return e->score;
 776
 777        score = 1;
 778        cp = nth_line(sb, e->lno);
 779        ep = nth_line(sb, e->lno + e->num_lines);
 780        while (cp < ep) {
 781                unsigned ch = *((unsigned char *)cp);
 782                if (isalnum(ch))
 783                        score++;
 784                cp++;
 785        }
 786        e->score = score;
 787        return score;
 788}
 789
 790/*
 791 * best_so_far[] and this[] are both a split of an existing blame_entry
 792 * that passes blame to the parent.  Maintain best_so_far the best split
 793 * so far, by comparing this and best_so_far and copying this into
 794 * bst_so_far as needed.
 795 */
 796static void copy_split_if_better(struct scoreboard *sb,
 797                                 struct blame_entry *best_so_far,
 798                                 struct blame_entry *this)
 799{
 800        int i;
 801
 802        if (!this[1].suspect)
 803                return;
 804        if (best_so_far[1].suspect) {
 805                if (ent_score(sb, &this[1]) < ent_score(sb, &best_so_far[1]))
 806                        return;
 807        }
 808
 809        for (i = 0; i < 3; i++)
 810                origin_incref(this[i].suspect);
 811        decref_split(best_so_far);
 812        memcpy(best_so_far, this, sizeof(struct blame_entry [3]));
 813}
 814
 815/*
 816 * We are looking at a part of the final image represented by
 817 * ent (tlno and same are offset by ent->s_lno).
 818 * tlno is where we are looking at in the final image.
 819 * up to (but not including) same match preimage.
 820 * plno is where we are looking at in the preimage.
 821 *
 822 * <-------------- final image ---------------------->
 823 *       <------ent------>
 824 *         ^tlno ^same
 825 *    <---------preimage----->
 826 *         ^plno
 827 *
 828 * All line numbers are 0-based.
 829 */
 830static void handle_split(struct scoreboard *sb,
 831                         struct blame_entry *ent,
 832                         int tlno, int plno, int same,
 833                         struct origin *parent,
 834                         struct blame_entry *split)
 835{
 836        if (ent->num_lines <= tlno)
 837                return;
 838        if (tlno < same) {
 839                struct blame_entry this[3];
 840                tlno += ent->s_lno;
 841                same += ent->s_lno;
 842                split_overlap(this, ent, tlno, plno, same, parent);
 843                copy_split_if_better(sb, split, this);
 844                decref_split(this);
 845        }
 846}
 847
 848struct handle_split_cb_data {
 849        struct scoreboard *sb;
 850        struct blame_entry *ent;
 851        struct origin *parent;
 852        struct blame_entry *split;
 853        long plno;
 854        long tlno;
 855};
 856
 857static void handle_split_cb(void *data, long same, long p_next, long t_next)
 858{
 859        struct handle_split_cb_data *d = data;
 860        handle_split(d->sb, d->ent, d->tlno, d->plno, same, d->parent, d->split);
 861        d->plno = p_next;
 862        d->tlno = t_next;
 863}
 864
 865/*
 866 * Find the lines from parent that are the same as ent so that
 867 * we can pass blames to it.  file_p has the blob contents for
 868 * the parent.
 869 */
 870static void find_copy_in_blob(struct scoreboard *sb,
 871                              struct blame_entry *ent,
 872                              struct origin *parent,
 873                              struct blame_entry *split,
 874                              mmfile_t *file_p)
 875{
 876        const char *cp;
 877        int cnt;
 878        mmfile_t file_o;
 879        struct handle_split_cb_data d;
 880        xpparam_t xpp;
 881        xdemitconf_t xecfg;
 882        memset(&d, 0, sizeof(d));
 883        d.sb = sb; d.ent = ent; d.parent = parent; d.split = split;
 884        /*
 885         * Prepare mmfile that contains only the lines in ent.
 886         */
 887        cp = nth_line(sb, ent->lno);
 888        file_o.ptr = (char *) cp;
 889        cnt = ent->num_lines;
 890
 891        while (cnt && cp < sb->final_buf + sb->final_buf_size) {
 892                if (*cp++ == '\n')
 893                        cnt--;
 894        }
 895        file_o.size = cp - file_o.ptr;
 896
 897        /*
 898         * file_o is a part of final image we are annotating.
 899         * file_p partially may match that image.
 900         */
 901        memset(&xpp, 0, sizeof(xpp));
 902        xpp.flags = xdl_opts;
 903        memset(&xecfg, 0, sizeof(xecfg));
 904        xecfg.ctxlen = 1;
 905        memset(split, 0, sizeof(struct blame_entry [3]));
 906        xdi_diff_hunks(file_p, &file_o, handle_split_cb, &d, &xpp, &xecfg);
 907        /* remainder, if any, all match the preimage */
 908        handle_split(sb, ent, d.tlno, d.plno, ent->num_lines, parent, split);
 909}
 910
 911/*
 912 * See if lines currently target is suspected for can be attributed to
 913 * parent.
 914 */
 915static int find_move_in_parent(struct scoreboard *sb,
 916                               struct origin *target,
 917                               struct origin *parent)
 918{
 919        int last_in_target, made_progress;
 920        struct blame_entry *e, split[3];
 921        mmfile_t file_p;
 922
 923        last_in_target = find_last_in_target(sb, target);
 924        if (last_in_target < 0)
 925                return 1; /* nothing remains for this target */
 926
 927        fill_origin_blob(parent, &file_p);
 928        if (!file_p.ptr)
 929                return 0;
 930
 931        made_progress = 1;
 932        while (made_progress) {
 933                made_progress = 0;
 934                for (e = sb->ent; e; e = e->next) {
 935                        if (e->guilty || !same_suspect(e->suspect, target) ||
 936                            ent_score(sb, e) < blame_move_score)
 937                                continue;
 938                        find_copy_in_blob(sb, e, parent, split, &file_p);
 939                        if (split[1].suspect &&
 940                            blame_move_score < ent_score(sb, &split[1])) {
 941                                split_blame(sb, split, e);
 942                                made_progress = 1;
 943                        }
 944                        decref_split(split);
 945                }
 946        }
 947        return 0;
 948}
 949
 950struct blame_list {
 951        struct blame_entry *ent;
 952        struct blame_entry split[3];
 953};
 954
 955/*
 956 * Count the number of entries the target is suspected for,
 957 * and prepare a list of entry and the best split.
 958 */
 959static struct blame_list *setup_blame_list(struct scoreboard *sb,
 960                                           struct origin *target,
 961                                           int min_score,
 962                                           int *num_ents_p)
 963{
 964        struct blame_entry *e;
 965        int num_ents, i;
 966        struct blame_list *blame_list = NULL;
 967
 968        for (e = sb->ent, num_ents = 0; e; e = e->next)
 969                if (!e->scanned && !e->guilty &&
 970                    same_suspect(e->suspect, target) &&
 971                    min_score < ent_score(sb, e))
 972                        num_ents++;
 973        if (num_ents) {
 974                blame_list = xcalloc(num_ents, sizeof(struct blame_list));
 975                for (e = sb->ent, i = 0; e; e = e->next)
 976                        if (!e->scanned && !e->guilty &&
 977                            same_suspect(e->suspect, target) &&
 978                            min_score < ent_score(sb, e))
 979                                blame_list[i++].ent = e;
 980        }
 981        *num_ents_p = num_ents;
 982        return blame_list;
 983}
 984
 985/*
 986 * Reset the scanned status on all entries.
 987 */
 988static void reset_scanned_flag(struct scoreboard *sb)
 989{
 990        struct blame_entry *e;
 991        for (e = sb->ent; e; e = e->next)
 992                e->scanned = 0;
 993}
 994
 995/*
 996 * For lines target is suspected for, see if we can find code movement
 997 * across file boundary from the parent commit.  porigin is the path
 998 * in the parent we already tried.
 999 */
1000static int find_copy_in_parent(struct scoreboard *sb,
1001                               struct origin *target,
1002                               struct commit *parent,
1003                               struct origin *porigin,
1004                               int opt)
1005{
1006        struct diff_options diff_opts;
1007        const char *paths[1];
1008        int i, j;
1009        int retval;
1010        struct blame_list *blame_list;
1011        int num_ents;
1012
1013        blame_list = setup_blame_list(sb, target, blame_copy_score, &num_ents);
1014        if (!blame_list)
1015                return 1; /* nothing remains for this target */
1016
1017        diff_setup(&diff_opts);
1018        DIFF_OPT_SET(&diff_opts, RECURSIVE);
1019        diff_opts.output_format = DIFF_FORMAT_NO_OUTPUT;
1020
1021        paths[0] = NULL;
1022        diff_tree_setup_paths(paths, &diff_opts);
1023        if (diff_setup_done(&diff_opts) < 0)
1024                die("diff-setup");
1025
1026        /* Try "find copies harder" on new path if requested;
1027         * we do not want to use diffcore_rename() actually to
1028         * match things up; find_copies_harder is set only to
1029         * force diff_tree_sha1() to feed all filepairs to diff_queue,
1030         * and this code needs to be after diff_setup_done(), which
1031         * usually makes find-copies-harder imply copy detection.
1032         */
1033        if ((opt & PICKAXE_BLAME_COPY_HARDEST)
1034            || ((opt & PICKAXE_BLAME_COPY_HARDER)
1035                && (!porigin || strcmp(target->path, porigin->path))))
1036                DIFF_OPT_SET(&diff_opts, FIND_COPIES_HARDER);
1037
1038        if (is_null_sha1(target->commit->object.sha1))
1039                do_diff_cache(parent->tree->object.sha1, &diff_opts);
1040        else
1041                diff_tree_sha1(parent->tree->object.sha1,
1042                               target->commit->tree->object.sha1,
1043                               "", &diff_opts);
1044
1045        if (!DIFF_OPT_TST(&diff_opts, FIND_COPIES_HARDER))
1046                diffcore_std(&diff_opts);
1047
1048        retval = 0;
1049        while (1) {
1050                int made_progress = 0;
1051
1052                for (i = 0; i < diff_queued_diff.nr; i++) {
1053                        struct diff_filepair *p = diff_queued_diff.queue[i];
1054                        struct origin *norigin;
1055                        mmfile_t file_p;
1056                        struct blame_entry this[3];
1057
1058                        if (!DIFF_FILE_VALID(p->one))
1059                                continue; /* does not exist in parent */
1060                        if (S_ISGITLINK(p->one->mode))
1061                                continue; /* ignore git links */
1062                        if (porigin && !strcmp(p->one->path, porigin->path))
1063                                /* find_move already dealt with this path */
1064                                continue;
1065
1066                        norigin = get_origin(sb, parent, p->one->path);
1067                        hashcpy(norigin->blob_sha1, p->one->sha1);
1068                        fill_origin_blob(norigin, &file_p);
1069                        if (!file_p.ptr)
1070                                continue;
1071
1072                        for (j = 0; j < num_ents; j++) {
1073                                find_copy_in_blob(sb, blame_list[j].ent,
1074                                                  norigin, this, &file_p);
1075                                copy_split_if_better(sb, blame_list[j].split,
1076                                                     this);
1077                                decref_split(this);
1078                        }
1079                        origin_decref(norigin);
1080                }
1081
1082                for (j = 0; j < num_ents; j++) {
1083                        struct blame_entry *split = blame_list[j].split;
1084                        if (split[1].suspect &&
1085                            blame_copy_score < ent_score(sb, &split[1])) {
1086                                split_blame(sb, split, blame_list[j].ent);
1087                                made_progress = 1;
1088                        }
1089                        else
1090                                blame_list[j].ent->scanned = 1;
1091                        decref_split(split);
1092                }
1093                free(blame_list);
1094
1095                if (!made_progress)
1096                        break;
1097                blame_list = setup_blame_list(sb, target, blame_copy_score, &num_ents);
1098                if (!blame_list) {
1099                        retval = 1;
1100                        break;
1101                }
1102        }
1103        reset_scanned_flag(sb);
1104        diff_flush(&diff_opts);
1105        diff_tree_release_paths(&diff_opts);
1106        return retval;
1107}
1108
1109/*
1110 * The blobs of origin and porigin exactly match, so everything
1111 * origin is suspected for can be blamed on the parent.
1112 */
1113static void pass_whole_blame(struct scoreboard *sb,
1114                             struct origin *origin, struct origin *porigin)
1115{
1116        struct blame_entry *e;
1117
1118        if (!porigin->file.ptr && origin->file.ptr) {
1119                /* Steal its file */
1120                porigin->file = origin->file;
1121                origin->file.ptr = NULL;
1122        }
1123        for (e = sb->ent; e; e = e->next) {
1124                if (!same_suspect(e->suspect, origin))
1125                        continue;
1126                origin_incref(porigin);
1127                origin_decref(e->suspect);
1128                e->suspect = porigin;
1129        }
1130}
1131
1132/*
1133 * We pass blame from the current commit to its parents.  We keep saying
1134 * "parent" (and "porigin"), but what we mean is to find scapegoat to
1135 * exonerate ourselves.
1136 */
1137static struct commit_list *first_scapegoat(struct rev_info *revs, struct commit *commit)
1138{
1139        if (!reverse)
1140                return commit->parents;
1141        return lookup_decoration(&revs->children, &commit->object);
1142}
1143
1144static int num_scapegoats(struct rev_info *revs, struct commit *commit)
1145{
1146        int cnt;
1147        struct commit_list *l = first_scapegoat(revs, commit);
1148        for (cnt = 0; l; l = l->next)
1149                cnt++;
1150        return cnt;
1151}
1152
1153#define MAXSG 16
1154
1155static void pass_blame(struct scoreboard *sb, struct origin *origin, int opt)
1156{
1157        struct rev_info *revs = sb->revs;
1158        int i, pass, num_sg;
1159        struct commit *commit = origin->commit;
1160        struct commit_list *sg;
1161        struct origin *sg_buf[MAXSG];
1162        struct origin *porigin, **sg_origin = sg_buf;
1163
1164        num_sg = num_scapegoats(revs, commit);
1165        if (!num_sg)
1166                goto finish;
1167        else if (num_sg < ARRAY_SIZE(sg_buf))
1168                memset(sg_buf, 0, sizeof(sg_buf));
1169        else
1170                sg_origin = xcalloc(num_sg, sizeof(*sg_origin));
1171
1172        /*
1173         * The first pass looks for unrenamed path to optimize for
1174         * common cases, then we look for renames in the second pass.
1175         */
1176        for (pass = 0; pass < 2; pass++) {
1177                struct origin *(*find)(struct scoreboard *,
1178                                       struct commit *, struct origin *);
1179                find = pass ? find_rename : find_origin;
1180
1181                for (i = 0, sg = first_scapegoat(revs, commit);
1182                     i < num_sg && sg;
1183                     sg = sg->next, i++) {
1184                        struct commit *p = sg->item;
1185                        int j, same;
1186
1187                        if (sg_origin[i])
1188                                continue;
1189                        if (parse_commit(p))
1190                                continue;
1191                        porigin = find(sb, p, origin);
1192                        if (!porigin)
1193                                continue;
1194                        if (!hashcmp(porigin->blob_sha1, origin->blob_sha1)) {
1195                                pass_whole_blame(sb, origin, porigin);
1196                                origin_decref(porigin);
1197                                goto finish;
1198                        }
1199                        for (j = same = 0; j < i; j++)
1200                                if (sg_origin[j] &&
1201                                    !hashcmp(sg_origin[j]->blob_sha1,
1202                                             porigin->blob_sha1)) {
1203                                        same = 1;
1204                                        break;
1205                                }
1206                        if (!same)
1207                                sg_origin[i] = porigin;
1208                        else
1209                                origin_decref(porigin);
1210                }
1211        }
1212
1213        num_commits++;
1214        for (i = 0, sg = first_scapegoat(revs, commit);
1215             i < num_sg && sg;
1216             sg = sg->next, i++) {
1217                struct origin *porigin = sg_origin[i];
1218                if (!porigin)
1219                        continue;
1220                if (!origin->previous) {
1221                        origin_incref(porigin);
1222                        origin->previous = porigin;
1223                }
1224                if (pass_blame_to_parent(sb, origin, porigin))
1225                        goto finish;
1226        }
1227
1228        /*
1229         * Optionally find moves in parents' files.
1230         */
1231        if (opt & PICKAXE_BLAME_MOVE)
1232                for (i = 0, sg = first_scapegoat(revs, commit);
1233                     i < num_sg && sg;
1234                     sg = sg->next, i++) {
1235                        struct origin *porigin = sg_origin[i];
1236                        if (!porigin)
1237                                continue;
1238                        if (find_move_in_parent(sb, origin, porigin))
1239                                goto finish;
1240                }
1241
1242        /*
1243         * Optionally find copies from parents' files.
1244         */
1245        if (opt & PICKAXE_BLAME_COPY)
1246                for (i = 0, sg = first_scapegoat(revs, commit);
1247                     i < num_sg && sg;
1248                     sg = sg->next, i++) {
1249                        struct origin *porigin = sg_origin[i];
1250                        if (find_copy_in_parent(sb, origin, sg->item,
1251                                                porigin, opt))
1252                                goto finish;
1253                }
1254
1255 finish:
1256        for (i = 0; i < num_sg; i++) {
1257                if (sg_origin[i]) {
1258                        drop_origin_blob(sg_origin[i]);
1259                        origin_decref(sg_origin[i]);
1260                }
1261        }
1262        drop_origin_blob(origin);
1263        if (sg_buf != sg_origin)
1264                free(sg_origin);
1265}
1266
1267/*
1268 * Information on commits, used for output.
1269 */
1270struct commit_info
1271{
1272        const char *author;
1273        const char *author_mail;
1274        unsigned long author_time;
1275        const char *author_tz;
1276
1277        /* filled only when asked for details */
1278        const char *committer;
1279        const char *committer_mail;
1280        unsigned long committer_time;
1281        const char *committer_tz;
1282
1283        const char *summary;
1284};
1285
1286/*
1287 * Parse author/committer line in the commit object buffer
1288 */
1289static void get_ac_line(const char *inbuf, const char *what,
1290                        int person_len, char *person,
1291                        int mail_len, char *mail,
1292                        unsigned long *time, const char **tz)
1293{
1294        int len, tzlen, maillen;
1295        char *tmp, *endp, *timepos, *mailpos;
1296
1297        tmp = strstr(inbuf, what);
1298        if (!tmp)
1299                goto error_out;
1300        tmp += strlen(what);
1301        endp = strchr(tmp, '\n');
1302        if (!endp)
1303                len = strlen(tmp);
1304        else
1305                len = endp - tmp;
1306        if (person_len <= len) {
1307        error_out:
1308                /* Ugh */
1309                *tz = "(unknown)";
1310                strcpy(person, *tz);
1311                strcpy(mail, *tz);
1312                *time = 0;
1313                return;
1314        }
1315        memcpy(person, tmp, len);
1316
1317        tmp = person;
1318        tmp += len;
1319        *tmp = 0;
1320        while (person < tmp && *tmp != ' ')
1321                tmp--;
1322        if (tmp <= person)
1323                goto error_out;
1324        *tz = tmp+1;
1325        tzlen = (person+len)-(tmp+1);
1326
1327        *tmp = 0;
1328        while (person < tmp && *tmp != ' ')
1329                tmp--;
1330        if (tmp <= person)
1331                goto error_out;
1332        *time = strtoul(tmp, NULL, 10);
1333        timepos = tmp;
1334
1335        *tmp = 0;
1336        while (person < tmp && *tmp != ' ')
1337                tmp--;
1338        if (tmp <= person)
1339                return;
1340        mailpos = tmp + 1;
1341        *tmp = 0;
1342        maillen = timepos - tmp;
1343        memcpy(mail, mailpos, maillen);
1344
1345        if (!mailmap.nr)
1346                return;
1347
1348        /*
1349         * mailmap expansion may make the name longer.
1350         * make room by pushing stuff down.
1351         */
1352        tmp = person + person_len - (tzlen + 1);
1353        memmove(tmp, *tz, tzlen);
1354        tmp[tzlen] = 0;
1355        *tz = tmp;
1356
1357        /*
1358         * Now, convert both name and e-mail using mailmap
1359         */
1360        if (map_user(&mailmap, mail+1, mail_len-1, person, tmp-person-1)) {
1361                /* Add a trailing '>' to email, since map_user returns plain emails
1362                   Note: It already has '<', since we replace from mail+1 */
1363                mailpos = memchr(mail, '\0', mail_len);
1364                if (mailpos && mailpos-mail < mail_len - 1) {
1365                        *mailpos = '>';
1366                        *(mailpos+1) = '\0';
1367                }
1368        }
1369}
1370
1371static void get_commit_info(struct commit *commit,
1372                            struct commit_info *ret,
1373                            int detailed)
1374{
1375        int len;
1376        char *tmp, *endp, *reencoded, *message;
1377        static char author_name[1024];
1378        static char author_mail[1024];
1379        static char committer_name[1024];
1380        static char committer_mail[1024];
1381        static char summary_buf[1024];
1382
1383        /*
1384         * We've operated without save_commit_buffer, so
1385         * we now need to populate them for output.
1386         */
1387        if (!commit->buffer) {
1388                enum object_type type;
1389                unsigned long size;
1390                commit->buffer =
1391                        read_sha1_file(commit->object.sha1, &type, &size);
1392                if (!commit->buffer)
1393                        die("Cannot read commit %s",
1394                            sha1_to_hex(commit->object.sha1));
1395        }
1396        reencoded = reencode_commit_message(commit, NULL);
1397        message   = reencoded ? reencoded : commit->buffer;
1398        ret->author = author_name;
1399        ret->author_mail = author_mail;
1400        get_ac_line(message, "\nauthor ",
1401                    sizeof(author_name), author_name,
1402                    sizeof(author_mail), author_mail,
1403                    &ret->author_time, &ret->author_tz);
1404
1405        if (!detailed) {
1406                free(reencoded);
1407                return;
1408        }
1409
1410        ret->committer = committer_name;
1411        ret->committer_mail = committer_mail;
1412        get_ac_line(message, "\ncommitter ",
1413                    sizeof(committer_name), committer_name,
1414                    sizeof(committer_mail), committer_mail,
1415                    &ret->committer_time, &ret->committer_tz);
1416
1417        ret->summary = summary_buf;
1418        tmp = strstr(message, "\n\n");
1419        if (!tmp) {
1420        error_out:
1421                sprintf(summary_buf, "(%s)", sha1_to_hex(commit->object.sha1));
1422                free(reencoded);
1423                return;
1424        }
1425        tmp += 2;
1426        endp = strchr(tmp, '\n');
1427        if (!endp)
1428                endp = tmp + strlen(tmp);
1429        len = endp - tmp;
1430        if (len >= sizeof(summary_buf) || len == 0)
1431                goto error_out;
1432        memcpy(summary_buf, tmp, len);
1433        summary_buf[len] = 0;
1434        free(reencoded);
1435}
1436
1437/*
1438 * To allow LF and other nonportable characters in pathnames,
1439 * they are c-style quoted as needed.
1440 */
1441static void write_filename_info(const char *path)
1442{
1443        printf("filename ");
1444        write_name_quoted(path, stdout, '\n');
1445}
1446
1447/*
1448 * Porcelain/Incremental format wants to show a lot of details per
1449 * commit.  Instead of repeating this every line, emit it only once,
1450 * the first time each commit appears in the output.
1451 */
1452static int emit_one_suspect_detail(struct origin *suspect)
1453{
1454        struct commit_info ci;
1455
1456        if (suspect->commit->object.flags & METAINFO_SHOWN)
1457                return 0;
1458
1459        suspect->commit->object.flags |= METAINFO_SHOWN;
1460        get_commit_info(suspect->commit, &ci, 1);
1461        printf("author %s\n", ci.author);
1462        printf("author-mail %s\n", ci.author_mail);
1463        printf("author-time %lu\n", ci.author_time);
1464        printf("author-tz %s\n", ci.author_tz);
1465        printf("committer %s\n", ci.committer);
1466        printf("committer-mail %s\n", ci.committer_mail);
1467        printf("committer-time %lu\n", ci.committer_time);
1468        printf("committer-tz %s\n", ci.committer_tz);
1469        printf("summary %s\n", ci.summary);
1470        if (suspect->commit->object.flags & UNINTERESTING)
1471                printf("boundary\n");
1472        if (suspect->previous) {
1473                struct origin *prev = suspect->previous;
1474                printf("previous %s ", sha1_to_hex(prev->commit->object.sha1));
1475                write_name_quoted(prev->path, stdout, '\n');
1476        }
1477        return 1;
1478}
1479
1480/*
1481 * The blame_entry is found to be guilty for the range.  Mark it
1482 * as such, and show it in incremental output.
1483 */
1484static void found_guilty_entry(struct blame_entry *ent)
1485{
1486        if (ent->guilty)
1487                return;
1488        ent->guilty = 1;
1489        if (incremental) {
1490                struct origin *suspect = ent->suspect;
1491
1492                printf("%s %d %d %d\n",
1493                       sha1_to_hex(suspect->commit->object.sha1),
1494                       ent->s_lno + 1, ent->lno + 1, ent->num_lines);
1495                emit_one_suspect_detail(suspect);
1496                write_filename_info(suspect->path);
1497                maybe_flush_or_die(stdout, "stdout");
1498        }
1499}
1500
1501/*
1502 * The main loop -- while the scoreboard has lines whose true origin
1503 * is still unknown, pick one blame_entry, and allow its current
1504 * suspect to pass blames to its parents.
1505 */
1506static void assign_blame(struct scoreboard *sb, int opt)
1507{
1508        struct rev_info *revs = sb->revs;
1509
1510        while (1) {
1511                struct blame_entry *ent;
1512                struct commit *commit;
1513                struct origin *suspect = NULL;
1514
1515                /* find one suspect to break down */
1516                for (ent = sb->ent; !suspect && ent; ent = ent->next)
1517                        if (!ent->guilty)
1518                                suspect = ent->suspect;
1519                if (!suspect)
1520                        return; /* all done */
1521
1522                /*
1523                 * We will use this suspect later in the loop,
1524                 * so hold onto it in the meantime.
1525                 */
1526                origin_incref(suspect);
1527                commit = suspect->commit;
1528                if (!commit->object.parsed)
1529                        parse_commit(commit);
1530                if (reverse ||
1531                    (!(commit->object.flags & UNINTERESTING) &&
1532                     !(revs->max_age != -1 && commit->date < revs->max_age)))
1533                        pass_blame(sb, suspect, opt);
1534                else {
1535                        commit->object.flags |= UNINTERESTING;
1536                        if (commit->object.parsed)
1537                                mark_parents_uninteresting(commit);
1538                }
1539                /* treat root commit as boundary */
1540                if (!commit->parents && !show_root)
1541                        commit->object.flags |= UNINTERESTING;
1542
1543                /* Take responsibility for the remaining entries */
1544                for (ent = sb->ent; ent; ent = ent->next)
1545                        if (same_suspect(ent->suspect, suspect))
1546                                found_guilty_entry(ent);
1547                origin_decref(suspect);
1548
1549                if (DEBUG) /* sanity */
1550                        sanity_check_refcnt(sb);
1551        }
1552}
1553
1554static const char *format_time(unsigned long time, const char *tz_str,
1555                               int show_raw_time)
1556{
1557        static char time_buf[128];
1558        const char *time_str;
1559        int time_len;
1560        int tz;
1561
1562        if (show_raw_time) {
1563                sprintf(time_buf, "%lu %s", time, tz_str);
1564        }
1565        else {
1566                tz = atoi(tz_str);
1567                time_str = show_date(time, tz, blame_date_mode);
1568                time_len = strlen(time_str);
1569                memcpy(time_buf, time_str, time_len);
1570                memset(time_buf + time_len, ' ', blame_date_width - time_len);
1571        }
1572        return time_buf;
1573}
1574
1575#define OUTPUT_ANNOTATE_COMPAT  001
1576#define OUTPUT_LONG_OBJECT_NAME 002
1577#define OUTPUT_RAW_TIMESTAMP    004
1578#define OUTPUT_PORCELAIN        010
1579#define OUTPUT_SHOW_NAME        020
1580#define OUTPUT_SHOW_NUMBER      040
1581#define OUTPUT_SHOW_SCORE      0100
1582#define OUTPUT_NO_AUTHOR       0200
1583
1584static void emit_porcelain(struct scoreboard *sb, struct blame_entry *ent)
1585{
1586        int cnt;
1587        const char *cp;
1588        struct origin *suspect = ent->suspect;
1589        char hex[41];
1590
1591        strcpy(hex, sha1_to_hex(suspect->commit->object.sha1));
1592        printf("%s%c%d %d %d\n",
1593               hex,
1594               ent->guilty ? ' ' : '*', /* purely for debugging */
1595               ent->s_lno + 1,
1596               ent->lno + 1,
1597               ent->num_lines);
1598        if (emit_one_suspect_detail(suspect) ||
1599            (suspect->commit->object.flags & MORE_THAN_ONE_PATH))
1600                write_filename_info(suspect->path);
1601
1602        cp = nth_line(sb, ent->lno);
1603        for (cnt = 0; cnt < ent->num_lines; cnt++) {
1604                char ch;
1605                if (cnt)
1606                        printf("%s %d %d\n", hex,
1607                               ent->s_lno + 1 + cnt,
1608                               ent->lno + 1 + cnt);
1609                putchar('\t');
1610                do {
1611                        ch = *cp++;
1612                        putchar(ch);
1613                } while (ch != '\n' &&
1614                         cp < sb->final_buf + sb->final_buf_size);
1615        }
1616
1617        if (sb->final_buf_size && cp[-1] != '\n')
1618                putchar('\n');
1619}
1620
1621static void emit_other(struct scoreboard *sb, struct blame_entry *ent, int opt)
1622{
1623        int cnt;
1624        const char *cp;
1625        struct origin *suspect = ent->suspect;
1626        struct commit_info ci;
1627        char hex[41];
1628        int show_raw_time = !!(opt & OUTPUT_RAW_TIMESTAMP);
1629
1630        get_commit_info(suspect->commit, &ci, 1);
1631        strcpy(hex, sha1_to_hex(suspect->commit->object.sha1));
1632
1633        cp = nth_line(sb, ent->lno);
1634        for (cnt = 0; cnt < ent->num_lines; cnt++) {
1635                char ch;
1636                int length = (opt & OUTPUT_LONG_OBJECT_NAME) ? 40 : 8;
1637
1638                if (suspect->commit->object.flags & UNINTERESTING) {
1639                        if (blank_boundary)
1640                                memset(hex, ' ', length);
1641                        else if (!(opt & OUTPUT_ANNOTATE_COMPAT)) {
1642                                length--;
1643                                putchar('^');
1644                        }
1645                }
1646
1647                printf("%.*s", length, hex);
1648                if (opt & OUTPUT_ANNOTATE_COMPAT)
1649                        printf("\t(%10s\t%10s\t%d)", ci.author,
1650                               format_time(ci.author_time, ci.author_tz,
1651                                           show_raw_time),
1652                               ent->lno + 1 + cnt);
1653                else {
1654                        if (opt & OUTPUT_SHOW_SCORE)
1655                                printf(" %*d %02d",
1656                                       max_score_digits, ent->score,
1657                                       ent->suspect->refcnt);
1658                        if (opt & OUTPUT_SHOW_NAME)
1659                                printf(" %-*.*s", longest_file, longest_file,
1660                                       suspect->path);
1661                        if (opt & OUTPUT_SHOW_NUMBER)
1662                                printf(" %*d", max_orig_digits,
1663                                       ent->s_lno + 1 + cnt);
1664
1665                        if (!(opt & OUTPUT_NO_AUTHOR)) {
1666                                int pad = longest_author - utf8_strwidth(ci.author);
1667                                printf(" (%s%*s %10s",
1668                                       ci.author, pad, "",
1669                                       format_time(ci.author_time,
1670                                                   ci.author_tz,
1671                                                   show_raw_time));
1672                        }
1673                        printf(" %*d) ",
1674                               max_digits, ent->lno + 1 + cnt);
1675                }
1676                do {
1677                        ch = *cp++;
1678                        putchar(ch);
1679                } while (ch != '\n' &&
1680                         cp < sb->final_buf + sb->final_buf_size);
1681        }
1682
1683        if (sb->final_buf_size && cp[-1] != '\n')
1684                putchar('\n');
1685}
1686
1687static void output(struct scoreboard *sb, int option)
1688{
1689        struct blame_entry *ent;
1690
1691        if (option & OUTPUT_PORCELAIN) {
1692                for (ent = sb->ent; ent; ent = ent->next) {
1693                        struct blame_entry *oth;
1694                        struct origin *suspect = ent->suspect;
1695                        struct commit *commit = suspect->commit;
1696                        if (commit->object.flags & MORE_THAN_ONE_PATH)
1697                                continue;
1698                        for (oth = ent->next; oth; oth = oth->next) {
1699                                if ((oth->suspect->commit != commit) ||
1700                                    !strcmp(oth->suspect->path, suspect->path))
1701                                        continue;
1702                                commit->object.flags |= MORE_THAN_ONE_PATH;
1703                                break;
1704                        }
1705                }
1706        }
1707
1708        for (ent = sb->ent; ent; ent = ent->next) {
1709                if (option & OUTPUT_PORCELAIN)
1710                        emit_porcelain(sb, ent);
1711                else {
1712                        emit_other(sb, ent, option);
1713                }
1714        }
1715}
1716
1717/*
1718 * To allow quick access to the contents of nth line in the
1719 * final image, prepare an index in the scoreboard.
1720 */
1721static int prepare_lines(struct scoreboard *sb)
1722{
1723        const char *buf = sb->final_buf;
1724        unsigned long len = sb->final_buf_size;
1725        int num = 0, incomplete = 0, bol = 1;
1726
1727        if (len && buf[len-1] != '\n')
1728                incomplete++; /* incomplete line at the end */
1729        while (len--) {
1730                if (bol) {
1731                        sb->lineno = xrealloc(sb->lineno,
1732                                              sizeof(int *) * (num + 1));
1733                        sb->lineno[num] = buf - sb->final_buf;
1734                        bol = 0;
1735                }
1736                if (*buf++ == '\n') {
1737                        num++;
1738                        bol = 1;
1739                }
1740        }
1741        sb->lineno = xrealloc(sb->lineno,
1742                              sizeof(int *) * (num + incomplete + 1));
1743        sb->lineno[num + incomplete] = buf - sb->final_buf;
1744        sb->num_lines = num + incomplete;
1745        return sb->num_lines;
1746}
1747
1748/*
1749 * Add phony grafts for use with -S; this is primarily to
1750 * support git's cvsserver that wants to give a linear history
1751 * to its clients.
1752 */
1753static int read_ancestry(const char *graft_file)
1754{
1755        FILE *fp = fopen(graft_file, "r");
1756        char buf[1024];
1757        if (!fp)
1758                return -1;
1759        while (fgets(buf, sizeof(buf), fp)) {
1760                /* The format is just "Commit Parent1 Parent2 ...\n" */
1761                int len = strlen(buf);
1762                struct commit_graft *graft = read_graft_line(buf, len);
1763                if (graft)
1764                        register_commit_graft(graft, 0);
1765        }
1766        fclose(fp);
1767        return 0;
1768}
1769
1770/*
1771 * How many columns do we need to show line numbers in decimal?
1772 */
1773static int lineno_width(int lines)
1774{
1775        int i, width;
1776
1777        for (width = 1, i = 10; i <= lines; width++)
1778                i *= 10;
1779        return width;
1780}
1781
1782/*
1783 * How many columns do we need to show line numbers, authors,
1784 * and filenames?
1785 */
1786static void find_alignment(struct scoreboard *sb, int *option)
1787{
1788        int longest_src_lines = 0;
1789        int longest_dst_lines = 0;
1790        unsigned largest_score = 0;
1791        struct blame_entry *e;
1792
1793        for (e = sb->ent; e; e = e->next) {
1794                struct origin *suspect = e->suspect;
1795                struct commit_info ci;
1796                int num;
1797
1798                if (strcmp(suspect->path, sb->path))
1799                        *option |= OUTPUT_SHOW_NAME;
1800                num = strlen(suspect->path);
1801                if (longest_file < num)
1802                        longest_file = num;
1803                if (!(suspect->commit->object.flags & METAINFO_SHOWN)) {
1804                        suspect->commit->object.flags |= METAINFO_SHOWN;
1805                        get_commit_info(suspect->commit, &ci, 1);
1806                        num = utf8_strwidth(ci.author);
1807                        if (longest_author < num)
1808                                longest_author = num;
1809                }
1810                num = e->s_lno + e->num_lines;
1811                if (longest_src_lines < num)
1812                        longest_src_lines = num;
1813                num = e->lno + e->num_lines;
1814                if (longest_dst_lines < num)
1815                        longest_dst_lines = num;
1816                if (largest_score < ent_score(sb, e))
1817                        largest_score = ent_score(sb, e);
1818        }
1819        max_orig_digits = lineno_width(longest_src_lines);
1820        max_digits = lineno_width(longest_dst_lines);
1821        max_score_digits = lineno_width(largest_score);
1822}
1823
1824/*
1825 * For debugging -- origin is refcounted, and this asserts that
1826 * we do not underflow.
1827 */
1828static void sanity_check_refcnt(struct scoreboard *sb)
1829{
1830        int baa = 0;
1831        struct blame_entry *ent;
1832
1833        for (ent = sb->ent; ent; ent = ent->next) {
1834                /* Nobody should have zero or negative refcnt */
1835                if (ent->suspect->refcnt <= 0) {
1836                        fprintf(stderr, "%s in %s has negative refcnt %d\n",
1837                                ent->suspect->path,
1838                                sha1_to_hex(ent->suspect->commit->object.sha1),
1839                                ent->suspect->refcnt);
1840                        baa = 1;
1841                }
1842        }
1843        if (baa) {
1844                int opt = 0160;
1845                find_alignment(sb, &opt);
1846                output(sb, opt);
1847                die("Baa %d!", baa);
1848        }
1849}
1850
1851/*
1852 * Used for the command line parsing; check if the path exists
1853 * in the working tree.
1854 */
1855static int has_string_in_work_tree(const char *path)
1856{
1857        struct stat st;
1858        return !lstat(path, &st);
1859}
1860
1861static unsigned parse_score(const char *arg)
1862{
1863        char *end;
1864        unsigned long score = strtoul(arg, &end, 10);
1865        if (*end)
1866                return 0;
1867        return score;
1868}
1869
1870static const char *add_prefix(const char *prefix, const char *path)
1871{
1872        return prefix_path(prefix, prefix ? strlen(prefix) : 0, path);
1873}
1874
1875/*
1876 * Parsing of (comma separated) one item in the -L option
1877 */
1878static const char *parse_loc(const char *spec,
1879                             struct scoreboard *sb, long lno,
1880                             long begin, long *ret)
1881{
1882        char *term;
1883        const char *line;
1884        long num;
1885        int reg_error;
1886        regex_t regexp;
1887        regmatch_t match[1];
1888
1889        /* Allow "-L <something>,+20" to mean starting at <something>
1890         * for 20 lines, or "-L <something>,-5" for 5 lines ending at
1891         * <something>.
1892         */
1893        if (1 < begin && (spec[0] == '+' || spec[0] == '-')) {
1894                num = strtol(spec + 1, &term, 10);
1895                if (term != spec + 1) {
1896                        if (spec[0] == '-')
1897                                num = 0 - num;
1898                        if (0 < num)
1899                                *ret = begin + num - 2;
1900                        else if (!num)
1901                                *ret = begin;
1902                        else
1903                                *ret = begin + num;
1904                        return term;
1905                }
1906                return spec;
1907        }
1908        num = strtol(spec, &term, 10);
1909        if (term != spec) {
1910                *ret = num;
1911                return term;
1912        }
1913        if (spec[0] != '/')
1914                return spec;
1915
1916        /* it could be a regexp of form /.../ */
1917        for (term = (char *) spec + 1; *term && *term != '/'; term++) {
1918                if (*term == '\\')
1919                        term++;
1920        }
1921        if (*term != '/')
1922                return spec;
1923
1924        /* try [spec+1 .. term-1] as regexp */
1925        *term = 0;
1926        begin--; /* input is in human terms */
1927        line = nth_line(sb, begin);
1928
1929        if (!(reg_error = regcomp(&regexp, spec + 1, REG_NEWLINE)) &&
1930            !(reg_error = regexec(&regexp, line, 1, match, 0))) {
1931                const char *cp = line + match[0].rm_so;
1932                const char *nline;
1933
1934                while (begin++ < lno) {
1935                        nline = nth_line(sb, begin);
1936                        if (line <= cp && cp < nline)
1937                                break;
1938                        line = nline;
1939                }
1940                *ret = begin;
1941                regfree(&regexp);
1942                *term++ = '/';
1943                return term;
1944        }
1945        else {
1946                char errbuf[1024];
1947                regerror(reg_error, &regexp, errbuf, 1024);
1948                die("-L parameter '%s': %s", spec + 1, errbuf);
1949        }
1950}
1951
1952/*
1953 * Parsing of -L option
1954 */
1955static void prepare_blame_range(struct scoreboard *sb,
1956                                const char *bottomtop,
1957                                long lno,
1958                                long *bottom, long *top)
1959{
1960        const char *term;
1961
1962        term = parse_loc(bottomtop, sb, lno, 1, bottom);
1963        if (*term == ',') {
1964                term = parse_loc(term + 1, sb, lno, *bottom + 1, top);
1965                if (*term)
1966                        usage(blame_usage);
1967        }
1968        if (*term)
1969                usage(blame_usage);
1970}
1971
1972static int git_blame_config(const char *var, const char *value, void *cb)
1973{
1974        if (!strcmp(var, "blame.showroot")) {
1975                show_root = git_config_bool(var, value);
1976                return 0;
1977        }
1978        if (!strcmp(var, "blame.blankboundary")) {
1979                blank_boundary = git_config_bool(var, value);
1980                return 0;
1981        }
1982        if (!strcmp(var, "blame.date")) {
1983                if (!value)
1984                        return config_error_nonbool(var);
1985                blame_date_mode = parse_date_format(value);
1986                return 0;
1987        }
1988        return git_default_config(var, value, cb);
1989}
1990
1991/*
1992 * Prepare a dummy commit that represents the work tree (or staged) item.
1993 * Note that annotating work tree item never works in the reverse.
1994 */
1995static struct commit *fake_working_tree_commit(const char *path, const char *contents_from)
1996{
1997        struct commit *commit;
1998        struct origin *origin;
1999        unsigned char head_sha1[20];
2000        struct strbuf buf = STRBUF_INIT;
2001        const char *ident;
2002        time_t now;
2003        int size, len;
2004        struct cache_entry *ce;
2005        unsigned mode;
2006
2007        if (get_sha1("HEAD", head_sha1))
2008                die("No such ref: HEAD");
2009
2010        time(&now);
2011        commit = xcalloc(1, sizeof(*commit));
2012        commit->parents = xcalloc(1, sizeof(*commit->parents));
2013        commit->parents->item = lookup_commit_reference(head_sha1);
2014        commit->object.parsed = 1;
2015        commit->date = now;
2016        commit->object.type = OBJ_COMMIT;
2017
2018        origin = make_origin(commit, path);
2019
2020        if (!contents_from || strcmp("-", contents_from)) {
2021                struct stat st;
2022                const char *read_from;
2023
2024                if (contents_from) {
2025                        if (stat(contents_from, &st) < 0)
2026                                die_errno("Cannot stat '%s'", contents_from);
2027                        read_from = contents_from;
2028                }
2029                else {
2030                        if (lstat(path, &st) < 0)
2031                                die_errno("Cannot lstat '%s'", path);
2032                        read_from = path;
2033                }
2034                mode = canon_mode(st.st_mode);
2035                switch (st.st_mode & S_IFMT) {
2036                case S_IFREG:
2037                        if (strbuf_read_file(&buf, read_from, st.st_size) != st.st_size)
2038                                die_errno("cannot open or read '%s'", read_from);
2039                        break;
2040                case S_IFLNK:
2041                        if (strbuf_readlink(&buf, read_from, st.st_size) < 0)
2042                                die_errno("cannot readlink '%s'", read_from);
2043                        break;
2044                default:
2045                        die("unsupported file type %s", read_from);
2046                }
2047        }
2048        else {
2049                /* Reading from stdin */
2050                contents_from = "standard input";
2051                mode = 0;
2052                if (strbuf_read(&buf, 0, 0) < 0)
2053                        die_errno("failed to read from stdin");
2054        }
2055        convert_to_git(path, buf.buf, buf.len, &buf, 0);
2056        origin->file.ptr = buf.buf;
2057        origin->file.size = buf.len;
2058        pretend_sha1_file(buf.buf, buf.len, OBJ_BLOB, origin->blob_sha1);
2059        commit->util = origin;
2060
2061        /*
2062         * Read the current index, replace the path entry with
2063         * origin->blob_sha1 without mucking with its mode or type
2064         * bits; we are not going to write this index out -- we just
2065         * want to run "diff-index --cached".
2066         */
2067        discard_cache();
2068        read_cache();
2069
2070        len = strlen(path);
2071        if (!mode) {
2072                int pos = cache_name_pos(path, len);
2073                if (0 <= pos)
2074                        mode = active_cache[pos]->ce_mode;
2075                else
2076                        /* Let's not bother reading from HEAD tree */
2077                        mode = S_IFREG | 0644;
2078        }
2079        size = cache_entry_size(len);
2080        ce = xcalloc(1, size);
2081        hashcpy(ce->sha1, origin->blob_sha1);
2082        memcpy(ce->name, path, len);
2083        ce->ce_flags = create_ce_flags(len, 0);
2084        ce->ce_mode = create_ce_mode(mode);
2085        add_cache_entry(ce, ADD_CACHE_OK_TO_ADD|ADD_CACHE_OK_TO_REPLACE);
2086
2087        /*
2088         * We are not going to write this out, so this does not matter
2089         * right now, but someday we might optimize diff-index --cached
2090         * with cache-tree information.
2091         */
2092        cache_tree_invalidate_path(active_cache_tree, path);
2093
2094        commit->buffer = xmalloc(400);
2095        ident = fmt_ident("Not Committed Yet", "not.committed.yet", NULL, 0);
2096        snprintf(commit->buffer, 400,
2097                "tree 0000000000000000000000000000000000000000\n"
2098                "parent %s\n"
2099                "author %s\n"
2100                "committer %s\n\n"
2101                "Version of %s from %s\n",
2102                sha1_to_hex(head_sha1),
2103                ident, ident, path, contents_from ? contents_from : path);
2104        return commit;
2105}
2106
2107static const char *prepare_final(struct scoreboard *sb)
2108{
2109        int i;
2110        const char *final_commit_name = NULL;
2111        struct rev_info *revs = sb->revs;
2112
2113        /*
2114         * There must be one and only one positive commit in the
2115         * revs->pending array.
2116         */
2117        for (i = 0; i < revs->pending.nr; i++) {
2118                struct object *obj = revs->pending.objects[i].item;
2119                if (obj->flags & UNINTERESTING)
2120                        continue;
2121                while (obj->type == OBJ_TAG)
2122                        obj = deref_tag(obj, NULL, 0);
2123                if (obj->type != OBJ_COMMIT)
2124                        die("Non commit %s?", revs->pending.objects[i].name);
2125                if (sb->final)
2126                        die("More than one commit to dig from %s and %s?",
2127                            revs->pending.objects[i].name,
2128                            final_commit_name);
2129                sb->final = (struct commit *) obj;
2130                final_commit_name = revs->pending.objects[i].name;
2131        }
2132        return final_commit_name;
2133}
2134
2135static const char *prepare_initial(struct scoreboard *sb)
2136{
2137        int i;
2138        const char *final_commit_name = NULL;
2139        struct rev_info *revs = sb->revs;
2140
2141        /*
2142         * There must be one and only one negative commit, and it must be
2143         * the boundary.
2144         */
2145        for (i = 0; i < revs->pending.nr; i++) {
2146                struct object *obj = revs->pending.objects[i].item;
2147                if (!(obj->flags & UNINTERESTING))
2148                        continue;
2149                while (obj->type == OBJ_TAG)
2150                        obj = deref_tag(obj, NULL, 0);
2151                if (obj->type != OBJ_COMMIT)
2152                        die("Non commit %s?", revs->pending.objects[i].name);
2153                if (sb->final)
2154                        die("More than one commit to dig down to %s and %s?",
2155                            revs->pending.objects[i].name,
2156                            final_commit_name);
2157                sb->final = (struct commit *) obj;
2158                final_commit_name = revs->pending.objects[i].name;
2159        }
2160        if (!final_commit_name)
2161                die("No commit to dig down to?");
2162        return final_commit_name;
2163}
2164
2165static int blame_copy_callback(const struct option *option, const char *arg, int unset)
2166{
2167        int *opt = option->value;
2168
2169        /*
2170         * -C enables copy from removed files;
2171         * -C -C enables copy from existing files, but only
2172         *       when blaming a new file;
2173         * -C -C -C enables copy from existing files for
2174         *          everybody
2175         */
2176        if (*opt & PICKAXE_BLAME_COPY_HARDER)
2177                *opt |= PICKAXE_BLAME_COPY_HARDEST;
2178        if (*opt & PICKAXE_BLAME_COPY)
2179                *opt |= PICKAXE_BLAME_COPY_HARDER;
2180        *opt |= PICKAXE_BLAME_COPY | PICKAXE_BLAME_MOVE;
2181
2182        if (arg)
2183                blame_copy_score = parse_score(arg);
2184        return 0;
2185}
2186
2187static int blame_move_callback(const struct option *option, const char *arg, int unset)
2188{
2189        int *opt = option->value;
2190
2191        *opt |= PICKAXE_BLAME_MOVE;
2192
2193        if (arg)
2194                blame_move_score = parse_score(arg);
2195        return 0;
2196}
2197
2198static int blame_bottomtop_callback(const struct option *option, const char *arg, int unset)
2199{
2200        const char **bottomtop = option->value;
2201        if (!arg)
2202                return -1;
2203        if (*bottomtop)
2204                die("More than one '-L n,m' option given");
2205        *bottomtop = arg;
2206        return 0;
2207}
2208
2209int cmd_blame(int argc, const char **argv, const char *prefix)
2210{
2211        struct rev_info revs;
2212        const char *path;
2213        struct scoreboard sb;
2214        struct origin *o;
2215        struct blame_entry *ent;
2216        long dashdash_pos, bottom, top, lno;
2217        const char *final_commit_name = NULL;
2218        enum object_type type;
2219
2220        static const char *bottomtop = NULL;
2221        static int output_option = 0, opt = 0;
2222        static int show_stats = 0;
2223        static const char *revs_file = NULL;
2224        static const char *contents_from = NULL;
2225        static const struct option options[] = {
2226                OPT_BOOLEAN(0, "incremental", &incremental, "Show blame entries as we find them, incrementally"),
2227                OPT_BOOLEAN('b', NULL, &blank_boundary, "Show blank SHA-1 for boundary commits (Default: off)"),
2228                OPT_BOOLEAN(0, "root", &show_root, "Do not treat root commits as boundaries (Default: off)"),
2229                OPT_BOOLEAN(0, "show-stats", &show_stats, "Show work cost statistics"),
2230                OPT_BIT(0, "score-debug", &output_option, "Show output score for blame entries", OUTPUT_SHOW_SCORE),
2231                OPT_BIT('f', "show-name", &output_option, "Show original filename (Default: auto)", OUTPUT_SHOW_NAME),
2232                OPT_BIT('n', "show-number", &output_option, "Show original linenumber (Default: off)", OUTPUT_SHOW_NUMBER),
2233                OPT_BIT('p', "porcelain", &output_option, "Show in a format designed for machine consumption", OUTPUT_PORCELAIN),
2234                OPT_BIT('c', NULL, &output_option, "Use the same output mode as git-annotate (Default: off)", OUTPUT_ANNOTATE_COMPAT),
2235                OPT_BIT('t', NULL, &output_option, "Show raw timestamp (Default: off)", OUTPUT_RAW_TIMESTAMP),
2236                OPT_BIT('l', NULL, &output_option, "Show long commit SHA1 (Default: off)", OUTPUT_LONG_OBJECT_NAME),
2237                OPT_BIT('s', NULL, &output_option, "Suppress author name and timestamp (Default: off)", OUTPUT_NO_AUTHOR),
2238                OPT_BIT('w', NULL, &xdl_opts, "Ignore whitespace differences", XDF_IGNORE_WHITESPACE),
2239                OPT_STRING('S', NULL, &revs_file, "file", "Use revisions from <file> instead of calling git-rev-list"),
2240                OPT_STRING(0, "contents", &contents_from, "file", "Use <file>'s contents as the final image"),
2241                { OPTION_CALLBACK, 'C', NULL, &opt, "score", "Find line copies within and across files", PARSE_OPT_OPTARG, blame_copy_callback },
2242                { OPTION_CALLBACK, 'M', NULL, &opt, "score", "Find line movements within and across files", PARSE_OPT_OPTARG, blame_move_callback },
2243                OPT_CALLBACK('L', NULL, &bottomtop, "n,m", "Process only line range n,m, counting from 1", blame_bottomtop_callback),
2244                OPT_END()
2245        };
2246
2247        struct parse_opt_ctx_t ctx;
2248        int cmd_is_annotate = !strcmp(argv[0], "annotate");
2249
2250        git_config(git_blame_config, NULL);
2251        init_revisions(&revs, NULL);
2252        revs.date_mode = blame_date_mode;
2253
2254        save_commit_buffer = 0;
2255        dashdash_pos = 0;
2256
2257        parse_options_start(&ctx, argc, argv, prefix, PARSE_OPT_KEEP_DASHDASH |
2258                            PARSE_OPT_KEEP_ARGV0);
2259        for (;;) {
2260                switch (parse_options_step(&ctx, options, blame_opt_usage)) {
2261                case PARSE_OPT_HELP:
2262                        exit(129);
2263                case PARSE_OPT_DONE:
2264                        if (ctx.argv[0])
2265                                dashdash_pos = ctx.cpidx;
2266                        goto parse_done;
2267                }
2268
2269                if (!strcmp(ctx.argv[0], "--reverse")) {
2270                        ctx.argv[0] = "--children";
2271                        reverse = 1;
2272                }
2273                parse_revision_opt(&revs, &ctx, options, blame_opt_usage);
2274        }
2275parse_done:
2276        argc = parse_options_end(&ctx);
2277
2278        if (revs_file && read_ancestry(revs_file))
2279                die_errno("reading graft file '%s' failed", revs_file);
2280
2281        if (cmd_is_annotate) {
2282                output_option |= OUTPUT_ANNOTATE_COMPAT;
2283                blame_date_mode = DATE_ISO8601;
2284        } else {
2285                blame_date_mode = revs.date_mode;
2286        }
2287
2288        /* The maximum width used to show the dates */
2289        switch (blame_date_mode) {
2290        case DATE_RFC2822:
2291                blame_date_width = sizeof("Thu, 19 Oct 2006 16:00:04 -0700");
2292                break;
2293        case DATE_ISO8601:
2294                blame_date_width = sizeof("2006-10-19 16:00:04 -0700");
2295                break;
2296        case DATE_RAW:
2297                blame_date_width = sizeof("1161298804 -0700");
2298                break;
2299        case DATE_SHORT:
2300                blame_date_width = sizeof("2006-10-19");
2301                break;
2302        case DATE_RELATIVE:
2303                /* "normal" is used as the fallback for "relative" */
2304        case DATE_LOCAL:
2305        case DATE_NORMAL:
2306                blame_date_width = sizeof("Thu Oct 19 16:00:04 2006 -0700");
2307                break;
2308        }
2309        blame_date_width -= 1; /* strip the null */
2310
2311        if (DIFF_OPT_TST(&revs.diffopt, FIND_COPIES_HARDER))
2312                opt |= (PICKAXE_BLAME_COPY | PICKAXE_BLAME_MOVE |
2313                        PICKAXE_BLAME_COPY_HARDER);
2314
2315        if (!blame_move_score)
2316                blame_move_score = BLAME_DEFAULT_MOVE_SCORE;
2317        if (!blame_copy_score)
2318                blame_copy_score = BLAME_DEFAULT_COPY_SCORE;
2319
2320        /*
2321         * We have collected options unknown to us in argv[1..unk]
2322         * which are to be passed to revision machinery if we are
2323         * going to do the "bottom" processing.
2324         *
2325         * The remaining are:
2326         *
2327         * (1) if dashdash_pos != 0, its either
2328         *     "blame [revisions] -- <path>" or
2329         *     "blame -- <path> <rev>"
2330         *
2331         * (2) otherwise, its one of the two:
2332         *     "blame [revisions] <path>"
2333         *     "blame <path> <rev>"
2334         *
2335         * Note that we must strip out <path> from the arguments: we do not
2336         * want the path pruning but we may want "bottom" processing.
2337         */
2338        if (dashdash_pos) {
2339                switch (argc - dashdash_pos - 1) {
2340                case 2: /* (1b) */
2341                        if (argc != 4)
2342                                usage_with_options(blame_opt_usage, options);
2343                        /* reorder for the new way: <rev> -- <path> */
2344                        argv[1] = argv[3];
2345                        argv[3] = argv[2];
2346                        argv[2] = "--";
2347                        /* FALLTHROUGH */
2348                case 1: /* (1a) */
2349                        path = add_prefix(prefix, argv[--argc]);
2350                        argv[argc] = NULL;
2351                        break;
2352                default:
2353                        usage_with_options(blame_opt_usage, options);
2354                }
2355        } else {
2356                if (argc < 2)
2357                        usage_with_options(blame_opt_usage, options);
2358                path = add_prefix(prefix, argv[argc - 1]);
2359                if (argc == 3 && !has_string_in_work_tree(path)) { /* (2b) */
2360                        path = add_prefix(prefix, argv[1]);
2361                        argv[1] = argv[2];
2362                }
2363                argv[argc - 1] = "--";
2364
2365                setup_work_tree();
2366                if (!has_string_in_work_tree(path))
2367                        die_errno("cannot stat path '%s'", path);
2368        }
2369
2370        revs.disable_stdin = 1;
2371        setup_revisions(argc, argv, &revs, NULL);
2372        memset(&sb, 0, sizeof(sb));
2373
2374        sb.revs = &revs;
2375        if (!reverse)
2376                final_commit_name = prepare_final(&sb);
2377        else if (contents_from)
2378                die("--contents and --children do not blend well.");
2379        else
2380                final_commit_name = prepare_initial(&sb);
2381
2382        if (!sb.final) {
2383                /*
2384                 * "--not A B -- path" without anything positive;
2385                 * do not default to HEAD, but use the working tree
2386                 * or "--contents".
2387                 */
2388                setup_work_tree();
2389                sb.final = fake_working_tree_commit(path, contents_from);
2390                add_pending_object(&revs, &(sb.final->object), ":");
2391        }
2392        else if (contents_from)
2393                die("Cannot use --contents with final commit object name");
2394
2395        /*
2396         * If we have bottom, this will mark the ancestors of the
2397         * bottom commits we would reach while traversing as
2398         * uninteresting.
2399         */
2400        if (prepare_revision_walk(&revs))
2401                die("revision walk setup failed");
2402
2403        if (is_null_sha1(sb.final->object.sha1)) {
2404                char *buf;
2405                o = sb.final->util;
2406                buf = xmalloc(o->file.size + 1);
2407                memcpy(buf, o->file.ptr, o->file.size + 1);
2408                sb.final_buf = buf;
2409                sb.final_buf_size = o->file.size;
2410        }
2411        else {
2412                o = get_origin(&sb, sb.final, path);
2413                if (fill_blob_sha1(o))
2414                        die("no such path %s in %s", path, final_commit_name);
2415
2416                sb.final_buf = read_sha1_file(o->blob_sha1, &type,
2417                                              &sb.final_buf_size);
2418                if (!sb.final_buf)
2419                        die("Cannot read blob %s for path %s",
2420                            sha1_to_hex(o->blob_sha1),
2421                            path);
2422        }
2423        num_read_blob++;
2424        lno = prepare_lines(&sb);
2425
2426        bottom = top = 0;
2427        if (bottomtop)
2428                prepare_blame_range(&sb, bottomtop, lno, &bottom, &top);
2429        if (bottom && top && top < bottom) {
2430                long tmp;
2431                tmp = top; top = bottom; bottom = tmp;
2432        }
2433        if (bottom < 1)
2434                bottom = 1;
2435        if (top < 1)
2436                top = lno;
2437        bottom--;
2438        if (lno < top || lno < bottom)
2439                die("file %s has only %lu lines", path, lno);
2440
2441        ent = xcalloc(1, sizeof(*ent));
2442        ent->lno = bottom;
2443        ent->num_lines = top - bottom;
2444        ent->suspect = o;
2445        ent->s_lno = bottom;
2446
2447        sb.ent = ent;
2448        sb.path = path;
2449
2450        read_mailmap(&mailmap, NULL);
2451
2452        if (!incremental)
2453                setup_pager();
2454
2455        assign_blame(&sb, opt);
2456
2457        if (incremental)
2458                return 0;
2459
2460        coalesce(&sb);
2461
2462        if (!(output_option & OUTPUT_PORCELAIN))
2463                find_alignment(&sb, &output_option);
2464
2465        output(&sb, output_option);
2466        free((void *)sb.final_buf);
2467        for (ent = sb.ent; ent; ) {
2468                struct blame_entry *e = ent->next;
2469                free(ent);
2470                ent = e;
2471        }
2472
2473        if (show_stats) {
2474                printf("num read blob: %d\n", num_read_blob);
2475                printf("num get patch: %d\n", num_get_patch);
2476                printf("num commits: %d\n", num_commits);
2477        }
2478        return 0;
2479}