Files
container/Sources/ContainerClient/Core/ClientVolume.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

99 lines
3.5 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.
//===----------------------------------------------------------------------===//
import ContainerXPC
import Containerization
import Foundation
public struct ClientVolume {
static let serviceIdentifier = "com.apple.container.apiserver"
public static func create(
name: String,
driver: String = "local",
driverOpts: [String: String] = [:],
labels: [String: String] = [:]
) async throws -> Volume {
let client = XPCClient(service: serviceIdentifier)
let message = XPCMessage(route: .volumeCreate)
message.set(key: .volumeName, value: name)
message.set(key: .volumeDriver, value: driver)
let driverOptsData = try JSONEncoder().encode(driverOpts)
message.set(key: .volumeDriverOpts, value: driverOptsData)
let labelsData = try JSONEncoder().encode(labels)
message.set(key: .volumeLabels, value: labelsData)
let reply = try await client.send(message)
guard let responseData = reply.dataNoCopy(key: .volume) else {
throw VolumeError.storageError("Invalid response from server")
}
return try JSONDecoder().decode(Volume.self, from: responseData)
}
public static func delete(name: String) async throws {
let client = XPCClient(service: serviceIdentifier)
let message = XPCMessage(route: .volumeDelete)
message.set(key: .volumeName, value: name)
_ = try await client.send(message)
}
public static func list() async throws -> [Volume] {
let client = XPCClient(service: serviceIdentifier)
let message = XPCMessage(route: .volumeList)
let reply = try await client.send(message)
guard let responseData = reply.dataNoCopy(key: .volumes) else {
return []
}
return try JSONDecoder().decode([Volume].self, from: responseData)
}
public static func inspect(_ name: String) async throws -> Volume {
let client = XPCClient(service: serviceIdentifier)
let message = XPCMessage(route: .volumeInspect)
message.set(key: .volumeName, value: name)
let reply = try await client.send(message)
guard let responseData = reply.dataNoCopy(key: .volume) else {
throw VolumeError.volumeNotFound(name)
}
return try JSONDecoder().decode(Volume.self, from: responseData)
}
public static func prune() async throws -> ([String], UInt64) {
let client = XPCClient(service: serviceIdentifier)
let message = XPCMessage(route: .volumePrune)
let reply = try await client.send(message)
guard let responseData = reply.dataNoCopy(key: .volumes) else {
return ([], 0)
}
let volumeNames = try JSONDecoder().decode([String].self, from: responseData)
let size = reply.uint64(key: .volumeSize)
return (volumeNames, size)
}
}