mirror of
https://github.com/apple/container.git
synced 2026-10-14 10:09:10 +00:00
Danny Canter
1be13d1d76
Now that the static linux SDK we use has libarchive linked against it, we can finally live our dream (/s) of supporting copying directories in/out a little easier. This was.. kind of annoying. I think the very simple route of writing archive to guest/host -> streaming over grpc is simplest, but on the guest end we have a couple problems: 1. The VMs rootfs is read only today always, which is a good thing to me and I don't want to change if we don't have to. 2. Writing the archive to the containers rootfs temporarily could work, but it's a bit weird, and the user can make the containers rootfs readonly which would screw that plan. 3. We could write it to /run or /tmp, but they're tmpfs and dealing with the headache of the user possibly tarring an enormous dir is one I don't want to care about. So, that leaves us with the (truthfully better to me) approach of trying to write the tar data directly to the host and skipping grpc which kinda forces us to have a temp spot. Because of that, I made it such that we pass a port number from host<->guest, and transfer the actual data (either the single file or tarred dir contents) over the vsock port instead. The stream is kinda clunky, but it just serves as a means to exchange metadata and a "we're done" signifier.
101 lines
4.3 KiB
Swift
101 lines
4.3 KiB
Swift
//===----------------------------------------------------------------------===//
|
|
// Copyright © 2025-2026 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 ContainerizationExtras
|
|
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 sync() async throws
|
|
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?,
|
|
ociRuntimePath: String?,
|
|
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, ipv4Address: CIDRv4) async throws
|
|
func routeAddLink(name: String, dstIPv4Addr: IPv4Address, srcIPv4Addr: IPv4Address?) async throws
|
|
func routeAddDefault(name: String, ipv4Gateway: IPv4Address) async throws
|
|
func configureDNS(config: DNS, location: String) async throws
|
|
func configureHosts(config: Hosts, location: String) async throws
|
|
|
|
// Container statistics
|
|
func containerStatistics(containerIDs: [String], categories: StatCategory) 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], categories: StatCategory) async throws -> [ContainerStatistics] {
|
|
throw ContainerizationError(.unsupported, message: "containerStatistics")
|
|
}
|
|
|
|
public func sync() async throws {
|
|
throw ContainerizationError(.unsupported, message: "sync")
|
|
}
|
|
}
|