4 * Copyright (c) 2006, Junio C Hamano
12 #include "tree-walk.h"
17 #include "xdiff-interface.h"
18 #include "cache-tree.h"
19 #include "string-list.h"
21 #include "parse-options.h"
24 static char blame_usage[] = "git blame [options] [rev-opts] [rev] [--] file";
26 static const char *blame_opt_usage[] = {
29 "[rev-opts] are documented in git-rev-list(1)",
33 static int longest_file;
34 static int longest_author;
35 static int max_orig_digits;
36 static int max_digits;
37 static int max_score_digits;
40 static int blank_boundary;
41 static int incremental;
42 static int xdl_opts = XDF_NEED_MINIMAL;
44 static enum date_mode blame_date_mode = DATE_ISO8601;
45 static size_t blame_date_width;
47 static struct string_list mailmap;
54 static int num_read_blob;
55 static int num_get_patch;
56 static int num_commits;
58 #define PICKAXE_BLAME_MOVE 01
59 #define PICKAXE_BLAME_COPY 02
60 #define PICKAXE_BLAME_COPY_HARDER 04
61 #define PICKAXE_BLAME_COPY_HARDEST 010
64 * blame for a blame_entry with score lower than these thresholds
65 * is not passed to the parent using move/copy logic.
67 static unsigned blame_move_score;
68 static unsigned blame_copy_score;
69 #define BLAME_DEFAULT_MOVE_SCORE 20
70 #define BLAME_DEFAULT_COPY_SCORE 40
72 /* bits #0..7 in revision.h, #8..11 used for merge_bases() in commit.c */
73 #define METAINFO_SHOWN (1u<<12)
74 #define MORE_THAN_ONE_PATH (1u<<13)
77 * One blob in a commit that is being suspected
81 struct origin *previous;
82 struct commit *commit;
84 unsigned char blob_sha1[20];
85 char path[FLEX_ARRAY];
89 * Given an origin, prepare mmfile_t structure to be used by the
92 static void fill_origin_blob(struct origin *o, mmfile_t *file)
95 enum object_type type;
97 file->ptr = read_sha1_file(o->blob_sha1, &type,
98 (unsigned long *)(&(file->size)));
100 die("Cannot read blob %s for path %s",
101 sha1_to_hex(o->blob_sha1),
110 * Origin is refcounted and usually we keep the blob contents to be
113 static inline struct origin *origin_incref(struct origin *o)
120 static void origin_decref(struct origin *o)
122 if (o && --o->refcnt <= 0) {
124 origin_decref(o->previous);
130 static void drop_origin_blob(struct origin *o)
139 * Each group of lines is described by a blame_entry; it can be split
140 * as we pass blame to the parents. They form a linked list in the
141 * scoreboard structure, sorted by the target line number.
144 struct blame_entry *prev;
145 struct blame_entry *next;
147 /* the first line of this group in the final image;
148 * internally all line numbers are 0 based.
152 /* how many lines this group has */
155 /* the commit that introduced this group into the final image */
156 struct origin *suspect;
158 /* true if the suspect is truly guilty; false while we have not
159 * checked if the group came from one of its parents.
163 /* true if the entry has been scanned for copies in the current parent
167 /* the line number of the first line of this group in the
168 * suspect's file; internally all line numbers are 0 based.
172 /* how significant this entry is -- cached to avoid
173 * scanning the lines over and over.
179 * The current state of the blame assignment.
182 /* the final commit (i.e. where we started digging from) */
183 struct commit *final;
184 struct rev_info *revs;
188 * The contents in the final image.
189 * Used by many functions to obtain contents of the nth line,
190 * indexed with scoreboard.lineno[blame_entry.lno].
192 const char *final_buf;
193 unsigned long final_buf_size;
195 /* linked list of blames */
196 struct blame_entry *ent;
198 /* look-up a line in the final buffer */
203 static inline int same_suspect(struct origin *a, struct origin *b)
207 if (a->commit != b->commit)
209 return !strcmp(a->path, b->path);
212 static void sanity_check_refcnt(struct scoreboard *);
215 * If two blame entries that are next to each other came from
216 * contiguous lines in the same origin (i.e. <commit, path> pair),
217 * merge them together.
219 static void coalesce(struct scoreboard *sb)
221 struct blame_entry *ent, *next;
223 for (ent = sb->ent; ent && (next = ent->next); ent = next) {
224 if (same_suspect(ent->suspect, next->suspect) &&
225 ent->guilty == next->guilty &&
226 ent->s_lno + ent->num_lines == next->s_lno) {
227 ent->num_lines += next->num_lines;
228 ent->next = next->next;
230 ent->next->prev = ent;
231 origin_decref(next->suspect);
234 next = ent; /* again */
238 if (DEBUG) /* sanity */
239 sanity_check_refcnt(sb);
243 * Given a commit and a path in it, create a new origin structure.
244 * The callers that add blame to the scoreboard should use
245 * get_origin() to obtain shared, refcounted copy instead of calling
246 * this function directly.
248 static struct origin *make_origin(struct commit *commit, const char *path)
251 o = xcalloc(1, sizeof(*o) + strlen(path) + 1);
254 strcpy(o->path, path);
259 * Locate an existing origin or create a new one.
261 static struct origin *get_origin(struct scoreboard *sb,
262 struct commit *commit,
265 struct blame_entry *e;
267 for (e = sb->ent; e; e = e->next) {
268 if (e->suspect->commit == commit &&
269 !strcmp(e->suspect->path, path))
270 return origin_incref(e->suspect);
272 return make_origin(commit, path);
276 * Fill the blob_sha1 field of an origin if it hasn't, so that later
277 * call to fill_origin_blob() can use it to locate the data. blob_sha1
278 * for an origin is also used to pass the blame for the entire file to
279 * the parent to detect the case where a child's blob is identical to
280 * that of its parent's.
282 static int fill_blob_sha1(struct origin *origin)
286 if (!is_null_sha1(origin->blob_sha1))
288 if (get_tree_entry(origin->commit->object.sha1,
290 origin->blob_sha1, &mode))
292 if (sha1_object_info(origin->blob_sha1, NULL) != OBJ_BLOB)
296 hashclr(origin->blob_sha1);
301 * We have an origin -- check if the same path exists in the
302 * parent and return an origin structure to represent it.
304 static struct origin *find_origin(struct scoreboard *sb,
305 struct commit *parent,
306 struct origin *origin)
308 struct origin *porigin = NULL;
309 struct diff_options diff_opts;
310 const char *paths[2];
314 * Each commit object can cache one origin in that
315 * commit. This is a freestanding copy of origin and
318 struct origin *cached = parent->util;
319 if (!strcmp(cached->path, origin->path)) {
321 * The same path between origin and its parent
322 * without renaming -- the most common case.
324 porigin = get_origin(sb, parent, cached->path);
327 * If the origin was newly created (i.e. get_origin
328 * would call make_origin if none is found in the
329 * scoreboard), it does not know the blob_sha1,
330 * so copy it. Otherwise porigin was in the
331 * scoreboard and already knows blob_sha1.
333 if (porigin->refcnt == 1)
334 hashcpy(porigin->blob_sha1, cached->blob_sha1);
337 /* otherwise it was not very useful; free it */
342 /* See if the origin->path is different between parent
343 * and origin first. Most of the time they are the
344 * same and diff-tree is fairly efficient about this.
346 diff_setup(&diff_opts);
347 DIFF_OPT_SET(&diff_opts, RECURSIVE);
348 diff_opts.detect_rename = 0;
349 diff_opts.output_format = DIFF_FORMAT_NO_OUTPUT;
350 paths[0] = origin->path;
353 diff_tree_setup_paths(paths, &diff_opts);
354 if (diff_setup_done(&diff_opts) < 0)
357 if (is_null_sha1(origin->commit->object.sha1))
358 do_diff_cache(parent->tree->object.sha1, &diff_opts);
360 diff_tree_sha1(parent->tree->object.sha1,
361 origin->commit->tree->object.sha1,
363 diffcore_std(&diff_opts);
365 if (!diff_queued_diff.nr) {
366 /* The path is the same as parent */
367 porigin = get_origin(sb, parent, origin->path);
368 hashcpy(porigin->blob_sha1, origin->blob_sha1);
371 * Since origin->path is a pathspec, if the parent
372 * commit had it as a directory, we will see a whole
373 * bunch of deletion of files in the directory that we
377 struct diff_filepair *p = NULL;
378 for (i = 0; i < diff_queued_diff.nr; i++) {
380 p = diff_queued_diff.queue[i];
381 name = p->one->path ? p->one->path : p->two->path;
382 if (!strcmp(name, origin->path))
386 die("internal error in blame::find_origin");
389 die("internal error in blame::find_origin (%c)",
392 porigin = get_origin(sb, parent, origin->path);
393 hashcpy(porigin->blob_sha1, p->one->sha1);
397 /* Did not exist in parent, or type changed */
401 diff_flush(&diff_opts);
402 diff_tree_release_paths(&diff_opts);
405 * Create a freestanding copy that is not part of
406 * the refcounted origin found in the scoreboard, and
407 * cache it in the commit.
409 struct origin *cached;
411 cached = make_origin(porigin->commit, porigin->path);
412 hashcpy(cached->blob_sha1, porigin->blob_sha1);
413 parent->util = cached;
419 * We have an origin -- find the path that corresponds to it in its
420 * parent and return an origin structure to represent it.
422 static struct origin *find_rename(struct scoreboard *sb,
423 struct commit *parent,
424 struct origin *origin)
426 struct origin *porigin = NULL;
427 struct diff_options diff_opts;
429 const char *paths[2];
431 diff_setup(&diff_opts);
432 DIFF_OPT_SET(&diff_opts, RECURSIVE);
433 diff_opts.detect_rename = DIFF_DETECT_RENAME;
434 diff_opts.output_format = DIFF_FORMAT_NO_OUTPUT;
435 diff_opts.single_follow = origin->path;
437 diff_tree_setup_paths(paths, &diff_opts);
438 if (diff_setup_done(&diff_opts) < 0)
441 if (is_null_sha1(origin->commit->object.sha1))
442 do_diff_cache(parent->tree->object.sha1, &diff_opts);
444 diff_tree_sha1(parent->tree->object.sha1,
445 origin->commit->tree->object.sha1,
447 diffcore_std(&diff_opts);
449 for (i = 0; i < diff_queued_diff.nr; i++) {
450 struct diff_filepair *p = diff_queued_diff.queue[i];
451 if ((p->status == 'R' || p->status == 'C') &&
452 !strcmp(p->two->path, origin->path)) {
453 porigin = get_origin(sb, parent, p->one->path);
454 hashcpy(porigin->blob_sha1, p->one->sha1);
458 diff_flush(&diff_opts);
459 diff_tree_release_paths(&diff_opts);
464 * Link in a new blame entry to the scoreboard. Entries that cover the
465 * same line range have been removed from the scoreboard previously.
467 static void add_blame_entry(struct scoreboard *sb, struct blame_entry *e)
469 struct blame_entry *ent, *prev = NULL;
471 origin_incref(e->suspect);
473 for (ent = sb->ent; ent && ent->lno < e->lno; ent = ent->next)
476 /* prev, if not NULL, is the last one that is below e */
479 e->next = prev->next;
491 * src typically is on-stack; we want to copy the information in it to
492 * a malloced blame_entry that is already on the linked list of the
493 * scoreboard. The origin of dst loses a refcnt while the origin of src
496 static void dup_entry(struct blame_entry *dst, struct blame_entry *src)
498 struct blame_entry *p, *n;
502 origin_incref(src->suspect);
503 origin_decref(dst->suspect);
504 memcpy(dst, src, sizeof(*src));
510 static const char *nth_line(struct scoreboard *sb, int lno)
512 return sb->final_buf + sb->lineno[lno];
516 * It is known that lines between tlno to same came from parent, and e
517 * has an overlap with that range. it also is known that parent's
518 * line plno corresponds to e's line tlno.
524 * <------------------>
526 * Split e into potentially three parts; before this chunk, the chunk
527 * to be blamed for the parent, and after that portion.
529 static void split_overlap(struct blame_entry *split,
530 struct blame_entry *e,
531 int tlno, int plno, int same,
532 struct origin *parent)
535 memset(split, 0, sizeof(struct blame_entry [3]));
537 if (e->s_lno < tlno) {
538 /* there is a pre-chunk part not blamed on parent */
539 split[0].suspect = origin_incref(e->suspect);
540 split[0].lno = e->lno;
541 split[0].s_lno = e->s_lno;
542 split[0].num_lines = tlno - e->s_lno;
543 split[1].lno = e->lno + tlno - e->s_lno;
544 split[1].s_lno = plno;
547 split[1].lno = e->lno;
548 split[1].s_lno = plno + (e->s_lno - tlno);
551 if (same < e->s_lno + e->num_lines) {
552 /* there is a post-chunk part not blamed on parent */
553 split[2].suspect = origin_incref(e->suspect);
554 split[2].lno = e->lno + (same - e->s_lno);
555 split[2].s_lno = e->s_lno + (same - e->s_lno);
556 split[2].num_lines = e->s_lno + e->num_lines - same;
557 chunk_end_lno = split[2].lno;
560 chunk_end_lno = e->lno + e->num_lines;
561 split[1].num_lines = chunk_end_lno - split[1].lno;
564 * if it turns out there is nothing to blame the parent for,
565 * forget about the splitting. !split[1].suspect signals this.
567 if (split[1].num_lines < 1)
569 split[1].suspect = origin_incref(parent);
573 * split_overlap() divided an existing blame e into up to three parts
574 * in split. Adjust the linked list of blames in the scoreboard to
577 static void split_blame(struct scoreboard *sb,
578 struct blame_entry *split,
579 struct blame_entry *e)
581 struct blame_entry *new_entry;
583 if (split[0].suspect && split[2].suspect) {
584 /* The first part (reuse storage for the existing entry e) */
585 dup_entry(e, &split[0]);
587 /* The last part -- me */
588 new_entry = xmalloc(sizeof(*new_entry));
589 memcpy(new_entry, &(split[2]), sizeof(struct blame_entry));
590 add_blame_entry(sb, new_entry);
592 /* ... and the middle part -- parent */
593 new_entry = xmalloc(sizeof(*new_entry));
594 memcpy(new_entry, &(split[1]), sizeof(struct blame_entry));
595 add_blame_entry(sb, new_entry);
597 else if (!split[0].suspect && !split[2].suspect)
599 * The parent covers the entire area; reuse storage for
600 * e and replace it with the parent.
602 dup_entry(e, &split[1]);
603 else if (split[0].suspect) {
604 /* me and then parent */
605 dup_entry(e, &split[0]);
607 new_entry = xmalloc(sizeof(*new_entry));
608 memcpy(new_entry, &(split[1]), sizeof(struct blame_entry));
609 add_blame_entry(sb, new_entry);
612 /* parent and then me */
613 dup_entry(e, &split[1]);
615 new_entry = xmalloc(sizeof(*new_entry));
616 memcpy(new_entry, &(split[2]), sizeof(struct blame_entry));
617 add_blame_entry(sb, new_entry);
620 if (DEBUG) { /* sanity */
621 struct blame_entry *ent;
622 int lno = sb->ent->lno, corrupt = 0;
624 for (ent = sb->ent; ent; ent = ent->next) {
629 lno += ent->num_lines;
633 for (ent = sb->ent; ent; ent = ent->next) {
634 printf("L %8d l %8d n %8d\n",
635 lno, ent->lno, ent->num_lines);
636 lno = ent->lno + ent->num_lines;
644 * After splitting the blame, the origins used by the
645 * on-stack blame_entry should lose one refcnt each.
647 static void decref_split(struct blame_entry *split)
651 for (i = 0; i < 3; i++)
652 origin_decref(split[i].suspect);
656 * Helper for blame_chunk(). blame_entry e is known to overlap with
657 * the patch hunk; split it and pass blame to the parent.
659 static void blame_overlap(struct scoreboard *sb, struct blame_entry *e,
660 int tlno, int plno, int same,
661 struct origin *parent)
663 struct blame_entry split[3];
665 split_overlap(split, e, tlno, plno, same, parent);
666 if (split[1].suspect)
667 split_blame(sb, split, e);
672 * Find the line number of the last line the target is suspected for.
674 static int find_last_in_target(struct scoreboard *sb, struct origin *target)
676 struct blame_entry *e;
677 int last_in_target = -1;
679 for (e = sb->ent; e; e = e->next) {
680 if (e->guilty || !same_suspect(e->suspect, target))
682 if (last_in_target < e->s_lno + e->num_lines)
683 last_in_target = e->s_lno + e->num_lines;
685 return last_in_target;
689 * Process one hunk from the patch between the current suspect for
690 * blame_entry e and its parent. Find and split the overlap, and
691 * pass blame to the overlapping part to the parent.
693 static void blame_chunk(struct scoreboard *sb,
694 int tlno, int plno, int same,
695 struct origin *target, struct origin *parent)
697 struct blame_entry *e;
699 for (e = sb->ent; e; e = e->next) {
700 if (e->guilty || !same_suspect(e->suspect, target))
702 if (same <= e->s_lno)
704 if (tlno < e->s_lno + e->num_lines)
705 blame_overlap(sb, e, tlno, plno, same, parent);
709 struct blame_chunk_cb_data {
710 struct scoreboard *sb;
711 struct origin *target;
712 struct origin *parent;
717 static void blame_chunk_cb(void *data, long same, long p_next, long t_next)
719 struct blame_chunk_cb_data *d = data;
720 blame_chunk(d->sb, d->tlno, d->plno, same, d->target, d->parent);
726 * We are looking at the origin 'target' and aiming to pass blame
727 * for the lines it is suspected to its parent. Run diff to find
728 * which lines came from parent and pass blame for them.
730 static int pass_blame_to_parent(struct scoreboard *sb,
731 struct origin *target,
732 struct origin *parent)
735 mmfile_t file_p, file_o;
736 struct blame_chunk_cb_data d = { sb, target, parent, 0, 0 };
740 last_in_target = find_last_in_target(sb, target);
741 if (last_in_target < 0)
742 return 1; /* nothing remains for this target */
744 fill_origin_blob(parent, &file_p);
745 fill_origin_blob(target, &file_o);
748 memset(&xpp, 0, sizeof(xpp));
749 xpp.flags = xdl_opts;
750 memset(&xecfg, 0, sizeof(xecfg));
752 xdi_diff_hunks(&file_p, &file_o, blame_chunk_cb, &d, &xpp, &xecfg);
753 /* The rest (i.e. anything after tlno) are the same as the parent */
754 blame_chunk(sb, d.tlno, d.plno, last_in_target, target, parent);
760 * The lines in blame_entry after splitting blames many times can become
761 * very small and trivial, and at some point it becomes pointless to
762 * blame the parents. E.g. "\t\t}\n\t}\n\n" appears everywhere in any
763 * ordinary C program, and it is not worth to say it was copied from
764 * totally unrelated file in the parent.
766 * Compute how trivial the lines in the blame_entry are.
768 static unsigned ent_score(struct scoreboard *sb, struct blame_entry *e)
777 cp = nth_line(sb, e->lno);
778 ep = nth_line(sb, e->lno + e->num_lines);
780 unsigned ch = *((unsigned char *)cp);
790 * best_so_far[] and this[] are both a split of an existing blame_entry
791 * that passes blame to the parent. Maintain best_so_far the best split
792 * so far, by comparing this and best_so_far and copying this into
793 * bst_so_far as needed.
795 static void copy_split_if_better(struct scoreboard *sb,
796 struct blame_entry *best_so_far,
797 struct blame_entry *this)
801 if (!this[1].suspect)
803 if (best_so_far[1].suspect) {
804 if (ent_score(sb, &this[1]) < ent_score(sb, &best_so_far[1]))
808 for (i = 0; i < 3; i++)
809 origin_incref(this[i].suspect);
810 decref_split(best_so_far);
811 memcpy(best_so_far, this, sizeof(struct blame_entry [3]));
815 * We are looking at a part of the final image represented by
816 * ent (tlno and same are offset by ent->s_lno).
817 * tlno is where we are looking at in the final image.
818 * up to (but not including) same match preimage.
819 * plno is where we are looking at in the preimage.
821 * <-------------- final image ---------------------->
824 * <---------preimage----->
827 * All line numbers are 0-based.
829 static void handle_split(struct scoreboard *sb,
830 struct blame_entry *ent,
831 int tlno, int plno, int same,
832 struct origin *parent,
833 struct blame_entry *split)
835 if (ent->num_lines <= tlno)
838 struct blame_entry this[3];
841 split_overlap(this, ent, tlno, plno, same, parent);
842 copy_split_if_better(sb, split, this);
847 struct handle_split_cb_data {
848 struct scoreboard *sb;
849 struct blame_entry *ent;
850 struct origin *parent;
851 struct blame_entry *split;
856 static void handle_split_cb(void *data, long same, long p_next, long t_next)
858 struct handle_split_cb_data *d = data;
859 handle_split(d->sb, d->ent, d->tlno, d->plno, same, d->parent, d->split);
865 * Find the lines from parent that are the same as ent so that
866 * we can pass blames to it. file_p has the blob contents for
869 static void find_copy_in_blob(struct scoreboard *sb,
870 struct blame_entry *ent,
871 struct origin *parent,
872 struct blame_entry *split,
878 struct handle_split_cb_data d = { sb, ent, parent, split, 0, 0 };
883 * Prepare mmfile that contains only the lines in ent.
885 cp = nth_line(sb, ent->lno);
886 file_o.ptr = (char *) cp;
887 cnt = ent->num_lines;
889 while (cnt && cp < sb->final_buf + sb->final_buf_size) {
893 file_o.size = cp - file_o.ptr;
896 * file_o is a part of final image we are annotating.
897 * file_p partially may match that image.
899 memset(&xpp, 0, sizeof(xpp));
900 xpp.flags = xdl_opts;
901 memset(&xecfg, 0, sizeof(xecfg));
903 memset(split, 0, sizeof(struct blame_entry [3]));
904 xdi_diff_hunks(file_p, &file_o, handle_split_cb, &d, &xpp, &xecfg);
905 /* remainder, if any, all match the preimage */
906 handle_split(sb, ent, d.tlno, d.plno, ent->num_lines, parent, split);
910 * See if lines currently target is suspected for can be attributed to
913 static int find_move_in_parent(struct scoreboard *sb,
914 struct origin *target,
915 struct origin *parent)
917 int last_in_target, made_progress;
918 struct blame_entry *e, split[3];
921 last_in_target = find_last_in_target(sb, target);
922 if (last_in_target < 0)
923 return 1; /* nothing remains for this target */
925 fill_origin_blob(parent, &file_p);
930 while (made_progress) {
932 for (e = sb->ent; e; e = e->next) {
933 if (e->guilty || !same_suspect(e->suspect, target) ||
934 ent_score(sb, e) < blame_move_score)
936 find_copy_in_blob(sb, e, parent, split, &file_p);
937 if (split[1].suspect &&
938 blame_move_score < ent_score(sb, &split[1])) {
939 split_blame(sb, split, e);
949 struct blame_entry *ent;
950 struct blame_entry split[3];
954 * Count the number of entries the target is suspected for,
955 * and prepare a list of entry and the best split.
957 static struct blame_list *setup_blame_list(struct scoreboard *sb,
958 struct origin *target,
962 struct blame_entry *e;
964 struct blame_list *blame_list = NULL;
966 for (e = sb->ent, num_ents = 0; e; e = e->next)
967 if (!e->scanned && !e->guilty &&
968 same_suspect(e->suspect, target) &&
969 min_score < ent_score(sb, e))
972 blame_list = xcalloc(num_ents, sizeof(struct blame_list));
973 for (e = sb->ent, i = 0; e; e = e->next)
974 if (!e->scanned && !e->guilty &&
975 same_suspect(e->suspect, target) &&
976 min_score < ent_score(sb, e))
977 blame_list[i++].ent = e;
979 *num_ents_p = num_ents;
984 * Reset the scanned status on all entries.
986 static void reset_scanned_flag(struct scoreboard *sb)
988 struct blame_entry *e;
989 for (e = sb->ent; e; e = e->next)
994 * For lines target is suspected for, see if we can find code movement
995 * across file boundary from the parent commit. porigin is the path
996 * in the parent we already tried.
998 static int find_copy_in_parent(struct scoreboard *sb,
999 struct origin *target,
1000 struct commit *parent,
1001 struct origin *porigin,
1004 struct diff_options diff_opts;
1005 const char *paths[1];
1008 struct blame_list *blame_list;
1011 blame_list = setup_blame_list(sb, target, blame_copy_score, &num_ents);
1013 return 1; /* nothing remains for this target */
1015 diff_setup(&diff_opts);
1016 DIFF_OPT_SET(&diff_opts, RECURSIVE);
1017 diff_opts.output_format = DIFF_FORMAT_NO_OUTPUT;
1020 diff_tree_setup_paths(paths, &diff_opts);
1021 if (diff_setup_done(&diff_opts) < 0)
1024 /* Try "find copies harder" on new path if requested;
1025 * we do not want to use diffcore_rename() actually to
1026 * match things up; find_copies_harder is set only to
1027 * force diff_tree_sha1() to feed all filepairs to diff_queue,
1028 * and this code needs to be after diff_setup_done(), which
1029 * usually makes find-copies-harder imply copy detection.
1031 if ((opt & PICKAXE_BLAME_COPY_HARDEST)
1032 || ((opt & PICKAXE_BLAME_COPY_HARDER)
1033 && (!porigin || strcmp(target->path, porigin->path))))
1034 DIFF_OPT_SET(&diff_opts, FIND_COPIES_HARDER);
1036 if (is_null_sha1(target->commit->object.sha1))
1037 do_diff_cache(parent->tree->object.sha1, &diff_opts);
1039 diff_tree_sha1(parent->tree->object.sha1,
1040 target->commit->tree->object.sha1,
1043 if (!DIFF_OPT_TST(&diff_opts, FIND_COPIES_HARDER))
1044 diffcore_std(&diff_opts);
1048 int made_progress = 0;
1050 for (i = 0; i < diff_queued_diff.nr; i++) {
1051 struct diff_filepair *p = diff_queued_diff.queue[i];
1052 struct origin *norigin;
1054 struct blame_entry this[3];
1056 if (!DIFF_FILE_VALID(p->one))
1057 continue; /* does not exist in parent */
1058 if (S_ISGITLINK(p->one->mode))
1059 continue; /* ignore git links */
1060 if (porigin && !strcmp(p->one->path, porigin->path))
1061 /* find_move already dealt with this path */
1064 norigin = get_origin(sb, parent, p->one->path);
1065 hashcpy(norigin->blob_sha1, p->one->sha1);
1066 fill_origin_blob(norigin, &file_p);
1070 for (j = 0; j < num_ents; j++) {
1071 find_copy_in_blob(sb, blame_list[j].ent,
1072 norigin, this, &file_p);
1073 copy_split_if_better(sb, blame_list[j].split,
1077 origin_decref(norigin);
1080 for (j = 0; j < num_ents; j++) {
1081 struct blame_entry *split = blame_list[j].split;
1082 if (split[1].suspect &&
1083 blame_copy_score < ent_score(sb, &split[1])) {
1084 split_blame(sb, split, blame_list[j].ent);
1088 blame_list[j].ent->scanned = 1;
1089 decref_split(split);
1095 blame_list = setup_blame_list(sb, target, blame_copy_score, &num_ents);
1101 reset_scanned_flag(sb);
1102 diff_flush(&diff_opts);
1103 diff_tree_release_paths(&diff_opts);
1108 * The blobs of origin and porigin exactly match, so everything
1109 * origin is suspected for can be blamed on the parent.
1111 static void pass_whole_blame(struct scoreboard *sb,
1112 struct origin *origin, struct origin *porigin)
1114 struct blame_entry *e;
1116 if (!porigin->file.ptr && origin->file.ptr) {
1117 /* Steal its file */
1118 porigin->file = origin->file;
1119 origin->file.ptr = NULL;
1121 for (e = sb->ent; e; e = e->next) {
1122 if (!same_suspect(e->suspect, origin))
1124 origin_incref(porigin);
1125 origin_decref(e->suspect);
1126 e->suspect = porigin;
1131 * We pass blame from the current commit to its parents. We keep saying
1132 * "parent" (and "porigin"), but what we mean is to find scapegoat to
1133 * exonerate ourselves.
1135 static struct commit_list *first_scapegoat(struct rev_info *revs, struct commit *commit)
1138 return commit->parents;
1139 return lookup_decoration(&revs->children, &commit->object);
1142 static int num_scapegoats(struct rev_info *revs, struct commit *commit)
1145 struct commit_list *l = first_scapegoat(revs, commit);
1146 for (cnt = 0; l; l = l->next)
1153 static void pass_blame(struct scoreboard *sb, struct origin *origin, int opt)
1155 struct rev_info *revs = sb->revs;
1156 int i, pass, num_sg;
1157 struct commit *commit = origin->commit;
1158 struct commit_list *sg;
1159 struct origin *sg_buf[MAXSG];
1160 struct origin *porigin, **sg_origin = sg_buf;
1162 num_sg = num_scapegoats(revs, commit);
1165 else if (num_sg < ARRAY_SIZE(sg_buf))
1166 memset(sg_buf, 0, sizeof(sg_buf));
1168 sg_origin = xcalloc(num_sg, sizeof(*sg_origin));
1171 * The first pass looks for unrenamed path to optimize for
1172 * common cases, then we look for renames in the second pass.
1174 for (pass = 0; pass < 2; pass++) {
1175 struct origin *(*find)(struct scoreboard *,
1176 struct commit *, struct origin *);
1177 find = pass ? find_rename : find_origin;
1179 for (i = 0, sg = first_scapegoat(revs, commit);
1181 sg = sg->next, i++) {
1182 struct commit *p = sg->item;
1187 if (parse_commit(p))
1189 porigin = find(sb, p, origin);
1192 if (!hashcmp(porigin->blob_sha1, origin->blob_sha1)) {
1193 pass_whole_blame(sb, origin, porigin);
1194 origin_decref(porigin);
1197 for (j = same = 0; j < i; j++)
1199 !hashcmp(sg_origin[j]->blob_sha1,
1200 porigin->blob_sha1)) {
1205 sg_origin[i] = porigin;
1207 origin_decref(porigin);
1212 for (i = 0, sg = first_scapegoat(revs, commit);
1214 sg = sg->next, i++) {
1215 struct origin *porigin = sg_origin[i];
1218 if (!origin->previous) {
1219 origin_incref(porigin);
1220 origin->previous = porigin;
1222 if (pass_blame_to_parent(sb, origin, porigin))
1227 * Optionally find moves in parents' files.
1229 if (opt & PICKAXE_BLAME_MOVE)
1230 for (i = 0, sg = first_scapegoat(revs, commit);
1232 sg = sg->next, i++) {
1233 struct origin *porigin = sg_origin[i];
1236 if (find_move_in_parent(sb, origin, porigin))
1241 * Optionally find copies from parents' files.
1243 if (opt & PICKAXE_BLAME_COPY)
1244 for (i = 0, sg = first_scapegoat(revs, commit);
1246 sg = sg->next, i++) {
1247 struct origin *porigin = sg_origin[i];
1248 if (find_copy_in_parent(sb, origin, sg->item,
1254 for (i = 0; i < num_sg; i++) {
1256 drop_origin_blob(sg_origin[i]);
1257 origin_decref(sg_origin[i]);
1260 drop_origin_blob(origin);
1261 if (sg_buf != sg_origin)
1266 * Information on commits, used for output.
1271 const char *author_mail;
1272 unsigned long author_time;
1273 const char *author_tz;
1275 /* filled only when asked for details */
1276 const char *committer;
1277 const char *committer_mail;
1278 unsigned long committer_time;
1279 const char *committer_tz;
1281 const char *summary;
1285 * Parse author/committer line in the commit object buffer
1287 static void get_ac_line(const char *inbuf, const char *what,
1288 int person_len, char *person,
1289 int mail_len, char *mail,
1290 unsigned long *time, const char **tz)
1292 int len, tzlen, maillen;
1293 char *tmp, *endp, *timepos, *mailpos;
1295 tmp = strstr(inbuf, what);
1298 tmp += strlen(what);
1299 endp = strchr(tmp, '\n');
1304 if (person_len <= len) {
1312 memcpy(person, tmp, len);
1320 tzlen = (person+len)-(tmp+1);
1325 *time = strtoul(tmp, NULL, 10);
1333 maillen = timepos - tmp;
1334 memcpy(mail, mailpos, maillen);
1340 * mailmap expansion may make the name longer.
1341 * make room by pushing stuff down.
1343 tmp = person + person_len - (tzlen + 1);
1344 memmove(tmp, *tz, tzlen);
1349 * Now, convert both name and e-mail using mailmap
1351 if(map_user(&mailmap, mail+1, mail_len-1, person, tmp-person-1)) {
1352 /* Add a trailing '>' to email, since map_user returns plain emails
1353 Note: It already has '<', since we replace from mail+1 */
1354 mailpos = memchr(mail, '\0', mail_len);
1355 if (mailpos && mailpos-mail < mail_len - 1) {
1357 *(mailpos+1) = '\0';
1362 static void get_commit_info(struct commit *commit,
1363 struct commit_info *ret,
1367 char *tmp, *endp, *reencoded, *message;
1368 static char author_name[1024];
1369 static char author_mail[1024];
1370 static char committer_name[1024];
1371 static char committer_mail[1024];
1372 static char summary_buf[1024];
1375 * We've operated without save_commit_buffer, so
1376 * we now need to populate them for output.
1378 if (!commit->buffer) {
1379 enum object_type type;
1382 read_sha1_file(commit->object.sha1, &type, &size);
1383 if (!commit->buffer)
1384 die("Cannot read commit %s",
1385 sha1_to_hex(commit->object.sha1));
1387 reencoded = reencode_commit_message(commit, NULL);
1388 message = reencoded ? reencoded : commit->buffer;
1389 ret->author = author_name;
1390 ret->author_mail = author_mail;
1391 get_ac_line(message, "\nauthor ",
1392 sizeof(author_name), author_name,
1393 sizeof(author_mail), author_mail,
1394 &ret->author_time, &ret->author_tz);
1401 ret->committer = committer_name;
1402 ret->committer_mail = committer_mail;
1403 get_ac_line(message, "\ncommitter ",
1404 sizeof(committer_name), committer_name,
1405 sizeof(committer_mail), committer_mail,
1406 &ret->committer_time, &ret->committer_tz);
1408 ret->summary = summary_buf;
1409 tmp = strstr(message, "\n\n");
1412 sprintf(summary_buf, "(%s)", sha1_to_hex(commit->object.sha1));
1417 endp = strchr(tmp, '\n');
1419 endp = tmp + strlen(tmp);
1421 if (len >= sizeof(summary_buf) || len == 0)
1423 memcpy(summary_buf, tmp, len);
1424 summary_buf[len] = 0;
1429 * To allow LF and other nonportable characters in pathnames,
1430 * they are c-style quoted as needed.
1432 static void write_filename_info(const char *path)
1434 printf("filename ");
1435 write_name_quoted(path, stdout, '\n');
1439 * Porcelain/Incremental format wants to show a lot of details per
1440 * commit. Instead of repeating this every line, emit it only once,
1441 * the first time each commit appears in the output.
1443 static int emit_one_suspect_detail(struct origin *suspect)
1445 struct commit_info ci;
1447 if (suspect->commit->object.flags & METAINFO_SHOWN)
1450 suspect->commit->object.flags |= METAINFO_SHOWN;
1451 get_commit_info(suspect->commit, &ci, 1);
1452 printf("author %s\n", ci.author);
1453 printf("author-mail %s\n", ci.author_mail);
1454 printf("author-time %lu\n", ci.author_time);
1455 printf("author-tz %s\n", ci.author_tz);
1456 printf("committer %s\n", ci.committer);
1457 printf("committer-mail %s\n", ci.committer_mail);
1458 printf("committer-time %lu\n", ci.committer_time);
1459 printf("committer-tz %s\n", ci.committer_tz);
1460 printf("summary %s\n", ci.summary);
1461 if (suspect->commit->object.flags & UNINTERESTING)
1462 printf("boundary\n");
1463 if (suspect->previous) {
1464 struct origin *prev = suspect->previous;
1465 printf("previous %s ", sha1_to_hex(prev->commit->object.sha1));
1466 write_name_quoted(prev->path, stdout, '\n');
1472 * The blame_entry is found to be guilty for the range. Mark it
1473 * as such, and show it in incremental output.
1475 static void found_guilty_entry(struct blame_entry *ent)
1481 struct origin *suspect = ent->suspect;
1483 printf("%s %d %d %d\n",
1484 sha1_to_hex(suspect->commit->object.sha1),
1485 ent->s_lno + 1, ent->lno + 1, ent->num_lines);
1486 emit_one_suspect_detail(suspect);
1487 write_filename_info(suspect->path);
1488 maybe_flush_or_die(stdout, "stdout");
1493 * The main loop -- while the scoreboard has lines whose true origin
1494 * is still unknown, pick one blame_entry, and allow its current
1495 * suspect to pass blames to its parents.
1497 static void assign_blame(struct scoreboard *sb, int opt)
1499 struct rev_info *revs = sb->revs;
1502 struct blame_entry *ent;
1503 struct commit *commit;
1504 struct origin *suspect = NULL;
1506 /* find one suspect to break down */
1507 for (ent = sb->ent; !suspect && ent; ent = ent->next)
1509 suspect = ent->suspect;
1511 return; /* all done */
1514 * We will use this suspect later in the loop,
1515 * so hold onto it in the meantime.
1517 origin_incref(suspect);
1518 commit = suspect->commit;
1519 if (!commit->object.parsed)
1520 parse_commit(commit);
1522 (!(commit->object.flags & UNINTERESTING) &&
1523 !(revs->max_age != -1 && commit->date < revs->max_age)))
1524 pass_blame(sb, suspect, opt);
1526 commit->object.flags |= UNINTERESTING;
1527 if (commit->object.parsed)
1528 mark_parents_uninteresting(commit);
1530 /* treat root commit as boundary */
1531 if (!commit->parents && !show_root)
1532 commit->object.flags |= UNINTERESTING;
1534 /* Take responsibility for the remaining entries */
1535 for (ent = sb->ent; ent; ent = ent->next)
1536 if (same_suspect(ent->suspect, suspect))
1537 found_guilty_entry(ent);
1538 origin_decref(suspect);
1540 if (DEBUG) /* sanity */
1541 sanity_check_refcnt(sb);
1545 static const char *format_time(unsigned long time, const char *tz_str,
1548 static char time_buf[128];
1549 const char *time_str;
1553 if (show_raw_time) {
1554 sprintf(time_buf, "%lu %s", time, tz_str);
1558 time_str = show_date(time, tz, blame_date_mode);
1559 time_len = strlen(time_str);
1560 memcpy(time_buf, time_str, time_len);
1561 memset(time_buf + time_len, ' ', blame_date_width - time_len);
1566 #define OUTPUT_ANNOTATE_COMPAT 001
1567 #define OUTPUT_LONG_OBJECT_NAME 002
1568 #define OUTPUT_RAW_TIMESTAMP 004
1569 #define OUTPUT_PORCELAIN 010
1570 #define OUTPUT_SHOW_NAME 020
1571 #define OUTPUT_SHOW_NUMBER 040
1572 #define OUTPUT_SHOW_SCORE 0100
1573 #define OUTPUT_NO_AUTHOR 0200
1575 static void emit_porcelain(struct scoreboard *sb, struct blame_entry *ent)
1579 struct origin *suspect = ent->suspect;
1582 strcpy(hex, sha1_to_hex(suspect->commit->object.sha1));
1583 printf("%s%c%d %d %d\n",
1585 ent->guilty ? ' ' : '*', // purely for debugging
1589 if (emit_one_suspect_detail(suspect) ||
1590 (suspect->commit->object.flags & MORE_THAN_ONE_PATH))
1591 write_filename_info(suspect->path);
1593 cp = nth_line(sb, ent->lno);
1594 for (cnt = 0; cnt < ent->num_lines; cnt++) {
1597 printf("%s %d %d\n", hex,
1598 ent->s_lno + 1 + cnt,
1599 ent->lno + 1 + cnt);
1604 } while (ch != '\n' &&
1605 cp < sb->final_buf + sb->final_buf_size);
1609 static void emit_other(struct scoreboard *sb, struct blame_entry *ent, int opt)
1613 struct origin *suspect = ent->suspect;
1614 struct commit_info ci;
1616 int show_raw_time = !!(opt & OUTPUT_RAW_TIMESTAMP);
1618 get_commit_info(suspect->commit, &ci, 1);
1619 strcpy(hex, sha1_to_hex(suspect->commit->object.sha1));
1621 cp = nth_line(sb, ent->lno);
1622 for (cnt = 0; cnt < ent->num_lines; cnt++) {
1624 int length = (opt & OUTPUT_LONG_OBJECT_NAME) ? 40 : 8;
1626 if (suspect->commit->object.flags & UNINTERESTING) {
1628 memset(hex, ' ', length);
1629 else if (!(opt & OUTPUT_ANNOTATE_COMPAT)) {
1635 printf("%.*s", length, hex);
1636 if (opt & OUTPUT_ANNOTATE_COMPAT)
1637 printf("\t(%10s\t%10s\t%d)", ci.author,
1638 format_time(ci.author_time, ci.author_tz,
1640 ent->lno + 1 + cnt);
1642 if (opt & OUTPUT_SHOW_SCORE)
1644 max_score_digits, ent->score,
1645 ent->suspect->refcnt);
1646 if (opt & OUTPUT_SHOW_NAME)
1647 printf(" %-*.*s", longest_file, longest_file,
1649 if (opt & OUTPUT_SHOW_NUMBER)
1650 printf(" %*d", max_orig_digits,
1651 ent->s_lno + 1 + cnt);
1653 if (!(opt & OUTPUT_NO_AUTHOR)) {
1654 int pad = longest_author - utf8_strwidth(ci.author);
1655 printf(" (%s%*s %10s",
1657 format_time(ci.author_time,
1662 max_digits, ent->lno + 1 + cnt);
1667 } while (ch != '\n' &&
1668 cp < sb->final_buf + sb->final_buf_size);
1672 static void output(struct scoreboard *sb, int option)
1674 struct blame_entry *ent;
1676 if (option & OUTPUT_PORCELAIN) {
1677 for (ent = sb->ent; ent; ent = ent->next) {
1678 struct blame_entry *oth;
1679 struct origin *suspect = ent->suspect;
1680 struct commit *commit = suspect->commit;
1681 if (commit->object.flags & MORE_THAN_ONE_PATH)
1683 for (oth = ent->next; oth; oth = oth->next) {
1684 if ((oth->suspect->commit != commit) ||
1685 !strcmp(oth->suspect->path, suspect->path))
1687 commit->object.flags |= MORE_THAN_ONE_PATH;
1693 for (ent = sb->ent; ent; ent = ent->next) {
1694 if (option & OUTPUT_PORCELAIN)
1695 emit_porcelain(sb, ent);
1697 emit_other(sb, ent, option);
1703 * To allow quick access to the contents of nth line in the
1704 * final image, prepare an index in the scoreboard.
1706 static int prepare_lines(struct scoreboard *sb)
1708 const char *buf = sb->final_buf;
1709 unsigned long len = sb->final_buf_size;
1710 int num = 0, incomplete = 0, bol = 1;
1712 if (len && buf[len-1] != '\n')
1713 incomplete++; /* incomplete line at the end */
1716 sb->lineno = xrealloc(sb->lineno,
1717 sizeof(int *) * (num + 1));
1718 sb->lineno[num] = buf - sb->final_buf;
1721 if (*buf++ == '\n') {
1726 sb->lineno = xrealloc(sb->lineno,
1727 sizeof(int *) * (num + incomplete + 1));
1728 sb->lineno[num + incomplete] = buf - sb->final_buf;
1729 sb->num_lines = num + incomplete;
1730 return sb->num_lines;
1734 * Add phony grafts for use with -S; this is primarily to
1735 * support git's cvsserver that wants to give a linear history
1738 static int read_ancestry(const char *graft_file)
1740 FILE *fp = fopen(graft_file, "r");
1744 while (fgets(buf, sizeof(buf), fp)) {
1745 /* The format is just "Commit Parent1 Parent2 ...\n" */
1746 int len = strlen(buf);
1747 struct commit_graft *graft = read_graft_line(buf, len);
1749 register_commit_graft(graft, 0);
1756 * How many columns do we need to show line numbers in decimal?
1758 static int lineno_width(int lines)
1762 for (width = 1, i = 10; i <= lines + 1; width++)
1768 * How many columns do we need to show line numbers, authors,
1771 static void find_alignment(struct scoreboard *sb, int *option)
1773 int longest_src_lines = 0;
1774 int longest_dst_lines = 0;
1775 unsigned largest_score = 0;
1776 struct blame_entry *e;
1778 for (e = sb->ent; e; e = e->next) {
1779 struct origin *suspect = e->suspect;
1780 struct commit_info ci;
1783 if (strcmp(suspect->path, sb->path))
1784 *option |= OUTPUT_SHOW_NAME;
1785 num = strlen(suspect->path);
1786 if (longest_file < num)
1788 if (!(suspect->commit->object.flags & METAINFO_SHOWN)) {
1789 suspect->commit->object.flags |= METAINFO_SHOWN;
1790 get_commit_info(suspect->commit, &ci, 1);
1791 num = utf8_strwidth(ci.author);
1792 if (longest_author < num)
1793 longest_author = num;
1795 num = e->s_lno + e->num_lines;
1796 if (longest_src_lines < num)
1797 longest_src_lines = num;
1798 num = e->lno + e->num_lines;
1799 if (longest_dst_lines < num)
1800 longest_dst_lines = num;
1801 if (largest_score < ent_score(sb, e))
1802 largest_score = ent_score(sb, e);
1804 max_orig_digits = lineno_width(longest_src_lines);
1805 max_digits = lineno_width(longest_dst_lines);
1806 max_score_digits = lineno_width(largest_score);
1810 * For debugging -- origin is refcounted, and this asserts that
1811 * we do not underflow.
1813 static void sanity_check_refcnt(struct scoreboard *sb)
1816 struct blame_entry *ent;
1818 for (ent = sb->ent; ent; ent = ent->next) {
1819 /* Nobody should have zero or negative refcnt */
1820 if (ent->suspect->refcnt <= 0) {
1821 fprintf(stderr, "%s in %s has negative refcnt %d\n",
1823 sha1_to_hex(ent->suspect->commit->object.sha1),
1824 ent->suspect->refcnt);
1830 find_alignment(sb, &opt);
1832 die("Baa %d!", baa);
1837 * Used for the command line parsing; check if the path exists
1838 * in the working tree.
1840 static int has_string_in_work_tree(const char *path)
1843 return !lstat(path, &st);
1846 static unsigned parse_score(const char *arg)
1849 unsigned long score = strtoul(arg, &end, 10);
1855 static const char *add_prefix(const char *prefix, const char *path)
1857 return prefix_path(prefix, prefix ? strlen(prefix) : 0, path);
1861 * Parsing of (comma separated) one item in the -L option
1863 static const char *parse_loc(const char *spec,
1864 struct scoreboard *sb, long lno,
1865 long begin, long *ret)
1872 regmatch_t match[1];
1874 /* Allow "-L <something>,+20" to mean starting at <something>
1875 * for 20 lines, or "-L <something>,-5" for 5 lines ending at
1878 if (1 < begin && (spec[0] == '+' || spec[0] == '-')) {
1879 num = strtol(spec + 1, &term, 10);
1880 if (term != spec + 1) {
1884 *ret = begin + num - 2;
1893 num = strtol(spec, &term, 10);
1901 /* it could be a regexp of form /.../ */
1902 for (term = (char *) spec + 1; *term && *term != '/'; term++) {
1909 /* try [spec+1 .. term-1] as regexp */
1911 begin--; /* input is in human terms */
1912 line = nth_line(sb, begin);
1914 if (!(reg_error = regcomp(®exp, spec + 1, REG_NEWLINE)) &&
1915 !(reg_error = regexec(®exp, line, 1, match, 0))) {
1916 const char *cp = line + match[0].rm_so;
1919 while (begin++ < lno) {
1920 nline = nth_line(sb, begin);
1921 if (line <= cp && cp < nline)
1932 regerror(reg_error, ®exp, errbuf, 1024);
1933 die("-L parameter '%s': %s", spec + 1, errbuf);
1938 * Parsing of -L option
1940 static void prepare_blame_range(struct scoreboard *sb,
1941 const char *bottomtop,
1943 long *bottom, long *top)
1947 term = parse_loc(bottomtop, sb, lno, 1, bottom);
1949 term = parse_loc(term + 1, sb, lno, *bottom + 1, top);
1957 static int git_blame_config(const char *var, const char *value, void *cb)
1959 if (!strcmp(var, "blame.showroot")) {
1960 show_root = git_config_bool(var, value);
1963 if (!strcmp(var, "blame.blankboundary")) {
1964 blank_boundary = git_config_bool(var, value);
1967 if (!strcmp(var, "blame.date")) {
1969 return config_error_nonbool(var);
1970 blame_date_mode = parse_date_format(value);
1973 return git_default_config(var, value, cb);
1977 * Prepare a dummy commit that represents the work tree (or staged) item.
1978 * Note that annotating work tree item never works in the reverse.
1980 static struct commit *fake_working_tree_commit(const char *path, const char *contents_from)
1982 struct commit *commit;
1983 struct origin *origin;
1984 unsigned char head_sha1[20];
1985 struct strbuf buf = STRBUF_INIT;
1989 struct cache_entry *ce;
1992 if (get_sha1("HEAD", head_sha1))
1993 die("No such ref: HEAD");
1996 commit = xcalloc(1, sizeof(*commit));
1997 commit->parents = xcalloc(1, sizeof(*commit->parents));
1998 commit->parents->item = lookup_commit_reference(head_sha1);
1999 commit->object.parsed = 1;
2001 commit->object.type = OBJ_COMMIT;
2003 origin = make_origin(commit, path);
2005 if (!contents_from || strcmp("-", contents_from)) {
2007 const char *read_from;
2009 if (contents_from) {
2010 if (stat(contents_from, &st) < 0)
2011 die_errno("Cannot stat '%s'", contents_from);
2012 read_from = contents_from;
2015 if (lstat(path, &st) < 0)
2016 die_errno("Cannot lstat '%s'", path);
2019 mode = canon_mode(st.st_mode);
2020 switch (st.st_mode & S_IFMT) {
2022 if (strbuf_read_file(&buf, read_from, st.st_size) != st.st_size)
2023 die_errno("cannot open or read '%s'", read_from);
2026 if (strbuf_readlink(&buf, read_from, st.st_size) < 0)
2027 die_errno("cannot readlink '%s'", read_from);
2030 die("unsupported file type %s", read_from);
2034 /* Reading from stdin */
2035 contents_from = "standard input";
2037 if (strbuf_read(&buf, 0, 0) < 0)
2038 die_errno("failed to read from stdin");
2040 convert_to_git(path, buf.buf, buf.len, &buf, 0);
2041 origin->file.ptr = buf.buf;
2042 origin->file.size = buf.len;
2043 pretend_sha1_file(buf.buf, buf.len, OBJ_BLOB, origin->blob_sha1);
2044 commit->util = origin;
2047 * Read the current index, replace the path entry with
2048 * origin->blob_sha1 without mucking with its mode or type
2049 * bits; we are not going to write this index out -- we just
2050 * want to run "diff-index --cached".
2057 int pos = cache_name_pos(path, len);
2059 mode = active_cache[pos]->ce_mode;
2061 /* Let's not bother reading from HEAD tree */
2062 mode = S_IFREG | 0644;
2064 size = cache_entry_size(len);
2065 ce = xcalloc(1, size);
2066 hashcpy(ce->sha1, origin->blob_sha1);
2067 memcpy(ce->name, path, len);
2068 ce->ce_flags = create_ce_flags(len, 0);
2069 ce->ce_mode = create_ce_mode(mode);
2070 add_cache_entry(ce, ADD_CACHE_OK_TO_ADD|ADD_CACHE_OK_TO_REPLACE);
2073 * We are not going to write this out, so this does not matter
2074 * right now, but someday we might optimize diff-index --cached
2075 * with cache-tree information.
2077 cache_tree_invalidate_path(active_cache_tree, path);
2079 commit->buffer = xmalloc(400);
2080 ident = fmt_ident("Not Committed Yet", "not.committed.yet", NULL, 0);
2081 snprintf(commit->buffer, 400,
2082 "tree 0000000000000000000000000000000000000000\n"
2086 "Version of %s from %s\n",
2087 sha1_to_hex(head_sha1),
2088 ident, ident, path, contents_from ? contents_from : path);
2092 static const char *prepare_final(struct scoreboard *sb)
2095 const char *final_commit_name = NULL;
2096 struct rev_info *revs = sb->revs;
2099 * There must be one and only one positive commit in the
2100 * revs->pending array.
2102 for (i = 0; i < revs->pending.nr; i++) {
2103 struct object *obj = revs->pending.objects[i].item;
2104 if (obj->flags & UNINTERESTING)
2106 while (obj->type == OBJ_TAG)
2107 obj = deref_tag(obj, NULL, 0);
2108 if (obj->type != OBJ_COMMIT)
2109 die("Non commit %s?", revs->pending.objects[i].name);
2111 die("More than one commit to dig from %s and %s?",
2112 revs->pending.objects[i].name,
2114 sb->final = (struct commit *) obj;
2115 final_commit_name = revs->pending.objects[i].name;
2117 return final_commit_name;
2120 static const char *prepare_initial(struct scoreboard *sb)
2123 const char *final_commit_name = NULL;
2124 struct rev_info *revs = sb->revs;
2127 * There must be one and only one negative commit, and it must be
2130 for (i = 0; i < revs->pending.nr; i++) {
2131 struct object *obj = revs->pending.objects[i].item;
2132 if (!(obj->flags & UNINTERESTING))
2134 while (obj->type == OBJ_TAG)
2135 obj = deref_tag(obj, NULL, 0);
2136 if (obj->type != OBJ_COMMIT)
2137 die("Non commit %s?", revs->pending.objects[i].name);
2139 die("More than one commit to dig down to %s and %s?",
2140 revs->pending.objects[i].name,
2142 sb->final = (struct commit *) obj;
2143 final_commit_name = revs->pending.objects[i].name;
2145 if (!final_commit_name)
2146 die("No commit to dig down to?");
2147 return final_commit_name;
2150 static int blame_copy_callback(const struct option *option, const char *arg, int unset)
2152 int *opt = option->value;
2155 * -C enables copy from removed files;
2156 * -C -C enables copy from existing files, but only
2157 * when blaming a new file;
2158 * -C -C -C enables copy from existing files for
2161 if (*opt & PICKAXE_BLAME_COPY_HARDER)
2162 *opt |= PICKAXE_BLAME_COPY_HARDEST;
2163 if (*opt & PICKAXE_BLAME_COPY)
2164 *opt |= PICKAXE_BLAME_COPY_HARDER;
2165 *opt |= PICKAXE_BLAME_COPY | PICKAXE_BLAME_MOVE;
2168 blame_copy_score = parse_score(arg);
2172 static int blame_move_callback(const struct option *option, const char *arg, int unset)
2174 int *opt = option->value;
2176 *opt |= PICKAXE_BLAME_MOVE;
2179 blame_move_score = parse_score(arg);
2183 static int blame_bottomtop_callback(const struct option *option, const char *arg, int unset)
2185 const char **bottomtop = option->value;
2189 die("More than one '-L n,m' option given");
2194 int cmd_blame(int argc, const char **argv, const char *prefix)
2196 struct rev_info revs;
2198 struct scoreboard sb;
2200 struct blame_entry *ent;
2201 long dashdash_pos, bottom, top, lno;
2202 const char *final_commit_name = NULL;
2203 enum object_type type;
2205 static const char *bottomtop = NULL;
2206 static int output_option = 0, opt = 0;
2207 static int show_stats = 0;
2208 static const char *revs_file = NULL;
2209 static const char *contents_from = NULL;
2210 static const struct option options[] = {
2211 OPT_BOOLEAN(0, "incremental", &incremental, "Show blame entries as we find them, incrementally"),
2212 OPT_BOOLEAN('b', NULL, &blank_boundary, "Show blank SHA-1 for boundary commits (Default: off)"),
2213 OPT_BOOLEAN(0, "root", &show_root, "Do not treat root commits as boundaries (Default: off)"),
2214 OPT_BOOLEAN(0, "show-stats", &show_stats, "Show work cost statistics"),
2215 OPT_BIT(0, "score-debug", &output_option, "Show output score for blame entries", OUTPUT_SHOW_SCORE),
2216 OPT_BIT('f', "show-name", &output_option, "Show original filename (Default: auto)", OUTPUT_SHOW_NAME),
2217 OPT_BIT('n', "show-number", &output_option, "Show original linenumber (Default: off)", OUTPUT_SHOW_NUMBER),
2218 OPT_BIT('p', "porcelain", &output_option, "Show in a format designed for machine consumption", OUTPUT_PORCELAIN),
2219 OPT_BIT('c', NULL, &output_option, "Use the same output mode as git-annotate (Default: off)", OUTPUT_ANNOTATE_COMPAT),
2220 OPT_BIT('t', NULL, &output_option, "Show raw timestamp (Default: off)", OUTPUT_RAW_TIMESTAMP),
2221 OPT_BIT('l', NULL, &output_option, "Show long commit SHA1 (Default: off)", OUTPUT_LONG_OBJECT_NAME),
2222 OPT_BIT('s', NULL, &output_option, "Suppress author name and timestamp (Default: off)", OUTPUT_NO_AUTHOR),
2223 OPT_BIT('w', NULL, &xdl_opts, "Ignore whitespace differences", XDF_IGNORE_WHITESPACE),
2224 OPT_STRING('S', NULL, &revs_file, "file", "Use revisions from <file> instead of calling git-rev-list"),
2225 OPT_STRING(0, "contents", &contents_from, "file", "Use <file>'s contents as the final image"),
2226 { OPTION_CALLBACK, 'C', NULL, &opt, "score", "Find line copies within and across files", PARSE_OPT_OPTARG, blame_copy_callback },
2227 { OPTION_CALLBACK, 'M', NULL, &opt, "score", "Find line movements within and across files", PARSE_OPT_OPTARG, blame_move_callback },
2228 OPT_CALLBACK('L', NULL, &bottomtop, "n,m", "Process only line range n,m, counting from 1", blame_bottomtop_callback),
2232 struct parse_opt_ctx_t ctx;
2233 int cmd_is_annotate = !strcmp(argv[0], "annotate");
2235 git_config(git_blame_config, NULL);
2236 init_revisions(&revs, NULL);
2237 revs.date_mode = blame_date_mode;
2239 save_commit_buffer = 0;
2242 parse_options_start(&ctx, argc, argv, prefix, PARSE_OPT_KEEP_DASHDASH |
2243 PARSE_OPT_KEEP_ARGV0);
2245 switch (parse_options_step(&ctx, options, blame_opt_usage)) {
2246 case PARSE_OPT_HELP:
2248 case PARSE_OPT_DONE:
2250 dashdash_pos = ctx.cpidx;
2254 if (!strcmp(ctx.argv[0], "--reverse")) {
2255 ctx.argv[0] = "--children";
2258 parse_revision_opt(&revs, &ctx, options, blame_opt_usage);
2261 argc = parse_options_end(&ctx);
2263 if (revs_file && read_ancestry(revs_file))
2264 die_errno("reading graft file '%s' failed", revs_file);
2266 if (cmd_is_annotate) {
2267 output_option |= OUTPUT_ANNOTATE_COMPAT;
2268 blame_date_mode = DATE_ISO8601;
2270 blame_date_mode = revs.date_mode;
2273 /* The maximum width used to show the dates */
2274 switch (blame_date_mode) {
2276 blame_date_width = sizeof("Thu, 19 Oct 2006 16:00:04 -0700");
2279 blame_date_width = sizeof("2006-10-19 16:00:04 -0700");
2282 blame_date_width = sizeof("1161298804 -0700");
2285 blame_date_width = sizeof("2006-10-19");
2288 /* "normal" is used as the fallback for "relative" */
2291 blame_date_width = sizeof("Thu Oct 19 16:00:04 2006 -0700");
2294 blame_date_width -= 1; /* strip the null */
2296 if (DIFF_OPT_TST(&revs.diffopt, FIND_COPIES_HARDER))
2297 opt |= (PICKAXE_BLAME_COPY | PICKAXE_BLAME_MOVE |
2298 PICKAXE_BLAME_COPY_HARDER);
2300 if (!blame_move_score)
2301 blame_move_score = BLAME_DEFAULT_MOVE_SCORE;
2302 if (!blame_copy_score)
2303 blame_copy_score = BLAME_DEFAULT_COPY_SCORE;
2306 * We have collected options unknown to us in argv[1..unk]
2307 * which are to be passed to revision machinery if we are
2308 * going to do the "bottom" processing.
2310 * The remaining are:
2312 * (1) if dashdash_pos != 0, its either
2313 * "blame [revisions] -- <path>" or
2314 * "blame -- <path> <rev>"
2316 * (2) otherwise, its one of the two:
2317 * "blame [revisions] <path>"
2318 * "blame <path> <rev>"
2320 * Note that we must strip out <path> from the arguments: we do not
2321 * want the path pruning but we may want "bottom" processing.
2324 switch (argc - dashdash_pos - 1) {
2327 usage_with_options(blame_opt_usage, options);
2328 /* reorder for the new way: <rev> -- <path> */
2334 path = add_prefix(prefix, argv[--argc]);
2338 usage_with_options(blame_opt_usage, options);
2342 usage_with_options(blame_opt_usage, options);
2343 path = add_prefix(prefix, argv[argc - 1]);
2344 if (argc == 3 && !has_string_in_work_tree(path)) { /* (2b) */
2345 path = add_prefix(prefix, argv[1]);
2348 argv[argc - 1] = "--";
2351 if (!has_string_in_work_tree(path))
2352 die_errno("cannot stat path '%s'", path);
2355 setup_revisions(argc, argv, &revs, NULL);
2356 memset(&sb, 0, sizeof(sb));
2360 final_commit_name = prepare_final(&sb);
2361 else if (contents_from)
2362 die("--contents and --children do not blend well.");
2364 final_commit_name = prepare_initial(&sb);
2368 * "--not A B -- path" without anything positive;
2369 * do not default to HEAD, but use the working tree
2373 sb.final = fake_working_tree_commit(path, contents_from);
2374 add_pending_object(&revs, &(sb.final->object), ":");
2376 else if (contents_from)
2377 die("Cannot use --contents with final commit object name");
2380 * If we have bottom, this will mark the ancestors of the
2381 * bottom commits we would reach while traversing as
2384 if (prepare_revision_walk(&revs))
2385 die("revision walk setup failed");
2387 if (is_null_sha1(sb.final->object.sha1)) {
2390 buf = xmalloc(o->file.size + 1);
2391 memcpy(buf, o->file.ptr, o->file.size + 1);
2393 sb.final_buf_size = o->file.size;
2396 o = get_origin(&sb, sb.final, path);
2397 if (fill_blob_sha1(o))
2398 die("no such path %s in %s", path, final_commit_name);
2400 sb.final_buf = read_sha1_file(o->blob_sha1, &type,
2401 &sb.final_buf_size);
2403 die("Cannot read blob %s for path %s",
2404 sha1_to_hex(o->blob_sha1),
2408 lno = prepare_lines(&sb);
2412 prepare_blame_range(&sb, bottomtop, lno, &bottom, &top);
2413 if (bottom && top && top < bottom) {
2415 tmp = top; top = bottom; bottom = tmp;
2423 die("file %s has only %lu lines", path, lno);
2425 ent = xcalloc(1, sizeof(*ent));
2427 ent->num_lines = top - bottom;
2429 ent->s_lno = bottom;
2434 read_mailmap(&mailmap, NULL);
2439 assign_blame(&sb, opt);
2446 if (!(output_option & OUTPUT_PORCELAIN))
2447 find_alignment(&sb, &output_option);
2449 output(&sb, output_option);
2450 free((void *)sb.final_buf);
2451 for (ent = sb.ent; ent; ) {
2452 struct blame_entry *e = ent->next;
2458 printf("num read blob: %d\n", num_read_blob);
2459 printf("num get patch: %d\n", num_get_patch);
2460 printf("num commits: %d\n", num_commits);