Implementation of task effort estimation and frame-rate independent task scheduling (CaffeineMC#2887 merge item 1)

Author: douira

common/src/main/java/net/caffeinemc/mods/sodium/client/gl/arena/staging/FallbackStagingBuffer.java

@@ -8,6 +8,8 @@
 import java.nio.ByteBuffer;
 
 public class FallbackStagingBuffer implements StagingBuffer {
+    private static final float BYTES_PER_NANO_LIMIT = 8_000_000.0f / (1_000_000_000.0f / 60.0f); // MB per frame at 60fps
+
     private final GlMutableBuffer fallbackBufferObject;
 
     public FallbackStagingBuffer(CommandList commandList) {
@@ -39,4 +41,9 @@ public void flip() {
     public String toString() {
         return "Fallback";
     }
+
+    @Override
+    public long getUploadSizeLimit(long frameDuration) {
+        return (long) (frameDuration * BYTES_PER_NANO_LIMIT);
+    }
 }

common/src/main/java/net/caffeinemc/mods/sodium/client/gl/arena/staging/MappedStagingBuffer.java

@@ -15,6 +15,8 @@
 import java.util.List;
 
 public class MappedStagingBuffer implements StagingBuffer {
+    private static final float UPLOAD_LIMIT_MARGIN = 0.8f;
+
     private static final EnumBitField<GlBufferStorageFlags> STORAGE_FLAGS =
             EnumBitField.of(GlBufferStorageFlags.PERSISTENT, GlBufferStorageFlags.CLIENT_STORAGE, GlBufferStorageFlags.MAP_WRITE);
 
@@ -163,6 +165,11 @@ public void flip() {
         }
     }
 
+    @Override
+    public long getUploadSizeLimit(long frameDuration) {
+        return (long) (this.capacity * UPLOAD_LIMIT_MARGIN);
+    }
+
     private static final class CopyCommand {
         private final GlBuffer buffer;
         private final long readOffset;

common/src/main/java/net/caffeinemc/mods/sodium/client/gl/arena/staging/StagingBuffer.java

@@ -13,4 +13,6 @@ public interface StagingBuffer {
     void delete(CommandList commandList);
 
     void flip();
+
+    long getUploadSizeLimit(long frameDuration);
 }

common/src/main/java/net/caffeinemc/mods/sodium/client/gui/SodiumGameOptionPages.java

@@ -15,6 +15,7 @@
 import net.caffeinemc.mods.sodium.client.gui.options.control.*;
 import net.caffeinemc.mods.sodium.client.gui.options.storage.MinecraftOptionsStorage;
 import net.caffeinemc.mods.sodium.client.gui.options.storage.SodiumOptionsStorage;
+import net.caffeinemc.mods.sodium.client.render.chunk.DeferMode;
 import net.caffeinemc.mods.sodium.client.render.chunk.translucent_sorting.QuadSplittingMode;
 import net.minecraft.client.*;
 import net.minecraft.network.chat.Component;
@@ -282,12 +283,12 @@ public static OptionPage performance() {
                         .setFlags(OptionFlag.REQUIRES_RENDERER_RELOAD)
                         .build()
                 )
-                .add(OptionImpl.createBuilder(boolean.class, sodiumOpts)
-                        .setName(Component.translatable("sodium.options.always_defer_chunk_updates.name"))
-                        .setTooltip(Component.translatable("sodium.options.always_defer_chunk_updates.tooltip"))
-                        .setControl(TickBoxControl::new)
+                .add(OptionImpl.createBuilder(DeferMode.class, sodiumOpts)
+                        .setName(Component.translatable("sodium.options.defer_chunk_updates.name"))
+                        .setTooltip(Component.translatable("sodium.options.defer_chunk_updates.tooltip"))
+                        .setControl(option -> new CyclingControl<>(option, DeferMode.class))
                         .setImpact(OptionImpact.HIGH)
-                        .setBinding((opts, value) -> opts.performance.alwaysDeferChunkUpdates = value, opts -> opts.performance.alwaysDeferChunkUpdates)
+                        .setBinding((opts, value) -> opts.performance.chunkBuildDeferMode = value, opts -> opts.performance.chunkBuildDeferMode)
                         .setFlags(OptionFlag.REQUIRES_RENDERER_UPDATE)
                         .build())
                 .build()

common/src/main/java/net/caffeinemc/mods/sodium/client/gui/SodiumGameOptions.java

@@ -3,8 +3,8 @@
 import com.google.gson.FieldNamingPolicy;
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
-import com.google.gson.annotations.SerializedName;
 import net.caffeinemc.mods.sodium.client.gui.options.TextProvider;
+import net.caffeinemc.mods.sodium.client.render.chunk.DeferMode;
 import net.caffeinemc.mods.sodium.client.render.chunk.translucent_sorting.QuadSplittingMode;
 import net.caffeinemc.mods.sodium.client.render.chunk.translucent_sorting.SortBehavior;
 import net.caffeinemc.mods.sodium.client.services.PlatformRuntimeInformation;
@@ -41,8 +41,7 @@ public static SodiumGameOptions defaults() {
 
     public static class PerformanceSettings {
         public int chunkBuilderThreads = 0;
-        @SerializedName("always_defer_chunk_updates_v2") // this will reset the option in older configs
-        public boolean alwaysDeferChunkUpdates = true;
+        public DeferMode chunkBuildDeferMode = DeferMode.ALWAYS;
 
         public boolean animateOnlyVisibleTextures = true;
         public boolean useEntityCulling = true;

common/src/main/java/net/caffeinemc/mods/sodium/client/render/SodiumWorldRenderer.java

@@ -191,14 +191,14 @@ public void setupTerrain(Camera camera,
         float fogDistance = RenderSystem.getShaderFog().end();
 
         if (this.lastCameraPos == null) {
-            this.lastCameraPos = new Vector3d(pos);
+            this.lastCameraPos = pos;
         }
         if (this.lastProjectionMatrix == null) {
             this.lastProjectionMatrix = new Matrix4f(projectionMatrix);
         }
         boolean cameraLocationChanged = !pos.equals(this.lastCameraPos);
         boolean cameraAngleChanged = pitch != this.lastCameraPitch || yaw != this.lastCameraYaw || fogDistance != this.lastFogDistance;
-        boolean cameraProjectionChanged = !projectionMatrix.equals(this.lastProjectionMatrix);
+        boolean cameraProjectionChanged = !projectionMatrix.equals(this.lastProjectionMatrix, 0.0001f);
 
         this.lastProjectionMatrix = projectionMatrix;
 
@@ -211,13 +211,13 @@ public void setupTerrain(Camera camera,
 
         this.lastFogDistance = fogDistance;
 
-        this.renderSectionManager.updateCameraState(pos, camera);
+        this.renderSectionManager.prepareFrame(pos);
 
         if (cameraLocationChanged) {
             profiler.popPush("translucent_triggering");
 
             this.renderSectionManager.processGFNIMovement(new CameraMovement(this.lastCameraPos, pos));
-            this.lastCameraPos = new Vector3d(pos);
+            this.lastCameraPos = pos;
         }
 
         int maxChunkUpdates = updateChunksImmediately ? this.renderDistance : 1;

common/src/main/java/net/caffeinemc/mods/sodium/client/render/chunk/ChunkUpdateType.java

@@ -0,0 +1,54 @@
+package net.caffeinemc.mods.sodium.client.render.chunk;
+
+/**
+ * Important: Whether the task is scheduled immediately after its creation. Otherwise, they're scheduled through
+ * asynchronous culling that collects non-important tasks. Defer mode: For important tasks, how fast they are going to
+ * be executed. One or zero frame deferral only allows one or zero frames to pass before the frame blocks on the task.
+ * Always deferral allows the task to be deferred indefinitely, but if it's important it will still be put to the front
+ * of the queue.
+ */
+public class ChunkUpdateTypes {
+    public static final int SORT = 0b001;
+    public static final int REBUILD = 0b010;
+    public static final int IMPORTANT = 0b100;
+    public static final int INITIAL_BUILD = 0b1000;
+
+    public static int join(int from, int to) {
+        return from | to;
+    }
+
+    public static boolean isSort(int type) {
+        return (type & SORT) != 0;
+    }
+
+    public static boolean isRebuild(int type) {
+        return (type & REBUILD) != 0;
+    }
+
+    public static boolean isImportant(int type) {
+        return (type & IMPORTANT) != 0;
+    }
+
+    public static boolean isInitialBuild(int type) {
+        return (type & INITIAL_BUILD) != 0;
+    }
+
+    public static boolean isRebuildWithSort(int type) {
+        return (isRebuild(type) || isInitialBuild(type)) && isSort(type);
+    }
+
+    public static TaskQueueType getQueueType(int type, TaskQueueType importantRebuildQueueType) {
+        if (isInitialBuild(type)) {
+            return TaskQueueType.INITIAL_BUILD;
+        }
+        if (isImportant(type)) {
+            if (isRebuild(type)) {
+                return importantRebuildQueueType;
+            } else { // implies important sort task
+                return TaskQueueType.ZERO_FRAME_DEFER;
+            }
+        } else {
+            return TaskQueueType.ALWAYS_DEFER;
+        }
+    }
+}

common/src/main/java/net/caffeinemc/mods/sodium/client/render/chunk/ChunkUpdateTypes.java

@@ -0,0 +1,27 @@
+package net.caffeinemc.mods.sodium.client.render.chunk;
+
+import net.caffeinemc.mods.sodium.client.gui.options.TextProvider;
+import net.minecraft.network.chat.Component;
+
+public enum DeferMode implements TextProvider {
+    ALWAYS("sodium.options.defer_chunk_updates.always", TaskQueueType.ALWAYS_DEFER),
+    ONE_FRAME("sodium.options.defer_chunk_updates.one_frame", TaskQueueType.ONE_FRAME_DEFER),
+    ZERO_FRAMES("sodium.options.defer_chunk_updates.zero_frames", TaskQueueType.ZERO_FRAME_DEFER);
+
+    private final Component name;
+    private final TaskQueueType importantRebuildQueueType;
+
+    DeferMode(String name, TaskQueueType importantRebuildQueueType) {
+        this.name = Component.translatable(name);
+        this.importantRebuildQueueType = importantRebuildQueueType;
+    }
+
+    @Override
+    public Component getLocalizedName() {
+        return this.name;
+    }
+
+    public TaskQueueType getImportantRebuildQueueType() {
+        return this.importantRebuildQueueType;
+    }
+}

common/src/main/java/net/caffeinemc/mods/sodium/client/render/chunk/DeferMode.java

@@ -1,5 +1,6 @@
 package net.caffeinemc.mods.sodium.client.render.chunk;
 
+import net.caffeinemc.mods.sodium.client.render.chunk.compile.estimation.MeshResultSize;
 import net.caffeinemc.mods.sodium.client.render.chunk.data.BuiltSectionInfo;
 import net.caffeinemc.mods.sodium.client.render.chunk.occlusion.GraphDirection;
 import net.caffeinemc.mods.sodium.client.render.chunk.occlusion.GraphDirectionSet;
@@ -54,9 +55,10 @@ public class RenderSection {
     // Pending Update State
     @Nullable
     private CancellationToken taskCancellationToken = null;
+    private long lastMeshResultSize = MeshResultSize.NO_DATA;
 
-    @Nullable
-    private ChunkUpdateType pendingUpdateType;
+    private int pendingUpdateType;
+    private long pendingUpdateSince;
 
     private int lastUploadFrame = -1;
     private int lastSubmittedFrame = -1;
@@ -179,6 +181,14 @@ private boolean clearRenderState() {
         return wasBuilt;
     }
 
+    public void setLastMeshResultSize(long size) {
+        this.lastMeshResultSize = size;
+    }
+
+    public long getLastMeshResultSize() {
+        return this.lastMeshResultSize;
+    }
+
     /**
      * Returns the chunk section position which this render refers to in the level.
      */
@@ -347,12 +357,21 @@ public void setTaskCancellationToken(@Nullable CancellationToken token) {
         this.taskCancellationToken = token;
     }
 
-    public @Nullable ChunkUpdateType getPendingUpdate() {
+    public int getPendingUpdate() {
         return this.pendingUpdateType;
     }
 
-    public void setPendingUpdate(@Nullable ChunkUpdateType type) {
+    public long getPendingUpdateSince() {
+        return this.pendingUpdateSince;
+    }
+
+    public void setPendingUpdate(int type, long now) {
         this.pendingUpdateType = type;
+        this.pendingUpdateSince = now;
+    }
+
+    public void clearPendingUpdate() {
+        this.pendingUpdateType = 0;
     }
 
     public void prepareTrigger(boolean isDirectTrigger) {