]>
Commit | Line | Data |
---|---|---|
883e248b BP |
1 | #include "cache.h" |
2 | #include "config.h" | |
3 | #include "dir.h" | |
4 | #include "ewah/ewok.h" | |
5 | #include "fsmonitor.h" | |
6 | #include "run-command.h" | |
7 | #include "strbuf.h" | |
8 | ||
56c69100 KW |
9 | #define INDEX_EXTENSION_VERSION1 (1) |
10 | #define INDEX_EXTENSION_VERSION2 (2) | |
8da2c576 KW |
11 | #define HOOK_INTERFACE_VERSION1 (1) |
12 | #define HOOK_INTERFACE_VERSION2 (2) | |
883e248b BP |
13 | |
14 | struct trace_key trace_fsmonitor = TRACE_KEY_INIT(FSMONITOR); | |
15 | ||
16 | static void fsmonitor_ewah_callback(size_t pos, void *is) | |
17 | { | |
18 | struct index_state *istate = (struct index_state *)is; | |
3444ec2e | 19 | struct cache_entry *ce; |
883e248b | 20 | |
3444ec2e WB |
21 | if (pos >= istate->cache_nr) |
22 | BUG("fsmonitor_dirty has more entries than the index (%"PRIuMAX" >= %u)", | |
23 | (uintmax_t)pos, istate->cache_nr); | |
24 | ||
25 | ce = istate->cache[pos]; | |
883e248b BP |
26 | ce->ce_flags &= ~CE_FSMONITOR_VALID; |
27 | } | |
28 | ||
8da2c576 KW |
29 | static int fsmonitor_hook_version(void) |
30 | { | |
31 | int hook_version; | |
32 | ||
33 | if (git_config_get_int("core.fsmonitorhookversion", &hook_version)) | |
34 | return -1; | |
35 | ||
36 | if (hook_version == HOOK_INTERFACE_VERSION1 || | |
37 | hook_version == HOOK_INTERFACE_VERSION2) | |
38 | return hook_version; | |
39 | ||
40 | warning("Invalid hook version '%i' in core.fsmonitorhookversion. " | |
41 | "Must be 1 or 2.", hook_version); | |
42 | return -1; | |
43 | } | |
44 | ||
883e248b BP |
45 | int read_fsmonitor_extension(struct index_state *istate, const void *data, |
46 | unsigned long sz) | |
47 | { | |
48 | const char *index = data; | |
49 | uint32_t hdr_version; | |
50 | uint32_t ewah_size; | |
51 | struct ewah_bitmap *fsmonitor_dirty; | |
883e248b | 52 | int ret; |
56c69100 KW |
53 | uint64_t timestamp; |
54 | struct strbuf last_update = STRBUF_INIT; | |
883e248b | 55 | |
56c69100 | 56 | if (sz < sizeof(uint32_t) + 1 + sizeof(uint32_t)) |
883e248b BP |
57 | return error("corrupt fsmonitor extension (too short)"); |
58 | ||
59 | hdr_version = get_be32(index); | |
60 | index += sizeof(uint32_t); | |
56c69100 KW |
61 | if (hdr_version == INDEX_EXTENSION_VERSION1) { |
62 | timestamp = get_be64(index); | |
63 | strbuf_addf(&last_update, "%"PRIu64"", timestamp); | |
64 | index += sizeof(uint64_t); | |
65 | } else if (hdr_version == INDEX_EXTENSION_VERSION2) { | |
66 | strbuf_addstr(&last_update, index); | |
67 | index += last_update.len + 1; | |
68 | } else { | |
883e248b | 69 | return error("bad fsmonitor version %d", hdr_version); |
56c69100 | 70 | } |
883e248b | 71 | |
56c69100 | 72 | istate->fsmonitor_last_update = strbuf_detach(&last_update, NULL); |
883e248b BP |
73 | |
74 | ewah_size = get_be32(index); | |
75 | index += sizeof(uint32_t); | |
76 | ||
77 | fsmonitor_dirty = ewah_new(); | |
78 | ret = ewah_read_mmap(fsmonitor_dirty, index, ewah_size); | |
79 | if (ret != ewah_size) { | |
80 | ewah_free(fsmonitor_dirty); | |
81 | return error("failed to parse ewah bitmap reading fsmonitor index extension"); | |
82 | } | |
ba1b9cac | 83 | istate->fsmonitor_dirty = fsmonitor_dirty; |
883e248b | 84 | |
61eea521 JH |
85 | if (!istate->split_index && |
86 | istate->fsmonitor_dirty->bit_size > istate->cache_nr) | |
3444ec2e WB |
87 | BUG("fsmonitor_dirty has more entries than the index (%"PRIuMAX" > %u)", |
88 | (uintmax_t)istate->fsmonitor_dirty->bit_size, istate->cache_nr); | |
89 | ||
29fbbf43 JH |
90 | trace2_data_string("index", NULL, "extension/fsmn/read/token", |
91 | istate->fsmonitor_last_update); | |
92 | trace_printf_key(&trace_fsmonitor, | |
93 | "read fsmonitor extension successful '%s'", | |
94 | istate->fsmonitor_last_update); | |
883e248b BP |
95 | return 0; |
96 | } | |
97 | ||
3bd28eb2 AV |
98 | void fill_fsmonitor_bitmap(struct index_state *istate) |
99 | { | |
3444ec2e | 100 | unsigned int i, skipped = 0; |
3bd28eb2 | 101 | istate->fsmonitor_dirty = ewah_new(); |
3444ec2e WB |
102 | for (i = 0; i < istate->cache_nr; i++) { |
103 | if (istate->cache[i]->ce_flags & CE_REMOVE) | |
104 | skipped++; | |
105 | else if (!(istate->cache[i]->ce_flags & CE_FSMONITOR_VALID)) | |
106 | ewah_set(istate->fsmonitor_dirty, i - skipped); | |
107 | } | |
3bd28eb2 AV |
108 | } |
109 | ||
883e248b BP |
110 | void write_fsmonitor_extension(struct strbuf *sb, struct index_state *istate) |
111 | { | |
112 | uint32_t hdr_version; | |
883e248b BP |
113 | uint32_t ewah_start; |
114 | uint32_t ewah_size = 0; | |
115 | int fixup = 0; | |
116 | ||
61eea521 JH |
117 | if (!istate->split_index && |
118 | istate->fsmonitor_dirty->bit_size > istate->cache_nr) | |
3444ec2e WB |
119 | BUG("fsmonitor_dirty has more entries than the index (%"PRIuMAX" > %u)", |
120 | (uintmax_t)istate->fsmonitor_dirty->bit_size, istate->cache_nr); | |
121 | ||
56c69100 | 122 | put_be32(&hdr_version, INDEX_EXTENSION_VERSION2); |
883e248b BP |
123 | strbuf_add(sb, &hdr_version, sizeof(uint32_t)); |
124 | ||
56c69100 KW |
125 | strbuf_addstr(sb, istate->fsmonitor_last_update); |
126 | strbuf_addch(sb, 0); /* Want to keep a NUL */ | |
127 | ||
883e248b BP |
128 | fixup = sb->len; |
129 | strbuf_add(sb, &ewah_size, sizeof(uint32_t)); /* we'll fix this up later */ | |
130 | ||
131 | ewah_start = sb->len; | |
3bd28eb2 AV |
132 | ewah_serialize_strbuf(istate->fsmonitor_dirty, sb); |
133 | ewah_free(istate->fsmonitor_dirty); | |
134 | istate->fsmonitor_dirty = NULL; | |
883e248b BP |
135 | |
136 | /* fix up size field */ | |
137 | put_be32(&ewah_size, sb->len - ewah_start); | |
138 | memcpy(sb->buf + fixup, &ewah_size, sizeof(uint32_t)); | |
139 | ||
29fbbf43 JH |
140 | trace2_data_string("index", NULL, "extension/fsmn/write/token", |
141 | istate->fsmonitor_last_update); | |
142 | trace_printf_key(&trace_fsmonitor, | |
143 | "write fsmonitor extension successful '%s'", | |
144 | istate->fsmonitor_last_update); | |
883e248b BP |
145 | } |
146 | ||
147 | /* | |
56c69100 | 148 | * Call the query-fsmonitor hook passing the last update token of the saved results. |
883e248b | 149 | */ |
56c69100 | 150 | static int query_fsmonitor(int version, const char *last_update, struct strbuf *query_result) |
883e248b BP |
151 | { |
152 | struct child_process cp = CHILD_PROCESS_INIT; | |
940b94f3 | 153 | int result; |
883e248b | 154 | |
735e4173 | 155 | if (!core_fsmonitor) |
883e248b BP |
156 | return -1; |
157 | ||
ef8d7ac4 JK |
158 | strvec_push(&cp.args, core_fsmonitor); |
159 | strvec_pushf(&cp.args, "%d", version); | |
160 | strvec_pushf(&cp.args, "%s", last_update); | |
883e248b | 161 | cp.use_shell = 1; |
11cf33be | 162 | cp.dir = get_git_work_tree(); |
883e248b | 163 | |
940b94f3 JH |
164 | trace2_region_enter("fsm_hook", "query", NULL); |
165 | ||
166 | result = capture_command(&cp, query_result, 1024); | |
167 | ||
168 | if (result) | |
169 | trace2_data_intmax("fsm_hook", NULL, "query/failed", result); | |
170 | else { | |
171 | trace2_data_intmax("fsm_hook", NULL, "query/response-length", | |
172 | query_result->len); | |
173 | ||
174 | if (fsmonitor_is_trivial_response(query_result)) | |
175 | trace2_data_intmax("fsm_hook", NULL, | |
176 | "query/trivial-response", 1); | |
177 | } | |
178 | ||
179 | trace2_region_leave("fsm_hook", "query", NULL); | |
180 | ||
181 | return result; | |
182 | } | |
183 | ||
184 | int fsmonitor_is_trivial_response(const struct strbuf *query_result) | |
185 | { | |
186 | static char trivial_response[3] = { '\0', '/', '\0' }; | |
187 | int is_trivial = !memcmp(trivial_response, | |
188 | &query_result->buf[query_result->len - 3], 3); | |
189 | ||
190 | return is_trivial; | |
883e248b BP |
191 | } |
192 | ||
193 | static void fsmonitor_refresh_callback(struct index_state *istate, const char *name) | |
194 | { | |
195 | int pos = index_name_pos(istate, name, strlen(name)); | |
196 | ||
197 | if (pos >= 0) { | |
198 | struct cache_entry *ce = istate->cache[pos]; | |
199 | ce->ce_flags &= ~CE_FSMONITOR_VALID; | |
200 | } | |
201 | ||
202 | /* | |
203 | * Mark the untracked cache dirty even if it wasn't found in the index | |
204 | * as it could be a new untracked file. | |
205 | */ | |
206 | trace_printf_key(&trace_fsmonitor, "fsmonitor_refresh_callback '%s'", name); | |
0cacebf0 | 207 | untracked_cache_invalidate_path(istate, name, 0); |
883e248b BP |
208 | } |
209 | ||
210 | void refresh_fsmonitor(struct index_state *istate) | |
211 | { | |
883e248b | 212 | struct strbuf query_result = STRBUF_INIT; |
8da2c576 KW |
213 | int query_success = 0, hook_version = -1; |
214 | size_t bol = 0; /* beginning of line */ | |
883e248b | 215 | uint64_t last_update; |
56c69100 | 216 | struct strbuf last_update_token = STRBUF_INIT; |
883e248b | 217 | char *buf; |
5d137fc2 | 218 | unsigned int i; |
883e248b | 219 | |
398a3b08 | 220 | if (!core_fsmonitor || istate->fsmonitor_has_run_once) |
883e248b | 221 | return; |
8da2c576 KW |
222 | |
223 | hook_version = fsmonitor_hook_version(); | |
224 | ||
398a3b08 | 225 | istate->fsmonitor_has_run_once = 1; |
883e248b BP |
226 | |
227 | trace_printf_key(&trace_fsmonitor, "refresh fsmonitor"); | |
228 | /* | |
229 | * This could be racy so save the date/time now and query_fsmonitor | |
230 | * should be inclusive to ensure we don't miss potential changes. | |
231 | */ | |
232 | last_update = getnanotime(); | |
8da2c576 KW |
233 | if (hook_version == HOOK_INTERFACE_VERSION1) |
234 | strbuf_addf(&last_update_token, "%"PRIu64"", last_update); | |
883e248b BP |
235 | |
236 | /* | |
8da2c576 KW |
237 | * If we have a last update token, call query_fsmonitor for the set of |
238 | * changes since that token, else assume everything is possibly dirty | |
883e248b BP |
239 | * and check it all. |
240 | */ | |
241 | if (istate->fsmonitor_last_update) { | |
8da2c576 KW |
242 | if (hook_version == -1 || hook_version == HOOK_INTERFACE_VERSION2) { |
243 | query_success = !query_fsmonitor(HOOK_INTERFACE_VERSION2, | |
244 | istate->fsmonitor_last_update, &query_result); | |
245 | ||
246 | if (query_success) { | |
247 | if (hook_version < 0) | |
248 | hook_version = HOOK_INTERFACE_VERSION2; | |
249 | ||
250 | /* | |
251 | * First entry will be the last update token | |
252 | * Need to use a char * variable because static | |
253 | * analysis was suggesting to use strbuf_addbuf | |
254 | * but we don't want to copy the entire strbuf | |
6d12b533 | 255 | * only the chars up to the first NUL |
8da2c576 KW |
256 | */ |
257 | buf = query_result.buf; | |
258 | strbuf_addstr(&last_update_token, buf); | |
259 | if (!last_update_token.len) { | |
260 | warning("Empty last update token."); | |
261 | query_success = 0; | |
262 | } else { | |
263 | bol = last_update_token.len + 1; | |
264 | } | |
265 | } else if (hook_version < 0) { | |
266 | hook_version = HOOK_INTERFACE_VERSION1; | |
267 | if (!last_update_token.len) | |
268 | strbuf_addf(&last_update_token, "%"PRIu64"", last_update); | |
269 | } | |
270 | } | |
271 | ||
272 | if (hook_version == HOOK_INTERFACE_VERSION1) { | |
273 | query_success = !query_fsmonitor(HOOK_INTERFACE_VERSION1, | |
274 | istate->fsmonitor_last_update, &query_result); | |
275 | } | |
276 | ||
883e248b BP |
277 | trace_performance_since(last_update, "fsmonitor process '%s'", core_fsmonitor); |
278 | trace_printf_key(&trace_fsmonitor, "fsmonitor process '%s' returned %s", | |
279 | core_fsmonitor, query_success ? "success" : "failure"); | |
280 | } | |
281 | ||
282 | /* a fsmonitor process can return '/' to indicate all entries are invalid */ | |
8da2c576 | 283 | if (query_success && query_result.buf[bol] != '/') { |
883e248b BP |
284 | /* Mark all entries returned by the monitor as dirty */ |
285 | buf = query_result.buf; | |
8da2c576 | 286 | for (i = bol; i < query_result.len; i++) { |
883e248b BP |
287 | if (buf[i] != '\0') |
288 | continue; | |
289 | fsmonitor_refresh_callback(istate, buf + bol); | |
290 | bol = i + 1; | |
291 | } | |
292 | if (bol < query_result.len) | |
293 | fsmonitor_refresh_callback(istate, buf + bol); | |
679f2f9f US |
294 | |
295 | /* Now mark the untracked cache for fsmonitor usage */ | |
296 | if (istate->untracked) | |
297 | istate->untracked->use_fsmonitor = 1; | |
883e248b | 298 | } else { |
679f2f9f US |
299 | |
300 | /* We only want to run the post index changed hook if we've actually changed entries, so keep track | |
301 | * if we actually changed entries or not */ | |
302 | int is_cache_changed = 0; | |
883e248b | 303 | /* Mark all entries invalid */ |
679f2f9f US |
304 | for (i = 0; i < istate->cache_nr; i++) { |
305 | if (istate->cache[i]->ce_flags & CE_FSMONITOR_VALID) { | |
306 | is_cache_changed = 1; | |
307 | istate->cache[i]->ce_flags &= ~CE_FSMONITOR_VALID; | |
308 | } | |
309 | } | |
883e248b | 310 | |
ca598d5f | 311 | /* If we're going to check every file, ensure we save the results */ |
679f2f9f US |
312 | if (is_cache_changed) |
313 | istate->cache_changed |= FSMONITOR_CHANGED; | |
ca598d5f | 314 | |
883e248b BP |
315 | if (istate->untracked) |
316 | istate->untracked->use_fsmonitor = 0; | |
317 | } | |
318 | strbuf_release(&query_result); | |
319 | ||
56c69100 KW |
320 | /* Now that we've updated istate, save the last_update_token */ |
321 | FREE_AND_NULL(istate->fsmonitor_last_update); | |
322 | istate->fsmonitor_last_update = strbuf_detach(&last_update_token, NULL); | |
883e248b BP |
323 | } |
324 | ||
325 | void add_fsmonitor(struct index_state *istate) | |
326 | { | |
5d137fc2 | 327 | unsigned int i; |
56c69100 | 328 | struct strbuf last_update = STRBUF_INIT; |
883e248b BP |
329 | |
330 | if (!istate->fsmonitor_last_update) { | |
331 | trace_printf_key(&trace_fsmonitor, "add fsmonitor"); | |
332 | istate->cache_changed |= FSMONITOR_CHANGED; | |
56c69100 KW |
333 | strbuf_addf(&last_update, "%"PRIu64"", getnanotime()); |
334 | istate->fsmonitor_last_update = strbuf_detach(&last_update, NULL); | |
883e248b BP |
335 | |
336 | /* reset the fsmonitor state */ | |
337 | for (i = 0; i < istate->cache_nr; i++) | |
338 | istate->cache[i]->ce_flags &= ~CE_FSMONITOR_VALID; | |
339 | ||
340 | /* reset the untracked cache */ | |
341 | if (istate->untracked) { | |
342 | add_untracked_cache(istate); | |
343 | istate->untracked->use_fsmonitor = 1; | |
344 | } | |
345 | ||
346 | /* Update the fsmonitor state */ | |
347 | refresh_fsmonitor(istate); | |
348 | } | |
349 | } | |
350 | ||
351 | void remove_fsmonitor(struct index_state *istate) | |
352 | { | |
353 | if (istate->fsmonitor_last_update) { | |
354 | trace_printf_key(&trace_fsmonitor, "remove fsmonitor"); | |
355 | istate->cache_changed |= FSMONITOR_CHANGED; | |
56c69100 | 356 | FREE_AND_NULL(istate->fsmonitor_last_update); |
883e248b BP |
357 | } |
358 | } | |
359 | ||
360 | void tweak_fsmonitor(struct index_state *istate) | |
361 | { | |
5d137fc2 | 362 | unsigned int i; |
ba1b9cac AV |
363 | int fsmonitor_enabled = git_config_get_fsmonitor(); |
364 | ||
365 | if (istate->fsmonitor_dirty) { | |
366 | if (fsmonitor_enabled) { | |
367 | /* Mark all entries valid */ | |
368 | for (i = 0; i < istate->cache_nr; i++) { | |
369 | istate->cache[i]->ce_flags |= CE_FSMONITOR_VALID; | |
370 | } | |
371 | ||
372 | /* Mark all previously saved entries as dirty */ | |
3444ec2e WB |
373 | if (istate->fsmonitor_dirty->bit_size > istate->cache_nr) |
374 | BUG("fsmonitor_dirty has more entries than the index (%"PRIuMAX" > %u)", | |
375 | (uintmax_t)istate->fsmonitor_dirty->bit_size, istate->cache_nr); | |
ba1b9cac AV |
376 | ewah_each_bit(istate->fsmonitor_dirty, fsmonitor_ewah_callback, istate); |
377 | ||
679f2f9f | 378 | refresh_fsmonitor(istate); |
ba1b9cac AV |
379 | } |
380 | ||
381 | ewah_free(istate->fsmonitor_dirty); | |
382 | istate->fsmonitor_dirty = NULL; | |
383 | } | |
384 | ||
385 | switch (fsmonitor_enabled) { | |
883e248b BP |
386 | case -1: /* keep: do nothing */ |
387 | break; | |
388 | case 0: /* false */ | |
389 | remove_fsmonitor(istate); | |
390 | break; | |
391 | case 1: /* true */ | |
392 | add_fsmonitor(istate); | |
393 | break; | |
394 | default: /* unknown value: do nothing */ | |
395 | break; | |
396 | } | |
397 | } |