X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=include%2Flibfirm%2Firgraph.h;h=6187d5139cc251af99237dd6df7b7f5710747f07;hb=485a16d5b15766a1b42d6cd2a58c7a749ac0de40;hp=0d664fb745434aaa0a2d056698d5cd1bd1285a65;hpb=1ec30d95387eb392ba5a1adc7958ebd91383d59c;p=libfirm diff --git a/include/libfirm/irgraph.h b/include/libfirm/irgraph.h index 0d664fb74..6187d5139 100644 --- a/include/libfirm/irgraph.h +++ b/include/libfirm/irgraph.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. * @@ -28,6 +28,7 @@ #include +#include "firm_config.h" #include "firm_types.h" #include "irop.h" #include "iropt.h" @@ -125,10 +126,14 @@ extern ir_graph *current_ir_graph; ir_graph *get_current_ir_graph(void); void set_current_ir_graph(ir_graph *graph); +#ifdef INTERPROCEDURAL_VIEW /** This flag indicate the current view. The behavior of some methods * (get_irn_*, set_irn_*) is influenced by this flag. */ int get_interprocedural_view(void); void set_interprocedural_view(int state); +#else +#define get_interprocedural_view() 0 +#endif /** * Create a new ir graph to build ir for a procedure. @@ -168,7 +173,7 @@ void set_interprocedural_view(int state); * * @see new_pseudo_ir_graph() */ -ir_graph *new_ir_graph (ir_entity *ent, int n_loc); +ir_graph *new_ir_graph(ir_entity *ent, int n_loc); /** Frees the passed irgraph. * Deallocates all nodes in this graph and the ir_graph structure. @@ -178,7 +183,7 @@ ir_graph *new_ir_graph (ir_entity *ent, int n_loc); * Does not free types, entities or modes that are used only by this * graph, nor the entity standing for this graph. */ -void free_ir_graph (ir_graph *irg); +void free_ir_graph(ir_graph *irg); /* --- access routines for all ir_graph attributes --- */ @@ -188,92 +193,106 @@ void free_ir_graph (ir_graph *irg); * @param thing an arbitrary pointer * * @return - * true if the thing is a ir graph, else false + * true if the thing is a IR graph, else false */ int is_ir_graph(const void *thing); -/* #define get_irg_entity get_irg_ent */ -/* #define set_irg_entity set_irg_ent */ -ir_entity *get_irg_entity (const ir_graph *irg); -void set_irg_entity (ir_graph *irg, ir_entity *ent); +/** Returns the entity of an IR graph. */ +ir_entity *get_irg_entity(const ir_graph *irg); +/** Sets the entity of an IR graph. */ +void set_irg_entity(ir_graph *irg, ir_entity *ent); -ir_type *get_irg_frame_type (ir_graph *irg); -void set_irg_frame_type (ir_graph *irg, ir_type *ftp); +/** Returns the frame type of an IR graph. */ +ir_type *get_irg_frame_type(ir_graph *irg); +/** Sets the frame type of an IR graph. */ +void set_irg_frame_type(ir_graph *irg, ir_type *ftp); -ir_node *get_irg_start_block (const ir_graph *irg); -void set_irg_start_block (ir_graph *irg, ir_node *node); +/** Returns the start block of an IR graph. */ +ir_node *get_irg_start_block(const ir_graph *irg); +/** Sets the start block of an IR graph. */ +void set_irg_start_block(ir_graph *irg, ir_node *node); -ir_node *get_irg_start (const ir_graph *irg); -void set_irg_start (ir_graph *irg, ir_node *node); +/** Returns the Start node of an IR graph. */ +ir_node *get_irg_start(const ir_graph *irg); +/** Sets the Start node of an IR graph. */ +void set_irg_start(ir_graph *irg, ir_node *node); -ir_node *get_irg_end_block (const ir_graph *irg); -void set_irg_end_block (ir_graph *irg, ir_node *node); +/** Returns the end block of an IR graph. */ +ir_node *get_irg_end_block(const ir_graph *irg); +/** Sets the end block of an IR graph. */ +void set_irg_end_block(ir_graph *irg, ir_node *node); -ir_node *get_irg_end (const ir_graph *irg); -void set_irg_end (ir_graph *irg, ir_node *node); +/** Returns the End node of an IR graph. */ +ir_node *get_irg_end(const ir_graph *irg); +/** Sets the End node of an IR graph. */ +void set_irg_end(ir_graph *irg, ir_node *node); /* The fields end_reg and end_except contain the end nodes of the interprocedural view. If the view is not constructed they contain the normal end node. */ -ir_node *get_irg_end_reg (const ir_graph *irg); -void set_irg_end_reg (ir_graph *irg, ir_node *node); - -ir_node *get_irg_end_except (const ir_graph *irg); -void set_irg_end_except (ir_graph *irg, ir_node *node); - -/** Returns the node that represents the frame pointer. */ -ir_node *get_irg_frame (const ir_graph *irg); -/** Sets the node that represents the frame pointer. */ -void set_irg_frame (ir_graph *irg, ir_node *node); - -/** Returns the node that represents the global pointer. */ -ir_node *get_irg_globals (const ir_graph *irg); -/** Sets the node that represents the global pointer. */ -void set_irg_globals (ir_graph *irg, ir_node *node); - -/** Returns the node that represents the tls pointer. */ -ir_node *get_irg_tls (const ir_graph *irg); -/** Sets the node that represents the tls pointer. */ -void set_irg_tls (ir_graph *irg, ir_node *node); - -/** Returns the node that represents the initial memory. */ -ir_node *get_irg_initial_mem (const ir_graph *irg); -/** Sets the node that represents the initial memory. */ -void set_irg_initial_mem (ir_graph *irg, ir_node *node); - -/** Returns the node that represents the argument pointer. */ -ir_node *get_irg_args (const ir_graph *irg); -/** Sets the node that represents the argument pointer. */ -void set_irg_args (ir_graph *irg, ir_node *node); - -/** Returns the node that represents the value parameter base pointer. */ -ir_node *get_irg_value_param_base (const ir_graph *irg); -/** Sets the node that represents the value parameter base pointer. */ -void set_irg_value_param_base (ir_graph *irg, ir_node *node); - -/** Returns an array of the nodes of the argument pointer. */ -ir_node **get_irg_proj_args (const ir_graph *irg); -/** Sets the array of the nodes of the argument pointer. */ -void set_irg_proj_args (ir_graph *irg, ir_node **nodes); - -/** Returns the current block of a graph. */ -ir_node *get_irg_current_block (const ir_graph *irg); -/** Sets the current block of a graph. */ -void set_irg_current_block (ir_graph *irg, ir_node *node); - -/** Returns the Bad node. Use new_Bad() instead!! */ -ir_node *get_irg_bad (const ir_graph *irg); -void set_irg_bad (ir_graph *irg, ir_node *node); - -/** Returns the NoMem node. Use new_NoMem() instead!! */ -ir_node *get_irg_no_mem (const ir_graph *irg); -void set_irg_no_mem (ir_graph *irg, ir_node *node); - -/** Returns the number of value numbers of a graph. */ -int get_irg_n_locs (ir_graph *irg); - +ir_node *get_irg_end_reg(const ir_graph *irg); +void set_irg_end_reg(ir_graph *irg, ir_node *node); + +ir_node *get_irg_end_except(const ir_graph *irg); +void set_irg_end_except(ir_graph *irg, ir_node *node); + +/** Returns the node that represents the initial control flow of the given IR graph. */ +ir_node *get_irg_initial_exec(const ir_graph *irg); +/** Sets the node that represents the initial control of the given IR graph. */ +void set_irg_initial_exec(ir_graph *irg, ir_node *node); + +/** Returns the node that represents the frame pointer of the given IR graph. */ +ir_node *get_irg_frame(const ir_graph *irg); +/** Sets the node that represents the frame pointer of the given IR graph. */ +void set_irg_frame(ir_graph *irg, ir_node *node); + +/** Returns the node that represents the tls pointer of the given IR graph. */ +ir_node *get_irg_tls(const ir_graph *irg); +/** Sets the node that represents the tls pointer of the given IR graph. */ +void set_irg_tls(ir_graph *irg, ir_node *node); + +/** Returns the node that represents the initial memory of the given IR graph. */ +ir_node *get_irg_initial_mem(const ir_graph *irg); +/** Sets the node that represents the initial memory of the given IR graph. */ +void set_irg_initial_mem(ir_graph *irg, ir_node *node); + +/** Returns the node that represents the argument pointer of the given IR graph. */ +ir_node *get_irg_args(const ir_graph *irg); +/** Sets the node that represents the argument pointer of the given IR graph. */ +void set_irg_args(ir_graph *irg, ir_node *node); + +/** Returns the node that represents the value parameter base pointer of the given IR graph. */ +ir_node *get_irg_value_param_base(const ir_graph *irg); +/** Sets the node that represents the value parameter base pointer of the given IR graph. */ +void set_irg_value_param_base(ir_graph *irg, ir_node *node); + +/** Returns the current block of an IR graph. */ +ir_node *get_irg_current_block(const ir_graph *irg); +/** Sets the current block of an IR graph. */ +void set_irg_current_block(ir_graph *irg, ir_node *node); + +/** Returns the Bad node of the given IR graph. Use new_Bad() instead!! */ +ir_node *get_irg_bad(const ir_graph *irg); +void set_irg_bad(ir_graph *irg, ir_node *node); + +/** Returns the NoMem node of the given IR graph. Use new_NoMem() instead!! */ +ir_node *get_irg_no_mem(const ir_graph *irg); +void set_irg_no_mem(ir_graph *irg, ir_node *node); + +/** Returns the number of value numbers of an IR graph. */ +int get_irg_n_locs(ir_graph *irg); + +#ifdef DEBUG_libfirm /** Returns the graph number. */ -long get_irg_graph_nr(ir_graph *irg); +long get_irg_graph_nr(const ir_graph *irg); +#endif + +/** + * Returns the graph number. This is a unique number for the graph and is + * smaller than get_irp_last_idx() + * Note: you cannot use this number for get_irp_irg() + */ +int get_irg_idx(const ir_graph *irg); /********************************************************************************/ /* States of an ir_graph. */ @@ -302,18 +321,19 @@ long get_irg_graph_nr(ir_graph *irg); * (and probably most standard Firm are removed). */ typedef enum { - phase_building, - phase_high, - phase_low, - phase_backend + phase_building, /**< The graph is still being constructed. */ + phase_high, /**< The construction of the graph is finish, high level nodes may be present. */ + phase_low, /**< High level nodes are removed. */ + phase_backend /**< The graph is taken by the backend. Machine specific nodes may be present. */ } irg_phase_state; -/** returns the phase_state of an IR graph. */ -irg_phase_state get_irg_phase_state (const ir_graph *irg); +/** Returns the phase_state of an IR graph. */ +irg_phase_state get_irg_phase_state(const ir_graph *irg); -/** sets the phase state of an IR graph. */ +/** Sets the phase state of an IR graph. */ void set_irg_phase_state(ir_graph *irg, irg_phase_state state); +/** Sets the phase of the given IR graph to low. */ #define set_irg_phase_low(irg) set_irg_phase_state(irg, phase_low) /** state: op_pin_state_pinned @@ -323,25 +343,25 @@ void set_irg_phase_state(ir_graph *irg, irg_phase_state state); invalid block, i.e., the block is not a dominator of all the uses of the node. The enum op_pin_state is defined in irop.h. */ -op_pin_state get_irg_pinned (const ir_graph *irg); +op_pin_state get_irg_pinned(const ir_graph *irg); /** state: outs_state * Outs are the back edges or def-use edges of ir nodes. * Values: outs_none, outs_consistent, outs_inconsistent */ typedef enum { - outs_none, /**< Outs are not computed, no memory is allocated. */ - outs_consistent, /**< Outs are computed and correct. */ - outs_inconsistent /**< Outs have been computed, memory is still allocated, - but the graph has been changed since. */ + outs_none, /**< Outs are not computed, no memory is allocated. */ + outs_consistent, /**< Outs are computed and correct. */ + outs_inconsistent /**< Outs have been computed, memory is still allocated, + but the graph has been changed since. */ } irg_outs_state; irg_outs_state get_irg_outs_state(const ir_graph *irg); void set_irg_outs_inconsistent(ir_graph *irg); /** state: extended basic block state. */ typedef enum { - extblk_none = 0, /**< No extended basic block information is constructed. Default. */ - extblk_valid = 1, /**< Extended basic block information is valid. */ - extblk_invalid = 2 /**< Extended basic block information is constructed but invalid. */ + extblk_none = 0, /**< No extended basic block information is constructed. Default. */ + extblk_valid = 1, /**< Extended basic block information is valid. */ + extblk_invalid = 2 /**< Extended basic block information is constructed but invalid. */ } irg_extblk_state; irg_extblk_state get_irg_extblk_state(const ir_graph *irg); void set_irg_extblk_inconsistent(ir_graph *irg); @@ -350,9 +370,9 @@ void set_irg_extblk_inconsistent(ir_graph *irg); * Signals the state of the dominator / post dominator information. */ typedef enum { - dom_none, /**< dominator are not computed, no memory is allocated */ - dom_consistent, /**< dominator information is computed and correct */ - dom_inconsistent /**< dominator information is computed but the graph has been changed since */ + dom_none, /**< dominator are not computed, no memory is allocated */ + dom_consistent, /**< dominator information is computed and correct */ + dom_inconsistent /**< dominator information is computed but the graph has been changed since */ } irg_dom_state; /** returns the dominator state of an IR graph. */ @@ -369,34 +389,34 @@ void set_irg_doms_inconsistent(ir_graph *irg); * data flow of the procedure. */ typedef enum { - loopinfo_none = 0, /**< No loop information is constructed. Default. */ - loopinfo_constructed = 1, /**< Some kind of loop information is constructed. */ - loopinfo_valid = 2, /**< Loop information is valid. */ - loopinfo_cf = 4, /**< Loop information constructed for control flow only. */ - loopinfo_inter = 8, /**< Loop information for interprocedural view. */ - - loopinfo_for_firmjni = 16, /**< A hack for firmjni: all enums must differ as they - are used in a switch. */ - - /** IntRAprocedural loop information constructed and valid. */ - loopinfo_consistent = loopinfo_constructed | loopinfo_for_firmjni | loopinfo_valid, - /** IntRAprocedural loop information constructed and invalid. */ - loopinfo_inconsistent = loopinfo_constructed | loopinfo_for_firmjni, - - /** IntERprocedural loop information constructed and valid. */ - loopinfo_ip_consistent = loopinfo_constructed | loopinfo_inter | loopinfo_valid, - /** IntERprocedural loop information constructed and invalid. */ - loopinfo_ip_inconsistent = loopinfo_constructed | loopinfo_inter, - - /** IntRAprocedural control loop information constructed and valid. */ - loopinfo_cf_consistent = loopinfo_constructed | loopinfo_cf | loopinfo_valid, - /** IntRAprocedural control loop information constructed and invalid. */ - loopinfo_cf_inconsistent = loopinfo_constructed | loopinfo_cf, - - /** IntERprocedural control loop information constructed and valid. */ - loopinfo_cf_ip_consistent = loopinfo_constructed | loopinfo_cf | loopinfo_inter | loopinfo_valid, - /** IntERprocedural control loop information constructed and invalid. */ - loopinfo_cf_ip_inconsistent = loopinfo_constructed | loopinfo_cf | loopinfo_inter + loopinfo_none = 0, /**< No loop information is constructed. Default. */ + loopinfo_constructed = 1, /**< Some kind of loop information is constructed. */ + loopinfo_valid = 2, /**< Loop information is valid. */ + loopinfo_cf = 4, /**< Loop information constructed for control flow only. */ + loopinfo_inter = 8, /**< Loop information for interprocedural view. */ + + loopinfo_for_firmjni = 16, /**< A hack for firmjni: all enums must differ as they + are used in a switch. */ + + /** IntRAprocedural loop information constructed and valid. */ + loopinfo_consistent = loopinfo_constructed | loopinfo_for_firmjni | loopinfo_valid, + /** IntRAprocedural loop information constructed and invalid. */ + loopinfo_inconsistent = loopinfo_constructed | loopinfo_for_firmjni, + + /** IntERprocedural loop information constructed and valid. */ + loopinfo_ip_consistent = loopinfo_constructed | loopinfo_inter | loopinfo_valid, + /** IntERprocedural loop information constructed and invalid. */ + loopinfo_ip_inconsistent = loopinfo_constructed | loopinfo_inter, + + /** IntRAprocedural control loop information constructed and valid. */ + loopinfo_cf_consistent = loopinfo_constructed | loopinfo_cf | loopinfo_valid, + /** IntRAprocedural control loop information constructed and invalid. */ + loopinfo_cf_inconsistent = loopinfo_constructed | loopinfo_cf, + + /** IntERprocedural control loop information constructed and valid. */ + loopinfo_cf_ip_consistent = loopinfo_constructed | loopinfo_cf | loopinfo_inter | loopinfo_valid, + /** IntERprocedural control loop information constructed and invalid. */ + loopinfo_cf_ip_inconsistent = loopinfo_constructed | loopinfo_cf | loopinfo_inter } irg_loopinfo_state; /** Return the current loop information state. */ @@ -421,9 +441,9 @@ void set_irp_loopinfo_inconsistent(void); * information must be computed for the whole program, or not? */ typedef enum { - irg_callee_info_none, - irg_callee_info_consistent, - irg_callee_info_inconsistent + irg_callee_info_none, + irg_callee_info_consistent, + irg_callee_info_inconsistent } irg_callee_info_state; /** returns the callee_info_state of an IR graph. */ @@ -436,12 +456,12 @@ void set_irg_callee_info_state(ir_graph *irg, irg_callee_info_s * Tells how to handle an ir graph in inlineing. */ typedef enum { - irg_inline_any, /**< No restriction on inlineing. Default. */ - irg_inline_forbidden, /**< The graph may not be inlined. */ - irg_inline_recomended, /**< The graph should be inlined. */ - irg_inline_forced, /**< The graph must be inlined. */ - irg_inline_forced_no_body /**< The graph must be inlined. No body is allowed - to be emitted. */ + irg_inline_any, /**< No restriction on inlineing. Default. */ + irg_inline_forbidden, /**< The graph may not be inlined. */ + irg_inline_recomended, /**< The graph should be inlined. */ + irg_inline_forced, /**< The graph must be inlined. */ + irg_inline_forced_no_body /**< The graph must be inlined. No body is allowed + to be emitted. */ } irg_inline_property; /** Returns the inline property of a graph. */ @@ -454,6 +474,8 @@ void set_irg_inline_property(ir_graph *irg, irg_inline_property s); * The properties are automatically inherited from the method type * if they were not set using set_irg_additional_properties() or * set_irg_additional_property(). + * + * @return a bitset of mtp_additional_property values */ unsigned get_irg_additional_properties(const ir_graph *irg); @@ -469,49 +491,55 @@ void *get_irg_link (const ir_graph *irg); /** Increments visited flag by one. * @see also: get_irn_visited() get_irg_block_visited(). */ -void inc_irg_visited (ir_graph *irg); -unsigned long get_irg_visited (const ir_graph *irg); -void set_irg_visited (ir_graph *irg, unsigned long i); +void inc_irg_visited(ir_graph *irg); +unsigned long get_irg_visited(const ir_graph *irg); +void set_irg_visited(ir_graph *irg, unsigned long i); /** An interprocedural flag valid for all irgs. * @see also: get_irn_visited() get_irg_block_visited(). */ -unsigned long get_max_irg_visited (void); -void set_max_irg_visited (int val); -unsigned long inc_max_irg_visited (void); +unsigned long get_max_irg_visited(void); +void set_max_irg_visited(int val); +unsigned long inc_max_irg_visited(void); /** Increments block_visited by one. * @see also: get_irn_visited() get_irg_block_visited(). */ -void inc_irg_block_visited (ir_graph *irg); -unsigned long get_irg_block_visited (const ir_graph *irg); -void set_irg_block_visited (ir_graph *irg, unsigned long i); +void inc_irg_block_visited(ir_graph *irg); +unsigned long get_irg_block_visited(const ir_graph *irg); +void set_irg_block_visited(ir_graph *irg, unsigned long i); /** - * Debug helpers: You can indicate wether you are currently using visited or + * Debug helpers: You can indicate whether you are currently using visited or * block_visited flags. If NDEBUG is not defined, then the compiler will abort * if 2 parties try to use the flags. */ #ifndef NDEBUG -void set_using_block_visited(ir_graph *irg); -void clear_using_block_visited(ir_graph *irg); -int using_block_visited(const ir_graph *irg); -void set_using_visited(ir_graph *irg); -void clear_using_visited(ir_graph *irg); -int using_visited(const ir_graph *irg); -void set_using_irn_link(ir_graph *irg); -void clear_using_irn_link(ir_graph *irg); -int using_irn_link(const ir_graph *irg); +void set_using_block_visited(ir_graph *irg); +void clear_using_block_visited(ir_graph *irg); +int using_block_visited(const ir_graph *irg); +void set_using_irn_visited(ir_graph *irg); +void clear_using_irn_visited(ir_graph *irg); +int using_irn_visited(const ir_graph *irg); +void set_using_irn_link(ir_graph *irg); +void clear_using_irn_link(ir_graph *irg); +int using_irn_link(const ir_graph *irg); +void set_using_block_mark(ir_graph *irg); +void clear_using_block_mark(ir_graph *irg); +int using_block_mark(const ir_graph *irg); #else -static INLINE void set_using_block_visited(ir_graph *irg) { (void) irg; } -static INLINE void clear_using_block_visited(ir_graph *irg) { (void) irg; } -static INLINE int using_block_visited(const ir_graph *irg) { (void) irg; return 0; } -static INLINE void set_using_visited(ir_graph *irg) { (void) irg; } -static INLINE void clear_using_visited(ir_graph *irg) { (void) irg; } -static INLINE int using_visited(const ir_graph *irg) { (void) irg; return 0; } -static INLINE void set_using_irn_link(ir_graph *irg) { (void) irg; } -static INLINE void clear_using_irn_link(ir_graph *irg) { (void) irg; } -static INLINE int using_irn_link(const ir_graph *irg) { (void) irg; return 0; } +#define set_using_block_visited(irg) +#define clear_using_block_visited(irg) +#define using_block_visited(irg) 0 +#define set_using_irn_visited(irg) +#define clear_using_irn_visited(irg) +#define using_irn_visited(irg) 0 +#define set_using_irn_link(irg) +#define clear_using_irn_link(irg) +#define using_irn_link(irg) 0 +#define set_using_block_mark(irg) +#define clear_using_block_mark(irg) +#define using_block_mark(irg) 0 #endif -/** move Proj nodes into the same block as its predecessors */ +/** Normalization: Move Proj nodes into the same block as its predecessors */ void normalize_proj_nodes(ir_graph *irg); /** set a description for local value n */ @@ -544,7 +572,7 @@ void set_irg_fp_model(ir_graph *irg, unsigned model); * @return A pointer of type @p type. */ #define get_irg_data(graph,type,off) \ - (assert(off > 0 && "Invalid graph data offset"), (type *) ((char *) (graph) - (off))) + (assert(off > 0 && "Invalid graph data offset"), (type *) ((char *) (graph) - (off))) /** * Get the pointer to the node some custom data belongs to. @@ -553,7 +581,7 @@ void set_irg_fp_model(ir_graph *irg, unsigned model); * @return A pointer to the ir node the custom data belongs to. */ #define get_irg_data_base(data,off) \ - (assert(off > 0 && "Invalid graph data offset"), (ir_graph *) ((char *) (data) + (off))) + (assert(off > 0 && "Invalid graph data offset"), (ir_graph *) ((char *) (data) + (off))) /** * Request additional data to be allocated with an ir graph.