1 /*
2 * Copyright (c) 2007, 2013, 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 #ifndef SHARE_VM_OPTO_SUPERWORD_HPP
25 #define SHARE_VM_OPTO_SUPERWORD_HPP
26
27 #include "opto/loopnode.hpp"
28 #include "opto/node.hpp"
29 #include "opto/phaseX.hpp"
30 #include "opto/vectornode.hpp"
31 #include "utilities/growableArray.hpp"
32
33 //
34 // S U P E R W O R D T R A N S F O R M
35 //
36 // SuperWords are short, fixed length vectors.
37 //
38 // Algorithm from:
39 //
40 // Exploiting SuperWord Level Parallelism with
41 // Multimedia Instruction Sets
42 // by
43 // Samuel Larsen and Saman Amarasighe
44 // MIT Laboratory for Computer Science
45 // date
46 // May 2000
47 // published in
48 // ACM SIGPLAN Notices
49 // Proceedings of ACM PLDI '00, Volume 35 Issue 5
50 //
51 // Definition 3.1 A Pack is an n-tuple, <s1, ...,sn>, where
52 // s1,...,sn are independent isomorphic statements in a basic
53 // block.
54 //
55 // Definition 3.2 A PackSet is a set of Packs.
56 //
57 // Definition 3.3 A Pair is a Pack of size two, where the
58 // first statement is considered the left element, and the
59 // second statement is considered the right element.
60
61 class SWPointer;
62 class OrderedPair;
63
64 // ========================= Dependence Graph =====================
65
66 class DepMem;
67
68 //------------------------------DepEdge---------------------------
69 // An edge in the dependence graph. The edges incident to a dependence
70 // node are threaded through _next_in for incoming edges and _next_out
71 // for outgoing edges.
72 class DepEdge : public ResourceObj {
73 protected:
74 DepMem* _pred;
75 DepMem* _succ;
76 DepEdge* _next_in; // list of in edges, null terminated
77 DepEdge* _next_out; // list of out edges, null terminated
78
79 public:
80 DepEdge(DepMem* pred, DepMem* succ, DepEdge* next_in, DepEdge* next_out) :
81 _pred(pred), _succ(succ), _next_in(next_in), _next_out(next_out) {}
82
83 DepEdge* next_in() { return _next_in; }
84 DepEdge* next_out() { return _next_out; }
85 DepMem* pred() { return _pred; }
86 DepMem* succ() { return _succ; }
87
88 void print();
89 };
90
91 //------------------------------DepMem---------------------------
92 // A node in the dependence graph. _in_head starts the threaded list of
93 // incoming edges, and _out_head starts the list of outgoing edges.
94 class DepMem : public ResourceObj {
95 protected:
96 Node* _node; // Corresponding ideal node
97 DepEdge* _in_head; // Head of list of in edges, null terminated
98 DepEdge* _out_head; // Head of list of out edges, null terminated
99
100 public:
101 DepMem(Node* node) : _node(node), _in_head(NULL), _out_head(NULL) {}
102
103 Node* node() { return _node; }
104 DepEdge* in_head() { return _in_head; }
105 DepEdge* out_head() { return _out_head; }
106 void set_in_head(DepEdge* hd) { _in_head = hd; }
107 void set_out_head(DepEdge* hd) { _out_head = hd; }
108
109 int in_cnt(); // Incoming edge count
110 int out_cnt(); // Outgoing edge count
111
112 void print();
113 };
114
115 //------------------------------DepGraph---------------------------
116 class DepGraph VALUE_OBJ_CLASS_SPEC {
117 protected:
118 Arena* _arena;
119 GrowableArray<DepMem*> _map;
120 DepMem* _root;
121 DepMem* _tail;
122
123 public:
124 DepGraph(Arena* a) : _arena(a), _map(a, 8, 0, NULL) {
125 _root = new (_arena) DepMem(NULL);
126 _tail = new (_arena) DepMem(NULL);
127 }
128
129 DepMem* root() { return _root; }
130 DepMem* tail() { return _tail; }
131
132 // Return dependence node corresponding to an ideal node
133 DepMem* dep(Node* node) { return _map.at(node->_idx); }
134
135 // Make a new dependence graph node for an ideal node.
136 DepMem* make_node(Node* node);
137
138 // Make a new dependence graph edge dprec->dsucc
139 DepEdge* make_edge(DepMem* dpred, DepMem* dsucc);
140
141 DepEdge* make_edge(Node* pred, Node* succ) { return make_edge(dep(pred), dep(succ)); }
142 DepEdge* make_edge(DepMem* pred, Node* succ) { return make_edge(pred, dep(succ)); }
143 DepEdge* make_edge(Node* pred, DepMem* succ) { return make_edge(dep(pred), succ); }
144
145 void init() { _map.clear(); } // initialize
146
147 void print(Node* n) { dep(n)->print(); }
148 void print(DepMem* d) { d->print(); }
149 };
150
151 //------------------------------DepPreds---------------------------
152 // Iterator over predecessors in the dependence graph and
153 // non-memory-graph inputs of ideal nodes.
154 class DepPreds : public StackObj {
155 private:
156 Node* _n;
157 int _next_idx, _end_idx;
158 DepEdge* _dep_next;
159 Node* _current;
160 bool _done;
161
162 public:
163 DepPreds(Node* n, DepGraph& dg);
164 Node* current() { return _current; }
165 bool done() { return _done; }
166 void next();
167 };
168
169 //------------------------------DepSuccs---------------------------
170 // Iterator over successors in the dependence graph and
171 // non-memory-graph outputs of ideal nodes.
172 class DepSuccs : public StackObj {
173 private:
174 Node* _n;
175 int _next_idx, _end_idx;
176 DepEdge* _dep_next;
177 Node* _current;
178 bool _done;
179
180 public:
181 DepSuccs(Node* n, DepGraph& dg);
182 Node* current() { return _current; }
183 bool done() { return _done; }
184 void next();
185 };
186
187
188 // ========================= SuperWord =====================
189
190 // -----------------------------SWNodeInfo---------------------------------
191 // Per node info needed by SuperWord
192 class SWNodeInfo VALUE_OBJ_CLASS_SPEC {
193 public:
194 int _alignment; // memory alignment for a node
195 int _depth; // Max expression (DAG) depth from block start
196 const Type* _velt_type; // vector element type
197 Node_List* _my_pack; // pack containing this node
198
199 SWNodeInfo() : _alignment(-1), _depth(0), _velt_type(NULL), _my_pack(NULL) {}
200 static const SWNodeInfo initial;
201 };
202
203 // -----------------------------SuperWord---------------------------------
204 // Transforms scalar operations into packed (superword) operations.
205 class SuperWord : public ResourceObj {
206 private:
207 PhaseIdealLoop* _phase;
208 Arena* _arena;
209 PhaseIterGVN &_igvn;
210
211 enum consts { top_align = -1, bottom_align = -666 };
212
213 GrowableArray<Node_List*> _packset; // Packs for the current block
214
215 GrowableArray<int> _bb_idx; // Map from Node _idx to index within block
216
217 GrowableArray<Node*> _block; // Nodes in current block
218 GrowableArray<Node*> _data_entry; // Nodes with all inputs from outside
219 GrowableArray<Node*> _mem_slice_head; // Memory slice head nodes
220 GrowableArray<Node*> _mem_slice_tail; // Memory slice tail nodes
221
222 GrowableArray<SWNodeInfo> _node_info; // Info needed per node
223
224 MemNode* _align_to_ref; // Memory reference that pre-loop will align to
225
226 GrowableArray<OrderedPair> _disjoint_ptrs; // runtime disambiguated pointer pairs
227
228 DepGraph _dg; // Dependence graph
229
230 // Scratch pads
231 VectorSet _visited; // Visited set
232 VectorSet _post_visited; // Post-visited set
233 Node_Stack _n_idx_list; // List of (node,index) pairs
234 GrowableArray<Node*> _nlist; // List of nodes
235 GrowableArray<Node*> _stk; // Stack of nodes
236
237 public:
238 SuperWord(PhaseIdealLoop* phase);
239
240 void transform_loop(IdealLoopTree* lpt);
241
242 // Accessors for SWPointer
243 PhaseIdealLoop* phase() { return _phase; }
244 IdealLoopTree* lpt() { return _lpt; }
245 PhiNode* iv() { return _iv; }
246
247 private:
248 IdealLoopTree* _lpt; // Current loop tree node
249 LoopNode* _lp; // Current LoopNode
250 Node* _bb; // Current basic block
251 PhiNode* _iv; // Induction var
252
253 // Accessors
254 Arena* arena() { return _arena; }
255
256 Node* bb() { return _bb; }
257 void set_bb(Node* bb) { _bb = bb; }
258
259 void set_lpt(IdealLoopTree* lpt) { _lpt = lpt; }
260
261 LoopNode* lp() { return _lp; }
262 void set_lp(LoopNode* lp) { _lp = lp;
263 _iv = lp->as_CountedLoop()->phi()->as_Phi(); }
264 int iv_stride() { return lp()->as_CountedLoop()->stride_con(); }
265
266 int vector_width(Node* n) {
267 BasicType bt = velt_basic_type(n);
268 return MIN2(ABS(iv_stride()), Matcher::max_vector_size(bt));
269 }
270 int vector_width_in_bytes(Node* n) {
271 BasicType bt = velt_basic_type(n);
272 return vector_width(n)*type2aelembytes(bt);
273 }
274 MemNode* align_to_ref() { return _align_to_ref; }
275 void set_align_to_ref(MemNode* m) { _align_to_ref = m; }
276
277 Node* ctrl(Node* n) const { return _phase->has_ctrl(n) ? _phase->get_ctrl(n) : n; }
278
279 // block accessors
280 bool in_bb(Node* n) { return n != NULL && n->outcnt() > 0 && ctrl(n) == _bb; }
281 int bb_idx(Node* n) { assert(in_bb(n), "must be"); return _bb_idx.at(n->_idx); }
282 void set_bb_idx(Node* n, int i) { _bb_idx.at_put_grow(n->_idx, i); }
283
284 // visited set accessors
285 void visited_clear() { _visited.Clear(); }
286 void visited_set(Node* n) { return _visited.set(bb_idx(n)); }
287 int visited_test(Node* n) { return _visited.test(bb_idx(n)); }
288 int visited_test_set(Node* n) { return _visited.test_set(bb_idx(n)); }
289 void post_visited_clear() { _post_visited.Clear(); }
290 void post_visited_set(Node* n) { return _post_visited.set(bb_idx(n)); }
291 int post_visited_test(Node* n) { return _post_visited.test(bb_idx(n)); }
292
293 // Ensure node_info contains element "i"
294 void grow_node_info(int i) { if (i >= _node_info.length()) _node_info.at_put_grow(i, SWNodeInfo::initial); }
295
296 // memory alignment for a node
297 int alignment(Node* n) { return _node_info.adr_at(bb_idx(n))->_alignment; }
298 void set_alignment(Node* n, int a) { int i = bb_idx(n); grow_node_info(i); _node_info.adr_at(i)->_alignment = a; }
299
300 // Max expression (DAG) depth from beginning of the block for each node
301 int depth(Node* n) { return _node_info.adr_at(bb_idx(n))->_depth; }
302 void set_depth(Node* n, int d) { int i = bb_idx(n); grow_node_info(i); _node_info.adr_at(i)->_depth = d; }
303
304 // vector element type
305 const Type* velt_type(Node* n) { return _node_info.adr_at(bb_idx(n))->_velt_type; }
306 BasicType velt_basic_type(Node* n) { return velt_type(n)->array_element_basic_type(); }
307 void set_velt_type(Node* n, const Type* t) { int i = bb_idx(n); grow_node_info(i); _node_info.adr_at(i)->_velt_type = t; }
308 bool same_velt_type(Node* n1, Node* n2);
309
310 // my_pack
311 Node_List* my_pack(Node* n) { return !in_bb(n) ? NULL : _node_info.adr_at(bb_idx(n))->_my_pack; }
312 void set_my_pack(Node* n, Node_List* p) { int i = bb_idx(n); grow_node_info(i); _node_info.adr_at(i)->_my_pack = p; }
313
314 // methods
315
316 // Extract the superword level parallelism
317 void SLP_extract();
318 // Find the adjacent memory references and create pack pairs for them.
319 void find_adjacent_refs();
320 // Find a memory reference to align the loop induction variable to.
321 MemNode* find_align_to_ref(Node_List &memops);
322 // Calculate loop's iv adjustment for this memory ops.
323 int get_iv_adjustment(MemNode* mem);
324 // Can the preloop align the reference to position zero in the vector?
325 bool ref_is_alignable(SWPointer& p);
326 // Construct dependency graph.
327 void dependence_graph();
328 // Return a memory slice (node list) in predecessor order starting at "start"
329 void mem_slice_preds(Node* start, Node* stop, GrowableArray<Node*> &preds);
330 // Can s1 and s2 be in a pack with s1 immediately preceding s2 and s1 aligned at "align"
331 bool stmts_can_pack(Node* s1, Node* s2, int align);
332 // Does s exist in a pack at position pos?
333 bool exists_at(Node* s, uint pos);
334 // Is s1 immediately before s2 in memory?
335 bool are_adjacent_refs(Node* s1, Node* s2);
336 // Are s1 and s2 similar?
337 bool isomorphic(Node* s1, Node* s2);
338 // Is there no data path from s1 to s2 or s2 to s1?
339 bool independent(Node* s1, Node* s2);
340 // Helper for independent
341 bool independent_path(Node* shallow, Node* deep, uint dp=0);
342 void set_alignment(Node* s1, Node* s2, int align);
343 int data_size(Node* s);
344 // Extend packset by following use->def and def->use links from pack members.
345 void extend_packlist();
346 // Extend the packset by visiting operand definitions of nodes in pack p
347 bool follow_use_defs(Node_List* p);
348 // Extend the packset by visiting uses of nodes in pack p
349 bool follow_def_uses(Node_List* p);
350 // Estimate the savings from executing s1 and s2 as a pack
351 int est_savings(Node* s1, Node* s2);
352 int adjacent_profit(Node* s1, Node* s2);
353 int pack_cost(int ct);
354 int unpack_cost(int ct);
355 // Combine packs A and B with A.last == B.first into A.first..,A.last,B.second,..B.last
356 void combine_packs();
357 // Construct the map from nodes to packs.
358 void construct_my_pack_map();
359 // Remove packs that are not implemented or not profitable.
360 void filter_packs();
361 // Adjust the memory graph for the packed operations
362 void schedule();
363 // Remove "current" from its current position in the memory graph and insert
364 // it after the appropriate insert points (lip or uip);
365 void remove_and_insert(MemNode *current, MemNode *prev, MemNode *lip, Node *uip, Unique_Node_List &schd_before);
366 // Within a store pack, schedule stores together by moving out the sandwiched memory ops according
367 // to dependence info; and within a load pack, move loads down to the last executed load.
368 void co_locate_pack(Node_List* p);
369 // Convert packs into vector node operations
370 void output();
371 // Create a vector operand for the nodes in pack p for operand: in(opd_idx)
372 Node* vector_opd(Node_List* p, int opd_idx);
373 // Can code be generated for pack p?
374 bool implemented(Node_List* p);
375 // For pack p, are all operands and all uses (with in the block) vector?
376 bool profitable(Node_List* p);
377 // If a use of pack p is not a vector use, then replace the use with an extract operation.
378 void insert_extracts(Node_List* p);
379 // Is use->in(u_idx) a vector use?
380 bool is_vector_use(Node* use, int u_idx);
381 // Construct reverse postorder list of block members
382 bool construct_bb();
383 // Initialize per node info
384 void initialize_bb();
385 // Insert n into block after pos
386 void bb_insert_after(Node* n, int pos);
387 // Compute max depth for expressions from beginning of block
388 void compute_max_depth();
389 // Compute necessary vector element type for expressions
390 void compute_vector_element_type();
391 // Are s1 and s2 in a pack pair and ordered as s1,s2?
392 bool in_packset(Node* s1, Node* s2);
393 // Is s in pack p?
394 Node_List* in_pack(Node* s, Node_List* p);
395 // Remove the pack at position pos in the packset
396 void remove_pack_at(int pos);
397 // Return the node executed first in pack p.
398 Node* executed_first(Node_List* p);
399 // Return the node executed last in pack p.
400 Node* executed_last(Node_List* p);
401 // Alignment within a vector memory reference
402 int memory_alignment(MemNode* s, int iv_adjust);
403 // (Start, end] half-open range defining which operands are vector
404 void vector_opd_range(Node* n, uint* start, uint* end);
405 // Smallest type containing range of values
406 const Type* container_type(Node* n);
407 // Adjust pre-loop limit so that in main loop, a load/store reference
408 // to align_to_ref will be a position zero in the vector.
409 void align_initial_loop_index(MemNode* align_to_ref);
410 // Find pre loop end from main loop. Returns null if none.
411 CountedLoopEndNode* get_pre_loop_end(CountedLoopNode *cl);
412 // Is the use of d1 in u1 at the same operand position as d2 in u2?
413 bool opnd_positions_match(Node* d1, Node* u1, Node* d2, Node* u2);
414 void init();
415
416 // print methods
417 void print_packset();
418 void print_pack(Node_List* p);
419 void print_bb();
420 void print_stmt(Node* s);
421 char* blank(uint depth);
422 };
423
424
425 //------------------------------SWPointer---------------------------
426 // Information about an address for dependence checking and vector alignment
427 class SWPointer VALUE_OBJ_CLASS_SPEC {
428 protected:
429 MemNode* _mem; // My memory reference node
430 SuperWord* _slp; // SuperWord class
431
432 Node* _base; // NULL if unsafe nonheap reference
433 Node* _adr; // address pointer
434 jint _scale; // multipler for iv (in bytes), 0 if no loop iv
435 jint _offset; // constant offset (in bytes)
436 Node* _invar; // invariant offset (in bytes), NULL if none
437 bool _negate_invar; // if true then use: (0 - _invar)
438
439 PhaseIdealLoop* phase() { return _slp->phase(); }
440 IdealLoopTree* lpt() { return _slp->lpt(); }
441 PhiNode* iv() { return _slp->iv(); } // Induction var
442
443 bool invariant(Node* n) {
444 Node *n_c = phase()->get_ctrl(n);
445 return !lpt()->is_member(phase()->get_loop(n_c));
446 }
447
448 // Match: k*iv + offset
449 bool scaled_iv_plus_offset(Node* n);
450 // Match: k*iv where k is a constant that's not zero
451 bool scaled_iv(Node* n);
452 // Match: offset is (k [+/- invariant])
453 bool offset_plus_k(Node* n, bool negate = false);
454
455 public:
456 enum CMP {
457 Less = 1,
458 Greater = 2,
459 Equal = 4,
460 NotEqual = (Less | Greater),
461 NotComparable = (Less | Greater | Equal)
462 };
463
464 SWPointer(MemNode* mem, SuperWord* slp);
465 // Following is used to create a temporary object during
466 // the pattern match of an address expression.
467 SWPointer(SWPointer* p);
468
469 bool valid() { return _adr != NULL; }
470 bool has_iv() { return _scale != 0; }
471
472 Node* base() { return _base; }
473 Node* adr() { return _adr; }
474 MemNode* mem() { return _mem; }
475 int scale_in_bytes() { return _scale; }
476 Node* invar() { return _invar; }
477 bool negate_invar() { return _negate_invar; }
478 int offset_in_bytes() { return _offset; }
479 int memory_size() { return _mem->memory_size(); }
480
481 // Comparable?
482 int cmp(SWPointer& q) {
483 if (valid() && q.valid() &&
484 (_adr == q._adr || _base == _adr && q._base == q._adr) &&
485 _scale == q._scale &&
486 _invar == q._invar &&
487 _negate_invar == q._negate_invar) {
488 bool overlap = q._offset < _offset + memory_size() &&
489 _offset < q._offset + q.memory_size();
490 return overlap ? Equal : (_offset < q._offset ? Less : Greater);
491 } else {
492 return NotComparable;
493 }
494 }
495
496 bool not_equal(SWPointer& q) { return not_equal(cmp(q)); }
497 bool equal(SWPointer& q) { return equal(cmp(q)); }
498 bool comparable(SWPointer& q) { return comparable(cmp(q)); }
499 static bool not_equal(int cmp) { return cmp <= NotEqual; }
500 static bool equal(int cmp) { return cmp == Equal; }
501 static bool comparable(int cmp) { return cmp < NotComparable; }
502
503 void print();
504 };
505
506
507 //------------------------------OrderedPair---------------------------
508 // Ordered pair of Node*.
509 class OrderedPair VALUE_OBJ_CLASS_SPEC {
510 protected:
511 Node* _p1;
512 Node* _p2;
513 public:
514 OrderedPair() : _p1(NULL), _p2(NULL) {}
515 OrderedPair(Node* p1, Node* p2) {
516 if (p1->_idx < p2->_idx) {
517 _p1 = p1; _p2 = p2;
518 } else {
519 _p1 = p2; _p2 = p1;
520 }
521 }
522
523 bool operator==(const OrderedPair &rhs) {
524 return _p1 == rhs._p1 && _p2 == rhs._p2;
525 }
526 void print() { tty->print(" (%d, %d)", _p1->_idx, _p2->_idx); }
527
528 static const OrderedPair initial;
529 };
530
531 #endif // SHARE_VM_OPTO_SUPERWORD_HPP