Dispatch getCapability calls using specialized ASM loop per provider types
Idea suggested by @eigenraven
This commit is contained in:
embeddedt
parent
3f9148fa62
commit
7420a7c7ab
|
|
@ -0,0 +1,42 @@
|
|||
package org.embeddedt.modernfix.common.mixin.perf.faster_capabilities;
|
||||
|
||||
import net.minecraft.core.Direction;
|
||||
import net.minecraftforge.common.capabilities.Capability;
|
||||
import net.minecraftforge.common.capabilities.CapabilityDispatcher;
|
||||
import net.minecraftforge.common.capabilities.CapabilityProvider;
|
||||
import net.minecraftforge.common.capabilities.ICapabilityProvider;
|
||||
import net.minecraftforge.common.util.LazyOptional;
|
||||
import org.embeddedt.modernfix.forge.capability.CapabilityProviderDispatcherGenerator;
|
||||
import org.jetbrains.annotations.Nullable;
|
||||
import org.spongepowered.asm.mixin.Final;
|
||||
import org.spongepowered.asm.mixin.Mixin;
|
||||
import org.spongepowered.asm.mixin.Overwrite;
|
||||
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;
|
||||
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
@Mixin(CapabilityDispatcher.class)
|
||||
public class CapabilityDispatcherMixin {
|
||||
@Shadow
|
||||
@Final
|
||||
private ICapabilityProvider[] caps;
|
||||
private ICapabilityProvider mfix$turboDispatcher;
|
||||
|
||||
@Inject(method = "<init>(Ljava/util/Map;Ljava/util/List;Lnet/minecraftforge/common/capabilities/ICapabilityProvider;)V", at = @At("RETURN"))
|
||||
private void createTurboDispatcher(Map list, List listeners, ICapabilityProvider parent, CallbackInfo ci) {
|
||||
this.mfix$turboDispatcher = CapabilityProviderDispatcherGenerator.getOrGenerateDispatcher(this.caps);
|
||||
}
|
||||
|
||||
/**
|
||||
* @author embeddedt
|
||||
* @reason use ASM-generated dispatcher
|
||||
*/
|
||||
@Overwrite(remap = false)
|
||||
public <T> LazyOptional<T> getCapability(Capability<T> cap, @Nullable Direction side) {
|
||||
return this.mfix$turboDispatcher.getCapability(cap, side);
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,259 @@
|
|||
package org.embeddedt.modernfix.forge.capability;
|
||||
|
||||
import net.minecraftforge.common.capabilities.ICapabilityProvider;
|
||||
import org.embeddedt.modernfix.ModernFix;
|
||||
import org.objectweb.asm.*;
|
||||
import org.objectweb.asm.commons.GeneratorAdapter;
|
||||
import org.objectweb.asm.commons.Method;
|
||||
|
||||
import java.lang.invoke.MethodHandle;
|
||||
import java.lang.invoke.MethodHandles;
|
||||
import java.lang.invoke.MethodType;
|
||||
import java.util.Arrays;
|
||||
import java.util.List;
|
||||
import java.util.concurrent.ConcurrentHashMap;
|
||||
import java.util.concurrent.atomic.AtomicInteger;
|
||||
import java.util.stream.Collectors;
|
||||
|
||||
import static org.objectweb.asm.Opcodes.*;
|
||||
|
||||
/**
|
||||
* Generates optimized hidden classes for ICapabilityProvider dispatch.
|
||||
* Each generated class unrolls the capability provider array into final fields
|
||||
* and performs direct dispatch instead of megamorphic virtual calls.
|
||||
*/
|
||||
public class CapabilityProviderDispatcherGenerator {
|
||||
|
||||
private static final ConcurrentHashMap<List<Class<? extends ICapabilityProvider>>, MethodHandle> cache =
|
||||
new ConcurrentHashMap<>();
|
||||
|
||||
private static final AtomicInteger classCounter = new AtomicInteger(0);
|
||||
private static final MethodHandles.Lookup lookup = MethodHandles.lookup();
|
||||
|
||||
// Type descriptors
|
||||
private static final String ICAP_PROVIDER_DESC = "Lnet/minecraftforge/common/capabilities/ICapabilityProvider;";
|
||||
private static final String CAPABILITY_DESC = "Lnet/minecraftforge/common/capabilities/Capability;";
|
||||
private static final String LAZY_OPTIONAL_DESC = "Lnet/minecraftforge/common/util/LazyOptional;";
|
||||
private static final String DIRECTION_DESC = "Lnet/minecraft/core/Direction;";
|
||||
|
||||
/**
|
||||
* Gets or generates a constructor MethodHandle for the given capability provider types.
|
||||
* The constructor takes an array of ICapabilityProvider instances.
|
||||
*
|
||||
* @param providerTypes The types of capability providers in order
|
||||
* @return A MethodHandle to construct the optimized dispatcher
|
||||
*/
|
||||
private static MethodHandle getOrGenerateConstructor(List<Class<? extends ICapabilityProvider>> providerTypes) {
|
||||
return cache.computeIfAbsent(providerTypes, CapabilityProviderDispatcherGenerator::generateClass);
|
||||
}
|
||||
|
||||
/**
|
||||
* Convenience method that takes an array of providers and returns the constructor.
|
||||
*/
|
||||
private static MethodHandle getOrGenerateConstructor(ICapabilityProvider[] providers) {
|
||||
List<Class<? extends ICapabilityProvider>> types = Arrays.stream(providers)
|
||||
.<Class<? extends ICapabilityProvider>>map(ICapabilityProvider::getClass)
|
||||
.toList();
|
||||
return getOrGenerateConstructor(types);
|
||||
}
|
||||
|
||||
public static ICapabilityProvider getOrGenerateDispatcher(ICapabilityProvider[] providers) {
|
||||
var handle = getOrGenerateConstructor(providers);
|
||||
try {
|
||||
return (ICapabilityProvider)handle.invokeExact((Object)providers);
|
||||
} catch (Throwable e) {
|
||||
throw new RuntimeException("Error constructing dispatcher", e);
|
||||
}
|
||||
}
|
||||
|
||||
private static MethodHandle generateClass(List<Class<? extends ICapabilityProvider>> providerTypes) {
|
||||
ModernFix.LOGGER.debug("Generating capability dispatcher for types: [{}]", providerTypes.stream().map(Class::getName).collect(Collectors.joining(", ")));
|
||||
try {
|
||||
String className = "org.embeddedt.modernfix.forge.capability.CapabilityDispatcher$Generated$" + classCounter.incrementAndGet();
|
||||
byte[] classBytes = generateClassBytes(className, providerTypes);
|
||||
|
||||
// Define the hidden class
|
||||
MethodHandles.Lookup hiddenLookup = lookup.defineHiddenClass(
|
||||
classBytes,
|
||||
true,
|
||||
MethodHandles.Lookup.ClassOption.NESTMATE
|
||||
);
|
||||
|
||||
// Return a MethodHandle to the constructor
|
||||
// Constructor signature: (ICapabilityProvider[])V
|
||||
// The constructor is adapted to take an Object and return an ICapabilityProvider to match
|
||||
// the usage in getOrGenerateDispatcher
|
||||
return hiddenLookup.findConstructor(
|
||||
hiddenLookup.lookupClass(),
|
||||
MethodType.methodType(void.class, ICapabilityProvider[].class)
|
||||
).asType(MethodType.methodType(ICapabilityProvider.class, Object.class));
|
||||
} catch (Exception e) {
|
||||
throw new RuntimeException("Failed to generate capability dispatcher class", e);
|
||||
}
|
||||
}
|
||||
|
||||
private static byte[] generateClassBytes(String className, List<Class<? extends ICapabilityProvider>> providerTypes) {
|
||||
ClassWriter cw = new ClassWriter(ClassWriter.COMPUTE_FRAMES | ClassWriter.COMPUTE_MAXS);
|
||||
|
||||
// Class declaration: implements ICapabilityProvider
|
||||
cw.visit(
|
||||
V17,
|
||||
ACC_PUBLIC | ACC_FINAL | ACC_SUPER,
|
||||
className.replace('.', '/'),
|
||||
null,
|
||||
"java/lang/Object",
|
||||
new String[] { "net/minecraftforge/common/capabilities/ICapabilityProvider" }
|
||||
);
|
||||
|
||||
// Generate final fields for each provider
|
||||
for (int i = 0; i < providerTypes.size(); i++) {
|
||||
cw.visitField(
|
||||
ACC_PRIVATE | ACC_FINAL,
|
||||
"provider" + i,
|
||||
ICAP_PROVIDER_DESC,
|
||||
null,
|
||||
null
|
||||
).visitEnd();
|
||||
}
|
||||
|
||||
// Generate constructor
|
||||
generateConstructor(cw, className, providerTypes.size());
|
||||
|
||||
// Generate getCapability method with sided parameter
|
||||
generateGetCapabilityMethod(cw, className, providerTypes.size());
|
||||
|
||||
cw.visitEnd();
|
||||
return cw.toByteArray();
|
||||
}
|
||||
|
||||
private static void generateConstructor(ClassWriter cw, String className, int providerCount) {
|
||||
Method constructor = Method.getMethod("void <init>(net.minecraftforge.common.capabilities.ICapabilityProvider[])");
|
||||
GeneratorAdapter mg = new GeneratorAdapter(ACC_PUBLIC, constructor, null, null, cw);
|
||||
|
||||
// Call super constructor
|
||||
mg.loadThis();
|
||||
mg.invokeConstructor(Type.getType(Object.class), Method.getMethod("void <init>()"));
|
||||
|
||||
// Unpack array into final fields
|
||||
for (int i = 0; i < providerCount; i++) {
|
||||
mg.loadThis(); // this
|
||||
mg.loadArg(0); // array
|
||||
mg.push(i); // index
|
||||
mg.arrayLoad(Type.getType(ICAP_PROVIDER_DESC)); // array[i]
|
||||
mg.putField(
|
||||
Type.getObjectType(className.replace('.', '/')),
|
||||
"provider" + i,
|
||||
Type.getType(ICAP_PROVIDER_DESC)
|
||||
);
|
||||
}
|
||||
|
||||
mg.returnValue();
|
||||
mg.endMethod();
|
||||
}
|
||||
|
||||
private static void generateGetCapabilityMethod(ClassWriter cw, String className, int providerCount) {
|
||||
// Method: <T> LazyOptional<T> getCapability(Capability<T>, Direction)
|
||||
MethodVisitor mv = cw.visitMethod(
|
||||
ACC_PUBLIC,
|
||||
"getCapability",
|
||||
"(" + CAPABILITY_DESC + DIRECTION_DESC + ")" + LAZY_OPTIONAL_DESC,
|
||||
"<T:Ljava/lang/Object;>(" + CAPABILITY_DESC.replace(";", "<TT;>;") + DIRECTION_DESC + ")" + LAZY_OPTIONAL_DESC.replace(";", "<TT;>;"),
|
||||
null
|
||||
);
|
||||
|
||||
mv.visitCode();
|
||||
|
||||
// Generate unrolled dispatch loop
|
||||
// For each provider, call getCapability and check if present
|
||||
Label endLabel = new Label();
|
||||
|
||||
for (int i = 0; i < providerCount; i++) {
|
||||
Label nextLabel = new Label();
|
||||
|
||||
// LazyOptional<T> result = this.providerN.getCapability(cap, side);
|
||||
mv.visitVarInsn(ALOAD, 0); // this
|
||||
mv.visitFieldInsn(
|
||||
GETFIELD,
|
||||
className.replace('.', '/'),
|
||||
"provider" + i,
|
||||
ICAP_PROVIDER_DESC
|
||||
);
|
||||
mv.visitVarInsn(ALOAD, 1); // cap parameter
|
||||
mv.visitVarInsn(ALOAD, 2); // side parameter
|
||||
mv.visitMethodInsn(
|
||||
INVOKEINTERFACE,
|
||||
"net/minecraftforge/common/capabilities/ICapabilityProvider",
|
||||
"getCapability",
|
||||
"(" + CAPABILITY_DESC + DIRECTION_DESC + ")" + LAZY_OPTIONAL_DESC,
|
||||
true
|
||||
);
|
||||
|
||||
// Store result in local variable
|
||||
mv.visitVarInsn(ASTORE, 3);
|
||||
|
||||
// if (result == null) continue to next;
|
||||
mv.visitVarInsn(ALOAD, 3);
|
||||
mv.visitJumpInsn(IFNULL, nextLabel);
|
||||
|
||||
// if (result.isPresent()) return result;
|
||||
mv.visitVarInsn(ALOAD, 3);
|
||||
mv.visitMethodInsn(
|
||||
INVOKEVIRTUAL,
|
||||
"net/minecraftforge/common/util/LazyOptional",
|
||||
"isPresent",
|
||||
"()Z",
|
||||
false
|
||||
);
|
||||
mv.visitJumpInsn(IFEQ, nextLabel);
|
||||
|
||||
// return result
|
||||
mv.visitVarInsn(ALOAD, 3);
|
||||
mv.visitInsn(ARETURN);
|
||||
|
||||
mv.visitLabel(nextLabel);
|
||||
if (i < providerCount - 1) {
|
||||
mv.visitFrame(Opcodes.F_SAME, 0, null, 0, null);
|
||||
}
|
||||
}
|
||||
|
||||
// If no provider returned a capability, return empty
|
||||
mv.visitLabel(endLabel);
|
||||
mv.visitMethodInsn(
|
||||
INVOKESTATIC,
|
||||
"net/minecraftforge/common/util/LazyOptional",
|
||||
"empty",
|
||||
"()" + LAZY_OPTIONAL_DESC,
|
||||
false
|
||||
);
|
||||
mv.visitInsn(ARETURN);
|
||||
|
||||
mv.visitMaxs(0, 0); // Computed by COMPUTE_MAXS
|
||||
mv.visitEnd();
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates an instance of the optimized dispatcher for the given providers.
|
||||
*/
|
||||
public static ICapabilityProvider createDispatcher(ICapabilityProvider[] providers) {
|
||||
try {
|
||||
MethodHandle constructor = getOrGenerateConstructor(providers);
|
||||
return (ICapabilityProvider) constructor.invoke(providers);
|
||||
} catch (Throwable e) {
|
||||
throw new RuntimeException("Failed to create capability dispatcher instance", e);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Clears the cache of generated classes. Use with caution.
|
||||
*/
|
||||
public static void clearCache() {
|
||||
cache.clear();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the number of cached dispatcher classes.
|
||||
*/
|
||||
public static int getCacheSize() {
|
||||
return cache.size();
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue
Block a user