Merge pull request swiftlang#57 from owenv/response-files

Use response files when running subcommands if needed

Author: DougGregor

Sources/SwiftDriver/Driver/Driver.swift

@@ -423,48 +423,61 @@ extension Driver {
   /// This method supports response files with:
   /// 1. Double slash comments at the beginning of a line.
   /// 2. Backslash escaping.
-  /// 3. Space character (U+0020 SPACE).
+  /// 3. Shell Quoting
   ///
-  /// - Returns: One line String ready to be used in the shell, if any.
+  /// - Returns: An array of 0 or more command line arguments
   ///
   /// - Complexity: O(*n*), where *n* is the length of the line.
-  private static func tokenizeResponseFileLine<S: StringProtocol>(_ line: S) -> String? {
-    if line.isEmpty { return nil }
-    
+  private static func tokenizeResponseFileLine<S: StringProtocol>(_ line: S) -> [String] {
     // Support double dash comments only if they start at the beginning of a line.
-    if line.hasPrefix("//") { return nil }
-    
-    var result: String = ""
-    /// Indicates if we just parsed an escaping backslash.
+    if line.hasPrefix("//") { return [] }
+
+    var tokens: [String] = []
+    var token: String = ""
+    // Conservatively assume ~1 token per line.
+    token.reserveCapacity(line.count)
+    // Indicates if we just parsed an escaping backslash.
     var isEscaping = false
+    // Indicates if we are currently parsing quoted text.
+    var quoted = false
 
     for char in line {
-      if char.isNewline { return result }
-
       // Backslash escapes to the next character.
       if char == #"\"#, !isEscaping {
         isEscaping = true
         continue
       } else if isEscaping {
         // Disable escaping and keep parsing.
         isEscaping = false
+      } else if char.isShellQuote {
+        // If an unescaped shell quote appears, begin or end quoting.
+        quoted.toggle()
+        continue
+      } else if char.isWhitespace && !quoted {
+        // This is unquoted, unescaped whitespace, start a new token.
+        tokens.append(token)
+        token = ""
+        continue
       }
-      
-      // Ignore spacing characters, except by the space character.
-      if char.isWhitespace && char != " " { continue }
-      
-      result.append(char)
+
+      token.append(char)
     }
-    return result.isEmpty ? nil : result
+    // Add the final token
+    tokens.append(token)
+
+    // Filter any empty tokens that might be parsed if there's excessive whitespace.
+    return tokens.filter { !$0.isEmpty }
   }
 
   /// Tokenize each line of the response file, omitting empty lines.
   ///
   /// - Parameter content: response file's content to be tokenized.
   private static func tokenizeResponseFile(_ content: String) -> [String] {
-    return content
-      .split(separator: "\n")
-      .compactMap { tokenizeResponseFileLine($0) }
+    #if !os(macOS) && !os(Linux)
+      #warning("Response file tokenization unimplemented for platform; behavior may be incorrect")
+    #endif
+    return content.split { $0 == "\n" || $0 == "\r\n" }
+           .flatMap { tokenizeResponseFileLine($0) }
   }
 
   /// Recursively expands the response files.
@@ -574,10 +587,12 @@ extension Driver {
 
     if jobs.isEmpty { return }
 
+    let forceResponseFiles = parsedOptions.contains(.driverForceResponseFiles)
+
     // If we're only supposed to print the jobs, do so now.
     if parsedOptions.contains(.driverPrintJobs) {
       for job in jobs {
-        print(job)
+        try Self.printJob(job, resolver: resolver, forceResponseFiles: forceResponseFiles)
       }
       return
     }
@@ -591,7 +606,7 @@ extension Driver {
 
     if jobs.contains(where: { $0.requiresInPlaceExecution }) {
       assert(jobs.count == 1, "Cannot execute in place for multi-job build plans")
-      return try executeJobInPlace(jobs[0], resolver: resolver)
+      return try executeJobInPlace(jobs[0], resolver: resolver, forceResponseFiles: forceResponseFiles)
     }
 
     // Create and use the tool execution delegate if one is not provided explicitly.
@@ -602,7 +617,8 @@ extension Driver {
         jobs: jobs, resolver: resolver,
         executorDelegate: executorDelegate,
         numParallelJobs: numParallelJobs,
-        processSet: processSet
+        processSet: processSet,
+        forceResponseFiles: forceResponseFiles
     )
     try jobExecutor.execute(env: env)
   }
@@ -621,16 +637,32 @@ extension Driver {
   }
 
   /// Execute a single job in-place.
-  private func executeJobInPlace(_ job: Job, resolver: ArgsResolver) throws {
-    let tool = try resolver.resolve(.path(job.tool))
-    let commandLine = try job.commandLine.map{ try resolver.resolve($0) }
-    let arguments = [tool] + commandLine
+  private func executeJobInPlace(_ job: Job, resolver: ArgsResolver, forceResponseFiles: Bool) throws {
+    let arguments: [String] = try resolver.resolveArgumentList(for: job, forceResponseFiles: forceResponseFiles)
 
     for (envVar, value) in job.extraEnvironment {
       try ProcessEnv.setVar(envVar, value: value)
     }
 
-    return try exec(path: tool, args: arguments)
+    return try exec(path: arguments[0], args: arguments)
+  }
+
+  public static func printJob(_ job: Job, resolver: ArgsResolver, forceResponseFiles: Bool) throws {
+    let (args, usedResponseFile) = try resolver.resolveArgumentList(for: job, forceResponseFiles: forceResponseFiles)
+    var result = args.joined(separator: " ")
+
+    if usedResponseFile {
+      // Print the response file arguments as a comment.
+      result += " # \(job.commandLine.joinedArguments)"
+    }
+
+    if !job.extraEnvironment.isEmpty {
+      result += " #"
+      for (envVar, val) in job.extraEnvironment {
+        result += " \(envVar)=\(val)"
+      }
+    }
+    print(result)
   }
 
   private func printVersion<S: OutputByteStream>(outputStream: inout S) throws {

Sources/SwiftDriver/Execution/JobExecutor.swift

@@ -32,6 +32,19 @@ public struct ArgsResolver {
     }
   }
 
+  public func resolveArgumentList(for job: Job, forceResponseFiles: Bool) throws -> [String] {
+    let (arguments, _) = try resolveArgumentList(for: job, forceResponseFiles: forceResponseFiles)
+    return arguments
+  }
+
+  public func resolveArgumentList(for job: Job, forceResponseFiles: Bool) throws -> ([String], usingResponseFile: Bool) {
+    let tool = try resolve(.path(job.tool))
+    var arguments = [tool] + (try job.commandLine.map { try resolve($0) })
+    let usingResponseFile = try createResponseFileIfNeeded(for: job, resolvedArguments: &arguments,
+                                                           forceResponseFiles: forceResponseFiles)
+    return (arguments, usingResponseFile)
+  }
+
   /// Resolve the given argument.
   public func resolve(_ arg: Job.ArgTemplate) throws -> String {
     switch arg {
@@ -55,6 +68,22 @@ public struct ArgsResolver {
     }
   }
 
+  private func createResponseFileIfNeeded(for job: Job, resolvedArguments: inout [String], forceResponseFiles: Bool) throws -> Bool {
+    if forceResponseFiles ||
+      (job.supportsResponseFiles && !commandLineFitsWithinSystemLimits(path: resolvedArguments[0], args: resolvedArguments)) {
+      assert(!forceResponseFiles || job.supportsResponseFiles,
+             "Platform does not support response files for job: \(job)")
+      // Match the integrated driver's behavior, which uses response file names of the form "arguments-[0-9a-zA-Z].resp".
+      let responseFilePath = temporaryDirectory.appending(component: "arguments-\(abs(job.hashValue)).resp")
+      try localFileSystem.writeFileContents(responseFilePath) {
+        $0 <<< resolvedArguments[1...].map{ $0.spm_shellEscaped() }.joined(separator: "\n")
+      }
+      resolvedArguments = [resolvedArguments[0], "@\(responseFilePath.pathString)"]
+      return true
+    }
+    return false
+  }
+
   /// Remove the temporary directory from disk.
   public func removeTemporaryDirectory() throws {
     _ = try FileManager.default.removeItem(atPath: temporaryDirectory.pathString)
@@ -106,20 +135,25 @@ public final class JobExecutor {
     /// The process set to use when launching new processes.
     let processSet: ProcessSet?
 
+    /// If true, always use response files to pass command line arguments.
+    let forceResponseFiles: Bool
+
     init(
       argsResolver: ArgsResolver,
       env: [String: String],
       producerMap: [VirtualPath: Job],
       executorDelegate: JobExecutorDelegate,
       jobQueue: OperationQueue,
-      processSet: ProcessSet?
+      processSet: ProcessSet?,
+      forceResponseFiles: Bool
     ) {
       self.producerMap = producerMap
       self.argsResolver = argsResolver
       self.env = env
       self.executorDelegate = executorDelegate
       self.jobQueue = jobQueue
       self.processSet = processSet
+      self.forceResponseFiles = forceResponseFiles
     }
   }
 
@@ -138,18 +172,23 @@ public final class JobExecutor {
   /// The process set to use when launching new processes.
   let processSet: ProcessSet?
 
+  /// If true, always use response files to pass command line arguments.
+  let forceResponseFiles: Bool
+
   public init(
     jobs: [Job],
     resolver: ArgsResolver,
     executorDelegate: JobExecutorDelegate,
     numParallelJobs: Int? = nil,
-    processSet: ProcessSet? = nil
+    processSet: ProcessSet? = nil,
+    forceResponseFiles: Bool = false
   ) {
     self.jobs = jobs
     self.argsResolver = resolver
     self.executorDelegate = executorDelegate
     self.numParallelJobs = numParallelJobs ?? 1
     self.processSet = processSet
+    self.forceResponseFiles = forceResponseFiles
   }
 
   /// Execute all jobs.
@@ -187,7 +226,8 @@ public final class JobExecutor {
       producerMap: producerMap,
       executorDelegate: executorDelegate,
       jobQueue: jobQueue,
-      processSet: processSet
+      processSet: processSet,
+      forceResponseFiles: forceResponseFiles
     )
   }
 }
@@ -339,9 +379,8 @@ class ExecuteJobRule: LLBuildRule {
     let value: DriverBuildValue
     var pid = 0
     do {
-      let tool = try resolver.resolve(.path(job.tool))
-      let commandLine = try job.commandLine.map{ try resolver.resolve($0) }
-      let arguments = [tool] + commandLine
+      let arguments: [String] = try resolver.resolveArgumentList(for: job,
+                                                                 forceResponseFiles: context.forceResponseFiles)
 
       let process = try context.executorDelegate.launchProcess(
         for: job, arguments: arguments, env: env

Sources/SwiftDriver/Jobs/AutolinkExtractJob.swift

@@ -33,7 +33,8 @@ extension Driver {
       tool: .absolute(try toolchain.getToolPath(.swiftAutolinkExtract)),
       commandLine: commandLine,
       inputs: inputs,
-      outputs: [.init(file: output, type: .autolink)]
+      outputs: [.init(file: output, type: .autolink)],
+      supportsResponseFiles: true
     )
   }
 }

Sources/SwiftDriver/Jobs/CompileJob.swift

@@ -158,7 +158,8 @@ extension Driver {
       commandLine: commandLine,
       displayInputs: primaryInputs,
       inputs: inputs,
-      outputs: outputs
+      outputs: outputs,
+      supportsResponseFiles: true
     )
   }
 }

Sources/SwiftDriver/Jobs/GeneratePCHJob.swift

@@ -67,7 +67,8 @@ extension Driver {
       commandLine: commandLine,
       displayInputs: [],
       inputs: inputs,
-      outputs: outputs
+      outputs: outputs,
+      supportsResponseFiles: true
     )
   }
 }

Sources/SwiftDriver/Jobs/InterpretJob.swift

@@ -47,7 +47,8 @@ extension Driver {
       inputs:inputs,
       outputs: [],
       extraEnvironment: extraEnvironment,
-      requiresInPlaceExecution: true
+      requiresInPlaceExecution: true,
+      supportsResponseFiles: true
     )
   }
 }

