From a86a07411ef628c2b8d89df5570fe2e9eaebb98e Mon Sep 17 00:00:00 2001 From: Raven Szewczyk Date: Sun, 28 Jan 2024 13:34:45 +0000 Subject: [PATCH] Move ASM upgrade to a batch transformer in RFB --- .../EventSubscriptionTransformer.java | 200 ------------------ .../asm/transformers/TerminalTransformer.java | 149 ------------- .../lwjgl3ify/core/Lwjgl3ifyCoremod.java | 1 - .../mixins/fml/ModVisitorAsmVersion.java | 22 -- 4 files changed, 372 deletions(-) delete mode 100644 src/forgePatches/java/cpw/mods/fml/common/asm/transformers/EventSubscriptionTransformer.java delete mode 100644 src/forgePatches/java/cpw/mods/fml/common/asm/transformers/TerminalTransformer.java delete mode 100644 src/main/java/me/eigenraven/lwjgl3ify/mixins/fml/ModVisitorAsmVersion.java diff --git a/src/forgePatches/java/cpw/mods/fml/common/asm/transformers/EventSubscriptionTransformer.java b/src/forgePatches/java/cpw/mods/fml/common/asm/transformers/EventSubscriptionTransformer.java deleted file mode 100644 index 71136a0..0000000 --- a/src/forgePatches/java/cpw/mods/fml/common/asm/transformers/EventSubscriptionTransformer.java +++ /dev/null @@ -1,200 +0,0 @@ -package cpw.mods.fml.common.asm.transformers; - -import static org.objectweb.asm.ClassWriter.COMPUTE_FRAMES; -import static org.objectweb.asm.Opcodes.ACC_PRIVATE; -import static org.objectweb.asm.Opcodes.ACC_PROTECTED; -import static org.objectweb.asm.Opcodes.ACC_PUBLIC; -import static org.objectweb.asm.Opcodes.ACC_STATIC; -import static org.objectweb.asm.Opcodes.ALOAD; -import static org.objectweb.asm.Opcodes.ARETURN; -import static org.objectweb.asm.Opcodes.DUP; -import static org.objectweb.asm.Opcodes.F_SAME; -import static org.objectweb.asm.Opcodes.GETSTATIC; -import static org.objectweb.asm.Opcodes.ICONST_1; -import static org.objectweb.asm.Opcodes.IFNULL; -import static org.objectweb.asm.Opcodes.INVOKESPECIAL; -import static org.objectweb.asm.Opcodes.IRETURN; -import static org.objectweb.asm.Opcodes.NEW; -import static org.objectweb.asm.Opcodes.PUTSTATIC; -import static org.objectweb.asm.Opcodes.RETURN; -import static org.objectweb.asm.Type.BOOLEAN_TYPE; -import static org.objectweb.asm.Type.VOID_TYPE; -import static org.objectweb.asm.Type.getMethodDescriptor; - -import java.util.List; - -import net.minecraft.launchwrapper.IClassTransformer; - -import org.objectweb.asm.ClassReader; -import org.objectweb.asm.ClassWriter; -import org.objectweb.asm.Type; -import org.objectweb.asm.tree.AnnotationNode; -import org.objectweb.asm.tree.ClassNode; -import org.objectweb.asm.tree.FieldInsnNode; -import org.objectweb.asm.tree.FieldNode; -import org.objectweb.asm.tree.FrameNode; -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 org.objectweb.asm.tree.TypeInsnNode; -import org.objectweb.asm.tree.VarInsnNode; - -import cpw.mods.fml.common.eventhandler.Event; - -public class EventSubscriptionTransformer implements IClassTransformer { - - public EventSubscriptionTransformer() {} - - @Override - public byte[] transform(String name, String transformedName, byte[] bytes) { - if (bytes == null || name.equals("cpw.mods.fml.common.eventhandler.Event") - || name.startsWith("net.minecraft.") - || name.indexOf('.') == -1) { - return bytes; - } - ClassReader cr = new ClassReader(bytes); - ClassNode classNode = new ClassNode(); - cr.accept(classNode, 0); - - try { - if (buildEvents(classNode)) { - ClassWriter cw = new ClassWriter(COMPUTE_FRAMES); - classNode.accept(cw); - return cw.toByteArray(); - } - return bytes; - } catch (ClassNotFoundException ex) { - // Discard silently- it's just noise - } catch (Exception e) { - e.printStackTrace(); - } - - return bytes; - } - - private boolean buildEvents(ClassNode classNode) throws Exception { - // Yes, this recursively loads classes until we get this base class. THIS IS NOT A ISSUE. Coremods should handle - // re-entry just fine. - // If they do not this a COREMOD issue NOT a Forge/LaunchWrapper issue. - Class parent = this.getClass() - .getClassLoader() - .loadClass(classNode.superName.replace('/', '.')); - if (!Event.class.isAssignableFrom(parent)) { - return false; - } - - // Class listenerListClazz = Class.forName("cpw.mods.fml.common.eventhandler.ListenerList", false, - // getClass().getClassLoader()); - Type tList = Type.getType("Lcpw/mods/fml/common/eventhandler/ListenerList;"); - - boolean edited = false; - boolean hasSetup = false; - boolean hasGetListenerList = false; - boolean hasDefaultCtr = false; - boolean hasCancelable = false; - boolean hasResult = false; - String voidDesc = Type.getMethodDescriptor(VOID_TYPE); - String boolDesc = Type.getMethodDescriptor(BOOLEAN_TYPE); - String listDesc = tList.getDescriptor(); - String listDescM = Type.getMethodDescriptor(tList); - - for (MethodNode method : (List) classNode.methods) { - if (method.name.equals("setup") && method.desc.equals(voidDesc) - && (method.access & ACC_PROTECTED) == ACC_PROTECTED) hasSetup = true; - if ((method.access & ACC_PUBLIC) == ACC_PUBLIC) { - if (method.name.equals("getListenerList") && method.desc.equals(listDescM)) hasGetListenerList = true; - if (method.name.equals("isCancelable") && method.desc.equals(boolDesc)) hasCancelable = true; - if (method.name.equals("hasResult") && method.desc.equals(boolDesc)) hasResult = true; - } - if (method.name.equals("") && method.desc.equals(voidDesc)) hasDefaultCtr = true; - } - - if (classNode.visibleAnnotations != null) { - for (AnnotationNode node : classNode.visibleAnnotations) { - if (!hasResult && node.desc.replace('$', '/') - .equals("Lcpw/mods/fml/common/eventhandler/Event/HasResult;")) { - /* - * Add: public boolean hasResult() { return true; } - */ - MethodNode method = new MethodNode(ACC_PUBLIC, "hasResult", boolDesc, null, null); - method.instructions.add(new InsnNode(ICONST_1)); - method.instructions.add(new InsnNode(IRETURN)); - classNode.methods.add(method); - edited = true; - } else if (!hasCancelable && node.desc.equals("Lcpw/mods/fml/common/eventhandler/Cancelable;")) { - /* - * Add: public boolean isCancelable() { return true; } - */ - MethodNode method = new MethodNode(ACC_PUBLIC, "isCancelable", boolDesc, null, null); - method.instructions.add(new InsnNode(ICONST_1)); - method.instructions.add(new InsnNode(IRETURN)); - classNode.methods.add(method); - edited = true; - } - } - } - - if (hasSetup) { - if (!hasGetListenerList) throw new RuntimeException( - "Event class defines setup() but does not define getListenerList! " + classNode.name); - else return edited; - } - - Type tSuper = Type.getObjectType(classNode.superName); - - // Add private static ListenerList LISTENER_LIST - classNode.fields.add(new FieldNode(ACC_PRIVATE | ACC_STATIC, "LISTENER_LIST", listDesc, null, null)); - - /* - * Add: public () { super(); } - */ - if (!hasDefaultCtr) { - MethodNode method = new MethodNode(ACC_PUBLIC, "", voidDesc, null, null); - method.instructions.add(new VarInsnNode(ALOAD, 0)); - method.instructions - .add(new MethodInsnNode(INVOKESPECIAL, tSuper.getInternalName(), "", voidDesc, false)); - method.instructions.add(new InsnNode(RETURN)); - classNode.methods.add(method); - } - - /* - * Add: protected void setup() { super.setup(); if (LISTENER_LIST != NULL) { return; } LISTENER_LIST = new - * ListenerList(super.getListenerList()); } - */ - MethodNode method = new MethodNode(ACC_PROTECTED, "setup", voidDesc, null, null); - method.instructions.add(new VarInsnNode(ALOAD, 0)); - method.instructions.add(new MethodInsnNode(INVOKESPECIAL, tSuper.getInternalName(), "setup", voidDesc, false)); - method.instructions.add(new FieldInsnNode(GETSTATIC, classNode.name, "LISTENER_LIST", listDesc)); - LabelNode initLisitener = new LabelNode(); - method.instructions.add(new JumpInsnNode(IFNULL, initLisitener)); - method.instructions.add(new InsnNode(RETURN)); - method.instructions.add(initLisitener); - method.instructions.add(new FrameNode(F_SAME, 0, null, 0, null)); - method.instructions.add(new TypeInsnNode(NEW, tList.getInternalName())); - method.instructions.add(new InsnNode(DUP)); - method.instructions.add(new VarInsnNode(ALOAD, 0)); - method.instructions - .add(new MethodInsnNode(INVOKESPECIAL, tSuper.getInternalName(), "getListenerList", listDescM, false)); - method.instructions.add( - new MethodInsnNode( - INVOKESPECIAL, - tList.getInternalName(), - "", - getMethodDescriptor(VOID_TYPE, tList), - false)); - method.instructions.add(new FieldInsnNode(PUTSTATIC, classNode.name, "LISTENER_LIST", listDesc)); - method.instructions.add(new InsnNode(RETURN)); - classNode.methods.add(method); - - /* - * Add: public ListenerList getListenerList() { return this.LISTENER_LIST; } - */ - method = new MethodNode(ACC_PUBLIC, "getListenerList", listDescM, null, null); - method.instructions.add(new FieldInsnNode(GETSTATIC, classNode.name, "LISTENER_LIST", listDesc)); - method.instructions.add(new InsnNode(ARETURN)); - classNode.methods.add(method); - return true; - } -} diff --git a/src/forgePatches/java/cpw/mods/fml/common/asm/transformers/TerminalTransformer.java b/src/forgePatches/java/cpw/mods/fml/common/asm/transformers/TerminalTransformer.java deleted file mode 100644 index 4ee3049..0000000 --- a/src/forgePatches/java/cpw/mods/fml/common/asm/transformers/TerminalTransformer.java +++ /dev/null @@ -1,149 +0,0 @@ -package cpw.mods.fml.common.asm.transformers; - -import net.minecraft.launchwrapper.IClassTransformer; - -import org.objectweb.asm.ClassReader; -import org.objectweb.asm.ClassVisitor; -import org.objectweb.asm.ClassWriter; -import org.objectweb.asm.MethodVisitor; -import org.objectweb.asm.Opcodes; - -import cpw.mods.fml.relauncher.FMLRelaunchLog; -import cpw.mods.fml.relauncher.FMLSecurityManager.ExitTrappedException; - -public class TerminalTransformer implements IClassTransformer { - - @Override - public byte[] transform(String name, String transformedName, byte[] basicClass) { - if (basicClass == null) return null; - ClassReader reader = new ClassReader(basicClass); - ClassWriter writer = new ClassWriter(ClassWriter.COMPUTE_MAXS); - - ClassVisitor visitor = writer; - visitor = new ExitVisitor(visitor); - - reader.accept(visitor, 0); - return writer.toByteArray(); - } - - public static class ExitVisitor extends ClassVisitor { - - private String clsName = null; - private static final String callbackOwner = org.objectweb.asm.Type.getInternalName(ExitVisitor.class); - - private ExitVisitor(ClassVisitor cv) { - // LWJGL3ify patch: ASM5->ASM9 - super(Opcodes.ASM9, cv); - } - - @Override - public void visit(int version, int access, String name, String signature, String superName, - String[] interfaces) { - super.visit(version, access, name, signature, superName, interfaces); - this.clsName = name; - } - - @Override - public MethodVisitor visitMethod(int mAccess, final String mName, final String mDesc, String mSignature, - String[] mExceptions) { - final boolean warn = !(clsName.equals("net/minecraft/client/Minecraft") - || clsName.equals("net/minecraft/server/dedicated/DedicatedServer") - || clsName.equals("cpw/mods/fml/common/FMLCommonHandler") - || clsName.startsWith("com/jcraft/jogg/") - || clsName.startsWith("scala/sys/")); - - // LWJGL3ify patch: ASM5->ASM9 - return new MethodVisitor(Opcodes.ASM9, super.visitMethod(mAccess, mName, mDesc, mSignature, mExceptions)) { - - @Override - public void visitMethodInsn(int opcode, String owner, String name, String desc, boolean isIntf) { - if (opcode == Opcodes.INVOKESTATIC && owner.equals("java/lang/System") - && name.equals("exit") - && desc.equals("(I)V")) { - if (warn) { - FMLRelaunchLog.warning("============================================================="); - FMLRelaunchLog.warning( - "MOD HAS DIRECT REFERENCE System.exit() THIS IS NOT ALLOWED REROUTING TO FML!"); - FMLRelaunchLog.warning("Offendor: %s.%s%s", ExitVisitor.this.clsName, mName, mDesc); - FMLRelaunchLog.warning("Use FMLCommonHandler.exitJava instead"); - FMLRelaunchLog.warning("============================================================="); - } - owner = ExitVisitor.callbackOwner; - name = "systemExitCalled"; - } else if (opcode == Opcodes.INVOKEVIRTUAL && owner.equals("java/lang/Runtime") - && name.equals("exit") - && desc.equals("(I)V")) { - if (warn) { - FMLRelaunchLog.warning("============================================================="); - FMLRelaunchLog.warning( - "MOD HAS DIRECT REFERENCE Runtime.exit() THIS IS NOT ALLOWED REROUTING TO FML!"); - FMLRelaunchLog.warning("Offendor: %s.%s%s", ExitVisitor.this.clsName, mName, mDesc); - FMLRelaunchLog.warning("Use FMLCommonHandler.exitJava instead"); - FMLRelaunchLog.warning("============================================================="); - } - opcode = Opcodes.INVOKESTATIC; - owner = ExitVisitor.callbackOwner; - name = "runtimeExitCalled"; - desc = "(Ljava/lang/Runtime;I)V"; - } else if (opcode == Opcodes.INVOKEVIRTUAL && owner.equals("java/lang/Runtime") - && name.equals("halt") - && desc.equals("(I)V")) { - if (warn) { - FMLRelaunchLog - .warning("============================================================="); - FMLRelaunchLog.warning( - "MOD HAS DIRECT REFERENCE Runtime.halt() THIS IS NOT ALLOWED REROUTING TO FML!"); - FMLRelaunchLog.warning("Offendor: %s.%s%s", ExitVisitor.this.clsName, mName, mDesc); - FMLRelaunchLog.warning("Use FMLCommonHandler.exitJava instead"); - FMLRelaunchLog - .warning("============================================================="); - } - opcode = Opcodes.INVOKESTATIC; - owner = ExitVisitor.callbackOwner; - name = "runtimeHaltCalled"; - desc = "(Ljava/lang/Runtime;I)V"; - } - - super.visitMethodInsn(opcode, owner, name, desc, isIntf); - } - }; - } - - // Intercept System.exit, and check if the caller is allowed to use it, if not wrap it in a ExitTrappedException - public static void systemExitCalled(int status) { - ExitVisitor.checkAccess(); - System.exit(status); - } - - // Intercept Runtime.getRuntime().exit, and check if the caller is allowed to use it, if not wrap it in a - // ExitTrappedException - public static void runtimeExitCalled(Runtime runtime, int status) { - ExitVisitor.checkAccess(); - runtime.exit(status); - } - - // Intercept Runtime.getRuntime().halt, and check if the caller is allowed to use it, if not wrap it in a - // ExitTrappedException - public static void runtimeHaltCalled(Runtime runtime, int status) { - ExitVisitor.checkAccess(); - runtime.halt(status); - } - - private static void checkAccess() { - StackTraceElement[] cause = Thread.currentThread() - .getStackTrace(); - - String callingClass = cause.length > 2 ? cause[3].getClassName() : "none"; - String callingParent = cause.length > 3 ? cause[4].getClassName() : "none"; - // FML is allowed to call system exit and the Minecraft applet (from the quit button), and the dedicated - // server (from itself) - if (!(callingClass.startsWith("cpw.mods.fml.") - || ("net.minecraft.client.Minecraft".equals(callingClass) - && "net.minecraft.client.Minecraft".equals(callingParent)) - || ("net.minecraft.server.dedicated.DedicatedServer".equals(callingClass) - && "net.minecraft.server.MinecraftServer".equals(callingParent)))) { - throw new ExitTrappedException(); - } - } - } -} diff --git a/src/main/java/me/eigenraven/lwjgl3ify/core/Lwjgl3ifyCoremod.java b/src/main/java/me/eigenraven/lwjgl3ify/core/Lwjgl3ifyCoremod.java index 7993b49..109128c 100644 --- a/src/main/java/me/eigenraven/lwjgl3ify/core/Lwjgl3ifyCoremod.java +++ b/src/main/java/me/eigenraven/lwjgl3ify/core/Lwjgl3ifyCoremod.java @@ -98,7 +98,6 @@ public class Lwjgl3ifyCoremod implements IFMLLoadingPlugin, IEarlyMixinLoader { // FML Java 9+ compatibility patches mixins.add("fml.ItemStackHolderRef"); mixins.add("fml.JarDiscoverer"); - mixins.add("fml.ModVisitorAsmVersion"); mixins.add("fml.ObjectHolderRef"); mixins.add("fml.ObjectHolderRegistry"); if (FMLLaunchHandler.side() diff --git a/src/main/java/me/eigenraven/lwjgl3ify/mixins/fml/ModVisitorAsmVersion.java b/src/main/java/me/eigenraven/lwjgl3ify/mixins/fml/ModVisitorAsmVersion.java deleted file mode 100644 index 961cedc..0000000 --- a/src/main/java/me/eigenraven/lwjgl3ify/mixins/fml/ModVisitorAsmVersion.java +++ /dev/null @@ -1,22 +0,0 @@ -package me.eigenraven.lwjgl3ify.mixins.fml; - -import org.objectweb.asm.Opcodes; -import org.spongepowered.asm.mixin.Mixin; -import org.spongepowered.asm.mixin.injection.Constant; -import org.spongepowered.asm.mixin.injection.ModifyConstant; - -import cpw.mods.fml.common.discovery.asm.ModAnnotationVisitor; -import cpw.mods.fml.common.discovery.asm.ModClassVisitor; -import cpw.mods.fml.common.discovery.asm.ModFieldVisitor; -import cpw.mods.fml.common.discovery.asm.ModMethodVisitor; - -@Mixin( - value = { ModClassVisitor.class, ModAnnotationVisitor.class, ModFieldVisitor.class, ModMethodVisitor.class }, - remap = false) -public class ModVisitorAsmVersion { - - @ModifyConstant(method = "*", constant = @Constant(intValue = Opcodes.ASM5), remap = false) - private static int lwjgl3ify$acceptNewerAsm(int original) { - return Opcodes.ASM9; - } -}