2 * Copyright (C) 1995-2010 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
27 #ifndef FIRM_ANA_IRMEMORY_H
28 #define FIRM_ANA_IRMEMORY_H
30 #include "firm_types.h"
33 /** The alias relation of two memory addresses. */
34 typedef enum ir_alias_relation {
35 ir_no_alias, /**< No alias. */
36 ir_may_alias, /**< Unknown state, may alias. */
37 ir_sure_alias /**< Sure alias. */
40 /** The state of the entity usage flags. */
41 typedef enum ir_entity_usage_computed_state {
42 ir_entity_usage_not_computed,
43 ir_entity_usage_computed
44 } ir_entity_usage_computed_state;
46 /** Possible options for the memory disambiguator. */
47 typedef enum ir_disambuigator_options {
48 aa_opt_no_opt = 0, /**< no options: most conservative */
49 aa_opt_type_based = 1, /**< use type based alias analysis: strict typed source language */
50 aa_opt_byte_type_may_alias = 2, /**< if type based analysis is enabled: bytes types may alias other types */
51 aa_opt_no_alias_args = 4, /**< arguments do not alias each other but may alias global storage */
52 aa_opt_no_alias_args_global = 8, /**< arguments do not alias global storage */
53 aa_opt_no_alias = 16, /**< two addresses NEVER alias, use with CAUTION (gcc -fno-alias) */
54 aa_opt_inherited = 128 /**< only for implementation: options from a graph are inherited from global */
55 } ir_disambuigator_options;
56 ENUM_BITSET(ir_disambuigator_options)
59 * Classify storage locations.
60 * Except ir_sc_pointer they are all disjoint.
61 * ir_sc_pointer potentially aliases all classes which don't have a
64 typedef enum ir_storage_class_class_t {
65 ir_sc_pointer = 0x0, /**< generic pointer, may be anything */
66 ir_sc_globalvar = 0x1, /**< an address of a global variable */
67 ir_sc_localvar = 0x2, /**< an address of a local variable or method argument */
68 ir_sc_tls = 0x3, /**< an address of a thread local storage variable */
69 ir_sc_malloced = 0x4, /**< an allocated heap address */
70 ir_sc_globaladdr = 0x5, /**< a constant address of something */
72 ir_sc_modifier_nottaken = 0x80, /**< if set, the address of the variable was not taken */
73 ir_sc_modifier_argument = 0x40, /**< if set pointer was a function argument */
74 ir_sc_modifiers = ir_sc_modifier_nottaken | ir_sc_modifier_argument
75 } ir_storage_class_class_t;
76 ENUM_BITSET(ir_storage_class_class_t)
78 /** Get the base storage class (ignore modifier) */
79 FIRM_API ir_storage_class_class_t get_base_sc(ir_storage_class_class_t x);
82 * A source language specific memory disambiguator function.
83 * Called by get_alias_relation().
85 typedef ir_alias_relation (*DISAMBIGUATOR_FUNC)(
86 const ir_node *adr1, const ir_mode *mode1,
87 const ir_node *adr2, const ir_mode *mode2);
90 * Classify a base pointer.
92 * @param irn the node representing the base address
93 * @param ent the base entity of the base address iff any
95 FIRM_API ir_storage_class_class_t classify_pointer(const ir_node *irn,
96 const ir_entity *ent);
99 * Returns a human readable name for an alias relation.
101 FIRM_API const char *get_ir_alias_relation_name(ir_alias_relation rel);
104 * Determine the alias relation between two addresses.
106 * @param adr1 The first address.
107 * @param mode1 The mode of the first memory access.
108 * @param adr2 The second address.
109 * @param mode2 The mode of the second memory access.
111 * The memory disambiguator tries to determine the alias state between
112 * two memory addresses. The following rules are used:
114 * - different variable from the same segment never alias (R1 a)
115 * - variables from different segments never alias when:
116 * - a global variable and a local one never alias (R1 b)
117 * - a global variable and a TLS one never alias (R1 c)
118 * - a local variable and a TLS one never alias (R1 d)
119 * - a local variable and a parameter never alias (R1 e)
120 * - a global variable and the result of a malloc routine never alias (R1 f)
121 * - a local variable and the result of a malloc routine never alias (R1 g)
122 * - a TLS variable and the result of a malloc routine never alias (R1 h)
123 * - a parameter and the result of a malloc routine (obtained in the
124 * same routine as the parameter) never alias (R1 i)
125 * - two different variables never alias (R2)
126 * - if one is a variable whose address has never been taken
127 * there is no alias (R3)
128 * - if two memory addresses have the same base and their offsets
129 * do not describe overlapping regions there is no alias (R4)
130 * - if opt_strong_typed is set and both addresses describe entities,
131 * different types never alias (R5)
133 * If none of these rules apply, the points-to framework must be
134 * interrogated to detect the alias relation.
136 FIRM_API ir_alias_relation get_alias_relation(
137 const ir_node *adr1, const ir_mode *mode1,
138 const ir_node *adr2, const ir_mode *mode2);
141 * Set a source language specific memory disambiguator function.
143 * @param func The callback.
145 FIRM_API void set_language_memory_disambiguator(DISAMBIGUATOR_FUNC func);
148 * Initialize the relation cache.
150 FIRM_API void mem_disambig_init(void);
153 * Determine the alias relation between two addresses and
156 * @param irg The current graph.
157 * @param adr1 The first address.
158 * @param mode1 The mode of the first memory access.
159 * @param adr2 The second address.
160 * @param mode2 The mode of the second memory access.
162 * @see get_alias_relation()
164 FIRM_API ir_alias_relation get_alias_relation_ex(
165 const ir_node *adr1, const ir_mode *mode1,
166 const ir_node *adr2, const ir_mode *mode2);
169 * Free the relation cache.
171 FIRM_API void mem_disambig_term(void);
174 * Assure that the entity usage flags have been computed for the given graph.
176 * This analysis computes the entity usage state for all local variables.
178 * Even then the information is not cleaned from the variables, call
179 * assure_irg_entity_usage_computed() again for recomputation.
181 FIRM_API void assure_irg_entity_usage_computed(ir_graph *irg);
184 * Returns the current address taken state of the globals.
186 FIRM_API ir_entity_usage_computed_state get_irp_globals_entity_usage_state(void);
189 * Sets the current address taken state of the globals.
191 * @param state the new state
193 FIRM_API void set_irp_globals_entity_usage_state(ir_entity_usage_computed_state state);
196 * Assure that the address taken flag is computed for the global and TLS entities (variables).
198 * This is an interprocedural analysis that computes the address_taken state
199 * for all global and TLS variables.
201 * Note that this is a conservative estimation that by no Firm transformation
202 * can be invalidated, so it's only recomputed if manually triggered by calling
203 * set_irp_globals_entity_usage_state(ir_entity_usage_not_computed).
204 * Even then the information is not cleaned from the variables, call
205 * assure_irp_globals_entity_usage_computed() again for recomputation.
207 FIRM_API void assure_irp_globals_entity_usage_computed(void);
210 * Get the memory disambiguator options for a graph.
212 * @param irg the graph
214 FIRM_API unsigned get_irg_memory_disambiguator_options(const ir_graph *irg);
217 * Set the memory disambiguator options for a graph.
219 * @param irg the graph
220 * @param options a set of options
222 FIRM_API void set_irg_memory_disambiguator_options(ir_graph *irg,
226 * Set the global disambiguator options for all graphs not having local options.
228 * @param options a set of options
230 FIRM_API void set_irp_memory_disambiguator_options(unsigned options);
233 * Mark all private methods, i.e. those of which all call sites are known.
234 * We use a very convervative estimation yet: If the address of a method is
235 * never taken AND its visibility is visibility_local, then it's private.
237 FIRM_API void mark_private_methods(void);
240 * Creates an ir_prog pass for mark_private_methods().
242 * @param name the name of this pass or NULL
244 * @return the newly created ir_prog pass
246 FIRM_API ir_prog_pass_t *mark_private_methods_pass(const char *name);