1 /*
2 * Copyright 1997-2009 Sun Microsystems, Inc. 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
20 * CA 95054 USA or visit www.sun.com if you need additional information or
21 * have any questions.
22 *
23 */
24
25 class BytecodeParseHistogram;
26 class InlineTree;
27 class Parse;
28 class SwitchRange;
29
30
31 //------------------------------InlineTree-------------------------------------
32 class InlineTree : public ResourceObj {
33 Compile* C; // cache
34 JVMState* _caller_jvms; // state of caller
35 ciMethod* _method; // method being called by the caller_jvms
36 InlineTree* _caller_tree;
37 uint _count_inline_bcs; // Accumulated count of inlined bytecodes
38 // Call-site count / interpreter invocation count, scaled recursively.
39 // Always between 0.0 and 1.0. Represents the percentage of the method's
40 // total execution time used at this call site.
41 const float _site_invoke_ratio;
42 float compute_callee_frequency( int caller_bci ) const;
43
44 GrowableArray<InlineTree*> _subtrees;
45 friend class Compile;
46
47 protected:
48 InlineTree(Compile* C,
49 const InlineTree* caller_tree,
50 ciMethod* callee_method,
51 JVMState* caller_jvms,
52 int caller_bci,
53 float site_invoke_ratio);
54 InlineTree *build_inline_tree_for_callee(ciMethod* callee_method,
55 JVMState* caller_jvms,
56 int caller_bci);
57 const char* try_to_inline(ciMethod* callee_method, ciMethod* caller_method, int caller_bci, ciCallProfile& profile, WarmCallInfo* wci_result);
58 const char* shouldInline(ciMethod* callee_method, ciMethod* caller_method, int caller_bci, ciCallProfile& profile, WarmCallInfo* wci_result) const;
59 const char* shouldNotInline(ciMethod* callee_method, ciMethod* caller_method, WarmCallInfo* wci_result) const;
60 void print_inlining(ciMethod *callee_method, int caller_bci, const char *failure_msg) const PRODUCT_RETURN;
61
62 InlineTree *caller_tree() const { return _caller_tree; }
63 InlineTree* callee_at(int bci, ciMethod* m) const;
64 int inline_depth() const { return _caller_jvms ? _caller_jvms->depth() : 0; }
65
66 public:
67 static InlineTree* build_inline_tree_root();
68 static InlineTree* find_subtree_from_root(InlineTree* root, JVMState* jvms, ciMethod* callee, bool create_if_not_found = false);
69
70 // For temporary (stack-allocated, stateless) ilts:
71 InlineTree(Compile* c, ciMethod* callee_method, JVMState* caller_jvms, float site_invoke_ratio);
72
73 // InlineTree enum
74 enum InlineStyle {
75 Inline_do_not_inline = 0, //
76 Inline_cha_is_monomorphic = 1, //
77 Inline_type_profile_monomorphic = 2 //
78 };
79
80 // See if it is OK to inline.
81 // The receiver is the inline tree for the caller.
82 //
83 // The result is a temperature indication. If it is hot or cold,
84 // inlining is immediate or undesirable. Otherwise, the info block
85 // returned is newly allocated and may be enqueued.
86 //
87 // If the method is inlinable, a new inline subtree is created on the fly,
88 // and may be accessed by find_subtree_from_root.
89 // The call_method is the dest_method for a special or static invocation.
90 // The call_method is an optimized virtual method candidate otherwise.
91 WarmCallInfo* ok_to_inline(ciMethod *call_method, JVMState* caller_jvms, ciCallProfile& profile, WarmCallInfo* wci);
92
93 // Information about inlined method
94 JVMState* caller_jvms() const { return _caller_jvms; }
95 ciMethod *method() const { return _method; }
96 int caller_bci() const { return _caller_jvms ? _caller_jvms->bci() : InvocationEntryBci; }
97 uint count_inline_bcs() const { return _count_inline_bcs; }
98 float site_invoke_ratio() const { return _site_invoke_ratio; };
99
100 #ifndef PRODUCT
101 private:
102 uint _count_inlines; // Count of inlined methods
103 public:
104 // Debug information collected during parse
105 uint count_inlines() const { return _count_inlines; };
106 #endif
107 GrowableArray<InlineTree*> subtrees() { return _subtrees; }
108 };
109
110
111 //-----------------------------------------------------------------------------
112 //------------------------------Parse------------------------------------------
113 // Parse bytecodes, build a Graph
114 class Parse : public GraphKit {
115 public:
116 // Per-block information needed by the parser:
117 class Block {
118 private:
119 ciTypeFlow::Block* _flow;
120 int _pred_count; // how many predecessors in CFG?
121 int _preds_parsed; // how many of these have been parsed?
122 uint _count; // how many times executed? Currently only set by _goto's
123 bool _is_parsed; // has this block been parsed yet?
124 bool _is_handler; // is this block an exception handler?
125 SafePointNode* _start_map; // all values flowing into this block
126 MethodLivenessResult _live_locals; // lazily initialized liveness bitmap
127
128 int _num_successors; // Includes only normal control flow.
129 int _all_successors; // Include exception paths also.
130 Block** _successors;
131
132 // Use init_node/init_graph to initialize Blocks.
133 // Block() : _live_locals((uintptr_t*)NULL,0) { ShouldNotReachHere(); }
134 Block() : _live_locals(NULL,0) { ShouldNotReachHere(); }
135
136 public:
137
138 // Set up the block data structure itself.
139 void init_node(Parse* outer, int po);
140 // Set up the block's relations to other blocks.
141 void init_graph(Parse* outer);
142
143 ciTypeFlow::Block* flow() const { return _flow; }
144 int pred_count() const { return _pred_count; }
145 int preds_parsed() const { return _preds_parsed; }
146 bool is_parsed() const { return _is_parsed; }
147 bool is_handler() const { return _is_handler; }
148 void set_count( uint x ) { _count = x; }
149 uint count() const { return _count; }
150
151 SafePointNode* start_map() const { assert(is_merged(),""); return _start_map; }
152 void set_start_map(SafePointNode* m) { assert(!is_merged(), ""); _start_map = m; }
153
154 // True after any predecessor flows control into this block
155 bool is_merged() const { return _start_map != NULL; }
156
157 // True when all non-exception predecessors have been parsed.
158 bool is_ready() const { return preds_parsed() == pred_count(); }
159
160 int num_successors() const { return _num_successors; }
161 int all_successors() const { return _all_successors; }
162 Block* successor_at(int i) const {
163 assert((uint)i < (uint)all_successors(), "");
164 return _successors[i];
165 }
166 Block* successor_for_bci(int bci);
167
168 int start() const { return flow()->start(); }
169 int limit() const { return flow()->limit(); }
170 int rpo() const { return flow()->rpo(); }
171 int start_sp() const { return flow()->stack_size(); }
172
173 bool is_loop_head() const { return flow()->is_loop_head(); }
174 bool is_SEL_head() const { return flow()->is_single_entry_loop_head(); }
175 bool is_SEL_backedge(Block* pred) const{ return is_SEL_head() && pred->rpo() >= rpo(); }
176 bool is_invariant_local(uint i) const {
177 const JVMState* jvms = start_map()->jvms();
178 if (!jvms->is_loc(i) || flow()->outer()->has_irreducible_entry()) return false;
179 return flow()->is_invariant_local(i - jvms->locoff());
180 }
181 bool can_elide_SEL_phi(uint i) const { assert(is_SEL_head(),""); return is_invariant_local(i); }
182
183 const Type* peek(int off=0) const { return stack_type_at(start_sp() - (off+1)); }
184
185 const Type* stack_type_at(int i) const;
186 const Type* local_type_at(int i) const;
187 static const Type* get_type(ciType* t) { return Type::get_typeflow_type(t); }
188
189 bool has_trap_at(int bci) const { return flow()->has_trap() && flow()->trap_bci() == bci; }
190
191 // Call this just before parsing a block.
192 void mark_parsed() {
193 assert(!_is_parsed, "must parse each block exactly once");
194 _is_parsed = true;
195 }
196
197 // Return the phi/region input index for the "current" pred,
198 // and bump the pred number. For historical reasons these index
199 // numbers are handed out in descending order. The last index is
200 // always PhiNode::Input (i.e., 1). The value returned is known
201 // as a "path number" because it distinguishes by which path we are
202 // entering the block.
203 int next_path_num() {
204 assert(preds_parsed() < pred_count(), "too many preds?");
205 return pred_count() - _preds_parsed++;
206 }
207
208 // Add a previously unaccounted predecessor to this block.
209 // This operates by increasing the size of the block's region
210 // and all its phi nodes (if any). The value returned is a
211 // path number ("pnum").
212 int add_new_path();
213
214 // Initialize me by recording the parser's map. My own map must be NULL.
215 void record_state(Parse* outer);
216 };
217
218 #ifndef PRODUCT
219 // BytecodeParseHistogram collects number of bytecodes parsed, nodes constructed, and transformations.
220 class BytecodeParseHistogram : public ResourceObj {
221 private:
222 enum BPHType {
223 BPH_transforms,
224 BPH_values
225 };
226 static bool _initialized;
227 static uint _bytecodes_parsed [Bytecodes::number_of_codes];
228 static uint _nodes_constructed[Bytecodes::number_of_codes];
229 static uint _nodes_transformed[Bytecodes::number_of_codes];
230 static uint _new_values [Bytecodes::number_of_codes];
231
232 Bytecodes::Code _initial_bytecode;
233 int _initial_node_count;
234 int _initial_transforms;
235 int _initial_values;
236
237 Parse *_parser;
238 Compile *_compiler;
239
240 // Initialization
241 static void reset();
242
243 // Return info being collected, select with global flag 'BytecodeParseInfo'
244 int current_count(BPHType info_selector);
245
246 public:
247 BytecodeParseHistogram(Parse *p, Compile *c);
248 static bool initialized();
249
250 // Record info when starting to parse one bytecode
251 void set_initial_state( Bytecodes::Code bc );
252 // Record results of parsing one bytecode
253 void record_change();
254
255 // Profile printing
256 static void print(float cutoff = 0.01F); // cutoff in percent
257 };
258
259 public:
260 // Record work done during parsing
261 BytecodeParseHistogram* _parse_histogram;
262 void set_parse_histogram(BytecodeParseHistogram *bph) { _parse_histogram = bph; }
263 BytecodeParseHistogram* parse_histogram() { return _parse_histogram; }
264 #endif
265
266 private:
267 friend class Block;
268
269 // Variables which characterize this compilation as a whole:
270
271 JVMState* _caller; // JVMS which carries incoming args & state.
272 float _expected_uses; // expected number of calls to this code
273 float _prof_factor; // discount applied to my profile counts
274 int _depth; // Inline tree depth, for debug printouts
275 const TypeFunc*_tf; // My kind of function type
276 int _entry_bci; // the osr bci or InvocationEntryBci
277
278 ciTypeFlow* _flow; // Results of previous flow pass.
279 Block* _blocks; // Array of basic-block structs.
280 int _block_count; // Number of elements in _blocks.
281
282 GraphKit _exits; // Record all normal returns and throws here.
283 bool _wrote_final; // Did we write a final field?
284 bool _count_invocations; // update and test invocation counter
285 bool _method_data_update; // update method data oop
286
287 // Variables which track Java semantics during bytecode parsing:
288
289 Block* _block; // block currently getting parsed
290 ciBytecodeStream _iter; // stream of this method's bytecodes
291
292 int _blocks_merged; // Progress meter: state merges from BB preds
293 int _blocks_parsed; // Progress meter: BBs actually parsed
294
295 const FastLockNode* _synch_lock; // FastLockNode for synchronized method
296
297 #ifndef PRODUCT
298 int _max_switch_depth; // Debugging SwitchRanges.
299 int _est_switch_depth; // Debugging SwitchRanges.
300 #endif
301
302 public:
303 // Constructor
304 Parse(JVMState* caller, ciMethod* parse_method, float expected_uses);
305
306 virtual Parse* is_Parse() const { return (Parse*)this; }
307
308 public:
309 // Accessors.
310 JVMState* caller() const { return _caller; }
311 float expected_uses() const { return _expected_uses; }
312 float prof_factor() const { return _prof_factor; }
313 int depth() const { return _depth; }
314 const TypeFunc* tf() const { return _tf; }
315 // entry_bci() -- see osr_bci, etc.
316
317 ciTypeFlow* flow() const { return _flow; }
318 // blocks() -- see rpo_at, start_block, etc.
319 int block_count() const { return _block_count; }
320
321 GraphKit& exits() { return _exits; }
322 bool wrote_final() const { return _wrote_final; }
323 void set_wrote_final(bool z) { _wrote_final = z; }
324 bool count_invocations() const { return _count_invocations; }
325 bool method_data_update() const { return _method_data_update; }
326
327 Block* block() const { return _block; }
328 ciBytecodeStream& iter() { return _iter; }
329 Bytecodes::Code bc() const { return _iter.cur_bc(); }
330
331 void set_block(Block* b) { _block = b; }
332
333 // Derived accessors:
334 bool is_normal_parse() const { return _entry_bci == InvocationEntryBci; }
335 bool is_osr_parse() const { return _entry_bci != InvocationEntryBci; }
336 int osr_bci() const { assert(is_osr_parse(),""); return _entry_bci; }
337
338 void set_parse_bci(int bci);
339
340 // Must this parse be aborted?
341 bool failing() { return C->failing(); }
342
343 Block* rpo_at(int rpo) {
344 assert(0 <= rpo && rpo < _block_count, "oob");
345 return &_blocks[rpo];
346 }
347 Block* start_block() {
348 return rpo_at(flow()->start_block()->rpo());
349 }
350 // Can return NULL if the flow pass did not complete a block.
351 Block* successor_for_bci(int bci) {
352 return block()->successor_for_bci(bci);
353 }
354
355 private:
356 // Create a JVMS & map for the initial state of this method.
357 SafePointNode* create_entry_map();
358
359 // OSR helpers
360 Node *fetch_interpreter_state(int index, BasicType bt, Node *local_addrs, Node *local_addrs_base);
361 Node* check_interpreter_type(Node* l, const Type* type, SafePointNode* &bad_type_exit);
362 void load_interpreter_state(Node* osr_buf);
363
364 // Functions for managing basic blocks:
365 void init_blocks();
366 void load_state_from(Block* b);
367 void store_state_to(Block* b) { b->record_state(this); }
368
369 // Parse all the basic blocks.
370 void do_all_blocks();
371
372 // Parse the current basic block
373 void do_one_block();
374
375 // Raise an error if we get a bad ciTypeFlow CFG.
376 void handle_missing_successor(int bci);
377
378 // first actions (before BCI 0)
379 void do_method_entry();
380
381 // implementation of monitorenter/monitorexit
382 void do_monitor_enter();
383 void do_monitor_exit();
384
385 // Eagerly create phie throughout the state, to cope with back edges.
386 void ensure_phis_everywhere();
387
388 // Merge the current mapping into the basic block starting at bci
389 void merge( int target_bci);
390 // Same as plain merge, except that it allocates a new path number.
391 void merge_new_path( int target_bci);
392 // Merge the current mapping into an exception handler.
393 void merge_exception(int target_bci);
394 // Helper: Merge the current mapping into the given basic block
395 void merge_common(Block* target, int pnum);
396 // Helper functions for merging individual cells.
397 PhiNode *ensure_phi( int idx, bool nocreate = false);
398 PhiNode *ensure_memory_phi(int idx, bool nocreate = false);
399 // Helper to merge the current memory state into the given basic block
400 void merge_memory_edges(MergeMemNode* n, int pnum, bool nophi);
401
402 // Parse this bytecode, and alter the Parsers JVM->Node mapping
403 void do_one_bytecode();
404
405 // helper function to generate array store check
406 void array_store_check();
407 // Helper function to generate array load
408 void array_load(BasicType etype);
409 // Helper function to generate array store
410 void array_store(BasicType etype);
411 // Helper function to compute array addressing
412 Node* array_addressing(BasicType type, int vals, const Type* *result2=NULL);
413
414 // Pass current map to exits
415 void return_current(Node* value);
416
417 // Register finalizers on return from Object.<init>
418 void call_register_finalizer();
419
420 // Insert a compiler safepoint into the graph
421 void add_safepoint();
422
423 // Insert a compiler safepoint into the graph, if there is a back-branch.
424 void maybe_add_safepoint(int target_bci) {
425 if (UseLoopSafepoints && target_bci <= bci()) {
426 add_safepoint();
427 }
428 }
429
430 // Note: Intrinsic generation routines may be found in library_call.cpp.
431
432 // Helper function to setup Ideal Call nodes
433 void do_call();
434
435 // Helper function to uncommon-trap or bailout for non-compilable call-sites
436 bool can_not_compile_call_site(ciMethod *dest_method, ciInstanceKlass *klass);
437
438 // Helper function to identify inlining potential at call-site
439 ciMethod* optimize_inlining(ciMethod* caller, int bci, ciInstanceKlass* klass,
440 ciMethod *dest_method, const TypeOopPtr* receiver_type);
441
442 // Helper function to setup for type-profile based inlining
443 bool prepare_type_profile_inline(ciInstanceKlass* prof_klass, ciMethod* prof_method);
444
445 // Helper functions for type checking bytecodes:
446 void do_checkcast();
447 void do_instanceof();
448
449 // Helper functions for shifting & arithmetic
450 void modf();
451 void modd();
452 void l2f();
453
454 void do_irem();
455
456 // implementation of _get* and _put* bytecodes
457 void do_getstatic() { do_field_access(true, false); }
458 void do_getfield () { do_field_access(true, true); }
459 void do_putstatic() { do_field_access(false, false); }
460 void do_putfield () { do_field_access(false, true); }
461
462 // common code for making initial checks and forming addresses
463 void do_field_access(bool is_get, bool is_field);
464 bool static_field_ok_in_clinit(ciField *field, ciMethod *method);
465
466 // common code for actually performing the load or store
467 void do_get_xxx(const TypePtr* obj_type, Node* obj, ciField* field, bool is_field);
468 void do_put_xxx(const TypePtr* obj_type, Node* obj, ciField* field, bool is_field);
469
470 // loading from a constant field or the constant pool
471 // returns false if push failed (non-perm field constants only, not ldcs)
472 bool push_constant(ciConstant con, bool require_constant = false);
473
474 // implementation of object creation bytecodes
475 void do_new();
476 void do_newarray(BasicType elemtype);
477 void do_anewarray();
478 void do_multianewarray();
479 Node* expand_multianewarray(ciArrayKlass* array_klass, Node* *lengths, int ndimensions, int nargs);
480
481 // implementation of jsr/ret
482 void do_jsr();
483 void do_ret();
484
485 float dynamic_branch_prediction(float &cnt);
486 float branch_prediction(float &cnt, BoolTest::mask btest, int target_bci);
487 bool seems_never_taken(float prob);
488
489 void do_ifnull(BoolTest::mask btest, Node* c);
490 void do_if(BoolTest::mask btest, Node* c);
491 void repush_if_args();
492 void adjust_map_after_if(BoolTest::mask btest, Node* c, float prob,
493 Block* path, Block* other_path);
494 IfNode* jump_if_fork_int(Node* a, Node* b, BoolTest::mask mask);
495 Node* jump_if_join(Node* iffalse, Node* iftrue);
496 void jump_if_true_fork(IfNode *ifNode, int dest_bci_if_true, int prof_table_index);
497 void jump_if_false_fork(IfNode *ifNode, int dest_bci_if_false, int prof_table_index);
498 void jump_if_always_fork(int dest_bci_if_true, int prof_table_index);
499
500 friend class SwitchRange;
501 void do_tableswitch();
502 void do_lookupswitch();
503 void jump_switch_ranges(Node* a, SwitchRange* lo, SwitchRange* hi, int depth = 0);
504 bool create_jump_tables(Node* a, SwitchRange* lo, SwitchRange* hi);
505
506 // helper functions for methodData style profiling
507 void test_counter_against_threshold(Node* cnt, int limit);
508 void increment_and_test_invocation_counter(int limit);
509 void test_for_osr_md_counter_at(ciMethodData* md, ciProfileData* data, ByteSize offset, int limit);
510 Node* method_data_addressing(ciMethodData* md, ciProfileData* data, ByteSize offset, Node* idx = NULL, uint stride = 0);
511 void increment_md_counter_at(ciMethodData* md, ciProfileData* data, ByteSize offset, Node* idx = NULL, uint stride = 0);
512 void set_md_flag_at(ciMethodData* md, ciProfileData* data, int flag_constant);
513
514 void profile_method_entry();
515 void profile_taken_branch(int target_bci, bool force_update = false);
516 void profile_not_taken_branch(bool force_update = false);
517 void profile_call(Node* receiver);
518 void profile_generic_call();
519 void profile_receiver_type(Node* receiver);
520 void profile_ret(int target_bci);
521 void profile_null_checkcast();
522 void profile_switch_case(int table_index);
523
524 // helper function for call statistics
525 void count_compiled_calls(bool at_method_entry, bool is_inline) PRODUCT_RETURN;
526
527 Node_Notes* make_node_notes(Node_Notes* caller_nn);
528
529 // Helper functions for handling normal and abnormal exits.
530 void build_exits();
531
532 // Fix up all exceptional control flow exiting a single bytecode.
533 void do_exceptions();
534
535 // Fix up all exiting control flow at the end of the parse.
536 void do_exits();
537
538 // Add Catch/CatchProjs
539 // The call is either a Java call or the VM's rethrow stub
540 void catch_call_exceptions(ciExceptionHandlerStream&);
541
542 // Handle all exceptions thrown by the inlined method.
543 // Also handles exceptions for individual bytecodes.
544 void catch_inline_exceptions(SafePointNode* ex_map);
545
546 // Bytecode classifier, helps decide to use uncommon_trap vs. rethrow_C.
547 bool can_rerun_bytecode();
548
549 // Merge the given map into correct exceptional exit state.
550 // Assumes that there is no applicable local handler.
551 void throw_to_exit(SafePointNode* ex_map);
552
553 public:
554 #ifndef PRODUCT
555 // Handle PrintOpto, etc.
556 void show_parse_info();
557 void dump_map_adr_mem() const;
558 static void print_statistics(); // Print some performance counters
559 void dump();
560 void dump_bci(int bci);
561 #endif
562 };