[CAS] Virtualize TBD output

Virtualize TBD file output so we can check the output determinisim and
also be cached.

Author: cachemeifyoucan

lib/FrontendTool/FrontendTool.cpp

@@ -806,7 +806,8 @@ static bool writeTBDIfNeeded(CompilerInstance &Instance) {
 
   const std::string &TBDPath = Invocation.getTBDPathForWholeModule();
 
-  return writeTBD(Instance.getMainModule(), TBDPath, tbdOpts);
+  return writeTBD(Instance.getMainModule(), TBDPath,
+                  Instance.getOutputBackend(), tbdOpts);
 }
 
 static bool performCompileStepsPostSILGen(CompilerInstance &Instance,

lib/FrontendTool/TBD.cpp

@@ -15,6 +15,7 @@
 #include "swift/AST/Decl.h"
 #include "swift/AST/DiagnosticEngine.h"
 #include "swift/AST/DiagnosticsFrontend.h"
+#include "swift/AST/FileSystem.h"
 #include "swift/AST/FileUnit.h"
 #include "swift/AST/Module.h"
 #include "swift/AST/TBDGenRequests.h"
@@ -29,6 +30,7 @@
 #include "llvm/IR/Mangler.h"
 #include "llvm/IR/ValueSymbolTable.h"
 #include "llvm/Support/FileSystem.h"
+#include "llvm/Support/VirtualOutputBackend.h"
 #include <vector>
 
 using namespace swift;
@@ -42,18 +44,13 @@ static std::vector<StringRef> sortSymbols(llvm::StringSet<> &symbols) {
 }
 
 bool swift::writeTBD(ModuleDecl *M, StringRef OutputFilename,
+                     llvm::vfs::OutputBackend &Backend,
                      const TBDGenOptions &Opts) {
-  std::error_code EC;
-  llvm::raw_fd_ostream OS(OutputFilename, EC, llvm::sys::fs::OF_None);
-  if (EC) {
-    M->getASTContext().Diags.diagnose(SourceLoc(), diag::error_opening_output,
-                                      OutputFilename, EC.message());
-    return true;
-  }
-
-  writeTBDFile(M, OS, Opts);
-
-  return false;
+  return withOutputPath(M->getDiags(), Backend, OutputFilename,
+                        [&](raw_ostream &OS) -> bool {
+                          writeTBDFile(M, OS, Opts);
+                          return false;
+                        });
 }
 
 static bool validateSymbols(DiagnosticEngine &diags,

lib/FrontendTool/TBD.h

@@ -18,6 +18,9 @@
 namespace llvm {
 class StringRef;
 class Module;
+namespace vfs {
+class OutputBackend;
+}
 }
 namespace swift {
 class ModuleDecl;
@@ -26,7 +29,7 @@ class FrontendOptions;
 struct TBDGenOptions;
 
 bool writeTBD(ModuleDecl *M, StringRef OutputFilename,
-              const TBDGenOptions &Opts);
+              llvm::vfs::OutputBackend &Backend, const TBDGenOptions &Opts);
 bool validateTBD(ModuleDecl *M,
                  const llvm::Module &IRModule,
                  const TBDGenOptions &opts,

test/Frontend/output_determinism_check.swift

@@ -1,6 +1,6 @@
 // RUN: %empty-directory(%t)
 // RUN: echo '[]' > %t/protocol.json
-// RUN: %target-swift-frontend -module-name test -emit-module -o %t/test.swiftmodule -primary-file %s  -emit-module-doc-path %t/test.docc -const-gather-protocols-file %t/protocol.json -emit-const-values-path %t/test.swiftconstvalues -enable-deterministic-check 2>&1 | %FileCheck %s --check-prefix=MODULE_OUTPUT --check-prefix=DOCC_OUTPUT --check-prefix=CONSTVALUE_OUTPUT
+// RUN: %target-swift-frontend -module-name test -emit-module -o %t/test.swiftmodule %s -emit-module-doc-path %t/test.docc -const-gather-protocols-file %t/protocol.json -emit-const-values-path %t/test.swiftconstvalues -emit-tbd-path %t/test.tbd -tbd-current-version 1 -tbd-compatibility-version 1 -tbd-install_name @rpath/test.dylib -enable-deterministic-check 2>&1 | %FileCheck %s --check-prefix=MODULE_OUTPUT --check-prefix=DOCC_OUTPUT --check-prefix=CONSTVALUE_OUTPUT --check-prefix=TBD_OUTPUT
 // RUN: %target-swift-frontend -module-name test -emit-sib -o %t/test.sib -primary-file %s -enable-deterministic-check 2>&1 | %FileCheck %s --check-prefix=SIB_OUTPUT
 
 /// object files are "not" deterministic because the second run going to match the mod hash and skip code generation.
@@ -28,6 +28,7 @@
 // DOCC_OUTPUT: remark: produced matching output file '{{.*}}{{/|\\}}test.docc'
 // CONSTVALUE_OUTPUT: remark: produced matching output file '{{.*}}{{/|\\}}test.swiftconstvalues'
 // MODULE_OUTPUT: remark: produced matching output file '{{.*}}{{/|\\}}test.swiftmodule'
+// TBD_OUTPUT: remark: produced matching output file '{{.*}}{{/|\\}}test.tbd'
 // SIB_OUTPUT: remark: produced matching output file '{{.*}}{{/|\\}}test.sib'
 // DEPS_OUTPUT: remark: produced matching output file '{{.*}}{{/|\\}}test.d'
 // OBJECT_OUTPUT: remark: produced matching output file '{{.*}}{{/|\\}}test.o'