Skip to content

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 1 commit into from
Apr 13, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions Sources/Basic/Lock.swift
Original file line number Diff line number Diff line change
Expand Up @@ -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?
Copy link
Contributor

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 of h for this variable?

Copy link
Contributor

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 :)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#else
private var fd: CInt?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What fd stands for?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

file descriptor

#endif

/// Path to the lock file.
private let lockFile: AbsolutePath
Expand All @@ -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)
Expand All @@ -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.
Expand Down
3 changes: 3 additions & 0 deletions Sources/SPMLibc/libc.swift
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@

#if os(Linux)
@_exported import Glibc
#elseif os(Windows)
@_exported import MSVCRT
@_exported import WinSDK
#else
@_exported import Darwin.C
#endif
Expand Down