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