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 */
24
25 #ifndef SHARE_OPTO_GRAPHKIT_HPP
26 #define SHARE_OPTO_GRAPHKIT_HPP
27
28 #include "ci/ciEnv.hpp"
29 #include "ci/ciMethodData.hpp"
30 #include "gc/shared/c2/barrierSetC2.hpp"
31 #include "opto/addnode.hpp"
32 #include "opto/callnode.hpp"
33 #include "opto/cfgnode.hpp"
34 #include "opto/compile.hpp"
35 #include "opto/divnode.hpp"
36 #include "opto/mulnode.hpp"
37 #include "opto/phaseX.hpp"
38 #include "opto/subnode.hpp"
39 #include "opto/type.hpp"
40 #include "runtime/deoptimization.hpp"
41
42 class BarrierSetC2;
43 class FastLockNode;
44 class FastUnlockNode;
45 class IdealKit;
46 class LibraryCallKit;
47 class Parse;
48 class RootNode;
49
50 //-----------------------------------------------------------------------------
51 //----------------------------GraphKit-----------------------------------------
52 // Toolkit for building the common sorts of subgraphs.
53 // Does not know about bytecode parsing or type-flow results.
54 // It is able to create graphs implementing the semantics of most
55 // or all bytecodes, so that it can expand intrinsics and calls.
56 // It may depend on JVMState structure, but it must not depend
57 // on specific bytecode streams.
58 class GraphKit : public Phase {
59 friend class PreserveJVMState;
60
61 protected:
62 ciEnv* _env; // Compilation environment
63 PhaseGVN &_gvn; // Some optimizations while parsing
64 SafePointNode* _map; // Parser map from JVM to Nodes
65 SafePointNode* _exceptions;// Parser map(s) for exception state(s)
66 int _bci; // JVM Bytecode Pointer
67 ciMethod* _method; // JVM Current Method
68 BarrierSetC2* _barrier_set;
69
70 private:
71 int _sp; // JVM Expression Stack Pointer; don't modify directly!
72
73 private:
74 SafePointNode* map_not_null() const {
75 assert(_map != nullptr, "must call stopped() to test for reset compiler map");
76 return _map;
77 }
78
79 public:
80 GraphKit(); // empty constructor
81 GraphKit(JVMState* jvms); // the JVM state on which to operate
82
83 #ifdef ASSERT
84 ~GraphKit() {
85 assert(failing_internal() || !has_exceptions(),
86 "unless compilation failed, user must call transfer_exceptions_into_jvms");
87 }
88 #endif
89
90 virtual Parse* is_Parse() const { return nullptr; }
91 virtual LibraryCallKit* is_LibraryCallKit() const { return nullptr; }
92
93 ciEnv* env() const { return _env; }
94 PhaseGVN& gvn() const { return _gvn; }
95 void* barrier_set_state() const { return C->barrier_set_state(); }
96
97 void record_for_igvn(Node* n) const { C->record_for_igvn(n); } // delegate to Compile
98 void remove_for_igvn(Node* n) const { C->remove_for_igvn(n); }
99
100 // Handy well-known nodes:
101 Node* null() const { return zerocon(T_OBJECT); }
102 Node* top() const { return C->top(); }
103 RootNode* root() const { return C->root(); }
104
105 // Create or find a constant node
106 Node* intcon(jint con) const { return _gvn.intcon(con); }
107 Node* longcon(jlong con) const { return _gvn.longcon(con); }
108 Node* integercon(jlong con, BasicType bt) const {
109 if (bt == T_INT) {
110 return intcon(checked_cast<jint>(con));
111 }
112 assert(bt == T_LONG, "basic type not an int or long");
113 return longcon(con);
114 }
115 Node* makecon(const Type *t) const { return _gvn.makecon(t); }
116 Node* zerocon(BasicType bt) const { return _gvn.zerocon(bt); }
117 // (See also macro MakeConX in type.hpp, which uses intcon or longcon.)
362 Node* ConvL2I(Node* offset);
363 // Find out the klass of an object.
364 Node* load_object_klass(Node* object);
365 // Find out the length of an array.
366 Node* load_array_length(Node* array);
367 // Cast array allocation's length as narrow as possible.
368 // If replace_length_in_map is true, replace length with CastIINode in map.
369 // This method is invoked after creating/moving ArrayAllocationNode or in load_array_length
370 Node* array_ideal_length(AllocateArrayNode* alloc,
371 const TypeOopPtr* oop_type,
372 bool replace_length_in_map);
373
374
375 // Helper function to do a null pointer check or ZERO check based on type.
376 // Throw an exception if a given value is null.
377 // Return the value cast to not-null.
378 // Be clever about equivalent dominating null checks.
379 Node* null_check_common(Node* value, BasicType type,
380 bool assert_null = false,
381 Node* *null_control = nullptr,
382 bool speculative = false);
383 Node* null_check(Node* value, BasicType type = T_OBJECT) {
384 return null_check_common(value, type, false, nullptr, !_gvn.type(value)->speculative_maybe_null());
385 }
386 Node* null_check_receiver() {
387 assert(argument(0)->bottom_type()->isa_ptr(), "must be");
388 return null_check(argument(0));
389 }
390 Node* zero_check_int(Node* value) {
391 assert(value->bottom_type()->basic_type() == T_INT,
392 "wrong type: %s", type2name(value->bottom_type()->basic_type()));
393 return null_check_common(value, T_INT);
394 }
395 Node* zero_check_long(Node* value) {
396 assert(value->bottom_type()->basic_type() == T_LONG,
397 "wrong type: %s", type2name(value->bottom_type()->basic_type()));
398 return null_check_common(value, T_LONG);
399 }
400 // Throw an uncommon trap if a given value is __not__ null.
401 // Return the value cast to null, and be clever about dominating checks.
402 Node* null_assert(Node* value, BasicType type = T_OBJECT) {
403 return null_check_common(value, type, true, nullptr, _gvn.type(value)->speculative_always_null());
404 }
405
406 // Check if value is null and abort if it is
407 Node* must_be_not_null(Node* value, bool do_replace_in_map);
442 void record_profiled_parameters_for_speculation();
443 void record_profiled_return_for_speculation();
444 Node* record_profiled_receiver_for_speculation(Node* n);
445
446 // Use the type profile to narrow an object type.
447 Node* maybe_cast_profiled_receiver(Node* not_null_obj,
448 const TypeKlassPtr* require_klass,
449 ciKlass* spec,
450 bool safe_for_replace);
451
452 // Cast obj to type and emit guard unless we had too many traps here already
453 Node* maybe_cast_profiled_obj(Node* obj,
454 ciKlass* type,
455 bool not_null = false);
456
457 // Cast obj to not-null on this path
458 Node* cast_not_null(Node* obj, bool do_replace_in_map = true);
459 // Replace all occurrences of one node by another.
460 void replace_in_map(Node* old, Node* neww);
461
462 Node* maybe_narrow_object_type(Node* obj, ciKlass* type);
463
464 void push(Node* n) { map_not_null(); _map->set_stack(_map->_jvms, _sp++ , n); }
465 Node* pop() { map_not_null(); return _map->stack( _map->_jvms, --_sp ); }
466 Node* peek(int off = 0) { map_not_null(); return _map->stack( _map->_jvms, _sp - off - 1 ); }
467
468 void push_pair(Node* ldval) {
469 push(ldval);
470 push(top()); // the halfword is merely a placeholder
471 }
472 void push_pair_local(int i) {
473 // longs are stored in locals in "push" order
474 push( local(i+0) ); // the real value
475 assert(local(i+1) == top(), "");
476 push(top()); // halfword placeholder
477 }
478 Node* pop_pair() {
479 // the second half is pushed last & popped first; it contains exactly nothing
480 Node* halfword = pop();
481 assert(halfword == top(), "");
482 // the long bits are pushed first & popped last:
569 // procedure must indicate that the store requires `release'
570 // semantics, if the stored value is an object reference that might
571 // point to a new object and may become externally visible.
572 // Return the new StoreXNode
573 Node* store_to_memory(Node* ctl, Node* adr, Node* val, BasicType bt,
574 MemNode::MemOrd,
575 bool require_atomic_access = false,
576 bool unaligned = false,
577 bool mismatched = false,
578 bool unsafe = false,
579 int barrier_data = 0);
580
581 // Perform decorated accesses
582
583 Node* access_store_at(Node* obj, // containing obj
584 Node* adr, // actual address to store val at
585 const TypePtr* adr_type,
586 Node* val,
587 const Type* val_type,
588 BasicType bt,
589 DecoratorSet decorators);
590
591 Node* access_load_at(Node* obj, // containing obj
592 Node* adr, // actual address to load val at
593 const TypePtr* adr_type,
594 const Type* val_type,
595 BasicType bt,
596 DecoratorSet decorators);
597
598 Node* access_load(Node* adr, // actual address to load val at
599 const Type* val_type,
600 BasicType bt,
601 DecoratorSet decorators);
602
603 Node* access_atomic_cmpxchg_val_at(Node* obj,
604 Node* adr,
605 const TypePtr* adr_type,
606 int alias_idx,
607 Node* expected_val,
608 Node* new_val,
609 const Type* value_type,
610 BasicType bt,
611 DecoratorSet decorators);
612
613 Node* access_atomic_cmpxchg_bool_at(Node* obj,
614 Node* adr,
615 const TypePtr* adr_type,
616 int alias_idx,
629 BasicType bt,
630 DecoratorSet decorators);
631
632 Node* access_atomic_add_at(Node* obj,
633 Node* adr,
634 const TypePtr* adr_type,
635 int alias_idx,
636 Node* new_val,
637 const Type* value_type,
638 BasicType bt,
639 DecoratorSet decorators);
640
641 void access_clone(Node* src, Node* dst, Node* size, bool is_array);
642
643 // Return addressing for an array element.
644 Node* array_element_address(Node* ary, Node* idx, BasicType elembt,
645 // Optional constraint on the array size:
646 const TypeInt* sizetype = nullptr,
647 // Optional control dependency (for example, on range check)
648 Node* ctrl = nullptr);
649
650 // Return a load of array element at idx.
651 Node* load_array_element(Node* ary, Node* idx, const TypeAryPtr* arytype, bool set_ctrl);
652
653 //---------------- Dtrace support --------------------
654 void make_dtrace_method_entry_exit(ciMethod* method, bool is_entry);
655 void make_dtrace_method_entry(ciMethod* method) {
656 make_dtrace_method_entry_exit(method, true);
657 }
658 void make_dtrace_method_exit(ciMethod* method) {
659 make_dtrace_method_entry_exit(method, false);
660 }
661
662 //--------------- stub generation -------------------
663 public:
664 void gen_stub(address C_function,
665 const char *name,
666 int is_fancy_jump,
667 bool pass_tls,
668 bool return_pc);
669
670 //---------- help for generating calls --------------
671
672 // Do a null check on the receiver as it would happen before the call to
673 // callee (with all arguments still on the stack).
674 Node* null_check_receiver_before_call(ciMethod* callee) {
675 assert(!callee->is_static(), "must be a virtual method");
676 // Callsite signature can be different from actual method being called (i.e _linkTo* sites).
677 // Use callsite signature always.
678 ciMethod* declared_method = method()->get_method_at_bci(bci());
679 const int nargs = declared_method->arg_size();
680 inc_sp(nargs);
681 Node* n = null_check_receiver();
682 dec_sp(nargs);
683 return n;
684 }
685
686 // Fill in argument edges for the call from argument(0), argument(1), ...
687 // (The next step is to call set_edges_for_java_call.)
688 void set_arguments_for_java_call(CallJavaNode* call);
689
690 // Fill in non-argument edges for the call.
691 // Transform the call, and update the basics: control, i_o, memory.
692 // (The next step is usually to call set_results_for_java_call.)
693 void set_edges_for_java_call(CallJavaNode* call,
694 bool must_throw = false, bool separate_io_proj = false);
695
696 // Finish up a java call that was started by set_edges_for_java_call.
697 // Call add_exception on any throw arising from the call.
698 // Return the call result (transformed).
699 Node* set_results_for_java_call(CallJavaNode* call, bool separate_io_proj = false, bool deoptimize = false);
700
701 // Similar to set_edges_for_java_call, but simplified for runtime calls.
702 void set_predefined_output_for_runtime_call(Node* call) {
703 set_predefined_output_for_runtime_call(call, nullptr, nullptr);
704 }
705 void set_predefined_output_for_runtime_call(Node* call,
706 Node* keep_mem,
707 const TypePtr* hook_mem);
708 Node* set_predefined_input_for_runtime_call(SafePointNode* call, Node* narrow_mem = nullptr);
801 void merge_memory(Node* new_mem, Node* region, int new_path);
802 void make_slow_call_ex(Node* call, ciInstanceKlass* ex_klass, bool separate_io_proj, bool deoptimize = false);
803
804 // Helper functions to build synchronizations
805 int next_monitor();
806 Node* insert_mem_bar(int opcode, Node* precedent = nullptr);
807 Node* insert_mem_bar_volatile(int opcode, int alias_idx, Node* precedent = nullptr);
808 // Optional 'precedent' is appended as an extra edge, to force ordering.
809 FastLockNode* shared_lock(Node* obj);
810 void shared_unlock(Node* box, Node* obj);
811
812 // helper functions for the fast path/slow path idioms
813 Node* fast_and_slow(Node* in, const Type *result_type, Node* null_result, IfNode* fast_test, Node* fast_result, address slow_call, const TypeFunc *slow_call_type, Node* slow_arg, Klass* ex_klass, Node* slow_result);
814
815 // Generate an instance-of idiom. Used by both the instance-of bytecode
816 // and the reflective instance-of call.
817 Node* gen_instanceof(Node *subobj, Node* superkls, bool safe_for_replace = false);
818
819 // Generate a check-cast idiom. Used by both the check-cast bytecode
820 // and the array-store bytecode
821 Node* gen_checkcast( Node *subobj, Node* superkls,
822 Node* *failure_control = nullptr );
823
824 Node* gen_subtype_check(Node* obj, Node* superklass);
825
826 // Exact type check used for predicted calls and casts.
827 // Rewrites (*casted_receiver) to be casted to the stronger type.
828 // (Caller is responsible for doing replace_in_map.)
829 Node* type_check_receiver(Node* receiver, ciKlass* klass, float prob,
830 Node* *casted_receiver);
831
832 // Inexact type check used for predicted calls.
833 Node* subtype_check_receiver(Node* receiver, ciKlass* klass,
834 Node** casted_receiver);
835
836 // implementation of object creation
837 Node* set_output_for_allocation(AllocateNode* alloc,
838 const TypeOopPtr* oop_type,
839 bool deoptimize_on_exception=false);
840 Node* get_layout_helper(Node* klass_node, jint& constant_value);
841 Node* new_instance(Node* klass_node,
842 Node* slow_test = nullptr,
843 Node* *return_size_val = nullptr,
844 bool deoptimize_on_exception = false);
845 Node* new_array(Node* klass_node, Node* count_val, int nargs,
846 Node* *return_size_val = nullptr,
847 bool deoptimize_on_exception = false);
848
849 // java.lang.String helpers
850 Node* load_String_length(Node* str, bool set_ctrl);
851 Node* load_String_value(Node* str, bool set_ctrl);
852 Node* load_String_coder(Node* str, bool set_ctrl);
853 void store_String_value(Node* str, Node* value);
854 void store_String_coder(Node* str, Node* value);
855 Node* capture_memory(const TypePtr* src_type, const TypePtr* dst_type);
856 Node* compress_string(Node* src, const TypeAryPtr* src_type, Node* dst, Node* count);
857 void inflate_string(Node* src, Node* dst, const TypeAryPtr* dst_type, Node* count);
858 void inflate_string_slow(Node* src, Node* dst, Node* start, Node* count);
859
860 // Handy for making control flow
861 IfNode* create_and_map_if(Node* ctrl, Node* tst, float prob, float cnt) {
862 IfNode* iff = new IfNode(ctrl, tst, prob, cnt);// New IfNode's
863 _gvn.set_type(iff, iff->Value(&_gvn)); // Value may be known at parse-time
864 // Place 'if' on worklist if it will be in graph
865 if (!tst->is_Con()) record_for_igvn(iff); // Range-check and Null-check removal is later
866 return iff;
867 }
868
869 IfNode* create_and_xform_if(Node* ctrl, Node* tst, float prob, float cnt) {
870 IfNode* iff = new IfNode(ctrl, tst, prob, cnt);// New IfNode's
871 _gvn.transform(iff); // Value may be known at parse-time
872 // Place 'if' on worklist if it will be in graph
873 if (!tst->is_Con()) record_for_igvn(iff); // Range-check and Null-check removal is later
874 return iff;
875 }
876
877 void add_parse_predicates(int nargs = 0);
878 void add_parse_predicate(Deoptimization::DeoptReason reason, int nargs);
879
880 Node* make_constant_from_field(ciField* field, Node* obj);
881
882 // Vector API support (implemented in vectorIntrinsics.cpp)
883 Node* box_vector(Node* in, const TypeInstPtr* vbox_type, BasicType elem_bt, int num_elem, bool deoptimize_on_exception = false);
884 Node* unbox_vector(Node* in, const TypeInstPtr* vbox_type, BasicType elem_bt, int num_elem);
885 Node* vector_shift_count(Node* cnt, int shift_op, BasicType bt, int num_elem);
886
887 // Helper class to support reverting to a previous parsing state.
888 // When an intrinsic makes changes before bailing out, it's necessary to restore the graph
889 // as it was. See JDK-8359344 for what can happen wrong. It's also not always possible to
890 // bailout before making changes because the bailing out decision might depend on new nodes
891 // (their types, for instance).
892 //
893 // So, if an intrinsic might cause this situation, one must start by saving the state in a
894 // SavedState by constructing it, and the state will be restored on destruction. If the
895 // intrinsic is not bailing out, one need to call discard to prevent restoring the old state.
896 class SavedState : public StackObj {
897 GraphKit* _kit;
898 int _sp;
899 JVMState* _jvms;
900 SafePointNode* _map;
|
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 */
24
25 #ifndef SHARE_OPTO_GRAPHKIT_HPP
26 #define SHARE_OPTO_GRAPHKIT_HPP
27
28 #include "ci/ciEnv.hpp"
29 #include "ci/ciMethodData.hpp"
30 #include "gc/shared/c2/barrierSetC2.hpp"
31 #include "opto/addnode.hpp"
32 #include "opto/callnode.hpp"
33 #include "opto/cfgnode.hpp"
34 #include "opto/compile.hpp"
35 #include "opto/divnode.hpp"
36 #include "opto/inlinetypenode.hpp"
37 #include "opto/mulnode.hpp"
38 #include "opto/phaseX.hpp"
39 #include "opto/subnode.hpp"
40 #include "opto/type.hpp"
41 #include "runtime/deoptimization.hpp"
42
43 class BarrierSetC2;
44 class FastLockNode;
45 class FastUnlockNode;
46 class IdealKit;
47 class LibraryCallKit;
48 class Parse;
49 class RootNode;
50
51 //-----------------------------------------------------------------------------
52 //----------------------------GraphKit-----------------------------------------
53 // Toolkit for building the common sorts of subgraphs.
54 // Does not know about bytecode parsing or type-flow results.
55 // It is able to create graphs implementing the semantics of most
56 // or all bytecodes, so that it can expand intrinsics and calls.
57 // It may depend on JVMState structure, but it must not depend
58 // on specific bytecode streams.
59 class GraphKit : public Phase {
60 friend class PreserveJVMState;
61
62 protected:
63 ciEnv* _env; // Compilation environment
64 PhaseGVN &_gvn; // Some optimizations while parsing
65 SafePointNode* _map; // Parser map from JVM to Nodes
66 SafePointNode* _exceptions;// Parser map(s) for exception state(s)
67 int _bci; // JVM Bytecode Pointer
68 ciMethod* _method; // JVM Current Method
69 BarrierSetC2* _barrier_set;
70 #ifdef ASSERT
71 uint _worklist_size;
72 #endif
73
74 private:
75 int _sp; // JVM Expression Stack Pointer; don't modify directly!
76
77 private:
78 SafePointNode* map_not_null() const {
79 assert(_map != nullptr, "must call stopped() to test for reset compiler map");
80 return _map;
81 }
82
83 public:
84 GraphKit(); // empty constructor
85 GraphKit(JVMState* jvms, PhaseGVN* gvn = nullptr); // the JVM state on which to operate
86
87 // Create a GraphKit from a debug state, useful for various kinds of macro expansion
88 GraphKit(const SafePointNode* sft, PhaseIterGVN& igvn);
89
90 #ifdef ASSERT
91 ~GraphKit() {
92 assert(failing_internal() || !has_exceptions(),
93 "unless compilation failed, user must call transfer_exceptions_into_jvms");
94 }
95 #endif
96
97 virtual Parse* is_Parse() const { return nullptr; }
98 virtual LibraryCallKit* is_LibraryCallKit() const { return nullptr; }
99
100 ciEnv* env() const { return _env; }
101 PhaseGVN& gvn() const { return _gvn; }
102 void* barrier_set_state() const { return C->barrier_set_state(); }
103
104 void record_for_igvn(Node* n) const { _gvn.record_for_igvn(n); }
105 void remove_for_igvn(Node* n) const { C->remove_for_igvn(n); }
106
107 // Handy well-known nodes:
108 Node* null() const { return zerocon(T_OBJECT); }
109 Node* top() const { return C->top(); }
110 RootNode* root() const { return C->root(); }
111
112 // Create or find a constant node
113 Node* intcon(jint con) const { return _gvn.intcon(con); }
114 Node* longcon(jlong con) const { return _gvn.longcon(con); }
115 Node* integercon(jlong con, BasicType bt) const {
116 if (bt == T_INT) {
117 return intcon(checked_cast<jint>(con));
118 }
119 assert(bt == T_LONG, "basic type not an int or long");
120 return longcon(con);
121 }
122 Node* makecon(const Type *t) const { return _gvn.makecon(t); }
123 Node* zerocon(BasicType bt) const { return _gvn.zerocon(bt); }
124 // (See also macro MakeConX in type.hpp, which uses intcon or longcon.)
369 Node* ConvL2I(Node* offset);
370 // Find out the klass of an object.
371 Node* load_object_klass(Node* object);
372 // Find out the length of an array.
373 Node* load_array_length(Node* array);
374 // Cast array allocation's length as narrow as possible.
375 // If replace_length_in_map is true, replace length with CastIINode in map.
376 // This method is invoked after creating/moving ArrayAllocationNode or in load_array_length
377 Node* array_ideal_length(AllocateArrayNode* alloc,
378 const TypeOopPtr* oop_type,
379 bool replace_length_in_map);
380
381
382 // Helper function to do a null pointer check or ZERO check based on type.
383 // Throw an exception if a given value is null.
384 // Return the value cast to not-null.
385 // Be clever about equivalent dominating null checks.
386 Node* null_check_common(Node* value, BasicType type,
387 bool assert_null = false,
388 Node* *null_control = nullptr,
389 bool speculative = false,
390 bool null_marker_check = false);
391 Node* null_check(Node* value, BasicType type = T_OBJECT) {
392 return null_check_common(value, type, false, nullptr, !_gvn.type(value)->speculative_maybe_null());
393 }
394 Node* null_check_receiver() {
395 return null_check(argument(0));
396 }
397 Node* zero_check_int(Node* value) {
398 assert(value->bottom_type()->basic_type() == T_INT,
399 "wrong type: %s", type2name(value->bottom_type()->basic_type()));
400 return null_check_common(value, T_INT);
401 }
402 Node* zero_check_long(Node* value) {
403 assert(value->bottom_type()->basic_type() == T_LONG,
404 "wrong type: %s", type2name(value->bottom_type()->basic_type()));
405 return null_check_common(value, T_LONG);
406 }
407 // Throw an uncommon trap if a given value is __not__ null.
408 // Return the value cast to null, and be clever about dominating checks.
409 Node* null_assert(Node* value, BasicType type = T_OBJECT) {
410 return null_check_common(value, type, true, nullptr, _gvn.type(value)->speculative_always_null());
411 }
412
413 // Check if value is null and abort if it is
414 Node* must_be_not_null(Node* value, bool do_replace_in_map);
449 void record_profiled_parameters_for_speculation();
450 void record_profiled_return_for_speculation();
451 Node* record_profiled_receiver_for_speculation(Node* n);
452
453 // Use the type profile to narrow an object type.
454 Node* maybe_cast_profiled_receiver(Node* not_null_obj,
455 const TypeKlassPtr* require_klass,
456 ciKlass* spec,
457 bool safe_for_replace);
458
459 // Cast obj to type and emit guard unless we had too many traps here already
460 Node* maybe_cast_profiled_obj(Node* obj,
461 ciKlass* type,
462 bool not_null = false);
463
464 // Cast obj to not-null on this path
465 Node* cast_not_null(Node* obj, bool do_replace_in_map = true);
466 // Replace all occurrences of one node by another.
467 void replace_in_map(Node* old, Node* neww);
468
469 Node* maybe_narrow_object_type(Node* obj, ciKlass* type, bool maybe_larval);
470
471 void push(Node* n) { map_not_null(); _map->set_stack(_map->_jvms, _sp++ , n); }
472 Node* pop() { map_not_null(); return _map->stack( _map->_jvms, --_sp ); }
473 Node* peek(int off = 0) { map_not_null(); return _map->stack( _map->_jvms, _sp - off - 1 ); }
474
475 void push_pair(Node* ldval) {
476 push(ldval);
477 push(top()); // the halfword is merely a placeholder
478 }
479 void push_pair_local(int i) {
480 // longs are stored in locals in "push" order
481 push( local(i+0) ); // the real value
482 assert(local(i+1) == top(), "");
483 push(top()); // halfword placeholder
484 }
485 Node* pop_pair() {
486 // the second half is pushed last & popped first; it contains exactly nothing
487 Node* halfword = pop();
488 assert(halfword == top(), "");
489 // the long bits are pushed first & popped last:
576 // procedure must indicate that the store requires `release'
577 // semantics, if the stored value is an object reference that might
578 // point to a new object and may become externally visible.
579 // Return the new StoreXNode
580 Node* store_to_memory(Node* ctl, Node* adr, Node* val, BasicType bt,
581 MemNode::MemOrd,
582 bool require_atomic_access = false,
583 bool unaligned = false,
584 bool mismatched = false,
585 bool unsafe = false,
586 int barrier_data = 0);
587
588 // Perform decorated accesses
589
590 Node* access_store_at(Node* obj, // containing obj
591 Node* adr, // actual address to store val at
592 const TypePtr* adr_type,
593 Node* val,
594 const Type* val_type,
595 BasicType bt,
596 DecoratorSet decorators,
597 bool safe_for_replace = true,
598 const InlineTypeNode* vt = nullptr);
599
600 Node* access_load_at(Node* obj, // containing obj
601 Node* adr, // actual address to load val at
602 const TypePtr* adr_type,
603 const Type* val_type,
604 BasicType bt,
605 DecoratorSet decorators,
606 Node* ctl = nullptr);
607
608 Node* access_load(Node* adr, // actual address to load val at
609 const Type* val_type,
610 BasicType bt,
611 DecoratorSet decorators);
612
613 Node* access_atomic_cmpxchg_val_at(Node* obj,
614 Node* adr,
615 const TypePtr* adr_type,
616 int alias_idx,
617 Node* expected_val,
618 Node* new_val,
619 const Type* value_type,
620 BasicType bt,
621 DecoratorSet decorators);
622
623 Node* access_atomic_cmpxchg_bool_at(Node* obj,
624 Node* adr,
625 const TypePtr* adr_type,
626 int alias_idx,
639 BasicType bt,
640 DecoratorSet decorators);
641
642 Node* access_atomic_add_at(Node* obj,
643 Node* adr,
644 const TypePtr* adr_type,
645 int alias_idx,
646 Node* new_val,
647 const Type* value_type,
648 BasicType bt,
649 DecoratorSet decorators);
650
651 void access_clone(Node* src, Node* dst, Node* size, bool is_array);
652
653 // Return addressing for an array element.
654 Node* array_element_address(Node* ary, Node* idx, BasicType elembt,
655 // Optional constraint on the array size:
656 const TypeInt* sizetype = nullptr,
657 // Optional control dependency (for example, on range check)
658 Node* ctrl = nullptr);
659 Node* cast_to_flat_array(Node* array, ciInlineKlass* elem_vk);
660 Node* cast_to_flat_array_exact(Node* array, ciInlineKlass* elem_vk, bool is_null_free, bool is_atomic);
661
662 // Return a load of array element at idx.
663 Node* load_array_element(Node* ary, Node* idx, const TypeAryPtr* arytype, bool set_ctrl);
664
665 //---------------- Dtrace support --------------------
666 void make_dtrace_method_entry_exit(ciMethod* method, bool is_entry);
667 void make_dtrace_method_entry(ciMethod* method) {
668 make_dtrace_method_entry_exit(method, true);
669 }
670 void make_dtrace_method_exit(ciMethod* method) {
671 make_dtrace_method_entry_exit(method, false);
672 }
673
674 //--------------- stub generation -------------------
675 public:
676 void gen_stub(address C_function,
677 const char *name,
678 int is_fancy_jump,
679 bool pass_tls,
680 bool return_pc);
681
682 //---------- help for generating calls --------------
683
684 // Do a null check on the receiver as it would happen before the call to
685 // callee (with all arguments still on the stack).
686 Node* null_check_receiver_before_call(ciMethod* callee) {
687 assert(!callee->is_static(), "must be a virtual method");
688 // Callsite signature can be different from actual method being called (i.e _linkTo* sites).
689 // Use callsite signature always.
690 ciMethod* declared_method = method()->get_method_at_bci(bci());
691 const int nargs = declared_method->arg_size();
692 inc_sp(nargs);
693 Node* n = null_check_receiver();
694 dec_sp(nargs);
695 return n;
696 }
697
698 // Fill in argument edges for the call from argument(0), argument(1), ...
699 // (The next step is to call set_edges_for_java_call.)
700 void set_arguments_for_java_call(CallJavaNode* call);
701
702 // Fill in non-argument edges for the call.
703 // Transform the call, and update the basics: control, i_o, memory.
704 // (The next step is usually to call set_results_for_java_call.)
705 void set_edges_for_java_call(CallJavaNode* call,
706 bool must_throw = false, bool separate_io_proj = false);
707
708 // Finish up a java call that was started by set_edges_for_java_call.
709 // Call add_exception on any throw arising from the call.
710 // Return the call result (transformed).
711 Node* set_results_for_java_call(CallJavaNode* call, bool separate_io_proj = false, bool deoptimize = false);
712
713 // Similar to set_edges_for_java_call, but simplified for runtime calls.
714 void set_predefined_output_for_runtime_call(Node* call) {
715 set_predefined_output_for_runtime_call(call, nullptr, nullptr);
716 }
717 void set_predefined_output_for_runtime_call(Node* call,
718 Node* keep_mem,
719 const TypePtr* hook_mem);
720 Node* set_predefined_input_for_runtime_call(SafePointNode* call, Node* narrow_mem = nullptr);
813 void merge_memory(Node* new_mem, Node* region, int new_path);
814 void make_slow_call_ex(Node* call, ciInstanceKlass* ex_klass, bool separate_io_proj, bool deoptimize = false);
815
816 // Helper functions to build synchronizations
817 int next_monitor();
818 Node* insert_mem_bar(int opcode, Node* precedent = nullptr);
819 Node* insert_mem_bar_volatile(int opcode, int alias_idx, Node* precedent = nullptr);
820 // Optional 'precedent' is appended as an extra edge, to force ordering.
821 FastLockNode* shared_lock(Node* obj);
822 void shared_unlock(Node* box, Node* obj);
823
824 // helper functions for the fast path/slow path idioms
825 Node* fast_and_slow(Node* in, const Type *result_type, Node* null_result, IfNode* fast_test, Node* fast_result, address slow_call, const TypeFunc *slow_call_type, Node* slow_arg, Klass* ex_klass, Node* slow_result);
826
827 // Generate an instance-of idiom. Used by both the instance-of bytecode
828 // and the reflective instance-of call.
829 Node* gen_instanceof(Node *subobj, Node* superkls, bool safe_for_replace = false);
830
831 // Generate a check-cast idiom. Used by both the check-cast bytecode
832 // and the array-store bytecode
833 Node* gen_checkcast(Node *subobj, Node* superkls, Node** failure_control = nullptr,
834 SafePointNode** new_cast_failure_map = nullptr, bool null_free = false,
835 bool maybe_larval = false);
836
837 // Inline types
838 Node* mark_word_test(Node* obj, uintptr_t mask_val, bool eq, bool check_lock = true);
839 Node* inline_type_test(Node* obj, bool is_inline = true);
840 Node* flat_array_test(Node* array_or_klass, bool flat = true);
841 Node* null_free_array_test(Node* array, bool null_free = true);
842 Node* null_free_atomic_array_test(Node* array, ciInlineKlass* vk);
843 Node* inline_array_null_guard(Node* ary, Node* val, int nargs, bool safe_for_replace = false);
844
845 Node* gen_subtype_check(Node* obj, Node* superklass);
846
847 // Exact type check used for predicted calls and casts.
848 // Rewrites (*casted_receiver) to be casted to the stronger type.
849 // (Caller is responsible for doing replace_in_map.)
850 Node* type_check_receiver(Node* receiver, ciKlass* klass, float prob,
851 Node* *casted_receiver);
852 Node* type_check(Node* recv_klass, const TypeKlassPtr* tklass, float prob);
853
854 // Inexact type check used for predicted calls.
855 Node* subtype_check_receiver(Node* receiver, ciKlass* klass,
856 Node** casted_receiver);
857
858 // implementation of object creation
859 Node* set_output_for_allocation(AllocateNode* alloc,
860 const TypeOopPtr* oop_type,
861 bool deoptimize_on_exception=false);
862 Node* get_layout_helper(Node* klass_node, jint& constant_value);
863 Node* new_instance(Node* klass_node,
864 Node* slow_test = nullptr,
865 Node* *return_size_val = nullptr,
866 bool deoptimize_on_exception = false,
867 InlineTypeNode* inline_type_node = nullptr);
868 Node* new_array(Node* klass_node, Node* count_val, int nargs,
869 Node* *return_size_val = nullptr,
870 bool deoptimize_on_exception = false,
871 Node* init_val = nullptr);
872
873 // java.lang.String helpers
874 Node* load_String_length(Node* str, bool set_ctrl);
875 Node* load_String_value(Node* str, bool set_ctrl);
876 Node* load_String_coder(Node* str, bool set_ctrl);
877 void store_String_value(Node* str, Node* value);
878 void store_String_coder(Node* str, Node* value);
879 Node* capture_memory(const TypePtr* src_type, const TypePtr* dst_type);
880 Node* compress_string(Node* src, const TypeAryPtr* src_type, Node* dst, Node* count);
881 void inflate_string(Node* src, Node* dst, const TypeAryPtr* dst_type, Node* count);
882 void inflate_string_slow(Node* src, Node* dst, Node* start, Node* count);
883
884 // Handy for making control flow
885 IfNode* create_and_map_if(Node* ctrl, Node* tst, float prob, float cnt) {
886 IfNode* iff = new IfNode(ctrl, tst, prob, cnt);// New IfNode's
887 _gvn.set_type(iff, iff->Value(&_gvn)); // Value may be known at parse-time
888 // Place 'if' on worklist if it will be in graph
889 if (!tst->is_Con()) record_for_igvn(iff); // Range-check and Null-check removal is later
890 return iff;
891 }
892
893 IfNode* create_and_xform_if(Node* ctrl, Node* tst, float prob, float cnt) {
894 IfNode* iff = new IfNode(ctrl, tst, prob, cnt);// New IfNode's
895 _gvn.transform(iff); // Value may be known at parse-time
896 // Place 'if' on worklist if it will be in graph
897 if (!tst->is_Con()) record_for_igvn(iff); // Range-check and Null-check removal is later
898 return iff;
899 }
900
901 void add_parse_predicates(int nargs = 0);
902 void add_parse_predicate(Deoptimization::DeoptReason reason, int nargs);
903
904 Node* make_constant_from_field(ciField* field, Node* obj);
905 Node* load_mirror_from_klass(Node* klass);
906
907 // Vector API support (implemented in vectorIntrinsics.cpp)
908 Node* box_vector(Node* in, const TypeInstPtr* vbox_type, BasicType elem_bt, int num_elem, bool deoptimize_on_exception = false);
909 Node* unbox_vector(Node* in, const TypeInstPtr* vbox_type, BasicType elem_bt, int num_elem);
910 Node* vector_shift_count(Node* cnt, int shift_op, BasicType bt, int num_elem);
911
912 // Helper class to support reverting to a previous parsing state.
913 // When an intrinsic makes changes before bailing out, it's necessary to restore the graph
914 // as it was. See JDK-8359344 for what can happen wrong. It's also not always possible to
915 // bailout before making changes because the bailing out decision might depend on new nodes
916 // (their types, for instance).
917 //
918 // So, if an intrinsic might cause this situation, one must start by saving the state in a
919 // SavedState by constructing it, and the state will be restored on destruction. If the
920 // intrinsic is not bailing out, one need to call discard to prevent restoring the old state.
921 class SavedState : public StackObj {
922 GraphKit* _kit;
923 int _sp;
924 JVMState* _jvms;
925 SafePointNode* _map;
|