mirror of
https://github.com/apple/container.git
synced 2026-07-12 20:47:04 +00:00
24f6b747f1
This PR reaps already running containers with auto remove flag on container system start. Container API server shutdown ideally should stop every running container, and reap the containers with auto remove flag. However, crash or unexpected exit of API server leaves the containers running. In such case, next system start should stop running containers (i.e., launchd services) and reap the containers with auto remove flag. ## Type of Change - [X] Bug fix - [ ] New feature - [ ] Breaking change - [ ] Documentation update ## Motivation and Context Preserve the system to be in a consistent state after unexpected failure. ## Testing - [X] Tested locally - [ ] Added/updated tests - [ ] Added/updated docs --------- Co-authored-by: Raj <realrajaryan@gmail.com>
138 lines
5.7 KiB
Swift
138 lines
5.7 KiB
Swift
//===----------------------------------------------------------------------===//
|
|
// Copyright © 2025-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.
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
import ContainerizationError
|
|
import Foundation
|
|
|
|
public struct ServiceManager {
|
|
private static func runLaunchctlCommand(args: [String]) throws -> Int32 {
|
|
let launchctl = Foundation.Process()
|
|
launchctl.executableURL = URL(fileURLWithPath: "/bin/launchctl")
|
|
launchctl.arguments = args
|
|
|
|
let null = FileHandle.nullDevice
|
|
launchctl.standardOutput = null
|
|
launchctl.standardError = null
|
|
|
|
try launchctl.run()
|
|
launchctl.waitUntilExit()
|
|
|
|
return launchctl.terminationStatus
|
|
}
|
|
|
|
/// Register a service by providing the path to a plist.
|
|
public static func register(plistPath: String) throws {
|
|
let domain = try Self.getDomainString()
|
|
_ = try runLaunchctlCommand(args: ["bootstrap", domain, plistPath])
|
|
}
|
|
|
|
/// Deregister a service by a launchd label.
|
|
public static func deregister(fullServiceLabel label: String) throws {
|
|
_ = try runLaunchctlCommand(args: ["bootout", label])
|
|
}
|
|
|
|
/// Deregister a service and pass return status
|
|
public static func deregister(fullServiceLabel label: String, status: inout Int32) throws {
|
|
status = try runLaunchctlCommand(args: ["bootout", label])
|
|
}
|
|
|
|
/// Restart a service by a launchd label.
|
|
public static func kickstart(fullServiceLabel label: String) throws {
|
|
_ = try runLaunchctlCommand(args: ["kickstart", "-k", label])
|
|
}
|
|
|
|
/// Send a signal to a service by a launchd label.
|
|
public static func kill(fullServiceLabel label: String, signal: Int32 = 15) throws {
|
|
_ = try runLaunchctlCommand(args: ["kill", "\(signal)", label])
|
|
}
|
|
|
|
/// Retrieve labels for all loaded launch units.
|
|
public static func enumerate() throws -> [String] {
|
|
let launchctl = Foundation.Process()
|
|
launchctl.executableURL = URL(fileURLWithPath: "/bin/launchctl")
|
|
launchctl.arguments = ["list"]
|
|
|
|
let stdoutPipe = Pipe()
|
|
let stderrPipe = Pipe()
|
|
launchctl.standardOutput = stdoutPipe
|
|
launchctl.standardError = stderrPipe
|
|
|
|
try launchctl.run()
|
|
let outputData = stdoutPipe.fileHandleForReading.readDataToEndOfFile()
|
|
let stderrData = stderrPipe.fileHandleForReading.readDataToEndOfFile()
|
|
launchctl.waitUntilExit()
|
|
let status = launchctl.terminationStatus
|
|
guard status == 0 else {
|
|
throw ContainerizationError(
|
|
.internalError, message: "command `launchctl list` failed with status \(status), message: \(String(data: stderrData, encoding: .utf8) ?? "no error message")")
|
|
}
|
|
|
|
guard let outputText = String(data: outputData, encoding: .utf8) else {
|
|
throw ContainerizationError(
|
|
.internalError, message: "could not decode output of command `launchctl list`, message: \(String(data: stderrData, encoding: .utf8) ?? "no error message")")
|
|
}
|
|
|
|
// The third field of each line of launchctl list output is the label
|
|
return outputText.split { $0.isNewline }
|
|
.map { String($0).split { $0.isWhitespace } }
|
|
.filter { $0.count >= 3 }
|
|
.map { String($0[2]) }
|
|
}
|
|
|
|
/// Check if a service has been registered or not.
|
|
public static func isRegistered(fullServiceLabel label: String) throws -> Bool {
|
|
let exitStatus = try runLaunchctlCommand(args: ["list", label])
|
|
return exitStatus == 0
|
|
}
|
|
|
|
private static func getLaunchdSessionType() throws -> String {
|
|
let launchctl = Foundation.Process()
|
|
launchctl.executableURL = URL(fileURLWithPath: "/bin/launchctl")
|
|
launchctl.arguments = ["managername"]
|
|
|
|
let null = FileHandle.nullDevice
|
|
let stdoutPipe = Pipe()
|
|
launchctl.standardOutput = stdoutPipe
|
|
launchctl.standardError = null
|
|
|
|
try launchctl.run()
|
|
let outputData = stdoutPipe.fileHandleForReading.readDataToEndOfFile()
|
|
launchctl.waitUntilExit()
|
|
let status = launchctl.terminationStatus
|
|
guard status == 0 else {
|
|
throw ContainerizationError(.internalError, message: "command `launchctl managername` failed with status \(status)")
|
|
}
|
|
guard let outputText = String(data: outputData, encoding: .utf8) else {
|
|
throw ContainerizationError(.internalError, message: "could not decode output of command `launchctl managername`")
|
|
}
|
|
return outputText.trimmingCharacters(in: .whitespacesAndNewlines)
|
|
}
|
|
|
|
public static func getDomainString() throws -> String {
|
|
let currentSessionType = try getLaunchdSessionType()
|
|
switch currentSessionType {
|
|
case LaunchPlist.Domain.System.rawValue:
|
|
return LaunchPlist.Domain.System.rawValue.lowercased()
|
|
case LaunchPlist.Domain.Background.rawValue:
|
|
return "user/\(getuid())"
|
|
case LaunchPlist.Domain.Aqua.rawValue:
|
|
return "gui/\(getuid())"
|
|
default:
|
|
throw ContainerizationError(.internalError, message: "unsupported session type \(currentSessionType)")
|
|
}
|
|
}
|
|
}
|