]>
Commit | Line | Data |
---|---|---|
dc076ae5 JS |
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" | |
072bf432 | 9 | #include "diff.h" |
dc076ae5 | 10 | |
b543bb1c JS |
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 | ||
09002f1b JS |
16 | #define BLAME_DEFAULT_MOVE_SCORE 20 |
17 | #define BLAME_DEFAULT_COPY_SCORE 40 | |
18 | ||
dc076ae5 JS |
19 | /* |
20 | * One blob in a commit that is being suspected | |
21 | */ | |
22 | struct 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 | */ | |
72 | struct 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 | */ | |
100 | struct 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 rev_info *revs; | |
106 | const char *path; | |
107 | ||
108 | /* | |
109 | * The contents in the final image. | |
110 | * Used by many functions to obtain contents of the nth line, | |
111 | * indexed with scoreboard.lineno[blame_entry.lno]. | |
112 | */ | |
113 | const char *final_buf; | |
114 | unsigned long final_buf_size; | |
115 | ||
116 | /* linked list of blames */ | |
117 | struct blame_entry *ent; | |
118 | ||
119 | /* look-up a line in the final buffer */ | |
120 | int num_lines; | |
121 | int *lineno; | |
122 | ||
123 | /* stats */ | |
124 | int num_read_blob; | |
125 | int num_get_patch; | |
126 | int num_commits; | |
127 | ||
128 | /* | |
129 | * blame for a blame_entry with score lower than these thresholds | |
130 | * is not passed to the parent using move/copy logic. | |
131 | */ | |
132 | unsigned move_score; | |
133 | unsigned copy_score; | |
134 | ||
135 | /* use this file's contents as the final image */ | |
136 | const char *contents_from; | |
137 | ||
138 | /* flags */ | |
139 | int reverse; | |
140 | int show_root; | |
141 | int xdl_opts; | |
142 | int no_whole_file_rename; | |
143 | int debug; | |
144 | ||
145 | /* callbacks */ | |
146 | void(*on_sanity_fail)(struct blame_scoreboard *, int); | |
147 | void(*found_guilty_entry)(struct blame_entry *, void *); | |
148 | ||
149 | void *found_guilty_entry_data; | |
150 | }; | |
151 | ||
f5dd754c JS |
152 | /* |
153 | * Origin is refcounted and usually we keep the blob contents to be | |
154 | * reused. | |
155 | */ | |
156 | static inline struct blame_origin *blame_origin_incref(struct blame_origin *o) | |
157 | { | |
158 | if (o) | |
159 | o->refcnt++; | |
160 | return o; | |
161 | } | |
162 | extern void blame_origin_decref(struct blame_origin *o); | |
163 | ||
b543bb1c JS |
164 | extern void blame_coalesce(struct blame_scoreboard *sb); |
165 | extern void blame_sort_final(struct blame_scoreboard *sb); | |
166 | extern unsigned blame_entry_score(struct blame_scoreboard *sb, struct blame_entry *e); | |
167 | extern void assign_blame(struct blame_scoreboard *sb, int opt); | |
168 | extern const char *blame_nth_line(struct blame_scoreboard *sb, long lno); | |
169 | ||
09002f1b JS |
170 | extern void init_scoreboard(struct blame_scoreboard *sb); |
171 | extern void setup_scoreboard(struct blame_scoreboard *sb, const char *path, struct blame_origin **orig); | |
172 | ||
bd481de7 JS |
173 | extern struct blame_entry *blame_entry_prepend(struct blame_entry *head, long start, long end, struct blame_origin *o); |
174 | ||
dc076ae5 | 175 | #endif /* BLAME_H */ |