Validate profile generation args

Author: owenv

Sources/SwiftDriver/Driver/Driver.swift

@@ -27,6 +27,7 @@ public struct Driver {
     case unableToLoadOutputFileMap(String)
     case unableToDecodeFrontendTargetInfo
     case failedToRetrieveFrontendTargetInfo
+    case missingProfilingData(String)
     // Explicit Module Build Failures
     case malformedModuleDependency(String, String)
     case missingPCMArguments(String)
@@ -55,6 +56,8 @@ public struct Driver {
         return "could not decode frontend target info; compiler driver and frontend executables may be incompatible"
       case .failedToRetrieveFrontendTargetInfo:
         return "failed to retrieve frontend target info"
+      case .missingProfilingData(let arg):
+        return "no profdata file exists at '\(arg)'"
       // Explicit Module Build Failures
       case .malformedModuleDependency(let moduleName, let errorDescription):
         return "Malformed Module Dependency: \(moduleName), \(errorDescription)"
@@ -328,6 +331,9 @@ public struct Driver {
     self.numParallelJobs = Self.determineNumParallelJobs(&parsedOptions, diagnosticsEngine: diagnosticEngine, env: env)
 
     try Self.validateWarningControlArgs(&parsedOptions)
+    try Self.validateProfilingArgs(&parsedOptions,
+                                   fileSystem: fileSystem,
+                                   workingDirectory: workingDirectory)
     Self.validateCoverageArgs(&parsedOptions, diagnosticsEngine: diagnosticEngine)
     try toolchain.validateArgs(&parsedOptions,
                                targetTriple: self.frontendTargetInfo.target.triple,
@@ -1565,6 +1571,25 @@ extension Driver {
     }
   }
 
+  static func validateProfilingArgs(_ parsedOptions: inout ParsedOptions,
+                                    fileSystem: FileSystem,
+                                    workingDirectory: AbsolutePath?) throws {
+    if parsedOptions.hasArgument(.profileGenerate) &&
+        parsedOptions.hasArgument(.profileUse) {
+      throw Error.conflictingOptions(.profileGenerate, .profileUse)
+    }
+
+    if let profileArgs = parsedOptions.getLastArgument(.profileUse)?.asMultiple,
+       let workingDirectory = workingDirectory ?? fileSystem.currentWorkingDirectory {
+      for profilingData in profileArgs {
+        guard fileSystem.exists(AbsolutePath(profilingData,
+                                             relativeTo: workingDirectory)) else {
+          throw Error.missingProfilingData(profilingData)
+        }
+      }
+    }
+  }
+
   private static func validateCoverageArgs(_ parsedOptions: inout ParsedOptions, diagnosticsEngine: DiagnosticsEngine) {
     for coveragePrefixMap in parsedOptions.arguments(for: .coveragePrefixMap) {
       let value = coveragePrefixMap.argument.asSingle

Tests/SwiftDriverTests/SwiftDriverTests.swift

@@ -1664,6 +1664,32 @@ final class SwiftDriverTests: XCTestCase {
     try assertNoDriverDiagnostics(args: "swiftc", "-c", "-target", "x86_64-apple-macosx10.14", "-link-objc-runtime", "foo.swift")
   }
 
+  func testProfileArgValidation() throws {
+    XCTAssertThrowsError(try Driver(args: ["swiftc", "foo.swift", "-profile-generate", "-profile-use=profile.profdata"])) {
+      XCTAssertEqual($0 as? Driver.Error, .conflictingOptions(.profileGenerate, .profileUse))
+    }
+
+    XCTAssertThrowsError(try Driver(args: ["swiftc", "foo.swift", "-profile-use=profile.profdata"])) {
+      XCTAssertEqual($0 as? Driver.Error, .missingProfilingData("profile.profdata"))
+    }
+
+    try withTemporaryDirectory { path in
+      try localFileSystem.writeFileContents(path.appending(component: "profile.profdata"), bytes: .init())
+      XCTAssertNoThrow(try Driver(args: ["swiftc", "-working-directory", path.pathString, "foo.swift", "-profile-use=profile.profdata"]))
+    }
+
+    try withTemporaryDirectory { path in
+      try localFileSystem.writeFileContents(path.appending(component: "profile.profdata"), bytes: .init())
+      XCTAssertThrowsError(try Driver(args: ["swiftc", "-working-directory", path.pathString, "foo.swift",
+                                             "-profile-use=profile.profdata,profile2.profdata"])) {
+        guard case Driver.Error.missingProfilingData = $0 else {
+          XCTFail()
+          return
+        }
+      }
+    }
+  }
+
   // Test cases ported from Driver/macabi-environment.swift
   func testDarwinSDKVersioning() throws {
     try withTemporaryDirectory { tmpDir in