]>
Commit | Line | Data |
---|---|---|
9dcba0ba JH |
1 | #ifndef FSMONITOR_DAEMON_H |
2 | #define FSMONITOR_DAEMON_H | |
3 | ||
4 | #ifdef HAVE_FSMONITOR_DAEMON_BACKEND | |
5 | ||
9dcba0ba JH |
6 | #include "dir.h" |
7 | #include "run-command.h" | |
8 | #include "simple-ipc.h" | |
9 | #include "thread-utils.h" | |
12fd27df | 10 | #include "fsmonitor-path-utils.h" |
9dcba0ba JH |
11 | |
12 | struct fsmonitor_batch; | |
13 | struct fsmonitor_token_data; | |
14 | ||
bec486b9 JH |
15 | /* |
16 | * Create a new batch of path(s). The returned batch is considered | |
17 | * private and not linked into the fsmonitor daemon state. The caller | |
18 | * should fill this batch with one or more paths and then publish it. | |
19 | */ | |
20 | struct fsmonitor_batch *fsmonitor_batch__new(void); | |
21 | ||
22 | /* | |
23 | * Free the list of batches starting with this one. | |
24 | */ | |
25 | void fsmonitor_batch__free_list(struct fsmonitor_batch *batch); | |
26 | ||
27 | /* | |
28 | * Add this path to this batch of modified files. | |
29 | * | |
30 | * The batch should be private and NOT (yet) linked into the fsmonitor | |
31 | * daemon state and therefore not yet visible to worker threads and so | |
32 | * no locking is required. | |
33 | */ | |
34 | void fsmonitor_batch__add_path(struct fsmonitor_batch *batch, const char *path); | |
35 | ||
207534e4 | 36 | struct fsm_listen_data; /* opaque platform-specific data for listener thread */ |
d0605550 | 37 | struct fsm_health_data; /* opaque platform-specific data for health thread */ |
9dcba0ba JH |
38 | |
39 | struct fsmonitor_daemon_state { | |
40 | pthread_t listener_thread; | |
d0605550 | 41 | pthread_t health_thread; |
9dcba0ba JH |
42 | pthread_mutex_t main_lock; |
43 | ||
44 | struct strbuf path_worktree_watch; | |
45 | struct strbuf path_gitdir_watch; | |
12fd27df | 46 | struct alias_info alias; |
9dcba0ba JH |
47 | int nr_paths_watching; |
48 | ||
49 | struct fsmonitor_token_data *current_token_data; | |
50 | ||
b05880d3 JH |
51 | struct strbuf path_cookie_prefix; |
52 | pthread_cond_t cookies_cond; | |
53 | int cookie_seq; | |
54 | struct hashmap cookies; | |
55 | ||
207534e4 | 56 | int listen_error_code; |
d0605550 | 57 | int health_error_code; |
207534e4 | 58 | struct fsm_listen_data *listen_data; |
d0605550 | 59 | struct fsm_health_data *health_data; |
9dcba0ba JH |
60 | |
61 | struct ipc_server_data *ipc_server_data; | |
39664e93 | 62 | struct strbuf path_ipc; |
12fd27df | 63 | |
9dcba0ba JH |
64 | }; |
65 | ||
0ae7a1d9 JH |
66 | /* |
67 | * Pathname classifications. | |
68 | * | |
69 | * The daemon classifies the pathnames that it receives from file | |
70 | * system notification events into the following categories and uses | |
71 | * that to decide whether clients are told about them. (And to watch | |
72 | * for file system synchronization events.) | |
73 | * | |
74 | * The daemon only collects and reports on the set of modified paths | |
75 | * within the working directory (proper). | |
76 | * | |
77 | * The client should only care about paths within the working | |
78 | * directory proper (inside the working directory and not ".git" nor | |
79 | * inside of ".git/"). That is, the client has read the index and is | |
80 | * asking for a list of any paths in the working directory that have | |
81 | * been modified since the last token. The client does not care about | |
82 | * file system changes within the ".git/" directory (such as new loose | |
83 | * objects or packfiles). So the client will only receive paths that | |
84 | * are classified as IS_WORKDIR_PATH. | |
85 | * | |
86 | * Note that ".git" is usually a directory and is therefore inside | |
87 | * the cone of the FS watch that we have on the working directory root, | |
88 | * so we will also get FS events for disk activity on and within ".git/" | |
89 | * that we need to respond to or filter from the client. | |
90 | * | |
91 | * But Git also allows ".git" to be a *file* that points to a GITDIR | |
92 | * outside of the working directory. When this happens, we need to | |
93 | * create FS watches on both the working directory root *and* on the | |
94 | * (external) GITDIR root. (The latter is required because we put | |
95 | * cookie files inside it and use them to sync with the FS event | |
96 | * stream.) | |
97 | * | |
98 | * Note that in the context of this discussion, I'm using "GITDIR" | |
99 | * to only mean an external GITDIR referenced by a ".git" file. | |
100 | * | |
101 | * The platform FS event backends will receive watch-specific | |
102 | * relative paths (except for those OS's that always emit absolute | |
103 | * paths). We use the following enum and routines to classify each | |
104 | * path so that we know how to handle it. There is a slight asymmetry | |
105 | * here because ".git/" is inside the working directory and the | |
106 | * (external) GITDIR is not, and therefore how we handle events may | |
107 | * vary slightly, so I have different enums for "IS...DOT_GIT..." and | |
108 | * "IS...GITDIR...". | |
109 | * | |
110 | * The daemon uses the IS_DOT_GIT and IS_GITDIR internally to mean the | |
111 | * exact ".git" file/directory or GITDIR directory. If the daemon | |
112 | * receives a delete event for either of these paths, it will | |
113 | * automatically shutdown, for example. | |
114 | * | |
115 | * Note that the daemon DOES NOT explicitly watch nor special case the | |
116 | * index. The daemon does not read the index nor have any internal | |
117 | * index-relative state, so there are no "IS...INDEX..." enum values. | |
118 | */ | |
119 | enum fsmonitor_path_type { | |
120 | IS_WORKDIR_PATH = 0, | |
121 | ||
122 | IS_DOT_GIT, | |
123 | IS_INSIDE_DOT_GIT, | |
124 | IS_INSIDE_DOT_GIT_WITH_COOKIE_PREFIX, | |
125 | ||
126 | IS_GITDIR, | |
127 | IS_INSIDE_GITDIR, | |
128 | IS_INSIDE_GITDIR_WITH_COOKIE_PREFIX, | |
129 | ||
130 | IS_OUTSIDE_CONE, | |
131 | }; | |
132 | ||
133 | /* | |
134 | * Classify a pathname relative to the root of the working directory. | |
135 | */ | |
136 | enum fsmonitor_path_type fsmonitor_classify_path_workdir_relative( | |
137 | const char *relative_path); | |
138 | ||
139 | /* | |
140 | * Classify a pathname relative to a <gitdir> that is external to the | |
141 | * worktree directory. | |
142 | */ | |
143 | enum fsmonitor_path_type fsmonitor_classify_path_gitdir_relative( | |
144 | const char *relative_path); | |
145 | ||
146 | /* | |
147 | * Classify an absolute pathname received from a filesystem event. | |
148 | */ | |
149 | enum fsmonitor_path_type fsmonitor_classify_path_absolute( | |
150 | struct fsmonitor_daemon_state *state, | |
151 | const char *path); | |
152 | ||
bec486b9 JH |
153 | /* |
154 | * Prepend the this batch of path(s) onto the list of batches associated | |
155 | * with the current token. This makes the batch visible to worker threads. | |
156 | * | |
157 | * The caller no longer owns the batch and must not free it. | |
158 | * | |
159 | * Wake up the client threads waiting on these cookies. | |
160 | */ | |
161 | void fsmonitor_publish(struct fsmonitor_daemon_state *state, | |
162 | struct fsmonitor_batch *batch, | |
163 | const struct string_list *cookie_names); | |
164 | ||
165 | /* | |
166 | * If the platform-specific layer loses sync with the filesystem, | |
167 | * it should call this to invalidate cached data and abort waiting | |
168 | * threads. | |
169 | */ | |
170 | void fsmonitor_force_resync(struct fsmonitor_daemon_state *state); | |
171 | ||
9dcba0ba JH |
172 | #endif /* HAVE_FSMONITOR_DAEMON_BACKEND */ |
173 | #endif /* FSMONITOR_DAEMON_H */ |