Run a virtual iPhone on an Apple Silicon Mac.
Swift
Shut the guest down before a quit turns the VM off
Jacky9cefcbdf1ee6
diff --git a/Documents/Guides/create-and-run.md b/Documents/Guides/create-and-run.mdindex 3d8e2b84..f27d1001 100644--- a/Documents/Guides/create-and-run.md+++ b/Documents/Guides/create-and-run.md@@ -28,6 +28,8 @@ vphone-cli vm launch myphone # start the VM window and keep it runningvphone-cli vm stop myphone # run from another terminal to stop it```+Closing the VM window, ⌘Q, `vm stop` and Control-C in the `vm launch` terminal all shut the guest down first (vphoned `system.shutdown`) and end the virtual machine once the guest has stopped, or after 15 seconds if it has not. A guest vphoned cannot answer for, such as one in DFU or still starting up, is turned off at once, as pulling the power would. A second Control-C turns it off without waiting.+`vm launch` starts the guest without waiting for vphoned; the daemon connects during boot. The VM window and menu provide Home/power keys, app installation and file browsing. The host control socket is `<VM bundle>/vphone.sock`: one JSON line in, one out. Connections are served concurrently, and the socket also exists with `--no-graphics`, where `tap` and `swipe` go through vphoned's touch injection and screen images come from the guest. Besides `tap`, `swipe`, `key` and `screenshot`, `{"t":"rpc","method":"<vphoned method>","params":{…}}` calls any method in `Research/vphoned_http_api.md`. For example, `input.key` with `{"name":"cmd+v"}` pastes and `input.type` types text. No SSH or VNC endpoint is installed by this workflow.## Manual stagesdiff --git a/VPhoneExecutable/VPhoneVirtualization/Resources/Localizable.xcstrings b/VPhoneExecutable/VPhoneVirtualization/Resources/Localizable.xcstringsindex be882f69..fa8a4761 100644--- a/VPhoneExecutable/VPhoneVirtualization/Resources/Localizable.xcstrings+++ b/VPhoneExecutable/VPhoneVirtualization/Resources/Localizable.xcstrings@@ -312,6 +312,41 @@}}},+ "The guest shuts down, then the virtual machine stops. A guest still running after 15 seconds is turned off, as pulling the power would." : {+ "extractionState" : "manual",+ "localizations" : {+ "en" : {+ "stringUnit" : {+ "state" : "translated",+ "value" : "The guest shuts down, then the virtual machine stops. A guest still running after 15 seconds is turned off, as pulling the power would."+ }+ },+ "ja" : {+ "stringUnit" : {+ "state" : "translated",+ "value" : "ゲストをシステム終了してから仮想マシンを停止します。15 秒たってもゲストが動作している場合は、電源を抜いたときのようにオフになります。"+ }+ },+ "ko" : {+ "stringUnit" : {+ "state" : "translated",+ "value" : "게스트를 종료한 다음 가상 머신을 중지합니다. 15초가 지나도 게스트가 실행 중이면 전원을 뽑은 것처럼 꺼집니다."+ }+ },+ "vi" : {+ "stringUnit" : {+ "state" : "translated",+ "value" : "Máy khách sẽ tắt máy, sau đó máy ảo dừng. Nếu sau 15 giây máy khách vẫn chạy, nó sẽ bị tắt như khi rút nguồn."+ }+ },+ "zh-Hans" : {+ "stringUnit" : {+ "state" : "translated",+ "value" : "客户机先关机,然后虚拟机停止。如果 15 秒后客户机仍在运行,将如同拔掉电源一样关闭它。"+ }+ }+ }+ },"The virtual machine stopped and the keyboard setting was saved. Launch this machine again. Unable to restart: %@" : {"extractionState" : "manual","localizations" : {diff --git a/VPhoneExecutable/VPhoneVirtualization/UI/VPhoneVirtualMachineAppDelegate.swift b/VPhoneExecutable/VPhoneVirtualization/UI/VPhoneVirtualMachineAppDelegate.swiftindex 580aef26..7b33a2de 100644--- a/VPhoneExecutable/VPhoneVirtualization/UI/VPhoneVirtualMachineAppDelegate.swift+++ b/VPhoneExecutable/VPhoneVirtualization/UI/VPhoneVirtualMachineAppDelegate.swift@@ -26,6 +26,13 @@ class VPhoneVirtualMachineAppDelegate: NSObject, NSApplicationDelegate {/// from `vm stop` or Launchpad, which must not wait for an answer.private var stopConfirmed = falseprivate var isConfirmingStop = false+ /// The guest was asked to shut down and the process waits for it to stop.+ private var isShuttingDownGuest = false+ /// The next quit ends the process, and the virtual machine with it.+ private var powersOffOnQuit = false+ /// How long a quit waits for the guest to shut down before turning it+ /// off. `vm stop` sends SIGKILL after 20 s by default, so it stays below.+ private static let guestShutdownTimeout: Duration = .seconds(15)init(command: VPhoneBootCommand) {self.command = command@@ -51,7 +58,7 @@ class VPhoneVirtualMachineAppDelegate: NSObject, NSApplicationDelegate {self?.stopConfirmed = trueif self?.isConfirmingStop == true {// A quit is waiting on the question; this answers it.- NSApp.reply(toApplicationShouldTerminate: true)+ self?.answerStopQuestion()} else {NSApp.terminate(nil)}@@ -490,25 +497,89 @@ class VPhoneVirtualMachineAppDelegate: NSObject, NSApplicationDelegate {stopControlServices()}- /// Quitting turns the guest off at once, so a quit from the window or ⌘Q- /// asks first while the VM runs. A SIGINT stop, a headless VM and a VM- /// that never started quit straight away.+ /// Quitting shuts the guest down first and turns the virtual machine off+ /// once it has, or when it has not within `guestShutdownTimeout`. A guest+ /// that cannot be asked (in DFU, still starting up, or a vphoned without+ /// `system.shutdown`) is turned off at once. A quit from the window or ⌘Q+ /// asks first while the VM runs; a SIGINT stop and a headless VM do not.+ /// A second SIGINT while the guest shuts down, as a second Control-C,+ /// turns it off without waiting.func applicationShouldTerminate(_: NSApplication) -> NSApplication.TerminateReply {- guard !command.noGraphics, !stopConfirmed, vm != nil else { return .terminateNow }+ guard !powersOffOnQuit, vm != nil else { return .terminateNow }+ if isShuttingDownGuest {+ return stopConfirmed ? .terminateNow : .terminateCancel+ }+ guard !command.noGraphics, !stopConfirmed else { return stopGuest() }guard !isConfirmingStop else { return .terminateCancel }isConfirmingStop = trueVPhoneAlert.present(title: "Stop the Virtual Machine?",- message: "Quitting turns the guest off at once, as pulling the power would. Anything not saved in the guest is lost.",+ message: canShutDownGuest+ ? "The guest shuts down, then the virtual machine stops. A guest still running after 15 seconds is turned off, as pulling the power would."+ : "Quitting turns the guest off at once, as pulling the power would. Anything not saved in the guest is lost.",style: .warning,buttons: ["Stop", "Cancel"],) { [weak self] response in- self?.isConfirmingStop = false- NSApp.reply(toApplicationShouldTerminate: response == .alertFirstButtonReturn)+ // A SIGINT that came while the question was up has answered it.+ guard let self, isConfirmingStop else { return }+ isConfirmingStop = false+ guard response == .alertFirstButtonReturn else {+ NSApp.reply(toApplicationShouldTerminate: false)+ return+ }+ NSApp.reply(toApplicationShouldTerminate: stopGuest() == .terminateNow)}return .terminateLater}+ /// Answers a quit waiting on the stop question, as a SIGINT does.+ @MainActor+ private func answerStopQuestion() {+ isConfirmingStop = false+ if let window = VPhoneAlert.hostWindow, let sheet = window.attachedSheet {+ window.endSheet(sheet)+ }+ NSApp.reply(toApplicationShouldTerminate: stopGuest() == .terminateNow)+ }++ @MainActor+ private var canShutDownGuest: Bool {+ guard !command.dfu, let control else { return false }+ return control.isConnected && control.guestCapabilities.contains("system_shutdown")+ }++ /// Asks the guest to shut down and cancels the quit, or turns the guest off+ /// now when it cannot be asked. `guestDidStop` exits the process once the+ /// guest has stopped.+ @MainActor+ private func stopGuest() -> NSApplication.TerminateReply {+ guard canShutDownGuest, let control else { return .terminateNow }+ isShuttingDownGuest = true+ print("[vphone] Asking the guest to shut down")+ Task { @MainActor [weak self] in+ do {+ try await control.shutDownGuest()+ } catch let VPhoneGuestControl.ControlError.guestError(message) {+ print("[vphone] Guest refused to shut down: \(message); turning it off")+ self?.powerOff()+ } catch {+ // The guest can stop before it replies, so the connection drops.+ }+ }+ Task { @MainActor [weak self] in+ try? await Task.sleep(for: Self.guestShutdownTimeout)+ print("[vphone] Guest still running after \(Self.guestShutdownTimeout); turning it off")+ self?.powerOff()+ }+ return .terminateCancel+ }++ @MainActor+ private func powerOff() {+ powersOffOnQuit = true+ NSApp.terminate(nil)+ }+func applicationShouldTerminateAfterLastWindowClosed(_: NSApplication) -> Bool {!command.noGraphics && !isRestartingVirtualMachine}