R3944Realms/ModernFix
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Modify entity loading semantics on Forge to allow EntityJoinWorldEvent handlers to load chunks

Browse Source
This commit is contained in:
embeddedt 2023-07-03 12:26:57 -04:00
parent ace3975156
commit 3541019ee0
No known key found for this signature in database
GPG Key ID: A69433EC199B5613
4 changed files with 144 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
forge/src/main/java/org/embeddedt/modernfix/forge/ducks/ILevelChunk.java Normal file
View File

@ -0,0 +1,9 @@
package org.embeddedt.modernfix.forge.ducks;
import org.jetbrains.annotations.Nullable;
public interface ILevelChunk {
void setEntityLoadHook(@Nullable Runnable loadHook);
void runEntityLoadHook();
boolean getEntitiesWereLoaded();
}

70
forge/src/main/java/org/embeddedt/modernfix/forge/mixin/bugfix/entity_load_deadlock/ChunkMapMixin.java Normal file
View File

@ -0,0 +1,70 @@
package org.embeddedt.modernfix.forge.mixin.bugfix.entity_load_deadlock;
import com.google.common.collect.Lists;
import net.minecraft.server.level.ChunkHolder;
import net.minecraft.server.level.ChunkMap;
import net.minecraft.server.level.ServerLevel;
import net.minecraft.util.ClassInstanceMultiMap;
import net.minecraft.util.thread.BlockableEventLoop;
import net.minecraft.world.entity.Entity;
import net.minecraft.world.entity.player.Player;
import net.minecraft.world.level.chunk.ChunkAccess;
import net.minecraft.world.level.chunk.ChunkStatus;
import net.minecraft.world.level.chunk.LevelChunk;
import org.embeddedt.modernfix.forge.ducks.ILevelChunk;
import org.spongepowered.asm.mixin.Final;
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.Redirect;
import java.util.List;
@Mixin(ChunkMap.class)
public class ChunkMapMixin {
@Shadow @Final private BlockableEventLoop<Runnable> mainThreadExecutor;
@Shadow @Final private ServerLevel level;
private static final ClassInstanceMultiMap<?>[] NO_ENTITY_SECTIONS = new ClassInstanceMultiMap[0];
/**
* Some mods try to do chunkloading inside EntityJoinWorldEvent, which causes issues. To address this we
* defer the loading of entities from chunks till after we are out of the chunk system.
* <br>
* A different patch is necessary for 1.17+, if the issue can be reproduced there, as entity loading
* works differently.
*/
@Redirect(method = "*(Lnet/minecraft/server/level/ChunkHolder;Lnet/minecraft/world/level/chunk/ChunkAccess;)Lnet/minecraft/world/level/chunk/ChunkAccess;", at = @At(value = "INVOKE", target = "Lnet/minecraft/world/level/chunk/LevelChunk;getEntitySections()[Lnet/minecraft/util/ClassInstanceMultiMap;"))
private ClassInstanceMultiMap<?>[] getEntitySections(LevelChunk chunk, ChunkHolder holder, ChunkAccess access) {
((ILevelChunk)chunk).setEntityLoadHook(() -> {
List<Entity> list = null;
ClassInstanceMultiMap<Entity>[] entitySections = chunk.getEntitySections();
for (ClassInstanceMultiMap<Entity> entitySection : entitySections) {
if(entitySection == null)
continue;
for (Entity entity : entitySection.getAllInstances()) {
if (!(entity instanceof Player) && !this.level.loadFromChunk(entity)) {
if (list == null) {
list = Lists.newArrayList(entity);
} else {
list.add(entity);
}
}
}
}
if (list != null) {
list.forEach(chunk::removeEntity);
}
});
holder.getOrScheduleFuture(ChunkStatus.FULL, (ChunkMap)(Object)this).thenRun(() -> {
// Ensure that this code runs on the main thread, in case another worker handled the future
this.mainThreadExecutor.execute(() -> {
// hook will be cleared when chunk.setLoaded(false) is called, so entities will not load
// if the chunk was already unloaded when we get here
((ILevelChunk)chunk).runEntityLoadHook();
});
});
return NO_ENTITY_SECTIONS;
}
}

40
forge/src/main/java/org/embeddedt/modernfix/forge/mixin/bugfix/entity_load_deadlock/LevelChunkMixin.java Normal file
View File

@ -0,0 +1,40 @@
package org.embeddedt.modernfix.forge.mixin.bugfix.entity_load_deadlock;
import net.minecraft.world.level.chunk.LevelChunk;
import org.embeddedt.modernfix.forge.ducks.ILevelChunk;
import org.jetbrains.annotations.Nullable;
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(LevelChunk.class)
public class LevelChunkMixin implements ILevelChunk {
private Runnable entityLoadHook;
private boolean entitiesWereLoaded = false;
@Override
public void setEntityLoadHook(@Nullable Runnable loadHook) {
entityLoadHook = loadHook;
}
@Inject(method = "setLoaded", at = @At("RETURN"))
private void clearLoadHook(boolean bl, CallbackInfo ci) {
if(!bl)
entityLoadHook = null;
}
@Override
public void runEntityLoadHook() {
if(entityLoadHook != null) {
entityLoadHook.run();
entitiesWereLoaded = true;
entityLoadHook = null;
}
}
@Override
public boolean getEntitiesWereLoaded() {
return entitiesWereLoaded;
}
}

25
forge/src/main/java/org/embeddedt/modernfix/forge/mixin/bugfix/entity_load_deadlock/ServerLevelMixin.java Normal file
View File

@ -0,0 +1,25 @@
package org.embeddedt.modernfix.forge.mixin.bugfix.entity_load_deadlock;
import net.minecraft.server.level.ServerLevel;
import net.minecraft.util.ClassInstanceMultiMap;
import net.minecraft.world.level.chunk.LevelChunk;
import org.embeddedt.modernfix.forge.ducks.ILevelChunk;
import org.spongepowered.asm.mixin.Mixin;
import org.spongepowered.asm.mixin.injection.At;
import org.spongepowered.asm.mixin.injection.Redirect;
@Mixin(ServerLevel.class)
public class ServerLevelMixin {
private static final ClassInstanceMultiMap<?>[] NO_ENTITY_SECTIONS = new ClassInstanceMultiMap[0];
/**
* Need to ensure entities aren't removed from the level when they were never added.
*/
@Redirect(method = "unload", at = @At(value = "INVOKE", target = "Lnet/minecraft/world/level/chunk/LevelChunk;getEntitySections()[Lnet/minecraft/util/ClassInstanceMultiMap;"))
private ClassInstanceMultiMap<?>[] skipUnloadIfNeverLoaded(LevelChunk chunk) {
if(!((ILevelChunk)chunk).getEntitiesWereLoaded()) {
return NO_ENTITY_SECTIONS;
}
return chunk.getEntitySections();
}
}