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