[IR] Mark IrSymbol.owner with OptIn annotation

^KT-60923 Fixed

analysis/analysis-api-fir/src/org/jetbrains/kotlin/analysis/api/fir/components/KtFirCompilerFacility.kt

@@ -64,6 +64,7 @@ import org.jetbrains.kotlin.ir.descriptors.IrBasedVariableDescriptor
 import org.jetbrains.kotlin.ir.expressions.*
 import org.jetbrains.kotlin.ir.symbols.IrClassSymbol
 import org.jetbrains.kotlin.ir.symbols.IrSymbol
+import org.jetbrains.kotlin.ir.symbols.IrSymbolInternals
 import org.jetbrains.kotlin.ir.types.IrSimpleType
 import org.jetbrains.kotlin.ir.util.classId
 import org.jetbrains.kotlin.ir.util.StubGeneratorExtensions
@@ -242,6 +243,7 @@ internal class KtFirCompilerFacility(
         irCodeFragmentFiles.forEach { it.acceptVoid(patchingVisitor) }
     }
 
+    @OptIn(IrSymbolInternals::class)
     private fun computeAdditionalCodeFragmentMapping(descriptor: IrBasedDeclarationDescriptor<*>): CodeFragmentCapturedValue? {
         val owner = descriptor.owner
 
@@ -541,6 +543,7 @@ private class IrDeclarationPatchingVisitor(private val mapping: Map<FirDeclarati
         super.visitClassReference(expression)
     }
 
+    @OptIn(IrSymbolInternals::class)
     private inline fun <reified T : IrSymbol> patchIfNeeded(irSymbol: T?, patcher: (T) -> Unit) {
         if (irSymbol != null) {
             val irDeclaration = irSymbol.owner as? IrMetadataSourceOwner ?: return
@@ -551,4 +554,4 @@ private class IrDeclarationPatchingVisitor(private val mapping: Map<FirDeclarati
             }
         }
     }
-}
+}

compiler/fir/fir2ir/build.gradle.kts

@@ -48,6 +48,8 @@ dependencies {
     testRuntimeOnly(jpsModelImpl())
 }
 
