org.jetbrains.kotlin.codegen.builtinSpecialBridges.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kotlin-compiler Show documentation
the Kotlin compiler
There is a newer version: 2.1.20-Beta1
/*
 * Copyright 2010-2015 JetBrains s.r.o.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.jetbrains.kotlin.codegen

import org.jetbrains.kotlin.backend.common.bridges.findAllReachableDeclarations
import org.jetbrains.kotlin.backend.common.bridges.findConcreteSuperDeclaration
import org.jetbrains.kotlin.codegen.state.GenerationState
import org.jetbrains.kotlin.descriptors.CallableMemberDescriptor
import org.jetbrains.kotlin.descriptors.FunctionDescriptor
import org.jetbrains.kotlin.descriptors.Modality
import org.jetbrains.kotlin.load.java.BuiltinMethodsWithSpecialGenericSignature
import org.jetbrains.kotlin.load.java.BuiltinMethodsWithSpecialGenericSignature.getSpecialSignatureInfo
import org.jetbrains.kotlin.load.java.descriptors.JavaClassDescriptor
import org.jetbrains.kotlin.load.java.getOverriddenBuiltinReflectingJvmDescriptor
import org.jetbrains.kotlin.psi.KtElement
import org.jetbrains.kotlin.psi.KtPsiUtil
import org.jetbrains.kotlin.resolve.BindingContext
import org.jetbrains.kotlin.resolve.DescriptorUtils
import org.jetbrains.kotlin.resolve.calls.util.getParentCall
import org.jetbrains.kotlin.resolve.calls.util.getResolvedCall
import org.jetbrains.kotlin.resolve.descriptorUtil.overriddenTreeAsSequence
import org.jetbrains.kotlin.utils.addIfNotNull
import java.util.*

class BridgeForBuiltinSpecial(
    val from: Signature, val to: Signature,
    val isSpecial: Boolean = false,
    val isDelegateToSuper: Boolean = false
)

object BuiltinSpecialBridgesUtil {
    @JvmStatic
    fun  generateBridgesForBuiltinSpecial(
        function: FunctionDescriptor,
        signatureByDescriptor: (FunctionDescriptor) -> Signature,
        state: GenerationState
    ): Set> {

        val functionHandle = DescriptorBasedFunctionHandleForJvm(function, state)
        val fake = !functionHandle.isDeclaration
        val overriddenBuiltin = function.getOverriddenBuiltinReflectingJvmDescriptor()!!

        val reachableDeclarations = findAllReachableDeclarations(function, state)

        // e.g. `getSize()I`
        val methodItself = signatureByDescriptor(function)
        // e.g. `size()I`
        val specialBridgeSignature = signatureByDescriptor(overriddenBuiltin)

        val specialBridgeExists = function.getSpecialBridgeSignatureIfExists(signatureByDescriptor) != null
        val specialBridgesSignaturesInSuperClass = function.overriddenTreeAsSequence(useOriginal = true).mapNotNull {
            it.takeUnless { it === function }?.getSpecialBridgeSignatureIfExists(signatureByDescriptor)
        }
        val isTherePossibleClashWithSpecialBridge =
            specialBridgeSignature in specialBridgesSignaturesInSuperClass
                    || reachableDeclarations.any { it.modality == Modality.FINAL && signatureByDescriptor(it) == specialBridgeSignature }

        val specialBridge = if (specialBridgeExists && !isTherePossibleClashWithSpecialBridge)
            BridgeForBuiltinSpecial(specialBridgeSignature, methodItself, isSpecial = true)
        else null

        val commonBridges = reachableDeclarations.mapTo(LinkedHashSet(), signatureByDescriptor)
        commonBridges.removeAll(specialBridgesSignaturesInSuperClass + listOfNotNull(specialBridge?.from))

        if (fake) {
            for (overridden in function.overriddenDescriptors.map { it.original }) {
                if (!DescriptorBasedFunctionHandleForJvm(overridden, state).isAbstract) {
                    commonBridges.removeAll(
                        findAllReachableDeclarations(
                            overridden,
                            state
                        ).map(signatureByDescriptor)
                    )
                }
            }
        }

        val bridges: MutableSet> = mutableSetOf()

        val superImplementationDescriptor =
            if (specialBridge != null && fake && !functionHandle.isAbstract)
                findSuperImplementationForStubDelegation(function, state, signatureByDescriptor)
            else
                null

        if (superImplementationDescriptor != null) {
            bridges.add(
                BridgeForBuiltinSpecial(
                    methodItself,
                    signatureByDescriptor(superImplementationDescriptor),
                    isDelegateToSuper = true
                )
            )
        }

        if (commonBridges.remove(methodItself)) {
            if (superImplementationDescriptor == null && fake && !functionHandle.isAbstract && methodItself != specialBridgeSignature) {
                // The only case when superImplementationDescriptor, but method is fake and not abstract is enum members
                // They have superImplementationDescriptor null because they are final

                // generate non-synthetic bridge 'getOrdinal()' to 'ordinal()' (see test enumAsOrdinaled.kt)
                bridges.add(BridgeForBuiltinSpecial(methodItself, specialBridgeSignature, isSpecial = false, isDelegateToSuper = false))
            }
        }

        bridges.addAll(commonBridges.map { BridgeForBuiltinSpecial(it, methodItself) })
        bridges.addIfNotNull(specialBridge)

        return bridges
    }

    @JvmStatic
    fun  FunctionDescriptor.shouldHaveTypeSafeBarrier(
        signatureByDescriptor: (FunctionDescriptor) -> Signature
    ): Boolean {
        if (BuiltinMethodsWithSpecialGenericSignature.getDefaultValueForOverriddenBuiltinFunction(this) == null) return false

        val builtin = getOverriddenBuiltinReflectingJvmDescriptor() ?: error("Overridden built-in member not found: $this")
        return signatureByDescriptor(this) == signatureByDescriptor(builtin)
    }
}

/**
 * Stub is a method having signature from Kotlin built-ins that we generate for non-abstract declarations,
 * it's bytecode consists of INVOKESPECIAL-call to real declaration in super class.
 *
 * Note that stub is needed only for first Kotlin class in the hierarchy.
 *
 * For example:
 * class A : HashMap
 *
 * Here we generate `entrySet()` special bridge with INVOKEVIRTUAL getEntries(),
 * But the latter does not exists yet, so we create a stub for it with delegation to super-class
 *
 * Also note that there is no special bridges for final declarations, thus no stubs either
 */
