Reset graphics, bufferbuilders, and TESR dispatcher after crash

Runemoro · Runemoro · commit 35fc330095fe · 2018-06-16T13:42:41.000-04:00
Fixes #78 Fixes #50
diff --git a/src/main/java/org/dimdev/utils/GlUtil.java b/src/main/java/org/dimdev/utils/GlUtil.java
@@ -0,0 +1,155 @@
+package org.dimdev.utils;
+
+import net.minecraft.client.renderer.GlStateManager;
+import net.minecraft.client.renderer.OpenGlHelper;
+import net.minecraft.client.renderer.RenderHelper;
+import org.lwjgl.opengl.*;
+
+public class GlUtil {
+    public static void resetState() {
+        // Clear matrix stack
+        GlStateManager.matrixMode(GL11.GL_MODELVIEW);
+        GlStateManager.loadIdentity();
+        GlStateManager.matrixMode(GL11.GL_PROJECTION);
+        GlStateManager.loadIdentity();
+        GlStateManager.matrixMode(GL11.GL_TEXTURE);
+        GlStateManager.loadIdentity();
+        GlStateManager.matrixMode(GL11.GL_COLOR);
+        GlStateManager.loadIdentity();
+
+        // Clear attribute stacks TODO: Broken, a stack underflow breaks LWJGL
+        // try {
+        //     do GL11.glPopAttrib(); while (GlStateManager.glGetError() == 0);
+        // } catch (Throwable ignored) {}
+        //
+        // try {
+        //     do GL11.glPopClientAttrib(); while (GlStateManager.glGetError() == 0);
+        // } catch (Throwable ignored) {}
+
+        // Reset texture
+        GlStateManager.bindTexture(0);
+        GlStateManager.disableTexture2D();
+
+        // Reset GL lighting
+        GlStateManager.disableLighting();
+        GlStateManager.glLightModel(GL11.GL_LIGHT_MODEL_AMBIENT, RenderHelper.setColorBuffer(0.2F, 0.2F, 0.2F, 1.0F));
+        for (int i = 0; i < 8; ++i) {
+            GlStateManager.disableLight(i);
+            GlStateManager.glLight(GL11.GL_LIGHT0 + i, GL11.GL_AMBIENT, RenderHelper.setColorBuffer(0.0F, 0.0F, 0.0F, 1.0F));
+            GlStateManager.glLight(GL11.GL_LIGHT0 + i, GL11.GL_POSITION, RenderHelper.setColorBuffer(0.0F, 0.0F, 1.0F, 0.0F));
+
+            if (i == 0) {
+                GlStateManager.glLight(GL11.GL_LIGHT0 + i, GL11.GL_DIFFUSE, RenderHelper.setColorBuffer(1.0F, 1.0F, 1.0F, 1.0F));
+                GlStateManager.glLight(GL11.GL_LIGHT0 + i, GL11.GL_SPECULAR, RenderHelper.setColorBuffer(1.0F, 1.0F, 1.0F, 1.0F));
+            } else {
+                GlStateManager.glLight(GL11.GL_LIGHT0 + i, GL11.GL_DIFFUSE, RenderHelper.setColorBuffer(0.0F, 0.0F, 0.0F, 1.0F));
+                GlStateManager.glLight(GL11.GL_LIGHT0 + i, GL11.GL_SPECULAR, RenderHelper.setColorBuffer(0.0F, 0.0F, 0.0F, 1.0F));
+            }
+        }
+        GlStateManager.disableColorMaterial();
+        GlStateManager.colorMaterial(1032, 5634);
+
+        // Reset depth
+        GlStateManager.disableDepth();
+        GlStateManager.depthFunc(513);
+        GlStateManager.depthMask(true);
+
+        // Reset blend mode
+        GlStateManager.disableBlend();
+        GlStateManager.blendFunc(GlStateManager.SourceFactor.ONE, GlStateManager.DestFactor.ZERO);
+        GlStateManager.tryBlendFuncSeparate(GlStateManager.SourceFactor.ONE, GlStateManager.DestFactor.ZERO, GlStateManager.SourceFactor.ONE, GlStateManager.DestFactor.ZERO);
+        GlStateManager.glBlendEquation(GL14.GL_FUNC_ADD);
+
+        // Reset fog
+        GlStateManager.disableFog();
+        GlStateManager.setFog(GlStateManager.FogMode.LINEAR);
+        GlStateManager.setFogDensity(1.0F);
+        GlStateManager.setFogStart(0.0F);
+        GlStateManager.setFogEnd(1.0F);
+        GlStateManager.glFog(GL11.GL_FOG_COLOR, RenderHelper.setColorBuffer(0.0F, 0.0F, 0.0F, 0.0F));
+        if (GLContext.getCapabilities().GL_NV_fog_distance) GlStateManager.glFogi(GL11.GL_FOG_MODE, 34140);
+
+        // Reset polygon offset
+        GlStateManager.doPolygonOffset(0.0F, 0.0F);
+        GlStateManager.disablePolygonOffset();
+
+        // Reset color logic
+        GlStateManager.disableColorLogic();
+        GlStateManager.colorLogicOp(5379);
+
+        // Reset texgen TODO: is this correct?
+        GlStateManager.disableTexGenCoord(GlStateManager.TexGen.S);
+        GlStateManager.disableTexGenCoord(GlStateManager.TexGen.T);
+        GlStateManager.disableTexGenCoord(GlStateManager.TexGen.R);
+        GlStateManager.disableTexGenCoord(GlStateManager.TexGen.Q);
+        GlStateManager.texGen(GlStateManager.TexGen.S, 9216);
+        GlStateManager.texGen(GlStateManager.TexGen.T, 9216);
+        GlStateManager.texGen(GlStateManager.TexGen.R, 9216);
+        GlStateManager.texGen(GlStateManager.TexGen.Q, 9216);
+        GlStateManager.texGen(GlStateManager.TexGen.S, 9474, RenderHelper.setColorBuffer(1.0F, 0.0F, 0.0F, 0.0F));
+        GlStateManager.texGen(GlStateManager.TexGen.T, 9474, RenderHelper.setColorBuffer(0.0F, 1.0F, 0.0F, 0.0F));
+        GlStateManager.texGen(GlStateManager.TexGen.R, 9474, RenderHelper.setColorBuffer(0.0F, 0.0F, 1.0F, 0.0F));
+        GlStateManager.texGen(GlStateManager.TexGen.Q, 9474, RenderHelper.setColorBuffer(0.0F, 0.0F, 0.0F, 1.0F));
+        GlStateManager.texGen(GlStateManager.TexGen.S, 9217, RenderHelper.setColorBuffer(1.0F, 0.0F, 0.0F, 0.0F));
+        GlStateManager.texGen(GlStateManager.TexGen.T, 9217, RenderHelper.setColorBuffer(0.0F, 1.0F, 0.0F, 0.0F));
+        GlStateManager.texGen(GlStateManager.TexGen.R, 9217, RenderHelper.setColorBuffer(0.0F, 0.0F, 1.0F, 0.0F));
+        GlStateManager.texGen(GlStateManager.TexGen.Q, 9217, RenderHelper.setColorBuffer(0.0F, 0.0F, 0.0F, 1.0F));
+
+        // Disable lightmap
+        GlStateManager.setActiveTexture(OpenGlHelper.lightmapTexUnit);
+        GlStateManager.disableTexture2D();
+
+        GlStateManager.setActiveTexture(OpenGlHelper.defaultTexUnit);
+
+        // Reset texture parameters
+        GlStateManager.glTexParameteri(GL11.GL_TEXTURE_2D, GL11.GL_TEXTURE_MAG_FILTER, GL11.GL_LINEAR);
+        GlStateManager.glTexParameteri(GL11.GL_TEXTURE_2D, GL11.GL_TEXTURE_MIN_FILTER, GL11.GL_NEAREST_MIPMAP_LINEAR);
+        GlStateManager.glTexParameteri(GL11.GL_TEXTURE_2D, GL11.GL_TEXTURE_WRAP_S, GL11.GL_REPEAT);
+        GlStateManager.glTexParameteri(GL11.GL_TEXTURE_2D, GL11.GL_TEXTURE_WRAP_T, GL11.GL_REPEAT);
+        GlStateManager.glTexParameteri(GL11.GL_TEXTURE_2D, GL12.GL_TEXTURE_MAX_LEVEL, 1000);
+        GlStateManager.glTexParameteri(GL11.GL_TEXTURE_2D, GL12.GL_TEXTURE_MAX_LOD, 1000);
+        GlStateManager.glTexParameteri(GL11.GL_TEXTURE_2D, GL12.GL_TEXTURE_MIN_LOD, -1000);
+        GlStateManager.glTexParameterf(GL11.GL_TEXTURE_2D, GL14.GL_TEXTURE_LOD_BIAS, 0.0F);
+
+        GlStateManager.glTexEnvi(GL11.GL_TEXTURE_ENV, GL11.GL_TEXTURE_ENV_MODE, GL11.GL_MODULATE);
+        GlStateManager.glTexEnv(GL11.GL_TEXTURE_ENV, GL11.GL_TEXTURE_ENV_COLOR, RenderHelper.setColorBuffer(0.0F, 0.0F, 0.0F, 0.0F));
+        GlStateManager.glTexEnvi(GL11.GL_TEXTURE_ENV, GL13.GL_COMBINE_RGB, GL11.GL_MODULATE);
+        GlStateManager.glTexEnvi(GL11.GL_TEXTURE_ENV, GL13.GL_COMBINE_ALPHA, GL11.GL_MODULATE);
+        GlStateManager.glTexEnvi(GL11.GL_TEXTURE_ENV, GL15.GL_SRC0_RGB, GL11.GL_TEXTURE);
+        GlStateManager.glTexEnvi(GL11.GL_TEXTURE_ENV, GL15.GL_SRC1_RGB, GL13.GL_PREVIOUS);
+        GlStateManager.glTexEnvi(GL11.GL_TEXTURE_ENV, GL15.GL_SRC2_RGB, GL13.GL_CONSTANT);
+        GlStateManager.glTexEnvi(GL11.GL_TEXTURE_ENV, GL15.GL_SRC0_ALPHA, GL11.GL_TEXTURE);
+        GlStateManager.glTexEnvi(GL11.GL_TEXTURE_ENV, GL15.GL_SRC1_ALPHA, GL13.GL_PREVIOUS);
+        GlStateManager.glTexEnvi(GL11.GL_TEXTURE_ENV, GL15.GL_SRC2_ALPHA, GL13.GL_CONSTANT);
+        GlStateManager.glTexEnvi(GL11.GL_TEXTURE_ENV, GL13.GL_OPERAND0_RGB, GL11.GL_SRC_COLOR);
+        GlStateManager.glTexEnvi(GL11.GL_TEXTURE_ENV, GL13.GL_OPERAND1_RGB, GL11.GL_SRC_COLOR);
+        GlStateManager.glTexEnvi(GL11.GL_TEXTURE_ENV, GL13.GL_OPERAND2_RGB, GL11.GL_SRC_ALPHA);
+        GlStateManager.glTexEnvi(GL11.GL_TEXTURE_ENV, GL13.GL_OPERAND0_ALPHA, GL11.GL_SRC_ALPHA);
+        GlStateManager.glTexEnvi(GL11.GL_TEXTURE_ENV, GL13.GL_OPERAND1_ALPHA, GL11.GL_SRC_ALPHA);
+        GlStateManager.glTexEnvi(GL11.GL_TEXTURE_ENV, GL13.GL_OPERAND2_ALPHA, GL11.GL_SRC_ALPHA);
+        GlStateManager.glTexEnvf(GL11.GL_TEXTURE_ENV, GL13.GL_RGB_SCALE, 1.0F);
+        GlStateManager.glTexEnvf(GL11.GL_TEXTURE_ENV, GL11.GL_ALPHA_SCALE, 1.0F);
+
+        GlStateManager.disableNormalize();
+        GlStateManager.shadeModel(7425);
+        GlStateManager.disableRescaleNormal();
+        GlStateManager.colorMask(true, true, true, true);
+        GlStateManager.clearDepth(1.0D);
+        GlStateManager.glLineWidth(1.0F);
+        GlStateManager.glNormal3f(0.0F, 0.0F, 1.0F);
+        GlStateManager.glPolygonMode(GL11.GL_FRONT, GL11.GL_FILL);
+        GlStateManager.glPolygonMode(GL11.GL_BACK, GL11.GL_FILL);
+
+        GlStateManager.enableTexture2D();
+        GlStateManager.shadeModel(7425);
+        GlStateManager.clearDepth(1.0D);
+        GlStateManager.enableDepth();
+        GlStateManager.depthFunc(515);
+        GlStateManager.enableAlpha();
+        GlStateManager.alphaFunc(516, 0.1F);
+        GlStateManager.cullFace(GlStateManager.CullFace.BACK);
+        GlStateManager.matrixMode(5889);
+        GlStateManager.loadIdentity();
+        GlStateManager.matrixMode(5888);
+    }
+}
diff --git a/src/main/java/org/dimdev/vanillafix/crashes/StateManager.java b/src/main/java/org/dimdev/vanillafix/crashes/StateManager.java
@@ -0,0 +1,36 @@
+package org.dimdev.vanillafix.crashes;
+
+import java.lang.ref.WeakReference;
+import java.util.HashSet;
+import java.util.Iterator;
+import java.util.Set;
+
+/**
+ * Allows registering objects to be reset after a crash. Objects registered
+ * use WeakReferences, so they will be garbage-collected despite still being
+ * registered here.
+ */
+public class StateManager {
+    public interface IResettable {
+        default void register() {
+            resettableRefs.add(new WeakReference<>(this));
+        }
+
+        void resetState();
+    }
+
+    // Use WeakReference to allow garbage collection, preventing memory leaks
+    private static Set<WeakReference<IResettable>> resettableRefs = new HashSet<>();
+
+    public static void resetStates() {
+        Iterator<WeakReference<IResettable>> iterator = resettableRefs.iterator();
+        while (iterator.hasNext()) {
+            WeakReference<IResettable> ref = iterator.next();
+            if (ref.get() != null) {
+                ref.get().resetState();
+            } else {
+                iterator.remove();
+            }
+        }
+    }
+}
diff --git a/src/main/java/org/dimdev/vanillafix/crashes/mixins/client/MixinBufferBuilder.java b/src/main/java/org/dimdev/vanillafix/crashes/mixins/client/MixinBufferBuilder.java
@@ -0,0 +1,25 @@
+package org.dimdev.vanillafix.crashes.mixins.client;
+
+import net.minecraft.client.renderer.BufferBuilder;
+import org.dimdev.vanillafix.crashes.StateManager;
+import org.spongepowered.asm.mixin.Mixin;
+import org.spongepowered.asm.mixin.Shadow;
+import org.spongepowered.asm.mixin.injection.At;
+import org.spongepowered.asm.mixin.injection.Inject;
+import org.spongepowered.asm.mixin.injection.callback.CallbackInfo;
+
+@Mixin(BufferBuilder.class)
+public abstract class MixinBufferBuilder implements StateManager.IResettable {
+    @Shadow private boolean isDrawing;
+    @Shadow public abstract void finishDrawing();
+
+    @Inject(method = "<init>", at = @At(value = "RETURN"))
+    public void onInit(int bufferSizeIn, CallbackInfo ci) {
+        register();
+    }
+
+    @Override
+    public void resetState() {
+        if (isDrawing) finishDrawing();
+    }
+}
diff --git a/src/main/java/org/dimdev/vanillafix/crashes/mixins/client/MixinMinecraft.java b/src/main/java/org/dimdev/vanillafix/crashes/mixins/client/MixinMinecraft.java
@@ -1,6 +1,7 @@
 package org.dimdev.vanillafix.crashes.mixins.client;
 
 import com.google.common.util.concurrent.ListenableFutureTask;
