[FIR/Native] Move fir-related code from backend.native module to new one

^KT-61249
This commit is contained in:
Pavel Kunyavskiy
2023-08-16 11:22:08 +02:00
committed by Space Team
parent fdab636a1b
commit 8bcd1f4efa
16 changed files with 103 additions and 47 deletions
+18
View File
@@ -0,0 +1,18 @@
plugins {
kotlin("jvm")
id("jps-compatible")
}
dependencies {
implementation(project(":core:compiler.common.native"))
implementation(project(":compiler:frontend.common"))
implementation(project(":compiler:fir:resolve"))
implementation(project(":compiler:fir:fir2ir"))
implementation(project(":compiler:ir.serialization.common"))
}
sourceSets {
"main" { projectDefault() }
"test" {}
}
@@ -0,0 +1,121 @@
/*
* 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.fir.backend.native
import org.jetbrains.kotlin.backend.common.serialization.mangle.KotlinExportChecker
import org.jetbrains.kotlin.backend.common.serialization.mangle.KotlinMangleComputer
import org.jetbrains.kotlin.backend.common.serialization.mangle.MangleMode
import org.jetbrains.kotlin.backend.common.serialization.mangle.SpecialDeclarationType
import org.jetbrains.kotlin.fir.FirSession
import org.jetbrains.kotlin.fir.backend.FirMangler
import org.jetbrains.kotlin.fir.backend.FirExportCheckerVisitor
import org.jetbrains.kotlin.fir.backend.FirMangleComputer
import org.jetbrains.kotlin.fir.backend.native.interop.*
import org.jetbrains.kotlin.fir.backend.native.interop.hasObjCFactoryAnnotation
import org.jetbrains.kotlin.fir.backend.native.interop.hasObjCMethodAnnotation
import org.jetbrains.kotlin.fir.backend.native.interop.isObjCClassMethod
import org.jetbrains.kotlin.fir.declarations.*
import org.jetbrains.kotlin.fir.isSubstitutionOrIntersectionOverride
import org.jetbrains.kotlin.fir.resolve.ScopeSession
import org.jetbrains.kotlin.fir.symbols.impl.FirClassLikeSymbol
import org.jetbrains.kotlin.fir.symbols.impl.FirTypeParameterSymbol
import org.jetbrains.kotlin.fir.types.coneType
import org.jetbrains.kotlin.fir.types.toSymbol
import org.jetbrains.kotlin.name.NativeRuntimeNames
class FirNativeKotlinMangler : FirMangler() {
override fun getMangleComputer(mode: MangleMode, compatibleMode: Boolean): KotlinMangleComputer<FirDeclaration> {
return FirNativeKotlinMangleComputer(StringBuilder(256), mode)
}
override fun getExportChecker(compatibleMode: Boolean): KotlinExportChecker<FirDeclaration> = FirNativeExportCheckerVisitor()
override fun FirDeclaration.isExported(compatibleMode: Boolean): Boolean =
getExportChecker(compatibleMode).check(this, SpecialDeclarationType.REGULAR)
}
class FirNativeExportCheckerVisitor : FirExportCheckerVisitor() {
/**
* mimics AbstractKonanDescriptorMangler::DeclarationDescriptor.isPlatformSpecificExport()
*/
override fun FirDeclaration.isPlatformSpecificExported(): Boolean {
if (this is FirCallableDeclaration && isSubstitutionOrIntersectionOverride)
return false
if (annotations.hasAnnotation(NativeRuntimeNames.Annotations.symbolNameClassId, moduleData.session)) {
// Treat any `@SymbolName` declaration as exported.
return true
}
if (annotations.hasAnnotation(NativeRuntimeNames.Annotations.gcUnsafeCallClassId, moduleData.session)) {
// Treat any `@GCUnsafeCall` declaration as exported.
return true
}
if (annotations.hasAnnotation(NativeRuntimeNames.Annotations.exportForCppRuntimeClassId, moduleData.session)) {
// Treat any `@ExportForCppRuntime` declaration as exported.
return true
}
if (annotations.hasAnnotation(NativeRuntimeNames.Annotations.cNameClassId, moduleData.session)) {
// Treat `@CName` declaration as exported.
return true
}
if (annotations.hasAnnotation(NativeRuntimeNames.Annotations.exportForCompilerClassId, moduleData.session)) {
return true
}
return false
}
}
class FirNativeKotlinMangleComputer(
builder: StringBuilder,
mode: MangleMode,
) : FirMangleComputer(builder, mode) {
override fun copy(newMode: MangleMode): FirNativeKotlinMangleComputer =
FirNativeKotlinMangleComputer(builder, newMode)
/**
* mimics FunctionDescriptor.platformSpecificFunctionName()
*/
override fun FirFunction.platformSpecificFunctionName(): String? {
val session = moduleData.session
val scopeSession = ScopeSession()
getInitMethodIfObjCConstructor(session, scopeSession)
?.getObjCMethodInfoFromOverriddenFunctions(session, scopeSession)
?.let {
return buildString {
receiverParameter?.let {
append(it.getTypeName(session))
append(".")
}
append("objc:")
append(it.selector)
if ((this@platformSpecificFunctionName is FirConstructor) && isObjCConstructor(session)) append("#Constructor")
if (this@platformSpecificFunctionName is FirPropertyAccessor) {
append("#Accessor")
}
}
}
return null
}
override fun FirFunction.specialValueParamPrefix(param: FirValueParameter): String {
val session = moduleData.session
return if (this.hasObjCMethodAnnotation(session) || this.hasObjCFactoryAnnotation(session) || this.isObjCClassMethod(session))
"${param.name}:"
else
""
}
}
private fun FirReceiverParameter.getTypeName(session: FirSession): String {
return when (val symbol = typeRef.coneType.toSymbol(session)) {
is FirClassLikeSymbol -> symbol.classId.shortClassName.asString()
is FirTypeParameterSymbol -> symbol.name.asString()
else -> error("Unexpected symbol class: ${symbol?.javaClass?.name}")
}
}
@@ -0,0 +1,76 @@
/*
* 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.fir.backend.native
import org.jetbrains.kotlin.fir.FirSession
import org.jetbrains.kotlin.fir.backend.native.interop.decodeObjCMethodAnnotation
import org.jetbrains.kotlin.fir.backend.native.interop.isExternalObjCClassProperty
import org.jetbrains.kotlin.fir.declarations.FirCallableDeclaration
import org.jetbrains.kotlin.fir.declarations.FirProperty
import org.jetbrains.kotlin.fir.declarations.FirSimpleFunction
import org.jetbrains.kotlin.fir.scopes.FirOverrideChecker
import org.jetbrains.kotlin.fir.scopes.impl.FirStandardOverrideChecker
class FirNativeOverrideChecker(private val session: FirSession) : FirOverrideChecker {
private val standardOverrideChecker = FirStandardOverrideChecker(session)
override fun isOverriddenFunction(overrideCandidate: FirSimpleFunction, baseDeclaration: FirSimpleFunction): Boolean =
overrideCandidate.isPlatformOverriddenFunction(session, baseDeclaration)
?: standardOverrideChecker.isOverriddenFunction(overrideCandidate, baseDeclaration)
override fun isOverriddenProperty(overrideCandidate: FirCallableDeclaration, baseDeclaration: FirProperty): Boolean =
overrideCandidate.isPlatformOverriddenProperty(baseDeclaration)
?: standardOverrideChecker.isOverriddenProperty(overrideCandidate, baseDeclaration)
// FIXME KT-57640: Revise the necessity of platform-specific property overridability handling
private fun FirCallableDeclaration.isPlatformOverriddenProperty(baseDeclaration: FirProperty): Boolean? {
if (this !is FirProperty || name != baseDeclaration.name) {
return null
}
if (this.isExternalObjCClassProperty(session) && baseDeclaration.isExternalObjCClassProperty(session))
return true
return null
}
/**
* mimics ObjCOverridabilityCondition.isOverridable
*/
private fun FirSimpleFunction.isPlatformOverriddenFunction(session: FirSession, baseDeclaration: FirSimpleFunction): Boolean? {
if (this.name != baseDeclaration.name) {
return null
}
val superInfo = baseDeclaration.decodeObjCMethodAnnotation(session) ?: return null
val subInfo = decodeObjCMethodAnnotation(session)
return if (subInfo != null) {
// Overriding Objective-C method by Objective-C method in interop stubs.
// Don't even check method signatures, so this check is weaker than the standard one
superInfo.selector == subInfo.selector
} else {
// Overriding Objective-C method by Kotlin method.
if (!parameterNamesMatch(this, baseDeclaration)) false else null
}
}
/**
* mimics ObjCInteropKt.parameterNamesMatch
*/
private fun parameterNamesMatch(first: FirSimpleFunction, second: FirSimpleFunction): Boolean {
// The original Objective-C method selector is represented as
// function name and parameter names (except first).
if (first.valueParameters.size != second.valueParameters.size) {
return false
}
first.valueParameters.forEachIndexed { index, parameter ->
if (index > 0 && parameter.name != second.valueParameters[index].name) {
return false
}
}
return true
}
}
@@ -0,0 +1,156 @@
/*
* 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.fir.backend.native.interop
import org.jetbrains.kotlin.fir.FirSession
import org.jetbrains.kotlin.fir.containingClassLookupTag
import org.jetbrains.kotlin.fir.declarations.*
import org.jetbrains.kotlin.fir.expressions.FirAnnotation
import org.jetbrains.kotlin.fir.expressions.FirConstExpression
import org.jetbrains.kotlin.fir.resolve.ScopeSession
import org.jetbrains.kotlin.fir.resolve.getContainingClass
import org.jetbrains.kotlin.fir.resolve.getContainingDeclaration
import org.jetbrains.kotlin.fir.resolve.providers.toSymbol
import org.jetbrains.kotlin.fir.resolve.substitution.ConeSubstitutor
import org.jetbrains.kotlin.fir.resolve.toSymbol
import org.jetbrains.kotlin.fir.scopes.getDirectOverriddenFunctions
import org.jetbrains.kotlin.fir.scopes.processAllFunctions
import org.jetbrains.kotlin.fir.scopes.scopeForClass
import org.jetbrains.kotlin.fir.scopes.unsubstitutedScope
import org.jetbrains.kotlin.fir.symbols.SymbolInternals
import org.jetbrains.kotlin.fir.symbols.impl.FirClassLikeSymbol
import org.jetbrains.kotlin.fir.symbols.impl.FirClassSymbol
import org.jetbrains.kotlin.fir.symbols.impl.FirNamedFunctionSymbol
import org.jetbrains.kotlin.fir.types.classId
import org.jetbrains.kotlin.name.Name
import org.jetbrains.kotlin.name.NativeStandardInteropNames
import org.jetbrains.kotlin.native.interop.ObjCMethodInfo
import org.jetbrains.kotlin.utils.DFS
@OptIn(SymbolInternals::class)
internal fun FirFunction.getObjCMethodInfoFromOverriddenFunctions(session: FirSession, scopeSession: ScopeSession): ObjCMethodInfo? {
decodeObjCMethodAnnotation(session)?.let {
return it
}
// recursively find ObjCMethod annotation in getDirectOverriddenFunctions() (same as `overriddenDescriptors` in K1)
return when (val symbol = this.symbol) {
is FirNamedFunctionSymbol -> {
val firClassSymbol = containingClassLookupTag()?.toSymbol(session) as FirClassSymbol<*>?
firClassSymbol?.let {
val unsubstitutedScope = it.unsubstitutedScope(session, scopeSession, withForcedTypeCalculator = false, memberRequiredPhase = null)
// call of `processFunctionsByName()` is needed only for necessary side-effect before `getDirectOverriddenFunctions` call
unsubstitutedScope.processFunctionsByName(symbol.name) {}
unsubstitutedScope.getDirectOverriddenFunctions(symbol).firstNotNullOfOrNull {
assert(it.fir != this) { "Function ${symbol.name}() is wrongly contained in its own getDirectOverriddenFunctions" }
it.fir.getObjCMethodInfoFromOverriddenFunctions(session, scopeSession)
}
}
}
else -> null
}
}
/**
* mimics ConstructorDescriptor.getObjCInitMethod()
*/
@OptIn(SymbolInternals::class)
private fun FirConstructor.getObjCInitMethod(session: FirSession, scopeSession: ScopeSession): FirFunction? {
this.annotations.getAnnotationByClassId(NativeStandardInteropNames.objCConstructorClassId, session)?.let { annotation ->
val initSelector: String = annotation.constStringArgument("initSelector")
val classSymbol = containingClassLookupTag()?.toSymbol(session) as FirClassSymbol<*>
val initSelectors = mutableListOf<FirFunction>()
classSymbol.fir.scopeForClass(ConeSubstitutor.Empty, session, scopeSession, classSymbol.toLookupTag(), memberRequiredPhase = null)
.processAllFunctions {
if (it.fir.decodeObjCMethodAnnotation(session)?.selector == initSelector)
initSelectors.add(it.fir)
}
return initSelectors.singleOrNull()
?: error("expected one init method for $classSymbol $initSelector, got ${initSelectors.size}")
}
return null
}
/**
* mimics FunctionDescriptor.decodeObjCMethodAnnotation()
*/
internal fun FirFunction.decodeObjCMethodAnnotation(session: FirSession): ObjCMethodInfo? =
annotations.getAnnotationByClassId(NativeStandardInteropNames.objCMethodClassId, session)?.let {
ObjCMethodInfo(
selector = it.constStringArgument("selector"),
encoding = it.constStringArgument("encoding"),
isStret = it.constBooleanArgumentOrNull("isStret") ?: false,
directSymbol = annotations.getAnnotationByClassId(NativeStandardInteropNames.objCDirectClassId, session)?.constStringArgument("symbol"),
)
}
private fun FirAnnotation.constStringArgument(argumentName: String): String =
constArgument(argumentName) as? String ?: error("Expected string constant value of argument '$argumentName' at annotation $this")
private fun FirAnnotation.constBooleanArgumentOrNull(argumentName: String): Boolean? =
constArgument(argumentName) as Boolean?
private fun FirAnnotation.constArgument(argumentName: String) =
(argumentMapping.mapping[Name.identifier(argumentName)] as? FirConstExpression<*>)?.value
internal fun FirFunction.hasObjCFactoryAnnotation(session: FirSession) = this.annotations.hasAnnotation(NativeStandardInteropNames.objCFactoryClassId, session)
internal fun FirFunction.hasObjCMethodAnnotation(session: FirSession) = this.annotations.hasAnnotation(NativeStandardInteropNames.objCMethodClassId, session)
/**
* almost mimics FunctionDescriptor.isObjCClassMethod(), apart from `it.isObjCClass()` changed to `it.symbol.isObjCClass(session)` for simplicity
*/
internal fun FirFunction.isObjCClassMethod(session: FirSession) =
getContainingClass(session).let { it is FirClass && it.symbol.isObjCClass(session) }
/**
* mimics ConstructorDescriptor.isObjCConstructor()
*/
internal fun FirConstructor.isObjCConstructor(session: FirSession) =
this.annotations.hasAnnotation(NativeStandardInteropNames.objCConstructorClassId, session)
/**
* mimics IrClass.isObjCClass()
*/
private fun FirClassSymbol<*>.isObjCClass(session: FirSession) = classId.packageFqName != NativeStandardInteropNames.cInteropPackage &&
selfOrAnySuperClass(session) {
it.classId == NativeStandardInteropNames.objCObjectClassId
}
/**
* almost mimics `IrClass.selfOrAnySuperClass()` apart from using of classsymbol instead of class itself, to use `classId.toSymbol()`
*/
private fun FirClassSymbol<*>.selfOrAnySuperClass(session: FirSession, pred: (FirClassSymbol<*>) -> Boolean): Boolean =
DFS.ifAny(
listOf(this),
{ current ->
current.resolvedSuperTypes.mapNotNull {
(it.classId?.toSymbol(session) as? FirClassLikeSymbol)?.fullyExpandedClass(session)
}
},
pred
)
internal fun FirFunction.getInitMethodIfObjCConstructor(session: FirSession, scopeSession: ScopeSession): FirFunction? =
if (this is FirConstructor && isObjCConstructor(session))
getObjCInitMethod(session, scopeSession)
else
this
internal fun FirProperty.isExternalObjCClassProperty(session: FirSession) =
(containingClassLookupTag()?.toSymbol(session) as? FirClassSymbol)?.isExternalObjCClass(session) == true
internal fun FirClassSymbol<*>.isExternalObjCClass(session: FirSession): Boolean =
isObjCClass(session) &&
parentsWithSelf(session).filterIsInstance<FirClass>().any {
it.hasAnnotation(NativeStandardInteropNames.externalObjCClassClassId, session)
}
@OptIn(SymbolInternals::class)
fun FirClassSymbol<*>.parentsWithSelf(session: FirSession): Sequence<FirClassLikeDeclaration> {
return generateSequence<FirClassLikeDeclaration>(fir) { it.getContainingDeclaration(session) }
}