1 /*
   2  * Copyright (c) 2011, 2015, 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 package org.graalvm.compiler.hotspot;
  24 
  25 import org.graalvm.compiler.api.runtime.GraalRuntime;
  26 import org.graalvm.compiler.hotspot.meta.HotSpotProviders;
  27 import org.graalvm.compiler.options.OptionValues;
  28 import org.graalvm.compiler.replacements.SnippetCounter.Group;
  29 import org.graalvm.compiler.runtime.RuntimeProvider;
  30 
  31 import jdk.vm.ci.code.TargetDescription;
  32 import jdk.vm.ci.meta.ResolvedJavaMethod;
  33 
  34 //JaCoCo Exclude
  35 
  36 /**
  37  * Configuration information for the HotSpot Graal runtime.
  38  */
  39 public interface HotSpotGraalRuntimeProvider extends GraalRuntime, RuntimeProvider, Group.Factory {
  40 
  41     default TargetDescription getTarget() {
  42         return getHostBackend().getTarget();
  43     }
  44 
  45     HotSpotProviders getHostProviders();
  46 
  47     @Override
  48     default String getName() {
  49         return getClass().getSimpleName();
  50     }
  51 
  52     @Override
  53     HotSpotBackend getHostBackend();
  54 
  55     GraalHotSpotVMConfig getVMConfig();
  56 
  57     /**
  58      * Gets the option values associated with this runtime.
  59      */
  60     OptionValues getOptions();
  61 
  62     /**
  63      * Gets the option values associated with this runtime that are applicable for given method.
  64      *
  65      * @param forMethod the method we are seeking for options for
  66      * @return the options - by default same as {@link #getOptions()}
  67      */
  68     default OptionValues getOptions(ResolvedJavaMethod forMethod) {
  69         return getOptions();
  70     }
  71 
  72     /**
  73      * Determines if the VM is currently bootstrapping the JVMCI compiler.
  74      */
  75     boolean isBootstrapping();
  76 
  77     /**
  78      * This runtime has been requested to shutdown.
  79      */
  80     boolean isShutdown();
  81 
  82     /**
  83      * Gets a directory into which diagnostics such crash reports and dumps should be written. This
  84      * method will create the directory if it doesn't exist so it should only be called if
  85      * diagnostics are about to be generated.
  86      *
  87      * @return the directory into which diagnostics can be written or {@code null} if the directory
  88      *         does not exist and could not be created or has already been deleted
  89      */
  90     String getOutputDirectory();
  91 }