1/*
2 * Copyright (c) 2011, 2016, 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 jdk.vm.ci.hotspot;
24
25import jdk.vm.ci.code.StackSlot;
26import jdk.vm.ci.code.site.DataPatch;
27import jdk.vm.ci.code.site.Site;
28import jdk.vm.ci.meta.Assumptions.Assumption;
29import jdk.vm.ci.meta.ResolvedJavaMethod;
30
31/**
32 * {@link HotSpotCompiledCode} destined for installation as an nmethod.
33 */
34public final class HotSpotCompiledNmethod extends HotSpotCompiledCode {
35
36    protected final HotSpotResolvedJavaMethod method;
37    protected final int entryBCI;
38
39    /**
40     * Compilation identifier.
41     */
42    protected final int id;
43
44    /**
45     * Address of a native {@code JVMCIEnv} object or 0L if no such object exists.
46     */
47    protected final long jvmciEnv;
48
49    protected final boolean hasUnsafeAccess;
50
51    /**
52     * May be set by VM if code installation fails. It will describe in more detail why installation
53     * failed (e.g., exactly which dependency failed).
54     */
55    @SuppressFBWarnings(value = "UWF_UNWRITTEN_FIELD", justification = "set by the VM") private String installationFailureMessage;
56
57    public HotSpotCompiledNmethod(String name, byte[] targetCode, int targetCodeSize, Site[] sites, Assumption[] assumptions, ResolvedJavaMethod[] methods, Comment[] comments, byte[] dataSection,
58                    int dataSectionAlignment, DataPatch[] dataSectionPatches, boolean isImmutablePIC, int totalFrameSize, StackSlot deoptRescueSlot, HotSpotResolvedJavaMethod method, int entryBCI,
59                    int id, long jvmciEnv, boolean hasUnsafeAccess) {
60        super(name, targetCode, targetCodeSize, sites, assumptions, methods, comments, dataSection, dataSectionAlignment, dataSectionPatches, isImmutablePIC, totalFrameSize, deoptRescueSlot);
61        this.method = method;
62        this.entryBCI = entryBCI;
63        this.id = id;
64        this.jvmciEnv = jvmciEnv;
65        this.hasUnsafeAccess = hasUnsafeAccess;
66    }
67
68    @Override
69    public String toString() {
70        return getClass().getSimpleName() + "[" + id + ":" + method.format("%H.%n(%p)%r@") + entryBCI + "]";
71    }
72
73    public String getInstallationFailureMessage() {
74        return installationFailureMessage;
75    }
76}
77