Sources/SwiftDriver/Jobs/Job.swift

@@ -12,7 +12,7 @@
 import TSCBasic
 
 /// A job represents an individual subprocess that should be invoked during compilation.
-public struct Job: Codable, Equatable {
+public struct Job: Codable, Equatable, Hashable {
   public enum Kind: String, Codable {
     case compile
     case mergeModule = "merge-module"
@@ -31,7 +31,7 @@ public struct Job: Codable, Equatable {
     case versionRequest = "version-request"
   }
 
-  public enum ArgTemplate: Equatable {
+  public enum ArgTemplate: Equatable, Hashable {
     /// Represents a command-line flag that is substitued as-is.
     case flag(String)
 
@@ -45,6 +45,9 @@ public struct Job: Codable, Equatable {
   /// The command-line arguments of the job.
   public var commandLine: [ArgTemplate]
 
+  /// Whether or not the job supports using response files to pass command line arguments.
+  public var supportsResponseFiles: Bool
+
   /// The list of inputs to use for displaying purposes.
   public var displayInputs: [TypedVirtualPath]
 
@@ -71,7 +74,8 @@ public struct Job: Codable, Equatable {
     inputs: [TypedVirtualPath],
     outputs: [TypedVirtualPath],
     extraEnvironment: [String: String] = [:],
-    requiresInPlaceExecution: Bool = false
+    requiresInPlaceExecution: Bool = false,
+    supportsResponseFiles: Bool = false
   ) {
     self.kind = kind
     self.tool = tool
@@ -81,21 +85,7 @@ public struct Job: Codable, Equatable {
     self.outputs = outputs
     self.extraEnvironment = extraEnvironment
     self.requiresInPlaceExecution = requiresInPlaceExecution
-  }
-}
-
-extension Job: CustomStringConvertible {
-  public var description: String {
-    var result: String = "\(tool.name) \(commandLine.joinedArguments)"
-
-    if !self.extraEnvironment.isEmpty {
-      result += " #"
-      for (envVar, val) in extraEnvironment {
-        result += " \(envVar)=\(val)"
-      }
-    }
-
-    return result
+    self.supportsResponseFiles = supportsResponseFiles
   }
 }
 

Sources/SwiftDriver/Jobs/LinkJob.swift

@@ -51,6 +51,7 @@ extension Driver {
       targetTriple: targetTriple
     )
 
+    // TODO: some, but not all, linkers support response files.
     return Job(
       kind: .link,
       tool: .absolute(toolPath),

Sources/SwiftDriver/Jobs/MergeModuleJob.swift

@@ -54,7 +54,8 @@ extension Driver {
       tool: .absolute(try toolchain.getToolPath(.swiftCompiler)),
       commandLine: commandLine,
       inputs: inputs,
-      outputs: outputs
+      outputs: outputs,
+      supportsResponseFiles: true
     )
   }
 }

Sources/SwiftDriver/Utilities/StringAdditions.swift

@@ -133,3 +133,9 @@ extension Unicode.Scalar {
     }
   }
 }
+
+extension Character {
+  var isShellQuote: Bool {
+    return self == "\"" || self == "'"
+  }
+}