Files
container/Sources/Services/ContainerImagesService/Client/RemoteContentStoreClient.swift
T
Raj d327a50219 Add container system df command for disk usage reporting (#902)
- Closes #884. 

## Type of Change
- [ ] Bug fix
- [x] New feature  
- [ ] Breaking change
- [ ] Documentation update

## Motivation and Context
This PR implements the `container system df` command to display disk
usage statistics for images, containers, and volumes, along with their
total count, active count, size, and reclaimable space for each resource
type.

Active resources are determined by container mount references and
running state, while reclaimable space is calculated from inactive or
stopped resources.

Example output:
```
~/container ❯ container system df
TYPE           TOTAL  ACTIVE  SIZE      RECLAIMABLE
Images         4      3       4.42 GB   516.5 MB (11%)
Containers     4      2       2.69 GB   1.51 GB (56%)
Local Volumes  3      2       208.5 MB  66.2 MB (32%)
```

I'll have some follow-on PRs that will add `-v/--verbose` flag for
detailed per-resource information, `--filter` flag for filtering output
by resource type, and a `--debug` flag for debug statistics like block
usage, clone counts etc.

## Testing
- [x] Tested locally
- [x] Added/updated tests
- [ ] Added/updated docs
2025-11-20 09:19:00 -08:00

149 lines
5.4 KiB
Swift

//===----------------------------------------------------------------------===//
// Copyright © 2025 Apple Inc. and the container project authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//===----------------------------------------------------------------------===//
#if os(macOS)
import Crypto
import ContainerizationError
import Foundation
import ContainerizationOCI
import ContainerXPC
public struct RemoteContentStoreClient: ContentStore {
private static let serviceIdentifier = "com.apple.container.core.container-core-images"
private static let encoder = JSONEncoder()
private static func newClient() -> XPCClient {
XPCClient(service: serviceIdentifier)
}
public init() {}
private func _get(digest: String) async throws -> URL? {
let client = Self.newClient()
let request = XPCMessage(route: .contentGet)
request.set(key: .digest, value: digest)
do {
let response = try await client.send(request)
guard let path = response.string(key: .contentPath) else {
return nil
}
return URL(filePath: path)
} catch let error as ContainerizationError {
if error.code == .notFound {
return nil
}
throw error
}
}
public func get(digest: String) async throws -> Content? {
guard let url = try await self._get(digest: digest) else {
return nil
}
return try LocalContent(path: url)
}
public func get<T: Decodable>(digest: String) async throws -> T? {
guard let content: Content = try await self.get(digest: digest) else {
return nil
}
return try content.decode()
}
public func delete(keeping: [String]) async throws -> ([String], UInt64) {
let client = Self.newClient()
let request = XPCMessage(route: .contentClean)
let d = try Self.encoder.encode(keeping)
request.set(key: .digests, value: d)
let response = try await client.send(request)
guard let data = response.dataNoCopy(key: .digests) else {
throw ContainerizationError.init(.internalError, message: "failed to delete digests")
}
let decoder = JSONDecoder()
let deleted = try decoder.decode([String].self, from: data)
let size = response.uint64(key: .imageSize)
return (deleted, size)
}
@discardableResult
public func delete(digests: [String]) async throws -> ([String], UInt64) {
let client = Self.newClient()
let request = XPCMessage(route: .contentDelete)
let d = try Self.encoder.encode(digests)
request.set(key: .digests, value: d)
let response = try await client.send(request)
guard let data = response.dataNoCopy(key: .digests) else {
throw ContainerizationError.init(.internalError, message: "failed to delete digests")
}
let decoder = JSONDecoder()
let deleted = try decoder.decode([String].self, from: data)
let size = response.uint64(key: .imageSize)
return (deleted, size)
}
@discardableResult
public func ingest(_ body: @Sendable @escaping (URL) async throws -> Void) async throws -> [String] {
let (id, tempPath) = try await self.newIngestSession()
try await body(tempPath)
return try await self.completeIngestSession(id)
}
public func newIngestSession() async throws -> (id: String, ingestDir: URL) {
let client = Self.newClient()
let request = XPCMessage(route: .contentIngestStart)
let response = try await client.send(request)
guard let id = response.string(key: .ingestSessionId) else {
throw ContainerizationError.init(.internalError, message: "failed create new ingest session")
}
guard let dir = response.string(key: .directory) else {
throw ContainerizationError.init(.internalError, message: "failed create new ingest session")
}
return (id, URL(filePath: dir))
}
@discardableResult
public func completeIngestSession(_ id: String) async throws -> [String] {
let client = Self.newClient()
let request = XPCMessage(route: .contentIngestComplete)
request.set(key: .ingestSessionId, value: id)
let response = try await client.send(request)
guard let data = response.dataNoCopy(key: .digests) else {
throw ContainerizationError.init(.internalError, message: "failed to delete digests")
}
let decoder = JSONDecoder()
let ingested = try decoder.decode([String].self, from: data)
return ingested
}
public func cancelIngestSession(_ id: String) async throws {
let client = Self.newClient()
let request = XPCMessage(route: .contentIngestCancel)
request.set(key: .ingestSessionId, value: id)
try await client.send(request)
}
}
#endif