X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=include%2Flibfirm%2Firprog.h;h=53a5a5febf80e43cc872be3f3715ed06bc9cb74a;hb=e2e929ea04eb563b5fffadfd84bd61eb1f85735f;hp=1a2e08f837517df285036a5232b3cbf0b4891b1c;hpb=6376760ac083ad5e8dadb9d2e292d1bc822357be;p=libfirm diff --git a/include/libfirm/irprog.h b/include/libfirm/irprog.h index 1a2e08f83..53a5a5feb 100644 --- a/include/libfirm/irprog.h +++ b/include/libfirm/irprog.h @@ -1,5 +1,5 @@ /* - * Copyright (C) 1995-2007 University of Karlsruhe. All right reserved. + * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved. * * This file is part of libFirm. * @@ -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 @@ -46,100 +46,123 @@ #include "firm_types.h" #include "irgraph.h" -/** - * 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; +typedef enum ir_segment_t { + IR_SEGMENT_FIRST, + /** "normal" global data */ + IR_SEGMENT_GLOBAL = IR_SEGMENT_FIRST, + /** thread local storage segment */ + IR_SEGMENT_THREAD_LOCAL, + /** + * the constructors segment. Contains pointers to functions which are + * executed on module initialization (program start or when a library is + * dynamically loaded) + */ + IR_SEGMENT_CONSTRUCTORS, + /** like constructors, but functions are executed on module exit */ + IR_SEGMENT_DESTRUCTORS, + + IR_SEGMENT_COUNT +} ir_segment_t; /** - * 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; +#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); +#else +#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. */ -void free_ir_prog(void); +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); +void set_irp_prog_name(ident *name); /** Returns true if the user ever set a program name */ -int irp_prog_name_is_set(void); +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); /** Sets the main routine of the compiled program. */ -void set_irp_main_irg(ir_graph *main_irg); +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. */ +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); +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); +void remove_irp_irg(ir_graph *irg); + +/** returns the biggest not used irg index number */ +int get_irp_last_idx(void); /** Returns the number of ir graphs in the irp. */ -int get_irp_n_irgs(void); +int get_irp_n_irgs(void); /** Returns the ir graph at position pos in the irp. */ ir_graph *get_irp_irg(int pos); /** Sets the ir graph at position pos. */ -void set_irp_irg(int pos, ir_graph *irg); +void set_irp_irg(int pos, ir_graph *irg); /** Gets the number of graphs _and_ pseudo graphs. */ -int get_irp_n_allirgs(void); +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); +/** + * Returns the type containing the entities for a segment. + * + * @param segment the segment + */ +ir_type *get_segment_type(ir_segment_t segment); + /** * 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); @@ -150,45 +173,45 @@ ir_type *get_glob_type(void); ir_type *get_tls_type(void); /** Adds type to the list of types in irp. */ -void add_irp_type(ir_type *typ); +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); +void remove_irp_type(ir_type *typ); /** Returns the number of all types in the irp. */ -int get_irp_n_types(void); +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); +void set_irp_type(int pos, ir_type *typ); /** Returns the number of all modes in the irp. */ -int get_irp_n_modes(void); +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); +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); +void remove_irp_opcode(ir_op *opcode); /** Returns the number of all opcodes in the irp. */ -int get_irp_n_opcodes(void); +int get_irp_n_opcodes(void); /** Returns the opcode at position pos in the irp. */ ir_op *get_irp_opcode(int pos); /** Sets the generic function pointer of all opcodes to NULL */ -void clear_irp_opcodes_generic_func(void); +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 @@ -216,6 +239,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); @@ -226,4 +258,13 @@ 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); +/** Add a new global asm include. */ +void add_irp_asm(ident *asm_string); + +/** 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); + #endif