builtin / blame.con commit blame: rework methods that determine 'final' commit (835c49f)
   1/*
   2 * Blame
   3 *
   4 * Copyright (c) 2006, 2014 by its authors
   5 * See COPYING for licensing conditions
   6 */
   7
   8#include "cache.h"
   9#include "refs.h"
  10#include "builtin.h"
  11#include "commit.h"
  12#include "tag.h"
  13#include "tree-walk.h"
  14#include "diff.h"
  15#include "diffcore.h"
  16#include "revision.h"
  17#include "quote.h"
  18#include "xdiff-interface.h"
  19#include "cache-tree.h"
  20#include "string-list.h"
  21#include "mailmap.h"
  22#include "mergesort.h"
  23#include "parse-options.h"
  24#include "prio-queue.h"
  25#include "utf8.h"
  26#include "userdiff.h"
  27#include "line-range.h"
  28#include "line-log.h"
  29#include "dir.h"
  30#include "progress.h"
  31
  32static char blame_usage[] = N_("git blame [<options>] [<rev-opts>] [<rev>] [--] <file>");
  33
  34static const char *blame_opt_usage[] = {
  35        blame_usage,
  36        "",
  37        N_("<rev-opts> are documented in git-rev-list(1)"),
  38        NULL
  39};
  40
  41static int longest_file;
  42static int longest_author;
  43static int max_orig_digits;
  44static int max_digits;
  45static int max_score_digits;
  46static int show_root;
  47static int reverse;
  48static int blank_boundary;
  49static int incremental;
  50static int xdl_opts;
  51static int abbrev = -1;
  52static int no_whole_file_rename;
  53static int show_progress;
  54
  55static struct date_mode blame_date_mode = { DATE_ISO8601 };
  56static size_t blame_date_width;
  57
  58static struct string_list mailmap = STRING_LIST_INIT_NODUP;
  59
  60#ifndef DEBUG
  61#define DEBUG 0
  62#endif
  63
  64#define PICKAXE_BLAME_MOVE              01
  65#define PICKAXE_BLAME_COPY              02
  66#define PICKAXE_BLAME_COPY_HARDER       04
  67#define PICKAXE_BLAME_COPY_HARDEST      010
  68
  69static unsigned blame_move_score;
  70static unsigned blame_copy_score;
  71#define BLAME_DEFAULT_MOVE_SCORE        20
  72#define BLAME_DEFAULT_COPY_SCORE        40
  73
  74/* Remember to update object flag allocation in object.h */
  75#define METAINFO_SHOWN          (1u<<12)
  76#define MORE_THAN_ONE_PATH      (1u<<13)
  77
  78/*
  79 * One blob in a commit that is being suspected
  80 */
  81struct blame_origin {
  82        int refcnt;
  83        /* Record preceding blame record for this blob */
  84        struct blame_origin *previous;
  85        /* origins are put in a list linked via `next' hanging off the
  86         * corresponding commit's util field in order to make finding
  87         * them fast.  The presence in this chain does not count
  88         * towards the origin's reference count.  It is tempting to
  89         * let it count as long as the commit is pending examination,
  90         * but even under circumstances where the commit will be
  91         * present multiple times in the priority queue of unexamined
  92         * commits, processing the first instance will not leave any
  93         * work requiring the origin data for the second instance.  An
  94         * interspersed commit changing that would have to be
  95         * preexisting with a different ancestry and with the same
  96         * commit date in order to wedge itself between two instances
  97         * of the same commit in the priority queue _and_ produce
  98         * blame entries relevant for it.  While we don't want to let
  99         * us get tripped up by this case, it certainly does not seem
 100         * worth optimizing for.
 101         */
 102        struct blame_origin *next;
 103        struct commit *commit;
 104        /* `suspects' contains blame entries that may be attributed to
 105         * this origin's commit or to parent commits.  When a commit
 106         * is being processed, all suspects will be moved, either by
 107         * assigning them to an origin in a different commit, or by
 108         * shipping them to the scoreboard's ent list because they
 109         * cannot be attributed to a different commit.
 110         */
 111        struct blame_entry *suspects;
 112        mmfile_t file;
 113        struct object_id blob_oid;
 114        unsigned mode;
 115        /* guilty gets set when shipping any suspects to the final
 116         * blame list instead of other commits
 117         */
 118        char guilty;
 119        char path[FLEX_ARRAY];
 120};
 121
 122struct progress_info {
 123        struct progress *progress;
 124        int blamed_lines;
 125};
 126
 127static int diff_hunks(mmfile_t *file_a, mmfile_t *file_b,
 128                      xdl_emit_hunk_consume_func_t hunk_func, void *cb_data, int xdl_opts)
 129{
 130        xpparam_t xpp = {0};
 131        xdemitconf_t xecfg = {0};
 132        xdemitcb_t ecb = {NULL};
 133
 134        xpp.flags = xdl_opts;
 135        xecfg.hunk_func = hunk_func;
 136        ecb.priv = cb_data;
 137        return xdi_diff(file_a, file_b, &xpp, &xecfg, &ecb);
 138}
 139
 140/*
 141 * Given an origin, prepare mmfile_t structure to be used by the
 142 * diff machinery
 143 */
 144static void fill_origin_blob(struct diff_options *opt,
 145                             struct blame_origin *o, mmfile_t *file, int *num_read_blob)
 146{
 147        if (!o->file.ptr) {
 148                enum object_type type;
 149                unsigned long file_size;
 150
 151                (*num_read_blob)++;
 152                if (DIFF_OPT_TST(opt, ALLOW_TEXTCONV) &&
 153                    textconv_object(o->path, o->mode, &o->blob_oid, 1, &file->ptr, &file_size))
 154                        ;
 155                else
 156                        file->ptr = read_sha1_file(o->blob_oid.hash, &type,
 157                                                   &file_size);
 158                file->size = file_size;
 159
 160                if (!file->ptr)
 161                        die("Cannot read blob %s for path %s",
 162                            oid_to_hex(&o->blob_oid),
 163                            o->path);
 164                o->file = *file;
 165        }
 166        else
 167                *file = o->file;
 168}
 169
 170/*
 171 * Origin is refcounted and usually we keep the blob contents to be
 172 * reused.
 173 */
 174static inline struct blame_origin *blame_origin_incref(struct blame_origin *o)
 175{
 176        if (o)
 177                o->refcnt++;
 178        return o;
 179}
 180
 181static void blame_origin_decref(struct blame_origin *o)
 182{
 183        if (o && --o->refcnt <= 0) {
 184                struct blame_origin *p, *l = NULL;
 185                if (o->previous)
 186                        blame_origin_decref(o->previous);
 187                free(o->file.ptr);
 188                /* Should be present exactly once in commit chain */
 189                for (p = o->commit->util; p; l = p, p = p->next) {
 190                        if (p == o) {
 191                                if (l)
 192                                        l->next = p->next;
 193                                else
 194                                        o->commit->util = p->next;
 195                                free(o);
 196                                return;
 197                        }
 198                }
 199                die("internal error in blame_origin_decref");
 200        }
 201}
 202
 203static void drop_origin_blob(struct blame_origin *o)
 204{
 205        if (o->file.ptr) {
 206                free(o->file.ptr);
 207                o->file.ptr = NULL;
 208        }
 209}
 210
 211/*
 212 * Each group of lines is described by a blame_entry; it can be split
 213 * as we pass blame to the parents.  They are arranged in linked lists
 214 * kept as `suspects' of some unprocessed origin, or entered (when the
 215 * blame origin has been finalized) into the scoreboard structure.
 216 * While the scoreboard structure is only sorted at the end of
 217 * processing (according to final image line number), the lists
 218 * attached to an origin are sorted by the target line number.
 219 */
 220struct blame_entry {
 221        struct blame_entry *next;
 222
 223        /* the first line of this group in the final image;
 224         * internally all line numbers are 0 based.
 225         */
 226        int lno;
 227
 228        /* how many lines this group has */
 229        int num_lines;
 230
 231        /* the commit that introduced this group into the final image */
 232        struct blame_origin *suspect;
 233
 234        /* the line number of the first line of this group in the
 235         * suspect's file; internally all line numbers are 0 based.
 236         */
 237        int s_lno;
 238
 239        /* how significant this entry is -- cached to avoid
 240         * scanning the lines over and over.
 241         */
 242        unsigned score;
 243};
 244
 245/*
 246 * Any merge of blames happens on lists of blames that arrived via
 247 * different parents in a single suspect.  In this case, we want to
 248 * sort according to the suspect line numbers as opposed to the final
 249 * image line numbers.  The function body is somewhat longish because
 250 * it avoids unnecessary writes.
 251 */
 252
 253static struct blame_entry *blame_merge(struct blame_entry *list1,
 254                                       struct blame_entry *list2)
 255{
 256        struct blame_entry *p1 = list1, *p2 = list2,
 257                **tail = &list1;
 258
 259        if (!p1)
 260                return p2;
 261        if (!p2)
 262                return p1;
 263
 264        if (p1->s_lno <= p2->s_lno) {
 265                do {
 266                        tail = &p1->next;
 267                        if ((p1 = *tail) == NULL) {
 268                                *tail = p2;
 269                                return list1;
 270                        }
 271                } while (p1->s_lno <= p2->s_lno);
 272        }
 273        for (;;) {
 274                *tail = p2;
 275                do {
 276                        tail = &p2->next;
 277                        if ((p2 = *tail) == NULL)  {
 278                                *tail = p1;
 279                                return list1;
 280                        }
 281                } while (p1->s_lno > p2->s_lno);
 282                *tail = p1;
 283                do {
 284                        tail = &p1->next;
 285                        if ((p1 = *tail) == NULL) {
 286                                *tail = p2;
 287                                return list1;
 288                        }
 289                } while (p1->s_lno <= p2->s_lno);
 290        }
 291}
 292
 293static void *get_next_blame(const void *p)
 294{
 295        return ((struct blame_entry *)p)->next;
 296}
 297
 298static void set_next_blame(void *p1, void *p2)
 299{
 300        ((struct blame_entry *)p1)->next = p2;
 301}
 302
 303/*
 304 * Final image line numbers are all different, so we don't need a
 305 * three-way comparison here.
 306 */
 307
 308static int compare_blame_final(const void *p1, const void *p2)
 309{
 310        return ((struct blame_entry *)p1)->lno > ((struct blame_entry *)p2)->lno
 311                ? 1 : -1;
 312}
 313
 314static int compare_blame_suspect(const void *p1, const void *p2)
 315{
 316        const struct blame_entry *s1 = p1, *s2 = p2;
 317        /*
 318         * to allow for collating suspects, we sort according to the
 319         * respective pointer value as the primary sorting criterion.
 320         * The actual relation is pretty unimportant as long as it
 321         * establishes a total order.  Comparing as integers gives us
 322         * that.
 323         */
 324        if (s1->suspect != s2->suspect)
 325                return (intptr_t)s1->suspect > (intptr_t)s2->suspect ? 1 : -1;
 326        if (s1->s_lno == s2->s_lno)
 327                return 0;
 328        return s1->s_lno > s2->s_lno ? 1 : -1;
 329}
 330
 331static int compare_commits_by_reverse_commit_date(const void *a,
 332                                                  const void *b,
 333                                                  void *c)
 334{
 335        return -compare_commits_by_commit_date(a, b, c);
 336}
 337
 338/*
 339 * The current state of the blame assignment.
 340 */
 341struct blame_scoreboard {
 342        /* the final commit (i.e. where we started digging from) */
 343        struct commit *final;
 344        /* Priority queue for commits with unassigned blame records */
 345        struct prio_queue commits;
 346        struct rev_info *revs;
 347        const char *path;
 348
 349        /*
 350         * The contents in the final image.
 351         * Used by many functions to obtain contents of the nth line,
 352         * indexed with scoreboard.lineno[blame_entry.lno].
 353         */
 354        const char *final_buf;
 355        unsigned long final_buf_size;
 356
 357        /* linked list of blames */
 358        struct blame_entry *ent;
 359
 360        /* look-up a line in the final buffer */
 361        int num_lines;
 362        int *lineno;
 363
 364        /* stats */
 365        int num_read_blob;
 366        int num_get_patch;
 367        int num_commits;
 368
 369        /*
 370         * blame for a blame_entry with score lower than these thresholds
 371         * is not passed to the parent using move/copy logic.
 372         */
 373        unsigned move_score;
 374        unsigned copy_score;
 375
 376        /* use this file's contents as the final image */
 377        const char *contents_from;
 378
 379        /* flags */
 380        int reverse;
 381        int show_root;
 382        int xdl_opts;
 383        int no_whole_file_rename;
 384        int debug;
 385
 386        /* callbacks */
 387        void(*on_sanity_fail)(struct blame_scoreboard *, int);
 388        void(*found_guilty_entry)(struct blame_entry *, void *);
 389
 390        void *found_guilty_entry_data;
 391};
 392
 393static void blame_sort_final(struct blame_scoreboard *sb)
 394{
 395        sb->ent = llist_mergesort(sb->ent, get_next_blame, set_next_blame,
 396                                  compare_blame_final);
 397}
 398
 399static void sanity_check_refcnt(struct blame_scoreboard *);
 400
 401/*
 402 * If two blame entries that are next to each other came from
 403 * contiguous lines in the same origin (i.e. <commit, path> pair),
 404 * merge them together.
 405 */
 406static void blame_coalesce(struct blame_scoreboard *sb)
 407{
 408        struct blame_entry *ent, *next;
 409
 410        for (ent = sb->ent; ent && (next = ent->next); ent = next) {
 411                if (ent->suspect == next->suspect &&
 412                    ent->s_lno + ent->num_lines == next->s_lno) {
 413                        ent->num_lines += next->num_lines;
 414                        ent->next = next->next;
 415                        blame_origin_decref(next->suspect);
 416                        free(next);
 417                        ent->score = 0;
 418                        next = ent; /* again */
 419                }
 420        }
 421
 422        if (sb->debug) /* sanity */
 423                sanity_check_refcnt(sb);
 424}
 425
 426/*
 427 * Merge the given sorted list of blames into a preexisting origin.
 428 * If there were no previous blames to that commit, it is entered into
 429 * the commit priority queue of the score board.
 430 */
 431
 432static void queue_blames(struct blame_scoreboard *sb, struct blame_origin *porigin,
 433                         struct blame_entry *sorted)
 434{
 435        if (porigin->suspects)
 436                porigin->suspects = blame_merge(porigin->suspects, sorted);
 437        else {
 438                struct blame_origin *o;
 439                for (o = porigin->commit->util; o; o = o->next) {
 440                        if (o->suspects) {
 441                                porigin->suspects = sorted;
 442                                return;
 443                        }
 444                }
 445                porigin->suspects = sorted;
 446                prio_queue_put(&sb->commits, porigin->commit);
 447        }
 448}
 449
 450/*
 451 * Given a commit and a path in it, create a new origin structure.
 452 * The callers that add blame to the scoreboard should use
 453 * get_origin() to obtain shared, refcounted copy instead of calling
 454 * this function directly.
 455 */
 456static struct blame_origin *make_origin(struct commit *commit, const char *path)
 457{
 458        struct blame_origin *o;
 459        FLEX_ALLOC_STR(o, path, path);
 460        o->commit = commit;
 461        o->refcnt = 1;
 462        o->next = commit->util;
 463        commit->util = o;
 464        return o;
 465}
 466
 467/*
 468 * Locate an existing origin or create a new one.
 469 * This moves the origin to front position in the commit util list.
 470 */
 471static struct blame_origin *get_origin(struct commit *commit, const char *path)
 472{
 473        struct blame_origin *o, *l;
 474
 475        for (o = commit->util, l = NULL; o; l = o, o = o->next) {
 476                if (!strcmp(o->path, path)) {
 477                        /* bump to front */
 478                        if (l) {
 479                                l->next = o->next;
 480                                o->next = commit->util;
 481                                commit->util = o;
 482                        }
 483                        return blame_origin_incref(o);
 484                }
 485        }
 486        return make_origin(commit, path);
 487}
 488
 489/*
 490 * Fill the blob_sha1 field of an origin if it hasn't, so that later
 491 * call to fill_origin_blob() can use it to locate the data.  blob_sha1
 492 * for an origin is also used to pass the blame for the entire file to
 493 * the parent to detect the case where a child's blob is identical to
 494 * that of its parent's.
 495 *
 496 * This also fills origin->mode for corresponding tree path.
 497 */
 498static int fill_blob_sha1_and_mode(struct blame_origin *origin)
 499{
 500        if (!is_null_oid(&origin->blob_oid))
 501                return 0;
 502        if (get_tree_entry(origin->commit->object.oid.hash,
 503                           origin->path,
 504                           origin->blob_oid.hash, &origin->mode))
 505                goto error_out;
 506        if (sha1_object_info(origin->blob_oid.hash, NULL) != OBJ_BLOB)
 507                goto error_out;
 508        return 0;
 509 error_out:
 510        oidclr(&origin->blob_oid);
 511        origin->mode = S_IFINVALID;
 512        return -1;
 513}
 514
 515/*
 516 * We have an origin -- check if the same path exists in the
 517 * parent and return an origin structure to represent it.
 518 */
 519static struct blame_origin *find_origin(struct commit *parent,
 520                                  struct blame_origin *origin)
 521{
 522        struct blame_origin *porigin;
 523        struct diff_options diff_opts;
 524        const char *paths[2];
 525
 526        /* First check any existing origins */
 527        for (porigin = parent->util; porigin; porigin = porigin->next)
 528                if (!strcmp(porigin->path, origin->path)) {
 529                        /*
 530                         * The same path between origin and its parent
 531                         * without renaming -- the most common case.
 532                         */
 533                        return blame_origin_incref (porigin);
 534                }
 535
 536        /* See if the origin->path is different between parent
 537         * and origin first.  Most of the time they are the
 538         * same and diff-tree is fairly efficient about this.
 539         */
 540        diff_setup(&diff_opts);
 541        DIFF_OPT_SET(&diff_opts, RECURSIVE);
 542        diff_opts.detect_rename = 0;
 543        diff_opts.output_format = DIFF_FORMAT_NO_OUTPUT;
 544        paths[0] = origin->path;
 545        paths[1] = NULL;
 546
 547        parse_pathspec(&diff_opts.pathspec,
 548                       PATHSPEC_ALL_MAGIC & ~PATHSPEC_LITERAL,
 549                       PATHSPEC_LITERAL_PATH, "", paths);
 550        diff_setup_done(&diff_opts);
 551
 552        if (is_null_oid(&origin->commit->object.oid))
 553                do_diff_cache(parent->tree->object.oid.hash, &diff_opts);
 554        else
 555                diff_tree_sha1(parent->tree->object.oid.hash,
 556                               origin->commit->tree->object.oid.hash,
 557                               "", &diff_opts);
 558        diffcore_std(&diff_opts);
 559
 560        if (!diff_queued_diff.nr) {
 561                /* The path is the same as parent */
 562                porigin = get_origin(parent, origin->path);
 563                oidcpy(&porigin->blob_oid, &origin->blob_oid);
 564                porigin->mode = origin->mode;
 565        } else {
 566                /*
 567                 * Since origin->path is a pathspec, if the parent
 568                 * commit had it as a directory, we will see a whole
 569                 * bunch of deletion of files in the directory that we
 570                 * do not care about.
 571                 */
 572                int i;
 573                struct diff_filepair *p = NULL;
 574                for (i = 0; i < diff_queued_diff.nr; i++) {
 575                        const char *name;
 576                        p = diff_queued_diff.queue[i];
 577                        name = p->one->path ? p->one->path : p->two->path;
 578                        if (!strcmp(name, origin->path))
 579                                break;
 580                }
 581                if (!p)
 582                        die("internal error in blame::find_origin");
 583                switch (p->status) {
 584                default:
 585                        die("internal error in blame::find_origin (%c)",
 586                            p->status);
 587                case 'M':
 588                        porigin = get_origin(parent, origin->path);
 589                        oidcpy(&porigin->blob_oid, &p->one->oid);
 590                        porigin->mode = p->one->mode;
 591                        break;
 592                case 'A':
 593                case 'T':
 594                        /* Did not exist in parent, or type changed */
 595                        break;
 596                }
 597        }
 598        diff_flush(&diff_opts);
 599        clear_pathspec(&diff_opts.pathspec);
 600        return porigin;
 601}
 602
 603/*
 604 * We have an origin -- find the path that corresponds to it in its
 605 * parent and return an origin structure to represent it.
 606 */
 607static struct blame_origin *find_rename(struct commit *parent,
 608                                  struct blame_origin *origin)
 609{
 610        struct blame_origin *porigin = NULL;
 611        struct diff_options diff_opts;
 612        int i;
 613
 614        diff_setup(&diff_opts);
 615        DIFF_OPT_SET(&diff_opts, RECURSIVE);
 616        diff_opts.detect_rename = DIFF_DETECT_RENAME;
 617        diff_opts.output_format = DIFF_FORMAT_NO_OUTPUT;
 618        diff_opts.single_follow = origin->path;
 619        diff_setup_done(&diff_opts);
 620
 621        if (is_null_oid(&origin->commit->object.oid))
 622                do_diff_cache(parent->tree->object.oid.hash, &diff_opts);
 623        else
 624                diff_tree_sha1(parent->tree->object.oid.hash,
 625                               origin->commit->tree->object.oid.hash,
 626                               "", &diff_opts);
 627        diffcore_std(&diff_opts);
 628
 629        for (i = 0; i < diff_queued_diff.nr; i++) {
 630                struct diff_filepair *p = diff_queued_diff.queue[i];
 631                if ((p->status == 'R' || p->status == 'C') &&
 632                    !strcmp(p->two->path, origin->path)) {
 633                        porigin = get_origin(parent, p->one->path);
 634                        oidcpy(&porigin->blob_oid, &p->one->oid);
 635                        porigin->mode = p->one->mode;
 636                        break;
 637                }
 638        }
 639        diff_flush(&diff_opts);
 640        clear_pathspec(&diff_opts.pathspec);
 641        return porigin;
 642}
 643
 644/*
 645 * Append a new blame entry to a given output queue.
 646 */
 647static void add_blame_entry(struct blame_entry ***queue,
 648                            const struct blame_entry *src)
 649{
 650        struct blame_entry *e = xmalloc(sizeof(*e));
 651        memcpy(e, src, sizeof(*e));
 652        blame_origin_incref(e->suspect);
 653
 654        e->next = **queue;
 655        **queue = e;
 656        *queue = &e->next;
 657}
 658
 659/*
 660 * src typically is on-stack; we want to copy the information in it to
 661 * a malloced blame_entry that gets added to the given queue.  The
 662 * origin of dst loses a refcnt.
 663 */
 664static void dup_entry(struct blame_entry ***queue,
 665                      struct blame_entry *dst, struct blame_entry *src)
 666{
 667        blame_origin_incref(src->suspect);
 668        blame_origin_decref(dst->suspect);
 669        memcpy(dst, src, sizeof(*src));
 670        dst->next = **queue;
 671        **queue = dst;
 672        *queue = &dst->next;
 673}
 674
 675static const char *blame_nth_line(struct blame_scoreboard *sb, long lno)
 676{
 677        return sb->final_buf + sb->lineno[lno];
 678}
 679
 680static const char *nth_line_cb(void *data, long lno)
 681{
 682        return blame_nth_line((struct blame_scoreboard *)data, lno);
 683}
 684
 685/*
 686 * It is known that lines between tlno to same came from parent, and e
 687 * has an overlap with that range.  it also is known that parent's
 688 * line plno corresponds to e's line tlno.
 689 *
 690 *                <---- e ----->
 691 *                   <------>
 692 *                   <------------>
 693 *             <------------>
 694 *             <------------------>
 695 *
 696 * Split e into potentially three parts; before this chunk, the chunk
 697 * to be blamed for the parent, and after that portion.
 698 */
 699static void split_overlap(struct blame_entry *split,
 700                          struct blame_entry *e,
 701                          int tlno, int plno, int same,
 702                          struct blame_origin *parent)
 703{
 704        int chunk_end_lno;
 705        memset(split, 0, sizeof(struct blame_entry [3]));
 706
 707        if (e->s_lno < tlno) {
 708                /* there is a pre-chunk part not blamed on parent */
 709                split[0].suspect = blame_origin_incref(e->suspect);
 710                split[0].lno = e->lno;
 711                split[0].s_lno = e->s_lno;
 712                split[0].num_lines = tlno - e->s_lno;
 713                split[1].lno = e->lno + tlno - e->s_lno;
 714                split[1].s_lno = plno;
 715        }
 716        else {
 717                split[1].lno = e->lno;
 718                split[1].s_lno = plno + (e->s_lno - tlno);
 719        }
 720
 721        if (same < e->s_lno + e->num_lines) {
 722                /* there is a post-chunk part not blamed on parent */
 723                split[2].suspect = blame_origin_incref(e->suspect);
 724                split[2].lno = e->lno + (same - e->s_lno);
 725                split[2].s_lno = e->s_lno + (same - e->s_lno);
 726                split[2].num_lines = e->s_lno + e->num_lines - same;
 727                chunk_end_lno = split[2].lno;
 728        }
 729        else
 730                chunk_end_lno = e->lno + e->num_lines;
 731        split[1].num_lines = chunk_end_lno - split[1].lno;
 732
 733        /*
 734         * if it turns out there is nothing to blame the parent for,
 735         * forget about the splitting.  !split[1].suspect signals this.
 736         */
 737        if (split[1].num_lines < 1)
 738                return;
 739        split[1].suspect = blame_origin_incref(parent);
 740}
 741
 742/*
 743 * split_overlap() divided an existing blame e into up to three parts
 744 * in split.  Any assigned blame is moved to queue to
 745 * reflect the split.
 746 */
 747static void split_blame(struct blame_entry ***blamed,
 748                        struct blame_entry ***unblamed,
 749                        struct blame_entry *split,
 750                        struct blame_entry *e)
 751{
 752        if (split[0].suspect && split[2].suspect) {
 753                /* The first part (reuse storage for the existing entry e) */
 754                dup_entry(unblamed, e, &split[0]);
 755
 756                /* The last part -- me */
 757                add_blame_entry(unblamed, &split[2]);
 758
 759                /* ... and the middle part -- parent */
 760                add_blame_entry(blamed, &split[1]);
 761        }
 762        else if (!split[0].suspect && !split[2].suspect)
 763                /*
 764                 * The parent covers the entire area; reuse storage for
 765                 * e and replace it with the parent.
 766                 */
 767                dup_entry(blamed, e, &split[1]);
 768        else if (split[0].suspect) {
 769                /* me and then parent */
 770                dup_entry(unblamed, e, &split[0]);
 771                add_blame_entry(blamed, &split[1]);
 772        }
 773        else {
 774                /* parent and then me */
 775                dup_entry(blamed, e, &split[1]);
 776                add_blame_entry(unblamed, &split[2]);
 777        }
 778}
 779
 780/*
 781 * After splitting the blame, the origins used by the
 782 * on-stack blame_entry should lose one refcnt each.
 783 */
 784static void decref_split(struct blame_entry *split)
 785{
 786        int i;
 787
 788        for (i = 0; i < 3; i++)
 789                blame_origin_decref(split[i].suspect);
 790}
 791
 792/*
 793 * reverse_blame reverses the list given in head, appending tail.
 794 * That allows us to build lists in reverse order, then reverse them
 795 * afterwards.  This can be faster than building the list in proper
 796 * order right away.  The reason is that building in proper order
 797 * requires writing a link in the _previous_ element, while building
 798 * in reverse order just requires placing the list head into the
 799 * _current_ element.
 800 */
 801
 802static struct blame_entry *reverse_blame(struct blame_entry *head,
 803                                         struct blame_entry *tail)
 804{
 805        while (head) {
 806                struct blame_entry *next = head->next;
 807                head->next = tail;
 808                tail = head;
 809                head = next;
 810        }
 811        return tail;
 812}
 813
 814/*
 815 * Process one hunk from the patch between the current suspect for
 816 * blame_entry e and its parent.  This first blames any unfinished
 817 * entries before the chunk (which is where target and parent start
 818 * differing) on the parent, and then splits blame entries at the
 819 * start and at the end of the difference region.  Since use of -M and
 820 * -C options may lead to overlapping/duplicate source line number
 821 * ranges, all we can rely on from sorting/merging is the order of the
 822 * first suspect line number.
 823 */
 824static void blame_chunk(struct blame_entry ***dstq, struct blame_entry ***srcq,
 825                        int tlno, int offset, int same,
 826                        struct blame_origin *parent)
 827{
 828        struct blame_entry *e = **srcq;
 829        struct blame_entry *samep = NULL, *diffp = NULL;
 830
 831        while (e && e->s_lno < tlno) {
 832                struct blame_entry *next = e->next;
 833                /*
 834                 * current record starts before differing portion.  If
 835                 * it reaches into it, we need to split it up and
 836                 * examine the second part separately.
 837                 */
 838                if (e->s_lno + e->num_lines > tlno) {
 839                        /* Move second half to a new record */
 840                        int len = tlno - e->s_lno;
 841                        struct blame_entry *n = xcalloc(1, sizeof (struct blame_entry));
 842                        n->suspect = e->suspect;
 843                        n->lno = e->lno + len;
 844                        n->s_lno = e->s_lno + len;
 845                        n->num_lines = e->num_lines - len;
 846                        e->num_lines = len;
 847                        e->score = 0;
 848                        /* Push new record to diffp */
 849                        n->next = diffp;
 850                        diffp = n;
 851                } else
 852                        blame_origin_decref(e->suspect);
 853                /* Pass blame for everything before the differing
 854                 * chunk to the parent */
 855                e->suspect = blame_origin_incref(parent);
 856                e->s_lno += offset;
 857                e->next = samep;
 858                samep = e;
 859                e = next;
 860        }
 861        /*
 862         * As we don't know how much of a common stretch after this
 863         * diff will occur, the currently blamed parts are all that we
 864         * can assign to the parent for now.
 865         */
 866
 867        if (samep) {
 868                **dstq = reverse_blame(samep, **dstq);
 869                *dstq = &samep->next;
 870        }
 871        /*
 872         * Prepend the split off portions: everything after e starts
 873         * after the blameable portion.
 874         */
 875        e = reverse_blame(diffp, e);
 876
 877        /*
 878         * Now retain records on the target while parts are different
 879         * from the parent.
 880         */
 881        samep = NULL;
 882        diffp = NULL;
 883        while (e && e->s_lno < same) {
 884                struct blame_entry *next = e->next;
 885
 886                /*
 887                 * If current record extends into sameness, need to split.
 888                 */
 889                if (e->s_lno + e->num_lines > same) {
 890                        /*
 891                         * Move second half to a new record to be
 892                         * processed by later chunks
 893                         */
 894                        int len = same - e->s_lno;
 895                        struct blame_entry *n = xcalloc(1, sizeof (struct blame_entry));
 896                        n->suspect = blame_origin_incref(e->suspect);
 897                        n->lno = e->lno + len;
 898                        n->s_lno = e->s_lno + len;
 899                        n->num_lines = e->num_lines - len;
 900                        e->num_lines = len;
 901                        e->score = 0;
 902                        /* Push new record to samep */
 903                        n->next = samep;
 904                        samep = n;
 905                }
 906                e->next = diffp;
 907                diffp = e;
 908                e = next;
 909        }
 910        **srcq = reverse_blame(diffp, reverse_blame(samep, e));
 911        /* Move across elements that are in the unblamable portion */
 912        if (diffp)
 913                *srcq = &diffp->next;
 914}
 915
 916struct blame_chunk_cb_data {
 917        struct blame_origin *parent;
 918        long offset;
 919        struct blame_entry **dstq;
 920        struct blame_entry **srcq;
 921};
 922
 923/* diff chunks are from parent to target */
 924static int blame_chunk_cb(long start_a, long count_a,
 925                          long start_b, long count_b, void *data)
 926{
 927        struct blame_chunk_cb_data *d = data;
 928        if (start_a - start_b != d->offset)
 929                die("internal error in blame::blame_chunk_cb");
 930        blame_chunk(&d->dstq, &d->srcq, start_b, start_a - start_b,
 931                    start_b + count_b, d->parent);
 932        d->offset = start_a + count_a - (start_b + count_b);
 933        return 0;
 934}
 935
 936/*
 937 * We are looking at the origin 'target' and aiming to pass blame
 938 * for the lines it is suspected to its parent.  Run diff to find
 939 * which lines came from parent and pass blame for them.
 940 */
 941static void pass_blame_to_parent(struct blame_scoreboard *sb,
 942                                 struct blame_origin *target,
 943                                 struct blame_origin *parent)
 944{
 945        mmfile_t file_p, file_o;
 946        struct blame_chunk_cb_data d;
 947        struct blame_entry *newdest = NULL;
 948
 949        if (!target->suspects)
 950                return; /* nothing remains for this target */
 951
 952        d.parent = parent;
 953        d.offset = 0;
 954        d.dstq = &newdest; d.srcq = &target->suspects;
 955
 956        fill_origin_blob(&sb->revs->diffopt, parent, &file_p, &sb->num_read_blob);
 957        fill_origin_blob(&sb->revs->diffopt, target, &file_o, &sb->num_read_blob);
 958        sb->num_get_patch++;
 959
 960        if (diff_hunks(&file_p, &file_o, blame_chunk_cb, &d, sb->xdl_opts))
 961                die("unable to generate diff (%s -> %s)",
 962                    oid_to_hex(&parent->commit->object.oid),
 963                    oid_to_hex(&target->commit->object.oid));
 964        /* The rest are the same as the parent */
 965        blame_chunk(&d.dstq, &d.srcq, INT_MAX, d.offset, INT_MAX, parent);
 966        *d.dstq = NULL;
 967        queue_blames(sb, parent, newdest);
 968
 969        return;
 970}
 971
 972/*
 973 * The lines in blame_entry after splitting blames many times can become
 974 * very small and trivial, and at some point it becomes pointless to
 975 * blame the parents.  E.g. "\t\t}\n\t}\n\n" appears everywhere in any
 976 * ordinary C program, and it is not worth to say it was copied from
 977 * totally unrelated file in the parent.
 978 *
 979 * Compute how trivial the lines in the blame_entry are.
 980 */
 981static unsigned blame_entry_score(struct blame_scoreboard *sb, struct blame_entry *e)
 982{
 983        unsigned score;
 984        const char *cp, *ep;
 985
 986        if (e->score)
 987                return e->score;
 988
 989        score = 1;
 990        cp = blame_nth_line(sb, e->lno);
 991        ep = blame_nth_line(sb, e->lno + e->num_lines);
 992        while (cp < ep) {
 993                unsigned ch = *((unsigned char *)cp);
 994                if (isalnum(ch))
 995                        score++;
 996                cp++;
 997        }
 998        e->score = score;
 999        return score;
1000}
1001
1002/*
1003 * best_so_far[] and this[] are both a split of an existing blame_entry
1004 * that passes blame to the parent.  Maintain best_so_far the best split
1005 * so far, by comparing this and best_so_far and copying this into
1006 * bst_so_far as needed.
1007 */
1008static void copy_split_if_better(struct blame_scoreboard *sb,
1009                                 struct blame_entry *best_so_far,
1010                                 struct blame_entry *this)
1011{
1012        int i;
1013
1014        if (!this[1].suspect)
1015                return;
1016        if (best_so_far[1].suspect) {
1017                if (blame_entry_score(sb, &this[1]) < blame_entry_score(sb, &best_so_far[1]))
1018                        return;
1019        }
1020
1021        for (i = 0; i < 3; i++)
1022                blame_origin_incref(this[i].suspect);
1023        decref_split(best_so_far);
1024        memcpy(best_so_far, this, sizeof(struct blame_entry [3]));
1025}
1026
1027/*
1028 * We are looking at a part of the final image represented by
1029 * ent (tlno and same are offset by ent->s_lno).
1030 * tlno is where we are looking at in the final image.
1031 * up to (but not including) same match preimage.
1032 * plno is where we are looking at in the preimage.
1033 *
1034 * <-------------- final image ---------------------->
1035 *       <------ent------>
1036 *         ^tlno ^same
1037 *    <---------preimage----->
1038 *         ^plno
1039 *
1040 * All line numbers are 0-based.
1041 */
1042static void handle_split(struct blame_scoreboard *sb,
1043                         struct blame_entry *ent,
1044                         int tlno, int plno, int same,
1045                         struct blame_origin *parent,
1046                         struct blame_entry *split)
1047{
1048        if (ent->num_lines <= tlno)
1049                return;
1050        if (tlno < same) {
1051                struct blame_entry this[3];
1052                tlno += ent->s_lno;
1053                same += ent->s_lno;
1054                split_overlap(this, ent, tlno, plno, same, parent);
1055                copy_split_if_better(sb, split, this);
1056                decref_split(this);
1057        }
1058}
1059
1060struct handle_split_cb_data {
1061        struct blame_scoreboard *sb;
1062        struct blame_entry *ent;
1063        struct blame_origin *parent;
1064        struct blame_entry *split;
1065        long plno;
1066        long tlno;
1067};
1068
1069static int handle_split_cb(long start_a, long count_a,
1070                           long start_b, long count_b, void *data)
1071{
1072        struct handle_split_cb_data *d = data;
1073        handle_split(d->sb, d->ent, d->tlno, d->plno, start_b, d->parent,
1074                     d->split);
1075        d->plno = start_a + count_a;
1076        d->tlno = start_b + count_b;
1077        return 0;
1078}
1079
1080/*
1081 * Find the lines from parent that are the same as ent so that
1082 * we can pass blames to it.  file_p has the blob contents for
1083 * the parent.
1084 */
1085static void find_copy_in_blob(struct blame_scoreboard *sb,
1086                              struct blame_entry *ent,
1087                              struct blame_origin *parent,
1088                              struct blame_entry *split,
1089                              mmfile_t *file_p)
1090{
1091        const char *cp;
1092        mmfile_t file_o;
1093        struct handle_split_cb_data d;
1094
1095        memset(&d, 0, sizeof(d));
1096        d.sb = sb; d.ent = ent; d.parent = parent; d.split = split;
1097        /*
1098         * Prepare mmfile that contains only the lines in ent.
1099         */
1100        cp = blame_nth_line(sb, ent->lno);
1101        file_o.ptr = (char *) cp;
1102        file_o.size = blame_nth_line(sb, ent->lno + ent->num_lines) - cp;
1103
1104        /*
1105         * file_o is a part of final image we are annotating.
1106         * file_p partially may match that image.
1107         */
1108        memset(split, 0, sizeof(struct blame_entry [3]));
1109        if (diff_hunks(file_p, &file_o, handle_split_cb, &d, sb->xdl_opts))
1110                die("unable to generate diff (%s)",
1111                    oid_to_hex(&parent->commit->object.oid));
1112        /* remainder, if any, all match the preimage */
1113        handle_split(sb, ent, d.tlno, d.plno, ent->num_lines, parent, split);
1114}
1115
1116/* Move all blame entries from list *source that have a score smaller
1117 * than score_min to the front of list *small.
1118 * Returns a pointer to the link pointing to the old head of the small list.
1119 */
1120
1121static struct blame_entry **filter_small(struct blame_scoreboard *sb,
1122                                         struct blame_entry **small,
1123                                         struct blame_entry **source,
1124                                         unsigned score_min)
1125{
1126        struct blame_entry *p = *source;
1127        struct blame_entry *oldsmall = *small;
1128        while (p) {
1129                if (blame_entry_score(sb, p) <= score_min) {
1130                        *small = p;
1131                        small = &p->next;
1132                        p = *small;
1133                } else {
1134                        *source = p;
1135                        source = &p->next;
1136                        p = *source;
1137                }
1138        }
1139        *small = oldsmall;
1140        *source = NULL;
1141        return small;
1142}
1143
1144/*
1145 * See if lines currently target is suspected for can be attributed to
1146 * parent.
1147 */
1148static void find_move_in_parent(struct blame_scoreboard *sb,
1149                                struct blame_entry ***blamed,
1150                                struct blame_entry **toosmall,
1151                                struct blame_origin *target,
1152                                struct blame_origin *parent)
1153{
1154        struct blame_entry *e, split[3];
1155        struct blame_entry *unblamed = target->suspects;
1156        struct blame_entry *leftover = NULL;
1157        mmfile_t file_p;
1158
1159        if (!unblamed)
1160                return; /* nothing remains for this target */
1161
1162        fill_origin_blob(&sb->revs->diffopt, parent, &file_p, &sb->num_read_blob);
1163        if (!file_p.ptr)
1164                return;
1165
1166        /* At each iteration, unblamed has a NULL-terminated list of
1167         * entries that have not yet been tested for blame.  leftover
1168         * contains the reversed list of entries that have been tested
1169         * without being assignable to the parent.
1170         */
1171        do {
1172                struct blame_entry **unblamedtail = &unblamed;
1173                struct blame_entry *next;
1174                for (e = unblamed; e; e = next) {
1175                        next = e->next;
1176                        find_copy_in_blob(sb, e, parent, split, &file_p);
1177                        if (split[1].suspect &&
1178                            sb->move_score < blame_entry_score(sb, &split[1])) {
1179                                split_blame(blamed, &unblamedtail, split, e);
1180                        } else {
1181                                e->next = leftover;
1182                                leftover = e;
1183                        }
1184                        decref_split(split);
1185                }
1186                *unblamedtail = NULL;
1187                toosmall = filter_small(sb, toosmall, &unblamed, sb->move_score);
1188        } while (unblamed);
1189        target->suspects = reverse_blame(leftover, NULL);
1190}
1191
1192struct blame_list {
1193        struct blame_entry *ent;
1194        struct blame_entry split[3];
1195};
1196
1197/*
1198 * Count the number of entries the target is suspected for,
1199 * and prepare a list of entry and the best split.
1200 */
1201static struct blame_list *setup_blame_list(struct blame_entry *unblamed,
1202                                           int *num_ents_p)
1203{
1204        struct blame_entry *e;
1205        int num_ents, i;
1206        struct blame_list *blame_list = NULL;
1207
1208        for (e = unblamed, num_ents = 0; e; e = e->next)
1209                num_ents++;
1210        if (num_ents) {
1211                blame_list = xcalloc(num_ents, sizeof(struct blame_list));
1212                for (e = unblamed, i = 0; e; e = e->next)
1213                        blame_list[i++].ent = e;
1214        }
1215        *num_ents_p = num_ents;
1216        return blame_list;
1217}
1218
1219/*
1220 * For lines target is suspected for, see if we can find code movement
1221 * across file boundary from the parent commit.  porigin is the path
1222 * in the parent we already tried.
1223 */
1224static void find_copy_in_parent(struct blame_scoreboard *sb,
1225                                struct blame_entry ***blamed,
1226                                struct blame_entry **toosmall,
1227                                struct blame_origin *target,
1228                                struct commit *parent,
1229                                struct blame_origin *porigin,
1230                                int opt)
1231{
1232        struct diff_options diff_opts;
1233        int i, j;
1234        struct blame_list *blame_list;
1235        int num_ents;
1236        struct blame_entry *unblamed = target->suspects;
1237        struct blame_entry *leftover = NULL;
1238
1239        if (!unblamed)
1240                return; /* nothing remains for this target */
1241
1242        diff_setup(&diff_opts);
1243        DIFF_OPT_SET(&diff_opts, RECURSIVE);
1244        diff_opts.output_format = DIFF_FORMAT_NO_OUTPUT;
1245
1246        diff_setup_done(&diff_opts);
1247
1248        /* Try "find copies harder" on new path if requested;
1249         * we do not want to use diffcore_rename() actually to
1250         * match things up; find_copies_harder is set only to
1251         * force diff_tree_sha1() to feed all filepairs to diff_queue,
1252         * and this code needs to be after diff_setup_done(), which
1253         * usually makes find-copies-harder imply copy detection.
1254         */
1255        if ((opt & PICKAXE_BLAME_COPY_HARDEST)
1256            || ((opt & PICKAXE_BLAME_COPY_HARDER)
1257                && (!porigin || strcmp(target->path, porigin->path))))
1258                DIFF_OPT_SET(&diff_opts, FIND_COPIES_HARDER);
1259
1260        if (is_null_oid(&target->commit->object.oid))
1261                do_diff_cache(parent->tree->object.oid.hash, &diff_opts);
1262        else
1263                diff_tree_sha1(parent->tree->object.oid.hash,
1264                               target->commit->tree->object.oid.hash,
1265                               "", &diff_opts);
1266
1267        if (!DIFF_OPT_TST(&diff_opts, FIND_COPIES_HARDER))
1268                diffcore_std(&diff_opts);
1269
1270        do {
1271                struct blame_entry **unblamedtail = &unblamed;
1272                blame_list = setup_blame_list(unblamed, &num_ents);
1273
1274                for (i = 0; i < diff_queued_diff.nr; i++) {
1275                        struct diff_filepair *p = diff_queued_diff.queue[i];
1276                        struct blame_origin *norigin;
1277                        mmfile_t file_p;
1278                        struct blame_entry this[3];
1279
1280                        if (!DIFF_FILE_VALID(p->one))
1281                                continue; /* does not exist in parent */
1282                        if (S_ISGITLINK(p->one->mode))
1283                                continue; /* ignore git links */
1284                        if (porigin && !strcmp(p->one->path, porigin->path))
1285                                /* find_move already dealt with this path */
1286                                continue;
1287
1288                        norigin = get_origin(parent, p->one->path);
1289                        oidcpy(&norigin->blob_oid, &p->one->oid);
1290                        norigin->mode = p->one->mode;
1291                        fill_origin_blob(&sb->revs->diffopt, norigin, &file_p, &sb->num_read_blob);
1292                        if (!file_p.ptr)
1293                                continue;
1294
1295                        for (j = 0; j < num_ents; j++) {
1296                                find_copy_in_blob(sb, blame_list[j].ent,
1297                                                  norigin, this, &file_p);
1298                                copy_split_if_better(sb, blame_list[j].split,
1299                                                     this);
1300                                decref_split(this);
1301                        }
1302                        blame_origin_decref(norigin);
1303                }
1304
1305                for (j = 0; j < num_ents; j++) {
1306                        struct blame_entry *split = blame_list[j].split;
1307                        if (split[1].suspect &&
1308                            sb->copy_score < blame_entry_score(sb, &split[1])) {
1309                                split_blame(blamed, &unblamedtail, split,
1310                                            blame_list[j].ent);
1311                        } else {
1312                                blame_list[j].ent->next = leftover;
1313                                leftover = blame_list[j].ent;
1314                        }
1315                        decref_split(split);
1316                }
1317                free(blame_list);
1318                *unblamedtail = NULL;
1319                toosmall = filter_small(sb, toosmall, &unblamed, sb->copy_score);
1320        } while (unblamed);
1321        target->suspects = reverse_blame(leftover, NULL);
1322        diff_flush(&diff_opts);
1323        clear_pathspec(&diff_opts.pathspec);
1324}
1325
1326/*
1327 * The blobs of origin and porigin exactly match, so everything
1328 * origin is suspected for can be blamed on the parent.
1329 */
1330static void pass_whole_blame(struct blame_scoreboard *sb,
1331                             struct blame_origin *origin, struct blame_origin *porigin)
1332{
1333        struct blame_entry *e, *suspects;
1334
1335        if (!porigin->file.ptr && origin->file.ptr) {
1336                /* Steal its file */
1337                porigin->file = origin->file;
1338                origin->file.ptr = NULL;
1339        }
1340        suspects = origin->suspects;
1341        origin->suspects = NULL;
1342        for (e = suspects; e; e = e->next) {
1343                blame_origin_incref(porigin);
1344                blame_origin_decref(e->suspect);
1345                e->suspect = porigin;
1346        }
1347        queue_blames(sb, porigin, suspects);
1348}
1349
1350/*
1351 * We pass blame from the current commit to its parents.  We keep saying
1352 * "parent" (and "porigin"), but what we mean is to find scapegoat to
1353 * exonerate ourselves.
1354 */
1355static struct commit_list *first_scapegoat(struct rev_info *revs, struct commit *commit,
1356                                           int reverse)
1357{
1358        if (!reverse) {
1359                if (revs->first_parent_only &&
1360                    commit->parents &&
1361                    commit->parents->next) {
1362                        free_commit_list(commit->parents->next);
1363                        commit->parents->next = NULL;
1364                }
1365                return commit->parents;
1366        }
1367        return lookup_decoration(&revs->children, &commit->object);
1368}
1369
1370static int num_scapegoats(struct rev_info *revs, struct commit *commit, int reverse)
1371{
1372        struct commit_list *l = first_scapegoat(revs, commit, reverse);
1373        return commit_list_count(l);
1374}
1375
1376/* Distribute collected unsorted blames to the respected sorted lists
1377 * in the various origins.
1378 */
1379static void distribute_blame(struct blame_scoreboard *sb, struct blame_entry *blamed)
1380{
1381        blamed = llist_mergesort(blamed, get_next_blame, set_next_blame,
1382                                 compare_blame_suspect);
1383        while (blamed)
1384        {
1385                struct blame_origin *porigin = blamed->suspect;
1386                struct blame_entry *suspects = NULL;
1387                do {
1388                        struct blame_entry *next = blamed->next;
1389                        blamed->next = suspects;
1390                        suspects = blamed;
1391                        blamed = next;
1392                } while (blamed && blamed->suspect == porigin);
1393                suspects = reverse_blame(suspects, NULL);
1394                queue_blames(sb, porigin, suspects);
1395        }
1396}
1397
1398#define MAXSG 16
1399
1400static void pass_blame(struct blame_scoreboard *sb, struct blame_origin *origin, int opt)
1401{
1402        struct rev_info *revs = sb->revs;
1403        int i, pass, num_sg;
1404        struct commit *commit = origin->commit;
1405        struct commit_list *sg;
1406        struct blame_origin *sg_buf[MAXSG];
1407        struct blame_origin *porigin, **sg_origin = sg_buf;
1408        struct blame_entry *toosmall = NULL;
1409        struct blame_entry *blames, **blametail = &blames;
1410
1411        num_sg = num_scapegoats(revs, commit, sb->reverse);
1412        if (!num_sg)
1413                goto finish;
1414        else if (num_sg < ARRAY_SIZE(sg_buf))
1415                memset(sg_buf, 0, sizeof(sg_buf));
1416        else
1417                sg_origin = xcalloc(num_sg, sizeof(*sg_origin));
1418
1419        /*
1420         * The first pass looks for unrenamed path to optimize for
1421         * common cases, then we look for renames in the second pass.
1422         */
1423        for (pass = 0; pass < 2 - sb->no_whole_file_rename; pass++) {
1424                struct blame_origin *(*find)(struct commit *, struct blame_origin *);
1425                find = pass ? find_rename : find_origin;
1426
1427                for (i = 0, sg = first_scapegoat(revs, commit, sb->reverse);
1428                     i < num_sg && sg;
1429                     sg = sg->next, i++) {
1430                        struct commit *p = sg->item;
1431                        int j, same;
1432
1433                        if (sg_origin[i])
1434                                continue;
1435                        if (parse_commit(p))
1436                                continue;
1437                        porigin = find(p, origin);
1438                        if (!porigin)
1439                                continue;
1440                        if (!oidcmp(&porigin->blob_oid, &origin->blob_oid)) {
1441                                pass_whole_blame(sb, origin, porigin);
1442                                blame_origin_decref(porigin);
1443                                goto finish;
1444                        }
1445                        for (j = same = 0; j < i; j++)
1446                                if (sg_origin[j] &&
1447                                    !oidcmp(&sg_origin[j]->blob_oid, &porigin->blob_oid)) {
1448                                        same = 1;
1449                                        break;
1450                                }
1451                        if (!same)
1452                                sg_origin[i] = porigin;
1453                        else
1454                                blame_origin_decref(porigin);
1455                }
1456        }
1457
1458        sb->num_commits++;
1459        for (i = 0, sg = first_scapegoat(revs, commit, sb->reverse);
1460             i < num_sg && sg;
1461             sg = sg->next, i++) {
1462                struct blame_origin *porigin = sg_origin[i];
1463                if (!porigin)
1464                        continue;
1465                if (!origin->previous) {
1466                        blame_origin_incref(porigin);
1467                        origin->previous = porigin;
1468                }
1469                pass_blame_to_parent(sb, origin, porigin);
1470                if (!origin->suspects)
1471                        goto finish;
1472        }
1473
1474        /*
1475         * Optionally find moves in parents' files.
1476         */
1477        if (opt & PICKAXE_BLAME_MOVE) {
1478                filter_small(sb, &toosmall, &origin->suspects, sb->move_score);
1479                if (origin->suspects) {
1480                        for (i = 0, sg = first_scapegoat(revs, commit, sb->reverse);
1481                             i < num_sg && sg;
1482                             sg = sg->next, i++) {
1483                                struct blame_origin *porigin = sg_origin[i];
1484                                if (!porigin)
1485                                        continue;
1486                                find_move_in_parent(sb, &blametail, &toosmall, origin, porigin);
1487                                if (!origin->suspects)
1488                                        break;
1489                        }
1490                }
1491        }
1492
1493        /*
1494         * Optionally find copies from parents' files.
1495         */
1496        if (opt & PICKAXE_BLAME_COPY) {
1497                if (sb->copy_score > sb->move_score)
1498                        filter_small(sb, &toosmall, &origin->suspects, sb->copy_score);
1499                else if (sb->copy_score < sb->move_score) {
1500                        origin->suspects = blame_merge(origin->suspects, toosmall);
1501                        toosmall = NULL;
1502                        filter_small(sb, &toosmall, &origin->suspects, sb->copy_score);
1503                }
1504                if (!origin->suspects)
1505                        goto finish;
1506
1507                for (i = 0, sg = first_scapegoat(revs, commit, sb->reverse);
1508                     i < num_sg && sg;
1509                     sg = sg->next, i++) {
1510                        struct blame_origin *porigin = sg_origin[i];
1511                        find_copy_in_parent(sb, &blametail, &toosmall,
1512                                            origin, sg->item, porigin, opt);
1513                        if (!origin->suspects)
1514                                goto finish;
1515                }
1516        }
1517
1518finish:
1519        *blametail = NULL;
1520        distribute_blame(sb, blames);
1521        /*
1522         * prepend toosmall to origin->suspects
1523         *
1524         * There is no point in sorting: this ends up on a big
1525         * unsorted list in the caller anyway.
1526         */
1527        if (toosmall) {
1528                struct blame_entry **tail = &toosmall;
1529                while (*tail)
1530                        tail = &(*tail)->next;
1531                *tail = origin->suspects;
1532                origin->suspects = toosmall;
1533        }
1534        for (i = 0; i < num_sg; i++) {
1535                if (sg_origin[i]) {
1536                        drop_origin_blob(sg_origin[i]);
1537                        blame_origin_decref(sg_origin[i]);
1538                }
1539        }
1540        drop_origin_blob(origin);
1541        if (sg_buf != sg_origin)
1542                free(sg_origin);
1543}
1544
1545/*
1546 * Information on commits, used for output.
1547 */
1548struct commit_info {
1549        struct strbuf author;
1550        struct strbuf author_mail;
1551        timestamp_t author_time;
1552        struct strbuf author_tz;
1553
1554        /* filled only when asked for details */
1555        struct strbuf committer;
1556        struct strbuf committer_mail;
1557        timestamp_t committer_time;
1558        struct strbuf committer_tz;
1559
1560        struct strbuf summary;
1561};
1562
1563/*
1564 * Parse author/committer line in the commit object buffer
1565 */
1566static void get_ac_line(const char *inbuf, const char *what,
1567        struct strbuf *name, struct strbuf *mail,
1568        timestamp_t *time, struct strbuf *tz)
1569{
1570        struct ident_split ident;
1571        size_t len, maillen, namelen;
1572        char *tmp, *endp;
1573        const char *namebuf, *mailbuf;
1574
1575        tmp = strstr(inbuf, what);
1576        if (!tmp)
1577                goto error_out;
1578        tmp += strlen(what);
1579        endp = strchr(tmp, '\n');
1580        if (!endp)
1581                len = strlen(tmp);
1582        else
1583                len = endp - tmp;
1584
1585        if (split_ident_line(&ident, tmp, len)) {
1586        error_out:
1587                /* Ugh */
1588                tmp = "(unknown)";
1589                strbuf_addstr(name, tmp);
1590                strbuf_addstr(mail, tmp);
1591                strbuf_addstr(tz, tmp);
1592                *time = 0;
1593                return;
1594        }
1595
1596        namelen = ident.name_end - ident.name_begin;
1597        namebuf = ident.name_begin;
1598
1599        maillen = ident.mail_end - ident.mail_begin;
1600        mailbuf = ident.mail_begin;
1601
1602        if (ident.date_begin && ident.date_end)
1603                *time = strtoul(ident.date_begin, NULL, 10);
1604        else
1605                *time = 0;
1606
1607        if (ident.tz_begin && ident.tz_end)
1608                strbuf_add(tz, ident.tz_begin, ident.tz_end - ident.tz_begin);
1609        else
1610                strbuf_addstr(tz, "(unknown)");
1611
1612        /*
1613         * Now, convert both name and e-mail using mailmap
1614         */
1615        map_user(&mailmap, &mailbuf, &maillen,
1616                 &namebuf, &namelen);
1617
1618        strbuf_addf(mail, "<%.*s>", (int)maillen, mailbuf);
1619        strbuf_add(name, namebuf, namelen);
1620}
1621
1622static void commit_info_init(struct commit_info *ci)
1623{
1624
1625        strbuf_init(&ci->author, 0);
1626        strbuf_init(&ci->author_mail, 0);
1627        strbuf_init(&ci->author_tz, 0);
1628        strbuf_init(&ci->committer, 0);
1629        strbuf_init(&ci->committer_mail, 0);
1630        strbuf_init(&ci->committer_tz, 0);
1631        strbuf_init(&ci->summary, 0);
1632}
1633
1634static void commit_info_destroy(struct commit_info *ci)
1635{
1636
1637        strbuf_release(&ci->author);
1638        strbuf_release(&ci->author_mail);
1639        strbuf_release(&ci->author_tz);
1640        strbuf_release(&ci->committer);
1641        strbuf_release(&ci->committer_mail);
1642        strbuf_release(&ci->committer_tz);
1643        strbuf_release(&ci->summary);
1644}
1645
1646static void get_commit_info(struct commit *commit,
1647                            struct commit_info *ret,
1648                            int detailed)
1649{
1650        int len;
1651        const char *subject, *encoding;
1652        const char *message;
1653
1654        commit_info_init(ret);
1655
1656        encoding = get_log_output_encoding();
1657        message = logmsg_reencode(commit, NULL, encoding);
1658        get_ac_line(message, "\nauthor ",
1659                    &ret->author, &ret->author_mail,
1660                    &ret->author_time, &ret->author_tz);
1661
1662        if (!detailed) {
1663                unuse_commit_buffer(commit, message);
1664                return;
1665        }
1666
1667        get_ac_line(message, "\ncommitter ",
1668                    &ret->committer, &ret->committer_mail,
1669                    &ret->committer_time, &ret->committer_tz);
1670
1671        len = find_commit_subject(message, &subject);
1672        if (len)
1673                strbuf_add(&ret->summary, subject, len);
1674        else
1675                strbuf_addf(&ret->summary, "(%s)", oid_to_hex(&commit->object.oid));
1676
1677        unuse_commit_buffer(commit, message);
1678}
1679
1680/*
1681 * Write out any suspect information which depends on the path. This must be
1682 * handled separately from emit_one_suspect_detail(), because a given commit
1683 * may have changes in multiple paths. So this needs to appear each time
1684 * we mention a new group.
1685 *
1686 * To allow LF and other nonportable characters in pathnames,
1687 * they are c-style quoted as needed.
1688 */
1689static void write_filename_info(struct blame_origin *suspect)
1690{
1691        if (suspect->previous) {
1692                struct blame_origin *prev = suspect->previous;
1693                printf("previous %s ", oid_to_hex(&prev->commit->object.oid));
1694                write_name_quoted(prev->path, stdout, '\n');
1695        }
1696        printf("filename ");
1697        write_name_quoted(suspect->path, stdout, '\n');
1698}
1699
1700/*
1701 * Porcelain/Incremental format wants to show a lot of details per
1702 * commit.  Instead of repeating this every line, emit it only once,
1703 * the first time each commit appears in the output (unless the
1704 * user has specifically asked for us to repeat).
1705 */
1706static int emit_one_suspect_detail(struct blame_origin *suspect, int repeat)
1707{
1708        struct commit_info ci;
1709
1710        if (!repeat && (suspect->commit->object.flags & METAINFO_SHOWN))
1711                return 0;
1712
1713        suspect->commit->object.flags |= METAINFO_SHOWN;
1714        get_commit_info(suspect->commit, &ci, 1);
1715        printf("author %s\n", ci.author.buf);
1716        printf("author-mail %s\n", ci.author_mail.buf);
1717        printf("author-time %"PRItime"\n", ci.author_time);
1718        printf("author-tz %s\n", ci.author_tz.buf);
1719        printf("committer %s\n", ci.committer.buf);
1720        printf("committer-mail %s\n", ci.committer_mail.buf);
1721        printf("committer-time %"PRItime"\n", ci.committer_time);
1722        printf("committer-tz %s\n", ci.committer_tz.buf);
1723        printf("summary %s\n", ci.summary.buf);
1724        if (suspect->commit->object.flags & UNINTERESTING)
1725                printf("boundary\n");
1726
1727        commit_info_destroy(&ci);
1728
1729        return 1;
1730}
1731
1732/*
1733 * The blame_entry is found to be guilty for the range.
1734 * Show it in incremental output.
1735 */
1736static void found_guilty_entry(struct blame_entry *ent, void *data)
1737{
1738        struct progress_info *pi = (struct progress_info *)data;
1739
1740        if (incremental) {
1741                struct blame_origin *suspect = ent->suspect;
1742
1743                printf("%s %d %d %d\n",
1744                       oid_to_hex(&suspect->commit->object.oid),
1745                       ent->s_lno + 1, ent->lno + 1, ent->num_lines);
1746                emit_one_suspect_detail(suspect, 0);
1747                write_filename_info(suspect);
1748                maybe_flush_or_die(stdout, "stdout");
1749        }
1750        pi->blamed_lines += ent->num_lines;
1751        display_progress(pi->progress, pi->blamed_lines);
1752}
1753
1754/*
1755 * The main loop -- while we have blobs with lines whose true origin
1756 * is still unknown, pick one blob, and allow its lines to pass blames
1757 * to its parents. */
1758static void assign_blame(struct blame_scoreboard *sb, int opt)
1759{
1760        struct rev_info *revs = sb->revs;
1761        struct commit *commit = prio_queue_get(&sb->commits);
1762
1763        while (commit) {
1764                struct blame_entry *ent;
1765                struct blame_origin *suspect = commit->util;
1766
1767                /* find one suspect to break down */
1768                while (suspect && !suspect->suspects)
1769                        suspect = suspect->next;
1770
1771                if (!suspect) {
1772                        commit = prio_queue_get(&sb->commits);
1773                        continue;
1774                }
1775
1776                assert(commit == suspect->commit);
1777
1778                /*
1779                 * We will use this suspect later in the loop,
1780                 * so hold onto it in the meantime.
1781                 */
1782                blame_origin_incref(suspect);
1783                parse_commit(commit);
1784                if (sb->reverse ||
1785                    (!(commit->object.flags & UNINTERESTING) &&
1786                     !(revs->max_age != -1 && commit->date < revs->max_age)))
1787                        pass_blame(sb, suspect, opt);
1788                else {
1789                        commit->object.flags |= UNINTERESTING;
1790                        if (commit->object.parsed)
1791                                mark_parents_uninteresting(commit);
1792                }
1793                /* treat root commit as boundary */
1794                if (!commit->parents && !sb->show_root)
1795                        commit->object.flags |= UNINTERESTING;
1796
1797                /* Take responsibility for the remaining entries */
1798                ent = suspect->suspects;
1799                if (ent) {
1800                        suspect->guilty = 1;
1801                        for (;;) {
1802                                struct blame_entry *next = ent->next;
1803                                if (sb->found_guilty_entry)
1804                                        sb->found_guilty_entry(ent, sb->found_guilty_entry_data);
1805                                if (next) {
1806                                        ent = next;
1807                                        continue;
1808                                }
1809                                ent->next = sb->ent;
1810                                sb->ent = suspect->suspects;
1811                                suspect->suspects = NULL;
1812                                break;
1813                        }
1814                }
1815                blame_origin_decref(suspect);
1816
1817                if (sb->debug) /* sanity */
1818                        sanity_check_refcnt(sb);
1819        }
1820}
1821
1822static const char *format_time(timestamp_t time, const char *tz_str,
1823                               int show_raw_time)
1824{
1825        static struct strbuf time_buf = STRBUF_INIT;
1826
1827        strbuf_reset(&time_buf);
1828        if (show_raw_time) {
1829                strbuf_addf(&time_buf, "%"PRItime" %s", time, tz_str);
1830        }
1831        else {
1832                const char *time_str;
1833                size_t time_width;
1834                int tz;
1835                tz = atoi(tz_str);
1836                time_str = show_date(time, tz, &blame_date_mode);
1837                strbuf_addstr(&time_buf, time_str);
1838                /*
1839                 * Add space paddings to time_buf to display a fixed width
1840                 * string, and use time_width for display width calibration.
1841                 */
1842                for (time_width = utf8_strwidth(time_str);
1843                     time_width < blame_date_width;
1844                     time_width++)
1845                        strbuf_addch(&time_buf, ' ');
1846        }
1847        return time_buf.buf;
1848}
1849
1850#define OUTPUT_ANNOTATE_COMPAT  001
1851#define OUTPUT_LONG_OBJECT_NAME 002
1852#define OUTPUT_RAW_TIMESTAMP    004
1853#define OUTPUT_PORCELAIN        010
1854#define OUTPUT_SHOW_NAME        020
1855#define OUTPUT_SHOW_NUMBER      040
1856#define OUTPUT_SHOW_SCORE      0100
1857#define OUTPUT_NO_AUTHOR       0200
1858#define OUTPUT_SHOW_EMAIL       0400
1859#define OUTPUT_LINE_PORCELAIN 01000
1860
1861static void emit_porcelain_details(struct blame_origin *suspect, int repeat)
1862{
1863        if (emit_one_suspect_detail(suspect, repeat) ||
1864            (suspect->commit->object.flags & MORE_THAN_ONE_PATH))
1865                write_filename_info(suspect);
1866}
1867
1868static void emit_porcelain(struct blame_scoreboard *sb, struct blame_entry *ent,
1869                           int opt)
1870{
1871        int repeat = opt & OUTPUT_LINE_PORCELAIN;
1872        int cnt;
1873        const char *cp;
1874        struct blame_origin *suspect = ent->suspect;
1875        char hex[GIT_MAX_HEXSZ + 1];
1876
1877        oid_to_hex_r(hex, &suspect->commit->object.oid);
1878        printf("%s %d %d %d\n",
1879               hex,
1880               ent->s_lno + 1,
1881               ent->lno + 1,
1882               ent->num_lines);
1883        emit_porcelain_details(suspect, repeat);
1884
1885        cp = blame_nth_line(sb, ent->lno);
1886        for (cnt = 0; cnt < ent->num_lines; cnt++) {
1887                char ch;
1888                if (cnt) {
1889                        printf("%s %d %d\n", hex,
1890                               ent->s_lno + 1 + cnt,
1891                               ent->lno + 1 + cnt);
1892                        if (repeat)
1893                                emit_porcelain_details(suspect, 1);
1894                }
1895                putchar('\t');
1896                do {
1897                        ch = *cp++;
1898                        putchar(ch);
1899                } while (ch != '\n' &&
1900                         cp < sb->final_buf + sb->final_buf_size);
1901        }
1902
1903        if (sb->final_buf_size && cp[-1] != '\n')
1904                putchar('\n');
1905}
1906
1907static void emit_other(struct blame_scoreboard *sb, struct blame_entry *ent, int opt)
1908{
1909        int cnt;
1910        const char *cp;
1911        struct blame_origin *suspect = ent->suspect;
1912        struct commit_info ci;
1913        char hex[GIT_MAX_HEXSZ + 1];
1914        int show_raw_time = !!(opt & OUTPUT_RAW_TIMESTAMP);
1915
1916        get_commit_info(suspect->commit, &ci, 1);
1917        oid_to_hex_r(hex, &suspect->commit->object.oid);
1918
1919        cp = blame_nth_line(sb, ent->lno);
1920        for (cnt = 0; cnt < ent->num_lines; cnt++) {
1921                char ch;
1922                int length = (opt & OUTPUT_LONG_OBJECT_NAME) ? GIT_SHA1_HEXSZ : abbrev;
1923
1924                if (suspect->commit->object.flags & UNINTERESTING) {
1925                        if (blank_boundary)
1926                                memset(hex, ' ', length);
1927                        else if (!(opt & OUTPUT_ANNOTATE_COMPAT)) {
1928                                length--;
1929                                putchar('^');
1930                        }
1931                }
1932
1933                printf("%.*s", length, hex);
1934                if (opt & OUTPUT_ANNOTATE_COMPAT) {
1935                        const char *name;
1936                        if (opt & OUTPUT_SHOW_EMAIL)
1937                                name = ci.author_mail.buf;
1938                        else
1939                                name = ci.author.buf;
1940                        printf("\t(%10s\t%10s\t%d)", name,
1941                               format_time(ci.author_time, ci.author_tz.buf,
1942                                           show_raw_time),
1943                               ent->lno + 1 + cnt);
1944                } else {
1945                        if (opt & OUTPUT_SHOW_SCORE)
1946                                printf(" %*d %02d",
1947                                       max_score_digits, ent->score,
1948                                       ent->suspect->refcnt);
1949                        if (opt & OUTPUT_SHOW_NAME)
1950                                printf(" %-*.*s", longest_file, longest_file,
1951                                       suspect->path);
1952                        if (opt & OUTPUT_SHOW_NUMBER)
1953                                printf(" %*d", max_orig_digits,
1954                                       ent->s_lno + 1 + cnt);
1955
1956                        if (!(opt & OUTPUT_NO_AUTHOR)) {
1957                                const char *name;
1958                                int pad;
1959                                if (opt & OUTPUT_SHOW_EMAIL)
1960                                        name = ci.author_mail.buf;
1961                                else
1962                                        name = ci.author.buf;
1963                                pad = longest_author - utf8_strwidth(name);
1964                                printf(" (%s%*s %10s",
1965                                       name, pad, "",
1966                                       format_time(ci.author_time,
1967                                                   ci.author_tz.buf,
1968                                                   show_raw_time));
1969                        }
1970                        printf(" %*d) ",
1971                               max_digits, ent->lno + 1 + cnt);
1972                }
1973                do {
1974                        ch = *cp++;
1975                        putchar(ch);
1976                } while (ch != '\n' &&
1977                         cp < sb->final_buf + sb->final_buf_size);
1978        }
1979
1980        if (sb->final_buf_size && cp[-1] != '\n')
1981                putchar('\n');
1982
1983        commit_info_destroy(&ci);
1984}
1985
1986static void output(struct blame_scoreboard *sb, int option)
1987{
1988        struct blame_entry *ent;
1989
1990        if (option & OUTPUT_PORCELAIN) {
1991                for (ent = sb->ent; ent; ent = ent->next) {
1992                        int count = 0;
1993                        struct blame_origin *suspect;
1994                        struct commit *commit = ent->suspect->commit;
1995                        if (commit->object.flags & MORE_THAN_ONE_PATH)
1996                                continue;
1997                        for (suspect = commit->util; suspect; suspect = suspect->next) {
1998                                if (suspect->guilty && count++) {
1999                                        commit->object.flags |= MORE_THAN_ONE_PATH;
2000                                        break;
2001                                }
2002                        }
2003                }
2004        }
2005
2006        for (ent = sb->ent; ent; ent = ent->next) {
2007                if (option & OUTPUT_PORCELAIN)
2008                        emit_porcelain(sb, ent, option);
2009                else {
2010                        emit_other(sb, ent, option);
2011                }
2012        }
2013}
2014
2015static const char *get_next_line(const char *start, const char *end)
2016{
2017        const char *nl = memchr(start, '\n', end - start);
2018        return nl ? nl + 1 : end;
2019}
2020
2021/*
2022 * To allow quick access to the contents of nth line in the
2023 * final image, prepare an index in the scoreboard.
2024 */
2025static int prepare_lines(struct blame_scoreboard *sb)
2026{
2027        const char *buf = sb->final_buf;
2028        unsigned long len = sb->final_buf_size;
2029        const char *end = buf + len;
2030        const char *p;
2031        int *lineno;
2032        int num = 0;
2033
2034        for (p = buf; p < end; p = get_next_line(p, end))
2035                num++;
2036
2037        ALLOC_ARRAY(sb->lineno, num + 1);
2038        lineno = sb->lineno;
2039
2040        for (p = buf; p < end; p = get_next_line(p, end))
2041                *lineno++ = p - buf;
2042
2043        *lineno = len;
2044
2045        sb->num_lines = num;
2046        return sb->num_lines;
2047}
2048
2049/*
2050 * Add phony grafts for use with -S; this is primarily to
2051 * support git's cvsserver that wants to give a linear history
2052 * to its clients.
2053 */
2054static int read_ancestry(const char *graft_file)
2055{
2056        FILE *fp = fopen(graft_file, "r");
2057        struct strbuf buf = STRBUF_INIT;
2058        if (!fp)
2059                return -1;
2060        while (!strbuf_getwholeline(&buf, fp, '\n')) {
2061                /* The format is just "Commit Parent1 Parent2 ...\n" */
2062                struct commit_graft *graft = read_graft_line(buf.buf, buf.len);
2063                if (graft)
2064                        register_commit_graft(graft, 0);
2065        }
2066        fclose(fp);
2067        strbuf_release(&buf);
2068        return 0;
2069}
2070
2071static int update_auto_abbrev(int auto_abbrev, struct blame_origin *suspect)
2072{
2073        const char *uniq = find_unique_abbrev(suspect->commit->object.oid.hash,
2074                                              auto_abbrev);
2075        int len = strlen(uniq);
2076        if (auto_abbrev < len)
2077                return len;
2078        return auto_abbrev;
2079}
2080
2081/*
2082 * How many columns do we need to show line numbers, authors,
2083 * and filenames?
2084 */
2085static void find_alignment(struct blame_scoreboard *sb, int *option)
2086{
2087        int longest_src_lines = 0;
2088        int longest_dst_lines = 0;
2089        unsigned largest_score = 0;
2090        struct blame_entry *e;
2091        int compute_auto_abbrev = (abbrev < 0);
2092        int auto_abbrev = DEFAULT_ABBREV;
2093
2094        for (e = sb->ent; e; e = e->next) {
2095                struct blame_origin *suspect = e->suspect;
2096                int num;
2097
2098                if (compute_auto_abbrev)
2099                        auto_abbrev = update_auto_abbrev(auto_abbrev, suspect);
2100                if (strcmp(suspect->path, sb->path))
2101                        *option |= OUTPUT_SHOW_NAME;
2102                num = strlen(suspect->path);
2103                if (longest_file < num)
2104                        longest_file = num;
2105                if (!(suspect->commit->object.flags & METAINFO_SHOWN)) {
2106                        struct commit_info ci;
2107                        suspect->commit->object.flags |= METAINFO_SHOWN;
2108                        get_commit_info(suspect->commit, &ci, 1);
2109                        if (*option & OUTPUT_SHOW_EMAIL)
2110                                num = utf8_strwidth(ci.author_mail.buf);
2111                        else
2112                                num = utf8_strwidth(ci.author.buf);
2113                        if (longest_author < num)
2114                                longest_author = num;
2115                        commit_info_destroy(&ci);
2116                }
2117                num = e->s_lno + e->num_lines;
2118                if (longest_src_lines < num)
2119                        longest_src_lines = num;
2120                num = e->lno + e->num_lines;
2121                if (longest_dst_lines < num)
2122                        longest_dst_lines = num;
2123                if (largest_score < blame_entry_score(sb, e))
2124                        largest_score = blame_entry_score(sb, e);
2125        }
2126        max_orig_digits = decimal_width(longest_src_lines);
2127        max_digits = decimal_width(longest_dst_lines);
2128        max_score_digits = decimal_width(largest_score);
2129
2130        if (compute_auto_abbrev)
2131                /* one more abbrev length is needed for the boundary commit */
2132                abbrev = auto_abbrev + 1;
2133}
2134
2135/*
2136 * For debugging -- origin is refcounted, and this asserts that
2137 * we do not underflow.
2138 */
2139static void sanity_check_refcnt(struct blame_scoreboard *sb)
2140{
2141        int baa = 0;
2142        struct blame_entry *ent;
2143
2144        for (ent = sb->ent; ent; ent = ent->next) {
2145                /* Nobody should have zero or negative refcnt */
2146                if (ent->suspect->refcnt <= 0) {
2147                        fprintf(stderr, "%s in %s has negative refcnt %d\n",
2148                                ent->suspect->path,
2149                                oid_to_hex(&ent->suspect->commit->object.oid),
2150                                ent->suspect->refcnt);
2151                        baa = 1;
2152                }
2153        }
2154        if (baa)
2155                sb->on_sanity_fail(sb, baa);
2156}
2157
2158static void sanity_check_on_fail(struct blame_scoreboard *sb, int baa)
2159{
2160        int opt = OUTPUT_SHOW_SCORE | OUTPUT_SHOW_NUMBER | OUTPUT_SHOW_NAME;
2161        find_alignment(sb, &opt);
2162        output(sb, opt);
2163        die("Baa %d!", baa);
2164}
2165
2166static unsigned parse_score(const char *arg)
2167{
2168        char *end;
2169        unsigned long score = strtoul(arg, &end, 10);
2170        if (*end)
2171                return 0;
2172        return score;
2173}
2174
2175static const char *add_prefix(const char *prefix, const char *path)
2176{
2177        return prefix_path(prefix, prefix ? strlen(prefix) : 0, path);
2178}
2179
2180static int git_blame_config(const char *var, const char *value, void *cb)
2181{
2182        if (!strcmp(var, "blame.showroot")) {
2183                show_root = git_config_bool(var, value);
2184                return 0;
2185        }
2186        if (!strcmp(var, "blame.blankboundary")) {
2187                blank_boundary = git_config_bool(var, value);
2188                return 0;
2189        }
2190        if (!strcmp(var, "blame.showemail")) {
2191                int *output_option = cb;
2192                if (git_config_bool(var, value))
2193                        *output_option |= OUTPUT_SHOW_EMAIL;
2194                else
2195                        *output_option &= ~OUTPUT_SHOW_EMAIL;
2196                return 0;
2197        }
2198        if (!strcmp(var, "blame.date")) {
2199                if (!value)
2200                        return config_error_nonbool(var);
2201                parse_date_format(value, &blame_date_mode);
2202                return 0;
2203        }
2204
2205        if (git_diff_heuristic_config(var, value, cb) < 0)
2206                return -1;
2207        if (userdiff_config(var, value) < 0)
2208                return -1;
2209
2210        return git_default_config(var, value, cb);
2211}
2212
2213static void verify_working_tree_path(struct commit *work_tree, const char *path)
2214{
2215        struct commit_list *parents;
2216        int pos;
2217
2218        for (parents = work_tree->parents; parents; parents = parents->next) {
2219                const struct object_id *commit_oid = &parents->item->object.oid;
2220                struct object_id blob_oid;
2221                unsigned mode;
2222
2223                if (!get_tree_entry(commit_oid->hash, path, blob_oid.hash, &mode) &&
2224                    sha1_object_info(blob_oid.hash, NULL) == OBJ_BLOB)
2225                        return;
2226        }
2227
2228        pos = cache_name_pos(path, strlen(path));
2229        if (pos >= 0)
2230                ; /* path is in the index */
2231        else if (-1 - pos < active_nr &&
2232                 !strcmp(active_cache[-1 - pos]->name, path))
2233                ; /* path is in the index, unmerged */
2234        else
2235                die("no such path '%s' in HEAD", path);
2236}
2237
2238static struct commit_list **append_parent(struct commit_list **tail, const struct object_id *oid)
2239{
2240        struct commit *parent;
2241
2242        parent = lookup_commit_reference(oid->hash);
2243        if (!parent)
2244                die("no such commit %s", oid_to_hex(oid));
2245        return &commit_list_insert(parent, tail)->next;
2246}
2247
2248static void append_merge_parents(struct commit_list **tail)
2249{
2250        int merge_head;
2251        struct strbuf line = STRBUF_INIT;
2252
2253        merge_head = open(git_path_merge_head(), O_RDONLY);
2254        if (merge_head < 0) {
2255                if (errno == ENOENT)
2256                        return;
2257                die("cannot open '%s' for reading", git_path_merge_head());
2258        }
2259
2260        while (!strbuf_getwholeline_fd(&line, merge_head, '\n')) {
2261                struct object_id oid;
2262                if (line.len < GIT_SHA1_HEXSZ || get_oid_hex(line.buf, &oid))
2263                        die("unknown line in '%s': %s", git_path_merge_head(), line.buf);
2264                tail = append_parent(tail, &oid);
2265        }
2266        close(merge_head);
2267        strbuf_release(&line);
2268}
2269
2270/*
2271 * This isn't as simple as passing sb->buf and sb->len, because we
2272 * want to transfer ownership of the buffer to the commit (so we
2273 * must use detach).
2274 */
2275static void set_commit_buffer_from_strbuf(struct commit *c, struct strbuf *sb)
2276{
2277        size_t len;
2278        void *buf = strbuf_detach(sb, &len);
2279        set_commit_buffer(c, buf, len);
2280}
2281
2282/*
2283 * Prepare a dummy commit that represents the work tree (or staged) item.
2284 * Note that annotating work tree item never works in the reverse.
2285 */
2286static struct commit *fake_working_tree_commit(struct diff_options *opt,
2287                                               const char *path,
2288                                               const char *contents_from)
2289{
2290        struct commit *commit;
2291        struct blame_origin *origin;
2292        struct commit_list **parent_tail, *parent;
2293        struct object_id head_oid;
2294        struct strbuf buf = STRBUF_INIT;
2295        const char *ident;
2296        time_t now;
2297        int size, len;
2298        struct cache_entry *ce;
2299        unsigned mode;
2300        struct strbuf msg = STRBUF_INIT;
2301
2302        read_cache();
2303        time(&now);
2304        commit = alloc_commit_node();
2305        commit->object.parsed = 1;
2306        commit->date = now;
2307        parent_tail = &commit->parents;
2308
2309        if (!resolve_ref_unsafe("HEAD", RESOLVE_REF_READING, head_oid.hash, NULL))
2310                die("no such ref: HEAD");
2311
2312        parent_tail = append_parent(parent_tail, &head_oid);
2313        append_merge_parents(parent_tail);
2314        verify_working_tree_path(commit, path);
2315
2316        origin = make_origin(commit, path);
2317
2318        ident = fmt_ident("Not Committed Yet", "not.committed.yet", NULL, 0);
2319        strbuf_addstr(&msg, "tree 0000000000000000000000000000000000000000\n");
2320        for (parent = commit->parents; parent; parent = parent->next)
2321                strbuf_addf(&msg, "parent %s\n",
2322                            oid_to_hex(&parent->item->object.oid));
2323        strbuf_addf(&msg,
2324                    "author %s\n"
2325                    "committer %s\n\n"
2326                    "Version of %s from %s\n",
2327                    ident, ident, path,
2328                    (!contents_from ? path :
2329                     (!strcmp(contents_from, "-") ? "standard input" : contents_from)));
2330        set_commit_buffer_from_strbuf(commit, &msg);
2331
2332        if (!contents_from || strcmp("-", contents_from)) {
2333                struct stat st;
2334                const char *read_from;
2335                char *buf_ptr;
2336                unsigned long buf_len;
2337
2338                if (contents_from) {
2339                        if (stat(contents_from, &st) < 0)
2340                                die_errno("Cannot stat '%s'", contents_from);
2341                        read_from = contents_from;
2342                }
2343                else {
2344                        if (lstat(path, &st) < 0)
2345                                die_errno("Cannot lstat '%s'", path);
2346                        read_from = path;
2347                }
2348                mode = canon_mode(st.st_mode);
2349
2350                switch (st.st_mode & S_IFMT) {
2351                case S_IFREG:
2352                        if (DIFF_OPT_TST(opt, ALLOW_TEXTCONV) &&
2353                            textconv_object(read_from, mode, &null_oid, 0, &buf_ptr, &buf_len))
2354                                strbuf_attach(&buf, buf_ptr, buf_len, buf_len + 1);
2355                        else if (strbuf_read_file(&buf, read_from, st.st_size) != st.st_size)
2356                                die_errno("cannot open or read '%s'", read_from);
2357                        break;
2358                case S_IFLNK:
2359                        if (strbuf_readlink(&buf, read_from, st.st_size) < 0)
2360                                die_errno("cannot readlink '%s'", read_from);
2361                        break;
2362                default:
2363                        die("unsupported file type %s", read_from);
2364                }
2365        }
2366        else {
2367                /* Reading from stdin */
2368                mode = 0;
2369                if (strbuf_read(&buf, 0, 0) < 0)
2370                        die_errno("failed to read from stdin");
2371        }
2372        convert_to_git(path, buf.buf, buf.len, &buf, 0);
2373        origin->file.ptr = buf.buf;
2374        origin->file.size = buf.len;
2375        pretend_sha1_file(buf.buf, buf.len, OBJ_BLOB, origin->blob_oid.hash);
2376
2377        /*
2378         * Read the current index, replace the path entry with
2379         * origin->blob_sha1 without mucking with its mode or type
2380         * bits; we are not going to write this index out -- we just
2381         * want to run "diff-index --cached".
2382         */
2383        discard_cache();
2384        read_cache();
2385
2386        len = strlen(path);
2387        if (!mode) {
2388                int pos = cache_name_pos(path, len);
2389                if (0 <= pos)
2390                        mode = active_cache[pos]->ce_mode;
2391                else
2392                        /* Let's not bother reading from HEAD tree */
2393                        mode = S_IFREG | 0644;
2394        }
2395        size = cache_entry_size(len);
2396        ce = xcalloc(1, size);
2397        oidcpy(&ce->oid, &origin->blob_oid);
2398        memcpy(ce->name, path, len);
2399        ce->ce_flags = create_ce_flags(0);
2400        ce->ce_namelen = len;
2401        ce->ce_mode = create_ce_mode(mode);
2402        add_cache_entry(ce, ADD_CACHE_OK_TO_ADD|ADD_CACHE_OK_TO_REPLACE);
2403
2404        cache_tree_invalidate_path(&the_index, path);
2405
2406        return commit;
2407}
2408
2409static struct commit *find_single_final(struct rev_info *revs,
2410                                        const char **name_p)
2411{
2412        int i;
2413        struct commit *found = NULL;
2414        const char *name = NULL;
2415
2416        for (i = 0; i < revs->pending.nr; i++) {
2417                struct object *obj = revs->pending.objects[i].item;
2418                if (obj->flags & UNINTERESTING)
2419                        continue;
2420                obj = deref_tag(obj, NULL, 0);
2421                if (obj->type != OBJ_COMMIT)
2422                        die("Non commit %s?", revs->pending.objects[i].name);
2423                if (found)
2424                        die("More than one commit to dig from %s and %s?",
2425                            revs->pending.objects[i].name, name);
2426                found = (struct commit *)obj;
2427                name = revs->pending.objects[i].name;
2428        }
2429        if (name_p)
2430                *name_p = name;
2431        return found;
2432}
2433
2434static struct commit *dwim_reverse_initial(struct rev_info *revs,
2435                                           const char **name_p)
2436{
2437        /*
2438         * DWIM "git blame --reverse ONE -- PATH" as
2439         * "git blame --reverse ONE..HEAD -- PATH" but only do so
2440         * when it makes sense.
2441         */
2442        struct object *obj;
2443        struct commit *head_commit;
2444        unsigned char head_sha1[20];
2445
2446        if (revs->pending.nr != 1)
2447                return NULL;
2448
2449        /* Is that sole rev a committish? */
2450        obj = revs->pending.objects[0].item;
2451        obj = deref_tag(obj, NULL, 0);
2452        if (obj->type != OBJ_COMMIT)
2453                return NULL;
2454
2455        /* Do we have HEAD? */
2456        if (!resolve_ref_unsafe("HEAD", RESOLVE_REF_READING, head_sha1, NULL))
2457                return NULL;
2458        head_commit = lookup_commit_reference_gently(head_sha1, 1);
2459        if (!head_commit)
2460                return NULL;
2461
2462        /* Turn "ONE" into "ONE..HEAD" then */
2463        obj->flags |= UNINTERESTING;
2464        add_pending_object(revs, &head_commit->object, "HEAD");
2465
2466        if (name_p)
2467                *name_p = revs->pending.objects[0].name;
2468        return (struct commit *)obj;
2469}
2470
2471static struct commit *find_single_initial(struct rev_info *revs,
2472                                          const char **name_p)
2473{
2474        int i;
2475        const char *final_commit_name = NULL;
2476        struct commit *found = NULL;
2477
2478        /*
2479         * There must be one and only one negative commit, and it must be
2480         * the boundary.
2481         */
2482        for (i = 0; i < revs->pending.nr; i++) {
2483                struct object *obj = revs->pending.objects[i].item;
2484                if (!(obj->flags & UNINTERESTING))
2485                        continue;
2486                obj = deref_tag(obj, NULL, 0);
2487                if (obj->type != OBJ_COMMIT)
2488                        die("Non commit %s?", revs->pending.objects[i].name);
2489                if (found)
2490                        die("More than one commit to dig up from, %s and %s?",
2491                            revs->pending.objects[i].name,
2492                            final_commit_name);
2493                found = (struct commit *) obj;
2494                final_commit_name = revs->pending.objects[i].name;
2495        }
2496
2497        if (!final_commit_name)
2498                found = dwim_reverse_initial(revs, &final_commit_name);
2499        if (!final_commit_name)
2500                die("No commit to dig up from?");
2501
2502        if (name_p)
2503                *name_p = final_commit_name;
2504        return found;
2505}
2506
2507static int blame_copy_callback(const struct option *option, const char *arg, int unset)
2508{
2509        int *opt = option->value;
2510
2511        /*
2512         * -C enables copy from removed files;
2513         * -C -C enables copy from existing files, but only
2514         *       when blaming a new file;
2515         * -C -C -C enables copy from existing files for
2516         *          everybody
2517         */
2518        if (*opt & PICKAXE_BLAME_COPY_HARDER)
2519                *opt |= PICKAXE_BLAME_COPY_HARDEST;
2520        if (*opt & PICKAXE_BLAME_COPY)
2521                *opt |= PICKAXE_BLAME_COPY_HARDER;
2522        *opt |= PICKAXE_BLAME_COPY | PICKAXE_BLAME_MOVE;
2523
2524        if (arg)
2525                blame_copy_score = parse_score(arg);
2526        return 0;
2527}
2528
2529static int blame_move_callback(const struct option *option, const char *arg, int unset)
2530{
2531        int *opt = option->value;
2532
2533        *opt |= PICKAXE_BLAME_MOVE;
2534
2535        if (arg)
2536                blame_move_score = parse_score(arg);
2537        return 0;
2538}
2539
2540int cmd_blame(int argc, const char **argv, const char *prefix)
2541{
2542        struct rev_info revs;
2543        const char *path;
2544        struct blame_scoreboard sb;
2545        struct blame_origin *o;
2546        struct blame_entry *ent = NULL;
2547        long dashdash_pos, lno;
2548        const char *final_commit_name = NULL;
2549        enum object_type type;
2550        struct commit *final_commit = NULL;
2551        struct progress_info pi = { NULL, 0 };
2552
2553        struct string_list range_list = STRING_LIST_INIT_NODUP;
2554        int output_option = 0, opt = 0;
2555        int show_stats = 0;
2556        const char *revs_file = NULL;
2557        const char *contents_from = NULL;
2558        const struct option options[] = {
2559                OPT_BOOL(0, "incremental", &incremental, N_("Show blame entries as we find them, incrementally")),
2560                OPT_BOOL('b', NULL, &blank_boundary, N_("Show blank SHA-1 for boundary commits (Default: off)")),
2561                OPT_BOOL(0, "root", &show_root, N_("Do not treat root commits as boundaries (Default: off)")),
2562                OPT_BOOL(0, "show-stats", &show_stats, N_("Show work cost statistics")),
2563                OPT_BOOL(0, "progress", &show_progress, N_("Force progress reporting")),
2564                OPT_BIT(0, "score-debug", &output_option, N_("Show output score for blame entries"), OUTPUT_SHOW_SCORE),
2565                OPT_BIT('f', "show-name", &output_option, N_("Show original filename (Default: auto)"), OUTPUT_SHOW_NAME),
2566                OPT_BIT('n', "show-number", &output_option, N_("Show original linenumber (Default: off)"), OUTPUT_SHOW_NUMBER),
2567                OPT_BIT('p', "porcelain", &output_option, N_("Show in a format designed for machine consumption"), OUTPUT_PORCELAIN),
2568                OPT_BIT(0, "line-porcelain", &output_option, N_("Show porcelain format with per-line commit information"), OUTPUT_PORCELAIN|OUTPUT_LINE_PORCELAIN),
2569                OPT_BIT('c', NULL, &output_option, N_("Use the same output mode as git-annotate (Default: off)"), OUTPUT_ANNOTATE_COMPAT),
2570                OPT_BIT('t', NULL, &output_option, N_("Show raw timestamp (Default: off)"), OUTPUT_RAW_TIMESTAMP),
2571                OPT_BIT('l', NULL, &output_option, N_("Show long commit SHA1 (Default: off)"), OUTPUT_LONG_OBJECT_NAME),
2572                OPT_BIT('s', NULL, &output_option, N_("Suppress author name and timestamp (Default: off)"), OUTPUT_NO_AUTHOR),
2573                OPT_BIT('e', "show-email", &output_option, N_("Show author email instead of name (Default: off)"), OUTPUT_SHOW_EMAIL),
2574                OPT_BIT('w', NULL, &xdl_opts, N_("Ignore whitespace differences"), XDF_IGNORE_WHITESPACE),
2575
2576                /*
2577                 * The following two options are parsed by parse_revision_opt()
2578                 * and are only included here to get included in the "-h"
2579                 * output:
2580                 */
2581                { OPTION_LOWLEVEL_CALLBACK, 0, "indent-heuristic", NULL, NULL, N_("Use an experimental heuristic to improve diffs"), PARSE_OPT_NOARG, parse_opt_unknown_cb },
2582
2583                OPT_BIT(0, "minimal", &xdl_opts, N_("Spend extra cycles to find better match"), XDF_NEED_MINIMAL),
2584                OPT_STRING('S', NULL, &revs_file, N_("file"), N_("Use revisions from <file> instead of calling git-rev-list")),
2585                OPT_STRING(0, "contents", &contents_from, N_("file"), N_("Use <file>'s contents as the final image")),
2586                { OPTION_CALLBACK, 'C', NULL, &opt, N_("score"), N_("Find line copies within and across files"), PARSE_OPT_OPTARG, blame_copy_callback },
2587                { OPTION_CALLBACK, 'M', NULL, &opt, N_("score"), N_("Find line movements within and across files"), PARSE_OPT_OPTARG, blame_move_callback },
2588                OPT_STRING_LIST('L', NULL, &range_list, N_("n,m"), N_("Process only line range n,m, counting from 1")),
2589                OPT__ABBREV(&abbrev),
2590                OPT_END()
2591        };
2592
2593        struct parse_opt_ctx_t ctx;
2594        int cmd_is_annotate = !strcmp(argv[0], "annotate");
2595        struct range_set ranges;
2596        unsigned int range_i;
2597        long anchor;
2598
2599        git_config(git_blame_config, &output_option);
2600        init_revisions(&revs, NULL);
2601        revs.date_mode = blame_date_mode;
2602        DIFF_OPT_SET(&revs.diffopt, ALLOW_TEXTCONV);
2603        DIFF_OPT_SET(&revs.diffopt, FOLLOW_RENAMES);
2604
2605        save_commit_buffer = 0;
2606        dashdash_pos = 0;
2607        show_progress = -1;
2608
2609        parse_options_start(&ctx, argc, argv, prefix, options,
2610                            PARSE_OPT_KEEP_DASHDASH | PARSE_OPT_KEEP_ARGV0);
2611        for (;;) {
2612                switch (parse_options_step(&ctx, options, blame_opt_usage)) {
2613                case PARSE_OPT_HELP:
2614                        exit(129);
2615                case PARSE_OPT_DONE:
2616                        if (ctx.argv[0])
2617                                dashdash_pos = ctx.cpidx;
2618                        goto parse_done;
2619                }
2620
2621                if (!strcmp(ctx.argv[0], "--reverse")) {
2622                        ctx.argv[0] = "--children";
2623                        reverse = 1;
2624                }
2625                parse_revision_opt(&revs, &ctx, options, blame_opt_usage);
2626        }
2627parse_done:
2628        no_whole_file_rename = !DIFF_OPT_TST(&revs.diffopt, FOLLOW_RENAMES);
2629        xdl_opts |= revs.diffopt.xdl_opts & XDF_INDENT_HEURISTIC;
2630        DIFF_OPT_CLR(&revs.diffopt, FOLLOW_RENAMES);
2631        argc = parse_options_end(&ctx);
2632
2633        if (incremental || (output_option & OUTPUT_PORCELAIN)) {
2634                if (show_progress > 0)
2635                        die(_("--progress can't be used with --incremental or porcelain formats"));
2636                show_progress = 0;
2637        } else if (show_progress < 0)
2638                show_progress = isatty(2);
2639
2640        if (0 < abbrev && abbrev < GIT_SHA1_HEXSZ)
2641                /* one more abbrev length is needed for the boundary commit */
2642                abbrev++;
2643        else if (!abbrev)
2644                abbrev = GIT_SHA1_HEXSZ;
2645
2646        if (revs_file && read_ancestry(revs_file))
2647                die_errno("reading graft file '%s' failed", revs_file);
2648
2649        if (cmd_is_annotate) {
2650                output_option |= OUTPUT_ANNOTATE_COMPAT;
2651                blame_date_mode.type = DATE_ISO8601;
2652        } else {
2653                blame_date_mode = revs.date_mode;
2654        }
2655
2656        /* The maximum width used to show the dates */
2657        switch (blame_date_mode.type) {
2658        case DATE_RFC2822:
2659                blame_date_width = sizeof("Thu, 19 Oct 2006 16:00:04 -0700");
2660                break;
2661        case DATE_ISO8601_STRICT:
2662                blame_date_width = sizeof("2006-10-19T16:00:04-07:00");
2663                break;
2664        case DATE_ISO8601:
2665                blame_date_width = sizeof("2006-10-19 16:00:04 -0700");
2666                break;
2667        case DATE_RAW:
2668                blame_date_width = sizeof("1161298804 -0700");
2669                break;
2670        case DATE_UNIX:
2671                blame_date_width = sizeof("1161298804");
2672                break;
2673        case DATE_SHORT:
2674                blame_date_width = sizeof("2006-10-19");
2675                break;
2676        case DATE_RELATIVE:
2677                /* TRANSLATORS: This string is used to tell us the maximum
2678                   display width for a relative timestamp in "git blame"
2679                   output.  For C locale, "4 years, 11 months ago", which
2680                   takes 22 places, is the longest among various forms of
2681                   relative timestamps, but your language may need more or
2682                   fewer display columns. */
2683                blame_date_width = utf8_strwidth(_("4 years, 11 months ago")) + 1; /* add the null */
2684                break;
2685        case DATE_NORMAL:
2686                blame_date_width = sizeof("Thu Oct 19 16:00:04 2006 -0700");
2687                break;
2688        case DATE_STRFTIME:
2689                blame_date_width = strlen(show_date(0, 0, &blame_date_mode)) + 1; /* add the null */
2690                break;
2691        }
2692        blame_date_width -= 1; /* strip the null */
2693
2694        if (DIFF_OPT_TST(&revs.diffopt, FIND_COPIES_HARDER))
2695                opt |= (PICKAXE_BLAME_COPY | PICKAXE_BLAME_MOVE |
2696                        PICKAXE_BLAME_COPY_HARDER);
2697
2698        /*
2699         * We have collected options unknown to us in argv[1..unk]
2700         * which are to be passed to revision machinery if we are
2701         * going to do the "bottom" processing.
2702         *
2703         * The remaining are:
2704         *
2705         * (1) if dashdash_pos != 0, it is either
2706         *     "blame [revisions] -- <path>" or
2707         *     "blame -- <path> <rev>"
2708         *
2709         * (2) otherwise, it is one of the two:
2710         *     "blame [revisions] <path>"
2711         *     "blame <path> <rev>"
2712         *
2713         * Note that we must strip out <path> from the arguments: we do not
2714         * want the path pruning but we may want "bottom" processing.
2715         */
2716        if (dashdash_pos) {
2717                switch (argc - dashdash_pos - 1) {
2718                case 2: /* (1b) */
2719                        if (argc != 4)
2720                                usage_with_options(blame_opt_usage, options);
2721                        /* reorder for the new way: <rev> -- <path> */
2722                        argv[1] = argv[3];
2723                        argv[3] = argv[2];
2724                        argv[2] = "--";
2725                        /* FALLTHROUGH */
2726                case 1: /* (1a) */
2727                        path = add_prefix(prefix, argv[--argc]);
2728                        argv[argc] = NULL;
2729                        break;
2730                default:
2731                        usage_with_options(blame_opt_usage, options);
2732                }
2733        } else {
2734                if (argc < 2)
2735                        usage_with_options(blame_opt_usage, options);
2736                path = add_prefix(prefix, argv[argc - 1]);
2737                if (argc == 3 && !file_exists(path)) { /* (2b) */
2738                        path = add_prefix(prefix, argv[1]);
2739                        argv[1] = argv[2];
2740                }
2741                argv[argc - 1] = "--";
2742
2743                setup_work_tree();
2744                if (!file_exists(path))
2745                        die_errno("cannot stat path '%s'", path);
2746        }
2747
2748        revs.disable_stdin = 1;
2749        setup_revisions(argc, argv, &revs, NULL);
2750        memset(&sb, 0, sizeof(sb));
2751        sb.move_score = BLAME_DEFAULT_MOVE_SCORE;
2752        sb.copy_score = BLAME_DEFAULT_COPY_SCORE;
2753
2754        sb.revs = &revs;
2755        sb.contents_from = contents_from;
2756        sb.reverse = reverse;
2757
2758        if (!reverse) {
2759                sb.final = find_single_final(&revs, &final_commit_name);
2760                sb.commits.compare = compare_commits_by_commit_date;
2761        }
2762        else if (contents_from)
2763                die(_("--contents and --reverse do not blend well."));
2764        else {
2765                sb.final = find_single_initial(&revs, &final_commit_name);
2766                sb.commits.compare = compare_commits_by_reverse_commit_date;
2767                if (revs.first_parent_only)
2768                        revs.children.name = NULL;
2769        }
2770
2771        if (!sb.final) {
2772                /*
2773                 * "--not A B -- path" without anything positive;
2774                 * do not default to HEAD, but use the working tree
2775                 * or "--contents".
2776                 */
2777                setup_work_tree();
2778                sb.final = fake_working_tree_commit(&sb.revs->diffopt,
2779                                                    path, contents_from);
2780                add_pending_object(&revs, &(sb.final->object), ":");
2781        }
2782        else if (contents_from)
2783                die(_("cannot use --contents with final commit object name"));
2784
2785        if (reverse && revs.first_parent_only) {
2786                final_commit = find_single_final(sb.revs, NULL);
2787                if (!final_commit)
2788                        die(_("--reverse and --first-parent together require specified latest commit"));
2789        }
2790
2791        /*
2792         * If we have bottom, this will mark the ancestors of the
2793         * bottom commits we would reach while traversing as
2794         * uninteresting.
2795         */
2796        if (prepare_revision_walk(&revs))
2797                die(_("revision walk setup failed"));
2798
2799        if (reverse && revs.first_parent_only) {
2800                struct commit *c = final_commit;
2801
2802                sb.revs->children.name = "children";
2803                while (c->parents &&
2804                       oidcmp(&c->object.oid, &sb.final->object.oid)) {
2805                        struct commit_list *l = xcalloc(1, sizeof(*l));
2806
2807                        l->item = c;
2808                        if (add_decoration(&sb.revs->children,
2809                                           &c->parents->item->object, l))
2810                                die("BUG: not unique item in first-parent chain");
2811                        c = c->parents->item;
2812                }
2813
2814                if (oidcmp(&c->object.oid, &sb.final->object.oid))
2815                        die(_("--reverse --first-parent together require range along first-parent chain"));
2816        }
2817
2818        if (is_null_oid(&sb.final->object.oid)) {
2819                o = sb.final->util;
2820                sb.final_buf = xmemdupz(o->file.ptr, o->file.size);
2821                sb.final_buf_size = o->file.size;
2822        }
2823        else {
2824                o = get_origin(sb.final, path);
2825                if (fill_blob_sha1_and_mode(o))
2826                        die(_("no such path %s in %s"), path, final_commit_name);
2827
2828                if (DIFF_OPT_TST(&sb.revs->diffopt, ALLOW_TEXTCONV) &&
2829                    textconv_object(path, o->mode, &o->blob_oid, 1, (char **) &sb.final_buf,
2830                                    &sb.final_buf_size))
2831                        ;
2832                else
2833                        sb.final_buf = read_sha1_file(o->blob_oid.hash, &type,
2834                                                      &sb.final_buf_size);
2835
2836                if (!sb.final_buf)
2837                        die(_("cannot read blob %s for path %s"),
2838                            oid_to_hex(&o->blob_oid),
2839                            path);
2840        }
2841        sb.num_read_blob++;
2842        lno = prepare_lines(&sb);
2843
2844        if (lno && !range_list.nr)
2845                string_list_append(&range_list, "1");
2846
2847        anchor = 1;
2848        range_set_init(&ranges, range_list.nr);
2849        for (range_i = 0; range_i < range_list.nr; ++range_i) {
2850                long bottom, top;
2851                if (parse_range_arg(range_list.items[range_i].string,
2852                                    nth_line_cb, &sb, lno, anchor,
2853                                    &bottom, &top, sb.path))
2854                        usage(blame_usage);
2855                if (lno < top || ((lno || bottom) && lno < bottom))
2856                        die(Q_("file %s has only %lu line",
2857                               "file %s has only %lu lines",
2858                               lno), path, lno);
2859                if (bottom < 1)
2860                        bottom = 1;
2861                if (top < 1)
2862                        top = lno;
2863                bottom--;
2864                range_set_append_unsafe(&ranges, bottom, top);
2865                anchor = top + 1;
2866        }
2867        sort_and_merge_range_set(&ranges);
2868
2869        for (range_i = ranges.nr; range_i > 0; --range_i) {
2870                const struct range *r = &ranges.ranges[range_i - 1];
2871                long bottom = r->start;
2872                long top = r->end;
2873                struct blame_entry *next = ent;
2874                ent = xcalloc(1, sizeof(*ent));
2875                ent->lno = bottom;
2876                ent->num_lines = top - bottom;
2877                ent->suspect = o;
2878                ent->s_lno = bottom;
2879                ent->next = next;
2880                blame_origin_incref(o);
2881        }
2882
2883        o->suspects = ent;
2884        prio_queue_put(&sb.commits, o->commit);
2885
2886        blame_origin_decref(o);
2887
2888        range_set_release(&ranges);
2889        string_list_clear(&range_list, 0);
2890
2891        sb.ent = NULL;
2892        sb.path = path;
2893
2894        if (blame_move_score)
2895                sb.move_score = blame_move_score;
2896        if (blame_copy_score)
2897                sb.copy_score = blame_copy_score;
2898
2899        sb.debug = DEBUG;
2900        sb.on_sanity_fail = &sanity_check_on_fail;
2901
2902        sb.show_root = show_root;
2903        sb.xdl_opts = xdl_opts;
2904        sb.no_whole_file_rename = no_whole_file_rename;
2905
2906        read_mailmap(&mailmap, NULL);
2907
2908        sb.found_guilty_entry = &found_guilty_entry;
2909        sb.found_guilty_entry_data = &pi;
2910        if (show_progress)
2911                pi.progress = start_progress_delay(_("Blaming lines"),
2912                                                   sb.num_lines, 50, 1);
2913
2914        assign_blame(&sb, opt);
2915
2916        stop_progress(&pi.progress);
2917
2918        if (!incremental)
2919                setup_pager();
2920        else
2921                return 0;
2922
2923        blame_sort_final(&sb);
2924
2925        blame_coalesce(&sb);
2926
2927        if (!(output_option & OUTPUT_PORCELAIN))
2928                find_alignment(&sb, &output_option);
2929
2930        output(&sb, output_option);
2931        free((void *)sb.final_buf);
2932        for (ent = sb.ent; ent; ) {
2933                struct blame_entry *e = ent->next;
2934                free(ent);
2935                ent = e;
2936        }
2937
2938        if (show_stats) {
2939                printf("num read blob: %d\n", sb.num_read_blob);
2940                printf("num get patch: %d\n", sb.num_get_patch);
2941                printf("num commits: %d\n", sb.num_commits);
2942        }
2943        return 0;
2944}