4 * Copyright (c) 2006, Junio C Hamano
12 #include "tree-walk.h"
17 #include "xdiff-interface.h"
18 #include "cache-tree.h"
19 #include "path-list.h"
21 #include "parse-options.h"
23 static char blame_usage
[] = "git-blame [options] [rev-opts] [rev] [--] file";
25 static const char *blame_opt_usage
[] = {
28 "[rev-opts] are documented in git-rev-list(1)",
32 static int longest_file
;
33 static int longest_author
;
34 static int max_orig_digits
;
35 static int max_digits
;
36 static int max_score_digits
;
39 static int blank_boundary
;
40 static int incremental
;
41 static int cmd_is_annotate
;
42 static int xdl_opts
= XDF_NEED_MINIMAL
;
43 static struct path_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 /* the line number of the first line of this group in the
157 * suspect's file; internally all line numbers are 0 based.
161 /* how significant this entry is -- cached to avoid
162 * scanning the lines over and over.
168 * The current state of the blame assignment.
171 /* the final commit (i.e. where we started digging from) */
172 struct commit
*final
;
173 struct rev_info
*revs
;
177 * The contents in the final image.
178 * Used by many functions to obtain contents of the nth line,
179 * indexed with scoreboard.lineno[blame_entry.lno].
181 const char *final_buf
;
182 unsigned long final_buf_size
;
184 /* linked list of blames */
185 struct blame_entry
*ent
;
187 /* look-up a line in the final buffer */
192 static inline int same_suspect(struct origin
*a
, struct origin
*b
)
196 if (a
->commit
!= b
->commit
)
198 return !strcmp(a
->path
, b
->path
);
201 static void sanity_check_refcnt(struct scoreboard
*);
204 * If two blame entries that are next to each other came from
205 * contiguous lines in the same origin (i.e. <commit, path> pair),
206 * merge them together.
208 static void coalesce(struct scoreboard
*sb
)
210 struct blame_entry
*ent
, *next
;
212 for (ent
= sb
->ent
; ent
&& (next
= ent
->next
); ent
= next
) {
213 if (same_suspect(ent
->suspect
, next
->suspect
) &&
214 ent
->guilty
== next
->guilty
&&
215 ent
->s_lno
+ ent
->num_lines
== next
->s_lno
) {
216 ent
->num_lines
+= next
->num_lines
;
217 ent
->next
= next
->next
;
219 ent
->next
->prev
= ent
;
220 origin_decref(next
->suspect
);
223 next
= ent
; /* again */
227 if (DEBUG
) /* sanity */
228 sanity_check_refcnt(sb
);
232 * Given a commit and a path in it, create a new origin structure.
233 * The callers that add blame to the scoreboard should use
234 * get_origin() to obtain shared, refcounted copy instead of calling
235 * this function directly.
237 static struct origin
*make_origin(struct commit
*commit
, const char *path
)
240 o
= xcalloc(1, sizeof(*o
) + strlen(path
) + 1);
243 strcpy(o
->path
, path
);
248 * Locate an existing origin or create a new one.
250 static struct origin
*get_origin(struct scoreboard
*sb
,
251 struct commit
*commit
,
254 struct blame_entry
*e
;
256 for (e
= sb
->ent
; e
; e
= e
->next
) {
257 if (e
->suspect
->commit
== commit
&&
258 !strcmp(e
->suspect
->path
, path
))
259 return origin_incref(e
->suspect
);
261 return make_origin(commit
, path
);
265 * Fill the blob_sha1 field of an origin if it hasn't, so that later
266 * call to fill_origin_blob() can use it to locate the data. blob_sha1
267 * for an origin is also used to pass the blame for the entire file to
268 * the parent to detect the case where a child's blob is identical to
269 * that of its parent's.
271 static int fill_blob_sha1(struct origin
*origin
)
275 if (!is_null_sha1(origin
->blob_sha1
))
277 if (get_tree_entry(origin
->commit
->object
.sha1
,
279 origin
->blob_sha1
, &mode
))
281 if (sha1_object_info(origin
->blob_sha1
, NULL
) != OBJ_BLOB
)
285 hashclr(origin
->blob_sha1
);
290 * We have an origin -- check if the same path exists in the
291 * parent and return an origin structure to represent it.
293 static struct origin
*find_origin(struct scoreboard
*sb
,
294 struct commit
*parent
,
295 struct origin
*origin
)
297 struct origin
*porigin
= NULL
;
298 struct diff_options diff_opts
;
299 const char *paths
[2];
303 * Each commit object can cache one origin in that
304 * commit. This is a freestanding copy of origin and
307 struct origin
*cached
= parent
->util
;
308 if (!strcmp(cached
->path
, origin
->path
)) {
310 * The same path between origin and its parent
311 * without renaming -- the most common case.
313 porigin
= get_origin(sb
, parent
, cached
->path
);
316 * If the origin was newly created (i.e. get_origin
317 * would call make_origin if none is found in the
318 * scoreboard), it does not know the blob_sha1,
319 * so copy it. Otherwise porigin was in the
320 * scoreboard and already knows blob_sha1.
322 if (porigin
->refcnt
== 1)
323 hashcpy(porigin
->blob_sha1
, cached
->blob_sha1
);
326 /* otherwise it was not very useful; free it */
331 /* See if the origin->path is different between parent
332 * and origin first. Most of the time they are the
333 * same and diff-tree is fairly efficient about this.
335 diff_setup(&diff_opts
);
336 DIFF_OPT_SET(&diff_opts
, RECURSIVE
);
337 diff_opts
.detect_rename
= 0;
338 diff_opts
.output_format
= DIFF_FORMAT_NO_OUTPUT
;
339 paths
[0] = origin
->path
;
342 diff_tree_setup_paths(paths
, &diff_opts
);
343 if (diff_setup_done(&diff_opts
) < 0)
346 if (is_null_sha1(origin
->commit
->object
.sha1
))
347 do_diff_cache(parent
->tree
->object
.sha1
, &diff_opts
);
349 diff_tree_sha1(parent
->tree
->object
.sha1
,
350 origin
->commit
->tree
->object
.sha1
,
352 diffcore_std(&diff_opts
);
354 /* It is either one entry that says "modified", or "created",
357 if (!diff_queued_diff
.nr
) {
358 /* The path is the same as parent */
359 porigin
= get_origin(sb
, parent
, origin
->path
);
360 hashcpy(porigin
->blob_sha1
, origin
->blob_sha1
);
362 else if (diff_queued_diff
.nr
!= 1)
363 die("internal error in blame::find_origin");
365 struct diff_filepair
*p
= diff_queued_diff
.queue
[0];
368 die("internal error in blame::find_origin (%c)",
371 porigin
= get_origin(sb
, parent
, origin
->path
);
372 hashcpy(porigin
->blob_sha1
, p
->one
->sha1
);
376 /* Did not exist in parent, or type changed */
380 diff_flush(&diff_opts
);
381 diff_tree_release_paths(&diff_opts
);
384 * Create a freestanding copy that is not part of
385 * the refcounted origin found in the scoreboard, and
386 * cache it in the commit.
388 struct origin
*cached
;
390 cached
= make_origin(porigin
->commit
, porigin
->path
);
391 hashcpy(cached
->blob_sha1
, porigin
->blob_sha1
);
392 parent
->util
= cached
;
398 * We have an origin -- find the path that corresponds to it in its
399 * parent and return an origin structure to represent it.
401 static struct origin
*find_rename(struct scoreboard
*sb
,
402 struct commit
*parent
,
403 struct origin
*origin
)
405 struct origin
*porigin
= NULL
;
406 struct diff_options diff_opts
;
408 const char *paths
[2];
410 diff_setup(&diff_opts
);
411 DIFF_OPT_SET(&diff_opts
, RECURSIVE
);
412 diff_opts
.detect_rename
= DIFF_DETECT_RENAME
;
413 diff_opts
.output_format
= DIFF_FORMAT_NO_OUTPUT
;
414 diff_opts
.single_follow
= origin
->path
;
416 diff_tree_setup_paths(paths
, &diff_opts
);
417 if (diff_setup_done(&diff_opts
) < 0)
420 if (is_null_sha1(origin
->commit
->object
.sha1
))
421 do_diff_cache(parent
->tree
->object
.sha1
, &diff_opts
);
423 diff_tree_sha1(parent
->tree
->object
.sha1
,
424 origin
->commit
->tree
->object
.sha1
,
426 diffcore_std(&diff_opts
);
428 for (i
= 0; i
< diff_queued_diff
.nr
; i
++) {
429 struct diff_filepair
*p
= diff_queued_diff
.queue
[i
];
430 if ((p
->status
== 'R' || p
->status
== 'C') &&
431 !strcmp(p
->two
->path
, origin
->path
)) {
432 porigin
= get_origin(sb
, parent
, p
->one
->path
);
433 hashcpy(porigin
->blob_sha1
, p
->one
->sha1
);
437 diff_flush(&diff_opts
);
438 diff_tree_release_paths(&diff_opts
);
443 * Parsing of patch chunks...
446 /* line number in postimage; up to but not including this
447 * line is the same as preimage
451 /* preimage line number after this chunk */
454 /* postimage line number after this chunk */
459 struct chunk
*chunks
;
463 struct blame_diff_state
{
464 struct xdiff_emit_state xm
;
466 unsigned hunk_post_context
;
467 unsigned hunk_in_pre_context
: 1;
470 static void process_u_diff(void *state_
, char *line
, unsigned long len
)
472 struct blame_diff_state
*state
= state_
;
474 int off1
, off2
, len1
, len2
, num
;
476 num
= state
->ret
->num
;
477 if (len
< 4 || line
[0] != '@' || line
[1] != '@') {
478 if (state
->hunk_in_pre_context
&& line
[0] == ' ')
479 state
->ret
->chunks
[num
- 1].same
++;
481 state
->hunk_in_pre_context
= 0;
483 state
->hunk_post_context
++;
485 state
->hunk_post_context
= 0;
490 if (num
&& state
->hunk_post_context
) {
491 chunk
= &state
->ret
->chunks
[num
- 1];
492 chunk
->p_next
-= state
->hunk_post_context
;
493 chunk
->t_next
-= state
->hunk_post_context
;
495 state
->ret
->num
= ++num
;
496 state
->ret
->chunks
= xrealloc(state
->ret
->chunks
,
497 sizeof(struct chunk
) * num
);
498 chunk
= &state
->ret
->chunks
[num
- 1];
499 if (parse_hunk_header(line
, len
, &off1
, &len1
, &off2
, &len2
)) {
504 /* Line numbers in patch output are one based. */
508 chunk
->same
= len2
? off2
: (off2
+ 1);
510 chunk
->p_next
= off1
+ (len1
? len1
: 1);
511 chunk
->t_next
= chunk
->same
+ len2
;
512 state
->hunk_in_pre_context
= 1;
513 state
->hunk_post_context
= 0;
516 static struct patch
*compare_buffer(mmfile_t
*file_p
, mmfile_t
*file_o
,
519 struct blame_diff_state state
;
524 xpp
.flags
= xdl_opts
;
525 memset(&xecfg
, 0, sizeof(xecfg
));
526 xecfg
.ctxlen
= context
;
527 ecb
.outf
= xdiff_outf
;
529 memset(&state
, 0, sizeof(state
));
530 state
.xm
.consume
= process_u_diff
;
531 state
.ret
= xmalloc(sizeof(struct patch
));
532 state
.ret
->chunks
= NULL
;
535 xdi_diff(file_p
, file_o
, &xpp
, &xecfg
, &ecb
);
537 if (state
.ret
->num
) {
539 chunk
= &state
.ret
->chunks
[state
.ret
->num
- 1];
540 chunk
->p_next
-= state
.hunk_post_context
;
541 chunk
->t_next
-= state
.hunk_post_context
;
547 * Run diff between two origins and grab the patch output, so that
548 * we can pass blame for lines origin is currently suspected for
551 static struct patch
*get_patch(struct origin
*parent
, struct origin
*origin
)
553 mmfile_t file_p
, file_o
;
556 fill_origin_blob(parent
, &file_p
);
557 fill_origin_blob(origin
, &file_o
);
558 if (!file_p
.ptr
|| !file_o
.ptr
)
560 patch
= compare_buffer(&file_p
, &file_o
, 0);
565 static void free_patch(struct patch
*p
)
572 * Link in a new blame entry to the scoreboard. Entries that cover the
573 * same line range have been removed from the scoreboard previously.
575 static void add_blame_entry(struct scoreboard
*sb
, struct blame_entry
*e
)
577 struct blame_entry
*ent
, *prev
= NULL
;
579 origin_incref(e
->suspect
);
581 for (ent
= sb
->ent
; ent
&& ent
->lno
< e
->lno
; ent
= ent
->next
)
584 /* prev, if not NULL, is the last one that is below e */
587 e
->next
= prev
->next
;
599 * src typically is on-stack; we want to copy the information in it to
600 * a malloced blame_entry that is already on the linked list of the
601 * scoreboard. The origin of dst loses a refcnt while the origin of src
604 static void dup_entry(struct blame_entry
*dst
, struct blame_entry
*src
)
606 struct blame_entry
*p
, *n
;
610 origin_incref(src
->suspect
);
611 origin_decref(dst
->suspect
);
612 memcpy(dst
, src
, sizeof(*src
));
618 static const char *nth_line(struct scoreboard
*sb
, int lno
)
620 return sb
->final_buf
+ sb
->lineno
[lno
];
624 * It is known that lines between tlno to same came from parent, and e
625 * has an overlap with that range. it also is known that parent's
626 * line plno corresponds to e's line tlno.
632 * <------------------>
634 * Split e into potentially three parts; before this chunk, the chunk
635 * to be blamed for the parent, and after that portion.
637 static void split_overlap(struct blame_entry
*split
,
638 struct blame_entry
*e
,
639 int tlno
, int plno
, int same
,
640 struct origin
*parent
)
643 memset(split
, 0, sizeof(struct blame_entry
[3]));
645 if (e
->s_lno
< tlno
) {
646 /* there is a pre-chunk part not blamed on parent */
647 split
[0].suspect
= origin_incref(e
->suspect
);
648 split
[0].lno
= e
->lno
;
649 split
[0].s_lno
= e
->s_lno
;
650 split
[0].num_lines
= tlno
- e
->s_lno
;
651 split
[1].lno
= e
->lno
+ tlno
- e
->s_lno
;
652 split
[1].s_lno
= plno
;
655 split
[1].lno
= e
->lno
;
656 split
[1].s_lno
= plno
+ (e
->s_lno
- tlno
);
659 if (same
< e
->s_lno
+ e
->num_lines
) {
660 /* there is a post-chunk part not blamed on parent */
661 split
[2].suspect
= origin_incref(e
->suspect
);
662 split
[2].lno
= e
->lno
+ (same
- e
->s_lno
);
663 split
[2].s_lno
= e
->s_lno
+ (same
- e
->s_lno
);
664 split
[2].num_lines
= e
->s_lno
+ e
->num_lines
- same
;
665 chunk_end_lno
= split
[2].lno
;
668 chunk_end_lno
= e
->lno
+ e
->num_lines
;
669 split
[1].num_lines
= chunk_end_lno
- split
[1].lno
;
672 * if it turns out there is nothing to blame the parent for,
673 * forget about the splitting. !split[1].suspect signals this.
675 if (split
[1].num_lines
< 1)
677 split
[1].suspect
= origin_incref(parent
);
681 * split_overlap() divided an existing blame e into up to three parts
682 * in split. Adjust the linked list of blames in the scoreboard to
685 static void split_blame(struct scoreboard
*sb
,
686 struct blame_entry
*split
,
687 struct blame_entry
*e
)
689 struct blame_entry
*new_entry
;
691 if (split
[0].suspect
&& split
[2].suspect
) {
692 /* The first part (reuse storage for the existing entry e) */
693 dup_entry(e
, &split
[0]);
695 /* The last part -- me */
696 new_entry
= xmalloc(sizeof(*new_entry
));
697 memcpy(new_entry
, &(split
[2]), sizeof(struct blame_entry
));
698 add_blame_entry(sb
, new_entry
);
700 /* ... and the middle part -- parent */
701 new_entry
= xmalloc(sizeof(*new_entry
));
702 memcpy(new_entry
, &(split
[1]), sizeof(struct blame_entry
));
703 add_blame_entry(sb
, new_entry
);
705 else if (!split
[0].suspect
&& !split
[2].suspect
)
707 * The parent covers the entire area; reuse storage for
708 * e and replace it with the parent.
710 dup_entry(e
, &split
[1]);
711 else if (split
[0].suspect
) {
712 /* me and then parent */
713 dup_entry(e
, &split
[0]);
715 new_entry
= xmalloc(sizeof(*new_entry
));
716 memcpy(new_entry
, &(split
[1]), sizeof(struct blame_entry
));
717 add_blame_entry(sb
, new_entry
);
720 /* parent and then me */
721 dup_entry(e
, &split
[1]);
723 new_entry
= xmalloc(sizeof(*new_entry
));
724 memcpy(new_entry
, &(split
[2]), sizeof(struct blame_entry
));
725 add_blame_entry(sb
, new_entry
);
728 if (DEBUG
) { /* sanity */
729 struct blame_entry
*ent
;
730 int lno
= sb
->ent
->lno
, corrupt
= 0;
732 for (ent
= sb
->ent
; ent
; ent
= ent
->next
) {
737 lno
+= ent
->num_lines
;
741 for (ent
= sb
->ent
; ent
; ent
= ent
->next
) {
742 printf("L %8d l %8d n %8d\n",
743 lno
, ent
->lno
, ent
->num_lines
);
744 lno
= ent
->lno
+ ent
->num_lines
;
752 * After splitting the blame, the origins used by the
753 * on-stack blame_entry should lose one refcnt each.
755 static void decref_split(struct blame_entry
*split
)
759 for (i
= 0; i
< 3; i
++)
760 origin_decref(split
[i
].suspect
);
764 * Helper for blame_chunk(). blame_entry e is known to overlap with
765 * the patch hunk; split it and pass blame to the parent.
767 static void blame_overlap(struct scoreboard
*sb
, struct blame_entry
*e
,
768 int tlno
, int plno
, int same
,
769 struct origin
*parent
)
771 struct blame_entry split
[3];
773 split_overlap(split
, e
, tlno
, plno
, same
, parent
);
774 if (split
[1].suspect
)
775 split_blame(sb
, split
, e
);
780 * Find the line number of the last line the target is suspected for.
782 static int find_last_in_target(struct scoreboard
*sb
, struct origin
*target
)
784 struct blame_entry
*e
;
785 int last_in_target
= -1;
787 for (e
= sb
->ent
; e
; e
= e
->next
) {
788 if (e
->guilty
|| !same_suspect(e
->suspect
, target
))
790 if (last_in_target
< e
->s_lno
+ e
->num_lines
)
791 last_in_target
= e
->s_lno
+ e
->num_lines
;
793 return last_in_target
;
797 * Process one hunk from the patch between the current suspect for
798 * blame_entry e and its parent. Find and split the overlap, and
799 * pass blame to the overlapping part to the parent.
801 static void blame_chunk(struct scoreboard
*sb
,
802 int tlno
, int plno
, int same
,
803 struct origin
*target
, struct origin
*parent
)
805 struct blame_entry
*e
;
807 for (e
= sb
->ent
; e
; e
= e
->next
) {
808 if (e
->guilty
|| !same_suspect(e
->suspect
, target
))
810 if (same
<= e
->s_lno
)
812 if (tlno
< e
->s_lno
+ e
->num_lines
)
813 blame_overlap(sb
, e
, tlno
, plno
, same
, parent
);
818 * We are looking at the origin 'target' and aiming to pass blame
819 * for the lines it is suspected to its parent. Run diff to find
820 * which lines came from parent and pass blame for them.
822 static int pass_blame_to_parent(struct scoreboard
*sb
,
823 struct origin
*target
,
824 struct origin
*parent
)
826 int i
, last_in_target
, plno
, tlno
;
829 last_in_target
= find_last_in_target(sb
, target
);
830 if (last_in_target
< 0)
831 return 1; /* nothing remains for this target */
833 patch
= get_patch(parent
, target
);
835 for (i
= 0; i
< patch
->num
; i
++) {
836 struct chunk
*chunk
= &patch
->chunks
[i
];
838 blame_chunk(sb
, tlno
, plno
, chunk
->same
, target
, parent
);
839 plno
= chunk
->p_next
;
840 tlno
= chunk
->t_next
;
842 /* The rest (i.e. anything after tlno) are the same as the parent */
843 blame_chunk(sb
, tlno
, plno
, last_in_target
, target
, parent
);
850 * The lines in blame_entry after splitting blames many times can become
851 * very small and trivial, and at some point it becomes pointless to
852 * blame the parents. E.g. "\t\t}\n\t}\n\n" appears everywhere in any
853 * ordinary C program, and it is not worth to say it was copied from
854 * totally unrelated file in the parent.
856 * Compute how trivial the lines in the blame_entry are.
858 static unsigned ent_score(struct scoreboard
*sb
, struct blame_entry
*e
)
867 cp
= nth_line(sb
, e
->lno
);
868 ep
= nth_line(sb
, e
->lno
+ e
->num_lines
);
870 unsigned ch
= *((unsigned char *)cp
);
880 * best_so_far[] and this[] are both a split of an existing blame_entry
881 * that passes blame to the parent. Maintain best_so_far the best split
882 * so far, by comparing this and best_so_far and copying this into
883 * bst_so_far as needed.
885 static void copy_split_if_better(struct scoreboard
*sb
,
886 struct blame_entry
*best_so_far
,
887 struct blame_entry
*this)
891 if (!this[1].suspect
)
893 if (best_so_far
[1].suspect
) {
894 if (ent_score(sb
, &this[1]) < ent_score(sb
, &best_so_far
[1]))
898 for (i
= 0; i
< 3; i
++)
899 origin_incref(this[i
].suspect
);
900 decref_split(best_so_far
);
901 memcpy(best_so_far
, this, sizeof(struct blame_entry
[3]));
905 * We are looking at a part of the final image represented by
906 * ent (tlno and same are offset by ent->s_lno).
907 * tlno is where we are looking at in the final image.
908 * up to (but not including) same match preimage.
909 * plno is where we are looking at in the preimage.
911 * <-------------- final image ---------------------->
914 * <---------preimage----->
917 * All line numbers are 0-based.
919 static void handle_split(struct scoreboard
*sb
,
920 struct blame_entry
*ent
,
921 int tlno
, int plno
, int same
,
922 struct origin
*parent
,
923 struct blame_entry
*split
)
925 if (ent
->num_lines
<= tlno
)
928 struct blame_entry
this[3];
931 split_overlap(this, ent
, tlno
, plno
, same
, parent
);
932 copy_split_if_better(sb
, split
, this);
938 * Find the lines from parent that are the same as ent so that
939 * we can pass blames to it. file_p has the blob contents for
942 static void find_copy_in_blob(struct scoreboard
*sb
,
943 struct blame_entry
*ent
,
944 struct origin
*parent
,
945 struct blame_entry
*split
,
955 * Prepare mmfile that contains only the lines in ent.
957 cp
= nth_line(sb
, ent
->lno
);
958 file_o
.ptr
= (char*) cp
;
959 cnt
= ent
->num_lines
;
961 while (cnt
&& cp
< sb
->final_buf
+ sb
->final_buf_size
) {
965 file_o
.size
= cp
- file_o
.ptr
;
967 patch
= compare_buffer(file_p
, &file_o
, 1);
970 * file_o is a part of final image we are annotating.
971 * file_p partially may match that image.
973 memset(split
, 0, sizeof(struct blame_entry
[3]));
975 for (i
= 0; i
< patch
->num
; i
++) {
976 struct chunk
*chunk
= &patch
->chunks
[i
];
978 handle_split(sb
, ent
, tlno
, plno
, chunk
->same
, parent
, split
);
979 plno
= chunk
->p_next
;
980 tlno
= chunk
->t_next
;
982 /* remainder, if any, all match the preimage */
983 handle_split(sb
, ent
, tlno
, plno
, ent
->num_lines
, parent
, split
);
988 * See if lines currently target is suspected for can be attributed to
991 static int find_move_in_parent(struct scoreboard
*sb
,
992 struct origin
*target
,
993 struct origin
*parent
)
995 int last_in_target
, made_progress
;
996 struct blame_entry
*e
, split
[3];
999 last_in_target
= find_last_in_target(sb
, target
);
1000 if (last_in_target
< 0)
1001 return 1; /* nothing remains for this target */
1003 fill_origin_blob(parent
, &file_p
);
1008 while (made_progress
) {
1010 for (e
= sb
->ent
; e
; e
= e
->next
) {
1011 if (e
->guilty
|| !same_suspect(e
->suspect
, target
))
1013 find_copy_in_blob(sb
, e
, parent
, split
, &file_p
);
1014 if (split
[1].suspect
&&
1015 blame_move_score
< ent_score(sb
, &split
[1])) {
1016 split_blame(sb
, split
, e
);
1019 decref_split(split
);
1026 struct blame_entry
*ent
;
1027 struct blame_entry split
[3];
1031 * Count the number of entries the target is suspected for,
1032 * and prepare a list of entry and the best split.
1034 static struct blame_list
*setup_blame_list(struct scoreboard
*sb
,
1035 struct origin
*target
,
1038 struct blame_entry
*e
;
1040 struct blame_list
*blame_list
= NULL
;
1042 for (e
= sb
->ent
, num_ents
= 0; e
; e
= e
->next
)
1043 if (!e
->guilty
&& same_suspect(e
->suspect
, target
))
1046 blame_list
= xcalloc(num_ents
, sizeof(struct blame_list
));
1047 for (e
= sb
->ent
, i
= 0; e
; e
= e
->next
)
1048 if (!e
->guilty
&& same_suspect(e
->suspect
, target
))
1049 blame_list
[i
++].ent
= e
;
1051 *num_ents_p
= num_ents
;
1056 * For lines target is suspected for, see if we can find code movement
1057 * across file boundary from the parent commit. porigin is the path
1058 * in the parent we already tried.
1060 static int find_copy_in_parent(struct scoreboard
*sb
,
1061 struct origin
*target
,
1062 struct commit
*parent
,
1063 struct origin
*porigin
,
1066 struct diff_options diff_opts
;
1067 const char *paths
[1];
1070 struct blame_list
*blame_list
;
1073 blame_list
= setup_blame_list(sb
, target
, &num_ents
);
1075 return 1; /* nothing remains for this target */
1077 diff_setup(&diff_opts
);
1078 DIFF_OPT_SET(&diff_opts
, RECURSIVE
);
1079 diff_opts
.output_format
= DIFF_FORMAT_NO_OUTPUT
;
1082 diff_tree_setup_paths(paths
, &diff_opts
);
1083 if (diff_setup_done(&diff_opts
) < 0)
1086 /* Try "find copies harder" on new path if requested;
1087 * we do not want to use diffcore_rename() actually to
1088 * match things up; find_copies_harder is set only to
1089 * force diff_tree_sha1() to feed all filepairs to diff_queue,
1090 * and this code needs to be after diff_setup_done(), which
1091 * usually makes find-copies-harder imply copy detection.
1093 if ((opt
& PICKAXE_BLAME_COPY_HARDEST
)
1094 || ((opt
& PICKAXE_BLAME_COPY_HARDER
)
1095 && (!porigin
|| strcmp(target
->path
, porigin
->path
))))
1096 DIFF_OPT_SET(&diff_opts
, FIND_COPIES_HARDER
);
1098 if (is_null_sha1(target
->commit
->object
.sha1
))
1099 do_diff_cache(parent
->tree
->object
.sha1
, &diff_opts
);
1101 diff_tree_sha1(parent
->tree
->object
.sha1
,
1102 target
->commit
->tree
->object
.sha1
,
1105 if (!DIFF_OPT_TST(&diff_opts
, FIND_COPIES_HARDER
))
1106 diffcore_std(&diff_opts
);
1110 int made_progress
= 0;
1112 for (i
= 0; i
< diff_queued_diff
.nr
; i
++) {
1113 struct diff_filepair
*p
= diff_queued_diff
.queue
[i
];
1114 struct origin
*norigin
;
1116 struct blame_entry
this[3];
1118 if (!DIFF_FILE_VALID(p
->one
))
1119 continue; /* does not exist in parent */
1120 if (porigin
&& !strcmp(p
->one
->path
, porigin
->path
))
1121 /* find_move already dealt with this path */
1124 norigin
= get_origin(sb
, parent
, p
->one
->path
);
1125 hashcpy(norigin
->blob_sha1
, p
->one
->sha1
);
1126 fill_origin_blob(norigin
, &file_p
);
1130 for (j
= 0; j
< num_ents
; j
++) {
1131 find_copy_in_blob(sb
, blame_list
[j
].ent
,
1132 norigin
, this, &file_p
);
1133 copy_split_if_better(sb
, blame_list
[j
].split
,
1137 origin_decref(norigin
);
1140 for (j
= 0; j
< num_ents
; j
++) {
1141 struct blame_entry
*split
= blame_list
[j
].split
;
1142 if (split
[1].suspect
&&
1143 blame_copy_score
< ent_score(sb
, &split
[1])) {
1144 split_blame(sb
, split
, blame_list
[j
].ent
);
1147 decref_split(split
);
1153 blame_list
= setup_blame_list(sb
, target
, &num_ents
);
1159 diff_flush(&diff_opts
);
1160 diff_tree_release_paths(&diff_opts
);
1165 * The blobs of origin and porigin exactly match, so everything
1166 * origin is suspected for can be blamed on the parent.
1168 static void pass_whole_blame(struct scoreboard
*sb
,
1169 struct origin
*origin
, struct origin
*porigin
)
1171 struct blame_entry
*e
;
1173 if (!porigin
->file
.ptr
&& origin
->file
.ptr
) {
1174 /* Steal its file */
1175 porigin
->file
= origin
->file
;
1176 origin
->file
.ptr
= NULL
;
1178 for (e
= sb
->ent
; e
; e
= e
->next
) {
1179 if (!same_suspect(e
->suspect
, origin
))
1181 origin_incref(porigin
);
1182 origin_decref(e
->suspect
);
1183 e
->suspect
= porigin
;
1188 * We pass blame from the current commit to its parents. We keep saying
1189 * "parent" (and "porigin"), but what we mean is to find scapegoat to
1190 * exonerate ourselves.
1192 static struct commit_list
*first_scapegoat(struct rev_info
*revs
, struct commit
*commit
)
1195 return commit
->parents
;
1196 return lookup_decoration(&revs
->children
, &commit
->object
);
1199 static int num_scapegoats(struct rev_info
*revs
, struct commit
*commit
)
1202 struct commit_list
*l
= first_scapegoat(revs
, commit
);
1203 for (cnt
= 0; l
; l
= l
->next
)
1210 static void pass_blame(struct scoreboard
*sb
, struct origin
*origin
, int opt
)
1212 struct rev_info
*revs
= sb
->revs
;
1213 int i
, pass
, num_sg
;
1214 struct commit
*commit
= origin
->commit
;
1215 struct commit_list
*sg
;
1216 struct origin
*sg_buf
[MAXSG
];
1217 struct origin
*porigin
, **sg_origin
= sg_buf
;
1219 num_sg
= num_scapegoats(revs
, commit
);
1222 else if (num_sg
< ARRAY_SIZE(sg_buf
))
1223 memset(sg_buf
, 0, sizeof(sg_buf
));
1225 sg_origin
= xcalloc(num_sg
, sizeof(*sg_origin
));
1228 * The first pass looks for unrenamed path to optimize for
1229 * common cases, then we look for renames in the second pass.
1231 for (pass
= 0; pass
< 2; pass
++) {
1232 struct origin
*(*find
)(struct scoreboard
*,
1233 struct commit
*, struct origin
*);
1234 find
= pass
? find_rename
: find_origin
;
1236 for (i
= 0, sg
= first_scapegoat(revs
, commit
);
1238 sg
= sg
->next
, i
++) {
1239 struct commit
*p
= sg
->item
;
1244 if (parse_commit(p
))
1246 porigin
= find(sb
, p
, origin
);
1249 if (!hashcmp(porigin
->blob_sha1
, origin
->blob_sha1
)) {
1250 pass_whole_blame(sb
, origin
, porigin
);
1251 origin_decref(porigin
);
1254 for (j
= same
= 0; j
< i
; j
++)
1256 !hashcmp(sg_origin
[j
]->blob_sha1
,
1257 porigin
->blob_sha1
)) {
1262 sg_origin
[i
] = porigin
;
1264 origin_decref(porigin
);
1269 for (i
= 0, sg
= first_scapegoat(revs
, commit
);
1271 sg
= sg
->next
, i
++) {
1272 struct origin
*porigin
= sg_origin
[i
];
1275 if (pass_blame_to_parent(sb
, origin
, porigin
))
1280 * Optionally find moves in parents' files.
1282 if (opt
& PICKAXE_BLAME_MOVE
)
1283 for (i
= 0, sg
= first_scapegoat(revs
, commit
);
1285 sg
= sg
->next
, i
++) {
1286 struct origin
*porigin
= sg_origin
[i
];
1289 if (find_move_in_parent(sb
, origin
, porigin
))
1294 * Optionally find copies from parents' files.
1296 if (opt
& PICKAXE_BLAME_COPY
)
1297 for (i
= 0, sg
= first_scapegoat(revs
, commit
);
1299 sg
= sg
->next
, i
++) {
1300 struct origin
*porigin
= sg_origin
[i
];
1301 if (find_copy_in_parent(sb
, origin
, sg
->item
,
1307 for (i
= 0; i
< num_sg
; i
++) {
1309 drop_origin_blob(sg_origin
[i
]);
1310 origin_decref(sg_origin
[i
]);
1313 drop_origin_blob(origin
);
1314 if (sg_buf
!= sg_origin
)
1319 * Information on commits, used for output.
1324 const char *author_mail
;
1325 unsigned long author_time
;
1326 const char *author_tz
;
1328 /* filled only when asked for details */
1329 const char *committer
;
1330 const char *committer_mail
;
1331 unsigned long committer_time
;
1332 const char *committer_tz
;
1334 const char *summary
;
1338 * Parse author/committer line in the commit object buffer
1340 static void get_ac_line(const char *inbuf
, const char *what
,
1341 int bufsz
, char *person
, const char **mail
,
1342 unsigned long *time
, const char **tz
)
1344 int len
, tzlen
, maillen
;
1345 char *tmp
, *endp
, *timepos
;
1347 tmp
= strstr(inbuf
, what
);
1350 tmp
+= strlen(what
);
1351 endp
= strchr(tmp
, '\n');
1359 *mail
= *tz
= "(unknown)";
1363 memcpy(person
, tmp
, len
);
1371 tzlen
= (person
+len
)-(tmp
+1);
1376 *time
= strtoul(tmp
, NULL
, 10);
1384 maillen
= timepos
- tmp
;
1390 * mailmap expansion may make the name longer.
1391 * make room by pushing stuff down.
1393 tmp
= person
+ bufsz
- (tzlen
+ 1);
1394 memmove(tmp
, *tz
, tzlen
);
1398 tmp
= tmp
- (maillen
+ 1);
1399 memmove(tmp
, *mail
, maillen
);
1404 * Now, convert e-mail using mailmap
1406 map_email(&mailmap
, tmp
+ 1, person
, tmp
-person
-1);
1409 static void get_commit_info(struct commit
*commit
,
1410 struct commit_info
*ret
,
1415 static char author_buf
[1024];
1416 static char committer_buf
[1024];
1417 static char summary_buf
[1024];
1420 * We've operated without save_commit_buffer, so
1421 * we now need to populate them for output.
1423 if (!commit
->buffer
) {
1424 enum object_type type
;
1427 read_sha1_file(commit
->object
.sha1
, &type
, &size
);
1428 if (!commit
->buffer
)
1429 die("Cannot read commit %s",
1430 sha1_to_hex(commit
->object
.sha1
));
1432 ret
->author
= author_buf
;
1433 get_ac_line(commit
->buffer
, "\nauthor ",
1434 sizeof(author_buf
), author_buf
, &ret
->author_mail
,
1435 &ret
->author_time
, &ret
->author_tz
);
1440 ret
->committer
= committer_buf
;
1441 get_ac_line(commit
->buffer
, "\ncommitter ",
1442 sizeof(committer_buf
), committer_buf
, &ret
->committer_mail
,
1443 &ret
->committer_time
, &ret
->committer_tz
);
1445 ret
->summary
= summary_buf
;
1446 tmp
= strstr(commit
->buffer
, "\n\n");
1449 sprintf(summary_buf
, "(%s)", sha1_to_hex(commit
->object
.sha1
));
1453 endp
= strchr(tmp
, '\n');
1455 endp
= tmp
+ strlen(tmp
);
1457 if (len
>= sizeof(summary_buf
) || len
== 0)
1459 memcpy(summary_buf
, tmp
, len
);
1460 summary_buf
[len
] = 0;
1464 * To allow LF and other nonportable characters in pathnames,
1465 * they are c-style quoted as needed.
1467 static void write_filename_info(const char *path
)
1469 printf("filename ");
1470 write_name_quoted(path
, stdout
, '\n');
1474 * The blame_entry is found to be guilty for the range. Mark it
1475 * as such, and show it in incremental output.
1477 static void found_guilty_entry(struct blame_entry
*ent
)
1483 struct origin
*suspect
= ent
->suspect
;
1485 printf("%s %d %d %d\n",
1486 sha1_to_hex(suspect
->commit
->object
.sha1
),
1487 ent
->s_lno
+ 1, ent
->lno
+ 1, ent
->num_lines
);
1488 if (!(suspect
->commit
->object
.flags
& METAINFO_SHOWN
)) {
1489 struct commit_info ci
;
1490 suspect
->commit
->object
.flags
|= METAINFO_SHOWN
;
1491 get_commit_info(suspect
->commit
, &ci
, 1);
1492 printf("author %s\n", ci
.author
);
1493 printf("author-mail %s\n", ci
.author_mail
);
1494 printf("author-time %lu\n", ci
.author_time
);
1495 printf("author-tz %s\n", ci
.author_tz
);
1496 printf("committer %s\n", ci
.committer
);
1497 printf("committer-mail %s\n", ci
.committer_mail
);
1498 printf("committer-time %lu\n", ci
.committer_time
);
1499 printf("committer-tz %s\n", ci
.committer_tz
);
1500 printf("summary %s\n", ci
.summary
);
1501 if (suspect
->commit
->object
.flags
& UNINTERESTING
)
1502 printf("boundary\n");
1504 write_filename_info(suspect
->path
);
1505 maybe_flush_or_die(stdout
, "stdout");
1510 * The main loop -- while the scoreboard has lines whose true origin
1511 * is still unknown, pick one blame_entry, and allow its current
1512 * suspect to pass blames to its parents.
1514 static void assign_blame(struct scoreboard
*sb
, int opt
)
1516 struct rev_info
*revs
= sb
->revs
;
1519 struct blame_entry
*ent
;
1520 struct commit
*commit
;
1521 struct origin
*suspect
= NULL
;
1523 /* find one suspect to break down */
1524 for (ent
= sb
->ent
; !suspect
&& ent
; ent
= ent
->next
)
1526 suspect
= ent
->suspect
;
1528 return; /* all done */
1531 * We will use this suspect later in the loop,
1532 * so hold onto it in the meantime.
1534 origin_incref(suspect
);
1535 commit
= suspect
->commit
;
1536 if (!commit
->object
.parsed
)
1537 parse_commit(commit
);
1539 (!(commit
->object
.flags
& UNINTERESTING
) &&
1540 !(revs
->max_age
!= -1 && commit
->date
< revs
->max_age
)))
1541 pass_blame(sb
, suspect
, opt
);
1543 commit
->object
.flags
|= UNINTERESTING
;
1544 if (commit
->object
.parsed
)
1545 mark_parents_uninteresting(commit
);
1547 /* treat root commit as boundary */
1548 if (!commit
->parents
&& !show_root
)
1549 commit
->object
.flags
|= UNINTERESTING
;
1551 /* Take responsibility for the remaining entries */
1552 for (ent
= sb
->ent
; ent
; ent
= ent
->next
)
1553 if (same_suspect(ent
->suspect
, suspect
))
1554 found_guilty_entry(ent
);
1555 origin_decref(suspect
);
1557 if (DEBUG
) /* sanity */
1558 sanity_check_refcnt(sb
);
1562 static const char *format_time(unsigned long time
, const char *tz_str
,
1565 static char time_buf
[128];
1570 if (show_raw_time
) {
1571 sprintf(time_buf
, "%lu %s", time
, tz_str
);
1576 minutes
= tz
< 0 ? -tz
: tz
;
1577 minutes
= (minutes
/ 100)*60 + (minutes
% 100);
1578 minutes
= tz
< 0 ? -minutes
: minutes
;
1579 t
= time
+ minutes
* 60;
1582 strftime(time_buf
, sizeof(time_buf
), "%Y-%m-%d %H:%M:%S ", tm
);
1583 strcat(time_buf
, tz_str
);
1587 #define OUTPUT_ANNOTATE_COMPAT 001
1588 #define OUTPUT_LONG_OBJECT_NAME 002
1589 #define OUTPUT_RAW_TIMESTAMP 004
1590 #define OUTPUT_PORCELAIN 010
1591 #define OUTPUT_SHOW_NAME 020
1592 #define OUTPUT_SHOW_NUMBER 040
1593 #define OUTPUT_SHOW_SCORE 0100
1594 #define OUTPUT_NO_AUTHOR 0200
1596 static void emit_porcelain(struct scoreboard
*sb
, struct blame_entry
*ent
)
1600 struct origin
*suspect
= ent
->suspect
;
1603 strcpy(hex
, sha1_to_hex(suspect
->commit
->object
.sha1
));
1604 printf("%s%c%d %d %d\n",
1606 ent
->guilty
? ' ' : '*', // purely for debugging
1610 if (!(suspect
->commit
->object
.flags
& METAINFO_SHOWN
)) {
1611 struct commit_info ci
;
1612 suspect
->commit
->object
.flags
|= METAINFO_SHOWN
;
1613 get_commit_info(suspect
->commit
, &ci
, 1);
1614 printf("author %s\n", ci
.author
);
1615 printf("author-mail %s\n", ci
.author_mail
);
1616 printf("author-time %lu\n", ci
.author_time
);
1617 printf("author-tz %s\n", ci
.author_tz
);
1618 printf("committer %s\n", ci
.committer
);
1619 printf("committer-mail %s\n", ci
.committer_mail
);
1620 printf("committer-time %lu\n", ci
.committer_time
);
1621 printf("committer-tz %s\n", ci
.committer_tz
);
1622 write_filename_info(suspect
->path
);
1623 printf("summary %s\n", ci
.summary
);
1624 if (suspect
->commit
->object
.flags
& UNINTERESTING
)
1625 printf("boundary\n");
1627 else if (suspect
->commit
->object
.flags
& MORE_THAN_ONE_PATH
)
1628 write_filename_info(suspect
->path
);
1630 cp
= nth_line(sb
, ent
->lno
);
1631 for (cnt
= 0; cnt
< ent
->num_lines
; cnt
++) {
1634 printf("%s %d %d\n", hex
,
1635 ent
->s_lno
+ 1 + cnt
,
1636 ent
->lno
+ 1 + cnt
);
1641 } while (ch
!= '\n' &&
1642 cp
< sb
->final_buf
+ sb
->final_buf_size
);
1646 static void emit_other(struct scoreboard
*sb
, struct blame_entry
*ent
, int opt
)
1650 struct origin
*suspect
= ent
->suspect
;
1651 struct commit_info ci
;
1653 int show_raw_time
= !!(opt
& OUTPUT_RAW_TIMESTAMP
);
1655 get_commit_info(suspect
->commit
, &ci
, 1);
1656 strcpy(hex
, sha1_to_hex(suspect
->commit
->object
.sha1
));
1658 cp
= nth_line(sb
, ent
->lno
);
1659 for (cnt
= 0; cnt
< ent
->num_lines
; cnt
++) {
1661 int length
= (opt
& OUTPUT_LONG_OBJECT_NAME
) ? 40 : 8;
1663 if (suspect
->commit
->object
.flags
& UNINTERESTING
) {
1665 memset(hex
, ' ', length
);
1666 else if (!cmd_is_annotate
) {
1672 printf("%.*s", length
, hex
);
1673 if (opt
& OUTPUT_ANNOTATE_COMPAT
)
1674 printf("\t(%10s\t%10s\t%d)", ci
.author
,
1675 format_time(ci
.author_time
, ci
.author_tz
,
1677 ent
->lno
+ 1 + cnt
);
1679 if (opt
& OUTPUT_SHOW_SCORE
)
1681 max_score_digits
, ent
->score
,
1682 ent
->suspect
->refcnt
);
1683 if (opt
& OUTPUT_SHOW_NAME
)
1684 printf(" %-*.*s", longest_file
, longest_file
,
1686 if (opt
& OUTPUT_SHOW_NUMBER
)
1687 printf(" %*d", max_orig_digits
,
1688 ent
->s_lno
+ 1 + cnt
);
1690 if (!(opt
& OUTPUT_NO_AUTHOR
))
1691 printf(" (%-*.*s %10s",
1692 longest_author
, longest_author
,
1694 format_time(ci
.author_time
,
1698 max_digits
, ent
->lno
+ 1 + cnt
);
1703 } while (ch
!= '\n' &&
1704 cp
< sb
->final_buf
+ sb
->final_buf_size
);
1708 static void output(struct scoreboard
*sb
, int option
)
1710 struct blame_entry
*ent
;
1712 if (option
& OUTPUT_PORCELAIN
) {
1713 for (ent
= sb
->ent
; ent
; ent
= ent
->next
) {
1714 struct blame_entry
*oth
;
1715 struct origin
*suspect
= ent
->suspect
;
1716 struct commit
*commit
= suspect
->commit
;
1717 if (commit
->object
.flags
& MORE_THAN_ONE_PATH
)
1719 for (oth
= ent
->next
; oth
; oth
= oth
->next
) {
1720 if ((oth
->suspect
->commit
!= commit
) ||
1721 !strcmp(oth
->suspect
->path
, suspect
->path
))
1723 commit
->object
.flags
|= MORE_THAN_ONE_PATH
;
1729 for (ent
= sb
->ent
; ent
; ent
= ent
->next
) {
1730 if (option
& OUTPUT_PORCELAIN
)
1731 emit_porcelain(sb
, ent
);
1733 emit_other(sb
, ent
, option
);
1739 * To allow quick access to the contents of nth line in the
1740 * final image, prepare an index in the scoreboard.
1742 static int prepare_lines(struct scoreboard
*sb
)
1744 const char *buf
= sb
->final_buf
;
1745 unsigned long len
= sb
->final_buf_size
;
1746 int num
= 0, incomplete
= 0, bol
= 1;
1748 if (len
&& buf
[len
-1] != '\n')
1749 incomplete
++; /* incomplete line at the end */
1752 sb
->lineno
= xrealloc(sb
->lineno
,
1753 sizeof(int* ) * (num
+ 1));
1754 sb
->lineno
[num
] = buf
- sb
->final_buf
;
1757 if (*buf
++ == '\n') {
1762 sb
->lineno
= xrealloc(sb
->lineno
,
1763 sizeof(int* ) * (num
+ incomplete
+ 1));
1764 sb
->lineno
[num
+ incomplete
] = buf
- sb
->final_buf
;
1765 sb
->num_lines
= num
+ incomplete
;
1766 return sb
->num_lines
;
1770 * Add phony grafts for use with -S; this is primarily to
1771 * support git-cvsserver that wants to give a linear history
1774 static int read_ancestry(const char *graft_file
)
1776 FILE *fp
= fopen(graft_file
, "r");
1780 while (fgets(buf
, sizeof(buf
), fp
)) {
1781 /* The format is just "Commit Parent1 Parent2 ...\n" */
1782 int len
= strlen(buf
);
1783 struct commit_graft
*graft
= read_graft_line(buf
, len
);
1785 register_commit_graft(graft
, 0);
1792 * How many columns do we need to show line numbers in decimal?
1794 static int lineno_width(int lines
)
1798 for (width
= 1, i
= 10; i
<= lines
+ 1; width
++)
1804 * How many columns do we need to show line numbers, authors,
1807 static void find_alignment(struct scoreboard
*sb
, int *option
)
1809 int longest_src_lines
= 0;
1810 int longest_dst_lines
= 0;
1811 unsigned largest_score
= 0;
1812 struct blame_entry
*e
;
1814 for (e
= sb
->ent
; e
; e
= e
->next
) {
1815 struct origin
*suspect
= e
->suspect
;
1816 struct commit_info ci
;
1819 if (strcmp(suspect
->path
, sb
->path
))
1820 *option
|= OUTPUT_SHOW_NAME
;
1821 num
= strlen(suspect
->path
);
1822 if (longest_file
< num
)
1824 if (!(suspect
->commit
->object
.flags
& METAINFO_SHOWN
)) {
1825 suspect
->commit
->object
.flags
|= METAINFO_SHOWN
;
1826 get_commit_info(suspect
->commit
, &ci
, 1);
1827 num
= strlen(ci
.author
);
1828 if (longest_author
< num
)
1829 longest_author
= num
;
1831 num
= e
->s_lno
+ e
->num_lines
;
1832 if (longest_src_lines
< num
)
1833 longest_src_lines
= num
;
1834 num
= e
->lno
+ e
->num_lines
;
1835 if (longest_dst_lines
< num
)
1836 longest_dst_lines
= num
;
1837 if (largest_score
< ent_score(sb
, e
))
1838 largest_score
= ent_score(sb
, e
);
1840 max_orig_digits
= lineno_width(longest_src_lines
);
1841 max_digits
= lineno_width(longest_dst_lines
);
1842 max_score_digits
= lineno_width(largest_score
);
1846 * For debugging -- origin is refcounted, and this asserts that
1847 * we do not underflow.
1849 static void sanity_check_refcnt(struct scoreboard
*sb
)
1852 struct blame_entry
*ent
;
1854 for (ent
= sb
->ent
; ent
; ent
= ent
->next
) {
1855 /* Nobody should have zero or negative refcnt */
1856 if (ent
->suspect
->refcnt
<= 0) {
1857 fprintf(stderr
, "%s in %s has negative refcnt %d\n",
1859 sha1_to_hex(ent
->suspect
->commit
->object
.sha1
),
1860 ent
->suspect
->refcnt
);
1864 for (ent
= sb
->ent
; ent
; ent
= ent
->next
) {
1865 /* Mark the ones that haven't been checked */
1866 if (0 < ent
->suspect
->refcnt
)
1867 ent
->suspect
->refcnt
= -ent
->suspect
->refcnt
;
1869 for (ent
= sb
->ent
; ent
; ent
= ent
->next
) {
1871 * ... then pick each and see if they have the the
1875 struct blame_entry
*e
;
1876 struct origin
*suspect
= ent
->suspect
;
1878 if (0 < suspect
->refcnt
)
1880 suspect
->refcnt
= -suspect
->refcnt
; /* Unmark */
1881 for (found
= 0, e
= sb
->ent
; e
; e
= e
->next
) {
1882 if (e
->suspect
!= suspect
)
1886 if (suspect
->refcnt
!= found
) {
1887 fprintf(stderr
, "%s in %s has refcnt %d, not %d\n",
1889 sha1_to_hex(ent
->suspect
->commit
->object
.sha1
),
1890 ent
->suspect
->refcnt
, found
);
1896 find_alignment(sb
, &opt
);
1898 die("Baa %d!", baa
);
1903 * Used for the command line parsing; check if the path exists
1904 * in the working tree.
1906 static int has_path_in_work_tree(const char *path
)
1909 return !lstat(path
, &st
);
1912 static unsigned parse_score(const char *arg
)
1915 unsigned long score
= strtoul(arg
, &end
, 10);
1921 static const char *add_prefix(const char *prefix
, const char *path
)
1923 return prefix_path(prefix
, prefix
? strlen(prefix
) : 0, path
);
1927 * Parsing of (comma separated) one item in the -L option
1929 static const char *parse_loc(const char *spec
,
1930 struct scoreboard
*sb
, long lno
,
1931 long begin
, long *ret
)
1938 regmatch_t match
[1];
1940 /* Allow "-L <something>,+20" to mean starting at <something>
1941 * for 20 lines, or "-L <something>,-5" for 5 lines ending at
1944 if (1 < begin
&& (spec
[0] == '+' || spec
[0] == '-')) {
1945 num
= strtol(spec
+ 1, &term
, 10);
1946 if (term
!= spec
+ 1) {
1950 *ret
= begin
+ num
- 2;
1959 num
= strtol(spec
, &term
, 10);
1967 /* it could be a regexp of form /.../ */
1968 for (term
= (char*) spec
+ 1; *term
&& *term
!= '/'; term
++) {
1975 /* try [spec+1 .. term-1] as regexp */
1977 begin
--; /* input is in human terms */
1978 line
= nth_line(sb
, begin
);
1980 if (!(reg_error
= regcomp(®exp
, spec
+ 1, REG_NEWLINE
)) &&
1981 !(reg_error
= regexec(®exp
, line
, 1, match
, 0))) {
1982 const char *cp
= line
+ match
[0].rm_so
;
1985 while (begin
++ < lno
) {
1986 nline
= nth_line(sb
, begin
);
1987 if (line
<= cp
&& cp
< nline
)
1998 regerror(reg_error
, ®exp
, errbuf
, 1024);
1999 die("-L parameter '%s': %s", spec
+ 1, errbuf
);
2004 * Parsing of -L option
2006 static void prepare_blame_range(struct scoreboard
*sb
,
2007 const char *bottomtop
,
2009 long *bottom
, long *top
)
2013 term
= parse_loc(bottomtop
, sb
, lno
, 1, bottom
);
2015 term
= parse_loc(term
+ 1, sb
, lno
, *bottom
+ 1, top
);
2023 static int git_blame_config(const char *var
, const char *value
, void *cb
)
2025 if (!strcmp(var
, "blame.showroot")) {
2026 show_root
= git_config_bool(var
, value
);
2029 if (!strcmp(var
, "blame.blankboundary")) {
2030 blank_boundary
= git_config_bool(var
, value
);
2033 return git_default_config(var
, value
, cb
);
2037 * Prepare a dummy commit that represents the work tree (or staged) item.
2038 * Note that annotating work tree item never works in the reverse.
2040 static struct commit
*fake_working_tree_commit(const char *path
, const char *contents_from
)
2042 struct commit
*commit
;
2043 struct origin
*origin
;
2044 unsigned char head_sha1
[20];
2049 struct cache_entry
*ce
;
2052 if (get_sha1("HEAD", head_sha1
))
2053 die("No such ref: HEAD");
2056 commit
= xcalloc(1, sizeof(*commit
));
2057 commit
->parents
= xcalloc(1, sizeof(*commit
->parents
));
2058 commit
->parents
->item
= lookup_commit_reference(head_sha1
);
2059 commit
->object
.parsed
= 1;
2061 commit
->object
.type
= OBJ_COMMIT
;
2063 origin
= make_origin(commit
, path
);
2065 strbuf_init(&buf
, 0);
2066 if (!contents_from
|| strcmp("-", contents_from
)) {
2068 const char *read_from
;
2069 unsigned long fin_size
;
2071 if (contents_from
) {
2072 if (stat(contents_from
, &st
) < 0)
2073 die("Cannot stat %s", contents_from
);
2074 read_from
= contents_from
;
2077 if (lstat(path
, &st
) < 0)
2078 die("Cannot lstat %s", path
);
2081 fin_size
= xsize_t(st
.st_size
);
2082 mode
= canon_mode(st
.st_mode
);
2083 switch (st
.st_mode
& S_IFMT
) {
2085 if (strbuf_read_file(&buf
, read_from
, st
.st_size
) != st
.st_size
)
2086 die("cannot open or read %s", read_from
);
2089 if (readlink(read_from
, buf
.buf
, buf
.alloc
) != fin_size
)
2090 die("cannot readlink %s", read_from
);
2094 die("unsupported file type %s", read_from
);
2098 /* Reading from stdin */
2099 contents_from
= "standard input";
2101 if (strbuf_read(&buf
, 0, 0) < 0)
2102 die("read error %s from stdin", strerror(errno
));
2104 convert_to_git(path
, buf
.buf
, buf
.len
, &buf
, 0);
2105 origin
->file
.ptr
= buf
.buf
;
2106 origin
->file
.size
= buf
.len
;
2107 pretend_sha1_file(buf
.buf
, buf
.len
, OBJ_BLOB
, origin
->blob_sha1
);
2108 commit
->util
= origin
;
2111 * Read the current index, replace the path entry with
2112 * origin->blob_sha1 without mucking with its mode or type
2113 * bits; we are not going to write this index out -- we just
2114 * want to run "diff-index --cached".
2121 int pos
= cache_name_pos(path
, len
);
2123 mode
= active_cache
[pos
]->ce_mode
;
2125 /* Let's not bother reading from HEAD tree */
2126 mode
= S_IFREG
| 0644;
2128 size
= cache_entry_size(len
);
2129 ce
= xcalloc(1, size
);
2130 hashcpy(ce
->sha1
, origin
->blob_sha1
);
2131 memcpy(ce
->name
, path
, len
);
2132 ce
->ce_flags
= create_ce_flags(len
, 0);
2133 ce
->ce_mode
= create_ce_mode(mode
);
2134 add_cache_entry(ce
, ADD_CACHE_OK_TO_ADD
|ADD_CACHE_OK_TO_REPLACE
);
2137 * We are not going to write this out, so this does not matter
2138 * right now, but someday we might optimize diff-index --cached
2139 * with cache-tree information.
2141 cache_tree_invalidate_path(active_cache_tree
, path
);
2143 commit
->buffer
= xmalloc(400);
2144 ident
= fmt_ident("Not Committed Yet", "not.committed.yet", NULL
, 0);
2145 snprintf(commit
->buffer
, 400,
2146 "tree 0000000000000000000000000000000000000000\n"
2150 "Version of %s from %s\n",
2151 sha1_to_hex(head_sha1
),
2152 ident
, ident
, path
, contents_from
? contents_from
: path
);
2156 static const char *prepare_final(struct scoreboard
*sb
)
2159 const char *final_commit_name
= NULL
;
2160 struct rev_info
*revs
= sb
->revs
;
2163 * There must be one and only one positive commit in the
2164 * revs->pending array.
2166 for (i
= 0; i
< revs
->pending
.nr
; i
++) {
2167 struct object
*obj
= revs
->pending
.objects
[i
].item
;
2168 if (obj
->flags
& UNINTERESTING
)
2170 while (obj
->type
== OBJ_TAG
)
2171 obj
= deref_tag(obj
, NULL
, 0);
2172 if (obj
->type
!= OBJ_COMMIT
)
2173 die("Non commit %s?", revs
->pending
.objects
[i
].name
);
2175 die("More than one commit to dig from %s and %s?",
2176 revs
->pending
.objects
[i
].name
,
2178 sb
->final
= (struct commit
*) obj
;
2179 final_commit_name
= revs
->pending
.objects
[i
].name
;
2181 return final_commit_name
;
2184 static const char *prepare_initial(struct scoreboard
*sb
)
2187 const char *final_commit_name
= NULL
;
2188 struct rev_info
*revs
= sb
->revs
;
2191 * There must be one and only one negative commit, and it must be
2194 for (i
= 0; i
< revs
->pending
.nr
; i
++) {
2195 struct object
*obj
= revs
->pending
.objects
[i
].item
;
2196 if (!(obj
->flags
& UNINTERESTING
))
2198 while (obj
->type
== OBJ_TAG
)
2199 obj
= deref_tag(obj
, NULL
, 0);
2200 if (obj
->type
!= OBJ_COMMIT
)
2201 die("Non commit %s?", revs
->pending
.objects
[i
].name
);
2203 die("More than one commit to dig down to %s and %s?",
2204 revs
->pending
.objects
[i
].name
,
2206 sb
->final
= (struct commit
*) obj
;
2207 final_commit_name
= revs
->pending
.objects
[i
].name
;
2209 if (!final_commit_name
)
2210 die("No commit to dig down to?");
2211 return final_commit_name
;
2214 static int blame_copy_callback(const struct option
*option
, const char *arg
, int unset
)
2216 int *opt
= option
->value
;
2219 * -C enables copy from removed files;
2220 * -C -C enables copy from existing files, but only
2221 * when blaming a new file;
2222 * -C -C -C enables copy from existing files for
2225 if (*opt
& PICKAXE_BLAME_COPY_HARDER
)
2226 *opt
|= PICKAXE_BLAME_COPY_HARDEST
;
2227 if (*opt
& PICKAXE_BLAME_COPY
)
2228 *opt
|= PICKAXE_BLAME_COPY_HARDER
;
2229 *opt
|= PICKAXE_BLAME_COPY
| PICKAXE_BLAME_MOVE
;
2232 blame_copy_score
= parse_score(arg
);
2236 static int blame_move_callback(const struct option
*option
, const char *arg
, int unset
)
2238 int *opt
= option
->value
;
2240 *opt
|= PICKAXE_BLAME_MOVE
;
2243 blame_move_score
= parse_score(arg
);
2247 static int blame_bottomtop_callback(const struct option
*option
, const char *arg
, int unset
)
2249 const char **bottomtop
= option
->value
;
2253 die("More than one '-L n,m' option given");
2258 int cmd_blame(int argc
, const char **argv
, const char *prefix
)
2260 struct rev_info revs
;
2262 struct scoreboard sb
;
2264 struct blame_entry
*ent
;
2265 long dashdash_pos
, bottom
, top
, lno
;
2266 const char *final_commit_name
= NULL
;
2267 enum object_type type
;
2269 static const char *bottomtop
= NULL
;
2270 static int output_option
= 0, opt
= 0;
2271 static int show_stats
= 0;
2272 static const char *revs_file
= NULL
;
2273 static const char *contents_from
= NULL
;
2274 static const struct option options
[] = {
2275 OPT_BOOLEAN(0, "incremental", &incremental
, "Show blame entries as we find them, incrementally"),
2276 OPT_BOOLEAN('b', NULL
, &blank_boundary
, "Show blank SHA-1 for boundary commits (Default: off)"),
2277 OPT_BOOLEAN(0, "root", &show_root
, "Do not treat root commits as boundaries (Default: off)"),
2278 OPT_BOOLEAN(0, "show-stats", &show_stats
, "Show work cost statistics"),
2279 OPT_BIT(0, "score-debug", &output_option
, "Show output score for blame entries", OUTPUT_SHOW_SCORE
),
2280 OPT_BIT('f', "show-name", &output_option
, "Show original filename (Default: auto)", OUTPUT_SHOW_NAME
),
2281 OPT_BIT('n', "show-number", &output_option
, "Show original linenumber (Default: off)", OUTPUT_SHOW_NUMBER
),
2282 OPT_BIT('p', "porcelain", &output_option
, "Show in a format designed for machine consumption", OUTPUT_PORCELAIN
),
2283 OPT_BIT('c', NULL
, &output_option
, "Use the same output mode as git-annotate (Default: off)", OUTPUT_ANNOTATE_COMPAT
),
2284 OPT_BIT('t', NULL
, &output_option
, "Show raw timestamp (Default: off)", OUTPUT_RAW_TIMESTAMP
),
2285 OPT_BIT('l', NULL
, &output_option
, "Show long commit SHA1 (Default: off)", OUTPUT_LONG_OBJECT_NAME
),
2286 OPT_BIT('s', NULL
, &output_option
, "Suppress author name and timestamp (Default: off)", OUTPUT_NO_AUTHOR
),
2287 OPT_BIT('w', NULL
, &xdl_opts
, "Ignore whitespace differences", XDF_IGNORE_WHITESPACE
),
2288 OPT_STRING('S', NULL
, &revs_file
, "file", "Use revisions from <file> instead of calling git-rev-list"),
2289 OPT_STRING(0, "contents", &contents_from
, "file", "Use <file>'s contents as the final image"),
2290 { OPTION_CALLBACK
, 'C', NULL
, &opt
, "score", "Find line copies within and across files", PARSE_OPT_OPTARG
, blame_copy_callback
},
2291 { OPTION_CALLBACK
, 'M', NULL
, &opt
, "score", "Find line movements within and across files", PARSE_OPT_OPTARG
, blame_move_callback
},
2292 OPT_CALLBACK('L', NULL
, &bottomtop
, "n,m", "Process only line range n,m, counting from 1", blame_bottomtop_callback
),
2296 struct parse_opt_ctx_t ctx
;
2298 cmd_is_annotate
= !strcmp(argv
[0], "annotate");
2300 git_config(git_blame_config
, NULL
);
2301 init_revisions(&revs
, NULL
);
2302 save_commit_buffer
= 0;
2305 parse_options_start(&ctx
, argc
, argv
, PARSE_OPT_KEEP_DASHDASH
|
2306 PARSE_OPT_KEEP_ARGV0
);
2308 switch (parse_options_step(&ctx
, options
, blame_opt_usage
)) {
2309 case PARSE_OPT_HELP
:
2311 case PARSE_OPT_DONE
:
2313 dashdash_pos
= ctx
.cpidx
;
2317 if (!strcmp(ctx
.argv
[0], "--reverse")) {
2318 ctx
.argv
[0] = "--children";
2321 parse_revision_opt(&revs
, &ctx
, options
, blame_opt_usage
);
2324 argc
= parse_options_end(&ctx
);
2326 if (!blame_move_score
)
2327 blame_move_score
= BLAME_DEFAULT_MOVE_SCORE
;
2328 if (!blame_copy_score
)
2329 blame_copy_score
= BLAME_DEFAULT_COPY_SCORE
;
2332 * We have collected options unknown to us in argv[1..unk]
2333 * which are to be passed to revision machinery if we are
2334 * going to do the "bottom" processing.
2336 * The remaining are:
2338 * (1) if dashdash_pos != 0, its either
2339 * "blame [revisions] -- <path>" or
2340 * "blame -- <path> <rev>"
2342 * (2) otherwise, its one of the two:
2343 * "blame [revisions] <path>"
2344 * "blame <path> <rev>"
2346 * Note that we must strip out <path> from the arguments: we do not
2347 * want the path pruning but we may want "bottom" processing.
2350 switch (argc
- dashdash_pos
- 1) {
2353 usage_with_options(blame_opt_usage
, options
);
2354 /* reorder for the new way: <rev> -- <path> */
2360 path
= add_prefix(prefix
, argv
[--argc
]);
2364 usage_with_options(blame_opt_usage
, options
);
2368 usage_with_options(blame_opt_usage
, options
);
2369 path
= add_prefix(prefix
, argv
[argc
- 1]);
2370 if (argc
== 3 && !has_path_in_work_tree(path
)) { /* (2b) */
2371 path
= add_prefix(prefix
, argv
[1]);
2374 argv
[argc
- 1] = "--";
2377 if (!has_path_in_work_tree(path
))
2378 die("cannot stat path %s: %s", path
, strerror(errno
));
2381 setup_revisions(argc
, argv
, &revs
, NULL
);
2382 memset(&sb
, 0, sizeof(sb
));
2386 final_commit_name
= prepare_final(&sb
);
2387 else if (contents_from
)
2388 die("--contents and --children do not blend well.");
2390 final_commit_name
= prepare_initial(&sb
);
2394 * "--not A B -- path" without anything positive;
2395 * do not default to HEAD, but use the working tree
2399 sb
.final
= fake_working_tree_commit(path
, contents_from
);
2400 add_pending_object(&revs
, &(sb
.final
->object
), ":");
2402 else if (contents_from
)
2403 die("Cannot use --contents with final commit object name");
2406 * If we have bottom, this will mark the ancestors of the
2407 * bottom commits we would reach while traversing as
2410 if (prepare_revision_walk(&revs
))
2411 die("revision walk setup failed");
2413 if (is_null_sha1(sb
.final
->object
.sha1
)) {
2416 buf
= xmalloc(o
->file
.size
+ 1);
2417 memcpy(buf
, o
->file
.ptr
, o
->file
.size
+ 1);
2419 sb
.final_buf_size
= o
->file
.size
;
2422 o
= get_origin(&sb
, sb
.final
, path
);
2423 if (fill_blob_sha1(o
))
2424 die("no such path %s in %s", path
, final_commit_name
);
2426 sb
.final_buf
= read_sha1_file(o
->blob_sha1
, &type
,
2427 &sb
.final_buf_size
);
2429 die("Cannot read blob %s for path %s",
2430 sha1_to_hex(o
->blob_sha1
),
2434 lno
= prepare_lines(&sb
);
2438 prepare_blame_range(&sb
, bottomtop
, lno
, &bottom
, &top
);
2439 if (bottom
&& top
&& top
< bottom
) {
2441 tmp
= top
; top
= bottom
; bottom
= tmp
;
2449 die("file %s has only %lu lines", path
, lno
);
2451 ent
= xcalloc(1, sizeof(*ent
));
2453 ent
->num_lines
= top
- bottom
;
2455 ent
->s_lno
= bottom
;
2460 if (revs_file
&& read_ancestry(revs_file
))
2461 die("reading graft file %s failed: %s",
2462 revs_file
, strerror(errno
));
2464 read_mailmap(&mailmap
, ".mailmap", NULL
);
2469 assign_blame(&sb
, opt
);
2476 if (!(output_option
& OUTPUT_PORCELAIN
))
2477 find_alignment(&sb
, &output_option
);
2479 output(&sb
, output_option
);
2480 free((void *)sb
.final_buf
);
2481 for (ent
= sb
.ent
; ent
; ) {
2482 struct blame_entry
*e
= ent
->next
;
2488 printf("num read blob: %d\n", num_read_blob
);
2489 printf("num get patch: %d\n", num_get_patch
);
2490 printf("num commits: %d\n", num_commits
);