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