001/*
002 * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation.
008 *
009 * This code is distributed in the hope that it will be useful, but WITHOUT
010 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
011 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
012 * version 2 for more details (a copy is included in the LICENSE file that
013 * accompanied this code).
014 *
015 * You should have received a copy of the GNU General Public License version
016 * 2 along with this work; if not, write to the Free Software Foundation,
017 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
018 *
019 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
020 * or visit www.oracle.com if you need additional information or have any
021 * questions.
022 */
023package com.oracle.graal.compiler.common.spi;
024
025import jdk.internal.jvmci.meta.*;
026
027/**
028 * Details about a set of supported {@link ForeignCallDescriptor foreign calls}.
029 */
030public interface ForeignCallsProvider {
031
032    /**
033     * Determines if a given foreign call is side-effect free. Deoptimization cannot return
034     * execution to a point before a foreign call that has a side effect.
035     */
036    boolean isReexecutable(ForeignCallDescriptor descriptor);
037
038    /**
039     * Gets the set of memory locations killed by a given foreign call. Returning the special value
040     * {@link LocationIdentity#any()} denotes that the call kills all memory locations. Returning
041     * any empty array denotes that the call does not kill any memory locations.
042     */
043    LocationIdentity[] getKilledLocations(ForeignCallDescriptor descriptor);
044
045    /**
046     * Determines if deoptimization can occur during a given foreign call.
047     */
048    boolean canDeoptimize(ForeignCallDescriptor descriptor);
049
050    /**
051     * Gets the linkage for a foreign call.
052     */
053    ForeignCallLinkage lookupForeignCall(ForeignCallDescriptor descriptor);
054}