+import net.minecraft.client.LoadingScreenRenderer;
 import net.minecraft.client.Minecraft;
 import net.minecraft.client.audio.SoundHandler;
 import net.minecraft.client.gui.*;
@@ -26,6 +27,7 @@
 import net.minecraft.util.text.TextComponentString;
 import net.minecraftforge.fml.client.SplashProgress;
 import org.apache.logging.log4j.Logger;
+import org.dimdev.utils.GlUtil;
 import org.dimdev.vanillafix.ModConfig;
 import org.dimdev.vanillafix.VanillaFix;
 import org.dimdev.vanillafix.VanillaFixLoadingPlugin;
@@ -97,6 +99,7 @@ public abstract class MixinMinecraft implements IThreadListener, ISnooperInfo, I
     @Shadow protected abstract void checkGLError(String message);
     // @formatter:on
 
+    @Shadow public LoadingScreenRenderer loadingScreen;
     private boolean crashIntegratedServerNextTick;
     private int clientCrashCount = 0;
     private int serverCrashCount = 0;
@@ -126,15 +129,15 @@ public void run() {
                         clientCrashCount++;
                         addGraphicsAndWorldToCrashReport(e.getCrashReport());
                         addInfoToCrash(e.getCrashReport());
-                        freeMemory();
+                        resetGameState();
                         LOGGER.fatal("Reported exception thrown!", e);
                         displayCrashScreen(e.getCrashReport());
                     } catch (Throwable e) {
                         clientCrashCount++;
                         CrashReport report = new CrashReport("Unexpected error", e);
                         addGraphicsAndWorldToCrashReport(report);
                         addInfoToCrash(report);
-                        freeMemory();
+                        resetGameState();
                         LOGGER.fatal("Unreported exception thrown!", e);
                         displayCrashScreen(report);
                     }
