jnr.ffi.provider.jffi.BufferMethodGenerator Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jnr-ffi Show documentation
A library for invoking native functions from java
There is a newer version: 2.2.16
package jnr.ffi.provider.jffi;

import com.kenai.jffi.CallContext;
import com.kenai.jffi.HeapInvocationBuffer;
import com.kenai.jffi.Invoker;
import com.kenai.jffi.ObjectParameterStrategy;
import jnr.ffi.NativeType;
import jnr.ffi.provider.InvocationSession;
import jnr.ffi.CallingConvention;
import jnr.ffi.provider.ParameterType;
import jnr.ffi.provider.ResultType;

import java.util.Collections;
import java.util.EnumMap;
import java.util.Map;

import static jnr.ffi.provider.jffi.AbstractFastNumericMethodGenerator.emitParameterStrategyLookup;
import static jnr.ffi.provider.jffi.AbstractFastNumericMethodGenerator.hasPointerParameterStrategy;
import static jnr.ffi.provider.jffi.AsmUtil.unboxedReturnType;
import static jnr.ffi.provider.jffi.CodegenUtils.*;
import static jnr.ffi.provider.jffi.NumberUtil.convertPrimitive;
import static jnr.ffi.provider.jffi.NumberUtil.sizeof;

/**
 *
 */
final class BufferMethodGenerator extends BaseMethodGenerator {
    private static abstract class Operation {
        final String methodName;
        final Class primitiveClass;

        private Operation(String methodName, Class primitiveClass) {
            this.methodName = methodName;
            this.primitiveClass = primitiveClass;
        }
    }

    private static final class MarshalOp extends Operation {
        private MarshalOp(String methodName, Class primitiveClass) {
            super("put" + methodName, primitiveClass);
        }
    }

    private static final class InvokeOp extends Operation {
        private InvokeOp(String methodName, Class primitiveClass) {
            super("invoke" + methodName, primitiveClass);
        }
    }

    static final Map marshalOps;
    static final Map invokeOps;
    static {
        Map mops = new EnumMap(NativeType.class);
        Map iops = new EnumMap(NativeType.class);
        mops.put(NativeType.SCHAR, new MarshalOp("Byte", int.class));
        mops.put(NativeType.UCHAR, new MarshalOp("Byte", int.class));
        mops.put(NativeType.SSHORT, new MarshalOp("Short", int.class));
        mops.put(NativeType.USHORT, new MarshalOp("Short", int.class));
        mops.put(NativeType.SINT, new MarshalOp("Int", int.class));
        mops.put(NativeType.UINT, new MarshalOp("Int", int.class));
        mops.put(NativeType.SLONGLONG, new MarshalOp("Long", long.class));
        mops.put(NativeType.ULONGLONG, new MarshalOp("Long", long.class));
        mops.put(NativeType.FLOAT, new MarshalOp("Float", float.class));
        mops.put(NativeType.DOUBLE, new MarshalOp("Double", double.class));
        mops.put(NativeType.ADDRESS, new MarshalOp("Address", long.class));
        if (sizeof(NativeType.SLONG) == 4) {
            mops.put(NativeType.SLONG, new MarshalOp("Int", int.class));
            mops.put(NativeType.ULONG, new MarshalOp("Int", int.class));
        } else {
            mops.put(NativeType.SLONG, new MarshalOp("Long", long.class));
            mops.put(NativeType.ULONG, new MarshalOp("Long", long.class));
        }

        iops.put(NativeType.SCHAR, new InvokeOp("Int", int.class));
        iops.put(NativeType.UCHAR, new InvokeOp("Int", int.class));
        iops.put(NativeType.SSHORT, new InvokeOp("Int", int.class));
        iops.put(NativeType.USHORT, new InvokeOp("Int", int.class));
        iops.put(NativeType.SINT, new InvokeOp("Int", int.class));
        iops.put(NativeType.UINT, new InvokeOp("Int", int.class));
        iops.put(NativeType.VOID, new InvokeOp("Int", int.class));
        iops.put(NativeType.SLONGLONG, new InvokeOp("Long", long.class));
        iops.put(NativeType.ULONGLONG, new InvokeOp("Long", long.class));
        iops.put(NativeType.FLOAT, new InvokeOp("Float", float.class));
        iops.put(NativeType.DOUBLE, new InvokeOp("Double", double.class));
        iops.put(NativeType.ADDRESS, new InvokeOp("Address", long.class));
        if (sizeof(NativeType.SLONG) == 4) {
            iops.put(NativeType.SLONG, new InvokeOp("Int", int.class));
            iops.put(NativeType.ULONG, new InvokeOp("Int", int.class));
        } else {
            iops.put(NativeType.SLONG, new InvokeOp("Long", long.class));
            iops.put(NativeType.ULONG, new InvokeOp("Long", long.class));
        }
        marshalOps = Collections.unmodifiableMap(mops);
        invokeOps = Collections.unmodifiableMap(iops);
    }

