X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=include%2Flibfirm%2Firprog.h;h=1d6f6bd60ca0bfaf7e5fa2ba2c488fe270768cad;hb=9c47bb543ad91bdfe94f5ad6cf63f49d901bdebe;hp=3d8abcb4a95649ff2230554b6f79beddd8b6e7f5;hpb=64d13bb5d7e4b2c992d562840c9625afad83fa22;p=libfirm diff --git a/include/libfirm/irprog.h b/include/libfirm/irprog.h index 3d8abcb4a..1d6f6bd60 100644 --- a/include/libfirm/irprog.h +++ b/include/libfirm/irprog.h @@ -23,7 +23,7 @@ * @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 @@ -61,35 +61,16 @@ 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; /** - * 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. - * - */ -typedef struct ir_prog ir_prog; - -/** - * A variable from where everything in the ir can be accessed. - * This variable contains the irp, the "immediate representation program". + * 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 libFirm. + * Think of the irp as the "handle" of a program. */ extern ir_prog *irp; @@ -98,21 +79,26 @@ 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); #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) +#define irp_free_resources(irp, resources) +#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); -/** 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), + * returns it and sets irp with it. + * + * @param name the name of this irp (module) + */ +ir_prog *new_ir_prog(const char *name); /** frees all memory used by irp. Types in type list and irgs in irg * list must be freed by hand before. */ @@ -125,13 +111,11 @@ void set_irp_prog_name(ident *name); /** Returns true if the user ever set a program name */ int irp_prog_name_is_set(void); -/** Gets the file name / executable name or the like. - */ -ident *get_irp_prog_ident(void); +/** Gets the name of the current irp. */ +ident *get_irp_ident(void); -/** Gets the file name / executable name or the like. - */ -const char *get_irp_prog_name (void); +/** Gets the name of the current irp. */ +const char *get_irp_name(void); /** Gets the main routine of the compiled program. */ ir_graph *get_irp_main_irg(void); @@ -139,7 +123,7 @@ ir_graph *get_irp_main_irg(void); /** Sets the main routine of the compiled program. */ void set_irp_main_irg(ir_graph *main_irg); -/** Adds irg to the list of ir graphs in irp. */ +/** Adds irg to the list of ir graphs in the current irp. */ void add_irp_irg(ir_graph *irg); /** Removes irg from the list of irgs and @@ -169,10 +153,18 @@ int get_irp_n_allirgs(void); ir_graph *get_irp_allirg(int pos); /** - * returns the type containing the entities for a segment + * Returns the type containing the entities for a segment. + * + * @param segment the segment */ ir_type *get_segment_type(ir_segment_t segment); +/** + * @brief Changes a segment segment type for the program. + * (use with care) + */ +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. @@ -183,6 +175,7 @@ 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); @@ -193,13 +186,22 @@ void add_irp_type(ir_type *typ); shrinks the list by one. */ void remove_irp_type(ir_type *typ); -/** Returns the number of all types in the irp. */ +/** + * Returns the number of all types in the irp. + * @deprecated + */ int get_irp_n_types(void); -/** Returns the type at position pos in the irp. */ +/** + * Returns the type at position pos in the irp. + * @deprecated + */ ir_type *get_irp_type(int pos); -/** Overwrites the type at position pos with another type. */ +/** + * Overwrites the type at position pos with another type. + * @deprecated + */ void set_irp_type(int pos, ir_type *typ); /** Returns the number of all modes in the irp. */ @@ -225,7 +227,7 @@ ir_op *get_irp_opcode(int pos); void clear_irp_opcodes_generic_func(void); -/** Return the graph for global constants. +/** Return 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 @@ -253,6 +255,15 @@ 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); +/** + * 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 + */ +ir_prog_pass_t *set_irp_phase_state_pass(const char *name, irg_phase_state state); irg_callee_info_state get_irp_callee_info_state(void); void set_irp_callee_info_state(irg_callee_info_state s);