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