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 xpp
.flags
= xdl_opts
;
527 memset(&xecfg
, 0, sizeof(xecfg
));
528 xecfg
.ctxlen
= context
;
529 memset(&state
, 0, sizeof(state
));
530 state
.ret
= xmalloc(sizeof(struct patch
));
531 state
.ret
->chunks
= NULL
;
534 xdi_diff_outf(file_p
, file_o
, process_u_diff
, &state
, &xpp
, &xecfg
, &ecb
);
536 if (state
.ret
->num
) {
538 chunk
= &state
.ret
->chunks
[state
.ret
->num
- 1];
539 chunk
->p_next
-= state
.hunk_post_context
;
540 chunk
->t_next
-= state
.hunk_post_context
;
546 * Run diff between two origins and grab the patch output, so that
547 * we can pass blame for lines origin is currently suspected for
550 static struct patch
*get_patch(struct origin
*parent
, struct origin
*origin
)
552 mmfile_t file_p
, file_o
;
555 fill_origin_blob(parent
, &file_p
);
556 fill_origin_blob(origin
, &file_o
);
557 if (!file_p
.ptr
|| !file_o
.ptr
)
559 patch
= compare_buffer(&file_p
, &file_o
, 0);
564 static void free_patch(struct patch
*p
)
571 * Link in a new blame entry to the scoreboard. Entries that cover the
572 * same line range have been removed from the scoreboard previously.
574 static void add_blame_entry(struct scoreboard
*sb
, struct blame_entry
*e
)
576 struct blame_entry
*ent
, *prev
= NULL
;
578 origin_incref(e
->suspect
);
580 for (ent
= sb
->ent
; ent
&& ent
->lno
< e
->lno
; ent
= ent
->next
)
583 /* prev, if not NULL, is the last one that is below e */
586 e
->next
= prev
->next
;
598 * src typically is on-stack; we want to copy the information in it to
599 * a malloced blame_entry that is already on the linked list of the
600 * scoreboard. The origin of dst loses a refcnt while the origin of src
603 static void dup_entry(struct blame_entry
*dst
, struct blame_entry
*src
)
605 struct blame_entry
*p
, *n
;
609 origin_incref(src
->suspect
);
610 origin_decref(dst
->suspect
);
611 memcpy(dst
, src
, sizeof(*src
));
617 static const char *nth_line(struct scoreboard
*sb
, int lno
)
619 return sb
->final_buf
+ sb
->lineno
[lno
];
623 * It is known that lines between tlno to same came from parent, and e
624 * has an overlap with that range. it also is known that parent's
625 * line plno corresponds to e's line tlno.
631 * <------------------>
633 * Split e into potentially three parts; before this chunk, the chunk
634 * to be blamed for the parent, and after that portion.
636 static void split_overlap(struct blame_entry
*split
,
637 struct blame_entry
*e
,
638 int tlno
, int plno
, int same
,
639 struct origin
*parent
)
642 memset(split
, 0, sizeof(struct blame_entry
[3]));
644 if (e
->s_lno
< tlno
) {
645 /* there is a pre-chunk part not blamed on parent */
646 split
[0].suspect
= origin_incref(e
->suspect
);
647 split
[0].lno
= e
->lno
;
648 split
[0].s_lno
= e
->s_lno
;
649 split
[0].num_lines
= tlno
- e
->s_lno
;
650 split
[1].lno
= e
->lno
+ tlno
- e
->s_lno
;
651 split
[1].s_lno
= plno
;
654 split
[1].lno
= e
->lno
;
655 split
[1].s_lno
= plno
+ (e
->s_lno
- tlno
);
658 if (same
< e
->s_lno
+ e
->num_lines
) {
659 /* there is a post-chunk part not blamed on parent */
660 split
[2].suspect
= origin_incref(e
->suspect
);
661 split
[2].lno
= e
->lno
+ (same
- e
->s_lno
);
662 split
[2].s_lno
= e
->s_lno
+ (same
- e
->s_lno
);
663 split
[2].num_lines
= e
->s_lno
+ e
->num_lines
- same
;
664 chunk_end_lno
= split
[2].lno
;
667 chunk_end_lno
= e
->lno
+ e
->num_lines
;
668 split
[1].num_lines
= chunk_end_lno
- split
[1].lno
;
671 * if it turns out there is nothing to blame the parent for,
672 * forget about the splitting. !split[1].suspect signals this.
674 if (split
[1].num_lines
< 1)
676 split
[1].suspect
= origin_incref(parent
);
680 * split_overlap() divided an existing blame e into up to three parts
681 * in split. Adjust the linked list of blames in the scoreboard to
684 static void split_blame(struct scoreboard
*sb
,
685 struct blame_entry
*split
,
686 struct blame_entry
*e
)
688 struct blame_entry
*new_entry
;
690 if (split
[0].suspect
&& split
[2].suspect
) {
691 /* The first part (reuse storage for the existing entry e) */
692 dup_entry(e
, &split
[0]);
694 /* The last part -- me */
695 new_entry
= xmalloc(sizeof(*new_entry
));
696 memcpy(new_entry
, &(split
[2]), sizeof(struct blame_entry
));
697 add_blame_entry(sb
, new_entry
);
699 /* ... and the middle part -- parent */
700 new_entry
= xmalloc(sizeof(*new_entry
));
701 memcpy(new_entry
, &(split
[1]), sizeof(struct blame_entry
));
702 add_blame_entry(sb
, new_entry
);
704 else if (!split
[0].suspect
&& !split
[2].suspect
)
706 * The parent covers the entire area; reuse storage for
707 * e and replace it with the parent.
709 dup_entry(e
, &split
[1]);
710 else if (split
[0].suspect
) {
711 /* me and then parent */
712 dup_entry(e
, &split
[0]);
714 new_entry
= xmalloc(sizeof(*new_entry
));
715 memcpy(new_entry
, &(split
[1]), sizeof(struct blame_entry
));
716 add_blame_entry(sb
, new_entry
);
719 /* parent and then me */
720 dup_entry(e
, &split
[1]);
722 new_entry
= xmalloc(sizeof(*new_entry
));
723 memcpy(new_entry
, &(split
[2]), sizeof(struct blame_entry
));
724 add_blame_entry(sb
, new_entry
);
727 if (DEBUG
) { /* sanity */
728 struct blame_entry
*ent
;
729 int lno
= sb
->ent
->lno
, corrupt
= 0;
731 for (ent
= sb
->ent
; ent
; ent
= ent
->next
) {
736 lno
+= ent
->num_lines
;
740 for (ent
= sb
->ent
; ent
; ent
= ent
->next
) {
741 printf("L %8d l %8d n %8d\n",
742 lno
, ent
->lno
, ent
->num_lines
);
743 lno
= ent
->lno
+ ent
->num_lines
;
751 * After splitting the blame, the origins used by the
752 * on-stack blame_entry should lose one refcnt each.
754 static void decref_split(struct blame_entry
*split
)
758 for (i
= 0; i
< 3; i
++)
759 origin_decref(split
[i
].suspect
);
763 * Helper for blame_chunk(). blame_entry e is known to overlap with
764 * the patch hunk; split it and pass blame to the parent.
766 static void blame_overlap(struct scoreboard
*sb
, struct blame_entry
*e
,
767 int tlno
, int plno
, int same
,
768 struct origin
*parent
)
770 struct blame_entry split
[3];
772 split_overlap(split
, e
, tlno
, plno
, same
, parent
);
773 if (split
[1].suspect
)
774 split_blame(sb
, split
, e
);
779 * Find the line number of the last line the target is suspected for.
781 static int find_last_in_target(struct scoreboard
*sb
, struct origin
*target
)
783 struct blame_entry
*e
;
784 int last_in_target
= -1;
786 for (e
= sb
->ent
; e
; e
= e
->next
) {
787 if (e
->guilty
|| !same_suspect(e
->suspect
, target
))
789 if (last_in_target
< e
->s_lno
+ e
->num_lines
)
790 last_in_target
= e
->s_lno
+ e
->num_lines
;
792 return last_in_target
;
796 * Process one hunk from the patch between the current suspect for
797 * blame_entry e and its parent. Find and split the overlap, and
798 * pass blame to the overlapping part to the parent.
800 static void blame_chunk(struct scoreboard
*sb
,
801 int tlno
, int plno
, int same
,
802 struct origin
*target
, struct origin
*parent
)
804 struct blame_entry
*e
;
806 for (e
= sb
->ent
; e
; e
= e
->next
) {
807 if (e
->guilty
|| !same_suspect(e
->suspect
, target
))
809 if (same
<= e
->s_lno
)
811 if (tlno
< e
->s_lno
+ e
->num_lines
)
812 blame_overlap(sb
, e
, tlno
, plno
, same
, parent
);
817 * We are looking at the origin 'target' and aiming to pass blame
818 * for the lines it is suspected to its parent. Run diff to find
819 * which lines came from parent and pass blame for them.
821 static int pass_blame_to_parent(struct scoreboard
*sb
,
822 struct origin
*target
,
823 struct origin
*parent
)
825 int i
, last_in_target
, plno
, tlno
;
828 last_in_target
= find_last_in_target(sb
, target
);
829 if (last_in_target
< 0)
830 return 1; /* nothing remains for this target */
832 patch
= get_patch(parent
, target
);
834 for (i
= 0; i
< patch
->num
; i
++) {
835 struct chunk
*chunk
= &patch
->chunks
[i
];
837 blame_chunk(sb
, tlno
, plno
, chunk
->same
, target
, parent
);
838 plno
= chunk
->p_next
;
839 tlno
= chunk
->t_next
;
841 /* The rest (i.e. anything after tlno) are the same as the parent */
842 blame_chunk(sb
, tlno
, plno
, last_in_target
, target
, parent
);
849 * The lines in blame_entry after splitting blames many times can become
850 * very small and trivial, and at some point it becomes pointless to
851 * blame the parents. E.g. "\t\t}\n\t}\n\n" appears everywhere in any
852 * ordinary C program, and it is not worth to say it was copied from
853 * totally unrelated file in the parent.
855 * Compute how trivial the lines in the blame_entry are.
857 static unsigned ent_score(struct scoreboard
*sb
, struct blame_entry
*e
)
866 cp
= nth_line(sb
, e
->lno
);
867 ep
= nth_line(sb
, e
->lno
+ e
->num_lines
);
869 unsigned ch
= *((unsigned char *)cp
);
879 * best_so_far[] and this[] are both a split of an existing blame_entry
880 * that passes blame to the parent. Maintain best_so_far the best split
881 * so far, by comparing this and best_so_far and copying this into
882 * bst_so_far as needed.
884 static void copy_split_if_better(struct scoreboard
*sb
,
885 struct blame_entry
*best_so_far
,
886 struct blame_entry
*this)
890 if (!this[1].suspect
)
892 if (best_so_far
[1].suspect
) {
893 if (ent_score(sb
, &this[1]) < ent_score(sb
, &best_so_far
[1]))
897 for (i
= 0; i
< 3; i
++)
898 origin_incref(this[i
].suspect
);
899 decref_split(best_so_far
);
900 memcpy(best_so_far
, this, sizeof(struct blame_entry
[3]));
904 * We are looking at a part of the final image represented by
905 * ent (tlno and same are offset by ent->s_lno).
906 * tlno is where we are looking at in the final image.
907 * up to (but not including) same match preimage.
908 * plno is where we are looking at in the preimage.
910 * <-------------- final image ---------------------->
913 * <---------preimage----->
916 * All line numbers are 0-based.
918 static void handle_split(struct scoreboard
*sb
,
919 struct blame_entry
*ent
,
920 int tlno
, int plno
, int same
,
921 struct origin
*parent
,
922 struct blame_entry
*split
)
924 if (ent
->num_lines
<= tlno
)
927 struct blame_entry
this[3];
930 split_overlap(this, ent
, tlno
, plno
, same
, parent
);
931 copy_split_if_better(sb
, split
, this);
937 * Find the lines from parent that are the same as ent so that
938 * we can pass blames to it. file_p has the blob contents for
941 static void find_copy_in_blob(struct scoreboard
*sb
,
942 struct blame_entry
*ent
,
943 struct origin
*parent
,
944 struct blame_entry
*split
,
954 * Prepare mmfile that contains only the lines in ent.
956 cp
= nth_line(sb
, ent
->lno
);
957 file_o
.ptr
= (char*) cp
;
958 cnt
= ent
->num_lines
;
960 while (cnt
&& cp
< sb
->final_buf
+ sb
->final_buf_size
) {
964 file_o
.size
= cp
- file_o
.ptr
;
966 patch
= compare_buffer(file_p
, &file_o
, 1);
969 * file_o is a part of final image we are annotating.
970 * file_p partially may match that image.
972 memset(split
, 0, sizeof(struct blame_entry
[3]));
974 for (i
= 0; i
< patch
->num
; i
++) {
975 struct chunk
*chunk
= &patch
->chunks
[i
];
977 handle_split(sb
, ent
, tlno
, plno
, chunk
->same
, parent
, split
);
978 plno
= chunk
->p_next
;
979 tlno
= chunk
->t_next
;
981 /* remainder, if any, all match the preimage */
982 handle_split(sb
, ent
, tlno
, plno
, ent
->num_lines
, parent
, split
);
987 * See if lines currently target is suspected for can be attributed to
990 static int find_move_in_parent(struct scoreboard
*sb
,
991 struct origin
*target
,
992 struct origin
*parent
)
994 int last_in_target
, made_progress
;
995 struct blame_entry
*e
, split
[3];
998 last_in_target
= find_last_in_target(sb
, target
);
999 if (last_in_target
< 0)
1000 return 1; /* nothing remains for this target */
1002 fill_origin_blob(parent
, &file_p
);
1007 while (made_progress
) {
1009 for (e
= sb
->ent
; e
; e
= e
->next
) {
1010 if (e
->guilty
|| !same_suspect(e
->suspect
, target
) ||
1011 ent_score(sb
, e
) < blame_move_score
)
1013 find_copy_in_blob(sb
, e
, parent
, split
, &file_p
);
1014 if (split
[1].suspect
&&
1015 blame_move_score
< ent_score(sb
, &split
[1])) {
1016 split_blame(sb
, split
, e
);
1019 decref_split(split
);
1026 struct blame_entry
*ent
;
1027 struct blame_entry split
[3];
1031 * Count the number of entries the target is suspected for,
1032 * and prepare a list of entry and the best split.
1034 static struct blame_list
*setup_blame_list(struct scoreboard
*sb
,
1035 struct origin
*target
,
1039 struct blame_entry
*e
;
1041 struct blame_list
*blame_list
= NULL
;
1043 for (e
= sb
->ent
, num_ents
= 0; e
; e
= e
->next
)
1044 if (!e
->scanned
&& !e
->guilty
&&
1045 same_suspect(e
->suspect
, target
) &&
1046 min_score
< ent_score(sb
, e
))
1049 blame_list
= xcalloc(num_ents
, sizeof(struct blame_list
));
1050 for (e
= sb
->ent
, i
= 0; e
; e
= e
->next
)
1051 if (!e
->scanned
&& !e
->guilty
&&
1052 same_suspect(e
->suspect
, target
) &&
1053 min_score
< ent_score(sb
, e
))
1054 blame_list
[i
++].ent
= e
;
1056 *num_ents_p
= num_ents
;
1061 * Reset the scanned status on all entries.
1063 static void reset_scanned_flag(struct scoreboard
*sb
)
1065 struct blame_entry
*e
;
1066 for (e
= sb
->ent
; e
; e
= e
->next
)
1071 * For lines target is suspected for, see if we can find code movement
1072 * across file boundary from the parent commit. porigin is the path
1073 * in the parent we already tried.
1075 static int find_copy_in_parent(struct scoreboard
*sb
,
1076 struct origin
*target
,
1077 struct commit
*parent
,
1078 struct origin
*porigin
,
1081 struct diff_options diff_opts
;
1082 const char *paths
[1];
1085 struct blame_list
*blame_list
;
1088 blame_list
= setup_blame_list(sb
, target
, blame_copy_score
, &num_ents
);
1090 return 1; /* nothing remains for this target */
1092 diff_setup(&diff_opts
);
1093 DIFF_OPT_SET(&diff_opts
, RECURSIVE
);
1094 diff_opts
.output_format
= DIFF_FORMAT_NO_OUTPUT
;
1097 diff_tree_setup_paths(paths
, &diff_opts
);
1098 if (diff_setup_done(&diff_opts
) < 0)
1101 /* Try "find copies harder" on new path if requested;
1102 * we do not want to use diffcore_rename() actually to
1103 * match things up; find_copies_harder is set only to
1104 * force diff_tree_sha1() to feed all filepairs to diff_queue,
1105 * and this code needs to be after diff_setup_done(), which
1106 * usually makes find-copies-harder imply copy detection.
1108 if ((opt
& PICKAXE_BLAME_COPY_HARDEST
)
1109 || ((opt
& PICKAXE_BLAME_COPY_HARDER
)
1110 && (!porigin
|| strcmp(target
->path
, porigin
->path
))))
1111 DIFF_OPT_SET(&diff_opts
, FIND_COPIES_HARDER
);
1113 if (is_null_sha1(target
->commit
->object
.sha1
))
1114 do_diff_cache(parent
->tree
->object
.sha1
, &diff_opts
);
1116 diff_tree_sha1(parent
->tree
->object
.sha1
,
1117 target
->commit
->tree
->object
.sha1
,
1120 if (!DIFF_OPT_TST(&diff_opts
, FIND_COPIES_HARDER
))
1121 diffcore_std(&diff_opts
);
1125 int made_progress
= 0;
1127 for (i
= 0; i
< diff_queued_diff
.nr
; i
++) {
1128 struct diff_filepair
*p
= diff_queued_diff
.queue
[i
];
1129 struct origin
*norigin
;
1131 struct blame_entry
this[3];
1133 if (!DIFF_FILE_VALID(p
->one
))
1134 continue; /* does not exist in parent */
1135 if (S_ISGITLINK(p
->one
->mode
))
1136 continue; /* ignore git links */
1137 if (porigin
&& !strcmp(p
->one
->path
, porigin
->path
))
1138 /* find_move already dealt with this path */
1141 norigin
= get_origin(sb
, parent
, p
->one
->path
);
1142 hashcpy(norigin
->blob_sha1
, p
->one
->sha1
);
1143 fill_origin_blob(norigin
, &file_p
);
1147 for (j
= 0; j
< num_ents
; j
++) {
1148 find_copy_in_blob(sb
, blame_list
[j
].ent
,
1149 norigin
, this, &file_p
);
1150 copy_split_if_better(sb
, blame_list
[j
].split
,
1154 origin_decref(norigin
);
1157 for (j
= 0; j
< num_ents
; j
++) {
1158 struct blame_entry
*split
= blame_list
[j
].split
;
1159 if (split
[1].suspect
&&
1160 blame_copy_score
< ent_score(sb
, &split
[1])) {
1161 split_blame(sb
, split
, blame_list
[j
].ent
);
1165 blame_list
[j
].ent
->scanned
= 1;
1166 decref_split(split
);
1172 blame_list
= setup_blame_list(sb
, target
, blame_copy_score
, &num_ents
);
1178 reset_scanned_flag(sb
);
1179 diff_flush(&diff_opts
);
1180 diff_tree_release_paths(&diff_opts
);
1185 * The blobs of origin and porigin exactly match, so everything
1186 * origin is suspected for can be blamed on the parent.
1188 static void pass_whole_blame(struct scoreboard
*sb
,
1189 struct origin
*origin
, struct origin
*porigin
)
1191 struct blame_entry
*e
;
1193 if (!porigin
->file
.ptr
&& origin
->file
.ptr
) {
1194 /* Steal its file */
1195 porigin
->file
= origin
->file
;
1196 origin
->file
.ptr
= NULL
;
1198 for (e
= sb
->ent
; e
; e
= e
->next
) {
1199 if (!same_suspect(e
->suspect
, origin
))
1201 origin_incref(porigin
);
1202 origin_decref(e
->suspect
);
1203 e
->suspect
= porigin
;
1208 * We pass blame from the current commit to its parents. We keep saying
1209 * "parent" (and "porigin"), but what we mean is to find scapegoat to
1210 * exonerate ourselves.
1212 static struct commit_list
*first_scapegoat(struct rev_info
*revs
, struct commit
*commit
)
1215 return commit
->parents
;
1216 return lookup_decoration(&revs
->children
, &commit
->object
);
1219 static int num_scapegoats(struct rev_info
*revs
, struct commit
*commit
)
1222 struct commit_list
*l
= first_scapegoat(revs
, commit
);
1223 for (cnt
= 0; l
; l
= l
->next
)
1230 static void pass_blame(struct scoreboard
*sb
, struct origin
*origin
, int opt
)
1232 struct rev_info
*revs
= sb
->revs
;
1233 int i
, pass
, num_sg
;
1234 struct commit
*commit
= origin
->commit
;
1235 struct commit_list
*sg
;
1236 struct origin
*sg_buf
[MAXSG
];
1237 struct origin
*porigin
, **sg_origin
= sg_buf
;
1239 num_sg
= num_scapegoats(revs
, commit
);
1242 else if (num_sg
< ARRAY_SIZE(sg_buf
))
1243 memset(sg_buf
, 0, sizeof(sg_buf
));
1245 sg_origin
= xcalloc(num_sg
, sizeof(*sg_origin
));
1248 * The first pass looks for unrenamed path to optimize for
1249 * common cases, then we look for renames in the second pass.
1251 for (pass
= 0; pass
< 2; pass
++) {
1252 struct origin
*(*find
)(struct scoreboard
*,
1253 struct commit
*, struct origin
*);
1254 find
= pass
? find_rename
: find_origin
;
1256 for (i
= 0, sg
= first_scapegoat(revs
, commit
);
1258 sg
= sg
->next
, i
++) {
1259 struct commit
*p
= sg
->item
;
1264 if (parse_commit(p
))
1266 porigin
= find(sb
, p
, origin
);
1269 if (!hashcmp(porigin
->blob_sha1
, origin
->blob_sha1
)) {
1270 pass_whole_blame(sb
, origin
, porigin
);
1271 origin_decref(porigin
);
1274 for (j
= same
= 0; j
< i
; j
++)
1276 !hashcmp(sg_origin
[j
]->blob_sha1
,
1277 porigin
->blob_sha1
)) {
1282 sg_origin
[i
] = porigin
;
1284 origin_decref(porigin
);
1289 for (i
= 0, sg
= first_scapegoat(revs
, commit
);
1291 sg
= sg
->next
, i
++) {
1292 struct origin
*porigin
= sg_origin
[i
];
1295 if (pass_blame_to_parent(sb
, origin
, porigin
))
1300 * Optionally find moves in parents' files.
1302 if (opt
& PICKAXE_BLAME_MOVE
)
1303 for (i
= 0, sg
= first_scapegoat(revs
, commit
);
1305 sg
= sg
->next
, i
++) {
1306 struct origin
*porigin
= sg_origin
[i
];
1309 if (find_move_in_parent(sb
, origin
, porigin
))
1314 * Optionally find copies from parents' files.
1316 if (opt
& PICKAXE_BLAME_COPY
)
1317 for (i
= 0, sg
= first_scapegoat(revs
, commit
);
1319 sg
= sg
->next
, i
++) {
1320 struct origin
*porigin
= sg_origin
[i
];
1321 if (find_copy_in_parent(sb
, origin
, sg
->item
,
1327 for (i
= 0; i
< num_sg
; i
++) {
1329 drop_origin_blob(sg_origin
[i
]);
1330 origin_decref(sg_origin
[i
]);
1333 drop_origin_blob(origin
);
1334 if (sg_buf
!= sg_origin
)
1339 * Information on commits, used for output.
1344 const char *author_mail
;
1345 unsigned long author_time
;
1346 const char *author_tz
;
1348 /* filled only when asked for details */
1349 const char *committer
;
1350 const char *committer_mail
;
1351 unsigned long committer_time
;
1352 const char *committer_tz
;
1354 const char *summary
;
1358 * Parse author/committer line in the commit object buffer
1360 static void get_ac_line(const char *inbuf
, const char *what
,
1361 int bufsz
, char *person
, const char **mail
,
1362 unsigned long *time
, const char **tz
)
1364 int len
, tzlen
, maillen
;
1365 char *tmp
, *endp
, *timepos
;
1367 tmp
= strstr(inbuf
, what
);
1370 tmp
+= strlen(what
);
1371 endp
= strchr(tmp
, '\n');
1379 *mail
= *tz
= "(unknown)";
1383 memcpy(person
, tmp
, len
);
1391 tzlen
= (person
+len
)-(tmp
+1);
1396 *time
= strtoul(tmp
, NULL
, 10);
1404 maillen
= timepos
- tmp
;
1410 * mailmap expansion may make the name longer.
1411 * make room by pushing stuff down.
1413 tmp
= person
+ bufsz
- (tzlen
+ 1);
1414 memmove(tmp
, *tz
, tzlen
);
1418 tmp
= tmp
- (maillen
+ 1);
1419 memmove(tmp
, *mail
, maillen
);
1424 * Now, convert e-mail using mailmap
1426 map_email(&mailmap
, tmp
+ 1, person
, tmp
-person
-1);
1429 static void get_commit_info(struct commit
*commit
,
1430 struct commit_info
*ret
,
1434 char *tmp
, *endp
, *reencoded
, *message
;
1435 static char author_buf
[1024];
1436 static char committer_buf
[1024];
1437 static char summary_buf
[1024];
1440 * We've operated without save_commit_buffer, so
1441 * we now need to populate them for output.
1443 if (!commit
->buffer
) {
1444 enum object_type type
;
1447 read_sha1_file(commit
->object
.sha1
, &type
, &size
);
1448 if (!commit
->buffer
)
1449 die("Cannot read commit %s",
1450 sha1_to_hex(commit
->object
.sha1
));
1452 reencoded
= reencode_commit_message(commit
, NULL
);
1453 message
= reencoded
? reencoded
: commit
->buffer
;
1454 ret
->author
= author_buf
;
1455 get_ac_line(message
, "\nauthor ",
1456 sizeof(author_buf
), author_buf
, &ret
->author_mail
,
1457 &ret
->author_time
, &ret
->author_tz
);
1464 ret
->committer
= committer_buf
;
1465 get_ac_line(message
, "\ncommitter ",
1466 sizeof(committer_buf
), committer_buf
, &ret
->committer_mail
,
1467 &ret
->committer_time
, &ret
->committer_tz
);
1469 ret
->summary
= summary_buf
;
1470 tmp
= strstr(message
, "\n\n");
1473 sprintf(summary_buf
, "(%s)", sha1_to_hex(commit
->object
.sha1
));
1478 endp
= strchr(tmp
, '\n');
1480 endp
= tmp
+ strlen(tmp
);
1482 if (len
>= sizeof(summary_buf
) || len
== 0)
1484 memcpy(summary_buf
, tmp
, len
);
1485 summary_buf
[len
] = 0;
1490 * To allow LF and other nonportable characters in pathnames,
1491 * they are c-style quoted as needed.
1493 static void write_filename_info(const char *path
)
1495 printf("filename ");
1496 write_name_quoted(path
, stdout
, '\n');
1500 * The blame_entry is found to be guilty for the range. Mark it
1501 * as such, and show it in incremental output.
1503 static void found_guilty_entry(struct blame_entry
*ent
)
1509 struct origin
*suspect
= ent
->suspect
;
1511 printf("%s %d %d %d\n",
1512 sha1_to_hex(suspect
->commit
->object
.sha1
),
1513 ent
->s_lno
+ 1, ent
->lno
+ 1, ent
->num_lines
);
1514 if (!(suspect
->commit
->object
.flags
& METAINFO_SHOWN
)) {
1515 struct commit_info ci
;
1516 suspect
->commit
->object
.flags
|= METAINFO_SHOWN
;
1517 get_commit_info(suspect
->commit
, &ci
, 1);
1518 printf("author %s\n", ci
.author
);
1519 printf("author-mail %s\n", ci
.author_mail
);
1520 printf("author-time %lu\n", ci
.author_time
);
1521 printf("author-tz %s\n", ci
.author_tz
);
1522 printf("committer %s\n", ci
.committer
);
1523 printf("committer-mail %s\n", ci
.committer_mail
);
1524 printf("committer-time %lu\n", ci
.committer_time
);
1525 printf("committer-tz %s\n", ci
.committer_tz
);
1526 printf("summary %s\n", ci
.summary
);
1527 if (suspect
->commit
->object
.flags
& UNINTERESTING
)
1528 printf("boundary\n");
1530 write_filename_info(suspect
->path
);
1531 maybe_flush_or_die(stdout
, "stdout");
1536 * The main loop -- while the scoreboard has lines whose true origin
1537 * is still unknown, pick one blame_entry, and allow its current
1538 * suspect to pass blames to its parents.
1540 static void assign_blame(struct scoreboard
*sb
, int opt
)
1542 struct rev_info
*revs
= sb
->revs
;
1545 struct blame_entry
*ent
;
1546 struct commit
*commit
;
1547 struct origin
*suspect
= NULL
;
1549 /* find one suspect to break down */
1550 for (ent
= sb
->ent
; !suspect
&& ent
; ent
= ent
->next
)
1552 suspect
= ent
->suspect
;
1554 return; /* all done */
1557 * We will use this suspect later in the loop,
1558 * so hold onto it in the meantime.
1560 origin_incref(suspect
);
1561 commit
= suspect
->commit
;
1562 if (!commit
->object
.parsed
)
1563 parse_commit(commit
);
1565 (!(commit
->object
.flags
& UNINTERESTING
) &&
1566 !(revs
->max_age
!= -1 && commit
->date
< revs
->max_age
)))
1567 pass_blame(sb
, suspect
, opt
);
1569 commit
->object
.flags
|= UNINTERESTING
;
1570 if (commit
->object
.parsed
)
1571 mark_parents_uninteresting(commit
);
1573 /* treat root commit as boundary */
1574 if (!commit
->parents
&& !show_root
)
1575 commit
->object
.flags
|= UNINTERESTING
;
1577 /* Take responsibility for the remaining entries */
1578 for (ent
= sb
->ent
; ent
; ent
= ent
->next
)
1579 if (same_suspect(ent
->suspect
, suspect
))
1580 found_guilty_entry(ent
);
1581 origin_decref(suspect
);
1583 if (DEBUG
) /* sanity */
1584 sanity_check_refcnt(sb
);
1588 static const char *format_time(unsigned long time
, const char *tz_str
,
1591 static char time_buf
[128];
1596 if (show_raw_time
) {
1597 sprintf(time_buf
, "%lu %s", time
, tz_str
);
1602 minutes
= tz
< 0 ? -tz
: tz
;
1603 minutes
= (minutes
/ 100)*60 + (minutes
% 100);
1604 minutes
= tz
< 0 ? -minutes
: minutes
;
1605 t
= time
+ minutes
* 60;
1608 strftime(time_buf
, sizeof(time_buf
), "%Y-%m-%d %H:%M:%S ", tm
);
1609 strcat(time_buf
, tz_str
);
1613 #define OUTPUT_ANNOTATE_COMPAT 001
1614 #define OUTPUT_LONG_OBJECT_NAME 002
1615 #define OUTPUT_RAW_TIMESTAMP 004
1616 #define OUTPUT_PORCELAIN 010
1617 #define OUTPUT_SHOW_NAME 020
1618 #define OUTPUT_SHOW_NUMBER 040
1619 #define OUTPUT_SHOW_SCORE 0100
1620 #define OUTPUT_NO_AUTHOR 0200
1622 static void emit_porcelain(struct scoreboard
*sb
, struct blame_entry
*ent
)
1626 struct origin
*suspect
= ent
->suspect
;
1629 strcpy(hex
, sha1_to_hex(suspect
->commit
->object
.sha1
));
1630 printf("%s%c%d %d %d\n",
1632 ent
->guilty
? ' ' : '*', // purely for debugging
1636 if (!(suspect
->commit
->object
.flags
& METAINFO_SHOWN
)) {
1637 struct commit_info ci
;
1638 suspect
->commit
->object
.flags
|= METAINFO_SHOWN
;
1639 get_commit_info(suspect
->commit
, &ci
, 1);
1640 printf("author %s\n", ci
.author
);
1641 printf("author-mail %s\n", ci
.author_mail
);
1642 printf("author-time %lu\n", ci
.author_time
);
1643 printf("author-tz %s\n", ci
.author_tz
);
1644 printf("committer %s\n", ci
.committer
);
1645 printf("committer-mail %s\n", ci
.committer_mail
);
1646 printf("committer-time %lu\n", ci
.committer_time
);
1647 printf("committer-tz %s\n", ci
.committer_tz
);
1648 write_filename_info(suspect
->path
);
1649 printf("summary %s\n", ci
.summary
);
1650 if (suspect
->commit
->object
.flags
& UNINTERESTING
)
1651 printf("boundary\n");
1653 else if (suspect
->commit
->object
.flags
& MORE_THAN_ONE_PATH
)
1654 write_filename_info(suspect
->path
);
1656 cp
= nth_line(sb
, ent
->lno
);
1657 for (cnt
= 0; cnt
< ent
->num_lines
; cnt
++) {
1660 printf("%s %d %d\n", hex
,
1661 ent
->s_lno
+ 1 + cnt
,
1662 ent
->lno
+ 1 + cnt
);
1667 } while (ch
!= '\n' &&
1668 cp
< sb
->final_buf
+ sb
->final_buf_size
);
1672 static void emit_other(struct scoreboard
*sb
, struct blame_entry
*ent
, int opt
)
1676 struct origin
*suspect
= ent
->suspect
;
1677 struct commit_info ci
;
1679 int show_raw_time
= !!(opt
& OUTPUT_RAW_TIMESTAMP
);
1681 get_commit_info(suspect
->commit
, &ci
, 1);
1682 strcpy(hex
, sha1_to_hex(suspect
->commit
->object
.sha1
));
1684 cp
= nth_line(sb
, ent
->lno
);
1685 for (cnt
= 0; cnt
< ent
->num_lines
; cnt
++) {
1687 int length
= (opt
& OUTPUT_LONG_OBJECT_NAME
) ? 40 : 8;
1689 if (suspect
->commit
->object
.flags
& UNINTERESTING
) {
1691 memset(hex
, ' ', length
);
1692 else if (!(opt
& OUTPUT_ANNOTATE_COMPAT
)) {
1698 printf("%.*s", length
, hex
);
1699 if (opt
& OUTPUT_ANNOTATE_COMPAT
)
1700 printf("\t(%10s\t%10s\t%d)", ci
.author
,
1701 format_time(ci
.author_time
, ci
.author_tz
,
1703 ent
->lno
+ 1 + cnt
);
1705 if (opt
& OUTPUT_SHOW_SCORE
)
1707 max_score_digits
, ent
->score
,
1708 ent
->suspect
->refcnt
);
1709 if (opt
& OUTPUT_SHOW_NAME
)
1710 printf(" %-*.*s", longest_file
, longest_file
,
1712 if (opt
& OUTPUT_SHOW_NUMBER
)
1713 printf(" %*d", max_orig_digits
,
1714 ent
->s_lno
+ 1 + cnt
);
1716 if (!(opt
& OUTPUT_NO_AUTHOR
))
1717 printf(" (%-*.*s %10s",
1718 longest_author
, longest_author
,
1720 format_time(ci
.author_time
,
1724 max_digits
, ent
->lno
+ 1 + cnt
);
1729 } while (ch
!= '\n' &&
1730 cp
< sb
->final_buf
+ sb
->final_buf_size
);
1734 static void output(struct scoreboard
*sb
, int option
)
1736 struct blame_entry
*ent
;
1738 if (option
& OUTPUT_PORCELAIN
) {
1739 for (ent
= sb
->ent
; ent
; ent
= ent
->next
) {
1740 struct blame_entry
*oth
;
1741 struct origin
*suspect
= ent
->suspect
;
1742 struct commit
*commit
= suspect
->commit
;
1743 if (commit
->object
.flags
& MORE_THAN_ONE_PATH
)
1745 for (oth
= ent
->next
; oth
; oth
= oth
->next
) {
1746 if ((oth
->suspect
->commit
!= commit
) ||
1747 !strcmp(oth
->suspect
->path
, suspect
->path
))
1749 commit
->object
.flags
|= MORE_THAN_ONE_PATH
;
1755 for (ent
= sb
->ent
; ent
; ent
= ent
->next
) {
1756 if (option
& OUTPUT_PORCELAIN
)
1757 emit_porcelain(sb
, ent
);
1759 emit_other(sb
, ent
, option
);
1765 * To allow quick access to the contents of nth line in the
1766 * final image, prepare an index in the scoreboard.
1768 static int prepare_lines(struct scoreboard
*sb
)
1770 const char *buf
= sb
->final_buf
;
1771 unsigned long len
= sb
->final_buf_size
;
1772 int num
= 0, incomplete
= 0, bol
= 1;
1774 if (len
&& buf
[len
-1] != '\n')
1775 incomplete
++; /* incomplete line at the end */
1778 sb
->lineno
= xrealloc(sb
->lineno
,
1779 sizeof(int* ) * (num
+ 1));
1780 sb
->lineno
[num
] = buf
- sb
->final_buf
;
1783 if (*buf
++ == '\n') {
1788 sb
->lineno
= xrealloc(sb
->lineno
,
1789 sizeof(int* ) * (num
+ incomplete
+ 1));
1790 sb
->lineno
[num
+ incomplete
] = buf
- sb
->final_buf
;
1791 sb
->num_lines
= num
+ incomplete
;
1792 return sb
->num_lines
;
1796 * Add phony grafts for use with -S; this is primarily to
1797 * support git's cvsserver that wants to give a linear history
1800 static int read_ancestry(const char *graft_file
)
1802 FILE *fp
= fopen(graft_file
, "r");
1806 while (fgets(buf
, sizeof(buf
), fp
)) {
1807 /* The format is just "Commit Parent1 Parent2 ...\n" */
1808 int len
= strlen(buf
);
1809 struct commit_graft
*graft
= read_graft_line(buf
, len
);
1811 register_commit_graft(graft
, 0);
1818 * How many columns do we need to show line numbers in decimal?
1820 static int lineno_width(int lines
)
1824 for (width
= 1, i
= 10; i
<= lines
+ 1; width
++)
1830 * How many columns do we need to show line numbers, authors,
1833 static void find_alignment(struct scoreboard
*sb
, int *option
)
1835 int longest_src_lines
= 0;
1836 int longest_dst_lines
= 0;
1837 unsigned largest_score
= 0;
1838 struct blame_entry
*e
;
1840 for (e
= sb
->ent
; e
; e
= e
->next
) {
1841 struct origin
*suspect
= e
->suspect
;
1842 struct commit_info ci
;
1845 if (strcmp(suspect
->path
, sb
->path
))
1846 *option
|= OUTPUT_SHOW_NAME
;
1847 num
= strlen(suspect
->path
);
1848 if (longest_file
< num
)
1850 if (!(suspect
->commit
->object
.flags
& METAINFO_SHOWN
)) {
1851 suspect
->commit
->object
.flags
|= METAINFO_SHOWN
;
1852 get_commit_info(suspect
->commit
, &ci
, 1);
1853 num
= strlen(ci
.author
);
1854 if (longest_author
< num
)
1855 longest_author
= num
;
1857 num
= e
->s_lno
+ e
->num_lines
;
1858 if (longest_src_lines
< num
)
1859 longest_src_lines
= num
;
1860 num
= e
->lno
+ e
->num_lines
;
1861 if (longest_dst_lines
< num
)
1862 longest_dst_lines
= num
;
1863 if (largest_score
< ent_score(sb
, e
))
1864 largest_score
= ent_score(sb
, e
);
1866 max_orig_digits
= lineno_width(longest_src_lines
);
1867 max_digits
= lineno_width(longest_dst_lines
);
1868 max_score_digits
= lineno_width(largest_score
);
1872 * For debugging -- origin is refcounted, and this asserts that
1873 * we do not underflow.
1875 static void sanity_check_refcnt(struct scoreboard
*sb
)
1878 struct blame_entry
*ent
;
1880 for (ent
= sb
->ent
; ent
; ent
= ent
->next
) {
1881 /* Nobody should have zero or negative refcnt */
1882 if (ent
->suspect
->refcnt
<= 0) {
1883 fprintf(stderr
, "%s in %s has negative refcnt %d\n",
1885 sha1_to_hex(ent
->suspect
->commit
->object
.sha1
),
1886 ent
->suspect
->refcnt
);
1890 for (ent
= sb
->ent
; ent
; ent
= ent
->next
) {
1891 /* Mark the ones that haven't been checked */
1892 if (0 < ent
->suspect
->refcnt
)
1893 ent
->suspect
->refcnt
= -ent
->suspect
->refcnt
;
1895 for (ent
= sb
->ent
; ent
; ent
= ent
->next
) {
1897 * ... then pick each and see if they have the the
1901 struct blame_entry
*e
;
1902 struct origin
*suspect
= ent
->suspect
;
1904 if (0 < suspect
->refcnt
)
1906 suspect
->refcnt
= -suspect
->refcnt
; /* Unmark */
1907 for (found
= 0, e
= sb
->ent
; e
; e
= e
->next
) {
1908 if (e
->suspect
!= suspect
)
1912 if (suspect
->refcnt
!= found
) {
1913 fprintf(stderr
, "%s in %s has refcnt %d, not %d\n",
1915 sha1_to_hex(ent
->suspect
->commit
->object
.sha1
),
1916 ent
->suspect
->refcnt
, found
);
1922 find_alignment(sb
, &opt
);
1924 die("Baa %d!", baa
);
1929 * Used for the command line parsing; check if the path exists
1930 * in the working tree.
1932 static int has_string_in_work_tree(const char *path
)
1935 return !lstat(path
, &st
);
1938 static unsigned parse_score(const char *arg
)
1941 unsigned long score
= strtoul(arg
, &end
, 10);
1947 static const char *add_prefix(const char *prefix
, const char *path
)
1949 return prefix_path(prefix
, prefix
? strlen(prefix
) : 0, path
);
1953 * Parsing of (comma separated) one item in the -L option
1955 static const char *parse_loc(const char *spec
,
1956 struct scoreboard
*sb
, long lno
,
1957 long begin
, long *ret
)
1964 regmatch_t match
[1];
1966 /* Allow "-L <something>,+20" to mean starting at <something>
1967 * for 20 lines, or "-L <something>,-5" for 5 lines ending at
1970 if (1 < begin
&& (spec
[0] == '+' || spec
[0] == '-')) {
1971 num
= strtol(spec
+ 1, &term
, 10);
1972 if (term
!= spec
+ 1) {
1976 *ret
= begin
+ num
- 2;
1985 num
= strtol(spec
, &term
, 10);
1993 /* it could be a regexp of form /.../ */
1994 for (term
= (char*) spec
+ 1; *term
&& *term
!= '/'; term
++) {
2001 /* try [spec+1 .. term-1] as regexp */
2003 begin
--; /* input is in human terms */
2004 line
= nth_line(sb
, begin
);
2006 if (!(reg_error
= regcomp(®exp
, spec
+ 1, REG_NEWLINE
)) &&
2007 !(reg_error
= regexec(®exp
, line
, 1, match
, 0))) {
2008 const char *cp
= line
+ match
[0].rm_so
;
2011 while (begin
++ < lno
) {
2012 nline
= nth_line(sb
, begin
);
2013 if (line
<= cp
&& cp
< nline
)
2024 regerror(reg_error
, ®exp
, errbuf
, 1024);
2025 die("-L parameter '%s': %s", spec
+ 1, errbuf
);
2030 * Parsing of -L option
2032 static void prepare_blame_range(struct scoreboard
*sb
,
2033 const char *bottomtop
,
2035 long *bottom
, long *top
)
2039 term
= parse_loc(bottomtop
, sb
, lno
, 1, bottom
);
2041 term
= parse_loc(term
+ 1, sb
, lno
, *bottom
+ 1, top
);
2049 static int git_blame_config(const char *var
, const char *value
, void *cb
)
2051 if (!strcmp(var
, "blame.showroot")) {
2052 show_root
= git_config_bool(var
, value
);
2055 if (!strcmp(var
, "blame.blankboundary")) {
2056 blank_boundary
= git_config_bool(var
, value
);
2059 return git_default_config(var
, value
, cb
);
2063 * Prepare a dummy commit that represents the work tree (or staged) item.
2064 * Note that annotating work tree item never works in the reverse.
2066 static struct commit
*fake_working_tree_commit(const char *path
, const char *contents_from
)
2068 struct commit
*commit
;
2069 struct origin
*origin
;
2070 unsigned char head_sha1
[20];
2071 struct strbuf buf
= STRBUF_INIT
;
2075 struct cache_entry
*ce
;
2078 if (get_sha1("HEAD", head_sha1
))
2079 die("No such ref: HEAD");
2082 commit
= xcalloc(1, sizeof(*commit
));
2083 commit
->parents
= xcalloc(1, sizeof(*commit
->parents
));
2084 commit
->parents
->item
= lookup_commit_reference(head_sha1
);
2085 commit
->object
.parsed
= 1;
2087 commit
->object
.type
= OBJ_COMMIT
;
2089 origin
= make_origin(commit
, path
);
2091 if (!contents_from
|| strcmp("-", contents_from
)) {
2093 const char *read_from
;
2094 unsigned long fin_size
;
2096 if (contents_from
) {
2097 if (stat(contents_from
, &st
) < 0)
2098 die("Cannot stat %s", contents_from
);
2099 read_from
= contents_from
;
2102 if (lstat(path
, &st
) < 0)
2103 die("Cannot lstat %s", path
);
2106 fin_size
= xsize_t(st
.st_size
);
2107 mode
= canon_mode(st
.st_mode
);
2108 switch (st
.st_mode
& S_IFMT
) {
2110 if (strbuf_read_file(&buf
, read_from
, st
.st_size
) != st
.st_size
)
2111 die("cannot open or read %s", read_from
);
2114 if (readlink(read_from
, buf
.buf
, buf
.alloc
) != fin_size
)
2115 die("cannot readlink %s", read_from
);
2119 die("unsupported file type %s", read_from
);
2123 /* Reading from stdin */
2124 contents_from
= "standard input";
2126 if (strbuf_read(&buf
, 0, 0) < 0)
2127 die("read error %s from stdin", strerror(errno
));
2129 convert_to_git(path
, buf
.buf
, buf
.len
, &buf
, 0);
2130 origin
->file
.ptr
= buf
.buf
;
2131 origin
->file
.size
= buf
.len
;
2132 pretend_sha1_file(buf
.buf
, buf
.len
, OBJ_BLOB
, origin
->blob_sha1
);
2133 commit
->util
= origin
;
2136 * Read the current index, replace the path entry with
2137 * origin->blob_sha1 without mucking with its mode or type
2138 * bits; we are not going to write this index out -- we just
2139 * want to run "diff-index --cached".
2146 int pos
= cache_name_pos(path
, len
);
2148 mode
= active_cache
[pos
]->ce_mode
;
2150 /* Let's not bother reading from HEAD tree */
2151 mode
= S_IFREG
| 0644;
2153 size
= cache_entry_size(len
);
2154 ce
= xcalloc(1, size
);
2155 hashcpy(ce
->sha1
, origin
->blob_sha1
);
2156 memcpy(ce
->name
, path
, len
);
2157 ce
->ce_flags
= create_ce_flags(len
, 0);
2158 ce
->ce_mode
= create_ce_mode(mode
);
2159 add_cache_entry(ce
, ADD_CACHE_OK_TO_ADD
|ADD_CACHE_OK_TO_REPLACE
);
2162 * We are not going to write this out, so this does not matter
2163 * right now, but someday we might optimize diff-index --cached
2164 * with cache-tree information.
2166 cache_tree_invalidate_path(active_cache_tree
, path
);
2168 commit
->buffer
= xmalloc(400);
2169 ident
= fmt_ident("Not Committed Yet", "not.committed.yet", NULL
, 0);
2170 snprintf(commit
->buffer
, 400,
2171 "tree 0000000000000000000000000000000000000000\n"
2175 "Version of %s from %s\n",
2176 sha1_to_hex(head_sha1
),
2177 ident
, ident
, path
, contents_from
? contents_from
: path
);
2181 static const char *prepare_final(struct scoreboard
*sb
)
2184 const char *final_commit_name
= NULL
;
2185 struct rev_info
*revs
= sb
->revs
;
2188 * There must be one and only one positive commit in the
2189 * revs->pending array.
2191 for (i
= 0; i
< revs
->pending
.nr
; i
++) {
2192 struct object
*obj
= revs
->pending
.objects
[i
].item
;
2193 if (obj
->flags
& UNINTERESTING
)
2195 while (obj
->type
== OBJ_TAG
)
2196 obj
= deref_tag(obj
, NULL
, 0);
2197 if (obj
->type
!= OBJ_COMMIT
)
2198 die("Non commit %s?", revs
->pending
.objects
[i
].name
);
2200 die("More than one commit to dig from %s and %s?",
2201 revs
->pending
.objects
[i
].name
,
2203 sb
->final
= (struct commit
*) obj
;
2204 final_commit_name
= revs
->pending
.objects
[i
].name
;
2206 return final_commit_name
;
2209 static const char *prepare_initial(struct scoreboard
*sb
)
2212 const char *final_commit_name
= NULL
;
2213 struct rev_info
*revs
= sb
->revs
;
2216 * There must be one and only one negative commit, and it must be
2219 for (i
= 0; i
< revs
->pending
.nr
; i
++) {
2220 struct object
*obj
= revs
->pending
.objects
[i
].item
;
2221 if (!(obj
->flags
& UNINTERESTING
))
2223 while (obj
->type
== OBJ_TAG
)
2224 obj
= deref_tag(obj
, NULL
, 0);
2225 if (obj
->type
!= OBJ_COMMIT
)
2226 die("Non commit %s?", revs
->pending
.objects
[i
].name
);
2228 die("More than one commit to dig down to %s and %s?",
2229 revs
->pending
.objects
[i
].name
,
2231 sb
->final
= (struct commit
*) obj
;
2232 final_commit_name
= revs
->pending
.objects
[i
].name
;
2234 if (!final_commit_name
)
2235 die("No commit to dig down to?");
2236 return final_commit_name
;
2239 static int blame_copy_callback(const struct option
*option
, const char *arg
, int unset
)
2241 int *opt
= option
->value
;
2244 * -C enables copy from removed files;
2245 * -C -C enables copy from existing files, but only
2246 * when blaming a new file;
2247 * -C -C -C enables copy from existing files for
2250 if (*opt
& PICKAXE_BLAME_COPY_HARDER
)
2251 *opt
|= PICKAXE_BLAME_COPY_HARDEST
;
2252 if (*opt
& PICKAXE_BLAME_COPY
)
2253 *opt
|= PICKAXE_BLAME_COPY_HARDER
;
2254 *opt
|= PICKAXE_BLAME_COPY
| PICKAXE_BLAME_MOVE
;
2257 blame_copy_score
= parse_score(arg
);
2261 static int blame_move_callback(const struct option
*option
, const char *arg
, int unset
)
2263 int *opt
= option
->value
;
2265 *opt
|= PICKAXE_BLAME_MOVE
;
2268 blame_move_score
= parse_score(arg
);
2272 static int blame_bottomtop_callback(const struct option
*option
, const char *arg
, int unset
)
2274 const char **bottomtop
= option
->value
;
2278 die("More than one '-L n,m' option given");
2283 int cmd_blame(int argc
, const char **argv
, const char *prefix
)
2285 struct rev_info revs
;
2287 struct scoreboard sb
;
2289 struct blame_entry
*ent
;
2290 long dashdash_pos
, bottom
, top
, lno
;
2291 const char *final_commit_name
= NULL
;
2292 enum object_type type
;
2294 static const char *bottomtop
= NULL
;
2295 static int output_option
= 0, opt
= 0;
2296 static int show_stats
= 0;
2297 static const char *revs_file
= NULL
;
2298 static const char *contents_from
= NULL
;
2299 static const struct option options
[] = {
2300 OPT_BOOLEAN(0, "incremental", &incremental
, "Show blame entries as we find them, incrementally"),
2301 OPT_BOOLEAN('b', NULL
, &blank_boundary
, "Show blank SHA-1 for boundary commits (Default: off)"),
2302 OPT_BOOLEAN(0, "root", &show_root
, "Do not treat root commits as boundaries (Default: off)"),
2303 OPT_BOOLEAN(0, "show-stats", &show_stats
, "Show work cost statistics"),
2304 OPT_BIT(0, "score-debug", &output_option
, "Show output score for blame entries", OUTPUT_SHOW_SCORE
),
2305 OPT_BIT('f', "show-name", &output_option
, "Show original filename (Default: auto)", OUTPUT_SHOW_NAME
),
2306 OPT_BIT('n', "show-number", &output_option
, "Show original linenumber (Default: off)", OUTPUT_SHOW_NUMBER
),
2307 OPT_BIT('p', "porcelain", &output_option
, "Show in a format designed for machine consumption", OUTPUT_PORCELAIN
),
2308 OPT_BIT('c', NULL
, &output_option
, "Use the same output mode as git-annotate (Default: off)", OUTPUT_ANNOTATE_COMPAT
),
2309 OPT_BIT('t', NULL
, &output_option
, "Show raw timestamp (Default: off)", OUTPUT_RAW_TIMESTAMP
),
2310 OPT_BIT('l', NULL
, &output_option
, "Show long commit SHA1 (Default: off)", OUTPUT_LONG_OBJECT_NAME
),
2311 OPT_BIT('s', NULL
, &output_option
, "Suppress author name and timestamp (Default: off)", OUTPUT_NO_AUTHOR
),
2312 OPT_BIT('w', NULL
, &xdl_opts
, "Ignore whitespace differences", XDF_IGNORE_WHITESPACE
),
2313 OPT_STRING('S', NULL
, &revs_file
, "file", "Use revisions from <file> instead of calling git-rev-list"),
2314 OPT_STRING(0, "contents", &contents_from
, "file", "Use <file>'s contents as the final image"),
2315 { OPTION_CALLBACK
, 'C', NULL
, &opt
, "score", "Find line copies within and across files", PARSE_OPT_OPTARG
, blame_copy_callback
},
2316 { OPTION_CALLBACK
, 'M', NULL
, &opt
, "score", "Find line movements within and across files", PARSE_OPT_OPTARG
, blame_move_callback
},
2317 OPT_CALLBACK('L', NULL
, &bottomtop
, "n,m", "Process only line range n,m, counting from 1", blame_bottomtop_callback
),
2321 struct parse_opt_ctx_t ctx
;
2322 int cmd_is_annotate
= !strcmp(argv
[0], "annotate");
2324 git_config(git_blame_config
, NULL
);
2325 init_revisions(&revs
, NULL
);
2326 save_commit_buffer
= 0;
2329 parse_options_start(&ctx
, argc
, argv
, PARSE_OPT_KEEP_DASHDASH
|
2330 PARSE_OPT_KEEP_ARGV0
);
2332 switch (parse_options_step(&ctx
, options
, blame_opt_usage
)) {
2333 case PARSE_OPT_HELP
:
2335 case PARSE_OPT_DONE
:
2337 dashdash_pos
= ctx
.cpidx
;
2341 if (!strcmp(ctx
.argv
[0], "--reverse")) {
2342 ctx
.argv
[0] = "--children";
2345 parse_revision_opt(&revs
, &ctx
, options
, blame_opt_usage
);
2348 argc
= parse_options_end(&ctx
);
2350 if (cmd_is_annotate
)
2351 output_option
|= OUTPUT_ANNOTATE_COMPAT
;
2353 if (DIFF_OPT_TST(&revs
.diffopt
, FIND_COPIES_HARDER
))
2354 opt
|= (PICKAXE_BLAME_COPY
| PICKAXE_BLAME_MOVE
|
2355 PICKAXE_BLAME_COPY_HARDER
);
2357 if (!blame_move_score
)
2358 blame_move_score
= BLAME_DEFAULT_MOVE_SCORE
;
2359 if (!blame_copy_score
)
2360 blame_copy_score
= BLAME_DEFAULT_COPY_SCORE
;
2363 * We have collected options unknown to us in argv[1..unk]
2364 * which are to be passed to revision machinery if we are
2365 * going to do the "bottom" processing.
2367 * The remaining are:
2369 * (1) if dashdash_pos != 0, its either
2370 * "blame [revisions] -- <path>" or
2371 * "blame -- <path> <rev>"
2373 * (2) otherwise, its one of the two:
2374 * "blame [revisions] <path>"
2375 * "blame <path> <rev>"
2377 * Note that we must strip out <path> from the arguments: we do not
2378 * want the path pruning but we may want "bottom" processing.
2381 switch (argc
- dashdash_pos
- 1) {
2384 usage_with_options(blame_opt_usage
, options
);
2385 /* reorder for the new way: <rev> -- <path> */
2391 path
= add_prefix(prefix
, argv
[--argc
]);
2395 usage_with_options(blame_opt_usage
, options
);
2399 usage_with_options(blame_opt_usage
, options
);
2400 path
= add_prefix(prefix
, argv
[argc
- 1]);
2401 if (argc
== 3 && !has_string_in_work_tree(path
)) { /* (2b) */
2402 path
= add_prefix(prefix
, argv
[1]);
2405 argv
[argc
- 1] = "--";
2408 if (!has_string_in_work_tree(path
))
2409 die("cannot stat path %s: %s", path
, strerror(errno
));
2412 setup_revisions(argc
, argv
, &revs
, NULL
);
2413 memset(&sb
, 0, sizeof(sb
));
2417 final_commit_name
= prepare_final(&sb
);
2418 else if (contents_from
)
2419 die("--contents and --children do not blend well.");
2421 final_commit_name
= prepare_initial(&sb
);
2425 * "--not A B -- path" without anything positive;
2426 * do not default to HEAD, but use the working tree
2430 sb
.final
= fake_working_tree_commit(path
, contents_from
);
2431 add_pending_object(&revs
, &(sb
.final
->object
), ":");
2433 else if (contents_from
)
2434 die("Cannot use --contents with final commit object name");
2437 * If we have bottom, this will mark the ancestors of the
2438 * bottom commits we would reach while traversing as
2441 if (prepare_revision_walk(&revs
))
2442 die("revision walk setup failed");
2444 if (is_null_sha1(sb
.final
->object
.sha1
)) {
2447 buf
= xmalloc(o
->file
.size
+ 1);
2448 memcpy(buf
, o
->file
.ptr
, o
->file
.size
+ 1);
2450 sb
.final_buf_size
= o
->file
.size
;
2453 o
= get_origin(&sb
, sb
.final
, path
);
2454 if (fill_blob_sha1(o
))
2455 die("no such path %s in %s", path
, final_commit_name
);
2457 sb
.final_buf
= read_sha1_file(o
->blob_sha1
, &type
,
2458 &sb
.final_buf_size
);
2460 die("Cannot read blob %s for path %s",
2461 sha1_to_hex(o
->blob_sha1
),
2465 lno
= prepare_lines(&sb
);
2469 prepare_blame_range(&sb
, bottomtop
, lno
, &bottom
, &top
);
2470 if (bottom
&& top
&& top
< bottom
) {
2472 tmp
= top
; top
= bottom
; bottom
= tmp
;
2480 die("file %s has only %lu lines", path
, lno
);
2482 ent
= xcalloc(1, sizeof(*ent
));
2484 ent
->num_lines
= top
- bottom
;
2486 ent
->s_lno
= bottom
;
2491 if (revs_file
&& read_ancestry(revs_file
))
2492 die("reading graft file %s failed: %s",
2493 revs_file
, strerror(errno
));
2495 read_mailmap(&mailmap
, ".mailmap", NULL
);
2500 assign_blame(&sb
, opt
);
2507 if (!(output_option
& OUTPUT_PORCELAIN
))
2508 find_alignment(&sb
, &output_option
);
2510 output(&sb
, output_option
);
2511 free((void *)sb
.final_buf
);
2512 for (ent
= sb
.ent
; ent
; ) {
2513 struct blame_entry
*e
= ent
->next
;
2519 printf("num read blob: %d\n", num_read_blob
);
2520 printf("num get patch: %d\n", num_get_patch
);
2521 printf("num commits: %d\n", num_commits
);