Mercurial > hg > truffle
annotate src/share/vm/opto/callGenerator.hpp @ 17820:248ff38d2950
8035828: Turn on @Stable support in VM
Reviewed-by: jrose, twisti
author | vlivanov |
---|---|
date | Fri, 28 Mar 2014 10:13:37 -0700 |
parents | b2ee5dc63353 |
children | 096c224171c4 922c87c9aed4 |
rev | line source |
---|---|
0 | 1 /* |
12146
9758d9f36299
8021954: VM SIGSEGV during classloading on MacOS; hs_err_pid file produced
coleenp
parents:
10278
diff
changeset
|
2 * Copyright (c) 2000, 2013, Oracle and/or its affiliates. All rights reserved. |
0 | 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 * | |
1552
c18cbe5936b8
6941466: Oracle rebranding changes for Hotspot repositories
trims
parents:
1138
diff
changeset
|
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
c18cbe5936b8
6941466: Oracle rebranding changes for Hotspot repositories
trims
parents:
1138
diff
changeset
|
20 * or visit www.oracle.com if you need additional information or have any |
c18cbe5936b8
6941466: Oracle rebranding changes for Hotspot repositories
trims
parents:
1138
diff
changeset
|
21 * questions. |
0 | 22 * |
23 */ | |
24 | |
1972 | 25 #ifndef SHARE_VM_OPTO_CALLGENERATOR_HPP |
26 #define SHARE_VM_OPTO_CALLGENERATOR_HPP | |
27 | |
6266
1d7922586cf6
7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
4117
diff
changeset
|
28 #include "compiler/compileBroker.hpp" |
1972 | 29 #include "opto/callnode.hpp" |
30 #include "opto/compile.hpp" | |
31 #include "opto/type.hpp" | |
32 #include "runtime/deoptimization.hpp" | |
33 | |
12956
3213ba4d3dff
8024069: replace_in_map() should operate on parent maps
roland
parents:
12330
diff
changeset
|
34 class Parse; |
3213ba4d3dff
8024069: replace_in_map() should operate on parent maps
roland
parents:
12330
diff
changeset
|
35 |
0 | 36 //---------------------------CallGenerator------------------------------------- |
37 // The subclasses of this class handle generation of ideal nodes for | |
38 // call sites and method entry points. | |
39 | |
40 class CallGenerator : public ResourceObj { | |
41 public: | |
42 enum { | |
43 xxxunusedxxx | |
44 }; | |
45 | |
46 private: | |
47 ciMethod* _method; // The method being called. | |
48 | |
49 protected: | |
6266
1d7922586cf6
7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
4117
diff
changeset
|
50 CallGenerator(ciMethod* method) : _method(method) {} |
0 | 51 |
52 public: | |
53 // Accessors | |
54 ciMethod* method() const { return _method; } | |
55 | |
56 // is_inline: At least some code implementing the method is copied here. | |
57 virtual bool is_inline() const { return false; } | |
58 // is_intrinsic: There's a method-specific way of generating the inline code. | |
59 virtual bool is_intrinsic() const { return false; } | |
60 // is_parse: Bytecodes implementing the specific method are copied here. | |
61 virtual bool is_parse() const { return false; } | |
62 // is_virtual: The call uses the receiver type to select or check the method. | |
63 virtual bool is_virtual() const { return false; } | |
64 // is_deferred: The decision whether to inline or not is deferred. | |
65 virtual bool is_deferred() const { return false; } | |
66 // is_predicted: Uses an explicit check against a predicted type. | |
67 virtual bool is_predicted() const { return false; } | |
68 // is_trap: Does not return to the caller. (E.g., uncommon trap.) | |
69 virtual bool is_trap() const { return false; } | |
12330
29bdcf12457c
8014447: Object.hashCode intrinsic breaks inline caches
shade
parents:
12295
diff
changeset
|
70 // does_virtual_dispatch: Should try inlining as normal method first. |
29bdcf12457c
8014447: Object.hashCode intrinsic breaks inline caches
shade
parents:
12295
diff
changeset
|
71 virtual bool does_virtual_dispatch() const { return false; } |
0 | 72 |
1080
7c57aead6d3e
6892658: C2 should optimize some stringbuilder patterns
never
parents:
0
diff
changeset
|
73 // is_late_inline: supports conversion of call into an inline |
7c57aead6d3e
6892658: C2 should optimize some stringbuilder patterns
never
parents:
0
diff
changeset
|
74 virtual bool is_late_inline() const { return false; } |
7473 | 75 // same but for method handle calls |
76 virtual bool is_mh_late_inline() const { return false; } | |
12966 | 77 virtual bool is_string_late_inline() const{ return false; } |
7473 | 78 |
79 // for method handle calls: have we tried inlinining the call already? | |
80 virtual bool already_attempted() const { ShouldNotReachHere(); return false; } | |
81 | |
1080
7c57aead6d3e
6892658: C2 should optimize some stringbuilder patterns
never
parents:
0
diff
changeset
|
82 // Replace the call with an inline version of the code |
7c57aead6d3e
6892658: C2 should optimize some stringbuilder patterns
never
parents:
0
diff
changeset
|
83 virtual void do_late_inline() { ShouldNotReachHere(); } |
7c57aead6d3e
6892658: C2 should optimize some stringbuilder patterns
never
parents:
0
diff
changeset
|
84 |
7c57aead6d3e
6892658: C2 should optimize some stringbuilder patterns
never
parents:
0
diff
changeset
|
85 virtual CallStaticJavaNode* call_node() const { ShouldNotReachHere(); return NULL; } |
7c57aead6d3e
6892658: C2 should optimize some stringbuilder patterns
never
parents:
0
diff
changeset
|
86 |
0 | 87 // Note: It is possible for a CG to be both inline and virtual. |
88 // (The hashCode intrinsic does a vtable check and an inlined fast path.) | |
89 | |
90 // Utilities: | |
91 const TypeFunc* tf() const; | |
92 | |
93 // The given jvms has state and arguments for a call to my method. | |
94 // Edges after jvms->argoff() carry all (pre-popped) argument values. | |
95 // | |
96 // Update the map with state and return values (if any) and return it. | |
97 // The return values (0, 1, or 2) must be pushed on the map's stack, | |
98 // and the sp of the jvms incremented accordingly. | |
99 // | |
100 // The jvms is returned on success. Alternatively, a copy of the | |
101 // given jvms, suitably updated, may be returned, in which case the | |
102 // caller should discard the original jvms. | |
103 // | |
104 // The non-Parm edges of the returned map will contain updated global state, | |
105 // and one or two edges before jvms->sp() will carry any return values. | |
106 // Other map edges may contain locals or monitors, and should not | |
107 // be changed in meaning. | |
108 // | |
109 // If the call traps, the returned map must have a control edge of top. | |
110 // If the call can throw, the returned map must report has_exceptions(). | |
111 // | |
112 // If the result is NULL, it means that this CallGenerator was unable | |
113 // to handle the given call, and another CallGenerator should be consulted. | |
12956
3213ba4d3dff
8024069: replace_in_map() should operate on parent maps
roland
parents:
12330
diff
changeset
|
114 virtual JVMState* generate(JVMState* jvms, Parse* parent_parser) = 0; |
0 | 115 |
116 // How to generate a call site that is inlined: | |
117 static CallGenerator* for_inline(ciMethod* m, float expected_uses = -1); | |
118 // How to generate code for an on-stack replacement handler. | |
119 static CallGenerator* for_osr(ciMethod* m, int osr_bci); | |
120 | |
121 // How to generate vanilla out-of-line call sites: | |
1080
7c57aead6d3e
6892658: C2 should optimize some stringbuilder patterns
never
parents:
0
diff
changeset
|
122 static CallGenerator* for_direct_call(ciMethod* m, bool separate_io_projs = false); // static, special |
4117
a04a201f0f5a
7108383: JSR 292: JRuby bench_define_method_methods.rb: assert(slow_jvms != NULL) failed: miss path must not
twisti
parents:
3852
diff
changeset
|
123 static CallGenerator* for_virtual_call(ciMethod* m, int vtable_index); // virtual, interface |
1137
97125851f396
6829187: compiler optimizations required for JSR 292
twisti
parents:
1080
diff
changeset
|
124 static CallGenerator* for_dynamic_call(ciMethod* m); // invokedynamic |
4117
a04a201f0f5a
7108383: JSR 292: JRuby bench_define_method_methods.rb: assert(slow_jvms != NULL) failed: miss path must not
twisti
parents:
3852
diff
changeset
|
125 |
7473 | 126 static CallGenerator* for_method_handle_call( JVMState* jvms, ciMethod* caller, ciMethod* callee, bool delayed_forbidden); |
127 static CallGenerator* for_method_handle_inline(JVMState* jvms, ciMethod* caller, ciMethod* callee, bool& input_not_const); | |
3752
f918d6096e23
7050554: JSR 292 - need optimization for selectAlternative
never
parents:
2443
diff
changeset
|
128 |
1080
7c57aead6d3e
6892658: C2 should optimize some stringbuilder patterns
never
parents:
0
diff
changeset
|
129 // How to generate a replace a direct call with an inline version |
7c57aead6d3e
6892658: C2 should optimize some stringbuilder patterns
never
parents:
0
diff
changeset
|
130 static CallGenerator* for_late_inline(ciMethod* m, CallGenerator* inline_cg); |
7473 | 131 static CallGenerator* for_mh_late_inline(ciMethod* caller, ciMethod* callee, bool input_not_const); |
132 static CallGenerator* for_string_late_inline(ciMethod* m, CallGenerator* inline_cg); | |
10278 | 133 static CallGenerator* for_boxing_late_inline(ciMethod* m, CallGenerator* inline_cg); |
1080
7c57aead6d3e
6892658: C2 should optimize some stringbuilder patterns
never
parents:
0
diff
changeset
|
134 |
0 | 135 // How to make a call but defer the decision whether to inline or not. |
136 static CallGenerator* for_warm_call(WarmCallInfo* ci, | |
137 CallGenerator* if_cold, | |
138 CallGenerator* if_hot); | |
139 | |
140 // How to make a call that optimistically assumes a receiver type: | |
141 static CallGenerator* for_predicted_call(ciKlass* predicted_receiver, | |
142 CallGenerator* if_missed, | |
143 CallGenerator* if_hit, | |
144 float hit_prob); | |
145 | |
1138
dd57230ba8fe
6893268: additional dynamic language related optimizations in C2
twisti
parents:
1137
diff
changeset
|
146 // How to make a call that optimistically assumes a MethodHandle target: |
dd57230ba8fe
6893268: additional dynamic language related optimizations in C2
twisti
parents:
1137
diff
changeset
|
147 static CallGenerator* for_predicted_dynamic_call(ciMethodHandle* predicted_method_handle, |
dd57230ba8fe
6893268: additional dynamic language related optimizations in C2
twisti
parents:
1137
diff
changeset
|
148 CallGenerator* if_missed, |
dd57230ba8fe
6893268: additional dynamic language related optimizations in C2
twisti
parents:
1137
diff
changeset
|
149 CallGenerator* if_hit, |
dd57230ba8fe
6893268: additional dynamic language related optimizations in C2
twisti
parents:
1137
diff
changeset
|
150 float hit_prob); |
dd57230ba8fe
6893268: additional dynamic language related optimizations in C2
twisti
parents:
1137
diff
changeset
|
151 |
0 | 152 // How to make a call that gives up and goes back to the interpreter: |
153 static CallGenerator* for_uncommon_trap(ciMethod* m, | |
154 Deoptimization::DeoptReason reason, | |
155 Deoptimization::DeoptAction action); | |
156 | |
157 // Registry for intrinsics: | |
158 static CallGenerator* for_intrinsic(ciMethod* m); | |
159 static void register_intrinsic(ciMethod* m, CallGenerator* cg); | |
6894 | 160 static CallGenerator* for_predicted_intrinsic(CallGenerator* intrinsic, |
161 CallGenerator* cg); | |
162 virtual Node* generate_predicate(JVMState* jvms) { return NULL; }; | |
6266
1d7922586cf6
7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
4117
diff
changeset
|
163 |
7473 | 164 virtual void print_inlining_late(const char* msg) { ShouldNotReachHere(); } |
165 | |
7421
ad5dd04754ee
8005031: Some cleanup in c2 to prepare for incremental inlining support
roland
parents:
6894
diff
changeset
|
166 static void print_inlining(Compile* C, ciMethod* callee, int inline_level, int bci, const char* msg) { |
12295 | 167 if (C->print_inlining()) { |
7421
ad5dd04754ee
8005031: Some cleanup in c2 to prepare for incremental inlining support
roland
parents:
6894
diff
changeset
|
168 C->print_inlining(callee, inline_level, bci, msg); |
12295 | 169 } |
6266
1d7922586cf6
7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
4117
diff
changeset
|
170 } |
0 | 171 }; |
172 | |
173 | |
6266
1d7922586cf6
7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
4117
diff
changeset
|
174 //------------------------InlineCallGenerator---------------------------------- |
1d7922586cf6
7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
4117
diff
changeset
|
175 class InlineCallGenerator : public CallGenerator { |
0 | 176 protected: |
6266
1d7922586cf6
7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
4117
diff
changeset
|
177 InlineCallGenerator(ciMethod* method) : CallGenerator(method) {} |
1d7922586cf6
7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
4117
diff
changeset
|
178 |
1d7922586cf6
7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
4117
diff
changeset
|
179 public: |
1d7922586cf6
7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
4117
diff
changeset
|
180 virtual bool is_inline() const { return true; } |
0 | 181 }; |
182 | |
183 | |
184 //---------------------------WarmCallInfo-------------------------------------- | |
185 // A struct to collect information about a given call site. | |
186 // Helps sort call sites into "hot", "medium", and "cold". | |
187 // Participates in the queueing of "medium" call sites for possible inlining. | |
188 class WarmCallInfo : public ResourceObj { | |
189 private: | |
190 | |
191 CallNode* _call; // The CallNode which may be inlined. | |
192 CallGenerator* _hot_cg;// CG for expanding the call node | |
193 | |
194 // These are the metrics we use to evaluate call sites: | |
195 | |
196 float _count; // How often do we expect to reach this site? | |
197 float _profit; // How much time do we expect to save by inlining? | |
198 float _work; // How long do we expect the average call to take? | |
199 float _size; // How big do we expect the inlined code to be? | |
200 | |
201 float _heat; // Combined score inducing total order on call sites. | |
202 WarmCallInfo* _next; // Next cooler call info in pending queue. | |
203 | |
204 // Count is the number of times this call site is expected to be executed. | |
205 // Large count is favorable for inlining, because the extra compilation | |
206 // work will be amortized more completely. | |
207 | |
208 // Profit is a rough measure of the amount of time we expect to save | |
209 // per execution of this site if we inline it. (1.0 == call overhead) | |
210 // Large profit favors inlining. Negative profit disables inlining. | |
211 | |
212 // Work is a rough measure of the amount of time a typical out-of-line | |
213 // call from this site is expected to take. (1.0 == call, no-op, return) | |
214 // Small work is somewhat favorable for inlining, since methods with | |
215 // short "hot" traces are more likely to inline smoothly. | |
216 | |
217 // Size is the number of graph nodes we expect this method to produce, | |
218 // not counting the inlining of any further warm calls it may include. | |
219 // Small size favors inlining, since small methods are more likely to | |
220 // inline smoothly. The size is estimated by examining the native code | |
221 // if available. The method bytecodes are also examined, assuming | |
222 // empirically observed node counts for each kind of bytecode. | |
223 | |
224 // Heat is the combined "goodness" of a site's inlining. If we were | |
225 // omniscient, it would be the difference of two sums of future execution | |
226 // times of code emitted for this site (amortized across multiple sites if | |
227 // sharing applies). The two sums are for versions of this call site with | |
228 // and without inlining. | |
229 | |
230 // We approximate this mythical quantity by playing with averages, | |
231 // rough estimates, and assumptions that history repeats itself. | |
232 // The basic formula count * profit is heuristically adjusted | |
233 // by looking at the expected compilation and execution times of | |
234 // of the inlined call. | |
235 | |
236 // Note: Some of these metrics may not be present in the final product, | |
237 // but exist in development builds to experiment with inline policy tuning. | |
238 | |
239 // This heuristic framework does not model well the very significant | |
240 // effects of multiple-level inlining. It is possible to see no immediate | |
241 // profit from inlining X->Y, but to get great profit from a subsequent | |
242 // inlining X->Y->Z. | |
243 | |
244 // This framework does not take well into account the problem of N**2 code | |
245 // size in a clique of mutually inlinable methods. | |
246 | |
247 WarmCallInfo* next() const { return _next; } | |
248 void set_next(WarmCallInfo* n) { _next = n; } | |
249 | |
2443
f8b038506985
6909440: C2 fails with assertion (_always_cold->is_cold(),"must always be cold")
never
parents:
1972
diff
changeset
|
250 static WarmCallInfo _always_hot; |
f8b038506985
6909440: C2 fails with assertion (_always_cold->is_cold(),"must always be cold")
never
parents:
1972
diff
changeset
|
251 static WarmCallInfo _always_cold; |
f8b038506985
6909440: C2 fails with assertion (_always_cold->is_cold(),"must always be cold")
never
parents:
1972
diff
changeset
|
252 |
f8b038506985
6909440: C2 fails with assertion (_always_cold->is_cold(),"must always be cold")
never
parents:
1972
diff
changeset
|
253 // Constructor intitialization of always_hot and always_cold |
f8b038506985
6909440: C2 fails with assertion (_always_cold->is_cold(),"must always be cold")
never
parents:
1972
diff
changeset
|
254 WarmCallInfo(float c, float p, float w, float s) { |
f8b038506985
6909440: C2 fails with assertion (_always_cold->is_cold(),"must always be cold")
never
parents:
1972
diff
changeset
|
255 _call = NULL; |
f8b038506985
6909440: C2 fails with assertion (_always_cold->is_cold(),"must always be cold")
never
parents:
1972
diff
changeset
|
256 _hot_cg = NULL; |
f8b038506985
6909440: C2 fails with assertion (_always_cold->is_cold(),"must always be cold")
never
parents:
1972
diff
changeset
|
257 _next = NULL; |
f8b038506985
6909440: C2 fails with assertion (_always_cold->is_cold(),"must always be cold")
never
parents:
1972
diff
changeset
|
258 _count = c; |
f8b038506985
6909440: C2 fails with assertion (_always_cold->is_cold(),"must always be cold")
never
parents:
1972
diff
changeset
|
259 _profit = p; |
f8b038506985
6909440: C2 fails with assertion (_always_cold->is_cold(),"must always be cold")
never
parents:
1972
diff
changeset
|
260 _work = w; |
f8b038506985
6909440: C2 fails with assertion (_always_cold->is_cold(),"must always be cold")
never
parents:
1972
diff
changeset
|
261 _size = s; |
f8b038506985
6909440: C2 fails with assertion (_always_cold->is_cold(),"must always be cold")
never
parents:
1972
diff
changeset
|
262 _heat = 0; |
f8b038506985
6909440: C2 fails with assertion (_always_cold->is_cold(),"must always be cold")
never
parents:
1972
diff
changeset
|
263 } |
0 | 264 |
265 public: | |
266 // Because WarmInfo objects live over the entire lifetime of the | |
267 // Compile object, they are allocated into the comp_arena, which | |
268 // does not get resource marked or reset during the compile process | |
12146
9758d9f36299
8021954: VM SIGSEGV during classloading on MacOS; hs_err_pid file produced
coleenp
parents:
10278
diff
changeset
|
269 void *operator new( size_t x, Compile* C ) throw() { return C->comp_arena()->Amalloc(x); } |
0 | 270 void operator delete( void * ) { } // fast deallocation |
271 | |
272 static WarmCallInfo* always_hot(); | |
273 static WarmCallInfo* always_cold(); | |
274 | |
275 WarmCallInfo() { | |
276 _call = NULL; | |
277 _hot_cg = NULL; | |
278 _next = NULL; | |
279 _count = _profit = _work = _size = _heat = 0; | |
280 } | |
281 | |
282 CallNode* call() const { return _call; } | |
283 float count() const { return _count; } | |
284 float size() const { return _size; } | |
285 float work() const { return _work; } | |
286 float profit() const { return _profit; } | |
287 float heat() const { return _heat; } | |
288 | |
289 void set_count(float x) { _count = x; } | |
290 void set_size(float x) { _size = x; } | |
291 void set_work(float x) { _work = x; } | |
292 void set_profit(float x) { _profit = x; } | |
293 void set_heat(float x) { _heat = x; } | |
294 | |
295 // Load initial heuristics from profiles, etc. | |
296 // The heuristics can be tweaked further by the caller. | |
297 void init(JVMState* call_site, ciMethod* call_method, ciCallProfile& profile, float prof_factor); | |
298 | |
299 static float MAX_VALUE() { return +1.0e10; } | |
300 static float MIN_VALUE() { return -1.0e10; } | |
301 | |
302 float compute_heat() const; | |
303 | |
304 void set_call(CallNode* call) { _call = call; } | |
305 void set_hot_cg(CallGenerator* cg) { _hot_cg = cg; } | |
306 | |
307 // Do not queue very hot or very cold calls. | |
308 // Make very cold ones out of line immediately. | |
309 // Inline very hot ones immediately. | |
310 // These queries apply various tunable limits | |
311 // to the above metrics in a systematic way. | |
312 // Test for coldness before testing for hotness. | |
313 bool is_cold() const; | |
314 bool is_hot() const; | |
315 | |
316 // Force a warm call to be hot. This worklists the call node for inlining. | |
317 void make_hot(); | |
318 | |
319 // Force a warm call to be cold. This worklists the call node for out-of-lining. | |
320 void make_cold(); | |
321 | |
322 // A reproducible total ordering, in which heat is the major key. | |
323 bool warmer_than(WarmCallInfo* that); | |
324 | |
325 // List management. These methods are called with the list head, | |
326 // and return the new list head, inserting or removing the receiver. | |
327 WarmCallInfo* insert_into(WarmCallInfo* head); | |
328 WarmCallInfo* remove_from(WarmCallInfo* head); | |
329 | |
330 #ifndef PRODUCT | |
331 void print() const; | |
332 void print_all() const; | |
333 int count_all() const; | |
334 #endif | |
335 }; | |
1972 | 336 |
337 #endif // SHARE_VM_OPTO_CALLGENERATOR_HPP |