duke@435: /* mikael@6198: * Copyright (c) 1999, 2013, Oracle and/or its affiliates. All rights reserved. duke@435: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. duke@435: * duke@435: * This code is free software; you can redistribute it and/or modify it duke@435: * under the terms of the GNU General Public License version 2 only, as duke@435: * published by the Free Software Foundation. duke@435: * duke@435: * This code is distributed in the hope that it will be useful, but WITHOUT duke@435: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or duke@435: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License duke@435: * version 2 for more details (a copy is included in the LICENSE file that duke@435: * accompanied this code). duke@435: * duke@435: * You should have received a copy of the GNU General Public License version duke@435: * 2 along with this work; if not, write to the Free Software Foundation, duke@435: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. duke@435: * trims@1907: * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA trims@1907: * or visit www.oracle.com if you need additional information or have any trims@1907: * questions. duke@435: * duke@435: */ duke@435: stefank@2314: #ifndef SHARE_VM_C1_C1_GRAPHBUILDER_HPP stefank@2314: #define SHARE_VM_C1_C1_GRAPHBUILDER_HPP stefank@2314: stefank@2314: #include "c1/c1_IR.hpp" stefank@2314: #include "c1/c1_Instruction.hpp" stefank@2314: #include "c1/c1_ValueMap.hpp" stefank@2314: #include "c1/c1_ValueStack.hpp" stefank@2314: #include "ci/ciMethodData.hpp" stefank@2314: #include "ci/ciStreams.hpp" vlivanov@4154: #include "compiler/compileLog.hpp" stefank@2314: duke@435: class MemoryBuffer; duke@435: duke@435: class GraphBuilder VALUE_OBJ_CLASS_SPEC { duke@435: private: duke@435: // Per-scope data. These are pushed and popped as we descend into duke@435: // inlined methods. Currently in order to generate good code in the duke@435: // inliner we have to attempt to inline methods directly into the duke@435: // basic block we are parsing; this adds complexity. duke@435: class ScopeData: public CompilationResourceObj { duke@435: private: duke@435: ScopeData* _parent; duke@435: // bci-to-block mapping duke@435: BlockList* _bci2block; duke@435: // Scope duke@435: IRScope* _scope; duke@435: // Whether this scope or any parent scope has exception handlers duke@435: bool _has_handler; duke@435: // The bytecodes duke@435: ciBytecodeStream* _stream; duke@435: duke@435: // Work list duke@435: BlockList* _work_list; duke@435: duke@435: // Maximum inline size for this scope duke@435: intx _max_inline_size; duke@435: // Expression stack depth at point where inline occurred duke@435: int _caller_stack_size; duke@435: duke@435: // The continuation point for the inline. Currently only used in duke@435: // multi-block inlines, but eventually would like to use this for duke@435: // all inlines for uniformity and simplicity; in this case would duke@435: // get the continuation point from the BlockList instead of duke@435: // fabricating it anew because Invokes would be considered to be duke@435: // BlockEnds. duke@435: BlockBegin* _continuation; duke@435: duke@435: // Was this ScopeData created only for the parsing and inlining of duke@435: // a jsr? duke@435: bool _parsing_jsr; duke@435: // We track the destination bci of the jsr only to determine duke@435: // bailout conditions, since we only handle a subset of all of the duke@435: // possible jsr-ret control structures. Recursive invocations of a duke@435: // jsr are disallowed by the verifier. duke@435: int _jsr_entry_bci; duke@435: // We need to track the local variable in which the return address duke@435: // was stored to ensure we can handle inlining the jsr, because we duke@435: // don't handle arbitrary jsr/ret constructs. duke@435: int _jsr_ret_addr_local; duke@435: // If we are parsing a jsr, the continuation point for rets duke@435: BlockBegin* _jsr_continuation; duke@435: // Cloned XHandlers for jsr-related ScopeDatas duke@435: XHandlers* _jsr_xhandlers; duke@435: duke@435: // Number of returns seen in this scope duke@435: int _num_returns; duke@435: duke@435: // In order to generate profitable code for inlining, we currently duke@435: // have to perform an optimization for single-block inlined duke@435: // methods where we continue parsing into the same block. This duke@435: // allows us to perform CSE across inlined scopes and to avoid duke@435: // storing parameters to the stack. Having a global register duke@435: // allocator and being able to perform global CSE would allow this duke@435: // code to be removed and thereby simplify the inliner. duke@435: BlockBegin* _cleanup_block; // The block to which the return was added duke@435: Instruction* _cleanup_return_prev; // Instruction before return instruction duke@435: ValueStack* _cleanup_state; // State of that block (not yet pinned) duke@435: duke@435: public: duke@435: ScopeData(ScopeData* parent); duke@435: duke@435: ScopeData* parent() const { return _parent; } duke@435: duke@435: BlockList* bci2block() const { return _bci2block; } duke@435: void set_bci2block(BlockList* bci2block) { _bci2block = bci2block; } duke@435: duke@435: // NOTE: this has a different effect when parsing jsrs duke@435: BlockBegin* block_at(int bci); duke@435: duke@435: IRScope* scope() const { return _scope; } duke@435: // Has side-effect of setting has_handler flag duke@435: void set_scope(IRScope* scope); duke@435: duke@435: // Whether this or any parent scope has exception handlers duke@435: bool has_handler() const { return _has_handler; } duke@435: void set_has_handler() { _has_handler = true; } duke@435: duke@435: // Exception handlers list to be used for this scope duke@435: XHandlers* xhandlers() const; duke@435: duke@435: // How to get a block to be parsed duke@435: void add_to_work_list(BlockBegin* block); duke@435: // How to remove the next block to be parsed; returns NULL if none left duke@435: BlockBegin* remove_from_work_list(); duke@435: // Indicates parse is over duke@435: bool is_work_list_empty() const; duke@435: duke@435: ciBytecodeStream* stream() { return _stream; } duke@435: void set_stream(ciBytecodeStream* stream) { _stream = stream; } duke@435: duke@435: intx max_inline_size() const { return _max_inline_size; } duke@435: duke@435: BlockBegin* continuation() const { return _continuation; } duke@435: void set_continuation(BlockBegin* cont) { _continuation = cont; } duke@435: duke@435: // Indicates whether this ScopeData was pushed only for the duke@435: // parsing and inlining of a jsr duke@435: bool parsing_jsr() const { return _parsing_jsr; } duke@435: void set_parsing_jsr() { _parsing_jsr = true; } duke@435: int jsr_entry_bci() const { return _jsr_entry_bci; } duke@435: void set_jsr_entry_bci(int bci) { _jsr_entry_bci = bci; } duke@435: void set_jsr_return_address_local(int local_no){ _jsr_ret_addr_local = local_no; } duke@435: int jsr_return_address_local() const { return _jsr_ret_addr_local; } duke@435: // Must be called after scope is set up for jsr ScopeData duke@435: void setup_jsr_xhandlers(); duke@435: duke@435: // The jsr continuation is only used when parsing_jsr is true, and duke@435: // is different from the "normal" continuation since we can end up duke@435: // doing a return (rather than a ret) from within a subroutine duke@435: BlockBegin* jsr_continuation() const { return _jsr_continuation; } duke@435: void set_jsr_continuation(BlockBegin* cont) { _jsr_continuation = cont; } duke@435: duke@435: int num_returns(); duke@435: void incr_num_returns(); duke@435: duke@435: void set_inline_cleanup_info(BlockBegin* block, duke@435: Instruction* return_prev, duke@435: ValueStack* return_state); duke@435: BlockBegin* inline_cleanup_block() const { return _cleanup_block; } duke@435: Instruction* inline_cleanup_return_prev() const{ return _cleanup_return_prev; } duke@435: ValueStack* inline_cleanup_state() const { return _cleanup_state; } duke@435: }; duke@435: duke@435: // for all GraphBuilders duke@435: static bool _can_trap[Bytecodes::number_of_java_codes]; duke@435: duke@435: // for each instance of GraphBuilder duke@435: ScopeData* _scope_data; // Per-scope data; used for inlining duke@435: Compilation* _compilation; // the current compilation duke@435: ValueMap* _vmap; // the map of values encountered (for CSE) duke@435: MemoryBuffer* _memory; duke@435: const char* _inline_bailout_msg; // non-null if most recent inline attempt failed duke@435: int _instruction_count; // for bailing out in pathological jsr/ret cases duke@435: BlockBegin* _start; // the start block duke@435: BlockBegin* _osr_entry; // the osr entry block block duke@435: ValueStack* _initial_state; // The state for the start block duke@435: duke@435: // for each call to connect_to_end; can also be set by inliner duke@435: BlockBegin* _block; // the current block duke@435: ValueStack* _state; // the current execution state duke@435: Instruction* _last; // the last instruction added duke@435: bool _skip_block; // skip processing of the rest of this block duke@435: duke@435: // accessors duke@435: ScopeData* scope_data() const { return _scope_data; } duke@435: Compilation* compilation() const { return _compilation; } duke@435: BlockList* bci2block() const { return scope_data()->bci2block(); } duke@435: ValueMap* vmap() const { assert(UseLocalValueNumbering, "should not access otherwise"); return _vmap; } duke@435: bool has_handler() const { return scope_data()->has_handler(); } duke@435: duke@435: BlockBegin* block() const { return _block; } duke@435: ValueStack* state() const { return _state; } duke@435: void set_state(ValueStack* state) { _state = state; } duke@435: IRScope* scope() const { return scope_data()->scope(); } duke@435: ciMethod* method() const { return scope()->method(); } duke@435: ciBytecodeStream* stream() const { return scope_data()->stream(); } duke@435: Instruction* last() const { return _last; } duke@435: Bytecodes::Code code() const { return stream()->cur_bc(); } duke@435: int bci() const { return stream()->cur_bci(); } duke@435: int next_bci() const { return stream()->next_bci(); } duke@435: duke@435: // unified bailout support duke@435: void bailout(const char* msg) const { compilation()->bailout(msg); } duke@435: bool bailed_out() const { return compilation()->bailed_out(); } duke@435: duke@435: // stack manipulation helpers duke@435: void ipush(Value t) const { state()->ipush(t); } duke@435: void lpush(Value t) const { state()->lpush(t); } duke@435: void fpush(Value t) const { state()->fpush(t); } duke@435: void dpush(Value t) const { state()->dpush(t); } duke@435: void apush(Value t) const { state()->apush(t); } duke@435: void push(ValueType* type, Value t) const { state()-> push(type, t); } duke@435: duke@435: Value ipop() { return state()->ipop(); } duke@435: Value lpop() { return state()->lpop(); } duke@435: Value fpop() { return state()->fpop(); } duke@435: Value dpop() { return state()->dpop(); } duke@435: Value apop() { return state()->apop(); } duke@435: Value pop(ValueType* type) { return state()-> pop(type); } duke@435: duke@435: // instruction helpers duke@435: void load_constant(); duke@435: void load_local(ValueType* type, int index); duke@435: void store_local(ValueType* type, int index); twisti@3969: void store_local(ValueStack* state, Value value, int index); duke@435: void load_indexed (BasicType type); duke@435: void store_indexed(BasicType type); duke@435: void stack_op(Bytecodes::Code code); roland@2174: void arithmetic_op(ValueType* type, Bytecodes::Code code, ValueStack* state_before = NULL); duke@435: void negate_op(ValueType* type); duke@435: void shift_op(ValueType* type, Bytecodes::Code code); duke@435: void logic_op(ValueType* type, Bytecodes::Code code); duke@435: void compare_op(ValueType* type, Bytecodes::Code code); duke@435: void convert(Bytecodes::Code op, BasicType from, BasicType to); duke@435: void increment(); duke@435: void _goto(int from_bci, int to_bci); duke@435: void if_node(Value x, If::Condition cond, Value y, ValueStack* stack_before); duke@435: void if_zero(ValueType* type, If::Condition cond); duke@435: void if_null(ValueType* type, If::Condition cond); duke@435: void if_same(ValueType* type, If::Condition cond); duke@435: void jsr(int dest); duke@435: void ret(int local_index); duke@435: void table_switch(); duke@435: void lookup_switch(); duke@435: void method_return(Value x); duke@435: void call_register_finalizer(); duke@435: void access_field(Bytecodes::Code code); duke@435: void invoke(Bytecodes::Code code); duke@435: void new_instance(int klass_index); duke@435: void new_type_array(); duke@435: void new_object_array(); duke@435: void check_cast(int klass_index); duke@435: void instance_of(int klass_index); duke@435: void monitorenter(Value x, int bci); duke@435: void monitorexit(Value x, int bci); duke@435: void new_multi_array(int dimensions); duke@435: void throw_op(int bci); duke@435: Value round_fp(Value fp_value); duke@435: duke@435: // stack/code manipulation helpers duke@435: Instruction* append_with_bci(Instruction* instr, int bci); duke@435: Instruction* append(Instruction* instr); duke@435: Instruction* append_split(StateSplit* instr); duke@435: duke@435: // other helpers duke@435: BlockBegin* block_at(int bci) { return scope_data()->block_at(bci); } roland@2174: XHandlers* handle_exception(Instruction* instruction); duke@435: void connect_to_end(BlockBegin* beg); duke@435: void null_check(Value value); duke@435: void eliminate_redundant_phis(BlockBegin* start); duke@435: BlockEnd* iterate_bytecodes_for_block(int bci); duke@435: void iterate_all_blocks(bool start_in_current_block_for_inlining = false); duke@435: Dependencies* dependency_recorder() const; // = compilation()->dependencies() duke@435: bool direct_compare(ciKlass* k); duke@435: duke@435: void kill_all(); duke@435: roland@2174: // use of state copy routines (try to minimize unnecessary state roland@2174: // object allocations): roland@2174: roland@2174: // - if the instruction unconditionally needs a full copy of the roland@2174: // state (for patching for example), then use copy_state_before* roland@2174: roland@2174: // - if the instruction needs a full copy of the state only for roland@2174: // handler generation (Instruction::needs_exception_state() returns roland@2174: // false) then use copy_state_exhandling* roland@2174: roland@2174: // - if the instruction needs either a full copy of the state for roland@2174: // handler generation and a least a minimal copy of the state (as roland@2174: // returned by Instruction::exception_state()) for debug info roland@2174: // generation (that is when Instruction::needs_exception_state() roland@2174: // returns true) then use copy_state_for_exception* roland@2174: roland@2174: ValueStack* copy_state_before_with_bci(int bci); roland@2174: ValueStack* copy_state_before(); roland@2174: ValueStack* copy_state_exhandling_with_bci(int bci); roland@2174: ValueStack* copy_state_exhandling(); roland@2174: ValueStack* copy_state_for_exception_with_bci(int bci); roland@2174: ValueStack* copy_state_for_exception(); roland@4860: ValueStack* copy_state_if_bb(bool is_bb) { return (is_bb || compilation()->is_optimistic()) ? copy_state_before() : NULL; } roland@4860: ValueStack* copy_state_indexed_access() { return compilation()->is_optimistic() ? copy_state_before() : copy_state_for_exception(); } duke@435: duke@435: // duke@435: // Inlining support duke@435: // duke@435: duke@435: // accessors duke@435: bool parsing_jsr() const { return scope_data()->parsing_jsr(); } duke@435: BlockBegin* continuation() const { return scope_data()->continuation(); } duke@435: BlockBegin* jsr_continuation() const { return scope_data()->jsr_continuation(); } duke@435: void set_continuation(BlockBegin* continuation) { scope_data()->set_continuation(continuation); } duke@435: void set_inline_cleanup_info(BlockBegin* block, duke@435: Instruction* return_prev, duke@435: ValueStack* return_state) { scope_data()->set_inline_cleanup_info(block, duke@435: return_prev, duke@435: return_state); } twisti@3100: void set_inline_cleanup_info() { twisti@3100: set_inline_cleanup_info(_block, _last, _state); twisti@3100: } duke@435: BlockBegin* inline_cleanup_block() const { return scope_data()->inline_cleanup_block(); } duke@435: Instruction* inline_cleanup_return_prev() const { return scope_data()->inline_cleanup_return_prev(); } duke@435: ValueStack* inline_cleanup_state() const { return scope_data()->inline_cleanup_state(); } twisti@3100: void restore_inline_cleanup_info() { twisti@3100: _block = inline_cleanup_block(); twisti@3100: _last = inline_cleanup_return_prev(); twisti@3100: _state = inline_cleanup_state(); twisti@3100: } duke@435: void incr_num_returns() { scope_data()->incr_num_returns(); } duke@435: int num_returns() const { return scope_data()->num_returns(); } duke@435: intx max_inline_size() const { return scope_data()->max_inline_size(); } duke@435: int inline_level() const { return scope()->level(); } duke@435: int recursive_inline_level(ciMethod* callee) const; duke@435: duke@435: // inlining of synchronized methods duke@435: void inline_sync_entry(Value lock, BlockBegin* sync_handler); duke@435: void fill_sync_handler(Value lock, BlockBegin* sync_handler, bool default_handler = false); duke@435: duke@435: // inliners twisti@3969: bool try_inline( ciMethod* callee, bool holder_known, Bytecodes::Code bc = Bytecodes::_illegal, Value receiver = NULL); duke@435: bool try_inline_intrinsics(ciMethod* callee); twisti@3969: bool try_inline_full( ciMethod* callee, bool holder_known, Bytecodes::Code bc = Bytecodes::_illegal, Value receiver = NULL); duke@435: bool try_inline_jsr(int jsr_dest_bci); duke@435: twisti@3969: const char* check_can_parse(ciMethod* callee) const; twisti@3969: const char* should_not_inline(ciMethod* callee) const; twisti@3969: twisti@3100: // JSR 292 support twisti@4021: bool try_method_handle_inline(ciMethod* callee); twisti@3100: duke@435: // helpers duke@435: void inline_bailout(const char* msg); duke@435: BlockBegin* header_block(BlockBegin* entry, BlockBegin::Flag f, ValueStack* state); duke@435: BlockBegin* setup_start_block(int osr_bci, BlockBegin* std_entry, BlockBegin* osr_entry, ValueStack* init_state); duke@435: void setup_osr_entry_block(); duke@435: void clear_inline_bailout(); duke@435: ValueStack* state_at_entry(); duke@435: void push_root_scope(IRScope* scope, BlockList* bci2block, BlockBegin* start); duke@435: void push_scope(ciMethod* callee, BlockBegin* continuation); duke@435: void push_scope_for_jsr(BlockBegin* jsr_continuation, int jsr_dest_bci); duke@435: void pop_scope(); duke@435: void pop_scope_for_jsr(); duke@435: duke@435: bool append_unsafe_get_obj(ciMethod* callee, BasicType t, bool is_volatile); duke@435: bool append_unsafe_put_obj(ciMethod* callee, BasicType t, bool is_volatile); duke@435: bool append_unsafe_get_raw(ciMethod* callee, BasicType t); duke@435: bool append_unsafe_put_raw(ciMethod* callee, BasicType t); duke@435: bool append_unsafe_prefetch(ciMethod* callee, bool is_store, bool is_static); duke@435: void append_unsafe_CAS(ciMethod* callee); roland@4106: bool append_unsafe_get_and_set_obj(ciMethod* callee, bool is_add); duke@435: vlivanov@4154: void print_inlining(ciMethod* callee, const char* msg = NULL, bool success = true); duke@435: roland@5914: void profile_call(ciMethod* callee, Value recv, ciKlass* predicted_holder, Values* obj_args, bool inlined); roland@5921: void profile_return_type(Value ret, ciMethod* callee, ciMethod* m = NULL, int bci = -1); iveresov@2180: void profile_invocation(ciMethod* inlinee, ValueStack* state); duke@435: iveresov@2138: // Shortcuts to profiling control. iveresov@2138: bool is_profiling() { return _compilation->is_profiling(); } iveresov@2138: bool count_invocations() { return _compilation->count_invocations(); } iveresov@2138: bool count_backedges() { return _compilation->count_backedges(); } iveresov@2138: bool profile_branches() { return _compilation->profile_branches(); } iveresov@2138: bool profile_calls() { return _compilation->profile_calls(); } iveresov@2138: bool profile_inlined_calls() { return _compilation->profile_inlined_calls(); } iveresov@2138: bool profile_checkcasts() { return _compilation->profile_checkcasts(); } roland@5987: bool profile_parameters() { return _compilation->profile_parameters(); } roland@5987: bool profile_arguments() { return _compilation->profile_arguments(); } roland@5987: bool profile_return() { return _compilation->profile_return(); } duke@435: roland@5987: Values* args_list_for_profiling(ciMethod* target, int& start, bool may_have_receiver); roland@5987: Values* collect_args_for_profiling(Values* args, ciMethod* target, bool may_have_receiver); roland@6668: void check_args_for_profiling(Values* obj_args, int expected); roland@5914: duke@435: public: duke@435: NOT_PRODUCT(void print_stats();) duke@435: duke@435: // initialization duke@435: static void initialize(); duke@435: duke@435: // public duke@435: static bool can_trap(ciMethod* method, Bytecodes::Code code) { duke@435: assert(0 <= code && code < Bytecodes::number_of_java_codes, "illegal bytecode"); duke@435: if (_can_trap[code]) return true; duke@435: // special handling for finalizer registration duke@435: return code == Bytecodes::_return && method->intrinsic_id() == vmIntrinsics::_Object_init; duke@435: } duke@435: duke@435: // creation duke@435: GraphBuilder(Compilation* compilation, IRScope* scope); duke@435: static void sort_top_into_worklist(BlockList* worklist, BlockBegin* top); duke@435: duke@435: BlockBegin* start() const { return _start; } duke@435: }; stefank@2314: stefank@2314: #endif // SHARE_VM_C1_C1_GRAPHBUILDER_HPP