X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=include%2Flibfirm%2Firprog.h;h=eba962c2fbbe946985c9e5f64b5d0f0f95e8aae2;hb=cdcd17c48e951c6e0201c58b94aaf52a8769703c;hp=3d8abcb4a95649ff2230554b6f79beddd8b6e7f5;hpb=64d13bb5d7e4b2c992d562840c9625afad83fa22;p=libfirm diff --git a/include/libfirm/irprog.h b/include/libfirm/irprog.h index 3d8abcb4a..eba962c2f 100644 --- a/include/libfirm/irprog.h +++ b/include/libfirm/irprog.h @@ -22,12 +22,22 @@ * @brief Entry point to the representation of a whole program. * @author Goetz Lindenmaier * @date 2000 - * @version $Id$ - * @summary + * @brief * Intermediate Representation (IR) of a program. * - * This file defines a construct that keeps all information about a - * program: + */ +#ifndef FIRM_IR_IRPROG_H +#define FIRM_IR_IRPROG_H + +#include +#include "firm_types.h" +#include "irgraph.h" +#include "begin.h" + +/** + * @defgroup ir_prog Program + * + * ir_prog keeps information about a program: * - A reference point to the method to be executed on program start. * - A list of all procedures. * - A list of all types. @@ -36,16 +46,17 @@ * program. It is not the base class of * all classes in a class hierarchy (as, e.g., "object" in java). * - A degenerated graph that contains constant expressions. - * - interprocedural outs state. - * - a flag indicating validity of the interprocedural representation. * - the output file name + * + * @{ */ -#ifndef FIRM_IR_IRPROG_H -#define FIRM_IR_IRPROG_H - -#include "firm_types.h" -#include "irgraph.h" +/** + * Segment + * + * A progrom has a number of special segments at the toplevel which modify + * the behaviour of the entities in them. + */ typedef enum ir_segment_t { IR_SEGMENT_FIRST, /** "normal" global data */ @@ -61,171 +72,165 @@ typedef enum ir_segment_t { /** like constructors, but functions are executed on module exit */ IR_SEGMENT_DESTRUCTORS, - IR_SEGMENT_COUNT + IR_SEGMENT_LAST = IR_SEGMENT_DESTRUCTORS } ir_segment_t; +ENUM_COUNTABLE(ir_segment_t) /** - * Datastructure that holds central information about a program - * - * Preliminary documentation ;-) - * - * - main_irg: The ir graph that is the entry point to the program. - * (Anything not reachable from here may be optimized away. - * If we want to translate libraries or the like correctly - * we must replace this by a list.) - * - irg: List of all ir graphs in the program. - * - type: A list containing all types known to the translated program. - * Some types can have several entries in this list (as a result of - * using exchange_types()). - * - glob_type: The unique global type that is owner of all global entities. + * A variable pointing to the current irp (program or module). + * This variable should be considered constant. Moreover, one should use get_irp() + * to get access the the irp. * + * @note Think of the irp as the "handle" of a program. */ -typedef struct ir_prog ir_prog; +FIRM_API ir_prog *irp; /** - * A variable from where everything in the ir can be accessed. - * This variable contains the irp, the "immediate representation program". - * This variable should be considered constant. Moreover, one should use get_irp() - * to get access the the irp. - * - * @note - * Think of the irp as the "handle" of libFirm. + * Resources usable by algorithms modifying the program */ -extern ir_prog *irp; +typedef enum irp_resources_t { + IRP_RESOURCE_NONE = 0, /**< no resource */ + /** irg link field @see set_irg_link(), get_irg_link() */ + IRP_RESOURCE_IRG_LINK = 1 << 0, + /** entity link field @see set_entity_link(), get_entity_link() */ + IRP_RESOURCE_ENTITY_LINK = 1 << 1, + /** type visited field @see type_visited(), mark_type_visited(), + * inc_master_type_visited() */ + IRP_RESOURCE_TYPE_VISITED = 1 << 2, + /** type link field @see set_type_link(), get_type_link() */ + IRP_RESOURCE_TYPE_LINK = 1 << 3, +} irp_resources_t; +ENUM_BITSET(irp_resources_t) #ifndef NDEBUG -void irp_reserve_resources(ir_prog *irp, ir_resources_t resources); -void irp_free_resources(ir_prog *irp, ir_resources_t resources); -ir_resources_t irp_resources_reserved(const ir_prog *irp); +/** + * Reserve resources available for a whole program. + * + * This is a debug tool: All code should properly allocate the resources it uses + * so if two interlocked algorithms use the same resources that bug will get + * detected. + */ +FIRM_API void irp_reserve_resources(ir_prog *irp, irp_resources_t resources); +/** Frees resources availabel for a whole program. */ +FIRM_API void irp_free_resources(ir_prog *irp, irp_resources_t resources); +/** Returns currently reserved whole program resources. */ +FIRM_API irp_resources_t irp_resources_reserved(const ir_prog *irp); #else -void irp_reserve_resources(irp, resources) -void irp_free_resources(irp, resources) -ir_resources_t irp_resources_reserved(irp) 0 +#define irp_reserve_resources(irp, resources) (void)0 +#define irp_free_resources(irp, resources) (void)0 +#define irp_resources_reserved(irp) 0 #endif /** - * Returns the access points from where everything in the ir can be accessed. + * Returns the current irp from where everything in the current module + * can be accessed. * * @see irp */ -ir_prog *get_irp(void); +FIRM_API ir_prog *get_irp(void); + +/** Sets current irp */ +FIRM_API void set_irp(ir_prog *irp); -/** Creates a new ir_prog, returns it and sets irp with it. - * Automatically called by init_firm() through init_irprog. */ -ir_prog *new_ir_prog(void); +/** + * Creates a new ir_prog (a module or compilation unit). + * Note: This does not set irp to the newly created ir_prog + * + * @param name the name of this irp (module) + */ +FIRM_API ir_prog *new_ir_prog(const char *name); -/** frees all memory used by irp. Types in type list and irgs in irg +/** Frees all memory used by irp. Types in type list and irgs in irg * list must be freed by hand before. */ -void free_ir_prog(void); +FIRM_API void free_ir_prog(void); /** Sets the file name / executable name or the like. Initially the ident 'no_name_set'. */ -void set_irp_prog_name(ident *name); +FIRM_API void set_irp_prog_name(ident *name); /** Returns true if the user ever set a program name */ -int irp_prog_name_is_set(void); +FIRM_API int irp_prog_name_is_set(void); -/** Gets the file name / executable name or the like. - */ -ident *get_irp_prog_ident(void); +/** Returns the name of the current irp. */ +FIRM_API ident *get_irp_ident(void); -/** Gets the file name / executable name or the like. - */ -const char *get_irp_prog_name (void); +/** Returns the name of the current irp. */ +FIRM_API const char *get_irp_name(void); -/** Gets the main routine of the compiled program. */ -ir_graph *get_irp_main_irg(void); +/** Returns the main routine of the compiled program. */ +FIRM_API ir_graph *get_irp_main_irg(void); /** Sets the main routine of the compiled program. */ -void set_irp_main_irg(ir_graph *main_irg); +FIRM_API void set_irp_main_irg(ir_graph *main_irg); -/** Adds irg to the list of ir graphs in irp. */ -void add_irp_irg(ir_graph *irg); +/** Adds irg to the list of ir graphs in the current irp. */ +FIRM_API void add_irp_irg(ir_graph *irg); /** Removes irg from the list of irgs and shrinks the list by one. */ -void remove_irp_irg_from_list(ir_graph *irg); +FIRM_API void remove_irp_irg_from_list(ir_graph *irg); /** Removes irg from the list of irgs, deallocates it and shrinks the list by one. */ -void remove_irp_irg(ir_graph *irg); +FIRM_API void remove_irp_irg(ir_graph *irg); /** returns the biggest not used irg index number */ -int get_irp_last_idx(void); +FIRM_API size_t get_irp_last_idx(void); /** Returns the number of ir graphs in the irp. */ -int get_irp_n_irgs(void); +FIRM_API size_t get_irp_n_irgs(void); /** Returns the ir graph at position pos in the irp. */ -ir_graph *get_irp_irg(int pos); +FIRM_API ir_graph *get_irp_irg(size_t pos); /** Sets the ir graph at position pos. */ -void set_irp_irg(int pos, ir_graph *irg); - -/** Gets the number of graphs _and_ pseudo graphs. */ -int get_irp_n_allirgs(void); +FIRM_API void set_irp_irg(size_t pos, ir_graph *irg); -/** Returns the ir graph at position pos of all graphs (including - pseudo graphs). Visits first graphs, then pseudo graphs. */ -ir_graph *get_irp_allirg(int pos); +/** + * Returns the type containing the entities for a segment. + * + * @param segment the segment + */ +FIRM_API ir_type *get_segment_type(ir_segment_t segment); /** - * returns the type containing the entities for a segment + * @brief Changes a segment segment type for the program. + * (use with care) */ -ir_type *get_segment_type(ir_segment_t segment); +FIRM_API void set_segment_type(ir_segment_t segment, ir_type *new_type); /** * Returns the "global" type of the irp. * Upon creation this is an empty class type. * This is a convenience function for get_segment_type(IR_SEGMENT_GLOBAL) */ -ir_type *get_glob_type(void); +FIRM_API ir_type *get_glob_type(void); /** * Returns the "thread local storage" type of the irp. * Upon creation this is an empty struct type. + * This is a convenience function for get_segment_type(IR_SEGMENT_THREAD_LOCAL) */ -ir_type *get_tls_type(void); - -/** Adds type to the list of types in irp. */ -void add_irp_type(ir_type *typ); - -/** Removes type from the list of types, deallocates it and - shrinks the list by one. */ -void remove_irp_type(ir_type *typ); - -/** Returns the number of all types in the irp. */ -int get_irp_n_types(void); - -/** Returns the type at position pos in the irp. */ -ir_type *get_irp_type(int pos); - -/** Overwrites the type at position pos with another type. */ -void set_irp_type(int pos, ir_type *typ); - -/** Returns the number of all modes in the irp. */ -int get_irp_n_modes(void); - -/** Returns the mode at position pos in the irp. */ -ir_mode *get_irp_mode(int pos); - -/** Adds opcode to the list of opcodes in irp. */ -void add_irp_opcode(ir_op *opcode); - -/** Removes opcode from the list of opcodes, deallocates it and - shrinks the list by one. */ -void remove_irp_opcode(ir_op *opcode); +FIRM_API ir_type *get_tls_type(void); -/** Returns the number of all opcodes in the irp. */ -int get_irp_n_opcodes(void); - -/** Returns the opcode at position pos in the irp. */ -ir_op *get_irp_opcode(int pos); +/** + * Returns the number of all types in the irp. + * @deprecated + */ +FIRM_API size_t get_irp_n_types(void); -/** Sets the generic function pointer of all opcodes to NULL */ -void clear_irp_opcodes_generic_func(void); +/** + * Returns the type at position pos in the irp. + * @deprecated + */ +FIRM_API ir_type *get_irp_type(size_t pos); +/** + * Overwrites the type at position pos with another type. + * @deprecated + */ +FIRM_API void set_irp_type(size_t pos, ir_type *typ); -/** Return the graph for global constants. +/** Returns the graph for global constants of the current irp. * * Returns an irgraph that only contains constant expressions for * constant entities. Do not use any access function for this @@ -236,8 +241,7 @@ void clear_irp_opcodes_generic_func(void); * or any controlflow. * See also copy_const_code() in entity.h. */ -ir_graph *get_const_code_irg(void); - +FIRM_API ir_graph *get_const_code_irg(void); /** The phase state for the program. * @@ -247,29 +251,42 @@ ir_graph *get_const_code_irg(void); * high: all graphs are in state high or low, all types are constructed. * low: all graphs are in state low, all types are in state layout fixed. */ -irg_phase_state get_irp_phase_state(void); -void set_irp_phase_state(irg_phase_state s); +FIRM_API irg_phase_state get_irp_phase_state(void); +/** Sets the phase state of the program */ +FIRM_API void set_irp_phase_state(irg_phase_state s); -irg_outs_state get_irp_ip_outs_state(void); -void set_irp_ip_outs_inconsistent(void); - - -irg_callee_info_state get_irp_callee_info_state(void); -void set_irp_callee_info_state(irg_callee_info_state s); +/** + * Creates an ir_prog pass for set_irp_phase_state(). + * + * @param name the name of this pass or NULL + * @param state the state to set + * + * @return the newly created ir_prog pass + */ +FIRM_API ir_prog_pass_t *set_irp_phase_state_pass(const char *name, + irg_phase_state state); -/** Returns a new, unique exception region number. */ -ir_exc_region_t get_irp_next_region_nr(void); +/** Returns callee info state for the whole program. + * @see get_irg_callee_info_state() */ +FIRM_API irg_callee_info_state get_irp_callee_info_state(void); +/** Sets callee info state for the whole program. + * @see set_irg_callee_info_state() */ +FIRM_API void set_irp_callee_info_state(irg_callee_info_state s); /** Returns a new, unique label number. */ -ir_label_t get_irp_next_label_nr(void); +FIRM_API ir_label_t get_irp_next_label_nr(void); /** Add a new global asm include. */ -void add_irp_asm(ident *asm_string); +FIRM_API void add_irp_asm(ident *asm_string); + +/** Returns the number of global asm includes. */ +FIRM_API size_t get_irp_n_asms(void); + +/** Returns the global asm include at position pos. */ +FIRM_API ident *get_irp_asm(size_t pos); -/** Return the number of global asm includes. */ -int get_irp_n_asms(void); +/** @} */ -/** Return the global asm include at position pos. */ -ident *get_irp_asm(int pos); +#include "end.h" #endif