src/share/vm/opto/escape.hpp

Mon, 31 Oct 2011 03:06:42 -0700

author
twisti
date
Mon, 31 Oct 2011 03:06:42 -0700
changeset 3249
e3b0dcc327b9
parent 2556
3763ca6579b7
child 3254
59e515ee9354
permissions
-rw-r--r--

7104561: UseRDPCForConstantTableBase doesn't work after shorten branches changes
Reviewed-by: never, kvn

duke@435 1 /*
kvn@2556 2 * Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved.
duke@435 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@435 4 *
duke@435 5 * This code is free software; you can redistribute it and/or modify it
duke@435 6 * under the terms of the GNU General Public License version 2 only, as
duke@435 7 * published by the Free Software Foundation.
duke@435 8 *
duke@435 9 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@435 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@435 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@435 12 * version 2 for more details (a copy is included in the LICENSE file that
duke@435 13 * accompanied this code).
duke@435 14 *
duke@435 15 * You should have received a copy of the GNU General Public License version
duke@435 16 * 2 along with this work; if not, write to the Free Software Foundation,
duke@435 17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@435 18 *
trims@1907 19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
trims@1907 20 * or visit www.oracle.com if you need additional information or have any
trims@1907 21 * questions.
duke@435 22 *
duke@435 23 */
duke@435 24
stefank@2314 25 #ifndef SHARE_VM_OPTO_ESCAPE_HPP
stefank@2314 26 #define SHARE_VM_OPTO_ESCAPE_HPP
stefank@2314 27
stefank@2314 28 #include "opto/addnode.hpp"
stefank@2314 29 #include "opto/node.hpp"
stefank@2314 30 #include "utilities/growableArray.hpp"
stefank@2314 31
duke@435 32 //
duke@435 33 // Adaptation for C2 of the escape analysis algorithm described in:
duke@435 34 //
kvn@500 35 // [Choi99] Jong-Deok Shoi, Manish Gupta, Mauricio Seffano,
kvn@500 36 // Vugranam C. Sreedhar, Sam Midkiff,
kvn@500 37 // "Escape Analysis for Java", Procedings of ACM SIGPLAN
kvn@500 38 // OOPSLA Conference, November 1, 1999
duke@435 39 //
duke@435 40 // The flow-insensitive analysis described in the paper has been implemented.
duke@435 41 //
kvn@500 42 // The analysis requires construction of a "connection graph" (CG) for
kvn@500 43 // the method being analyzed. The nodes of the connection graph are:
duke@435 44 //
duke@435 45 // - Java objects (JO)
duke@435 46 // - Local variables (LV)
duke@435 47 // - Fields of an object (OF), these also include array elements
duke@435 48 //
duke@435 49 // The CG contains 3 types of edges:
duke@435 50 //
kvn@500 51 // - PointsTo (-P>) {LV, OF} to JO
kvn@500 52 // - Deferred (-D>) from {LV, OF} to {LV, OF}
duke@435 53 // - Field (-F>) from JO to OF
duke@435 54 //
duke@435 55 // The following utility functions is used by the algorithm:
duke@435 56 //
kvn@500 57 // PointsTo(n) - n is any CG node, it returns the set of JO that n could
kvn@500 58 // point to.
duke@435 59 //
kvn@500 60 // The algorithm describes how to construct the connection graph
kvn@500 61 // in the following 4 cases:
duke@435 62 //
duke@435 63 // Case Edges Created
duke@435 64 //
kvn@500 65 // (1) p = new T() LV -P> JO
kvn@500 66 // (2) p = q LV -D> LV
kvn@500 67 // (3) p.f = q JO -F> OF, OF -D> LV
kvn@500 68 // (4) p = q.f JO -F> OF, LV -D> OF
duke@435 69 //
kvn@500 70 // In all these cases, p and q are local variables. For static field
kvn@500 71 // references, we can construct a local variable containing a reference
kvn@500 72 // to the static memory.
duke@435 73 //
duke@435 74 // C2 does not have local variables. However for the purposes of constructing
duke@435 75 // the connection graph, the following IR nodes are treated as local variables:
duke@435 76 // Phi (pointer values)
duke@435 77 // LoadP
kvn@500 78 // Proj#5 (value returned from callnodes including allocations)
kvn@500 79 // CheckCastPP, CastPP
duke@435 80 //
kvn@500 81 // The LoadP, Proj and CheckCastPP behave like variables assigned to only once.
kvn@500 82 // Only a Phi can have multiple assignments. Each input to a Phi is treated
duke@435 83 // as an assignment to it.
duke@435 84 //
kvn@500 85 // The following node types are JavaObject:
duke@435 86 //
duke@435 87 // top()
duke@435 88 // Allocate
duke@435 89 // AllocateArray
duke@435 90 // Parm (for incoming arguments)
kvn@500 91 // CastX2P ("unsafe" operations)
duke@435 92 // CreateEx
duke@435 93 // ConP
duke@435 94 // LoadKlass
kvn@500 95 // ThreadLocal
duke@435 96 //
duke@435 97 // AddP nodes are fields.
duke@435 98 //
duke@435 99 // After building the graph, a pass is made over the nodes, deleting deferred
duke@435 100 // nodes and copying the edges from the target of the deferred edge to the
duke@435 101 // source. This results in a graph with no deferred edges, only:
duke@435 102 //
duke@435 103 // LV -P> JO
kvn@500 104 // OF -P> JO (the object whose oop is stored in the field)
duke@435 105 // JO -F> OF
duke@435 106 //
duke@435 107 // Then, for each node which is GlobalEscape, anything it could point to
duke@435 108 // is marked GlobalEscape. Finally, for any node marked ArgEscape, anything
duke@435 109 // it could point to is marked ArgEscape.
duke@435 110 //
duke@435 111
duke@435 112 class Compile;
duke@435 113 class Node;
duke@435 114 class CallNode;
duke@435 115 class PhiNode;
duke@435 116 class PhaseTransform;
duke@435 117 class Type;
duke@435 118 class TypePtr;
duke@435 119 class VectorSet;
duke@435 120
duke@435 121 class PointsToNode {
duke@435 122 friend class ConnectionGraph;
duke@435 123 public:
duke@435 124 typedef enum {
kvn@500 125 UnknownType = 0,
kvn@500 126 JavaObject = 1,
kvn@500 127 LocalVar = 2,
kvn@500 128 Field = 3
duke@435 129 } NodeType;
duke@435 130
duke@435 131 typedef enum {
duke@435 132 UnknownEscape = 0,
kvn@500 133 NoEscape = 1, // A scalar replaceable object with unique type.
kvn@500 134 ArgEscape = 2, // An object passed as argument or referenced by
kvn@500 135 // argument (and not globally escape during call).
kvn@500 136 GlobalEscape = 3 // An object escapes the method and thread.
duke@435 137 } EscapeState;
duke@435 138
duke@435 139 typedef enum {
duke@435 140 UnknownEdge = 0,
duke@435 141 PointsToEdge = 1,
duke@435 142 DeferredEdge = 2,
duke@435 143 FieldEdge = 3
duke@435 144 } EdgeType;
duke@435 145
duke@435 146 private:
duke@435 147 enum {
duke@435 148 EdgeMask = 3,
duke@435 149 EdgeShift = 2,
duke@435 150
duke@435 151 INITIAL_EDGE_COUNT = 4
duke@435 152 };
duke@435 153
duke@435 154 NodeType _type;
duke@435 155 EscapeState _escape;
kvn@500 156 GrowableArray<uint>* _edges; // outgoing edges
duke@435 157
duke@435 158 public:
kvn@500 159 Node* _node; // Ideal node corresponding to this PointsTo node.
kvn@500 160 int _offset; // Object fields offsets.
kvn@500 161 bool _scalar_replaceable;// Not escaped object could be replaced with scalar
kvn@500 162 bool _hidden_alias; // This node is an argument to a function.
kvn@500 163 // which may return it creating a hidden alias.
duke@435 164
kvn@500 165 PointsToNode():
kvn@500 166 _type(UnknownType),
kvn@500 167 _escape(UnknownEscape),
kvn@500 168 _edges(NULL),
kvn@500 169 _node(NULL),
kvn@500 170 _offset(-1),
kvn@500 171 _scalar_replaceable(true),
kvn@500 172 _hidden_alias(false) {}
duke@435 173
duke@435 174
duke@435 175 EscapeState escape_state() const { return _escape; }
duke@435 176 NodeType node_type() const { return _type;}
duke@435 177 int offset() { return _offset;}
duke@435 178
duke@435 179 void set_offset(int offs) { _offset = offs;}
duke@435 180 void set_escape_state(EscapeState state) { _escape = state; }
duke@435 181 void set_node_type(NodeType ntype) {
duke@435 182 assert(_type == UnknownType || _type == ntype, "Can't change node type");
duke@435 183 _type = ntype;
duke@435 184 }
duke@435 185
duke@435 186 // count of outgoing edges
duke@435 187 uint edge_count() const { return (_edges == NULL) ? 0 : _edges->length(); }
kvn@679 188
duke@435 189 // node index of target of outgoing edge "e"
kvn@679 190 uint edge_target(uint e) const {
kvn@679 191 assert(_edges != NULL, "valid edge index");
kvn@679 192 return (_edges->at(e) >> EdgeShift);
kvn@679 193 }
duke@435 194 // type of outgoing edge "e"
kvn@679 195 EdgeType edge_type(uint e) const {
kvn@679 196 assert(_edges != NULL, "valid edge index");
kvn@679 197 return (EdgeType) (_edges->at(e) & EdgeMask);
kvn@679 198 }
kvn@679 199
duke@435 200 // add a edge of the specified type pointing to the specified target
duke@435 201 void add_edge(uint targIdx, EdgeType et);
kvn@679 202
duke@435 203 // remove an edge of the specified type pointing to the specified target
duke@435 204 void remove_edge(uint targIdx, EdgeType et);
kvn@679 205
duke@435 206 #ifndef PRODUCT
kvn@688 207 void dump(bool print_state=true) const;
duke@435 208 #endif
duke@435 209
duke@435 210 };
duke@435 211
duke@435 212 class ConnectionGraph: public ResourceObj {
duke@435 213 private:
kvn@679 214 GrowableArray<PointsToNode> _nodes; // Connection graph nodes indexed
kvn@500 215 // by ideal node index.
duke@435 216
kvn@500 217 Unique_Node_List _delayed_worklist; // Nodes to be processed before
kvn@500 218 // the call build_connection_graph().
duke@435 219
kvn@1535 220 GrowableArray<MergeMemNode *> _mergemem_worklist; // List of all MergeMem nodes
kvn@1535 221
kvn@500 222 VectorSet _processed; // Records which nodes have been
kvn@500 223 // processed.
kvn@500 224
kvn@500 225 bool _collecting; // Indicates whether escape information
kvn@500 226 // is still being collected. If false,
kvn@500 227 // no new nodes will be processed.
kvn@500 228
kvn@2276 229 bool _progress; // Indicates whether new Graph's edges
kvn@2276 230 // were created.
kvn@2276 231
kvn@500 232 uint _phantom_object; // Index of globally escaping object
kvn@500 233 // that pointer values loaded from
kvn@500 234 // a field which has not been set
kvn@500 235 // are assumed to point to.
kvn@688 236 uint _oop_null; // ConP(#NULL)
kvn@688 237 uint _noop_null; // ConN(#NULL)
kvn@500 238
kvn@500 239 Compile * _compile; // Compile object for current compilation
kvn@1989 240 PhaseIterGVN * _igvn; // Value numbering
duke@435 241
kvn@679 242 // Address of an element in _nodes. Used when the element is to be modified
kvn@679 243 PointsToNode *ptnode_adr(uint idx) const {
kvn@679 244 // There should be no new ideal nodes during ConnectionGraph build,
kvn@679 245 // growableArray::adr_at() will throw assert otherwise.
kvn@679 246 return _nodes.adr_at(idx);
duke@435 247 }
kvn@679 248 uint nodes_size() const { return _nodes.length(); }
duke@435 249
kvn@500 250 // Add node to ConnectionGraph.
kvn@500 251 void add_node(Node *n, PointsToNode::NodeType nt, PointsToNode::EscapeState es, bool done);
kvn@500 252
duke@435 253 // offset of a field reference
kvn@500 254 int address_offset(Node* adr, PhaseTransform *phase);
duke@435 255
duke@435 256 // compute the escape state for arguments to a call
duke@435 257 void process_call_arguments(CallNode *call, PhaseTransform *phase);
duke@435 258
duke@435 259 // compute the escape state for the return value of a call
duke@435 260 void process_call_result(ProjNode *resproj, PhaseTransform *phase);
duke@435 261
kvn@500 262 // Populate Connection Graph with Ideal nodes.
kvn@500 263 void record_for_escape_analysis(Node *n, PhaseTransform *phase);
duke@435 264
kvn@500 265 // Build Connection Graph and set nodes escape state.
kvn@500 266 void build_connection_graph(Node *n, PhaseTransform *phase);
duke@435 267
duke@435 268 // walk the connection graph starting at the node corresponding to "n" and
duke@435 269 // add the index of everything it could point to, to "ptset". This may cause
duke@435 270 // Phi's encountered to get (re)processed (which requires "phase".)
kvn@2556 271 VectorSet* PointsTo(Node * n);
kvn@2556 272
kvn@2556 273 // Reused structures for PointsTo().
kvn@2556 274 VectorSet pt_ptset;
kvn@2556 275 VectorSet pt_visited;
kvn@2556 276 GrowableArray<uint> pt_worklist;
duke@435 277
duke@435 278 // Edge manipulation. The "from_i" and "to_i" arguments are the
duke@435 279 // node indices of the source and destination of the edge
duke@435 280 void add_pointsto_edge(uint from_i, uint to_i);
duke@435 281 void add_deferred_edge(uint from_i, uint to_i);
duke@435 282 void add_field_edge(uint from_i, uint to_i, int offs);
duke@435 283
kvn@2276 284 // Add an edge of the specified type pointing to the specified target.
kvn@2276 285 // Set _progress if new edge is added.
kvn@2276 286 void add_edge(PointsToNode *f, uint to_i, PointsToNode::EdgeType et) {
kvn@2276 287 uint e_cnt = f->edge_count();
kvn@2276 288 f->add_edge(to_i, et);
kvn@2276 289 _progress |= (f->edge_count() != e_cnt);
kvn@2276 290 }
duke@435 291
duke@435 292 // Add an edge to node given by "to_i" from any field of adr_i whose offset
duke@435 293 // matches "offset" A deferred edge is added if to_i is a LocalVar, and
duke@435 294 // a pointsto edge is added if it is a JavaObject
duke@435 295 void add_edge_from_fields(uint adr, uint to_i, int offs);
duke@435 296
kvn@500 297 // Add a deferred edge from node given by "from_i" to any field
kvn@500 298 // of adr_i whose offset matches "offset"
duke@435 299 void add_deferred_edge_to_fields(uint from_i, uint adr, int offs);
duke@435 300
duke@435 301
duke@435 302 // Remove outgoing deferred edges from the node referenced by "ni".
duke@435 303 // Any outgoing edges from the target of the deferred edge are copied
duke@435 304 // to "ni".
kvn@536 305 void remove_deferred(uint ni, GrowableArray<uint>* deferred_edges, VectorSet* visited);
duke@435 306
duke@435 307 Node_Array _node_map; // used for bookeeping during type splitting
duke@435 308 // Used for the following purposes:
duke@435 309 // Memory Phi - most recent unique Phi split out
duke@435 310 // from this Phi
duke@435 311 // MemNode - new memory input for this node
duke@435 312 // ChecCastPP - allocation that this is a cast of
duke@435 313 // allocation - CheckCastPP of the allocation
kvn@728 314 bool split_AddP(Node *addp, Node *base, PhaseGVN *igvn);
duke@435 315 PhiNode *create_split_phi(PhiNode *orig_phi, int alias_idx, GrowableArray<PhiNode *> &orig_phi_worklist, PhaseGVN *igvn, bool &new_created);
duke@435 316 PhiNode *split_memory_phi(PhiNode *orig_phi, int alias_idx, GrowableArray<PhiNode *> &orig_phi_worklist, PhaseGVN *igvn);
kvn@1536 317 void move_inst_mem(Node* n, GrowableArray<PhiNode *> &orig_phis, PhaseGVN *igvn);
kvn@500 318 Node *find_inst_mem(Node *mem, int alias_idx,GrowableArray<PhiNode *> &orig_phi_worklist, PhaseGVN *igvn);
kvn@500 319
duke@435 320 // Propagate unique types created for unescaped allocated objects
duke@435 321 // through the graph
duke@435 322 void split_unique_types(GrowableArray<Node *> &alloc_worklist);
duke@435 323
duke@435 324 // manage entries in _node_map
duke@435 325 void set_map(int idx, Node *n) { _node_map.map(idx, n); }
duke@435 326 Node *get_map(int idx) { return _node_map[idx]; }
duke@435 327 PhiNode *get_map_phi(int idx) {
duke@435 328 Node *phi = _node_map[idx];
duke@435 329 return (phi == NULL) ? NULL : phi->as_Phi();
duke@435 330 }
duke@435 331
duke@435 332 // Notify optimizer that a node has been modified
duke@435 333 // Node: This assumes that escape analysis is run before
duke@435 334 // PhaseIterGVN creation
duke@435 335 void record_for_optimizer(Node *n) {
kvn@1989 336 _igvn->_worklist.push(n);
duke@435 337 }
duke@435 338
duke@435 339 // Set the escape state of a node
duke@435 340 void set_escape_state(uint ni, PointsToNode::EscapeState es);
duke@435 341
kvn@2556 342 // Adjust escape state after Connection Graph is built.
kvn@2556 343 void adjust_escape_state(int nidx, PhaseTransform* phase);
kvn@2556 344
kvn@2556 345 // Compute the escape information
kvn@2556 346 bool compute_escape();
kvn@1535 347
duke@435 348 public:
kvn@1989 349 ConnectionGraph(Compile *C, PhaseIterGVN *igvn);
duke@435 350
kvn@679 351 // Check for non-escaping candidates
kvn@679 352 static bool has_candidates(Compile *C);
kvn@679 353
kvn@1989 354 // Perform escape analysis
kvn@1989 355 static void do_analysis(Compile *C, PhaseIterGVN *igvn);
kvn@1989 356
duke@435 357 // escape state of a node
kvn@1989 358 PointsToNode::EscapeState escape_state(Node *n);
kvn@1989 359
kvn@500 360 // other information we have collected
kvn@500 361 bool is_scalar_replaceable(Node *n) {
kvn@679 362 if (_collecting || (n->_idx >= nodes_size()))
kvn@500 363 return false;
kvn@679 364 PointsToNode* ptn = ptnode_adr(n->_idx);
kvn@679 365 return ptn->escape_state() == PointsToNode::NoEscape && ptn->_scalar_replaceable;
kvn@500 366 }
duke@435 367
duke@435 368 bool hidden_alias(Node *n) {
kvn@679 369 if (_collecting || (n->_idx >= nodes_size()))
duke@435 370 return true;
kvn@679 371 PointsToNode* ptn = ptnode_adr(n->_idx);
kvn@679 372 return (ptn->escape_state() != PointsToNode::NoEscape) || ptn->_hidden_alias;
duke@435 373 }
duke@435 374
duke@435 375 #ifndef PRODUCT
duke@435 376 void dump();
duke@435 377 #endif
duke@435 378 };
stefank@2314 379
stefank@2314 380 #endif // SHARE_VM_OPTO_ESCAPE_HPP

mercurial