Revert "Simplify static field scrambling"

This reverts commit b6bba95435.

Although this code is more complicated, it allows us to control the
destination class for fields individually (rather than an entire set at
a time). This is a requirement for name mapping.

deob/src/main/java/dev/openrs2/deob/transform/StaticScramblingTransformer.kt

@@ -2,20 +2,22 @@ package dev.openrs2.deob.transform
 
 import com.github.michaelbull.logging.InlineLogger
 import dev.openrs2.asm.ClassVersionUtils
+import dev.openrs2.asm.MemberDesc
 import dev.openrs2.asm.MemberRef
 import dev.openrs2.asm.classpath.ClassPath
 import dev.openrs2.asm.classpath.Library
+import dev.openrs2.asm.getExpression
+import dev.openrs2.asm.isSequential
 import dev.openrs2.asm.transform.Transformer
 import dev.openrs2.deob.Profile
 import dev.openrs2.util.collect.DisjointSet
 import org.objectweb.asm.Opcodes
+import org.objectweb.asm.tree.AbstractInsnNode
 import org.objectweb.asm.tree.ClassNode
 import org.objectweb.asm.tree.FieldInsnNode
 import org.objectweb.asm.tree.FieldNode
 import org.objectweb.asm.tree.InsnList
 import org.objectweb.asm.tree.InsnNode
-import org.objectweb.asm.tree.JumpInsnNode
-import org.objectweb.asm.tree.LabelNode
 import org.objectweb.asm.tree.MethodInsnNode
 import org.objectweb.asm.tree.MethodNode
 import javax.inject.Inject