+optInToIrSymbolInternals()
+
 val generationRoot = projectDir.resolve("tests-gen")
 
 sourceSets {

compiler/fir/fir2ir/jvm-backend/build.gradle.kts

@@ -23,6 +23,8 @@ dependencies {
     compileOnly(commonDependency("org.jetbrains.intellij.deps:asm-all"))
 }
 
+optInToIrSymbolInternals()
+
 sourceSets {
     "main" { projectDefault() }
 }

compiler/ir/backend.common/build.gradle.kts

@@ -12,6 +12,8 @@ dependencies {
     compileOnly(intellijCore())
 }
 
+optInToIrSymbolInternals()
+
 sourceSets {
     "main" { projectDefault() }
     "test" {}

compiler/ir/backend.js/build.gradle.kts

@@ -19,6 +19,8 @@ dependencies {
     compileOnly(intellijCore())
 }
 
+optInToIrSymbolInternals()
+
 sourceSets {
     "main" { projectDefault() }
     "test" {}

compiler/ir/backend.jvm/build.gradle.kts

@@ -12,6 +12,8 @@ dependencies {
     compileOnly(commonDependency("org.jetbrains.intellij.deps:asm-all"))
 }
 
+optInToIrSymbolInternals()
+
 sourceSets {
     "main" {
         projectDefault()

compiler/ir/backend.jvm/codegen/build.gradle.kts

@@ -10,6 +10,8 @@ dependencies {
     compileOnly(intellijCore())
 }
 
+optInToIrSymbolInternals()
+
 sourceSets {
     "main" {
         projectDefault()

compiler/ir/backend.jvm/entrypoint/build.gradle.kts

@@ -13,6 +13,8 @@ dependencies {
     compileOnly(intellijCore())
 }
 
+optInToIrSymbolInternals()
+
 sourceSets {
     "main" {
         projectDefault()

compiler/ir/backend.jvm/lower/build.gradle.kts

@@ -11,6 +11,8 @@ dependencies {
     compileOnly(commonDependency("org.jetbrains.intellij.deps:trove4j"))
 }
 
+optInToIrSymbolInternals()
+
 sourceSets {
     "main" {
         projectDefault()

compiler/ir/backend.wasm/build.gradle.kts

@@ -19,6 +19,8 @@ dependencies {
     compileOnly(intellijCore())
 }
 
+optInToIrSymbolInternals()
+
 sourceSets {
     "main" { projectDefault() }
     "test" {}

compiler/ir/ir.interpreter/build.gradle.kts

@@ -8,6 +8,8 @@ dependencies {
     compileOnly(commonDependency("org.jetbrains.kotlin:kotlin-reflect")) { isTransitive = false }
 }
 
+optInToIrSymbolInternals()
+
 sourceSets {
     "main" { projectDefault() }
     "test" {}

compiler/ir/ir.ir2cfg/build.gradle.kts

@@ -10,8 +10,9 @@ dependencies {
     api(project(":compiler:ir.tree"))
 }
 
+optInToIrSymbolInternals()
+
 sourceSets {
     "main" { projectDefault() }
     "test" {}
 }
-

compiler/ir/ir.psi2ir/build.gradle.kts

@@ -11,6 +11,8 @@ dependencies {
     compileOnly(intellijCore())
 }
 
+optInToIrSymbolInternals()
+
 sourceSets {
     "main" { projectDefault() }
     "test" {}

compiler/ir/ir.tree/build.gradle.kts

@@ -18,6 +18,8 @@ dependencies {
     compileOnly(intellijCore())
 }
 
+optInToIrSymbolInternals()
+
 sourceSets {
     "main" {
         projectDefault()

compiler/ir/ir.tree/src/org/jetbrains/kotlin/ir/symbols/IrSymbol.kt

@@ -29,6 +29,13 @@ import org.jetbrains.kotlin.mpp.*
 import org.jetbrains.kotlin.types.model.TypeConstructorMarker
 import org.jetbrains.kotlin.types.model.TypeParameterMarker
 
+/**
+ * Usage of [IrSymbol.owner] can be unsafe in some context (like in fir2ir), where not all symbols can be bound),
+ *   so it should be used with care
+ */
+@RequiresOptIn(level = RequiresOptIn.Level.WARNING)
+annotation class IrSymbolInternals
+
 /**
  * A special object that can be used to refer to [IrDeclaration]s and some other entities from IR nodes.
  *
@@ -59,6 +66,7 @@ interface IrSymbol : DeclarationSymbolMarker {
      * **A:** Because we most often need to access a symbol's owner in lowerings, which happen after linkage, at which point all symbols
      * should be already bound. Declaring this property nullable would make working with it more difficult most of the time.
      */
+    @IrSymbolInternals
     val owner: IrSymbolOwner
 
     /**
@@ -118,6 +126,7 @@ val IrSymbol.isPublicApi: Boolean
  * Only leaf interfaces in the symbol hierarchy inherit from this interface.
  */
 interface IrBindableSymbol<out Descriptor : DeclarationDescriptor, Owner : IrSymbolOwner> : IrSymbol {
+    @IrSymbolInternals
     override val owner: Owner
 
     @ObsoleteDescriptorBasedAPI
@@ -221,6 +230,7 @@ sealed interface IrValueSymbol : IrSymbol {
     @ObsoleteDescriptorBasedAPI
     override val descriptor: ValueDescriptor
 
+    @IrSymbolInternals
     override val owner: IrValueDeclaration
 }
 
@@ -243,6 +253,7 @@ sealed interface IrReturnTargetSymbol : IrSymbol {
     @ObsoleteDescriptorBasedAPI
     override val descriptor: FunctionDescriptor
 
+    @IrSymbolInternals
     override val owner: IrReturnTarget
 }
 
@@ -252,6 +263,7 @@ sealed interface IrReturnTargetSymbol : IrSymbol {
  * @see IrFunctionReference
  */
 sealed interface IrFunctionSymbol : IrReturnTargetSymbol, FunctionSymbolMarker {
+    @IrSymbolInternals
     override val owner: IrFunction
 }
 

compiler/ir/serialization.common/build.gradle.kts

@@ -16,6 +16,8 @@ dependencies {
     compileOnly(intellijCore())
 }
 
+optInToIrSymbolInternals()
+
 sourceSets {
     "main" { projectDefault() }
     "test" {}

compiler/tests-common-new/build.gradle.kts

@@ -39,6 +39,7 @@ dependencies {
 }
 
 optInToExperimentalCompilerApi()
+optInToIrSymbolInternals()
 
 sourceSets {
     "main" { none() }

compiler/tests-common/build.gradle.kts

@@ -85,6 +85,7 @@ dependencies {
 }
 
 optInToExperimentalCompilerApi()
+optInToIrSymbolInternals()
 
 sourceSets {
     "main" { }

compiler/tests-compiler-utils/build.gradle.kts

@@ -37,6 +37,8 @@ dependencies {
     testApi(commonDependency("org.jetbrains.intellij.deps:jdom"))
 }
 
+optInToIrSymbolInternals()
+
 sourceSets {
     "main" { none() }
     "test" { projectDefault() }

kotlin-native/backend.native/build.gradle

@@ -41,6 +41,8 @@ compileCompilerKotlin {
             '-Xskip-prerelease-check']
 }
 
+TasksKt.optInToIrSymbolInternals(project)
+
 compileCli_bcKotlin {
     kotlinOptions.freeCompilerArgs += ['-Xskip-prerelease-check']
 }

plugins/android-extensions/android-extensions-compiler/build.gradle.kts

@@ -50,6 +50,7 @@ dependencies {
 }
 
 optInToExperimentalCompilerApi()
+optInToIrSymbolInternals()
 
 sourceSets {
     "main" { projectDefault() }

plugins/atomicfu/atomicfu-compiler/build.gradle.kts

@@ -156,14 +156,13 @@ dependencies {
 }
 
 optInToExperimentalCompilerApi()
+optInToIrSymbolInternals()
 
 sourceSets {
     "main" { projectDefault() }
     "test" { projectDefault() }
 }
 
-optInToExperimentalCompilerApi()
-
 testsJar()
 useD8Plugin()
 

plugins/fir-plugin-prototype/build.gradle.kts

@@ -45,6 +45,7 @@ dependencies {
 }
 
 optInToExperimentalCompilerApi()
+optInToIrSymbolInternals()
 
 val generationRoot = projectDir.resolve("tests-gen")
 

plugins/kotlinx-serialization/kotlinx-serialization.backend/build.gradle.kts

@@ -25,6 +25,8 @@ dependencies {
     compileOnly(intellijCore())
 }
 
+optInToIrSymbolInternals()
+
 sourceSets {
     "main" { projectDefault() }
     "test" { none() }

plugins/noarg/noarg.backend/build.gradle.kts

@@ -13,6 +13,8 @@ dependencies {
     implementation(kotlinStdlib())
 }
 
+optInToIrSymbolInternals()
+
 sourceSets {
     "main" { projectDefault() }
     "test" { none() }

plugins/parcelize/parcelize-compiler/build.gradle.kts

@@ -66,6 +66,7 @@ dependencies {
 }
 
 optInToExperimentalCompilerApi()
+optInToIrSymbolInternals()
 
 sourceSets {
     "main" { none() }

plugins/parcelize/parcelize-compiler/parcelize.backend/build.gradle.kts

@@ -18,6 +18,8 @@ dependencies {
     compileOnly(commonDependency("org.jetbrains.intellij.deps:asm-all"))
 }
 
+optInToIrSymbolInternals()
+
 sourceSets {
     "main" { projectDefault() }
     "test" { none() }

repo/gradle-build-conventions/buildsrc-compat/src/main/kotlin/tasks.kt

@@ -402,11 +402,18 @@ fun Project.confugureFirPluginAnnotationsDependency(testTask: TaskProvider<Test>
     }
 }
 
-fun Project.optInToExperimentalCompilerApi() {
-    @Suppress("DEPRECATION")
+private fun Project.optInTo(annotationFqName: String) {
     tasks.withType<org.jetbrains.kotlin.gradle.dsl.KotlinCompile<*>>().configureEach {
         kotlinOptions {
-            freeCompilerArgs += "-opt-in=org.jetbrains.kotlin.compiler.plugin.ExperimentalCompilerApi"
+            freeCompilerArgs += "-opt-in=$annotationFqName"
         }
     }
 }
+
+fun Project.optInToExperimentalCompilerApi() {
+    optInTo("org.jetbrains.kotlin.compiler.plugin.ExperimentalCompilerApi")
+}
+
+fun Project.optInToIrSymbolInternals() {
+    optInTo("org.jetbrains.kotlin.ir.symbols.IrSymbolInternals")
+}