diff --git a/HiddenBarTests/MenuBarEngineTests.swift b/HiddenBarTests/MenuBarEngineTests.swift index 72d06c86..1ae16e0d 100644 --- a/HiddenBarTests/MenuBarEngineTests.swift +++ b/HiddenBarTests/MenuBarEngineTests.swift @@ -3534,3 +3534,45 @@ final class PresentationModeEngineTests: XCTestCase { } } + +// MARK: - Capture activity listeners (#386) + +// Each monitor adds CoreAudio and CoreMediaIO property listeners and removes them +// again, on deinit and on every device change. A removal that does not match its +// add leaves the listener (a malloc block) registered for the life of the app, +// which is how the footprint grew to hundreds of MB over weeks of uptime. +final class CaptureActivityMonitorTests: XCTestCase { + func testRemovedListenersDoNotStayRegistered() throws { + let cycles = 100 + // The first monitor loads CoreMediaIO, which keeps its own blocks. + autoreleasepool { _ = CaptureActivityMonitor() } + let before = try liveMallocBlocks() + for _ in 0.. Int { + RunLoop.current.run(until: Date().addingTimeInterval(0.5)) + let heap = Process() + heap.executableURL = URL(fileURLWithPath: "/usr/bin/heap") + heap.arguments = ["\(ProcessInfo.processInfo.processIdentifier)"] + let out = Pipe() + heap.standardOutput = out + heap.standardError = Pipe() + try heap.run() + let data = out.fileHandleForReading.readDataToEndOfFile() + heap.waitUntilExit() + let line = String(decoding: data, as: UTF8.self).split(separator: "\n").first { $0.contains("__NSMallocBlock__") } + guard heap.terminationStatus == 0, let count = line?.split(separator: " ").first.flatMap({ Int($0) }) else { + throw XCTSkip("heap could not read this process (status \(heap.terminationStatus))") + } + return count + } +} diff --git a/hidden/Features/StatusBar/Engine/Native/CaptureActivityMonitor.swift b/hidden/Features/StatusBar/Engine/Native/CaptureActivityMonitor.swift index 62eb80c1..b56d2e8c 100644 --- a/hidden/Features/StatusBar/Engine/Native/CaptureActivityMonitor.swift +++ b/hidden/Features/StatusBar/Engine/Native/CaptureActivityMonitor.swift @@ -40,19 +40,49 @@ final class CaptureActivityMonitor: CaptureActivityMonitoring { private var processes: [AudioObjectID] = [] private var cameras: [CMIOObjectID] = [] - private var audioListener: AudioObjectPropertyListenerBlock! - private var cameraListener: CMIOObjectPropertyListenerBlock! + + // Listeners use the C function API, not the block API. Swift wraps a closure in + // a new block on every call, so a block remove never matched its add, and every + // listener stayed registered (and allocated) for the life of the app: one per + // audio process and camera on each device change (#386). The C API matches a + // removal by proc and client data. The client data is an id rather than a + // pointer, so a callback still in flight after deinit finds no monitor. + private let id: Int + private var clientData: UnsafeMutableRawPointer? { UnsafeMutableRawPointer(bitPattern: id) } + private static var nextID = 0 + private static var live: [Int: WeakMonitor] = [:] // main queue only + + private final class WeakMonitor { + weak var monitor: CaptureActivityMonitor? + init(_ monitor: CaptureActivityMonitor) { self.monitor = monitor } + } + + private static let audioListener: AudioObjectPropertyListenerProc = { _, _, _, clientData in + CaptureActivityMonitor.notify(clientData) + return noErr + } + + private static let cameraListener: CMIOObjectPropertyListenerProc = { _, _, _, clientData in + CaptureActivityMonitor.notify(clientData) + return noErr + } + + // Runs on a CoreAudio or CoreMediaIO thread. + private static func notify(_ clientData: UnsafeMutableRawPointer?) { + let id = Int(bitPattern: clientData) + DispatchQueue.main.async { live[id]?.monitor?.devicesDidChange() } + } init() { - // One block for every registration, so each can be removed again. - audioListener = { [weak self] _, _ in self?.devicesDidChange() } - cameraListener = { [weak self] _, _ in self?.devicesDidChange() } + Self.nextID += 1 + id = Self.nextID + Self.live[id] = WeakMonitor(self) if #available(macOS 14.2, *) { var processList = Self.audioAddress(kAudioHardwarePropertyProcessObjectList) - AudioObjectAddPropertyListenerBlock(AudioObjectID(kAudioObjectSystemObject), &processList, .main, audioListener) + AudioObjectAddPropertyListener(AudioObjectID(kAudioObjectSystemObject), &processList, Self.audioListener, clientData) } var cameraList = Self.cameraAddress(CMIOObjectPropertySelector(kCMIOHardwarePropertyDevices)) - CMIOObjectAddPropertyListenerBlock(CMIOObjectID(kCMIOObjectSystemObject), &cameraList, .main, cameraListener) + CMIOObjectAddPropertyListener(CMIOObjectID(kCMIOObjectSystemObject), &cameraList, Self.cameraListener, clientData) track() } @@ -60,10 +90,11 @@ final class CaptureActivityMonitor: CaptureActivityMonitoring { untrack() if #available(macOS 14.2, *) { var processList = Self.audioAddress(kAudioHardwarePropertyProcessObjectList) - AudioObjectRemovePropertyListenerBlock(AudioObjectID(kAudioObjectSystemObject), &processList, .main, audioListener) + AudioObjectRemovePropertyListener(AudioObjectID(kAudioObjectSystemObject), &processList, Self.audioListener, clientData) } var cameraList = Self.cameraAddress(CMIOObjectPropertySelector(kCMIOHardwarePropertyDevices)) - CMIOObjectRemovePropertyListenerBlock(CMIOObjectID(kCMIOObjectSystemObject), &cameraList, .main, cameraListener) + CMIOObjectRemovePropertyListener(CMIOObjectID(kCMIOObjectSystemObject), &cameraList, Self.cameraListener, clientData) + Self.live[id] = nil } var isActive: Bool { @@ -88,13 +119,13 @@ final class CaptureActivityMonitor: CaptureActivityMonitoring { processes = Self.audioObjects(kAudioHardwarePropertyProcessObjectList) var running = Self.audioAddress(kAudioProcessPropertyIsRunningInput) for process in processes { - AudioObjectAddPropertyListenerBlock(process, &running, .main, audioListener) + AudioObjectAddPropertyListener(process, &running, Self.audioListener, clientData) } } cameras = Self.cameraObjects() var running = Self.cameraAddress(CMIOObjectPropertySelector(kCMIODevicePropertyDeviceIsRunningSomewhere)) for camera in cameras { - CMIOObjectAddPropertyListenerBlock(camera, &running, .main, cameraListener) + CMIOObjectAddPropertyListener(camera, &running, Self.cameraListener, clientData) } } @@ -103,12 +134,12 @@ final class CaptureActivityMonitor: CaptureActivityMonitoring { if #available(macOS 14.2, *) { var running = Self.audioAddress(kAudioProcessPropertyIsRunningInput) for process in processes { - AudioObjectRemovePropertyListenerBlock(process, &running, .main, audioListener) + AudioObjectRemovePropertyListener(process, &running, Self.audioListener, clientData) } } var running = Self.cameraAddress(CMIOObjectPropertySelector(kCMIODevicePropertyDeviceIsRunningSomewhere)) for camera in cameras { - CMIOObjectRemovePropertyListenerBlock(camera, &running, .main, cameraListener) + CMIOObjectRemovePropertyListener(camera, &running, Self.cameraListener, clientData) } processes = [] cameras = []