1#ifndef BLAME_H 2#define BLAME_H 3 4#include "cache.h" 5#include "commit.h" 6#include "xdiff-interface.h" 7#include "revision.h" 8#include "prio-queue.h" 9#include "diff.h" 10 11#define PICKAXE_BLAME_MOVE 01 12#define PICKAXE_BLAME_COPY 02 13#define PICKAXE_BLAME_COPY_HARDER 04 14#define PICKAXE_BLAME_COPY_HARDEST 010 15 16#define BLAME_DEFAULT_MOVE_SCORE 20 17#define BLAME_DEFAULT_COPY_SCORE 40 18 19/* 20 * One blob in a commit that is being suspected 21 */ 22struct blame_origin { 23 int refcnt; 24 /* Record preceding blame record for this blob */ 25 struct blame_origin *previous; 26 /* origins are put in a list linked via `next' hanging off the 27 * corresponding commit's util field in order to make finding 28 * them fast. The presence in this chain does not count 29 * towards the origin's reference count. It is tempting to 30 * let it count as long as the commit is pending examination, 31 * but even under circumstances where the commit will be 32 * present multiple times in the priority queue of unexamined 33 * commits, processing the first instance will not leave any 34 * work requiring the origin data for the second instance. An 35 * interspersed commit changing that would have to be 36 * preexisting with a different ancestry and with the same 37 * commit date in order to wedge itself between two instances 38 * of the same commit in the priority queue _and_ produce 39 * blame entries relevant for it. While we don't want to let 40 * us get tripped up by this case, it certainly does not seem 41 * worth optimizing for. 42 */ 43 struct blame_origin *next; 44 struct commit *commit; 45 /* `suspects' contains blame entries that may be attributed to 46 * this origin's commit or to parent commits. When a commit 47 * is being processed, all suspects will be moved, either by 48 * assigning them to an origin in a different commit, or by 49 * shipping them to the scoreboard's ent list because they 50 * cannot be attributed to a different commit. 51 */ 52 struct blame_entry *suspects; 53 mmfile_t file; 54 struct object_id blob_oid; 55 unsigned mode; 56 /* guilty gets set when shipping any suspects to the final 57 * blame list instead of other commits 58 */ 59 char guilty; 60 char path[FLEX_ARRAY]; 61}; 62 63/* 64 * Each group of lines is described by a blame_entry; it can be split 65 * as we pass blame to the parents. They are arranged in linked lists 66 * kept as `suspects' of some unprocessed origin, or entered (when the 67 * blame origin has been finalized) into the scoreboard structure. 68 * While the scoreboard structure is only sorted at the end of 69 * processing (according to final image line number), the lists 70 * attached to an origin are sorted by the target line number. 71 */ 72struct blame_entry { 73 struct blame_entry *next; 74 75 /* the first line of this group in the final image; 76 * internally all line numbers are 0 based. 77 */ 78 int lno; 79 80 /* how many lines this group has */ 81 int num_lines; 82 83 /* the commit that introduced this group into the final image */ 84 struct blame_origin *suspect; 85 86 /* the line number of the first line of this group in the 87 * suspect's file; internally all line numbers are 0 based. 88 */ 89 int s_lno; 90 91 /* how significant this entry is -- cached to avoid 92 * scanning the lines over and over. 93 */ 94 unsigned score; 95}; 96 97/* 98 * The current state of the blame assignment. 99 */ 100struct blame_scoreboard { 101 /* the final commit (i.e. where we started digging from) */ 102 struct commit *final; 103 /* Priority queue for commits with unassigned blame records */ 104 struct prio_queue commits; 105 struct repository *repo; 106 struct rev_info *revs; 107 const char *path; 108 109 /* 110 * The contents in the final image. 111 * Used by many functions to obtain contents of the nth line, 112 * indexed with scoreboard.lineno[blame_entry.lno]. 113 */ 114 const char *final_buf; 115 unsigned long final_buf_size; 116 117 /* linked list of blames */ 118 struct blame_entry *ent; 119 120 struct oidset ignore_list; 121 122 /* look-up a line in the final buffer */ 123 int num_lines; 124 int *lineno; 125 126 /* stats */ 127 int num_read_blob; 128 int num_get_patch; 129 int num_commits; 130 131 /* 132 * blame for a blame_entry with score lower than these thresholds 133 * is not passed to the parent using move/copy logic. 134 */ 135 unsigned move_score; 136 unsigned copy_score; 137 138 /* use this file's contents as the final image */ 139 const char *contents_from; 140 141 /* flags */ 142 int reverse; 143 int show_root; 144 int xdl_opts; 145 int no_whole_file_rename; 146 int debug; 147 148 /* callbacks */ 149 void(*on_sanity_fail)(struct blame_scoreboard *, int); 150 void(*found_guilty_entry)(struct blame_entry *, void *); 151 152 void *found_guilty_entry_data; 153}; 154 155/* 156 * Origin is refcounted and usually we keep the blob contents to be 157 * reused. 158 */ 159static inline struct blame_origin *blame_origin_incref(struct blame_origin *o) 160{ 161 if (o) 162 o->refcnt++; 163 return o; 164} 165void blame_origin_decref(struct blame_origin *o); 166 167void blame_coalesce(struct blame_scoreboard *sb); 168void blame_sort_final(struct blame_scoreboard *sb); 169unsigned blame_entry_score(struct blame_scoreboard *sb, struct blame_entry *e); 170void assign_blame(struct blame_scoreboard *sb, int opt); 171const char *blame_nth_line(struct blame_scoreboard *sb, long lno); 172 173void init_scoreboard(struct blame_scoreboard *sb); 174void setup_scoreboard(struct blame_scoreboard *sb, 175 const char *path, 176 struct blame_origin **orig); 177 178struct blame_entry *blame_entry_prepend(struct blame_entry *head, 179 long start, long end, 180 struct blame_origin *o); 181 182extern struct blame_origin *get_blame_suspects(struct commit *commit); 183 184#endif /* BLAME_H */