Skip to content

armgit / peel

Public Imported from GitHub
0

Uninstall Mac apps with every file they leave behind, and see why each belongs. Free up space, fine-tune macOS, and set up Terminal.

Stop reading a file when Duplicates is stopped

Țugui Dragoșc0eef8cef3d1
diff --git a/Packages/PeelCore/Sources/PeelCore/Duplicates/DuplicateFinder.swift b/Packages/PeelCore/Sources/PeelCore/Duplicates/DuplicateFinder.swift
index 3fc2f334..1ba55e26 100644
--- a/Packages/PeelCore/Sources/PeelCore/Duplicates/DuplicateFinder.swift
+++ b/Packages/PeelCore/Sources/PeelCore/Duplicates/DuplicateFinder.swift
@@ -214,7 +214,7 @@ public struct DuplicateFinder: Sendable {
let comparing = ReportThrottle()
let sampled = await FileDigest.many(
sameSize,
- digest: { FileDigest.sample(of: $0.url, identity: $0.identity, known: known) }
+ digest: { FileDigest.sample(of: $0.url, identity: $0.identity, known: known, isGivenUp: $1) }
) { completed in
if comparing.allows(isLast: completed == sameSize.count) {
progress(.comparing(filesCompared: completed, filesToCompare: sameSize.count))
@@ -236,8 +236,10 @@ public struct DuplicateFinder: Sendable {
bytesToRead: FileDigest.bytesToRead(toVerify.map(\.identity), known: known),
report: progress
)
- let verified = await FileDigest.many(toVerify) { candidate in
- FileDigest.full(of: candidate.url, identity: candidate.identity, known: known, onRead: reading.add)
+ let verified = await FileDigest.many(toVerify) { candidate, isGivenUp in
+ FileDigest.full(
+ of: candidate.url, identity: candidate.identity, known: known, isGivenUp: isGivenUp, onRead: reading.add
+ )
}
guard !Task.isCancelled else { throw CancellationError() }
diff --git a/Packages/PeelCore/Sources/PeelCore/Duplicates/FileDigest.swift b/Packages/PeelCore/Sources/PeelCore/Duplicates/FileDigest.swift
index 91e90a9c..0a1eafe2 100644
--- a/Packages/PeelCore/Sources/PeelCore/Duplicates/FileDigest.swift
+++ b/Packages/PeelCore/Sources/PeelCore/Duplicates/FileDigest.swift
@@ -21,7 +21,7 @@ enum FileDigest {
/// reads still under way are given up and no new read starts.
static func many<Item: Sendable>(
_ items: [Item],
- digest: @escaping @Sendable (Item) -> ContentDigest?,
+ digest: @escaping @Sendable (Item, _ isGivenUp: @escaping @Sendable () -> Bool) -> ContentDigest?,
onCompletion: (Int) -> Void = { _ in }
) async -> [(item: Item, digest: ContentDigest)] {
await withTaskGroup(of: (item: Item, digest: ContentDigest)?.self) { group in
@@ -48,13 +48,18 @@ enum FileDigest {
private static func read<Item: Sendable>(
_ item: Item,
- _ digest: @escaping @Sendable (Item) -> ContentDigest?
+ _ digest: @escaping @Sendable (Item, _ isGivenUp: @escaping @Sendable () -> Bool) -> ContentDigest?
) async -> (item: Item, digest: ContentDigest)? {
- (await BlockingWork.run { _ in digest(item) } ?? nil).map { (item: item, digest: $0) }
+ (await BlockingWork.run { digest(item, $0) } ?? nil).map { (item: item, digest: $0) }
}
/// SHA-256 of the first and last `sampleLength` bytes, or of the whole file when it isn't longer than both.
- static func sample(of url: URL, identity: FileIdentity, known: KnownDigests? = nil) -> ContentDigest? {
+ static func sample(
+ of url: URL,
+ identity: FileIdentity,
+ known: KnownDigests? = nil,
+ isGivenUp: () -> Bool = { false }
+ ) -> ContentDigest? {
if let digest = known?.sample(of: identity) { return digest }
// Each buffer is only as large as the read it serves, not `chunkLength`: this pass runs for every
// candidate and reads at most 128 KiB of each.
@@ -69,7 +74,7 @@ enum FileDigest {
into: &hasher
)
}
- : whole(url, identity: identity)
+ : whole(url, identity: identity, isGivenUp: isGivenUp)
if let digest { known?.keep(sample: digest, of: identity) }
return digest
}
@@ -78,15 +83,18 @@ enum FileDigest {
of url: URL,
identity: FileIdentity,
known: KnownDigests? = nil,
+ isGivenUp: () -> Bool = { false },
onRead: (Int) -> Void = { _ in }
) -> ContentDigest? {
if let digest = known?.full(of: identity) { return digest }
- let digest = whole(url, identity: identity, onRead: onRead)
+ let digest = whole(url, identity: identity, isGivenUp: isGivenUp, onRead: onRead)
if let digest { known?.keep(full: digest, of: identity) }
return digest
}
- private static func whole(_ url: URL, identity: FileIdentity, onRead: (Int) -> Void = { _ in }) -> ContentDigest? {
+ private static func whole(
+ _ url: URL, identity: FileIdentity, isGivenUp: () -> Bool, onRead: (Int) -> Void = { _ in }
+ ) -> ContentDigest? {
read(
url,
bufferLength: Int(min(Int64(chunkLength), max(identity.size, 1))),
@@ -94,7 +102,8 @@ enum FileDigest {
) { descriptor, buffer, hasher in
var offset: Int64 = 0
while offset < identity.size {
- guard !Task.isCancelled else { return false }
+ // This runs on `BlockingWork`'s queue, where no task is current and `Task.isCancelled` is always false.
+ guard !isGivenUp() else { return false }
let count = Int(min(Int64(buffer.count), identity.size - offset))
guard readFully(descriptor, count: count, offset: offset, buffer: buffer, into: &hasher) else {
return false
diff --git a/Packages/PeelCore/Sources/PeelCore/Duplicates/FolderDuplicates.swift b/Packages/PeelCore/Sources/PeelCore/Duplicates/FolderDuplicates.swift
index 650d415f..7f7bc796 100644
--- a/Packages/PeelCore/Sources/PeelCore/Duplicates/FolderDuplicates.swift
+++ b/Packages/PeelCore/Sources/PeelCore/Duplicates/FolderDuplicates.swift
@@ -79,7 +79,7 @@ struct FolderDuplicates: Sendable {
let comparing = ReportThrottle()
let sampled = await FileDigest.many(
files,
- digest: { FileDigest.sample(of: $0.url, identity: $0.identity, known: known) }
+ digest: { FileDigest.sample(of: $0.url, identity: $0.identity, known: known, isGivenUp: $1) }
) { completed in
if comparing.allows(isLast: completed == files.count) {
progress(.comparing(filesCompared: completed, filesToCompare: files.count))
@@ -94,8 +94,10 @@ struct FolderDuplicates: Sendable {
bytesToRead: FileDigest.bytesToRead(toRead.map(\.identity), known: known),
report: progress
)
- let read = await FileDigest.many(toRead) { file in
- FileDigest.full(of: file.url, identity: file.identity, known: known, onRead: reading.add)
+ let read = await FileDigest.many(toRead) { file, isGivenUp in
+ FileDigest.full(
+ of: file.url, identity: file.identity, known: known, isGivenUp: isGivenUp, onRead: reading.add
+ )
}
guard !Task.isCancelled else { throw CancellationError() }
var contents = samples.filter { !FileDigest.isSampled(size: $0.key.size) }
diff --git a/Packages/PeelCore/Tests/PeelCoreTests/DuplicateFinderTests.swift b/Packages/PeelCore/Tests/PeelCoreTests/DuplicateFinderTests.swift
index 167d3fab..d3c662c5 100644
--- a/Packages/PeelCore/Tests/PeelCoreTests/DuplicateFinderTests.swift
+++ b/Packages/PeelCore/Tests/PeelCoreTests/DuplicateFinderTests.swift
@@ -17,7 +17,7 @@ struct DuplicateFinderTests {
@Test func aReadThatNeverAnswersHoldsNeitherAStoppedScanNorItsThreads() async throws {
let stuck = Stuck()
let reading = Task {
- await FileDigest.many(Array(0..<8)) { _ -> ContentDigest? in
+ await FileDigest.many(Array(0..<8)) { _, _ -> ContentDigest? in
stuck.hold()
return nil
}
@@ -31,6 +31,34 @@ struct DuplicateFinderTests {
stuck.letGo()
}
+ @Test func aStoppedScanStopsReadingTheFileItIsReadingWhole() async throws {
+ let directory = try TemporaryDirectory()
+ let length = 64 << 20
+ let file = try directory.file("big.bin", contents: Data(count: length))
+ var info = stat()
+ #expect(lstat(file.path(percentEncoded: false), &info) == 0)
+ let identity = FileIdentity(info)
+ let bytesRead = Mutex(0)
+ let stop = Mutex<(@Sendable () -> Void)?>(nil)
+ let (ended, end) = AsyncStream.makeStream(of: Void.self)
+ let reading = Task {
+ await FileDigest.many([file]) { url, isGivenUp in
+ defer { end.finish() }
+ return FileDigest.full(of: url, identity: identity, isGivenUp: isGivenUp) { count in
+ bytesRead.withLock { $0 += count }
+ stop.withLock { $0 }?()
+ while !isGivenUp() { usleep(100) }
+ }
+ }
+ }
+ stop.withLock { $0 = { reading.cancel() } }
+
+ for await _ in ended {}
+ _ = await reading.value
+
+ #expect(bytesRead.withLock { $0 } < length)
+ }
+
@Test func aWalkThatNeverAnswersHoldsNeitherAStoppedScanNorItsThreads() async throws {
let stuck = Stuck()
let walking = Task {