Swift: Assign indexes to fileprivate ValueDecls

At least in the case of function declarations there can be multiple
identical ones within the same module, causing data set check errors
if not differentiated.

Author: jketema

swift/extractor/mangler/SwiftMangler.cpp

@@ -40,8 +40,8 @@ std::string_view getTypeKindStr(const swift::TypeBase* type) {
 
 }  // namespace
 
-std::unordered_map<const swift::Decl*, SwiftMangler::ExtensionIndex>
-    SwiftMangler::preloadedExtensionIndexes;
+std::unordered_map<const swift::Decl*, SwiftMangler::ExtensionOrFilePrivateValueIndex>
+    SwiftMangler::preloadedExtensionOrFilePrivateValueIndexes;
 
 SwiftMangledName SwiftMangler::initMangled(const swift::TypeBase* type) {
   return {getTypeKindStr(type), '_'};
@@ -75,6 +75,11 @@ SwiftMangledName SwiftMangler::visitValueDecl(const swift::ValueDecl* decl, bool
   if (decl->isStatic()) {
     ret << "|static";
   }
+  if (decl->getFormalAccess() == swift::AccessLevel::FilePrivate) {
+    auto parent = getParent(decl);
+    auto index = getExtensionofFilePrivateValueIndex(decl, parent);
+    ret << "|fileprivate" << index.index;
+  }
   return ret;
 }
 
@@ -105,17 +110,18 @@ SwiftMangledName SwiftMangler::visitExtensionDecl(const swift::ExtensionDecl* de
 
   auto parent = getParent(decl);
   auto target = decl->getExtendedType();
-  auto index = getExtensionIndex(decl, parent);
+  auto index = getExtensionofFilePrivateValueIndex(decl, parent);
   return initMangled(decl) << fetch(target) << index.index
                            << (index.kind == ExtensionKind::clang ? "_clang" : "");
 }
 
-SwiftMangler::ExtensionIndex SwiftMangler::getExtensionIndex(const swift::ExtensionDecl* decl,
-                                                             const swift::Decl* parent) {
-  // to avoid iterating multiple times on the parent of multiple extensions, we preload extension
-  // indexes once for each encountered parent into the `preloadedExtensionIndexes` mapping.
-  if (auto found = SwiftMangler::preloadedExtensionIndexes.find(decl);
-      found != SwiftMangler::preloadedExtensionIndexes.end()) {
+SwiftMangler::ExtensionOrFilePrivateValueIndex SwiftMangler::getExtensionofFilePrivateValueIndex(
+    const swift::Decl* decl,
+    const swift::Decl* parent) {
+  // to avoid iterating multiple times on the parent, we preload the indexes once for each
+  // encountered parent.
+  if (auto found = SwiftMangler::preloadedExtensionOrFilePrivateValueIndexes.find(decl);
+      found != SwiftMangler::preloadedExtensionOrFilePrivateValueIndexes.end()) {
     return found->second;
   }
   if (auto parentModule = llvm::dyn_cast<swift::ModuleDecl>(parent)) {
@@ -131,18 +137,25 @@ SwiftMangler::ExtensionIndex SwiftMangler::getExtensionIndex(const swift::Extens
     // TODO use a generic logging handle for Swift entities here, once it's available
     CODEQL_ASSERT(false, "non-local context must be module or iterable decl context");
   }
-  auto found = SwiftMangler::preloadedExtensionIndexes.find(decl);
+  auto found = SwiftMangler::preloadedExtensionOrFilePrivateValueIndexes.find(decl);
   // TODO use a generic logging handle for Swift entities here, once it's available
-  CODEQL_ASSERT(found != SwiftMangler::preloadedExtensionIndexes.end(),
-                "extension not found within parent");
+  CODEQL_ASSERT(found != SwiftMangler::preloadedExtensionOrFilePrivateValueIndexes.end(),
+                "declaration not found within parent");
   return found->second;
 }
 
 void SwiftMangler::indexExtensions(llvm::ArrayRef<swift::Decl*> siblings) {
   auto index = 0u;
   for (auto sibling : siblings) {
     if (sibling->getKind() == swift::DeclKind::Extension) {
-      SwiftMangler::preloadedExtensionIndexes.try_emplace(sibling, ExtensionKind::swift, index);
+      SwiftMangler::preloadedExtensionOrFilePrivateValueIndexes.try_emplace(
+          sibling, ExtensionKind::swift, index);
+      index++;
+    } else if (swift::isa<swift::ValueDecl>(sibling) &&
+               swift::dyn_cast<swift::ValueDecl>(sibling)->getFormalAccess() ==
+                   swift::AccessLevel::FilePrivate) {
+      SwiftMangler::preloadedExtensionOrFilePrivateValueIndexes.try_emplace(
+          sibling, ExtensionKind::swift, index);
       index++;
     }
   }
@@ -161,7 +174,8 @@ void SwiftMangler::indexClangExtensions(const clang::Module* clangModule,
       swiftSubmodule->getTopLevelDecls(children);
       for (const auto child : children) {
         if (child->getKind() == swift::DeclKind::Extension) {
-          SwiftMangler::preloadedExtensionIndexes.try_emplace(child, ExtensionKind::clang, index);
+          SwiftMangler::preloadedExtensionOrFilePrivateValueIndexes.try_emplace(
+              child, ExtensionKind::clang, index);
           index++;
         }
       }

swift/extractor/mangler/SwiftMangler.h

@@ -112,12 +112,13 @@ class SwiftMangler : private swift::TypeVisitor<SwiftMangler, SwiftMangledName>,
     clang,
   };
 
-  struct ExtensionIndex {
+  struct ExtensionOrFilePrivateValueIndex {
     const ExtensionKind kind : 1;
     const uint32_t index : 31;
   };
 
-  static std::unordered_map<const swift::Decl*, ExtensionIndex> preloadedExtensionIndexes;
+  static std::unordered_map<const swift::Decl*, ExtensionOrFilePrivateValueIndex>
+      preloadedExtensionOrFilePrivateValueIndexes;
 
   virtual SwiftMangledName fetch(const swift::Decl* decl) = 0;
   virtual SwiftMangledName fetch(const swift::TypeBase* type) = 0;
@@ -126,7 +127,8 @@ class SwiftMangler : private swift::TypeVisitor<SwiftMangler, SwiftMangledName>,
   void indexExtensions(llvm::ArrayRef<swift::Decl*> siblings);
   void indexClangExtensions(const clang::Module* clangModule,
                             swift::ClangModuleLoader* moduleLoader);
-  ExtensionIndex getExtensionIndex(const swift::ExtensionDecl* decl, const swift::Decl* parent);
+  ExtensionOrFilePrivateValueIndex getExtensionofFilePrivateValueIndex(const swift::Decl* decl,
+                                                                       const swift::Decl* parent);
   static SwiftMangledName initMangled(const swift::TypeBase* type);
   SwiftMangledName initMangled(const swift::Decl* decl);
   SwiftMangledName visitTypeDiscriminatedValueDecl(const swift::ValueDecl* decl);