Merge pull request swiftlang#29837 from hamishknight/request-tbd

Add top-level request for TBDGen

Author: hamishknight

include/swift/AST/FileUnit.h

@@ -369,6 +369,7 @@ class LoadedFile : public FileUnit {
   }
 };
 
+void simple_display(llvm::raw_ostream &out, const FileUnit *file);
 
 inline FileUnit &ModuleDecl::getMainFile(FileUnitKind expectedKind) const {
   assert(expectedKind != FileUnitKind::Source &&

include/swift/AST/TBDGenRequests.h

@@ -0,0 +1,124 @@
+//===--- TBDGenRequests.h - TBDGen Requests ---------------------*- C++ -*-===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2020 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+//
+//  This file defines TBDGen requests.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef SWIFT_TBDGEN_REQUESTS_H
+#define SWIFT_TBDGEN_REQUESTS_H
+
+#include "swift/AST/ASTTypeIDs.h"
+#include "swift/AST/SimpleRequest.h"
+
+namespace llvm {
+namespace MachO {
+class InterfaceFile;
+} // end namespace MachO
+
+template <class AllocatorTy>
+class StringSet;
+} // end namespace llvm
+
+namespace swift {
+
+class FileUnit;
+class ModuleDecl;
+struct TBDGenOptions;
+
+class TBDGenDescriptor final {
+  using FileOrModule = llvm::PointerUnion<FileUnit *, ModuleDecl *>;
+  FileOrModule Input;
+  const TBDGenOptions &Opts;
+
+  TBDGenDescriptor(FileOrModule input, const TBDGenOptions &opts)
+      : Input(input), Opts(opts) {
+    assert(input);
+  }
+
+public:
+  /// Returns the file or module we're emitting TBD for.
+  FileOrModule getFileOrModule() const { return Input; }
+
+  /// If the input is a single file, returns that file. Otherwise returns
+  /// \c nullptr.
+  FileUnit *getSingleFile() const;
+
+  /// Returns the parent module for TBD emission.
+  ModuleDecl *getParentModule() const;
+
+  /// Returns the TBDGen options.
+  const TBDGenOptions &getOptions() const { return Opts; }
+
+  bool operator==(const TBDGenDescriptor &other) const;
+  bool operator!=(const TBDGenDescriptor &other) const {
+    return !(*this == other);
+  }
+
+  static TBDGenDescriptor forFile(FileUnit *file, const TBDGenOptions &opts) {
+    return TBDGenDescriptor(file, opts);
+  }
+
+  static TBDGenDescriptor forModule(ModuleDecl *M, const TBDGenOptions &opts) {
+    return TBDGenDescriptor(M, opts);
+  }
+};
+
+llvm::hash_code hash_value(const TBDGenDescriptor &desc);
+void simple_display(llvm::raw_ostream &out, const TBDGenDescriptor &desc);
+SourceLoc extractNearestSourceLoc(const TBDGenDescriptor &desc);
+
+using TBDFileAndSymbols =
+    std::pair<llvm::MachO::InterfaceFile, llvm::StringSet<>>;
+
+/// Computes the TBD file and public symbols for a given module or file.
+class GenerateTBDRequest
+    : public SimpleRequest<GenerateTBDRequest,
+                           TBDFileAndSymbols(TBDGenDescriptor),
+                           CacheKind::Uncached> {
+public:
+  using SimpleRequest::SimpleRequest;
+
+private:
+  friend SimpleRequest;
+
+  // Evaluation.
+  llvm::Expected<TBDFileAndSymbols> evaluate(Evaluator &evaluator,
+                                             TBDGenDescriptor desc) const;
+};
+
+/// Report that a request of the given kind is being evaluated, so it
+/// can be recorded by the stats reporter.
+template <typename Request>
+void reportEvaluatedRequest(UnifiedStatsReporter &stats,
+                            const Request &request);
+
+/// The zone number for TBDGen.
+#define SWIFT_TYPEID_ZONE TBDGen
+#define SWIFT_TYPEID_HEADER "swift/AST/TBDGenTypeIDZone.def"
+#include "swift/Basic/DefineTypeIDZone.h"
+#undef SWIFT_TYPEID_ZONE
+#undef SWIFT_TYPEID_HEADER
+
+// Set up reporting of evaluated requests.
+#define SWIFT_REQUEST(Zone, RequestType, Sig, Caching, LocOptions)             \
+template<>                                                                     \
+inline void reportEvaluatedRequest(UnifiedStatsReporter &stats,                \
+                                   const RequestType &request) {               \
+  ++stats.getFrontendCounters().RequestType;                                   \
+}
+#include "swift/AST/TBDGenTypeIDZone.def"
+#undef SWIFT_REQUEST
+
+} // end namespace swift
+
+#endif // SWIFT_TBDGEN_REQUESTS_H

include/swift/AST/TBDGenTypeIDZone.def

@@ -0,0 +1,18 @@
+//===--- TBDGenTypeIDZone.def -----------------------------------*- C++ -*-===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2020 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+//
+//  This definition file describes the requests in TBDGen's zone.
+//
+//===----------------------------------------------------------------------===//
+
+SWIFT_REQUEST(TBDGen, GenerateTBDRequest, TBDFileAndSymbols(TBDGenDescriptor),
+              Uncached, NoLocationInfo)

include/swift/Basic/Statistics.def

@@ -300,4 +300,8 @@ FRONTEND_STATISTIC(IRModule, NumGOTEntries)
 /// the .o file you find on disk after the frontend exits.
 FRONTEND_STATISTIC(LLVM, NumLLVMBytesOutput)
 
+#define SWIFT_REQUEST(ZONE, NAME, Sig, Caching, LocOptions) FRONTEND_STATISTIC(TBDGen, NAME)
+#include "swift/AST/TBDGenTypeIDZone.def"
+#undef SWIFT_REQUEST
+
 #endif

include/swift/Basic/TypeID.h

@@ -38,6 +38,7 @@ enum class Zone : uint8_t {
   Parse                   = 8,
   TypeChecker             = 10,
   SILGen                  = 12,
+  TBDGen                  = 14,
   // N.B. This is not a formal zone and exists solely to support the unit tests.
   ArithmeticEvaluator     = 255,
 };

include/swift/IRGen/Linking.h

@@ -53,12 +53,10 @@ class UniversalLinkageInfo {
   /// be promoted to public external. Used by the LLDB expression evaluator.
   bool ForcePublicDecls;
 
-  bool IsWholeModule;
-
   explicit UniversalLinkageInfo(IRGenModule &IGM);
 
   UniversalLinkageInfo(const llvm::Triple &triple, bool hasMultipleIGMs,
-                       bool forcePublicDecls, bool isWholeModule);
+                       bool forcePublicDecls);
 
   /// In case of multiple llvm modules (in multi-threaded compilation) all
   /// private decls must be visible from other files.

include/swift/Subsystems.h

@@ -375,6 +375,12 @@ namespace swift {
   /// should call this functions after forming the ASTContext.
   void registerSILGenRequestFunctions(Evaluator &evaluator);
 
+  /// Register TBDGen-level request functions with the evaluator.
+  ///
+  /// Clients that form an ASTContext and will perform any TBD generation
+  /// should call this functions after forming the ASTContext.
+  void registerTBDGenRequestFunctions(Evaluator &evaluator);
+
   /// Register IDE-level request functions with the evaluator.
   ///
   /// The ASTContext will automatically call these upon construction.

include/swift/TBDGen/TBDGen.h

@@ -59,6 +59,32 @@ struct TBDGenOptions {
   /// Typically, these modules are static linked libraries. Thus their symbols
   /// are embeded in the current dylib.
   std::vector<std::string> embedSymbolsFromModules;
+
+  friend bool operator==(const TBDGenOptions &lhs, const TBDGenOptions &rhs) {
+    return lhs.HasMultipleIGMs == rhs.HasMultipleIGMs &&
+           lhs.IsInstallAPI == rhs.IsInstallAPI &&
+           lhs.LinkerDirectivesOnly == rhs.LinkerDirectivesOnly &&
+           lhs.InstallName == rhs.InstallName &&
+           lhs.ModuleLinkName == rhs.ModuleLinkName &&
+           lhs.CurrentVersion == rhs.CurrentVersion &&
+           lhs.CompatibilityVersion == rhs.CompatibilityVersion &&
+           lhs.ModuleInstallNameMapPath == rhs.ModuleInstallNameMapPath &&
+           lhs.embedSymbolsFromModules == rhs.embedSymbolsFromModules;
+  }
+
+  friend bool operator!=(const TBDGenOptions &lhs, const TBDGenOptions &rhs) {
+    return !(lhs == rhs);
+  }
+
+  friend llvm::hash_code hash_value(const TBDGenOptions &opts) {
+    using namespace llvm;
+    return hash_combine(
+        opts.HasMultipleIGMs, opts.IsInstallAPI, opts.LinkerDirectivesOnly,
+        opts.InstallName, opts.ModuleLinkName, opts.CurrentVersion,
+        opts.CompatibilityVersion, opts.ModuleInstallNameMapPath,
+        hash_combine_range(opts.embedSymbolsFromModules.begin(),
+                           opts.embedSymbolsFromModules.end()));
+  }
 };
 
 void enumeratePublicSymbols(FileUnit *module, llvm::StringSet<> &symbols,

lib/AST/Module.cpp

@@ -1895,6 +1895,28 @@ void FileUnit::getTopLevelDeclsWhereAttributesMatch(
   Results.erase(newEnd, Results.end());
 }
 
+void swift::simple_display(llvm::raw_ostream &out, const FileUnit *file) {
+  if (!file) {
+    out << "(null)";
+    return;
+  }
+
+  switch (file->getKind()) {
+  case FileUnitKind::Source:
+    out << '\"' << cast<SourceFile>(file)->getFilename() << '\"';
+    return;
+  case FileUnitKind::Builtin:
+    out << "(Builtin)";
+    return;
+  case FileUnitKind::DWARFModule:
+  case FileUnitKind::ClangModule:
+  case FileUnitKind::SerializedAST:
+    out << '\"' << cast<LoadedFile>(file)->getFilename() << '\"';
+    return;
+  }
+  llvm_unreachable("Unhandled case in switch");
+}
+
 StringRef LoadedFile::getFilename() const {
   return "";
 }

lib/Frontend/CMakeLists.txt

@@ -22,5 +22,6 @@ target_link_libraries(swiftFrontend PRIVATE
   swiftSILGen
   swiftSILOptimizer
   swiftSema
-  swiftSerialization)
+  swiftSerialization
+  swiftTBDGen)