1 /*
   2  * Copyright (c) 2013, 2018, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  */
  23 
  24 
  25 package org.graalvm.compiler.core.common.spi;
  26 
  27 import org.graalvm.compiler.core.common.LIRKind;
  28 import jdk.internal.vm.compiler.word.LocationIdentity;
  29 
  30 import jdk.vm.ci.code.ValueKindFactory;
  31 
  32 /**
  33  * Details about a set of supported {@link ForeignCallDescriptor foreign calls}.
  34  */
  35 public interface ForeignCallsProvider extends ValueKindFactory<LIRKind> {
  36 
  37     /**
  38      * Determines if a given foreign call is side-effect free. Deoptimization cannot return
  39      * execution to a point before a foreign call that has a side effect.
  40      */
  41     boolean isReexecutable(ForeignCallDescriptor descriptor);
  42 
  43     /**
  44      * Gets the set of memory locations killed by a given foreign call. Returning the special value
  45      * {@link LocationIdentity#any()} denotes that the call kills all memory locations. Returning
  46      * any empty array denotes that the call does not kill any memory locations.
  47      */
  48     LocationIdentity[] getKilledLocations(ForeignCallDescriptor descriptor);
  49 
  50     /**
  51      * Determines if deoptimization can occur during a given foreign call.
  52      */
  53     boolean canDeoptimize(ForeignCallDescriptor descriptor);
  54 
  55     /**
  56      * Identifies foreign calls which are guaranteed to include a safepoint check.
  57      */
  58     boolean isGuaranteedSafepoint(ForeignCallDescriptor descriptor);
  59 
  60     /**
  61      * Gets the linkage for a foreign call.
  62      */
  63     ForeignCallLinkage lookupForeignCall(ForeignCallDescriptor descriptor);
  64 
  65     /**
  66      * Return true if the foreign call has a binding.
  67      */
  68     boolean isAvailable(ForeignCallDescriptor descriptor);
  69 }