@@ -24,16 +26,17 @@ import kotlin.math.max
 
 @Singleton
 class StaticScramblingTransformer @Inject constructor(private val profile: Profile) : Transformer() {
-    private class FieldSet(val owner: ClassNode, val fields: List<FieldNode>, val clinit: MethodNode?) {
+    private data class Field(val node: FieldNode, val initializer: InsnList, val version: Int, val maxStack: Int) {
-        val dependencies = clinit?.instructions
+        val dependencies = initializer.asSequence()
-            ?.filterIsInstance<FieldInsnNode>()
+            .filterIsInstance<FieldInsnNode>()
-            ?.filter { it.opcode == Opcodes.GETSTATIC && it.owner != owner.name }
+            .filter { it.opcode == Opcodes.GETSTATIC }
-            ?.mapTo(mutableSetOf(), ::MemberRef) ?: emptySet<MemberRef>()
+            .map(::MemberRef)
+            .toSet()
     }
 
     private lateinit var inheritedFieldSets: DisjointSet<MemberRef>
     private lateinit var inheritedMethodSets: DisjointSet<MemberRef>
-    private val fieldSets = mutableMapOf<MemberRef, FieldSet>()
+    private val fields = mutableMapOf<DisjointSet.Partition<MemberRef>, Field>()
     private val fieldClasses = mutableMapOf<DisjointSet.Partition<MemberRef>, String>()
     private val methodClasses = mutableMapOf<DisjointSet.Partition<MemberRef>, String>()
     private var nextStaticClass: ClassNode? = null
@@ -73,63 +76,103 @@ class StaticScramblingTransformer @Inject constructor(private val profile: Profi
         return Pair(clazz, clinit)
     }
 
-    private fun spliceFields() {
+    private fun MethodNode.extractEntryExitBlocks(): List<AbstractInsnNode> {
-        val done = mutableSetOf<FieldSet>()
+        /*
-        for (fieldSet in fieldSets.values) {
+         * Most (or all?) of the <clinit> methods have "simple" initializers
-            spliceFields(done, fieldSet)
+         * that we're capable of moving in the first and last basic blocks of
-        }
+         * the method. The last basic block is always at the end of the code
-    }
+         * and ends in a RETURN. This allows us to avoid worrying about making
-
+         * a full basic block control flow graph here.
-    private fun spliceFields(done: MutableSet<FieldSet>, fieldSet: FieldSet) {
+         */
-        if (!done.add(fieldSet)) {
+        val entry = instructions.takeWhile { it.isSequential }
-            return
+
+        val last = instructions.lastOrNull()
+        if (last == null || last.opcode != Opcodes.RETURN) {
+            return entry
         }
 
-        for (dependency in fieldSet.dependencies) {
+        val exit = instructions.toList()
-            val dependencyFieldSet = fieldSets[dependency] ?: continue
+            .dropLast(1)
-            spliceFields(done, dependencyFieldSet)
+            .takeLastWhile { it.isSequential }
-        }
 
-        val (staticClass, staticClinit) = nextClass()
+        return entry.plus(exit)
-        staticClass.fields.addAll(fieldSet.fields)
+    }
-        staticClass.version = ClassVersionUtils.max(staticClass.version, fieldSet.owner.version)
 
-        if (fieldSet.clinit != null) {
+    private fun MethodNode.extractInitializers(owner: String): Pair<Map<MemberDesc, InsnList>, Set<MemberDesc>> {
-            // remove tail RETURN
+        val entryExitBlocks = extractEntryExitBlocks()
-            val insns = fieldSet.clinit.instructions
+
-            val last = insns.lastOrNull()
+        val simpleInitializers = mutableMapOf<MemberDesc, InsnList>()
-            if (last != null && last.opcode == Opcodes.RETURN) {
+        val complexInitializers = instructions.asSequence()
-                insns.remove(last)
+            .filter { !entryExitBlocks.contains(it) }
+            .filterIsInstance<FieldInsnNode>()
+            .filter { it.opcode == Opcodes.GETSTATIC && it.owner == owner }
+            .filter { !profile.excludedFields.matches(it.owner, it.name, it.desc) }
+            .map(::MemberDesc)
+            .toSet()
+
+        val putstatics = entryExitBlocks
+            .filterIsInstance<FieldInsnNode>()
+            .filter { it.opcode == Opcodes.PUTSTATIC && it.owner == owner }
+            .filter { !profile.excludedFields.matches(it.owner, it.name, it.desc) }
+
+        for (putstatic in putstatics) {
+            val desc = MemberDesc(putstatic)
+            if (simpleInitializers.containsKey(desc) || complexInitializers.contains(desc)) {
+                continue
             }
 
-            // replace any remaining RETURNs with a GOTO to the end of the method
+            // TODO(gpe): use a filter here (pure with no *LOADs?)
-            val end = LabelNode()
+            val expr = getExpression(putstatic) ?: continue
-            insns.add(end)
 
-            for (insn in insns) {
+            val initializer = InsnList()
-                if (insn.opcode == Opcodes.RETURN) {
+            for (insn in expr) {
-                    insns.set(insn, JumpInsnNode(Opcodes.GOTO, end))
+                instructions.remove(insn)
-                }
+                initializer.add(insn)
             }
+            instructions.remove(putstatic)
+            initializer.add(putstatic)
 
-            // append just before the end of the static <clinit> RETURN
+            simpleInitializers[desc] = initializer
-            staticClinit.instructions.insertBefore(staticClinit.instructions.last, insns)
+        }
+
+        return Pair(simpleInitializers, complexInitializers)
+    }
 
-            staticClinit.tryCatchBlocks.addAll(fieldSet.clinit.tryCatchBlocks)
+    private fun spliceInitializers() {
-            staticClinit.maxStack = max(staticClinit.maxStack, fieldSet.clinit.maxStack)
+        val done = mutableSetOf<DisjointSet.Partition<MemberRef>>()
-            staticClinit.maxLocals = max(staticClinit.maxLocals, fieldSet.clinit.maxLocals)
+        for ((partition, field) in fields) {
+            spliceInitializers(done, partition, field)
+        }
+    }
+
+    private fun spliceInitializers(
+        done: MutableSet<DisjointSet.Partition<MemberRef>>,
+        partition: DisjointSet.Partition<MemberRef>,
+        field: Field
+    ) {
+        if (!done.add(partition)) {
+            return
         }
 
-        for (field in fieldSet.fields) {
+        for (dependency in field.dependencies) {
-            val partition = inheritedFieldSets[MemberRef(fieldSet.owner, field)]!!
+            val dependencyPartition = inheritedFieldSets[dependency]!!
-            fieldClasses[partition] = staticClass.name
+            val dependencyField = fields[dependencyPartition] ?: continue
+            spliceInitializers(done, partition, dependencyField)
         }
+
+        val (staticClass, clinit) = nextClass()
+        staticClass.fields.add(field.node)
+        staticClass.version = ClassVersionUtils.max(staticClass.version, field.version)
+        clinit.instructions.insertBefore(clinit.instructions.last, field.initializer)
+        clinit.maxStack = max(clinit.maxStack, field.maxStack)
+
+        fieldClasses[partition] = staticClass.name
     }
 
     override fun preTransform(classPath: ClassPath) {
         inheritedFieldSets = classPath.createInheritedFieldSets()
         inheritedMethodSets = classPath.createInheritedMethodSets()
-        fieldSets.clear()
+        fields.clear()
         fieldClasses.clear()
         methodClasses.clear()
         nextStaticClass = null
@@ -143,22 +186,29 @@ class StaticScramblingTransformer @Inject constructor(private val profile: Profi
 
             for (clazz in library) {
                 // TODO(gpe): exclude the JSObject class
-                if (clazz.name == "jagex3/jagmisc/jagmisc") {
-                    continue
-                }
-
-                val fields = clazz.fields.filter { it.access and Opcodes.ACC_STATIC != 0 }
-                clazz.fields.removeAll(fields)
 
                 val clinit = clazz.methods.find { it.name == "<clinit>" }
-                if (clinit != null) {
+                val (simpleInitializers, complexInitializers) = clinit?.extractInitializers(clazz.name)
-                    clazz.methods.remove(clinit)
+                    ?: Pair(emptyMap(), emptySet())
-                }
+
+                clazz.fields.removeIf { field ->
+                    if (field.access and Opcodes.ACC_STATIC == 0) {
+                        return@removeIf false
+                    } else if (profile.excludedFields.matches(clazz.name, field.name, field.desc)) {
+                        return@removeIf false
+                    }
 
-                val fieldSet = FieldSet(clazz, fields, clinit)
+                    val desc = MemberDesc(field)
-                for (field in fields) {
+                    if (complexInitializers.contains(desc)) {
-                    val ref = MemberRef(clazz, field)
+                        return@removeIf false
-                    fieldSets[ref] = fieldSet
+                    }
+
+                    val initializer = simpleInitializers[desc] ?: InsnList()
+                    val maxStack = clinit?.maxStack ?: 0
+
+                    val partition = inheritedFieldSets[MemberRef(clazz, field)]!!
+                    fields[partition] = Field(field, initializer, clazz.version, maxStack)
+                    return@removeIf true
                 }
 
                 clazz.methods.removeIf { method ->
@@ -180,7 +230,7 @@ class StaticScramblingTransformer @Inject constructor(private val profile: Profi
                 }
             }
 
-            spliceFields()
+            spliceInitializers()
 
             for (clazz in staticClasses) {
                 library.add(clazz)