fix(kqueue): close watch descriptors on Close()#1
Merged
Conversation
Close() calls shared.close() first, which marks the watcher as closed by closing the done channel. It then iterates calling Remove() for each watched path. But remove() checks isClosed() at entry and short-circuits without closing any file descriptors. This leaks every file and directory watch descriptor opened by addWatch(). On macOS with kqueue, watching a directory also watches all files within it, so a watcher monitoring N directories with M total files leaks N+M descriptors per Close() call. Long-running processes that recreate watchers (e.g. dev servers with hot reload) accumulate leaked descriptors until hitting EMFILE. Fix: close all watch descriptors directly by iterating the wd map instead of delegating to Remove(). Signed-off-by: Christian Stewart <christian@aperture.us>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Close() calls shared.close() first, which marks the watcher as closed by closing the done channel. It then iterates calling Remove() for each watched path. But remove() checks isClosed() at entry and short-circuits without closing any file descriptors.
This leaks every file and directory watch descriptor opened by addWatch(). On macOS with kqueue, watching a directory also watches all files within it, so a watcher monitoring N directories with M total files leaks N+M descriptors per Close() call. Long-running processes that recreate watchers (e.g. dev servers with hot reload) accumulate leaked descriptors until hitting EMFILE.
Fix: close all watch descriptors directly by iterating the wd map instead of delegating to Remove().
Upstream issue: fsnotify#720