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