1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2014 - 2018 Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See http://swift.org/LICENSE.txt for license information
See http://swift.org/CONTRIBUTORS.txt for Swift project authors
*/
import TSCBasic
import Dispatch
import Foundation
import TSCLibc
#if os(Windows)
import WinSDK
#endif
/// FSWatch is a cross-platform filesystem watching utility.
public class FSWatch {
public typealias EventReceivedBlock = (_ paths: [AbsolutePath]) -> Void
/// Delegate for handling events from the underling watcher.
fileprivate struct _WatcherDelegate {
let block: EventReceivedBlock
func pathsDidReceiveEvent(_ paths: [AbsolutePath]) {
block(paths)
}
}
/// The paths being watched.
public let paths: [AbsolutePath]
/// The underlying file watching utility.
///
/// This is FSEventStream on macOS and inotify on linux.
private var _watcher: _FileWatcher!
/// The number of seconds the watcher should wait before passing the
/// collected events to the clients.
let latency: Double
/// Create an instance with given paths.
///
/// Paths can be files or directories. Directories are watched recursively.
public init(paths: [AbsolutePath], latency: Double = 1, block: @escaping EventReceivedBlock) {
precondition(!paths.isEmpty)
self.paths = paths
self.latency = latency
#if os(OpenBSD)
self._watcher = NoOpWatcher(paths: paths, latency: latency, delegate: _WatcherDelegate(block: block))
#elseif os(Windows)
self._watcher = RDCWatcher(paths: paths, latency: latency, delegate: _WatcherDelegate(block: block))
#elseif canImport(Glibc) || canImport(Musl) || canImport(Android)
var ipaths: [AbsolutePath: Inotify.WatchOptions] = [:]
// FIXME: We need to recurse here.
for path in paths {
if localFileSystem.isDirectory(path) {
ipaths[path] = .defaultDirectoryWatchOptions
} else if localFileSystem.isFile(path) {
ipaths[path] = .defaultFileWatchOptions
// Watch files.
} else {
// FIXME: Report errors
}
}
self._watcher = Inotify(paths: ipaths, latency: latency, delegate: _WatcherDelegate(block: block))
#elseif os(macOS)
self._watcher = FSEventStream(paths: paths, latency: latency, delegate: _WatcherDelegate(block: block))
#else
fatalError("Unsupported platform")
#endif
}
/// Start watching the filesystem for events.
///
/// This method should be called only once.
public func start() throws {
// FIXME: Write precondition to ensure its called only once.
try _watcher.start()
}
/// Stop watching the filesystem.
///
/// This method should be called after start() and the object should be thrown away.
public func stop() {
// FIXME: Write precondition to ensure its called after start() and once only.
_watcher.stop()
}
}
/// Protocol to which the different file watcher implementations should conform.
private protocol _FileWatcher {
func start() throws
func stop()
}
#if os(OpenBSD) || (!os(macOS) && canImport(Darwin))
extension FSWatch._WatcherDelegate: NoOpWatcherDelegate {}
extension NoOpWatcher: _FileWatcher{}
#elseif os(Windows)
extension FSWatch._WatcherDelegate: RDCWatcherDelegate {}
extension RDCWatcher: _FileWatcher {}
#elseif canImport(Glibc) || canImport(Musl) || canImport(Android)
extension FSWatch._WatcherDelegate: InotifyDelegate {}
extension Inotify: _FileWatcher{}
#elseif os(macOS)
extension FSWatch._WatcherDelegate: FSEventStreamDelegate {}
extension FSEventStream: _FileWatcher{}
#else
#error("Implementation required")
#endif
// MARK:- inotify
#if os(OpenBSD) || (!os(macOS) && canImport(Darwin))
public protocol NoOpWatcherDelegate {
func pathsDidReceiveEvent(_ paths: [AbsolutePath])
}
public final class NoOpWatcher {
public init(paths: [AbsolutePath], latency: Double, delegate: NoOpWatcherDelegate? = nil) {
}
public func start() throws {}
public func stop() {}
}
#elseif os(Windows)
public protocol RDCWatcherDelegate {
func pathsDidReceiveEvent(_ paths: [AbsolutePath])
}
/// Bindings for `ReadDirectoryChangesW` C APIs.
public final class RDCWatcher {
class Watch {
var hDirectory: HANDLE
let path: String
var overlapped: OVERLAPPED
var terminate: HANDLE
var buffer: UnsafeMutableBufferPointer<DWORD> // buffer must be DWORD-aligned
var thread: TSCBasic.Thread?
public init(directory handle: HANDLE, _ path: String) {
self.hDirectory = handle
self.path = path
self.overlapped = OVERLAPPED()
self.overlapped.hEvent = CreateEventW(nil, false, false, nil)
self.terminate = CreateEventW(nil, true, false, nil)
let EntrySize: Int =
MemoryLayout<FILE_NOTIFY_INFORMATION>.stride + (Int(MAX_PATH) * MemoryLayout<WCHAR>.stride)
self.buffer =
UnsafeMutableBufferPointer<DWORD>.allocate(capacity: EntrySize * 4 / MemoryLayout<DWORD>.stride)
}
deinit {
SetEvent(self.terminate)
CloseHandle(self.terminate)
CloseHandle(self.overlapped.hEvent)
CloseHandle(hDirectory)
self.buffer.deallocate()
}
}
/// The paths being watched.
private let paths: [AbsolutePath]
/// The settle period (in seconds).
private let settle: Double
/// The watcher delegate.
private let delegate: RDCWatcherDelegate?
private let watches: [Watch]
private let queue: DispatchQueue =
DispatchQueue(label: "org.swift.swiftpm.\(RDCWatcher.self).callback")
public init(paths: [AbsolutePath], latency: Double, delegate: RDCWatcherDelegate? = nil) {
self.paths = paths
self.settle = latency
self.delegate = delegate
self.watches = paths.map {
$0.pathString.withCString(encodedAs: UTF16.self) {
let dwDesiredAccess: DWORD = DWORD(FILE_LIST_DIRECTORY)
let dwShareMode: DWORD = DWORD(FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE)
let dwCreationDisposition: DWORD = DWORD(OPEN_EXISTING)
let dwFlags: DWORD = DWORD(FILE_FLAG_BACKUP_SEMANTICS | FILE_FLAG_OVERLAPPED)
let handle: HANDLE =
CreateFileW($0, dwDesiredAccess, dwShareMode, nil,
dwCreationDisposition, dwFlags, nil)
assert(!(handle == INVALID_HANDLE_VALUE))
let dwSize: DWORD = GetFinalPathNameByHandleW(handle, nil, 0, 0)
let path: String = String(decodingCString: Array<WCHAR>(unsafeUninitializedCapacity: Int(dwSize) + 1) {
let dwSize: DWORD = GetFinalPathNameByHandleW(handle, $0.baseAddress, DWORD($0.count), 0)
assert(dwSize == $0.count)
$1 = Int(dwSize)
}, as: UTF16.self)
return Watch(directory: handle, path)
}
}
}
public func start() throws {
// TODO(compnerd) can we compress the threads to a single worker thread
self.watches.forEach { watch in
watch.thread = Thread { [delegate = self.delegate, queue = self.queue, weak watch] in
guard let watch = watch else { return }
while true {
let dwNotifyFilter: DWORD = DWORD(FILE_NOTIFY_CHANGE_FILE_NAME)
| DWORD(FILE_NOTIFY_CHANGE_DIR_NAME)
| DWORD(FILE_NOTIFY_CHANGE_SIZE)
| DWORD(FILE_NOTIFY_CHANGE_LAST_WRITE)
| DWORD(FILE_NOTIFY_CHANGE_CREATION)
var dwBytesReturned: DWORD = 0
if !ReadDirectoryChangesW(watch.hDirectory, &watch.buffer,
DWORD(watch.buffer.count * MemoryLayout<DWORD>.stride),
true, dwNotifyFilter, &dwBytesReturned,
&watch.overlapped, nil) {
return
}
var handles: (HANDLE?, HANDLE?) = (watch.terminate, watch.overlapped.hEvent)
switch WaitForMultipleObjects(2, &handles.0, false, INFINITE) {
case WAIT_OBJECT_0 + 1:
break
case DWORD(WAIT_TIMEOUT): // Spurious Wakeup?
continue
case WAIT_FAILED: // Failure
fallthrough
case WAIT_OBJECT_0: // Terminate Request
fallthrough
default:
CloseHandle(watch.hDirectory)
watch.hDirectory = INVALID_HANDLE_VALUE
return
}
if !GetOverlappedResult(watch.hDirectory, &watch.overlapped, &dwBytesReturned, false) {
queue.async {
delegate?.pathsDidReceiveEvent([AbsolutePath(watch.path)])
}
return
}
// There was a buffer underrun on the kernel side. We may
// have lost events, please re-synchronize.
if dwBytesReturned == 0 {
return
}
var paths: [AbsolutePath] = []
watch.buffer.withMemoryRebound(to: FILE_NOTIFY_INFORMATION.self) {
let pNotify: UnsafeMutablePointer<FILE_NOTIFY_INFORMATION>? =
$0.baseAddress
while var pNotify = pNotify {
// FIXME(compnerd) do we care what type of event was received?
let file: String =
String(utf16CodeUnitsNoCopy: &pNotify.pointee.FileName,
count: Int(pNotify.pointee.FileNameLength) / MemoryLayout<WCHAR>.stride,
freeWhenDone: false)
paths.append(AbsolutePath(file))
pNotify = (UnsafeMutableRawPointer(pNotify) + Int(pNotify.pointee.NextEntryOffset))
.assumingMemoryBound(to: FILE_NOTIFY_INFORMATION.self)
}
}
queue.async {
delegate?.pathsDidReceiveEvent(paths)
}
}
}
watch.thread?.start()
}
}
public func stop() {
self.watches.forEach {
SetEvent($0.terminate)
$0.thread?.join()
}
}
}
#elseif canImport(Glibc) || canImport(Musl) || canImport(Android)
/// The delegate for receiving inotify events.
public protocol InotifyDelegate {
func pathsDidReceiveEvent(_ paths: [AbsolutePath])
}
/// Bindings for inotify C APIs.
public final class Inotify {
/// The errors encountered during inotify operations.
public enum Error: Swift.Error {
case invalidFD
case failedToWatch(AbsolutePath)
}
/// The available options for a particular path.
public struct WatchOptions: OptionSet {
public let rawValue: Int32
public init(rawValue: Int32) {
self.rawValue = rawValue
}
// File/directory created in watched directory (e.g., open(2)
// O_CREAT, mkdir(2), link(2), symlink(2), bind(2) on a UNIX
// domain socket).
public static let create = WatchOptions(rawValue: IN_CREATE)
// File/directory deleted from watched directory.
public static let delete = WatchOptions(rawValue: IN_DELETE)
// Watched file/directory was itself deleted. (This event
// also occurs if an object is moved to another filesystem,
// since mv(1) in effect copies the file to the other
// filesystem and then deletes it from the original filesys‐
// tem.) In addition, an IN_IGNORED event will subsequently
// be generated for the watch descriptor.
public static let deleteSelf = WatchOptions(rawValue: IN_DELETE_SELF)
public static let move = WatchOptions(rawValue: IN_MOVE)
/// Watched file/directory was itself moved.
public static let moveSelf = WatchOptions(rawValue: IN_MOVE_SELF)
/// File was modified (e.g., write(2), truncate(2)).
public static let modify = WatchOptions(rawValue: IN_MODIFY)
// File or directory was opened.
public static let open = WatchOptions(rawValue: IN_OPEN)
// Metadata changed—for example, permissions (e.g.,
// chmod(2)), timestamps (e.g., utimensat(2)), extended
// attributes (setxattr(2)), link count (since Linux 2.6.25;
// e.g., for the target of link(2) and for unlink(2)), and
// user/group ID (e.g., chown(2)).
public static let attrib = WatchOptions(rawValue: IN_ATTRIB)
// File opened for writing was closed.
public static let closeWrite = WatchOptions(rawValue: IN_CLOSE_WRITE)
// File or directory not opened for writing was closed.
public static let closeNoWrite = WatchOptions(rawValue: IN_CLOSE_NOWRITE)
// File was accessed (e.g., read(2), execve(2)).
public static let access = WatchOptions(rawValue: IN_ACCESS)
/// The list of default options that can be used for watching files.
public static let defaultFileWatchOptions: WatchOptions = [.deleteSelf, .moveSelf, .modify]
/// The list of default options that can be used for watching directories.
public static let defaultDirectoryWatchOptions: WatchOptions = [.create, .delete, .deleteSelf, .move, .moveSelf]
/// List of all available events.
public static let all: [WatchOptions] = [
.create,
.delete,
.deleteSelf,
.move,
.moveSelf,
.modify,
.open,
.attrib,
.closeWrite,
.closeNoWrite,
.access,
]
}
// Sizeof inotify_event + max len of filepath + 1 (for null char).
private static let eventSize = MemoryLayout<inotify_event>.size + Int(NAME_MAX) + 1
/// The paths being watched.
public let paths: [AbsolutePath: WatchOptions]
/// The delegate.
private let delegate: InotifyDelegate?
/// The settle period (in seconds).
public let settle: Double
/// Internal properties.
private var fd: Int32?
/// The list of watched directories/files.
private var wds: [Int32: AbsolutePath] = [:]
/// The queue on which we read the events.
private let readQueue = DispatchQueue(label: "org.swift.swiftpm.\(Inotify.self).read")
/// Callback queue for the delegate.
private let callbacksQueue = DispatchQueue(label: "org.swift.swiftpm.\(Inotify.self).callback")
/// Condition for handling event reporting.
private var reportCondition = Condition()
// Should be read or written to using the report condition only.
private var collectedEvents: [AbsolutePath] = []
// Should be read or written to using the report condition only.
private var lastEventTime: Date? = nil
// Should be read or written to using the report condition only.
private var cancelled = false
/// Pipe for waking up the read loop.
private var cancellationPipe: [Int32] = [0, 0]
/// Create a inotify instance.
///
/// The paths are not watched recursively.
public init(paths: [AbsolutePath: WatchOptions], latency: Double, delegate: InotifyDelegate? = nil) {
self.paths = paths
self.delegate = delegate
self.settle = latency
}
/// Start the watch operation.
public func start() throws {
// All paths need to exist.
for (path, _) in paths {
guard localFileSystem.exists(path) else {
throw Error.failedToWatch(path)
}
}
// Create the file descriptor.
let fd = inotify_init1(Int32(IN_NONBLOCK))
guard fd != -1 else {
throw Error.invalidFD
}
self.fd = fd
/// Add watch for each path.
for (path, options) in paths {
let wd = inotify_add_watch(fd, path.description, UInt32(options.rawValue))
guard wd != -1 else {
throw Error.failedToWatch(path)
}
self.wds[wd] = path
}
// Start the report thread.
startReportThread()
readQueue.async {
self.startRead()
}
}
/// End the watch operation.
public func stop() {
// FIXME: Write precondition to ensure this is called only once.
guard let fd = fd else {
assertionFailure("end called without a fd")
return
}
// Shutdown the report thread.
reportCondition.whileLocked {
cancelled = true
reportCondition.signal()
}
// Wakeup the read loop by writing on the cancellation pipe.
let writtenData = write(cancellationPipe[1], "", 1)
assert(writtenData == 1)
// FIXME: We need to remove the watches.
close(fd)
}
private func startRead() {
guard let fd = fd else {
fatalError("unexpected call to startRead without fd")
}
// Create a pipe that we can use to get notified when we're cancelled.
let pipeRv = pipe(&cancellationPipe)
// FIXME: We don't see pipe2 for some reason.
let f = fcntl(cancellationPipe[0], F_SETFL, O_NONBLOCK)
assert(f != -1)
assert(pipeRv == 0)
while true {
// The read fd set. Contains the inotify and cancellation fd.
var rfds = fd_set()
FD_ZERO(&rfds)
FD_SET(fd, &rfds)
FD_SET(cancellationPipe[0], &rfds)
let nfds = [fd, cancellationPipe[0]].reduce(0, max) + 1
// num fds, read fds, write fds, except fds, timeout
let selectRet = select(nfds, &rfds, nil, nil, nil)
// FIXME: Check for int signal.
assert(selectRet != -1)
// Return if we're cancelled.
if FD_ISSET(cancellationPipe[0], &rfds) {
return
}
assert(FD_ISSET(fd, &rfds))
let buf = UnsafeMutablePointer<CChar>.allocate(capacity: Inotify.eventSize)
// FIXME: We need to free the buffer.
let readLength = read(fd, buf, Inotify.eventSize)
// FIXME: Check for int signal.
// Consume events.
var idx = 0
while idx < readLength {
let event = withUnsafePointer(to: &buf[idx]) {
$0.withMemoryRebound(to: inotify_event.self, capacity: 1) {
$0.pointee
}
}
// Get the associated with the event.
var path = wds[event.wd]!
// FIXME: We need extract information from the event mask and
// create a data structure.
// FIXME: Do we need to detect and remove watch for directories
// that are deleted?
// Get the relative base name from the event if present.
if event.len > 0 {
// Get the basename of the file that had the event.
let basename = String(cString: buf + idx + MemoryLayout<inotify_event>.size)
// Construct the full path.
// FIXME: We should report this path separately.
path = path.appending(component: basename)
}
// Signal the reporter.
reportCondition.whileLocked {
lastEventTime = Date()
collectedEvents.append(path)
reportCondition.signal()
}
idx += MemoryLayout<inotify_event>.size + Int(event.len)
}
}
}
/// Spawns a thread that collects events and reports them after the settle period.
private func startReportThread() {
let thread = TSCBasic.Thread {
var endLoop = false
while !endLoop {
// Block until we timeout or get signalled.
self.reportCondition.whileLocked {
var performReport = false
// Block until timeout expires or wait forever until we get some event.
if let lastEventTime = self.lastEventTime {
let timeout = lastEventTime + Double(self.settle)
let timeLimitReached = !self.reportCondition.wait(until: timeout)
if timeLimitReached {
self.lastEventTime = nil
performReport = true
}
} else {
self.reportCondition.wait()
}
// If we're cancelled, just return.
if self.cancelled {
endLoop = true
return
}
// Report the events if we're asked to.
if performReport && !self.collectedEvents.isEmpty {
let events = self.collectedEvents
self.collectedEvents = []
self.callbacksQueue.async {
self.report(events)
}
}
}
}
}
thread.start()
}
private func report(_ paths: [AbsolutePath]) {
delegate?.pathsDidReceiveEvent(paths)
}
}
// FIXME: <rdar://problem/45794219> Swift should provide shims for FD_ macros
private func FD_ZERO(_ set: inout fd_set) {
#if os(Android) || canImport(Musl)
#if arch(arm)
set.fds_bits = (0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0)
#else
set.fds_bits = (0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0)
#endif
#else
#if arch(arm)
set.__fds_bits = (0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0)
#else
set.__fds_bits = (0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0)
#endif
#endif
}
private func FD_SET(_ fd: Int32, _ set: inout fd_set) {
let intOffset = Int(fd / 16)
let bitOffset = Int(fd % 16)
#if os(Android) || canImport(Musl)
var fd_bits = set.fds_bits
let mask: UInt = 1 << bitOffset
#else
var fd_bits = set.__fds_bits
let mask = 1 << bitOffset
#endif
switch intOffset {
case 0: fd_bits.0 = fd_bits.0 | mask
case 1: fd_bits.1 = fd_bits.1 | mask
case 2: fd_bits.2 = fd_bits.2 | mask
case 3: fd_bits.3 = fd_bits.3 | mask
case 4: fd_bits.4 = fd_bits.4 | mask
case 5: fd_bits.5 = fd_bits.5 | mask
case 6: fd_bits.6 = fd_bits.6 | mask
case 7: fd_bits.7 = fd_bits.7 | mask
case 8: fd_bits.8 = fd_bits.8 | mask
case 9: fd_bits.9 = fd_bits.9 | mask
case 10: fd_bits.10 = fd_bits.10 | mask
case 11: fd_bits.11 = fd_bits.11 | mask
case 12: fd_bits.12 = fd_bits.12 | mask
case 13: fd_bits.13 = fd_bits.13 | mask
case 14: fd_bits.14 = fd_bits.14 | mask
case 15: fd_bits.15 = fd_bits.15 | mask
#if arch(arm)
case 16: fd_bits.16 = fd_bits.16 | mask
case 17: fd_bits.17 = fd_bits.17 | mask
case 18: fd_bits.18 = fd_bits.18 | mask
case 19: fd_bits.19 = fd_bits.19 | mask
case 20: fd_bits.20 = fd_bits.20 | mask
case 21: fd_bits.21 = fd_bits.21 | mask
case 22: fd_bits.22 = fd_bits.22 | mask
case 23: fd_bits.23 = fd_bits.23 | mask
case 24: fd_bits.24 = fd_bits.24 | mask
case 25: fd_bits.25 = fd_bits.25 | mask
case 26: fd_bits.26 = fd_bits.26 | mask
case 27: fd_bits.27 = fd_bits.27 | mask
case 28: fd_bits.28 = fd_bits.28 | mask
case 29: fd_bits.29 = fd_bits.29 | mask
case 30: fd_bits.30 = fd_bits.30 | mask
case 31: fd_bits.31 = fd_bits.31 | mask
#endif
default: break
}
#if os(Android) || canImport(Musl)
set.fds_bits = fd_bits
#else
set.__fds_bits = fd_bits
#endif
}
private func FD_ISSET(_ fd: Int32, _ set: inout fd_set) -> Bool {
let intOffset = Int(fd / 32)
let bitOffset = Int(fd % 32)
#if os(Android) || canImport(Musl)
let fd_bits = set.fds_bits
let mask: UInt = 1 << bitOffset
#else
let fd_bits = set.__fds_bits
let mask = 1 << bitOffset
#endif
switch intOffset {
case 0: return fd_bits.0 & mask != 0
case 1: return fd_bits.1 & mask != 0
case 2: return fd_bits.2 & mask != 0
case 3: return fd_bits.3 & mask != 0
case 4: return fd_bits.4 & mask != 0
case 5: return fd_bits.5 & mask != 0
case 6: return fd_bits.6 & mask != 0
case 7: return fd_bits.7 & mask != 0
case 8: return fd_bits.8 & mask != 0
case 9: return fd_bits.9 & mask != 0
case 10: return fd_bits.10 & mask != 0
case 11: return fd_bits.11 & mask != 0
case 12: return fd_bits.12 & mask != 0
case 13: return fd_bits.13 & mask != 0
case 14: return fd_bits.14 & mask != 0
case 15: return fd_bits.15 & mask != 0
#if arch(arm)
case 16: return fd_bits.16 & mask != 0
case 17: return fd_bits.17 & mask != 0
case 18: return fd_bits.18 & mask != 0
case 19: return fd_bits.19 & mask != 0
case 20: return fd_bits.20 & mask != 0
case 21: return fd_bits.21 & mask != 0
case 22: return fd_bits.22 & mask != 0
case 23: return fd_bits.23 & mask != 0
case 24: return fd_bits.24 & mask != 0
case 25: return fd_bits.25 & mask != 0
case 26: return fd_bits.26 & mask != 0
case 27: return fd_bits.27 & mask != 0
case 28: return fd_bits.28 & mask != 0
case 29: return fd_bits.29 & mask != 0
case 30: return fd_bits.30 & mask != 0
case 31: return fd_bits.31 & mask != 0
#endif
default: return false
}
}
#endif
// MARK:- FSEventStream
#if os(macOS)
private func callback(
streamRef: ConstFSEventStreamRef,
clientCallBackInfo: UnsafeMutableRawPointer?,
numEvents: Int,
eventPaths: UnsafeMutableRawPointer,
eventFlags: UnsafePointer<FSEventStreamEventFlags>,
eventIds: UnsafePointer<FSEventStreamEventId>
) {
let eventStream = unsafeBitCast(clientCallBackInfo, to: FSEventStream.self)
// We expect the paths to be reported in an NSArray because we requested CFTypes.
let eventPaths = unsafeBitCast(eventPaths, to: NSArray.self) as? [String] ?? []
// Compute the set of paths that were changed.
let paths = eventPaths.compactMap({ try? AbsolutePath(validating: $0) })
eventStream.callbacksQueue.async {
eventStream.delegate.pathsDidReceiveEvent(paths)
}
}
public protocol FSEventStreamDelegate {
func pathsDidReceiveEvent(_ paths: [AbsolutePath])
}
/// Wrapper for Darwin's FSEventStream API.
public final class FSEventStream {
/// The errors encountered during fs event watching.
public enum Error: Swift.Error {
case unknownError
}
/// Reference to the underlying event stream.
///
/// This is var and implicitly unwrapped optional because
/// we need to capture self for the context.
private var stream: FSEventStreamRef!
/// Reference to the handler that should be called.
let delegate: FSEventStreamDelegate
/// The thread on which the stream is running.
private var thread: TSCBasic.Thread?
/// The run loop attached to the stream.
private var runLoop: CFRunLoop?
/// Callback queue for the delegate.
fileprivate let callbacksQueue = DispatchQueue(label: "org.swift.swiftpm.\(FSEventStream.self).callback")
public init(
paths: [AbsolutePath],
latency: Double,
delegate: FSEventStreamDelegate,
flags: FSEventStreamCreateFlags = FSEventStreamCreateFlags(kFSEventStreamCreateFlagUseCFTypes)
) {
self.delegate = delegate
// Create the context that needs to be passed to the callback.
var callbackContext = FSEventStreamContext()
callbackContext.info = unsafeBitCast(self, to: UnsafeMutableRawPointer.self)
// Create the stream.
self.stream = FSEventStreamCreate(nil,
callback,
&callbackContext,
paths.map({ $0.pathString }) as CFArray,
FSEventStreamEventId(kFSEventStreamEventIdSinceNow),
latency,
flags
)
}
// Start the runloop.
public func start() throws {
let thread = TSCBasic.Thread { [weak self] in
guard let `self` = self else { return }
self.runLoop = CFRunLoopGetCurrent()
// Schedule the run loop.
FSEventStreamScheduleWithRunLoop(
self.stream,
CFRunLoopGetCurrent(),
CFRunLoopMode.defaultMode.rawValue
)
// Start the stream.
FSEventStreamScheduleWithRunLoop(self.stream, CFRunLoopGetCurrent(), CFRunLoopMode.defaultMode.rawValue)
FSEventStreamStart(self.stream)
CFRunLoopRun()
// Perform cleanup.
FSEventStreamStop(self.stream)
FSEventStreamUnscheduleFromRunLoop(self.stream, CFRunLoopGetCurrent(), CFRunLoopMode.defaultMode.rawValue)
FSEventStreamInvalidate(self.stream)
FSEventStreamRelease(self.stream)
}
thread.start()
self.thread = thread
}
/// Stop watching the events.
public func stop() {
// FIXME: This is probably not thread safe?
if let runLoop = self.runLoop {
CFRunLoopStop(runLoop)
}
}
}
#endif
|