2 * Copyright (C) 1995-2008 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 Memory disambiguator
23 * @author Michael Beck
35 #include "irgraph_t.h"
37 #include "irmemory_t.h"
48 /** The debug handle. */
49 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
51 /** The source language specific language disambiguator function. */
52 static DISAMBIGUATOR_FUNC language_disambuigator = NULL;
54 /** The global memory disambiguator options. */
55 static unsigned global_mem_disamgig_opt = aa_opt_no_opt;
57 /* Returns a human readable name for an alias relation. */
58 const char *get_ir_alias_relation_name(ir_alias_relation rel) {
59 #define X(a) case a: return #a
64 default: assert(0); return "UNKNOWN";
69 /* Get the memory disambiguator options for a graph. */
70 unsigned get_irg_memory_disambiguator_options(ir_graph *irg) {
71 unsigned opt = irg->mem_disambig_opt;
72 if (opt & aa_opt_inherited)
73 return global_mem_disamgig_opt;
75 } /* get_irg_memory_disambiguator_options */
77 /* Set the memory disambiguator options for a graph. */
78 void set_irg_memory_disambiguator_options(ir_graph *irg, unsigned options) {
79 irg->mem_disambig_opt = options & ~aa_opt_inherited;
80 } /* set_irg_memory_disambiguator_options */
82 /* Set the global disambiguator options for all graphs not having local options. */
83 void set_irp_memory_disambiguator_options(unsigned options) {
84 global_mem_disamgig_opt = options;
85 } /* set_irp_memory_disambiguator_options */
88 * Find the base address and entity of an Sel node.
91 * @param pEnt after return points to the base entity.
93 * @return the base address.
95 static ir_node *find_base_adr(ir_node *sel, ir_entity **pEnt) {
96 ir_node *ptr = get_Sel_ptr(sel);
100 ptr = get_Sel_ptr(sel);
102 *pEnt = get_Sel_entity(sel);
104 } /* find_base_adr */
107 * Check if a given Const node is greater or equal a given size.
109 * @param cns a Const node
110 * @param size a integer size
112 * @return ir_no_alias if the Const is greater, ir_may_alias else
114 static ir_alias_relation check_const(ir_node *cns, int size) {
115 tarval *tv = get_Const_tarval(cns);
119 return tarval_is_null(tv) ? ir_may_alias : ir_no_alias;
120 tv_size = new_tarval_from_long(size, get_tarval_mode(tv));
121 return tarval_cmp(tv_size, tv) & (pn_Cmp_Eq|pn_Cmp_Lt) ? ir_no_alias : ir_may_alias;
125 * Treat idx1 and idx2 as integer indexes and check if they differ always more than size.
127 * @param idx1 a node representing the first index
128 * @param idx2 a node representing the second index
129 * @param size an integer size
131 * @return ir_sure_alias iff idx1 == idx2
132 * ir_no_alias iff they ALWAYS differ more than size
135 static ir_alias_relation different_index(ir_node *idx1, ir_node *idx2, int size) {
137 return ir_sure_alias;
138 if (is_Const(idx1) && is_Const(idx2)) {
139 /* both are const, we can compare them */
140 tarval *tv1 = get_Const_tarval(idx1);
141 tarval *tv2 = get_Const_tarval(idx2);
142 tarval *tv, *tv_size;
146 return tv1 == tv2 ? ir_sure_alias : ir_no_alias;
148 /* arg, modes may be different */
149 m1 = get_tarval_mode(tv1);
150 m2 = get_tarval_mode(tv2);
152 int size = get_mode_size_bits(m1) - get_mode_size_bits(m2);
155 /* m1 is a small mode, cast up */
156 m1 = mode_is_signed(m1) ? find_signed_mode(m2) : find_unsigned_mode(m2);
158 /* should NOT happen, but if it does we give up here */
161 tv1 = tarval_convert_to(tv1, m1);
162 } else if (size > 0) {
163 /* m2 is a small mode, cast up */
164 m2 = mode_is_signed(m2) ? find_signed_mode(m1) : find_unsigned_mode(m1);
166 /* should NOT happen, but if it does we give up here */
169 tv2 = tarval_convert_to(tv2, m2);
171 /* here the size should be identical, check for signed */
172 if (get_mode_sign(m1) != get_mode_sign(m2)) {
173 /* find the signed */
174 if (mode_is_signed(m2)) {
181 /* m1 is now the signed one */
182 if (tarval_cmp(tv1, get_tarval_null(m1)) & (pn_Cmp_Eq|pn_Cmp_Gt)) {
183 /* tv1 is signed, but >= 0, simply cast into unsigned */
184 tv1 = tarval_convert_to(tv1, m2);
186 tv_size = new_tarval_from_long(size, m2);
188 if (tarval_cmp(tv2, tv_size) & (pn_Cmp_Eq|pn_Cmp_Gt)) {
189 /* tv1 is negative and tv2 >= tv_size, so the difference is bigger than size */
192 /* tv_size > tv2, so we can subtract without overflow */
193 tv2 = tarval_sub(tv_size, tv2, NULL);
195 /* tv1 is < 0, so we can negate it */
196 tv1 = tarval_neg(tv1);
198 /* cast it into unsigned. for two-complement it does the right thing for MIN_INT */
199 tv1 = tarval_convert_to(tv1, m2);
201 /* now we can compare without overflow */
202 return tarval_cmp(tv1, tv2) & (pn_Cmp_Eq|pn_Cmp_Gt) ? ir_no_alias : ir_may_alias;
206 if (tarval_cmp(tv1, tv2) == pn_Cmp_Gt) {
211 /* tv1 is now the "smaller" one */
212 tv = tarval_sub(tv2, tv1, NULL);
213 tv_size = new_tarval_from_long(size, get_tarval_mode(tv));
214 return tarval_cmp(tv_size, tv) & (pn_Cmp_Eq|pn_Cmp_Lt) ? ir_no_alias : ir_may_alias;
217 /* Note: we rely here on the fact that normalization puts constants on the RIGHT side */
219 ir_node *l1 = get_Add_left(idx1);
220 ir_node *r1 = get_Add_right(idx1);
225 return check_const(r1, size);
228 /* both are Adds, check if they are of x + a == x + b kind */
229 ir_node *l2 = get_Add_left(idx2);
230 ir_node *r2 = get_Add_right(idx2);
233 return different_index(r1, r2, size);
235 return different_index(r1, l2, size);
237 return different_index(l1, l2, size);
239 return different_index(l1, r2, size);
243 ir_node *l2 = get_Add_left(idx2);
244 ir_node *r2 = get_Add_right(idx2);
249 return check_const(r2, size);
254 ir_node *l1 = get_Sub_left(idx1);
255 ir_node *r1 = get_Sub_right(idx1);
260 return check_const(r1, size);
264 /* both are Subs, check if they are of x - a == x - b kind */
265 ir_node *l2 = get_Sub_left(idx2);
268 ir_node *r2 = get_Sub_right(idx2);
269 return different_index(r1, r2, size);
274 ir_node *l2 = get_Sub_left(idx2);
275 ir_node *r2 = get_Sub_right(idx2);
280 return check_const(r2, size);
285 } /* different_index */
288 * Two Sel addresses have the same base address, check if there offsets are
291 * @param adr1 The first address.
292 * @param adr2 The second address.
294 static ir_alias_relation different_sel_offsets(ir_node *sel1, ir_node *sel2) {
295 /* seems to be broken */
299 ir_entity *ent1 = get_Sel_entity(sel1);
300 ir_entity *ent2 = get_Sel_entity(sel2);
301 int i, check_arr = 0;
306 ir_type *tp1 = get_entity_type(ent1);
307 ir_type *tp2 = get_entity_type(ent2);
311 else if (get_type_state(tp1) == layout_fixed && get_type_state(tp2) == layout_fixed &&
312 get_type_size_bits(tp1) == get_type_size_bits(tp2))
316 /* we select an entity of same size, check for indexes */
317 int n = get_Sel_n_indexs(sel1);
320 if (n > 0 && n == get_Sel_n_indexs(sel2)) {
321 /* same non-zero number of indexes, an array access, check */
322 for (i = 0; i < n; ++i) {
323 ir_node *idx1 = get_Sel_index(sel1, i);
324 ir_node *idx2 = get_Sel_index(sel2, i);
325 ir_alias_relation res = different_index(idx1, idx2, 0); /* we can safely IGNORE the size here if it's at least >0 */
327 if (res == may_alias)
329 else if (res == no_alias)
332 /* if we have at least one no_alias, there is no alias relation, else we have sure */
333 return have_no > 0 ? no_alias : sure_alias;
338 } /* different_sel_offsets */
341 * Determine the alias relation by checking if adr1 and adr2 are pointer
344 * @param adr1 The first address.
345 * @param adr2 The second address.
347 static ir_alias_relation different_types(ir_node *adr1, ir_node *adr2)
349 ir_entity *ent1 = NULL, *ent2 = NULL;
352 ent1 = get_Global_entity(adr1);
353 else if (is_Sel(adr1))
354 ent1 = get_Sel_entity(adr1);
357 ent2 = get_Global_entity(adr2);
358 else if (is_Sel(adr2))
359 ent2 = get_Sel_entity(adr2);
361 if (ent1 != NULL && ent2 != NULL) {
362 ir_type *tp1 = get_entity_type(ent1);
363 ir_type *tp2 = get_entity_type(ent2);
367 /* do deref until no pointer types are found */
368 while (is_Pointer_type(tp1) && is_Pointer_type(tp2)) {
369 tp1 = get_pointer_points_to_type(tp1);
370 tp2 = get_pointer_points_to_type(tp2);
374 if (get_type_tpop(tp1) != get_type_tpop(tp2)) {
375 /* different type structure */
378 if (is_Class_type(tp1)) {
379 /* check class hierarchy */
380 if (! is_SubClass_of(tp1, tp2) &&
381 ! is_SubClass_of(tp2, tp1))
384 /* different types */
390 } /* different_types */
393 * Returns non-zero if a node is a result on a malloc-like routine.
395 * @param node the Proj node to test
397 static int is_malloc_Result(ir_node *node) {
398 node = get_Proj_pred(node);
401 node = get_Proj_pred(node);
404 node = get_Call_ptr(node);
405 if (is_Global(node)) {
406 ir_entity *ent = get_Global_entity(node);
408 if (get_entity_additional_properties(ent) & mtp_property_malloc)
413 } /* is_malloc_Result */
416 * Classify a base pointer.
418 * @param irg the graph of the pointer
419 * @param irn the node representing the base address
420 * @param ent the base entity of the base address iff any
422 ir_storage_class_class_t classify_pointer(ir_graph *irg, ir_node *irn, ir_entity *ent)
424 ir_storage_class_class_t res = ir_sc_pointer;
425 if (is_Global(irn)) {
426 ir_entity *entity = get_Global_entity(irn);
427 res = ir_sc_globalvar;
428 if (! (get_entity_usage(entity) & ir_usage_address_taken))
429 res |= ir_sc_modifier_nottaken;
430 } else if (irn == get_irg_frame(irg)) {
431 res = ir_sc_localvar;
432 if (ent != NULL && !(get_entity_usage(ent) & ir_usage_address_taken))
433 res |= ir_sc_modifier_nottaken;
434 } else if (is_arg_Proj(irn)) {
435 return ir_sc_argument;
436 } else if (irn == get_irg_tls(irg)) {
438 if (ent != NULL && !(get_entity_usage(ent) & ir_usage_address_taken))
439 res |= ir_sc_modifier_nottaken;
440 } else if (is_Proj(irn) && is_malloc_Result(irn)) {
441 return ir_sc_malloced;
448 * If adr represents a Bitfield Sel, skip it
450 static ir_node *skip_Bitfield_Sels(ir_node *adr) {
452 ir_entity *ent = get_Sel_entity(adr);
453 ir_type *bf_type = get_entity_type(ent);
455 /* is it a bitfield type? */
456 if (is_Primitive_type(bf_type) && get_primitive_base_type(bf_type) != NULL)
457 adr = get_Sel_ptr(adr);
463 * Determine the alias relation between two addresses.
465 * @param irg the graph of both memory operations
466 * @param addr1 pointer address of the first memory operation
467 * @param mode1 the mode of the accessed data through addr1
468 * @param addr2 pointer address of the second memory operation
469 * @param mode2 the mode of the accessed data through addr2
471 * @return found memory relation
473 static ir_alias_relation _get_alias_relation(
475 ir_node *adr1, ir_mode *mode1,
476 ir_node *adr2, ir_mode *mode2)
478 ir_entity *ent1, *ent2;
484 ir_node *orig_adr1 = adr1;
485 ir_node *orig_adr2 = adr2;
487 ir_storage_class_class_t class1, class2;
488 int have_const_offsets;
490 if (! get_opt_alias_analysis())
494 return ir_sure_alias;
496 options = get_irg_memory_disambiguator_options(irg);
498 /* The Armageddon switch */
499 if (options & aa_opt_no_alias)
502 /* do the addresses have constants offsets?
503 * Note: nodes are normalized to have constants at right inputs,
504 * sub X, C is normalized to add X, -C
506 have_const_offsets = 1;
507 while (is_Add(adr1)) {
508 ir_node *add_right = get_Add_right(adr1);
509 if (is_Const(add_right) && !mode_is_reference(get_irn_mode(add_right))) {
510 tarval *tv = get_Const_tarval(add_right);
511 offset1 += get_tarval_long(tv);
512 adr1 = get_Add_left(adr1);
513 } else if (mode_is_reference(get_irn_mode(add_right))) {
515 have_const_offsets = 0;
517 adr1 = get_Add_left(adr1);
518 have_const_offsets = 0;
521 while (is_Add(adr2)) {
522 ir_node *add_right = get_Add_right(adr2);
523 if (is_Const(add_right) && !mode_is_reference(get_irn_mode(add_right))) {
524 tarval *tv = get_Const_tarval(add_right);
525 offset2 += get_tarval_long(tv);
526 adr2 = get_Add_left(adr2);
527 } else if (mode_is_reference(get_irn_mode(add_right))) {
529 have_const_offsets = 0;
531 adr2 = get_Add_left(adr2);
532 have_const_offsets = 0;
536 mode_size = get_mode_size_bytes(mode1);
537 if (get_mode_size_bytes(mode2) > mode_size) {
538 mode_size = get_mode_size_bytes(mode2);
541 /* same base address -> compare offsets if possible.
542 * FIXME: type long is not sufficient for this task ...
544 if (adr1 == adr2 && have_const_offsets) {
545 if ((unsigned long)labs(offset2 - offset1) >= mode_size)
548 return ir_sure_alias;
552 * Bitfields can be constructed as Sels from its base address.
553 * As they have different entities, the disambiguator would find that they are
554 * alias free. While this is true for it's values, it is false for the addresses
555 * (strictly speaking, the Sel's are NOT the addresses of the bitfields).
556 * So, skip those bitfield selecting Sel's.
558 adr1 = skip_Bitfield_Sels(adr1);
559 adr2 = skip_Bitfield_Sels(adr2);
567 base1 = find_base_adr(adr1, &ent1);
570 base2 = find_base_adr(adr2, &ent2);
573 /* same base address -> compare Sel entities */
574 if (base1 == base2 && ent1 != NULL && ent2 != NULL) {
577 else if (have_const_offsets)
578 return different_sel_offsets(adr1, adr2);
581 class1 = classify_pointer(irg, base1, ent1);
582 class2 = classify_pointer(irg, base2, ent2);
584 if (class1 == ir_sc_pointer) {
585 if (class2 & ir_sc_modifier_nottaken) {
586 /* a pointer and an object whose objects was never taken */
589 } else if (class2 == ir_sc_pointer) {
590 if (class1 & ir_sc_modifier_nottaken) {
591 /* a pointer and an object whose objects was never taken */
594 } else if (class1 != class2) {
595 /* two objects from different memory spaces */
598 /* both classes are equal */
599 if (class1 == ir_sc_globalvar) {
600 ir_entity *entity1 = get_SymConst_entity(base1);
601 ir_entity *entity2 = get_SymConst_entity(base2);
602 if (entity1 != entity2)
605 /* for some reason CSE didn't happen yet for the 2 SymConsts... */
610 /* Type based alias analysis */
611 if (options & aa_opt_type_based) {
612 ir_alias_relation rel;
614 if (options & aa_opt_byte_type_may_alias) {
615 if (get_mode_size_bits(mode1) == 8 || get_mode_size_bits(mode2) == 8) {
616 /* One of the modes address a byte. Assume a ir_may_alias and leave
617 the type based check. */
618 goto leave_type_based_alias;
621 /* cheap check: If the mode sizes did not match, the types MUST be different */
622 if (get_mode_size_bits(mode1) != get_mode_size_bits(mode2))
625 /* cheap test: if only one is a reference mode, no alias */
626 if (mode_is_reference(mode1) != mode_is_reference(mode2))
629 /* cheap test: if arithmetic is different, no alias */
630 if (get_mode_arithmetic(mode1) != get_mode_arithmetic(mode2))
634 rel = different_types(orig_adr1, orig_adr2);
635 if (rel != ir_may_alias)
637 leave_type_based_alias:;
640 /* do we have a language specific memory disambiguator? */
641 if (language_disambuigator) {
642 ir_alias_relation rel = (*language_disambuigator)(irg, orig_adr1, mode1, orig_adr2, mode2);
643 if (rel != ir_may_alias)
647 /* access points-to information here */
649 } /* _get_alias_relation */
652 * Determine the alias relation between two addresses.
654 ir_alias_relation get_alias_relation(
656 ir_node *adr1, ir_mode *mode1,
657 ir_node *adr2, ir_mode *mode2)
659 ir_alias_relation rel = _get_alias_relation(irg, adr1, mode1, adr2, mode2);
660 DB((dbg, LEVEL_1, "alias(%+F, %+F) = %s\n", adr1, adr2, get_ir_alias_relation_name(rel)));
662 } /* get_alias_relation */
664 /* Set a source language specific memory disambiguator function. */
665 void set_language_memory_disambiguator(DISAMBIGUATOR_FUNC func) {
666 language_disambuigator = func;
667 } /* set_language_memory_disambiguator */
669 /** The result cache for the memory disambiguator. */
670 static set *result_cache = NULL;
672 /** An entry in the relation cache. */
673 typedef struct mem_disambig_entry {
674 ir_node *adr1; /**< The first address. */
675 ir_node *adr2; /**< The second address. */
676 ir_alias_relation result; /**< The alias relation result. */
677 } mem_disambig_entry;
679 #define HASH_ENTRY(adr1, adr2) (HASH_PTR(adr1) ^ HASH_PTR(adr2))
682 * Compare two relation cache entries.
684 static int cmp_mem_disambig_entry(const void *elt, const void *key, size_t size) {
685 const mem_disambig_entry *p1 = elt;
686 const mem_disambig_entry *p2 = key;
689 return p1->adr1 == p2->adr1 && p1->adr2 == p2->adr2;
690 } /* cmp_mem_disambig_entry */
693 * Initialize the relation cache.
695 void mem_disambig_init(void) {
696 result_cache = new_set(cmp_mem_disambig_entry, 8);
697 } /* mem_disambig_init */
700 * Determine the alias relation between two addresses.
702 ir_alias_relation get_alias_relation_ex(
704 ir_node *adr1, ir_mode *mode1,
705 ir_node *adr2, ir_mode *mode2)
707 mem_disambig_entry key, *entry;
709 ir_fprintf(stderr, "%+F <-> %+F\n", adr1, adr2);
711 if (! get_opt_alias_analysis())
714 if (get_irn_opcode(adr1) > get_irn_opcode(adr2)) {
722 entry = set_find(result_cache, &key, sizeof(key), HASH_ENTRY(adr1, adr2));
724 return entry->result;
726 key.result = get_alias_relation(irg, adr1, mode1, adr2, mode2);
728 set_insert(result_cache, &key, sizeof(key), HASH_ENTRY(adr1, adr2));
730 } /* get_alias_relation_ex */
732 /* Free the relation cache. */
733 void mem_disambig_term(void) {
735 del_set(result_cache);
738 } /* mem_disambig_term */
741 * Check the mode of a Load/Store with the mode of the entity
743 * If the mode of the entity and the Load/Store mode do not match, we
744 * have the bad reinterpret case:
747 * char b = *(char *)&i;
749 * We do NOT count this as one value and return address_taken
751 * However, we support an often used case. If the mode is two-complement
752 * we allow casts between signed/unsigned.
754 * @param mode the mode of the Load/Store
755 * @param ent_mode the mode of the accessed entity
757 * @return non-zero if the Load/Store is a hidden cast, zero else
759 static int is_hidden_cast(ir_mode *mode, ir_mode *ent_mode) {
760 if (ent_mode == NULL)
763 if (ent_mode != mode) {
764 if (ent_mode == NULL ||
765 get_mode_size_bits(ent_mode) != get_mode_size_bits(mode) ||
766 get_mode_sort(ent_mode) != get_mode_sort(mode) ||
767 get_mode_arithmetic(ent_mode) != irma_twos_complement ||
768 get_mode_arithmetic(mode) != irma_twos_complement)
772 } /* is_hidden_cast */
775 * Determine the usage state of a node (or it's successor Sels).
777 * @param irn the node
779 static ir_entity_usage determine_entity_usage(const ir_node *irn, ir_entity *entity) {
781 ir_mode *emode, *mode;
784 ir_entity_usage res = 0;
786 for (i = get_irn_n_outs(irn) - 1; i >= 0; --i) {
787 ir_node *succ = get_irn_out(irn, i);
789 switch (get_irn_opcode(succ)) {
791 assert(irn == get_Load_ptr(succ));
792 res |= ir_usage_read;
794 /* check if this load is not a hidden conversion */
795 mode = get_Load_mode(succ);
796 emode = get_type_mode(get_entity_type(entity));
797 if (is_hidden_cast(mode, emode))
798 res |= ir_usage_reinterpret_cast;
802 /* check that the node is not the Store's value */
803 if (irn == get_Store_value(succ)) {
804 res |= ir_usage_unknown;
806 if (irn == get_Store_ptr(succ)) {
807 res |= ir_usage_write;
809 /* check if this Store is not a hidden conversion */
810 value = get_Store_value(succ);
811 mode = get_irn_mode(value);
812 emode = get_type_mode(get_entity_type(entity));
813 if (is_hidden_cast(mode, emode))
814 res |= ir_usage_reinterpret_cast;
816 assert(irn != get_Store_mem(succ));
820 /* CopyB are like Loads/Stores */
821 tp = get_entity_type(entity);
822 if (tp != get_CopyB_type(succ)) {
823 /* bad, different types, might be a hidden conversion */
824 res |= ir_usage_reinterpret_cast;
826 if (irn == get_CopyB_dst(succ)) {
827 res |= ir_usage_write;
829 assert(irn == get_CopyB_src(succ));
830 res |= ir_usage_read;
837 /* Check the successor of irn. */
838 res |= determine_entity_usage(succ, entity);
843 if (irn == get_Call_ptr(succ)) {
844 /* TODO: we could check for reinterpret casts here...
845 * But I doubt anyone is interested in that bit for
846 * function entities and I'm too lazy to write the code now.
848 res |= ir_usage_read;
850 assert(irn != get_Call_mem(succ));
851 res |= ir_usage_unknown;
856 /* another op, we don't know anything */
857 res |= ir_usage_unknown;
866 * Update the usage flags of all frame entities.
868 static void analyse_irg_entity_usage(ir_graph *irg) {
869 ir_type *ft = get_irg_frame_type(irg);
873 /* set initial state to not_taken, as this is the "smallest" state */
874 for (i = get_class_n_members(ft) - 1; i >= 0; --i) {
875 ir_entity *ent = get_class_member(ft, i);
877 set_entity_usage(ent, 0);
880 assure_irg_outs(irg);
882 irg_frame = get_irg_frame(irg);
884 for (i = get_irn_n_outs(irg_frame) - 1; i >= 0; --i) {
885 ir_node *succ = get_irn_out(irg_frame, i);
887 ir_entity_usage flags;
892 entity = get_Sel_entity(succ);
893 flags = get_entity_usage(entity);
894 flags |= determine_entity_usage(succ, entity);
895 set_entity_usage(entity, flags);
899 irg->entity_usage_state = ir_entity_usage_computed;
902 ir_entity_usage_computed_state get_irg_entity_usage_state(const ir_graph *irg) {
903 return irg->entity_usage_state;
906 void set_irg_entity_usage_state(ir_graph *irg, ir_entity_usage_computed_state state) {
907 irg->entity_usage_state = state;
910 void assure_irg_entity_usage_computed(ir_graph *irg) {
911 if (irg->entity_usage_state != ir_entity_usage_not_computed)
914 analyse_irg_entity_usage(irg);
919 * Initialize the entity_usage flag for a global type like type.
921 static void init_entity_usage(ir_type * tp) {
924 /* We have to be conservative: All external visible entities are unknown */
925 for (i = get_compound_n_members(tp) - 1; i >= 0; --i) {
926 ir_entity *entity = get_compound_member(tp, i);
927 ir_entity_usage flags;
929 flags = get_entity_visibility(entity) == visibility_external_visible ?
930 ir_usage_unknown : 0;
931 set_entity_usage(entity, flags);
935 static void check_initializer_nodes(ir_initializer_t *initializer)
937 switch (initializer->kind) {
938 case IR_INITIALIZER_CONST: {
939 ir_node *n = initializer->consti.value;
941 /* let's check if it's an address */
943 ir_entity *ent = get_Global_entity(n);
944 set_entity_usage(ent, ir_usage_unknown);
948 case IR_INITIALIZER_TARVAL:
949 case IR_INITIALIZER_NULL:
951 case IR_INITIALIZER_COMPOUND: {
954 for (i = 0; i < initializer->compound.n_initializers; ++i) {
955 ir_initializer_t *sub_initializer
956 = initializer->compound.initializers[i];
957 check_initializer_nodes(sub_initializer);
962 panic("invalid initializer found");
963 } /* check_initializer_nodes */
966 * Mark all entities used in the initializer for the given entity as address taken.
968 * @param ent the entity
970 static void check_initializer(ir_entity *ent) {
974 /* do not check uninitialized values */
975 if (get_entity_variability(ent) == variability_uninitialized)
978 /* Beware: Methods are always initialized with "themself". This does not
979 count as a taken address. */
980 if (is_Method_type(get_entity_type(ent)))
983 if (ent->has_initializer) {
984 check_initializer_nodes(ent->attr.initializer);
985 } else if (is_atomic_entity(ent)) {
986 /* let's check if it's an address */
987 n = get_atomic_ent_value(ent);
989 ir_entity *ent = get_Global_entity(n);
990 set_entity_usage(ent, ir_usage_unknown);
993 for (i = get_compound_ent_n_values(ent) - 1; i >= 0; --i) {
994 n = get_compound_ent_value(ent, i);
996 /* let's check if it's an address */
998 ir_entity *ent = get_Global_entity(n);
999 set_entity_usage(ent, ir_usage_unknown);
1003 } /* check_initializer */
1007 * Mark all entities used in initializers as address taken.
1009 * @param tp a compound type
1011 static void check_initializers(ir_type *tp) {
1014 for (i = get_compound_n_members(tp) - 1; i >= 0; --i) {
1015 ir_entity *ent = get_compound_member(tp, i);
1017 check_initializer(ent);
1019 } /* check_initializers */
1021 #ifdef DEBUG_libfirm
1023 * Print the entity usage flags of all entities of a given type for debugging.
1025 * @param tp a compound type
1027 static void print_entity_usage_flags(ir_type *tp) {
1029 for (i = get_compound_n_members(tp) - 1; i >= 0; --i) {
1030 ir_entity *ent = get_compound_member(tp, i);
1031 ir_entity_usage flags = get_entity_usage(ent);
1036 if (flags & ir_usage_address_taken)
1037 printf(" address_taken");
1038 if (flags & ir_usage_read)
1040 if (flags & ir_usage_write)
1042 if (flags & ir_usage_reinterpret_cast)
1043 printf(" reinterp_cast");
1047 #endif /* DEBUG_libfirm */
1050 * Post-walker: check for global entity address
1052 static void check_global_address(ir_node *irn, void *env) {
1055 ir_entity_usage flags;
1057 if (is_Global(irn)) {
1059 ent = get_Global_entity(irn);
1060 } else if (is_Sel(irn) && get_Sel_ptr(irn) == tls) {
1061 /* A TLS variable. */
1062 ent = get_Sel_entity(irn);
1066 flags = get_entity_usage(ent);
1067 flags |= determine_entity_usage(irn, ent);
1068 set_entity_usage(ent, flags);
1069 } /* check_global_address */
1072 * Update the entity usage flags of all global entities.
1074 static void analyse_irp_globals_entity_usage(void) {
1078 for (s = IR_SEGMENT_FIRST; s < IR_SEGMENT_COUNT; ++s) {
1079 ir_type *type = get_segment_type(s);
1080 init_entity_usage(type);
1083 for (s = IR_SEGMENT_FIRST; s < IR_SEGMENT_COUNT; ++s) {
1084 ir_type *type = get_segment_type(s);
1085 check_initializers(type);
1088 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
1089 ir_graph *irg = get_irp_irg(i);
1091 assure_irg_outs(irg);
1092 irg_walk_graph(irg, NULL, check_global_address, get_irg_tls(irg));
1095 #ifdef DEBUG_libfirm
1096 if (firm_dbg_get_mask(dbg) & LEVEL_1) {
1098 for (s = IR_SEGMENT_FIRST; s < IR_SEGMENT_COUNT; ++s) {
1099 print_entity_usage_flags(get_segment_type(s));
1102 #endif /* DEBUG_libfirm */
1105 irp->globals_entity_usage_state = ir_entity_usage_computed;
1108 /* Returns the current address taken state of the globals. */
1109 ir_entity_usage_computed_state get_irp_globals_entity_usage_state(void) {
1110 return irp->globals_entity_usage_state;
1113 /* Sets the current address taken state of the graph. */
1114 void set_irp_globals_entity_usage_state(ir_entity_usage_computed_state state) {
1115 irp->globals_entity_usage_state = state;
1118 /* Assure that the address taken flag is computed for the globals. */
1119 void assure_irp_globals_entity_usage_computed(void) {
1120 if (irp->globals_entity_usage_state != ir_entity_usage_not_computed)
1123 analyse_irp_globals_entity_usage();
1126 void firm_init_memory_disambiguator(void) {
1127 FIRM_DBG_REGISTER(dbg, "firm.ana.irmemory");
1131 #include <adt/pmap.h>
1132 #include "typerep.h"
1134 DEBUG_ONLY(static firm_dbg_module_t *dbgcall = NULL;)
1136 /** Maps method types to cloned method types. */
1137 static pmap *mtp_map;
1140 * Clone a method type if not already cloned.
1142 * @param tp the type to clone
1144 static ir_type *clone_type_and_cache(ir_type *tp) {
1145 static ident *prefix = NULL;
1147 pmap_entry *e = pmap_find(mtp_map, tp);
1153 prefix = new_id_from_chars("C", 1);
1155 res = clone_type_method(tp, prefix);
1156 pmap_insert(mtp_map, tp, res);
1157 DB((dbgcall, LEVEL_2, "cloned type %+F into %+F\n", tp, res));
1160 } /* clone_type_and_cache */
1163 * Walker: clone all call types of Calls to methods having the
1164 * mtp_property_private property set.
1166 static void update_calls_to_private(ir_node *call, void *env) {
1168 if (is_Call(call)) {
1169 ir_node *ptr = get_Call_ptr(call);
1171 if (is_SymConst(ptr)) {
1172 ir_entity *ent = get_SymConst_entity(ptr);
1173 ir_type *ctp = get_Call_type(call);
1175 if (get_entity_additional_properties(ent) & mtp_property_private) {
1176 if ((get_method_additional_properties(ctp) & mtp_property_private) == 0) {
1177 ctp = clone_type_and_cache(ctp);
1178 set_method_additional_property(ctp, mtp_property_private);
1179 set_Call_type(call, ctp);
1180 DB((dbgcall, LEVEL_1, "changed call to private method %+F\n", ent));
1185 } /* update_calls_to_private */
1187 /* Mark all private methods, i.e. those of which all call sites are known. */
1188 void mark_private_methods(void) {
1192 FIRM_DBG_REGISTER(dbgcall, "firm.opt.cc");
1194 assure_irp_globals_entity_usage_computed();
1196 mtp_map = pmap_create();
1198 /* first step: change the calling conventions of the local non-escaped entities */
1199 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
1200 ir_graph *irg = get_irp_irg(i);
1201 ir_entity *ent = get_irg_entity(irg);
1202 ir_entity_usage flags = get_entity_usage(ent);
1204 /* If an entity is sticky, it might be called from external
1205 places (like inline assembler), so do NOT mark it as private. */
1206 if (get_entity_visibility(ent) == visibility_local &&
1207 !(flags & ir_usage_address_taken) &&
1208 get_entity_stickyness(ent) != stickyness_sticky) {
1209 ir_type *mtp = get_entity_type(ent);
1211 set_entity_additional_property(ent, mtp_property_private);
1212 DB((dbgcall, LEVEL_1, "found private method %+F\n", ent));
1213 if ((get_method_additional_properties(mtp) & mtp_property_private) == 0) {
1214 /* need a new type */
1215 mtp = clone_type_and_cache(mtp);
1216 set_entity_type(ent, mtp);
1217 set_method_additional_property(mtp, mtp_property_private);
1224 all_irg_walk(NULL, update_calls_to_private, NULL);
1226 pmap_destroy(mtp_map);
1227 } /* mark_private_methods */