annotate hotspot/src/share/vm/opto/graphKit.hpp @ 1374:4c24294029a9

6711316: Open source the Garbage-First garbage collector Summary: First mercurial integration of the code for the Garbage-First garbage collector. Reviewed-by: apetrusenko, iveresov, jmasa, sgoldman, tonyp, ysr
author ysr
date Thu, 05 Jun 2008 15:57:56 -0700
parents 489c9b5090e2
children a980915cf495
rev   line source
duke@1 1 /*
duke@1 2 * Copyright 2001-2007 Sun Microsystems, Inc. All Rights Reserved.
duke@1 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1 4 *
duke@1 5 * This code is free software; you can redistribute it and/or modify it
duke@1 6 * under the terms of the GNU General Public License version 2 only, as
duke@1 7 * published by the Free Software Foundation.
duke@1 8 *
duke@1 9 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@1 12 * version 2 for more details (a copy is included in the LICENSE file that
duke@1 13 * accompanied this code).
duke@1 14 *
duke@1 15 * You should have received a copy of the GNU General Public License version
duke@1 16 * 2 along with this work; if not, write to the Free Software Foundation,
duke@1 17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1 18 *
duke@1 19 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@1 20 * CA 95054 USA or visit www.sun.com if you need additional information or
duke@1 21 * have any questions.
duke@1 22 *
duke@1 23 */
duke@1 24
duke@1 25 class FastLockNode;
duke@1 26 class FastUnlockNode;
ysr@1374 27 class IdealKit;
duke@1 28 class Parse;
duke@1 29 class RootNode;
duke@1 30
duke@1 31 //-----------------------------------------------------------------------------
duke@1 32 //----------------------------GraphKit-----------------------------------------
duke@1 33 // Toolkit for building the common sorts of subgraphs.
duke@1 34 // Does not know about bytecode parsing or type-flow results.
duke@1 35 // It is able to create graphs implementing the semantics of most
duke@1 36 // or all bytecodes, so that it can expand intrinsics and calls.
duke@1 37 // It may depend on JVMState structure, but it must not depend
duke@1 38 // on specific bytecode streams.
duke@1 39 class GraphKit : public Phase {
duke@1 40 friend class PreserveJVMState;
duke@1 41
duke@1 42 protected:
duke@1 43 ciEnv* _env; // Compilation environment
duke@1 44 PhaseGVN &_gvn; // Some optimizations while parsing
duke@1 45 SafePointNode* _map; // Parser map from JVM to Nodes
duke@1 46 SafePointNode* _exceptions;// Parser map(s) for exception state(s)
duke@1 47 int _sp; // JVM Expression Stack Pointer
duke@1 48 int _bci; // JVM Bytecode Pointer
duke@1 49 ciMethod* _method; // JVM Current Method
duke@1 50
duke@1 51 private:
duke@1 52 SafePointNode* map_not_null() const {
duke@1 53 assert(_map != NULL, "must call stopped() to test for reset compiler map");
duke@1 54 return _map;
duke@1 55 }
duke@1 56
duke@1 57 public:
duke@1 58 GraphKit(); // empty constructor
duke@1 59 GraphKit(JVMState* jvms); // the JVM state on which to operate
duke@1 60
duke@1 61 #ifdef ASSERT
duke@1 62 ~GraphKit() {
duke@1 63 assert(!has_exceptions(), "user must call transfer_exceptions_into_jvms");
duke@1 64 }
duke@1 65 #endif
duke@1 66
duke@1 67 virtual Parse* is_Parse() const { return NULL; }
duke@1 68
duke@1 69 ciEnv* env() const { return _env; }
duke@1 70 PhaseGVN& gvn() const { return _gvn; }
duke@1 71
duke@1 72 void record_for_igvn(Node* n) const { C->record_for_igvn(n); } // delegate to Compile
duke@1 73
duke@1 74 // Handy well-known nodes:
duke@1 75 Node* null() const { return zerocon(T_OBJECT); }
duke@1 76 Node* top() const { return C->top(); }
duke@1 77 RootNode* root() const { return C->root(); }
duke@1 78
duke@1 79 // Create or find a constant node
duke@1 80 Node* intcon(jint con) const { return _gvn.intcon(con); }
duke@1 81 Node* longcon(jlong con) const { return _gvn.longcon(con); }
duke@1 82 Node* makecon(const Type *t) const { return _gvn.makecon(t); }
duke@1 83 Node* zerocon(BasicType bt) const { return _gvn.zerocon(bt); }
duke@1 84 // (See also macro MakeConX in type.hpp, which uses intcon or longcon.)
duke@1 85
duke@1 86 jint find_int_con(Node* n, jint value_if_unknown) {
duke@1 87 return _gvn.find_int_con(n, value_if_unknown);
duke@1 88 }
duke@1 89 jlong find_long_con(Node* n, jlong value_if_unknown) {
duke@1 90 return _gvn.find_long_con(n, value_if_unknown);
duke@1 91 }
duke@1 92 // (See also macro find_intptr_t_con in type.hpp, which uses one of these.)
duke@1 93
duke@1 94 // JVM State accessors:
duke@1 95 // Parser mapping from JVM indices into Nodes.
duke@1 96 // Low slots are accessed by the StartNode::enum.
duke@1 97 // Then come the locals at StartNode::Parms to StartNode::Parms+max_locals();
duke@1 98 // Then come JVM stack slots.
duke@1 99 // Finally come the monitors, if any.
duke@1 100 // See layout accessors in class JVMState.
duke@1 101
duke@1 102 SafePointNode* map() const { return _map; }
duke@1 103 bool has_exceptions() const { return _exceptions != NULL; }
duke@1 104 JVMState* jvms() const { return map_not_null()->_jvms; }
duke@1 105 int sp() const { return _sp; }
duke@1 106 int bci() const { return _bci; }
duke@1 107 Bytecodes::Code java_bc() const;
duke@1 108 ciMethod* method() const { return _method; }
duke@1 109
duke@1 110 void set_jvms(JVMState* jvms) { set_map(jvms->map());
duke@1 111 assert(jvms == this->jvms(), "sanity");
duke@1 112 _sp = jvms->sp();
duke@1 113 _bci = jvms->bci();
duke@1 114 _method = jvms->has_method() ? jvms->method() : NULL; }
duke@1 115 void set_map(SafePointNode* m) { _map = m; debug_only(verify_map()); }
duke@1 116 void set_sp(int i) { assert(i >= 0, "must be non-negative"); _sp = i; }
duke@1 117 void clean_stack(int from_sp); // clear garbage beyond from_sp to top
duke@1 118
duke@1 119 void inc_sp(int i) { set_sp(sp() + i); }
duke@1 120 void set_bci(int bci) { _bci = bci; }
duke@1 121
duke@1 122 // Make sure jvms has current bci & sp.
duke@1 123 JVMState* sync_jvms() const;
duke@1 124 #ifdef ASSERT
duke@1 125 // Make sure JVMS has an updated copy of bci and sp.
duke@1 126 // Also sanity-check method, depth, and monitor depth.
duke@1 127 bool jvms_in_sync() const;
duke@1 128
duke@1 129 // Make sure the map looks OK.
duke@1 130 void verify_map() const;
duke@1 131
duke@1 132 // Make sure a proposed exception state looks OK.
duke@1 133 static void verify_exception_state(SafePointNode* ex_map);
duke@1 134 #endif
duke@1 135
duke@1 136 // Clone the existing map state. (Implements PreserveJVMState.)
duke@1 137 SafePointNode* clone_map();
duke@1 138
duke@1 139 // Set the map to a clone of the given one.
duke@1 140 void set_map_clone(SafePointNode* m);
duke@1 141
duke@1 142 // Tell if the compilation is failing.
duke@1 143 bool failing() const { return C->failing(); }
duke@1 144
duke@1 145 // Set _map to NULL, signalling a stop to further bytecode execution.
duke@1 146 // Preserve the map intact for future use, and return it back to the caller.
duke@1 147 SafePointNode* stop() { SafePointNode* m = map(); set_map(NULL); return m; }
duke@1 148
duke@1 149 // Stop, but first smash the map's inputs to NULL, to mark it dead.
duke@1 150 void stop_and_kill_map();
duke@1 151
duke@1 152 // Tell if _map is NULL, or control is top.
duke@1 153 bool stopped();
duke@1 154
duke@1 155 // Tell if this method or any caller method has exception handlers.
duke@1 156 bool has_ex_handler();
duke@1 157
duke@1 158 // Save an exception without blowing stack contents or other JVM state.
duke@1 159 // (The extra pointer is stuck with add_req on the map, beyond the JVMS.)
duke@1 160 static void set_saved_ex_oop(SafePointNode* ex_map, Node* ex_oop);
duke@1 161
duke@1 162 // Recover a saved exception from its map.
duke@1 163 static Node* saved_ex_oop(SafePointNode* ex_map);
duke@1 164
duke@1 165 // Recover a saved exception from its map, and remove it from the map.
duke@1 166 static Node* clear_saved_ex_oop(SafePointNode* ex_map);
duke@1 167
duke@1 168 #ifdef ASSERT
duke@1 169 // Recover a saved exception from its map, and remove it from the map.
duke@1 170 static bool has_saved_ex_oop(SafePointNode* ex_map);
duke@1 171 #endif
duke@1 172
duke@1 173 // Push an exception in the canonical position for handlers (stack(0)).
duke@1 174 void push_ex_oop(Node* ex_oop) {
duke@1 175 ensure_stack(1); // ensure room to push the exception
duke@1 176 set_stack(0, ex_oop);
duke@1 177 set_sp(1);
duke@1 178 clean_stack(1);
duke@1 179 }
duke@1 180
duke@1 181 // Detach and return an exception state.
duke@1 182 SafePointNode* pop_exception_state() {
duke@1 183 SafePointNode* ex_map = _exceptions;
duke@1 184 if (ex_map != NULL) {
duke@1 185 _exceptions = ex_map->next_exception();
duke@1 186 ex_map->set_next_exception(NULL);
duke@1 187 debug_only(verify_exception_state(ex_map));
duke@1 188 }
duke@1 189 return ex_map;
duke@1 190 }
duke@1 191
duke@1 192 // Add an exception, using the given JVM state, without commoning.
duke@1 193 void push_exception_state(SafePointNode* ex_map) {
duke@1 194 debug_only(verify_exception_state(ex_map));
duke@1 195 ex_map->set_next_exception(_exceptions);
duke@1 196 _exceptions = ex_map;
duke@1 197 }
duke@1 198
duke@1 199 // Turn the current JVM state into an exception state, appending the ex_oop.
duke@1 200 SafePointNode* make_exception_state(Node* ex_oop);
duke@1 201
duke@1 202 // Add an exception, using the given JVM state.
duke@1 203 // Combine all exceptions with a common exception type into a single state.
duke@1 204 // (This is done via combine_exception_states.)
duke@1 205 void add_exception_state(SafePointNode* ex_map);
duke@1 206
duke@1 207 // Combine all exceptions of any sort whatever into a single master state.
duke@1 208 SafePointNode* combine_and_pop_all_exception_states() {
duke@1 209 if (_exceptions == NULL) return NULL;
duke@1 210 SafePointNode* phi_map = pop_exception_state();
duke@1 211 SafePointNode* ex_map;
duke@1 212 while ((ex_map = pop_exception_state()) != NULL) {
duke@1 213 combine_exception_states(ex_map, phi_map);
duke@1 214 }
duke@1 215 return phi_map;
duke@1 216 }
duke@1 217
duke@1 218 // Combine the two exception states, building phis as necessary.
duke@1 219 // The second argument is updated to include contributions from the first.
duke@1 220 void combine_exception_states(SafePointNode* ex_map, SafePointNode* phi_map);
duke@1 221
duke@1 222 // Reset the map to the given state. If there are any half-finished phis
duke@1 223 // in it (created by combine_exception_states), transform them now.
duke@1 224 // Returns the exception oop. (Caller must call push_ex_oop if required.)
duke@1 225 Node* use_exception_state(SafePointNode* ex_map);
duke@1 226
duke@1 227 // Collect exceptions from a given JVM state into my exception list.
duke@1 228 void add_exception_states_from(JVMState* jvms);
duke@1 229
duke@1 230 // Collect all raised exceptions into the current JVM state.
duke@1 231 // Clear the current exception list and map, returns the combined states.
duke@1 232 JVMState* transfer_exceptions_into_jvms();
duke@1 233
duke@1 234 // Helper to throw a built-in exception.
duke@1 235 // Range checks take the offending index.
duke@1 236 // Cast and array store checks take the offending class.
duke@1 237 // Others do not take the optional argument.
duke@1 238 // The JVMS must allow the bytecode to be re-executed
duke@1 239 // via an uncommon trap.
duke@1 240 void builtin_throw(Deoptimization::DeoptReason reason, Node* arg = NULL);
duke@1 241
duke@1 242 // Helper Functions for adding debug information
duke@1 243 void kill_dead_locals();
duke@1 244 #ifdef ASSERT
duke@1 245 bool dead_locals_are_killed();
duke@1 246 #endif
duke@1 247 // The call may deoptimize. Supply required JVM state as debug info.
duke@1 248 // If must_throw is true, the call is guaranteed not to return normally.
duke@1 249 void add_safepoint_edges(SafePointNode* call,
duke@1 250 bool must_throw = false);
duke@1 251
duke@1 252 // How many stack inputs does the current BC consume?
duke@1 253 // And, how does the stack change after the bytecode?
duke@1 254 // Returns false if unknown.
duke@1 255 bool compute_stack_effects(int& inputs, int& depth);
duke@1 256
duke@1 257 // Add a fixed offset to a pointer
duke@1 258 Node* basic_plus_adr(Node* base, Node* ptr, intptr_t offset) {
duke@1 259 return basic_plus_adr(base, ptr, MakeConX(offset));
duke@1 260 }
duke@1 261 Node* basic_plus_adr(Node* base, intptr_t offset) {
duke@1 262 return basic_plus_adr(base, base, MakeConX(offset));
duke@1 263 }
duke@1 264 // Add a variable offset to a pointer
duke@1 265 Node* basic_plus_adr(Node* base, Node* offset) {
duke@1 266 return basic_plus_adr(base, base, offset);
duke@1 267 }
duke@1 268 Node* basic_plus_adr(Node* base, Node* ptr, Node* offset);
duke@1 269
duke@1 270 // Convert between int and long, and size_t.
duke@1 271 // (See macros ConvI2X, etc., in type.hpp for ConvI2X, etc.)
duke@1 272 Node* ConvI2L(Node* offset);
duke@1 273 Node* ConvL2I(Node* offset);
duke@1 274 // Find out the klass of an object.
duke@1 275 Node* load_object_klass(Node* object);
duke@1 276 // Find out the length of an array.
duke@1 277 Node* load_array_length(Node* array);
duke@1 278 // Helper function to do a NULL pointer check or ZERO check based on type.
duke@1 279 Node* null_check_common(Node* value, BasicType type,
duke@1 280 bool assert_null, Node* *null_control);
duke@1 281 // Throw an exception if a given value is null.
duke@1 282 // Return the value cast to not-null.
duke@1 283 // Be clever about equivalent dominating null checks.
duke@1 284 Node* do_null_check(Node* value, BasicType type) {
duke@1 285 return null_check_common(value, type, false, NULL);
duke@1 286 }
duke@1 287 // Throw an uncommon trap if a given value is __not__ null.
duke@1 288 // Return the value cast to null, and be clever about dominating checks.
duke@1 289 Node* do_null_assert(Node* value, BasicType type) {
duke@1 290 return null_check_common(value, type, true, NULL);
duke@1 291 }
duke@1 292 // Null check oop. Return null-path control into (*null_control).
duke@1 293 // Return a cast-not-null node which depends on the not-null control.
duke@1 294 // If never_see_null, use an uncommon trap (*null_control sees a top).
duke@1 295 // The cast is not valid along the null path; keep a copy of the original.
duke@1 296 Node* null_check_oop(Node* value, Node* *null_control,
duke@1 297 bool never_see_null = false);
duke@1 298
duke@1 299 // Cast obj to not-null on this path
duke@1 300 Node* cast_not_null(Node* obj, bool do_replace_in_map = true);
duke@1 301 // Replace all occurrences of one node by another.
duke@1 302 void replace_in_map(Node* old, Node* neww);
duke@1 303
duke@1 304 void push(Node* n) { map_not_null(); _map->set_stack(_map->_jvms,_sp++,n); }
duke@1 305 Node* pop() { map_not_null(); return _map->stack(_map->_jvms,--_sp); }
duke@1 306 Node* peek(int off=0) { map_not_null(); return _map->stack(_map->_jvms, _sp - off - 1); }
duke@1 307
duke@1 308 void push_pair(Node* ldval) {
duke@1 309 push(ldval);
duke@1 310 push(top()); // the halfword is merely a placeholder
duke@1 311 }
duke@1 312 void push_pair_local(int i) {
duke@1 313 // longs are stored in locals in "push" order
duke@1 314 push( local(i+0) ); // the real value
duke@1 315 assert(local(i+1) == top(), "");
duke@1 316 push(top()); // halfword placeholder
duke@1 317 }
duke@1 318 Node* pop_pair() {
duke@1 319 // the second half is pushed last & popped first; it contains exactly nothing
duke@1 320 Node* halfword = pop();
duke@1 321 assert(halfword == top(), "");
duke@1 322 // the long bits are pushed first & popped last:
duke@1 323 return pop();
duke@1 324 }
duke@1 325 void set_pair_local(int i, Node* lval) {
duke@1 326 // longs are stored in locals as a value/half pair (like doubles)
duke@1 327 set_local(i+0, lval);
duke@1 328 set_local(i+1, top());
duke@1 329 }
duke@1 330
duke@1 331 // Push the node, which may be zero, one, or two words.
duke@1 332 void push_node(BasicType n_type, Node* n) {
duke@1 333 int n_size = type2size[n_type];
duke@1 334 if (n_size == 1) push( n ); // T_INT, ...
duke@1 335 else if (n_size == 2) push_pair( n ); // T_DOUBLE, T_LONG
duke@1 336 else { assert(n_size == 0, "must be T_VOID"); }
duke@1 337 }
duke@1 338
duke@1 339 Node* pop_node(BasicType n_type) {
duke@1 340 int n_size = type2size[n_type];
duke@1 341 if (n_size == 1) return pop();
duke@1 342 else if (n_size == 2) return pop_pair();
duke@1 343 else return NULL;
duke@1 344 }
duke@1 345
duke@1 346 Node* control() const { return map_not_null()->control(); }
duke@1 347 Node* i_o() const { return map_not_null()->i_o(); }
duke@1 348 Node* returnadr() const { return map_not_null()->returnadr(); }
duke@1 349 Node* frameptr() const { return map_not_null()->frameptr(); }
duke@1 350 Node* local(uint idx) const { map_not_null(); return _map->local( _map->_jvms, idx); }
duke@1 351 Node* stack(uint idx) const { map_not_null(); return _map->stack( _map->_jvms, idx); }
duke@1 352 Node* argument(uint idx) const { map_not_null(); return _map->argument( _map->_jvms, idx); }
duke@1 353 Node* monitor_box(uint idx) const { map_not_null(); return _map->monitor_box(_map->_jvms, idx); }
duke@1 354 Node* monitor_obj(uint idx) const { map_not_null(); return _map->monitor_obj(_map->_jvms, idx); }
duke@1 355
duke@1 356 void set_control (Node* c) { map_not_null()->set_control(c); }
duke@1 357 void set_i_o (Node* c) { map_not_null()->set_i_o(c); }
duke@1 358 void set_local(uint idx, Node* c) { map_not_null(); _map->set_local( _map->_jvms, idx, c); }
duke@1 359 void set_stack(uint idx, Node* c) { map_not_null(); _map->set_stack( _map->_jvms, idx, c); }
duke@1 360 void set_argument(uint idx, Node* c){ map_not_null(); _map->set_argument(_map->_jvms, idx, c); }
duke@1 361 void ensure_stack(uint stk_size) { map_not_null(); _map->ensure_stack(_map->_jvms, stk_size); }
duke@1 362
duke@1 363 // Access unaliased memory
duke@1 364 Node* memory(uint alias_idx);
duke@1 365 Node* memory(const TypePtr *tp) { return memory(C->get_alias_index(tp)); }
duke@1 366 Node* memory(Node* adr) { return memory(_gvn.type(adr)->is_ptr()); }
duke@1 367
duke@1 368 // Access immutable memory
duke@1 369 Node* immutable_memory() { return C->immutable_memory(); }
duke@1 370
duke@1 371 // Set unaliased memory
duke@1 372 void set_memory(Node* c, uint alias_idx) { merged_memory()->set_memory_at(alias_idx, c); }
duke@1 373 void set_memory(Node* c, const TypePtr *tp) { set_memory(c,C->get_alias_index(tp)); }
duke@1 374 void set_memory(Node* c, Node* adr) { set_memory(c,_gvn.type(adr)->is_ptr()); }
duke@1 375
duke@1 376 // Get the entire memory state (probably a MergeMemNode), and reset it
duke@1 377 // (The resetting prevents somebody from using the dangling Node pointer.)
duke@1 378 Node* reset_memory();
duke@1 379
duke@1 380 // Get the entire memory state, asserted to be a MergeMemNode.
duke@1 381 MergeMemNode* merged_memory() {
duke@1 382 Node* mem = map_not_null()->memory();
duke@1 383 assert(mem->is_MergeMem(), "parse memory is always pre-split");
duke@1 384 return mem->as_MergeMem();
duke@1 385 }
duke@1 386
duke@1 387 // Set the entire memory state; produce a new MergeMemNode.
duke@1 388 void set_all_memory(Node* newmem);
duke@1 389
duke@1 390 // Create a memory projection from the call, then set_all_memory.
duke@1 391 void set_all_memory_call(Node* call);
duke@1 392
duke@1 393 // Create a LoadNode, reading from the parser's memory state.
duke@1 394 // (Note: require_atomic_access is useful only with T_LONG.)
duke@1 395 Node* make_load(Node* ctl, Node* adr, const Type* t, BasicType bt,
duke@1 396 bool require_atomic_access = false) {
duke@1 397 // This version computes alias_index from bottom_type
duke@1 398 return make_load(ctl, adr, t, bt, adr->bottom_type()->is_ptr(),
duke@1 399 require_atomic_access);
duke@1 400 }
duke@1 401 Node* make_load(Node* ctl, Node* adr, const Type* t, BasicType bt, const TypePtr* adr_type, bool require_atomic_access = false) {
duke@1 402 // This version computes alias_index from an address type
duke@1 403 assert(adr_type != NULL, "use other make_load factory");
duke@1 404 return make_load(ctl, adr, t, bt, C->get_alias_index(adr_type),
duke@1 405 require_atomic_access);
duke@1 406 }
duke@1 407 // This is the base version which is given an alias index.
duke@1 408 Node* make_load(Node* ctl, Node* adr, const Type* t, BasicType bt, int adr_idx, bool require_atomic_access = false);
duke@1 409
duke@1 410 // Create & transform a StoreNode and store the effect into the
duke@1 411 // parser's memory state.
duke@1 412 Node* store_to_memory(Node* ctl, Node* adr, Node* val, BasicType bt,
duke@1 413 const TypePtr* adr_type,
duke@1 414 bool require_atomic_access = false) {
duke@1 415 // This version computes alias_index from an address type
duke@1 416 assert(adr_type != NULL, "use other store_to_memory factory");
duke@1 417 return store_to_memory(ctl, adr, val, bt,
duke@1 418 C->get_alias_index(adr_type),
duke@1 419 require_atomic_access);
duke@1 420 }
duke@1 421 // This is the base version which is given alias index
duke@1 422 // Return the new StoreXNode
duke@1 423 Node* store_to_memory(Node* ctl, Node* adr, Node* val, BasicType bt,
duke@1 424 int adr_idx,
duke@1 425 bool require_atomic_access = false);
duke@1 426
duke@1 427
duke@1 428 // All in one pre-barrier, store, post_barrier
duke@1 429 // Insert a write-barrier'd store. This is to let generational GC
duke@1 430 // work; we have to flag all oop-stores before the next GC point.
duke@1 431 //
duke@1 432 // It comes in 3 flavors of store to an object, array, or unknown.
duke@1 433 // We use precise card marks for arrays to avoid scanning the entire
duke@1 434 // array. We use imprecise for object. We use precise for unknown
duke@1 435 // since we don't know if we have an array or and object or even
duke@1 436 // where the object starts.
duke@1 437 //
duke@1 438 // If val==NULL, it is taken to be a completely unknown value. QQQ
duke@1 439
duke@1 440 Node* store_oop_to_object(Node* ctl,
duke@1 441 Node* obj, // containing obj
duke@1 442 Node* adr, // actual adress to store val at
duke@1 443 const TypePtr* adr_type,
duke@1 444 Node* val,
duke@1 445 const Type* val_type,
duke@1 446 BasicType bt);
duke@1 447
duke@1 448 Node* store_oop_to_array(Node* ctl,
duke@1 449 Node* obj, // containing obj
duke@1 450 Node* adr, // actual adress to store val at
duke@1 451 const TypePtr* adr_type,
duke@1 452 Node* val,
duke@1 453 const Type* val_type,
duke@1 454 BasicType bt);
duke@1 455
duke@1 456 // Could be an array or object we don't know at compile time (unsafe ref.)
duke@1 457 Node* store_oop_to_unknown(Node* ctl,
duke@1 458 Node* obj, // containing obj
duke@1 459 Node* adr, // actual adress to store val at
duke@1 460 const TypePtr* adr_type,
duke@1 461 Node* val,
duke@1 462 const Type* val_type,
duke@1 463 BasicType bt);
duke@1 464
duke@1 465 // For the few case where the barriers need special help
duke@1 466 void pre_barrier(Node* ctl, Node* obj, Node* adr, uint adr_idx,
duke@1 467 Node* val, const Type* val_type, BasicType bt);
duke@1 468
duke@1 469 void post_barrier(Node* ctl, Node* store, Node* obj, Node* adr, uint adr_idx,
duke@1 470 Node* val, BasicType bt, bool use_precise);
duke@1 471
duke@1 472 // Return addressing for an array element.
duke@1 473 Node* array_element_address(Node* ary, Node* idx, BasicType elembt,
duke@1 474 // Optional constraint on the array size:
duke@1 475 const TypeInt* sizetype = NULL);
duke@1 476
duke@1 477 // Return a load of array element at idx.
duke@1 478 Node* load_array_element(Node* ctl, Node* ary, Node* idx, const TypeAryPtr* arytype);
duke@1 479
duke@1 480 // CMS card-marks have an input from the corresponding oop_store
duke@1 481 void cms_card_mark(Node* ctl, Node* adr, Node* val, Node* oop_store);
duke@1 482
duke@1 483 //---------------- Dtrace support --------------------
duke@1 484 void make_dtrace_method_entry_exit(ciMethod* method, bool is_entry);
duke@1 485 void make_dtrace_method_entry(ciMethod* method) {
duke@1 486 make_dtrace_method_entry_exit(method, true);
duke@1 487 }
duke@1 488 void make_dtrace_method_exit(ciMethod* method) {
duke@1 489 make_dtrace_method_entry_exit(method, false);
duke@1 490 }
duke@1 491
duke@1 492 //--------------- stub generation -------------------
duke@1 493 public:
duke@1 494 void gen_stub(address C_function,
duke@1 495 const char *name,
duke@1 496 int is_fancy_jump,
duke@1 497 bool pass_tls,
duke@1 498 bool return_pc);
duke@1 499
duke@1 500 //---------- help for generating calls --------------
duke@1 501
duke@1 502 // Do a null check on the receiver, which is in argument(0).
duke@1 503 Node* null_check_receiver(ciMethod* callee) {
duke@1 504 assert(!callee->is_static(), "must be a virtual method");
duke@1 505 int nargs = 1 + callee->signature()->size();
duke@1 506 // Null check on self without removing any arguments. The argument
duke@1 507 // null check technically happens in the wrong place, which can lead to
duke@1 508 // invalid stack traces when the primitive is inlined into a method
duke@1 509 // which handles NullPointerExceptions.
duke@1 510 Node* receiver = argument(0);
duke@1 511 _sp += nargs;
duke@1 512 receiver = do_null_check(receiver, T_OBJECT);
duke@1 513 _sp -= nargs;
duke@1 514 return receiver;
duke@1 515 }
duke@1 516
duke@1 517 // Fill in argument edges for the call from argument(0), argument(1), ...
duke@1 518 // (The next step is to call set_edges_for_java_call.)
duke@1 519 void set_arguments_for_java_call(CallJavaNode* call);
duke@1 520
duke@1 521 // Fill in non-argument edges for the call.
duke@1 522 // Transform the call, and update the basics: control, i_o, memory.
duke@1 523 // (The next step is usually to call set_results_for_java_call.)
duke@1 524 void set_edges_for_java_call(CallJavaNode* call,
duke@1 525 bool must_throw = false);
duke@1 526
duke@1 527 // Finish up a java call that was started by set_edges_for_java_call.
duke@1 528 // Call add_exception on any throw arising from the call.
duke@1 529 // Return the call result (transformed).
duke@1 530 Node* set_results_for_java_call(CallJavaNode* call);
duke@1 531
duke@1 532 // Similar to set_edges_for_java_call, but simplified for runtime calls.
duke@1 533 void set_predefined_output_for_runtime_call(Node* call) {
duke@1 534 set_predefined_output_for_runtime_call(call, NULL, NULL);
duke@1 535 }
duke@1 536 void set_predefined_output_for_runtime_call(Node* call,
duke@1 537 Node* keep_mem,
duke@1 538 const TypePtr* hook_mem);
duke@1 539 Node* set_predefined_input_for_runtime_call(SafePointNode* call);
duke@1 540
duke@1 541 // helper functions for statistics
duke@1 542 void increment_counter(address counter_addr); // increment a debug counter
duke@1 543 void increment_counter(Node* counter_addr); // increment a debug counter
duke@1 544
duke@1 545 // Bail out to the interpreter right now
duke@1 546 // The optional klass is the one causing the trap.
duke@1 547 // The optional reason is debug information written to the compile log.
duke@1 548 // Optional must_throw is the same as with add_safepoint_edges.
duke@1 549 void uncommon_trap(int trap_request,
duke@1 550 ciKlass* klass = NULL, const char* reason_string = NULL,
duke@1 551 bool must_throw = false, bool keep_exact_action = false);
duke@1 552
duke@1 553 // Shorthand, to avoid saying "Deoptimization::" so many times.
duke@1 554 void uncommon_trap(Deoptimization::DeoptReason reason,
duke@1 555 Deoptimization::DeoptAction action,
duke@1 556 ciKlass* klass = NULL, const char* reason_string = NULL,
duke@1 557 bool must_throw = false, bool keep_exact_action = false) {
duke@1 558 uncommon_trap(Deoptimization::make_trap_request(reason, action),
duke@1 559 klass, reason_string, must_throw, keep_exact_action);
duke@1 560 }
duke@1 561
duke@1 562 // Report if there were too many traps at the current method and bci.
duke@1 563 // Report if a trap was recorded, and/or PerMethodTrapLimit was exceeded.
duke@1 564 // If there is no MDO at all, report no trap unless told to assume it.
duke@1 565 bool too_many_traps(Deoptimization::DeoptReason reason) {
duke@1 566 return C->too_many_traps(method(), bci(), reason);
duke@1 567 }
duke@1 568
duke@1 569 // Report if there were too many recompiles at the current method and bci.
duke@1 570 bool too_many_recompiles(Deoptimization::DeoptReason reason) {
duke@1 571 return C->too_many_recompiles(method(), bci(), reason);
duke@1 572 }
duke@1 573
duke@1 574 // vanilla/CMS post barrier
duke@1 575 void write_barrier_post(Node *store, Node* obj, Node* adr, Node* val, bool use_precise);
duke@1 576
duke@1 577 // Returns the object (if any) which was created the moment before.
duke@1 578 Node* just_allocated_object(Node* current_control);
duke@1 579
duke@1 580 static bool use_ReduceInitialCardMarks() {
duke@1 581 return (ReduceInitialCardMarks
duke@1 582 && Universe::heap()->can_elide_tlab_store_barriers());
duke@1 583 }
duke@1 584
ysr@1374 585 // G1 pre/post barriers
ysr@1374 586 void g1_write_barrier_pre(Node* obj,
ysr@1374 587 Node* adr,
ysr@1374 588 uint alias_idx,
ysr@1374 589 Node* val,
ysr@1374 590 const Type* val_type,
ysr@1374 591 BasicType bt);
ysr@1374 592
ysr@1374 593 void g1_write_barrier_post(Node* store,
ysr@1374 594 Node* obj,
ysr@1374 595 Node* adr,
ysr@1374 596 uint alias_idx,
ysr@1374 597 Node* val,
ysr@1374 598 BasicType bt,
ysr@1374 599 bool use_precise);
ysr@1374 600 // Helper function for g1
ysr@1374 601 private:
ysr@1374 602 void g1_mark_card(IdealKit* ideal, Node* card_adr, Node* store, Node* index, Node* index_adr,
ysr@1374 603 Node* buffer, const TypeFunc* tf);
ysr@1374 604
ysr@1374 605 public:
duke@1 606 // Helper function to round double arguments before a call
duke@1 607 void round_double_arguments(ciMethod* dest_method);
duke@1 608 void round_double_result(ciMethod* dest_method);
duke@1 609
duke@1 610 // rounding for strict float precision conformance
duke@1 611 Node* precision_rounding(Node* n);
duke@1 612
duke@1 613 // rounding for strict double precision conformance
duke@1 614 Node* dprecision_rounding(Node* n);
duke@1 615
duke@1 616 // rounding for non-strict double stores
duke@1 617 Node* dstore_rounding(Node* n);
duke@1 618
duke@1 619 // Helper functions for fast/slow path codes
duke@1 620 Node* opt_iff(Node* region, Node* iff);
duke@1 621 Node* make_runtime_call(int flags,
duke@1 622 const TypeFunc* call_type, address call_addr,
duke@1 623 const char* call_name,
duke@1 624 const TypePtr* adr_type, // NULL if no memory effects
duke@1 625 Node* parm0 = NULL, Node* parm1 = NULL,
duke@1 626 Node* parm2 = NULL, Node* parm3 = NULL,
duke@1 627 Node* parm4 = NULL, Node* parm5 = NULL,
duke@1 628 Node* parm6 = NULL, Node* parm7 = NULL);
duke@1 629 enum { // flag values for make_runtime_call
duke@1 630 RC_NO_FP = 1, // CallLeafNoFPNode
duke@1 631 RC_NO_IO = 2, // do not hook IO edges
duke@1 632 RC_NO_LEAF = 4, // CallStaticJavaNode
duke@1 633 RC_MUST_THROW = 8, // flag passed to add_safepoint_edges
duke@1 634 RC_NARROW_MEM = 16, // input memory is same as output
duke@1 635 RC_UNCOMMON = 32, // freq. expected to be like uncommon trap
duke@1 636 RC_LEAF = 0 // null value: no flags set
duke@1 637 };
duke@1 638
duke@1 639 // merge in all memory slices from new_mem, along the given path
duke@1 640 void merge_memory(Node* new_mem, Node* region, int new_path);
duke@1 641 void make_slow_call_ex(Node* call, ciInstanceKlass* ex_klass, bool separate_io_proj);
duke@1 642
duke@1 643 // Helper functions to build synchronizations
duke@1 644 int next_monitor();
duke@1 645 Node* insert_mem_bar(int opcode, Node* precedent = NULL);
duke@1 646 Node* insert_mem_bar_volatile(int opcode, int alias_idx, Node* precedent = NULL);
duke@1 647 // Optional 'precedent' is appended as an extra edge, to force ordering.
duke@1 648 FastLockNode* shared_lock(Node* obj);
duke@1 649 void shared_unlock(Node* box, Node* obj);
duke@1 650
duke@1 651 // helper functions for the fast path/slow path idioms
duke@1 652 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);
duke@1 653
duke@1 654 // Generate an instance-of idiom. Used by both the instance-of bytecode
duke@1 655 // and the reflective instance-of call.
duke@1 656 Node* gen_instanceof( Node *subobj, Node* superkls );
duke@1 657
duke@1 658 // Generate a check-cast idiom. Used by both the check-cast bytecode
duke@1 659 // and the array-store bytecode
duke@1 660 Node* gen_checkcast( Node *subobj, Node* superkls,
duke@1 661 Node* *failure_control = NULL );
duke@1 662
duke@1 663 // Generate a subtyping check. Takes as input the subtype and supertype.
duke@1 664 // Returns 2 values: sets the default control() to the true path and
duke@1 665 // returns the false path. Only reads from constant memory taken from the
duke@1 666 // default memory; does not write anything. It also doesn't take in an
duke@1 667 // Object; if you wish to check an Object you need to load the Object's
duke@1 668 // class prior to coming here.
duke@1 669 Node* gen_subtype_check(Node* subklass, Node* superklass);
duke@1 670
duke@1 671 // Static parse-time type checking logic for gen_subtype_check:
duke@1 672 enum { SSC_always_false, SSC_always_true, SSC_easy_test, SSC_full_test };
duke@1 673 int static_subtype_check(ciKlass* superk, ciKlass* subk);
duke@1 674
duke@1 675 // Exact type check used for predicted calls and casts.
duke@1 676 // Rewrites (*casted_receiver) to be casted to the stronger type.
duke@1 677 // (Caller is responsible for doing replace_in_map.)
duke@1 678 Node* type_check_receiver(Node* receiver, ciKlass* klass, float prob,
duke@1 679 Node* *casted_receiver);
duke@1 680
duke@1 681 // implementation of object creation
duke@1 682 Node* set_output_for_allocation(AllocateNode* alloc,
duke@1 683 const TypeOopPtr* oop_type,
duke@1 684 bool raw_mem_only);
duke@1 685 Node* get_layout_helper(Node* klass_node, jint& constant_value);
duke@1 686 Node* new_instance(Node* klass_node,
duke@1 687 Node* slow_test = NULL,
duke@1 688 bool raw_mem_only = false,
duke@1 689 Node* *return_size_val = NULL);
duke@1 690 Node* new_array(Node* klass_node, Node* count_val,
duke@1 691 bool raw_mem_only = false, Node* *return_size_val = NULL);
duke@1 692
duke@1 693 // Handy for making control flow
duke@1 694 IfNode* create_and_map_if(Node* ctrl, Node* tst, float prob, float cnt) {
duke@1 695 IfNode* iff = new (C, 2) IfNode(ctrl, tst, prob, cnt);// New IfNode's
duke@1 696 _gvn.set_type(iff, iff->Value(&_gvn)); // Value may be known at parse-time
duke@1 697 // Place 'if' on worklist if it will be in graph
duke@1 698 if (!tst->is_Con()) record_for_igvn(iff); // Range-check and Null-check removal is later
duke@1 699 return iff;
duke@1 700 }
duke@1 701
duke@1 702 IfNode* create_and_xform_if(Node* ctrl, Node* tst, float prob, float cnt) {
duke@1 703 IfNode* iff = new (C, 2) IfNode(ctrl, tst, prob, cnt);// New IfNode's
duke@1 704 _gvn.transform(iff); // Value may be known at parse-time
duke@1 705 // Place 'if' on worklist if it will be in graph
duke@1 706 if (!tst->is_Con()) record_for_igvn(iff); // Range-check and Null-check removal is later
duke@1 707 return iff;
duke@1 708 }
duke@1 709 };
duke@1 710
duke@1 711 // Helper class to support building of control flow branches. Upon
duke@1 712 // creation the map and sp at bci are cloned and restored upon de-
duke@1 713 // struction. Typical use:
duke@1 714 //
duke@1 715 // { PreserveJVMState pjvms(this);
duke@1 716 // // code of new branch
duke@1 717 // }
duke@1 718 // // here the JVM state at bci is established
duke@1 719
duke@1 720 class PreserveJVMState: public StackObj {
duke@1 721 protected:
duke@1 722 GraphKit* _kit;
duke@1 723 #ifdef ASSERT
duke@1 724 int _block; // PO of current block, if a Parse
duke@1 725 int _bci;
duke@1 726 #endif
duke@1 727 SafePointNode* _map;
duke@1 728 uint _sp;
duke@1 729
duke@1 730 public:
duke@1 731 PreserveJVMState(GraphKit* kit, bool clone_map = true);
duke@1 732 ~PreserveJVMState();
duke@1 733 };
duke@1 734
duke@1 735 // Helper class to build cutouts of the form if (p) ; else {x...}.
duke@1 736 // The code {x...} must not fall through.
duke@1 737 // The kit's main flow of control is set to the "then" continuation of if(p).
duke@1 738 class BuildCutout: public PreserveJVMState {
duke@1 739 public:
duke@1 740 BuildCutout(GraphKit* kit, Node* p, float prob, float cnt = COUNT_UNKNOWN);
duke@1 741 ~BuildCutout();
duke@1 742 };