4 * Copyright (c) 2006, 2014 by its authors
5 * See COPYING for licensing conditions
13 #include "tree-walk.h"
18 #include "xdiff-interface.h"
19 #include "cache-tree.h"
20 #include "string-list.h"
22 #include "mergesort.h"
23 #include "parse-options.h"
24 #include "prio-queue.h"
27 #include "line-range.h"
31 static char blame_usage
[] = N_("git blame [<options>] [<rev-opts>] [<rev>] [--] <file>");
33 static const char *blame_opt_usage
[] = {
36 N_("<rev-opts> are documented in git-rev-list(1)"),
40 static int longest_file
;
41 static int longest_author
;
42 static int max_orig_digits
;
43 static int max_digits
;
44 static int max_score_digits
;
47 static int blank_boundary
;
48 static int incremental
;
50 static int abbrev
= -1;
51 static int no_whole_file_rename
;
53 static enum date_mode blame_date_mode
= DATE_ISO8601
;
54 static size_t blame_date_width
;
56 static struct string_list mailmap
;
63 static int num_read_blob
;
64 static int num_get_patch
;
65 static int num_commits
;
67 #define PICKAXE_BLAME_MOVE 01
68 #define PICKAXE_BLAME_COPY 02
69 #define PICKAXE_BLAME_COPY_HARDER 04
70 #define PICKAXE_BLAME_COPY_HARDEST 010
73 * blame for a blame_entry with score lower than these thresholds
74 * is not passed to the parent using move/copy logic.
76 static unsigned blame_move_score
;
77 static unsigned blame_copy_score
;
78 #define BLAME_DEFAULT_MOVE_SCORE 20
79 #define BLAME_DEFAULT_COPY_SCORE 40
81 /* Remember to update object flag allocation in object.h */
82 #define METAINFO_SHOWN (1u<<12)
83 #define MORE_THAN_ONE_PATH (1u<<13)
86 * One blob in a commit that is being suspected
90 /* Record preceding blame record for this blob */
91 struct origin
*previous
;
92 /* origins are put in a list linked via `next' hanging off the
93 * corresponding commit's util field in order to make finding
94 * them fast. The presence in this chain does not count
95 * towards the origin's reference count. It is tempting to
96 * let it count as long as the commit is pending examination,
97 * but even under circumstances where the commit will be
98 * present multiple times in the priority queue of unexamined
99 * commits, processing the first instance will not leave any
100 * work requiring the origin data for the second instance. An
101 * interspersed commit changing that would have to be
102 * preexisting with a different ancestry and with the same
103 * commit date in order to wedge itself between two instances
104 * of the same commit in the priority queue _and_ produce
105 * blame entries relevant for it. While we don't want to let
106 * us get tripped up by this case, it certainly does not seem
107 * worth optimizing for.
110 struct commit
*commit
;
111 /* `suspects' contains blame entries that may be attributed to
112 * this origin's commit or to parent commits. When a commit
113 * is being processed, all suspects will be moved, either by
114 * assigning them to an origin in a different commit, or by
115 * shipping them to the scoreboard's ent list because they
116 * cannot be attributed to a different commit.
118 struct blame_entry
*suspects
;
120 unsigned char blob_sha1
[20];
122 /* guilty gets set when shipping any suspects to the final
123 * blame list instead of other commits
126 char path
[FLEX_ARRAY
];
129 static int diff_hunks(mmfile_t
*file_a
, mmfile_t
*file_b
, long ctxlen
,
130 xdl_emit_hunk_consume_func_t hunk_func
, void *cb_data
)
133 xdemitconf_t xecfg
= {0};
134 xdemitcb_t ecb
= {NULL
};
136 xpp
.flags
= xdl_opts
;
137 xecfg
.ctxlen
= ctxlen
;
138 xecfg
.hunk_func
= hunk_func
;
140 return xdi_diff(file_a
, file_b
, &xpp
, &xecfg
, &ecb
);
144 * Prepare diff_filespec and convert it using diff textconv API
145 * if the textconv driver exists.
146 * Return 1 if the conversion succeeds, 0 otherwise.
148 int textconv_object(const char *path
,
150 const unsigned char *sha1
,
153 unsigned long *buf_size
)
155 struct diff_filespec
*df
;
156 struct userdiff_driver
*textconv
;
158 df
= alloc_filespec(path
);
159 fill_filespec(df
, sha1
, sha1_valid
, mode
);
160 textconv
= get_textconv(df
);
166 *buf_size
= fill_textconv(textconv
, df
, buf
);
172 * Given an origin, prepare mmfile_t structure to be used by the
175 static void fill_origin_blob(struct diff_options
*opt
,
176 struct origin
*o
, mmfile_t
*file
)
179 enum object_type type
;
180 unsigned long file_size
;
183 if (DIFF_OPT_TST(opt
, ALLOW_TEXTCONV
) &&
184 textconv_object(o
->path
, o
->mode
, o
->blob_sha1
, 1, &file
->ptr
, &file_size
))
187 file
->ptr
= read_sha1_file(o
->blob_sha1
, &type
, &file_size
);
188 file
->size
= file_size
;
191 die("Cannot read blob %s for path %s",
192 sha1_to_hex(o
->blob_sha1
),
201 * Origin is refcounted and usually we keep the blob contents to be
204 static inline struct origin
*origin_incref(struct origin
*o
)
211 static void origin_decref(struct origin
*o
)
213 if (o
&& --o
->refcnt
<= 0) {
214 struct origin
*p
, *l
= NULL
;
216 origin_decref(o
->previous
);
218 /* Should be present exactly once in commit chain */
219 for (p
= o
->commit
->util
; p
; l
= p
, p
= p
->next
) {
224 o
->commit
->util
= p
->next
;
229 die("internal error in blame::origin_decref");
233 static void drop_origin_blob(struct origin
*o
)
242 * Each group of lines is described by a blame_entry; it can be split
243 * as we pass blame to the parents. They are arranged in linked lists
244 * kept as `suspects' of some unprocessed origin, or entered (when the
245 * blame origin has been finalized) into the scoreboard structure.
246 * While the scoreboard structure is only sorted at the end of
247 * processing (according to final image line number), the lists
248 * attached to an origin are sorted by the target line number.
251 struct blame_entry
*next
;
253 /* the first line of this group in the final image;
254 * internally all line numbers are 0 based.
258 /* how many lines this group has */
261 /* the commit that introduced this group into the final image */
262 struct origin
*suspect
;
264 /* the line number of the first line of this group in the
265 * suspect's file; internally all line numbers are 0 based.
269 /* how significant this entry is -- cached to avoid
270 * scanning the lines over and over.
276 * Any merge of blames happens on lists of blames that arrived via
277 * different parents in a single suspect. In this case, we want to
278 * sort according to the suspect line numbers as opposed to the final
279 * image line numbers. The function body is somewhat longish because
280 * it avoids unnecessary writes.
283 static struct blame_entry
*blame_merge(struct blame_entry
*list1
,
284 struct blame_entry
*list2
)
286 struct blame_entry
*p1
= list1
, *p2
= list2
,
294 if (p1
->s_lno
<= p2
->s_lno
) {
297 if ((p1
= *tail
) == NULL
) {
301 } while (p1
->s_lno
<= p2
->s_lno
);
307 if ((p2
= *tail
) == NULL
) {
311 } while (p1
->s_lno
> p2
->s_lno
);
315 if ((p1
= *tail
) == NULL
) {
319 } while (p1
->s_lno
<= p2
->s_lno
);
323 static void *get_next_blame(const void *p
)
325 return ((struct blame_entry
*)p
)->next
;
328 static void set_next_blame(void *p1
, void *p2
)
330 ((struct blame_entry
*)p1
)->next
= p2
;
334 * Final image line numbers are all different, so we don't need a
335 * three-way comparison here.
338 static int compare_blame_final(const void *p1
, const void *p2
)
340 return ((struct blame_entry
*)p1
)->lno
> ((struct blame_entry
*)p2
)->lno
344 static int compare_blame_suspect(const void *p1
, const void *p2
)
346 const struct blame_entry
*s1
= p1
, *s2
= p2
;
348 * to allow for collating suspects, we sort according to the
349 * respective pointer value as the primary sorting criterion.
350 * The actual relation is pretty unimportant as long as it
351 * establishes a total order. Comparing as integers gives us
354 if (s1
->suspect
!= s2
->suspect
)
355 return (intptr_t)s1
->suspect
> (intptr_t)s2
->suspect
? 1 : -1;
356 if (s1
->s_lno
== s2
->s_lno
)
358 return s1
->s_lno
> s2
->s_lno
? 1 : -1;
361 static struct blame_entry
*blame_sort(struct blame_entry
*head
,
362 int (*compare_fn
)(const void *, const void *))
364 return llist_mergesort (head
, get_next_blame
, set_next_blame
, compare_fn
);
367 static int compare_commits_by_reverse_commit_date(const void *a
,
371 return -compare_commits_by_commit_date(a
, b
, c
);
375 * The current state of the blame assignment.
378 /* the final commit (i.e. where we started digging from) */
379 struct commit
*final
;
380 /* Priority queue for commits with unassigned blame records */
381 struct prio_queue commits
;
382 struct rev_info
*revs
;
386 * The contents in the final image.
387 * Used by many functions to obtain contents of the nth line,
388 * indexed with scoreboard.lineno[blame_entry.lno].
390 const char *final_buf
;
391 unsigned long final_buf_size
;
393 /* linked list of blames */
394 struct blame_entry
*ent
;
396 /* look-up a line in the final buffer */
401 static void sanity_check_refcnt(struct scoreboard
*);
404 * If two blame entries that are next to each other came from
405 * contiguous lines in the same origin (i.e. <commit, path> pair),
406 * merge them together.
408 static void coalesce(struct scoreboard
*sb
)
410 struct blame_entry
*ent
, *next
;
412 for (ent
= sb
->ent
; ent
&& (next
= ent
->next
); ent
= next
) {
413 if (ent
->suspect
== next
->suspect
&&
414 ent
->s_lno
+ ent
->num_lines
== next
->s_lno
) {
415 ent
->num_lines
+= next
->num_lines
;
416 ent
->next
= next
->next
;
417 origin_decref(next
->suspect
);
420 next
= ent
; /* again */
424 if (DEBUG
) /* sanity */
425 sanity_check_refcnt(sb
);
429 * Merge the given sorted list of blames into a preexisting origin.
430 * If there were no previous blames to that commit, it is entered into
431 * the commit priority queue of the score board.
434 static void queue_blames(struct scoreboard
*sb
, struct origin
*porigin
,
435 struct blame_entry
*sorted
)
437 if (porigin
->suspects
)
438 porigin
->suspects
= blame_merge(porigin
->suspects
, sorted
);
441 for (o
= porigin
->commit
->util
; o
; o
= o
->next
) {
443 porigin
->suspects
= sorted
;
447 porigin
->suspects
= sorted
;
448 prio_queue_put(&sb
->commits
, porigin
->commit
);
453 * Given a commit and a path in it, create a new origin structure.
454 * The callers that add blame to the scoreboard should use
455 * get_origin() to obtain shared, refcounted copy instead of calling
456 * this function directly.
458 static struct origin
*make_origin(struct commit
*commit
, const char *path
)
461 o
= xcalloc(1, sizeof(*o
) + strlen(path
) + 1);
464 o
->next
= commit
->util
;
466 strcpy(o
->path
, path
);
471 * Locate an existing origin or create a new one.
472 * This moves the origin to front position in the commit util list.
474 static struct origin
*get_origin(struct scoreboard
*sb
,
475 struct commit
*commit
,
478 struct origin
*o
, *l
;
480 for (o
= commit
->util
, l
= NULL
; o
; l
= o
, o
= o
->next
) {
481 if (!strcmp(o
->path
, path
)) {
485 o
->next
= commit
->util
;
488 return origin_incref(o
);
491 return make_origin(commit
, path
);
495 * Fill the blob_sha1 field of an origin if it hasn't, so that later
496 * call to fill_origin_blob() can use it to locate the data. blob_sha1
497 * for an origin is also used to pass the blame for the entire file to
498 * the parent to detect the case where a child's blob is identical to
499 * that of its parent's.
501 * This also fills origin->mode for corresponding tree path.
503 static int fill_blob_sha1_and_mode(struct origin
*origin
)
505 if (!is_null_sha1(origin
->blob_sha1
))
507 if (get_tree_entry(origin
->commit
->object
.sha1
,
509 origin
->blob_sha1
, &origin
->mode
))
511 if (sha1_object_info(origin
->blob_sha1
, NULL
) != OBJ_BLOB
)
515 hashclr(origin
->blob_sha1
);
516 origin
->mode
= S_IFINVALID
;
521 * We have an origin -- check if the same path exists in the
522 * parent and return an origin structure to represent it.
524 static struct origin
*find_origin(struct scoreboard
*sb
,
525 struct commit
*parent
,
526 struct origin
*origin
)
528 struct origin
*porigin
;
529 struct diff_options diff_opts
;
530 const char *paths
[2];
532 /* First check any existing origins */
533 for (porigin
= parent
->util
; porigin
; porigin
= porigin
->next
)
534 if (!strcmp(porigin
->path
, origin
->path
)) {
536 * The same path between origin and its parent
537 * without renaming -- the most common case.
539 return origin_incref (porigin
);
542 /* See if the origin->path is different between parent
543 * and origin first. Most of the time they are the
544 * same and diff-tree is fairly efficient about this.
546 diff_setup(&diff_opts
);
547 DIFF_OPT_SET(&diff_opts
, RECURSIVE
);
548 diff_opts
.detect_rename
= 0;
549 diff_opts
.output_format
= DIFF_FORMAT_NO_OUTPUT
;
550 paths
[0] = origin
->path
;
553 parse_pathspec(&diff_opts
.pathspec
,
554 PATHSPEC_ALL_MAGIC
& ~PATHSPEC_LITERAL
,
555 PATHSPEC_LITERAL_PATH
, "", paths
);
556 diff_setup_done(&diff_opts
);
558 if (is_null_sha1(origin
->commit
->object
.sha1
))
559 do_diff_cache(parent
->tree
->object
.sha1
, &diff_opts
);
561 diff_tree_sha1(parent
->tree
->object
.sha1
,
562 origin
->commit
->tree
->object
.sha1
,
564 diffcore_std(&diff_opts
);
566 if (!diff_queued_diff
.nr
) {
567 /* The path is the same as parent */
568 porigin
= get_origin(sb
, parent
, origin
->path
);
569 hashcpy(porigin
->blob_sha1
, origin
->blob_sha1
);
570 porigin
->mode
= origin
->mode
;
573 * Since origin->path is a pathspec, if the parent
574 * commit had it as a directory, we will see a whole
575 * bunch of deletion of files in the directory that we
579 struct diff_filepair
*p
= NULL
;
580 for (i
= 0; i
< diff_queued_diff
.nr
; i
++) {
582 p
= diff_queued_diff
.queue
[i
];
583 name
= p
->one
->path
? p
->one
->path
: p
->two
->path
;
584 if (!strcmp(name
, origin
->path
))
588 die("internal error in blame::find_origin");
591 die("internal error in blame::find_origin (%c)",
594 porigin
= get_origin(sb
, parent
, origin
->path
);
595 hashcpy(porigin
->blob_sha1
, p
->one
->sha1
);
596 porigin
->mode
= p
->one
->mode
;
600 /* Did not exist in parent, or type changed */
604 diff_flush(&diff_opts
);
605 free_pathspec(&diff_opts
.pathspec
);
610 * We have an origin -- find the path that corresponds to it in its
611 * parent and return an origin structure to represent it.
613 static struct origin
*find_rename(struct scoreboard
*sb
,
614 struct commit
*parent
,
615 struct origin
*origin
)
617 struct origin
*porigin
= NULL
;
618 struct diff_options diff_opts
;
621 diff_setup(&diff_opts
);
622 DIFF_OPT_SET(&diff_opts
, RECURSIVE
);
623 diff_opts
.detect_rename
= DIFF_DETECT_RENAME
;
624 diff_opts
.output_format
= DIFF_FORMAT_NO_OUTPUT
;
625 diff_opts
.single_follow
= origin
->path
;
626 diff_setup_done(&diff_opts
);
628 if (is_null_sha1(origin
->commit
->object
.sha1
))
629 do_diff_cache(parent
->tree
->object
.sha1
, &diff_opts
);
631 diff_tree_sha1(parent
->tree
->object
.sha1
,
632 origin
->commit
->tree
->object
.sha1
,
634 diffcore_std(&diff_opts
);
636 for (i
= 0; i
< diff_queued_diff
.nr
; i
++) {
637 struct diff_filepair
*p
= diff_queued_diff
.queue
[i
];
638 if ((p
->status
== 'R' || p
->status
== 'C') &&
639 !strcmp(p
->two
->path
, origin
->path
)) {
640 porigin
= get_origin(sb
, parent
, p
->one
->path
);
641 hashcpy(porigin
->blob_sha1
, p
->one
->sha1
);
642 porigin
->mode
= p
->one
->mode
;
646 diff_flush(&diff_opts
);
647 free_pathspec(&diff_opts
.pathspec
);
652 * Append a new blame entry to a given output queue.
654 static void add_blame_entry(struct blame_entry
***queue
, struct blame_entry
*e
)
656 origin_incref(e
->suspect
);
664 * src typically is on-stack; we want to copy the information in it to
665 * a malloced blame_entry that gets added to the given queue. The
666 * origin of dst loses a refcnt.
668 static void dup_entry(struct blame_entry
***queue
,
669 struct blame_entry
*dst
, struct blame_entry
*src
)
671 origin_incref(src
->suspect
);
672 origin_decref(dst
->suspect
);
673 memcpy(dst
, src
, sizeof(*src
));
679 static const char *nth_line(struct scoreboard
*sb
, long lno
)
681 return sb
->final_buf
+ sb
->lineno
[lno
];
684 static const char *nth_line_cb(void *data
, long lno
)
686 return nth_line((struct scoreboard
*)data
, lno
);
690 * It is known that lines between tlno to same came from parent, and e
691 * has an overlap with that range. it also is known that parent's
692 * line plno corresponds to e's line tlno.
698 * <------------------>
700 * Split e into potentially three parts; before this chunk, the chunk
701 * to be blamed for the parent, and after that portion.
703 static void split_overlap(struct blame_entry
*split
,
704 struct blame_entry
*e
,
705 int tlno
, int plno
, int same
,
706 struct origin
*parent
)
709 memset(split
, 0, sizeof(struct blame_entry
[3]));
711 if (e
->s_lno
< tlno
) {
712 /* there is a pre-chunk part not blamed on parent */
713 split
[0].suspect
= origin_incref(e
->suspect
);
714 split
[0].lno
= e
->lno
;
715 split
[0].s_lno
= e
->s_lno
;
716 split
[0].num_lines
= tlno
- e
->s_lno
;
717 split
[1].lno
= e
->lno
+ tlno
- e
->s_lno
;
718 split
[1].s_lno
= plno
;
721 split
[1].lno
= e
->lno
;
722 split
[1].s_lno
= plno
+ (e
->s_lno
- tlno
);
725 if (same
< e
->s_lno
+ e
->num_lines
) {
726 /* there is a post-chunk part not blamed on parent */
727 split
[2].suspect
= origin_incref(e
->suspect
);
728 split
[2].lno
= e
->lno
+ (same
- e
->s_lno
);
729 split
[2].s_lno
= e
->s_lno
+ (same
- e
->s_lno
);
730 split
[2].num_lines
= e
->s_lno
+ e
->num_lines
- same
;
731 chunk_end_lno
= split
[2].lno
;
734 chunk_end_lno
= e
->lno
+ e
->num_lines
;
735 split
[1].num_lines
= chunk_end_lno
- split
[1].lno
;
738 * if it turns out there is nothing to blame the parent for,
739 * forget about the splitting. !split[1].suspect signals this.
741 if (split
[1].num_lines
< 1)
743 split
[1].suspect
= origin_incref(parent
);
747 * split_overlap() divided an existing blame e into up to three parts
748 * in split. Any assigned blame is moved to queue to
751 static void split_blame(struct blame_entry
***blamed
,
752 struct blame_entry
***unblamed
,
753 struct blame_entry
*split
,
754 struct blame_entry
*e
)
756 struct blame_entry
*new_entry
;
758 if (split
[0].suspect
&& split
[2].suspect
) {
759 /* The first part (reuse storage for the existing entry e) */
760 dup_entry(unblamed
, e
, &split
[0]);
762 /* The last part -- me */
763 new_entry
= xmalloc(sizeof(*new_entry
));
764 memcpy(new_entry
, &(split
[2]), sizeof(struct blame_entry
));
765 add_blame_entry(unblamed
, new_entry
);
767 /* ... and the middle part -- parent */
768 new_entry
= xmalloc(sizeof(*new_entry
));
769 memcpy(new_entry
, &(split
[1]), sizeof(struct blame_entry
));
770 add_blame_entry(blamed
, new_entry
);
772 else if (!split
[0].suspect
&& !split
[2].suspect
)
774 * The parent covers the entire area; reuse storage for
775 * e and replace it with the parent.
777 dup_entry(blamed
, e
, &split
[1]);
778 else if (split
[0].suspect
) {
779 /* me and then parent */
780 dup_entry(unblamed
, e
, &split
[0]);
782 new_entry
= xmalloc(sizeof(*new_entry
));
783 memcpy(new_entry
, &(split
[1]), sizeof(struct blame_entry
));
784 add_blame_entry(blamed
, new_entry
);
787 /* parent and then me */
788 dup_entry(blamed
, e
, &split
[1]);
790 new_entry
= xmalloc(sizeof(*new_entry
));
791 memcpy(new_entry
, &(split
[2]), sizeof(struct blame_entry
));
792 add_blame_entry(unblamed
, new_entry
);
797 * After splitting the blame, the origins used by the
798 * on-stack blame_entry should lose one refcnt each.
800 static void decref_split(struct blame_entry
*split
)
804 for (i
= 0; i
< 3; i
++)
805 origin_decref(split
[i
].suspect
);
809 * reverse_blame reverses the list given in head, appending tail.
810 * That allows us to build lists in reverse order, then reverse them
811 * afterwards. This can be faster than building the list in proper
812 * order right away. The reason is that building in proper order
813 * requires writing a link in the _previous_ element, while building
814 * in reverse order just requires placing the list head into the
818 static struct blame_entry
*reverse_blame(struct blame_entry
*head
,
819 struct blame_entry
*tail
)
822 struct blame_entry
*next
= head
->next
;
831 * Process one hunk from the patch between the current suspect for
832 * blame_entry e and its parent. This first blames any unfinished
833 * entries before the chunk (which is where target and parent start
834 * differing) on the parent, and then splits blame entries at the
835 * start and at the end of the difference region. Since use of -M and
836 * -C options may lead to overlapping/duplicate source line number
837 * ranges, all we can rely on from sorting/merging is the order of the
838 * first suspect line number.
840 static void blame_chunk(struct blame_entry
***dstq
, struct blame_entry
***srcq
,
841 int tlno
, int offset
, int same
,
842 struct origin
*parent
)
844 struct blame_entry
*e
= **srcq
;
845 struct blame_entry
*samep
= NULL
, *diffp
= NULL
;
847 while (e
&& e
->s_lno
< tlno
) {
848 struct blame_entry
*next
= e
->next
;
850 * current record starts before differing portion. If
851 * it reaches into it, we need to split it up and
852 * examine the second part separately.
854 if (e
->s_lno
+ e
->num_lines
> tlno
) {
855 /* Move second half to a new record */
856 int len
= tlno
- e
->s_lno
;
857 struct blame_entry
*n
= xcalloc(1, sizeof (struct blame_entry
));
858 n
->suspect
= e
->suspect
;
859 n
->lno
= e
->lno
+ len
;
860 n
->s_lno
= e
->s_lno
+ len
;
861 n
->num_lines
= e
->num_lines
- len
;
864 /* Push new record to diffp */
868 origin_decref(e
->suspect
);
869 /* Pass blame for everything before the differing
870 * chunk to the parent */
871 e
->suspect
= origin_incref(parent
);
878 * As we don't know how much of a common stretch after this
879 * diff will occur, the currently blamed parts are all that we
880 * can assign to the parent for now.
884 **dstq
= reverse_blame(samep
, **dstq
);
885 *dstq
= &samep
->next
;
888 * Prepend the split off portions: everything after e starts
889 * after the blameable portion.
891 e
= reverse_blame(diffp
, e
);
894 * Now retain records on the target while parts are different
899 while (e
&& e
->s_lno
< same
) {
900 struct blame_entry
*next
= e
->next
;
903 * If current record extends into sameness, need to split.
905 if (e
->s_lno
+ e
->num_lines
> same
) {
907 * Move second half to a new record to be
908 * processed by later chunks
910 int len
= same
- e
->s_lno
;
911 struct blame_entry
*n
= xcalloc(1, sizeof (struct blame_entry
));
912 n
->suspect
= origin_incref(e
->suspect
);
913 n
->lno
= e
->lno
+ len
;
914 n
->s_lno
= e
->s_lno
+ len
;
915 n
->num_lines
= e
->num_lines
- len
;
918 /* Push new record to samep */
926 **srcq
= reverse_blame(diffp
, reverse_blame(samep
, e
));
927 /* Move across elements that are in the unblamable portion */
929 *srcq
= &diffp
->next
;
932 struct blame_chunk_cb_data
{
933 struct origin
*parent
;
935 struct blame_entry
**dstq
;
936 struct blame_entry
**srcq
;
939 /* diff chunks are from parent to target */
940 static int blame_chunk_cb(long start_a
, long count_a
,
941 long start_b
, long count_b
, void *data
)
943 struct blame_chunk_cb_data
*d
= data
;
944 if (start_a
- start_b
!= d
->offset
)
945 die("internal error in blame::blame_chunk_cb");
946 blame_chunk(&d
->dstq
, &d
->srcq
, start_b
, start_a
- start_b
,
947 start_b
+ count_b
, d
->parent
);
948 d
->offset
= start_a
+ count_a
- (start_b
+ count_b
);
953 * We are looking at the origin 'target' and aiming to pass blame
954 * for the lines it is suspected to its parent. Run diff to find
955 * which lines came from parent and pass blame for them.
957 static void pass_blame_to_parent(struct scoreboard
*sb
,
958 struct origin
*target
,
959 struct origin
*parent
)
961 mmfile_t file_p
, file_o
;
962 struct blame_chunk_cb_data d
;
963 struct blame_entry
*newdest
= NULL
;
965 if (!target
->suspects
)
966 return; /* nothing remains for this target */
970 d
.dstq
= &newdest
; d
.srcq
= &target
->suspects
;
972 fill_origin_blob(&sb
->revs
->diffopt
, parent
, &file_p
);
973 fill_origin_blob(&sb
->revs
->diffopt
, target
, &file_o
);
976 if (diff_hunks(&file_p
, &file_o
, 0, blame_chunk_cb
, &d
))
977 die("unable to generate diff (%s -> %s)",
978 sha1_to_hex(parent
->commit
->object
.sha1
),
979 sha1_to_hex(target
->commit
->object
.sha1
));
980 /* The rest are the same as the parent */
981 blame_chunk(&d
.dstq
, &d
.srcq
, INT_MAX
, d
.offset
, INT_MAX
, parent
);
983 queue_blames(sb
, parent
, newdest
);
989 * The lines in blame_entry after splitting blames many times can become
990 * very small and trivial, and at some point it becomes pointless to
991 * blame the parents. E.g. "\t\t}\n\t}\n\n" appears everywhere in any
992 * ordinary C program, and it is not worth to say it was copied from
993 * totally unrelated file in the parent.
995 * Compute how trivial the lines in the blame_entry are.
997 static unsigned ent_score(struct scoreboard
*sb
, struct blame_entry
*e
)
1000 const char *cp
, *ep
;
1006 cp
= nth_line(sb
, e
->lno
);
1007 ep
= nth_line(sb
, e
->lno
+ e
->num_lines
);
1009 unsigned ch
= *((unsigned char *)cp
);
1019 * best_so_far[] and this[] are both a split of an existing blame_entry
1020 * that passes blame to the parent. Maintain best_so_far the best split
1021 * so far, by comparing this and best_so_far and copying this into
1022 * bst_so_far as needed.
1024 static void copy_split_if_better(struct scoreboard
*sb
,
1025 struct blame_entry
*best_so_far
,
1026 struct blame_entry
*this)
1030 if (!this[1].suspect
)
1032 if (best_so_far
[1].suspect
) {
1033 if (ent_score(sb
, &this[1]) < ent_score(sb
, &best_so_far
[1]))
1037 for (i
= 0; i
< 3; i
++)
1038 origin_incref(this[i
].suspect
);
1039 decref_split(best_so_far
);
1040 memcpy(best_so_far
, this, sizeof(struct blame_entry
[3]));
1044 * We are looking at a part of the final image represented by
1045 * ent (tlno and same are offset by ent->s_lno).
1046 * tlno is where we are looking at in the final image.
1047 * up to (but not including) same match preimage.
1048 * plno is where we are looking at in the preimage.
1050 * <-------------- final image ---------------------->
1053 * <---------preimage----->
1056 * All line numbers are 0-based.
1058 static void handle_split(struct scoreboard
*sb
,
1059 struct blame_entry
*ent
,
1060 int tlno
, int plno
, int same
,
1061 struct origin
*parent
,
1062 struct blame_entry
*split
)
1064 if (ent
->num_lines
<= tlno
)
1067 struct blame_entry
this[3];
1070 split_overlap(this, ent
, tlno
, plno
, same
, parent
);
1071 copy_split_if_better(sb
, split
, this);
1076 struct handle_split_cb_data
{
1077 struct scoreboard
*sb
;
1078 struct blame_entry
*ent
;
1079 struct origin
*parent
;
1080 struct blame_entry
*split
;
1085 static int handle_split_cb(long start_a
, long count_a
,
1086 long start_b
, long count_b
, void *data
)
1088 struct handle_split_cb_data
*d
= data
;
1089 handle_split(d
->sb
, d
->ent
, d
->tlno
, d
->plno
, start_b
, d
->parent
,
1091 d
->plno
= start_a
+ count_a
;
1092 d
->tlno
= start_b
+ count_b
;
1097 * Find the lines from parent that are the same as ent so that
1098 * we can pass blames to it. file_p has the blob contents for
1101 static void find_copy_in_blob(struct scoreboard
*sb
,
1102 struct blame_entry
*ent
,
1103 struct origin
*parent
,
1104 struct blame_entry
*split
,
1109 struct handle_split_cb_data d
;
1111 memset(&d
, 0, sizeof(d
));
1112 d
.sb
= sb
; d
.ent
= ent
; d
.parent
= parent
; d
.split
= split
;
1114 * Prepare mmfile that contains only the lines in ent.
1116 cp
= nth_line(sb
, ent
->lno
);
1117 file_o
.ptr
= (char *) cp
;
1118 file_o
.size
= nth_line(sb
, ent
->lno
+ ent
->num_lines
) - cp
;
1121 * file_o is a part of final image we are annotating.
1122 * file_p partially may match that image.
1124 memset(split
, 0, sizeof(struct blame_entry
[3]));
1125 if (diff_hunks(file_p
, &file_o
, 1, handle_split_cb
, &d
))
1126 die("unable to generate diff (%s)",
1127 sha1_to_hex(parent
->commit
->object
.sha1
));
1128 /* remainder, if any, all match the preimage */
1129 handle_split(sb
, ent
, d
.tlno
, d
.plno
, ent
->num_lines
, parent
, split
);
1132 /* Move all blame entries from list *source that have a score smaller
1133 * than score_min to the front of list *small.
1134 * Returns a pointer to the link pointing to the old head of the small list.
1137 static struct blame_entry
**filter_small(struct scoreboard
*sb
,
1138 struct blame_entry
**small
,
1139 struct blame_entry
**source
,
1142 struct blame_entry
*p
= *source
;
1143 struct blame_entry
*oldsmall
= *small
;
1145 if (ent_score(sb
, p
) <= score_min
) {
1161 * See if lines currently target is suspected for can be attributed to
1164 static void find_move_in_parent(struct scoreboard
*sb
,
1165 struct blame_entry
***blamed
,
1166 struct blame_entry
**toosmall
,
1167 struct origin
*target
,
1168 struct origin
*parent
)
1170 struct blame_entry
*e
, split
[3];
1171 struct blame_entry
*unblamed
= target
->suspects
;
1172 struct blame_entry
*leftover
= NULL
;
1176 return; /* nothing remains for this target */
1178 fill_origin_blob(&sb
->revs
->diffopt
, parent
, &file_p
);
1182 /* At each iteration, unblamed has a NULL-terminated list of
1183 * entries that have not yet been tested for blame. leftover
1184 * contains the reversed list of entries that have been tested
1185 * without being assignable to the parent.
1188 struct blame_entry
**unblamedtail
= &unblamed
;
1189 struct blame_entry
*next
;
1190 for (e
= unblamed
; e
; e
= next
) {
1192 find_copy_in_blob(sb
, e
, parent
, split
, &file_p
);
1193 if (split
[1].suspect
&&
1194 blame_move_score
< ent_score(sb
, &split
[1])) {
1195 split_blame(blamed
, &unblamedtail
, split
, e
);
1200 decref_split(split
);
1202 *unblamedtail
= NULL
;
1203 toosmall
= filter_small(sb
, toosmall
, &unblamed
, blame_move_score
);
1205 target
->suspects
= reverse_blame(leftover
, NULL
);
1209 struct blame_entry
*ent
;
1210 struct blame_entry split
[3];
1214 * Count the number of entries the target is suspected for,
1215 * and prepare a list of entry and the best split.
1217 static struct blame_list
*setup_blame_list(struct blame_entry
*unblamed
,
1220 struct blame_entry
*e
;
1222 struct blame_list
*blame_list
= NULL
;
1224 for (e
= unblamed
, num_ents
= 0; e
; e
= e
->next
)
1227 blame_list
= xcalloc(num_ents
, sizeof(struct blame_list
));
1228 for (e
= unblamed
, i
= 0; e
; e
= e
->next
)
1229 blame_list
[i
++].ent
= e
;
1231 *num_ents_p
= num_ents
;
1236 * For lines target is suspected for, see if we can find code movement
1237 * across file boundary from the parent commit. porigin is the path
1238 * in the parent we already tried.
1240 static void find_copy_in_parent(struct scoreboard
*sb
,
1241 struct blame_entry
***blamed
,
1242 struct blame_entry
**toosmall
,
1243 struct origin
*target
,
1244 struct commit
*parent
,
1245 struct origin
*porigin
,
1248 struct diff_options diff_opts
;
1250 struct blame_list
*blame_list
;
1252 struct blame_entry
*unblamed
= target
->suspects
;
1253 struct blame_entry
*leftover
= NULL
;
1256 return; /* nothing remains for this target */
1258 diff_setup(&diff_opts
);
1259 DIFF_OPT_SET(&diff_opts
, RECURSIVE
);
1260 diff_opts
.output_format
= DIFF_FORMAT_NO_OUTPUT
;
1262 diff_setup_done(&diff_opts
);
1264 /* Try "find copies harder" on new path if requested;
1265 * we do not want to use diffcore_rename() actually to
1266 * match things up; find_copies_harder is set only to
1267 * force diff_tree_sha1() to feed all filepairs to diff_queue,
1268 * and this code needs to be after diff_setup_done(), which
1269 * usually makes find-copies-harder imply copy detection.
1271 if ((opt
& PICKAXE_BLAME_COPY_HARDEST
)
1272 || ((opt
& PICKAXE_BLAME_COPY_HARDER
)
1273 && (!porigin
|| strcmp(target
->path
, porigin
->path
))))
1274 DIFF_OPT_SET(&diff_opts
, FIND_COPIES_HARDER
);
1276 if (is_null_sha1(target
->commit
->object
.sha1
))
1277 do_diff_cache(parent
->tree
->object
.sha1
, &diff_opts
);
1279 diff_tree_sha1(parent
->tree
->object
.sha1
,
1280 target
->commit
->tree
->object
.sha1
,
1283 if (!DIFF_OPT_TST(&diff_opts
, FIND_COPIES_HARDER
))
1284 diffcore_std(&diff_opts
);
1287 struct blame_entry
**unblamedtail
= &unblamed
;
1288 blame_list
= setup_blame_list(unblamed
, &num_ents
);
1290 for (i
= 0; i
< diff_queued_diff
.nr
; i
++) {
1291 struct diff_filepair
*p
= diff_queued_diff
.queue
[i
];
1292 struct origin
*norigin
;
1294 struct blame_entry
this[3];
1296 if (!DIFF_FILE_VALID(p
->one
))
1297 continue; /* does not exist in parent */
1298 if (S_ISGITLINK(p
->one
->mode
))
1299 continue; /* ignore git links */
1300 if (porigin
&& !strcmp(p
->one
->path
, porigin
->path
))
1301 /* find_move already dealt with this path */
1304 norigin
= get_origin(sb
, parent
, p
->one
->path
);
1305 hashcpy(norigin
->blob_sha1
, p
->one
->sha1
);
1306 norigin
->mode
= p
->one
->mode
;
1307 fill_origin_blob(&sb
->revs
->diffopt
, norigin
, &file_p
);
1311 for (j
= 0; j
< num_ents
; j
++) {
1312 find_copy_in_blob(sb
, blame_list
[j
].ent
,
1313 norigin
, this, &file_p
);
1314 copy_split_if_better(sb
, blame_list
[j
].split
,
1318 origin_decref(norigin
);
1321 for (j
= 0; j
< num_ents
; j
++) {
1322 struct blame_entry
*split
= blame_list
[j
].split
;
1323 if (split
[1].suspect
&&
1324 blame_copy_score
< ent_score(sb
, &split
[1])) {
1325 split_blame(blamed
, &unblamedtail
, split
,
1328 blame_list
[j
].ent
->next
= leftover
;
1329 leftover
= blame_list
[j
].ent
;
1331 decref_split(split
);
1334 *unblamedtail
= NULL
;
1335 toosmall
= filter_small(sb
, toosmall
, &unblamed
, blame_copy_score
);
1337 target
->suspects
= reverse_blame(leftover
, NULL
);
1338 diff_flush(&diff_opts
);
1339 free_pathspec(&diff_opts
.pathspec
);
1343 * The blobs of origin and porigin exactly match, so everything
1344 * origin is suspected for can be blamed on the parent.
1346 static void pass_whole_blame(struct scoreboard
*sb
,
1347 struct origin
*origin
, struct origin
*porigin
)
1349 struct blame_entry
*e
, *suspects
;
1351 if (!porigin
->file
.ptr
&& origin
->file
.ptr
) {
1352 /* Steal its file */
1353 porigin
->file
= origin
->file
;
1354 origin
->file
.ptr
= NULL
;
1356 suspects
= origin
->suspects
;
1357 origin
->suspects
= NULL
;
1358 for (e
= suspects
; e
; e
= e
->next
) {
1359 origin_incref(porigin
);
1360 origin_decref(e
->suspect
);
1361 e
->suspect
= porigin
;
1363 queue_blames(sb
, porigin
, suspects
);
1367 * We pass blame from the current commit to its parents. We keep saying
1368 * "parent" (and "porigin"), but what we mean is to find scapegoat to
1369 * exonerate ourselves.
1371 static struct commit_list
*first_scapegoat(struct rev_info
*revs
, struct commit
*commit
)
1374 return commit
->parents
;
1375 return lookup_decoration(&revs
->children
, &commit
->object
);
1378 static int num_scapegoats(struct rev_info
*revs
, struct commit
*commit
)
1380 struct commit_list
*l
= first_scapegoat(revs
, commit
);
1381 return commit_list_count(l
);
1384 /* Distribute collected unsorted blames to the respected sorted lists
1385 * in the various origins.
1387 static void distribute_blame(struct scoreboard
*sb
, struct blame_entry
*blamed
)
1389 blamed
= blame_sort(blamed
, compare_blame_suspect
);
1392 struct origin
*porigin
= blamed
->suspect
;
1393 struct blame_entry
*suspects
= NULL
;
1395 struct blame_entry
*next
= blamed
->next
;
1396 blamed
->next
= suspects
;
1399 } while (blamed
&& blamed
->suspect
== porigin
);
1400 suspects
= reverse_blame(suspects
, NULL
);
1401 queue_blames(sb
, porigin
, suspects
);
1407 static void pass_blame(struct scoreboard
*sb
, struct origin
*origin
, int opt
)
1409 struct rev_info
*revs
= sb
->revs
;
1410 int i
, pass
, num_sg
;
1411 struct commit
*commit
= origin
->commit
;
1412 struct commit_list
*sg
;
1413 struct origin
*sg_buf
[MAXSG
];
1414 struct origin
*porigin
, **sg_origin
= sg_buf
;
1415 struct blame_entry
*toosmall
= NULL
;
1416 struct blame_entry
*blames
, **blametail
= &blames
;
1418 num_sg
= num_scapegoats(revs
, commit
);
1421 else if (num_sg
< ARRAY_SIZE(sg_buf
))
1422 memset(sg_buf
, 0, sizeof(sg_buf
));
1424 sg_origin
= xcalloc(num_sg
, sizeof(*sg_origin
));
1427 * The first pass looks for unrenamed path to optimize for
1428 * common cases, then we look for renames in the second pass.
1430 for (pass
= 0; pass
< 2 - no_whole_file_rename
; pass
++) {
1431 struct origin
*(*find
)(struct scoreboard
*,
1432 struct commit
*, struct origin
*);
1433 find
= pass
? find_rename
: find_origin
;
1435 for (i
= 0, sg
= first_scapegoat(revs
, commit
);
1437 sg
= sg
->next
, i
++) {
1438 struct commit
*p
= sg
->item
;
1443 if (parse_commit(p
))
1445 porigin
= find(sb
, p
, origin
);
1448 if (!hashcmp(porigin
->blob_sha1
, origin
->blob_sha1
)) {
1449 pass_whole_blame(sb
, origin
, porigin
);
1450 origin_decref(porigin
);
1453 for (j
= same
= 0; j
< i
; j
++)
1455 !hashcmp(sg_origin
[j
]->blob_sha1
,
1456 porigin
->blob_sha1
)) {
1461 sg_origin
[i
] = porigin
;
1463 origin_decref(porigin
);
1468 for (i
= 0, sg
= first_scapegoat(revs
, commit
);
1470 sg
= sg
->next
, i
++) {
1471 struct origin
*porigin
= sg_origin
[i
];
1474 if (!origin
->previous
) {
1475 origin_incref(porigin
);
1476 origin
->previous
= porigin
;
1478 pass_blame_to_parent(sb
, origin
, porigin
);
1479 if (!origin
->suspects
)
1484 * Optionally find moves in parents' files.
1486 if (opt
& PICKAXE_BLAME_MOVE
) {
1487 filter_small(sb
, &toosmall
, &origin
->suspects
, blame_move_score
);
1488 if (origin
->suspects
) {
1489 for (i
= 0, sg
= first_scapegoat(revs
, commit
);
1491 sg
= sg
->next
, i
++) {
1492 struct origin
*porigin
= sg_origin
[i
];
1495 find_move_in_parent(sb
, &blametail
, &toosmall
, origin
, porigin
);
1496 if (!origin
->suspects
)
1503 * Optionally find copies from parents' files.
1505 if (opt
& PICKAXE_BLAME_COPY
) {
1506 if (blame_copy_score
> blame_move_score
)
1507 filter_small(sb
, &toosmall
, &origin
->suspects
, blame_copy_score
);
1508 else if (blame_copy_score
< blame_move_score
) {
1509 origin
->suspects
= blame_merge(origin
->suspects
, toosmall
);
1511 filter_small(sb
, &toosmall
, &origin
->suspects
, blame_copy_score
);
1513 if (!origin
->suspects
)
1516 for (i
= 0, sg
= first_scapegoat(revs
, commit
);
1518 sg
= sg
->next
, i
++) {
1519 struct origin
*porigin
= sg_origin
[i
];
1520 find_copy_in_parent(sb
, &blametail
, &toosmall
,
1521 origin
, sg
->item
, porigin
, opt
);
1522 if (!origin
->suspects
)
1529 distribute_blame(sb
, blames
);
1531 * prepend toosmall to origin->suspects
1533 * There is no point in sorting: this ends up on a big
1534 * unsorted list in the caller anyway.
1537 struct blame_entry
**tail
= &toosmall
;
1539 tail
= &(*tail
)->next
;
1540 *tail
= origin
->suspects
;
1541 origin
->suspects
= toosmall
;
1543 for (i
= 0; i
< num_sg
; i
++) {
1545 drop_origin_blob(sg_origin
[i
]);
1546 origin_decref(sg_origin
[i
]);
1549 drop_origin_blob(origin
);
1550 if (sg_buf
!= sg_origin
)
1555 * Information on commits, used for output.
1557 struct commit_info
{
1558 struct strbuf author
;
1559 struct strbuf author_mail
;
1560 unsigned long author_time
;
1561 struct strbuf author_tz
;
1563 /* filled only when asked for details */
1564 struct strbuf committer
;
1565 struct strbuf committer_mail
;
1566 unsigned long committer_time
;
1567 struct strbuf committer_tz
;
1569 struct strbuf summary
;
1573 * Parse author/committer line in the commit object buffer
1575 static void get_ac_line(const char *inbuf
, const char *what
,
1576 struct strbuf
*name
, struct strbuf
*mail
,
1577 unsigned long *time
, struct strbuf
*tz
)
1579 struct ident_split ident
;
1580 size_t len
, maillen
, namelen
;
1582 const char *namebuf
, *mailbuf
;
1584 tmp
= strstr(inbuf
, what
);
1587 tmp
+= strlen(what
);
1588 endp
= strchr(tmp
, '\n');
1594 if (split_ident_line(&ident
, tmp
, len
)) {
1598 strbuf_addstr(name
, tmp
);
1599 strbuf_addstr(mail
, tmp
);
1600 strbuf_addstr(tz
, tmp
);
1605 namelen
= ident
.name_end
- ident
.name_begin
;
1606 namebuf
= ident
.name_begin
;
1608 maillen
= ident
.mail_end
- ident
.mail_begin
;
1609 mailbuf
= ident
.mail_begin
;
1611 if (ident
.date_begin
&& ident
.date_end
)
1612 *time
= strtoul(ident
.date_begin
, NULL
, 10);
1616 if (ident
.tz_begin
&& ident
.tz_end
)
1617 strbuf_add(tz
, ident
.tz_begin
, ident
.tz_end
- ident
.tz_begin
);
1619 strbuf_addstr(tz
, "(unknown)");
1622 * Now, convert both name and e-mail using mailmap
1624 map_user(&mailmap
, &mailbuf
, &maillen
,
1625 &namebuf
, &namelen
);
1627 strbuf_addf(mail
, "<%.*s>", (int)maillen
, mailbuf
);
1628 strbuf_add(name
, namebuf
, namelen
);
1631 static void commit_info_init(struct commit_info
*ci
)
1634 strbuf_init(&ci
->author
, 0);
1635 strbuf_init(&ci
->author_mail
, 0);
1636 strbuf_init(&ci
->author_tz
, 0);
1637 strbuf_init(&ci
->committer
, 0);
1638 strbuf_init(&ci
->committer_mail
, 0);
1639 strbuf_init(&ci
->committer_tz
, 0);
1640 strbuf_init(&ci
->summary
, 0);
1643 static void commit_info_destroy(struct commit_info
*ci
)
1646 strbuf_release(&ci
->author
);
1647 strbuf_release(&ci
->author_mail
);
1648 strbuf_release(&ci
->author_tz
);
1649 strbuf_release(&ci
->committer
);
1650 strbuf_release(&ci
->committer_mail
);
1651 strbuf_release(&ci
->committer_tz
);
1652 strbuf_release(&ci
->summary
);
1655 static void get_commit_info(struct commit
*commit
,
1656 struct commit_info
*ret
,
1660 const char *subject
, *encoding
;
1661 const char *message
;
1663 commit_info_init(ret
);
1665 encoding
= get_log_output_encoding();
1666 message
= logmsg_reencode(commit
, NULL
, encoding
);
1667 get_ac_line(message
, "\nauthor ",
1668 &ret
->author
, &ret
->author_mail
,
1669 &ret
->author_time
, &ret
->author_tz
);
1672 unuse_commit_buffer(commit
, message
);
1676 get_ac_line(message
, "\ncommitter ",
1677 &ret
->committer
, &ret
->committer_mail
,
1678 &ret
->committer_time
, &ret
->committer_tz
);
1680 len
= find_commit_subject(message
, &subject
);
1682 strbuf_add(&ret
->summary
, subject
, len
);
1684 strbuf_addf(&ret
->summary
, "(%s)", sha1_to_hex(commit
->object
.sha1
));
1686 unuse_commit_buffer(commit
, message
);
1690 * To allow LF and other nonportable characters in pathnames,
1691 * they are c-style quoted as needed.
1693 static void write_filename_info(const char *path
)
1695 printf("filename ");
1696 write_name_quoted(path
, stdout
, '\n');
1700 * Porcelain/Incremental format wants to show a lot of details per
1701 * commit. Instead of repeating this every line, emit it only once,
1702 * the first time each commit appears in the output (unless the
1703 * user has specifically asked for us to repeat).
1705 static int emit_one_suspect_detail(struct origin
*suspect
, int repeat
)
1707 struct commit_info ci
;
1709 if (!repeat
&& (suspect
->commit
->object
.flags
& METAINFO_SHOWN
))
1712 suspect
->commit
->object
.flags
|= METAINFO_SHOWN
;
1713 get_commit_info(suspect
->commit
, &ci
, 1);
1714 printf("author %s\n", ci
.author
.buf
);
1715 printf("author-mail %s\n", ci
.author_mail
.buf
);
1716 printf("author-time %lu\n", ci
.author_time
);
1717 printf("author-tz %s\n", ci
.author_tz
.buf
);
1718 printf("committer %s\n", ci
.committer
.buf
);
1719 printf("committer-mail %s\n", ci
.committer_mail
.buf
);
1720 printf("committer-time %lu\n", ci
.committer_time
);
1721 printf("committer-tz %s\n", ci
.committer_tz
.buf
);
1722 printf("summary %s\n", ci
.summary
.buf
);
1723 if (suspect
->commit
->object
.flags
& UNINTERESTING
)
1724 printf("boundary\n");
1725 if (suspect
->previous
) {
1726 struct origin
*prev
= suspect
->previous
;
1727 printf("previous %s ", sha1_to_hex(prev
->commit
->object
.sha1
));
1728 write_name_quoted(prev
->path
, stdout
, '\n');
1731 commit_info_destroy(&ci
);
1737 * The blame_entry is found to be guilty for the range.
1738 * Show it in incremental output.
1740 static void found_guilty_entry(struct blame_entry
*ent
)
1743 struct origin
*suspect
= ent
->suspect
;
1745 printf("%s %d %d %d\n",
1746 sha1_to_hex(suspect
->commit
->object
.sha1
),
1747 ent
->s_lno
+ 1, ent
->lno
+ 1, ent
->num_lines
);
1748 emit_one_suspect_detail(suspect
, 0);
1749 write_filename_info(suspect
->path
);
1750 maybe_flush_or_die(stdout
, "stdout");
1755 * The main loop -- while we have blobs with lines whose true origin
1756 * is still unknown, pick one blob, and allow its lines to pass blames
1757 * to its parents. */
1758 static void assign_blame(struct scoreboard
*sb
, int opt
)
1760 struct rev_info
*revs
= sb
->revs
;
1761 struct commit
*commit
= prio_queue_get(&sb
->commits
);
1764 struct blame_entry
*ent
;
1765 struct origin
*suspect
= commit
->util
;
1767 /* find one suspect to break down */
1768 while (suspect
&& !suspect
->suspects
)
1769 suspect
= suspect
->next
;
1772 commit
= prio_queue_get(&sb
->commits
);
1776 assert(commit
== suspect
->commit
);
1779 * We will use this suspect later in the loop,
1780 * so hold onto it in the meantime.
1782 origin_incref(suspect
);
1783 parse_commit(commit
);
1785 (!(commit
->object
.flags
& UNINTERESTING
) &&
1786 !(revs
->max_age
!= -1 && commit
->date
< revs
->max_age
)))
1787 pass_blame(sb
, suspect
, opt
);
1789 commit
->object
.flags
|= UNINTERESTING
;
1790 if (commit
->object
.parsed
)
1791 mark_parents_uninteresting(commit
);
1793 /* treat root commit as boundary */
1794 if (!commit
->parents
&& !show_root
)
1795 commit
->object
.flags
|= UNINTERESTING
;
1797 /* Take responsibility for the remaining entries */
1798 ent
= suspect
->suspects
;
1800 suspect
->guilty
= 1;
1802 struct blame_entry
*next
= ent
->next
;
1803 found_guilty_entry(ent
);
1808 ent
->next
= sb
->ent
;
1809 sb
->ent
= suspect
->suspects
;
1810 suspect
->suspects
= NULL
;
1814 origin_decref(suspect
);
1816 if (DEBUG
) /* sanity */
1817 sanity_check_refcnt(sb
);
1821 static const char *format_time(unsigned long time
, const char *tz_str
,
1824 static struct strbuf time_buf
= STRBUF_INIT
;
1826 strbuf_reset(&time_buf
);
1827 if (show_raw_time
) {
1828 strbuf_addf(&time_buf
, "%lu %s", time
, tz_str
);
1831 const char *time_str
;
1835 time_str
= show_date(time
, tz
, blame_date_mode
);
1836 strbuf_addstr(&time_buf
, time_str
);
1838 * Add space paddings to time_buf to display a fixed width
1839 * string, and use time_width for display width calibration.
1841 for (time_width
= utf8_strwidth(time_str
);
1842 time_width
< blame_date_width
;
1844 strbuf_addch(&time_buf
, ' ');
1846 return time_buf
.buf
;
1849 #define OUTPUT_ANNOTATE_COMPAT 001
1850 #define OUTPUT_LONG_OBJECT_NAME 002
1851 #define OUTPUT_RAW_TIMESTAMP 004
1852 #define OUTPUT_PORCELAIN 010
1853 #define OUTPUT_SHOW_NAME 020
1854 #define OUTPUT_SHOW_NUMBER 040
1855 #define OUTPUT_SHOW_SCORE 0100
1856 #define OUTPUT_NO_AUTHOR 0200
1857 #define OUTPUT_SHOW_EMAIL 0400
1858 #define OUTPUT_LINE_PORCELAIN 01000
1860 static void emit_porcelain_details(struct origin
*suspect
, int repeat
)
1862 if (emit_one_suspect_detail(suspect
, repeat
) ||
1863 (suspect
->commit
->object
.flags
& MORE_THAN_ONE_PATH
))
1864 write_filename_info(suspect
->path
);
1867 static void emit_porcelain(struct scoreboard
*sb
, struct blame_entry
*ent
,
1870 int repeat
= opt
& OUTPUT_LINE_PORCELAIN
;
1873 struct origin
*suspect
= ent
->suspect
;
1876 strcpy(hex
, sha1_to_hex(suspect
->commit
->object
.sha1
));
1877 printf("%s %d %d %d\n",
1882 emit_porcelain_details(suspect
, repeat
);
1884 cp
= nth_line(sb
, ent
->lno
);
1885 for (cnt
= 0; cnt
< ent
->num_lines
; cnt
++) {
1888 printf("%s %d %d\n", hex
,
1889 ent
->s_lno
+ 1 + cnt
,
1890 ent
->lno
+ 1 + cnt
);
1892 emit_porcelain_details(suspect
, 1);
1898 } while (ch
!= '\n' &&
1899 cp
< sb
->final_buf
+ sb
->final_buf_size
);
1902 if (sb
->final_buf_size
&& cp
[-1] != '\n')
1906 static void emit_other(struct scoreboard
*sb
, struct blame_entry
*ent
, int opt
)
1910 struct origin
*suspect
= ent
->suspect
;
1911 struct commit_info ci
;
1913 int show_raw_time
= !!(opt
& OUTPUT_RAW_TIMESTAMP
);
1915 get_commit_info(suspect
->commit
, &ci
, 1);
1916 strcpy(hex
, sha1_to_hex(suspect
->commit
->object
.sha1
));
1918 cp
= nth_line(sb
, ent
->lno
);
1919 for (cnt
= 0; cnt
< ent
->num_lines
; cnt
++) {
1921 int length
= (opt
& OUTPUT_LONG_OBJECT_NAME
) ? 40 : abbrev
;
1923 if (suspect
->commit
->object
.flags
& UNINTERESTING
) {
1925 memset(hex
, ' ', length
);
1926 else if (!(opt
& OUTPUT_ANNOTATE_COMPAT
)) {
1932 printf("%.*s", length
, hex
);
1933 if (opt
& OUTPUT_ANNOTATE_COMPAT
) {
1935 if (opt
& OUTPUT_SHOW_EMAIL
)
1936 name
= ci
.author_mail
.buf
;
1938 name
= ci
.author
.buf
;
1939 printf("\t(%10s\t%10s\t%d)", name
,
1940 format_time(ci
.author_time
, ci
.author_tz
.buf
,
1942 ent
->lno
+ 1 + cnt
);
1944 if (opt
& OUTPUT_SHOW_SCORE
)
1946 max_score_digits
, ent
->score
,
1947 ent
->suspect
->refcnt
);
1948 if (opt
& OUTPUT_SHOW_NAME
)
1949 printf(" %-*.*s", longest_file
, longest_file
,
1951 if (opt
& OUTPUT_SHOW_NUMBER
)
1952 printf(" %*d", max_orig_digits
,
1953 ent
->s_lno
+ 1 + cnt
);
1955 if (!(opt
& OUTPUT_NO_AUTHOR
)) {
1958 if (opt
& OUTPUT_SHOW_EMAIL
)
1959 name
= ci
.author_mail
.buf
;
1961 name
= ci
.author
.buf
;
1962 pad
= longest_author
- utf8_strwidth(name
);
1963 printf(" (%s%*s %10s",
1965 format_time(ci
.author_time
,
1970 max_digits
, ent
->lno
+ 1 + cnt
);
1975 } while (ch
!= '\n' &&
1976 cp
< sb
->final_buf
+ sb
->final_buf_size
);
1979 if (sb
->final_buf_size
&& cp
[-1] != '\n')
1982 commit_info_destroy(&ci
);
1985 static void output(struct scoreboard
*sb
, int option
)
1987 struct blame_entry
*ent
;
1989 if (option
& OUTPUT_PORCELAIN
) {
1990 for (ent
= sb
->ent
; ent
; ent
= ent
->next
) {
1992 struct origin
*suspect
;
1993 struct commit
*commit
= ent
->suspect
->commit
;
1994 if (commit
->object
.flags
& MORE_THAN_ONE_PATH
)
1996 for (suspect
= commit
->util
; suspect
; suspect
= suspect
->next
) {
1997 if (suspect
->guilty
&& count
++) {
1998 commit
->object
.flags
|= MORE_THAN_ONE_PATH
;
2005 for (ent
= sb
->ent
; ent
; ent
= ent
->next
) {
2006 if (option
& OUTPUT_PORCELAIN
)
2007 emit_porcelain(sb
, ent
, option
);
2009 emit_other(sb
, ent
, option
);
2014 static const char *get_next_line(const char *start
, const char *end
)
2016 const char *nl
= memchr(start
, '\n', end
- start
);
2017 return nl
? nl
+ 1 : end
;
2021 * To allow quick access to the contents of nth line in the
2022 * final image, prepare an index in the scoreboard.
2024 static int prepare_lines(struct scoreboard
*sb
)
2026 const char *buf
= sb
->final_buf
;
2027 unsigned long len
= sb
->final_buf_size
;
2028 const char *end
= buf
+ len
;
2033 for (p
= buf
; p
< end
; p
= get_next_line(p
, end
))
2036 sb
->lineno
= lineno
= xmalloc(sizeof(*sb
->lineno
) * (num
+ 1));
2038 for (p
= buf
; p
< end
; p
= get_next_line(p
, end
))
2039 *lineno
++ = p
- buf
;
2043 sb
->num_lines
= num
;
2044 return sb
->num_lines
;
2048 * Add phony grafts for use with -S; this is primarily to
2049 * support git's cvsserver that wants to give a linear history
2052 static int read_ancestry(const char *graft_file
)
2054 FILE *fp
= fopen(graft_file
, "r");
2055 struct strbuf buf
= STRBUF_INIT
;
2058 while (!strbuf_getwholeline(&buf
, fp
, '\n')) {
2059 /* The format is just "Commit Parent1 Parent2 ...\n" */
2060 struct commit_graft
*graft
= read_graft_line(buf
.buf
, buf
.len
);
2062 register_commit_graft(graft
, 0);
2065 strbuf_release(&buf
);
2069 static int update_auto_abbrev(int auto_abbrev
, struct origin
*suspect
)
2071 const char *uniq
= find_unique_abbrev(suspect
->commit
->object
.sha1
,
2073 int len
= strlen(uniq
);
2074 if (auto_abbrev
< len
)
2080 * How many columns do we need to show line numbers, authors,
2083 static void find_alignment(struct scoreboard
*sb
, int *option
)
2085 int longest_src_lines
= 0;
2086 int longest_dst_lines
= 0;
2087 unsigned largest_score
= 0;
2088 struct blame_entry
*e
;
2089 int compute_auto_abbrev
= (abbrev
< 0);
2090 int auto_abbrev
= default_abbrev
;
2092 for (e
= sb
->ent
; e
; e
= e
->next
) {
2093 struct origin
*suspect
= e
->suspect
;
2096 if (compute_auto_abbrev
)
2097 auto_abbrev
= update_auto_abbrev(auto_abbrev
, suspect
);
2098 if (strcmp(suspect
->path
, sb
->path
))
2099 *option
|= OUTPUT_SHOW_NAME
;
2100 num
= strlen(suspect
->path
);
2101 if (longest_file
< num
)
2103 if (!(suspect
->commit
->object
.flags
& METAINFO_SHOWN
)) {
2104 struct commit_info ci
;
2105 suspect
->commit
->object
.flags
|= METAINFO_SHOWN
;
2106 get_commit_info(suspect
->commit
, &ci
, 1);
2107 if (*option
& OUTPUT_SHOW_EMAIL
)
2108 num
= utf8_strwidth(ci
.author_mail
.buf
);
2110 num
= utf8_strwidth(ci
.author
.buf
);
2111 if (longest_author
< num
)
2112 longest_author
= num
;
2113 commit_info_destroy(&ci
);
2115 num
= e
->s_lno
+ e
->num_lines
;
2116 if (longest_src_lines
< num
)
2117 longest_src_lines
= num
;
2118 num
= e
->lno
+ e
->num_lines
;
2119 if (longest_dst_lines
< num
)
2120 longest_dst_lines
= num
;
2121 if (largest_score
< ent_score(sb
, e
))
2122 largest_score
= ent_score(sb
, e
);
2124 max_orig_digits
= decimal_width(longest_src_lines
);
2125 max_digits
= decimal_width(longest_dst_lines
);
2126 max_score_digits
= decimal_width(largest_score
);
2128 if (compute_auto_abbrev
)
2129 /* one more abbrev length is needed for the boundary commit */
2130 abbrev
= auto_abbrev
+ 1;
2134 * For debugging -- origin is refcounted, and this asserts that
2135 * we do not underflow.
2137 static void sanity_check_refcnt(struct scoreboard
*sb
)
2140 struct blame_entry
*ent
;
2142 for (ent
= sb
->ent
; ent
; ent
= ent
->next
) {
2143 /* Nobody should have zero or negative refcnt */
2144 if (ent
->suspect
->refcnt
<= 0) {
2145 fprintf(stderr
, "%s in %s has negative refcnt %d\n",
2147 sha1_to_hex(ent
->suspect
->commit
->object
.sha1
),
2148 ent
->suspect
->refcnt
);
2154 find_alignment(sb
, &opt
);
2156 die("Baa %d!", baa
);
2160 static unsigned parse_score(const char *arg
)
2163 unsigned long score
= strtoul(arg
, &end
, 10);
2169 static const char *add_prefix(const char *prefix
, const char *path
)
2171 return prefix_path(prefix
, prefix
? strlen(prefix
) : 0, path
);
2174 static int git_blame_config(const char *var
, const char *value
, void *cb
)
2176 if (!strcmp(var
, "blame.showroot")) {
2177 show_root
= git_config_bool(var
, value
);
2180 if (!strcmp(var
, "blame.blankboundary")) {
2181 blank_boundary
= git_config_bool(var
, value
);
2184 if (!strcmp(var
, "blame.date")) {
2186 return config_error_nonbool(var
);
2187 blame_date_mode
= parse_date_format(value
);
2191 if (userdiff_config(var
, value
) < 0)
2194 return git_default_config(var
, value
, cb
);
2197 static void verify_working_tree_path(struct commit
*work_tree
, const char *path
)
2199 struct commit_list
*parents
;
2201 for (parents
= work_tree
->parents
; parents
; parents
= parents
->next
) {
2202 const unsigned char *commit_sha1
= parents
->item
->object
.sha1
;
2203 unsigned char blob_sha1
[20];
2206 if (!get_tree_entry(commit_sha1
, path
, blob_sha1
, &mode
) &&
2207 sha1_object_info(blob_sha1
, NULL
) == OBJ_BLOB
)
2210 die("no such path '%s' in HEAD", path
);
2213 static struct commit_list
**append_parent(struct commit_list
**tail
, const unsigned char *sha1
)
2215 struct commit
*parent
;
2217 parent
= lookup_commit_reference(sha1
);
2219 die("no such commit %s", sha1_to_hex(sha1
));
2220 return &commit_list_insert(parent
, tail
)->next
;
2223 static void append_merge_parents(struct commit_list
**tail
)
2226 const char *merge_head_file
= git_path("MERGE_HEAD");
2227 struct strbuf line
= STRBUF_INIT
;
2229 merge_head
= open(merge_head_file
, O_RDONLY
);
2230 if (merge_head
< 0) {
2231 if (errno
== ENOENT
)
2233 die("cannot open '%s' for reading", merge_head_file
);
2236 while (!strbuf_getwholeline_fd(&line
, merge_head
, '\n')) {
2237 unsigned char sha1
[20];
2238 if (line
.len
< 40 || get_sha1_hex(line
.buf
, sha1
))
2239 die("unknown line in '%s': %s", merge_head_file
, line
.buf
);
2240 tail
= append_parent(tail
, sha1
);
2243 strbuf_release(&line
);
2247 * This isn't as simple as passing sb->buf and sb->len, because we
2248 * want to transfer ownership of the buffer to the commit (so we
2251 static void set_commit_buffer_from_strbuf(struct commit
*c
, struct strbuf
*sb
)
2254 void *buf
= strbuf_detach(sb
, &len
);
2255 set_commit_buffer(c
, buf
, len
);
2259 * Prepare a dummy commit that represents the work tree (or staged) item.
2260 * Note that annotating work tree item never works in the reverse.
2262 static struct commit
*fake_working_tree_commit(struct diff_options
*opt
,
2264 const char *contents_from
)
2266 struct commit
*commit
;
2267 struct origin
*origin
;
2268 struct commit_list
**parent_tail
, *parent
;
2269 unsigned char head_sha1
[20];
2270 struct strbuf buf
= STRBUF_INIT
;
2274 struct cache_entry
*ce
;
2276 struct strbuf msg
= STRBUF_INIT
;
2279 commit
= alloc_commit_node();
2280 commit
->object
.parsed
= 1;
2282 parent_tail
= &commit
->parents
;
2284 if (!resolve_ref_unsafe("HEAD", RESOLVE_REF_READING
, head_sha1
, NULL
))
2285 die("no such ref: HEAD");
2287 parent_tail
= append_parent(parent_tail
, head_sha1
);
2288 append_merge_parents(parent_tail
);
2289 verify_working_tree_path(commit
, path
);
2291 origin
= make_origin(commit
, path
);
2293 ident
= fmt_ident("Not Committed Yet", "not.committed.yet", NULL
, 0);
2294 strbuf_addstr(&msg
, "tree 0000000000000000000000000000000000000000\n");
2295 for (parent
= commit
->parents
; parent
; parent
= parent
->next
)
2296 strbuf_addf(&msg
, "parent %s\n",
2297 sha1_to_hex(parent
->item
->object
.sha1
));
2301 "Version of %s from %s\n",
2303 (!contents_from
? path
:
2304 (!strcmp(contents_from
, "-") ? "standard input" : contents_from
)));
2305 set_commit_buffer_from_strbuf(commit
, &msg
);
2307 if (!contents_from
|| strcmp("-", contents_from
)) {
2309 const char *read_from
;
2311 unsigned long buf_len
;
2313 if (contents_from
) {
2314 if (stat(contents_from
, &st
) < 0)
2315 die_errno("Cannot stat '%s'", contents_from
);
2316 read_from
= contents_from
;
2319 if (lstat(path
, &st
) < 0)
2320 die_errno("Cannot lstat '%s'", path
);
2323 mode
= canon_mode(st
.st_mode
);
2325 switch (st
.st_mode
& S_IFMT
) {
2327 if (DIFF_OPT_TST(opt
, ALLOW_TEXTCONV
) &&
2328 textconv_object(read_from
, mode
, null_sha1
, 0, &buf_ptr
, &buf_len
))
2329 strbuf_attach(&buf
, buf_ptr
, buf_len
, buf_len
+ 1);
2330 else if (strbuf_read_file(&buf
, read_from
, st
.st_size
) != st
.st_size
)
2331 die_errno("cannot open or read '%s'", read_from
);
2334 if (strbuf_readlink(&buf
, read_from
, st
.st_size
) < 0)
2335 die_errno("cannot readlink '%s'", read_from
);
2338 die("unsupported file type %s", read_from
);
2342 /* Reading from stdin */
2344 if (strbuf_read(&buf
, 0, 0) < 0)
2345 die_errno("failed to read from stdin");
2347 convert_to_git(path
, buf
.buf
, buf
.len
, &buf
, 0);
2348 origin
->file
.ptr
= buf
.buf
;
2349 origin
->file
.size
= buf
.len
;
2350 pretend_sha1_file(buf
.buf
, buf
.len
, OBJ_BLOB
, origin
->blob_sha1
);
2353 * Read the current index, replace the path entry with
2354 * origin->blob_sha1 without mucking with its mode or type
2355 * bits; we are not going to write this index out -- we just
2356 * want to run "diff-index --cached".
2363 int pos
= cache_name_pos(path
, len
);
2365 mode
= active_cache
[pos
]->ce_mode
;
2367 /* Let's not bother reading from HEAD tree */
2368 mode
= S_IFREG
| 0644;
2370 size
= cache_entry_size(len
);
2371 ce
= xcalloc(1, size
);
2372 hashcpy(ce
->sha1
, origin
->blob_sha1
);
2373 memcpy(ce
->name
, path
, len
);
2374 ce
->ce_flags
= create_ce_flags(0);
2375 ce
->ce_namelen
= len
;
2376 ce
->ce_mode
= create_ce_mode(mode
);
2377 add_cache_entry(ce
, ADD_CACHE_OK_TO_ADD
|ADD_CACHE_OK_TO_REPLACE
);
2380 * We are not going to write this out, so this does not matter
2381 * right now, but someday we might optimize diff-index --cached
2382 * with cache-tree information.
2384 cache_tree_invalidate_path(&the_index
, path
);
2389 static char *prepare_final(struct scoreboard
*sb
)
2392 const char *final_commit_name
= NULL
;
2393 struct rev_info
*revs
= sb
->revs
;
2396 * There must be one and only one positive commit in the
2397 * revs->pending array.
2399 for (i
= 0; i
< revs
->pending
.nr
; i
++) {
2400 struct object
*obj
= revs
->pending
.objects
[i
].item
;
2401 if (obj
->flags
& UNINTERESTING
)
2403 while (obj
->type
== OBJ_TAG
)
2404 obj
= deref_tag(obj
, NULL
, 0);
2405 if (obj
->type
!= OBJ_COMMIT
)
2406 die("Non commit %s?", revs
->pending
.objects
[i
].name
);
2408 die("More than one commit to dig from %s and %s?",
2409 revs
->pending
.objects
[i
].name
,
2411 sb
->final
= (struct commit
*) obj
;
2412 final_commit_name
= revs
->pending
.objects
[i
].name
;
2414 return xstrdup_or_null(final_commit_name
);
2417 static char *prepare_initial(struct scoreboard
*sb
)
2420 const char *final_commit_name
= NULL
;
2421 struct rev_info
*revs
= sb
->revs
;
2424 * There must be one and only one negative commit, and it must be
2427 for (i
= 0; i
< revs
->pending
.nr
; i
++) {
2428 struct object
*obj
= revs
->pending
.objects
[i
].item
;
2429 if (!(obj
->flags
& UNINTERESTING
))
2431 while (obj
->type
== OBJ_TAG
)
2432 obj
= deref_tag(obj
, NULL
, 0);
2433 if (obj
->type
!= OBJ_COMMIT
)
2434 die("Non commit %s?", revs
->pending
.objects
[i
].name
);
2436 die("More than one commit to dig down to %s and %s?",
2437 revs
->pending
.objects
[i
].name
,
2439 sb
->final
= (struct commit
*) obj
;
2440 final_commit_name
= revs
->pending
.objects
[i
].name
;
2442 if (!final_commit_name
)
2443 die("No commit to dig down to?");
2444 return xstrdup(final_commit_name
);
2447 static int blame_copy_callback(const struct option
*option
, const char *arg
, int unset
)
2449 int *opt
= option
->value
;
2452 * -C enables copy from removed files;
2453 * -C -C enables copy from existing files, but only
2454 * when blaming a new file;
2455 * -C -C -C enables copy from existing files for
2458 if (*opt
& PICKAXE_BLAME_COPY_HARDER
)
2459 *opt
|= PICKAXE_BLAME_COPY_HARDEST
;
2460 if (*opt
& PICKAXE_BLAME_COPY
)
2461 *opt
|= PICKAXE_BLAME_COPY_HARDER
;
2462 *opt
|= PICKAXE_BLAME_COPY
| PICKAXE_BLAME_MOVE
;
2465 blame_copy_score
= parse_score(arg
);
2469 static int blame_move_callback(const struct option
*option
, const char *arg
, int unset
)
2471 int *opt
= option
->value
;
2473 *opt
|= PICKAXE_BLAME_MOVE
;
2476 blame_move_score
= parse_score(arg
);
2480 int cmd_blame(int argc
, const char **argv
, const char *prefix
)
2482 struct rev_info revs
;
2484 struct scoreboard sb
;
2486 struct blame_entry
*ent
= NULL
;
2487 long dashdash_pos
, lno
;
2488 char *final_commit_name
= NULL
;
2489 enum object_type type
;
2491 static struct string_list range_list
;
2492 static int output_option
= 0, opt
= 0;
2493 static int show_stats
= 0;
2494 static const char *revs_file
= NULL
;
2495 static const char *contents_from
= NULL
;
2496 static const struct option options
[] = {
2497 OPT_BOOL(0, "incremental", &incremental
, N_("Show blame entries as we find them, incrementally")),
2498 OPT_BOOL('b', NULL
, &blank_boundary
, N_("Show blank SHA-1 for boundary commits (Default: off)")),
2499 OPT_BOOL(0, "root", &show_root
, N_("Do not treat root commits as boundaries (Default: off)")),
2500 OPT_BOOL(0, "show-stats", &show_stats
, N_("Show work cost statistics")),
2501 OPT_BIT(0, "score-debug", &output_option
, N_("Show output score for blame entries"), OUTPUT_SHOW_SCORE
),
2502 OPT_BIT('f', "show-name", &output_option
, N_("Show original filename (Default: auto)"), OUTPUT_SHOW_NAME
),
2503 OPT_BIT('n', "show-number", &output_option
, N_("Show original linenumber (Default: off)"), OUTPUT_SHOW_NUMBER
),
2504 OPT_BIT('p', "porcelain", &output_option
, N_("Show in a format designed for machine consumption"), OUTPUT_PORCELAIN
),
2505 OPT_BIT(0, "line-porcelain", &output_option
, N_("Show porcelain format with per-line commit information"), OUTPUT_PORCELAIN
|OUTPUT_LINE_PORCELAIN
),
2506 OPT_BIT('c', NULL
, &output_option
, N_("Use the same output mode as git-annotate (Default: off)"), OUTPUT_ANNOTATE_COMPAT
),
2507 OPT_BIT('t', NULL
, &output_option
, N_("Show raw timestamp (Default: off)"), OUTPUT_RAW_TIMESTAMP
),
2508 OPT_BIT('l', NULL
, &output_option
, N_("Show long commit SHA1 (Default: off)"), OUTPUT_LONG_OBJECT_NAME
),
2509 OPT_BIT('s', NULL
, &output_option
, N_("Suppress author name and timestamp (Default: off)"), OUTPUT_NO_AUTHOR
),
2510 OPT_BIT('e', "show-email", &output_option
, N_("Show author email instead of name (Default: off)"), OUTPUT_SHOW_EMAIL
),
2511 OPT_BIT('w', NULL
, &xdl_opts
, N_("Ignore whitespace differences"), XDF_IGNORE_WHITESPACE
),
2512 OPT_BIT(0, "minimal", &xdl_opts
, N_("Spend extra cycles to find better match"), XDF_NEED_MINIMAL
),
2513 OPT_STRING('S', NULL
, &revs_file
, N_("file"), N_("Use revisions from <file> instead of calling git-rev-list")),
2514 OPT_STRING(0, "contents", &contents_from
, N_("file"), N_("Use <file>'s contents as the final image")),
2515 { OPTION_CALLBACK
, 'C', NULL
, &opt
, N_("score"), N_("Find line copies within and across files"), PARSE_OPT_OPTARG
, blame_copy_callback
},
2516 { OPTION_CALLBACK
, 'M', NULL
, &opt
, N_("score"), N_("Find line movements within and across files"), PARSE_OPT_OPTARG
, blame_move_callback
},
2517 OPT_STRING_LIST('L', NULL
, &range_list
, N_("n,m"), N_("Process only line range n,m, counting from 1")),
2518 OPT__ABBREV(&abbrev
),
2522 struct parse_opt_ctx_t ctx
;
2523 int cmd_is_annotate
= !strcmp(argv
[0], "annotate");
2524 struct range_set ranges
;
2525 unsigned int range_i
;
2528 git_config(git_blame_config
, NULL
);
2529 init_revisions(&revs
, NULL
);
2530 revs
.date_mode
= blame_date_mode
;
2531 DIFF_OPT_SET(&revs
.diffopt
, ALLOW_TEXTCONV
);
2532 DIFF_OPT_SET(&revs
.diffopt
, FOLLOW_RENAMES
);
2534 save_commit_buffer
= 0;
2537 parse_options_start(&ctx
, argc
, argv
, prefix
, options
,
2538 PARSE_OPT_KEEP_DASHDASH
| PARSE_OPT_KEEP_ARGV0
);
2540 switch (parse_options_step(&ctx
, options
, blame_opt_usage
)) {
2541 case PARSE_OPT_HELP
:
2543 case PARSE_OPT_DONE
:
2545 dashdash_pos
= ctx
.cpidx
;
2549 if (!strcmp(ctx
.argv
[0], "--reverse")) {
2550 ctx
.argv
[0] = "--children";
2553 parse_revision_opt(&revs
, &ctx
, options
, blame_opt_usage
);
2556 no_whole_file_rename
= !DIFF_OPT_TST(&revs
.diffopt
, FOLLOW_RENAMES
);
2557 DIFF_OPT_CLR(&revs
.diffopt
, FOLLOW_RENAMES
);
2558 argc
= parse_options_end(&ctx
);
2561 /* one more abbrev length is needed for the boundary commit */
2564 if (revs_file
&& read_ancestry(revs_file
))
2565 die_errno("reading graft file '%s' failed", revs_file
);
2567 if (cmd_is_annotate
) {
2568 output_option
|= OUTPUT_ANNOTATE_COMPAT
;
2569 blame_date_mode
= DATE_ISO8601
;
2571 blame_date_mode
= revs
.date_mode
;
2574 /* The maximum width used to show the dates */
2575 switch (blame_date_mode
) {
2577 blame_date_width
= sizeof("Thu, 19 Oct 2006 16:00:04 -0700");
2579 case DATE_ISO8601_STRICT
:
2580 blame_date_width
= sizeof("2006-10-19T16:00:04-07:00");
2583 blame_date_width
= sizeof("2006-10-19 16:00:04 -0700");
2586 blame_date_width
= sizeof("1161298804 -0700");
2589 blame_date_width
= sizeof("2006-10-19");
2592 /* TRANSLATORS: This string is used to tell us the maximum
2593 display width for a relative timestamp in "git blame"
2594 output. For C locale, "4 years, 11 months ago", which
2595 takes 22 places, is the longest among various forms of
2596 relative timestamps, but your language may need more or
2597 fewer display columns. */
2598 blame_date_width
= utf8_strwidth(_("4 years, 11 months ago")) + 1; /* add the null */
2602 blame_date_width
= sizeof("Thu Oct 19 16:00:04 2006 -0700");
2605 blame_date_width
-= 1; /* strip the null */
2607 if (DIFF_OPT_TST(&revs
.diffopt
, FIND_COPIES_HARDER
))
2608 opt
|= (PICKAXE_BLAME_COPY
| PICKAXE_BLAME_MOVE
|
2609 PICKAXE_BLAME_COPY_HARDER
);
2611 if (!blame_move_score
)
2612 blame_move_score
= BLAME_DEFAULT_MOVE_SCORE
;
2613 if (!blame_copy_score
)
2614 blame_copy_score
= BLAME_DEFAULT_COPY_SCORE
;
2617 * We have collected options unknown to us in argv[1..unk]
2618 * which are to be passed to revision machinery if we are
2619 * going to do the "bottom" processing.
2621 * The remaining are:
2623 * (1) if dashdash_pos != 0, it is either
2624 * "blame [revisions] -- <path>" or
2625 * "blame -- <path> <rev>"
2627 * (2) otherwise, it is one of the two:
2628 * "blame [revisions] <path>"
2629 * "blame <path> <rev>"
2631 * Note that we must strip out <path> from the arguments: we do not
2632 * want the path pruning but we may want "bottom" processing.
2635 switch (argc
- dashdash_pos
- 1) {
2638 usage_with_options(blame_opt_usage
, options
);
2639 /* reorder for the new way: <rev> -- <path> */
2645 path
= add_prefix(prefix
, argv
[--argc
]);
2649 usage_with_options(blame_opt_usage
, options
);
2653 usage_with_options(blame_opt_usage
, options
);
2654 path
= add_prefix(prefix
, argv
[argc
- 1]);
2655 if (argc
== 3 && !file_exists(path
)) { /* (2b) */
2656 path
= add_prefix(prefix
, argv
[1]);
2659 argv
[argc
- 1] = "--";
2662 if (!file_exists(path
))
2663 die_errno("cannot stat path '%s'", path
);
2666 revs
.disable_stdin
= 1;
2667 setup_revisions(argc
, argv
, &revs
, NULL
);
2668 memset(&sb
, 0, sizeof(sb
));
2672 final_commit_name
= prepare_final(&sb
);
2673 sb
.commits
.compare
= compare_commits_by_commit_date
;
2675 else if (contents_from
)
2676 die("--contents and --children do not blend well.");
2678 final_commit_name
= prepare_initial(&sb
);
2679 sb
.commits
.compare
= compare_commits_by_reverse_commit_date
;
2684 * "--not A B -- path" without anything positive;
2685 * do not default to HEAD, but use the working tree
2689 sb
.final
= fake_working_tree_commit(&sb
.revs
->diffopt
,
2690 path
, contents_from
);
2691 add_pending_object(&revs
, &(sb
.final
->object
), ":");
2693 else if (contents_from
)
2694 die("Cannot use --contents with final commit object name");
2697 * If we have bottom, this will mark the ancestors of the
2698 * bottom commits we would reach while traversing as
2701 if (prepare_revision_walk(&revs
))
2702 die(_("revision walk setup failed"));
2704 if (is_null_sha1(sb
.final
->object
.sha1
)) {
2706 sb
.final_buf
= xmemdupz(o
->file
.ptr
, o
->file
.size
);
2707 sb
.final_buf_size
= o
->file
.size
;
2710 o
= get_origin(&sb
, sb
.final
, path
);
2711 if (fill_blob_sha1_and_mode(o
))
2712 die("no such path %s in %s", path
, final_commit_name
);
2714 if (DIFF_OPT_TST(&sb
.revs
->diffopt
, ALLOW_TEXTCONV
) &&
2715 textconv_object(path
, o
->mode
, o
->blob_sha1
, 1, (char **) &sb
.final_buf
,
2716 &sb
.final_buf_size
))
2719 sb
.final_buf
= read_sha1_file(o
->blob_sha1
, &type
,
2720 &sb
.final_buf_size
);
2723 die("Cannot read blob %s for path %s",
2724 sha1_to_hex(o
->blob_sha1
),
2728 lno
= prepare_lines(&sb
);
2730 if (lno
&& !range_list
.nr
)
2731 string_list_append(&range_list
, xstrdup("1"));
2734 range_set_init(&ranges
, range_list
.nr
);
2735 for (range_i
= 0; range_i
< range_list
.nr
; ++range_i
) {
2737 if (parse_range_arg(range_list
.items
[range_i
].string
,
2738 nth_line_cb
, &sb
, lno
, anchor
,
2739 &bottom
, &top
, sb
.path
))
2741 if (lno
< top
|| ((lno
|| bottom
) && lno
< bottom
))
2742 die("file %s has only %lu lines", path
, lno
);
2748 range_set_append_unsafe(&ranges
, bottom
, top
);
2751 sort_and_merge_range_set(&ranges
);
2753 for (range_i
= ranges
.nr
; range_i
> 0; --range_i
) {
2754 const struct range
*r
= &ranges
.ranges
[range_i
- 1];
2755 long bottom
= r
->start
;
2757 struct blame_entry
*next
= ent
;
2758 ent
= xcalloc(1, sizeof(*ent
));
2760 ent
->num_lines
= top
- bottom
;
2762 ent
->s_lno
= bottom
;
2768 prio_queue_put(&sb
.commits
, o
->commit
);
2772 range_set_release(&ranges
);
2773 string_list_clear(&range_list
, 0);
2778 read_mailmap(&mailmap
, NULL
);
2783 assign_blame(&sb
, opt
);
2785 free(final_commit_name
);
2790 sb
.ent
= blame_sort(sb
.ent
, compare_blame_final
);
2794 if (!(output_option
& OUTPUT_PORCELAIN
))
2795 find_alignment(&sb
, &output_option
);
2797 output(&sb
, output_option
);
2798 free((void *)sb
.final_buf
);
2799 for (ent
= sb
.ent
; ent
; ) {
2800 struct blame_entry
*e
= ent
->next
;
2806 printf("num read blob: %d\n", num_read_blob
);
2807 printf("num get patch: %d\n", num_get_patch
);
2808 printf("num commits: %d\n", num_commits
);