nsz Git - libfirm/blob - include/libfirm/irmemory.h

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