-
Notifications
You must be signed in to change notification settings - Fork 275
Support running native process outside sandbox #724
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
JaewonHur
wants to merge
2
commits into
apple:main
Choose a base branch
from
JaewonHur:native-process
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| //===----------------------------------------------------------------------===// | ||
| // Copyright © 2026 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. | ||
| //===----------------------------------------------------------------------===// | ||
|
|
||
| public struct CreateProcessOptions: Sendable, Codable { | ||
| /// The process is created outside containerized env. | ||
| public var native: Bool | ||
|
|
||
| enum CodingKeys: String, CodingKey { | ||
| case native | ||
| } | ||
|
|
||
| public init(native: Bool) { | ||
| self.native = native | ||
| } | ||
|
|
||
| public init(from decoder: Decoder) throws { | ||
| let container = try decoder.container(keyedBy: CodingKeys.self) | ||
|
|
||
| native = try container.decodeIfPresent(Bool.self, forKey: .native) ?? false | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,206 @@ | ||
| //===----------------------------------------------------------------------===// | ||
| // Copyright © 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 ContainerizationOCI | ||
| import ContainerizationOS | ||
| import Foundation | ||
| import Logging | ||
| import Synchronization | ||
| import SystemPackage | ||
|
|
||
| final class NativeProcess: ContainerProcess, Sendable { | ||
| private struct State { | ||
| init(io: ManagedProcess.IO) { | ||
| self.io = io | ||
| } | ||
|
|
||
| var waiters: [CheckedContinuation<ContainerExitStatus, Never>] = [] | ||
| var exitStatus: ContainerExitStatus? = nil | ||
| var pid: Int32? | ||
| let io: ManagedProcess.IO | ||
| } | ||
|
|
||
| let id: String | ||
|
|
||
| private let log: Logger | ||
| private let command: Command | ||
| private let state: Mutex<State> | ||
|
|
||
| var pid: Int32? { | ||
| self.state.withLock { | ||
| $0.pid | ||
| } | ||
| } | ||
|
|
||
| init( | ||
| id: String, | ||
| stdio: HostStdio, | ||
| process: ContainerizationOCI.Process, | ||
| log: Logger | ||
| ) throws { | ||
| self.id = id | ||
| var log = log | ||
| log[metadataKey: "id"] = "\(id)" | ||
| self.log = log | ||
|
|
||
| guard !process.args.isEmpty else { | ||
| throw ContainerizationError(.invalidArgument, message: "process args cannot be empty") | ||
| } | ||
|
|
||
| let executableArg = process.args[0] | ||
| guard executableArg.hasPrefix("/") else { | ||
| throw ContainerizationError(.invalidArgument, message: "executable path must be absolute path") | ||
| } | ||
|
|
||
| let executable = FilePath(executableArg) | ||
| guard FileManager.default.fileExists(atPath: executable.string) else { | ||
| throw ContainerizationError(.invalidArgument, message: "failed to find target executable \(executableArg)") | ||
| } | ||
|
|
||
| var command = Command( | ||
| executable.string, | ||
| arguments: Array(process.args.dropFirst()), | ||
| environment: process.env, | ||
| directory: process.cwd | ||
| ) | ||
|
|
||
| guard !stdio.terminal else { | ||
| throw ContainerizationError(.invalidArgument, message: "native process doesn't support terminal") | ||
| } | ||
|
|
||
| command.attrs = .init(setsid: false) | ||
| let io = StandardIO( | ||
| stdio: stdio, | ||
| log: log | ||
| ) | ||
|
|
||
| log.info("starting I/O") | ||
|
|
||
| // Setup IO early. We expect the host to be listening already. | ||
| try io.start(process: &command) | ||
|
|
||
| self.command = command | ||
| self.state = Mutex(State(io: io)) | ||
| } | ||
|
|
||
| func start() async throws -> Int32 { | ||
| do { | ||
| return try self.state.withLock { | ||
| log.info( | ||
| "starting native process", | ||
| metadata: ["id": "\(id)"] | ||
| ) | ||
|
|
||
| try command.start() | ||
| try $0.io.closeAfterExec() | ||
|
|
||
| let pid = command.pid | ||
| $0.pid = pid | ||
|
|
||
| log.info( | ||
| "started native process", | ||
| metadata: [ | ||
| "pid": "\(pid)", | ||
| "id": "\(id)", | ||
| ] | ||
| ) | ||
|
|
||
| return pid | ||
| } | ||
| } catch { | ||
| throw ContainerizationError( | ||
| .internalError, | ||
| message: "native process failed to start: \(error)" | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| func setExit(_ status: Int32) { | ||
| self.state.withLock { state in | ||
| self.log.info( | ||
| "native process exit", | ||
| metadata: [ | ||
| "status": "\(status)" | ||
| ] | ||
| ) | ||
|
|
||
| let exitStatus = ContainerExitStatus(exitCode: status, exitedAt: Date.now) | ||
| state.exitStatus = exitStatus | ||
|
|
||
| do { | ||
| try state.io.close() | ||
| } catch { | ||
| self.log.error("failed to close I/O for process: \(error)") | ||
| } | ||
|
|
||
| for waiter in state.waiters { | ||
| waiter.resume(returning: exitStatus) | ||
| } | ||
|
|
||
| self.log.debug("\(state.waiters.count) native process waiters signaled") | ||
| state.waiters.removeAll() | ||
| } | ||
| } | ||
|
|
||
| func wait() async -> ContainerExitStatus { | ||
| await withCheckedContinuation { cont in | ||
| self.state.withLock { | ||
| if let status = $0.exitStatus { | ||
| cont.resume(returning: status) | ||
| return | ||
| } | ||
| $0.waiters.append(cont) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func kill(_ signal: Int32) async throws { | ||
| try self.state.withLock { | ||
| guard let pid = $0.pid else { | ||
| throw ContainerizationError(.invalidState, message: "process PID is required") | ||
| } | ||
|
|
||
| guard $0.exitStatus == nil else { | ||
| return | ||
| } | ||
|
|
||
| self.log.info("sending signal \(signal) to native process \(pid)") | ||
| guard Foundation.kill(pid, signal) == 0 else { | ||
| throw POSIXError.fromErrno() | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func resize(size: Terminal.Size) throws { | ||
| try self.state.withLock { | ||
| guard $0.exitStatus == nil else { | ||
| return | ||
| } | ||
| try $0.io.resize(size: size) | ||
| } | ||
| } | ||
|
|
||
| func closeStdin() throws { | ||
| let io = self.state.withLock { $0.io } | ||
| try io.closeStdin() | ||
| } | ||
|
|
||
| func delete() async throws { | ||
| // Nothing to be done | ||
| } | ||
|
|
||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The createProcess API takes in an optional containerID. This is what I was going to use to signify that we'd want to run a process in the root of the VM. e.g. supplying a nil containerID.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd prefer we don't introduce new public API like this without really thinking through it
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh I forgot. Yeah let me update.
Do you think
NativeProcessshould live outside ofManagedContainer?This will need reimplementing bookkeeping structure and management logic for
NativeProcess.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Whatever you think is right. If it feels too much hassle let me know