1 /*
2 * Copyright (c) 2001, 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 */
24
25 #ifndef SHARE_VM_OPTO_GRAPHKIT_HPP
26 #define SHARE_VM_OPTO_GRAPHKIT_HPP
27
28 #include "ci/ciEnv.hpp"
29 #include "ci/ciMethodData.hpp"
30 #include "opto/addnode.hpp"
31 #include "opto/callnode.hpp"
32 #include "opto/cfgnode.hpp"
33 #include "opto/compile.hpp"
34 #include "opto/divnode.hpp"
35 #include "opto/mulnode.hpp"
36 #include "opto/phaseX.hpp"
37 #include "opto/subnode.hpp"
38 #include "opto/type.hpp"
39 #include "runtime/deoptimization.hpp"
40
41 class FastLockNode;
42 class FastUnlockNode;
43 class IdealKit;
44 class LibraryCallKit;
45 class Parse;
46 class RootNode;
47
48 //-----------------------------------------------------------------------------
49 //----------------------------GraphKit-----------------------------------------
50 // Toolkit for building the common sorts of subgraphs.
51 // Does not know about bytecode parsing or type-flow results.
52 // It is able to create graphs implementing the semantics of most
53 // or all bytecodes, so that it can expand intrinsics and calls.
54 // It may depend on JVMState structure, but it must not depend
55 // on specific bytecode streams.
56 class GraphKit : public Phase {
57 friend class PreserveJVMState;
58
59 protected:
60 ciEnv* _env; // Compilation environment
61 PhaseGVN &_gvn; // Some optimizations while parsing
62 SafePointNode* _map; // Parser map from JVM to Nodes
63 SafePointNode* _exceptions;// Parser map(s) for exception state(s)
64 int _bci; // JVM Bytecode Pointer
65 ciMethod* _method; // JVM Current Method
66
67 private:
68 int _sp; // JVM Expression Stack Pointer; don't modify directly!
69
70 private:
71 SafePointNode* map_not_null() const {
72 assert(_map != NULL, "must call stopped() to test for reset compiler map");
73 return _map;
74 }
75
76 public:
77 GraphKit(); // empty constructor
78 GraphKit(JVMState* jvms); // the JVM state on which to operate
79
80 #ifdef ASSERT
81 ~GraphKit() {
82 assert(!has_exceptions(), "user must call transfer_exceptions_into_jvms");
83 }
84 #endif
85
86 virtual Parse* is_Parse() const { return NULL; }
87 virtual LibraryCallKit* is_LibraryCallKit() const { return NULL; }
88
89 ciEnv* env() const { return _env; }
90 PhaseGVN& gvn() const { return _gvn; }
91
92 void record_for_igvn(Node* n) const { C->record_for_igvn(n); } // delegate to Compile
93
94 // Handy well-known nodes:
95 Node* null() const { return zerocon(T_OBJECT); }
96 Node* top() const { return C->top(); }
97 RootNode* root() const { return C->root(); }
98
99 // Create or find a constant node
100 Node* intcon(jint con) const { return _gvn.intcon(con); }
101 Node* longcon(jlong con) const { return _gvn.longcon(con); }
102 Node* makecon(const Type *t) const { return _gvn.makecon(t); }
103 Node* zerocon(BasicType bt) const { return _gvn.zerocon(bt); }
104 // (See also macro MakeConX in type.hpp, which uses intcon or longcon.)
105
106 // Helper for byte_map_base
107 Node* byte_map_base_node() {
108 // Get base of card map
109 CardTableModRefBS* ct = (CardTableModRefBS*)(Universe::heap()->barrier_set());
110 assert(sizeof(*ct->byte_map_base) == sizeof(jbyte), "adjust users of this code");
111 if (ct->byte_map_base != NULL) {
112 return makecon(TypeRawPtr::make((address)ct->byte_map_base));
113 } else {
114 return null();
115 }
116 }
117
118 jint find_int_con(Node* n, jint value_if_unknown) {
119 return _gvn.find_int_con(n, value_if_unknown);
120 }
121 jlong find_long_con(Node* n, jlong value_if_unknown) {
122 return _gvn.find_long_con(n, value_if_unknown);
123 }
124 // (See also macro find_intptr_t_con in type.hpp, which uses one of these.)
125
126 // JVM State accessors:
127 // Parser mapping from JVM indices into Nodes.
128 // Low slots are accessed by the StartNode::enum.
129 // Then come the locals at StartNode::Parms to StartNode::Parms+max_locals();
130 // Then come JVM stack slots.
131 // Finally come the monitors, if any.
132 // See layout accessors in class JVMState.
133
134 SafePointNode* map() const { return _map; }
135 bool has_exceptions() const { return _exceptions != NULL; }
136 JVMState* jvms() const { return map_not_null()->_jvms; }
137 int sp() const { return _sp; }
138 int bci() const { return _bci; }
139 Bytecodes::Code java_bc() const;
140 ciMethod* method() const { return _method; }
141
142 void set_jvms(JVMState* jvms) { set_map(jvms->map());
143 assert(jvms == this->jvms(), "sanity");
144 _sp = jvms->sp();
145 _bci = jvms->bci();
146 _method = jvms->has_method() ? jvms->method() : NULL; }
147 void set_map(SafePointNode* m) { _map = m; debug_only(verify_map()); }
148 void set_sp(int sp) { assert(sp >= 0, err_msg_res("sp must be non-negative: %d", sp)); _sp = sp; }
149 void clean_stack(int from_sp); // clear garbage beyond from_sp to top
150
151 void inc_sp(int i) { set_sp(sp() + i); }
152 void dec_sp(int i) { set_sp(sp() - i); }
153 void set_bci(int bci) { _bci = bci; }
154
155 // Make sure jvms has current bci & sp.
156 JVMState* sync_jvms() const;
157 JVMState* sync_jvms_for_reexecute();
158
159 #ifdef ASSERT
160 // Make sure JVMS has an updated copy of bci and sp.
161 // Also sanity-check method, depth, and monitor depth.
162 bool jvms_in_sync() const;
163
164 // Make sure the map looks OK.
165 void verify_map() const;
166
167 // Make sure a proposed exception state looks OK.
168 static void verify_exception_state(SafePointNode* ex_map);
169 #endif
170
171 // Clone the existing map state. (Implements PreserveJVMState.)
172 SafePointNode* clone_map();
173
174 // Set the map to a clone of the given one.
175 void set_map_clone(SafePointNode* m);
176
177 // Tell if the compilation is failing.
178 bool failing() const { return C->failing(); }
179
180 // Set _map to NULL, signalling a stop to further bytecode execution.
181 // Preserve the map intact for future use, and return it back to the caller.
182 SafePointNode* stop() { SafePointNode* m = map(); set_map(NULL); return m; }
183
184 // Stop, but first smash the map's inputs to NULL, to mark it dead.
185 void stop_and_kill_map();
186
187 // Tell if _map is NULL, or control is top.
188 bool stopped();
189
190 // Tell if this method or any caller method has exception handlers.
191 bool has_ex_handler();
192
193 // Save an exception without blowing stack contents or other JVM state.
194 // (The extra pointer is stuck with add_req on the map, beyond the JVMS.)
195 static void set_saved_ex_oop(SafePointNode* ex_map, Node* ex_oop);
196
197 // Recover a saved exception from its map.
198 static Node* saved_ex_oop(SafePointNode* ex_map);
199
200 // Recover a saved exception from its map, and remove it from the map.
201 static Node* clear_saved_ex_oop(SafePointNode* ex_map);
202
203 #ifdef ASSERT
204 // Recover a saved exception from its map, and remove it from the map.
205 static bool has_saved_ex_oop(SafePointNode* ex_map);
206 #endif
207
208 // Push an exception in the canonical position for handlers (stack(0)).
209 void push_ex_oop(Node* ex_oop) {
210 ensure_stack(1); // ensure room to push the exception
211 set_stack(0, ex_oop);
212 set_sp(1);
213 clean_stack(1);
214 }
215
216 // Detach and return an exception state.
217 SafePointNode* pop_exception_state() {
218 SafePointNode* ex_map = _exceptions;
219 if (ex_map != NULL) {
220 _exceptions = ex_map->next_exception();
221 ex_map->set_next_exception(NULL);
222 debug_only(verify_exception_state(ex_map));
223 }
224 return ex_map;
225 }
226
227 // Add an exception, using the given JVM state, without commoning.
228 void push_exception_state(SafePointNode* ex_map) {
229 debug_only(verify_exception_state(ex_map));
230 ex_map->set_next_exception(_exceptions);
231 _exceptions = ex_map;
232 }
233
234 // Turn the current JVM state into an exception state, appending the ex_oop.
235 SafePointNode* make_exception_state(Node* ex_oop);
236
237 // Add an exception, using the given JVM state.
238 // Combine all exceptions with a common exception type into a single state.
239 // (This is done via combine_exception_states.)
240 void add_exception_state(SafePointNode* ex_map);
241
242 // Combine all exceptions of any sort whatever into a single master state.
243 SafePointNode* combine_and_pop_all_exception_states() {
244 if (_exceptions == NULL) return NULL;
245 SafePointNode* phi_map = pop_exception_state();
246 SafePointNode* ex_map;
247 while ((ex_map = pop_exception_state()) != NULL) {
248 combine_exception_states(ex_map, phi_map);
249 }
250 return phi_map;
251 }
252
253 // Combine the two exception states, building phis as necessary.
254 // The second argument is updated to include contributions from the first.
255 void combine_exception_states(SafePointNode* ex_map, SafePointNode* phi_map);
256
257 // Reset the map to the given state. If there are any half-finished phis
258 // in it (created by combine_exception_states), transform them now.
259 // Returns the exception oop. (Caller must call push_ex_oop if required.)
260 Node* use_exception_state(SafePointNode* ex_map);
261
262 // Collect exceptions from a given JVM state into my exception list.
263 void add_exception_states_from(JVMState* jvms);
264
265 // Collect all raised exceptions into the current JVM state.
266 // Clear the current exception list and map, returns the combined states.
267 JVMState* transfer_exceptions_into_jvms();
268
269 // Helper to throw a built-in exception.
270 // Range checks take the offending index.
271 // Cast and array store checks take the offending class.
272 // Others do not take the optional argument.
273 // The JVMS must allow the bytecode to be re-executed
274 // via an uncommon trap.
275 void builtin_throw(Deoptimization::DeoptReason reason, Node* arg = NULL);
276
277 // Helper to check the JavaThread::_should_post_on_exceptions flag
278 // and branch to an uncommon_trap if it is true (with the specified reason and must_throw)
279 void uncommon_trap_if_should_post_on_exceptions(Deoptimization::DeoptReason reason,
280 bool must_throw) ;
281
282 // Helper Functions for adding debug information
283 void kill_dead_locals();
284 #ifdef ASSERT
285 bool dead_locals_are_killed();
286 #endif
287 // The call may deoptimize. Supply required JVM state as debug info.
288 // If must_throw is true, the call is guaranteed not to return normally.
289 void add_safepoint_edges(SafePointNode* call,
290 bool must_throw = false);
291
292 // How many stack inputs does the current BC consume?
293 // And, how does the stack change after the bytecode?
294 // Returns false if unknown.
295 bool compute_stack_effects(int& inputs, int& depth);
296
297 // Add a fixed offset to a pointer
298 Node* basic_plus_adr(Node* base, Node* ptr, intptr_t offset) {
299 return basic_plus_adr(base, ptr, MakeConX(offset));
300 }
301 Node* basic_plus_adr(Node* base, intptr_t offset) {
302 return basic_plus_adr(base, base, MakeConX(offset));
303 }
304 // Add a variable offset to a pointer
305 Node* basic_plus_adr(Node* base, Node* offset) {
306 return basic_plus_adr(base, base, offset);
307 }
308 Node* basic_plus_adr(Node* base, Node* ptr, Node* offset);
309
310
311 // Some convenient shortcuts for common nodes
312 Node* IfTrue(IfNode* iff) { return _gvn.transform(new (C) IfTrueNode(iff)); }
313 Node* IfFalse(IfNode* iff) { return _gvn.transform(new (C) IfFalseNode(iff)); }
314
315 Node* AddI(Node* l, Node* r) { return _gvn.transform(new (C) AddINode(l, r)); }
316 Node* SubI(Node* l, Node* r) { return _gvn.transform(new (C) SubINode(l, r)); }
317 Node* MulI(Node* l, Node* r) { return _gvn.transform(new (C) MulINode(l, r)); }
318 Node* DivI(Node* ctl, Node* l, Node* r) { return _gvn.transform(new (C) DivINode(ctl, l, r)); }
319
320 Node* AndI(Node* l, Node* r) { return _gvn.transform(new (C) AndINode(l, r)); }
321 Node* OrI(Node* l, Node* r) { return _gvn.transform(new (C) OrINode(l, r)); }
322 Node* XorI(Node* l, Node* r) { return _gvn.transform(new (C) XorINode(l, r)); }
323
324 Node* MaxI(Node* l, Node* r) { return _gvn.transform(new (C) MaxINode(l, r)); }
325 Node* MinI(Node* l, Node* r) { return _gvn.transform(new (C) MinINode(l, r)); }
326
327 Node* LShiftI(Node* l, Node* r) { return _gvn.transform(new (C) LShiftINode(l, r)); }
328 Node* RShiftI(Node* l, Node* r) { return _gvn.transform(new (C) RShiftINode(l, r)); }
329 Node* URShiftI(Node* l, Node* r) { return _gvn.transform(new (C) URShiftINode(l, r)); }
330
331 Node* CmpI(Node* l, Node* r) { return _gvn.transform(new (C) CmpINode(l, r)); }
332 Node* CmpL(Node* l, Node* r) { return _gvn.transform(new (C) CmpLNode(l, r)); }
333 Node* CmpP(Node* l, Node* r) { return _gvn.transform(new (C) CmpPNode(l, r)); }
334 Node* Bool(Node* cmp, BoolTest::mask relop) { return _gvn.transform(new (C) BoolNode(cmp, relop)); }
335
336 Node* AddP(Node* b, Node* a, Node* o) { return _gvn.transform(new (C) AddPNode(b, a, o)); }
337
338 // Convert between int and long, and size_t.
339 // (See macros ConvI2X, etc., in type.hpp for ConvI2X, etc.)
340 Node* ConvI2L(Node* offset);
341 Node* ConvI2UL(Node* offset);
342 Node* ConvL2I(Node* offset);
343 // Find out the klass of an object.
344 Node* load_object_klass(Node* object);
345 // Find out the length of an array.
346 Node* load_array_length(Node* array);
347
348
349 // Helper function to do a NULL pointer check or ZERO check based on type.
350 // Throw an exception if a given value is null.
351 // Return the value cast to not-null.
352 // Be clever about equivalent dominating null checks.
353 Node* null_check_common(Node* value, BasicType type,
354 bool assert_null = false, Node* *null_control = NULL);
355 Node* null_check(Node* value, BasicType type = T_OBJECT) {
356 return null_check_common(value, type);
357 }
358 Node* null_check_receiver() {
359 assert(argument(0)->bottom_type()->isa_ptr(), "must be");
360 return null_check(argument(0));
361 }
362 Node* zero_check_int(Node* value) {
363 assert(value->bottom_type()->basic_type() == T_INT,
364 err_msg_res("wrong type: %s", type2name(value->bottom_type()->basic_type())));
365 return null_check_common(value, T_INT);
366 }
367 Node* zero_check_long(Node* value) {
368 assert(value->bottom_type()->basic_type() == T_LONG,
369 err_msg_res("wrong type: %s", type2name(value->bottom_type()->basic_type())));
370 return null_check_common(value, T_LONG);
371 }
372 // Throw an uncommon trap if a given value is __not__ null.
373 // Return the value cast to null, and be clever about dominating checks.
374 Node* null_assert(Node* value, BasicType type = T_OBJECT) {
375 return null_check_common(value, type, true);
376 }
377
378 // Null check oop. Return null-path control into (*null_control).
379 // Return a cast-not-null node which depends on the not-null control.
380 // If never_see_null, use an uncommon trap (*null_control sees a top).
381 // The cast is not valid along the null path; keep a copy of the original.
382 Node* null_check_oop(Node* value, Node* *null_control,
383 bool never_see_null = false);
384
385 // Check the null_seen bit.
386 bool seems_never_null(Node* obj, ciProfileData* data);
387
388 // Use the type profile to narrow an object type.
389 Node* maybe_cast_profiled_receiver(Node* not_null_obj,
390 ciProfileData* data,
391 ciKlass* require_klass);
392
393 // Cast obj to not-null on this path
394 Node* cast_not_null(Node* obj, bool do_replace_in_map = true);
395 // Replace all occurrences of one node by another.
396 void replace_in_map(Node* old, Node* neww);
397
398 void push(Node* n) { map_not_null(); _map->set_stack(_map->_jvms, _sp++ , n); }
399 Node* pop() { map_not_null(); return _map->stack( _map->_jvms, --_sp ); }
400 Node* peek(int off = 0) { map_not_null(); return _map->stack( _map->_jvms, _sp - off - 1 ); }
401
402 void push_pair(Node* ldval) {
403 push(ldval);
404 push(top()); // the halfword is merely a placeholder
405 }
406 void push_pair_local(int i) {
407 // longs are stored in locals in "push" order
408 push( local(i+0) ); // the real value
409 assert(local(i+1) == top(), "");
410 push(top()); // halfword placeholder
411 }
412 Node* pop_pair() {
413 // the second half is pushed last & popped first; it contains exactly nothing
414 Node* halfword = pop();
415 assert(halfword == top(), "");
416 // the long bits are pushed first & popped last:
417 return pop();
418 }
419 void set_pair_local(int i, Node* lval) {
420 // longs are stored in locals as a value/half pair (like doubles)
421 set_local(i+0, lval);
422 set_local(i+1, top());
423 }
424
425 // Push the node, which may be zero, one, or two words.
426 void push_node(BasicType n_type, Node* n) {
427 int n_size = type2size[n_type];
428 if (n_size == 1) push( n ); // T_INT, ...
429 else if (n_size == 2) push_pair( n ); // T_DOUBLE, T_LONG
430 else { assert(n_size == 0, "must be T_VOID"); }
431 }
432
433 Node* pop_node(BasicType n_type) {
434 int n_size = type2size[n_type];
435 if (n_size == 1) return pop();
436 else if (n_size == 2) return pop_pair();
437 else return NULL;
438 }
439
440 Node* control() const { return map_not_null()->control(); }
441 Node* i_o() const { return map_not_null()->i_o(); }
442 Node* returnadr() const { return map_not_null()->returnadr(); }
443 Node* frameptr() const { return map_not_null()->frameptr(); }
444 Node* local(uint idx) const { map_not_null(); return _map->local( _map->_jvms, idx); }
445 Node* stack(uint idx) const { map_not_null(); return _map->stack( _map->_jvms, idx); }
446 Node* argument(uint idx) const { map_not_null(); return _map->argument( _map->_jvms, idx); }
447 Node* monitor_box(uint idx) const { map_not_null(); return _map->monitor_box(_map->_jvms, idx); }
448 Node* monitor_obj(uint idx) const { map_not_null(); return _map->monitor_obj(_map->_jvms, idx); }
449
450 void set_control (Node* c) { map_not_null()->set_control(c); }
451 void set_i_o (Node* c) { map_not_null()->set_i_o(c); }
452 void set_local(uint idx, Node* c) { map_not_null(); _map->set_local( _map->_jvms, idx, c); }
453 void set_stack(uint idx, Node* c) { map_not_null(); _map->set_stack( _map->_jvms, idx, c); }
454 void set_argument(uint idx, Node* c){ map_not_null(); _map->set_argument(_map->_jvms, idx, c); }
455 void ensure_stack(uint stk_size) { map_not_null(); _map->ensure_stack(_map->_jvms, stk_size); }
456
457 // Access unaliased memory
458 Node* memory(uint alias_idx);
459 Node* memory(const TypePtr *tp) { return memory(C->get_alias_index(tp)); }
460 Node* memory(Node* adr) { return memory(_gvn.type(adr)->is_ptr()); }
461
462 // Access immutable memory
463 Node* immutable_memory() { return C->immutable_memory(); }
464
465 // Set unaliased memory
466 void set_memory(Node* c, uint alias_idx) { merged_memory()->set_memory_at(alias_idx, c); }
467 void set_memory(Node* c, const TypePtr *tp) { set_memory(c,C->get_alias_index(tp)); }
468 void set_memory(Node* c, Node* adr) { set_memory(c,_gvn.type(adr)->is_ptr()); }
469
470 // Get the entire memory state (probably a MergeMemNode), and reset it
471 // (The resetting prevents somebody from using the dangling Node pointer.)
472 Node* reset_memory();
473
474 // Get the entire memory state, asserted to be a MergeMemNode.
475 MergeMemNode* merged_memory() {
476 Node* mem = map_not_null()->memory();
477 assert(mem->is_MergeMem(), "parse memory is always pre-split");
478 return mem->as_MergeMem();
479 }
480
481 // Set the entire memory state; produce a new MergeMemNode.
482 void set_all_memory(Node* newmem);
483
484 // Create a memory projection from the call, then set_all_memory.
485 void set_all_memory_call(Node* call, bool separate_io_proj = false);
486
487 // Create a LoadNode, reading from the parser's memory state.
488 // (Note: require_atomic_access is useful only with T_LONG.)
489 //
490 // We choose the unordered semantics by default because we have
491 // adapted the `do_put_xxx' and `do_get_xxx' procedures for the case
492 // of volatile fields.
493 Node* make_load(Node* ctl, Node* adr, const Type* t, BasicType bt,
494 bool require_atomic_access = false, LoadNode::Sem sem = LoadNode::unordered) {
495 // This version computes alias_index from bottom_type
496 return make_load(ctl, adr, t, bt, adr->bottom_type()->is_ptr(),
497 require_atomic_access, sem);
498 }
499 Node* make_load(Node* ctl, Node* adr, const Type* t, BasicType bt, const TypePtr* adr_type,
500 bool require_atomic_access = false, LoadNode::Sem sem = LoadNode::unordered) {
501 // This version computes alias_index from an address type
502 assert(adr_type != NULL, "use other make_load factory");
503 return make_load(ctl, adr, t, bt, C->get_alias_index(adr_type),
504 require_atomic_access, sem);
505 }
506 // This is the base version which is given an alias index.
507 Node* make_load(Node* ctl, Node* adr, const Type* t, BasicType bt, int adr_idx,
508 bool require_atomic_access = false, LoadNode::Sem sem = LoadNode::unordered);
509
510 // Create & transform a StoreNode and store the effect into the
511 // parser's memory state.
512 //
513 // We must ensure that stores of object references will be visible
514 // only after the object's initialization. So the clients of this
515 // procedure must indicate that the store requires `release'
516 // semantics, if the stored value is an object reference that might
517 // point to a new object and may become externally visible.
518 Node* store_to_memory(Node* ctl, Node* adr, Node* val, BasicType bt,
519 const TypePtr* adr_type,
520 bool require_atomic_access = false,
521 StoreNode::Sem sem = StoreNode::unordered) {
522 // This version computes alias_index from an address type
523 assert(adr_type != NULL, "use other store_to_memory factory");
524 return store_to_memory(ctl, adr, val, bt,
525 C->get_alias_index(adr_type),
526 require_atomic_access, sem);
527 }
528 // This is the base version which is given alias index
529 // Return the new StoreXNode
530 Node* store_to_memory(Node* ctl, Node* adr, Node* val, BasicType bt,
531 int adr_idx,
532 bool require_atomic_access = false,
533 StoreNode::Sem = StoreNode::unordered);
534
535
536 // All in one pre-barrier, store, post_barrier
537 // Insert a write-barrier'd store. This is to let generational GC
538 // work; we have to flag all oop-stores before the next GC point.
539 //
540 // It comes in 3 flavors of store to an object, array, or unknown.
541 // We use precise card marks for arrays to avoid scanning the entire
542 // array. We use imprecise for object. We use precise for unknown
543 // since we don't know if we have an array or and object or even
544 // where the object starts.
545 //
546 // If val==NULL, it is taken to be a completely unknown value. QQQ
547
548 Node* store_oop(Node* ctl,
549 Node* obj, // containing obj
550 Node* adr, // actual adress to store val at
551 const TypePtr* adr_type,
552 Node* val,
553 const TypeOopPtr* val_type,
554 BasicType bt,
555 bool use_precise,
556 StoreNode::Sem sem = StoreNode::unordered);
557
558 Node* store_oop_to_object(Node* ctl,
559 Node* obj, // containing obj
560 Node* adr, // actual adress to store val at
561 const TypePtr* adr_type,
562 Node* val,
563 const TypeOopPtr* val_type,
564 BasicType bt,
565 StoreNode::Sem sem = StoreNode::unordered) {
566 return store_oop(ctl, obj, adr, adr_type, val, val_type, bt, false, sem);
567 }
568
569 Node* store_oop_to_array(Node* ctl,
570 Node* obj, // containing obj
571 Node* adr, // actual adress to store val at
572 const TypePtr* adr_type,
573 Node* val,
574 const TypeOopPtr* val_type,
575 BasicType bt,
576 StoreNode::Sem sem = StoreNode::unordered) {
577 return store_oop(ctl, obj, adr, adr_type, val, val_type, bt, true, sem);
578 }
579
580 // Could be an array or object we don't know at compile time (unsafe ref.)
581 Node* store_oop_to_unknown(Node* ctl,
582 Node* obj, // containing obj
583 Node* adr, // actual adress to store val at
584 const TypePtr* adr_type,
585 Node* val,
586 BasicType bt,
587 StoreNode::Sem sem = StoreNode::unordered);
588
589 // For the few case where the barriers need special help
590 void pre_barrier(bool do_load, Node* ctl,
591 Node* obj, Node* adr, uint adr_idx, Node* val, const TypeOopPtr* val_type,
592 Node* pre_val,
593 BasicType bt);
594
595 void post_barrier(Node* ctl, Node* store, Node* obj, Node* adr, uint adr_idx,
596 Node* val, BasicType bt, bool use_precise);
597
598 // Return addressing for an array element.
599 Node* array_element_address(Node* ary, Node* idx, BasicType elembt,
600 // Optional constraint on the array size:
601 const TypeInt* sizetype = NULL);
602
603 // Return a load of array element at idx.
604 Node* load_array_element(Node* ctl, Node* ary, Node* idx, const TypeAryPtr* arytype);
605
606 //---------------- Dtrace support --------------------
607 void make_dtrace_method_entry_exit(ciMethod* method, bool is_entry);
608 void make_dtrace_method_entry(ciMethod* method) {
609 make_dtrace_method_entry_exit(method, true);
610 }
611 void make_dtrace_method_exit(ciMethod* method) {
612 make_dtrace_method_entry_exit(method, false);
613 }
614
615 //--------------- stub generation -------------------
616 public:
617 void gen_stub(address C_function,
618 const char *name,
619 int is_fancy_jump,
620 bool pass_tls,
621 bool return_pc);
622
623 //---------- help for generating calls --------------
624
625 // Do a null check on the receiver as it would happen before the call to
626 // callee (with all arguments still on the stack).
627 Node* null_check_receiver_before_call(ciMethod* callee) {
628 assert(!callee->is_static(), "must be a virtual method");
629 const int nargs = callee->arg_size();
630 inc_sp(nargs);
631 Node* n = null_check_receiver();
632 dec_sp(nargs);
633 return n;
634 }
635
636 // Fill in argument edges for the call from argument(0), argument(1), ...
637 // (The next step is to call set_edges_for_java_call.)
638 void set_arguments_for_java_call(CallJavaNode* call);
639
640 // Fill in non-argument edges for the call.
641 // Transform the call, and update the basics: control, i_o, memory.
642 // (The next step is usually to call set_results_for_java_call.)
643 void set_edges_for_java_call(CallJavaNode* call,
644 bool must_throw = false, bool separate_io_proj = false);
645
646 // Finish up a java call that was started by set_edges_for_java_call.
647 // Call add_exception on any throw arising from the call.
648 // Return the call result (transformed).
649 Node* set_results_for_java_call(CallJavaNode* call, bool separate_io_proj = false);
650
651 // Similar to set_edges_for_java_call, but simplified for runtime calls.
652 void set_predefined_output_for_runtime_call(Node* call) {
653 set_predefined_output_for_runtime_call(call, NULL, NULL);
654 }
655 void set_predefined_output_for_runtime_call(Node* call,
656 Node* keep_mem,
657 const TypePtr* hook_mem);
658 Node* set_predefined_input_for_runtime_call(SafePointNode* call);
659
660 // Replace the call with the current state of the kit. Requires
661 // that the call was generated with separate io_projs so that
662 // exceptional control flow can be handled properly.
663 void replace_call(CallNode* call, Node* result);
664
665 // helper functions for statistics
666 void increment_counter(address counter_addr); // increment a debug counter
667 void increment_counter(Node* counter_addr); // increment a debug counter
668
669 // Bail out to the interpreter right now
670 // The optional klass is the one causing the trap.
671 // The optional reason is debug information written to the compile log.
672 // Optional must_throw is the same as with add_safepoint_edges.
673 void uncommon_trap(int trap_request,
674 ciKlass* klass = NULL, const char* reason_string = NULL,
675 bool must_throw = false, bool keep_exact_action = false);
676
677 // Shorthand, to avoid saying "Deoptimization::" so many times.
678 void uncommon_trap(Deoptimization::DeoptReason reason,
679 Deoptimization::DeoptAction action,
680 ciKlass* klass = NULL, const char* reason_string = NULL,
681 bool must_throw = false, bool keep_exact_action = false) {
682 uncommon_trap(Deoptimization::make_trap_request(reason, action),
683 klass, reason_string, must_throw, keep_exact_action);
684 }
685
686 // SP when bytecode needs to be reexecuted.
687 virtual int reexecute_sp() { return sp(); }
688
689 // Report if there were too many traps at the current method and bci.
690 // Report if a trap was recorded, and/or PerMethodTrapLimit was exceeded.
691 // If there is no MDO at all, report no trap unless told to assume it.
692 bool too_many_traps(Deoptimization::DeoptReason reason) {
693 return C->too_many_traps(method(), bci(), reason);
694 }
695
696 // Report if there were too many recompiles at the current method and bci.
697 bool too_many_recompiles(Deoptimization::DeoptReason reason) {
698 return C->too_many_recompiles(method(), bci(), reason);
699 }
700
701 // Returns the object (if any) which was created the moment before.
702 Node* just_allocated_object(Node* current_control);
703
704 static bool use_ReduceInitialCardMarks() {
705 return (ReduceInitialCardMarks
706 && Universe::heap()->can_elide_tlab_store_barriers());
707 }
708
709 // Sync Ideal and Graph kits.
710 void sync_kit(IdealKit& ideal);
711 void final_sync(IdealKit& ideal);
712
713 // vanilla/CMS post barrier
714 void write_barrier_post(Node *store, Node* obj,
715 Node* adr, uint adr_idx, Node* val, bool use_precise);
716
717 // G1 pre/post barriers
718 void g1_write_barrier_pre(bool do_load,
719 Node* obj,
720 Node* adr,
721 uint alias_idx,
722 Node* val,
723 const TypeOopPtr* val_type,
724 Node* pre_val,
725 BasicType bt);
726
727 void g1_write_barrier_post(Node* store,
728 Node* obj,
729 Node* adr,
730 uint alias_idx,
731 Node* val,
732 BasicType bt,
733 bool use_precise);
734 // Helper function for g1
735 private:
736 void g1_mark_card(IdealKit& ideal, Node* card_adr, Node* store, uint oop_alias_idx,
737 Node* index, Node* index_adr,
738 Node* buffer, const TypeFunc* tf);
739
740 public:
741 // Helper function to round double arguments before a call
742 void round_double_arguments(ciMethod* dest_method);
743 void round_double_result(ciMethod* dest_method);
744
745 // rounding for strict float precision conformance
746 Node* precision_rounding(Node* n);
747
748 // rounding for strict double precision conformance
749 Node* dprecision_rounding(Node* n);
750
751 // rounding for non-strict double stores
752 Node* dstore_rounding(Node* n);
753
754 // Helper functions for fast/slow path codes
755 Node* opt_iff(Node* region, Node* iff);
756 Node* make_runtime_call(int flags,
757 const TypeFunc* call_type, address call_addr,
758 const char* call_name,
759 const TypePtr* adr_type, // NULL if no memory effects
760 Node* parm0 = NULL, Node* parm1 = NULL,
761 Node* parm2 = NULL, Node* parm3 = NULL,
762 Node* parm4 = NULL, Node* parm5 = NULL,
763 Node* parm6 = NULL, Node* parm7 = NULL);
764 enum { // flag values for make_runtime_call
765 RC_NO_FP = 1, // CallLeafNoFPNode
766 RC_NO_IO = 2, // do not hook IO edges
767 RC_NO_LEAF = 4, // CallStaticJavaNode
768 RC_MUST_THROW = 8, // flag passed to add_safepoint_edges
769 RC_NARROW_MEM = 16, // input memory is same as output
770 RC_UNCOMMON = 32, // freq. expected to be like uncommon trap
771 RC_LEAF = 0 // null value: no flags set
772 };
773
774 // merge in all memory slices from new_mem, along the given path
775 void merge_memory(Node* new_mem, Node* region, int new_path);
776 void make_slow_call_ex(Node* call, ciInstanceKlass* ex_klass, bool separate_io_proj);
777
778 // Helper functions to build synchronizations
779 int next_monitor();
780 Node* insert_mem_bar(int opcode, Node* precedent = NULL);
781 Node* insert_mem_bar_volatile(int opcode, int alias_idx, Node* precedent = NULL);
782 // Optional 'precedent' is appended as an extra edge, to force ordering.
783 FastLockNode* shared_lock(Node* obj);
784 void shared_unlock(Node* box, Node* obj);
785
786 // helper functions for the fast path/slow path idioms
787 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, klassOop ex_klass, Node* slow_result);
788
789 // Generate an instance-of idiom. Used by both the instance-of bytecode
790 // and the reflective instance-of call.
791 Node* gen_instanceof( Node *subobj, Node* superkls );
792
793 // Generate a check-cast idiom. Used by both the check-cast bytecode
794 // and the array-store bytecode
795 Node* gen_checkcast( Node *subobj, Node* superkls,
796 Node* *failure_control = NULL );
797
798 // Generate a subtyping check. Takes as input the subtype and supertype.
799 // Returns 2 values: sets the default control() to the true path and
800 // returns the false path. Only reads from constant memory taken from the
801 // default memory; does not write anything. It also doesn't take in an
802 // Object; if you wish to check an Object you need to load the Object's
803 // class prior to coming here.
804 Node* gen_subtype_check(Node* subklass, Node* superklass);
805
806 // Static parse-time type checking logic for gen_subtype_check:
807 enum { SSC_always_false, SSC_always_true, SSC_easy_test, SSC_full_test };
808 int static_subtype_check(ciKlass* superk, ciKlass* subk);
809
810 // Exact type check used for predicted calls and casts.
811 // Rewrites (*casted_receiver) to be casted to the stronger type.
812 // (Caller is responsible for doing replace_in_map.)
813 Node* type_check_receiver(Node* receiver, ciKlass* klass, float prob,
814 Node* *casted_receiver);
815
816 // implementation of object creation
817 Node* set_output_for_allocation(AllocateNode* alloc,
818 const TypeOopPtr* oop_type);
819 Node* get_layout_helper(Node* klass_node, jint& constant_value);
820 Node* new_instance(Node* klass_node,
821 Node* slow_test = NULL,
822 Node* *return_size_val = NULL);
823 Node* new_array(Node* klass_node, Node* count_val, int nargs,
824 Node* *return_size_val = NULL);
825
826 // java.lang.String helpers
827 Node* load_String_offset(Node* ctrl, Node* str);
828 Node* load_String_length(Node* ctrl, Node* str);
829 Node* load_String_value(Node* ctrl, Node* str);
830 void store_String_offset(Node* ctrl, Node* str, Node* value);
831 void store_String_length(Node* ctrl, Node* str, Node* value);
832 void store_String_value(Node* ctrl, Node* str, Node* value);
833
834 // Handy for making control flow
835 IfNode* create_and_map_if(Node* ctrl, Node* tst, float prob, float cnt) {
836 IfNode* iff = new (C) IfNode(ctrl, tst, prob, cnt);// New IfNode's
837 _gvn.set_type(iff, iff->Value(&_gvn)); // Value may be known at parse-time
838 // Place 'if' on worklist if it will be in graph
839 if (!tst->is_Con()) record_for_igvn(iff); // Range-check and Null-check removal is later
840 return iff;
841 }
842
843 IfNode* create_and_xform_if(Node* ctrl, Node* tst, float prob, float cnt) {
844 IfNode* iff = new (C) IfNode(ctrl, tst, prob, cnt);// New IfNode's
845 _gvn.transform(iff); // Value may be known at parse-time
846 // Place 'if' on worklist if it will be in graph
847 if (!tst->is_Con()) record_for_igvn(iff); // Range-check and Null-check removal is later
848 return iff;
849 }
850
851 // Insert a loop predicate into the graph
852 void add_predicate(int nargs = 0);
853 void add_predicate_impl(Deoptimization::DeoptReason reason, int nargs);
854 };
855
856 // Helper class to support building of control flow branches. Upon
857 // creation the map and sp at bci are cloned and restored upon de-
858 // struction. Typical use:
859 //
860 // { PreserveJVMState pjvms(this);
861 // // code of new branch
862 // }
863 // // here the JVM state at bci is established
864
865 class PreserveJVMState: public StackObj {
866 protected:
867 GraphKit* _kit;
868 #ifdef ASSERT
869 int _block; // PO of current block, if a Parse
870 int _bci;
871 #endif
872 SafePointNode* _map;
873 uint _sp;
874
875 public:
876 PreserveJVMState(GraphKit* kit, bool clone_map = true);
877 ~PreserveJVMState();
878 };
879
880 // Helper class to build cutouts of the form if (p) ; else {x...}.
881 // The code {x...} must not fall through.
882 // The kit's main flow of control is set to the "then" continuation of if(p).
883 class BuildCutout: public PreserveJVMState {
884 public:
885 BuildCutout(GraphKit* kit, Node* p, float prob, float cnt = COUNT_UNKNOWN);
886 ~BuildCutout();
887 };
888
889 // Helper class to preserve the original _reexecute bit and _sp and restore
890 // them back
891 class PreserveReexecuteState: public StackObj {
892 protected:
893 GraphKit* _kit;
894 uint _sp;
895 JVMState::ReexecuteState _reexecute;
896
897 public:
898 PreserveReexecuteState(GraphKit* kit);
899 ~PreserveReexecuteState();
900 };
901
902 #endif // SHARE_VM_OPTO_GRAPHKIT_HPP