2 * Copyright (C) 1995-2009 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * @brief analyze graph to provide value range information
32 #include "irgraph_t.h"
40 #include "irphase_t.h"
44 static void *VISITED = &v;
50 static int vrp_update_node(ir_node *node)
52 tarval *new_bits_set = get_tarval_bad();
53 tarval *new_bits_not_set = get_tarval_bad();
54 tarval *new_range_bottom = get_tarval_bad();
55 tarval *new_range_top = get_tarval_bad();
56 enum range_types new_range_type = VRP_UNDEFINED;
57 int something_changed = 0;
61 if (!mode_is_int(get_irn_mode(node))) {
62 return 0; /* we don't optimize for non-int-nodes*/
65 phase = get_irg_phase(get_irn_irg(node), PHASE_VRP);
67 ir_printf("update_vrp for %d called\n", get_irn_node_nr(node));
68 vrp = phase_get_or_set_irn_data(phase, node);
70 /* TODO: Check if all predecessors have valid VRP information*/
74 switch (get_irn_opcode(node)) {
76 tarval *tv = get_Const_tarval(node);
78 new_bits_not_set = tarval_not(tv);
79 new_range_bottom = tv;
81 new_range_type = VRP_RANGE;
86 vrp_attr *vrp_left, *vrp_right;
87 ir_node *left, *right;
89 left = get_And_left(node);
90 right = get_And_right(node);
91 vrp_left = phase_get_or_set_irn_data(phase, left);
92 vrp_right = phase_get_or_set_irn_data(phase, right);
93 new_bits_set = tarval_and(vrp_left->bits_set, vrp_right->bits_set);
94 new_bits_not_set = tarval_or(vrp_left->bits_not_set, vrp_right->bits_not_set);
100 vrp_attr *vrp_left, *vrp_right;
101 vrp_left = phase_get_or_set_irn_data(phase, get_Add_left(node));
102 vrp_right = phase_get_or_set_irn_data(phase, get_Add_right(node));
103 int overflow_top, overflow_bottom;
104 tarval *new_top, *new_bottom;
106 if (vrp_left->range_type == VRP_UNDEFINED || vrp_right->range_type ==
107 VRP_UNDEFINED || vrp_left->range_type == VRP_VARYING ||
108 vrp_right->range_type == VRP_VARYING) {
112 new_top = tarval_add(vrp_left->range_top, vrp_right->range_top);
113 overflow_top = tarval_carry();
114 new_bottom = tarval_add(vrp_left->range_bottom, vrp_right->range_bottom);
115 overflow_bottom = tarval_carry();
117 if (!overflow_top && !overflow_bottom && vrp_left->range_type == VRP_RANGE
118 &&vrp_right->range_type == VRP_RANGE) {
119 new_range_bottom = new_bottom;
120 new_range_top = new_top;
121 new_range_type = VRP_RANGE;
124 if (overflow_top || overflow_bottom) {
125 /* TODO Implement overflow handling*/
126 new_range_type = VRP_UNDEFINED;
132 vrp_attr *vrp_left, *vrp_right;
133 vrp_left = phase_get_or_set_irn_data(phase, get_Sub_left(node));
134 vrp_right = phase_get_or_set_irn_data(phase, get_Sub_right(node));
135 int overflow_top, overflow_bottom;
136 tarval *new_top, *new_bottom;
138 if (vrp_left->range_type == VRP_UNDEFINED || vrp_right->range_type ==
143 new_top = tarval_sub(vrp_left->range_top, vrp_right->range_top, NULL);
144 overflow_top = tarval_carry();
145 new_bottom = tarval_sub(vrp_left->range_bottom, vrp_right->range_bottom, NULL);
146 overflow_bottom = tarval_carry();
148 if (!overflow_top && !overflow_bottom && vrp_left->range_type == VRP_RANGE
149 &&vrp_right->range_type == VRP_RANGE) {
150 new_range_bottom = new_bottom;
151 new_range_top = new_top;
152 new_range_type = VRP_RANGE;
155 if (overflow_top || overflow_bottom) {
156 /* TODO Implement overflow handling*/
162 vrp_attr *vrp_left, *vrp_right;
163 ir_node *left, *right;
165 left = get_Or_left(node);
166 right = get_Or_right(node);
168 vrp_left = phase_get_or_set_irn_data(phase, get_Or_left(node));
169 vrp_right = phase_get_or_set_irn_data(phase, get_Or_right(node));
171 new_bits_set = tarval_or(vrp_left->bits_set, vrp_right->bits_set);
172 new_bits_not_set = tarval_and(vrp_left->bits_not_set, vrp_right->bits_not_set);
178 vrp_attr *vrp_left, *vrp_right;
179 ir_node *right = get_Rotl_right(node);
181 vrp_left = phase_get_or_set_irn_data(phase, get_Rotl_left(node));
182 vrp_right = phase_get_or_set_irn_data(phase, get_Rotl_right(node));
184 /* We can only compute this if the right value is a constant*/
185 if (is_Const(right)) {
186 tarval *bits_set, *bits_not_set;
187 bits_set = tarval_rotl(vrp_left->bits_set, get_Const_tarval(right));
188 bits_not_set = tarval_rotl(vrp_left->bits_not_set, get_Const_tarval(right));
190 new_bits_set = tarval_or(bits_set, vrp->bits_set);
191 new_bits_not_set = tarval_or(bits_not_set, vrp->bits_not_set);
197 vrp_attr *vrp_left, *vrp_right;
198 ir_node *right = get_Shl_right(node);
199 vrp_left = phase_get_or_set_irn_data(phase, get_Shl_left(node));
200 vrp_right = phase_get_or_set_irn_data(phase, get_Shl_right(node));
202 /* We can only compute this if the right value is a constant*/
203 if (is_Const(right)) {
204 tarval *bits_set, *bits_not_set;
205 ir_mode *m = get_tarval_mode(vrp->bits_not_set);
206 bits_set = tarval_shl(vrp_left->bits_set, get_Const_tarval(right));
207 bits_not_set = tarval_shl(vrp_left->bits_not_set, get_Const_tarval(right));
209 new_bits_set = tarval_or(bits_set, vrp->bits_set);
210 new_bits_not_set = tarval_or(bits_not_set, vrp->bits_not_set);
212 bits_not_set = tarval_not( tarval_shl(
214 get_Const_tarval(right)));
215 new_bits_not_set = tarval_or(bits_not_set, new_bits_not_set);
222 vrp_attr *vrp_left, *vrp_right;
223 ir_node *right = get_Shr_right(node);
225 vrp_left = phase_get_or_set_irn_data(phase, get_Shr_left(node));
226 vrp_right = phase_get_or_set_irn_data(phase, get_Shr_right(node));
228 /* We can only compute this if the right value is a constant*/
229 if (is_Const(right)) {
230 tarval *bits_set, *bits_not_set;
231 ir_mode *m = get_tarval_mode(vrp->bits_not_set);
232 bits_set = tarval_shr(vrp_left->bits_set, get_Const_tarval(right));
233 bits_not_set = tarval_shr(vrp_left->bits_not_set, get_Const_tarval(right));
235 new_bits_set = tarval_or(bits_set, vrp->bits_set);
236 new_bits_not_set = tarval_or(bits_not_set, vrp->bits_not_set);
238 bits_not_set = tarval_not( tarval_shr(
240 get_Const_tarval(right)));
241 new_bits_not_set = tarval_or(bits_not_set, new_bits_not_set);
247 vrp_attr *vrp_left, *vrp_right;
248 ir_node *right = get_Shrs_right(node);
250 vrp_left = phase_get_or_set_irn_data(phase, get_Shrs_left(node));
251 vrp_right = phase_get_or_set_irn_data(phase, get_Shrs_right(node));
253 /* We can only compute this if the right value is a constant*/
254 if (is_Const(right)) {
255 tarval *bits_set, *bits_not_set;
256 ir_mode *m = get_tarval_mode(vrp->bits_not_set);
257 bits_set = tarval_shrs(vrp_left->bits_set, get_Const_tarval(right));
258 bits_not_set = tarval_shrs(vrp_left->bits_not_set, get_Const_tarval(right));
260 new_bits_set = tarval_or(bits_set, vrp->bits_set);
261 new_bits_not_set = tarval_or(bits_not_set, vrp->bits_not_set);
263 bits_not_set = tarval_not( tarval_shrs(
265 get_Const_tarval(right)));
266 new_bits_not_set = tarval_or(bits_not_set, new_bits_not_set);
272 vrp_attr *vrp_left, *vrp_right;
274 vrp_left = phase_get_or_set_irn_data(phase, get_Eor_left(node));
275 vrp_right = phase_get_or_set_irn_data(phase, get_Eor_right(node));
277 tarval *bits_set, *bits_not_set;
278 bits_not_set = tarval_or(
279 tarval_and(vrp_left->bits_set, vrp_right->bits_set),
280 tarval_and(vrp_left->bits_not_set,
281 vrp_right->bits_not_set));
283 bits_set = tarval_or(
284 tarval_and(vrp_left->bits_set, vrp_right->bits_not_set),
285 tarval_and(vrp_left->bits_not_set, vrp_right->bits_set));
287 new_bits_set = tarval_or(bits_set, vrp->bits_set);
288 new_bits_not_set = tarval_or(bits_not_set, vrp->bits_not_set);
293 vrp_attr *vrp_pred = phase_get_or_set_irn_data(phase, get_Id_pred(node));
294 new_bits_set = vrp_pred->bits_set;
295 new_bits_not_set = vrp_pred->bits_not_set;
296 new_range_top = vrp_pred->range_top;
297 new_range_bottom = vrp_pred->range_bottom;
298 new_range_type = vrp_pred->range_type;
303 vrp_attr *vrp_pred = phase_get_or_set_irn_data(phase, get_Not_op(node));
304 new_bits_set = tarval_or(vrp_pred->bits_not_set, vrp->bits_set);
305 new_bits_not_set = tarval_or(vrp_pred->bits_set, vrp->bits_not_set);
310 ir_node *pred = get_Conv_op(node);
311 ir_mode *old_mode = get_irn_mode(pred);
312 vrp_attr *vrp_pred = phase_get_or_set_irn_data(phase, pred);
315 tarval *bits_not_set;
317 if (!mode_is_int(old_mode))
320 new_mode = get_irn_mode(node);
322 /* The second and is needed if target type is smaller*/
323 bits_not_set = tarval_not(
324 tarval_convert_to(get_mode_all_one(old_mode),
327 bits_not_set = tarval_or(bits_not_set, tarval_convert_to(vrp_pred->bits_not_set, new_mode));
328 new_bits_not_set = tarval_or(bits_not_set, vrp->bits_not_set);
329 new_bits_set = tarval_and(
330 tarval_not(bits_not_set), tarval_convert_to(vrp_pred->bits_set, new_mode));
332 if (tarval_cmp(vrp_pred->range_top, get_mode_max(new_mode)) == pn_Cmp_Le) {
333 vrp->range_top = vrp_pred->range_top;
336 if (tarval_cmp(vrp_pred->range_bottom, get_mode_min(new_mode)) == pn_Cmp_Ge) {
337 vrp->range_bottom = vrp_pred->range_bottom;
343 pn_Cmp cmp = get_Confirm_cmp(node);
344 ir_node *bound = get_Confirm_bound(node);
346 /** @todo: Handle non-Const bounds */
348 if (cmp == pn_Cmp_Lg) {
349 /** @todo: Is there some way to preserve the information? */
350 new_range_type = VRP_ANTIRANGE;
351 if (is_Const(bound)) {
352 new_range_top = get_Const_tarval(bound);
353 new_range_bottom = get_Const_tarval(bound);
355 } else if (cmp == pn_Cmp_Le) {
356 if (vrp->range_type == VRP_UNDEFINED) {
357 new_range_type = VRP_RANGE;
358 if (is_Const(bound)) {
359 new_range_top = get_Const_tarval(bound);
361 new_range_bottom = get_tarval_min(get_irn_mode(node));
362 } else if (vrp->range_type == VRP_RANGE) {
363 if (is_Const(bound)) {
364 if (tarval_cmp(vrp->range_top,
365 get_Const_tarval(bound)) == pn_Cmp_Le) {
366 new_range_top = get_Const_tarval(bound);
368 new_range_bottom = get_tarval_min(get_irn_mode(node));
370 } else if (vrp->range_type == VRP_ANTIRANGE) {
371 /** @todo: How do we manage not to get a never ending loop? */
379 /* combine all ranges*/
381 ir_node *pred = get_Phi_pred(node,0);
382 vrp_attr *vrp_pred = phase_get_or_set_irn_data(phase, pred);
383 new_range_top = vrp_pred->range_top;
384 new_range_bottom = vrp_pred->range_bottom;
385 new_range_type = vrp_pred->range_type;
386 new_bits_set = vrp_pred->bits_set;
387 new_bits_not_set = vrp_pred->bits_not_set;
389 int num = get_Phi_n_preds(node);
396 for (i = 1; i < num; i++) {
397 pred = get_Phi_pred(node, i);
398 vrp_pred = phase_get_or_set_irn_data(phase, pred);
399 if (new_range_type == VRP_RANGE && vrp_pred->range_type ==
401 cmp = tarval_cmp(new_range_top, vrp_pred->range_top);
402 if (cmp == pn_Cmp_Lt) {
403 new_range_top = vrp_pred->range_top;
405 cmp = tarval_cmp(new_range_bottom, vrp_pred->range_bottom);
406 if (cmp == pn_Cmp_Gt) {
407 new_range_bottom = vrp_pred->range_bottom;
410 new_range_type = VRP_VARYING;
418 /* unhandled, therefore never updated */
424 /* TODO: Check, if there can be information derived from any of these:
425 is_Abs(node) is_Alloc(node) is_Anchor(node) is_Borrow(node) is_Bound(node)
426 is_Break(node) is_Builtin(node) is_Call(node) is_CallBegin(node)
427 is_Carry(node) is_Cast(node) is_Cmp(node) is_Cond(node)
428 is_CopyB(node) is_Div(node) is_DivMod(node) is_Dummy(node)
429 is_End(node) is_EndExcept(node) is_EndReg(node) is_Filter(node) is_Free(node)
430 is_IJmp(node) is_InstOf(node) is_Jmp(node) is_Load(node) is_Minus(node)
431 is_Mod(node) is_Mul(node) is_Mulh(node) is_Mux(node) is_NoMem(node)
432 is_Pin(node) is_Proj(node) is_Quot(node)
433 is_Raise(node) is_Return(node) is_Sel(node) is_Start(node) is_Store(node)
434 is_SymConst(node) is_Sync(node) is_Tuple(node)
437 /* Merge the newly calculated values with those that might already exist*/
438 if (new_bits_set != tarval_bad) {
439 new_bits_set = tarval_or(new_bits_set, vrp->bits_set);
440 if (tarval_cmp(new_bits_set, vrp->bits_set) != pn_Cmp_Eq) {
441 something_changed = 1;
442 vrp->bits_set = new_bits_set;
446 if (new_bits_not_set != tarval_bad) {
447 new_bits_not_set = tarval_or(new_bits_not_set, vrp->bits_not_set);
449 if (tarval_cmp(new_bits_not_set, vrp->bits_not_set) != pn_Cmp_Eq) {
450 something_changed = 1;
451 vrp->bits_not_set = new_bits_not_set;
455 if (vrp->range_type == VRP_UNDEFINED &&
456 new_range_type != VRP_UNDEFINED) {
457 something_changed = 1;
458 vrp->range_type = new_range_type;
459 vrp->range_bottom = new_range_bottom;
460 vrp->range_top = new_range_top;
462 } else if (vrp->range_type == VRP_RANGE) {
463 if (new_range_type == VRP_RANGE) {
464 if (tarval_cmp(vrp->range_bottom, new_range_bottom) == pn_Cmp_Lt) {
465 something_changed = 1;
466 vrp->range_bottom = new_range_bottom;
468 if (tarval_cmp(vrp->range_top, new_range_top) == pn_Cmp_Gt) {
469 something_changed = 1;
470 vrp->range_top = new_range_top;
474 if (new_range_type == VRP_ANTIRANGE) {
475 /* if they are overlapping, cut the range.*/
476 /* TODO: Maybe we can preserve more information here*/
477 if (tarval_cmp(vrp->range_bottom, new_range_top) == pn_Cmp_Gt &&
478 tarval_cmp(vrp->range_bottom, new_range_bottom) == pn_Cmp_Gt) {
479 something_changed = 1;
480 vrp->range_bottom = new_range_top;
482 } else if (tarval_cmp(vrp->range_top, new_range_bottom) == pn_Cmp_Gt &&
483 tarval_cmp(vrp->range_top, new_range_top) == pn_Cmp_Lt) {
484 something_changed = 1;
485 vrp->range_top = new_range_bottom;
488 /* We can not handle the case where the anti range is in the*/
492 } else if (vrp->range_type == VRP_ANTIRANGE) {
493 if (new_range_type == VRP_ANTIRANGE) {
494 if (tarval_cmp(vrp->range_bottom, new_range_bottom) == pn_Cmp_Gt) {
495 something_changed = 1;
496 vrp->range_bottom = new_range_bottom;
498 if (tarval_cmp(vrp->range_top, new_range_top) == pn_Cmp_Lt) {
499 something_changed = 1;
500 vrp->range_top = new_range_top;
504 if (new_range_type == VRP_RANGE) {
505 if (tarval_cmp(vrp->range_bottom, new_range_top) == pn_Cmp_Gt) {
506 something_changed = 1;
507 vrp->range_bottom = new_range_top;
509 if (tarval_cmp(vrp->range_top, new_range_bottom) == pn_Cmp_Lt) {
510 something_changed = 1;
511 vrp->range_top = new_range_bottom;
516 assert(tarval_is_null(
517 tarval_and(vrp->bits_set, vrp->bits_not_set)));
518 return something_changed;
521 static void vrp_first_pass(ir_node *n, void *e)
525 struct vrp_env_t *env = e;
530 set_irn_link(n, VISITED);
534 for (i = get_irn_n_outs(n) - 1; i >=0; --i) {
535 succ = get_irn_out(n, i);
536 if (get_irn_link(succ) == VISITED) {
538 waitq_put(env->workqueue, n);
543 static void *vrp_init_node(ir_phase *phase, const ir_node *n, void *old)
545 ir_printf("initialized node nr: %d\n", get_irn_node_nr(n));
548 assert(1==0 && "init called for node already initialized");
550 vrp_attr *vrp = phase_alloc(phase, sizeof(vrp_attr));
552 memset(vrp, 0, sizeof(vrp_attr));
553 /* Initialize the vrp information to default */
555 mode = get_irn_mode(n);
557 vrp->range_type = VRP_UNDEFINED;
559 /* TODO: We might be able to optimize space usage if we do not allocate
560 * vrp space for non-int nodes. (currently caught by vrp_update_node)
562 if (mode_is_int(mode)) {
563 // We are assuming that 0 is always represented as 0x0000
565 vrp->bits_set = new_tarval_from_long(0, mode);
566 vrp->bits_not_set = new_tarval_from_long(0, mode);
567 vrp->range_bottom = get_tarval_top();
568 vrp->range_top = get_tarval_top();
571 vrp->bits_set = get_tarval_bad();
572 vrp->bits_not_set = get_tarval_bad();
573 vrp->range_bottom = get_tarval_bad();
574 vrp->range_top = get_tarval_bad();
577 /* TODO: We might be able to set better vrp info at this time, if this is
578 * a node which is newly created in an already initalized irg
580 * maybe just call vrp_update_node and if it returns one, iterate over
586 void set_vrp_data(ir_graph *irg)
589 ir_node *succ, *node;
591 struct vrp_env_t *env;
599 assure_irg_outs(irg); /* ensure that out edges are consistent*/
600 if (!(phase = get_irg_phase(irg, PHASE_VRP))) {
601 /* this is our first run */
602 phase = init_irg_phase(irg, PHASE_VRP, 0, vrp_init_node);
603 env = phase_alloc(phase, sizeof(struct vrp_env_t));
609 env->workqueue = new_waitq();
612 irg_walk_graph(irg, NULL, vrp_first_pass, env);
614 /* while there are entries in the worklist, continue*/
615 while (!waitq_empty(env->workqueue)) {
616 node = waitq_get(env->workqueue);
618 if (vrp_update_node(node)) {
619 /* if something changed, add successors to worklist*/
620 for (i = get_irn_n_outs(node) - 1; i >=0; --i) {
621 succ = get_irn_out(node, i);
622 waitq_put(env->workqueue, node);
626 del_waitq(env->workqueue);
630 ir_graph_pass_t *set_vrp_pass(const char *name)
632 return def_graph_pass(name ? name : "set_vrp", set_vrp_data);
635 pn_Cmp vrp_cmp(const ir_node *left, const ir_node *right)
637 vrp_attr *vrp_left, *vrp_right;
639 vrp_left = vrp_get_info(left);
640 vrp_right = vrp_get_info(right);
642 if (!vrp_left || !vrp_right) {
646 if (vrp_left->range_type == VRP_RANGE && vrp_right->range_type == VRP_RANGE) {
647 if (tarval_cmp(vrp_left->range_top, vrp_right->range_bottom) == pn_Cmp_Lt) {
650 if (tarval_cmp(vrp_left->range_bottom, vrp_right->range_top) == pn_Cmp_Gt) {
655 if (!tarval_is_null(tarval_and(vrp_left->bits_set, vrp_right->bits_not_set)) ||
656 !tarval_is_null(tarval_and(vrp_left->bits_not_set, vrp_right->bits_set))) {
659 /* TODO: We can get way more information here*/
664 vrp_attr *vrp_get_info(const ir_node *n) {
665 ir_graph *irg = get_irn_irg(n);
666 ir_phase *phase = get_irg_phase(irg, PHASE_VRP);
670 /* phase has not yet been initialized */
674 return phase_get_irn_data(phase, n);