Files
container/Sources/Containerization/NATNetworkInterface.swift
T
Danny Canter 6bc4bf5124 Source code documentation updates (#9)
This change adds documentation to quite a few existing public types that
didn't have a blurb before.

Additionally, this fixes a couple things that I think either didn't make
sense when going to document them:
- Rename ConnectionStream to VsockConnectionStream. This type only
functions for vsock connections.
- Deletes NsLock+Closure. This was not used anywhere.
- Rename ContainerizationOCI/Config.swift to ImageConfig.swift.

Signed-off-by: Danny Canter <danny_canter@apple.com>
2025-06-05 16:16:18 -07:00

115 lines
3.3 KiB
Swift

//===----------------------------------------------------------------------===//
// Copyright © 2025 Apple Inc. and the containerization project authors. All rights reserved.
//
// 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 vmnet
import Virtualization
import ContainerizationError
import Foundation
import Synchronization
/// An interface that uses NAT to provide an IP address for a given
/// container/virtual machine.
@available(macOS 16, *)
public final class NATNetworkInterface: Interface, Sendable {
public var address: String {
get { state.withLock { $0.address } }
set { state.withLock { $0.address = newValue } }
}
public var gateway: String {
get { state.withLock { $0.gateway } }
set { state.withLock { $0.gateway = newValue } }
}
public var macAddress: String? {
get { state.withLock { $0.macAddress } }
set { state.withLock { $0.macAddress = newValue } }
}
struct State {
var address: String
var gateway: String
var macAddress: String?
#if !CURRENT_SDK
var reference: vmnet_network_ref
#endif
}
#if !CURRENT_SDK
public var reference: vmnet_network_ref {
state.withLock { $0.reference }
}
#endif
private let state: Mutex<State>
#if !CURRENT_SDK
public init(
address: String,
gateway: String,
reference: sending vmnet_network_ref,
macAddress: String? = nil
) {
self.state = .init(
.init(
address: address,
gateway: gateway,
macAddress: macAddress,
reference: reference
)
)
}
#else
public init(
address: String,
gateway: String,
macAddress: String? = nil
) {
self.state = .init(
.init(
address: address,
gateway: gateway,
macAddress: macAddress
)
)
}
#endif
}
@available(macOS 16, *)
extension NATNetworkInterface: VZInterface {
public func device() throws -> VZVirtioNetworkDeviceConfiguration {
let config = VZVirtioNetworkDeviceConfiguration()
if let macAddress = self.macAddress {
guard let mac = VZMACAddress(string: macAddress) else {
throw ContainerizationError(.invalidArgument, message: "invalid mac address \(macAddress)")
}
config.macAddress = mac
}
#if !CURRENT_SDK
config.attachment = VZVmnetNetworkDeviceAttachment(network: self.reference)
#else
config.attachment = VZNATNetworkDeviceAttachment()
#endif
return config
}
}
#endif