private fun  findSuperImplementationForStubDelegation(
    function: FunctionDescriptor,
    state: GenerationState,
    signatureByDescriptor: (FunctionDescriptor) -> Signature
): FunctionDescriptor? {
    val implementation = findConcreteSuperDeclaration(DescriptorBasedFunctionHandleForJvm(function, state)) ?: return null

    // Implementation from interface will be generated by common mechanism
    if (!implementation.mayBeUsedAsSuperImplementation) return null

    // Implementation in super-class already has proper signature
    if (signatureByDescriptor(function) == signatureByDescriptor(implementation.descriptor)) return null

// TODO: Enable the assertion once KT-34507 is fixed
//    assert(function.modality == Modality.OPEN) {
//        "Should generate stubs only for non-abstract built-ins, but ${function.name} is ${function.modality}"
//    }

    return implementation.descriptor
}

private fun findAllReachableDeclarations(
    functionDescriptor: FunctionDescriptor,
    state: GenerationState
): MutableSet =
    findAllReachableDeclarations(
        DescriptorBasedFunctionHandleForJvm(
            functionDescriptor,
            state
        )
    ).map { it.descriptor }.toMutableSet()

private fun  CallableMemberDescriptor.getSpecialBridgeSignatureIfExists(
    signatureByDescriptor: (FunctionDescriptor) -> Signature
): Signature? {
    // Only functions should be considered here (may be assertion)
    if (this !is FunctionDescriptor) return null

    // Only Kotlin classes can have special bridges
    if (containingDeclaration is JavaClassDescriptor || DescriptorUtils.isInterface(containingDeclaration)) return null

    // Getting original is necessary here, because we want to determine JVM signature of descriptor as it was declared in containing class
    val originalOverride = original
    val overriddenSpecial = originalOverride.getOverriddenBuiltinReflectingJvmDescriptor() ?: return null
    val specialBridgeSignature = signatureByDescriptor(overriddenSpecial)

    // Does special bridge has different signature
    if (signatureByDescriptor(originalOverride) == specialBridgeSignature) return null

    return specialBridgeSignature
}

fun isValueArgumentForCallToMethodWithTypeCheckBarrier(
    element: KtElement,
    bindingContext: BindingContext
): Boolean {

    val parentCall = element.getParentCall(bindingContext, strict = true) ?: return false
    val argumentExpression = parentCall.valueArguments.singleOrNull()?.getArgumentExpression() ?: return false
    if (KtPsiUtil.deparenthesize(argumentExpression) !== element) return false

    val candidateDescriptor = parentCall.getResolvedCall(bindingContext)?.candidateDescriptor as CallableMemberDescriptor?
        ?: return false

    return candidateDescriptor.getSpecialSignatureInfo()?.isObjectReplacedWithTypeParameter ?: false
}