mirror of
https://github.com/git/git.git
synced 2024-05-11 17:06:08 +02:00
1e0ea5c431
Move fsmonitor config settings to a new and opaque `struct fsmonitor_settings` structure. Add a lazily-loaded pointer to this into `struct repo_settings` Create an `enum fsmonitor_mode` type in `struct fsmonitor_settings` to represent the state of fsmonitor. This lets us represent which, if any, fsmonitor provider (hook or IPC) is enabled. Create `fsm_settings__get_*()` getters to lazily look up fsmonitor- related config settings. Get rid of the `core_fsmonitor` global variable. Move the code to lookup the existing `core.fsmonitor` config value into the fsmonitor settings. Create a hook pathname variable in `struct fsmonitor-settings` and only set it when in hook mode. Extend the definition of `core.fsmonitor` to be either a boolean or a hook pathname. When true, the builtin FSMonitor is used. When false or unset, no FSMonitor (neither builtin nor hook) is used. The existing `core_fsmonitor` global variable was used to store the pathname to the fsmonitor hook *and* it was used as a boolean to see if fsmonitor was enabled. This dual usage and global visibility leads to confusion when we add the IPC-based provider. So lets hide the details in fsmonitor-settings.c and let it decide which provider to use in the case of multiple settings. This avoids cluttering up repo-settings.c with these private details. A future commit in builtin-fsmonitor series will add the ability to disqualify worktrees for various reasons, such as being mounted from a remote volume, where fsmonitor should not be started. Having the config settings hidden in fsmonitor-settings.c allows such worktree restrictions to override the config values used. Signed-off-by: Jeff Hostetler <jeffhost@microsoft.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
103 lines
3.2 KiB
C
103 lines
3.2 KiB
C
#ifndef FSMONITOR_H
|
|
#define FSMONITOR_H
|
|
|
|
#include "cache.h"
|
|
#include "dir.h"
|
|
#include "fsmonitor-settings.h"
|
|
|
|
extern struct trace_key trace_fsmonitor;
|
|
|
|
/*
|
|
* Read the fsmonitor index extension and (if configured) restore the
|
|
* CE_FSMONITOR_VALID state.
|
|
*/
|
|
int read_fsmonitor_extension(struct index_state *istate, const void *data, unsigned long sz);
|
|
|
|
/*
|
|
* Fill the fsmonitor_dirty ewah bits with their state from the index,
|
|
* before it is split during writing.
|
|
*/
|
|
void fill_fsmonitor_bitmap(struct index_state *istate);
|
|
|
|
/*
|
|
* Write the CE_FSMONITOR_VALID state into the fsmonitor index
|
|
* extension. Reads from the fsmonitor_dirty ewah in the index.
|
|
*/
|
|
void write_fsmonitor_extension(struct strbuf *sb, struct index_state *istate);
|
|
|
|
/*
|
|
* Add/remove the fsmonitor index extension
|
|
*/
|
|
void add_fsmonitor(struct index_state *istate);
|
|
void remove_fsmonitor(struct index_state *istate);
|
|
|
|
/*
|
|
* Add/remove the fsmonitor index extension as necessary based on the current
|
|
* core.fsmonitor setting.
|
|
*/
|
|
void tweak_fsmonitor(struct index_state *istate);
|
|
|
|
/*
|
|
* Run the configured fsmonitor integration script and clear the
|
|
* CE_FSMONITOR_VALID bit for any files returned as dirty. Also invalidate
|
|
* any corresponding untracked cache directory structures. Optimized to only
|
|
* run the first time it is called.
|
|
*/
|
|
void refresh_fsmonitor(struct index_state *istate);
|
|
|
|
/*
|
|
* Does the received result contain the "trivial" response?
|
|
*/
|
|
int fsmonitor_is_trivial_response(const struct strbuf *query_result);
|
|
|
|
/*
|
|
* Check if refresh_fsmonitor has been called at least once.
|
|
* refresh_fsmonitor is idempotent. Returns true if fsmonitor is
|
|
* not enabled (since the state will be "fresh" w/ CE_FSMONITOR_VALID unset)
|
|
* This version is useful for assertions
|
|
*/
|
|
static inline int is_fsmonitor_refreshed(const struct index_state *istate)
|
|
{
|
|
enum fsmonitor_mode fsm_mode = fsm_settings__get_mode(istate->repo);
|
|
|
|
return fsm_mode <= FSMONITOR_MODE_DISABLED ||
|
|
istate->fsmonitor_has_run_once;
|
|
}
|
|
|
|
/*
|
|
* Set the given cache entries CE_FSMONITOR_VALID bit. This should be
|
|
* called any time the cache entry has been updated to reflect the
|
|
* current state of the file on disk.
|
|
*/
|
|
static inline void mark_fsmonitor_valid(struct index_state *istate, struct cache_entry *ce)
|
|
{
|
|
enum fsmonitor_mode fsm_mode = fsm_settings__get_mode(istate->repo);
|
|
|
|
if (fsm_mode > FSMONITOR_MODE_DISABLED &&
|
|
!(ce->ce_flags & CE_FSMONITOR_VALID)) {
|
|
istate->cache_changed = 1;
|
|
ce->ce_flags |= CE_FSMONITOR_VALID;
|
|
trace_printf_key(&trace_fsmonitor, "mark_fsmonitor_clean '%s'", ce->name);
|
|
}
|
|
}
|
|
|
|
/*
|
|
* Clear the given cache entry's CE_FSMONITOR_VALID bit and invalidate
|
|
* any corresponding untracked cache directory structures. This should
|
|
* be called any time git creates or modifies a file that should
|
|
* trigger an lstat() or invalidate the untracked cache for the
|
|
* corresponding directory
|
|
*/
|
|
static inline void mark_fsmonitor_invalid(struct index_state *istate, struct cache_entry *ce)
|
|
{
|
|
enum fsmonitor_mode fsm_mode = fsm_settings__get_mode(istate->repo);
|
|
|
|
if (fsm_mode > FSMONITOR_MODE_DISABLED) {
|
|
ce->ce_flags &= ~CE_FSMONITOR_VALID;
|
|
untracked_cache_invalidate_path(istate, ce->name, 1);
|
|
trace_printf_key(&trace_fsmonitor, "mark_fsmonitor_invalid '%s'", ce->name);
|
|
}
|
|
}
|
|
|
|
#endif
|