org.jetbrains.kotlin.codegen.optimization.common.ReferenceTrackingInterpreter.kt Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of kotlin-compiler Show documentation
Kotlin Compiler
There is a newer version: 2.0.0
/*
 * Copyright 2010-2017 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.optimization.common

import org.jetbrains.kotlin.resolve.jvm.AsmTypes
import org.jetbrains.org.objectweb.asm.Type
import org.jetbrains.org.objectweb.asm.tree.AbstractInsnNode
import org.jetbrains.org.objectweb.asm.tree.analysis.BasicValue

abstract class ReferenceTrackingInterpreter : OptimizationBasicInterpreter() {
    override fun merge(v: BasicValue, w: BasicValue): BasicValue =
        when {
            v is ProperTrackedReferenceValue && w is ProperTrackedReferenceValue ->
                if (v.descriptor == w.descriptor)
                    v
                else
                    createTaintedValue(v, w)

            v is TrackedReferenceValue && w is TrackedReferenceValue ->
                createPossiblyMergedValue(v, w)

            v is TrackedReferenceValue || w is TrackedReferenceValue ->
                createTaintedValue(v, w)

            else ->
                super.merge(v, w)
        }

    protected fun createTaintedValue(v: BasicValue, w: BasicValue): TrackedReferenceValue =
        TaintedTrackedReferenceValue(
            getMergedValueType(v.type, w.type),
            mergeDescriptors(v, w).also {
                assert(it.isNotEmpty()) { "At least one of ($v, $w) should be a tracked reference" }
            }
        )

    protected fun createMergedValue(v: TrackedReferenceValue, w: TrackedReferenceValue): TrackedReferenceValue =
        if (v is TaintedTrackedReferenceValue || w is TaintedTrackedReferenceValue)
            createTaintedValue(v, w)
        else
            MergedTrackedReferenceValue(getMergedValueType(v.type, w.type), mergeDescriptors(v, w))

    protected open fun createPossiblyMergedValue(v: TrackedReferenceValue, w: TrackedReferenceValue): TrackedReferenceValue =
        createTaintedValue(v, w)

    private fun mergeDescriptors(v: BasicValue, w: BasicValue) =
        v.referenceValueDescriptors + w.referenceValueDescriptors

    private val BasicValue.referenceValueDescriptors: Set
        get() = if (this is TrackedReferenceValue) this.descriptors else emptySet()

    protected fun getMergedValueType(type1: Type?, type2: Type?): Type =
        when {
            type1 == null || type2 == null -> AsmTypes.OBJECT_TYPE
            type1 == type2 -> type1
            else -> AsmTypes.OBJECT_TYPE
        }

    override fun copyOperation(insn: AbstractInsnNode, value: BasicValue): BasicValue? =
        if (value is TrackedReferenceValue) {
            checkRefValuesUsages(insn, listOf(value))
            value
        } else {
            super.copyOperation(insn, value)
        }

    override fun unaryOperation(insn: AbstractInsnNode, value: BasicValue): BasicValue? {
        checkRefValuesUsages(insn, listOf(value))
        return super.unaryOperation(insn, value)
    }

    override fun binaryOperation(insn: AbstractInsnNode, value1: BasicValue, value2: BasicValue): BasicValue? {
        checkRefValuesUsages(insn, listOf(value1, value2))
        return super.binaryOperation(insn, value1, value2)
    }

    override fun ternaryOperation(insn: AbstractInsnNode, value1: BasicValue, value2: BasicValue, value3: BasicValue): BasicValue? {
        checkRefValuesUsages(insn, listOf(value1, value2, value3))
        return super.ternaryOperation(insn, value1, value2, value3)
    }

    override fun naryOperation(insn: AbstractInsnNode, values: List): BasicValue? {
        checkRefValuesUsages(insn, values)
        return super.naryOperation(insn, values)
    }

    protected open fun checkRefValuesUsages(insn: AbstractInsnNode, values: List) {
        values.forEach { value ->
            if (value is TaintedTrackedReferenceValue) {
                value.descriptors.forEach { it.onUseAsTainted() }
            }
        }

        values.forEachIndexed { pos, value ->
            if (value is TrackedReferenceValue) {
                processRefValueUsage(value, insn, pos)
            }
        }
    }

    protected abstract fun processRefValueUsage(value: TrackedReferenceValue, insn: AbstractInsnNode, position: Int)
}