Files
container/Sources/Services/ContainerImagesService/Client/ImageServiceXPCKeys.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

101 lines
2.7 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 Foundation
import ContainerXPC
/// Keys for XPC fields.
public enum ImagesServiceXPCKeys: String {
case fd
/// FDs pointing to container logs key.
case logs
/// Path to a file on disk key.
case filePath
/// Images
case imageReference
case imageNewReference
case imageDescription
case imageDescriptions
case filesystem
case ociPlatform
case insecureFlag
case garbageCollect
/// ContentStore
case digest
case digests
case directory
case contentPath
case imageSize
case ingestSessionId
/// Disk Usage
case activeImageReferences
case totalCount
case activeCount
case reclaimableSize
}
extension XPCMessage {
public func set(key: ImagesServiceXPCKeys, value: String) {
self.set(key: key.rawValue, value: value)
}
public func set(key: ImagesServiceXPCKeys, value: UInt64) {
self.set(key: key.rawValue, value: value)
}
public func set(key: ImagesServiceXPCKeys, value: Data) {
self.set(key: key.rawValue, value: value)
}
public func set(key: ImagesServiceXPCKeys, value: Bool) {
self.set(key: key.rawValue, value: value)
}
public func set(key: ImagesServiceXPCKeys, value: Int64) {
self.set(key: key.rawValue, value: value)
}
public func string(key: ImagesServiceXPCKeys) -> String? {
self.string(key: key.rawValue)
}
public func data(key: ImagesServiceXPCKeys) -> Data? {
self.data(key: key.rawValue)
}
public func dataNoCopy(key: ImagesServiceXPCKeys) -> Data? {
self.dataNoCopy(key: key.rawValue)
}
public func uint64(key: ImagesServiceXPCKeys) -> UInt64 {
self.uint64(key: key.rawValue)
}
public func int64(key: ImagesServiceXPCKeys) -> Int64 {
self.int64(key: key.rawValue)
}
public func bool(key: ImagesServiceXPCKeys) -> Bool {
self.bool(key: key.rawValue)
}
}
#endif