Merge pull request #20170 from graydon/text-interface-to-module

Switch from .sid files to using FILE_DEPENDENCY records in INPUT_BLOCK

Author: graydon

include/swift/Basic/FileTypes.def

@@ -50,8 +50,6 @@ TYPE("swiftmodule",         SwiftModuleFile,           "swiftmodule",     "")
 TYPE("swiftdoc",            SwiftModuleDocFile,        "swiftdoc",        "")
 TYPE("swiftinterface",      SwiftParseableInterfaceFile, \
                                                        "swiftinterface",  "")
-TYPE("swiftinterfacedeps",  SwiftParseableInterfaceDeps, \
-                                                       "sid",             "")
 TYPE("assembly",            Assembly,                  "s",               "")
 TYPE("raw-sil",             RawSIL,                    "sil",             "")
 TYPE("raw-sib",             RawSIB,                    "sib",             "")

include/swift/Frontend/ParseableInterfaceSupport.h

@@ -49,6 +49,11 @@ bool emitParseableInterface(raw_ostream &out,
                             ParseableInterfaceOptions const &Opts,
                             ModuleDecl *M);
 
+/// Extract the specified-or-defaulted -module-cache-path that winds up in
+/// the clang importer, for reuse as the .swiftmodule cache path when
+/// building a ParseableInterfaceModuleLoader.
+std::string
+getModuleCachePathFromClang(const clang::CompilerInstance &Instance);
 
 /// A ModuleLoader that runs a subordinate \c CompilerInvocation and \c
 /// CompilerInstance to convert .swiftinterface files to .swiftmodule
