Option to pass externally created serial console (#448)

* Option to pass externally created serial console

See https://github.com/cirruslabs/tart/pull/364#issuecomment-1472111742 for details

* Fixed compilation

* Apply suggestions from code review

Co-authored-by: Nikolay Edigaryev <edigaryev@gmail.com>

---------

Co-authored-by: Nikolay Edigaryev <edigaryev@gmail.com>

.cirrus.yml

@@ -80,8 +80,6 @@ task:
   always:
     dist_artifacts:
       path: "dist/*"
-    pkg_artifacts:
-      path: ".ci/*.pkg"
 
 task:
   name: Release

.goreleaser.yml

@@ -4,10 +4,6 @@ before:
   hooks:
     - .ci/set-version.sh
     - swift build -c debug --product tart
-    - xattr -cr .build/arm64-apple-macosx/debug/tart
-    - gon gon.hcl
-    - codesign --verify --deep --strict .build/arm64-apple-macosx/debug/tart
-    - ./.ci/create-pkg.sh
 
 builds:
   - builder: prebuilt
@@ -17,17 +13,22 @@ builds:
       - arm64
     prebuilt:
       path: .build/arm64-apple-macosx/debug/tart
+    hooks:
+      post:
+        - gon gon.hcl
 
 archives:
   - name_template: "{{ .ProjectName }}"
     files:
       - src: Resources/embedded.provisionprofile
+        dst: tart.app/Contents
+        strip_parent: true
+      - src: ".build/arm64-apple-macosx/debug/tart"
+        dst: tart.app/Contents/MacOS
         strip_parent: true
 
 release:
   prerelease: auto
-  extra_files:
-    - glob: ./.ci/Tart-{{ .Tag }}.pkg
 
 brews:
   - name: tart
@@ -42,9 +43,7 @@ brews:
     dependencies:
       - "cirruslabs/cli/softnet"
     install: |
-      mkdir_p libexec/"tart.app/Contents/MacOS/"
-      libexec.install "tart" => "tart.app/Contents/MacOS/tart"
-      libexec.install "embedded.provisionprofile" => "tart.app/Contents/embedded.provisionprofile"
+      libexec.install Dir["*"]
       bin.write_exec_script "#{libexec}/tart.app/Contents/MacOS/tart"
     custom_block: |
       depends_on :macos => :monterey

README.md

@@ -37,6 +37,9 @@ Many more companies are using Tart in their internal setups. Here are a few of t
   <a href="https://symflower.com/" target=_blank>
     <img src="https://github.com/cirruslabs/tart/raw/main/Resources/Users/Symflower.png" height="65"/>
   </a>
+  <a href="https://transloadit.com/" target=_blank>
+    <img src="https://github.com/cirruslabs/tart/raw/main/Resources/Users/Transloadit.png" height="65"/>
+  </a>
 </p>
 
 **Note:** If your company or project is using Tart please consider [adding yourself to the list above](/Resources/Users/HowToAddYourself.md).

Sources/tart/Commands/IP.swift

@@ -4,6 +4,12 @@ import Network
 import SystemConfiguration
 import Sentry
 
+enum IPResolutionStrategy: String, ExpressibleByArgument, CaseIterable {
+  case dhcp, arp
+
+  private(set) static var allValueStrings: [String] = Format.allCases.map { "\($0)"}
+}
+
 struct IP: AsyncParsableCommand {
   static var configuration = CommandConfiguration(abstract: "Get VM's IP address")
 
@@ -13,46 +19,40 @@ struct IP: AsyncParsableCommand {
   @Option(help: "Number of seconds to wait for a potential VM booting")
   var wait: UInt16 = 0
 
+  @Option(help: ArgumentHelp("Strategy for resolving IP address: dhcp or arp",
+                             discussion: """
+                             By default, Tart is looking up and parsing DHCP lease file to determine the IP of the VM.\n
+                             This method is fast and the most reliable but only returns local IP adresses.\n
+                             Alternatively, Tart can call external `arp` executable and parse it's output.\n
+                             In case of enabled Bridged Networking this method will return VM's IP address on the network interface used for Bridged Networking.\n
+                             Note that `arp` strategy won't work for VMs using `--net-softnet`.
+                             """))
+  var resolver: IPResolutionStrategy = .dhcp
+
   func run() async throws {
     let vmDir = try VMStorageLocal().open(name)
     let vmConfig = try VMConfig.init(fromURL: vmDir.configURL)
     let vmMACAddress = MACAddress(fromString: vmConfig.macAddress.string)!
 
-    guard let ipViaDHCP = try await IP.resolveIP(vmMACAddress, secondsToWait: wait) else {
+    guard let ip = try await IP.resolveIP(vmMACAddress, resolutionStrategy: resolver, secondsToWait: wait) else {
       throw RuntimeError.NoIPAddressFound("no IP address found, is your VM running?")
     }
-
-    let arpCache = try ARPCache()
-
-    if let ipViaARP = try arpCache.ResolveMACAddress(macAddress: vmMACAddress), ipViaARP != ipViaDHCP {
-      // Capture the warning into Sentry
-      SentrySDK.capture(message: "DHCP lease and ARP cache entries for a single MAC address differ") { scope in
-        scope.setLevel(.warning)
-
-        scope.setContext(value: [
-          "MAC address": vmMACAddress,
-          "IP via ARP": ipViaARP,
-          "IP via DHCP": ipViaDHCP,
-        ], key: "Address conflict details")
-
-        scope.add(Attachment(path: "/var/db/dhcpd_leases", filename: "dhcpd_leases.txt", contentType: "text/plain"))
-        scope.add(Attachment(data: arpCache.arpCommandOutput, filename: "arp-an-output.txt", contentType: "text/plain"))
-      }
-
-      fputs("WARNING: DHCP lease and ARP cache entries for MAC address \(vmMACAddress) differ: "
-        + "got \(ipViaDHCP) and \(ipViaARP) respectively, consider reporting this case to"
-        + " https://github.com/cirruslabs/tart/issues/172\n", stderr)
-    }
-
-    print(ipViaDHCP)
+    print(ip)
   }
 
-  static public func resolveIP(_ vmMACAddress: MACAddress, secondsToWait: UInt16) async throws -> IPv4Address? {
+  static public func resolveIP(_ vmMACAddress: MACAddress, resolutionStrategy: IPResolutionStrategy = .dhcp, secondsToWait: UInt16 = 0) async throws -> IPv4Address? {
     let waitUntil = Calendar.current.date(byAdding: .second, value: Int(secondsToWait), to: Date.now)!
 
     repeat {
-      if let leases = try Leases(), let ip = try leases.resolveMACAddress(macAddress: vmMACAddress) {
-        return ip
+      switch resolutionStrategy {
+      case .arp:
+        if let ip = try ARPCache().ResolveMACAddress(macAddress: vmMACAddress) {
+          return ip
+        }
+      case .dhcp:
+        if let leases = try Leases(), let ip = try leases.ResolveMACAddress(macAddress: vmMACAddress) {
+          return ip
+        }
       }
 
       // wait a second

Sources/tart/Commands/Run.swift

@@ -17,13 +17,24 @@ struct Run: AsyncParsableCommand {
 
   @Flag(help: ArgumentHelp(
     "Don't open a UI window.",
-    discussion: "Useful for integrating Tart VMs into other tools.\nUse `tart ip` in order to get an IP for SSHing or VNCing into the VM.")) 
+    discussion: "Useful for integrating Tart VMs into other tools.\nUse `tart ip` in order to get an IP for SSHing or VNCing into the VM."))
   var noGraphics: Bool = false
 
+  @Flag(help: ArgumentHelp(
+    "Open serial console in /dev/ttySXX",
+    discussion: "Useful for debugging Linux Kernel."))
+  var serial: Bool = false
+
+  @Option(help: ArgumentHelp(
+    "Attach an externally created serial console",
+    discussion: "Alternative to `--serial` flag for programmatic integrations."
+  ))
+  var serialPath: String?
+
   @Flag(help: "Force open a UI window, even when VNC is enabled.")
   var graphics: Bool = false
 
-  @Flag(help: "Boot into recovery mode") 
+  @Flag(help: "Boot into recovery mode")
   var recovery: Bool = false
 
   @Flag(help: ArgumentHelp(
@@ -118,11 +129,30 @@ struct Run: AsyncParsableCommand {
       }
     }
 
+    var serialPorts: [VZSerialPortConfiguration] = []
+    if serial {
+      let tty_fd = createPTY()
+      if (tty_fd < 0) {
+        throw RuntimeError.VMConfigurationError("Failed to create PTY")
+      }
+      let tty_read = FileHandle.init(fileDescriptor: tty_fd)
+      let tty_write = FileHandle.init(fileDescriptor: tty_fd)
+      serialPorts.append(createSerialPortConfiguration(tty_read, tty_write))
+    } else if serialPath != nil {
+      let tty_read = FileHandle.init(forReadingAtPath: serialPath!)
+      let tty_write = FileHandle.init(forWritingAtPath: serialPath!)
+      if (tty_read == nil || tty_write == nil) {
+        throw RuntimeError.VMConfigurationError("Failed to open PTY")
+      }
+      serialPorts.append(createSerialPortConfiguration(tty_read!, tty_write!))
+    }
+
     vm = try VM(
       vmDir: vmDir,
       network: userSpecifiedNetwork(vmDir: vmDir) ?? NetworkShared(),
       additionalDiskAttachments: additionalDiskAttachments,
-      directorySharingDevices: directoryShares() + rosettaDirectoryShare()
+      directorySharingDevices: directoryShares() + rosettaDirectoryShare(),
+      serialPorts: serialPorts
     )
 
     let vncImpl: VNC? = try {
@@ -198,6 +228,16 @@ struct Run: AsyncParsableCommand {
     }
   }
 
+  private func createSerialPortConfiguration(_ tty_read: FileHandle, _ tty_write: FileHandle) -> VZVirtioConsoleDeviceSerialPortConfiguration {
+    let serialPortConfiguration = VZVirtioConsoleDeviceSerialPortConfiguration()
+    let serialPortAttachment = VZFileHandleSerialPortAttachment(
+      fileHandleForReading: tty_read,
+      fileHandleForWriting: tty_write)
+
+    serialPortConfiguration.attachment = serialPortAttachment
+    return serialPortConfiguration
+  }
+
   func isInteractiveSession() -> Bool {
     isatty(STDOUT_FILENO) == 1
   }
@@ -357,7 +397,13 @@ struct Run: AsyncParsableCommand {
             VMView(vm: vm!).onAppear {
               NSWindow.allowsAutomaticWindowTabbing = false
             }.onDisappear {
-              NSApplication.shared.terminate(self)
+              let ret = kill(getpid(), SIGINT)
+              if ret != 0 {
+                // Fallback to the old termination method that doesn't
+                // propagate the cancellation to Task's in case graceful
+                // termination via kill(2) is not successful
+                NSApplication.shared.terminate(self)
+              }
             }
           }.frame(width: CGFloat(vm!.config.display.width), height: CGFloat(vm!.config.display.height))
         }.commands {

Sources/tart/MACAddressResolver/ARPCache.swift

@@ -67,7 +67,7 @@ struct ARPCache {
     self.arpCommandOutput = arpCommandOutput
   }
 
-  func ResolveMACAddress(macAddress: MACAddress, bridgeOnly: Bool = true) throws -> IPv4Address? {
+  func ResolveMACAddress(macAddress: MACAddress) throws -> IPv4Address? {
     let lines = String(decoding: arpCommandOutput, as: UTF8.self)
       .trimmingCharacters(in: .whitespacesAndNewlines)
       .components(separatedBy: "\n")
@@ -95,11 +95,6 @@ struct ARPCache {
         throw ARPCommandYieldedInvalidOutputError(explanation: "failed to parse MAC address \(rawMAC)")
       }
 
-      let interface = try match.getCaptureGroup(name: "interface", for: line)
-      if bridgeOnly && !interface.starts(with: "bridge") {
-        continue
-      }
-
       if macAddress == mac {
         return ip
       }

Sources/tart/MACAddressResolver/Leases.swift

@@ -107,7 +107,7 @@ class Leases {
     return rawLeases
   }
 
-  func resolveMACAddress(macAddress: MACAddress) throws -> IPv4Address? {
+  func ResolveMACAddress(macAddress: MACAddress) throws -> IPv4Address? {
     leases[macAddress]?.ip
   }
 }

Sources/tart/Serial.swift

@@ -0,0 +1,44 @@
+import Foundation
+
+func createPTY() -> Int32 {
+  var tty_fd: Int32 = -1
+  var sfd: Int32 = -1
+  var termios_ = termios()
+  let tty_path = UnsafeMutablePointer<CChar>.allocate(capacity: 1024)
+
+  var res = openpty(&tty_fd, &sfd, tty_path, nil, nil);
+  if (res < 0) {
+    perror("openpty error")
+    return -1
+  }
+
+  // close slave file descriptor
+  close(sfd)
+
+  res = fcntl(tty_fd, F_GETFL)
+  if (res < 0) {
+    perror("fcntl F_GETFL error")
+    return res
+  }
+
+  // set serial nonblocking
+  res = fcntl(tty_fd, F_SETFL, res | O_NONBLOCK)
+  if (res < 0) {
+    perror("fcntl F_SETFL O_NONBLOCK error")
+    return res
+  }
+
+  // set baudrate to 115200
+  tcgetattr(tty_fd, &termios_)
+  cfsetispeed(&termios_, speed_t(B115200))
+  cfsetospeed(&termios_, speed_t(B115200))
+  if (tcsetattr(tty_fd, TCSANOW, &termios_) != 0) {
+    perror("tcsetattr error")
+    return -1
+  }
+
+  print("Successfully open pty \(String(cString: tty_path))")
+
+  tty_path.deallocate()
+  return tty_fd
+}

Sources/tart/VM.swift

@@ -40,7 +40,8 @@ class VM: NSObject, VZVirtualMachineDelegate, ObservableObject {
   init(vmDir: VMDirectory,
        network: Network = NetworkShared(),
        additionalDiskAttachments: [VZDiskImageStorageDeviceAttachment] = [],
-       directorySharingDevices: [VZDirectorySharingDeviceConfiguration] = []
+       directorySharingDevices: [VZDirectorySharingDeviceConfiguration] = [],
+       serialPorts: [VZSerialPortConfiguration] = []
   ) throws {
     name = vmDir.name
     config = try VMConfig.init(fromURL: vmDir.configURL)
@@ -54,7 +55,8 @@ class VM: NSObject, VZVirtualMachineDelegate, ObservableObject {
     let configuration = try Self.craftConfiguration(diskURL: vmDir.diskURL,
                                                     nvramURL: vmDir.nvramURL, vmConfig: config,
                                                     network: network, additionalDiskAttachments: additionalDiskAttachments,
-                                                    directorySharingDevices: directorySharingDevices
+                                                    directorySharingDevices: directorySharingDevices,
+                                                    serialPorts: serialPorts
     )
     virtualMachine = VZVirtualMachine(configuration: configuration)
 
@@ -132,7 +134,8 @@ class VM: NSObject, VZVirtualMachineDelegate, ObservableObject {
     diskSizeGB: UInt16,
     network: Network = NetworkShared(),
     additionalDiskAttachments: [VZDiskImageStorageDeviceAttachment] = [],
-    directorySharingDevices: [VZDirectorySharingDeviceConfiguration] = []
+    directorySharingDevices: [VZDirectorySharingDeviceConfiguration] = [],
+    serialPorts: [VZSerialPortConfiguration] = []
   ) async throws {
     var ipswURL = ipswURL
 
@@ -179,7 +182,8 @@ class VM: NSObject, VZVirtualMachineDelegate, ObservableObject {
     let configuration = try Self.craftConfiguration(diskURL: vmDir.diskURL, nvramURL: vmDir.nvramURL,
                                                     vmConfig: config, network: network,
                                                     additionalDiskAttachments: additionalDiskAttachments,
-                                                    directorySharingDevices: directorySharingDevices
+                                                    directorySharingDevices: directorySharingDevices,
+                                                    serialPorts: serialPorts
     )
     virtualMachine = VZVirtualMachine(configuration: configuration)
 
@@ -261,7 +265,8 @@ class VM: NSObject, VZVirtualMachineDelegate, ObservableObject {
     vmConfig: VMConfig,
     network: Network = NetworkShared(),
     additionalDiskAttachments: [VZDiskImageStorageDeviceAttachment],
-    directorySharingDevices: [VZDirectorySharingDeviceConfiguration]
+    directorySharingDevices: [VZDirectorySharingDeviceConfiguration],
+    serialPorts: [VZSerialPortConfiguration]
   ) throws -> VZVirtualMachineConfiguration {
     let configuration = VZVirtualMachineConfiguration()
 
@@ -308,6 +313,9 @@ class VM: NSObject, VZVirtualMachineDelegate, ObservableObject {
     // Directory sharing devices
     configuration.directorySharingDevices = directorySharingDevices
 
+    // Serial Port
+    configuration.serialPorts = serialPorts
+
     try configuration.validate()
 
     return configuration

Sources/tart/VMStorageHelper.swift

@@ -41,6 +41,7 @@ extension Error {
 }
 
 enum RuntimeError : Error {
+  case VMConfigurationError(_ message: String)
   case VMDoesNotExist(name: String)
   case VMMissingFiles(_ message: String)
   case VMNotRunning(_ message: String)
@@ -65,6 +66,8 @@ protocol HasExitCode {
 extension RuntimeError : CustomStringConvertible {
   public var description: String {
     switch self {
+    case .VMConfigurationError(let message):
+      return message
     case .VMDoesNotExist(let name):
       return "the specified VM \"\(name)\" does not exist"
     case .VMMissingFiles(let message):

Tests/TartTests/MACAddressResolverTests.swift

@@ -12,7 +12,7 @@ final class MACAddressResolverTests: XCTestCase {
     """)
 
     XCTAssertEqual(IPv4Address("1.2.3.4"),
-                   try leases.resolveMACAddress(macAddress: MACAddress(fromString: "00:11:22:33:44:55")!))
+                   try leases.ResolveMACAddress(macAddress: MACAddress(fromString: "00:11:22:33:44:55")!))
   }
 
   func testMultipleEntries() throws {
@@ -28,8 +28,8 @@ final class MACAddressResolverTests: XCTestCase {
     """)
 
     XCTAssertEqual(IPv4Address("1.2.3.4"),
-                   try leases.resolveMACAddress(macAddress: MACAddress(fromString: "00:11:22:33:44:55")!))
+                   try leases.ResolveMACAddress(macAddress: MACAddress(fromString: "00:11:22:33:44:55")!))
     XCTAssertEqual(IPv4Address("5.6.7.8"),
-                   try leases.resolveMACAddress(macAddress: MACAddress(fromString: "AA:BB:CC:DD:EE:FF")!))
+                   try leases.ResolveMACAddress(macAddress: MACAddress(fromString: "AA:BB:CC:DD:EE:FF")!))
   }
 }