/*

 * Copyright (c) 2012, 2018, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package org.graalvm.compiler.hotspot.amd64;

import static org.graalvm.compiler.lir.LIRInstruction.OperandFlag.REG;

import static jdk.vm.ci.code.ValueUtil.asRegister;

import org.graalvm.compiler.asm.amd64.AMD64MacroAssembler;

import org.graalvm.compiler.hotspot.GraalHotSpotVMConfig;

import org.graalvm.compiler.lir.LIRFrameState;

import org.graalvm.compiler.lir.LIRInstructionClass;

import org.graalvm.compiler.lir.Opcode;

import org.graalvm.compiler.lir.amd64.AMD64Call;

import org.graalvm.compiler.lir.amd64.AMD64Call.IndirectCallOp;

import org.graalvm.compiler.lir.asm.CompilationResultBuilder;

import jdk.vm.ci.amd64.AMD64;

import jdk.vm.ci.code.Register;

import jdk.vm.ci.meta.ResolvedJavaMethod;

import jdk.vm.ci.meta.Value;

/**

 * A register indirect call that complies with the extra conventions for such calls in HotSpot. In

 * particular, the metaspace Method of the callee must be in RBX for the case where a vtable entry's

 * _from_compiled_entry is the address of an C2I adapter. Such adapters expect the target method to

 * be in RBX.

 */

@Opcode("CALL_INDIRECT")

final class AMD64IndirectCallOp extends IndirectCallOp {

    public static final LIRInstructionClass<AMD64IndirectCallOp> TYPE = LIRInstructionClass.create(AMD64IndirectCallOp.class);

    /**

     * Vtable stubs expect the metaspace Method in RBX.

     */

    public static final Register METHOD = AMD64.rbx;

    @Use({REG}) protected Value metaspaceMethod;

    private final GraalHotSpotVMConfig config;

    AMD64IndirectCallOp(ResolvedJavaMethod targetMethod, Value result, Value[] parameters, Value[] temps, Value metaspaceMethod, Value targetAddress, LIRFrameState state,

                    GraalHotSpotVMConfig config) {

        super(TYPE, targetMethod, result, parameters, temps, targetAddress, state);

        this.metaspaceMethod = metaspaceMethod;

        this.config = config;

    }

    @Override

    public void emitCode(CompilationResultBuilder crb, AMD64MacroAssembler masm) {

        crb.recordMark(config.MARKID_INLINE_INVOKE);

        Register callReg = asRegister(targetAddress);

        assert !callReg.equals(METHOD);

        int pcOffset = AMD64Call.indirectCall(crb, masm, callReg, callTarget, state);

        crb.recordInlineInvokeCallOp(pcOffset, getPosition());

    }

    @Override

    public void verify() {

        super.verify();

        assert asRegister(metaspaceMethod).equals(METHOD);

    }

}