Here is V4 of Part 2 of my Builtin FSMonitor series. I have rebased it onto
the current "master" branch to address conflicts and errors with recent
changes already in master.
In response to comments on V3, I have pulled in more commits from complete
series. Part 2 now includes both the client-side code to talk to via a
daemon via IPC and an MVP implementation of the fsmonitor--daemon itself.
This version of the daemon is functional and can be tested using t/t7527 and
t/perf/p7519.
A followup Part 3 will contain additional refinements to the daemon and
additional tests. I drew the line here between Part 2 and 3 to make it
easier to review.
cc: Bagas Sanjaya bagasdotme@xxxxxxxxx cc: Ævar Arnfjörð Bjarmason
avarab@xxxxxxxxx cc: Jeff Hostetler git@xxxxxxxxxxxxxxxxx
Jeff Hostetler (29):
fsmonitor: enhance existing comments
fsmonitor-ipc: create client routines for git-fsmonitor--daemon
fsmonitor: config settings are repository-specific
fsmonitor: use IPC to query the builtin FSMonitor daemon
fsmonitor: document builtin fsmonitor
fsmonitor--daemon: add a built-in fsmonitor daemon
fsmonitor--daemon: implement 'stop' and 'status' commands
compat/fsmonitor/fsm-listen-win32: stub in backend for Windows
compat/fsmonitor/fsm-listen-darwin: stub in backend for Darwin
fsmonitor--daemon: implement 'run' command
fsmonitor--daemon: implement 'start' command
fsmonitor--daemon: add pathname classification
fsmonitor--daemon: define token-ids
fsmonitor--daemon: create token-based changed path cache
compat/fsmonitor/fsm-listen-win32: implement FSMonitor backend on
Windows
compat/fsmonitor/fsm-listen-darwin: add macos header files for FSEvent
compat/fsmonitor/fsm-listen-darwin: implement FSEvent listener on
MacOS
fsmonitor--daemon: implement handle_client callback
help: include fsmonitor--daemon feature flag in version info
t/helper/fsmonitor-client: create IPC client to talk to FSMonitor
Daemon
t7527: create test for fsmonitor--daemon
t/perf: avoid copying builtin fsmonitor files into test repo
t/helper/test-chmtime: skip directories on Windows
t/perf/p7519: speed up test on Windows
t/perf/p7519: add fsmonitor--daemon test cases
fsmonitor--daemon: periodically truncate list of modified files
fsmonitor--daemon: use a cookie file to sync with file system
fsmonitor: force update index after large responses
t7527: test status with untracked-cache and fsmonitor--daemon
.gitignore | 1 +
Documentation/config/core.txt | 56 +-
Documentation/git-fsmonitor--daemon.txt | 75 ++
Documentation/git-update-index.txt | 27 +-
Documentation/githooks.txt | 3 +-
Makefile | 17 +
builtin.h | 1 +
builtin/fsmonitor--daemon.c | 1454 +++++++++++++++++++++++
builtin/update-index.c | 19 +-
cache.h | 1 -
compat/fsmonitor/fsm-listen-darwin.c | 496 ++++++++
compat/fsmonitor/fsm-listen-win32.c | 586 +++++++++
compat/fsmonitor/fsm-listen.h | 49 +
config.c | 14 -
config.h | 1 -
config.mak.uname | 20 +
contrib/buildsystems/CMakeLists.txt | 10 +
environment.c | 1 -
fsmonitor--daemon.h | 140 +++
fsmonitor-ipc.c | 176 +++
fsmonitor-ipc.h | 48 +
fsmonitor-settings.c | 97 ++
fsmonitor-settings.h | 21 +
fsmonitor.c | 187 ++-
fsmonitor.h | 18 +-
git.c | 1 +
help.c | 4 +
repo-settings.c | 1 +
repository.h | 3 +
t/README | 4 +-
t/helper/test-chmtime.c | 15 +
t/helper/test-fsmonitor-client.c | 121 ++
t/helper/test-tool.c | 1 +
t/helper/test-tool.h | 1 +
t/perf/p7519-fsmonitor.sh | 61 +-
t/perf/perf-lib.sh | 2 +-
t/t7527-builtin-fsmonitor.sh | 607 ++++++++++
t/test-lib.sh | 6 +
38 files changed, 4247 insertions(+), 98 deletions(-)
create mode 100644 Documentation/git-fsmonitor--daemon.txt
create mode 100644 builtin/fsmonitor--daemon.c
create mode 100644 compat/fsmonitor/fsm-listen-darwin.c
create mode 100644 compat/fsmonitor/fsm-listen-win32.c
create mode 100644 compat/fsmonitor/fsm-listen.h
create mode 100644 fsmonitor--daemon.h
create mode 100644 fsmonitor-ipc.c
create mode 100644 fsmonitor-ipc.h
create mode 100644 fsmonitor-settings.c
create mode 100644 fsmonitor-settings.h
create mode 100644 t/helper/test-fsmonitor-client.c
create mode 100755 t/t7527-builtin-fsmonitor.sh
base-commit: 9d530dc0024503ab4218fe6c4395b8a0aa245478
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1041%2Fjeffhostetler%2Fbuiltin-fsmonitor-part2-v4
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1041/jeffhostetler/builtin-fsmonitor-part2-v4
Pull-Request: https://github.com/gitgitgadget/git/pull/1041
Range-diff vs v3:
1: cb25eeaf72d = 1: ecc40795fa2 fsmonitor: enhance existing comments
2: df81a63acee = 2: 82f17692128 fsmonitor-ipc: create client routines for git-fsmonitor--daemon
3: a1d606aa622 = 3: 882789b4dfe fsmonitor: config settings are repository-specific
4: 4d8d812be08 = 4: de82c726182 fsmonitor: use IPC to query the builtin FSMonitor daemon
5: 45a86cef8d7 ! 5: d365704d551 fsmonitor: update fsmonitor config documentation
@@ Metadata
Author: Jeff Hostetler <jeffhost@xxxxxxxxxxxxx>
## Commit message ##
- fsmonitor: update fsmonitor config documentation
+ fsmonitor: document builtin fsmonitor
+
+ Document the new `core.useBuiltinFSMonitor` config value.
Update references to `core.fsmonitor` and `core.fsmonitorHookVersion` and
- pointers to `Watchman` to mention the new `core.useBuiltinFSMonitor`
- value.
+ pointers to `Watchman` to refer to it.
+
+ Create `git-fsmonitor--daemon` manual page and describe its features.
Signed-off-by: Jeff Hostetler <jeffhost@xxxxxxxxxxxxx>
@@ Documentation/config/core.txt: core.protectNTFS::
core.trustctime::
If false, the ctime differences between the index and the
+ ## Documentation/git-fsmonitor--daemon.txt (new) ##
+@@
++git-fsmonitor--daemon(1)
++========================
++
++NAME
++----
++git-fsmonitor--daemon - A Built-in File System Monitor
++
++SYNOPSIS
++--------
++[verse]
++'git fsmonitor--daemon' start
++'git fsmonitor--daemon' run
++'git fsmonitor--daemon' stop
++'git fsmonitor--daemon' status
++
++DESCRIPTION
++-----------
++
++A daemon to watch the working directory for file and directory
++changes using platform-specific file system notification facilities.
++
++This daemon communicates directly with commands like `git status`
++using the link:technical/api-simple-ipc.html[simple IPC] interface
++instead of the slower linkgit:githooks[5] interface.
++
++This daemon is built into Git so that no third-party tools are
++required.
++
++OPTIONS
++-------
++
++start::
++ Starts a daemon in the background.
++
++run::
++ Runs a daemon in the foreground.
++
++stop::
++ Stops the daemon running in the current working
++ directory, if present.
++
++status::
++ Exits with zero status if a daemon is watching the
++ current working directory.
++
++REMARKS
++-------
++
++This daemon is a long running process used to watch a single working
++directory and maintain a list of the recently changed files and
++directories. Performance of commands such as `git status` can be
++increased if they just ask for a summary of changes to the working
++directory and can avoid scanning the disk.
++
++When `core.useBuiltinFSMonitor` is set to `true` (see
++linkgit:git-config[1]) commands, such as `git status`, will ask the
++daemon for changes and automatically start it (if necessary).
++
++For more information see the "File System Monitor" section in
++linkgit:git-update-index[1].
++
++CAVEATS
++-------
++
++The fsmonitor daemon does not currently know about submodules and does
++not know to filter out file system events that happen within a
++submodule. If fsmonitor daemon is watching a super repo and a file is
++modified within the working directory of a submodule, it will report
++the change (as happening against the super repo). However, the client
++will properly ignore these extra events, so performance may be affected
++but it will not cause an incorrect result.
++
++GIT
++---
++Part of the linkgit:git[1] suite
+
## Documentation/git-update-index.txt ##
@@ Documentation/git-update-index.txt: FILE SYSTEM MONITOR
This feature is intended to speed up git operations for repos that have
-: ----------- > 6: 78e682fc530 fsmonitor--daemon: add a built-in fsmonitor daemon
-: ----------- > 7: ea64b5c9753 fsmonitor--daemon: implement 'stop' and 'status' commands
-: ----------- > 8: 5a40b33a00c compat/fsmonitor/fsm-listen-win32: stub in backend for Windows
-: ----------- > 9: ed5819e29f8 compat/fsmonitor/fsm-listen-darwin: stub in backend for Darwin
-: ----------- > 10: d3ac973a5f1 fsmonitor--daemon: implement 'run' command
-: ----------- > 11: d08c28b549c fsmonitor--daemon: implement 'start' command
-: ----------- > 12: 6fa71fdc825 fsmonitor--daemon: add pathname classification
-: ----------- > 13: 65821da5b03 fsmonitor--daemon: define token-ids
-: ----------- > 14: 429c48a5bad fsmonitor--daemon: create token-based changed path cache
-: ----------- > 15: b04c460c619 compat/fsmonitor/fsm-listen-win32: implement FSMonitor backend on Windows
-: ----------- > 16: 862bbfcc32e compat/fsmonitor/fsm-listen-darwin: add macos header files for FSEvent
-: ----------- > 17: 40d9a816b52 compat/fsmonitor/fsm-listen-darwin: implement FSEvent listener on MacOS
-: ----------- > 18: 241962894f1 fsmonitor--daemon: implement handle_client callback
-: ----------- > 19: 704d37d2033 help: include fsmonitor--daemon feature flag in version info
-: ----------- > 20: de6c72a9ce0 t/helper/fsmonitor-client: create IPC client to talk to FSMonitor Daemon
-: ----------- > 21: eedaa787c2e t7527: create test for fsmonitor--daemon
-: ----------- > 22: 4e96e0667ba t/perf: avoid copying builtin fsmonitor files into test repo
-: ----------- > 23: de9c015d78c t/helper/test-chmtime: skip directories on Windows
-: ----------- > 24: 1c2eccacff6 t/perf/p7519: speed up test on Windows
-: ----------- > 25: 236b5966257 t/perf/p7519: add fsmonitor--daemon test cases
-: ----------- > 26: 54710a4830d fsmonitor--daemon: periodically truncate list of modified files
-: ----------- > 27: 1e2bd77fcea fsmonitor--daemon: use a cookie file to sync with file system
-: ----------- > 28: 30e61b6d1ad fsmonitor: force update index after large responses
-: ----------- > 29: 507020bbef0 t7527: test status with untracked-cache and fsmonitor--daemon
--
gitgitgadget
