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 jdk.vm.ci.hotspot;
24
25import java.lang.reflect.Modifier;
26
27import jdk.vm.ci.meta.JavaMethod;
28import jdk.vm.ci.meta.ResolvedJavaMethod;
29import jdk.vm.ci.meta.ResolvedJavaType;
30
31/**
32 * Implementation of {@link JavaMethod} for resolved HotSpot methods.
33 */
34public interface HotSpotResolvedJavaMethod extends ResolvedJavaMethod {
35
36    /**
37     * Returns true if this method has a {@code CallerSensitive} annotation.
38     *
39     * @return true if CallerSensitive annotation present, false otherwise
40     */
41    boolean isCallerSensitive();
42
43    HotSpotResolvedObjectType getDeclaringClass();
44
45    /**
46     * Returns true if this method has a {@code ForceInline} annotation.
47     *
48     * @return true if ForceInline annotation present, false otherwise
49     */
50    boolean isForceInline();
51
52    /**
53     * Returns true if this method has a {@code ReservedStackAccess} annotation.
54     *
55     * @return true if ReservedStackAccess annotation present, false otherwise
56     */
57    boolean hasReservedStackAccess();
58
59    /**
60     * Sets flags on {@code method} indicating that it should never be inlined or compiled by the VM.
61     */
62    void setNotInlineableOrCompileable();
63
64    /**
65     * Returns true if this method is one of the special methods that is ignored by security stack
66     * walks.
67     *
68     * @return true if special method ignored by security stack walks, false otherwise
69     */
70    boolean ignoredBySecurityStackWalk();
71
72    ResolvedJavaMethod uniqueConcreteMethod(HotSpotResolvedObjectType receiver);
73
74    /**
75     * Returns whether this method has compiled code.
76     *
77     * @return true if this method has compiled code, false otherwise
78     */
79    boolean hasCompiledCode();
80
81    /**
82     * @param level
83     * @return true if the currently installed code was generated at {@code level}.
84     */
85    boolean hasCompiledCodeAtLevel(int level);
86
87    default boolean isDefault() {
88        if (isConstructor()) {
89            return false;
90        }
91        // Copied from java.lang.Method.isDefault()
92        int mask = Modifier.ABSTRACT | Modifier.PUBLIC | Modifier.STATIC;
93        return ((getModifiers() & mask) == Modifier.PUBLIC) && getDeclaringClass().isInterface();
94    }
95
96    /**
97     * Returns the offset of this method into the v-table. The method must have a v-table entry as
98     * indicated by {@link #isInVirtualMethodTable(ResolvedJavaType)}, otherwise an exception is
99     * thrown.
100     *
101     * @return the offset of this method into the v-table
102     */
103    int vtableEntryOffset(ResolvedJavaType resolved);
104
105    int intrinsicId();
106
107    /**
108     * Determines if this method denotes itself as a candidate for intrinsification. As of JDK 9,
109     * this is denoted by the {@code HotSpotIntrinsicCandidate} annotation. In earlier JDK versions,
110     * this method returns true.
111     *
112     * @see <a href="https://bugs.openjdk.java.net/browse/JDK-8076112">JDK-8076112</a>
113     */
114    boolean isIntrinsicCandidate();
115
116    /**
117     * Allocates a compile id for this method by asking the VM for one.
118     *
119     * @param entryBCI entry bci
120     * @return compile id
121     */
122    int allocateCompileId(int entryBCI);
123
124    boolean hasCodeAtLevel(int entryBCI, int level);
125}
126