Merge pull request #40368 from apple/revert-40357-obfuscate-searialized-paths

compnerd · web-flow · commit aebd77190c01 · 2021-12-02T12:26:09.000-08:00
Revert "serialization: obfuscate the serialized search paths"
diff --git a/include/swift/AST/FileUnit.h b/include/swift/AST/FileUnit.h
@@ -405,8 +405,6 @@ class LoadedFile : public FileUnit {
   virtual void collectBasicSourceFileInfo(
       llvm::function_ref<void(const BasicSourceFileInfo &)> callback) const {}
 
-  virtual void collectSerializedSearchPath(
-      llvm::function_ref<void(StringRef)> callback) const {}
   static bool classof(const FileUnit *file) {
     return file->getKind() == FileUnitKind::SerializedAST ||
            file->getKind() == FileUnitKind::ClangModule ||
diff --git a/include/swift/AST/Module.h b/include/swift/AST/Module.h
@@ -833,8 +833,6 @@ class ModuleDecl
   void collectBasicSourceFileInfo(
       llvm::function_ref<void(const BasicSourceFileInfo &)> callback) const;
 
-  void collectSerializedSearchPath(
-      llvm::function_ref<void(StringRef)> callback) const;
   /// Retrieve a fingerprint value that summarizes the contents of this module.
   ///
   /// This interface hash a of a module is guaranteed to change if the interface
diff --git a/include/swift/AST/SearchPathOptions.h b/include/swift/AST/SearchPathOptions.h
@@ -103,10 +103,6 @@ class SearchPathOptions {
   /// specified in LLDB from the target.source-map entries.
   PathRemapper SearchPathRemapper;
 
-  /// Recover the search paths deserialized from .swiftmodule files to their
-  /// original form.
-  PathObfuscator DeserializedPathRecoverer;
-
 private:
   static StringRef
   pathStringFromFrameworkSearchPath(const FrameworkSearchPath &next) {
diff --git a/include/swift/Basic/PathRemapper.h b/include/swift/Basic/PathRemapper.h
@@ -58,21 +58,6 @@ class PathRemapper {
   }
 };
 
-class PathObfuscator {
-  PathRemapper obfuscator, recoverer;
-public:
-  void addMapping(StringRef FromPrefix, StringRef ToPrefix) {
-    obfuscator.addMapping(FromPrefix, ToPrefix);
-    recoverer.addMapping(ToPrefix, FromPrefix);
-  }
-  std::string obfuscate(StringRef Path) const {
-    return obfuscator.remapPath(Path);
-  }
-  std::string recover(StringRef Path) const {
-    return recoverer.remapPath(Path);
-  }
-};
-
 } // end namespace swift
 
 #endif // SWIFT_BASIC_PATHREMAPPER_H
diff --git a/include/swift/Frontend/FrontendOptions.h b/include/swift/Frontend/FrontendOptions.h
@@ -15,7 +15,6 @@
 
 #include "swift/Basic/FileTypes.h"
 #include "swift/Basic/Version.h"
-#include "swift/Basic/PathRemapper.h"
 #include "swift/Frontend/FrontendInputsAndOutputs.h"
 #include "swift/Frontend/InputFile.h"
 #include "llvm/ADT/Hashing.h"
@@ -438,10 +437,6 @@ class FrontendOptions {
   /// Whether to include symbols with SPI information in the symbol graph.
   bool IncludeSPISymbolsInSymbolGraph = false;
 
-  /// This is used to obfuscate the serialized search paths so we don't have
-  /// to encode the actual paths into the .swiftmodule file.
-  PathObfuscator serializedPathObfuscator;
-
 private:
   static bool canActionEmitDependencies(ActionType);
   static bool canActionEmitReferenceDependencies(ActionType);
diff --git a/include/swift/Option/FrontendOptions.td b/include/swift/Option/FrontendOptions.td
@@ -165,10 +165,6 @@ def print_clang_stats : Flag<["-"], "print-clang-stats">,
 
 def serialize_debugging_options : Flag<["-"], "serialize-debugging-options">,
   HelpText<"Always serialize options for debugging (default: only for apps)">;
-
-def serialized_path_obfuscate : Separate<["-"], "serialized-path-obfuscate">,
-    HelpText<"Remap source paths in debug info">, MetaVarName<"<prefix=replacement>">;
-
 def no_serialize_debugging_options :
   Flag<["-"], "no-serialize-debugging-options">,
   HelpText<"Never serialize options for debugging (default: only for apps)">;
diff --git a/include/swift/Serialization/SerializationOptions.h b/include/swift/Serialization/SerializationOptions.h
@@ -45,10 +45,6 @@ namespace swift {
     /// Path prefixes that should be rewritten in debug info.
     PathRemapper DebuggingOptionsPrefixMap;
 
-    /// Obfuscate the serialized paths so we don't have the actual paths encoded
-    /// in the .swiftmodule file.
-    PathObfuscator PathObfuscator;
-
     /// Describes a single-file dependency for this module, along with the
     /// appropriate strategy for how to verify if it's up-to-date.
     class FileDependency {
diff --git a/include/swift/Serialization/SerializedModuleLoader.h b/include/swift/Serialization/SerializedModuleLoader.h
@@ -465,9 +465,6 @@ class SerializedASTFile final : public LoadedFile {
   virtual void collectBasicSourceFileInfo(
       llvm::function_ref<void(const BasicSourceFileInfo &)>) const override;
 
-  virtual void collectSerializedSearchPath(
-      llvm::function_ref<void(StringRef)> callback) const override;
-
   static bool classof(const FileUnit *file) {
     return file->getKind() == FileUnitKind::SerializedAST;
   }
diff --git a/include/swift/Serialization/Validation.h b/include/swift/Serialization/Validation.h
@@ -104,7 +104,7 @@ struct ValidationInfo {
 /// \sa validateSerializedAST()
 class ExtendedValidationInfo {
   SmallVector<StringRef, 4> ExtraClangImporterOpts;
-  std::string SDKPath;
+  StringRef SDKPath;
   StringRef ModuleABIName;
   struct {
     unsigned ArePrivateImportsEnabled : 1;
@@ -121,7 +121,7 @@ class ExtendedValidationInfo {
   ExtendedValidationInfo() : Bits() {}
 
   StringRef getSDKPath() const { return SDKPath; }
-  void setSDKPath(std::string path) {
+  void setSDKPath(StringRef path) {
     assert(SDKPath.empty());
     SDKPath = path;
   }
diff --git a/lib/AST/Module.cpp b/lib/AST/Module.cpp
@@ -1808,15 +1808,6 @@ void ModuleDecl::collectBasicSourceFileInfo(
   }
 }
 
-void ModuleDecl::collectSerializedSearchPath(
-    llvm::function_ref<void(StringRef)> callback) const {
-  for (const FileUnit *fileUnit : getFiles()) {
-    if (auto *serialized = dyn_cast<LoadedFile>(fileUnit)) {
-      serialized->collectSerializedSearchPath(callback);
-    }
-  }
-}
-
 Fingerprint ModuleDecl::getFingerprint() const {
   StableHasher hasher = StableHasher::defaultHasher();
   SmallVector<Fingerprint, 16> FPs;
diff --git a/lib/Frontend/ArgsToFrontendOptionsConverter.cpp b/lib/Frontend/ArgsToFrontendOptionsConverter.cpp
@@ -292,10 +292,6 @@ bool ArgsToFrontendOptionsConverter::convert(
 
   Opts.HermeticSealAtLink = Args.hasArg(OPT_experimental_hermetic_seal_at_link);
 
-  for (auto A : Args.getAllArgValues(options::OPT_serialized_path_obfuscate)) {
-    auto SplitMap = StringRef(A).split('=');
-    Opts.serializedPathObfuscator.addMapping(SplitMap.first, SplitMap.second);
-  }
   return false;
 }
 
diff --git a/lib/Frontend/CompilerInvocation.cpp b/lib/Frontend/CompilerInvocation.cpp
@@ -1214,11 +1214,6 @@ static bool ParseSearchPathArgs(SearchPathOptions &Opts,
     Opts.PlaceholderDependencyModuleMap = A->getValue();
   if (const Arg *A = Args.getLastArg(OPT_batch_scan_input_file))
     Opts.BatchScanInputFilePath = A->getValue();
-
-  for (auto A : Args.getAllArgValues(options::OPT_serialized_path_obfuscate)) {
-    auto SplitMap = StringRef(A).split('=');
-    Opts.DeserializedPathRecoverer.addMapping(SplitMap.first, SplitMap.second);
-  }
   // Opts.RuntimeIncludePath is set by calls to
   // setRuntimeIncludePath() or setMainExecutablePath().
   // Opts.RuntimeImportPath is set by calls to
diff --git a/lib/Frontend/Frontend.cpp b/lib/Frontend/Frontend.cpp
@@ -164,7 +164,6 @@ SerializationOptions CompilerInvocation::computeSerializationOptions(
       opts.SerializeOptionsForDebugging.getValueOr(
           !module->isExternallyConsumed());
 
-  serializationOpts.PathObfuscator = opts.serializedPathObfuscator;
   if (serializationOpts.SerializeOptionsForDebugging &&
       opts.DebugPrefixSerializedDebuggingOptions) {
     serializationOpts.DebuggingOptionsPrefixMap =
diff --git a/lib/Serialization/ModuleFile.cpp b/lib/Serialization/ModuleFile.cpp
@@ -361,7 +361,6 @@ ModuleFile::getModuleName(ASTContext &Ctx, StringRef modulePath,
   serialization::ValidationInfo loadInfo = ModuleFileSharedCore::load(
       modulePath.str(), std::move(newBuf), nullptr, nullptr,
       /*isFramework*/ isFramework, Ctx.SILOpts.EnableOSSAModules,
-      Ctx.SearchPathOpts.DeserializedPathRecoverer,
       loadedModuleFile);
   Name = loadedModuleFile->Name.str();
   return std::move(moduleBuf.get());
@@ -1000,13 +999,6 @@ Optional<CommentInfo> ModuleFile::getCommentForDecl(const Decl *D) const {
   return getCommentForDeclByUSR(USRBuffer.str());
 }
 
-void ModuleFile::collectSerializedSearchPath(
-    llvm::function_ref<void(StringRef)> callback) const {
-  for (auto path: Core->SearchPaths) {
-    callback(path.Path);
-  }
-}
-
 void ModuleFile::collectBasicSourceFileInfo(
     llvm::function_ref<void(const BasicSourceFileInfo &)> callback) const {
   if (Core->SourceFileListData.empty())
diff --git a/lib/Serialization/ModuleFile.h b/lib/Serialization/ModuleFile.h
@@ -743,8 +743,7 @@ class ModuleFile
   Optional<Fingerprint> loadFingerprint(const IterableDeclContext *IDC) const;
   void collectBasicSourceFileInfo(
       llvm::function_ref<void(const BasicSourceFileInfo &)> callback) const;
-  void collectSerializedSearchPath(
-      llvm::function_ref<void(StringRef)> callback) const;
+
 
   // MARK: Deserialization interface
 
diff --git a/lib/Serialization/ModuleFileSharedCore.cpp b/lib/Serialization/ModuleFileSharedCore.cpp
@@ -84,8 +84,7 @@ static bool enterTopLevelModuleBlock(llvm::BitstreamCursor &cursor,
 /// Returns true on success.
 static bool readOptionsBlock(llvm::BitstreamCursor &cursor,
                              SmallVectorImpl<uint64_t> &scratch,
-                             ExtendedValidationInfo &extendedInfo,
-                             PathObfuscator &pathRecoverer) {
+                             ExtendedValidationInfo &extendedInfo) {
   while (!cursor.AtEndOfStream()) {
     Expected<llvm::BitstreamEntry> maybeEntry = cursor.advance();
     if (!maybeEntry) {
@@ -120,7 +119,7 @@ static bool readOptionsBlock(llvm::BitstreamCursor &cursor,
     unsigned kind = maybeKind.get();
     switch (kind) {
     case options_block::SDK_PATH:
-      extendedInfo.setSDKPath(pathRecoverer.recover(blobData));
+      extendedInfo.setSDKPath(blobData);
       break;
     case options_block::XCC:
       extendedInfo.addExtraClangImporterOption(blobData);
@@ -172,8 +171,7 @@ static bool readOptionsBlock(llvm::BitstreamCursor &cursor,
 static ValidationInfo validateControlBlock(
     llvm::BitstreamCursor &cursor, SmallVectorImpl<uint64_t> &scratch,
     std::pair<uint16_t, uint16_t> expectedVersion, bool requiresOSSAModules,
-    ExtendedValidationInfo *extendedInfo,
-    PathObfuscator &pathRecoverer) {
+    ExtendedValidationInfo *extendedInfo) {
   // The control block is malformed until we've at least read a major version
   // number.
   ValidationInfo result;
@@ -204,7 +202,7 @@ static ValidationInfo validateControlBlock(
           result.status = Status::Malformed;
           return result;
         }
-        if (!readOptionsBlock(cursor, scratch, *extendedInfo, pathRecoverer)) {
+        if (!readOptionsBlock(cursor, scratch, *extendedInfo)) {
           result.status = Status::Malformed;
           return result;
         }
@@ -467,11 +465,10 @@ ValidationInfo serialization::validateSerializedAST(
         result.status = Status::Malformed;
         return result;
       }
-      PathObfuscator localObfuscator;
       result = validateControlBlock(
           cursor, scratch,
           {SWIFTMODULE_VERSION_MAJOR, SWIFTMODULE_VERSION_MINOR},
-          requiresOSSAModules, extendedInfo, localObfuscator);
+          requiresOSSAModules, extendedInfo);
       if (result.status == Status::Malformed)
         return result;
     } else if (dependencies &&
@@ -941,7 +938,7 @@ getActualImportControl(unsigned rawValue) {
   }
 }
 
-bool ModuleFileSharedCore::readModuleDocIfPresent(PathObfuscator &pathRecoverer) {
+bool ModuleFileSharedCore::readModuleDocIfPresent() {
   if (!this->ModuleDocInputBuffer)
     return true;
 
@@ -980,7 +977,7 @@ bool ModuleFileSharedCore::readModuleDocIfPresent(PathObfuscator &pathRecoverer)
       info = validateControlBlock(
           docCursor, scratch, {SWIFTDOC_VERSION_MAJOR, SWIFTDOC_VERSION_MINOR},
           RequiresOSSAModules,
-          /*extendedInfo*/ nullptr, pathRecoverer);
+          /*extendedInfo*/ nullptr);
       if (info.status != Status::Valid)
         return false;
       // Check that the swiftdoc is actually for this module.
@@ -1086,7 +1083,7 @@ bool ModuleFileSharedCore::readDeclLocsBlock(llvm::BitstreamCursor &cursor) {
   return false;
 }
 
-bool ModuleFileSharedCore::readModuleSourceInfoIfPresent(PathObfuscator &pathRecoverer) {
+bool ModuleFileSharedCore::readModuleSourceInfoIfPresent() {
   if (!this->ModuleSourceInfoInputBuffer)
     return true;
 
@@ -1124,8 +1121,7 @@ bool ModuleFileSharedCore::readModuleSourceInfoIfPresent(PathObfuscator &pathRec
           infoCursor, scratch,
           {SWIFTSOURCEINFO_VERSION_MAJOR, SWIFTSOURCEINFO_VERSION_MINOR},
           RequiresOSSAModules,
-          /*extendedInfo*/ nullptr,
-          pathRecoverer);
+          /*extendedInfo*/ nullptr);
       if (info.status != Status::Valid)
         return false;
       // Check that the swiftsourceinfo is actually for this module.
@@ -1200,7 +1196,7 @@ ModuleFileSharedCore::ModuleFileSharedCore(
     std::unique_ptr<llvm::MemoryBuffer> moduleDocInputBuffer,
     std::unique_ptr<llvm::MemoryBuffer> moduleSourceInfoInputBuffer,
     bool isFramework, bool requiresOSSAModules,
-    serialization::ValidationInfo &info, PathObfuscator &pathRecoverer)
+    serialization::ValidationInfo &info)
     : ModuleInputBuffer(std::move(moduleInputBuffer)),
       ModuleDocInputBuffer(std::move(moduleDocInputBuffer)),
       ModuleSourceInfoInputBuffer(std::move(moduleSourceInfoInputBuffer)),
@@ -1251,7 +1247,7 @@ ModuleFileSharedCore::ModuleFileSharedCore(
       info = validateControlBlock(
           cursor, scratch,
           {SWIFTMODULE_VERSION_MAJOR, SWIFTMODULE_VERSION_MINOR},
-          RequiresOSSAModules, &extInfo, pathRecoverer);
+          RequiresOSSAModules, &extInfo);
       if (info.status != Status::Valid) {
         error(info.status);
         return;
@@ -1376,8 +1372,7 @@ ModuleFileSharedCore::ModuleFileSharedCore(
           bool isSystem;
           input_block::SearchPathLayout::readRecord(scratch, isFramework,
                                                     isSystem);
-          SearchPaths.push_back({pathRecoverer.recover(blobData), isFramework,
-            isSystem});
+          SearchPaths.push_back({blobData, isFramework, isSystem});
           break;
         }
         case input_block::MODULE_INTERFACE_PATH: {
@@ -1577,8 +1572,8 @@ ModuleFileSharedCore::ModuleFileSharedCore(
     return;
   }
   // Read source info file.
-  readModuleSourceInfoIfPresent(pathRecoverer);
-  if (!readModuleDocIfPresent(pathRecoverer)) {
+  readModuleSourceInfoIfPresent();
+  if (!readModuleDocIfPresent()) {
     info.status = error(Status::MalformedDocumentation);
     return;
   }
diff --git a/lib/Serialization/ModuleFileSharedCore.h b/lib/Serialization/ModuleFileSharedCore.h
@@ -149,7 +149,7 @@ class ModuleFileSharedCore {
   SmallVector<Dependency, 8> Dependencies;
 
   struct SearchPath {
-    std::string Path;
+    StringRef Path;
     bool IsFramework;
     bool IsSystem;
   };
@@ -374,7 +374,7 @@ class ModuleFileSharedCore {
       std::unique_ptr<llvm::MemoryBuffer> moduleDocInputBuffer,
       std::unique_ptr<llvm::MemoryBuffer> moduleSourceInfoInputBuffer,
       bool isFramework, bool requiresOSSAModules,
-      serialization::ValidationInfo &info, PathObfuscator &pathRecoverer);
+      serialization::ValidationInfo &info);
 
   /// Change the status of the current module.
   Status error(Status issue) {
@@ -464,7 +464,7 @@ class ModuleFileSharedCore {
   /// Loads data from #ModuleDocInputBuffer.
   ///
   /// Returns false if there was an error.
-  bool readModuleDocIfPresent(PathObfuscator &pathRecoverer);
+  bool readModuleDocIfPresent();
 
   /// Reads the source loc block, which contains USR to decl location mapping.
   ///
@@ -474,7 +474,7 @@ class ModuleFileSharedCore {
   /// Loads data from #ModuleSourceInfoInputBuffer.
   ///
   /// Returns false if there was an error.
-  bool readModuleSourceInfoIfPresent(PathObfuscator &pathRecoverer);
+  bool readModuleSourceInfoIfPresent();
 
   /// Read an on-disk decl hash table stored in
   /// \c sourceinfo_block::DeclUSRSLayout format.
@@ -510,13 +510,12 @@ class ModuleFileSharedCore {
        std::unique_ptr<llvm::MemoryBuffer> moduleDocInputBuffer,
        std::unique_ptr<llvm::MemoryBuffer> moduleSourceInfoInputBuffer,
        bool isFramework, bool requiresOSSAModules,
-       PathObfuscator &pathRecoverer,
        std::shared_ptr<const ModuleFileSharedCore> &theModule) {
     serialization::ValidationInfo info;
     auto *core = new ModuleFileSharedCore(
         std::move(moduleInputBuffer), std::move(moduleDocInputBuffer),
         std::move(moduleSourceInfoInputBuffer), isFramework,
-        requiresOSSAModules, info, pathRecoverer);
+        requiresOSSAModules, info);
     if (!moduleInterfacePath.empty()) {
       ArrayRef<char> path;
       core->allocateBuffer(path, moduleInterfacePath);
diff --git a/lib/Serialization/Serialization.cpp b/lib/Serialization/Serialization.cpp
diff --git a/lib/Serialization/SerializedModuleLoader.cpp b/lib/Serialization/SerializedModuleLoader.cpp
diff --git a/test/Serialization/path_obfuscator.swift b/test/Serialization/path_obfuscator.swift
diff --git a/tools/swift-ide-test/swift-ide-test.cpp b/tools/swift-ide-test/swift-ide-test.cpp

Original file line number	Diff line number	Diff line change
`@@ -465,9 +465,6 @@ class SerializedASTFile final : public LoadedFile {`
`465`	`465`	`virtual void collectBasicSourceFileInfo(`
`466`	`466`	`llvm::function_ref<void(const BasicSourceFileInfo &)>) const override;`
`467`	`467`
`468`		`- virtual void collectSerializedSearchPath(`
`469`		`- llvm::function_ref<void(StringRef)> callback) const override;`
`470`		`-`
`471`	`468`	`static bool classof(const FileUnit *file) {`
`472`	`469`	`return file->getKind() == FileUnitKind::SerializedAST;`
`473`	`470`	`}`