    @Override
    void generate(AsmBuilder builder, SkinnyMethodAdapter mv, LocalVariableAllocator localVariableAllocator, CallContext callContext, ResultType resultType, ParameterType[] parameterTypes, boolean ignoreError) {
        generateBufferInvocation(builder, mv, localVariableAllocator, callContext, resultType, parameterTypes);
    }

    public boolean isSupported(ResultType resultType, ParameterType[] parameterTypes, CallingConvention callingConvention) {
        // Buffer invocation supports everything
        return true;
    }

    private static void emitPrimitiveOp(final SkinnyMethodAdapter mv, ParameterType parameterType, ToNativeOp op) {
        MarshalOp marshalOp = marshalOps.get(parameterType.getNativeType());
        if (marshalOp == null) {
            throw new IllegalArgumentException("unsupported parameter type " + parameterType);
        }

        op.emitPrimitive(mv, marshalOp.primitiveClass, parameterType.getNativeType());
        mv.invokevirtual(HeapInvocationBuffer.class, marshalOp.methodName, void.class, marshalOp.primitiveClass);
    }

    static boolean isSessionRequired(ParameterType parameterType) {
        return false;
    }


    static boolean isSessionRequired(ParameterType[] parameterTypes) {
        for (ParameterType parameterType : parameterTypes) {
            if (isSessionRequired(parameterType)) {
                return true;
            }
        }

        return false;
    }

    void generateBufferInvocation(final AsmBuilder builder, final SkinnyMethodAdapter mv, LocalVariableAllocator localVariableAllocator, CallContext callContext, final ResultType resultType, final ParameterType[] parameterTypes) {
        // [ stack contains: Invoker, Function ]
        final boolean sessionRequired = isSessionRequired(parameterTypes);
        final LocalVariable session = localVariableAllocator.allocate(InvocationSession.class);

        if (sessionRequired) {
            mv.newobj(p(InvocationSession.class));
            mv.dup();
            mv.invokespecial(InvocationSession.class, "", void.class);
            mv.astore(session);
        }

        // Create a new InvocationBuffer
        mv.aload(0);
        mv.getfield(builder.getClassNamePath(), builder.getCallContextFieldName(callContext), ci(CallContext.class));
        mv.invokestatic(AsmRuntime.class, "newHeapInvocationBuffer", HeapInvocationBuffer.class, CallContext.class);
        // [ stack contains: Invoker, Function, HeapInvocationBuffer ]

        final LocalVariable[] parameters = AsmUtil.getParameterVariables(parameterTypes);
        final LocalVariable[] converted = new LocalVariable[parameterTypes.length];
        LocalVariable[] strategies = new LocalVariable[parameterTypes.length];

        for (int i = 0; i < parameterTypes.length; ++i) {
            mv.dup(); // dup ref to HeapInvocationBuffer

            if (isSessionRequired(parameterTypes[i])) {
                mv.aload(session);
            }
            converted[i] = loadAndConvertParameter(builder, mv, localVariableAllocator, parameters[i], parameterTypes[i]);

            final Class javaParameterType = parameterTypes[i].effectiveJavaType();
            ToNativeOp op = ToNativeOp.get(parameterTypes[i]);
            if (op != null && op.isPrimitive()) {
                emitPrimitiveOp(mv, parameterTypes[i], op);

            } else if (hasPointerParameterStrategy(javaParameterType)) {
                emitParameterStrategyLookup(mv, javaParameterType);
                mv.astore(strategies[i] = localVariableAllocator.allocate(PointerParameterStrategy.class));

                mv.aload(converted[i]);
                mv.aload(strategies[i]);
                mv.pushInt(AsmUtil.getNativeArrayFlags(parameterTypes[i].annotations()));
                mv.invokevirtual(HeapInvocationBuffer.class, "putObject", void.class, Object.class, ObjectParameterStrategy.class, int.class);

            } else {
                throw new IllegalArgumentException("unsupported parameter type " + parameterTypes[i]);
            }
        }

        InvokeOp iop = invokeOps.get(resultType.getNativeType());
        if (iop == null) {
            throw new IllegalArgumentException("unsupported return type " + resultType.getDeclaredType());
        }

        mv.invokevirtual(Invoker.class, iop.methodName, iop.primitiveClass, CallContext.class, long.class, HeapInvocationBuffer.class);

        // box and/or narrow/widen the return value if needed
        convertPrimitive(mv, iop.primitiveClass, unboxedReturnType(resultType.effectiveJavaType()), resultType.getNativeType());
        emitEpilogue(builder, mv, resultType, parameterTypes, parameters, converted, sessionRequired ? new Runnable() {
            public void run() {
                mv.aload(session);
                mv.invokevirtual(p(InvocationSession.class), "finish", "()V");
            }
        } : null);
    }
}