libfirm/irmemory.h

Go to the documentation of this file.

/*
 * Copyright (C) 1995-2010 University of Karlsruhe.  All right reserved.
 *
 * This file is part of libFirm.
 *
 * This file may be distributed and/or modified under the terms of the
 * GNU General Public License version 2 as published by the Free Software
 * Foundation and appearing in the file LICENSE.GPL included in the
 * packaging of this file.
 *
 * Licensees holding valid libFirm Professional Edition licenses may use
 * this file in accordance with the libFirm Commercial License.
 * Agreement provided with the Software.
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE.
 */

#ifndef FIRM_ANA_IRMEMORY_H
#define FIRM_ANA_IRMEMORY_H

#include "firm_types.h"
#include "begin.h"

typedef enum ir_alias_relation {
    ir_no_alias,       
    ir_may_alias,      
    ir_sure_alias      
} ir_alias_relation;

typedef enum ir_entity_usage_computed_state {
    ir_entity_usage_not_computed,
    ir_entity_usage_computed
} ir_entity_usage_computed_state;

typedef enum ir_disambuigator_options {
    aa_opt_no_opt               = 0,  
    aa_opt_type_based           = 1,  
    aa_opt_byte_type_may_alias  = 2,  
    aa_opt_no_alias_args        = 4,  
    aa_opt_no_alias_args_global = 8,  
    aa_opt_no_alias             = 16, 
    aa_opt_inherited            = 128 
} ir_disambuigator_options;
ENUM_BITSET(ir_disambuigator_options)


typedef enum ir_storage_class_class_t {
    ir_sc_pointer           = 0x0,  
    ir_sc_globalvar         = 0x1,  
    ir_sc_localvar          = 0x2,  
    ir_sc_tls               = 0x3,  
    ir_sc_malloced          = 0x4,  
    ir_sc_globaladdr        = 0x5,  
    ir_sc_modifier_nottaken = 0x80, 
    ir_sc_modifier_argument = 0x40, 
    ir_sc_modifiers         = ir_sc_modifier_nottaken | ir_sc_modifier_argument
} ir_storage_class_class_t;
ENUM_BITSET(ir_storage_class_class_t)


FIRM_API ir_storage_class_class_t get_base_sc(ir_storage_class_class_t x);

typedef ir_alias_relation (*DISAMBIGUATOR_FUNC)(
    const ir_node *adr1, const ir_mode *mode1,
    const ir_node *adr2, const ir_mode *mode2);

FIRM_API ir_storage_class_class_t classify_pointer(const ir_node *irn,
                                                   const ir_entity *ent);

FIRM_API const char *get_ir_alias_relation_name(ir_alias_relation rel);

FIRM_API ir_alias_relation get_alias_relation(
    const ir_node *adr1, const ir_mode *mode1,
    const ir_node *adr2, const ir_mode *mode2);

FIRM_API void set_language_memory_disambiguator(DISAMBIGUATOR_FUNC func);

FIRM_API void mem_disambig_init(void);

FIRM_API ir_alias_relation get_alias_relation_ex(
    const ir_node *adr1, const ir_mode *mode1,
    const ir_node *adr2, const ir_mode *mode2);

FIRM_API void mem_disambig_term(void);

FIRM_API void assure_irg_entity_usage_computed(ir_graph *irg);

FIRM_API ir_entity_usage_computed_state get_irp_globals_entity_usage_state(void);

FIRM_API void set_irp_globals_entity_usage_state(ir_entity_usage_computed_state state);

FIRM_API void assure_irp_globals_entity_usage_computed(void);

FIRM_API unsigned get_irg_memory_disambiguator_options(const ir_graph *irg);

FIRM_API void set_irg_memory_disambiguator_options(ir_graph *irg,
                                                   unsigned options);

FIRM_API void set_irp_memory_disambiguator_options(unsigned options);

FIRM_API void mark_private_methods(void);

FIRM_API ir_prog_pass_t *mark_private_methods_pass(const char *name);

#include "end.h"

#endif