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"
24 static char blame_usage
[] = "git blame [options] [rev-opts] [rev] [--] file";
26 static const char *blame_opt_usage
[] = {
29 "[rev-opts] are documented in git-rev-list(1)",
33 static int longest_file
;
34 static int longest_author
;
35 static int max_orig_digits
;
36 static int max_digits
;
37 static int max_score_digits
;
40 static int blank_boundary
;
41 static int incremental
;
42 static int xdl_opts
= XDF_NEED_MINIMAL
;
43 static struct string_list mailmap
;
50 static int num_read_blob
;
51 static int num_get_patch
;
52 static int num_commits
;
54 #define PICKAXE_BLAME_MOVE 01
55 #define PICKAXE_BLAME_COPY 02
56 #define PICKAXE_BLAME_COPY_HARDER 04
57 #define PICKAXE_BLAME_COPY_HARDEST 010
60 * blame for a blame_entry with score lower than these thresholds
61 * is not passed to the parent using move/copy logic.
63 static unsigned blame_move_score
;
64 static unsigned blame_copy_score
;
65 #define BLAME_DEFAULT_MOVE_SCORE 20
66 #define BLAME_DEFAULT_COPY_SCORE 40
68 /* bits #0..7 in revision.h, #8..11 used for merge_bases() in commit.c */
69 #define METAINFO_SHOWN (1u<<12)
70 #define MORE_THAN_ONE_PATH (1u<<13)
73 * One blob in a commit that is being suspected
77 struct commit
*commit
;
79 unsigned char blob_sha1
[20];
80 char path
[FLEX_ARRAY
];
84 * Given an origin, prepare mmfile_t structure to be used by the
87 static void fill_origin_blob(struct origin
*o
, mmfile_t
*file
)
90 enum object_type type
;
92 file
->ptr
= read_sha1_file(o
->blob_sha1
, &type
,
93 (unsigned long *)(&(file
->size
)));
95 die("Cannot read blob %s for path %s",
96 sha1_to_hex(o
->blob_sha1
),
105 * Origin is refcounted and usually we keep the blob contents to be
108 static inline struct origin
*origin_incref(struct origin
*o
)
115 static void origin_decref(struct origin
*o
)
117 if (o
&& --o
->refcnt
<= 0) {
123 static void drop_origin_blob(struct origin
*o
)
132 * Each group of lines is described by a blame_entry; it can be split
133 * as we pass blame to the parents. They form a linked list in the
134 * scoreboard structure, sorted by the target line number.
137 struct blame_entry
*prev
;
138 struct blame_entry
*next
;
140 /* the first line of this group in the final image;
141 * internally all line numbers are 0 based.
145 /* how many lines this group has */
148 /* the commit that introduced this group into the final image */
149 struct origin
*suspect
;
151 /* true if the suspect is truly guilty; false while we have not
152 * checked if the group came from one of its parents.
156 /* true if the entry has been scanned for copies in the current parent
160 /* the line number of the first line of this group in the
161 * suspect's file; internally all line numbers are 0 based.
165 /* how significant this entry is -- cached to avoid
166 * scanning the lines over and over.
172 * The current state of the blame assignment.
175 /* the final commit (i.e. where we started digging from) */
176 struct commit
*final
;
177 struct rev_info
*revs
;
181 * The contents in the final image.
182 * Used by many functions to obtain contents of the nth line,
183 * indexed with scoreboard.lineno[blame_entry.lno].
185 const char *final_buf
;
186 unsigned long final_buf_size
;
188 /* linked list of blames */
189 struct blame_entry
*ent
;
191 /* look-up a line in the final buffer */
196 static inline int same_suspect(struct origin
*a
, struct origin
*b
)
200 if (a
->commit
!= b
->commit
)
202 return !strcmp(a
->path
, b
->path
);
205 static void sanity_check_refcnt(struct scoreboard
*);
208 * If two blame entries that are next to each other came from
209 * contiguous lines in the same origin (i.e. <commit, path> pair),
210 * merge them together.
212 static void coalesce(struct scoreboard
*sb
)
214 struct blame_entry
*ent
, *next
;
216 for (ent
= sb
->ent
; ent
&& (next
= ent
->next
); ent
= next
) {
217 if (same_suspect(ent
->suspect
, next
->suspect
) &&
218 ent
->guilty
== next
->guilty
&&
219 ent
->s_lno
+ ent
->num_lines
== next
->s_lno
) {
220 ent
->num_lines
+= next
->num_lines
;
221 ent
->next
= next
->next
;
223 ent
->next
->prev
= ent
;
224 origin_decref(next
->suspect
);
227 next
= ent
; /* again */
231 if (DEBUG
) /* sanity */
232 sanity_check_refcnt(sb
);
236 * Given a commit and a path in it, create a new origin structure.
237 * The callers that add blame to the scoreboard should use
238 * get_origin() to obtain shared, refcounted copy instead of calling
239 * this function directly.
241 static struct origin
*make_origin(struct commit
*commit
, const char *path
)
244 o
= xcalloc(1, sizeof(*o
) + strlen(path
) + 1);
247 strcpy(o
->path
, path
);
252 * Locate an existing origin or create a new one.
254 static struct origin
*get_origin(struct scoreboard
*sb
,
255 struct commit
*commit
,
258 struct blame_entry
*e
;
260 for (e
= sb
->ent
; e
; e
= e
->next
) {
261 if (e
->suspect
->commit
== commit
&&
262 !strcmp(e
->suspect
->path
, path
))
263 return origin_incref(e
->suspect
);
265 return make_origin(commit
, path
);
269 * Fill the blob_sha1 field of an origin if it hasn't, so that later
270 * call to fill_origin_blob() can use it to locate the data. blob_sha1
271 * for an origin is also used to pass the blame for the entire file to
272 * the parent to detect the case where a child's blob is identical to
273 * that of its parent's.
275 static int fill_blob_sha1(struct origin
*origin
)
279 if (!is_null_sha1(origin
->blob_sha1
))
281 if (get_tree_entry(origin
->commit
->object
.sha1
,
283 origin
->blob_sha1
, &mode
))
285 if (sha1_object_info(origin
->blob_sha1
, NULL
) != OBJ_BLOB
)
289 hashclr(origin
->blob_sha1
);
294 * We have an origin -- check if the same path exists in the
295 * parent and return an origin structure to represent it.
297 static struct origin
*find_origin(struct scoreboard
*sb
,
298 struct commit
*parent
,
299 struct origin
*origin
)
301 struct origin
*porigin
= NULL
;
302 struct diff_options diff_opts
;
303 const char *paths
[2];
307 * Each commit object can cache one origin in that
308 * commit. This is a freestanding copy of origin and
311 struct origin
*cached
= parent
->util
;
312 if (!strcmp(cached
->path
, origin
->path
)) {
314 * The same path between origin and its parent
315 * without renaming -- the most common case.
317 porigin
= get_origin(sb
, parent
, cached
->path
);
320 * If the origin was newly created (i.e. get_origin
321 * would call make_origin if none is found in the
322 * scoreboard), it does not know the blob_sha1,
323 * so copy it. Otherwise porigin was in the
324 * scoreboard and already knows blob_sha1.
326 if (porigin
->refcnt
== 1)
327 hashcpy(porigin
->blob_sha1
, cached
->blob_sha1
);
330 /* otherwise it was not very useful; free it */
335 /* See if the origin->path is different between parent
336 * and origin first. Most of the time they are the
337 * same and diff-tree is fairly efficient about this.
339 diff_setup(&diff_opts
);
340 DIFF_OPT_SET(&diff_opts
, RECURSIVE
);
341 diff_opts
.detect_rename
= 0;
342 diff_opts
.output_format
= DIFF_FORMAT_NO_OUTPUT
;
343 paths
[0] = origin
->path
;
346 diff_tree_setup_paths(paths
, &diff_opts
);
347 if (diff_setup_done(&diff_opts
) < 0)
350 if (is_null_sha1(origin
->commit
->object
.sha1
))
351 do_diff_cache(parent
->tree
->object
.sha1
, &diff_opts
);
353 diff_tree_sha1(parent
->tree
->object
.sha1
,
354 origin
->commit
->tree
->object
.sha1
,
356 diffcore_std(&diff_opts
);
358 /* It is either one entry that says "modified", or "created",
361 if (!diff_queued_diff
.nr
) {
362 /* The path is the same as parent */
363 porigin
= get_origin(sb
, parent
, origin
->path
);
364 hashcpy(porigin
->blob_sha1
, origin
->blob_sha1
);
366 else if (diff_queued_diff
.nr
!= 1)
367 die("internal error in blame::find_origin");
369 struct diff_filepair
*p
= diff_queued_diff
.queue
[0];
372 die("internal error in blame::find_origin (%c)",
375 porigin
= get_origin(sb
, parent
, origin
->path
);
376 hashcpy(porigin
->blob_sha1
, p
->one
->sha1
);
380 /* Did not exist in parent, or type changed */
384 diff_flush(&diff_opts
);
385 diff_tree_release_paths(&diff_opts
);
388 * Create a freestanding copy that is not part of
389 * the refcounted origin found in the scoreboard, and
390 * cache it in the commit.
392 struct origin
*cached
;
394 cached
= make_origin(porigin
->commit
, porigin
->path
);
395 hashcpy(cached
->blob_sha1
, porigin
->blob_sha1
);
396 parent
->util
= cached
;
402 * We have an origin -- find the path that corresponds to it in its
403 * parent and return an origin structure to represent it.
405 static struct origin
*find_rename(struct scoreboard
*sb
,
406 struct commit
*parent
,
407 struct origin
*origin
)
409 struct origin
*porigin
= NULL
;
410 struct diff_options diff_opts
;
412 const char *paths
[2];
414 diff_setup(&diff_opts
);
415 DIFF_OPT_SET(&diff_opts
, RECURSIVE
);
416 diff_opts
.detect_rename
= DIFF_DETECT_RENAME
;
417 diff_opts
.output_format
= DIFF_FORMAT_NO_OUTPUT
;
418 diff_opts
.single_follow
= origin
->path
;
420 diff_tree_setup_paths(paths
, &diff_opts
);
421 if (diff_setup_done(&diff_opts
) < 0)
424 if (is_null_sha1(origin
->commit
->object
.sha1
))
425 do_diff_cache(parent
->tree
->object
.sha1
, &diff_opts
);
427 diff_tree_sha1(parent
->tree
->object
.sha1
,
428 origin
->commit
->tree
->object
.sha1
,
430 diffcore_std(&diff_opts
);
432 for (i
= 0; i
< diff_queued_diff
.nr
; i
++) {
433 struct diff_filepair
*p
= diff_queued_diff
.queue
[i
];
434 if ((p
->status
== 'R' || p
->status
== 'C') &&
435 !strcmp(p
->two
->path
, origin
->path
)) {
436 porigin
= get_origin(sb
, parent
, p
->one
->path
);
437 hashcpy(porigin
->blob_sha1
, p
->one
->sha1
);
441 diff_flush(&diff_opts
);
442 diff_tree_release_paths(&diff_opts
);
447 * Link in a new blame entry to the scoreboard. Entries that cover the
448 * same line range have been removed from the scoreboard previously.
450 static void add_blame_entry(struct scoreboard
*sb
, struct blame_entry
*e
)
452 struct blame_entry
*ent
, *prev
= NULL
;
454 origin_incref(e
->suspect
);
456 for (ent
= sb
->ent
; ent
&& ent
->lno
< e
->lno
; ent
= ent
->next
)
459 /* prev, if not NULL, is the last one that is below e */
462 e
->next
= prev
->next
;
474 * src typically is on-stack; we want to copy the information in it to
475 * a malloced blame_entry that is already on the linked list of the
476 * scoreboard. The origin of dst loses a refcnt while the origin of src
479 static void dup_entry(struct blame_entry
*dst
, struct blame_entry
*src
)
481 struct blame_entry
*p
, *n
;
485 origin_incref(src
->suspect
);
486 origin_decref(dst
->suspect
);
487 memcpy(dst
, src
, sizeof(*src
));
493 static const char *nth_line(struct scoreboard
*sb
, int lno
)
495 return sb
->final_buf
+ sb
->lineno
[lno
];
499 * It is known that lines between tlno to same came from parent, and e
500 * has an overlap with that range. it also is known that parent's
501 * line plno corresponds to e's line tlno.
507 * <------------------>
509 * Split e into potentially three parts; before this chunk, the chunk
510 * to be blamed for the parent, and after that portion.
512 static void split_overlap(struct blame_entry
*split
,
513 struct blame_entry
*e
,
514 int tlno
, int plno
, int same
,
515 struct origin
*parent
)
518 memset(split
, 0, sizeof(struct blame_entry
[3]));
520 if (e
->s_lno
< tlno
) {
521 /* there is a pre-chunk part not blamed on parent */
522 split
[0].suspect
= origin_incref(e
->suspect
);
523 split
[0].lno
= e
->lno
;
524 split
[0].s_lno
= e
->s_lno
;
525 split
[0].num_lines
= tlno
- e
->s_lno
;
526 split
[1].lno
= e
->lno
+ tlno
- e
->s_lno
;
527 split
[1].s_lno
= plno
;
530 split
[1].lno
= e
->lno
;
531 split
[1].s_lno
= plno
+ (e
->s_lno
- tlno
);
534 if (same
< e
->s_lno
+ e
->num_lines
) {
535 /* there is a post-chunk part not blamed on parent */
536 split
[2].suspect
= origin_incref(e
->suspect
);
537 split
[2].lno
= e
->lno
+ (same
- e
->s_lno
);
538 split
[2].s_lno
= e
->s_lno
+ (same
- e
->s_lno
);
539 split
[2].num_lines
= e
->s_lno
+ e
->num_lines
- same
;
540 chunk_end_lno
= split
[2].lno
;
543 chunk_end_lno
= e
->lno
+ e
->num_lines
;
544 split
[1].num_lines
= chunk_end_lno
- split
[1].lno
;
547 * if it turns out there is nothing to blame the parent for,
548 * forget about the splitting. !split[1].suspect signals this.
550 if (split
[1].num_lines
< 1)
552 split
[1].suspect
= origin_incref(parent
);
556 * split_overlap() divided an existing blame e into up to three parts
557 * in split. Adjust the linked list of blames in the scoreboard to
560 static void split_blame(struct scoreboard
*sb
,
561 struct blame_entry
*split
,
562 struct blame_entry
*e
)
564 struct blame_entry
*new_entry
;
566 if (split
[0].suspect
&& split
[2].suspect
) {
567 /* The first part (reuse storage for the existing entry e) */
568 dup_entry(e
, &split
[0]);
570 /* The last part -- me */
571 new_entry
= xmalloc(sizeof(*new_entry
));
572 memcpy(new_entry
, &(split
[2]), sizeof(struct blame_entry
));
573 add_blame_entry(sb
, new_entry
);
575 /* ... and the middle part -- parent */
576 new_entry
= xmalloc(sizeof(*new_entry
));
577 memcpy(new_entry
, &(split
[1]), sizeof(struct blame_entry
));
578 add_blame_entry(sb
, new_entry
);
580 else if (!split
[0].suspect
&& !split
[2].suspect
)
582 * The parent covers the entire area; reuse storage for
583 * e and replace it with the parent.
585 dup_entry(e
, &split
[1]);
586 else if (split
[0].suspect
) {
587 /* me and then parent */
588 dup_entry(e
, &split
[0]);
590 new_entry
= xmalloc(sizeof(*new_entry
));
591 memcpy(new_entry
, &(split
[1]), sizeof(struct blame_entry
));
592 add_blame_entry(sb
, new_entry
);
595 /* parent and then me */
596 dup_entry(e
, &split
[1]);
598 new_entry
= xmalloc(sizeof(*new_entry
));
599 memcpy(new_entry
, &(split
[2]), sizeof(struct blame_entry
));
600 add_blame_entry(sb
, new_entry
);
603 if (DEBUG
) { /* sanity */
604 struct blame_entry
*ent
;
605 int lno
= sb
->ent
->lno
, corrupt
= 0;
607 for (ent
= sb
->ent
; ent
; ent
= ent
->next
) {
612 lno
+= ent
->num_lines
;
616 for (ent
= sb
->ent
; ent
; ent
= ent
->next
) {
617 printf("L %8d l %8d n %8d\n",
618 lno
, ent
->lno
, ent
->num_lines
);
619 lno
= ent
->lno
+ ent
->num_lines
;
627 * After splitting the blame, the origins used by the
628 * on-stack blame_entry should lose one refcnt each.
630 static void decref_split(struct blame_entry
*split
)
634 for (i
= 0; i
< 3; i
++)
635 origin_decref(split
[i
].suspect
);
639 * Helper for blame_chunk(). blame_entry e is known to overlap with
640 * the patch hunk; split it and pass blame to the parent.
642 static void blame_overlap(struct scoreboard
*sb
, struct blame_entry
*e
,
643 int tlno
, int plno
, int same
,
644 struct origin
*parent
)
646 struct blame_entry split
[3];
648 split_overlap(split
, e
, tlno
, plno
, same
, parent
);
649 if (split
[1].suspect
)
650 split_blame(sb
, split
, e
);
655 * Find the line number of the last line the target is suspected for.
657 static int find_last_in_target(struct scoreboard
*sb
, struct origin
*target
)
659 struct blame_entry
*e
;
660 int last_in_target
= -1;
662 for (e
= sb
->ent
; e
; e
= e
->next
) {
663 if (e
->guilty
|| !same_suspect(e
->suspect
, target
))
665 if (last_in_target
< e
->s_lno
+ e
->num_lines
)
666 last_in_target
= e
->s_lno
+ e
->num_lines
;
668 return last_in_target
;
672 * Process one hunk from the patch between the current suspect for
673 * blame_entry e and its parent. Find and split the overlap, and
674 * pass blame to the overlapping part to the parent.
676 static void blame_chunk(struct scoreboard
*sb
,
677 int tlno
, int plno
, int same
,
678 struct origin
*target
, struct origin
*parent
)
680 struct blame_entry
*e
;
682 for (e
= sb
->ent
; e
; e
= e
->next
) {
683 if (e
->guilty
|| !same_suspect(e
->suspect
, target
))
685 if (same
<= e
->s_lno
)
687 if (tlno
< e
->s_lno
+ e
->num_lines
)
688 blame_overlap(sb
, e
, tlno
, plno
, same
, parent
);
692 struct blame_chunk_cb_data
{
693 struct scoreboard
*sb
;
694 struct origin
*target
;
695 struct origin
*parent
;
700 static void blame_chunk_cb(void *data
, long same
, long p_next
, long t_next
)
702 struct blame_chunk_cb_data
*d
= data
;
703 blame_chunk(d
->sb
, d
->tlno
, d
->plno
, same
, d
->target
, d
->parent
);
709 * We are looking at the origin 'target' and aiming to pass blame
710 * for the lines it is suspected to its parent. Run diff to find
711 * which lines came from parent and pass blame for them.
713 static int pass_blame_to_parent(struct scoreboard
*sb
,
714 struct origin
*target
,
715 struct origin
*parent
)
718 mmfile_t file_p
, file_o
;
719 struct blame_chunk_cb_data d
= { sb
, target
, parent
, 0, 0 };
723 last_in_target
= find_last_in_target(sb
, target
);
724 if (last_in_target
< 0)
725 return 1; /* nothing remains for this target */
727 fill_origin_blob(parent
, &file_p
);
728 fill_origin_blob(target
, &file_o
);
731 memset(&xpp
, 0, sizeof(xpp
));
732 xpp
.flags
= xdl_opts
;
733 memset(&xecfg
, 0, sizeof(xecfg
));
735 xdi_diff_hunks(&file_p
, &file_o
, blame_chunk_cb
, &d
, &xpp
, &xecfg
);
736 /* The rest (i.e. anything after tlno) are the same as the parent */
737 blame_chunk(sb
, d
.tlno
, d
.plno
, last_in_target
, target
, parent
);
743 * The lines in blame_entry after splitting blames many times can become
744 * very small and trivial, and at some point it becomes pointless to
745 * blame the parents. E.g. "\t\t}\n\t}\n\n" appears everywhere in any
746 * ordinary C program, and it is not worth to say it was copied from
747 * totally unrelated file in the parent.
749 * Compute how trivial the lines in the blame_entry are.
751 static unsigned ent_score(struct scoreboard
*sb
, struct blame_entry
*e
)
760 cp
= nth_line(sb
, e
->lno
);
761 ep
= nth_line(sb
, e
->lno
+ e
->num_lines
);
763 unsigned ch
= *((unsigned char *)cp
);
773 * best_so_far[] and this[] are both a split of an existing blame_entry
774 * that passes blame to the parent. Maintain best_so_far the best split
775 * so far, by comparing this and best_so_far and copying this into
776 * bst_so_far as needed.
778 static void copy_split_if_better(struct scoreboard
*sb
,
779 struct blame_entry
*best_so_far
,
780 struct blame_entry
*this)
784 if (!this[1].suspect
)
786 if (best_so_far
[1].suspect
) {
787 if (ent_score(sb
, &this[1]) < ent_score(sb
, &best_so_far
[1]))
791 for (i
= 0; i
< 3; i
++)
792 origin_incref(this[i
].suspect
);
793 decref_split(best_so_far
);
794 memcpy(best_so_far
, this, sizeof(struct blame_entry
[3]));
798 * We are looking at a part of the final image represented by
799 * ent (tlno and same are offset by ent->s_lno).
800 * tlno is where we are looking at in the final image.
801 * up to (but not including) same match preimage.
802 * plno is where we are looking at in the preimage.
804 * <-------------- final image ---------------------->
807 * <---------preimage----->
810 * All line numbers are 0-based.
812 static void handle_split(struct scoreboard
*sb
,
813 struct blame_entry
*ent
,
814 int tlno
, int plno
, int same
,
815 struct origin
*parent
,
816 struct blame_entry
*split
)
818 if (ent
->num_lines
<= tlno
)
821 struct blame_entry
this[3];
824 split_overlap(this, ent
, tlno
, plno
, same
, parent
);
825 copy_split_if_better(sb
, split
, this);
830 struct handle_split_cb_data
{
831 struct scoreboard
*sb
;
832 struct blame_entry
*ent
;
833 struct origin
*parent
;
834 struct blame_entry
*split
;
839 static void handle_split_cb(void *data
, long same
, long p_next
, long t_next
)
841 struct handle_split_cb_data
*d
= data
;
842 handle_split(d
->sb
, d
->ent
, d
->tlno
, d
->plno
, same
, d
->parent
, d
->split
);
848 * Find the lines from parent that are the same as ent so that
849 * we can pass blames to it. file_p has the blob contents for
852 static void find_copy_in_blob(struct scoreboard
*sb
,
853 struct blame_entry
*ent
,
854 struct origin
*parent
,
855 struct blame_entry
*split
,
861 struct handle_split_cb_data d
= { sb
, ent
, parent
, split
, 0, 0 };
866 * Prepare mmfile that contains only the lines in ent.
868 cp
= nth_line(sb
, ent
->lno
);
869 file_o
.ptr
= (char*) cp
;
870 cnt
= ent
->num_lines
;
872 while (cnt
&& cp
< sb
->final_buf
+ sb
->final_buf_size
) {
876 file_o
.size
= cp
- file_o
.ptr
;
879 * file_o is a part of final image we are annotating.
880 * file_p partially may match that image.
882 memset(&xpp
, 0, sizeof(xpp
));
883 xpp
.flags
= xdl_opts
;
884 memset(&xecfg
, 0, sizeof(xecfg
));
886 memset(split
, 0, sizeof(struct blame_entry
[3]));
887 xdi_diff_hunks(file_p
, &file_o
, handle_split_cb
, &d
, &xpp
, &xecfg
);
888 /* remainder, if any, all match the preimage */
889 handle_split(sb
, ent
, d
.tlno
, d
.plno
, ent
->num_lines
, parent
, split
);
893 * See if lines currently target is suspected for can be attributed to
896 static int find_move_in_parent(struct scoreboard
*sb
,
897 struct origin
*target
,
898 struct origin
*parent
)
900 int last_in_target
, made_progress
;
901 struct blame_entry
*e
, split
[3];
904 last_in_target
= find_last_in_target(sb
, target
);
905 if (last_in_target
< 0)
906 return 1; /* nothing remains for this target */
908 fill_origin_blob(parent
, &file_p
);
913 while (made_progress
) {
915 for (e
= sb
->ent
; e
; e
= e
->next
) {
916 if (e
->guilty
|| !same_suspect(e
->suspect
, target
) ||
917 ent_score(sb
, e
) < blame_move_score
)
919 find_copy_in_blob(sb
, e
, parent
, split
, &file_p
);
920 if (split
[1].suspect
&&
921 blame_move_score
< ent_score(sb
, &split
[1])) {
922 split_blame(sb
, split
, e
);
932 struct blame_entry
*ent
;
933 struct blame_entry split
[3];
937 * Count the number of entries the target is suspected for,
938 * and prepare a list of entry and the best split.
940 static struct blame_list
*setup_blame_list(struct scoreboard
*sb
,
941 struct origin
*target
,
945 struct blame_entry
*e
;
947 struct blame_list
*blame_list
= NULL
;
949 for (e
= sb
->ent
, num_ents
= 0; e
; e
= e
->next
)
950 if (!e
->scanned
&& !e
->guilty
&&
951 same_suspect(e
->suspect
, target
) &&
952 min_score
< ent_score(sb
, e
))
955 blame_list
= xcalloc(num_ents
, sizeof(struct blame_list
));
956 for (e
= sb
->ent
, i
= 0; e
; e
= e
->next
)
957 if (!e
->scanned
&& !e
->guilty
&&
958 same_suspect(e
->suspect
, target
) &&
959 min_score
< ent_score(sb
, e
))
960 blame_list
[i
++].ent
= e
;
962 *num_ents_p
= num_ents
;
967 * Reset the scanned status on all entries.
969 static void reset_scanned_flag(struct scoreboard
*sb
)
971 struct blame_entry
*e
;
972 for (e
= sb
->ent
; e
; e
= e
->next
)
977 * For lines target is suspected for, see if we can find code movement
978 * across file boundary from the parent commit. porigin is the path
979 * in the parent we already tried.
981 static int find_copy_in_parent(struct scoreboard
*sb
,
982 struct origin
*target
,
983 struct commit
*parent
,
984 struct origin
*porigin
,
987 struct diff_options diff_opts
;
988 const char *paths
[1];
991 struct blame_list
*blame_list
;
994 blame_list
= setup_blame_list(sb
, target
, blame_copy_score
, &num_ents
);
996 return 1; /* nothing remains for this target */
998 diff_setup(&diff_opts
);
999 DIFF_OPT_SET(&diff_opts
, RECURSIVE
);
1000 diff_opts
.output_format
= DIFF_FORMAT_NO_OUTPUT
;
1003 diff_tree_setup_paths(paths
, &diff_opts
);
1004 if (diff_setup_done(&diff_opts
) < 0)
1007 /* Try "find copies harder" on new path if requested;
1008 * we do not want to use diffcore_rename() actually to
1009 * match things up; find_copies_harder is set only to
1010 * force diff_tree_sha1() to feed all filepairs to diff_queue,
1011 * and this code needs to be after diff_setup_done(), which
1012 * usually makes find-copies-harder imply copy detection.
1014 if ((opt
& PICKAXE_BLAME_COPY_HARDEST
)
1015 || ((opt
& PICKAXE_BLAME_COPY_HARDER
)
1016 && (!porigin
|| strcmp(target
->path
, porigin
->path
))))
1017 DIFF_OPT_SET(&diff_opts
, FIND_COPIES_HARDER
);
1019 if (is_null_sha1(target
->commit
->object
.sha1
))
1020 do_diff_cache(parent
->tree
->object
.sha1
, &diff_opts
);
1022 diff_tree_sha1(parent
->tree
->object
.sha1
,
1023 target
->commit
->tree
->object
.sha1
,
1026 if (!DIFF_OPT_TST(&diff_opts
, FIND_COPIES_HARDER
))
1027 diffcore_std(&diff_opts
);
1031 int made_progress
= 0;
1033 for (i
= 0; i
< diff_queued_diff
.nr
; i
++) {
1034 struct diff_filepair
*p
= diff_queued_diff
.queue
[i
];
1035 struct origin
*norigin
;
1037 struct blame_entry
this[3];
1039 if (!DIFF_FILE_VALID(p
->one
))
1040 continue; /* does not exist in parent */
1041 if (S_ISGITLINK(p
->one
->mode
))
1042 continue; /* ignore git links */
1043 if (porigin
&& !strcmp(p
->one
->path
, porigin
->path
))
1044 /* find_move already dealt with this path */
1047 norigin
= get_origin(sb
, parent
, p
->one
->path
);
1048 hashcpy(norigin
->blob_sha1
, p
->one
->sha1
);
1049 fill_origin_blob(norigin
, &file_p
);
1053 for (j
= 0; j
< num_ents
; j
++) {
1054 find_copy_in_blob(sb
, blame_list
[j
].ent
,
1055 norigin
, this, &file_p
);
1056 copy_split_if_better(sb
, blame_list
[j
].split
,
1060 origin_decref(norigin
);
1063 for (j
= 0; j
< num_ents
; j
++) {
1064 struct blame_entry
*split
= blame_list
[j
].split
;
1065 if (split
[1].suspect
&&
1066 blame_copy_score
< ent_score(sb
, &split
[1])) {
1067 split_blame(sb
, split
, blame_list
[j
].ent
);
1071 blame_list
[j
].ent
->scanned
= 1;
1072 decref_split(split
);
1078 blame_list
= setup_blame_list(sb
, target
, blame_copy_score
, &num_ents
);
1084 reset_scanned_flag(sb
);
1085 diff_flush(&diff_opts
);
1086 diff_tree_release_paths(&diff_opts
);
1091 * The blobs of origin and porigin exactly match, so everything
1092 * origin is suspected for can be blamed on the parent.
1094 static void pass_whole_blame(struct scoreboard
*sb
,
1095 struct origin
*origin
, struct origin
*porigin
)
1097 struct blame_entry
*e
;
1099 if (!porigin
->file
.ptr
&& origin
->file
.ptr
) {
1100 /* Steal its file */
1101 porigin
->file
= origin
->file
;
1102 origin
->file
.ptr
= NULL
;
1104 for (e
= sb
->ent
; e
; e
= e
->next
) {
1105 if (!same_suspect(e
->suspect
, origin
))
1107 origin_incref(porigin
);
1108 origin_decref(e
->suspect
);
1109 e
->suspect
= porigin
;
1114 * We pass blame from the current commit to its parents. We keep saying
1115 * "parent" (and "porigin"), but what we mean is to find scapegoat to
1116 * exonerate ourselves.
1118 static struct commit_list
*first_scapegoat(struct rev_info
*revs
, struct commit
*commit
)
1121 return commit
->parents
;
1122 return lookup_decoration(&revs
->children
, &commit
->object
);
1125 static int num_scapegoats(struct rev_info
*revs
, struct commit
*commit
)
1128 struct commit_list
*l
= first_scapegoat(revs
, commit
);
1129 for (cnt
= 0; l
; l
= l
->next
)
1136 static void pass_blame(struct scoreboard
*sb
, struct origin
*origin
, int opt
)
1138 struct rev_info
*revs
= sb
->revs
;
1139 int i
, pass
, num_sg
;
1140 struct commit
*commit
= origin
->commit
;
1141 struct commit_list
*sg
;
1142 struct origin
*sg_buf
[MAXSG
];
1143 struct origin
*porigin
, **sg_origin
= sg_buf
;
1145 num_sg
= num_scapegoats(revs
, commit
);
1148 else if (num_sg
< ARRAY_SIZE(sg_buf
))
1149 memset(sg_buf
, 0, sizeof(sg_buf
));
1151 sg_origin
= xcalloc(num_sg
, sizeof(*sg_origin
));
1154 * The first pass looks for unrenamed path to optimize for
1155 * common cases, then we look for renames in the second pass.
1157 for (pass
= 0; pass
< 2; pass
++) {
1158 struct origin
*(*find
)(struct scoreboard
*,
1159 struct commit
*, struct origin
*);
1160 find
= pass
? find_rename
: find_origin
;
1162 for (i
= 0, sg
= first_scapegoat(revs
, commit
);
1164 sg
= sg
->next
, i
++) {
1165 struct commit
*p
= sg
->item
;
1170 if (parse_commit(p
))
1172 porigin
= find(sb
, p
, origin
);
1175 if (!hashcmp(porigin
->blob_sha1
, origin
->blob_sha1
)) {
1176 pass_whole_blame(sb
, origin
, porigin
);
1177 origin_decref(porigin
);
1180 for (j
= same
= 0; j
< i
; j
++)
1182 !hashcmp(sg_origin
[j
]->blob_sha1
,
1183 porigin
->blob_sha1
)) {
1188 sg_origin
[i
] = porigin
;
1190 origin_decref(porigin
);
1195 for (i
= 0, sg
= first_scapegoat(revs
, commit
);
1197 sg
= sg
->next
, i
++) {
1198 struct origin
*porigin
= sg_origin
[i
];
1201 if (pass_blame_to_parent(sb
, origin
, porigin
))
1206 * Optionally find moves in parents' files.
1208 if (opt
& PICKAXE_BLAME_MOVE
)
1209 for (i
= 0, sg
= first_scapegoat(revs
, commit
);
1211 sg
= sg
->next
, i
++) {
1212 struct origin
*porigin
= sg_origin
[i
];
1215 if (find_move_in_parent(sb
, origin
, porigin
))
1220 * Optionally find copies from parents' files.
1222 if (opt
& PICKAXE_BLAME_COPY
)
1223 for (i
= 0, sg
= first_scapegoat(revs
, commit
);
1225 sg
= sg
->next
, i
++) {
1226 struct origin
*porigin
= sg_origin
[i
];
1227 if (find_copy_in_parent(sb
, origin
, sg
->item
,
1233 for (i
= 0; i
< num_sg
; i
++) {
1235 drop_origin_blob(sg_origin
[i
]);
1236 origin_decref(sg_origin
[i
]);
1239 drop_origin_blob(origin
);
1240 if (sg_buf
!= sg_origin
)
1245 * Information on commits, used for output.
1250 const char *author_mail
;
1251 unsigned long author_time
;
1252 const char *author_tz
;
1254 /* filled only when asked for details */
1255 const char *committer
;
1256 const char *committer_mail
;
1257 unsigned long committer_time
;
1258 const char *committer_tz
;
1260 const char *summary
;
1264 * Parse author/committer line in the commit object buffer
1266 static void get_ac_line(const char *inbuf
, const char *what
,
1267 int person_len
, char *person
,
1268 int mail_len
, char *mail
,
1269 unsigned long *time
, const char **tz
)
1271 int len
, tzlen
, maillen
;
1272 char *tmp
, *endp
, *timepos
, *mailpos
;
1274 tmp
= strstr(inbuf
, what
);
1277 tmp
+= strlen(what
);
1278 endp
= strchr(tmp
, '\n');
1283 if (person_len
<= len
) {
1291 memcpy(person
, tmp
, len
);
1299 tzlen
= (person
+len
)-(tmp
+1);
1304 *time
= strtoul(tmp
, NULL
, 10);
1312 maillen
= timepos
- tmp
;
1313 memcpy(mail
, mailpos
, maillen
);
1319 * mailmap expansion may make the name longer.
1320 * make room by pushing stuff down.
1322 tmp
= person
+ person_len
- (tzlen
+ 1);
1323 memmove(tmp
, *tz
, tzlen
);
1328 * Now, convert both name and e-mail using mailmap
1330 if(map_user(&mailmap
, mail
+1, mail_len
-1, person
, tmp
-person
-1)) {
1331 /* Add a trailing '>' to email, since map_user returns plain emails
1332 Note: It already has '<', since we replace from mail+1 */
1333 mailpos
= memchr(mail
, '\0', mail_len
);
1334 if (mailpos
&& mailpos
-mail
< mail_len
- 1) {
1336 *(mailpos
+1) = '\0';
1341 static void get_commit_info(struct commit
*commit
,
1342 struct commit_info
*ret
,
1346 char *tmp
, *endp
, *reencoded
, *message
;
1347 static char author_name
[1024];
1348 static char author_mail
[1024];
1349 static char committer_name
[1024];
1350 static char committer_mail
[1024];
1351 static char summary_buf
[1024];
1354 * We've operated without save_commit_buffer, so
1355 * we now need to populate them for output.
1357 if (!commit
->buffer
) {
1358 enum object_type type
;
1361 read_sha1_file(commit
->object
.sha1
, &type
, &size
);
1362 if (!commit
->buffer
)
1363 die("Cannot read commit %s",
1364 sha1_to_hex(commit
->object
.sha1
));
1366 reencoded
= reencode_commit_message(commit
, NULL
);
1367 message
= reencoded
? reencoded
: commit
->buffer
;
1368 ret
->author
= author_name
;
1369 ret
->author_mail
= author_mail
;
1370 get_ac_line(message
, "\nauthor ",
1371 sizeof(author_name
), author_name
,
1372 sizeof(author_mail
), author_mail
,
1373 &ret
->author_time
, &ret
->author_tz
);
1380 ret
->committer
= committer_name
;
1381 ret
->committer_mail
= committer_mail
;
1382 get_ac_line(message
, "\ncommitter ",
1383 sizeof(committer_name
), committer_name
,
1384 sizeof(committer_mail
), committer_mail
,
1385 &ret
->committer_time
, &ret
->committer_tz
);
1387 ret
->summary
= summary_buf
;
1388 tmp
= strstr(message
, "\n\n");
1391 sprintf(summary_buf
, "(%s)", sha1_to_hex(commit
->object
.sha1
));
1396 endp
= strchr(tmp
, '\n');
1398 endp
= tmp
+ strlen(tmp
);
1400 if (len
>= sizeof(summary_buf
) || len
== 0)
1402 memcpy(summary_buf
, tmp
, len
);
1403 summary_buf
[len
] = 0;
1408 * To allow LF and other nonportable characters in pathnames,
1409 * they are c-style quoted as needed.
1411 static void write_filename_info(const char *path
)
1413 printf("filename ");
1414 write_name_quoted(path
, stdout
, '\n');
1418 * The blame_entry is found to be guilty for the range. Mark it
1419 * as such, and show it in incremental output.
1421 static void found_guilty_entry(struct blame_entry
*ent
)
1427 struct origin
*suspect
= ent
->suspect
;
1429 printf("%s %d %d %d\n",
1430 sha1_to_hex(suspect
->commit
->object
.sha1
),
1431 ent
->s_lno
+ 1, ent
->lno
+ 1, ent
->num_lines
);
1432 if (!(suspect
->commit
->object
.flags
& METAINFO_SHOWN
)) {
1433 struct commit_info ci
;
1434 suspect
->commit
->object
.flags
|= METAINFO_SHOWN
;
1435 get_commit_info(suspect
->commit
, &ci
, 1);
1436 printf("author %s\n", ci
.author
);
1437 printf("author-mail %s\n", ci
.author_mail
);
1438 printf("author-time %lu\n", ci
.author_time
);
1439 printf("author-tz %s\n", ci
.author_tz
);
1440 printf("committer %s\n", ci
.committer
);
1441 printf("committer-mail %s\n", ci
.committer_mail
);
1442 printf("committer-time %lu\n", ci
.committer_time
);
1443 printf("committer-tz %s\n", ci
.committer_tz
);
1444 printf("summary %s\n", ci
.summary
);
1445 if (suspect
->commit
->object
.flags
& UNINTERESTING
)
1446 printf("boundary\n");
1448 write_filename_info(suspect
->path
);
1449 maybe_flush_or_die(stdout
, "stdout");
1454 * The main loop -- while the scoreboard has lines whose true origin
1455 * is still unknown, pick one blame_entry, and allow its current
1456 * suspect to pass blames to its parents.
1458 static void assign_blame(struct scoreboard
*sb
, int opt
)
1460 struct rev_info
*revs
= sb
->revs
;
1463 struct blame_entry
*ent
;
1464 struct commit
*commit
;
1465 struct origin
*suspect
= NULL
;
1467 /* find one suspect to break down */
1468 for (ent
= sb
->ent
; !suspect
&& ent
; ent
= ent
->next
)
1470 suspect
= ent
->suspect
;
1472 return; /* all done */
1475 * We will use this suspect later in the loop,
1476 * so hold onto it in the meantime.
1478 origin_incref(suspect
);
1479 commit
= suspect
->commit
;
1480 if (!commit
->object
.parsed
)
1481 parse_commit(commit
);
1483 (!(commit
->object
.flags
& UNINTERESTING
) &&
1484 !(revs
->max_age
!= -1 && commit
->date
< revs
->max_age
)))
1485 pass_blame(sb
, suspect
, opt
);
1487 commit
->object
.flags
|= UNINTERESTING
;
1488 if (commit
->object
.parsed
)
1489 mark_parents_uninteresting(commit
);
1491 /* treat root commit as boundary */
1492 if (!commit
->parents
&& !show_root
)
1493 commit
->object
.flags
|= UNINTERESTING
;
1495 /* Take responsibility for the remaining entries */
1496 for (ent
= sb
->ent
; ent
; ent
= ent
->next
)
1497 if (same_suspect(ent
->suspect
, suspect
))
1498 found_guilty_entry(ent
);
1499 origin_decref(suspect
);
1501 if (DEBUG
) /* sanity */
1502 sanity_check_refcnt(sb
);
1506 static const char *format_time(unsigned long time
, const char *tz_str
,
1509 static char time_buf
[128];
1514 if (show_raw_time
) {
1515 sprintf(time_buf
, "%lu %s", time
, tz_str
);
1520 minutes
= tz
< 0 ? -tz
: tz
;
1521 minutes
= (minutes
/ 100)*60 + (minutes
% 100);
1522 minutes
= tz
< 0 ? -minutes
: minutes
;
1523 t
= time
+ minutes
* 60;
1526 strftime(time_buf
, sizeof(time_buf
), "%Y-%m-%d %H:%M:%S ", tm
);
1527 strcat(time_buf
, tz_str
);
1531 #define OUTPUT_ANNOTATE_COMPAT 001
1532 #define OUTPUT_LONG_OBJECT_NAME 002
1533 #define OUTPUT_RAW_TIMESTAMP 004
1534 #define OUTPUT_PORCELAIN 010
1535 #define OUTPUT_SHOW_NAME 020
1536 #define OUTPUT_SHOW_NUMBER 040
1537 #define OUTPUT_SHOW_SCORE 0100
1538 #define OUTPUT_NO_AUTHOR 0200
1540 static void emit_porcelain(struct scoreboard
*sb
, struct blame_entry
*ent
)
1544 struct origin
*suspect
= ent
->suspect
;
1547 strcpy(hex
, sha1_to_hex(suspect
->commit
->object
.sha1
));
1548 printf("%s%c%d %d %d\n",
1550 ent
->guilty
? ' ' : '*', // purely for debugging
1554 if (!(suspect
->commit
->object
.flags
& METAINFO_SHOWN
)) {
1555 struct commit_info ci
;
1556 suspect
->commit
->object
.flags
|= METAINFO_SHOWN
;
1557 get_commit_info(suspect
->commit
, &ci
, 1);
1558 printf("author %s\n", ci
.author
);
1559 printf("author-mail %s\n", ci
.author_mail
);
1560 printf("author-time %lu\n", ci
.author_time
);
1561 printf("author-tz %s\n", ci
.author_tz
);
1562 printf("committer %s\n", ci
.committer
);
1563 printf("committer-mail %s\n", ci
.committer_mail
);
1564 printf("committer-time %lu\n", ci
.committer_time
);
1565 printf("committer-tz %s\n", ci
.committer_tz
);
1566 write_filename_info(suspect
->path
);
1567 printf("summary %s\n", ci
.summary
);
1568 if (suspect
->commit
->object
.flags
& UNINTERESTING
)
1569 printf("boundary\n");
1571 else if (suspect
->commit
->object
.flags
& MORE_THAN_ONE_PATH
)
1572 write_filename_info(suspect
->path
);
1574 cp
= nth_line(sb
, ent
->lno
);
1575 for (cnt
= 0; cnt
< ent
->num_lines
; cnt
++) {
1578 printf("%s %d %d\n", hex
,
1579 ent
->s_lno
+ 1 + cnt
,
1580 ent
->lno
+ 1 + cnt
);
1585 } while (ch
!= '\n' &&
1586 cp
< sb
->final_buf
+ sb
->final_buf_size
);
1590 static void emit_other(struct scoreboard
*sb
, struct blame_entry
*ent
, int opt
)
1594 struct origin
*suspect
= ent
->suspect
;
1595 struct commit_info ci
;
1597 int show_raw_time
= !!(opt
& OUTPUT_RAW_TIMESTAMP
);
1599 get_commit_info(suspect
->commit
, &ci
, 1);
1600 strcpy(hex
, sha1_to_hex(suspect
->commit
->object
.sha1
));
1602 cp
= nth_line(sb
, ent
->lno
);
1603 for (cnt
= 0; cnt
< ent
->num_lines
; cnt
++) {
1605 int length
= (opt
& OUTPUT_LONG_OBJECT_NAME
) ? 40 : 8;
1607 if (suspect
->commit
->object
.flags
& UNINTERESTING
) {
1609 memset(hex
, ' ', length
);
1610 else if (!(opt
& OUTPUT_ANNOTATE_COMPAT
)) {
1616 printf("%.*s", length
, hex
);
1617 if (opt
& OUTPUT_ANNOTATE_COMPAT
)
1618 printf("\t(%10s\t%10s\t%d)", ci
.author
,
1619 format_time(ci
.author_time
, ci
.author_tz
,
1621 ent
->lno
+ 1 + cnt
);
1623 if (opt
& OUTPUT_SHOW_SCORE
)
1625 max_score_digits
, ent
->score
,
1626 ent
->suspect
->refcnt
);
1627 if (opt
& OUTPUT_SHOW_NAME
)
1628 printf(" %-*.*s", longest_file
, longest_file
,
1630 if (opt
& OUTPUT_SHOW_NUMBER
)
1631 printf(" %*d", max_orig_digits
,
1632 ent
->s_lno
+ 1 + cnt
);
1634 if (!(opt
& OUTPUT_NO_AUTHOR
)) {
1635 int pad
= longest_author
- utf8_strwidth(ci
.author
);
1636 printf(" (%s%*s %10s",
1638 format_time(ci
.author_time
,
1643 max_digits
, ent
->lno
+ 1 + cnt
);
1648 } while (ch
!= '\n' &&
1649 cp
< sb
->final_buf
+ sb
->final_buf_size
);
1653 static void output(struct scoreboard
*sb
, int option
)
1655 struct blame_entry
*ent
;
1657 if (option
& OUTPUT_PORCELAIN
) {
1658 for (ent
= sb
->ent
; ent
; ent
= ent
->next
) {
1659 struct blame_entry
*oth
;
1660 struct origin
*suspect
= ent
->suspect
;
1661 struct commit
*commit
= suspect
->commit
;
1662 if (commit
->object
.flags
& MORE_THAN_ONE_PATH
)
1664 for (oth
= ent
->next
; oth
; oth
= oth
->next
) {
1665 if ((oth
->suspect
->commit
!= commit
) ||
1666 !strcmp(oth
->suspect
->path
, suspect
->path
))
1668 commit
->object
.flags
|= MORE_THAN_ONE_PATH
;
1674 for (ent
= sb
->ent
; ent
; ent
= ent
->next
) {
1675 if (option
& OUTPUT_PORCELAIN
)
1676 emit_porcelain(sb
, ent
);
1678 emit_other(sb
, ent
, option
);
1684 * To allow quick access to the contents of nth line in the
1685 * final image, prepare an index in the scoreboard.
1687 static int prepare_lines(struct scoreboard
*sb
)
1689 const char *buf
= sb
->final_buf
;
1690 unsigned long len
= sb
->final_buf_size
;
1691 int num
= 0, incomplete
= 0, bol
= 1;
1693 if (len
&& buf
[len
-1] != '\n')
1694 incomplete
++; /* incomplete line at the end */
1697 sb
->lineno
= xrealloc(sb
->lineno
,
1698 sizeof(int* ) * (num
+ 1));
1699 sb
->lineno
[num
] = buf
- sb
->final_buf
;
1702 if (*buf
++ == '\n') {
1707 sb
->lineno
= xrealloc(sb
->lineno
,
1708 sizeof(int* ) * (num
+ incomplete
+ 1));
1709 sb
->lineno
[num
+ incomplete
] = buf
- sb
->final_buf
;
1710 sb
->num_lines
= num
+ incomplete
;
1711 return sb
->num_lines
;
1715 * Add phony grafts for use with -S; this is primarily to
1716 * support git's cvsserver that wants to give a linear history
1719 static int read_ancestry(const char *graft_file
)
1721 FILE *fp
= fopen(graft_file
, "r");
1725 while (fgets(buf
, sizeof(buf
), fp
)) {
1726 /* The format is just "Commit Parent1 Parent2 ...\n" */
1727 int len
= strlen(buf
);
1728 struct commit_graft
*graft
= read_graft_line(buf
, len
);
1730 register_commit_graft(graft
, 0);
1737 * How many columns do we need to show line numbers in decimal?
1739 static int lineno_width(int lines
)
1743 for (width
= 1, i
= 10; i
<= lines
+ 1; width
++)
1749 * How many columns do we need to show line numbers, authors,
1752 static void find_alignment(struct scoreboard
*sb
, int *option
)
1754 int longest_src_lines
= 0;
1755 int longest_dst_lines
= 0;
1756 unsigned largest_score
= 0;
1757 struct blame_entry
*e
;
1759 for (e
= sb
->ent
; e
; e
= e
->next
) {
1760 struct origin
*suspect
= e
->suspect
;
1761 struct commit_info ci
;
1764 if (strcmp(suspect
->path
, sb
->path
))
1765 *option
|= OUTPUT_SHOW_NAME
;
1766 num
= strlen(suspect
->path
);
1767 if (longest_file
< num
)
1769 if (!(suspect
->commit
->object
.flags
& METAINFO_SHOWN
)) {
1770 suspect
->commit
->object
.flags
|= METAINFO_SHOWN
;
1771 get_commit_info(suspect
->commit
, &ci
, 1);
1772 num
= utf8_strwidth(ci
.author
);
1773 if (longest_author
< num
)
1774 longest_author
= num
;
1776 num
= e
->s_lno
+ e
->num_lines
;
1777 if (longest_src_lines
< num
)
1778 longest_src_lines
= num
;
1779 num
= e
->lno
+ e
->num_lines
;
1780 if (longest_dst_lines
< num
)
1781 longest_dst_lines
= num
;
1782 if (largest_score
< ent_score(sb
, e
))
1783 largest_score
= ent_score(sb
, e
);
1785 max_orig_digits
= lineno_width(longest_src_lines
);
1786 max_digits
= lineno_width(longest_dst_lines
);
1787 max_score_digits
= lineno_width(largest_score
);
1791 * For debugging -- origin is refcounted, and this asserts that
1792 * we do not underflow.
1794 static void sanity_check_refcnt(struct scoreboard
*sb
)
1797 struct blame_entry
*ent
;
1799 for (ent
= sb
->ent
; ent
; ent
= ent
->next
) {
1800 /* Nobody should have zero or negative refcnt */
1801 if (ent
->suspect
->refcnt
<= 0) {
1802 fprintf(stderr
, "%s in %s has negative refcnt %d\n",
1804 sha1_to_hex(ent
->suspect
->commit
->object
.sha1
),
1805 ent
->suspect
->refcnt
);
1809 for (ent
= sb
->ent
; ent
; ent
= ent
->next
) {
1810 /* Mark the ones that haven't been checked */
1811 if (0 < ent
->suspect
->refcnt
)
1812 ent
->suspect
->refcnt
= -ent
->suspect
->refcnt
;
1814 for (ent
= sb
->ent
; ent
; ent
= ent
->next
) {
1816 * ... then pick each and see if they have the the
1820 struct blame_entry
*e
;
1821 struct origin
*suspect
= ent
->suspect
;
1823 if (0 < suspect
->refcnt
)
1825 suspect
->refcnt
= -suspect
->refcnt
; /* Unmark */
1826 for (found
= 0, e
= sb
->ent
; e
; e
= e
->next
) {
1827 if (e
->suspect
!= suspect
)
1831 if (suspect
->refcnt
!= found
) {
1832 fprintf(stderr
, "%s in %s has refcnt %d, not %d\n",
1834 sha1_to_hex(ent
->suspect
->commit
->object
.sha1
),
1835 ent
->suspect
->refcnt
, found
);
1841 find_alignment(sb
, &opt
);
1843 die("Baa %d!", baa
);
1848 * Used for the command line parsing; check if the path exists
1849 * in the working tree.
1851 static int has_string_in_work_tree(const char *path
)
1854 return !lstat(path
, &st
);
1857 static unsigned parse_score(const char *arg
)
1860 unsigned long score
= strtoul(arg
, &end
, 10);
1866 static const char *add_prefix(const char *prefix
, const char *path
)
1868 return prefix_path(prefix
, prefix
? strlen(prefix
) : 0, path
);
1872 * Parsing of (comma separated) one item in the -L option
1874 static const char *parse_loc(const char *spec
,
1875 struct scoreboard
*sb
, long lno
,
1876 long begin
, long *ret
)
1883 regmatch_t match
[1];
1885 /* Allow "-L <something>,+20" to mean starting at <something>
1886 * for 20 lines, or "-L <something>,-5" for 5 lines ending at
1889 if (1 < begin
&& (spec
[0] == '+' || spec
[0] == '-')) {
1890 num
= strtol(spec
+ 1, &term
, 10);
1891 if (term
!= spec
+ 1) {
1895 *ret
= begin
+ num
- 2;
1904 num
= strtol(spec
, &term
, 10);
1912 /* it could be a regexp of form /.../ */
1913 for (term
= (char*) spec
+ 1; *term
&& *term
!= '/'; term
++) {
1920 /* try [spec+1 .. term-1] as regexp */
1922 begin
--; /* input is in human terms */
1923 line
= nth_line(sb
, begin
);
1925 if (!(reg_error
= regcomp(®exp
, spec
+ 1, REG_NEWLINE
)) &&
1926 !(reg_error
= regexec(®exp
, line
, 1, match
, 0))) {
1927 const char *cp
= line
+ match
[0].rm_so
;
1930 while (begin
++ < lno
) {
1931 nline
= nth_line(sb
, begin
);
1932 if (line
<= cp
&& cp
< nline
)
1943 regerror(reg_error
, ®exp
, errbuf
, 1024);
1944 die("-L parameter '%s': %s", spec
+ 1, errbuf
);
1949 * Parsing of -L option
1951 static void prepare_blame_range(struct scoreboard
*sb
,
1952 const char *bottomtop
,
1954 long *bottom
, long *top
)
1958 term
= parse_loc(bottomtop
, sb
, lno
, 1, bottom
);
1960 term
= parse_loc(term
+ 1, sb
, lno
, *bottom
+ 1, top
);
1968 static int git_blame_config(const char *var
, const char *value
, void *cb
)
1970 if (!strcmp(var
, "blame.showroot")) {
1971 show_root
= git_config_bool(var
, value
);
1974 if (!strcmp(var
, "blame.blankboundary")) {
1975 blank_boundary
= git_config_bool(var
, value
);
1978 return git_default_config(var
, value
, cb
);
1982 * Prepare a dummy commit that represents the work tree (or staged) item.
1983 * Note that annotating work tree item never works in the reverse.
1985 static struct commit
*fake_working_tree_commit(const char *path
, const char *contents_from
)
1987 struct commit
*commit
;
1988 struct origin
*origin
;
1989 unsigned char head_sha1
[20];
1990 struct strbuf buf
= STRBUF_INIT
;
1994 struct cache_entry
*ce
;
1997 if (get_sha1("HEAD", head_sha1
))
1998 die("No such ref: HEAD");
2001 commit
= xcalloc(1, sizeof(*commit
));
2002 commit
->parents
= xcalloc(1, sizeof(*commit
->parents
));
2003 commit
->parents
->item
= lookup_commit_reference(head_sha1
);
2004 commit
->object
.parsed
= 1;
2006 commit
->object
.type
= OBJ_COMMIT
;
2008 origin
= make_origin(commit
, path
);
2010 if (!contents_from
|| strcmp("-", contents_from
)) {
2012 const char *read_from
;
2014 if (contents_from
) {
2015 if (stat(contents_from
, &st
) < 0)
2016 die("Cannot stat %s", contents_from
);
2017 read_from
= contents_from
;
2020 if (lstat(path
, &st
) < 0)
2021 die("Cannot lstat %s", path
);
2024 mode
= canon_mode(st
.st_mode
);
2025 switch (st
.st_mode
& S_IFMT
) {
2027 if (strbuf_read_file(&buf
, read_from
, st
.st_size
) != st
.st_size
)
2028 die("cannot open or read %s", read_from
);
2031 if (strbuf_readlink(&buf
, read_from
, st
.st_size
) < 0)
2032 die("cannot readlink %s", read_from
);
2035 die("unsupported file type %s", read_from
);
2039 /* Reading from stdin */
2040 contents_from
= "standard input";
2042 if (strbuf_read(&buf
, 0, 0) < 0)
2043 die("read error %s from stdin", strerror(errno
));
2045 convert_to_git(path
, buf
.buf
, buf
.len
, &buf
, 0);
2046 origin
->file
.ptr
= buf
.buf
;
2047 origin
->file
.size
= buf
.len
;
2048 pretend_sha1_file(buf
.buf
, buf
.len
, OBJ_BLOB
, origin
->blob_sha1
);
2049 commit
->util
= origin
;
2052 * Read the current index, replace the path entry with
2053 * origin->blob_sha1 without mucking with its mode or type
2054 * bits; we are not going to write this index out -- we just
2055 * want to run "diff-index --cached".
2062 int pos
= cache_name_pos(path
, len
);
2064 mode
= active_cache
[pos
]->ce_mode
;
2066 /* Let's not bother reading from HEAD tree */
2067 mode
= S_IFREG
| 0644;
2069 size
= cache_entry_size(len
);
2070 ce
= xcalloc(1, size
);
2071 hashcpy(ce
->sha1
, origin
->blob_sha1
);
2072 memcpy(ce
->name
, path
, len
);
2073 ce
->ce_flags
= create_ce_flags(len
, 0);
2074 ce
->ce_mode
= create_ce_mode(mode
);
2075 add_cache_entry(ce
, ADD_CACHE_OK_TO_ADD
|ADD_CACHE_OK_TO_REPLACE
);
2078 * We are not going to write this out, so this does not matter
2079 * right now, but someday we might optimize diff-index --cached
2080 * with cache-tree information.
2082 cache_tree_invalidate_path(active_cache_tree
, path
);
2084 commit
->buffer
= xmalloc(400);
2085 ident
= fmt_ident("Not Committed Yet", "not.committed.yet", NULL
, 0);
2086 snprintf(commit
->buffer
, 400,
2087 "tree 0000000000000000000000000000000000000000\n"
2091 "Version of %s from %s\n",
2092 sha1_to_hex(head_sha1
),
2093 ident
, ident
, path
, contents_from
? contents_from
: path
);
2097 static const char *prepare_final(struct scoreboard
*sb
)
2100 const char *final_commit_name
= NULL
;
2101 struct rev_info
*revs
= sb
->revs
;
2104 * There must be one and only one positive commit in the
2105 * revs->pending array.
2107 for (i
= 0; i
< revs
->pending
.nr
; i
++) {
2108 struct object
*obj
= revs
->pending
.objects
[i
].item
;
2109 if (obj
->flags
& UNINTERESTING
)
2111 while (obj
->type
== OBJ_TAG
)
2112 obj
= deref_tag(obj
, NULL
, 0);
2113 if (obj
->type
!= OBJ_COMMIT
)
2114 die("Non commit %s?", revs
->pending
.objects
[i
].name
);
2116 die("More than one commit to dig from %s and %s?",
2117 revs
->pending
.objects
[i
].name
,
2119 sb
->final
= (struct commit
*) obj
;
2120 final_commit_name
= revs
->pending
.objects
[i
].name
;
2122 return final_commit_name
;
2125 static const char *prepare_initial(struct scoreboard
*sb
)
2128 const char *final_commit_name
= NULL
;
2129 struct rev_info
*revs
= sb
->revs
;
2132 * There must be one and only one negative commit, and it must be
2135 for (i
= 0; i
< revs
->pending
.nr
; i
++) {
2136 struct object
*obj
= revs
->pending
.objects
[i
].item
;
2137 if (!(obj
->flags
& UNINTERESTING
))
2139 while (obj
->type
== OBJ_TAG
)
2140 obj
= deref_tag(obj
, NULL
, 0);
2141 if (obj
->type
!= OBJ_COMMIT
)
2142 die("Non commit %s?", revs
->pending
.objects
[i
].name
);
2144 die("More than one commit to dig down to %s and %s?",
2145 revs
->pending
.objects
[i
].name
,
2147 sb
->final
= (struct commit
*) obj
;
2148 final_commit_name
= revs
->pending
.objects
[i
].name
;
2150 if (!final_commit_name
)
2151 die("No commit to dig down to?");
2152 return final_commit_name
;
2155 static int blame_copy_callback(const struct option
*option
, const char *arg
, int unset
)
2157 int *opt
= option
->value
;
2160 * -C enables copy from removed files;
2161 * -C -C enables copy from existing files, but only
2162 * when blaming a new file;
2163 * -C -C -C enables copy from existing files for
2166 if (*opt
& PICKAXE_BLAME_COPY_HARDER
)
2167 *opt
|= PICKAXE_BLAME_COPY_HARDEST
;
2168 if (*opt
& PICKAXE_BLAME_COPY
)
2169 *opt
|= PICKAXE_BLAME_COPY_HARDER
;
2170 *opt
|= PICKAXE_BLAME_COPY
| PICKAXE_BLAME_MOVE
;
2173 blame_copy_score
= parse_score(arg
);
2177 static int blame_move_callback(const struct option
*option
, const char *arg
, int unset
)
2179 int *opt
= option
->value
;
2181 *opt
|= PICKAXE_BLAME_MOVE
;
2184 blame_move_score
= parse_score(arg
);
2188 static int blame_bottomtop_callback(const struct option
*option
, const char *arg
, int unset
)
2190 const char **bottomtop
= option
->value
;
2194 die("More than one '-L n,m' option given");
2199 int cmd_blame(int argc
, const char **argv
, const char *prefix
)
2201 struct rev_info revs
;
2203 struct scoreboard sb
;
2205 struct blame_entry
*ent
;
2206 long dashdash_pos
, bottom
, top
, lno
;
2207 const char *final_commit_name
= NULL
;
2208 enum object_type type
;
2210 static const char *bottomtop
= NULL
;
2211 static int output_option
= 0, opt
= 0;
2212 static int show_stats
= 0;
2213 static const char *revs_file
= NULL
;
2214 static const char *contents_from
= NULL
;
2215 static const struct option options
[] = {
2216 OPT_BOOLEAN(0, "incremental", &incremental
, "Show blame entries as we find them, incrementally"),
2217 OPT_BOOLEAN('b', NULL
, &blank_boundary
, "Show blank SHA-1 for boundary commits (Default: off)"),
2218 OPT_BOOLEAN(0, "root", &show_root
, "Do not treat root commits as boundaries (Default: off)"),
2219 OPT_BOOLEAN(0, "show-stats", &show_stats
, "Show work cost statistics"),
2220 OPT_BIT(0, "score-debug", &output_option
, "Show output score for blame entries", OUTPUT_SHOW_SCORE
),
2221 OPT_BIT('f', "show-name", &output_option
, "Show original filename (Default: auto)", OUTPUT_SHOW_NAME
),
2222 OPT_BIT('n', "show-number", &output_option
, "Show original linenumber (Default: off)", OUTPUT_SHOW_NUMBER
),
2223 OPT_BIT('p', "porcelain", &output_option
, "Show in a format designed for machine consumption", OUTPUT_PORCELAIN
),
2224 OPT_BIT('c', NULL
, &output_option
, "Use the same output mode as git-annotate (Default: off)", OUTPUT_ANNOTATE_COMPAT
),
2225 OPT_BIT('t', NULL
, &output_option
, "Show raw timestamp (Default: off)", OUTPUT_RAW_TIMESTAMP
),
2226 OPT_BIT('l', NULL
, &output_option
, "Show long commit SHA1 (Default: off)", OUTPUT_LONG_OBJECT_NAME
),
2227 OPT_BIT('s', NULL
, &output_option
, "Suppress author name and timestamp (Default: off)", OUTPUT_NO_AUTHOR
),
2228 OPT_BIT('w', NULL
, &xdl_opts
, "Ignore whitespace differences", XDF_IGNORE_WHITESPACE
),
2229 OPT_STRING('S', NULL
, &revs_file
, "file", "Use revisions from <file> instead of calling git-rev-list"),
2230 OPT_STRING(0, "contents", &contents_from
, "file", "Use <file>'s contents as the final image"),
2231 { OPTION_CALLBACK
, 'C', NULL
, &opt
, "score", "Find line copies within and across files", PARSE_OPT_OPTARG
, blame_copy_callback
},
2232 { OPTION_CALLBACK
, 'M', NULL
, &opt
, "score", "Find line movements within and across files", PARSE_OPT_OPTARG
, blame_move_callback
},
2233 OPT_CALLBACK('L', NULL
, &bottomtop
, "n,m", "Process only line range n,m, counting from 1", blame_bottomtop_callback
),
2237 struct parse_opt_ctx_t ctx
;
2238 int cmd_is_annotate
= !strcmp(argv
[0], "annotate");
2240 git_config(git_blame_config
, NULL
);
2241 init_revisions(&revs
, NULL
);
2242 save_commit_buffer
= 0;
2245 parse_options_start(&ctx
, argc
, argv
, PARSE_OPT_KEEP_DASHDASH
|
2246 PARSE_OPT_KEEP_ARGV0
);
2248 switch (parse_options_step(&ctx
, options
, blame_opt_usage
)) {
2249 case PARSE_OPT_HELP
:
2251 case PARSE_OPT_DONE
:
2253 dashdash_pos
= ctx
.cpidx
;
2257 if (!strcmp(ctx
.argv
[0], "--reverse")) {
2258 ctx
.argv
[0] = "--children";
2261 parse_revision_opt(&revs
, &ctx
, options
, blame_opt_usage
);
2264 argc
= parse_options_end(&ctx
);
2266 if (cmd_is_annotate
)
2267 output_option
|= OUTPUT_ANNOTATE_COMPAT
;
2269 if (DIFF_OPT_TST(&revs
.diffopt
, FIND_COPIES_HARDER
))
2270 opt
|= (PICKAXE_BLAME_COPY
| PICKAXE_BLAME_MOVE
|
2271 PICKAXE_BLAME_COPY_HARDER
);
2273 if (!blame_move_score
)
2274 blame_move_score
= BLAME_DEFAULT_MOVE_SCORE
;
2275 if (!blame_copy_score
)
2276 blame_copy_score
= BLAME_DEFAULT_COPY_SCORE
;
2279 * We have collected options unknown to us in argv[1..unk]
2280 * which are to be passed to revision machinery if we are
2281 * going to do the "bottom" processing.
2283 * The remaining are:
2285 * (1) if dashdash_pos != 0, its either
2286 * "blame [revisions] -- <path>" or
2287 * "blame -- <path> <rev>"
2289 * (2) otherwise, its one of the two:
2290 * "blame [revisions] <path>"
2291 * "blame <path> <rev>"
2293 * Note that we must strip out <path> from the arguments: we do not
2294 * want the path pruning but we may want "bottom" processing.
2297 switch (argc
- dashdash_pos
- 1) {
2300 usage_with_options(blame_opt_usage
, options
);
2301 /* reorder for the new way: <rev> -- <path> */
2307 path
= add_prefix(prefix
, argv
[--argc
]);
2311 usage_with_options(blame_opt_usage
, options
);
2315 usage_with_options(blame_opt_usage
, options
);
2316 path
= add_prefix(prefix
, argv
[argc
- 1]);
2317 if (argc
== 3 && !has_string_in_work_tree(path
)) { /* (2b) */
2318 path
= add_prefix(prefix
, argv
[1]);
2321 argv
[argc
- 1] = "--";
2324 if (!has_string_in_work_tree(path
))
2325 die("cannot stat path %s: %s", path
, strerror(errno
));
2328 setup_revisions(argc
, argv
, &revs
, NULL
);
2329 memset(&sb
, 0, sizeof(sb
));
2333 final_commit_name
= prepare_final(&sb
);
2334 else if (contents_from
)
2335 die("--contents and --children do not blend well.");
2337 final_commit_name
= prepare_initial(&sb
);
2341 * "--not A B -- path" without anything positive;
2342 * do not default to HEAD, but use the working tree
2346 sb
.final
= fake_working_tree_commit(path
, contents_from
);
2347 add_pending_object(&revs
, &(sb
.final
->object
), ":");
2349 else if (contents_from
)
2350 die("Cannot use --contents with final commit object name");
2353 * If we have bottom, this will mark the ancestors of the
2354 * bottom commits we would reach while traversing as
2357 if (prepare_revision_walk(&revs
))
2358 die("revision walk setup failed");
2360 if (is_null_sha1(sb
.final
->object
.sha1
)) {
2363 buf
= xmalloc(o
->file
.size
+ 1);
2364 memcpy(buf
, o
->file
.ptr
, o
->file
.size
+ 1);
2366 sb
.final_buf_size
= o
->file
.size
;
2369 o
= get_origin(&sb
, sb
.final
, path
);
2370 if (fill_blob_sha1(o
))
2371 die("no such path %s in %s", path
, final_commit_name
);
2373 sb
.final_buf
= read_sha1_file(o
->blob_sha1
, &type
,
2374 &sb
.final_buf_size
);
2376 die("Cannot read blob %s for path %s",
2377 sha1_to_hex(o
->blob_sha1
),
2381 lno
= prepare_lines(&sb
);
2385 prepare_blame_range(&sb
, bottomtop
, lno
, &bottom
, &top
);
2386 if (bottom
&& top
&& top
< bottom
) {
2388 tmp
= top
; top
= bottom
; bottom
= tmp
;
2396 die("file %s has only %lu lines", path
, lno
);
2398 ent
= xcalloc(1, sizeof(*ent
));
2400 ent
->num_lines
= top
- bottom
;
2402 ent
->s_lno
= bottom
;
2407 if (revs_file
&& read_ancestry(revs_file
))
2408 die("reading graft file %s failed: %s",
2409 revs_file
, strerror(errno
));
2411 read_mailmap(&mailmap
, NULL
);
2416 assign_blame(&sb
, opt
);
2423 if (!(output_option
& OUTPUT_PORCELAIN
))
2424 find_alignment(&sb
, &output_option
);
2426 output(&sb
, output_option
);
2427 free((void *)sb
.final_buf
);
2428 for (ent
= sb
.ent
; ent
; ) {
2429 struct blame_entry
*e
= ent
->next
;
2435 printf("num read blob: %d\n", num_read_blob
);
2436 printf("num get patch: %d\n", num_get_patch
);
2437 printf("num commits: %d\n", num_commits
);