2 * abcremoval.c: Array bounds check removal
5 * Massimiliano Mantione (massi@ximian.com)
7 * (C) 2004 Ximian, Inc. http://www.ximian.com
12 #include <mono/metadata/debug-helpers.h>
13 #include <mono/metadata/mempool.h>
14 #include <mono/metadata/opcodes.h>
15 #include <mono/metadata/mempool-internals.h>
21 #include "abcremoval.h"
23 #if SIZEOF_VOID_P == 8
24 #define OP_PCONST OP_I8CONST
26 #define OP_PCONST OP_ICONST
30 #define TRACE_ABC_REMOVAL (verbose_level > 2)
31 #define REPORT_ABC_REMOVAL (verbose_level > 1)
34 * A little hack for the verbosity level.
35 * The verbosity level is stored in the cfg, but not all functions that must
36 * print something see the cfg, so we store the verbosity level here at the
37 * beginning of the algorithm.
38 * This is not thread safe (does not handle correctly different verbosity
39 * levels in different threads), and is not exact in case of dynamic changes
40 * of the verbosity level...
41 * Anyway, this is not needed, all that can happen is that something more
42 * (or less) is logged, the result is in any case correct.
44 static int verbose_level;
47 #define RELATION_BETWEEN_VALUES(value,related_value) (\
48 ((value) > (related_value))? MONO_GT_RELATION :\
49 (((value) < (related_value))? MONO_LT_RELATION : MONO_EQ_RELATION))
51 #define MAKE_VALUE_ANY(v) do{\
52 (v).type = MONO_ANY_SUMMARIZED_VALUE;\
55 #define MAKE_VALUE_RELATION_ANY(r) do{\
56 (r)->relation = MONO_ANY_RELATION;\
57 MAKE_VALUE_ANY((r)->related_value);\
60 #define INITIALIZE_VALUE_RELATION(r) do{\
61 MAKE_VALUE_RELATION_ANY((r));\
65 #define MONO_NEGATED_RELATION(r) ((~(r))&MONO_ANY_RELATION)
66 #define MONO_SYMMETRIC_RELATION(r) (((r)&MONO_EQ_RELATION)|(((r)&MONO_LT_RELATION)<<1)|((r&MONO_GT_RELATION)>>1))
71 print_relation (int relation) {
74 if (relation & MONO_LT_RELATION) {
78 if (relation & MONO_EQ_RELATION) {
85 if (relation & MONO_GT_RELATION) {
96 print_summarized_value (MonoSummarizedValue *value) {
97 switch (value->type) {
98 case MONO_ANY_SUMMARIZED_VALUE:
101 case MONO_CONSTANT_SUMMARIZED_VALUE:
102 printf ("CONSTANT %d", value->value.constant.value);
104 case MONO_VARIABLE_SUMMARIZED_VALUE:
105 printf ("VARIABLE %d, delta %d", value->value.variable.variable, value->value.variable.delta);
107 case MONO_PHI_SUMMARIZED_VALUE: {
110 for (phi = 0; phi < value->value.phi.number_of_alternatives; phi++) {
111 if (phi) printf (",");
112 printf ("%d", value->value.phi.phi_alternatives [phi]);
118 g_assert_not_reached ();
123 print_summarized_value_relation (MonoSummarizedValueRelation *relation) {
124 printf ("Relation ");
125 print_relation (relation->relation);
126 printf (" with value ");
127 print_summarized_value (&(relation->related_value));
132 print_summarized_value_relation_chain (MonoSummarizedValueRelation *relation) {
133 printf ("Relations:\n");
135 print_summarized_value_relation (relation);
137 relation = relation->next;
143 print_evaluation_context_status (MonoRelationsEvaluationStatus status) {
144 if (status == MONO_RELATIONS_EVALUATION_NOT_STARTED) {
145 printf ("EVALUATION_NOT_STARTED");
147 gboolean print_or = FALSE;
150 if (status & MONO_RELATIONS_EVALUATION_IN_PROGRESS) {
151 if (print_or) printf ("|");
152 printf ("EVALUATION_IN_PROGRESS");
155 if (status & MONO_RELATIONS_EVALUATION_COMPLETED) {
156 if (print_or) printf ("|");
157 printf ("EVALUATION_COMPLETED");
160 if (status & MONO_RELATIONS_EVALUATION_IS_RECURSIVELY_ASCENDING) {
161 if (print_or) printf ("|");
162 printf ("RECURSIVELY_ASCENDING");
165 if (status & MONO_RELATIONS_EVALUATION_IS_RECURSIVELY_DESCENDING) {
166 if (print_or) printf ("|");
167 printf ("RECURSIVELY_DESCENDING");
170 if (status & MONO_RELATIONS_EVALUATION_IS_RECURSIVELY_INDEFINITE) {
171 if (print_or) printf ("|");
172 printf ("RECURSIVELY_INDEFINITE");
181 print_evaluation_context_ranges (MonoRelationsEvaluationRanges *ranges) {
182 printf ("(ranges: zero [%d,%d], variable [%d,%d])", ranges->zero.lower, ranges->zero.upper, ranges->variable.lower, ranges->variable.upper);
186 print_evaluation_context (MonoRelationsEvaluationContext *context) {
187 printf ("Context status: ");
188 print_evaluation_context_status (context->status);
189 if (context->status & (MONO_RELATIONS_EVALUATION_IN_PROGRESS|MONO_RELATIONS_EVALUATION_COMPLETED)) {
190 print_evaluation_context_ranges (&(context->ranges));
197 print_evaluation_area (MonoVariableRelationsEvaluationArea *area) {
199 printf ("Dump of evaluation area (%d variables):\n", area->cfg->num_varinfo);
200 for (i = 0; i < area->cfg->num_varinfo; i++) {
201 printf ("Variable %d: ", i);
202 print_evaluation_context (&(area->contexts [i]));
203 print_summarized_value_relation_chain (&(area->relations [i]));
208 print_evaluation_area_contexts (MonoVariableRelationsEvaluationArea *area) {
210 printf ("Dump of evaluation area contexts (%d variables):\n", area->cfg->num_varinfo);
211 for (i = 0; i < area->cfg->num_varinfo; i++) {
212 printf ("Variable %d: ", i);
213 print_evaluation_context (&(area->contexts [i]));
219 * Check if the delta of an integer variable value is safe with respect
220 * to the variable size in bytes and its kind (signed or unsigned).
221 * If the delta is not safe, make the value an "any".
223 static G_GNUC_UNUSED void
224 check_delta_safety (MonoVariableRelationsEvaluationArea *area, MonoSummarizedValue *value) {
225 if (value->type == MONO_VARIABLE_SUMMARIZED_VALUE) {
226 int variable = value->value.variable.variable;
227 int delta = value->value.variable.delta;
228 if ((area->variable_value_kind [variable]) & MONO_UNSIGNED_VALUE_FLAG) {
230 MAKE_VALUE_ANY (*value);
233 if (((area->variable_value_kind [variable]) & MONO_INTEGER_VALUE_SIZE_BITMASK) < 4) {
234 MAKE_VALUE_ANY (*value);
235 } else if (delta > 16) {
236 MAKE_VALUE_ANY (*value);
243 * get_relation_from_ins:
245 * Obtain relations from a MonoInst.
247 * result_value_kind: the "expected" kind of result;
248 * result: the "summarized" value
249 * returns the "actual" kind of result, if guessable (otherwise MONO_UNKNOWN_INTEGER_VALUE)
251 static MonoIntegerValueKind
252 get_relation_from_ins (MonoVariableRelationsEvaluationArea *area, MonoInst *ins, MonoSummarizedValueRelation *result, MonoIntegerValueKind result_value_kind)
254 MonoIntegerValueKind value_kind;
255 MonoSummarizedValue *value = &result->related_value;
257 if (ins->type == STACK_I8) {
258 value_kind = MONO_INTEGER_VALUE_SIZE_8;
259 } else if (ins->type == STACK_I4) {
260 value_kind = MONO_INTEGER_VALUE_SIZE_4;
262 value_kind = MONO_UNKNOWN_INTEGER_VALUE;
265 result->relation = MONO_EQ_RELATION;
266 MAKE_VALUE_ANY (*value);
268 switch (ins->opcode) {
270 value->type = MONO_CONSTANT_SUMMARIZED_VALUE;
271 value->value.constant.value = ins->inst_c0;
274 value->type = MONO_VARIABLE_SUMMARIZED_VALUE;
275 value->value.variable.variable = ins->sreg1;
276 value->value.variable.delta = 0;
279 value->type = MONO_PHI_SUMMARIZED_VALUE;
280 value->value.phi.number_of_alternatives = *(ins->inst_phi_args);
281 value->value.phi.phi_alternatives = ins->inst_phi_args + 1;
284 value->type = MONO_VARIABLE_SUMMARIZED_VALUE;
285 value->value.variable.variable = ins->sreg1;
286 value->value.variable.delta = ins->inst_imm;
288 //check_delta_safety (area, result);
291 value->type = MONO_VARIABLE_SUMMARIZED_VALUE;
292 value->value.variable.variable = ins->sreg1;
293 value->value.variable.delta = ins->inst_imm;
295 //check_delta_safety (area, result);
298 /* The result of an unsigned remainder is 0 < x < the divisor */
299 result->relation = MONO_LT_RELATION;
300 value->type = MONO_VARIABLE_SUMMARIZED_VALUE;
301 value->value.variable.variable = ins->sreg2;
302 value->value.variable.delta = 0;
303 value_kind = MONO_UNSIGNED_INTEGER_VALUE_SIZE_4;
307 * We represent arrays by their length, so r1<-ldlen r2 is stored
308 * as r1 == r2 in the evaluation graph.
310 value->type = MONO_VARIABLE_SUMMARIZED_VALUE;
311 value->value.variable.variable = ins->sreg1;
312 value->value.variable.delta = 0;
313 value_kind = MONO_UNSIGNED_INTEGER_VALUE_SIZE_4;
316 value->type = MONO_VARIABLE_SUMMARIZED_VALUE;
317 value->value.variable.variable = ins->sreg1;
318 value->value.variable.delta = 0;
321 /* FIXME: Add more opcodes */
323 /* These opcodes are not currently handled while running SciMark, first
324 * column is the number of times the warning was shown:
356 * 12 outarg_vtretaddr
384 static MonoValueRelation
385 get_relation_from_branch_instruction (MonoInst *ins)
387 if (MONO_IS_COND_BRANCH_OP (ins)) {
388 CompRelation rel = mono_opcode_to_cond (ins->opcode);
392 return MONO_EQ_RELATION;
394 return MONO_NE_RELATION;
397 return MONO_LE_RELATION;
400 return MONO_GE_RELATION;
403 return MONO_LT_RELATION;
406 return MONO_GT_RELATION;
408 g_assert_not_reached ();
409 return MONO_ANY_RELATION;
412 return MONO_ANY_RELATION;
417 * Given a BB, find its entry condition and put its relations in a
418 * "MonoAdditionalVariableRelationsForBB" structure.
420 * relations: the resulting relations (entry condition of the given BB)
423 get_relations_from_previous_bb (MonoVariableRelationsEvaluationArea *area, MonoBasicBlock *bb, MonoAdditionalVariableRelationsForBB *relations)
425 MonoBasicBlock *in_bb;
426 MonoInst *ins, *compare, *branch;
427 MonoValueRelation branch_relation;
428 MonoValueRelation symmetric_relation;
431 INITIALIZE_VALUE_RELATION (&(relations->relation1.relation));
432 relations->relation1.relation.relation_is_static_definition = FALSE;
433 relations->relation1.relation.next = NULL;
434 relations->relation1.insertion_point = NULL;
435 relations->relation1.variable = -1;
436 INITIALIZE_VALUE_RELATION (&(relations->relation2.relation));
437 relations->relation2.relation.relation_is_static_definition = FALSE;
438 relations->relation2.relation.next = NULL;
439 relations->relation2.insertion_point = NULL;
440 relations->relation2.variable = -1;
442 if (bb->in_count == 1) { /* Should write the code to "sum" conditions... */
443 in_bb = bb->in_bb [0];
445 if ((in_bb->last_ins == NULL) || (in_bb->code == in_bb->last_ins))
448 for (ins = in_bb->code; ins->next != in_bb->last_ins; ins = ins->next)
453 branch_relation = get_relation_from_branch_instruction (branch);
455 if (branch_relation != MONO_ANY_RELATION) {
456 if (branch->inst_true_bb == bb) {
458 } else if (branch->inst_false_bb == bb) {
462 g_assert_not_reached ();
465 branch_relation = MONO_NEGATED_RELATION (branch_relation);
466 symmetric_relation = MONO_SYMMETRIC_RELATION (branch_relation);
468 /* FIXME: Other compare opcodes */
469 if (compare->opcode == OP_ICOMPARE) {
470 relations->relation1.variable = compare->sreg1;
471 relations->relation1.relation.relation = branch_relation;
472 relations->relation1.relation.related_value.type = MONO_VARIABLE_SUMMARIZED_VALUE;
473 relations->relation1.relation.related_value.value.variable.variable = compare->sreg2;
474 relations->relation1.relation.related_value.value.variable.delta = 0;
476 relations->relation2.variable = compare->sreg2;
477 relations->relation2.relation.relation = symmetric_relation;
478 relations->relation2.relation.related_value.type = MONO_VARIABLE_SUMMARIZED_VALUE;
479 relations->relation2.relation.related_value.value.variable.variable = compare->sreg1;
480 relations->relation2.relation.related_value.value.variable.delta = 0;
481 } else if (compare->opcode == OP_ICOMPARE_IMM) {
482 relations->relation1.variable = compare->sreg1;
483 relations->relation1.relation.relation = branch_relation;
484 relations->relation1.relation.related_value.type = MONO_CONSTANT_SUMMARIZED_VALUE;
485 relations->relation1.relation.related_value.value.constant.value = compare->inst_imm;
492 * Add the given relations to the evaluation area.
493 * area: the evaluation area
494 * change: the relations that must be added
497 apply_change_to_evaluation_area (MonoVariableRelationsEvaluationArea *area, MonoAdditionalVariableRelation *change)
499 MonoSummarizedValueRelation *base_relation;
501 if (change->relation.relation != MONO_ANY_RELATION) {
502 base_relation = &(area->relations [change->variable]);
503 while ((base_relation->next != NULL) && (base_relation->next->relation_is_static_definition)) {
504 base_relation = base_relation->next;
506 change->insertion_point = base_relation;
507 change->relation.next = base_relation->next;
508 base_relation->next = &(change->relation);
513 * Remove the given relation from the evaluation area.
514 * change: the relation that must be removed
517 remove_change_from_evaluation_area (MonoAdditionalVariableRelation *change)
519 if (change->insertion_point != NULL) {
520 change->insertion_point->next = change->relation.next;
521 change->relation.next = NULL;
527 clean_contexts (MonoRelationsEvaluationContext *contexts, int number)
530 for (i = 0; i < number; i++) {
531 contexts [i].status = MONO_RELATIONS_EVALUATION_NOT_STARTED;
537 * Perform the intersection of a range and a constant value (taking into
538 * account the relation that the value has with the range).
539 * range: the range that will be intersected with the value
540 * value: the value that will be intersected with the range
541 * relation: the relation between the range and the value
544 intersect_value( MonoRelationsEvaluationRange *range, int value, MonoValueRelation relation )
547 case MONO_NO_RELATION:
548 MONO_MAKE_RELATIONS_EVALUATION_RANGE_IMPOSSIBLE (*range);
550 case MONO_ANY_RELATION:
552 case MONO_EQ_RELATION:
553 MONO_UPPER_EVALUATION_RANGE_INTERSECTION (range->upper, value);
554 MONO_LOWER_EVALUATION_RANGE_INTERSECTION (range->lower, value);
556 case MONO_NE_RELATION: {
557 /* IMPROVEMENT Figure this out! (ignoring it is safe anyway) */
560 case MONO_LT_RELATION:
561 MONO_UPPER_EVALUATION_RANGE_INTERSECTION (range->upper, MONO_UPPER_EVALUATION_RANGE_NOT_EQUAL (value));
563 case MONO_LE_RELATION:
564 MONO_UPPER_EVALUATION_RANGE_INTERSECTION (range->upper, value);
566 case MONO_GT_RELATION:
567 MONO_LOWER_EVALUATION_RANGE_INTERSECTION (range->lower, MONO_LOWER_EVALUATION_RANGE_NOT_EQUAL (value));
569 case MONO_GE_RELATION:
570 MONO_LOWER_EVALUATION_RANGE_INTERSECTION (range->lower, value);
573 g_assert_not_reached();
579 * Perform the intersection of two pairs of ranges (taking into account the
580 * relation between the ranges and a given delta).
581 * ranges: the ranges that will be intersected
582 * other_ranges the other ranges that will be intersected
583 * delta: the delta between the pairs of ranges
584 * relation: the relation between the pairs of ranges
587 intersect_ranges( MonoRelationsEvaluationRanges *ranges, MonoRelationsEvaluationRanges *other_ranges, int delta, MonoValueRelation relation )
591 case MONO_NO_RELATION:
592 MONO_MAKE_RELATIONS_EVALUATION_RANGES_IMPOSSIBLE (*ranges);
594 case MONO_ANY_RELATION:
596 case MONO_EQ_RELATION:
597 MONO_RELATIONS_EVALUATION_RANGES_INTERSECTION (*ranges, *other_ranges);
599 case MONO_NE_RELATION: {
600 /* FIXME Figure this out! (ignoring it is safe anyway) */
603 case MONO_LT_RELATION:
604 MONO_UPPER_EVALUATION_RANGE_INTERSECTION (ranges->zero.upper, MONO_UPPER_EVALUATION_RANGE_NOT_EQUAL (other_ranges->zero.upper));
605 MONO_UPPER_EVALUATION_RANGE_INTERSECTION (ranges->variable.upper, MONO_UPPER_EVALUATION_RANGE_NOT_EQUAL (other_ranges->variable.upper));
607 case MONO_LE_RELATION:
608 MONO_UPPER_EVALUATION_RANGE_INTERSECTION (ranges->zero.upper, other_ranges->zero.upper);
609 MONO_UPPER_EVALUATION_RANGE_INTERSECTION (ranges->variable.upper, other_ranges->variable.upper);
611 case MONO_GT_RELATION:
612 MONO_LOWER_EVALUATION_RANGE_INTERSECTION (ranges->zero.lower, MONO_LOWER_EVALUATION_RANGE_NOT_EQUAL (other_ranges->zero.lower));
613 MONO_LOWER_EVALUATION_RANGE_INTERSECTION (ranges->variable.lower, MONO_LOWER_EVALUATION_RANGE_NOT_EQUAL (other_ranges->variable.lower));
615 case MONO_GE_RELATION:
616 MONO_LOWER_EVALUATION_RANGE_INTERSECTION (ranges->zero.lower, other_ranges->zero.lower);
617 MONO_LOWER_EVALUATION_RANGE_INTERSECTION (ranges->variable.lower, other_ranges->variable.lower);
620 g_assert_not_reached();
623 MonoRelationsEvaluationRanges translated_ranges = *other_ranges;
624 MONO_ADD_DELTA_SAFELY_TO_RANGES (translated_ranges, delta);
625 intersect_ranges( ranges, &translated_ranges, FALSE, relation );
630 * Recursive method that traverses the relation graph to evaluate the
631 * relation between two variables.
632 * At the end of the execution, the resulting ranges are in the context of
633 * the "starting" variable.
634 * area: the current evaluation area (it contains the relation graph and
635 * memory for all the evaluation contexts is already allocated)
636 * variable: starting variable (the value ranges in its context are the result
637 * of the execution of this procedure)
638 * target_variable: the variable with respect to which the starting variable
639 * is evaluated (tipically the starting variable is the index
640 * and the target one is the array (which means its length))
641 * father_context: the previous evaluation context in recursive invocations
642 * (or NULL for the first invocation)
645 evaluate_relation_with_target_variable (MonoVariableRelationsEvaluationArea *area, int variable, int target_variable, MonoRelationsEvaluationContext *father_context)
647 MonoRelationsEvaluationContext *context = &(area->contexts [variable]);
649 // First of all, we check the evaluation status
650 // (what must be done is *very* different in each case)
651 switch (context->status) {
652 case MONO_RELATIONS_EVALUATION_NOT_STARTED: {
653 MonoSummarizedValueRelation *relation = &(area->relations [variable]);
655 if (TRACE_ABC_REMOVAL) {
656 printf ("Evaluating variable %d (target variable %d)\n", variable, target_variable);
657 print_summarized_value_relation (relation);
661 // We properly inizialize the context
662 context->status = MONO_RELATIONS_EVALUATION_IN_PROGRESS;
663 context->father = father_context;
664 MONO_MAKE_RELATIONS_EVALUATION_RANGES_WEAK (context->ranges);
666 // If we have found the target variable, we can set the range
667 // related to it in the context to "equal" (which is [0,0])
668 if (variable == target_variable) {
669 if (TRACE_ABC_REMOVAL) {
670 printf ("Target variable reached (%d), continuing to evaluate relations with constants\n", variable);
672 context->ranges.variable.lower = 0;
673 context->ranges.variable.upper = 0;
676 // Examine all relations for this variable (scan the list)
677 // The contribute of each relation will be intersected (logical and)
678 while (relation != NULL) {
679 context->current_relation = relation;
681 if (TRACE_ABC_REMOVAL) {
682 printf ("Processing (%d): ", variable);
683 print_summarized_value_relation (relation);
687 // We decie what to do according the the type of the related value
688 switch (relation->related_value.type) {
689 case MONO_ANY_SUMMARIZED_VALUE:
690 // No added information, skip it
692 case MONO_CONSTANT_SUMMARIZED_VALUE:
693 // Intersect range with constant (taking into account the relation)
694 intersect_value (&(context->ranges.zero), relation->related_value.value.constant.value, relation->relation);
696 case MONO_VARIABLE_SUMMARIZED_VALUE:
697 // Generally, evaluate related variable and intersect ranges.
698 // However, some check is necessary...
700 // If the relation is "ANY", nothing to do (no added information)
701 if (relation->relation != MONO_ANY_RELATION) {
702 int related_variable = relation->related_value.value.variable.variable;
703 MonoRelationsEvaluationContext *related_context = &(area->contexts [related_variable]);
705 // The second condition in the "or" avoids messing with "back edges" in the graph traversal
706 // (they are simply ignored instead of triggering the handling of recursion)
707 if ( (related_context->status == MONO_RELATIONS_EVALUATION_NOT_STARTED) || !
708 ((related_context->current_relation->related_value.type == MONO_VARIABLE_SUMMARIZED_VALUE) &&
709 (related_context->current_relation->related_value.value.variable.variable == variable))) {
710 // Evaluate the related variable
711 evaluate_relation_with_target_variable (area, related_variable, target_variable, context);
713 // Check if we are part of a recursive loop
714 if (context->status & MONO_RELATIONS_EVALUATION_IS_RECURSIVE) {
715 if (TRACE_ABC_REMOVAL) {
716 printf ("Recursivity detected for variable %d (target variable %d), status ", variable, target_variable);
717 print_evaluation_context_status (context->status);
720 // If we are, check if the evaluation of the related variable is complete
721 if (related_context->status == MONO_RELATIONS_EVALUATION_COMPLETED) {
722 // If it is complete, we are part of a recursive definition.
723 // Since it is a *definition* (and definitions are evaluated *before*
724 // conditions because they are first in the list), intersection is not
725 // strictly necessary, we simply copy the ranges and apply the delta
726 context->ranges = related_context->ranges;
727 /* Delta has already been checked for over/under-flow when evaluating values */
728 MONO_ADD_DELTA_SAFELY_TO_RANGES (context->ranges, relation->related_value.value.variable.delta);
729 context->status = MONO_RELATIONS_EVALUATION_COMPLETED;
730 if (TRACE_ABC_REMOVAL) {
731 printf (", ranges already computed, result: \n");
732 print_evaluation_context_ranges (&(context->ranges));
733 printf (" (delta is %d)\n", relation->related_value.value.variable.delta);
736 // If it is not complete, do nothing (we do not have enough information)
737 if (TRACE_ABC_REMOVAL) {
738 printf (", ranges not computed\n");
742 // If we are not (the common case) intersect the result
743 intersect_ranges( &(context->ranges), &(related_context->ranges), relation->related_value.value.variable.delta, relation->relation );
746 if (TRACE_ABC_REMOVAL) {
747 printf ("Relation is a back-edge in this traversal, skipping\n");
752 case MONO_PHI_SUMMARIZED_VALUE: {
753 // We must compute all PHI alternatives, combining the results (with a union, which is a logical "or"),
754 // and intersect this result with the ranges in the context; we must also take into account recursions
755 // (with loops that can be ascending, descending, or indefinite)
756 MonoRelationsEvaluationRanges phi_ranges;
758 gboolean is_ascending = FALSE;
759 gboolean is_descending = FALSE;
761 MONO_MAKE_RELATIONS_EVALUATION_RANGES_IMPOSSIBLE (phi_ranges);
762 for (phi = 0; phi < relation->related_value.value.phi.number_of_alternatives; phi++) {
763 int phi_alternative = relation->related_value.value.phi.phi_alternatives [phi];
764 evaluate_relation_with_target_variable (area, phi_alternative, target_variable, context);
766 // This means we are part of a recursive loop
767 if (context->status & MONO_RELATIONS_EVALUATION_IS_RECURSIVE) {
768 if (TRACE_ABC_REMOVAL) {
769 printf ("Recursivity detected for variable %d (target variable %d), status ", variable, target_variable);
770 print_evaluation_context_status (context->status);
773 if (context->status & MONO_RELATIONS_EVALUATION_IS_RECURSIVELY_ASCENDING) {
776 if (context->status & MONO_RELATIONS_EVALUATION_IS_RECURSIVELY_DESCENDING) {
777 is_descending = TRUE;
779 if (context->status & MONO_RELATIONS_EVALUATION_IS_RECURSIVELY_INDEFINITE) {
781 is_descending = TRUE;
784 // Clear "recursivity" bits in the status (recursion has been handled)
785 context->status = MONO_RELATIONS_EVALUATION_IN_PROGRESS;
787 MONO_RELATIONS_EVALUATION_RANGES_UNION (phi_ranges, area->contexts [phi_alternative].ranges);
791 // Apply the effects of all recursive loops
793 phi_ranges.zero.upper = INT_MAX;
794 phi_ranges.variable.upper = INT_MAX;
797 phi_ranges.zero.lower = INT_MIN;
798 phi_ranges.variable.lower = INT_MIN;
801 // Intersect final result
802 MONO_RELATIONS_EVALUATION_RANGES_INTERSECTION (context->ranges, phi_ranges);
806 g_assert_not_reached();
809 // Pass to next relation
810 relation = relation->next;
813 // Check if any recursivity bits are still in the status, and in any case clear them
814 if (context->status & MONO_RELATIONS_EVALUATION_IS_RECURSIVE) {
815 if (TRACE_ABC_REMOVAL) {
816 printf ("Recursivity for variable %d (target variable %d) discards computation, status ", variable, target_variable);
817 print_evaluation_context_status (context->status);
820 // If yes, we did not have enough information (most likely we were evaluated inside a PHI, but we also
821 // depended on the same PHI, which was still in evaluation...), so clear the status to "NOT_STARTED"
822 // (if we will be evaluated again, the PHI will be already done, so our evaluation will succeed)
823 context->status = MONO_RELATIONS_EVALUATION_NOT_STARTED;
825 if (TRACE_ABC_REMOVAL) {
826 printf ("Ranges for variable %d (target variable %d) computed: ", variable, target_variable);
827 print_evaluation_context_ranges (&(context->ranges));
830 // If not (the common case) the evaluation is complete, and the result is in the context
831 context->status = MONO_RELATIONS_EVALUATION_COMPLETED;
835 case MONO_RELATIONS_EVALUATION_IN_PROGRESS: {
836 // This means we are in a recursive loop
837 MonoRelationsEvaluationContext *current_context = father_context;
838 MonoRelationsEvaluationContext *last_context = context->father;
839 gboolean evaluation_can_be_recursive = TRUE;
840 gboolean evaluation_is_definition = TRUE;
843 if (TRACE_ABC_REMOVAL) {
844 printf ("Evaluation of variable %d (target variable %d) already in progress\n", variable, target_variable);
845 print_evaluation_context (context);
846 print_summarized_value_relation (context->current_relation);
850 // We must check if the loop can be a recursive definition (we scan the whole loop)
851 while (current_context != last_context) {
852 if (current_context == NULL) {
853 printf ("Broken recursive ring in ABC removal\n");
854 g_assert_not_reached ();
857 if (current_context->current_relation->relation_is_static_definition) {
858 if (current_context->current_relation->related_value.type == MONO_VARIABLE_SUMMARIZED_VALUE) {
859 /* No need to check path_value for over/under-flow, since delta should be safe */
860 path_value += current_context->current_relation->related_value.value.variable.delta;
861 } else if (current_context->current_relation->related_value.type != MONO_PHI_SUMMARIZED_VALUE) {
862 evaluation_can_be_recursive = FALSE;
865 evaluation_is_definition = FALSE;
866 evaluation_can_be_recursive = FALSE;
869 current_context = current_context->father;
872 // If this is a recursive definition, we properly flag the status in all the involved contexts
873 if (evaluation_is_definition) {
874 MonoRelationsEvaluationStatus recursive_status;
875 if (evaluation_can_be_recursive) {
876 if (path_value > 0) {
877 recursive_status = MONO_RELATIONS_EVALUATION_IS_RECURSIVELY_ASCENDING;
878 } else if (path_value < 0) {
879 recursive_status = MONO_RELATIONS_EVALUATION_IS_RECURSIVELY_DESCENDING;
881 recursive_status = MONO_RELATIONS_EVALUATION_IS_RECURSIVELY_INDEFINITE;
884 recursive_status = MONO_RELATIONS_EVALUATION_IS_RECURSIVELY_INDEFINITE;
887 if (TRACE_ABC_REMOVAL) {
888 printf ("Recursivity accepted (");
889 print_evaluation_context_status (recursive_status);
893 current_context = father_context;
894 while (current_context != last_context) {
895 current_context->status |= recursive_status;
896 current_context = current_context->father;
899 if (TRACE_ABC_REMOVAL) {
900 printf ("Recursivity rejected (some relation in the cycle is not a defintion)\n");
905 case MONO_RELATIONS_EVALUATION_COMPLETED: {
909 if (TRACE_ABC_REMOVAL) {
910 printf ("Variable %d (target variable %d) already in a recursive ring, skipping\n", variable, target_variable);
911 print_evaluation_context (context);
912 print_summarized_value_relation (context->current_relation);
921 * Apply the given value kind to the given range
924 apply_value_kind_to_range (MonoRelationsEvaluationRange *range, MonoIntegerValueKind value_kind)
926 if (value_kind != MONO_UNKNOWN_INTEGER_VALUE) {
927 if (value_kind & MONO_UNSIGNED_VALUE_FLAG) {
928 if (range->lower < 0) {
931 if ((value_kind & MONO_INTEGER_VALUE_SIZE_BITMASK) == 1) {
932 if (range->upper > 0xff) {
935 } else if ((value_kind & MONO_INTEGER_VALUE_SIZE_BITMASK) == 2) {
936 if (range->upper > 0xffff) {
937 range->upper = 0xffff;
941 if ((value_kind & MONO_INTEGER_VALUE_SIZE_BITMASK) == 1) {
942 if (range->lower < -0x80) {
943 range->lower = -0x80;
945 if (range->upper > 0x7f) {
948 } else if ((value_kind & MONO_INTEGER_VALUE_SIZE_BITMASK) == 2) {
949 if (range->lower < -0x8000) {
950 range->lower = -0x8000;
952 if (range->upper > 0x7fff) {
953 range->upper = 0x7fff;
961 * Attempt the removal of bounds checks from a MonoInst.
963 * area: the current evaluation area (it contains the relation graph and
964 * memory for all the evaluation contexts is already allocated)
967 remove_abc_from_inst (MonoInst *ins, MonoVariableRelationsEvaluationArea *area)
969 /* FIXME: Add support for 'constant' arrays and constant indexes */
971 int array_variable = ins->sreg1;
972 int index_variable = ins->sreg2;
973 MonoRelationsEvaluationContext *array_context = &(area->contexts [array_variable]);
974 MonoRelationsEvaluationContext *index_context = &(area->contexts [index_variable]);
976 clean_contexts (area->contexts, area->cfg->next_vreg);
978 evaluate_relation_with_target_variable (area, index_variable, array_variable, NULL);
979 evaluate_relation_with_target_variable (area, array_variable, array_variable, NULL);
981 if ((index_context->ranges.zero.lower >=0) && ((index_context->ranges.variable.upper < 0)||(index_context->ranges.zero.upper < array_context->ranges.zero.lower))) {
982 if (REPORT_ABC_REMOVAL) {
983 printf ("ARRAY-ACCESS: removed bounds check on array %d with index %d\n",
984 array_variable, index_variable);
988 if (TRACE_ABC_REMOVAL) {
989 if (index_context->ranges.zero.lower >= 0) {
990 printf ("ARRAY-ACCESS: Removed lower bound check on array %d with index %d\n", array_variable, index_variable);
992 if (index_context->ranges.variable.upper < 0) {
993 printf ("ARRAY-ACCESS: Removed upper bound check (through variable) on array %d with index %d\n", array_variable, index_variable);
995 if (index_context->ranges.zero.upper < array_context->ranges.zero.lower) {
996 printf ("ARRAY-ACCESS: Removed upper bound check (through constant) on array %d with index %d\n", array_variable, index_variable);
1003 eval_non_null (MonoVariableRelationsEvaluationArea *area, int reg)
1005 MonoRelationsEvaluationContext *context = &(area->contexts [reg]);
1007 clean_contexts (area->contexts, area->cfg->next_vreg);
1008 evaluate_relation_with_target_variable (area, reg, reg, NULL);
1010 return context->ranges.zero.lower > 0;
1014 add_non_null (MonoVariableRelationsEvaluationArea *area, MonoCompile *cfg, int reg,
1015 GSList **check_relations)
1017 MonoAdditionalVariableRelation *rel;
1019 rel = mono_mempool_alloc0 (cfg->mempool, sizeof (MonoAdditionalVariableRelation));
1020 rel->variable = reg;
1021 rel->relation.relation = MONO_GT_RELATION;
1022 rel->relation.related_value.type = MONO_CONSTANT_SUMMARIZED_VALUE;
1023 rel->relation.related_value.value.constant.value = 0;
1025 apply_change_to_evaluation_area (area, rel);
1027 *check_relations = g_slist_append_mempool (cfg->mempool, *check_relations, rel);
1031 * Process a BB removing bounds checks from array accesses.
1032 * It does the following (in sequence):
1033 * - Get the BB entry condition
1034 * - Add its relations to the relation graph in the evaluation area
1035 * - Process all the MonoInst trees in the BB
1036 * - Recursively process all the children BBs in the dominator tree
1037 * - Remove the relations previously added to the relation graph
1039 * bb: the BB that must be processed
1040 * area: the current evaluation area (it contains the relation graph and
1041 * memory for all the evaluation contexts is already allocated)
1044 process_block (MonoCompile *cfg, MonoBasicBlock *bb, MonoVariableRelationsEvaluationArea *area) {
1047 MonoAdditionalVariableRelationsForBB additional_relations;
1048 GSList *dominated_bb, *l;
1049 GSList *check_relations = NULL;
1051 if (TRACE_ABC_REMOVAL) {
1052 printf ("\nProcessing block %d [dfn %d]...\n", bb->block_num, bb->dfn);
1055 if (bb->region != -1)
1058 get_relations_from_previous_bb (area, bb, &additional_relations);
1059 if (TRACE_ABC_REMOVAL) {
1060 if (additional_relations.relation1.relation.relation != MONO_ANY_RELATION) {
1061 printf ("Adding relation 1 on variable %d: ", additional_relations.relation1.variable);
1062 print_summarized_value_relation (&(additional_relations.relation1.relation));
1065 if (additional_relations.relation2.relation.relation != MONO_ANY_RELATION) {
1066 printf ("Adding relation 2 on variable %d: ", additional_relations.relation2.variable);
1067 print_summarized_value_relation (&(additional_relations.relation2.relation));
1071 apply_change_to_evaluation_area (area, &(additional_relations.relation1));
1072 apply_change_to_evaluation_area (area, &(additional_relations.relation2));
1075 for (ins = bb->code; ins; ins = ins->next) {
1076 MonoAdditionalVariableRelation *rel;
1077 int array_var, index_var;
1079 if (TRACE_ABC_REMOVAL) {
1080 printf ("Processing instruction %d\n", inst_index);
1084 if (ins->opcode == OP_BOUNDS_CHECK) { /* Handle OP_LDELEMA2D, too */
1085 if (TRACE_ABC_REMOVAL) {
1086 printf ("Attempting check removal...\n");
1089 array_var = ins->sreg1;
1090 index_var = ins->sreg2;
1092 remove_abc_from_inst (ins, area);
1094 /* We can derive additional relations from the bounds check */
1095 if (ins->opcode != OP_NOP) {
1096 rel = mono_mempool_alloc0 (cfg->mempool, sizeof (MonoAdditionalVariableRelation));
1097 rel->variable = index_var;
1098 rel->relation.relation = MONO_LT_RELATION;
1099 rel->relation.related_value.type = MONO_VARIABLE_SUMMARIZED_VALUE;
1100 rel->relation.related_value.value.variable.variable = array_var;
1101 rel->relation.related_value.value.variable.delta = 0;
1103 apply_change_to_evaluation_area (area, rel);
1105 check_relations = g_slist_append_mempool (cfg->mempool, check_relations, rel);
1107 rel = mono_mempool_alloc0 (cfg->mempool, sizeof (MonoAdditionalVariableRelation));
1108 rel->variable = index_var;
1109 rel->relation.relation = MONO_GE_RELATION;
1110 rel->relation.related_value.type = MONO_CONSTANT_SUMMARIZED_VALUE;
1111 rel->relation.related_value.value.constant.value = 0;
1113 apply_change_to_evaluation_area (area, rel);
1115 check_relations = g_slist_append_mempool (cfg->mempool, check_relations, rel);
1119 if (ins->opcode == OP_CHECK_THIS) {
1120 if (eval_non_null (area, ins->sreg1)) {
1121 if (REPORT_ABC_REMOVAL)
1122 printf ("ARRAY-ACCESS: removed check_this instruction.\n");
1127 if (ins->opcode == OP_NOT_NULL)
1128 add_non_null (area, cfg, ins->sreg1, &check_relations);
1131 * This doesn't work because LLVM can move the non-faulting loads before the faulting
1132 * ones (test_0_llvm_moving_faulting_loads ()).
1133 * FIXME: This also doesn't work because abcrem equates an array with its length,
1134 * so a = new int [100] implies a != null, but a = new int [0] doesn't.
1138 * Eliminate MONO_INST_FAULT flags if possible.
1140 if (COMPILE_LLVM (cfg) && (ins->opcode == OP_LDLEN ||
1141 ins->opcode == OP_BOUNDS_CHECK ||
1142 ins->opcode == OP_STRLEN ||
1143 (MONO_IS_LOAD_MEMBASE (ins) && (ins->flags & MONO_INST_FAULT)) ||
1144 (MONO_IS_STORE_MEMBASE (ins) && (ins->flags & MONO_INST_FAULT)))) {
1147 if (MONO_IS_STORE_MEMBASE (ins))
1148 reg = ins->inst_destbasereg;
1149 else if (MONO_IS_LOAD_MEMBASE (ins))
1150 reg = ins->inst_basereg;
1154 if (eval_non_null (area, reg)) {
1155 if (REPORT_ABC_REMOVAL)
1156 printf ("ARRAY-ACCESS: removed MONO_INST_FAULT flag.\n");
1157 ins->flags &= ~MONO_INST_FAULT;
1159 add_non_null (area, cfg, reg, &check_relations);
1165 if (TRACE_ABC_REMOVAL) {
1166 printf ("Processing block %d [dfn %d] done.\n", bb->block_num, bb->dfn);
1169 for (dominated_bb = bb->dominated; dominated_bb != NULL; dominated_bb = dominated_bb->next) {
1170 process_block (cfg, (MonoBasicBlock*) (dominated_bb->data), area);
1173 for (l = check_relations; l; l = l->next)
1174 remove_change_from_evaluation_area (l->data);
1176 remove_change_from_evaluation_area (&(additional_relations.relation1));
1177 remove_change_from_evaluation_area (&(additional_relations.relation2));
1180 static MonoIntegerValueKind
1181 type_to_value_kind (MonoType *type)
1184 return MONO_UNKNOWN_INTEGER_VALUE;
1185 switch (type->type) {
1187 return MONO_INTEGER_VALUE_SIZE_1;
1190 return MONO_UNSIGNED_INTEGER_VALUE_SIZE_1;
1193 return MONO_INTEGER_VALUE_SIZE_2;
1196 return MONO_UNSIGNED_INTEGER_VALUE_SIZE_2;
1199 return MONO_INTEGER_VALUE_SIZE_4;
1202 return MONO_UNSIGNED_INTEGER_VALUE_SIZE_4;
1205 return SIZEOF_VOID_P;
1208 return (MONO_UNSIGNED_VALUE_FLAG|SIZEOF_VOID_P);
1211 return MONO_INTEGER_VALUE_SIZE_8;
1214 return MONO_UNSIGNED_INTEGER_VALUE_SIZE_8;
1216 return MONO_UNKNOWN_INTEGER_VALUE;
1221 * mono_perform_abc_removal:
1222 * @cfg: Control Flow Graph
1224 * Performs the ABC removal from a cfg in SSA form.
1225 * It does the following:
1226 * - Prepare the evaluation area
1227 * - Allocate memory for the relation graph in the evaluation area
1228 * (of course, only for variable definitions) and summarize there all
1229 * variable definitions
1230 * - Allocate memory for the evaluation contexts in the evaluation area
1231 * - Recursively process all the BBs in the dominator tree (it is enough
1232 * to invoke the processing on the entry BB)
1234 * cfg: the method code
1237 mono_perform_abc_removal (MonoCompile *cfg)
1239 MonoVariableRelationsEvaluationArea area;
1243 verbose_level = cfg->verbose_level;
1245 if (TRACE_ABC_REMOVAL) {
1246 printf ("\nRemoving array bound checks in %s\n", mono_method_full_name (cfg->method, TRUE));
1250 area.relations = (MonoSummarizedValueRelation *)
1251 mono_mempool_alloc (cfg->mempool, sizeof (MonoSummarizedValueRelation) * (cfg->next_vreg) * 2);
1252 area.contexts = (MonoRelationsEvaluationContext *)
1253 mono_mempool_alloc (cfg->mempool, sizeof (MonoRelationsEvaluationContext) * (cfg->next_vreg));
1254 area.variable_value_kind = (MonoIntegerValueKind *)
1255 mono_mempool_alloc (cfg->mempool, sizeof (MonoIntegerValueKind) * (cfg->next_vreg));
1256 for (i = 0; i < cfg->next_vreg; i++) {
1257 area.variable_value_kind [i] = MONO_UNKNOWN_INTEGER_VALUE;
1258 area.relations [i].relation = MONO_EQ_RELATION;
1259 area.relations [i].relation_is_static_definition = TRUE;
1260 MAKE_VALUE_ANY (area.relations [i].related_value);
1261 area.relations [i].next = NULL;
1264 for (bb = cfg->bb_entry; bb; bb = bb->next_bb) {
1267 if (TRACE_ABC_REMOVAL)
1268 printf ("\nABCREM BLOCK %d:\n", bb->block_num);
1270 for (ins = bb->code; ins; ins = ins->next) {
1271 const char *spec = INS_INFO (ins->opcode);
1273 if (spec [MONO_INST_DEST] == ' ' || MONO_IS_STORE_MEMBASE (ins))
1276 if (spec [MONO_INST_DEST] == 'i') {
1277 MonoIntegerValueKind effective_value_kind;
1278 MonoRelationsEvaluationRange range;
1279 MonoSummarizedValueRelation *type_relation;
1282 if (TRACE_ABC_REMOVAL)
1283 mono_print_ins (ins);
1285 var = get_vreg_to_inst (cfg, ins->dreg);
1287 area.variable_value_kind [ins->dreg] = type_to_value_kind (var->inst_vtype);
1289 effective_value_kind = get_relation_from_ins (&area, ins, &area.relations [ins->dreg], area.variable_value_kind [ins->dreg]);
1291 MONO_MAKE_RELATIONS_EVALUATION_RANGE_WEAK (range);
1292 apply_value_kind_to_range (&range, area.variable_value_kind [ins->dreg]);
1293 apply_value_kind_to_range (&range, effective_value_kind);
1295 if (range.upper < INT_MAX) {
1296 type_relation = (MonoSummarizedValueRelation *) mono_mempool_alloc (cfg->mempool, sizeof (MonoSummarizedValueRelation));
1297 type_relation->relation = MONO_LE_RELATION;
1298 type_relation->related_value.type = MONO_CONSTANT_SUMMARIZED_VALUE;
1299 type_relation->related_value.value.constant.value = range.upper;
1300 type_relation->relation_is_static_definition = TRUE;
1301 type_relation->next = area.relations [ins->dreg].next;
1302 area.relations [ins->dreg].next = type_relation;
1303 if (TRACE_ABC_REMOVAL) {
1304 printf ("[var%d <= %d]", ins->dreg, range.upper);
1307 if (range.lower > INT_MIN) {
1308 type_relation = (MonoSummarizedValueRelation *) mono_mempool_alloc (cfg->mempool, sizeof (MonoSummarizedValueRelation));
1309 type_relation->relation = MONO_GE_RELATION;
1310 type_relation->related_value.type = MONO_CONSTANT_SUMMARIZED_VALUE;
1311 type_relation->related_value.value.constant.value = range.lower;
1312 type_relation->relation_is_static_definition = TRUE;
1313 type_relation->next = area.relations [ins->dreg].next;
1314 area.relations [ins->dreg].next = type_relation;
1315 if (TRACE_ABC_REMOVAL) {
1316 printf ("[var%d >= %d]", ins->dreg, range.lower);
1319 if (TRACE_ABC_REMOVAL) {
1320 printf ("Summarized variable %d: ", ins->dreg);
1321 print_summarized_value (&(area.relations [ins->dreg].related_value));
1328 /* Add symmetric relations */
1329 for (i = 0; i < cfg->next_vreg; i++) {
1330 if (area.relations [i].related_value.type == MONO_VARIABLE_SUMMARIZED_VALUE) {
1331 int related_index = cfg->next_vreg + i;
1332 int related_variable = area.relations [i].related_value.value.variable.variable;
1334 area.relations [related_index].relation = MONO_EQ_RELATION;
1335 area.relations [related_index].relation_is_static_definition = TRUE;
1336 area.relations [related_index].related_value.type = MONO_VARIABLE_SUMMARIZED_VALUE;
1337 area.relations [related_index].related_value.value.variable.variable = i;
1338 area.relations [related_index].related_value.value.variable.delta = - area.relations [i].related_value.value.variable.delta;
1340 area.relations [related_index].next = area.relations [related_variable].next;
1341 area.relations [related_variable].next = &(area.relations [related_index]);
1343 if (TRACE_ABC_REMOVAL) {
1344 printf ("Added symmetric summarized value for variable variable %d (to %d): ", i, related_variable);
1345 print_summarized_value (&(area.relations [related_index].related_value));
1351 process_block (cfg, cfg->bblocks [0], &area);
1354 #endif /* DISABLE_JIT */