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