blob: 739318ab6d1060e3f5ef9eba0ab93aa560c1d246 [file] [log] [blame]
Ben Peart883e2482017-09-22 12:35:40 -04001#ifndef FSMONITOR_H
2#define FSMONITOR_H
3
Elijah Newrenef3ca952018-08-15 10:54:05 -07004#include "cache.h"
5#include "dir.h"
6
Ben Peart883e2482017-09-22 12:35:40 -04007extern struct trace_key trace_fsmonitor;
8
9/*
10 * Read the fsmonitor index extension and (if configured) restore the
11 * CE_FSMONITOR_VALID state.
12 */
Denton Liu55454422019-04-29 04:28:14 -040013int read_fsmonitor_extension(struct index_state *istate, const void *data, unsigned long sz);
Ben Peart883e2482017-09-22 12:35:40 -040014
15/*
Alex Vandiver3bd28eb2017-11-09 11:58:10 -080016 * Fill the fsmonitor_dirty ewah bits with their state from the index,
17 * before it is split during writing.
18 */
Denton Liu55454422019-04-29 04:28:14 -040019void fill_fsmonitor_bitmap(struct index_state *istate);
Alex Vandiver3bd28eb2017-11-09 11:58:10 -080020
21/*
22 * Write the CE_FSMONITOR_VALID state into the fsmonitor index
23 * extension. Reads from the fsmonitor_dirty ewah in the index.
Ben Peart883e2482017-09-22 12:35:40 -040024 */
Denton Liu55454422019-04-29 04:28:14 -040025void write_fsmonitor_extension(struct strbuf *sb, struct index_state *istate);
Ben Peart883e2482017-09-22 12:35:40 -040026
27/*
28 * Add/remove the fsmonitor index extension
29 */
Denton Liu55454422019-04-29 04:28:14 -040030void add_fsmonitor(struct index_state *istate);
31void remove_fsmonitor(struct index_state *istate);
Ben Peart883e2482017-09-22 12:35:40 -040032
33/*
34 * Add/remove the fsmonitor index extension as necessary based on the current
35 * core.fsmonitor setting.
36 */
Denton Liu55454422019-04-29 04:28:14 -040037void tweak_fsmonitor(struct index_state *istate);
Ben Peart883e2482017-09-22 12:35:40 -040038
39/*
40 * Run the configured fsmonitor integration script and clear the
41 * CE_FSMONITOR_VALID bit for any files returned as dirty. Also invalidate
42 * any corresponding untracked cache directory structures. Optimized to only
43 * run the first time it is called.
44 */
Denton Liu55454422019-04-29 04:28:14 -040045void refresh_fsmonitor(struct index_state *istate);
Ben Peart883e2482017-09-22 12:35:40 -040046
47/*
48 * Set the given cache entries CE_FSMONITOR_VALID bit. This should be
49 * called any time the cache entry has been updated to reflect the
50 * current state of the file on disk.
51 */
Johannes Schindelinb5a81692019-05-24 05:23:48 -070052static inline void mark_fsmonitor_valid(struct index_state *istate, struct cache_entry *ce)
Ben Peart883e2482017-09-22 12:35:40 -040053{
Johannes Schindelinb5a81692019-05-24 05:23:48 -070054 if (core_fsmonitor && !(ce->ce_flags & CE_FSMONITOR_VALID)) {
55 istate->cache_changed = 1;
Ben Peart883e2482017-09-22 12:35:40 -040056 ce->ce_flags |= CE_FSMONITOR_VALID;
57 trace_printf_key(&trace_fsmonitor, "mark_fsmonitor_clean '%s'", ce->name);
58 }
59}
60
61/*
62 * Clear the given cache entry's CE_FSMONITOR_VALID bit and invalidate
63 * any corresponding untracked cache directory structures. This should
64 * be called any time git creates or modifies a file that should
65 * trigger an lstat() or invalidate the untracked cache for the
66 * corresponding directory
67 */
68static inline void mark_fsmonitor_invalid(struct index_state *istate, struct cache_entry *ce)
69{
70 if (core_fsmonitor) {
71 ce->ce_flags &= ~CE_FSMONITOR_VALID;
Nguyễn Thái Ngọc Duy0cacebf2018-02-07 16:21:40 +070072 untracked_cache_invalidate_path(istate, ce->name, 1);
Ben Peart883e2482017-09-22 12:35:40 -040073 trace_printf_key(&trace_fsmonitor, "mark_fsmonitor_invalid '%s'", ce->name);
74 }
75}
76
77#endif