3 * File name: ir/opt/opt_osr.
4 * Purpose: Operator Strength Reduction, based on
5 * Keith D. Cooper, L. Taylor Simpson, Christopher A. Vick
10 * Copyright: (c) 2006 Universität Karlsruhe
11 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
44 /** The debug handle. */
45 DEBUG_ONLY(static firm_dbg_module_t *dbg;)
49 ir_node *head; /**< the head of the list */
53 typedef struct node_entry {
54 unsigned DFSnum; /**< the DFS number of this node */
55 unsigned low; /**< the low number of this node */
56 ir_node *header; /**< the header of this node */
57 int in_stack; /**< flag, set if the node is on the stack */
58 ir_node *next; /**< link to the next node the the same scc */
59 scc *pscc; /**< the scc of this node */
60 unsigned POnum; /**< the post order number for blocks */
63 /** The environment. */
64 typedef struct iv_env {
65 struct obstack obst; /**< an obstack for allocations */
66 ir_node **stack; /**< the node stack */
67 int tos; /**< tos index */
68 unsigned nextDFSnum; /**< the current DFS number */
69 unsigned POnum; /**< current post order number */
70 set *quad_map; /**< a map from (op, iv, rc) to node */
71 set *lftr_edges; /**< the set of lftr edges */
72 unsigned replaced; /**< number of replaced ops */
73 unsigned lftr_replaced; /**< number of applied linear function test replacements */
74 unsigned flags; /**< additional flags */
78 * An entry in the (op, node, node) -> node map.
80 typedef struct quad_t {
81 opcode code; /**< the opcode of the reduced operation */
82 ir_node *op1; /**< the first operand the reduced operation */
83 ir_node *op2; /**< the second operand of the reduced operation */
85 ir_node *res; /**< the reduced operation */
91 typedef struct LFTR_edge {
92 ir_node *src; /**< the source node */
93 ir_node *dst; /**< the destination node */
94 opcode code; /**< the opcode that must be applied */
95 ir_node *rc; /**< the region const that must be applied */
99 static ir_node *reduce(ir_node *orig, ir_node *iv, ir_node *rc, iv_env *env);
102 * Compare two LFTR edges.
104 static int LFTR_cmp(const void *e1, const void *e2, size_t size) {
105 const LFTR_edge *l1 = e1;
106 const LFTR_edge *l2 = e2;
108 return l1->src != l2->src;
114 static LFTR_edge *LFTR_find(ir_node *src, iv_env *env) {
119 return set_find(env->lftr_edges, &key, sizeof(key), HASH_PTR(src));
125 static void LFTR_add(ir_node *src, ir_node *dst, opcode code, ir_node *rc, iv_env *env) {
134 * There might be more than one edge here. This is rather bad
135 * because we currently store only one.
137 // assert(LFTR_find(src, env) == NULL);
138 set_insert(env->lftr_edges, &key, sizeof(key), HASH_PTR(src));
142 * Gets the node_entry of a node
144 static node_entry *get_irn_ne(ir_node *irn, iv_env *env) {
145 node_entry *e = get_irn_link(irn);
148 e = obstack_alloc(&env->obst, sizeof(*e));
149 memset(e, 0, sizeof(*e));
150 set_irn_link(irn, e);
156 * Check if irn is an IV.
158 * @param irn the node to check
159 * @param env the environment
161 * @returns the header if it is one, NULL else
163 static ir_node *is_iv(ir_node *irn, iv_env *env) {
164 return get_irn_ne(irn, env)->header;
168 * Check if irn is a region constant.
169 * The block or irn must strictly dominate the header block.
171 * @param irn the node to check
172 * @param header_block the header block of the induction variable
174 static int is_rc(ir_node *irn, ir_node *header_block) {
175 ir_node *block = get_nodes_block(irn);
177 return (block != header_block) && block_dominates(block, header_block);
181 * Set compare function for the quad set.
183 static int quad_cmp(const void *e1, const void *e2, size_t size) {
184 const quad_t *c1 = e1;
185 const quad_t *c2 = e2;
187 return c1->code != c2->code || c1->op1 != c2->op1 || c1->op2 != c2->op2;
191 * Check if an reduced operation was already calculated.
193 * @param code the opcode of the operation
194 * @param op1 the first operand of the operation
195 * @param op2 the second operand of the operation
196 * @param env the environment
198 * @return the already reduced node or NULL if this operation is not yet reduced
200 static ir_node *search(opcode code, ir_node *op1, ir_node *op2, iv_env *env) {
207 entry = set_find(env->quad_map, &key, sizeof(key),
208 (code * 9) ^ HASH_PTR(op1) ^HASH_PTR(op2));
215 * Add an reduced operation.
217 * @param code the opcode of the operation
218 * @param op1 the first operand of the operation
219 * @param op2 the second operand of the operation
220 * @param result the result of the reduced operation
221 * @param env the environment
223 static void add(opcode code, ir_node *op1, ir_node *op2, ir_node *result, iv_env *env) {
231 set_insert(env->quad_map, &key, sizeof(key),
232 (code * 9) ^ HASH_PTR(op1) ^HASH_PTR(op2));
236 * Find a location where to place a bin-op whose operands are in
239 * @param block1 the block of the first operand
240 * @param block2 the block of the second operand
242 * Note that we know here that such a place must exists. Moreover, this means
243 * that either block1 dominates block2 or vice versa. So, just return
246 static ir_node *find_location(ir_node *block1, ir_node *block2) {
247 if (block_dominates(block1, block2))
249 assert(block_dominates(block2, block1));
254 * Create a node that executes an op1 code op1 operation.
256 * @param code the opcode to execute
257 * @param db debug info to add to the new node
258 * @param op1 the first operand
259 * @param op2 the second operand
260 * @param mode the mode of the new operation
262 * @return the newly created node
264 static ir_node *do_apply(opcode code, dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode) {
265 ir_graph *irg = current_ir_graph;
267 ir_node *block = find_location(get_nodes_block(op1), get_nodes_block(op2));
271 result = new_rd_Mul(db, irg, block, op1, op2, mode);
274 result = new_rd_Add(db, irg, block, op1, op2, mode);
277 result = new_rd_Sub(db, irg, block, op1, op2, mode);
287 * The Apply operation.
289 * @param orig the node that represent the original operation and determines
290 * the opcode, debug-info and mode of a newly created one
291 * @param op1 the first operand
292 * @param op2 the second operand
293 * @param env the environment
295 * @return the newly created node
297 static ir_node *apply(ir_node *orig, ir_node *op1, ir_node *op2, iv_env *env) {
298 opcode code = get_irn_opcode(orig);
299 ir_node *result = search(code, op1, op2, env);
302 dbg_info *db = get_irn_dbg_info(orig);
303 ir_node *op1_header = get_irn_ne(op1, env)->header;
304 ir_node *op2_header = get_irn_ne(op2, env)->header;
306 if (op1_header != NULL && is_rc(op2, op1_header)) {
307 result = reduce(orig, op1, op2, env);
309 else if (op2_header != NULL && is_rc(op1, op2_header)) {
310 result = reduce(orig, op2, op1, env);
313 result = do_apply(code, db, op1, op2, get_irn_mode(orig));
314 get_irn_ne(result, env)->header = NULL; }
320 * The Reduce operation.
322 * @param orig the node that represent the original operation and determines
323 * the opcode, debug-info and mode of a newly created one
324 * @param iv the induction variable
325 * @param rc the region constant
326 * @param env the environment
328 * @return the reduced node
330 static ir_node *reduce(ir_node *orig, ir_node *iv, ir_node *rc, iv_env *env) {
331 opcode code = get_irn_opcode(orig);
332 ir_node *result = search(code, iv, rc, env);
335 node_entry *e, *iv_e;
337 ir_mode *mode = get_irn_mode(orig);
339 result = exact_copy(iv);
341 /* Beware: we must always create a new nduction variable with the same mode
342 as the node we are replacing. Espicially this means the mode might be changed
343 from P to I and back. This is always possible, because we have only Phi, Add
345 set_irn_mode(result, mode);
346 add(code, iv, rc, result, env);
347 DB((dbg, LEVEL_3, " Created new %+F for %+F (%s %+F)\n", result, iv,
348 get_irn_opname(orig), rc));
350 iv_e = get_irn_ne(iv, env);
351 e = get_irn_ne(result, env);
352 e->header = iv_e->header;
354 /* create the LFTR edge */
355 LFTR_add(iv, result, code, rc, env);
357 n = get_irn_arity(result);
358 for (i = 0; i < n; ++i) {
359 ir_node *o = get_irn_n(result, i);
361 e = get_irn_ne(o, env);
362 if (e->header == iv_e->header)
363 o = reduce(orig, o, rc, env);
364 else if (is_Phi(result))
365 o = apply(orig, o, rc, env);
368 o = apply(orig, o, rc, env);
370 set_irn_n(result, i, o);
374 DB((dbg, LEVEL_3, " Already Created %+F for %+F (%s %+F)\n", result, iv,
375 get_irn_opname(orig), rc));
381 * The Replace operation.
383 * @param irn the node that will be replaced
384 * @param iv the induction variable
385 * @param rc the region constant
386 * @param env the environment
388 static int replace(ir_node *irn, ir_node *iv, ir_node *rc, iv_env *env) {
390 ir_loop *iv_loop = get_irn_loop(get_nodes_block(iv));
391 ir_loop *irn_loop = get_irn_loop(get_nodes_block(irn));
393 /* only replace nodes that are in the same (or deeper loops) */
394 if (get_loop_depth(irn_loop) >= get_loop_depth(iv_loop)) {
395 DB((dbg, LEVEL_2, " Replacing %+F\n", irn));
397 result = reduce(irn, iv, rc, env);
399 node_entry *e, *iv_e;
401 hook_strength_red(current_ir_graph, irn);
402 exchange(irn, result);
403 e = get_irn_ne(result, env);
404 iv_e = get_irn_ne(iv, env);
405 e->header = iv_e->header;
414 * Check if a node can be replaced (+, -, *).
416 * @param irn the node to check
417 * @param env the environment
419 * @return non-zero if irn should be Replace'd
421 static int check_replace(ir_node *irn, iv_env *env) {
422 ir_node *left, *right, *iv, *rc;
423 ir_op *op = get_irn_op(irn);
424 opcode code = get_op_code(op);
433 left = get_binop_left(irn);
434 right = get_binop_right(irn);
436 liv = is_iv(left, env);
437 riv = is_iv(right, env);
438 if (liv && is_rc(right, liv)) {
439 iv = left; rc = right;
441 else if (riv && is_op_commutative(op) &&
443 iv = right; rc = left;
447 return replace(irn, iv, rc, env);
456 * Check which SCC's are induction variables.
459 * @param env the environment
461 static void classify_iv(scc *pscc, iv_env *env) {
462 ir_node *irn, *next, *header = NULL;
463 node_entry *b, *h = NULL;
464 int j, only_phi, num_outside;
467 /* find the header block for this scc */
468 for (irn = pscc->head; irn; irn = next) {
469 node_entry *e = get_irn_link(irn);
470 ir_node *block = get_nodes_block(irn);
473 b = get_irn_ne(block, env);
476 if (h->POnum < b->POnum) {
487 /* check if this scc contains only Phi, Add or Sub nodes */
491 for (irn = pscc->head; irn; irn = next) {
492 node_entry *e = get_irn_ne(irn, env);
495 switch (get_irn_opcode(irn)) {
501 for (j = get_irn_arity(irn) - 1; j >= 0; --j) {
502 ir_node *pred = get_irn_n(irn, j);
503 node_entry *pe = get_irn_ne(pred, env);
505 if (pe->pscc != e->pscc) {
506 /* not in the same SCC, must be a region const */
507 if (! is_rc(pred, header)) {
508 /* not an induction variable */
515 else if (out_rc != pred)
521 /* not an induction variable */
525 /* found an induction variable */
526 DB((dbg, LEVEL_2, " Found an induction variable:\n "));
527 if (only_phi && num_outside == 1) {
528 DB((dbg, LEVEL_2, " Found an USELESS Phi cycle:\n "));
531 /* set the header for every node in this scc */
532 for (irn = pscc->head; irn; irn = next) {
533 node_entry *e = get_irn_ne(irn, env);
536 DB((dbg, LEVEL_2, " %+F,", irn));
538 DB((dbg, LEVEL_2, "\n"));
542 for (irn = pscc->head; irn; irn = next) {
543 node_entry *e = get_irn_ne(irn, env);
546 if (! check_replace(irn, env))
554 * @param pscc the SCC
555 * @param env the environment
557 static void process_scc(scc *pscc, iv_env *env) {
558 ir_node *head = pscc->head;
559 node_entry *e = get_irn_link(head);
565 DB((dbg, LEVEL_4, " SCC at %p:\n ", pscc));
566 for (irn = pscc->head; irn; irn = next) {
567 node_entry *e = get_irn_link(irn);
571 DB((dbg, LEVEL_4, " %+F,", irn));
573 DB((dbg, LEVEL_4, "\n"));
577 if (e->next == NULL) {
578 /* this SCC has only a single member */
579 check_replace(head, env);
582 classify_iv(pscc, env);
587 * Push a node onto the stack.
589 * @param env the environment
590 * @param n the node to push
592 static void push(iv_env *env, ir_node *n) {
595 if (env->tos == ARR_LEN(env->stack)) {
596 int nlen = ARR_LEN(env->stack) * 2;
597 ARR_RESIZE(ir_node *, env->stack, nlen);
599 env->stack[env->tos++] = n;
600 e = get_irn_ne(n, env);
605 * pop a node from the stack
607 * @param env the environment
609 * @return The topmost node
611 static ir_node *pop(iv_env *env)
613 ir_node *n = env->stack[--env->tos];
614 node_entry *e = get_irn_ne(n, env);
621 * Do Tarjan's SCC algorithm and drive OSR.
623 * @param irn start at this node
624 * @param env the environment
626 static void dfs(ir_node *irn, iv_env *env)
629 node_entry *node = get_irn_ne(irn, env);
631 mark_irn_visited(irn);
633 /* do not put blocks into the scc */
635 n = get_irn_arity(irn);
636 for (i = 0; i < n; ++i) {
637 ir_node *pred = get_irn_n(irn, i);
639 if (irn_not_visited(pred))
644 ir_node *block = get_nodes_block(irn);
646 node->DFSnum = env->nextDFSnum++;
647 node->low = node->DFSnum;
650 /* handle the block */
651 if (irn_not_visited(block))
654 n = get_irn_arity(irn);
655 for (i = 0; i < n; ++i) {
656 ir_node *pred = get_irn_n(irn, i);
657 node_entry *o = get_irn_ne(pred, env);
659 if (irn_not_visited(pred)) {
661 node->low = MIN(node->low, o->low);
663 if (o->DFSnum < node->DFSnum && o->in_stack)
664 node->low = MIN(o->DFSnum, node->low);
666 if (node->low == node->DFSnum) {
667 scc *pscc = obstack_alloc(&env->obst, sizeof(*pscc));
675 e = get_irn_ne(x, env);
677 e->next = pscc->head;
681 process_scc(pscc, env);
687 * Do the DFS by starting at the End node of a graph.
689 * @param irg the graph to process
690 * @param env the environment
692 static void do_dfs(ir_graph *irg, iv_env *env) {
693 ir_graph *rem = current_ir_graph;
694 ir_node *end = get_irg_end(irg);
697 current_ir_graph = irg;
698 inc_irg_visited(irg);
700 /* visit all visible nodes */
703 /* visit the keep-alives */
704 n = get_End_n_keepalives(end);
705 for (i = 0; i < n; ++i) {
706 ir_node *ka = get_End_keepalive(end, i);
708 if (irn_not_visited(ka))
712 current_ir_graph = rem;
716 * Post-block-walker: assign the post-order number.
718 static void assign_po(ir_node *block, void *ctx) {
720 node_entry *e = get_irn_ne(block, env);
722 e->POnum = env->POnum++;
726 * Follows the LFTR edges and return the last node in the chain.
728 * @param irn the node that should be followed
729 * @param env the IV environment
732 * In the current implementation only the last edge is stored, so
733 * only one chain exists. That's why we might miss some opportunities.
735 static ir_node *followEdges(ir_node *irn, iv_env *env) {
737 LFTR_edge *e = LFTR_find(irn, env);
746 * Apply one LFTR edge operation.
747 * Return NULL if the transformation cannot be done safely without
750 * @param rc the IV node that should be translated
751 * @param e the LFTR edge
752 * @param env the IV environment
754 * @return the translated region constant or NULL
755 * if the translation was not possible
758 * In the current implementation only the last edge is stored, so
759 * only one chain exists. That's why we might miss some opportunities.
761 static ir_node *applyOneEdge(ir_node *rc, LFTR_edge *e, iv_env *env) {
762 if (env->flags & osr_flag_lftr_with_ov_check) {
763 tarval *tv_l, *tv_r, *tv;
764 tarval_int_overflow_mode_t ovmode;
766 /* overflow can only be decided for Consts */
767 if (! is_Const(e->rc)) {
768 DB((dbg, LEVEL_4, " = UNKNOWN (%+F)", e->rc));
772 tv_l = get_Const_tarval(rc);
773 tv_r = get_Const_tarval(e->rc);
775 ovmode = tarval_get_integer_overflow_mode();
776 tarval_set_integer_overflow_mode(TV_OVERFLOW_BAD);
780 tv = tarval_mul(tv_l, tv_r);
781 DB((dbg, LEVEL_4, " * %+F", tv_r));
784 tv = tarval_add(tv_l, tv_r);
785 DB((dbg, LEVEL_4, " + %+F", tv_r));
788 tv = tarval_sub(tv_l, tv_r);
789 DB((dbg, LEVEL_4, " - %+F", tv_r));
795 tarval_set_integer_overflow_mode(ovmode);
797 if (tv == tarval_bad) {
798 DB((dbg, LEVEL_4, " = OVERFLOW"));
801 return new_r_Const(current_ir_graph, get_irn_n(rc, -1), get_tarval_mode(tv), tv);
803 return do_apply(e->code, NULL, rc, e->rc, get_irn_mode(rc));
807 * Applies the operations represented by the LFTR edges to a
808 * region constant and returns the value.
809 * Return NULL if the transformation cannot be done safely without
812 * @param iv the IV node that starts the LFTR edge chain
813 * @param rc the region constant that should be translated
814 * @param env the IV environment
816 * @return the translated region constant or NULL
817 * if the translation was not possible
819 static ir_node *applyEdges(ir_node *iv, ir_node *rc, iv_env *env) {
822 if (env->flags & osr_flag_lftr_with_ov_check) {
823 /* overflow can only be decided for Consts */
824 if (! is_Const(rc)) {
825 DB((dbg, LEVEL_4, " = UNKNOWN (%+F)\n", rc));
828 DB((dbg, LEVEL_4, "%+F", get_Const_tarval(rc)));
831 for (irn = iv; rc;) {
832 LFTR_edge *e = LFTR_find(irn, env);
834 rc = applyOneEdge(rc, e, env);
840 DB((dbg, LEVEL_3, "\n"));
845 * Walker, finds Cmp(iv, rc) or Cmp(rc, iv)
846 * and tries to optimize them.
848 static void do_lftr(ir_node *cmp, void *ctx) {
850 ir_node *left, *right, *liv, *riv;
852 ir_node *nleft = NULL, *nright = NULL;
854 if (get_irn_op(cmp) != op_Cmp)
857 left = get_Cmp_left(cmp);
858 right = get_Cmp_right(cmp);
860 liv = is_iv(left, env);
861 riv = is_iv(right, env);
862 if (liv && is_rc(right, liv)) {
863 iv = left; rc = right;
865 nright = applyEdges(iv, rc, env);
866 if (nright && nright != rc) {
867 nleft = followEdges(iv, env);
870 else if (riv && is_rc(left, riv)) {
871 iv = right; rc = left;
873 nleft = applyEdges(iv, rc, env);
874 if (nleft && nleft != rc) {
875 nright = followEdges(iv, env);
879 if (nleft && nright) {
880 DB((dbg, LEVEL_2, " LFTR for %+F\n", cmp));
881 set_Cmp_left(cmp, nleft);
882 set_Cmp_right(cmp, nright);
883 ++env->lftr_replaced;
888 * do linear function test replacement.
890 * @param irg the graph that should be optimized
891 * @param env the IV environment
893 static void lftr(ir_graph *irg, iv_env *env) {
894 irg_walk_graph(irg, NULL, do_lftr, env);
898 * Pre-walker: set all node links to NULL and fix the
899 * block of Proj nodes.
901 static void clear_and_fix(ir_node *irn, void *env)
903 set_irn_link(irn, NULL);
906 ir_node *pred = get_Proj_pred(irn);
907 set_irn_n(irn, -1, get_irn_n(pred, -1));
911 /* Performs Operator Strength Reduction for the passed graph. */
912 void opt_osr(ir_graph *irg, unsigned flags) {
915 if (! get_opt_strength_red())
918 FIRM_DBG_REGISTER(dbg, "firm.opt.osr");
919 // firm_dbg_set_mask(dbg, SET_LEVEL_3);
921 DB((dbg, LEVEL_1, "Doing Operator Strength Reduction for %+F\n", irg));
923 obstack_init(&env.obst);
924 env.stack = NEW_ARR_F(ir_node *, 128);
928 env.quad_map = new_set(quad_cmp, 64);
929 env.lftr_edges = new_set(LFTR_cmp, 64);
931 env.lftr_replaced = 0;
934 /* we need control flow loop information to decide whether
935 * we should do a replacement or not. */
936 construct_cf_backedges(irg);
938 /* Clear all links and move Proj nodes into the
939 the same block as it's predecessors.
940 This can improve the placement of new nodes.
942 irg_walk_graph(irg, NULL, clear_and_fix, NULL);
944 /* we need dominance */
946 assure_irg_outs(irg);
948 /* calculate the post order number for blocks. */
949 irg_out_block_walk(get_irg_start_block(irg), NULL, assign_po, &env);
951 /* calculate the SCC's and drive OSR. */
955 /* try linear function test replacements */
958 set_irg_outs_inconsistent(irg);
959 /* cfg loop still valid */
961 DB((dbg, LEVEL_1, "Replacements: %u + %u (lftr)\n\n", env.replaced, env.lftr_replaced));
964 del_set(env.lftr_edges);
965 del_set(env.quad_map);
966 DEL_ARR_F(env.stack);
967 obstack_free(&env.obst, NULL);