4 * Copyright (c) 2006, 2014 by its authors
5 * See COPYING for licensing conditions
14 #include "tree-walk.h"
19 #include "xdiff-interface.h"
20 #include "cache-tree.h"
21 #include "string-list.h"
23 #include "mergesort.h"
24 #include "parse-options.h"
25 #include "prio-queue.h"
28 #include "line-range.h"
33 static char blame_usage[] = N_("git blame [<options>] [<rev-opts>] [<rev>] [--] <file>");
35 static const char *blame_opt_usage[] = {
38 N_("<rev-opts> are documented in git-rev-list(1)"),
42 static int longest_file;
43 static int longest_author;
44 static int max_orig_digits;
45 static int max_digits;
46 static int max_score_digits;
49 static int blank_boundary;
50 static int incremental;
52 static int abbrev = -1;
53 static int no_whole_file_rename;
54 static int show_progress;
56 static struct date_mode blame_date_mode = { DATE_ISO8601 };
57 static size_t blame_date_width;
59 static struct string_list mailmap;
66 static int num_read_blob;
67 static int num_get_patch;
68 static int num_commits;
70 #define PICKAXE_BLAME_MOVE 01
71 #define PICKAXE_BLAME_COPY 02
72 #define PICKAXE_BLAME_COPY_HARDER 04
73 #define PICKAXE_BLAME_COPY_HARDEST 010
76 * blame for a blame_entry with score lower than these thresholds
77 * is not passed to the parent using move/copy logic.
79 static unsigned blame_move_score;
80 static unsigned blame_copy_score;
81 #define BLAME_DEFAULT_MOVE_SCORE 20
82 #define BLAME_DEFAULT_COPY_SCORE 40
84 /* Remember to update object flag allocation in object.h */
85 #define METAINFO_SHOWN (1u<<12)
86 #define MORE_THAN_ONE_PATH (1u<<13)
89 * One blob in a commit that is being suspected
93 /* Record preceding blame record for this blob */
94 struct origin *previous;
95 /* origins are put in a list linked via `next' hanging off the
96 * corresponding commit's util field in order to make finding
97 * them fast. The presence in this chain does not count
98 * towards the origin's reference count. It is tempting to
99 * let it count as long as the commit is pending examination,
100 * but even under circumstances where the commit will be
101 * present multiple times in the priority queue of unexamined
102 * commits, processing the first instance will not leave any
103 * work requiring the origin data for the second instance. An
104 * interspersed commit changing that would have to be
105 * preexisting with a different ancestry and with the same
106 * commit date in order to wedge itself between two instances
107 * of the same commit in the priority queue _and_ produce
108 * blame entries relevant for it. While we don't want to let
109 * us get tripped up by this case, it certainly does not seem
110 * worth optimizing for.
113 struct commit *commit;
114 /* `suspects' contains blame entries that may be attributed to
115 * this origin's commit or to parent commits. When a commit
116 * is being processed, all suspects will be moved, either by
117 * assigning them to an origin in a different commit, or by
118 * shipping them to the scoreboard's ent list because they
119 * cannot be attributed to a different commit.
121 struct blame_entry *suspects;
123 unsigned char blob_sha1[20];
125 /* guilty gets set when shipping any suspects to the final
126 * blame list instead of other commits
129 char path[FLEX_ARRAY];
132 struct progress_info {
133 struct progress *progress;
137 static int diff_hunks(mmfile_t *file_a, mmfile_t *file_b,
138 xdl_emit_hunk_consume_func_t hunk_func, void *cb_data)
141 xdemitconf_t xecfg = {0};
142 xdemitcb_t ecb = {NULL};
144 xpp.flags = xdl_opts;
145 xecfg.hunk_func = hunk_func;
147 return xdi_diff(file_a, file_b, &xpp, &xecfg, &ecb);
151 * Prepare diff_filespec and convert it using diff textconv API
152 * if the textconv driver exists.
153 * Return 1 if the conversion succeeds, 0 otherwise.
155 int textconv_object(const char *path,
157 const unsigned char *sha1,
160 unsigned long *buf_size)
162 struct diff_filespec *df;
163 struct userdiff_driver *textconv;
165 df = alloc_filespec(path);
166 fill_filespec(df, sha1, sha1_valid, mode);
167 textconv = get_textconv(df);
173 *buf_size = fill_textconv(textconv, df, buf);
179 * Given an origin, prepare mmfile_t structure to be used by the
182 static void fill_origin_blob(struct diff_options *opt,
183 struct origin *o, mmfile_t *file)
186 enum object_type type;
187 unsigned long file_size;
190 if (DIFF_OPT_TST(opt, ALLOW_TEXTCONV) &&
191 textconv_object(o->path, o->mode, o->blob_sha1, 1, &file->ptr, &file_size))
194 file->ptr = read_sha1_file(o->blob_sha1, &type, &file_size);
195 file->size = file_size;
198 die("Cannot read blob %s for path %s",
199 sha1_to_hex(o->blob_sha1),
208 * Origin is refcounted and usually we keep the blob contents to be
211 static inline struct origin *origin_incref(struct origin *o)
218 static void origin_decref(struct origin *o)
220 if (o && --o->refcnt <= 0) {
221 struct origin *p, *l = NULL;
223 origin_decref(o->previous);
225 /* Should be present exactly once in commit chain */
226 for (p = o->commit->util; p; l = p, p = p->next) {
231 o->commit->util = p->next;
236 die("internal error in blame::origin_decref");
240 static void drop_origin_blob(struct origin *o)
249 * Each group of lines is described by a blame_entry; it can be split
250 * as we pass blame to the parents. They are arranged in linked lists
251 * kept as `suspects' of some unprocessed origin, or entered (when the
252 * blame origin has been finalized) into the scoreboard structure.
253 * While the scoreboard structure is only sorted at the end of
254 * processing (according to final image line number), the lists
255 * attached to an origin are sorted by the target line number.
258 struct blame_entry *next;
260 /* the first line of this group in the final image;
261 * internally all line numbers are 0 based.
265 /* how many lines this group has */
268 /* the commit that introduced this group into the final image */
269 struct origin *suspect;
271 /* the line number of the first line of this group in the
272 * suspect's file; internally all line numbers are 0 based.
276 /* how significant this entry is -- cached to avoid
277 * scanning the lines over and over.
283 * Any merge of blames happens on lists of blames that arrived via
284 * different parents in a single suspect. In this case, we want to
285 * sort according to the suspect line numbers as opposed to the final
286 * image line numbers. The function body is somewhat longish because
287 * it avoids unnecessary writes.
290 static struct blame_entry *blame_merge(struct blame_entry *list1,
291 struct blame_entry *list2)
293 struct blame_entry *p1 = list1, *p2 = list2,
301 if (p1->s_lno <= p2->s_lno) {
304 if ((p1 = *tail) == NULL) {
308 } while (p1->s_lno <= p2->s_lno);
314 if ((p2 = *tail) == NULL) {
318 } while (p1->s_lno > p2->s_lno);
322 if ((p1 = *tail) == NULL) {
326 } while (p1->s_lno <= p2->s_lno);
330 static void *get_next_blame(const void *p)
332 return ((struct blame_entry *)p)->next;
335 static void set_next_blame(void *p1, void *p2)
337 ((struct blame_entry *)p1)->next = p2;
341 * Final image line numbers are all different, so we don't need a
342 * three-way comparison here.
345 static int compare_blame_final(const void *p1, const void *p2)
347 return ((struct blame_entry *)p1)->lno > ((struct blame_entry *)p2)->lno
351 static int compare_blame_suspect(const void *p1, const void *p2)
353 const struct blame_entry *s1 = p1, *s2 = p2;
355 * to allow for collating suspects, we sort according to the
356 * respective pointer value as the primary sorting criterion.
357 * The actual relation is pretty unimportant as long as it
358 * establishes a total order. Comparing as integers gives us
361 if (s1->suspect != s2->suspect)
362 return (intptr_t)s1->suspect > (intptr_t)s2->suspect ? 1 : -1;
363 if (s1->s_lno == s2->s_lno)
365 return s1->s_lno > s2->s_lno ? 1 : -1;
368 static struct blame_entry *blame_sort(struct blame_entry *head,
369 int (*compare_fn)(const void *, const void *))
371 return llist_mergesort (head, get_next_blame, set_next_blame, compare_fn);
374 static int compare_commits_by_reverse_commit_date(const void *a,
378 return -compare_commits_by_commit_date(a, b, c);
382 * The current state of the blame assignment.
385 /* the final commit (i.e. where we started digging from) */
386 struct commit *final;
387 /* Priority queue for commits with unassigned blame records */
388 struct prio_queue commits;
389 struct rev_info *revs;
393 * The contents in the final image.
394 * Used by many functions to obtain contents of the nth line,
395 * indexed with scoreboard.lineno[blame_entry.lno].
397 const char *final_buf;
398 unsigned long final_buf_size;
400 /* linked list of blames */
401 struct blame_entry *ent;
403 /* look-up a line in the final buffer */
408 static void sanity_check_refcnt(struct scoreboard *);
411 * If two blame entries that are next to each other came from
412 * contiguous lines in the same origin (i.e. <commit, path> pair),
413 * merge them together.
415 static void coalesce(struct scoreboard *sb)
417 struct blame_entry *ent, *next;
419 for (ent = sb->ent; ent && (next = ent->next); ent = next) {
420 if (ent->suspect == next->suspect &&
421 ent->s_lno + ent->num_lines == next->s_lno) {
422 ent->num_lines += next->num_lines;
423 ent->next = next->next;
424 origin_decref(next->suspect);
427 next = ent; /* again */
431 if (DEBUG) /* sanity */
432 sanity_check_refcnt(sb);
436 * Merge the given sorted list of blames into a preexisting origin.
437 * If there were no previous blames to that commit, it is entered into
438 * the commit priority queue of the score board.
441 static void queue_blames(struct scoreboard *sb, struct origin *porigin,
442 struct blame_entry *sorted)
444 if (porigin->suspects)
445 porigin->suspects = blame_merge(porigin->suspects, sorted);
448 for (o = porigin->commit->util; o; o = o->next) {
450 porigin->suspects = sorted;
454 porigin->suspects = sorted;
455 prio_queue_put(&sb->commits, porigin->commit);
460 * Given a commit and a path in it, create a new origin structure.
461 * The callers that add blame to the scoreboard should use
462 * get_origin() to obtain shared, refcounted copy instead of calling
463 * this function directly.
465 static struct origin *make_origin(struct commit *commit, const char *path)
468 FLEX_ALLOC_STR(o, path, path);
471 o->next = commit->util;
477 * Locate an existing origin or create a new one.
478 * This moves the origin to front position in the commit util list.
480 static struct origin *get_origin(struct scoreboard *sb,
481 struct commit *commit,
484 struct origin *o, *l;
486 for (o = commit->util, l = NULL; o; l = o, o = o->next) {
487 if (!strcmp(o->path, path)) {
491 o->next = commit->util;
494 return origin_incref(o);
497 return make_origin(commit, path);
501 * Fill the blob_sha1 field of an origin if it hasn't, so that later
502 * call to fill_origin_blob() can use it to locate the data. blob_sha1
503 * for an origin is also used to pass the blame for the entire file to
504 * the parent to detect the case where a child's blob is identical to
505 * that of its parent's.
507 * This also fills origin->mode for corresponding tree path.
509 static int fill_blob_sha1_and_mode(struct origin *origin)
511 if (!is_null_sha1(origin->blob_sha1))
513 if (get_tree_entry(origin->commit->object.oid.hash,
515 origin->blob_sha1, &origin->mode))
517 if (sha1_object_info(origin->blob_sha1, NULL) != OBJ_BLOB)
521 hashclr(origin->blob_sha1);
522 origin->mode = S_IFINVALID;
527 * We have an origin -- check if the same path exists in the
528 * parent and return an origin structure to represent it.
530 static struct origin *find_origin(struct scoreboard *sb,
531 struct commit *parent,
532 struct origin *origin)
534 struct origin *porigin;
535 struct diff_options diff_opts;
536 const char *paths[2];
538 /* First check any existing origins */
539 for (porigin = parent->util; porigin; porigin = porigin->next)
540 if (!strcmp(porigin->path, origin->path)) {
542 * The same path between origin and its parent
543 * without renaming -- the most common case.
545 return origin_incref (porigin);
548 /* See if the origin->path is different between parent
549 * and origin first. Most of the time they are the
550 * same and diff-tree is fairly efficient about this.
552 diff_setup(&diff_opts);
553 DIFF_OPT_SET(&diff_opts, RECURSIVE);
554 diff_opts.detect_rename = 0;
555 diff_opts.output_format = DIFF_FORMAT_NO_OUTPUT;
556 paths[0] = origin->path;
559 parse_pathspec(&diff_opts.pathspec,
560 PATHSPEC_ALL_MAGIC & ~PATHSPEC_LITERAL,
561 PATHSPEC_LITERAL_PATH, "", paths);
562 diff_setup_done(&diff_opts);
564 if (is_null_oid(&origin->commit->object.oid))
565 do_diff_cache(parent->tree->object.oid.hash, &diff_opts);
567 diff_tree_sha1(parent->tree->object.oid.hash,
568 origin->commit->tree->object.oid.hash,
570 diffcore_std(&diff_opts);
572 if (!diff_queued_diff.nr) {
573 /* The path is the same as parent */
574 porigin = get_origin(sb, parent, origin->path);
575 hashcpy(porigin->blob_sha1, origin->blob_sha1);
576 porigin->mode = origin->mode;
579 * Since origin->path is a pathspec, if the parent
580 * commit had it as a directory, we will see a whole
581 * bunch of deletion of files in the directory that we
585 struct diff_filepair *p = NULL;
586 for (i = 0; i < diff_queued_diff.nr; i++) {
588 p = diff_queued_diff.queue[i];
589 name = p->one->path ? p->one->path : p->two->path;
590 if (!strcmp(name, origin->path))
594 die("internal error in blame::find_origin");
597 die("internal error in blame::find_origin (%c)",
600 porigin = get_origin(sb, parent, origin->path);
601 hashcpy(porigin->blob_sha1, p->one->sha1);
602 porigin->mode = p->one->mode;
606 /* Did not exist in parent, or type changed */
610 diff_flush(&diff_opts);
611 free_pathspec(&diff_opts.pathspec);
616 * We have an origin -- find the path that corresponds to it in its
617 * parent and return an origin structure to represent it.
619 static struct origin *find_rename(struct scoreboard *sb,
620 struct commit *parent,
621 struct origin *origin)
623 struct origin *porigin = NULL;
624 struct diff_options diff_opts;
627 diff_setup(&diff_opts);
628 DIFF_OPT_SET(&diff_opts, RECURSIVE);
629 diff_opts.detect_rename = DIFF_DETECT_RENAME;
630 diff_opts.output_format = DIFF_FORMAT_NO_OUTPUT;
631 diff_opts.single_follow = origin->path;
632 diff_setup_done(&diff_opts);
634 if (is_null_oid(&origin->commit->object.oid))
635 do_diff_cache(parent->tree->object.oid.hash, &diff_opts);
637 diff_tree_sha1(parent->tree->object.oid.hash,
638 origin->commit->tree->object.oid.hash,
640 diffcore_std(&diff_opts);
642 for (i = 0; i < diff_queued_diff.nr; i++) {
643 struct diff_filepair *p = diff_queued_diff.queue[i];
644 if ((p->status == 'R' || p->status == 'C') &&
645 !strcmp(p->two->path, origin->path)) {
646 porigin = get_origin(sb, parent, p->one->path);
647 hashcpy(porigin->blob_sha1, p->one->sha1);
648 porigin->mode = p->one->mode;
652 diff_flush(&diff_opts);
653 free_pathspec(&diff_opts.pathspec);
658 * Append a new blame entry to a given output queue.
660 static void add_blame_entry(struct blame_entry ***queue, struct blame_entry *e)
662 origin_incref(e->suspect);
670 * src typically is on-stack; we want to copy the information in it to
671 * a malloced blame_entry that gets added to the given queue. The
672 * origin of dst loses a refcnt.
674 static void dup_entry(struct blame_entry ***queue,
675 struct blame_entry *dst, struct blame_entry *src)
677 origin_incref(src->suspect);
678 origin_decref(dst->suspect);
679 memcpy(dst, src, sizeof(*src));
685 static const char *nth_line(struct scoreboard *sb, long lno)
687 return sb->final_buf + sb->lineno[lno];
690 static const char *nth_line_cb(void *data, long lno)
692 return nth_line((struct scoreboard *)data, lno);
696 * It is known that lines between tlno to same came from parent, and e
697 * has an overlap with that range. it also is known that parent's
698 * line plno corresponds to e's line tlno.
704 * <------------------>
706 * Split e into potentially three parts; before this chunk, the chunk
707 * to be blamed for the parent, and after that portion.
709 static void split_overlap(struct blame_entry *split,
710 struct blame_entry *e,
711 int tlno, int plno, int same,
712 struct origin *parent)
715 memset(split, 0, sizeof(struct blame_entry [3]));
717 if (e->s_lno < tlno) {
718 /* there is a pre-chunk part not blamed on parent */
719 split[0].suspect = origin_incref(e->suspect);
720 split[0].lno = e->lno;
721 split[0].s_lno = e->s_lno;
722 split[0].num_lines = tlno - e->s_lno;
723 split[1].lno = e->lno + tlno - e->s_lno;
724 split[1].s_lno = plno;
727 split[1].lno = e->lno;
728 split[1].s_lno = plno + (e->s_lno - tlno);
731 if (same < e->s_lno + e->num_lines) {
732 /* there is a post-chunk part not blamed on parent */
733 split[2].suspect = origin_incref(e->suspect);
734 split[2].lno = e->lno + (same - e->s_lno);
735 split[2].s_lno = e->s_lno + (same - e->s_lno);
736 split[2].num_lines = e->s_lno + e->num_lines - same;
737 chunk_end_lno = split[2].lno;
740 chunk_end_lno = e->lno + e->num_lines;
741 split[1].num_lines = chunk_end_lno - split[1].lno;
744 * if it turns out there is nothing to blame the parent for,
745 * forget about the splitting. !split[1].suspect signals this.
747 if (split[1].num_lines < 1)
749 split[1].suspect = origin_incref(parent);
753 * split_overlap() divided an existing blame e into up to three parts
754 * in split. Any assigned blame is moved to queue to
757 static void split_blame(struct blame_entry ***blamed,
758 struct blame_entry ***unblamed,
759 struct blame_entry *split,
760 struct blame_entry *e)
762 struct blame_entry *new_entry;
764 if (split[0].suspect && split[2].suspect) {
765 /* The first part (reuse storage for the existing entry e) */
766 dup_entry(unblamed, e, &split[0]);
768 /* The last part -- me */
769 new_entry = xmalloc(sizeof(*new_entry));
770 memcpy(new_entry, &(split[2]), sizeof(struct blame_entry));
771 add_blame_entry(unblamed, new_entry);
773 /* ... and the middle part -- parent */
774 new_entry = xmalloc(sizeof(*new_entry));
775 memcpy(new_entry, &(split[1]), sizeof(struct blame_entry));
776 add_blame_entry(blamed, new_entry);
778 else if (!split[0].suspect && !split[2].suspect)
780 * The parent covers the entire area; reuse storage for
781 * e and replace it with the parent.
783 dup_entry(blamed, e, &split[1]);
784 else if (split[0].suspect) {
785 /* me and then parent */
786 dup_entry(unblamed, e, &split[0]);
788 new_entry = xmalloc(sizeof(*new_entry));
789 memcpy(new_entry, &(split[1]), sizeof(struct blame_entry));
790 add_blame_entry(blamed, new_entry);
793 /* parent and then me */
794 dup_entry(blamed, e, &split[1]);
796 new_entry = xmalloc(sizeof(*new_entry));
797 memcpy(new_entry, &(split[2]), sizeof(struct blame_entry));
798 add_blame_entry(unblamed, new_entry);
803 * After splitting the blame, the origins used by the
804 * on-stack blame_entry should lose one refcnt each.
806 static void decref_split(struct blame_entry *split)
810 for (i = 0; i < 3; i++)
811 origin_decref(split[i].suspect);
815 * reverse_blame reverses the list given in head, appending tail.
816 * That allows us to build lists in reverse order, then reverse them
817 * afterwards. This can be faster than building the list in proper
818 * order right away. The reason is that building in proper order
819 * requires writing a link in the _previous_ element, while building
820 * in reverse order just requires placing the list head into the
824 static struct blame_entry *reverse_blame(struct blame_entry *head,
825 struct blame_entry *tail)
828 struct blame_entry *next = head->next;
837 * Process one hunk from the patch between the current suspect for
838 * blame_entry e and its parent. This first blames any unfinished
839 * entries before the chunk (which is where target and parent start
840 * differing) on the parent, and then splits blame entries at the
841 * start and at the end of the difference region. Since use of -M and
842 * -C options may lead to overlapping/duplicate source line number
843 * ranges, all we can rely on from sorting/merging is the order of the
844 * first suspect line number.
846 static void blame_chunk(struct blame_entry ***dstq, struct blame_entry ***srcq,
847 int tlno, int offset, int same,
848 struct origin *parent)
850 struct blame_entry *e = **srcq;
851 struct blame_entry *samep = NULL, *diffp = NULL;
853 while (e && e->s_lno < tlno) {
854 struct blame_entry *next = e->next;
856 * current record starts before differing portion. If
857 * it reaches into it, we need to split it up and
858 * examine the second part separately.
860 if (e->s_lno + e->num_lines > tlno) {
861 /* Move second half to a new record */
862 int len = tlno - e->s_lno;
863 struct blame_entry *n = xcalloc(1, sizeof (struct blame_entry));
864 n->suspect = e->suspect;
865 n->lno = e->lno + len;
866 n->s_lno = e->s_lno + len;
867 n->num_lines = e->num_lines - len;
870 /* Push new record to diffp */
874 origin_decref(e->suspect);
875 /* Pass blame for everything before the differing
876 * chunk to the parent */
877 e->suspect = origin_incref(parent);
884 * As we don't know how much of a common stretch after this
885 * diff will occur, the currently blamed parts are all that we
886 * can assign to the parent for now.
890 **dstq = reverse_blame(samep, **dstq);
891 *dstq = &samep->next;
894 * Prepend the split off portions: everything after e starts
895 * after the blameable portion.
897 e = reverse_blame(diffp, e);
900 * Now retain records on the target while parts are different
905 while (e && e->s_lno < same) {
906 struct blame_entry *next = e->next;
909 * If current record extends into sameness, need to split.
911 if (e->s_lno + e->num_lines > same) {
913 * Move second half to a new record to be
914 * processed by later chunks
916 int len = same - e->s_lno;
917 struct blame_entry *n = xcalloc(1, sizeof (struct blame_entry));
918 n->suspect = origin_incref(e->suspect);
919 n->lno = e->lno + len;
920 n->s_lno = e->s_lno + len;
921 n->num_lines = e->num_lines - len;
924 /* Push new record to samep */
932 **srcq = reverse_blame(diffp, reverse_blame(samep, e));
933 /* Move across elements that are in the unblamable portion */
935 *srcq = &diffp->next;
938 struct blame_chunk_cb_data {
939 struct origin *parent;
941 struct blame_entry **dstq;
942 struct blame_entry **srcq;
945 /* diff chunks are from parent to target */
946 static int blame_chunk_cb(long start_a, long count_a,
947 long start_b, long count_b, void *data)
949 struct blame_chunk_cb_data *d = data;
950 if (start_a - start_b != d->offset)
951 die("internal error in blame::blame_chunk_cb");
952 blame_chunk(&d->dstq, &d->srcq, start_b, start_a - start_b,
953 start_b + count_b, d->parent);
954 d->offset = start_a + count_a - (start_b + count_b);
959 * We are looking at the origin 'target' and aiming to pass blame
960 * for the lines it is suspected to its parent. Run diff to find
961 * which lines came from parent and pass blame for them.
963 static void pass_blame_to_parent(struct scoreboard *sb,
964 struct origin *target,
965 struct origin *parent)
967 mmfile_t file_p, file_o;
968 struct blame_chunk_cb_data d;
969 struct blame_entry *newdest = NULL;
971 if (!target->suspects)
972 return; /* nothing remains for this target */
976 d.dstq = &newdest; d.srcq = &target->suspects;
978 fill_origin_blob(&sb->revs->diffopt, parent, &file_p);
979 fill_origin_blob(&sb->revs->diffopt, target, &file_o);
982 if (diff_hunks(&file_p, &file_o, blame_chunk_cb, &d))
983 die("unable to generate diff (%s -> %s)",
984 oid_to_hex(&parent->commit->object.oid),
985 oid_to_hex(&target->commit->object.oid));
986 /* The rest are the same as the parent */
987 blame_chunk(&d.dstq, &d.srcq, INT_MAX, d.offset, INT_MAX, parent);
989 queue_blames(sb, parent, newdest);
995 * The lines in blame_entry after splitting blames many times can become
996 * very small and trivial, and at some point it becomes pointless to
997 * blame the parents. E.g. "\t\t}\n\t}\n\n" appears everywhere in any
998 * ordinary C program, and it is not worth to say it was copied from
999 * totally unrelated file in the parent.
1001 * Compute how trivial the lines in the blame_entry are.
1003 static unsigned ent_score(struct scoreboard *sb, struct blame_entry *e)
1006 const char *cp, *ep;
1012 cp = nth_line(sb, e->lno);
1013 ep = nth_line(sb, e->lno + e->num_lines);
1015 unsigned ch = *((unsigned char *)cp);
1025 * best_so_far[] and this[] are both a split of an existing blame_entry
1026 * that passes blame to the parent. Maintain best_so_far the best split
1027 * so far, by comparing this and best_so_far and copying this into
1028 * bst_so_far as needed.
1030 static void copy_split_if_better(struct scoreboard *sb,
1031 struct blame_entry *best_so_far,
1032 struct blame_entry *this)
1036 if (!this[1].suspect)
1038 if (best_so_far[1].suspect) {
1039 if (ent_score(sb, &this[1]) < ent_score(sb, &best_so_far[1]))
1043 for (i = 0; i < 3; i++)
1044 origin_incref(this[i].suspect);
1045 decref_split(best_so_far);
1046 memcpy(best_so_far, this, sizeof(struct blame_entry [3]));
1050 * We are looking at a part of the final image represented by
1051 * ent (tlno and same are offset by ent->s_lno).
1052 * tlno is where we are looking at in the final image.
1053 * up to (but not including) same match preimage.
1054 * plno is where we are looking at in the preimage.
1056 * <-------------- final image ---------------------->
1059 * <---------preimage----->
1062 * All line numbers are 0-based.
1064 static void handle_split(struct scoreboard *sb,
1065 struct blame_entry *ent,
1066 int tlno, int plno, int same,
1067 struct origin *parent,
1068 struct blame_entry *split)
1070 if (ent->num_lines <= tlno)
1073 struct blame_entry this[3];
1076 split_overlap(this, ent, tlno, plno, same, parent);
1077 copy_split_if_better(sb, split, this);
1082 struct handle_split_cb_data {
1083 struct scoreboard *sb;
1084 struct blame_entry *ent;
1085 struct origin *parent;
1086 struct blame_entry *split;
1091 static int handle_split_cb(long start_a, long count_a,
1092 long start_b, long count_b, void *data)
1094 struct handle_split_cb_data *d = data;
1095 handle_split(d->sb, d->ent, d->tlno, d->plno, start_b, d->parent,
1097 d->plno = start_a + count_a;
1098 d->tlno = start_b + count_b;
1103 * Find the lines from parent that are the same as ent so that
1104 * we can pass blames to it. file_p has the blob contents for
1107 static void find_copy_in_blob(struct scoreboard *sb,
1108 struct blame_entry *ent,
1109 struct origin *parent,
1110 struct blame_entry *split,
1115 struct handle_split_cb_data d;
1117 memset(&d, 0, sizeof(d));
1118 d.sb = sb; d.ent = ent; d.parent = parent; d.split = split;
1120 * Prepare mmfile that contains only the lines in ent.
1122 cp = nth_line(sb, ent->lno);
1123 file_o.ptr = (char *) cp;
1124 file_o.size = nth_line(sb, ent->lno + ent->num_lines) - cp;
1127 * file_o is a part of final image we are annotating.
1128 * file_p partially may match that image.
1130 memset(split, 0, sizeof(struct blame_entry [3]));
1131 if (diff_hunks(file_p, &file_o, handle_split_cb, &d))
1132 die("unable to generate diff (%s)",
1133 oid_to_hex(&parent->commit->object.oid));
1134 /* remainder, if any, all match the preimage */
1135 handle_split(sb, ent, d.tlno, d.plno, ent->num_lines, parent, split);
1138 /* Move all blame entries from list *source that have a score smaller
1139 * than score_min to the front of list *small.
1140 * Returns a pointer to the link pointing to the old head of the small list.
1143 static struct blame_entry **filter_small(struct scoreboard *sb,
1144 struct blame_entry **small,
1145 struct blame_entry **source,
1148 struct blame_entry *p = *source;
1149 struct blame_entry *oldsmall = *small;
1151 if (ent_score(sb, p) <= score_min) {
1167 * See if lines currently target is suspected for can be attributed to
1170 static void find_move_in_parent(struct scoreboard *sb,
1171 struct blame_entry ***blamed,
1172 struct blame_entry **toosmall,
1173 struct origin *target,
1174 struct origin *parent)
1176 struct blame_entry *e, split[3];
1177 struct blame_entry *unblamed = target->suspects;
1178 struct blame_entry *leftover = NULL;
1182 return; /* nothing remains for this target */
1184 fill_origin_blob(&sb->revs->diffopt, parent, &file_p);
1188 /* At each iteration, unblamed has a NULL-terminated list of
1189 * entries that have not yet been tested for blame. leftover
1190 * contains the reversed list of entries that have been tested
1191 * without being assignable to the parent.
1194 struct blame_entry **unblamedtail = &unblamed;
1195 struct blame_entry *next;
1196 for (e = unblamed; e; e = next) {
1198 find_copy_in_blob(sb, e, parent, split, &file_p);
1199 if (split[1].suspect &&
1200 blame_move_score < ent_score(sb, &split[1])) {
1201 split_blame(blamed, &unblamedtail, split, e);
1206 decref_split(split);
1208 *unblamedtail = NULL;
1209 toosmall = filter_small(sb, toosmall, &unblamed, blame_move_score);
1211 target->suspects = reverse_blame(leftover, NULL);
1215 struct blame_entry *ent;
1216 struct blame_entry split[3];
1220 * Count the number of entries the target is suspected for,
1221 * and prepare a list of entry and the best split.
1223 static struct blame_list *setup_blame_list(struct blame_entry *unblamed,
1226 struct blame_entry *e;
1228 struct blame_list *blame_list = NULL;
1230 for (e = unblamed, num_ents = 0; e; e = e->next)
1233 blame_list = xcalloc(num_ents, sizeof(struct blame_list));
1234 for (e = unblamed, i = 0; e; e = e->next)
1235 blame_list[i++].ent = e;
1237 *num_ents_p = num_ents;
1242 * For lines target is suspected for, see if we can find code movement
1243 * across file boundary from the parent commit. porigin is the path
1244 * in the parent we already tried.
1246 static void find_copy_in_parent(struct scoreboard *sb,
1247 struct blame_entry ***blamed,
1248 struct blame_entry **toosmall,
1249 struct origin *target,
1250 struct commit *parent,
1251 struct origin *porigin,
1254 struct diff_options diff_opts;
1256 struct blame_list *blame_list;
1258 struct blame_entry *unblamed = target->suspects;
1259 struct blame_entry *leftover = NULL;
1262 return; /* nothing remains for this target */
1264 diff_setup(&diff_opts);
1265 DIFF_OPT_SET(&diff_opts, RECURSIVE);
1266 diff_opts.output_format = DIFF_FORMAT_NO_OUTPUT;
1268 diff_setup_done(&diff_opts);
1270 /* Try "find copies harder" on new path if requested;
1271 * we do not want to use diffcore_rename() actually to
1272 * match things up; find_copies_harder is set only to
1273 * force diff_tree_sha1() to feed all filepairs to diff_queue,
1274 * and this code needs to be after diff_setup_done(), which
1275 * usually makes find-copies-harder imply copy detection.
1277 if ((opt & PICKAXE_BLAME_COPY_HARDEST)
1278 || ((opt & PICKAXE_BLAME_COPY_HARDER)
1279 && (!porigin || strcmp(target->path, porigin->path))))
1280 DIFF_OPT_SET(&diff_opts, FIND_COPIES_HARDER);
1282 if (is_null_oid(&target->commit->object.oid))
1283 do_diff_cache(parent->tree->object.oid.hash, &diff_opts);
1285 diff_tree_sha1(parent->tree->object.oid.hash,
1286 target->commit->tree->object.oid.hash,
1289 if (!DIFF_OPT_TST(&diff_opts, FIND_COPIES_HARDER))
1290 diffcore_std(&diff_opts);
1293 struct blame_entry **unblamedtail = &unblamed;
1294 blame_list = setup_blame_list(unblamed, &num_ents);
1296 for (i = 0; i < diff_queued_diff.nr; i++) {
1297 struct diff_filepair *p = diff_queued_diff.queue[i];
1298 struct origin *norigin;
1300 struct blame_entry this[3];
1302 if (!DIFF_FILE_VALID(p->one))
1303 continue; /* does not exist in parent */
1304 if (S_ISGITLINK(p->one->mode))
1305 continue; /* ignore git links */
1306 if (porigin && !strcmp(p->one->path, porigin->path))
1307 /* find_move already dealt with this path */
1310 norigin = get_origin(sb, parent, p->one->path);
1311 hashcpy(norigin->blob_sha1, p->one->sha1);
1312 norigin->mode = p->one->mode;
1313 fill_origin_blob(&sb->revs->diffopt, norigin, &file_p);
1317 for (j = 0; j < num_ents; j++) {
1318 find_copy_in_blob(sb, blame_list[j].ent,
1319 norigin, this, &file_p);
1320 copy_split_if_better(sb, blame_list[j].split,
1324 origin_decref(norigin);
1327 for (j = 0; j < num_ents; j++) {
1328 struct blame_entry *split = blame_list[j].split;
1329 if (split[1].suspect &&
1330 blame_copy_score < ent_score(sb, &split[1])) {
1331 split_blame(blamed, &unblamedtail, split,
1334 blame_list[j].ent->next = leftover;
1335 leftover = blame_list[j].ent;
1337 decref_split(split);
1340 *unblamedtail = NULL;
1341 toosmall = filter_small(sb, toosmall, &unblamed, blame_copy_score);
1343 target->suspects = reverse_blame(leftover, NULL);
1344 diff_flush(&diff_opts);
1345 free_pathspec(&diff_opts.pathspec);
1349 * The blobs of origin and porigin exactly match, so everything
1350 * origin is suspected for can be blamed on the parent.
1352 static void pass_whole_blame(struct scoreboard *sb,
1353 struct origin *origin, struct origin *porigin)
1355 struct blame_entry *e, *suspects;
1357 if (!porigin->file.ptr && origin->file.ptr) {
1358 /* Steal its file */
1359 porigin->file = origin->file;
1360 origin->file.ptr = NULL;
1362 suspects = origin->suspects;
1363 origin->suspects = NULL;
1364 for (e = suspects; e; e = e->next) {
1365 origin_incref(porigin);
1366 origin_decref(e->suspect);
1367 e->suspect = porigin;
1369 queue_blames(sb, porigin, suspects);
1373 * We pass blame from the current commit to its parents. We keep saying
1374 * "parent" (and "porigin"), but what we mean is to find scapegoat to
1375 * exonerate ourselves.
1377 static struct commit_list *first_scapegoat(struct rev_info *revs, struct commit *commit)
1380 if (revs->first_parent_only &&
1382 commit->parents->next) {
1383 free_commit_list(commit->parents->next);
1384 commit->parents->next = NULL;
1386 return commit->parents;
1388 return lookup_decoration(&revs->children, &commit->object);
1391 static int num_scapegoats(struct rev_info *revs, struct commit *commit)
1393 struct commit_list *l = first_scapegoat(revs, commit);
1394 return commit_list_count(l);
1397 /* Distribute collected unsorted blames to the respected sorted lists
1398 * in the various origins.
1400 static void distribute_blame(struct scoreboard *sb, struct blame_entry *blamed)
1402 blamed = blame_sort(blamed, compare_blame_suspect);
1405 struct origin *porigin = blamed->suspect;
1406 struct blame_entry *suspects = NULL;
1408 struct blame_entry *next = blamed->next;
1409 blamed->next = suspects;
1412 } while (blamed && blamed->suspect == porigin);
1413 suspects = reverse_blame(suspects, NULL);
1414 queue_blames(sb, porigin, suspects);
1420 static void pass_blame(struct scoreboard *sb, struct origin *origin, int opt)
1422 struct rev_info *revs = sb->revs;
1423 int i, pass, num_sg;
1424 struct commit *commit = origin->commit;
1425 struct commit_list *sg;
1426 struct origin *sg_buf[MAXSG];
1427 struct origin *porigin, **sg_origin = sg_buf;
1428 struct blame_entry *toosmall = NULL;
1429 struct blame_entry *blames, **blametail = &blames;
1431 num_sg = num_scapegoats(revs, commit);
1434 else if (num_sg < ARRAY_SIZE(sg_buf))
1435 memset(sg_buf, 0, sizeof(sg_buf));
1437 sg_origin = xcalloc(num_sg, sizeof(*sg_origin));
1440 * The first pass looks for unrenamed path to optimize for
1441 * common cases, then we look for renames in the second pass.
1443 for (pass = 0; pass < 2 - no_whole_file_rename; pass++) {
1444 struct origin *(*find)(struct scoreboard *,
1445 struct commit *, struct origin *);
1446 find = pass ? find_rename : find_origin;
1448 for (i = 0, sg = first_scapegoat(revs, commit);
1450 sg = sg->next, i++) {
1451 struct commit *p = sg->item;
1456 if (parse_commit(p))
1458 porigin = find(sb, p, origin);
1461 if (!hashcmp(porigin->blob_sha1, origin->blob_sha1)) {
1462 pass_whole_blame(sb, origin, porigin);
1463 origin_decref(porigin);
1466 for (j = same = 0; j < i; j++)
1468 !hashcmp(sg_origin[j]->blob_sha1,
1469 porigin->blob_sha1)) {
1474 sg_origin[i] = porigin;
1476 origin_decref(porigin);
1481 for (i = 0, sg = first_scapegoat(revs, commit);
1483 sg = sg->next, i++) {
1484 struct origin *porigin = sg_origin[i];
1487 if (!origin->previous) {
1488 origin_incref(porigin);
1489 origin->previous = porigin;
1491 pass_blame_to_parent(sb, origin, porigin);
1492 if (!origin->suspects)
1497 * Optionally find moves in parents' files.
1499 if (opt & PICKAXE_BLAME_MOVE) {
1500 filter_small(sb, &toosmall, &origin->suspects, blame_move_score);
1501 if (origin->suspects) {
1502 for (i = 0, sg = first_scapegoat(revs, commit);
1504 sg = sg->next, i++) {
1505 struct origin *porigin = sg_origin[i];
1508 find_move_in_parent(sb, &blametail, &toosmall, origin, porigin);
1509 if (!origin->suspects)
1516 * Optionally find copies from parents' files.
1518 if (opt & PICKAXE_BLAME_COPY) {
1519 if (blame_copy_score > blame_move_score)
1520 filter_small(sb, &toosmall, &origin->suspects, blame_copy_score);
1521 else if (blame_copy_score < blame_move_score) {
1522 origin->suspects = blame_merge(origin->suspects, toosmall);
1524 filter_small(sb, &toosmall, &origin->suspects, blame_copy_score);
1526 if (!origin->suspects)
1529 for (i = 0, sg = first_scapegoat(revs, commit);
1531 sg = sg->next, i++) {
1532 struct origin *porigin = sg_origin[i];
1533 find_copy_in_parent(sb, &blametail, &toosmall,
1534 origin, sg->item, porigin, opt);
1535 if (!origin->suspects)
1542 distribute_blame(sb, blames);
1544 * prepend toosmall to origin->suspects
1546 * There is no point in sorting: this ends up on a big
1547 * unsorted list in the caller anyway.
1550 struct blame_entry **tail = &toosmall;
1552 tail = &(*tail)->next;
1553 *tail = origin->suspects;
1554 origin->suspects = toosmall;
1556 for (i = 0; i < num_sg; i++) {
1558 drop_origin_blob(sg_origin[i]);
1559 origin_decref(sg_origin[i]);
1562 drop_origin_blob(origin);
1563 if (sg_buf != sg_origin)
1568 * Information on commits, used for output.
1570 struct commit_info {
1571 struct strbuf author;
1572 struct strbuf author_mail;
1573 unsigned long author_time;
1574 struct strbuf author_tz;
1576 /* filled only when asked for details */
1577 struct strbuf committer;
1578 struct strbuf committer_mail;
1579 unsigned long committer_time;
1580 struct strbuf committer_tz;
1582 struct strbuf summary;
1586 * Parse author/committer line in the commit object buffer
1588 static void get_ac_line(const char *inbuf, const char *what,
1589 struct strbuf *name, struct strbuf *mail,
1590 unsigned long *time, struct strbuf *tz)
1592 struct ident_split ident;
1593 size_t len, maillen, namelen;
1595 const char *namebuf, *mailbuf;
1597 tmp = strstr(inbuf, what);
1600 tmp += strlen(what);
1601 endp = strchr(tmp, '\n');
1607 if (split_ident_line(&ident, tmp, len)) {
1611 strbuf_addstr(name, tmp);
1612 strbuf_addstr(mail, tmp);
1613 strbuf_addstr(tz, tmp);
1618 namelen = ident.name_end - ident.name_begin;
1619 namebuf = ident.name_begin;
1621 maillen = ident.mail_end - ident.mail_begin;
1622 mailbuf = ident.mail_begin;
1624 if (ident.date_begin && ident.date_end)
1625 *time = strtoul(ident.date_begin, NULL, 10);
1629 if (ident.tz_begin && ident.tz_end)
1630 strbuf_add(tz, ident.tz_begin, ident.tz_end - ident.tz_begin);
1632 strbuf_addstr(tz, "(unknown)");
1635 * Now, convert both name and e-mail using mailmap
1637 map_user(&mailmap, &mailbuf, &maillen,
1638 &namebuf, &namelen);
1640 strbuf_addf(mail, "<%.*s>", (int)maillen, mailbuf);
1641 strbuf_add(name, namebuf, namelen);
1644 static void commit_info_init(struct commit_info *ci)
1647 strbuf_init(&ci->author, 0);
1648 strbuf_init(&ci->author_mail, 0);
1649 strbuf_init(&ci->author_tz, 0);
1650 strbuf_init(&ci->committer, 0);
1651 strbuf_init(&ci->committer_mail, 0);
1652 strbuf_init(&ci->committer_tz, 0);
1653 strbuf_init(&ci->summary, 0);
1656 static void commit_info_destroy(struct commit_info *ci)
1659 strbuf_release(&ci->author);
1660 strbuf_release(&ci->author_mail);
1661 strbuf_release(&ci->author_tz);
1662 strbuf_release(&ci->committer);
1663 strbuf_release(&ci->committer_mail);
1664 strbuf_release(&ci->committer_tz);
1665 strbuf_release(&ci->summary);
1668 static void get_commit_info(struct commit *commit,
1669 struct commit_info *ret,
1673 const char *subject, *encoding;
1674 const char *message;
1676 commit_info_init(ret);
1678 encoding = get_log_output_encoding();
1679 message = logmsg_reencode(commit, NULL, encoding);
1680 get_ac_line(message, "\nauthor ",
1681 &ret->author, &ret->author_mail,
1682 &ret->author_time, &ret->author_tz);
1685 unuse_commit_buffer(commit, message);
1689 get_ac_line(message, "\ncommitter ",
1690 &ret->committer, &ret->committer_mail,
1691 &ret->committer_time, &ret->committer_tz);
1693 len = find_commit_subject(message, &subject);
1695 strbuf_add(&ret->summary, subject, len);
1697 strbuf_addf(&ret->summary, "(%s)", oid_to_hex(&commit->object.oid));
1699 unuse_commit_buffer(commit, message);
1703 * To allow LF and other nonportable characters in pathnames,
1704 * they are c-style quoted as needed.
1706 static void write_filename_info(const char *path)
1708 printf("filename ");
1709 write_name_quoted(path, stdout, '\n');
1713 * Porcelain/Incremental format wants to show a lot of details per
1714 * commit. Instead of repeating this every line, emit it only once,
1715 * the first time each commit appears in the output (unless the
1716 * user has specifically asked for us to repeat).
1718 static int emit_one_suspect_detail(struct origin *suspect, int repeat)
1720 struct commit_info ci;
1722 if (!repeat && (suspect->commit->object.flags & METAINFO_SHOWN))
1725 suspect->commit->object.flags |= METAINFO_SHOWN;
1726 get_commit_info(suspect->commit, &ci, 1);
1727 printf("author %s\n", ci.author.buf);
1728 printf("author-mail %s\n", ci.author_mail.buf);
1729 printf("author-time %lu\n", ci.author_time);
1730 printf("author-tz %s\n", ci.author_tz.buf);
1731 printf("committer %s\n", ci.committer.buf);
1732 printf("committer-mail %s\n", ci.committer_mail.buf);
1733 printf("committer-time %lu\n", ci.committer_time);
1734 printf("committer-tz %s\n", ci.committer_tz.buf);
1735 printf("summary %s\n", ci.summary.buf);
1736 if (suspect->commit->object.flags & UNINTERESTING)
1737 printf("boundary\n");
1738 if (suspect->previous) {
1739 struct origin *prev = suspect->previous;
1740 printf("previous %s ", oid_to_hex(&prev->commit->object.oid));
1741 write_name_quoted(prev->path, stdout, '\n');
1744 commit_info_destroy(&ci);
1750 * The blame_entry is found to be guilty for the range.
1751 * Show it in incremental output.
1753 static void found_guilty_entry(struct blame_entry *ent,
1754 struct progress_info *pi)
1757 struct origin *suspect = ent->suspect;
1759 printf("%s %d %d %d\n",
1760 oid_to_hex(&suspect->commit->object.oid),
1761 ent->s_lno + 1, ent->lno + 1, ent->num_lines);
1762 emit_one_suspect_detail(suspect, 0);
1763 write_filename_info(suspect->path);
1764 maybe_flush_or_die(stdout, "stdout");
1766 pi->blamed_lines += ent->num_lines;
1767 display_progress(pi->progress, pi->blamed_lines);
1771 * The main loop -- while we have blobs with lines whose true origin
1772 * is still unknown, pick one blob, and allow its lines to pass blames
1773 * to its parents. */
1774 static void assign_blame(struct scoreboard *sb, int opt)
1776 struct rev_info *revs = sb->revs;
1777 struct commit *commit = prio_queue_get(&sb->commits);
1778 struct progress_info pi = { NULL, 0 };
1781 pi.progress = start_progress_delay(_("Blaming lines"),
1782 sb->num_lines, 50, 1);
1785 struct blame_entry *ent;
1786 struct origin *suspect = commit->util;
1788 /* find one suspect to break down */
1789 while (suspect && !suspect->suspects)
1790 suspect = suspect->next;
1793 commit = prio_queue_get(&sb->commits);
1797 assert(commit == suspect->commit);
1800 * We will use this suspect later in the loop,
1801 * so hold onto it in the meantime.
1803 origin_incref(suspect);
1804 parse_commit(commit);
1806 (!(commit->object.flags & UNINTERESTING) &&
1807 !(revs->max_age != -1 && commit->date < revs->max_age)))
1808 pass_blame(sb, suspect, opt);
1810 commit->object.flags |= UNINTERESTING;
1811 if (commit->object.parsed)
1812 mark_parents_uninteresting(commit);
1814 /* treat root commit as boundary */
1815 if (!commit->parents && !show_root)
1816 commit->object.flags |= UNINTERESTING;
1818 /* Take responsibility for the remaining entries */
1819 ent = suspect->suspects;
1821 suspect->guilty = 1;
1823 struct blame_entry *next = ent->next;
1824 found_guilty_entry(ent, &pi);
1829 ent->next = sb->ent;
1830 sb->ent = suspect->suspects;
1831 suspect->suspects = NULL;
1835 origin_decref(suspect);
1837 if (DEBUG) /* sanity */
1838 sanity_check_refcnt(sb);
1841 stop_progress(&pi.progress);
1844 static const char *format_time(unsigned long time, const char *tz_str,
1847 static struct strbuf time_buf = STRBUF_INIT;
1849 strbuf_reset(&time_buf);
1850 if (show_raw_time) {
1851 strbuf_addf(&time_buf, "%lu %s", time, tz_str);
1854 const char *time_str;
1858 time_str = show_date(time, tz, &blame_date_mode);
1859 strbuf_addstr(&time_buf, time_str);
1861 * Add space paddings to time_buf to display a fixed width
1862 * string, and use time_width for display width calibration.
1864 for (time_width = utf8_strwidth(time_str);
1865 time_width < blame_date_width;
1867 strbuf_addch(&time_buf, ' ');
1869 return time_buf.buf;
1872 #define OUTPUT_ANNOTATE_COMPAT 001
1873 #define OUTPUT_LONG_OBJECT_NAME 002
1874 #define OUTPUT_RAW_TIMESTAMP 004
1875 #define OUTPUT_PORCELAIN 010
1876 #define OUTPUT_SHOW_NAME 020
1877 #define OUTPUT_SHOW_NUMBER 040
1878 #define OUTPUT_SHOW_SCORE 0100
1879 #define OUTPUT_NO_AUTHOR 0200
1880 #define OUTPUT_SHOW_EMAIL 0400
1881 #define OUTPUT_LINE_PORCELAIN 01000
1883 static void emit_porcelain_details(struct origin *suspect, int repeat)
1885 if (emit_one_suspect_detail(suspect, repeat) ||
1886 (suspect->commit->object.flags & MORE_THAN_ONE_PATH))
1887 write_filename_info(suspect->path);
1890 static void emit_porcelain(struct scoreboard *sb, struct blame_entry *ent,
1893 int repeat = opt & OUTPUT_LINE_PORCELAIN;
1896 struct origin *suspect = ent->suspect;
1897 char hex[GIT_SHA1_HEXSZ + 1];
1899 sha1_to_hex_r(hex, suspect->commit->object.oid.hash);
1900 printf("%s %d %d %d\n",
1905 emit_porcelain_details(suspect, repeat);
1907 cp = nth_line(sb, ent->lno);
1908 for (cnt = 0; cnt < ent->num_lines; cnt++) {
1911 printf("%s %d %d\n", hex,
1912 ent->s_lno + 1 + cnt,
1913 ent->lno + 1 + cnt);
1915 emit_porcelain_details(suspect, 1);
1921 } while (ch != '\n' &&
1922 cp < sb->final_buf + sb->final_buf_size);
1925 if (sb->final_buf_size && cp[-1] != '\n')
1929 static void emit_other(struct scoreboard *sb, struct blame_entry *ent, int opt)
1933 struct origin *suspect = ent->suspect;
1934 struct commit_info ci;
1935 char hex[GIT_SHA1_HEXSZ + 1];
1936 int show_raw_time = !!(opt & OUTPUT_RAW_TIMESTAMP);
1938 get_commit_info(suspect->commit, &ci, 1);
1939 sha1_to_hex_r(hex, suspect->commit->object.oid.hash);
1941 cp = nth_line(sb, ent->lno);
1942 for (cnt = 0; cnt < ent->num_lines; cnt++) {
1944 int length = (opt & OUTPUT_LONG_OBJECT_NAME) ? 40 : abbrev;
1946 if (suspect->commit->object.flags & UNINTERESTING) {
1948 memset(hex, ' ', length);
1949 else if (!(opt & OUTPUT_ANNOTATE_COMPAT)) {
1955 printf("%.*s", length, hex);
1956 if (opt & OUTPUT_ANNOTATE_COMPAT) {
1958 if (opt & OUTPUT_SHOW_EMAIL)
1959 name = ci.author_mail.buf;
1961 name = ci.author.buf;
1962 printf("\t(%10s\t%10s\t%d)", name,
1963 format_time(ci.author_time, ci.author_tz.buf,
1965 ent->lno + 1 + cnt);
1967 if (opt & OUTPUT_SHOW_SCORE)
1969 max_score_digits, ent->score,
1970 ent->suspect->refcnt);
1971 if (opt & OUTPUT_SHOW_NAME)
1972 printf(" %-*.*s", longest_file, longest_file,
1974 if (opt & OUTPUT_SHOW_NUMBER)
1975 printf(" %*d", max_orig_digits,
1976 ent->s_lno + 1 + cnt);
1978 if (!(opt & OUTPUT_NO_AUTHOR)) {
1981 if (opt & OUTPUT_SHOW_EMAIL)
1982 name = ci.author_mail.buf;
1984 name = ci.author.buf;
1985 pad = longest_author - utf8_strwidth(name);
1986 printf(" (%s%*s %10s",
1988 format_time(ci.author_time,
1993 max_digits, ent->lno + 1 + cnt);
1998 } while (ch != '\n' &&
1999 cp < sb->final_buf + sb->final_buf_size);
2002 if (sb->final_buf_size && cp[-1] != '\n')
2005 commit_info_destroy(&ci);
2008 static void output(struct scoreboard *sb, int option)
2010 struct blame_entry *ent;
2012 if (option & OUTPUT_PORCELAIN) {
2013 for (ent = sb->ent; ent; ent = ent->next) {
2015 struct origin *suspect;
2016 struct commit *commit = ent->suspect->commit;
2017 if (commit->object.flags & MORE_THAN_ONE_PATH)
2019 for (suspect = commit->util; suspect; suspect = suspect->next) {
2020 if (suspect->guilty && count++) {
2021 commit->object.flags |= MORE_THAN_ONE_PATH;
2028 for (ent = sb->ent; ent; ent = ent->next) {
2029 if (option & OUTPUT_PORCELAIN)
2030 emit_porcelain(sb, ent, option);
2032 emit_other(sb, ent, option);
2037 static const char *get_next_line(const char *start, const char *end)
2039 const char *nl = memchr(start, '\n', end - start);
2040 return nl ? nl + 1 : end;
2044 * To allow quick access to the contents of nth line in the
2045 * final image, prepare an index in the scoreboard.
2047 static int prepare_lines(struct scoreboard *sb)
2049 const char *buf = sb->final_buf;
2050 unsigned long len = sb->final_buf_size;
2051 const char *end = buf + len;
2056 for (p = buf; p < end; p = get_next_line(p, end))
2059 ALLOC_ARRAY(sb->lineno, num + 1);
2060 lineno = sb->lineno;
2062 for (p = buf; p < end; p = get_next_line(p, end))
2063 *lineno++ = p - buf;
2067 sb->num_lines = num;
2068 return sb->num_lines;
2072 * Add phony grafts for use with -S; this is primarily to
2073 * support git's cvsserver that wants to give a linear history
2076 static int read_ancestry(const char *graft_file)
2078 FILE *fp = fopen(graft_file, "r");
2079 struct strbuf buf = STRBUF_INIT;
2082 while (!strbuf_getwholeline(&buf, fp, '\n')) {
2083 /* The format is just "Commit Parent1 Parent2 ...\n" */
2084 struct commit_graft *graft = read_graft_line(buf.buf, buf.len);
2086 register_commit_graft(graft, 0);
2089 strbuf_release(&buf);
2093 static int update_auto_abbrev(int auto_abbrev, struct origin *suspect)
2095 const char *uniq = find_unique_abbrev(suspect->commit->object.oid.hash,
2097 int len = strlen(uniq);
2098 if (auto_abbrev < len)
2104 * How many columns do we need to show line numbers, authors,
2107 static void find_alignment(struct scoreboard *sb, int *option)
2109 int longest_src_lines = 0;
2110 int longest_dst_lines = 0;
2111 unsigned largest_score = 0;
2112 struct blame_entry *e;
2113 int compute_auto_abbrev = (abbrev < 0);
2114 int auto_abbrev = default_abbrev;
2116 for (e = sb->ent; e; e = e->next) {
2117 struct origin *suspect = e->suspect;
2120 if (compute_auto_abbrev)
2121 auto_abbrev = update_auto_abbrev(auto_abbrev, suspect);
2122 if (strcmp(suspect->path, sb->path))
2123 *option |= OUTPUT_SHOW_NAME;
2124 num = strlen(suspect->path);
2125 if (longest_file < num)
2127 if (!(suspect->commit->object.flags & METAINFO_SHOWN)) {
2128 struct commit_info ci;
2129 suspect->commit->object.flags |= METAINFO_SHOWN;
2130 get_commit_info(suspect->commit, &ci, 1);
2131 if (*option & OUTPUT_SHOW_EMAIL)
2132 num = utf8_strwidth(ci.author_mail.buf);
2134 num = utf8_strwidth(ci.author.buf);
2135 if (longest_author < num)
2136 longest_author = num;
2137 commit_info_destroy(&ci);
2139 num = e->s_lno + e->num_lines;
2140 if (longest_src_lines < num)
2141 longest_src_lines = num;
2142 num = e->lno + e->num_lines;
2143 if (longest_dst_lines < num)
2144 longest_dst_lines = num;
2145 if (largest_score < ent_score(sb, e))
2146 largest_score = ent_score(sb, e);
2148 max_orig_digits = decimal_width(longest_src_lines);
2149 max_digits = decimal_width(longest_dst_lines);
2150 max_score_digits = decimal_width(largest_score);
2152 if (compute_auto_abbrev)
2153 /* one more abbrev length is needed for the boundary commit */
2154 abbrev = auto_abbrev + 1;
2158 * For debugging -- origin is refcounted, and this asserts that
2159 * we do not underflow.
2161 static void sanity_check_refcnt(struct scoreboard *sb)
2164 struct blame_entry *ent;
2166 for (ent = sb->ent; ent; ent = ent->next) {
2167 /* Nobody should have zero or negative refcnt */
2168 if (ent->suspect->refcnt <= 0) {
2169 fprintf(stderr, "%s in %s has negative refcnt %d\n",
2171 oid_to_hex(&ent->suspect->commit->object.oid),
2172 ent->suspect->refcnt);
2178 find_alignment(sb, &opt);
2180 die("Baa %d!", baa);
2184 static unsigned parse_score(const char *arg)
2187 unsigned long score = strtoul(arg, &end, 10);
2193 static const char *add_prefix(const char *prefix, const char *path)
2195 return prefix_path(prefix, prefix ? strlen(prefix) : 0, path);
2198 static int git_blame_config(const char *var, const char *value, void *cb)
2200 if (!strcmp(var, "blame.showroot")) {
2201 show_root = git_config_bool(var, value);
2204 if (!strcmp(var, "blame.blankboundary")) {
2205 blank_boundary = git_config_bool(var, value);
2208 if (!strcmp(var, "blame.showemail")) {
2209 int *output_option = cb;
2210 if (git_config_bool(var, value))
2211 *output_option |= OUTPUT_SHOW_EMAIL;
2213 *output_option &= ~OUTPUT_SHOW_EMAIL;
2216 if (!strcmp(var, "blame.date")) {
2218 return config_error_nonbool(var);
2219 parse_date_format(value, &blame_date_mode);
2223 if (userdiff_config(var, value) < 0)
2226 return git_default_config(var, value, cb);
2229 static void verify_working_tree_path(struct commit *work_tree, const char *path)
2231 struct commit_list *parents;
2234 for (parents = work_tree->parents; parents; parents = parents->next) {
2235 const unsigned char *commit_sha1 = parents->item->object.oid.hash;
2236 unsigned char blob_sha1[20];
2239 if (!get_tree_entry(commit_sha1, path, blob_sha1, &mode) &&
2240 sha1_object_info(blob_sha1, NULL) == OBJ_BLOB)
2244 pos = cache_name_pos(path, strlen(path));
2246 ; /* path is in the index */
2247 else if (!strcmp(active_cache[-1 - pos]->name, path))
2248 ; /* path is in the index, unmerged */
2250 die("no such path '%s' in HEAD", path);
2253 static struct commit_list **append_parent(struct commit_list **tail, const unsigned char *sha1)
2255 struct commit *parent;
2257 parent = lookup_commit_reference(sha1);
2259 die("no such commit %s", sha1_to_hex(sha1));
2260 return &commit_list_insert(parent, tail)->next;
2263 static void append_merge_parents(struct commit_list **tail)
2266 struct strbuf line = STRBUF_INIT;
2268 merge_head = open(git_path_merge_head(), O_RDONLY);
2269 if (merge_head < 0) {
2270 if (errno == ENOENT)
2272 die("cannot open '%s' for reading", git_path_merge_head());
2275 while (!strbuf_getwholeline_fd(&line, merge_head, '\n')) {
2276 unsigned char sha1[20];
2277 if (line.len < 40 || get_sha1_hex(line.buf, sha1))
2278 die("unknown line in '%s': %s", git_path_merge_head(), line.buf);
2279 tail = append_parent(tail, sha1);
2282 strbuf_release(&line);
2286 * This isn't as simple as passing sb->buf and sb->len, because we
2287 * want to transfer ownership of the buffer to the commit (so we
2290 static void set_commit_buffer_from_strbuf(struct commit *c, struct strbuf *sb)
2293 void *buf = strbuf_detach(sb, &len);
2294 set_commit_buffer(c, buf, len);
2298 * Prepare a dummy commit that represents the work tree (or staged) item.
2299 * Note that annotating work tree item never works in the reverse.
2301 static struct commit *fake_working_tree_commit(struct diff_options *opt,
2303 const char *contents_from)
2305 struct commit *commit;
2306 struct origin *origin;
2307 struct commit_list **parent_tail, *parent;
2308 unsigned char head_sha1[20];
2309 struct strbuf buf = STRBUF_INIT;
2313 struct cache_entry *ce;
2315 struct strbuf msg = STRBUF_INIT;
2319 commit = alloc_commit_node();
2320 commit->object.parsed = 1;
2322 parent_tail = &commit->parents;
2324 if (!resolve_ref_unsafe("HEAD", RESOLVE_REF_READING, head_sha1, NULL))
2325 die("no such ref: HEAD");
2327 parent_tail = append_parent(parent_tail, head_sha1);
2328 append_merge_parents(parent_tail);
2329 verify_working_tree_path(commit, path);
2331 origin = make_origin(commit, path);
2333 ident = fmt_ident("Not Committed Yet", "not.committed.yet", NULL, 0);
2334 strbuf_addstr(&msg, "tree 0000000000000000000000000000000000000000\n");
2335 for (parent = commit->parents; parent; parent = parent->next)
2336 strbuf_addf(&msg, "parent %s\n",
2337 oid_to_hex(&parent->item->object.oid));
2341 "Version of %s from %s\n",
2343 (!contents_from ? path :
2344 (!strcmp(contents_from, "-") ? "standard input" : contents_from)));
2345 set_commit_buffer_from_strbuf(commit, &msg);
2347 if (!contents_from || strcmp("-", contents_from)) {
2349 const char *read_from;
2351 unsigned long buf_len;
2353 if (contents_from) {
2354 if (stat(contents_from, &st) < 0)
2355 die_errno("Cannot stat '%s'", contents_from);
2356 read_from = contents_from;
2359 if (lstat(path, &st) < 0)
2360 die_errno("Cannot lstat '%s'", path);
2363 mode = canon_mode(st.st_mode);
2365 switch (st.st_mode & S_IFMT) {
2367 if (DIFF_OPT_TST(opt, ALLOW_TEXTCONV) &&
2368 textconv_object(read_from, mode, null_sha1, 0, &buf_ptr, &buf_len))
2369 strbuf_attach(&buf, buf_ptr, buf_len, buf_len + 1);
2370 else if (strbuf_read_file(&buf, read_from, st.st_size) != st.st_size)
2371 die_errno("cannot open or read '%s'", read_from);
2374 if (strbuf_readlink(&buf, read_from, st.st_size) < 0)
2375 die_errno("cannot readlink '%s'", read_from);
2378 die("unsupported file type %s", read_from);
2382 /* Reading from stdin */
2384 if (strbuf_read(&buf, 0, 0) < 0)
2385 die_errno("failed to read from stdin");
2387 convert_to_git(path, buf.buf, buf.len, &buf, 0);
2388 origin->file.ptr = buf.buf;
2389 origin->file.size = buf.len;
2390 pretend_sha1_file(buf.buf, buf.len, OBJ_BLOB, origin->blob_sha1);
2393 * Read the current index, replace the path entry with
2394 * origin->blob_sha1 without mucking with its mode or type
2395 * bits; we are not going to write this index out -- we just
2396 * want to run "diff-index --cached".
2403 int pos = cache_name_pos(path, len);
2405 mode = active_cache[pos]->ce_mode;
2407 /* Let's not bother reading from HEAD tree */
2408 mode = S_IFREG | 0644;
2410 size = cache_entry_size(len);
2411 ce = xcalloc(1, size);
2412 hashcpy(ce->sha1, origin->blob_sha1);
2413 memcpy(ce->name, path, len);
2414 ce->ce_flags = create_ce_flags(0);
2415 ce->ce_namelen = len;
2416 ce->ce_mode = create_ce_mode(mode);
2417 add_cache_entry(ce, ADD_CACHE_OK_TO_ADD|ADD_CACHE_OK_TO_REPLACE);
2419 cache_tree_invalidate_path(&the_index, path);
2424 static struct commit *find_single_final(struct rev_info *revs,
2425 const char **name_p)
2428 struct commit *found = NULL;
2429 const char *name = NULL;
2431 for (i = 0; i < revs->pending.nr; i++) {
2432 struct object *obj = revs->pending.objects[i].item;
2433 if (obj->flags & UNINTERESTING)
2435 obj = deref_tag(obj, NULL, 0);
2436 if (obj->type != OBJ_COMMIT)
2437 die("Non commit %s?", revs->pending.objects[i].name);
2439 die("More than one commit to dig from %s and %s?",
2440 revs->pending.objects[i].name, name);
2441 found = (struct commit *)obj;
2442 name = revs->pending.objects[i].name;
2449 static char *prepare_final(struct scoreboard *sb)
2452 sb->final = find_single_final(sb->revs, &name);
2453 return xstrdup_or_null(name);
2456 static char *prepare_initial(struct scoreboard *sb)
2459 const char *final_commit_name = NULL;
2460 struct rev_info *revs = sb->revs;
2463 * There must be one and only one negative commit, and it must be
2466 for (i = 0; i < revs->pending.nr; i++) {
2467 struct object *obj = revs->pending.objects[i].item;
2468 if (!(obj->flags & UNINTERESTING))
2470 obj = deref_tag(obj, NULL, 0);
2471 if (obj->type != OBJ_COMMIT)
2472 die("Non commit %s?", revs->pending.objects[i].name);
2474 die("More than one commit to dig down to %s and %s?",
2475 revs->pending.objects[i].name,
2477 sb->final = (struct commit *) obj;
2478 final_commit_name = revs->pending.objects[i].name;
2480 if (!final_commit_name)
2481 die("No commit to dig down to?");
2482 return xstrdup(final_commit_name);
2485 static int blame_copy_callback(const struct option *option, const char *arg, int unset)
2487 int *opt = option->value;
2490 * -C enables copy from removed files;
2491 * -C -C enables copy from existing files, but only
2492 * when blaming a new file;
2493 * -C -C -C enables copy from existing files for
2496 if (*opt & PICKAXE_BLAME_COPY_HARDER)
2497 *opt |= PICKAXE_BLAME_COPY_HARDEST;
2498 if (*opt & PICKAXE_BLAME_COPY)
2499 *opt |= PICKAXE_BLAME_COPY_HARDER;
2500 *opt |= PICKAXE_BLAME_COPY | PICKAXE_BLAME_MOVE;
2503 blame_copy_score = parse_score(arg);
2507 static int blame_move_callback(const struct option *option, const char *arg, int unset)
2509 int *opt = option->value;
2511 *opt |= PICKAXE_BLAME_MOVE;
2514 blame_move_score = parse_score(arg);
2518 int cmd_blame(int argc, const char **argv, const char *prefix)
2520 struct rev_info revs;
2522 struct scoreboard sb;
2524 struct blame_entry *ent = NULL;
2525 long dashdash_pos, lno;
2526 char *final_commit_name = NULL;
2527 enum object_type type;
2528 struct commit *final_commit = NULL;
2530 static struct string_list range_list;
2531 static int output_option = 0, opt = 0;
2532 static int show_stats = 0;
2533 static const char *revs_file = NULL;
2534 static const char *contents_from = NULL;
2535 static const struct option options[] = {
2536 OPT_BOOL(0, "incremental", &incremental, N_("Show blame entries as we find them, incrementally")),
2537 OPT_BOOL('b', NULL, &blank_boundary, N_("Show blank SHA-1 for boundary commits (Default: off)")),
2538 OPT_BOOL(0, "root", &show_root, N_("Do not treat root commits as boundaries (Default: off)")),
2539 OPT_BOOL(0, "show-stats", &show_stats, N_("Show work cost statistics")),
2540 OPT_BOOL(0, "progress", &show_progress, N_("Force progress reporting")),
2541 OPT_BIT(0, "score-debug", &output_option, N_("Show output score for blame entries"), OUTPUT_SHOW_SCORE),
2542 OPT_BIT('f', "show-name", &output_option, N_("Show original filename (Default: auto)"), OUTPUT_SHOW_NAME),
2543 OPT_BIT('n', "show-number", &output_option, N_("Show original linenumber (Default: off)"), OUTPUT_SHOW_NUMBER),
2544 OPT_BIT('p', "porcelain", &output_option, N_("Show in a format designed for machine consumption"), OUTPUT_PORCELAIN),
2545 OPT_BIT(0, "line-porcelain", &output_option, N_("Show porcelain format with per-line commit information"), OUTPUT_PORCELAIN|OUTPUT_LINE_PORCELAIN),
2546 OPT_BIT('c', NULL, &output_option, N_("Use the same output mode as git-annotate (Default: off)"), OUTPUT_ANNOTATE_COMPAT),
2547 OPT_BIT('t', NULL, &output_option, N_("Show raw timestamp (Default: off)"), OUTPUT_RAW_TIMESTAMP),
2548 OPT_BIT('l', NULL, &output_option, N_("Show long commit SHA1 (Default: off)"), OUTPUT_LONG_OBJECT_NAME),
2549 OPT_BIT('s', NULL, &output_option, N_("Suppress author name and timestamp (Default: off)"), OUTPUT_NO_AUTHOR),
2550 OPT_BIT('e', "show-email", &output_option, N_("Show author email instead of name (Default: off)"), OUTPUT_SHOW_EMAIL),
2551 OPT_BIT('w', NULL, &xdl_opts, N_("Ignore whitespace differences"), XDF_IGNORE_WHITESPACE),
2552 OPT_BIT(0, "minimal", &xdl_opts, N_("Spend extra cycles to find better match"), XDF_NEED_MINIMAL),
2553 OPT_STRING('S', NULL, &revs_file, N_("file"), N_("Use revisions from <file> instead of calling git-rev-list")),
2554 OPT_STRING(0, "contents", &contents_from, N_("file"), N_("Use <file>'s contents as the final image")),
2555 { OPTION_CALLBACK, 'C', NULL, &opt, N_("score"), N_("Find line copies within and across files"), PARSE_OPT_OPTARG, blame_copy_callback },
2556 { OPTION_CALLBACK, 'M', NULL, &opt, N_("score"), N_("Find line movements within and across files"), PARSE_OPT_OPTARG, blame_move_callback },
2557 OPT_STRING_LIST('L', NULL, &range_list, N_("n,m"), N_("Process only line range n,m, counting from 1")),
2558 OPT__ABBREV(&abbrev),
2562 struct parse_opt_ctx_t ctx;
2563 int cmd_is_annotate = !strcmp(argv[0], "annotate");
2564 struct range_set ranges;
2565 unsigned int range_i;
2568 git_config(git_blame_config, &output_option);
2569 init_revisions(&revs, NULL);
2570 revs.date_mode = blame_date_mode;
2571 DIFF_OPT_SET(&revs.diffopt, ALLOW_TEXTCONV);
2572 DIFF_OPT_SET(&revs.diffopt, FOLLOW_RENAMES);
2574 save_commit_buffer = 0;
2578 parse_options_start(&ctx, argc, argv, prefix, options,
2579 PARSE_OPT_KEEP_DASHDASH | PARSE_OPT_KEEP_ARGV0);
2581 switch (parse_options_step(&ctx, options, blame_opt_usage)) {
2582 case PARSE_OPT_HELP:
2584 case PARSE_OPT_DONE:
2586 dashdash_pos = ctx.cpidx;
2590 if (!strcmp(ctx.argv[0], "--reverse")) {
2591 ctx.argv[0] = "--children";
2594 parse_revision_opt(&revs, &ctx, options, blame_opt_usage);
2597 no_whole_file_rename = !DIFF_OPT_TST(&revs.diffopt, FOLLOW_RENAMES);
2598 DIFF_OPT_CLR(&revs.diffopt, FOLLOW_RENAMES);
2599 argc = parse_options_end(&ctx);
2601 if (incremental || (output_option & OUTPUT_PORCELAIN)) {
2602 if (show_progress > 0)
2603 die("--progress can't be used with --incremental or porcelain formats");
2605 } else if (show_progress < 0)
2606 show_progress = isatty(2);
2609 /* one more abbrev length is needed for the boundary commit */
2612 if (revs_file && read_ancestry(revs_file))
2613 die_errno("reading graft file '%s' failed", revs_file);
2615 if (cmd_is_annotate) {
2616 output_option |= OUTPUT_ANNOTATE_COMPAT;
2617 blame_date_mode.type = DATE_ISO8601;
2619 blame_date_mode = revs.date_mode;
2622 /* The maximum width used to show the dates */
2623 switch (blame_date_mode.type) {
2625 blame_date_width = sizeof("Thu, 19 Oct 2006 16:00:04 -0700");
2627 case DATE_ISO8601_STRICT:
2628 blame_date_width = sizeof("2006-10-19T16:00:04-07:00");
2631 blame_date_width = sizeof("2006-10-19 16:00:04 -0700");
2634 blame_date_width = sizeof("1161298804 -0700");
2637 blame_date_width = sizeof("2006-10-19");
2640 /* TRANSLATORS: This string is used to tell us the maximum
2641 display width for a relative timestamp in "git blame"
2642 output. For C locale, "4 years, 11 months ago", which
2643 takes 22 places, is the longest among various forms of
2644 relative timestamps, but your language may need more or
2645 fewer display columns. */
2646 blame_date_width = utf8_strwidth(_("4 years, 11 months ago")) + 1; /* add the null */
2649 blame_date_width = sizeof("Thu Oct 19 16:00:04 2006 -0700");
2652 blame_date_width = strlen(show_date(0, 0, &blame_date_mode)) + 1; /* add the null */
2655 blame_date_width -= 1; /* strip the null */
2657 if (DIFF_OPT_TST(&revs.diffopt, FIND_COPIES_HARDER))
2658 opt |= (PICKAXE_BLAME_COPY | PICKAXE_BLAME_MOVE |
2659 PICKAXE_BLAME_COPY_HARDER);
2661 if (!blame_move_score)
2662 blame_move_score = BLAME_DEFAULT_MOVE_SCORE;
2663 if (!blame_copy_score)
2664 blame_copy_score = BLAME_DEFAULT_COPY_SCORE;
2667 * We have collected options unknown to us in argv[1..unk]
2668 * which are to be passed to revision machinery if we are
2669 * going to do the "bottom" processing.
2671 * The remaining are:
2673 * (1) if dashdash_pos != 0, it is either
2674 * "blame [revisions] -- <path>" or
2675 * "blame -- <path> <rev>"
2677 * (2) otherwise, it is one of the two:
2678 * "blame [revisions] <path>"
2679 * "blame <path> <rev>"
2681 * Note that we must strip out <path> from the arguments: we do not
2682 * want the path pruning but we may want "bottom" processing.
2685 switch (argc - dashdash_pos - 1) {
2688 usage_with_options(blame_opt_usage, options);
2689 /* reorder for the new way: <rev> -- <path> */
2695 path = add_prefix(prefix, argv[--argc]);
2699 usage_with_options(blame_opt_usage, options);
2703 usage_with_options(blame_opt_usage, options);
2704 path = add_prefix(prefix, argv[argc - 1]);
2705 if (argc == 3 && !file_exists(path)) { /* (2b) */
2706 path = add_prefix(prefix, argv[1]);
2709 argv[argc - 1] = "--";
2712 if (!file_exists(path))
2713 die_errno("cannot stat path '%s'", path);
2716 revs.disable_stdin = 1;
2717 setup_revisions(argc, argv, &revs, NULL);
2718 memset(&sb, 0, sizeof(sb));
2722 final_commit_name = prepare_final(&sb);
2723 sb.commits.compare = compare_commits_by_commit_date;
2725 else if (contents_from)
2726 die("--contents and --reverse do not blend well.");
2728 final_commit_name = prepare_initial(&sb);
2729 sb.commits.compare = compare_commits_by_reverse_commit_date;
2730 if (revs.first_parent_only)
2731 revs.children.name = NULL;
2736 * "--not A B -- path" without anything positive;
2737 * do not default to HEAD, but use the working tree
2741 sb.final = fake_working_tree_commit(&sb.revs->diffopt,
2742 path, contents_from);
2743 add_pending_object(&revs, &(sb.final->object), ":");
2745 else if (contents_from)
2746 die("Cannot use --contents with final commit object name");
2748 if (reverse && revs.first_parent_only) {
2749 final_commit = find_single_final(sb.revs, NULL);
2751 die("--reverse and --first-parent together require specified latest commit");
2755 * If we have bottom, this will mark the ancestors of the
2756 * bottom commits we would reach while traversing as
2759 if (prepare_revision_walk(&revs))
2760 die(_("revision walk setup failed"));
2762 if (reverse && revs.first_parent_only) {
2763 struct commit *c = final_commit;
2765 sb.revs->children.name = "children";
2766 while (c->parents &&
2767 oidcmp(&c->object.oid, &sb.final->object.oid)) {
2768 struct commit_list *l = xcalloc(1, sizeof(*l));
2771 if (add_decoration(&sb.revs->children,
2772 &c->parents->item->object, l))
2773 die("BUG: not unique item in first-parent chain");
2774 c = c->parents->item;
2777 if (oidcmp(&c->object.oid, &sb.final->object.oid))
2778 die("--reverse --first-parent together require range along first-parent chain");
2781 if (is_null_oid(&sb.final->object.oid)) {
2783 sb.final_buf = xmemdupz(o->file.ptr, o->file.size);
2784 sb.final_buf_size = o->file.size;
2787 o = get_origin(&sb, sb.final, path);
2788 if (fill_blob_sha1_and_mode(o))
2789 die("no such path %s in %s", path, final_commit_name);
2791 if (DIFF_OPT_TST(&sb.revs->diffopt, ALLOW_TEXTCONV) &&
2792 textconv_object(path, o->mode, o->blob_sha1, 1, (char **) &sb.final_buf,
2793 &sb.final_buf_size))
2796 sb.final_buf = read_sha1_file(o->blob_sha1, &type,
2797 &sb.final_buf_size);
2800 die("Cannot read blob %s for path %s",
2801 sha1_to_hex(o->blob_sha1),
2805 lno = prepare_lines(&sb);
2807 if (lno && !range_list.nr)
2808 string_list_append(&range_list, xstrdup("1"));
2811 range_set_init(&ranges, range_list.nr);
2812 for (range_i = 0; range_i < range_list.nr; ++range_i) {
2814 if (parse_range_arg(range_list.items[range_i].string,
2815 nth_line_cb, &sb, lno, anchor,
2816 &bottom, &top, sb.path))
2818 if (lno < top || ((lno || bottom) && lno < bottom))
2819 die("file %s has only %lu lines", path, lno);
2825 range_set_append_unsafe(&ranges, bottom, top);
2828 sort_and_merge_range_set(&ranges);
2830 for (range_i = ranges.nr; range_i > 0; --range_i) {
2831 const struct range *r = &ranges.ranges[range_i - 1];
2832 long bottom = r->start;
2834 struct blame_entry *next = ent;
2835 ent = xcalloc(1, sizeof(*ent));
2837 ent->num_lines = top - bottom;
2839 ent->s_lno = bottom;
2845 prio_queue_put(&sb.commits, o->commit);
2849 range_set_release(&ranges);
2850 string_list_clear(&range_list, 0);
2855 read_mailmap(&mailmap, NULL);
2857 assign_blame(&sb, opt);
2862 free(final_commit_name);
2867 sb.ent = blame_sort(sb.ent, compare_blame_final);
2871 if (!(output_option & OUTPUT_PORCELAIN))
2872 find_alignment(&sb, &output_option);
2874 output(&sb, output_option);
2875 free((void *)sb.final_buf);
2876 for (ent = sb.ent; ent; ) {
2877 struct blame_entry *e = ent->next;
2883 printf("num read blob: %d\n", num_read_blob);
2884 printf("num get patch: %d\n", num_get_patch);
2885 printf("num commits: %d\n", num_commits);