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"
25 static char blame_usage
[] = "git blame [options] [rev-opts] [rev] [--] file";
27 static const char *blame_opt_usage
[] = {
30 "[rev-opts] are documented in git-rev-list(1)",
34 static int longest_file
;
35 static int longest_author
;
36 static int max_orig_digits
;
37 static int max_digits
;
38 static int max_score_digits
;
41 static int blank_boundary
;
42 static int incremental
;
45 static enum date_mode blame_date_mode
= DATE_ISO8601
;
46 static size_t blame_date_width
;
48 static struct string_list mailmap
;
55 static int num_read_blob
;
56 static int num_get_patch
;
57 static int num_commits
;
59 #define PICKAXE_BLAME_MOVE 01
60 #define PICKAXE_BLAME_COPY 02
61 #define PICKAXE_BLAME_COPY_HARDER 04
62 #define PICKAXE_BLAME_COPY_HARDEST 010
65 * blame for a blame_entry with score lower than these thresholds
66 * is not passed to the parent using move/copy logic.
68 static unsigned blame_move_score
;
69 static unsigned blame_copy_score
;
70 #define BLAME_DEFAULT_MOVE_SCORE 20
71 #define BLAME_DEFAULT_COPY_SCORE 40
73 /* bits #0..7 in revision.h, #8..11 used for merge_bases() in commit.c */
74 #define METAINFO_SHOWN (1u<<12)
75 #define MORE_THAN_ONE_PATH (1u<<13)
78 * One blob in a commit that is being suspected
82 struct origin
*previous
;
83 struct commit
*commit
;
85 unsigned char blob_sha1
[20];
86 char path
[FLEX_ARRAY
];
90 * Prepare diff_filespec and convert it using diff textconv API
91 * if the textconv driver exists.
92 * Return 1 if the conversion succeeds, 0 otherwise.
94 int textconv_object(const char *path
,
95 const unsigned char *sha1
,
97 unsigned long *buf_size
)
99 struct diff_filespec
*df
;
100 struct userdiff_driver
*textconv
;
102 df
= alloc_filespec(path
);
103 fill_filespec(df
, sha1
, S_IFREG
| 0664);
104 textconv
= get_textconv(df
);
110 *buf_size
= fill_textconv(textconv
, df
, buf
);
116 * Given an origin, prepare mmfile_t structure to be used by the
119 static void fill_origin_blob(struct diff_options
*opt
,
120 struct origin
*o
, mmfile_t
*file
)
123 enum object_type type
;
124 unsigned long file_size
;
127 if (DIFF_OPT_TST(opt
, ALLOW_TEXTCONV
) &&
128 textconv_object(o
->path
, o
->blob_sha1
, &file
->ptr
, &file_size
))
131 file
->ptr
= read_sha1_file(o
->blob_sha1
, &type
, &file_size
);
132 file
->size
= file_size
;
135 die("Cannot read blob %s for path %s",
136 sha1_to_hex(o
->blob_sha1
),
145 * Origin is refcounted and usually we keep the blob contents to be
148 static inline struct origin
*origin_incref(struct origin
*o
)
155 static void origin_decref(struct origin
*o
)
157 if (o
&& --o
->refcnt
<= 0) {
159 origin_decref(o
->previous
);
165 static void drop_origin_blob(struct origin
*o
)
174 * Each group of lines is described by a blame_entry; it can be split
175 * as we pass blame to the parents. They form a linked list in the
176 * scoreboard structure, sorted by the target line number.
179 struct blame_entry
*prev
;
180 struct blame_entry
*next
;
182 /* the first line of this group in the final image;
183 * internally all line numbers are 0 based.
187 /* how many lines this group has */
190 /* the commit that introduced this group into the final image */
191 struct origin
*suspect
;
193 /* true if the suspect is truly guilty; false while we have not
194 * checked if the group came from one of its parents.
198 /* true if the entry has been scanned for copies in the current parent
202 /* the line number of the first line of this group in the
203 * suspect's file; internally all line numbers are 0 based.
207 /* how significant this entry is -- cached to avoid
208 * scanning the lines over and over.
214 * The current state of the blame assignment.
217 /* the final commit (i.e. where we started digging from) */
218 struct commit
*final
;
219 struct rev_info
*revs
;
223 * The contents in the final image.
224 * Used by many functions to obtain contents of the nth line,
225 * indexed with scoreboard.lineno[blame_entry.lno].
227 const char *final_buf
;
228 unsigned long final_buf_size
;
230 /* linked list of blames */
231 struct blame_entry
*ent
;
233 /* look-up a line in the final buffer */
238 static inline int same_suspect(struct origin
*a
, struct origin
*b
)
242 if (a
->commit
!= b
->commit
)
244 return !strcmp(a
->path
, b
->path
);
247 static void sanity_check_refcnt(struct scoreboard
*);
250 * If two blame entries that are next to each other came from
251 * contiguous lines in the same origin (i.e. <commit, path> pair),
252 * merge them together.
254 static void coalesce(struct scoreboard
*sb
)
256 struct blame_entry
*ent
, *next
;
258 for (ent
= sb
->ent
; ent
&& (next
= ent
->next
); ent
= next
) {
259 if (same_suspect(ent
->suspect
, next
->suspect
) &&
260 ent
->guilty
== next
->guilty
&&
261 ent
->s_lno
+ ent
->num_lines
== next
->s_lno
) {
262 ent
->num_lines
+= next
->num_lines
;
263 ent
->next
= next
->next
;
265 ent
->next
->prev
= ent
;
266 origin_decref(next
->suspect
);
269 next
= ent
; /* again */
273 if (DEBUG
) /* sanity */
274 sanity_check_refcnt(sb
);
278 * Given a commit and a path in it, create a new origin structure.
279 * The callers that add blame to the scoreboard should use
280 * get_origin() to obtain shared, refcounted copy instead of calling
281 * this function directly.
283 static struct origin
*make_origin(struct commit
*commit
, const char *path
)
286 o
= xcalloc(1, sizeof(*o
) + strlen(path
) + 1);
289 strcpy(o
->path
, path
);
294 * Locate an existing origin or create a new one.
296 static struct origin
*get_origin(struct scoreboard
*sb
,
297 struct commit
*commit
,
300 struct blame_entry
*e
;
302 for (e
= sb
->ent
; e
; e
= e
->next
) {
303 if (e
->suspect
->commit
== commit
&&
304 !strcmp(e
->suspect
->path
, path
))
305 return origin_incref(e
->suspect
);
307 return make_origin(commit
, path
);
311 * Fill the blob_sha1 field of an origin if it hasn't, so that later
312 * call to fill_origin_blob() can use it to locate the data. blob_sha1
313 * for an origin is also used to pass the blame for the entire file to
314 * the parent to detect the case where a child's blob is identical to
315 * that of its parent's.
317 static int fill_blob_sha1(struct origin
*origin
)
320 if (!is_null_sha1(origin
->blob_sha1
))
322 if (get_tree_entry(origin
->commit
->object
.sha1
,
324 origin
->blob_sha1
, &mode
))
326 if (sha1_object_info(origin
->blob_sha1
, NULL
) != OBJ_BLOB
)
330 hashclr(origin
->blob_sha1
);
335 * We have an origin -- check if the same path exists in the
336 * parent and return an origin structure to represent it.
338 static struct origin
*find_origin(struct scoreboard
*sb
,
339 struct commit
*parent
,
340 struct origin
*origin
)
342 struct origin
*porigin
= NULL
;
343 struct diff_options diff_opts
;
344 const char *paths
[2];
348 * Each commit object can cache one origin in that
349 * commit. This is a freestanding copy of origin and
352 struct origin
*cached
= parent
->util
;
353 if (!strcmp(cached
->path
, origin
->path
)) {
355 * The same path between origin and its parent
356 * without renaming -- the most common case.
358 porigin
= get_origin(sb
, parent
, cached
->path
);
361 * If the origin was newly created (i.e. get_origin
362 * would call make_origin if none is found in the
363 * scoreboard), it does not know the blob_sha1,
364 * so copy it. Otherwise porigin was in the
365 * scoreboard and already knows blob_sha1.
367 if (porigin
->refcnt
== 1)
368 hashcpy(porigin
->blob_sha1
, cached
->blob_sha1
);
371 /* otherwise it was not very useful; free it */
376 /* See if the origin->path is different between parent
377 * and origin first. Most of the time they are the
378 * same and diff-tree is fairly efficient about this.
380 diff_setup(&diff_opts
);
381 DIFF_OPT_SET(&diff_opts
, RECURSIVE
);
382 diff_opts
.detect_rename
= 0;
383 diff_opts
.output_format
= DIFF_FORMAT_NO_OUTPUT
;
384 paths
[0] = origin
->path
;
387 diff_tree_setup_paths(paths
, &diff_opts
);
388 if (diff_setup_done(&diff_opts
) < 0)
391 if (is_null_sha1(origin
->commit
->object
.sha1
))
392 do_diff_cache(parent
->tree
->object
.sha1
, &diff_opts
);
394 diff_tree_sha1(parent
->tree
->object
.sha1
,
395 origin
->commit
->tree
->object
.sha1
,
397 diffcore_std(&diff_opts
);
399 if (!diff_queued_diff
.nr
) {
400 /* The path is the same as parent */
401 porigin
= get_origin(sb
, parent
, origin
->path
);
402 hashcpy(porigin
->blob_sha1
, origin
->blob_sha1
);
405 * Since origin->path is a pathspec, if the parent
406 * commit had it as a directory, we will see a whole
407 * bunch of deletion of files in the directory that we
411 struct diff_filepair
*p
= NULL
;
412 for (i
= 0; i
< diff_queued_diff
.nr
; i
++) {
414 p
= diff_queued_diff
.queue
[i
];
415 name
= p
->one
->path
? p
->one
->path
: p
->two
->path
;
416 if (!strcmp(name
, origin
->path
))
420 die("internal error in blame::find_origin");
423 die("internal error in blame::find_origin (%c)",
426 porigin
= get_origin(sb
, parent
, origin
->path
);
427 hashcpy(porigin
->blob_sha1
, p
->one
->sha1
);
431 /* Did not exist in parent, or type changed */
435 diff_flush(&diff_opts
);
436 diff_tree_release_paths(&diff_opts
);
439 * Create a freestanding copy that is not part of
440 * the refcounted origin found in the scoreboard, and
441 * cache it in the commit.
443 struct origin
*cached
;
445 cached
= make_origin(porigin
->commit
, porigin
->path
);
446 hashcpy(cached
->blob_sha1
, porigin
->blob_sha1
);
447 parent
->util
= cached
;
453 * We have an origin -- find the path that corresponds to it in its
454 * parent and return an origin structure to represent it.
456 static struct origin
*find_rename(struct scoreboard
*sb
,
457 struct commit
*parent
,
458 struct origin
*origin
)
460 struct origin
*porigin
= NULL
;
461 struct diff_options diff_opts
;
463 const char *paths
[2];
465 diff_setup(&diff_opts
);
466 DIFF_OPT_SET(&diff_opts
, RECURSIVE
);
467 diff_opts
.detect_rename
= DIFF_DETECT_RENAME
;
468 diff_opts
.output_format
= DIFF_FORMAT_NO_OUTPUT
;
469 diff_opts
.single_follow
= origin
->path
;
471 diff_tree_setup_paths(paths
, &diff_opts
);
472 if (diff_setup_done(&diff_opts
) < 0)
475 if (is_null_sha1(origin
->commit
->object
.sha1
))
476 do_diff_cache(parent
->tree
->object
.sha1
, &diff_opts
);
478 diff_tree_sha1(parent
->tree
->object
.sha1
,
479 origin
->commit
->tree
->object
.sha1
,
481 diffcore_std(&diff_opts
);
483 for (i
= 0; i
< diff_queued_diff
.nr
; i
++) {
484 struct diff_filepair
*p
= diff_queued_diff
.queue
[i
];
485 if ((p
->status
== 'R' || p
->status
== 'C') &&
486 !strcmp(p
->two
->path
, origin
->path
)) {
487 porigin
= get_origin(sb
, parent
, p
->one
->path
);
488 hashcpy(porigin
->blob_sha1
, p
->one
->sha1
);
492 diff_flush(&diff_opts
);
493 diff_tree_release_paths(&diff_opts
);
498 * Link in a new blame entry to the scoreboard. Entries that cover the
499 * same line range have been removed from the scoreboard previously.
501 static void add_blame_entry(struct scoreboard
*sb
, struct blame_entry
*e
)
503 struct blame_entry
*ent
, *prev
= NULL
;
505 origin_incref(e
->suspect
);
507 for (ent
= sb
->ent
; ent
&& ent
->lno
< e
->lno
; ent
= ent
->next
)
510 /* prev, if not NULL, is the last one that is below e */
513 e
->next
= prev
->next
;
525 * src typically is on-stack; we want to copy the information in it to
526 * a malloced blame_entry that is already on the linked list of the
527 * scoreboard. The origin of dst loses a refcnt while the origin of src
530 static void dup_entry(struct blame_entry
*dst
, struct blame_entry
*src
)
532 struct blame_entry
*p
, *n
;
536 origin_incref(src
->suspect
);
537 origin_decref(dst
->suspect
);
538 memcpy(dst
, src
, sizeof(*src
));
544 static const char *nth_line(struct scoreboard
*sb
, int lno
)
546 return sb
->final_buf
+ sb
->lineno
[lno
];
550 * It is known that lines between tlno to same came from parent, and e
551 * has an overlap with that range. it also is known that parent's
552 * line plno corresponds to e's line tlno.
558 * <------------------>
560 * Split e into potentially three parts; before this chunk, the chunk
561 * to be blamed for the parent, and after that portion.
563 static void split_overlap(struct blame_entry
*split
,
564 struct blame_entry
*e
,
565 int tlno
, int plno
, int same
,
566 struct origin
*parent
)
569 memset(split
, 0, sizeof(struct blame_entry
[3]));
571 if (e
->s_lno
< tlno
) {
572 /* there is a pre-chunk part not blamed on parent */
573 split
[0].suspect
= origin_incref(e
->suspect
);
574 split
[0].lno
= e
->lno
;
575 split
[0].s_lno
= e
->s_lno
;
576 split
[0].num_lines
= tlno
- e
->s_lno
;
577 split
[1].lno
= e
->lno
+ tlno
- e
->s_lno
;
578 split
[1].s_lno
= plno
;
581 split
[1].lno
= e
->lno
;
582 split
[1].s_lno
= plno
+ (e
->s_lno
- tlno
);
585 if (same
< e
->s_lno
+ e
->num_lines
) {
586 /* there is a post-chunk part not blamed on parent */
587 split
[2].suspect
= origin_incref(e
->suspect
);
588 split
[2].lno
= e
->lno
+ (same
- e
->s_lno
);
589 split
[2].s_lno
= e
->s_lno
+ (same
- e
->s_lno
);
590 split
[2].num_lines
= e
->s_lno
+ e
->num_lines
- same
;
591 chunk_end_lno
= split
[2].lno
;
594 chunk_end_lno
= e
->lno
+ e
->num_lines
;
595 split
[1].num_lines
= chunk_end_lno
- split
[1].lno
;
598 * if it turns out there is nothing to blame the parent for,
599 * forget about the splitting. !split[1].suspect signals this.
601 if (split
[1].num_lines
< 1)
603 split
[1].suspect
= origin_incref(parent
);
607 * split_overlap() divided an existing blame e into up to three parts
608 * in split. Adjust the linked list of blames in the scoreboard to
611 static void split_blame(struct scoreboard
*sb
,
612 struct blame_entry
*split
,
613 struct blame_entry
*e
)
615 struct blame_entry
*new_entry
;
617 if (split
[0].suspect
&& split
[2].suspect
) {
618 /* The first part (reuse storage for the existing entry e) */
619 dup_entry(e
, &split
[0]);
621 /* The last part -- me */
622 new_entry
= xmalloc(sizeof(*new_entry
));
623 memcpy(new_entry
, &(split
[2]), sizeof(struct blame_entry
));
624 add_blame_entry(sb
, new_entry
);
626 /* ... and the middle part -- parent */
627 new_entry
= xmalloc(sizeof(*new_entry
));
628 memcpy(new_entry
, &(split
[1]), sizeof(struct blame_entry
));
629 add_blame_entry(sb
, new_entry
);
631 else if (!split
[0].suspect
&& !split
[2].suspect
)
633 * The parent covers the entire area; reuse storage for
634 * e and replace it with the parent.
636 dup_entry(e
, &split
[1]);
637 else if (split
[0].suspect
) {
638 /* me and then parent */
639 dup_entry(e
, &split
[0]);
641 new_entry
= xmalloc(sizeof(*new_entry
));
642 memcpy(new_entry
, &(split
[1]), sizeof(struct blame_entry
));
643 add_blame_entry(sb
, new_entry
);
646 /* parent and then me */
647 dup_entry(e
, &split
[1]);
649 new_entry
= xmalloc(sizeof(*new_entry
));
650 memcpy(new_entry
, &(split
[2]), sizeof(struct blame_entry
));
651 add_blame_entry(sb
, new_entry
);
654 if (DEBUG
) { /* sanity */
655 struct blame_entry
*ent
;
656 int lno
= sb
->ent
->lno
, corrupt
= 0;
658 for (ent
= sb
->ent
; ent
; ent
= ent
->next
) {
663 lno
+= ent
->num_lines
;
667 for (ent
= sb
->ent
; ent
; ent
= ent
->next
) {
668 printf("L %8d l %8d n %8d\n",
669 lno
, ent
->lno
, ent
->num_lines
);
670 lno
= ent
->lno
+ ent
->num_lines
;
678 * After splitting the blame, the origins used by the
679 * on-stack blame_entry should lose one refcnt each.
681 static void decref_split(struct blame_entry
*split
)
685 for (i
= 0; i
< 3; i
++)
686 origin_decref(split
[i
].suspect
);
690 * Helper for blame_chunk(). blame_entry e is known to overlap with
691 * the patch hunk; split it and pass blame to the parent.
693 static void blame_overlap(struct scoreboard
*sb
, struct blame_entry
*e
,
694 int tlno
, int plno
, int same
,
695 struct origin
*parent
)
697 struct blame_entry split
[3];
699 split_overlap(split
, e
, tlno
, plno
, same
, parent
);
700 if (split
[1].suspect
)
701 split_blame(sb
, split
, e
);
706 * Find the line number of the last line the target is suspected for.
708 static int find_last_in_target(struct scoreboard
*sb
, struct origin
*target
)
710 struct blame_entry
*e
;
711 int last_in_target
= -1;
713 for (e
= sb
->ent
; e
; e
= e
->next
) {
714 if (e
->guilty
|| !same_suspect(e
->suspect
, target
))
716 if (last_in_target
< e
->s_lno
+ e
->num_lines
)
717 last_in_target
= e
->s_lno
+ e
->num_lines
;
719 return last_in_target
;
723 * Process one hunk from the patch between the current suspect for
724 * blame_entry e and its parent. Find and split the overlap, and
725 * pass blame to the overlapping part to the parent.
727 static void blame_chunk(struct scoreboard
*sb
,
728 int tlno
, int plno
, int same
,
729 struct origin
*target
, struct origin
*parent
)
731 struct blame_entry
*e
;
733 for (e
= sb
->ent
; e
; e
= e
->next
) {
734 if (e
->guilty
|| !same_suspect(e
->suspect
, target
))
736 if (same
<= e
->s_lno
)
738 if (tlno
< e
->s_lno
+ e
->num_lines
)
739 blame_overlap(sb
, e
, tlno
, plno
, same
, parent
);
743 struct blame_chunk_cb_data
{
744 struct scoreboard
*sb
;
745 struct origin
*target
;
746 struct origin
*parent
;
751 static void blame_chunk_cb(void *data
, long same
, long p_next
, long t_next
)
753 struct blame_chunk_cb_data
*d
= data
;
754 blame_chunk(d
->sb
, d
->tlno
, d
->plno
, same
, d
->target
, d
->parent
);
760 * We are looking at the origin 'target' and aiming to pass blame
761 * for the lines it is suspected to its parent. Run diff to find
762 * which lines came from parent and pass blame for them.
764 static int pass_blame_to_parent(struct scoreboard
*sb
,
765 struct origin
*target
,
766 struct origin
*parent
)
769 mmfile_t file_p
, file_o
;
770 struct blame_chunk_cb_data d
;
773 memset(&d
, 0, sizeof(d
));
774 d
.sb
= sb
; d
.target
= target
; d
.parent
= parent
;
775 last_in_target
= find_last_in_target(sb
, target
);
776 if (last_in_target
< 0)
777 return 1; /* nothing remains for this target */
779 fill_origin_blob(&sb
->revs
->diffopt
, parent
, &file_p
);
780 fill_origin_blob(&sb
->revs
->diffopt
, target
, &file_o
);
783 memset(&xpp
, 0, sizeof(xpp
));
784 xpp
.flags
= xdl_opts
;
785 memset(&xecfg
, 0, sizeof(xecfg
));
787 xdi_diff_hunks(&file_p
, &file_o
, blame_chunk_cb
, &d
, &xpp
, &xecfg
);
788 /* The rest (i.e. anything after tlno) are the same as the parent */
789 blame_chunk(sb
, d
.tlno
, d
.plno
, last_in_target
, target
, parent
);
795 * The lines in blame_entry after splitting blames many times can become
796 * very small and trivial, and at some point it becomes pointless to
797 * blame the parents. E.g. "\t\t}\n\t}\n\n" appears everywhere in any
798 * ordinary C program, and it is not worth to say it was copied from
799 * totally unrelated file in the parent.
801 * Compute how trivial the lines in the blame_entry are.
803 static unsigned ent_score(struct scoreboard
*sb
, struct blame_entry
*e
)
812 cp
= nth_line(sb
, e
->lno
);
813 ep
= nth_line(sb
, e
->lno
+ e
->num_lines
);
815 unsigned ch
= *((unsigned char *)cp
);
825 * best_so_far[] and this[] are both a split of an existing blame_entry
826 * that passes blame to the parent. Maintain best_so_far the best split
827 * so far, by comparing this and best_so_far and copying this into
828 * bst_so_far as needed.
830 static void copy_split_if_better(struct scoreboard
*sb
,
831 struct blame_entry
*best_so_far
,
832 struct blame_entry
*this)
836 if (!this[1].suspect
)
838 if (best_so_far
[1].suspect
) {
839 if (ent_score(sb
, &this[1]) < ent_score(sb
, &best_so_far
[1]))
843 for (i
= 0; i
< 3; i
++)
844 origin_incref(this[i
].suspect
);
845 decref_split(best_so_far
);
846 memcpy(best_so_far
, this, sizeof(struct blame_entry
[3]));
850 * We are looking at a part of the final image represented by
851 * ent (tlno and same are offset by ent->s_lno).
852 * tlno is where we are looking at in the final image.
853 * up to (but not including) same match preimage.
854 * plno is where we are looking at in the preimage.
856 * <-------------- final image ---------------------->
859 * <---------preimage----->
862 * All line numbers are 0-based.
864 static void handle_split(struct scoreboard
*sb
,
865 struct blame_entry
*ent
,
866 int tlno
, int plno
, int same
,
867 struct origin
*parent
,
868 struct blame_entry
*split
)
870 if (ent
->num_lines
<= tlno
)
873 struct blame_entry
this[3];
876 split_overlap(this, ent
, tlno
, plno
, same
, parent
);
877 copy_split_if_better(sb
, split
, this);
882 struct handle_split_cb_data
{
883 struct scoreboard
*sb
;
884 struct blame_entry
*ent
;
885 struct origin
*parent
;
886 struct blame_entry
*split
;
891 static void handle_split_cb(void *data
, long same
, long p_next
, long t_next
)
893 struct handle_split_cb_data
*d
= data
;
894 handle_split(d
->sb
, d
->ent
, d
->tlno
, d
->plno
, same
, d
->parent
, d
->split
);
900 * Find the lines from parent that are the same as ent so that
901 * we can pass blames to it. file_p has the blob contents for
904 static void find_copy_in_blob(struct scoreboard
*sb
,
905 struct blame_entry
*ent
,
906 struct origin
*parent
,
907 struct blame_entry
*split
,
913 struct handle_split_cb_data d
;
916 memset(&d
, 0, sizeof(d
));
917 d
.sb
= sb
; d
.ent
= ent
; d
.parent
= parent
; d
.split
= split
;
919 * Prepare mmfile that contains only the lines in ent.
921 cp
= nth_line(sb
, ent
->lno
);
922 file_o
.ptr
= (char *) cp
;
923 cnt
= ent
->num_lines
;
925 while (cnt
&& cp
< sb
->final_buf
+ sb
->final_buf_size
) {
929 file_o
.size
= cp
- file_o
.ptr
;
932 * file_o is a part of final image we are annotating.
933 * file_p partially may match that image.
935 memset(&xpp
, 0, sizeof(xpp
));
936 xpp
.flags
= xdl_opts
;
937 memset(&xecfg
, 0, sizeof(xecfg
));
939 memset(split
, 0, sizeof(struct blame_entry
[3]));
940 xdi_diff_hunks(file_p
, &file_o
, handle_split_cb
, &d
, &xpp
, &xecfg
);
941 /* remainder, if any, all match the preimage */
942 handle_split(sb
, ent
, d
.tlno
, d
.plno
, ent
->num_lines
, parent
, split
);
946 * See if lines currently target is suspected for can be attributed to
949 static int find_move_in_parent(struct scoreboard
*sb
,
950 struct origin
*target
,
951 struct origin
*parent
)
953 int last_in_target
, made_progress
;
954 struct blame_entry
*e
, split
[3];
957 last_in_target
= find_last_in_target(sb
, target
);
958 if (last_in_target
< 0)
959 return 1; /* nothing remains for this target */
961 fill_origin_blob(&sb
->revs
->diffopt
, parent
, &file_p
);
966 while (made_progress
) {
968 for (e
= sb
->ent
; e
; e
= e
->next
) {
969 if (e
->guilty
|| !same_suspect(e
->suspect
, target
) ||
970 ent_score(sb
, e
) < blame_move_score
)
972 find_copy_in_blob(sb
, e
, parent
, split
, &file_p
);
973 if (split
[1].suspect
&&
974 blame_move_score
< ent_score(sb
, &split
[1])) {
975 split_blame(sb
, split
, e
);
985 struct blame_entry
*ent
;
986 struct blame_entry split
[3];
990 * Count the number of entries the target is suspected for,
991 * and prepare a list of entry and the best split.
993 static struct blame_list
*setup_blame_list(struct scoreboard
*sb
,
994 struct origin
*target
,
998 struct blame_entry
*e
;
1000 struct blame_list
*blame_list
= NULL
;
1002 for (e
= sb
->ent
, num_ents
= 0; e
; e
= e
->next
)
1003 if (!e
->scanned
&& !e
->guilty
&&
1004 same_suspect(e
->suspect
, target
) &&
1005 min_score
< ent_score(sb
, e
))
1008 blame_list
= xcalloc(num_ents
, sizeof(struct blame_list
));
1009 for (e
= sb
->ent
, i
= 0; e
; e
= e
->next
)
1010 if (!e
->scanned
&& !e
->guilty
&&
1011 same_suspect(e
->suspect
, target
) &&
1012 min_score
< ent_score(sb
, e
))
1013 blame_list
[i
++].ent
= e
;
1015 *num_ents_p
= num_ents
;
1020 * Reset the scanned status on all entries.
1022 static void reset_scanned_flag(struct scoreboard
*sb
)
1024 struct blame_entry
*e
;
1025 for (e
= sb
->ent
; e
; e
= e
->next
)
1030 * For lines target is suspected for, see if we can find code movement
1031 * across file boundary from the parent commit. porigin is the path
1032 * in the parent we already tried.
1034 static int find_copy_in_parent(struct scoreboard
*sb
,
1035 struct origin
*target
,
1036 struct commit
*parent
,
1037 struct origin
*porigin
,
1040 struct diff_options diff_opts
;
1041 const char *paths
[1];
1044 struct blame_list
*blame_list
;
1047 blame_list
= setup_blame_list(sb
, target
, blame_copy_score
, &num_ents
);
1049 return 1; /* nothing remains for this target */
1051 diff_setup(&diff_opts
);
1052 DIFF_OPT_SET(&diff_opts
, RECURSIVE
);
1053 diff_opts
.output_format
= DIFF_FORMAT_NO_OUTPUT
;
1056 diff_tree_setup_paths(paths
, &diff_opts
);
1057 if (diff_setup_done(&diff_opts
) < 0)
1060 /* Try "find copies harder" on new path if requested;
1061 * we do not want to use diffcore_rename() actually to
1062 * match things up; find_copies_harder is set only to
1063 * force diff_tree_sha1() to feed all filepairs to diff_queue,
1064 * and this code needs to be after diff_setup_done(), which
1065 * usually makes find-copies-harder imply copy detection.
1067 if ((opt
& PICKAXE_BLAME_COPY_HARDEST
)
1068 || ((opt
& PICKAXE_BLAME_COPY_HARDER
)
1069 && (!porigin
|| strcmp(target
->path
, porigin
->path
))))
1070 DIFF_OPT_SET(&diff_opts
, FIND_COPIES_HARDER
);
1072 if (is_null_sha1(target
->commit
->object
.sha1
))
1073 do_diff_cache(parent
->tree
->object
.sha1
, &diff_opts
);
1075 diff_tree_sha1(parent
->tree
->object
.sha1
,
1076 target
->commit
->tree
->object
.sha1
,
1079 if (!DIFF_OPT_TST(&diff_opts
, FIND_COPIES_HARDER
))
1080 diffcore_std(&diff_opts
);
1084 int made_progress
= 0;
1086 for (i
= 0; i
< diff_queued_diff
.nr
; i
++) {
1087 struct diff_filepair
*p
= diff_queued_diff
.queue
[i
];
1088 struct origin
*norigin
;
1090 struct blame_entry
this[3];
1092 if (!DIFF_FILE_VALID(p
->one
))
1093 continue; /* does not exist in parent */
1094 if (S_ISGITLINK(p
->one
->mode
))
1095 continue; /* ignore git links */
1096 if (porigin
&& !strcmp(p
->one
->path
, porigin
->path
))
1097 /* find_move already dealt with this path */
1100 norigin
= get_origin(sb
, parent
, p
->one
->path
);
1101 hashcpy(norigin
->blob_sha1
, p
->one
->sha1
);
1102 fill_origin_blob(&sb
->revs
->diffopt
, norigin
, &file_p
);
1106 for (j
= 0; j
< num_ents
; j
++) {
1107 find_copy_in_blob(sb
, blame_list
[j
].ent
,
1108 norigin
, this, &file_p
);
1109 copy_split_if_better(sb
, blame_list
[j
].split
,
1113 origin_decref(norigin
);
1116 for (j
= 0; j
< num_ents
; j
++) {
1117 struct blame_entry
*split
= blame_list
[j
].split
;
1118 if (split
[1].suspect
&&
1119 blame_copy_score
< ent_score(sb
, &split
[1])) {
1120 split_blame(sb
, split
, blame_list
[j
].ent
);
1124 blame_list
[j
].ent
->scanned
= 1;
1125 decref_split(split
);
1131 blame_list
= setup_blame_list(sb
, target
, blame_copy_score
, &num_ents
);
1137 reset_scanned_flag(sb
);
1138 diff_flush(&diff_opts
);
1139 diff_tree_release_paths(&diff_opts
);
1144 * The blobs of origin and porigin exactly match, so everything
1145 * origin is suspected for can be blamed on the parent.
1147 static void pass_whole_blame(struct scoreboard
*sb
,
1148 struct origin
*origin
, struct origin
*porigin
)
1150 struct blame_entry
*e
;
1152 if (!porigin
->file
.ptr
&& origin
->file
.ptr
) {
1153 /* Steal its file */
1154 porigin
->file
= origin
->file
;
1155 origin
->file
.ptr
= NULL
;
1157 for (e
= sb
->ent
; e
; e
= e
->next
) {
1158 if (!same_suspect(e
->suspect
, origin
))
1160 origin_incref(porigin
);
1161 origin_decref(e
->suspect
);
1162 e
->suspect
= porigin
;
1167 * We pass blame from the current commit to its parents. We keep saying
1168 * "parent" (and "porigin"), but what we mean is to find scapegoat to
1169 * exonerate ourselves.
1171 static struct commit_list
*first_scapegoat(struct rev_info
*revs
, struct commit
*commit
)
1174 return commit
->parents
;
1175 return lookup_decoration(&revs
->children
, &commit
->object
);
1178 static int num_scapegoats(struct rev_info
*revs
, struct commit
*commit
)
1181 struct commit_list
*l
= first_scapegoat(revs
, commit
);
1182 for (cnt
= 0; l
; l
= l
->next
)
1189 static void pass_blame(struct scoreboard
*sb
, struct origin
*origin
, int opt
)
1191 struct rev_info
*revs
= sb
->revs
;
1192 int i
, pass
, num_sg
;
1193 struct commit
*commit
= origin
->commit
;
1194 struct commit_list
*sg
;
1195 struct origin
*sg_buf
[MAXSG
];
1196 struct origin
*porigin
, **sg_origin
= sg_buf
;
1198 num_sg
= num_scapegoats(revs
, commit
);
1201 else if (num_sg
< ARRAY_SIZE(sg_buf
))
1202 memset(sg_buf
, 0, sizeof(sg_buf
));
1204 sg_origin
= xcalloc(num_sg
, sizeof(*sg_origin
));
1207 * The first pass looks for unrenamed path to optimize for
1208 * common cases, then we look for renames in the second pass.
1210 for (pass
= 0; pass
< 2; pass
++) {
1211 struct origin
*(*find
)(struct scoreboard
*,
1212 struct commit
*, struct origin
*);
1213 find
= pass
? find_rename
: find_origin
;
1215 for (i
= 0, sg
= first_scapegoat(revs
, commit
);
1217 sg
= sg
->next
, i
++) {
1218 struct commit
*p
= sg
->item
;
1223 if (parse_commit(p
))
1225 porigin
= find(sb
, p
, origin
);
1228 if (!hashcmp(porigin
->blob_sha1
, origin
->blob_sha1
)) {
1229 pass_whole_blame(sb
, origin
, porigin
);
1230 origin_decref(porigin
);
1233 for (j
= same
= 0; j
< i
; j
++)
1235 !hashcmp(sg_origin
[j
]->blob_sha1
,
1236 porigin
->blob_sha1
)) {
1241 sg_origin
[i
] = porigin
;
1243 origin_decref(porigin
);
1248 for (i
= 0, sg
= first_scapegoat(revs
, commit
);
1250 sg
= sg
->next
, i
++) {
1251 struct origin
*porigin
= sg_origin
[i
];
1254 if (!origin
->previous
) {
1255 origin_incref(porigin
);
1256 origin
->previous
= porigin
;
1258 if (pass_blame_to_parent(sb
, origin
, porigin
))
1263 * Optionally find moves in parents' files.
1265 if (opt
& PICKAXE_BLAME_MOVE
)
1266 for (i
= 0, sg
= first_scapegoat(revs
, commit
);
1268 sg
= sg
->next
, i
++) {
1269 struct origin
*porigin
= sg_origin
[i
];
1272 if (find_move_in_parent(sb
, origin
, porigin
))
1277 * Optionally find copies from parents' files.
1279 if (opt
& PICKAXE_BLAME_COPY
)
1280 for (i
= 0, sg
= first_scapegoat(revs
, commit
);
1282 sg
= sg
->next
, i
++) {
1283 struct origin
*porigin
= sg_origin
[i
];
1284 if (find_copy_in_parent(sb
, origin
, sg
->item
,
1290 for (i
= 0; i
< num_sg
; i
++) {
1292 drop_origin_blob(sg_origin
[i
]);
1293 origin_decref(sg_origin
[i
]);
1296 drop_origin_blob(origin
);
1297 if (sg_buf
!= sg_origin
)
1302 * Information on commits, used for output.
1307 const char *author_mail
;
1308 unsigned long author_time
;
1309 const char *author_tz
;
1311 /* filled only when asked for details */
1312 const char *committer
;
1313 const char *committer_mail
;
1314 unsigned long committer_time
;
1315 const char *committer_tz
;
1317 const char *summary
;
1321 * Parse author/committer line in the commit object buffer
1323 static void get_ac_line(const char *inbuf
, const char *what
,
1324 int person_len
, char *person
,
1325 int mail_len
, char *mail
,
1326 unsigned long *time
, const char **tz
)
1328 int len
, tzlen
, maillen
;
1329 char *tmp
, *endp
, *timepos
, *mailpos
;
1331 tmp
= strstr(inbuf
, what
);
1334 tmp
+= strlen(what
);
1335 endp
= strchr(tmp
, '\n');
1340 if (person_len
<= len
) {
1344 strcpy(person
, *tz
);
1349 memcpy(person
, tmp
, len
);
1354 while (person
< tmp
&& *tmp
!= ' ')
1359 tzlen
= (person
+len
)-(tmp
+1);
1362 while (person
< tmp
&& *tmp
!= ' ')
1366 *time
= strtoul(tmp
, NULL
, 10);
1370 while (person
< tmp
&& *tmp
!= ' ')
1376 maillen
= timepos
- tmp
;
1377 memcpy(mail
, mailpos
, maillen
);
1383 * mailmap expansion may make the name longer.
1384 * make room by pushing stuff down.
1386 tmp
= person
+ person_len
- (tzlen
+ 1);
1387 memmove(tmp
, *tz
, tzlen
);
1392 * Now, convert both name and e-mail using mailmap
1394 if (map_user(&mailmap
, mail
+1, mail_len
-1, person
, tmp
-person
-1)) {
1395 /* Add a trailing '>' to email, since map_user returns plain emails
1396 Note: It already has '<', since we replace from mail+1 */
1397 mailpos
= memchr(mail
, '\0', mail_len
);
1398 if (mailpos
&& mailpos
-mail
< mail_len
- 1) {
1400 *(mailpos
+1) = '\0';
1405 static void get_commit_info(struct commit
*commit
,
1406 struct commit_info
*ret
,
1410 char *tmp
, *endp
, *reencoded
, *message
;
1411 static char author_name
[1024];
1412 static char author_mail
[1024];
1413 static char committer_name
[1024];
1414 static char committer_mail
[1024];
1415 static char summary_buf
[1024];
1418 * We've operated without save_commit_buffer, so
1419 * we now need to populate them for output.
1421 if (!commit
->buffer
) {
1422 enum object_type type
;
1425 read_sha1_file(commit
->object
.sha1
, &type
, &size
);
1426 if (!commit
->buffer
)
1427 die("Cannot read commit %s",
1428 sha1_to_hex(commit
->object
.sha1
));
1430 reencoded
= reencode_commit_message(commit
, NULL
);
1431 message
= reencoded
? reencoded
: commit
->buffer
;
1432 ret
->author
= author_name
;
1433 ret
->author_mail
= author_mail
;
1434 get_ac_line(message
, "\nauthor ",
1435 sizeof(author_name
), author_name
,
1436 sizeof(author_mail
), author_mail
,
1437 &ret
->author_time
, &ret
->author_tz
);
1444 ret
->committer
= committer_name
;
1445 ret
->committer_mail
= committer_mail
;
1446 get_ac_line(message
, "\ncommitter ",
1447 sizeof(committer_name
), committer_name
,
1448 sizeof(committer_mail
), committer_mail
,
1449 &ret
->committer_time
, &ret
->committer_tz
);
1451 ret
->summary
= summary_buf
;
1452 tmp
= strstr(message
, "\n\n");
1455 sprintf(summary_buf
, "(%s)", sha1_to_hex(commit
->object
.sha1
));
1460 endp
= strchr(tmp
, '\n');
1462 endp
= tmp
+ strlen(tmp
);
1464 if (len
>= sizeof(summary_buf
) || len
== 0)
1466 memcpy(summary_buf
, tmp
, len
);
1467 summary_buf
[len
] = 0;
1472 * To allow LF and other nonportable characters in pathnames,
1473 * they are c-style quoted as needed.
1475 static void write_filename_info(const char *path
)
1477 printf("filename ");
1478 write_name_quoted(path
, stdout
, '\n');
1482 * Porcelain/Incremental format wants to show a lot of details per
1483 * commit. Instead of repeating this every line, emit it only once,
1484 * the first time each commit appears in the output.
1486 static int emit_one_suspect_detail(struct origin
*suspect
)
1488 struct commit_info ci
;
1490 if (suspect
->commit
->object
.flags
& METAINFO_SHOWN
)
1493 suspect
->commit
->object
.flags
|= METAINFO_SHOWN
;
1494 get_commit_info(suspect
->commit
, &ci
, 1);
1495 printf("author %s\n", ci
.author
);
1496 printf("author-mail %s\n", ci
.author_mail
);
1497 printf("author-time %lu\n", ci
.author_time
);
1498 printf("author-tz %s\n", ci
.author_tz
);
1499 printf("committer %s\n", ci
.committer
);
1500 printf("committer-mail %s\n", ci
.committer_mail
);
1501 printf("committer-time %lu\n", ci
.committer_time
);
1502 printf("committer-tz %s\n", ci
.committer_tz
);
1503 printf("summary %s\n", ci
.summary
);
1504 if (suspect
->commit
->object
.flags
& UNINTERESTING
)
1505 printf("boundary\n");
1506 if (suspect
->previous
) {
1507 struct origin
*prev
= suspect
->previous
;
1508 printf("previous %s ", sha1_to_hex(prev
->commit
->object
.sha1
));
1509 write_name_quoted(prev
->path
, stdout
, '\n');
1515 * The blame_entry is found to be guilty for the range. Mark it
1516 * as such, and show it in incremental output.
1518 static void found_guilty_entry(struct blame_entry
*ent
)
1524 struct origin
*suspect
= ent
->suspect
;
1526 printf("%s %d %d %d\n",
1527 sha1_to_hex(suspect
->commit
->object
.sha1
),
1528 ent
->s_lno
+ 1, ent
->lno
+ 1, ent
->num_lines
);
1529 emit_one_suspect_detail(suspect
);
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];
1592 const char *time_str
;
1596 if (show_raw_time
) {
1597 sprintf(time_buf
, "%lu %s", time
, tz_str
);
1601 time_str
= show_date(time
, tz
, blame_date_mode
);
1602 time_len
= strlen(time_str
);
1603 memcpy(time_buf
, time_str
, time_len
);
1604 memset(time_buf
+ time_len
, ' ', blame_date_width
- time_len
);
1609 #define OUTPUT_ANNOTATE_COMPAT 001
1610 #define OUTPUT_LONG_OBJECT_NAME 002
1611 #define OUTPUT_RAW_TIMESTAMP 004
1612 #define OUTPUT_PORCELAIN 010
1613 #define OUTPUT_SHOW_NAME 020
1614 #define OUTPUT_SHOW_NUMBER 040
1615 #define OUTPUT_SHOW_SCORE 0100
1616 #define OUTPUT_NO_AUTHOR 0200
1618 static void emit_porcelain(struct scoreboard
*sb
, struct blame_entry
*ent
)
1622 struct origin
*suspect
= ent
->suspect
;
1625 strcpy(hex
, sha1_to_hex(suspect
->commit
->object
.sha1
));
1626 printf("%s%c%d %d %d\n",
1628 ent
->guilty
? ' ' : '*', /* purely for debugging */
1632 if (emit_one_suspect_detail(suspect
) ||
1633 (suspect
->commit
->object
.flags
& MORE_THAN_ONE_PATH
))
1634 write_filename_info(suspect
->path
);
1636 cp
= nth_line(sb
, ent
->lno
);
1637 for (cnt
= 0; cnt
< ent
->num_lines
; cnt
++) {
1640 printf("%s %d %d\n", hex
,
1641 ent
->s_lno
+ 1 + cnt
,
1642 ent
->lno
+ 1 + cnt
);
1647 } while (ch
!= '\n' &&
1648 cp
< sb
->final_buf
+ sb
->final_buf_size
);
1651 if (sb
->final_buf_size
&& cp
[-1] != '\n')
1655 static void emit_other(struct scoreboard
*sb
, struct blame_entry
*ent
, int opt
)
1659 struct origin
*suspect
= ent
->suspect
;
1660 struct commit_info ci
;
1662 int show_raw_time
= !!(opt
& OUTPUT_RAW_TIMESTAMP
);
1664 get_commit_info(suspect
->commit
, &ci
, 1);
1665 strcpy(hex
, sha1_to_hex(suspect
->commit
->object
.sha1
));
1667 cp
= nth_line(sb
, ent
->lno
);
1668 for (cnt
= 0; cnt
< ent
->num_lines
; cnt
++) {
1670 int length
= (opt
& OUTPUT_LONG_OBJECT_NAME
) ? 40 : 8;
1672 if (suspect
->commit
->object
.flags
& UNINTERESTING
) {
1674 memset(hex
, ' ', length
);
1675 else if (!(opt
& OUTPUT_ANNOTATE_COMPAT
)) {
1681 printf("%.*s", length
, hex
);
1682 if (opt
& OUTPUT_ANNOTATE_COMPAT
)
1683 printf("\t(%10s\t%10s\t%d)", ci
.author
,
1684 format_time(ci
.author_time
, ci
.author_tz
,
1686 ent
->lno
+ 1 + cnt
);
1688 if (opt
& OUTPUT_SHOW_SCORE
)
1690 max_score_digits
, ent
->score
,
1691 ent
->suspect
->refcnt
);
1692 if (opt
& OUTPUT_SHOW_NAME
)
1693 printf(" %-*.*s", longest_file
, longest_file
,
1695 if (opt
& OUTPUT_SHOW_NUMBER
)
1696 printf(" %*d", max_orig_digits
,
1697 ent
->s_lno
+ 1 + cnt
);
1699 if (!(opt
& OUTPUT_NO_AUTHOR
)) {
1700 int pad
= longest_author
- utf8_strwidth(ci
.author
);
1701 printf(" (%s%*s %10s",
1703 format_time(ci
.author_time
,
1708 max_digits
, ent
->lno
+ 1 + cnt
);
1713 } while (ch
!= '\n' &&
1714 cp
< sb
->final_buf
+ sb
->final_buf_size
);
1717 if (sb
->final_buf_size
&& cp
[-1] != '\n')
1721 static void output(struct scoreboard
*sb
, int option
)
1723 struct blame_entry
*ent
;
1725 if (option
& OUTPUT_PORCELAIN
) {
1726 for (ent
= sb
->ent
; ent
; ent
= ent
->next
) {
1727 struct blame_entry
*oth
;
1728 struct origin
*suspect
= ent
->suspect
;
1729 struct commit
*commit
= suspect
->commit
;
1730 if (commit
->object
.flags
& MORE_THAN_ONE_PATH
)
1732 for (oth
= ent
->next
; oth
; oth
= oth
->next
) {
1733 if ((oth
->suspect
->commit
!= commit
) ||
1734 !strcmp(oth
->suspect
->path
, suspect
->path
))
1736 commit
->object
.flags
|= MORE_THAN_ONE_PATH
;
1742 for (ent
= sb
->ent
; ent
; ent
= ent
->next
) {
1743 if (option
& OUTPUT_PORCELAIN
)
1744 emit_porcelain(sb
, ent
);
1746 emit_other(sb
, ent
, option
);
1752 * To allow quick access to the contents of nth line in the
1753 * final image, prepare an index in the scoreboard.
1755 static int prepare_lines(struct scoreboard
*sb
)
1757 const char *buf
= sb
->final_buf
;
1758 unsigned long len
= sb
->final_buf_size
;
1759 int num
= 0, incomplete
= 0, bol
= 1;
1761 if (len
&& buf
[len
-1] != '\n')
1762 incomplete
++; /* incomplete line at the end */
1765 sb
->lineno
= xrealloc(sb
->lineno
,
1766 sizeof(int *) * (num
+ 1));
1767 sb
->lineno
[num
] = buf
- sb
->final_buf
;
1770 if (*buf
++ == '\n') {
1775 sb
->lineno
= xrealloc(sb
->lineno
,
1776 sizeof(int *) * (num
+ incomplete
+ 1));
1777 sb
->lineno
[num
+ incomplete
] = buf
- sb
->final_buf
;
1778 sb
->num_lines
= num
+ incomplete
;
1779 return sb
->num_lines
;
1783 * Add phony grafts for use with -S; this is primarily to
1784 * support git's cvsserver that wants to give a linear history
1787 static int read_ancestry(const char *graft_file
)
1789 FILE *fp
= fopen(graft_file
, "r");
1793 while (fgets(buf
, sizeof(buf
), fp
)) {
1794 /* The format is just "Commit Parent1 Parent2 ...\n" */
1795 int len
= strlen(buf
);
1796 struct commit_graft
*graft
= read_graft_line(buf
, len
);
1798 register_commit_graft(graft
, 0);
1805 * How many columns do we need to show line numbers in decimal?
1807 static int lineno_width(int lines
)
1811 for (width
= 1, i
= 10; i
<= lines
; width
++)
1817 * How many columns do we need to show line numbers, authors,
1820 static void find_alignment(struct scoreboard
*sb
, int *option
)
1822 int longest_src_lines
= 0;
1823 int longest_dst_lines
= 0;
1824 unsigned largest_score
= 0;
1825 struct blame_entry
*e
;
1827 for (e
= sb
->ent
; e
; e
= e
->next
) {
1828 struct origin
*suspect
= e
->suspect
;
1829 struct commit_info ci
;
1832 if (strcmp(suspect
->path
, sb
->path
))
1833 *option
|= OUTPUT_SHOW_NAME
;
1834 num
= strlen(suspect
->path
);
1835 if (longest_file
< num
)
1837 if (!(suspect
->commit
->object
.flags
& METAINFO_SHOWN
)) {
1838 suspect
->commit
->object
.flags
|= METAINFO_SHOWN
;
1839 get_commit_info(suspect
->commit
, &ci
, 1);
1840 num
= utf8_strwidth(ci
.author
);
1841 if (longest_author
< num
)
1842 longest_author
= num
;
1844 num
= e
->s_lno
+ e
->num_lines
;
1845 if (longest_src_lines
< num
)
1846 longest_src_lines
= num
;
1847 num
= e
->lno
+ e
->num_lines
;
1848 if (longest_dst_lines
< num
)
1849 longest_dst_lines
= num
;
1850 if (largest_score
< ent_score(sb
, e
))
1851 largest_score
= ent_score(sb
, e
);
1853 max_orig_digits
= lineno_width(longest_src_lines
);
1854 max_digits
= lineno_width(longest_dst_lines
);
1855 max_score_digits
= lineno_width(largest_score
);
1859 * For debugging -- origin is refcounted, and this asserts that
1860 * we do not underflow.
1862 static void sanity_check_refcnt(struct scoreboard
*sb
)
1865 struct blame_entry
*ent
;
1867 for (ent
= sb
->ent
; ent
; ent
= ent
->next
) {
1868 /* Nobody should have zero or negative refcnt */
1869 if (ent
->suspect
->refcnt
<= 0) {
1870 fprintf(stderr
, "%s in %s has negative refcnt %d\n",
1872 sha1_to_hex(ent
->suspect
->commit
->object
.sha1
),
1873 ent
->suspect
->refcnt
);
1879 find_alignment(sb
, &opt
);
1881 die("Baa %d!", baa
);
1886 * Used for the command line parsing; check if the path exists
1887 * in the working tree.
1889 static int has_string_in_work_tree(const char *path
)
1892 return !lstat(path
, &st
);
1895 static unsigned parse_score(const char *arg
)
1898 unsigned long score
= strtoul(arg
, &end
, 10);
1904 static const char *add_prefix(const char *prefix
, const char *path
)
1906 return prefix_path(prefix
, prefix
? strlen(prefix
) : 0, path
);
1910 * Parsing of (comma separated) one item in the -L option
1912 static const char *parse_loc(const char *spec
,
1913 struct scoreboard
*sb
, long lno
,
1914 long begin
, long *ret
)
1921 regmatch_t match
[1];
1923 /* Allow "-L <something>,+20" to mean starting at <something>
1924 * for 20 lines, or "-L <something>,-5" for 5 lines ending at
1927 if (1 < begin
&& (spec
[0] == '+' || spec
[0] == '-')) {
1928 num
= strtol(spec
+ 1, &term
, 10);
1929 if (term
!= spec
+ 1) {
1933 *ret
= begin
+ num
- 2;
1942 num
= strtol(spec
, &term
, 10);
1950 /* it could be a regexp of form /.../ */
1951 for (term
= (char *) spec
+ 1; *term
&& *term
!= '/'; term
++) {
1958 /* try [spec+1 .. term-1] as regexp */
1960 begin
--; /* input is in human terms */
1961 line
= nth_line(sb
, begin
);
1963 if (!(reg_error
= regcomp(®exp
, spec
+ 1, REG_NEWLINE
)) &&
1964 !(reg_error
= regexec(®exp
, line
, 1, match
, 0))) {
1965 const char *cp
= line
+ match
[0].rm_so
;
1968 while (begin
++ < lno
) {
1969 nline
= nth_line(sb
, begin
);
1970 if (line
<= cp
&& cp
< nline
)
1981 regerror(reg_error
, ®exp
, errbuf
, 1024);
1982 die("-L parameter '%s': %s", spec
+ 1, errbuf
);
1987 * Parsing of -L option
1989 static void prepare_blame_range(struct scoreboard
*sb
,
1990 const char *bottomtop
,
1992 long *bottom
, long *top
)
1996 term
= parse_loc(bottomtop
, sb
, lno
, 1, bottom
);
1998 term
= parse_loc(term
+ 1, sb
, lno
, *bottom
+ 1, top
);
2006 static int git_blame_config(const char *var
, const char *value
, void *cb
)
2008 if (!strcmp(var
, "blame.showroot")) {
2009 show_root
= git_config_bool(var
, value
);
2012 if (!strcmp(var
, "blame.blankboundary")) {
2013 blank_boundary
= git_config_bool(var
, value
);
2016 if (!strcmp(var
, "blame.date")) {
2018 return config_error_nonbool(var
);
2019 blame_date_mode
= parse_date_format(value
);
2023 switch (userdiff_config(var
, value
)) {
2032 return git_default_config(var
, value
, cb
);
2036 * Prepare a dummy commit that represents the work tree (or staged) item.
2037 * Note that annotating work tree item never works in the reverse.
2039 static struct commit
*fake_working_tree_commit(struct diff_options
*opt
,
2041 const char *contents_from
)
2043 struct commit
*commit
;
2044 struct origin
*origin
;
2045 unsigned char head_sha1
[20];
2046 struct strbuf buf
= STRBUF_INIT
;
2050 struct cache_entry
*ce
;
2053 if (get_sha1("HEAD", head_sha1
))
2054 die("No such ref: HEAD");
2057 commit
= xcalloc(1, sizeof(*commit
));
2058 commit
->parents
= xcalloc(1, sizeof(*commit
->parents
));
2059 commit
->parents
->item
= lookup_commit_reference(head_sha1
);
2060 commit
->object
.parsed
= 1;
2062 commit
->object
.type
= OBJ_COMMIT
;
2064 origin
= make_origin(commit
, path
);
2066 if (!contents_from
|| strcmp("-", contents_from
)) {
2068 const char *read_from
;
2069 unsigned long buf_len
;
2071 if (contents_from
) {
2072 if (stat(contents_from
, &st
) < 0)
2073 die_errno("Cannot stat '%s'", contents_from
);
2074 read_from
= contents_from
;
2077 if (lstat(path
, &st
) < 0)
2078 die_errno("Cannot lstat '%s'", path
);
2081 mode
= canon_mode(st
.st_mode
);
2083 switch (st
.st_mode
& S_IFMT
) {
2085 if (DIFF_OPT_TST(opt
, ALLOW_TEXTCONV
) &&
2086 textconv_object(read_from
, null_sha1
, &buf
.buf
, &buf_len
))
2088 else if (strbuf_read_file(&buf
, read_from
, st
.st_size
) != st
.st_size
)
2089 die_errno("cannot open or read '%s'", read_from
);
2092 if (strbuf_readlink(&buf
, read_from
, st
.st_size
) < 0)
2093 die_errno("cannot readlink '%s'", read_from
);
2096 die("unsupported file type %s", read_from
);
2100 /* Reading from stdin */
2101 contents_from
= "standard input";
2103 if (strbuf_read(&buf
, 0, 0) < 0)
2104 die_errno("failed to read from stdin");
2106 convert_to_git(path
, buf
.buf
, buf
.len
, &buf
, 0);
2107 origin
->file
.ptr
= buf
.buf
;
2108 origin
->file
.size
= buf
.len
;
2109 pretend_sha1_file(buf
.buf
, buf
.len
, OBJ_BLOB
, origin
->blob_sha1
);
2110 commit
->util
= origin
;
2113 * Read the current index, replace the path entry with
2114 * origin->blob_sha1 without mucking with its mode or type
2115 * bits; we are not going to write this index out -- we just
2116 * want to run "diff-index --cached".
2123 int pos
= cache_name_pos(path
, len
);
2125 mode
= active_cache
[pos
]->ce_mode
;
2127 /* Let's not bother reading from HEAD tree */
2128 mode
= S_IFREG
| 0644;
2130 size
= cache_entry_size(len
);
2131 ce
= xcalloc(1, size
);
2132 hashcpy(ce
->sha1
, origin
->blob_sha1
);
2133 memcpy(ce
->name
, path
, len
);
2134 ce
->ce_flags
= create_ce_flags(len
, 0);
2135 ce
->ce_mode
= create_ce_mode(mode
);
2136 add_cache_entry(ce
, ADD_CACHE_OK_TO_ADD
|ADD_CACHE_OK_TO_REPLACE
);
2139 * We are not going to write this out, so this does not matter
2140 * right now, but someday we might optimize diff-index --cached
2141 * with cache-tree information.
2143 cache_tree_invalidate_path(active_cache_tree
, path
);
2145 commit
->buffer
= xmalloc(400);
2146 ident
= fmt_ident("Not Committed Yet", "not.committed.yet", NULL
, 0);
2147 snprintf(commit
->buffer
, 400,
2148 "tree 0000000000000000000000000000000000000000\n"
2152 "Version of %s from %s\n",
2153 sha1_to_hex(head_sha1
),
2154 ident
, ident
, path
, contents_from
? contents_from
: path
);
2158 static const char *prepare_final(struct scoreboard
*sb
)
2161 const char *final_commit_name
= NULL
;
2162 struct rev_info
*revs
= sb
->revs
;
2165 * There must be one and only one positive commit in the
2166 * revs->pending array.
2168 for (i
= 0; i
< revs
->pending
.nr
; i
++) {
2169 struct object
*obj
= revs
->pending
.objects
[i
].item
;
2170 if (obj
->flags
& UNINTERESTING
)
2172 while (obj
->type
== OBJ_TAG
)
2173 obj
= deref_tag(obj
, NULL
, 0);
2174 if (obj
->type
!= OBJ_COMMIT
)
2175 die("Non commit %s?", revs
->pending
.objects
[i
].name
);
2177 die("More than one commit to dig from %s and %s?",
2178 revs
->pending
.objects
[i
].name
,
2180 sb
->final
= (struct commit
*) obj
;
2181 final_commit_name
= revs
->pending
.objects
[i
].name
;
2183 return final_commit_name
;
2186 static const char *prepare_initial(struct scoreboard
*sb
)
2189 const char *final_commit_name
= NULL
;
2190 struct rev_info
*revs
= sb
->revs
;
2193 * There must be one and only one negative commit, and it must be
2196 for (i
= 0; i
< revs
->pending
.nr
; i
++) {
2197 struct object
*obj
= revs
->pending
.objects
[i
].item
;
2198 if (!(obj
->flags
& UNINTERESTING
))
2200 while (obj
->type
== OBJ_TAG
)
2201 obj
= deref_tag(obj
, NULL
, 0);
2202 if (obj
->type
!= OBJ_COMMIT
)
2203 die("Non commit %s?", revs
->pending
.objects
[i
].name
);
2205 die("More than one commit to dig down to %s and %s?",
2206 revs
->pending
.objects
[i
].name
,
2208 sb
->final
= (struct commit
*) obj
;
2209 final_commit_name
= revs
->pending
.objects
[i
].name
;
2211 if (!final_commit_name
)
2212 die("No commit to dig down to?");
2213 return final_commit_name
;
2216 static int blame_copy_callback(const struct option
*option
, const char *arg
, int unset
)
2218 int *opt
= option
->value
;
2221 * -C enables copy from removed files;
2222 * -C -C enables copy from existing files, but only
2223 * when blaming a new file;
2224 * -C -C -C enables copy from existing files for
2227 if (*opt
& PICKAXE_BLAME_COPY_HARDER
)
2228 *opt
|= PICKAXE_BLAME_COPY_HARDEST
;
2229 if (*opt
& PICKAXE_BLAME_COPY
)
2230 *opt
|= PICKAXE_BLAME_COPY_HARDER
;
2231 *opt
|= PICKAXE_BLAME_COPY
| PICKAXE_BLAME_MOVE
;
2234 blame_copy_score
= parse_score(arg
);
2238 static int blame_move_callback(const struct option
*option
, const char *arg
, int unset
)
2240 int *opt
= option
->value
;
2242 *opt
|= PICKAXE_BLAME_MOVE
;
2245 blame_move_score
= parse_score(arg
);
2249 static int blame_bottomtop_callback(const struct option
*option
, const char *arg
, int unset
)
2251 const char **bottomtop
= option
->value
;
2255 die("More than one '-L n,m' option given");
2260 int cmd_blame(int argc
, const char **argv
, const char *prefix
)
2262 struct rev_info revs
;
2264 struct scoreboard sb
;
2266 struct blame_entry
*ent
;
2267 long dashdash_pos
, bottom
, top
, lno
;
2268 const char *final_commit_name
= NULL
;
2269 enum object_type type
;
2271 static const char *bottomtop
= NULL
;
2272 static int output_option
= 0, opt
= 0;
2273 static int show_stats
= 0;
2274 static const char *revs_file
= NULL
;
2275 static const char *contents_from
= NULL
;
2276 static const struct option options
[] = {
2277 OPT_BOOLEAN(0, "incremental", &incremental
, "Show blame entries as we find them, incrementally"),
2278 OPT_BOOLEAN('b', NULL
, &blank_boundary
, "Show blank SHA-1 for boundary commits (Default: off)"),
2279 OPT_BOOLEAN(0, "root", &show_root
, "Do not treat root commits as boundaries (Default: off)"),
2280 OPT_BOOLEAN(0, "show-stats", &show_stats
, "Show work cost statistics"),
2281 OPT_BIT(0, "score-debug", &output_option
, "Show output score for blame entries", OUTPUT_SHOW_SCORE
),
2282 OPT_BIT('f', "show-name", &output_option
, "Show original filename (Default: auto)", OUTPUT_SHOW_NAME
),
2283 OPT_BIT('n', "show-number", &output_option
, "Show original linenumber (Default: off)", OUTPUT_SHOW_NUMBER
),
2284 OPT_BIT('p', "porcelain", &output_option
, "Show in a format designed for machine consumption", OUTPUT_PORCELAIN
),
2285 OPT_BIT('c', NULL
, &output_option
, "Use the same output mode as git-annotate (Default: off)", OUTPUT_ANNOTATE_COMPAT
),
2286 OPT_BIT('t', NULL
, &output_option
, "Show raw timestamp (Default: off)", OUTPUT_RAW_TIMESTAMP
),
2287 OPT_BIT('l', NULL
, &output_option
, "Show long commit SHA1 (Default: off)", OUTPUT_LONG_OBJECT_NAME
),
2288 OPT_BIT('s', NULL
, &output_option
, "Suppress author name and timestamp (Default: off)", OUTPUT_NO_AUTHOR
),
2289 OPT_BIT('w', NULL
, &xdl_opts
, "Ignore whitespace differences", XDF_IGNORE_WHITESPACE
),
2290 OPT_STRING('S', NULL
, &revs_file
, "file", "Use revisions from <file> instead of calling git-rev-list"),
2291 OPT_STRING(0, "contents", &contents_from
, "file", "Use <file>'s contents as the final image"),
2292 { OPTION_CALLBACK
, 'C', NULL
, &opt
, "score", "Find line copies within and across files", PARSE_OPT_OPTARG
, blame_copy_callback
},
2293 { OPTION_CALLBACK
, 'M', NULL
, &opt
, "score", "Find line movements within and across files", PARSE_OPT_OPTARG
, blame_move_callback
},
2294 OPT_CALLBACK('L', NULL
, &bottomtop
, "n,m", "Process only line range n,m, counting from 1", blame_bottomtop_callback
),
2298 struct parse_opt_ctx_t ctx
;
2299 int cmd_is_annotate
= !strcmp(argv
[0], "annotate");
2301 git_config(git_blame_config
, NULL
);
2302 init_revisions(&revs
, NULL
);
2303 revs
.date_mode
= blame_date_mode
;
2304 DIFF_OPT_SET(&revs
.diffopt
, ALLOW_TEXTCONV
);
2306 save_commit_buffer
= 0;
2309 parse_options_start(&ctx
, argc
, argv
, prefix
, PARSE_OPT_KEEP_DASHDASH
|
2310 PARSE_OPT_KEEP_ARGV0
);
2312 switch (parse_options_step(&ctx
, options
, blame_opt_usage
)) {
2313 case PARSE_OPT_HELP
:
2315 case PARSE_OPT_DONE
:
2317 dashdash_pos
= ctx
.cpidx
;
2321 if (!strcmp(ctx
.argv
[0], "--reverse")) {
2322 ctx
.argv
[0] = "--children";
2325 parse_revision_opt(&revs
, &ctx
, options
, blame_opt_usage
);
2328 argc
= parse_options_end(&ctx
);
2330 if (revs_file
&& read_ancestry(revs_file
))
2331 die_errno("reading graft file '%s' failed", revs_file
);
2333 if (cmd_is_annotate
) {
2334 output_option
|= OUTPUT_ANNOTATE_COMPAT
;
2335 blame_date_mode
= DATE_ISO8601
;
2337 blame_date_mode
= revs
.date_mode
;
2340 /* The maximum width used to show the dates */
2341 switch (blame_date_mode
) {
2343 blame_date_width
= sizeof("Thu, 19 Oct 2006 16:00:04 -0700");
2346 blame_date_width
= sizeof("2006-10-19 16:00:04 -0700");
2349 blame_date_width
= sizeof("1161298804 -0700");
2352 blame_date_width
= sizeof("2006-10-19");
2355 /* "normal" is used as the fallback for "relative" */
2358 blame_date_width
= sizeof("Thu Oct 19 16:00:04 2006 -0700");
2361 blame_date_width
-= 1; /* strip the null */
2363 if (DIFF_OPT_TST(&revs
.diffopt
, FIND_COPIES_HARDER
))
2364 opt
|= (PICKAXE_BLAME_COPY
| PICKAXE_BLAME_MOVE
|
2365 PICKAXE_BLAME_COPY_HARDER
);
2367 if (!blame_move_score
)
2368 blame_move_score
= BLAME_DEFAULT_MOVE_SCORE
;
2369 if (!blame_copy_score
)
2370 blame_copy_score
= BLAME_DEFAULT_COPY_SCORE
;
2373 * We have collected options unknown to us in argv[1..unk]
2374 * which are to be passed to revision machinery if we are
2375 * going to do the "bottom" processing.
2377 * The remaining are:
2379 * (1) if dashdash_pos != 0, it is either
2380 * "blame [revisions] -- <path>" or
2381 * "blame -- <path> <rev>"
2383 * (2) otherwise, it is one of the two:
2384 * "blame [revisions] <path>"
2385 * "blame <path> <rev>"
2387 * Note that we must strip out <path> from the arguments: we do not
2388 * want the path pruning but we may want "bottom" processing.
2391 switch (argc
- dashdash_pos
- 1) {
2394 usage_with_options(blame_opt_usage
, options
);
2395 /* reorder for the new way: <rev> -- <path> */
2401 path
= add_prefix(prefix
, argv
[--argc
]);
2405 usage_with_options(blame_opt_usage
, options
);
2409 usage_with_options(blame_opt_usage
, options
);
2410 path
= add_prefix(prefix
, argv
[argc
- 1]);
2411 if (argc
== 3 && !has_string_in_work_tree(path
)) { /* (2b) */
2412 path
= add_prefix(prefix
, argv
[1]);
2415 argv
[argc
- 1] = "--";
2418 if (!has_string_in_work_tree(path
))
2419 die_errno("cannot stat path '%s'", path
);
2422 revs
.disable_stdin
= 1;
2423 setup_revisions(argc
, argv
, &revs
, NULL
);
2424 memset(&sb
, 0, sizeof(sb
));
2428 final_commit_name
= prepare_final(&sb
);
2429 else if (contents_from
)
2430 die("--contents and --children do not blend well.");
2432 final_commit_name
= prepare_initial(&sb
);
2436 * "--not A B -- path" without anything positive;
2437 * do not default to HEAD, but use the working tree
2441 sb
.final
= fake_working_tree_commit(&sb
.revs
->diffopt
,
2442 path
, contents_from
);
2443 add_pending_object(&revs
, &(sb
.final
->object
), ":");
2445 else if (contents_from
)
2446 die("Cannot use --contents with final commit object name");
2449 * If we have bottom, this will mark the ancestors of the
2450 * bottom commits we would reach while traversing as
2453 if (prepare_revision_walk(&revs
))
2454 die("revision walk setup failed");
2456 if (is_null_sha1(sb
.final
->object
.sha1
)) {
2459 buf
= xmalloc(o
->file
.size
+ 1);
2460 memcpy(buf
, o
->file
.ptr
, o
->file
.size
+ 1);
2462 sb
.final_buf_size
= o
->file
.size
;
2465 o
= get_origin(&sb
, sb
.final
, path
);
2466 if (fill_blob_sha1(o
))
2467 die("no such path %s in %s", path
, final_commit_name
);
2469 if (DIFF_OPT_TST(&sb
.revs
->diffopt
, ALLOW_TEXTCONV
) &&
2470 textconv_object(path
, o
->blob_sha1
, (char **) &sb
.final_buf
,
2471 &sb
.final_buf_size
))
2474 sb
.final_buf
= read_sha1_file(o
->blob_sha1
, &type
,
2475 &sb
.final_buf_size
);
2478 die("Cannot read blob %s for path %s",
2479 sha1_to_hex(o
->blob_sha1
),
2483 lno
= prepare_lines(&sb
);
2487 prepare_blame_range(&sb
, bottomtop
, lno
, &bottom
, &top
);
2488 if (bottom
&& top
&& top
< bottom
) {
2490 tmp
= top
; top
= bottom
; bottom
= tmp
;
2497 if (lno
< top
|| lno
< bottom
)
2498 die("file %s has only %lu lines", path
, lno
);
2500 ent
= xcalloc(1, sizeof(*ent
));
2502 ent
->num_lines
= top
- bottom
;
2504 ent
->s_lno
= bottom
;
2509 read_mailmap(&mailmap
, NULL
);
2514 assign_blame(&sb
, opt
);
2521 if (!(output_option
& OUTPUT_PORCELAIN
))
2522 find_alignment(&sb
, &output_option
);
2524 output(&sb
, output_option
);
2525 free((void *)sb
.final_buf
);
2526 for (ent
= sb
.ent
; ent
; ) {
2527 struct blame_entry
*e
= ent
->next
;
2533 printf("num read blob: %d\n", num_read_blob
);
2534 printf("num get patch: %d\n", num_get_patch
);
2535 printf("num commits: %d\n", num_commits
);