4 * Copyright (c) 2006, Junio C Hamano
12 #include "tree-walk.h"
17 #include "xdiff-interface.h"
18 #include "cache-tree.h"
19 #include "string-list.h"
21 #include "parse-options.h"
23 static char blame_usage[] = "git blame [options] [rev-opts] [rev] [--] file";
25 static const char *blame_opt_usage[] = {
28 "[rev-opts] are documented in git-rev-list(1)",
32 static int longest_file;
33 static int longest_author;
34 static int max_orig_digits;
35 static int max_digits;
36 static int max_score_digits;
39 static int blank_boundary;
40 static int incremental;
41 static int xdl_opts = XDF_NEED_MINIMAL;
42 static struct string_list mailmap;
49 static int num_read_blob;
50 static int num_get_patch;
51 static int num_commits;
53 #define PICKAXE_BLAME_MOVE 01
54 #define PICKAXE_BLAME_COPY 02
55 #define PICKAXE_BLAME_COPY_HARDER 04
56 #define PICKAXE_BLAME_COPY_HARDEST 010
59 * blame for a blame_entry with score lower than these thresholds
60 * is not passed to the parent using move/copy logic.
62 static unsigned blame_move_score;
63 static unsigned blame_copy_score;
64 #define BLAME_DEFAULT_MOVE_SCORE 20
65 #define BLAME_DEFAULT_COPY_SCORE 40
67 /* bits #0..7 in revision.h, #8..11 used for merge_bases() in commit.c */
68 #define METAINFO_SHOWN (1u<<12)
69 #define MORE_THAN_ONE_PATH (1u<<13)
72 * One blob in a commit that is being suspected
76 struct commit *commit;
78 unsigned char blob_sha1[20];
79 char path[FLEX_ARRAY];
83 * Given an origin, prepare mmfile_t structure to be used by the
86 static void fill_origin_blob(struct origin *o, mmfile_t *file)
89 enum object_type type;
91 file->ptr = read_sha1_file(o->blob_sha1, &type,
92 (unsigned long *)(&(file->size)));
94 die("Cannot read blob %s for path %s",
95 sha1_to_hex(o->blob_sha1),
104 * Origin is refcounted and usually we keep the blob contents to be
107 static inline struct origin *origin_incref(struct origin *o)
114 static void origin_decref(struct origin *o)
116 if (o && --o->refcnt <= 0) {
122 static void drop_origin_blob(struct origin *o)
131 * Each group of lines is described by a blame_entry; it can be split
132 * as we pass blame to the parents. They form a linked list in the
133 * scoreboard structure, sorted by the target line number.
136 struct blame_entry *prev;
137 struct blame_entry *next;
139 /* the first line of this group in the final image;
140 * internally all line numbers are 0 based.
144 /* how many lines this group has */
147 /* the commit that introduced this group into the final image */
148 struct origin *suspect;
150 /* true if the suspect is truly guilty; false while we have not
151 * checked if the group came from one of its parents.
155 /* true if the entry has been scanned for copies in the current parent
159 /* the line number of the first line of this group in the
160 * suspect's file; internally all line numbers are 0 based.
164 /* how significant this entry is -- cached to avoid
165 * scanning the lines over and over.
171 * The current state of the blame assignment.
174 /* the final commit (i.e. where we started digging from) */
175 struct commit *final;
176 struct rev_info *revs;
180 * The contents in the final image.
181 * Used by many functions to obtain contents of the nth line,
182 * indexed with scoreboard.lineno[blame_entry.lno].
184 const char *final_buf;
185 unsigned long final_buf_size;
187 /* linked list of blames */
188 struct blame_entry *ent;
190 /* look-up a line in the final buffer */
195 static inline int same_suspect(struct origin *a, struct origin *b)
199 if (a->commit != b->commit)
201 return !strcmp(a->path, b->path);
204 static void sanity_check_refcnt(struct scoreboard *);
207 * If two blame entries that are next to each other came from
208 * contiguous lines in the same origin (i.e. <commit, path> pair),
209 * merge them together.
211 static void coalesce(struct scoreboard *sb)
213 struct blame_entry *ent, *next;
215 for (ent = sb->ent; ent && (next = ent->next); ent = next) {
216 if (same_suspect(ent->suspect, next->suspect) &&
217 ent->guilty == next->guilty &&
218 ent->s_lno + ent->num_lines == next->s_lno) {
219 ent->num_lines += next->num_lines;
220 ent->next = next->next;
222 ent->next->prev = ent;
223 origin_decref(next->suspect);
226 next = ent; /* again */
230 if (DEBUG) /* sanity */
231 sanity_check_refcnt(sb);
235 * Given a commit and a path in it, create a new origin structure.
236 * The callers that add blame to the scoreboard should use
237 * get_origin() to obtain shared, refcounted copy instead of calling
238 * this function directly.
240 static struct origin *make_origin(struct commit *commit, const char *path)
243 o = xcalloc(1, sizeof(*o) + strlen(path) + 1);
246 strcpy(o->path, path);
251 * Locate an existing origin or create a new one.
253 static struct origin *get_origin(struct scoreboard *sb,
254 struct commit *commit,
257 struct blame_entry *e;
259 for (e = sb->ent; e; e = e->next) {
260 if (e->suspect->commit == commit &&
261 !strcmp(e->suspect->path, path))
262 return origin_incref(e->suspect);
264 return make_origin(commit, path);
268 * Fill the blob_sha1 field of an origin if it hasn't, so that later
269 * call to fill_origin_blob() can use it to locate the data. blob_sha1
270 * for an origin is also used to pass the blame for the entire file to
271 * the parent to detect the case where a child's blob is identical to
272 * that of its parent's.
274 static int fill_blob_sha1(struct origin *origin)
278 if (!is_null_sha1(origin->blob_sha1))
280 if (get_tree_entry(origin->commit->object.sha1,
282 origin->blob_sha1, &mode))
284 if (sha1_object_info(origin->blob_sha1, NULL) != OBJ_BLOB)
288 hashclr(origin->blob_sha1);
293 * We have an origin -- check if the same path exists in the
294 * parent and return an origin structure to represent it.
296 static struct origin *find_origin(struct scoreboard *sb,
297 struct commit *parent,
298 struct origin *origin)
300 struct origin *porigin = NULL;
301 struct diff_options diff_opts;
302 const char *paths[2];
306 * Each commit object can cache one origin in that
307 * commit. This is a freestanding copy of origin and
310 struct origin *cached = parent->util;
311 if (!strcmp(cached->path, origin->path)) {
313 * The same path between origin and its parent
314 * without renaming -- the most common case.
316 porigin = get_origin(sb, parent, cached->path);
319 * If the origin was newly created (i.e. get_origin
320 * would call make_origin if none is found in the
321 * scoreboard), it does not know the blob_sha1,
322 * so copy it. Otherwise porigin was in the
323 * scoreboard and already knows blob_sha1.
325 if (porigin->refcnt == 1)
326 hashcpy(porigin->blob_sha1, cached->blob_sha1);
329 /* otherwise it was not very useful; free it */
334 /* See if the origin->path is different between parent
335 * and origin first. Most of the time they are the
336 * same and diff-tree is fairly efficient about this.
338 diff_setup(&diff_opts);
339 DIFF_OPT_SET(&diff_opts, RECURSIVE);
340 diff_opts.detect_rename = 0;
341 diff_opts.output_format = DIFF_FORMAT_NO_OUTPUT;
342 paths[0] = origin->path;
345 diff_tree_setup_paths(paths, &diff_opts);
346 if (diff_setup_done(&diff_opts) < 0)
349 if (is_null_sha1(origin->commit->object.sha1))
350 do_diff_cache(parent->tree->object.sha1, &diff_opts);
352 diff_tree_sha1(parent->tree->object.sha1,
353 origin->commit->tree->object.sha1,
355 diffcore_std(&diff_opts);
357 /* It is either one entry that says "modified", or "created",
360 if (!diff_queued_diff.nr) {
361 /* The path is the same as parent */
362 porigin = get_origin(sb, parent, origin->path);
363 hashcpy(porigin->blob_sha1, origin->blob_sha1);
365 else if (diff_queued_diff.nr != 1)
366 die("internal error in blame::find_origin");
368 struct diff_filepair *p = diff_queued_diff.queue[0];
371 die("internal error in blame::find_origin (%c)",
374 porigin = get_origin(sb, parent, origin->path);
375 hashcpy(porigin->blob_sha1, p->one->sha1);
379 /* Did not exist in parent, or type changed */
383 diff_flush(&diff_opts);
384 diff_tree_release_paths(&diff_opts);
387 * Create a freestanding copy that is not part of
388 * the refcounted origin found in the scoreboard, and
389 * cache it in the commit.
391 struct origin *cached;
393 cached = make_origin(porigin->commit, porigin->path);
394 hashcpy(cached->blob_sha1, porigin->blob_sha1);
395 parent->util = cached;
401 * We have an origin -- find the path that corresponds to it in its
402 * parent and return an origin structure to represent it.
404 static struct origin *find_rename(struct scoreboard *sb,
405 struct commit *parent,
406 struct origin *origin)
408 struct origin *porigin = NULL;
409 struct diff_options diff_opts;
411 const char *paths[2];
413 diff_setup(&diff_opts);
414 DIFF_OPT_SET(&diff_opts, RECURSIVE);
415 diff_opts.detect_rename = DIFF_DETECT_RENAME;
416 diff_opts.output_format = DIFF_FORMAT_NO_OUTPUT;
417 diff_opts.single_follow = origin->path;
419 diff_tree_setup_paths(paths, &diff_opts);
420 if (diff_setup_done(&diff_opts) < 0)
423 if (is_null_sha1(origin->commit->object.sha1))
424 do_diff_cache(parent->tree->object.sha1, &diff_opts);
426 diff_tree_sha1(parent->tree->object.sha1,
427 origin->commit->tree->object.sha1,
429 diffcore_std(&diff_opts);
431 for (i = 0; i < diff_queued_diff.nr; i++) {
432 struct diff_filepair *p = diff_queued_diff.queue[i];
433 if ((p->status == 'R' || p->status == 'C') &&
434 !strcmp(p->two->path, origin->path)) {
435 porigin = get_origin(sb, parent, p->one->path);
436 hashcpy(porigin->blob_sha1, p->one->sha1);
440 diff_flush(&diff_opts);
441 diff_tree_release_paths(&diff_opts);
446 * Parsing of patch chunks...
449 /* line number in postimage; up to but not including this
450 * line is the same as preimage
454 /* preimage line number after this chunk */
457 /* postimage line number after this chunk */
462 struct chunk *chunks;
466 struct blame_diff_state {
468 unsigned hunk_post_context;
469 unsigned hunk_in_pre_context : 1;
472 static void process_u_diff(void *state_, char *line, unsigned long len)
474 struct blame_diff_state *state = state_;
476 int off1, off2, len1, len2, num;
478 num = state->ret->num;
479 if (len < 4 || line[0] != '@' || line[1] != '@') {
480 if (state->hunk_in_pre_context && line[0] == ' ')
481 state->ret->chunks[num - 1].same++;
483 state->hunk_in_pre_context = 0;
485 state->hunk_post_context++;
487 state->hunk_post_context = 0;
492 if (num && state->hunk_post_context) {
493 chunk = &state->ret->chunks[num - 1];
494 chunk->p_next -= state->hunk_post_context;
495 chunk->t_next -= state->hunk_post_context;
497 state->ret->num = ++num;
498 state->ret->chunks = xrealloc(state->ret->chunks,
499 sizeof(struct chunk) * num);
500 chunk = &state->ret->chunks[num - 1];
501 if (parse_hunk_header(line, len, &off1, &len1, &off2, &len2)) {
506 /* Line numbers in patch output are one based. */
510 chunk->same = len2 ? off2 : (off2 + 1);
512 chunk->p_next = off1 + (len1 ? len1 : 1);
513 chunk->t_next = chunk->same + len2;
514 state->hunk_in_pre_context = 1;
515 state->hunk_post_context = 0;
518 static struct patch *compare_buffer(mmfile_t *file_p, mmfile_t *file_o,
521 struct blame_diff_state state;
526 memset(&xpp, 0, sizeof(xpp));
527 xpp.flags = xdl_opts;
528 memset(&xecfg, 0, sizeof(xecfg));
529 xecfg.ctxlen = context;
530 memset(&state, 0, sizeof(state));
531 state.ret = xmalloc(sizeof(struct patch));
532 state.ret->chunks = NULL;
535 xdi_diff_outf(file_p, file_o, process_u_diff, &state, &xpp, &xecfg, &ecb);
537 if (state.ret->num) {
539 chunk = &state.ret->chunks[state.ret->num - 1];
540 chunk->p_next -= state.hunk_post_context;
541 chunk->t_next -= state.hunk_post_context;
546 static void free_patch(struct patch *p)
553 * Link in a new blame entry to the scoreboard. Entries that cover the
554 * same line range have been removed from the scoreboard previously.
556 static void add_blame_entry(struct scoreboard *sb, struct blame_entry *e)
558 struct blame_entry *ent, *prev = NULL;
560 origin_incref(e->suspect);
562 for (ent = sb->ent; ent && ent->lno < e->lno; ent = ent->next)
565 /* prev, if not NULL, is the last one that is below e */
568 e->next = prev->next;
580 * src typically is on-stack; we want to copy the information in it to
581 * a malloced blame_entry that is already on the linked list of the
582 * scoreboard. The origin of dst loses a refcnt while the origin of src
585 static void dup_entry(struct blame_entry *dst, struct blame_entry *src)
587 struct blame_entry *p, *n;
591 origin_incref(src->suspect);
592 origin_decref(dst->suspect);
593 memcpy(dst, src, sizeof(*src));
599 static const char *nth_line(struct scoreboard *sb, int lno)
601 return sb->final_buf + sb->lineno[lno];
605 * It is known that lines between tlno to same came from parent, and e
606 * has an overlap with that range. it also is known that parent's
607 * line plno corresponds to e's line tlno.
613 * <------------------>
615 * Split e into potentially three parts; before this chunk, the chunk
616 * to be blamed for the parent, and after that portion.
618 static void split_overlap(struct blame_entry *split,
619 struct blame_entry *e,
620 int tlno, int plno, int same,
621 struct origin *parent)
624 memset(split, 0, sizeof(struct blame_entry [3]));
626 if (e->s_lno < tlno) {
627 /* there is a pre-chunk part not blamed on parent */
628 split[0].suspect = origin_incref(e->suspect);
629 split[0].lno = e->lno;
630 split[0].s_lno = e->s_lno;
631 split[0].num_lines = tlno - e->s_lno;
632 split[1].lno = e->lno + tlno - e->s_lno;
633 split[1].s_lno = plno;
636 split[1].lno = e->lno;
637 split[1].s_lno = plno + (e->s_lno - tlno);
640 if (same < e->s_lno + e->num_lines) {
641 /* there is a post-chunk part not blamed on parent */
642 split[2].suspect = origin_incref(e->suspect);
643 split[2].lno = e->lno + (same - e->s_lno);
644 split[2].s_lno = e->s_lno + (same - e->s_lno);
645 split[2].num_lines = e->s_lno + e->num_lines - same;
646 chunk_end_lno = split[2].lno;
649 chunk_end_lno = e->lno + e->num_lines;
650 split[1].num_lines = chunk_end_lno - split[1].lno;
653 * if it turns out there is nothing to blame the parent for,
654 * forget about the splitting. !split[1].suspect signals this.
656 if (split[1].num_lines < 1)
658 split[1].suspect = origin_incref(parent);
662 * split_overlap() divided an existing blame e into up to three parts
663 * in split. Adjust the linked list of blames in the scoreboard to
666 static void split_blame(struct scoreboard *sb,
667 struct blame_entry *split,
668 struct blame_entry *e)
670 struct blame_entry *new_entry;
672 if (split[0].suspect && split[2].suspect) {
673 /* The first part (reuse storage for the existing entry e) */
674 dup_entry(e, &split[0]);
676 /* The last part -- me */
677 new_entry = xmalloc(sizeof(*new_entry));
678 memcpy(new_entry, &(split[2]), sizeof(struct blame_entry));
679 add_blame_entry(sb, new_entry);
681 /* ... and the middle part -- parent */
682 new_entry = xmalloc(sizeof(*new_entry));
683 memcpy(new_entry, &(split[1]), sizeof(struct blame_entry));
684 add_blame_entry(sb, new_entry);
686 else if (!split[0].suspect && !split[2].suspect)
688 * The parent covers the entire area; reuse storage for
689 * e and replace it with the parent.
691 dup_entry(e, &split[1]);
692 else if (split[0].suspect) {
693 /* me and then parent */
694 dup_entry(e, &split[0]);
696 new_entry = xmalloc(sizeof(*new_entry));
697 memcpy(new_entry, &(split[1]), sizeof(struct blame_entry));
698 add_blame_entry(sb, new_entry);
701 /* parent and then me */
702 dup_entry(e, &split[1]);
704 new_entry = xmalloc(sizeof(*new_entry));
705 memcpy(new_entry, &(split[2]), sizeof(struct blame_entry));
706 add_blame_entry(sb, new_entry);
709 if (DEBUG) { /* sanity */
710 struct blame_entry *ent;
711 int lno = sb->ent->lno, corrupt = 0;
713 for (ent = sb->ent; ent; ent = ent->next) {
718 lno += ent->num_lines;
722 for (ent = sb->ent; ent; ent = ent->next) {
723 printf("L %8d l %8d n %8d\n",
724 lno, ent->lno, ent->num_lines);
725 lno = ent->lno + ent->num_lines;
733 * After splitting the blame, the origins used by the
734 * on-stack blame_entry should lose one refcnt each.
736 static void decref_split(struct blame_entry *split)
740 for (i = 0; i < 3; i++)
741 origin_decref(split[i].suspect);
745 * Helper for blame_chunk(). blame_entry e is known to overlap with
746 * the patch hunk; split it and pass blame to the parent.
748 static void blame_overlap(struct scoreboard *sb, struct blame_entry *e,
749 int tlno, int plno, int same,
750 struct origin *parent)
752 struct blame_entry split[3];
754 split_overlap(split, e, tlno, plno, same, parent);
755 if (split[1].suspect)
756 split_blame(sb, split, e);
761 * Find the line number of the last line the target is suspected for.
763 static int find_last_in_target(struct scoreboard *sb, struct origin *target)
765 struct blame_entry *e;
766 int last_in_target = -1;
768 for (e = sb->ent; e; e = e->next) {
769 if (e->guilty || !same_suspect(e->suspect, target))
771 if (last_in_target < e->s_lno + e->num_lines)
772 last_in_target = e->s_lno + e->num_lines;
774 return last_in_target;
778 * Process one hunk from the patch between the current suspect for
779 * blame_entry e and its parent. Find and split the overlap, and
780 * pass blame to the overlapping part to the parent.
782 static void blame_chunk(struct scoreboard *sb,
783 int tlno, int plno, int same,
784 struct origin *target, struct origin *parent)
786 struct blame_entry *e;
788 for (e = sb->ent; e; e = e->next) {
789 if (e->guilty || !same_suspect(e->suspect, target))
791 if (same <= e->s_lno)
793 if (tlno < e->s_lno + e->num_lines)
794 blame_overlap(sb, e, tlno, plno, same, parent);
799 * We are looking at the origin 'target' and aiming to pass blame
800 * for the lines it is suspected to its parent. Run diff to find
801 * which lines came from parent and pass blame for them.
803 static int pass_blame_to_parent(struct scoreboard *sb,
804 struct origin *target,
805 struct origin *parent)
807 int i, last_in_target, plno, tlno;
809 mmfile_t file_p, file_o;
811 last_in_target = find_last_in_target(sb, target);
812 if (last_in_target < 0)
813 return 1; /* nothing remains for this target */
816 * Run diff between two origins and grab the patch output, so that
817 * we can pass blame for lines origin is currently suspected for
820 fill_origin_blob(parent, &file_p);
821 fill_origin_blob(target, &file_o);
822 patch = compare_buffer(&file_p, &file_o, 0);
826 for (i = 0; i < patch->num; i++) {
827 struct chunk *chunk = &patch->chunks[i];
829 blame_chunk(sb, tlno, plno, chunk->same, target, parent);
830 plno = chunk->p_next;
831 tlno = chunk->t_next;
833 /* The rest (i.e. anything after tlno) are the same as the parent */
834 blame_chunk(sb, tlno, plno, last_in_target, target, parent);
841 * The lines in blame_entry after splitting blames many times can become
842 * very small and trivial, and at some point it becomes pointless to
843 * blame the parents. E.g. "\t\t}\n\t}\n\n" appears everywhere in any
844 * ordinary C program, and it is not worth to say it was copied from
845 * totally unrelated file in the parent.
847 * Compute how trivial the lines in the blame_entry are.
849 static unsigned ent_score(struct scoreboard *sb, struct blame_entry *e)
858 cp = nth_line(sb, e->lno);
859 ep = nth_line(sb, e->lno + e->num_lines);
861 unsigned ch = *((unsigned char *)cp);
871 * best_so_far[] and this[] are both a split of an existing blame_entry
872 * that passes blame to the parent. Maintain best_so_far the best split
873 * so far, by comparing this and best_so_far and copying this into
874 * bst_so_far as needed.
876 static void copy_split_if_better(struct scoreboard *sb,
877 struct blame_entry *best_so_far,
878 struct blame_entry *this)
882 if (!this[1].suspect)
884 if (best_so_far[1].suspect) {
885 if (ent_score(sb, &this[1]) < ent_score(sb, &best_so_far[1]))
889 for (i = 0; i < 3; i++)
890 origin_incref(this[i].suspect);
891 decref_split(best_so_far);
892 memcpy(best_so_far, this, sizeof(struct blame_entry [3]));
896 * We are looking at a part of the final image represented by
897 * ent (tlno and same are offset by ent->s_lno).
898 * tlno is where we are looking at in the final image.
899 * up to (but not including) same match preimage.
900 * plno is where we are looking at in the preimage.
902 * <-------------- final image ---------------------->
905 * <---------preimage----->
908 * All line numbers are 0-based.
910 static void handle_split(struct scoreboard *sb,
911 struct blame_entry *ent,
912 int tlno, int plno, int same,
913 struct origin *parent,
914 struct blame_entry *split)
916 if (ent->num_lines <= tlno)
919 struct blame_entry this[3];
922 split_overlap(this, ent, tlno, plno, same, parent);
923 copy_split_if_better(sb, split, this);
929 * Find the lines from parent that are the same as ent so that
930 * we can pass blames to it. file_p has the blob contents for
933 static void find_copy_in_blob(struct scoreboard *sb,
934 struct blame_entry *ent,
935 struct origin *parent,
936 struct blame_entry *split,
946 * Prepare mmfile that contains only the lines in ent.
948 cp = nth_line(sb, ent->lno);
949 file_o.ptr = (char*) cp;
950 cnt = ent->num_lines;
952 while (cnt && cp < sb->final_buf + sb->final_buf_size) {
956 file_o.size = cp - file_o.ptr;
958 patch = compare_buffer(file_p, &file_o, 1);
961 * file_o is a part of final image we are annotating.
962 * file_p partially may match that image.
964 memset(split, 0, sizeof(struct blame_entry [3]));
966 for (i = 0; i < patch->num; i++) {
967 struct chunk *chunk = &patch->chunks[i];
969 handle_split(sb, ent, tlno, plno, chunk->same, parent, split);
970 plno = chunk->p_next;
971 tlno = chunk->t_next;
973 /* remainder, if any, all match the preimage */
974 handle_split(sb, ent, tlno, plno, ent->num_lines, parent, split);
979 * See if lines currently target is suspected for can be attributed to
982 static int find_move_in_parent(struct scoreboard *sb,
983 struct origin *target,
984 struct origin *parent)
986 int last_in_target, made_progress;
987 struct blame_entry *e, split[3];
990 last_in_target = find_last_in_target(sb, target);
991 if (last_in_target < 0)
992 return 1; /* nothing remains for this target */
994 fill_origin_blob(parent, &file_p);
999 while (made_progress) {
1001 for (e = sb->ent; e; e = e->next) {
1002 if (e->guilty || !same_suspect(e->suspect, target) ||
1003 ent_score(sb, e) < blame_move_score)
1005 find_copy_in_blob(sb, e, parent, split, &file_p);
1006 if (split[1].suspect &&
1007 blame_move_score < ent_score(sb, &split[1])) {
1008 split_blame(sb, split, e);
1011 decref_split(split);
1018 struct blame_entry *ent;
1019 struct blame_entry split[3];
1023 * Count the number of entries the target is suspected for,
1024 * and prepare a list of entry and the best split.
1026 static struct blame_list *setup_blame_list(struct scoreboard *sb,
1027 struct origin *target,
1031 struct blame_entry *e;
1033 struct blame_list *blame_list = NULL;
1035 for (e = sb->ent, num_ents = 0; e; e = e->next)
1036 if (!e->scanned && !e->guilty &&
1037 same_suspect(e->suspect, target) &&
1038 min_score < ent_score(sb, e))
1041 blame_list = xcalloc(num_ents, sizeof(struct blame_list));
1042 for (e = sb->ent, i = 0; e; e = e->next)
1043 if (!e->scanned && !e->guilty &&
1044 same_suspect(e->suspect, target) &&
1045 min_score < ent_score(sb, e))
1046 blame_list[i++].ent = e;
1048 *num_ents_p = num_ents;
1053 * Reset the scanned status on all entries.
1055 static void reset_scanned_flag(struct scoreboard *sb)
1057 struct blame_entry *e;
1058 for (e = sb->ent; e; e = e->next)
1063 * For lines target is suspected for, see if we can find code movement
1064 * across file boundary from the parent commit. porigin is the path
1065 * in the parent we already tried.
1067 static int find_copy_in_parent(struct scoreboard *sb,
1068 struct origin *target,
1069 struct commit *parent,
1070 struct origin *porigin,
1073 struct diff_options diff_opts;
1074 const char *paths[1];
1077 struct blame_list *blame_list;
1080 blame_list = setup_blame_list(sb, target, blame_copy_score, &num_ents);
1082 return 1; /* nothing remains for this target */
1084 diff_setup(&diff_opts);
1085 DIFF_OPT_SET(&diff_opts, RECURSIVE);
1086 diff_opts.output_format = DIFF_FORMAT_NO_OUTPUT;
1089 diff_tree_setup_paths(paths, &diff_opts);
1090 if (diff_setup_done(&diff_opts) < 0)
1093 /* Try "find copies harder" on new path if requested;
1094 * we do not want to use diffcore_rename() actually to
1095 * match things up; find_copies_harder is set only to
1096 * force diff_tree_sha1() to feed all filepairs to diff_queue,
1097 * and this code needs to be after diff_setup_done(), which
1098 * usually makes find-copies-harder imply copy detection.
1100 if ((opt & PICKAXE_BLAME_COPY_HARDEST)
1101 || ((opt & PICKAXE_BLAME_COPY_HARDER)
1102 && (!porigin || strcmp(target->path, porigin->path))))
1103 DIFF_OPT_SET(&diff_opts, FIND_COPIES_HARDER);
1105 if (is_null_sha1(target->commit->object.sha1))
1106 do_diff_cache(parent->tree->object.sha1, &diff_opts);
1108 diff_tree_sha1(parent->tree->object.sha1,
1109 target->commit->tree->object.sha1,
1112 if (!DIFF_OPT_TST(&diff_opts, FIND_COPIES_HARDER))
1113 diffcore_std(&diff_opts);
1117 int made_progress = 0;
1119 for (i = 0; i < diff_queued_diff.nr; i++) {
1120 struct diff_filepair *p = diff_queued_diff.queue[i];
1121 struct origin *norigin;
1123 struct blame_entry this[3];
1125 if (!DIFF_FILE_VALID(p->one))
1126 continue; /* does not exist in parent */
1127 if (S_ISGITLINK(p->one->mode))
1128 continue; /* ignore git links */
1129 if (porigin && !strcmp(p->one->path, porigin->path))
1130 /* find_move already dealt with this path */
1133 norigin = get_origin(sb, parent, p->one->path);
1134 hashcpy(norigin->blob_sha1, p->one->sha1);
1135 fill_origin_blob(norigin, &file_p);
1139 for (j = 0; j < num_ents; j++) {
1140 find_copy_in_blob(sb, blame_list[j].ent,
1141 norigin, this, &file_p);
1142 copy_split_if_better(sb, blame_list[j].split,
1146 origin_decref(norigin);
1149 for (j = 0; j < num_ents; j++) {
1150 struct blame_entry *split = blame_list[j].split;
1151 if (split[1].suspect &&
1152 blame_copy_score < ent_score(sb, &split[1])) {
1153 split_blame(sb, split, blame_list[j].ent);
1157 blame_list[j].ent->scanned = 1;
1158 decref_split(split);
1164 blame_list = setup_blame_list(sb, target, blame_copy_score, &num_ents);
1170 reset_scanned_flag(sb);
1171 diff_flush(&diff_opts);
1172 diff_tree_release_paths(&diff_opts);
1177 * The blobs of origin and porigin exactly match, so everything
1178 * origin is suspected for can be blamed on the parent.
1180 static void pass_whole_blame(struct scoreboard *sb,
1181 struct origin *origin, struct origin *porigin)
1183 struct blame_entry *e;
1185 if (!porigin->file.ptr && origin->file.ptr) {
1186 /* Steal its file */
1187 porigin->file = origin->file;
1188 origin->file.ptr = NULL;
1190 for (e = sb->ent; e; e = e->next) {
1191 if (!same_suspect(e->suspect, origin))
1193 origin_incref(porigin);
1194 origin_decref(e->suspect);
1195 e->suspect = porigin;
1200 * We pass blame from the current commit to its parents. We keep saying
1201 * "parent" (and "porigin"), but what we mean is to find scapegoat to
1202 * exonerate ourselves.
1204 static struct commit_list *first_scapegoat(struct rev_info *revs, struct commit *commit)
1207 return commit->parents;
1208 return lookup_decoration(&revs->children, &commit->object);
1211 static int num_scapegoats(struct rev_info *revs, struct commit *commit)
1214 struct commit_list *l = first_scapegoat(revs, commit);
1215 for (cnt = 0; l; l = l->next)
1222 static void pass_blame(struct scoreboard *sb, struct origin *origin, int opt)
1224 struct rev_info *revs = sb->revs;
1225 int i, pass, num_sg;
1226 struct commit *commit = origin->commit;
1227 struct commit_list *sg;
1228 struct origin *sg_buf[MAXSG];
1229 struct origin *porigin, **sg_origin = sg_buf;
1231 num_sg = num_scapegoats(revs, commit);
1234 else if (num_sg < ARRAY_SIZE(sg_buf))
1235 memset(sg_buf, 0, sizeof(sg_buf));
1237 sg_origin = xcalloc(num_sg, sizeof(*sg_origin));
1240 * The first pass looks for unrenamed path to optimize for
1241 * common cases, then we look for renames in the second pass.
1243 for (pass = 0; pass < 2; pass++) {
1244 struct origin *(*find)(struct scoreboard *,
1245 struct commit *, struct origin *);
1246 find = pass ? find_rename : find_origin;
1248 for (i = 0, sg = first_scapegoat(revs, commit);
1250 sg = sg->next, i++) {
1251 struct commit *p = sg->item;
1256 if (parse_commit(p))
1258 porigin = find(sb, p, origin);
1261 if (!hashcmp(porigin->blob_sha1, origin->blob_sha1)) {
1262 pass_whole_blame(sb, origin, porigin);
1263 origin_decref(porigin);
1266 for (j = same = 0; j < i; j++)
1268 !hashcmp(sg_origin[j]->blob_sha1,
1269 porigin->blob_sha1)) {
1274 sg_origin[i] = porigin;
1276 origin_decref(porigin);
1281 for (i = 0, sg = first_scapegoat(revs, commit);
1283 sg = sg->next, i++) {
1284 struct origin *porigin = sg_origin[i];
1287 if (pass_blame_to_parent(sb, origin, porigin))
1292 * Optionally find moves in parents' files.
1294 if (opt & PICKAXE_BLAME_MOVE)
1295 for (i = 0, sg = first_scapegoat(revs, commit);
1297 sg = sg->next, i++) {
1298 struct origin *porigin = sg_origin[i];
1301 if (find_move_in_parent(sb, origin, porigin))
1306 * Optionally find copies from parents' files.
1308 if (opt & PICKAXE_BLAME_COPY)
1309 for (i = 0, sg = first_scapegoat(revs, commit);
1311 sg = sg->next, i++) {
1312 struct origin *porigin = sg_origin[i];
1313 if (find_copy_in_parent(sb, origin, sg->item,
1319 for (i = 0; i < num_sg; i++) {
1321 drop_origin_blob(sg_origin[i]);
1322 origin_decref(sg_origin[i]);
1325 drop_origin_blob(origin);
1326 if (sg_buf != sg_origin)
1331 * Information on commits, used for output.
1336 const char *author_mail;
1337 unsigned long author_time;
1338 const char *author_tz;
1340 /* filled only when asked for details */
1341 const char *committer;
1342 const char *committer_mail;
1343 unsigned long committer_time;
1344 const char *committer_tz;
1346 const char *summary;
1350 * Parse author/committer line in the commit object buffer
1352 static void get_ac_line(const char *inbuf, const char *what,
1353 int bufsz, char *person, const char **mail,
1354 unsigned long *time, const char **tz)
1356 int len, tzlen, maillen;
1357 char *tmp, *endp, *timepos;
1359 tmp = strstr(inbuf, what);
1362 tmp += strlen(what);
1363 endp = strchr(tmp, '\n');
1371 *mail = *tz = "(unknown)";
1375 memcpy(person, tmp, len);
1383 tzlen = (person+len)-(tmp+1);
1388 *time = strtoul(tmp, NULL, 10);
1396 maillen = timepos - tmp;
1402 * mailmap expansion may make the name longer.
1403 * make room by pushing stuff down.
1405 tmp = person + bufsz - (tzlen + 1);
1406 memmove(tmp, *tz, tzlen);
1410 tmp = tmp - (maillen + 1);
1411 memmove(tmp, *mail, maillen);
1416 * Now, convert e-mail using mailmap
1418 map_email(&mailmap, tmp + 1, person, tmp-person-1);
1421 static void get_commit_info(struct commit *commit,
1422 struct commit_info *ret,
1427 static char author_buf[1024];
1428 static char committer_buf[1024];
1429 static char summary_buf[1024];
1432 * We've operated without save_commit_buffer, so
1433 * we now need to populate them for output.
1435 if (!commit->buffer) {
1436 enum object_type type;
1439 read_sha1_file(commit->object.sha1, &type, &size);
1440 if (!commit->buffer)
1441 die("Cannot read commit %s",
1442 sha1_to_hex(commit->object.sha1));
1444 ret->author = author_buf;
1445 get_ac_line(commit->buffer, "\nauthor ",
1446 sizeof(author_buf), author_buf, &ret->author_mail,
1447 &ret->author_time, &ret->author_tz);
1452 ret->committer = committer_buf;
1453 get_ac_line(commit->buffer, "\ncommitter ",
1454 sizeof(committer_buf), committer_buf, &ret->committer_mail,
1455 &ret->committer_time, &ret->committer_tz);
1457 ret->summary = summary_buf;
1458 tmp = strstr(commit->buffer, "\n\n");
1461 sprintf(summary_buf, "(%s)", sha1_to_hex(commit->object.sha1));
1465 endp = strchr(tmp, '\n');
1467 endp = tmp + strlen(tmp);
1469 if (len >= sizeof(summary_buf) || len == 0)
1471 memcpy(summary_buf, tmp, len);
1472 summary_buf[len] = 0;
1476 * To allow LF and other nonportable characters in pathnames,
1477 * they are c-style quoted as needed.
1479 static void write_filename_info(const char *path)
1481 printf("filename ");
1482 write_name_quoted(path, stdout, '\n');
1486 * The blame_entry is found to be guilty for the range. Mark it
1487 * as such, and show it in incremental output.
1489 static void found_guilty_entry(struct blame_entry *ent)
1495 struct origin *suspect = ent->suspect;
1497 printf("%s %d %d %d\n",
1498 sha1_to_hex(suspect->commit->object.sha1),
1499 ent->s_lno + 1, ent->lno + 1, ent->num_lines);
1500 if (!(suspect->commit->object.flags & METAINFO_SHOWN)) {
1501 struct commit_info ci;
1502 suspect->commit->object.flags |= METAINFO_SHOWN;
1503 get_commit_info(suspect->commit, &ci, 1);
1504 printf("author %s\n", ci.author);
1505 printf("author-mail %s\n", ci.author_mail);
1506 printf("author-time %lu\n", ci.author_time);
1507 printf("author-tz %s\n", ci.author_tz);
1508 printf("committer %s\n", ci.committer);
1509 printf("committer-mail %s\n", ci.committer_mail);
1510 printf("committer-time %lu\n", ci.committer_time);
1511 printf("committer-tz %s\n", ci.committer_tz);
1512 printf("summary %s\n", ci.summary);
1513 if (suspect->commit->object.flags & UNINTERESTING)
1514 printf("boundary\n");
1516 write_filename_info(suspect->path);
1517 maybe_flush_or_die(stdout, "stdout");
1522 * The main loop -- while the scoreboard has lines whose true origin
1523 * is still unknown, pick one blame_entry, and allow its current
1524 * suspect to pass blames to its parents.
1526 static void assign_blame(struct scoreboard *sb, int opt)
1528 struct rev_info *revs = sb->revs;
1531 struct blame_entry *ent;
1532 struct commit *commit;
1533 struct origin *suspect = NULL;
1535 /* find one suspect to break down */
1536 for (ent = sb->ent; !suspect && ent; ent = ent->next)
1538 suspect = ent->suspect;
1540 return; /* all done */
1543 * We will use this suspect later in the loop,
1544 * so hold onto it in the meantime.
1546 origin_incref(suspect);
1547 commit = suspect->commit;
1548 if (!commit->object.parsed)
1549 parse_commit(commit);
1551 (!(commit->object.flags & UNINTERESTING) &&
1552 !(revs->max_age != -1 && commit->date < revs->max_age)))
1553 pass_blame(sb, suspect, opt);
1555 commit->object.flags |= UNINTERESTING;
1556 if (commit->object.parsed)
1557 mark_parents_uninteresting(commit);
1559 /* treat root commit as boundary */
1560 if (!commit->parents && !show_root)
1561 commit->object.flags |= UNINTERESTING;
1563 /* Take responsibility for the remaining entries */
1564 for (ent = sb->ent; ent; ent = ent->next)
1565 if (same_suspect(ent->suspect, suspect))
1566 found_guilty_entry(ent);
1567 origin_decref(suspect);
1569 if (DEBUG) /* sanity */
1570 sanity_check_refcnt(sb);
1574 static const char *format_time(unsigned long time, const char *tz_str,
1577 static char time_buf[128];
1582 if (show_raw_time) {
1583 sprintf(time_buf, "%lu %s", time, tz_str);
1588 minutes = tz < 0 ? -tz : tz;
1589 minutes = (minutes / 100)*60 + (minutes % 100);
1590 minutes = tz < 0 ? -minutes : minutes;
1591 t = time + minutes * 60;
1594 strftime(time_buf, sizeof(time_buf), "%Y-%m-%d %H:%M:%S ", tm);
1595 strcat(time_buf, tz_str);
1599 #define OUTPUT_ANNOTATE_COMPAT 001
1600 #define OUTPUT_LONG_OBJECT_NAME 002
1601 #define OUTPUT_RAW_TIMESTAMP 004
1602 #define OUTPUT_PORCELAIN 010
1603 #define OUTPUT_SHOW_NAME 020
1604 #define OUTPUT_SHOW_NUMBER 040
1605 #define OUTPUT_SHOW_SCORE 0100
1606 #define OUTPUT_NO_AUTHOR 0200
1608 static void emit_porcelain(struct scoreboard *sb, struct blame_entry *ent)
1612 struct origin *suspect = ent->suspect;
1615 strcpy(hex, sha1_to_hex(suspect->commit->object.sha1));
1616 printf("%s%c%d %d %d\n",
1618 ent->guilty ? ' ' : '*', // purely for debugging
1622 if (!(suspect->commit->object.flags & METAINFO_SHOWN)) {
1623 struct commit_info ci;
1624 suspect->commit->object.flags |= METAINFO_SHOWN;
1625 get_commit_info(suspect->commit, &ci, 1);
1626 printf("author %s\n", ci.author);
1627 printf("author-mail %s\n", ci.author_mail);
1628 printf("author-time %lu\n", ci.author_time);
1629 printf("author-tz %s\n", ci.author_tz);
1630 printf("committer %s\n", ci.committer);
1631 printf("committer-mail %s\n", ci.committer_mail);
1632 printf("committer-time %lu\n", ci.committer_time);
1633 printf("committer-tz %s\n", ci.committer_tz);
1634 write_filename_info(suspect->path);
1635 printf("summary %s\n", ci.summary);
1636 if (suspect->commit->object.flags & UNINTERESTING)
1637 printf("boundary\n");
1639 else if (suspect->commit->object.flags & MORE_THAN_ONE_PATH)
1640 write_filename_info(suspect->path);
1642 cp = nth_line(sb, ent->lno);
1643 for (cnt = 0; cnt < ent->num_lines; cnt++) {
1646 printf("%s %d %d\n", hex,
1647 ent->s_lno + 1 + cnt,
1648 ent->lno + 1 + cnt);
1653 } while (ch != '\n' &&
1654 cp < sb->final_buf + sb->final_buf_size);
1658 static void emit_other(struct scoreboard *sb, struct blame_entry *ent, int opt)
1662 struct origin *suspect = ent->suspect;
1663 struct commit_info ci;
1665 int show_raw_time = !!(opt & OUTPUT_RAW_TIMESTAMP);
1667 get_commit_info(suspect->commit, &ci, 1);
1668 strcpy(hex, sha1_to_hex(suspect->commit->object.sha1));
1670 cp = nth_line(sb, ent->lno);
1671 for (cnt = 0; cnt < ent->num_lines; cnt++) {
1673 int length = (opt & OUTPUT_LONG_OBJECT_NAME) ? 40 : 8;
1675 if (suspect->commit->object.flags & UNINTERESTING) {
1677 memset(hex, ' ', length);
1678 else if (!(opt & OUTPUT_ANNOTATE_COMPAT)) {
1684 printf("%.*s", length, hex);
1685 if (opt & OUTPUT_ANNOTATE_COMPAT)
1686 printf("\t(%10s\t%10s\t%d)", ci.author,
1687 format_time(ci.author_time, ci.author_tz,
1689 ent->lno + 1 + cnt);
1691 if (opt & OUTPUT_SHOW_SCORE)
1693 max_score_digits, ent->score,
1694 ent->suspect->refcnt);
1695 if (opt & OUTPUT_SHOW_NAME)
1696 printf(" %-*.*s", longest_file, longest_file,
1698 if (opt & OUTPUT_SHOW_NUMBER)
1699 printf(" %*d", max_orig_digits,
1700 ent->s_lno + 1 + cnt);
1702 if (!(opt & OUTPUT_NO_AUTHOR))
1703 printf(" (%-*.*s %10s",
1704 longest_author, longest_author,
1706 format_time(ci.author_time,
1710 max_digits, ent->lno + 1 + cnt);
1715 } while (ch != '\n' &&
1716 cp < sb->final_buf + sb->final_buf_size);
1720 static void output(struct scoreboard *sb, int option)
1722 struct blame_entry *ent;
1724 if (option & OUTPUT_PORCELAIN) {
1725 for (ent = sb->ent; ent; ent = ent->next) {
1726 struct blame_entry *oth;
1727 struct origin *suspect = ent->suspect;
1728 struct commit *commit = suspect->commit;
1729 if (commit->object.flags & MORE_THAN_ONE_PATH)
1731 for (oth = ent->next; oth; oth = oth->next) {
1732 if ((oth->suspect->commit != commit) ||
1733 !strcmp(oth->suspect->path, suspect->path))
1735 commit->object.flags |= MORE_THAN_ONE_PATH;
1741 for (ent = sb->ent; ent; ent = ent->next) {
1742 if (option & OUTPUT_PORCELAIN)
1743 emit_porcelain(sb, ent);
1745 emit_other(sb, ent, option);
1751 * To allow quick access to the contents of nth line in the
1752 * final image, prepare an index in the scoreboard.
1754 static int prepare_lines(struct scoreboard *sb)
1756 const char *buf = sb->final_buf;
1757 unsigned long len = sb->final_buf_size;
1758 int num = 0, incomplete = 0, bol = 1;
1760 if (len && buf[len-1] != '\n')
1761 incomplete++; /* incomplete line at the end */
1764 sb->lineno = xrealloc(sb->lineno,
1765 sizeof(int* ) * (num + 1));
1766 sb->lineno[num] = buf - sb->final_buf;
1769 if (*buf++ == '\n') {
1774 sb->lineno = xrealloc(sb->lineno,
1775 sizeof(int* ) * (num + incomplete + 1));
1776 sb->lineno[num + incomplete] = buf - sb->final_buf;
1777 sb->num_lines = num + incomplete;
1778 return sb->num_lines;
1782 * Add phony grafts for use with -S; this is primarily to
1783 * support git's cvsserver that wants to give a linear history
1786 static int read_ancestry(const char *graft_file)
1788 FILE *fp = fopen(graft_file, "r");
1792 while (fgets(buf, sizeof(buf), fp)) {
1793 /* The format is just "Commit Parent1 Parent2 ...\n" */
1794 int len = strlen(buf);
1795 struct commit_graft *graft = read_graft_line(buf, len);
1797 register_commit_graft(graft, 0);
1804 * How many columns do we need to show line numbers in decimal?
1806 static int lineno_width(int lines)
1810 for (width = 1, i = 10; i <= lines + 1; width++)
1816 * How many columns do we need to show line numbers, authors,
1819 static void find_alignment(struct scoreboard *sb, int *option)
1821 int longest_src_lines = 0;
1822 int longest_dst_lines = 0;
1823 unsigned largest_score = 0;
1824 struct blame_entry *e;
1826 for (e = sb->ent; e; e = e->next) {
1827 struct origin *suspect = e->suspect;
1828 struct commit_info ci;
1831 if (strcmp(suspect->path, sb->path))
1832 *option |= OUTPUT_SHOW_NAME;
1833 num = strlen(suspect->path);
1834 if (longest_file < num)
1836 if (!(suspect->commit->object.flags & METAINFO_SHOWN)) {
1837 suspect->commit->object.flags |= METAINFO_SHOWN;
1838 get_commit_info(suspect->commit, &ci, 1);
1839 num = strlen(ci.author);
1840 if (longest_author < num)
1841 longest_author = num;
1843 num = e->s_lno + e->num_lines;
1844 if (longest_src_lines < num)
1845 longest_src_lines = num;
1846 num = e->lno + e->num_lines;
1847 if (longest_dst_lines < num)
1848 longest_dst_lines = num;
1849 if (largest_score < ent_score(sb, e))
1850 largest_score = ent_score(sb, e);
1852 max_orig_digits = lineno_width(longest_src_lines);
1853 max_digits = lineno_width(longest_dst_lines);
1854 max_score_digits = lineno_width(largest_score);
1858 * For debugging -- origin is refcounted, and this asserts that
1859 * we do not underflow.
1861 static void sanity_check_refcnt(struct scoreboard *sb)
1864 struct blame_entry *ent;
1866 for (ent = sb->ent; ent; ent = ent->next) {
1867 /* Nobody should have zero or negative refcnt */
1868 if (ent->suspect->refcnt <= 0) {
1869 fprintf(stderr, "%s in %s has negative refcnt %d\n",
1871 sha1_to_hex(ent->suspect->commit->object.sha1),
1872 ent->suspect->refcnt);
1876 for (ent = sb->ent; ent; ent = ent->next) {
1877 /* Mark the ones that haven't been checked */
1878 if (0 < ent->suspect->refcnt)
1879 ent->suspect->refcnt = -ent->suspect->refcnt;
1881 for (ent = sb->ent; ent; ent = ent->next) {
1883 * ... then pick each and see if they have the the
1887 struct blame_entry *e;
1888 struct origin *suspect = ent->suspect;
1890 if (0 < suspect->refcnt)
1892 suspect->refcnt = -suspect->refcnt; /* Unmark */
1893 for (found = 0, e = sb->ent; e; e = e->next) {
1894 if (e->suspect != suspect)
1898 if (suspect->refcnt != found) {
1899 fprintf(stderr, "%s in %s has refcnt %d, not %d\n",
1901 sha1_to_hex(ent->suspect->commit->object.sha1),
1902 ent->suspect->refcnt, found);
1908 find_alignment(sb, &opt);
1910 die("Baa %d!", baa);
1915 * Used for the command line parsing; check if the path exists
1916 * in the working tree.
1918 static int has_string_in_work_tree(const char *path)
1921 return !lstat(path, &st);
1924 static unsigned parse_score(const char *arg)
1927 unsigned long score = strtoul(arg, &end, 10);
1933 static const char *add_prefix(const char *prefix, const char *path)
1935 return prefix_path(prefix, prefix ? strlen(prefix) : 0, path);
1939 * Parsing of (comma separated) one item in the -L option
1941 static const char *parse_loc(const char *spec,
1942 struct scoreboard *sb, long lno,
1943 long begin, long *ret)
1950 regmatch_t match[1];
1952 /* Allow "-L <something>,+20" to mean starting at <something>
1953 * for 20 lines, or "-L <something>,-5" for 5 lines ending at
1956 if (1 < begin && (spec[0] == '+' || spec[0] == '-')) {
1957 num = strtol(spec + 1, &term, 10);
1958 if (term != spec + 1) {
1962 *ret = begin + num - 2;
1971 num = strtol(spec, &term, 10);
1979 /* it could be a regexp of form /.../ */
1980 for (term = (char*) spec + 1; *term && *term != '/'; term++) {
1987 /* try [spec+1 .. term-1] as regexp */
1989 begin--; /* input is in human terms */
1990 line = nth_line(sb, begin);
1992 if (!(reg_error = regcomp(®exp, spec + 1, REG_NEWLINE)) &&
1993 !(reg_error = regexec(®exp, line, 1, match, 0))) {
1994 const char *cp = line + match[0].rm_so;
1997 while (begin++ < lno) {
1998 nline = nth_line(sb, begin);
1999 if (line <= cp && cp < nline)
2010 regerror(reg_error, ®exp, errbuf, 1024);
2011 die("-L parameter '%s': %s", spec + 1, errbuf);
2016 * Parsing of -L option
2018 static void prepare_blame_range(struct scoreboard *sb,
2019 const char *bottomtop,
2021 long *bottom, long *top)
2025 term = parse_loc(bottomtop, sb, lno, 1, bottom);
2027 term = parse_loc(term + 1, sb, lno, *bottom + 1, top);
2035 static int git_blame_config(const char *var, const char *value, void *cb)
2037 if (!strcmp(var, "blame.showroot")) {
2038 show_root = git_config_bool(var, value);
2041 if (!strcmp(var, "blame.blankboundary")) {
2042 blank_boundary = git_config_bool(var, value);
2045 return git_default_config(var, value, cb);
2049 * Prepare a dummy commit that represents the work tree (or staged) item.
2050 * Note that annotating work tree item never works in the reverse.
2052 static struct commit *fake_working_tree_commit(const char *path, const char *contents_from)
2054 struct commit *commit;
2055 struct origin *origin;
2056 unsigned char head_sha1[20];
2057 struct strbuf buf = STRBUF_INIT;
2061 struct cache_entry *ce;
2064 if (get_sha1("HEAD", head_sha1))
2065 die("No such ref: HEAD");
2068 commit = xcalloc(1, sizeof(*commit));
2069 commit->parents = xcalloc(1, sizeof(*commit->parents));
2070 commit->parents->item = lookup_commit_reference(head_sha1);
2071 commit->object.parsed = 1;
2073 commit->object.type = OBJ_COMMIT;
2075 origin = make_origin(commit, path);
2077 if (!contents_from || strcmp("-", contents_from)) {
2079 const char *read_from;
2080 unsigned long fin_size;
2082 if (contents_from) {
2083 if (stat(contents_from, &st) < 0)
2084 die("Cannot stat %s", contents_from);
2085 read_from = contents_from;
2088 if (lstat(path, &st) < 0)
2089 die("Cannot lstat %s", path);
2092 fin_size = xsize_t(st.st_size);
2093 mode = canon_mode(st.st_mode);
2094 switch (st.st_mode & S_IFMT) {
2096 if (strbuf_read_file(&buf, read_from, st.st_size) != st.st_size)
2097 die("cannot open or read %s", read_from);
2100 if (readlink(read_from, buf.buf, buf.alloc) != fin_size)
2101 die("cannot readlink %s", read_from);
2105 die("unsupported file type %s", read_from);
2109 /* Reading from stdin */
2110 contents_from = "standard input";
2112 if (strbuf_read(&buf, 0, 0) < 0)
2113 die("read error %s from stdin", strerror(errno));
2115 convert_to_git(path, buf.buf, buf.len, &buf, 0);
2116 origin->file.ptr = buf.buf;
2117 origin->file.size = buf.len;
2118 pretend_sha1_file(buf.buf, buf.len, OBJ_BLOB, origin->blob_sha1);
2119 commit->util = origin;
2122 * Read the current index, replace the path entry with
2123 * origin->blob_sha1 without mucking with its mode or type
2124 * bits; we are not going to write this index out -- we just
2125 * want to run "diff-index --cached".
2132 int pos = cache_name_pos(path, len);
2134 mode = active_cache[pos]->ce_mode;
2136 /* Let's not bother reading from HEAD tree */
2137 mode = S_IFREG | 0644;
2139 size = cache_entry_size(len);
2140 ce = xcalloc(1, size);
2141 hashcpy(ce->sha1, origin->blob_sha1);
2142 memcpy(ce->name, path, len);
2143 ce->ce_flags = create_ce_flags(len, 0);
2144 ce->ce_mode = create_ce_mode(mode);
2145 add_cache_entry(ce, ADD_CACHE_OK_TO_ADD|ADD_CACHE_OK_TO_REPLACE);
2148 * We are not going to write this out, so this does not matter
2149 * right now, but someday we might optimize diff-index --cached
2150 * with cache-tree information.
2152 cache_tree_invalidate_path(active_cache_tree, path);
2154 commit->buffer = xmalloc(400);
2155 ident = fmt_ident("Not Committed Yet", "not.committed.yet", NULL, 0);
2156 snprintf(commit->buffer, 400,
2157 "tree 0000000000000000000000000000000000000000\n"
2161 "Version of %s from %s\n",
2162 sha1_to_hex(head_sha1),
2163 ident, ident, path, contents_from ? contents_from : path);
2167 static const char *prepare_final(struct scoreboard *sb)
2170 const char *final_commit_name = NULL;
2171 struct rev_info *revs = sb->revs;
2174 * There must be one and only one positive commit in the
2175 * revs->pending array.
2177 for (i = 0; i < revs->pending.nr; i++) {
2178 struct object *obj = revs->pending.objects[i].item;
2179 if (obj->flags & UNINTERESTING)
2181 while (obj->type == OBJ_TAG)
2182 obj = deref_tag(obj, NULL, 0);
2183 if (obj->type != OBJ_COMMIT)
2184 die("Non commit %s?", revs->pending.objects[i].name);
2186 die("More than one commit to dig from %s and %s?",
2187 revs->pending.objects[i].name,
2189 sb->final = (struct commit *) obj;
2190 final_commit_name = revs->pending.objects[i].name;
2192 return final_commit_name;
2195 static const char *prepare_initial(struct scoreboard *sb)
2198 const char *final_commit_name = NULL;
2199 struct rev_info *revs = sb->revs;
2202 * There must be one and only one negative commit, and it must be
2205 for (i = 0; i < revs->pending.nr; i++) {
2206 struct object *obj = revs->pending.objects[i].item;
2207 if (!(obj->flags & UNINTERESTING))
2209 while (obj->type == OBJ_TAG)
2210 obj = deref_tag(obj, NULL, 0);
2211 if (obj->type != OBJ_COMMIT)
2212 die("Non commit %s?", revs->pending.objects[i].name);
2214 die("More than one commit to dig down to %s and %s?",
2215 revs->pending.objects[i].name,
2217 sb->final = (struct commit *) obj;
2218 final_commit_name = revs->pending.objects[i].name;
2220 if (!final_commit_name)
2221 die("No commit to dig down to?");
2222 return final_commit_name;
2225 static int blame_copy_callback(const struct option *option, const char *arg, int unset)
2227 int *opt = option->value;
2230 * -C enables copy from removed files;
2231 * -C -C enables copy from existing files, but only
2232 * when blaming a new file;
2233 * -C -C -C enables copy from existing files for
2236 if (*opt & PICKAXE_BLAME_COPY_HARDER)
2237 *opt |= PICKAXE_BLAME_COPY_HARDEST;
2238 if (*opt & PICKAXE_BLAME_COPY)
2239 *opt |= PICKAXE_BLAME_COPY_HARDER;
2240 *opt |= PICKAXE_BLAME_COPY | PICKAXE_BLAME_MOVE;
2243 blame_copy_score = parse_score(arg);
2247 static int blame_move_callback(const struct option *option, const char *arg, int unset)
2249 int *opt = option->value;
2251 *opt |= PICKAXE_BLAME_MOVE;
2254 blame_move_score = parse_score(arg);
2258 static int blame_bottomtop_callback(const struct option *option, const char *arg, int unset)
2260 const char **bottomtop = option->value;
2264 die("More than one '-L n,m' option given");
2269 int cmd_blame(int argc, const char **argv, const char *prefix)
2271 struct rev_info revs;
2273 struct scoreboard sb;
2275 struct blame_entry *ent;
2276 long dashdash_pos, bottom, top, lno;
2277 const char *final_commit_name = NULL;
2278 enum object_type type;
2280 static const char *bottomtop = NULL;
2281 static int output_option = 0, opt = 0;
2282 static int show_stats = 0;
2283 static const char *revs_file = NULL;
2284 static const char *contents_from = NULL;
2285 static const struct option options[] = {
2286 OPT_BOOLEAN(0, "incremental", &incremental, "Show blame entries as we find them, incrementally"),
2287 OPT_BOOLEAN('b', NULL, &blank_boundary, "Show blank SHA-1 for boundary commits (Default: off)"),
2288 OPT_BOOLEAN(0, "root", &show_root, "Do not treat root commits as boundaries (Default: off)"),
2289 OPT_BOOLEAN(0, "show-stats", &show_stats, "Show work cost statistics"),
2290 OPT_BIT(0, "score-debug", &output_option, "Show output score for blame entries", OUTPUT_SHOW_SCORE),
2291 OPT_BIT('f', "show-name", &output_option, "Show original filename (Default: auto)", OUTPUT_SHOW_NAME),
2292 OPT_BIT('n', "show-number", &output_option, "Show original linenumber (Default: off)", OUTPUT_SHOW_NUMBER),
2293 OPT_BIT('p', "porcelain", &output_option, "Show in a format designed for machine consumption", OUTPUT_PORCELAIN),
2294 OPT_BIT('c', NULL, &output_option, "Use the same output mode as git-annotate (Default: off)", OUTPUT_ANNOTATE_COMPAT),
2295 OPT_BIT('t', NULL, &output_option, "Show raw timestamp (Default: off)", OUTPUT_RAW_TIMESTAMP),
2296 OPT_BIT('l', NULL, &output_option, "Show long commit SHA1 (Default: off)", OUTPUT_LONG_OBJECT_NAME),
2297 OPT_BIT('s', NULL, &output_option, "Suppress author name and timestamp (Default: off)", OUTPUT_NO_AUTHOR),
2298 OPT_BIT('w', NULL, &xdl_opts, "Ignore whitespace differences", XDF_IGNORE_WHITESPACE),
2299 OPT_STRING('S', NULL, &revs_file, "file", "Use revisions from <file> instead of calling git-rev-list"),
2300 OPT_STRING(0, "contents", &contents_from, "file", "Use <file>'s contents as the final image"),
2301 { OPTION_CALLBACK, 'C', NULL, &opt, "score", "Find line copies within and across files", PARSE_OPT_OPTARG, blame_copy_callback },
2302 { OPTION_CALLBACK, 'M', NULL, &opt, "score", "Find line movements within and across files", PARSE_OPT_OPTARG, blame_move_callback },
2303 OPT_CALLBACK('L', NULL, &bottomtop, "n,m", "Process only line range n,m, counting from 1", blame_bottomtop_callback),
2307 struct parse_opt_ctx_t ctx;
2308 int cmd_is_annotate = !strcmp(argv[0], "annotate");
2310 git_config(git_blame_config, NULL);
2311 init_revisions(&revs, NULL);
2312 save_commit_buffer = 0;
2315 parse_options_start(&ctx, argc, argv, PARSE_OPT_KEEP_DASHDASH |
2316 PARSE_OPT_KEEP_ARGV0);
2318 switch (parse_options_step(&ctx, options, blame_opt_usage)) {
2319 case PARSE_OPT_HELP:
2321 case PARSE_OPT_DONE:
2323 dashdash_pos = ctx.cpidx;
2327 if (!strcmp(ctx.argv[0], "--reverse")) {
2328 ctx.argv[0] = "--children";
2331 parse_revision_opt(&revs, &ctx, options, blame_opt_usage);
2334 argc = parse_options_end(&ctx);
2336 if (cmd_is_annotate)
2337 output_option |= OUTPUT_ANNOTATE_COMPAT;
2339 if (DIFF_OPT_TST(&revs.diffopt, FIND_COPIES_HARDER))
2340 opt |= (PICKAXE_BLAME_COPY | PICKAXE_BLAME_MOVE |
2341 PICKAXE_BLAME_COPY_HARDER);
2343 if (!blame_move_score)
2344 blame_move_score = BLAME_DEFAULT_MOVE_SCORE;
2345 if (!blame_copy_score)
2346 blame_copy_score = BLAME_DEFAULT_COPY_SCORE;
2349 * We have collected options unknown to us in argv[1..unk]
2350 * which are to be passed to revision machinery if we are
2351 * going to do the "bottom" processing.
2353 * The remaining are:
2355 * (1) if dashdash_pos != 0, its either
2356 * "blame [revisions] -- <path>" or
2357 * "blame -- <path> <rev>"
2359 * (2) otherwise, its one of the two:
2360 * "blame [revisions] <path>"
2361 * "blame <path> <rev>"
2363 * Note that we must strip out <path> from the arguments: we do not
2364 * want the path pruning but we may want "bottom" processing.
2367 switch (argc - dashdash_pos - 1) {
2370 usage_with_options(blame_opt_usage, options);
2371 /* reorder for the new way: <rev> -- <path> */
2377 path = add_prefix(prefix, argv[--argc]);
2381 usage_with_options(blame_opt_usage, options);
2385 usage_with_options(blame_opt_usage, options);
2386 path = add_prefix(prefix, argv[argc - 1]);
2387 if (argc == 3 && !has_string_in_work_tree(path)) { /* (2b) */
2388 path = add_prefix(prefix, argv[1]);
2391 argv[argc - 1] = "--";
2394 if (!has_string_in_work_tree(path))
2395 die("cannot stat path %s: %s", path, strerror(errno));
2398 setup_revisions(argc, argv, &revs, NULL);
2399 memset(&sb, 0, sizeof(sb));
2403 final_commit_name = prepare_final(&sb);
2404 else if (contents_from)
2405 die("--contents and --children do not blend well.");
2407 final_commit_name = prepare_initial(&sb);
2411 * "--not A B -- path" without anything positive;
2412 * do not default to HEAD, but use the working tree
2416 sb.final = fake_working_tree_commit(path, contents_from);
2417 add_pending_object(&revs, &(sb.final->object), ":");
2419 else if (contents_from)
2420 die("Cannot use --contents with final commit object name");
2423 * If we have bottom, this will mark the ancestors of the
2424 * bottom commits we would reach while traversing as
2427 if (prepare_revision_walk(&revs))
2428 die("revision walk setup failed");
2430 if (is_null_sha1(sb.final->object.sha1)) {
2433 buf = xmalloc(o->file.size + 1);
2434 memcpy(buf, o->file.ptr, o->file.size + 1);
2436 sb.final_buf_size = o->file.size;
2439 o = get_origin(&sb, sb.final, path);
2440 if (fill_blob_sha1(o))
2441 die("no such path %s in %s", path, final_commit_name);
2443 sb.final_buf = read_sha1_file(o->blob_sha1, &type,
2444 &sb.final_buf_size);
2446 die("Cannot read blob %s for path %s",
2447 sha1_to_hex(o->blob_sha1),
2451 lno = prepare_lines(&sb);
2455 prepare_blame_range(&sb, bottomtop, lno, &bottom, &top);
2456 if (bottom && top && top < bottom) {
2458 tmp = top; top = bottom; bottom = tmp;
2466 die("file %s has only %lu lines", path, lno);
2468 ent = xcalloc(1, sizeof(*ent));
2470 ent->num_lines = top - bottom;
2472 ent->s_lno = bottom;
2477 if (revs_file && read_ancestry(revs_file))
2478 die("reading graft file %s failed: %s",
2479 revs_file, strerror(errno));
2481 read_mailmap(&mailmap, ".mailmap", NULL);
2486 assign_blame(&sb, opt);
2493 if (!(output_option & OUTPUT_PORCELAIN))
2494 find_alignment(&sb, &output_option);
2496 output(&sb, output_option);
2497 free((void *)sb.final_buf);
2498 for (ent = sb.ent; ent; ) {
2499 struct blame_entry *e = ent->next;
2505 printf("num read blob: %d\n", num_read_blob);
2506 printf("num get patch: %d\n", num_get_patch);
2507 printf("num commits: %d\n", num_commits);