[LL FIR] KT-57314 Combine Kotlin symbol providers

- `LLFirCombinedKotlinSymbolProvider` combines multiple `LLFirProvider$SymbolProvider`s. Its advantages are: combined "names in package" optimization, caching, combined index access, classpath order disambiguation. - Scopes can still be optimized with a combined scope instead of a naive union scope. ^KT-57314 fixed
2023-03-22 18:32:04 +01:00
parent 16af67e99c
commit 29276d94ca
3 changed files with 182 additions and 5 deletions
@@ -0,0 +1,172 @@
+/*
+ * Copyright 2010-2023 JetBrains s.r.o. and Kotlin Programming Language contributors.
+ * Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file.
+ */
+
+package org.jetbrains.kotlin.analysis.low.level.api.fir.providers
+
+import com.intellij.openapi.project.Project
+import com.intellij.psi.search.GlobalSearchScope
+import org.jetbrains.kotlin.analysis.low.level.api.fir.project.structure.llFirModuleData
+import org.jetbrains.kotlin.analysis.low.level.api.fir.util.LLFirSymbolProviderNameCache
+import org.jetbrains.kotlin.analysis.project.structure.KtModule
+import org.jetbrains.kotlin.analysis.project.structure.ProjectStructureProvider
+import org.jetbrains.kotlin.analysis.project.structure.getKtModule
+import org.jetbrains.kotlin.analysis.providers.KotlinDeclarationProvider
+import org.jetbrains.kotlin.analysis.providers.createDeclarationProvider
+import org.jetbrains.kotlin.fir.FirSession
+import org.jetbrains.kotlin.fir.resolve.providers.FirSymbolProvider
+import org.jetbrains.kotlin.fir.resolve.providers.FirSymbolProviderInternals
+import org.jetbrains.kotlin.fir.symbols.impl.FirCallableSymbol
+import org.jetbrains.kotlin.fir.symbols.impl.FirClassLikeSymbol
+import org.jetbrains.kotlin.fir.symbols.impl.FirNamedFunctionSymbol
+import org.jetbrains.kotlin.fir.symbols.impl.FirPropertySymbol
+import org.jetbrains.kotlin.name.CallableId
+import org.jetbrains.kotlin.name.ClassId
+import org.jetbrains.kotlin.name.FqName
+import org.jetbrains.kotlin.name.Name
+import org.jetbrains.kotlin.psi.KtClassLikeDeclaration
+import org.jetbrains.kotlin.psi.KtFile
+import org.jetbrains.kotlin.utils.mapToIndex
+
+/**
+ * [LLFirCombinedKotlinSymbolProvider] combines multiple [LLFirProvider.SymbolProvider]s with the following advantages:
+ *
+ * - The combined symbol provider can combine the "names in package" sets built by individual providers. The name set can then be checked
+ *   once instead of for each subordinate symbol provider. Because Kotlin symbol providers are ordered first in
+ *   [LLFirDependenciesSymbolProvider], this check is especially fruitful.
+ * - For a given class or callable ID, indices can be accessed once to get relevant PSI elements. Then the correct symbol provider(s) to
+ *   call can be found out via the PSI element's [KtModule]s. This avoids the need to call every single subordinate symbol provider.
+ * - TODO (marco): Another layer of caching can be provided, perhaps with an LRU cache.
+ *
+ * [declarationProvider] must have a scope which combines the scopes of the individual [providers].
+ */
+internal class LLFirCombinedKotlinSymbolProvider(
+    session: FirSession,
+    private val project: Project,
+    private val providers: List<LLFirProvider.SymbolProvider>,
+    private val declarationProvider: KotlinDeclarationProvider,
+) : FirSymbolProvider(session) {
+    private val providersByKtModule: Map<KtModule, LLFirProvider.SymbolProvider> =
+        providers
+            .groupBy { it.session.llFirModuleData.ktModule }
+            .mapValues { (module, list) -> list.singleOrNull() ?: error("$module must have a unique Kotlin symbol providers.") }
+
+    /**
+     * [KtModule] precedence must be checked in case the index finds multiple elements and classpath order needs to be preserved.
+     */
+    private val modulePrecedenceMap: Map<KtModule, Int> = providers.map { it.session.llFirModuleData.ktModule }.mapToIndex()
+
+    /**
+     * Cache [ProjectStructureProvider] to avoid service access when getting [KtModule]s.
+     */
+    private val projectStructureProvider: ProjectStructureProvider = project.getService(ProjectStructureProvider::class.java)
+
+    private val symbolNameCache = object : LLFirSymbolProviderNameCache(session) {
+        override fun computeClassifierNames(packageFqName: FqName): Set<String>? = buildSet {
+            providers.forEach { addAll(it.knownTopLevelClassifiersInPackage(packageFqName) ?: return null) }
+        }
+
+        override fun computeCallableNames(packageFqName: FqName): Set<Name>? = buildSet {
+            providers.forEach { addAll(it.computeCallableNamesInPackage(packageFqName) ?: return null) }
+        }
+    }
+
+    @OptIn(FirSymbolProviderInternals::class)
+    override fun getClassLikeSymbolByClassId(classId: ClassId): FirClassLikeSymbol<*>? {
+        if (!symbolNameCache.mayHaveTopLevelClassifier(classId, mayHaveFunctionClass = false)) return null
+
+        val candidates = declarationProvider.getAllClassesByClassId(classId) + declarationProvider.getAllTypeAliasesByClassId(classId)
+        if (candidates.isEmpty()) return null
+
+        // Find the `KtClassLikeDeclaration` with the highest module precedence. (We're using a custom implementation instead of `minBy` so
+        // that `ktModule` doesn't need to be fetched twice.)
+        // TODO (marco): This algorithm can be applied to other combined symbol providers as well, such as Java symbol providers.
+        var ktClassCandidate: KtClassLikeDeclaration? = null
+        var currentPrecedence: Int = Int.MAX_VALUE
+        var ktModule: KtModule? = null
+
+        candidates.forEach { candidate ->
+            val candidateKtModule = projectStructureProvider.getKtModuleForKtElement(candidate)
+
+            // If `candidateKtModule` cannot be found in the map, `candidate` cannot be processed by any of the available providers, because
+            // none of them belong to the correct module. We can skip in that case, because iterating through all providers wouldn't lead to
+            // any results for `candidate`.
+            val precedence = modulePrecedenceMap[candidateKtModule] ?: return@forEach
+            if (precedence < currentPrecedence) {
+                ktClassCandidate = candidate
+                currentPrecedence = precedence
+                ktModule = candidateKtModule
+            }
+        }
+
+        val ktClass = ktClassCandidate ?: return null
+
+        // The provider will always be found at this point, because `modulePrecedenceMap` contains the same keys as `providersByKtModule`
+        // and a precedence for `ktModule` must have been found in the previous step.
+        return providersByKtModule[ktModule]!!.getClassLikeSymbolByClassId(classId, ktClass)
+    }
+
+    @FirSymbolProviderInternals
+    override fun getTopLevelCallableSymbolsTo(destination: MutableList<FirCallableSymbol<*>>, packageFqName: FqName, name: Name) {
+        forEachCallableProvider(packageFqName, name) { callableId, callableFiles ->
+            getTopLevelCallableSymbolsTo(destination, callableId, callableFiles)
+        }
+    }
+
+    @FirSymbolProviderInternals
+    override fun getTopLevelFunctionSymbolsTo(destination: MutableList<FirNamedFunctionSymbol>, packageFqName: FqName, name: Name) {
+        forEachCallableProvider(packageFqName, name) { callableId, callableFiles ->
+            getTopLevelFunctionSymbolsTo(destination, callableId, callableFiles)
+        }
+    }
+
+    @FirSymbolProviderInternals
+    override fun getTopLevelPropertySymbolsTo(destination: MutableList<FirPropertySymbol>, packageFqName: FqName, name: Name) {
+        forEachCallableProvider(packageFqName, name) { callableId, callableFiles ->
+            getTopLevelPropertySymbolsTo(destination, callableId, callableFiles)
+        }
+    }
+
+    /**
+     * Calls [provide] on those providers which can contribute a callable of the given name.
+     */
+    private fun forEachCallableProvider(
+        packageFqName: FqName,
+        name: Name,
+        provide: LLFirProvider.SymbolProvider.(CallableId, Collection<KtFile>) -> Unit,
+    ) {
+        if (!symbolNameCache.mayHaveTopLevelCallable(packageFqName, name)) return
+
+        val callableId = CallableId(packageFqName, name)
+
+        declarationProvider.getTopLevelCallableFiles(callableId)
+            .groupBy { it.getKtModule(project) }
+            .forEach { (ktModule, ktFiles) ->
+                // If `ktModule` cannot be found in the map, `ktFiles` cannot be processed by any of the available providers, because none
+                // of them belong to the correct module. We can skip in that case, because iterating through all providers wouldn't lead to
+                // any results for `ktFiles`.
+                val provider = providersByKtModule[ktModule] ?: return@forEach
+                provider.provide(callableId, ktFiles)
+            }
+    }
+
+    override fun getPackage(fqName: FqName): FqName? = providers.firstNotNullOfOrNull { it.getPackage(fqName) }
+
+    override fun computePackageSetWithTopLevelCallables(): Set<String>? = null
+
+    override fun knownTopLevelClassifiersInPackage(packageFqName: FqName): Set<String>? =
+        symbolNameCache.getTopLevelClassifierNamesInPackage(packageFqName)
+
+    override fun computeCallableNamesInPackage(packageFqName: FqName): Set<Name>? =
+        symbolNameCache.getTopLevelCallableNamesInPackage(packageFqName)
+
+    companion object {
+        fun merge(session: FirSession, project: Project, providers: List<LLFirProvider.SymbolProvider>): FirSymbolProvider? =
+            if (providers.size > 1) {
+                val combinedScope = GlobalSearchScope.union(providers.map { it.session.llFirModuleData.ktModule.contentScope })
+                val declarationProvider = project.createDeclarationProvider(combinedScope)
+                LLFirCombinedKotlinSymbolProvider(session, project, providers, declarationProvider)
+            } else providers.singleOrNull()
+    }
+}
@@ -109,7 +109,7 @@ internal class LLFirProvider(
        declarationProvider.getTopLevelKotlinClassLikeDeclarationNamesInPackage(fqName)

    @NoMutableState
-    private inner class SymbolProvider : FirSymbolProvider(session) {
+    internal inner class SymbolProvider : FirSymbolProvider(session) {
        override fun getClassLikeSymbolByClassId(classId: ClassId): FirClassLikeSymbol<*>? {
            if (!providerHelper.symbolNameCache.mayHaveTopLevelClassifier(classId, mayHaveFunctionClass = false)) return null
            return getFirClassifierByFqName(classId)?.symbol
@@ -13,6 +13,7 @@ import com.intellij.psi.util.CachedValue
 import com.intellij.psi.util.CachedValueProvider
 import com.intellij.psi.util.CachedValuesManager
 import com.intellij.util.containers.CollectionFactory
+import java.util.concurrent.ConcurrentMap
 import org.jetbrains.kotlin.analysis.low.level.api.fir.LLFirGlobalResolveComponents
 import org.jetbrains.kotlin.analysis.low.level.api.fir.LLFirLazyDeclarationResolver
 import org.jetbrains.kotlin.analysis.low.level.api.fir.LLFirModuleResolveComponents
@@ -48,8 +49,9 @@ import org.jetbrains.kotlin.platform.jvm.JvmPlatforms
 import org.jetbrains.kotlin.psi.KtFile
 import org.jetbrains.kotlin.resolve.jvm.modules.JavaModuleResolver
 import org.jetbrains.kotlin.resolve.jvm.platform.JvmPlatformAnalyzerServices
+import org.jetbrains.kotlin.analysis.providers.KotlinDeclarationProvider
 import org.jetbrains.kotlin.utils.addToStdlib.partitionIsInstance
-import java.util.concurrent.ConcurrentMap
+import org.jetbrains.kotlin.utils.addIfNotNull

@OptIn(PrivateSessionConstructor::class, SessionConfiguration::class)
 internal class LLFirSessionCache(private val project: Project) {
@@ -536,10 +538,13 @@ internal class LLFirSessionCache(private val project: Project) {
        session: FirSession,
        destination: MutableList<FirSymbolProvider>,
    ) {
-        val (syntheticFunctionSymbolProviders, remainingSymbolProviders1) =
-            partitionIsInstance<_, FirExtensionSyntheticFunctionInterfaceProvider>()
+        val (kotlinSymbolProviders, remainingSymbolProviders1) = partitionIsInstance<_, LLFirProvider.SymbolProvider>()
+        destination.addIfNotNull(LLFirCombinedKotlinSymbolProvider.merge(session, project, kotlinSymbolProviders))

-        destination.addAll(remainingSymbolProviders1)
+        val (syntheticFunctionSymbolProviders, remainingSymbolProviders2) =
+            remainingSymbolProviders1.partitionIsInstance<_, FirExtensionSyntheticFunctionInterfaceProvider>()
+
+        destination.addAll(remainingSymbolProviders2)

        // Unfortunately, the functions that an extension synthetic function symbol provider might provide differ between sessions because
        // they depend on compiler plugins. However, only extension providers that are affected by compiler plugins are added in