mirror of
https://github.com/apple/container.git
synced 2026-09-12 10:45:42 +00:00
Danny Canter
06d3a37f8d
Closes #138 This rounds up cgroup and network stats (via netlink) and exposes them via an agent rpc and on LinuxContainer. While this is not an entirely accurate view into the full resources being used by the container given the virtualized nature (doesn't account for vcpu, device etc overhead) it should give an accurate overview of the workload resource usage in the guest. This change besides the stated goal also removes the interfaceStatistics rpc and just moves these network stats into the new containerStatistics one. Related to that, it also renames the InterfaceStatistics struct to NetworkStatistics and moves this into ContainerStatistics as a nested struct.
93 lines
3.9 KiB
Swift
93 lines
3.9 KiB
Swift
//===----------------------------------------------------------------------===//
|
|
// Copyright © 2025 Apple Inc. and the Containerization 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 ContainerizationError
|
|
import ContainerizationOCI
|
|
import Foundation
|
|
|
|
public struct WriteFileFlags {
|
|
public var createParentDirectories = false
|
|
public var append = false
|
|
public var create = false
|
|
}
|
|
|
|
/// A protocol for the agent running inside a virtual machine. If an operation isn't
|
|
/// supported the implementation MUST return a ContainerizationError with a code of
|
|
/// `.unsupported`.
|
|
public protocol VirtualMachineAgent: Sendable {
|
|
/// Perform a platform specific standard setup
|
|
/// of the runtime environment.
|
|
func standardSetup() async throws
|
|
/// Close any resources held by the agent.
|
|
func close() async throws
|
|
|
|
// POSIX-y
|
|
func getenv(key: String) async throws -> String
|
|
func setenv(key: String, value: String) async throws
|
|
func mount(_ mount: ContainerizationOCI.Mount) async throws
|
|
func umount(path: String, flags: Int32) async throws
|
|
func mkdir(path: String, all: Bool, perms: UInt32) async throws
|
|
@discardableResult
|
|
func kill(pid: Int32, signal: Int32) async throws -> Int32
|
|
func writeFile(path: String, data: Data, flags: WriteFileFlags, mode: UInt32) async throws
|
|
|
|
// Process lifecycle
|
|
func createProcess(
|
|
id: String,
|
|
containerID: String?,
|
|
stdinPort: UInt32?,
|
|
stdoutPort: UInt32?,
|
|
stderrPort: UInt32?,
|
|
configuration: ContainerizationOCI.Spec,
|
|
options: Data?
|
|
) async throws
|
|
func startProcess(id: String, containerID: String?) async throws -> Int32
|
|
func signalProcess(id: String, containerID: String?, signal: Int32) async throws
|
|
func resizeProcess(id: String, containerID: String?, columns: UInt32, rows: UInt32) async throws
|
|
func waitProcess(id: String, containerID: String?, timeoutInSeconds: Int64?) async throws -> ExitStatus
|
|
func deleteProcess(id: String, containerID: String?) async throws
|
|
func closeProcessStdin(id: String, containerID: String?) async throws
|
|
|
|
// Networking
|
|
func up(name: String, mtu: UInt32?) async throws
|
|
func down(name: String) async throws
|
|
func addressAdd(name: String, address: String) async throws
|
|
func routeAddDefault(name: String, gateway: String) async throws
|
|
func configureDNS(config: DNS, location: String) async throws
|
|
func configureHosts(config: Hosts, location: String) async throws
|
|
|
|
// Container statistics
|
|
func containerStatistics(containerIDs: [String]) async throws -> [ContainerStatistics]
|
|
}
|
|
|
|
extension VirtualMachineAgent {
|
|
public func closeProcessStdin(id: String, containerID: String?) async throws {
|
|
throw ContainerizationError(.unsupported, message: "closeProcessStdin")
|
|
}
|
|
|
|
public func configureHosts(config: Hosts, location: String) async throws {
|
|
throw ContainerizationError(.unsupported, message: "configureHosts")
|
|
}
|
|
|
|
public func writeFile(path: String, data: Data, flags: WriteFileFlags, mode: UInt32) async throws {
|
|
throw ContainerizationError(.unsupported, message: "writeFile")
|
|
}
|
|
|
|
public func containerStatistics(containerIDs: [String]) async throws -> [ContainerStatistics] {
|
|
throw ContainerizationError(.unsupported, message: "containerStatistics")
|
|
}
|
|
}
|