Files
container/Sources/Containerization/LinuxContainer.swift
T
Danny Canter 1be13d1d76 LinuxContainer: Support copying directories (#571)
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.
2026-03-06 15:30:00 -08:00

1338 lines
54 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.
//===----------------------------------------------------------------------===//
#if os(macOS)
import ContainerizationArchive
import ContainerizationError
import ContainerizationExtras
import ContainerizationOCI
import Foundation
import Logging
import Synchronization
import struct ContainerizationOS.Terminal
/// `LinuxContainer` is an easy to use type for launching and managing the
/// full lifecycle of a Linux container ran inside of a virtual machine.
public final class LinuxContainer: Container, Sendable {
/// The identifier of the container.
public let id: String
/// Rootfs for the container.
///
/// Note: The `destination` field of this mount is ignored as mounting is handled internally.
public let rootfs: Mount
/// Optional writable layer for the container. When provided, the rootfs
/// is mounted as the lower layer of an overlayfs, with this as the upper layer.
/// All writes will go to this layer instead of the rootfs.
///
/// Note: The `destination` field of this mount is ignored as mounting is handled internally.
public let writableLayer: Mount?
/// Configuration for the container.
public let config: Configuration
/// The configuration for the LinuxContainer.
public struct Configuration: Sendable {
/// Configuration for the init process of the container.
public var process = LinuxProcessConfiguration()
/// The amount of cpus for the container.
public var cpus: Int = 4
/// The memory in bytes to give to the container.
public var memoryInBytes: UInt64 = 1024.mib()
/// The hostname for the container.
public var hostname: String?
/// The system control options for the container.
public var sysctl: [String: String] = [:]
/// The network interfaces for the container.
public var interfaces: [any Interface] = []
/// The Unix domain socket relays to setup for the container.
public var sockets: [UnixSocketConfiguration] = []
/// The mounts for the container.
public var mounts: [Mount] = LinuxContainer.defaultMounts()
/// The DNS configuration for the container.
public var dns: DNS?
/// The hosts to add to /etc/hosts for the container.
public var hosts: Hosts?
/// Enable nested virtualization support.
public var virtualization: Bool = false
/// Optional destination for serial boot logs.
public var bootLog: BootLog?
/// EXPERIMENTAL: Path in the root filesystem for the virtual
/// machine where the OCI runtime used to spawn the container lives.
public var ociRuntimePath: String?
/// Run the container with a minimal init process that handles signal
/// forwarding and zombie reaping.
public var useInit: Bool = false
public init() {}
public init(
process: LinuxProcessConfiguration,
cpus: Int = 4,
memoryInBytes: UInt64 = 1024.mib(),
hostname: String? = nil,
sysctl: [String: String] = [:],
interfaces: [any Interface] = [],
sockets: [UnixSocketConfiguration] = [],
mounts: [Mount] = LinuxContainer.defaultMounts(),
dns: DNS? = nil,
hosts: Hosts? = nil,
virtualization: Bool = false,
bootLog: BootLog? = nil,
ociRuntimePath: String? = nil,
useInit: Bool = false
) {
self.process = process
self.cpus = cpus
self.memoryInBytes = memoryInBytes
self.hostname = hostname
self.sysctl = sysctl
self.interfaces = interfaces
self.sockets = sockets
self.mounts = mounts
self.dns = dns
self.hosts = hosts
self.virtualization = virtualization
self.bootLog = bootLog
self.ociRuntimePath = ociRuntimePath
self.useInit = useInit
}
}
private let state: AsyncMutex<State>
// Ports to be allocated from for stdio and for
// unix socket relays that are sharing a guest
// uds to the host.
private let hostVsockPorts: Atomic<UInt32>
// Ports we request the guest to allocate for unix socket relays from
// the host.
private let guestVsockPorts: Atomic<UInt32>
// Queue for copy IO.
private let copyQueue = DispatchQueue(label: "com.apple.containerization.copy")
private enum State: Sendable {
/// The container class has been created but no live resources are running.
case initialized
/// The container's virtual machine has been setup and the runtime environment has been configured.
case created(CreatedState)
/// The initial process of the container has started and is running.
case started(StartedState)
/// The container has run and fully stopped.
case stopped
/// An error occurred during the lifetime of this class.
case errored(Swift.Error)
/// The container is paused.
case paused(PausedState)
struct CreatedState: Sendable {
let vm: any VirtualMachineInstance
let relayManager: UnixSocketRelayManager
var fileMountContext: FileMountContext
}
struct StartedState: Sendable {
let vm: any VirtualMachineInstance
let process: LinuxProcess
let relayManager: UnixSocketRelayManager
var vendedProcesses: [String: LinuxProcess]
let fileMountContext: FileMountContext
init(_ state: CreatedState, process: LinuxProcess) {
self.vm = state.vm
self.relayManager = state.relayManager
self.process = process
self.vendedProcesses = [:]
self.fileMountContext = state.fileMountContext
}
init(_ state: PausedState) {
self.vm = state.vm
self.relayManager = state.relayManager
self.process = state.process
self.vendedProcesses = state.vendedProcesses
self.fileMountContext = state.fileMountContext
}
}
struct PausedState: Sendable {
let vm: any VirtualMachineInstance
let relayManager: UnixSocketRelayManager
let process: LinuxProcess
var vendedProcesses: [String: LinuxProcess]
let fileMountContext: FileMountContext
init(_ state: StartedState) {
self.vm = state.vm
self.relayManager = state.relayManager
self.process = state.process
self.vendedProcesses = state.vendedProcesses
self.fileMountContext = state.fileMountContext
}
}
func createdState(_ operation: String) throws -> CreatedState {
switch self {
case .created(let state):
return state
case .errored(let err):
throw err
default:
throw ContainerizationError(
.invalidState,
message: "failed to \(operation): container must be created"
)
}
}
func startedState(_ operation: String) throws -> StartedState {
switch self {
case .started(let state):
return state
case .errored(let err):
throw err
default:
throw ContainerizationError(
.invalidState,
message: "failed to \(operation): container must be running"
)
}
}
func pausedState(_ operation: String) throws -> PausedState {
switch self {
case .paused(let state):
return state
case .errored(let err):
throw err
default:
throw ContainerizationError(
.invalidState,
message: "failed to \(operation): container must be paused"
)
}
}
mutating func validateForCreate() throws {
switch self {
case .initialized, .stopped:
break
case .errored(let err):
throw err
default:
throw ContainerizationError(
.invalidState,
message: "container must be in initialized or stopped state to create"
)
}
}
mutating func setErrored(error: Swift.Error) {
self = .errored(error)
}
}
private let vmm: VirtualMachineManager
private let logger: Logger?
/// Create a new `LinuxContainer`.
///
/// - Parameters:
/// - id: The identifier for the container.
/// - rootfs: The root filesystem mount containing the container image contents.
/// The `destination` field is ignored as mounting is handled internally.
/// - writableLayer: Optional writable layer mount. When provided, an overlayfs is used with
/// rootfs as the lower layer and this as the upper layer. Must be a block device.
/// The `destination` field is ignored as mounting is handled internally.
/// - vmm: The virtual machine manager that will handle launching the VM for the container.
/// - logger: Optional logger for container operations.
/// - configuration: A closure that configures the container by modifying the Configuration instance.
public convenience init(
_ id: String,
rootfs: Mount,
writableLayer: Mount? = nil,
vmm: VirtualMachineManager,
logger: Logger? = nil,
configuration: (inout Configuration) throws -> Void
) throws {
var config = Configuration()
try configuration(&config)
try self.init(
id,
rootfs: rootfs,
writableLayer: writableLayer,
vmm: vmm,
configuration: config,
logger: logger
)
}
/// Create a new `LinuxContainer`.
///
/// - Parameters:
/// - id: The identifier for the container.
/// - rootfs: The root filesystem mount containing the container image contents.
/// The `destination` field is ignored as mounting is handled internally.
/// - writableLayer: Optional writable layer mount. When provided, an overlayfs is used with
/// rootfs as the lower layer and this as the upper layer. Must be a block device.
/// The `destination` field is ignored as mounting is handled internally.
/// - vmm: The virtual machine manager that will handle launching the VM for the container.
/// - configuration: The container configuration specifying process, resources, networking, and other settings.
/// - logger: Optional logger for container operations.
public init(
_ id: String,
rootfs: Mount,
writableLayer: Mount? = nil,
vmm: VirtualMachineManager,
configuration: LinuxContainer.Configuration,
logger: Logger? = nil
) throws {
if let writableLayer {
guard writableLayer.isBlock else {
throw ContainerizationError(
.invalidArgument,
message: "writableLayer must be a block device"
)
}
}
self.id = id
self.vmm = vmm
self.hostVsockPorts = Atomic<UInt32>(0x1000_0000)
self.guestVsockPorts = Atomic<UInt32>(0x1000_0000)
self.logger = logger
self.config = configuration
self.state = AsyncMutex(.initialized)
self.rootfs = rootfs
self.writableLayer = writableLayer
}
private static func createDefaultRuntimeSpec(_ id: String) -> Spec {
.init(
process: .init(),
hostname: id,
root: .init(
path: Self.guestRootfsPath(id),
readonly: false
),
linux: .init(
resources: .init(),
cgroupsPath: "/container/\(id)"
)
)
}
private func generateRuntimeSpec() -> Spec {
var spec = Self.createDefaultRuntimeSpec(id)
// Process toggles.
spec.process = config.process.toOCI()
// Wrap with init process if requested.
if config.useInit {
let originalArgs = spec.process?.args ?? []
spec.process?.args = ["/.cz-init", "--"] + originalArgs
}
// General toggles.
if let hostname = config.hostname {
spec.hostname = hostname
}
// Linux toggles.
spec.linux?.sysctl = config.sysctl
// If the rootfs was requested as read-only, set it in the OCI spec.
// We let the OCI runtime remount as ro, instead of doing it originally.
// However, if we have a writable layer, the overlay allows writes so we don't mark it read-only.
spec.root?.readonly = self.rootfs.options.contains("ro") && self.writableLayer == nil
// Resource limits.
// CPU: quota/period model where period is 100ms (100,000µs) and quota is cpus * period
// Memory: limit in bytes
spec.linux?.resources = LinuxResources(
memory: LinuxMemory(
limit: Int64(config.memoryInBytes)
),
cpu: LinuxCPU(
quota: Int64(config.cpus * 100_000),
period: 100_000
)
)
spec.linux?.namespaces = [
LinuxNamespace(type: .cgroup),
LinuxNamespace(type: .ipc),
LinuxNamespace(type: .mount),
LinuxNamespace(type: .pid),
LinuxNamespace(type: .uts),
]
return spec
}
/// The default set of mounts for a LinuxContainer.
public static func defaultMounts() -> [Mount] {
let defaultOptions = ["nosuid", "noexec", "nodev"]
return [
.any(type: "proc", source: "proc", destination: "/proc"),
.any(type: "sysfs", source: "sysfs", destination: "/sys", options: defaultOptions),
.any(type: "devtmpfs", source: "none", destination: "/dev", options: ["nosuid", "mode=755"]),
.any(type: "mqueue", source: "mqueue", destination: "/dev/mqueue", options: defaultOptions),
.any(type: "tmpfs", source: "tmpfs", destination: "/dev/shm", options: defaultOptions + ["mode=1777", "size=65536k"]),
.any(type: "cgroup2", source: "none", destination: "/sys/fs/cgroup", options: defaultOptions),
.any(type: "devpts", source: "devpts", destination: "/dev/pts", options: ["nosuid", "noexec", "newinstance", "gid=5", "mode=0620", "ptmxmode=0666"]),
]
}
/// A more traditional default set of mounts that OCI runtimes typically employ.
public static func defaultOCIMounts() -> [Mount] {
let defaultOptions = ["nosuid", "noexec", "nodev"]
return [
.any(type: "proc", source: "proc", destination: "/proc"),
.any(type: "tmpfs", source: "tmpfs", destination: "/dev", options: ["nosuid", "mode=755", "size=65536k"]),
.any(type: "devpts", source: "devpts", destination: "/dev/pts", options: ["nosuid", "noexec", "newinstance", "gid=5", "mode=0620", "ptmxmode=0666"]),
.any(type: "sysfs", source: "sysfs", destination: "/sys", options: defaultOptions),
.any(type: "mqueue", source: "mqueue", destination: "/dev/mqueue", options: defaultOptions),
.any(type: "tmpfs", source: "tmpfs", destination: "/dev/shm", options: defaultOptions + ["mode=1777", "size=65536k"]),
.any(type: "cgroup2", source: "none", destination: "/sys/fs/cgroup", options: defaultOptions),
]
}
private static func guestRootfsPath(_ id: String) -> String {
"/run/container/\(id)/rootfs"
}
private static func guestSocketStagingPath(_ containerID: String, socketID: String) -> String {
"/run/container/\(containerID)/sockets/\(socketID).sock"
}
}
extension LinuxContainer {
package var root: String {
Self.guestRootfsPath(id)
}
/// Number of CPU cores allocated.
public var cpus: Int {
config.cpus
}
/// Amount of memory in bytes allocated for the container.
/// This will be aligned to a 1MB boundary if it isn't already.
public var memoryInBytes: UInt64 {
config.memoryInBytes
}
/// Network interfaces of the container.
public var interfaces: [any Interface] {
config.interfaces
}
private func mountRootfs(
attachments: [AttachedFilesystem],
rootfsPath: String,
agent: VirtualMachineAgent
) async throws {
guard let rootfsAttachment = attachments.first else {
throw ContainerizationError(.notFound, message: "rootfs mount not found")
}
if self.writableLayer != nil {
// Set up overlayfs with image as lower layer and writable layer as upper.
guard attachments.count >= 2 else {
throw ContainerizationError(
.notFound,
message: "writable layer mount not found"
)
}
let writableAttachment = attachments[1]
let lowerPath = "/run/container/\(self.id)/lower"
let upperMountPath = "/run/container/\(self.id)/upper"
let upperPath = "/run/container/\(self.id)/upper/diff"
let workPath = "/run/container/\(self.id)/upper/work"
// Mount the image (lower layer) as read-only.
var lowerMount = rootfsAttachment.to
lowerMount.destination = lowerPath
if !lowerMount.options.contains("ro") {
lowerMount.options.append("ro")
}
try await agent.mount(lowerMount)
// Mount the writable layer.
var upperMount = writableAttachment.to
upperMount.destination = upperMountPath
try await agent.mount(upperMount)
// Create the upper and work directories inside the writable layer.
try await agent.mkdir(path: upperPath, all: true, perms: 0o755)
try await agent.mkdir(path: workPath, all: true, perms: 0o755)
// Mount the overlay.
let overlayMount = ContainerizationOCI.Mount(
type: "overlay",
source: "overlay",
destination: rootfsPath,
options: [
"lowerdir=\(lowerPath)",
"upperdir=\(upperPath)",
"workdir=\(workPath)",
]
)
try await agent.mount(overlayMount)
} else {
// No writable layer. Mount rootfs directly.
var rootfs = rootfsAttachment.to
rootfs.destination = rootfsPath
try await agent.mount(rootfs)
}
}
/// Create and start the underlying container's virtual machine
/// and set up the runtime environment. The container's init process
/// is NOT running afterwards.
public func create() async throws {
try await self.state.withLock { state in
try state.validateForCreate()
// This is a bit of an annoyance, but because the type we use for the rootfs is simply
// the same Mount type we use for non-rootfs mounts, it's possible someone passed 'ro'
// in the options (which should be perfectly valid). However, the problem is when we go to
// setup /etc/hosts and /etc/resolv.conf, as we'd get EROFS if they did supply 'ro'.
// To remedy this, remove any "ro" options before passing to VZ. Having the OCI runtime
// remount "ro" (which is what we do later in the guest) is truthfully the right thing,
// but this bit here is just a tad awkward.
var modifiedRootfs = self.rootfs
modifiedRootfs.options.removeAll(where: { $0 == "ro" })
// Calculate VM memory with overhead for the guest agent.
// The container cgroup limit stays at the requested memory, but the VM
// gets an additional 50MB for the guest agent (could be higher, could be lower
// but this is a decent baseline for now).
//
// Clamp to system RAM if the total would exceed it as Virtualization.framework
// bounds us to this.
let guestAgentOverhead: UInt64 = 50.mib()
let vmMemory = min(
self.memoryInBytes + guestAgentOverhead,
ProcessInfo.processInfo.physicalMemory
)
// Prepare file mounts. This transforms single-file mounts into directory shares.
let fileMountContext = try FileMountContext.prepare(mounts: self.config.mounts)
// This is dumb, but alas.
let fileMountContextHolder = Mutex<FileMountContext>(fileMountContext)
// Build the list of mounts to attach to the VM.
var containerMounts = [modifiedRootfs] + fileMountContext.transformedMounts
if let writableLayer = self.writableLayer {
containerMounts.insert(writableLayer, at: 1)
}
let vmConfig = VMConfiguration(
cpus: self.cpus,
memoryInBytes: vmMemory,
interfaces: self.interfaces,
mountsByID: [self.id: containerMounts],
bootLog: self.config.bootLog,
nestedVirtualization: self.config.virtualization
)
let creationConfig = StandardVMConfig(configuration: vmConfig)
let vm = try await self.vmm.create(config: creationConfig)
let relayManager = UnixSocketRelayManager(vm: vm, log: self.logger)
try await vm.start()
do {
try await vm.withAgent { agent in
try await agent.standardSetup()
guard let attachments = vm.mounts[self.id] else {
throw ContainerizationError(.notFound, message: "rootfs mount not found")
}
let rootfsPath = Self.guestRootfsPath(self.id)
try await self.mountRootfs(attachments: attachments, rootfsPath: rootfsPath, agent: agent)
// Mount file mount holding directories under /run.
if fileMountContext.hasFileMounts {
let containerMounts = vm.mounts[self.id] ?? []
var ctx = fileMountContextHolder.withLock { $0 }
try await ctx.mountHoldingDirectories(
vmMounts: containerMounts,
agent: agent
)
fileMountContextHolder.withLock { $0 = ctx }
}
// Start up our friendly unix socket relays.
for socket in self.config.sockets {
try await self.relayUnixSocket(
socket: socket,
relayManager: relayManager,
agent: agent
)
}
// For every interface asked for:
// 1. Add the address requested
// 2. Online the adapter
// 3. If a gateway IP address is present, add the default route.
for (index, i) in self.interfaces.enumerated() {
let name = "eth\(index)"
self.logger?.debug("setting up interface \(name) with address \(i.ipv4Address)")
try await agent.addressAdd(name: name, ipv4Address: i.ipv4Address)
try await agent.up(name: name, mtu: i.mtu)
if let ipv4Gateway = i.ipv4Gateway {
if !i.ipv4Address.contains(ipv4Gateway) {
self.logger?.debug("gateway \(ipv4Gateway) is outside subnet \(i.ipv4Address), adding a route first")
try await agent.routeAddLink(name: name, dstIPv4Addr: ipv4Gateway, srcIPv4Addr: i.ipv4Address.address)
}
try await agent.routeAddDefault(name: name, ipv4Gateway: ipv4Gateway)
}
}
// Setup /etc/resolv.conf and /etc/hosts if asked for.
if let dns = self.config.dns {
try await agent.configureDNS(config: dns, location: rootfsPath)
}
if let hosts = self.config.hosts {
try await agent.configureHosts(config: hosts, location: rootfsPath)
}
}
state = .created(.init(vm: vm, relayManager: relayManager, fileMountContext: fileMountContextHolder.withLock { $0 }))
} catch {
try? await relayManager.stopAll()
try? await vm.stop()
state.setErrored(error: error)
throw error
}
}
}
/// Start the container's initial process.
public func start() async throws {
try await self.state.withLock { state in
let createdState = try state.createdState("start")
let agent = try await createdState.vm.dialAgent()
do {
var spec = self.generateRuntimeSpec()
// We don't need the rootfs (or writable layer), nor do OCI runtimes want it included.
// Also filter out file mount holding directories. We'll mount those separately under /run.
let containerMounts = createdState.vm.mounts[self.id] ?? []
let holdingTags = createdState.fileMountContext.holdingDirectoryTags
// Drop rootfs, and writable layer if present.
let mountsToSkip = self.writableLayer != nil ? 2 : 1
var mounts: [ContainerizationOCI.Mount] =
containerMounts.dropFirst(mountsToSkip)
.filter { !holdingTags.contains($0.source) }
.map { $0.to }
+ createdState.fileMountContext.ociBindMounts()
// When useInit is enabled, bind mount vminitd from the VM's filesystem
// into the container so it can be executed.
if self.config.useInit {
mounts.append(
ContainerizationOCI.Mount(
type: "bind",
source: "/sbin/vminitd",
destination: "/.cz-init",
options: ["bind", "ro"]
))
}
// Bind mount staged sockets into the container. Sockets relayed
// .into the container are created in a staging directory outside
// the rootfs to avoid symlink traversal and mount shadowing.
for socket in self.config.sockets where socket.direction == .into {
mounts.append(
ContainerizationOCI.Mount(
type: "bind",
source: Self.guestSocketStagingPath(self.id, socketID: socket.id),
destination: socket.destination.path,
options: ["bind"]
))
}
spec.mounts = mounts
let stdio = IOUtil.setup(
portAllocator: self.hostVsockPorts,
stdin: self.config.process.stdin,
stdout: self.config.process.stdout,
stderr: self.config.process.stderr
)
let process = LinuxProcess(
self.id,
containerID: self.id,
spec: spec,
io: stdio,
ociRuntimePath: self.config.ociRuntimePath,
agent: agent,
vm: createdState.vm,
logger: self.logger
)
try await process.start()
state = .started(.init(createdState, process: process))
} catch {
try? await agent.close()
try? await createdState.vm.stop()
state.setErrored(error: error)
throw error
}
}
}
private static func setupIO(
portAllocator: borrowing Atomic<UInt32>,
stdin: ReaderStream?,
stdout: Writer?,
stderr: Writer?
) -> LinuxProcess.Stdio {
var stdinSetup: LinuxProcess.StdioReaderSetup? = nil
if let reader = stdin {
let ret = portAllocator.wrappingAdd(1, ordering: .relaxed)
stdinSetup = .init(
port: ret.oldValue,
reader: reader
)
}
var stdoutSetup: LinuxProcess.StdioSetup? = nil
if let writer = stdout {
let ret = portAllocator.wrappingAdd(1, ordering: .relaxed)
stdoutSetup = LinuxProcess.StdioSetup(
port: ret.oldValue,
writer: writer
)
}
var stderrSetup: LinuxProcess.StdioSetup? = nil
if let writer = stderr {
let ret = portAllocator.wrappingAdd(1, ordering: .relaxed)
stderrSetup = LinuxProcess.StdioSetup(
port: ret.oldValue,
writer: writer
)
}
return LinuxProcess.Stdio(
stdin: stdinSetup,
stdout: stdoutSetup,
stderr: stderrSetup
)
}
/// Stop the container from executing. This MUST be called even if wait() has returned
/// as their are additional resources to free.
public func stop() async throws {
try await self.state.withLock { state in
// Allow stop to be called multiple times.
if case .stopped = state {
return
}
let vm: any VirtualMachineInstance
let relayManager: UnixSocketRelayManager
let fileMountContext: FileMountContext
let startedState = try? state.startedState("stop")
if let startedState {
vm = startedState.vm
relayManager = startedState.relayManager
fileMountContext = startedState.fileMountContext
} else {
let createdState = try state.createdState("stop")
vm = createdState.vm
relayManager = createdState.relayManager
fileMountContext = createdState.fileMountContext
}
var firstError: Error?
do {
try await relayManager.stopAll()
} catch {
self.logger?.error("failed to stop relay manager: \(error)")
firstError = firstError ?? error
}
do {
try await vm.withAgent { agent in
// First, we need to stop any unix socket relays as this will
// keep the rootfs from being able to umount (EBUSY).
let sockets = self.config.sockets
if !sockets.isEmpty {
guard let relayAgent = agent as? SocketRelayAgent else {
throw ContainerizationError(
.unsupported,
message: "VirtualMachineAgent does not support relaySocket surface"
)
}
for socket in sockets {
try await relayAgent.stopSocketRelay(configuration: socket)
}
}
if let _ = startedState {
// Now lets ensure every process is donezo.
try await agent.kill(pid: -1, signal: SIGKILL)
// Wait on init proc exit. Give it 5 seconds of leeway.
_ = try await agent.waitProcess(
id: self.id,
containerID: self.id,
timeoutInSeconds: 5
)
}
// Today, we leave EBUSY looping and other fun logic up to the
// guest agent.
try await agent.umount(
path: Self.guestRootfsPath(self.id),
flags: 0
)
// If we have a writable layer, we also need to unmount the lower and upper layers.
if self.writableLayer != nil {
let upperPath = "/run/container/\(self.id)/upper"
let lowerPath = "/run/container/\(self.id)/lower"
try await agent.umount(path: upperPath, flags: 0)
try await agent.umount(path: lowerPath, flags: 0)
}
try await agent.sync()
}
} catch {
self.logger?.error("failed during guest cleanup: \(error)")
firstError = firstError ?? error
}
if let startedState {
for process in startedState.vendedProcesses.values {
do {
try await process._delete()
} catch {
self.logger?.error("failed to delete process \(process.id): \(error)")
firstError = firstError ?? error
}
}
do {
try await startedState.process.delete()
} catch {
self.logger?.error("failed to delete init process: \(error)")
firstError = firstError ?? error
}
}
// Clean up file mount temporary directories.
fileMountContext.cleanUp()
do {
try await vm.stop()
state = .stopped
if let firstError {
throw firstError
}
} catch {
self.logger?.error("failed to stop VM: \(error)")
let finalError = firstError ?? error
state.setErrored(error: finalError)
throw finalError
}
}
}
/// Send a signal to the container.
public func kill(_ signal: Int32) async throws {
try await self.state.withLock {
let state = try $0.startedState("kill")
try await state.process.kill(signal)
}
}
/// Wait for the container to exit. Returns the exit code.
@discardableResult
public func wait(timeoutInSeconds: Int64? = nil) async throws -> ExitStatus {
let t = try await self.state.withLock {
let state = try $0.startedState("wait")
let t = Task {
try await state.process.wait(timeoutInSeconds: timeoutInSeconds)
}
return t
}
return try await t.value
}
/// Resize the container's terminal (if one was requested). This
/// will error if terminal was set to false before creating the container.
public func resize(to: Terminal.Size) async throws {
try await self.state.withLock {
let state = try $0.startedState("resize")
try await state.process.resize(to: to)
}
}
/// Execute a new process in the container. The process is not started after this call, and must be manually started
/// via the `start` method.
public func exec(_ id: String, configuration: @Sendable @escaping (inout LinuxProcessConfiguration) throws -> Void) async throws -> LinuxProcess {
try await self.state.withLock { state in
var startedState = try state.startedState("exec")
var spec = self.generateRuntimeSpec()
var config = LinuxProcessConfiguration()
try configuration(&config)
spec.process = config.toOCI()
let stdio = IOUtil.setup(
portAllocator: self.hostVsockPorts,
stdin: config.stdin,
stdout: config.stdout,
stderr: config.stderr
)
let agent = try await startedState.vm.dialAgent()
let process = LinuxProcess(
id,
containerID: self.id,
spec: spec,
io: stdio,
ociRuntimePath: self.config.ociRuntimePath,
agent: agent,
vm: startedState.vm,
logger: self.logger,
onDelete: { [weak self] in
await self?.removeProcess(id: id)
}
)
startedState.vendedProcesses[id] = process
state = .started(startedState)
return process
}
}
/// Execute a new process in the container. The process is not started after this call, and must be manually started
/// via the `start` method.
public func exec(_ id: String, configuration: LinuxProcessConfiguration) async throws -> LinuxProcess {
try await self.state.withLock {
var state = try $0.startedState("exec")
var spec = self.generateRuntimeSpec()
spec.process = configuration.toOCI()
let stdio = IOUtil.setup(
portAllocator: self.hostVsockPorts,
stdin: configuration.stdin,
stdout: configuration.stdout,
stderr: configuration.stderr
)
let agent = try await state.vm.dialAgent()
let process = LinuxProcess(
id,
containerID: self.id,
spec: spec,
io: stdio,
ociRuntimePath: self.config.ociRuntimePath,
agent: agent,
vm: state.vm,
logger: self.logger,
onDelete: { [weak self] in
await self?.removeProcess(id: id)
}
)
state.vendedProcesses[id] = process
$0 = .started(state)
return process
}
}
/// Dial a vsock port in the container.
public func dialVsock(port: UInt32) async throws -> FileHandle {
try await self.state.withLock {
let state = try $0.startedState("dialVsock")
return try await state.vm.dial(port)
}
}
/// Close the containers standard input to signal no more input is
/// arriving.
public func closeStdin() async throws {
try await self.state.withLock {
let state = try $0.startedState("closeStdin")
return try await state.process.closeStdin()
}
}
/// Remove a process from the vended processes tracking.
private func removeProcess(id: String) async {
await self.state.withLock {
guard case .started(var state) = $0 else {
return
}
state.vendedProcesses.removeValue(forKey: id)
$0 = .started(state)
}
}
/// Get statistics for the container.
public func statistics(categories: StatCategory = .all) async throws -> ContainerStatistics {
try await self.state.withLock {
let state = try $0.startedState("statistics")
let stats = try await state.vm.withAgent { agent in
let allStats = try await agent.containerStatistics(containerIDs: [self.id], categories: categories)
guard let containerStats = allStats.first else {
throw ContainerizationError(
.notFound,
message: "statistics for container \(self.id) not found"
)
}
return containerStats
}
return stats
}
}
private func relayUnixSocket(
socket: UnixSocketConfiguration,
relayManager: UnixSocketRelayManager,
agent: any VirtualMachineAgent
) async throws {
guard let relayAgent = agent as? SocketRelayAgent else {
throw ContainerizationError(
.unsupported,
message: "VirtualMachineAgent does not support relaySocket surface"
)
}
var socket = socket
let rootInGuest = URL(filePath: self.root)
let port: UInt32
if socket.direction == .into {
port = self.hostVsockPorts.wrappingAdd(1, ordering: .relaxed).oldValue
socket.destination = URL(filePath: Self.guestSocketStagingPath(self.id, socketID: socket.id))
} else {
port = self.guestVsockPorts.wrappingAdd(1, ordering: .relaxed).oldValue
socket.source = rootInGuest.appending(path: socket.source.path)
}
try await relayManager.start(port: port, socket: socket)
try await relayAgent.relaySocket(port: port, configuration: socket)
}
/// Default chunk size for file transfers (1MiB).
public static let defaultCopyChunkSize = 1024 * 1024
/// Copy a file or directory from the host into the container.
///
/// Data transfer happens over a dedicated vsock connection. For directories,
/// the source is archived as tar+gzip and streamed directly through vsock
/// without intermediate temp files.
public func copyIn(
from source: URL,
to destination: URL,
mode: UInt32 = 0o644,
createParents: Bool = true,
chunkSize: Int = defaultCopyChunkSize
) async throws {
try await self.state.withLock {
let state = try $0.startedState("copyIn")
var isDirectory: ObjCBool = false
guard FileManager.default.fileExists(atPath: source.path, isDirectory: &isDirectory) else {
throw ContainerizationError(.notFound, message: "copyIn: source not found '\(source.path)'")
}
let isArchive = isDirectory.boolValue
let guestPath = URL(filePath: self.root).appending(path: destination.path)
let port = self.hostVsockPorts.wrappingAdd(1, ordering: .relaxed).oldValue
let listener = try state.vm.listen(port)
try await withThrowingTaskGroup(of: Void.self) { group in
group.addTask {
try await state.vm.withAgent { agent in
guard let vminitd = agent as? Vminitd else {
throw ContainerizationError(.unsupported, message: "copyIn requires Vminitd agent")
}
try await vminitd.copy(
direction: .copyIn,
guestPath: guestPath,
vsockPort: port,
mode: mode,
createParents: createParents,
isArchive: isArchive
)
}
}
group.addTask {
guard let conn = await listener.first(where: { _ in true }) else {
throw ContainerizationError(.internalError, message: "copyIn: vsock connection not established")
}
try listener.finish()
try await withCheckedThrowingContinuation { (continuation: CheckedContinuation<Void, any Error>) in
self.copyQueue.async {
do {
defer { conn.closeFile() }
if isArchive {
let writer = try ArchiveWriter(configuration: .init(format: .pax, filter: .gzip))
try writer.open(fileDescriptor: conn.fileDescriptor)
try writer.archiveDirectory(source)
try writer.finishEncoding()
} else {
let srcFd = open(source.path, O_RDONLY)
guard srcFd != -1 else {
throw ContainerizationError(
.internalError,
message: "copyIn: failed to open '\(source.path)': \(String(cString: strerror(errno)))"
)
}
defer { close(srcFd) }
var buf = [UInt8](repeating: 0, count: chunkSize)
while true {
let n = read(srcFd, &buf, buf.count)
if n == 0 { break }
guard n > 0 else {
throw ContainerizationError(
.internalError,
message: "copyIn: read error: \(String(cString: strerror(errno)))"
)
}
var written = 0
while written < n {
let w = buf.withUnsafeBytes { ptr in
write(conn.fileDescriptor, ptr.baseAddress! + written, n - written)
}
guard w > 0 else {
throw ContainerizationError(
.internalError,
message: "copyIn: vsock write error: \(String(cString: strerror(errno)))"
)
}
written += w
}
}
}
continuation.resume()
} catch {
continuation.resume(throwing: error)
}
}
}
}
try await group.waitForAll()
}
}
}
/// Copy a file or directory from the container to the host.
///
/// Data transfer happens over a dedicated vsock connection. For directories,
/// the guest archives the source as tar+gzip and streams it directly through
/// vsock. The host extracts the archive without intermediate temp files.
public func copyOut(
from source: URL,
to destination: URL,
createParents: Bool = true,
chunkSize: Int = defaultCopyChunkSize
) async throws {
try await self.state.withLock {
let state = try $0.startedState("copyOut")
if createParents {
let parentDir = destination.deletingLastPathComponent()
try FileManager.default.createDirectory(at: parentDir, withIntermediateDirectories: true)
}
let guestPath = URL(filePath: self.root).appending(path: source.path)
let port = self.hostVsockPorts.wrappingAdd(1, ordering: .relaxed).oldValue
let listener = try state.vm.listen(port)
let (metadataStream, metadataCont) = AsyncStream.makeStream(of: Vminitd.CopyMetadata.self)
try await withThrowingTaskGroup(of: Void.self) { group in
group.addTask {
try await state.vm.withAgent { agent in
guard let vminitd = agent as? Vminitd else {
throw ContainerizationError(.unsupported, message: "copyOut requires Vminitd agent")
}
try await vminitd.copy(
direction: .copyOut,
guestPath: guestPath,
vsockPort: port,
onMetadata: { meta in
metadataCont.yield(meta)
metadataCont.finish()
}
)
}
}
group.addTask {
guard let metadata = await metadataStream.first(where: { _ in true }) else {
throw ContainerizationError(.internalError, message: "copyOut: no metadata received")
}
guard let conn = await listener.first(where: { _ in true }) else {
throw ContainerizationError(.internalError, message: "copyOut: vsock connection not established")
}
try listener.finish()
try await withCheckedThrowingContinuation { (continuation: CheckedContinuation<Void, any Error>) in
self.copyQueue.async {
do {
defer { conn.closeFile() }
if metadata.isArchive {
try FileManager.default.createDirectory(at: destination, withIntermediateDirectories: true)
let fh = FileHandle(fileDescriptor: dup(conn.fileDescriptor), closeOnDealloc: true)
let reader = try ArchiveReader(format: .pax, filter: .gzip, fileHandle: fh)
_ = try reader.extractContents(to: destination)
} else {
let destFd = open(destination.path, O_WRONLY | O_CREAT | O_TRUNC, 0o644)
guard destFd != -1 else {
throw ContainerizationError(
.internalError,
message: "copyOut: failed to open '\(destination.path)': \(String(cString: strerror(errno)))"
)
}
defer { close(destFd) }
var buf = [UInt8](repeating: 0, count: chunkSize)
while true {
let n = read(conn.fileDescriptor, &buf, buf.count)
if n == 0 { break }
guard n > 0 else {
throw ContainerizationError(
.internalError,
message: "copyOut: vsock read error: \(String(cString: strerror(errno)))"
)
}
var written = 0
while written < n {
let w = buf.withUnsafeBytes { ptr in
write(destFd, ptr.baseAddress! + written, n - written)
}
guard w > 0 else {
throw ContainerizationError(
.internalError,
message: "copyOut: write error: \(String(cString: strerror(errno)))"
)
}
written += w
}
}
}
continuation.resume()
} catch {
continuation.resume(throwing: error)
}
}
}
}
try await group.waitForAll()
}
}
}
}
extension VirtualMachineInstance {
/// Scoped access to an agent instance to ensure the resources are always freed (mostly close(2)'ing
/// the vsock fd)
func withAgent<T>(fn: @Sendable (VirtualMachineAgent) async throws -> T) async throws -> T {
let agent = try await self.dialAgent()
do {
let result = try await fn(agent)
try await agent.close()
return result
} catch {
try? await agent.close()
throw error
}
}
}
extension AttachedFilesystem {
var to: ContainerizationOCI.Mount {
.init(
type: self.type,
source: self.source,
destination: self.destination,
options: self.options
)
}
}
struct IOUtil {
static func setup(
portAllocator: borrowing Atomic<UInt32>,
stdin: ReaderStream?,
stdout: Writer?,
stderr: Writer?
) -> LinuxProcess.Stdio {
var stdinSetup: LinuxProcess.StdioReaderSetup? = nil
if let reader = stdin {
let ret = portAllocator.wrappingAdd(1, ordering: .relaxed)
stdinSetup = .init(
port: ret.oldValue,
reader: reader
)
}
var stdoutSetup: LinuxProcess.StdioSetup? = nil
if let writer = stdout {
let ret = portAllocator.wrappingAdd(1, ordering: .relaxed)
stdoutSetup = LinuxProcess.StdioSetup(
port: ret.oldValue,
writer: writer
)
}
var stderrSetup: LinuxProcess.StdioSetup? = nil
if let writer = stderr {
let ret = portAllocator.wrappingAdd(1, ordering: .relaxed)
stderrSetup = LinuxProcess.StdioSetup(
port: ret.oldValue,
writer: writer
)
}
return LinuxProcess.Stdio(
stdin: stdinSetup,
stdout: stdoutSetup,
stderr: stderrSetup
)
}
}
#endif