/*
* This file is part of Mixin, licensed under the MIT License (MIT).
*
* Copyright (c) SpongePowered <https://www.spongepowered.org>
* Copyright (c) contributors
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package org.spongepowered.asm.mixin.injection.code;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.spongepowered.asm.lib.Opcodes;
import org.spongepowered.asm.lib.Type;
import org.spongepowered.asm.lib.tree.AbstractInsnNode;
import org.spongepowered.asm.lib.tree.ClassNode;
import org.spongepowered.asm.lib.tree.InsnList;
import org.spongepowered.asm.lib.tree.InsnNode;
import org.spongepowered.asm.lib.tree.LdcInsnNode;
import org.spongepowered.asm.lib.tree.MethodInsnNode;
import org.spongepowered.asm.lib.tree.MethodNode;
import org.spongepowered.asm.lib.tree.TypeInsnNode;
import org.spongepowered.asm.mixin.MixinEnvironment.Option;
import org.spongepowered.asm.mixin.injection.InjectionNodes.InjectionNode;
import org.spongepowered.asm.mixin.injection.InjectionPoint;
import org.spongepowered.asm.mixin.injection.struct.InjectionInfo;
import org.spongepowered.asm.mixin.injection.struct.Target;
import org.spongepowered.asm.mixin.injection.throwables.InvalidInjectionException;
import org.spongepowered.asm.util.Bytecode;
import com.google.common.base.Joiner;
/**
* Base class for bytecode injectors
*/
public abstract class Injector {
/**
* A nominated target node
*/
class TargetNode {
final AbstractInsnNode node;
final Set<InjectionPoint> nominators = new HashSet<InjectionPoint>();
TargetNode(AbstractInsnNode node) {
this.node = node;
}
}
/**
* Log more things
*/
protected static final Logger logger = LogManager.getLogger("mixin");
/**
* Injection info
*/
protected InjectionInfo info;
/**
* Class node
*/
protected final ClassNode classNode;
/**
* Callback method
*/
protected final MethodNode methodNode;
/**
* Arguments of the handler method
*/
protected final Type[] methodArgs;
/**
* Return type of the handler method
*/
protected final Type returnType;
/**
* True if the callback method is static
*/
protected final boolean isStatic;
/**
* Make a new CallbackInjector for the supplied InjectionInfo
*
* @param info Information about this injection
*/
public Injector(InjectionInfo info) {
this(info.getClassNode(), info.getMethod());
this.info = info;
}
/**
* Make a new CallbackInjector with the supplied args
*
* @param classNode Class containing callback and target methods
* @param methodNode Callback method
*/
private Injector(ClassNode classNode, MethodNode methodNode) {
this.classNode = classNode;
this.methodNode = methodNode;
this.methodArgs = Type.getArgumentTypes(this.methodNode.desc);
this.returnType = Type.getReturnType(this.methodNode.desc);
this.isStatic = Bytecode.methodIsStatic(this.methodNode);
}
@Override
public String toString() {
return String.format("%s::%s", this.classNode.name, this.methodNode.name);
}
/**
* ...
*
* @param injectorTarget Target method to inject into
* @param injectionPoints InjectionPoint instances which will identify
* target insns in the target method
* @return discovered injection points
*/
public final List<InjectionNode> find(InjectorTarget injectorTarget, List<InjectionPoint> injectionPoints) {
this.sanityCheck(injectorTarget.getTarget(), injectionPoints);
List<InjectionNode> myNodes = new ArrayList<InjectionNode>();
for (TargetNode node : this.findTargetNodes(injectorTarget, injectionPoints)) {
this.addTargetNode(injectorTarget.getTarget(), myNodes, node.node, node.nominators);
}
return myNodes;
}
protected void addTargetNode(Target target, List<InjectionNode> myNodes, AbstractInsnNode node, Set<InjectionPoint> nominators) {
myNodes.add(target.injectionNodes.add(node));
}
/**
* Performs the injection on the specified target
*
* @param target target to inject into
* @param nodes selected nodes
*/
public final void inject(Target target, List<InjectionNode> nodes) {
for (InjectionNode node : nodes) {
if (node.isRemoved()) {
if (this.info.getContext().getOption(Option.DEBUG_VERBOSE)) {
Injector.logger.warn("Target node for {} was removed by a previous injector in {}", this.info, target);
}
continue;
}
this.inject(target, node);
}
for (InjectionNode node : nodes) {
this.postInject(target, node);
}
}
/**
* Use the supplied InjectionPoints to find target insns in the target
* method
*
* @param target.method Target method
* @param injectionPoints List of injection points parsed from At
* annotations on the callback method
* @return Target insn nodes in the target method
*/
private Collection<TargetNode> findTargetNodes(InjectorTarget injectorTarget, List<InjectionPoint> injectionPoints) {
Map<AbstractInsnNode, TargetNode> targetNodes = new HashMap<AbstractInsnNode, TargetNode>();
Collection<AbstractInsnNode> nodes = new ArrayList<AbstractInsnNode>(32);
for (InjectionPoint injectionPoint : injectionPoints) {
nodes.clear();
if (this.findTargetNodes(injectorTarget.getMethod(), injectionPoint, injectorTarget.getSlice(injectionPoint), nodes)) {
for (AbstractInsnNode node : nodes) {
TargetNode targetNode = targetNodes.get(node);
if (targetNode == null) {
targetNode = new TargetNode(node);
targetNodes.put(node, targetNode);
}
targetNode.nominators.add(injectionPoint);
}
}
}
return targetNodes.values();
}
protected boolean findTargetNodes(MethodNode into, InjectionPoint injectionPoint, InsnList insns, Collection<AbstractInsnNode> nodes) {
return injectionPoint.find(into.desc, insns, nodes);
}
protected void sanityCheck(Target target, List<InjectionPoint> injectionPoints) {
if (target.classNode != this.classNode) {
throw new InvalidInjectionException(this.info, "Target class does not match injector class in " + this);
}
}
protected abstract void inject(Target target, InjectionNode node);
protected void postInject(Target target, InjectionNode node) {
// stub
}
/**
* Invoke the handler method
*
* @param insns Instruction list to inject into
* @return injected insn node
*/
protected AbstractInsnNode invokeHandler(InsnList insns) {
return this.invokeHandler(insns, this.methodNode);
}
/**
* Invoke a handler method
*
* @param insns Instruction list to inject into
* @param handler Actual method to invoke (may be different if using a
* surrogate)
* @return injected insn node
*/
protected AbstractInsnNode invokeHandler(InsnList insns, MethodNode handler) {
boolean isPrivate = (handler.access & Opcodes.ACC_PRIVATE) != 0;
int invokeOpcode = this.isStatic ? Opcodes.INVOKESTATIC : isPrivate ? Opcodes.INVOKESPECIAL : Opcodes.INVOKEVIRTUAL;
MethodInsnNode insn = new MethodInsnNode(invokeOpcode, this.classNode.name, handler.name, handler.desc, false);
insns.add(insn);
this.info.addCallbackInvocation(handler);
return insn;
}
/**
* Throw an exception. The exception class must have a string which takes a
* string argument
*
* @param insns Insn list to inject into
* @param exceptionType Type of exception to throw (binary name)
* @param message Message to pass to the exception constructor
*/
protected void throwException(InsnList insns, String exceptionType, String message) {
insns.add(new TypeInsnNode(Opcodes.NEW, exceptionType));
insns.add(new InsnNode(Opcodes.DUP));
insns.add(new LdcInsnNode(message));
insns.add(new MethodInsnNode(Opcodes.INVOKESPECIAL, exceptionType, "<init>", "(Ljava/lang/String;)V", false));
insns.add(new InsnNode(Opcodes.ATHROW));
}
protected static String printArgs(Type[] args) {
return "(" + Joiner.on("").join(args) + ")";
}
/**
* Returns whether the <tt>from</tt> type can be coerced to the <tt>to</tt>
* type.
*
* @param from type to coerce from
* @param to type to coerce to
* @return true if <tt>from</tt> can be coerced to <tt>to</tt>
*/
public static boolean canCoerce(Type from, Type to) {
return Injector.canCoerce(from.getDescriptor(), to.getDescriptor());
}
/**
* Returns whether the <tt>from</tt> type can be coerced to the <tt>to</tt>
* type.
*
* @param from type to coerce from
* @param to type to coerce to
* @return true if <tt>from</tt> can be coerced to <tt>to</tt>
*/
public static boolean canCoerce(String from, String to) {
if (from.length() > 1 || to.length() > 1) {
return false;
}
return Injector.canCoerce(from.charAt(0), to.charAt(0));
}
/**
* Returns whether the <tt>from</tt> type can be coerced to the <tt>to</tt>
* type.
*
* @param from type to coerce from
* @param to type to coerce to
* @return true if <tt>from</tt> can be coerced to <tt>to</tt>
*/
public static boolean canCoerce(char from, char to) {
return to == 'I' && "IBSCZ".indexOf(from) > -1;
}
}