-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Implement Lock.swift on Windows #2080
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -36,7 +36,11 @@ enum ProcessLockError: Swift.Error { | |
/// by mutiple instances of a process. The `FileLock` is not thread-safe. | ||
public final class FileLock { | ||
/// File descriptor to the lock file. | ||
#if os(Windows) | ||
private var h: HANDLE? | ||
#else | ||
private var fd: CInt? | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. file descriptor |
||
#endif | ||
|
||
/// Path to the lock file. | ||
private let lockFile: AbsolutePath | ||
|
@@ -53,6 +57,32 @@ public final class FileLock { | |
/// | ||
/// Note: This method can throw if underlying POSIX methods fail. | ||
public func lock() throws { | ||
#if os(Windows) | ||
if h == nil { | ||
let h = lockFile.pathString.withCString(encodedAs: UTF16.self, { | ||
CreateFileW( | ||
$0, | ||
UInt32(GENERIC_READ) | UInt32(GENERIC_WRITE), | ||
0, | ||
nil, | ||
DWORD(OPEN_ALWAYS), | ||
DWORD(FILE_ATTRIBUTE_NORMAL), | ||
nil | ||
) | ||
}) | ||
if h == INVALID_HANDLE_VALUE { | ||
throw FileSystemError(errno: Int32(GetLastError())) | ||
} | ||
self.h = h | ||
} | ||
var overlapped = OVERLAPPED() | ||
overlapped.Offset = 0 | ||
overlapped.OffsetHigh = 0 | ||
overlapped.hEvent = nil | ||
if FALSE == LockFileEx(h, DWORD(LOCKFILE_EXCLUSIVE_LOCK), 0, DWORD(INT_MAX), DWORD(INT_MAX), &overlapped) { | ||
throw ProcessLockError.unableToAquireLock(errno: Int32(GetLastError())) | ||
} | ||
#else | ||
// Open the lock file. | ||
if fd == nil { | ||
let fd = SPMLibc.open(lockFile.pathString, O_WRONLY | O_CREAT | O_CLOEXEC, 0o666) | ||
|
@@ -70,17 +100,31 @@ public final class FileLock { | |
if errno == EINTR { continue } | ||
throw ProcessLockError.unableToAquireLock(errno: errno) | ||
} | ||
#endif | ||
} | ||
|
||
/// Unlock the held lock. | ||
public func unlock() { | ||
#if os(Windows) | ||
var overlapped = OVERLAPPED() | ||
overlapped.Offset = 0 | ||
overlapped.OffsetHigh = 0 | ||
overlapped.hEvent = nil | ||
UnlockFileEx(h, 0, DWORD(INT_MAX), DWORD(INT_MAX), &overlapped) | ||
#else | ||
guard let fd = fd else { return } | ||
flock(fd, LOCK_UN) | ||
#endif | ||
} | ||
|
||
deinit { | ||
#if os(Windows) | ||
guard let h = h else { return } | ||
CloseHandle(h) | ||
#else | ||
guard let fd = fd else { return } | ||
close(fd) | ||
#endif | ||
} | ||
|
||
/// Execute the given block while holding the lock. | ||
|
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why not at least
handle
instead ofh
for this variable?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Renaming to
handle
would be nice to have. Feel free to make a PR :)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@aciidb0mb3r PR #2093 ;)