X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=include%2Flibfirm%2Firprog.h;h=66c695c991ad5110767503a156b175b0eb14dc99;hb=e1d0a7c980faef658ffd4fd63a43e74b764a7dfe;hp=38289397a7ee595962aa48a39121076631605757;hpb=8e274ccd621c6743361fd63fca32630197da3107;p=libfirm diff --git a/include/libfirm/irprog.h b/include/libfirm/irprog.h index 38289397a..66c695c99 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 @@ -36,15 +36,15 @@ * 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 #include "firm_types.h" #include "irgraph.h" +#include "begin.h" typedef enum ir_segment_t { IR_SEGMENT_FIRST, @@ -61,40 +61,23 @@ 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; - -/** - * Data structure that holds central information about a program - * or a module. - * One irp is created by libFirm on construction, so irp should never be NULL. - * - * - main_irg: The ir graph that is the entry point to the program. - * (Anything not reachable from here may be optimized away - * if this irp represents a whole program. - * - irg: List of all ir graphs in the program or module. - * - 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 - * of this module. - */ -typedef struct ir_prog ir_prog; +ENUM_COUNTABLE(ir_segment_t) /** * 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. + * @note Think of the irp as the "handle" of a program. */ -extern ir_prog *irp; +FIRM_API ir_prog *irp; #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); +FIRM_API void irp_reserve_resources(ir_prog *irp, ir_resources_t resources); +FIRM_API void irp_free_resources(ir_prog *irp, ir_resources_t resources); +FIRM_API ir_resources_t irp_resources_reserved(const ir_prog *irp); #else #define irp_reserve_resources(irp, resources) #define irp_free_resources(irp, resources) @@ -107,125 +90,139 @@ ir_resources_t irp_resources_reserved(const ir_prog *irp); * * @see irp */ -ir_prog *get_irp(void); +FIRM_API ir_prog *get_irp(void); + +/** + * Set current irp + */ +FIRM_API void set_irp(ir_prog *irp); /** - * Creates a new ir_prog (a module or compilation unit), - * returns it and sets irp with it. + * Creates a new ir_prog (a module or compilation unit). + * Note: This does not set irp to the newly created ir_prog * - * @param module_name the name of this irp (module) + * @param name the name of this irp (module) */ -ir_prog *new_ir_prog(const char *name); +FIRM_API 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. */ -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 name of the current irp. */ -ident *get_irp_ident(void); +FIRM_API ident *get_irp_ident(void); /** Gets the name of the current irp. */ -const char *get_irp_name(void); +FIRM_API const char *get_irp_name(void); /** Gets the main routine of the compiled program. */ -ir_graph *get_irp_main_irg(void); +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 the current irp. */ -void add_irp_irg(ir_graph *irg); +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); - -/** 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); +FIRM_API void set_irp_irg(size_t pos, ir_graph *irg); /** * Returns the type containing the entities for a segment. * * @param segment the segment */ -ir_type *get_segment_type(ir_segment_t segment); +FIRM_API ir_type *get_segment_type(ir_segment_t segment); + +/** + * @brief Changes a segment segment type for the program. + * (use with care) + */ +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); +FIRM_API ir_type *get_tls_type(void); /** Adds type to the list of types in irp. */ -void add_irp_type(ir_type *typ); +FIRM_API 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); +FIRM_API void remove_irp_type(ir_type *typ); -/** Returns the number of all types in the irp. */ -int get_irp_n_types(void); +/** + * Returns the number of all types in the irp. + * @deprecated + */ +FIRM_API size_t get_irp_n_types(void); -/** Returns the type at position pos in the irp. */ -ir_type *get_irp_type(int pos); +/** + * 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. */ -void set_irp_type(int pos, ir_type *typ); +/** + * Overwrites the type at position pos with another type. + * @deprecated + */ +FIRM_API void set_irp_type(size_t pos, ir_type *typ); /** Returns the number of all modes in the irp. */ -int get_irp_n_modes(void); +FIRM_API size_t get_irp_n_modes(void); /** Returns the mode at position pos in the irp. */ -ir_mode *get_irp_mode(int pos); +FIRM_API ir_mode *get_irp_mode(size_t pos); /** Adds opcode to the list of opcodes in irp. */ -void add_irp_opcode(ir_op *opcode); +FIRM_API 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 void remove_irp_opcode(ir_op *opcode); /** Returns the number of all opcodes in the irp. */ -int get_irp_n_opcodes(void); +FIRM_API size_t get_irp_n_opcodes(void); /** Returns the opcode at position pos in the irp. */ -ir_op *get_irp_opcode(int pos); +FIRM_API ir_op *get_irp_opcode(size_t pos); /** Sets the generic function pointer of all opcodes to NULL */ -void clear_irp_opcodes_generic_func(void); +FIRM_API void clear_irp_opcodes_generic_func(void); /** Return the graph for global constants of the current irp. @@ -239,7 +236,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. @@ -250,29 +247,41 @@ 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); +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); +FIRM_API irg_outs_state get_irp_ip_outs_state(void); +FIRM_API 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 + */ +FIRM_API 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); +FIRM_API irg_callee_info_state get_irp_callee_info_state(void); +FIRM_API void set_irp_callee_info_state(irg_callee_info_state s); /** Returns a new, unique exception region number. */ -ir_exc_region_t get_irp_next_region_nr(void); +FIRM_API ir_exc_region_t get_irp_next_region_nr(void); /** 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); /** Return the number of global asm includes. */ -int get_irp_n_asms(void); +FIRM_API size_t get_irp_n_asms(void); /** Return the global asm include at position pos. */ -ident *get_irp_asm(int pos); +FIRM_API ident *get_irp_asm(size_t pos); + +#include "end.h" #endif