feat: printTpsInfoWhenCantKeepUp

Author: OptiJava

src/main/java/io/github/optijava/opt_carpet_addition/OptCarpetSettings.java

@@ -3,6 +3,7 @@
 //#if MC >= 11900
 //$$ import carpet.api.settings.RuleCategory;
 //#else
+
 import carpet.settings.RuleCategory;
 //#endif
 import carpet.settings.Rule;
@@ -230,4 +231,10 @@ public class OptCarpetSettings {
             options = {"true", "false", "ops"}
     )
     public static String commandLoggerBroadcastToPlayer = FALSE;
+
+    @Rule(
+            desc = "Append tps information in `cant keep up!` logs.",
+            category = RuleCategory.FEATURE
+    )
+    public static boolean printTpsInfoWhenCantKeepUp = false;
 }

src/main/java/io/github/optijava/opt_carpet_addition/mixins/rule/printTpsInfoWhenCantKeepUp/MinecraftServer_Mixin.java

@@ -0,0 +1,50 @@
+package io.github.optijava.opt_carpet_addition.mixins.rule.printTpsInfoWhenCantKeepUp;
+
+import carpet.CarpetServer;
+import io.github.optijava.opt_carpet_addition.OptCarpetAddition;
+import io.github.optijava.opt_carpet_addition.OptCarpetSettings;
+import net.minecraft.server.MinecraftServer;
+//#if MC >= 12004
+//$$ import net.minecraft.server.ServerTickManager;
+//$$ import net.minecraft.util.TimeHelper;
+//#else
+import carpet.helpers.TickSpeed;
+//#endif
+import net.minecraft.util.math.MathHelper;
+import org.spongepowered.asm.mixin.Mixin;
+import org.spongepowered.asm.mixin.injection.At;
+import org.spongepowered.asm.mixin.injection.Inject;
+import org.spongepowered.asm.mixin.injection.callback.CallbackInfo;
+
+@Mixin(MinecraftServer.class)
+public class MinecraftServer_Mixin {
+
+    @Inject(
+            method = "runServer",
+            at = @At(value = "INVOKE", target = "Lorg/apache/logging/log4j/Logger;warn(Ljava/lang/String;Ljava/lang/Object;Ljava/lang/Object;)V", shift = At.Shift.AFTER),
+            remap = false
+    )
+    private void injectRunServer(CallbackInfo ci) {
+        // reference: carpet logger `tps`
+        // carpet.logging.HUDController#126 `send_tps_display(MinecraftServer server)`
+
+        if (OptCarpetSettings.printTpsInfoWhenCantKeepUp) {
+            //#if MC >= 12004
+            //$$ double mspt = (double)CarpetServer.minecraft_server.getAverageNanosPerTick() / (double) TimeHelper.MILLI_IN_NANOS;
+            //$$ ServerTickManager trm = CarpetServer.minecraft_server.getTickManager();
+            //$$ double tps = 1000.0 / Math.max(trm.isSprinting() ? 0.0 : (double)trm.getMillisPerTick(), mspt);
+            //$$ if (trm.isFrozen()) {
+            //$$     tps = 0.0;
+            //$$ }
+            //#else
+            double mspt = MathHelper.average(CarpetServer.minecraft_server.lastTickLengths) * 1.0E-6;
+            double tps = 1000.0 / Math.max(TickSpeed.time_warp_start_time != 0L ? 0.0 : (double) TickSpeed.mspt, mspt);
+            if (TickSpeed.isPaused()) {
+                tps = 0.0;
+            }
+            //#endif
+
+            OptCarpetAddition.LOGGER.warn("Server TPS: %s, MSPT: %s".formatted(tps, mspt));
+        }
+    }
+}

src/main/resources/opt-carpet-addition.mixins.json

@@ -8,7 +8,9 @@
   "compatibilityLevel": "JAVA_16",
   //#endif
   "mixins": [
-    //#if MC < 11900
+    "logger.HUDController_Mixin",
+    "logger.blockUpdate.LoggerRegistry_Mixin",
+    "logger.blockUpdate.World_Mixin",
     "logger.updateSuppression.World_Mixin",
     "rule.async.MinecraftServer_Mixin",
     "rule.async.optimizePlayerConnect.EntityTrackerEntry_Mixin",
@@ -18,37 +20,22 @@
     "rule.async.optimizePlayerConnect.World_Mixin",
     "rule.async.optimizeTeleport.ServerPlayerEntity_Mixin",
     "rule.async.optimizeTeleport.ServerPlayNetworkHandler_Mixin",
-    "rule.disabledUpdateSuppressionErrorStackTrace.ThreadExecutor_Mixin",
-    "rule.dropperCrashFix.DispenserBlock_Mixin",
-    "rule.dropperCrashFix.DropperBlock_Mixin",
-    //#if MC >= 11800
-    //$$ "rule.disabledUpdateSuppressionErrorStackTrace.NetworkThreadUtils_Mixin",
-    //#endif
-    //#endif
-    "logger.HUDController_Mixin",
     "rule.cceSuppressionCrashFix.MinecraftServer_Mixin",
     "rule.cceSuppressionCrashFix.ShulkerBoxBlock_Mixin",
     "rule.commandLogger.CommandManager_Mixin",
+    "rule.customItemDiscardTime.ItemEntity_Mixin",
     "rule.disabledEnderManPickupGoal.EnderManEntity_Mixin",
     "rule.disabledEnderManPlaceBlockGoal.EndermanEntity_Mixin",
     "rule.disabledEntityTick.ServerWorld_Mixin",
     "rule.disabledLayEggs.ChickenEntity_Mixin",
     "rule.disabledNetherPortalSpawn.NetherPortalBlock_Mixin",
+    "rule.disabledUpdateSuppressionErrorStackTrace.ThreadExecutor_Mixin",
+    "rule.dropperCrashFix.DispenserBlock_Mixin",
+    "rule.dropperCrashFix.DropperBlock_Mixin",
     "rule.optimizeFakePlayerSpawn.EntityPlayerMPFake_Mixin",
     "rule.optimizeFakePlayerSpawn.PlayerCommand_Mixin",
+    "rule.printTpsInfoWhenCantKeepUp.MinecraftServer_Mixin",
     "rule.removeAllCurseOfBindingArmorWhenPlayerDeadInWall.ServerPlayerEntity_Mixin",
-    //#if MC >= 12000
-    //$$ "rule.disallowRedstoneWireConnectsToOpenTrapdoor.RedstoneWireBlock_Mixin",
-    //#endif
-    //#if MC >= 11900
-    //$$ "logger.blockUpdate.SimpleNeighborUpdater_Mixin",
-    //$$ "logger.blockUpdate.ChainRestrictedNeighborUpdater_Mixin",
-    //#endif
-    //#if MC <= 11900
-    "logger.blockUpdate.World_Mixin",
-    //#endif
-    "rule.customItemDiscardTime.ItemEntity_Mixin",
-    "logger.blockUpdate.LoggerRegistry_Mixin",
     "rule.removeBats.BatEntity_Mixin"
   ],
   "client": [