@@ -246,7 +249,7 @@ private void runGUILoop(GuiScreen screen) throws IOException {
         }
     }
 
-    public void displayCrashScreen(CrashReport report) { // TODO: Shouldn't the GL state be reset here and on displayInitErrorScreen?
+    public void displayCrashScreen(CrashReport report) {
         try {
             CrashUtils.outputReport(report);
 
@@ -275,61 +278,62 @@ public void displayCrashReport(CrashReport report) {
         CrashUtils.outputReport(report);
     }
 
-    /**
-     * @reason Disconnect from the current world and free memory, using a memory reserve
-     * to make sure that an OutOfMemory doesn't happen while doing this.
-     * <p>
-     * Bugs Fixed:
-     * - https://bugs.mojang.com/browse/MC-128953
-     * - Memory reserve not recreated after out-of memory
-     */
-    @Overwrite
-    @SuppressWarnings("CallToSystemGC")
-    public void freeMemory() {
-        int originalMemoryReserveSize = -1;
+    public void resetGameState() {
         try {
-            // Separate try in case another mod actually deletes the memoryReserve field
-            if (memoryReserve != null) {
-                originalMemoryReserveSize = memoryReserve.length;
-                memoryReserve = new byte[0];
-            }
-        } catch (Throwable ignored) {}
-
-        try {
-            renderGlobal.deleteAllDisplayLists();
-        } catch (Throwable ignored) {}
+            // Free up memory such that this works properly in case of an OutOfMemoryError
+            int originalMemoryReserveSize = -1;
+            try { // In case another mod actually deletes the memoryReserve field
+                if (memoryReserve != null) {
+                    originalMemoryReserveSize = memoryReserve.length;
+                    memoryReserve = new byte[0];
+                }
+            } catch (Throwable ignored) {}
 
-        try {
-            System.gc();
+            // Reset registered resettables
+            StateManager.resetStates();
 
-            // Fix: Close the connection to avoid receiving packets from old server
-            // when playing in another world (MC-128953)
+            // Close the world
             if (getConnection() != null) {
+                // Fix: Close the connection to avoid receiving packets from old server
+                // when playing in another world (MC-128953)
                 getConnection().getNetworkManager().closeChannel(new TextComponentString("[VanillaFix] Client crashed"));
             }
-
             loadWorld(null);
+            if (entityRenderer.isShaderActive()) entityRenderer.stopUseShader();
+            scheduledTasks.clear(); // TODO: Figure out why this isn't necessary for vanilla disconnect
 
-            // TODO: Figure out why this isn't necessary for vanilla disconnect:
-            scheduledTasks.clear();
+            // Reset graphics
+            GlUtil.resetState();
 
-            // Fix: Probably not necessary, but do this now rathe than next tick to
-            // make it identical to a regular disconnect:
-            if (entityRenderer.isShaderActive()) {
-                entityRenderer.stopUseShader();
+            // Re-create memory reserve so that future crashes work well too
+            if (originalMemoryReserveSize != -1) {
+                try {
+                    memoryReserve = new byte[originalMemoryReserveSize];
+                } catch (Throwable ignored) {}
             }
-        } catch (Throwable ignored) {}
-
-        System.gc();
-
-        // Fix: Re-create memory reserve so that future crashes work well too
-        if (originalMemoryReserveSize != -1) {
+            System.gc();
+        } catch (Throwable t) {
+            LOGGER.error("Failed to reset state after a crash", t);
             try {
-                memoryReserve = new byte[originalMemoryReserveSize];
+                StateManager.resetStates();
+                GlUtil.resetState();
             } catch (Throwable ignored) {}
         }
     }
 
+    /**
+     * @reason Disconnect from the current world and free memory, using a memory reserve
+     * to make sure that an OutOfMemory doesn't happen while doing this.
+     * <p>
+     * Bugs Fixed:
+     * - https://bugs.mojang.com/browse/MC-128953
+     * - Memory reserve not recreated after out-of memory
+     */
+    @Overwrite
+    public void freeMemory() {
+        resetGameState();
+    }
+
     /**
      * @reason Replaces the vanilla F3 + C logic to immediately crash rather than requiring
      * that the buttons are pressed for 6 seconds and add more crash types:
@@ -377,6 +381,10 @@ private long checkForF3C(Minecraft mc) {
         return -1;
     }
 
+    private void breakRendering() {
+        getTextureManager().bindTexture(Gui.OPTIONS_BACKGROUND);
+    }
+
     /** @reason Disables the vanilla F3 + C logic. */
     @Redirect(method = "runTickKeyboard", at = @At(value = "INVOKE", target = "Lorg/lwjgl/input/Keyboard;isKeyDown(I)Z", ordinal = 0))
     private boolean isKeyDownF3(int key) {
diff --git a/src/main/java/org/dimdev/vanillafix/crashes/mixins/client/MixinTileEntityRenderDispatcher.java b/src/main/java/org/dimdev/vanillafix/crashes/mixins/client/MixinTileEntityRenderDispatcher.java
diff --git a/src/main/resources/mixins.vanillafix.crashes.json b/src/main/resources/mixins.vanillafix.crashes.json
