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.core.common.CompilationIdentifier; 27 import org.graalvm.compiler.debug.DebugHandlersFactory; 28 import org.graalvm.compiler.debug.DebugContext; 29 import org.graalvm.compiler.hotspot.meta.HotSpotProviders; 30 import org.graalvm.compiler.options.OptionValues; 31 import org.graalvm.compiler.replacements.SnippetCounter.Group; 32 import org.graalvm.compiler.runtime.RuntimeProvider; 33 34 import jdk.vm.ci.code.TargetDescription; 35 import jdk.vm.ci.meta.ResolvedJavaMethod; 36 37 //JaCoCo Exclude 38 39 /** 40 * Configuration information for the HotSpot Graal runtime. 41 */ 42 public interface HotSpotGraalRuntimeProvider extends GraalRuntime, RuntimeProvider, Group.Factory { 43 44 default TargetDescription getTarget() { 45 return getHostBackend().getTarget(); 46 } 47 48 HotSpotProviders getHostProviders(); 49 50 @Override 51 default String getName() { 52 return getClass().getSimpleName(); 53 } 54 55 @Override 56 HotSpotBackend getHostBackend(); 57 58 GraalHotSpotVMConfig getVMConfig(); 59 60 /** 61 * Opens a debug context for compiling {@code compilable}. The {@link DebugContext#close()} 62 * method should be called on the returned object once the compilation is finished. 63 * 64 * @param compilationOptions the options used to configure the compilation debug context 65 * @param compilationId a system wide unique compilation id 66 * @param compilable the input to the compilation 67 */ 68 DebugContext openDebugContext(OptionValues compilationOptions, CompilationIdentifier compilationId, Object compilable, Iterable<DebugHandlersFactory> factories); 69 70 /** 71 * Gets the option values associated with this runtime. 72 */ 73 OptionValues getOptions(); 74 75 /** 76 * Gets the option values associated with this runtime that are applicable for a given method. 77 * 78 * @param forMethod the method we are seeking for options for 79 * @return the options applicable for compiling {@code method} 80 */ 81 OptionValues getOptions(ResolvedJavaMethod forMethod); 82 83 /** 84 * Determines if the VM is currently bootstrapping the JVMCI compiler. 85 */ 86 boolean isBootstrapping(); 87 88 /** 89 * This runtime has been requested to shutdown. 90 */ 91 boolean isShutdown(); 92 93 /** 94 * Gets a directory into which diagnostics such crash reports and dumps should be written. This 95 * method will create the directory if it doesn't exist so it should only be called if 96 * diagnostics are about to be generated. 97 * 98 * @return the directory into which diagnostics can be written or {@code null} if the directory 99 * does not exist and could not be created or has already been deleted 100 */ 101 String getOutputDirectory(); 102 }