@@ -66,8 +71,7 @@ class ParseableInterfaceModuleLoader : public SerializedModuleLoaderBase {
   void
   configureSubInvocationAndOutputPaths(CompilerInvocation &SubInvocation,
                                        StringRef InPath,
-                                       llvm::SmallString<128> &OutPath,
-                                       llvm::SmallString<128> &DepPath);
+                                       llvm::SmallString<128> &OutPath);
 
   std::error_code
   openModuleFiles(StringRef DirName, StringRef ModuleFilename,

include/swift/Serialization/ModuleFormat.h

@@ -52,7 +52,7 @@ const uint16_t SWIFTMODULE_VERSION_MAJOR = 0;
 /// describe what change you made. The content of this comment isn't important;
 /// it just ensures a conflict if two people change the module format.
 /// Don't worry about adhering to the 80-column limit for this line.
-const uint16_t SWIFTMODULE_VERSION_MINOR = 456; // Last change: encode depth in generic param XREFs
+const uint16_t SWIFTMODULE_VERSION_MINOR = 458; // Last change: enrich FILE_DEPENDENCY records.
 
 using DeclIDField = BCFixed<31>;
 
@@ -630,7 +630,8 @@ namespace input_block {
     IMPORTED_HEADER,
     IMPORTED_HEADER_CONTENTS,
     MODULE_FLAGS, // [unused]
-    SEARCH_PATH
+    SEARCH_PATH,
+    FILE_DEPENDENCY
   };
 
   using ImportedModuleLayout = BCRecordLayout<
@@ -668,6 +669,13 @@ namespace input_block {
     BCFixed<1>, // system?
     BCBlob      // path
   >;
+
+  using FileDependencyLayout = BCRecordLayout<
+    FILE_DEPENDENCY,
+    FileSizeField,    // file size (for validation)
+    FileModTimeField, // file mtime (for validation)
+    BCBlob            // path
+  >;
 }
 
 /// The record types within the "decls-and-types" block.

include/swift/Serialization/SerializationOptions.h

@@ -35,6 +35,13 @@ namespace swift {
     StringRef ModuleLinkName;
     ArrayRef<std::string> ExtraClangOptions;
 
+    struct FileDependency {
+      uint64_t Size;
+      llvm::sys::TimePoint<> LastModTime;
+      StringRef Path;
+    };
+    ArrayRef<FileDependency> Dependencies;
+
     bool AutolinkForceLoad = false;
     bool EnableNestedTypeLookupTable = false;
     bool SerializeAllSIL = false;

include/swift/Serialization/Validation.h

@@ -14,6 +14,7 @@
 #define SWIFT_SERIALIZATION_VALIDATION_H
 
 #include "swift/Basic/LLVM.h"
+#include "swift/Serialization/SerializationOptions.h"
 #include "llvm/ADT/ArrayRef.h"
 #include "llvm/ADT/SmallVector.h"
 #include "llvm/ADT/StringRef.h"
@@ -144,9 +145,12 @@ class ExtendedValidationInfo {
 /// \param[out] extendedInfo If present, will be populated with additional
 /// compilation options serialized into the AST at build time that may be
 /// necessary to load it properly.
-ValidationInfo
-validateSerializedAST(StringRef data,
-                      ExtendedValidationInfo *extendedInfo = nullptr);
+/// \param[out] dependencies If present, will be populated with list of
+/// input files the module depends on, if present in INPUT_BLOCK.
+ValidationInfo validateSerializedAST(
+    StringRef data, ExtendedValidationInfo *extendedInfo = nullptr,
+    SmallVectorImpl<SerializationOptions::FileDependency> *dependencies =
+        nullptr);
 
 /// Emit diagnostics explaining a failure to load a serialized AST.
 ///

lib/Basic/FileTypes.cpp

@@ -79,7 +79,6 @@ bool file_types::isTextual(ID Id) {
   case file_types::TY_ModuleTrace:
   case file_types::TY_OptRecord:
   case file_types::TY_SwiftParseableInterfaceFile:
-  case file_types::TY_SwiftParseableInterfaceDeps:
     return true;
   case file_types::TY_Image:
   case file_types::TY_Object:
@@ -136,7 +135,6 @@ bool file_types::isAfterLLVM(ID Id) {
   case file_types::TY_ModuleTrace:
   case file_types::TY_OptRecord:
   case file_types::TY_SwiftParseableInterfaceFile:
-  case file_types::TY_SwiftParseableInterfaceDeps:
     return false;
   case file_types::TY_INVALID:
     llvm_unreachable("Invalid type ID.");
@@ -169,7 +167,6 @@ bool file_types::isPartOfSwiftCompilation(ID Id) {
   case file_types::TY_SwiftModuleFile:
   case file_types::TY_SwiftModuleDocFile:
   case file_types::TY_SwiftParseableInterfaceFile:
-  case file_types::TY_SwiftParseableInterfaceDeps:
   case file_types::TY_SerializedDiagnostics:
   case file_types::TY_ClangModuleFile:
   case file_types::TY_SwiftDeps:

lib/Driver/Driver.cpp

@@ -1783,7 +1783,6 @@ void Driver::buildActions(SmallVectorImpl<const Action *> &TopLevelActions,
       case file_types::TY_ModuleTrace:
       case file_types::TY_OptRecord:
       case file_types::TY_SwiftParseableInterfaceFile:
-      case file_types::TY_SwiftParseableInterfaceDeps:
         // We could in theory handle assembly or LLVM input, but let's not.
         // FIXME: What about LTO?
         Diags.diagnose(SourceLoc(), diag::error_unexpected_input_file,

lib/Driver/ToolChains.cpp

@@ -440,7 +440,6 @@ const char *ToolChain::JobContext::computeFrontendModeForCompile() const {
   case file_types::TY_TBD:
   case file_types::TY_OptRecord:
   case file_types::TY_SwiftParseableInterfaceFile:
-  case file_types::TY_SwiftParseableInterfaceDeps:
     llvm_unreachable("Output type can never be primary output.");
   case file_types::TY_INVALID:
     llvm_unreachable("Invalid type ID");
@@ -673,7 +672,6 @@ ToolChain::constructInvocation(const BackendJobAction &job,
     case file_types::TY_ModuleTrace:
     case file_types::TY_OptRecord:
     case file_types::TY_SwiftParseableInterfaceFile:
-    case file_types::TY_SwiftParseableInterfaceDeps:
       llvm_unreachable("Output type can never be primary output.");
     case file_types::TY_INVALID:
       llvm_unreachable("Invalid type ID");

lib/Frontend/Frontend.cpp

@@ -36,9 +36,6 @@
 #include "llvm/Support/CommandLine.h"
 #include "llvm/Support/MemoryBuffer.h"
 #include "llvm/Support/Path.h"
-#include "clang/Frontend/CompilerInstance.h"
-#include "clang/Lex/Preprocessor.h"
-#include "clang/Lex/HeaderSearch.h"
 
 using namespace swift;
 
@@ -308,20 +305,8 @@ bool CompilerInstance::setUpModuleLoaders() {
       Diagnostics.diagnose(SourceLoc(), diag::error_clang_importer_create_fail);
       return true;
     }
-    // Capture the specified-or-defaulted -module-cache-path that winds up in
-    // the clang importer, for reuse as the .swiftmodule cache path when
-    // building the ParseableInterfaceModuleLoader below.
-    //
-    // The returned-from-clang module cache path includes a suffix directory
-    // that is specific to the clang version and invocation; we want the
-    // directory above that.
     auto const &Clang = clangImporter->getClangInstance();
-    if (Clang.hasPreprocessor()) {
-      std::string SpecificModuleCachePath = Clang.getPreprocessor()
-                                                .getHeaderSearchInfo()
-                                                .getModuleCachePath();
-      ModuleCachePath = llvm::sys::path::parent_path(SpecificModuleCachePath);
-    }
+    ModuleCachePath = getModuleCachePathFromClang(Clang);
     Context->addModuleLoader(std::move(clangImporter), /*isClang*/ true);
   }
   if (Invocation.getFrontendOptions().EnableParseableModuleInterface) {