From: Michael Beck Date: Wed, 11 Jul 2007 13:15:02 +0000 (+0000) Subject: type type definitions to new irtype.h X-Git-Url: http://nsz.repo.hu/git/?a=commitdiff_plain;h=e4276a2614fb8c5027549e54b64dee3cc3be4c12;p=libfirm type type definitions to new irtype.h [r15042] --- diff --git a/ir/ir/irgraph_t.h b/ir/ir/irgraph_t.h index 06761e19d..586f3385b 100644 --- a/ir/ir/irgraph_t.h +++ b/ir/ir/irgraph_t.h @@ -30,156 +30,22 @@ #include "irgraph.h" #include "firm_common_t.h" -#include "irtypeinfo.h" +#include "irtypes.h" #include "irprog.h" #include "pseudo_irg.h" #include "type_t.h" #include "entity_t.h" #include "iredgekinds.h" -#include "irmemory.h" #include "irloop.h" -#include "execution_frequency.h" #include "obst.h" #include "pset.h" #include "set.h" -/** Prefix that is added to every frame type. */ +/** Suffix that is added to every frame type. */ #define FRAME_TP_SUFFIX "frame_tp" -/** - * Edge info to put into an irg. - */ -typedef struct _irg_edge_info_t { - set *edges; /**< a set containing all edges of a graph. */ - unsigned activated : 1; /**< set if edges are activated for the graph. */ -} irg_edge_info_t; - -typedef irg_edge_info_t irg_edges_info_t[EDGE_KIND_LAST]; - -/** - * Index constants for nodes that can be accessed through the graph itself. - */ -enum irg_anchors { - anchor_start_block = 0, /**< block the start node will belong to */ - anchor_start, /**< start node of this ir_graph */ - anchor_end_block, /**< block the end node will belong to */ - anchor_end, /**< end node of this ir_graph */ - anchor_end_reg, /**< end node of this ir_graph */ - anchor_end_except, /**< end node of this ir_graph */ - anchor_frame, /**< method's frame */ - anchor_globals, /**< pointer to the data segment containing all - globals as well as global procedures. */ - anchor_tls, /**< pointer to the thread local storage containing all - thread local data. */ - anchor_initial_mem, /**< initial memory of this graph */ - anchor_args, /**< methods arguments */ - anchor_value_param_base, /**< method value param base */ - anchor_bad, /**< bad node of this ir_graph, the one and - only in this graph */ - anchor_no_mem, /**< NoMem node of this ir_graph, the one and only in this graph */ - anchor_max -}; - -/** A callgraph entry for callees. */ -typedef struct cg_callee_entry { - ir_graph *irg; /**< The called irg. */ - ir_node **call_list; /**< The list of all calls to the irg. */ - int max_depth; /**< Maximum depth of all Call nodes to irg. */ -} cg_callee_entry; - -/** - * An ir_graph holds all information for a procedure. - */ -struct ir_graph { - firm_kind kind; /**< Always set to k_ir_graph. */ - /* -- Basics of the representation -- */ - ir_entity *ent; /**< The entity of this procedure, i.e., - the type of the procedure and the - class it belongs to. */ - ir_type *frame_type; /**< A class type representing the stack frame. - Can include "inner" methods. */ - ir_node *anchors[anchor_max]; /**< List of anchor nodes. */ - ir_node **proj_args; /**< Projs of the methods arguments. */ - struct obstack *obst; /**< The obstack where all of the ir_nodes live. */ - ir_node *current_block; /**< Current block for newly gen_*()-erated ir_nodes. */ - struct obstack *extbb_obst; /**< The obstack for extended basic block info. */ - - unsigned last_node_idx; /**< The last IR node index for this graph. */ - - /* -- Fields for graph properties -- */ - irg_inline_property inline_property; /**< How to handle inlineing. */ - unsigned additional_properties; /**< Additional graph properties. */ - - /* -- Fields indicating different states of irgraph -- */ - irg_phase_state phase_state; /**< Compiler phase. */ - op_pin_state irg_pinned_state; /**< Flag for status of nodes. */ - irg_outs_state outs_state; /**< Out edges. */ - irg_dom_state dom_state; /**< Dominator state information. */ - irg_dom_state pdom_state; /**< Post Dominator state information. */ - ir_typeinfo_state typeinfo_state; /**< Validity of type information. */ - irg_callee_info_state callee_info_state; /**< Validity of callee information. */ - irg_loopinfo_state loopinfo_state; /**< State of loop information. */ - ir_class_cast_state class_cast_state; /**< Kind of cast operations in code. */ - irg_extblk_info_state extblk_state; /**< State of extended basic block info. */ - exec_freq_state execfreq_state; /**< Execution frequency state. */ - ir_address_taken_computed_state adr_taken_state; /**< Address taken state. */ - unsigned mem_disambig_opt; /**< Options for the memory disambiguator. */ - unsigned fp_model; /**< floating point model of the graph. */ - - /* -- Fields for construction -- */ -#if USE_EXPLICIT_PHI_IN_STACK - struct Phi_in_stack *Phi_in_stack; /**< Needed for automatic Phi construction. */ -#endif - int n_loc; /**< Number of local variables in this - procedure including procedure parameters. */ - void **loc_descriptions; /**< Storage for local variable descriptions. */ - - /* -- Fields for optimizations / analysis information -- */ - pset *value_table; /**< Hash table for global value numbering (cse) - for optimizing use in iropt.c */ - ir_node **outs; /**< Space for the out arrays. */ - - ir_loop *loop; /**< The outermost loop for this graph. */ - void *link; /**< A void* field to link any information to - the node. */ - - ir_graph **callers; /**< For callgraph analysis: list of caller graphs. */ - unsigned char *caller_isbe; /**< For callgraph analysis: set if backedge. */ - cg_callee_entry **callees; /**< For callgraph analysis: list of callee calls */ - unsigned char *callee_isbe; /**< For callgraph analysis: set if backedge. */ - int callgraph_loop_depth; /**< For callgraph analysis */ - int callgraph_recursion_depth; /**< For callgraph analysis */ - double method_execution_frequency; /**< For callgraph analysis */ - - ir_loop *l; /**< For callgraph analysis. */ - - /* -- Fields for Walking the graph -- */ - unsigned long visited; /**< this flag is an identifier for - ir walk. it will be incremented - every time someone walks through - the graph */ - unsigned long block_visited; /**< same as visited, for a complete block */ - - unsigned estimated_node_count; /**< estimated number of nodes in this graph, - updated after every walk */ - irg_edges_info_t edge_info; /**< edge info for automatic outs */ - ir_node **idx_irn_map; /**< Array mapping node indexes to nodes. */ - -#ifdef DEBUG_libfirm - int n_outs; /**< Size wasted for outs */ - long graph_nr; /**< a unique graph number for each graph to make output - readable. */ -#endif - -#ifndef NDEBUG - unsigned using_visited : 1; /**< set to 1 if we are currently using the visited flag */ - unsigned using_block_visited : 1; /**< set to 1 if we are currently using the block_visited flag */ - unsigned using_irn_link : 1; /**< set to 1 if we are currently using the irn_link fields */ -#endif -}; - /** * Initializes the graph construction module */ diff --git a/ir/ir/irmode_t.h b/ir/ir/irmode_t.h index 22670d526..a414242d8 100644 --- a/ir/ir/irmode_t.h +++ b/ir/ir/irmode_t.h @@ -28,60 +28,8 @@ #define FIRM_IR_IRMODE_T_H #include +#include "irtypes.h" #include "irmode.h" -#include "tv.h" - -/** - * Contains relevant information about a mode. - * - * Necessary information about a mode is stored in this struct - * which is used by the tarval module to perform calculations - * and comparisons of values of a such described mode. - * - * ATTRIBUTES: - * - modecode code: An unambiguous int (enum) for the mode - * - ident *name: Name of this mode. Two modes are different if the name is different. - * - mode_sort sort: sort of mode specifying possible usage categories - * - int size: size of the mode in Bits. - * - unsigned sign:1: signedness of this mode - * - ... more to come - * - modulo_shift specifies for modes of kind irms_int_number - * whether shift applies modulo to value of bits to shift - * - * SEE ALSO: - * The tech report 1999-44 describing FIRM and predefined modes - * tarval.h - */ -struct ir_mode { - firm_kind kind; /**< distinguishes this node from others */ - modecode code; /**< unambiguous identifier of a mode */ - ident *name; /**< Name ident of this mode */ - - /* ----------------------------------------------------------------------- */ - /* On changing this struct you have to evaluate the mode_are_equal function!*/ - mode_sort sort; /**< coarse classification of this mode: - int, float, reference ... - (see irmode.h) */ - mode_arithmetic arithmetic; /**< different arithmetic operations possible with a mode */ - int size; /**< size of the mode in Bits. */ - unsigned sign:1; /**< signedness of this mode */ - unsigned int modulo_shift; /**< number of bits a values of this mode will be shifted */ - unsigned vector_elem; /**< if this is not equal 1, this is a vector mode with - vector_elem number of elements, size contains the size - of all bits and must be dividable by vector_elem */ - - /* ----------------------------------------------------------------------- */ - tarval *min; /**< the minimum value that can be expressed */ - tarval *max; /**< the maximum value that can be expressed */ - tarval *null; /**< the value 0 */ - tarval *one; /**< the value 1 */ - tarval *minus_one; /**< the value -1 */ - ir_mode *eq_signed; /**< For pointer modes, the equivalent signed integer one. */ - ir_mode *eq_unsigned; /**< For pointer modes, the equivalent unsigned integer one. */ - void *link; /**< To store some intermediate information */ - const void *tv_priv; /**< tarval module will save private data here */ -}; - /* ------------------------------- * * inline functions * diff --git a/ir/ir/irnode_t.h b/ir/ir/irnode_t.h index c5ca3264d..0a1d40116 100644 --- a/ir/ir/irnode_t.h +++ b/ir/ir/irnode_t.h @@ -27,268 +27,14 @@ #define FIRM_IR_IRNODE_T_H #include "firm_config.h" +#include "irtypes.h" #include "irnode.h" #include "irop_t.h" #include "irgraph_t.h" #include "irflag_t.h" #include "firm_common_t.h" -#include "irdom_t.h" /* For size of struct dom_info. */ -#include "iredgekinds.h" #include "array.h" -#include "set.h" -#include "list.h" - -/** ir node attributes **/ - -/** Block attributes */ -typedef struct { - /* General attributes */ - ir_graph *irg; /**< The graph this block belongs to. */ - unsigned long block_visited; /**< For the walker that walks over all blocks. */ - /* Attributes private to construction: */ - unsigned is_matured:1; /**< If set, all in-nodes of the block are fixed. */ - unsigned is_dead:1; /**< If set, the block is dead (and could be replace by a Bad. */ - unsigned is_mb_head:1; /**< Set if this block is a macroblock head. */ - ir_node **graph_arr; /**< An array to store all parameters. */ - /* Attributes holding analyses information */ - ir_dom_info dom; /**< Datastructure that holds information about dominators. - @@@ @todo - Eventually overlay with graph_arr as only valid - in different phases. Eventually inline the whole - datastructure. */ - ir_dom_info pdom; /**< Datastructure that holds information about post-dominators. */ - ir_node ** in_cg; /**< array with predecessors in - * interprocedural_view, if they differ - * from intraprocedural predecessors */ - int *backedge; /**< Field n set to true if pred n is backedge. - @@@ @todo Ev. replace by bit field! */ - int *cg_backedge; /**< Field n set to true if pred n is interprocedural backedge. - @@@ @todo Ev. replace by bit field! */ - ir_extblk *extblk; /**< The extended basic block this block belongs to. */ - ir_region *region; /**< The immediate structural region this block belongs to. */ - unsigned mb_depth; /**< The macroblock depth: A distance from the macroblock header */ - - struct list_head succ_head; /**< A list head for all successor edges of a block. */ -} block_attr; - -/** Cond attributes. */ -typedef struct { - cond_kind kind; /**< flavor of Cond */ - long default_proj; /**< only for non-binary Conds: biggest Proj number, i.e. the one used for default. */ - cond_jmp_predicate pred; /**< only for binary Conds: The jump predication. */ -} cond_attr; - -/** Const attributes. */ -typedef struct { - tarval *tv; /**< the target value */ - ir_type *tp; /**< the source type, for analyses. default: type_unknown. */ -} const_attr; - -/** SymConst attributes. */ -typedef struct { - symconst_symbol sym; // old tori - symconst_kind num; - ir_type *tp; /**< the source type, for analyses. default: type_unknown. */ -} symconst_attr; - -/** Sel attributes. */ -typedef struct { - ir_entity *ent; /**< entity to select */ -} sel_attr; - -/** Exception attributes. */ -typedef struct { - op_pin_state pin_state; /**< the pin state for operations that might generate a exception: - If it's know that no exception will be generated, could be set to - op_pin_state_floats. */ -#if PRECISE_EXC_CONTEXT - struct ir_node **frag_arr; /**< For Phi node construction in case of exception */ -#endif -} except_attr; - -/** Call attributes. */ -typedef struct { - except_attr exc; /**< the exception attribute. MUST be the first one. */ - ir_type *cld_tp; /**< type of called procedure */ - ir_entity ** callee_arr; /**< result of callee analysis */ -} call_attr; - -/** Alloc attributes. */ -typedef struct { - except_attr exc; /**< the exception attribute. MUST be the first one. */ - ir_type *type; /**< Type of the allocated object. */ - where_alloc where; /**< stack, heap or other managed part of memory */ -} alloc_attr; - -/** Free attributes. */ -typedef struct { - ir_type *type; /**< Type of the allocated object. */ - where_alloc where; /**< stack, heap or other managed part of memory */ -} free_attr; - -/** InstOf attributes. */ -typedef struct { - except_attr exc; /**< the exception attribute. MUST be the first one. */ - ir_type *type; /**< the type of which the object pointer must be */ -} io_attr; - -/** Filter attributes. */ -typedef struct { - long proj; /**< contains the result position to project (Proj) */ - ir_node ** in_cg; /**< array with interprocedural predecessors (Phi) */ - int *backedge; /**< Field n set to true if pred n is backedge. - @todo Ev. replace by bitfield! */ -} filter_attr; - -/** CallBegin attributes. */ -typedef struct { - ir_node * call; /**< Associated Call-operation. */ -} callbegin_attr; - -/** Cast attributes. */ -typedef struct { - ir_type *totype; /**< Type of the casted node. */ -} cast_attr; - -/** Load attributes. */ -typedef struct { - except_attr exc; /**< The exception attribute. MUST be the first one. */ - ir_mode *load_mode; /**< The mode of this Load operation. */ - ir_volatility volatility; /**< The volatility of a Load/Store operation. */ -} load_attr; - -/** Store attributes. */ -typedef struct { - except_attr exc; /**< the exception attribute. MUST be the first one. */ - ir_volatility volatility; /**< the volatility of a Store operation */ -} store_attr; - -typedef struct { - int pos; /**< For Phi0. Used to remember the value defined by - this Phi node. Needed when the Phi is completed - to call get_r_internal_value to find the - predecessors. If this attribute is set, the Phi - node takes the role of the obsolete Phi0 node, - therefore the name. */ -} phi0_attr; - -/**< Confirm attribute. */ -typedef struct { - pn_Cmp cmp; /**< The compare operation. */ -} confirm_attr; - -/** CopyB attribute. */ -typedef struct { - except_attr exc; /**< The exception attribute. MUST be the first one. */ - ir_type *data_type; /**< Type of the copied entity. */ -} copyb_attr; - -/** Bound attribute. */ -typedef struct { - except_attr exc; /**< The exception attribute. MUST be the first one. */ -} bound_attr; - -/** Conv attribute. */ -typedef struct { - char strict; /**< If set, this is a strict Conv that cannot be removed. */ -} conv_attr; - -/** Div/Mod/DivMod/Quot attribute. */ -typedef struct { - except_attr exc; /**< The exception attribute. MUST be the first one. */ - ir_mode *res_mode; /**< Result mode for the division. */ -} divmod_attr; - -/** Inline Assembler support attribute. */ -typedef struct { - op_pin_state pin_state; /**< the pin state for operations that might generate a exception */ - ident *asm_text; /**< The inline assembler text. */ - ir_asm_constraint *inputs; /**< Input constraints. */ - ir_asm_constraint *outputs; /**< Output constraints. */ - ident **clobber; /**< List of clobbered registers. */ -} asm_attr; - -/** Some IR-nodes just have one attribute, these are stored here, - some have more. Their name is 'irnodename_attr' */ -typedef union { - block_attr block; /**< For Block: Fields needed to construct it */ - cond_attr cond; /**< For Cond. */ - const_attr con; /**< For Const: contains the value of the constant and a type */ - symconst_attr symc; /**< For SymConst. */ - sel_attr sel; /**< For Sel. */ - call_attr call; /**< For Call: pointer to the type of the method to call */ - callbegin_attr callbegin; /**< For CallBegin. */ - alloc_attr alloc; /**< For Alloc. */ - free_attr free; /**< For Free. */ - io_attr instof; /**< For InstOf */ - cast_attr cast; /**< For Cast. */ - load_attr load; /**< For Load. */ - store_attr store; /**< For Store. */ - phi0_attr phi0; /**< for Phi0 nodes. */ - int *phi_backedge; /**< For Phi after construction. - Field n set to true if pred n is backedge. - @todo Ev. replace by bitfield! */ - long proj; /**< For Proj: contains the result position to project */ - confirm_attr confirm; /**< For Confirm: compare operation and region. */ - filter_attr filter; /**< For Filter */ - except_attr except; /**< For Phi node construction in case of exceptions */ - copyb_attr copyb; /**< For CopyB operation */ - bound_attr bound; /**< For Bound operation */ - conv_attr conv; /**< For Conv operation */ - divmod_attr divmod; /**< For Div/Mod/DivMod operation */ - asm_attr assem; /**< For ASM operation. */ -} attr; - -/** - * Edge info to put into an irn. - */ -typedef struct _irn_edge_kind_info_t { - struct list_head outs_head; /**< The list of all outs. */ - int out_count; /**< Number of outs in the list. */ -} irn_edge_info_t; - -typedef irn_edge_info_t irn_edges_info_t[EDGE_KIND_LAST]; - -/** - * The common structure of an irnode. - * If the node has some attributes, they are stored in the attr field. - */ -struct ir_node { - /* ------- Basics of the representation ------- */ - firm_kind kind; /**< Distinguishes this node from others. */ - ir_op *op; /**< The Opcode of this node. */ - ir_mode *mode; /**< The Mode of this node. */ - struct ir_node **in; /**< The array of predecessors / operands. */ - unsigned long visited; /**< The visited counter for walks of the graph. */ - unsigned node_idx; /**< The node index of this node in its graph. */ - void *link; /**< To attach additional information to the node, e.g. - used while construction to link Phi0 nodes and - during optimization to link to nodes that - shall replace a node. */ - /* ------- Fields for optimizations / analysis information ------- */ - struct ir_node **out; /**< @deprecated array of out edges. */ - struct dbg_info *dbi; /**< A pointer to information for debug support. */ - /* ------- For debugging ------- */ -#ifdef DEBUG_libfirm - int out_valid; - long node_nr; /**< A unique node number for each node to make output - readable. */ -#endif - /* ------- For analyses -------- */ - ir_loop *loop; /**< the loop the node is in. Access routines in irloop.h */ -#ifdef DO_HEAPANALYSIS - struct abstval *av; /**< Heapanalysis: The abstract value of this node. */ - struct section *sec; /**< Heapanalysis: The section of this node. */ -#endif - struct ir_node **deps; /**< Additional dependencies induced by state. */ - irn_edges_info_t edge_info; /**< Everlasting out edges. */ - /* ------- Opcode depending fields -------- */ - attr attr; /**< The set of attributes of this node. Depends on opcode. - Must be last field of struct ir_node. */ -}; - - /** * Returns the array with the ins. The content of the array may not be * changed. diff --git a/ir/ir/irop_t.h b/ir/ir/irop_t.h index 0c2c8e2e6..3502053b6 100644 --- a/ir/ir/irop_t.h +++ b/ir/ir/irop_t.h @@ -28,23 +28,8 @@ #include "firm_config.h" #include "irop.h" +#include "irtypes.h" #include "tv.h" -#include "irnode.h" - - -/** The type of an ir_op. */ -struct ir_op { - unsigned code; /**< The unique opcode of the op. */ - ident *name; /**< The name of the op. */ - size_t attr_size; /**< Space needed in memory for private attributes. */ - op_pin_state op_pin_state_pinned; /**< How to deal with the node in CSE, PRE. */ - op_arity opar; /**< The arity of operator. */ - int op_index; /**< The index of the first data operand, 0 for most cases, 1 for Div etc. */ - unsigned flags; /**< Flags describing the behavior of the ir_op, a bitmasks of irop_flags. */ - void *tag; /**< Some custom pointer the op's creator can attach stuff to. */ - - ir_op_ops ops; /**< The operations of the this op. */ -}; /** * Frees a newly created ir operation. diff --git a/ir/ir/irprog_t.h b/ir/ir/irprog_t.h index 660f3fc29..4b9de62f9 100644 --- a/ir/ir/irprog_t.h +++ b/ir/ir/irprog_t.h @@ -27,12 +27,9 @@ #ifndef FIRM_IR_IRPROG_T_H #define FIRM_IR_IRPROG_T_H -#ifdef HAVE_CONFIG_H #include "firm_config.h" -#endif - #include "irprog.h" -#include "irgraph.h" +#include "irtypes.h" #include "pseudo_irg.h" #include "ircgcons.h" #include "firm_common_t.h" @@ -45,60 +42,6 @@ #include "array.h" -/** ir_prog */ -struct ir_prog { - firm_kind kind; /**< must be k_ir_prog */ - ident *name; /**< A file name or the like. */ - ir_graph *main_irg; /**< The entry point to the compiled program - or NULL if no point exists. */ - ir_graph **graphs; /**< A list of all graphs in the ir. */ - ir_graph **pseudo_graphs; /**< A list of all pseudo graphs in the ir. See pseudo_irg.c */ - ir_graph *const_code_irg; /**< This ir graph gives the proper environment - to allocate nodes the represent values - of constant entities. It is not meant as - a procedure. */ - ir_type *glob_type; /**< The global type. Must be a class as it can - have fields and procedures. */ - ir_type *tls_type; /**< The thread local storage type. Must be a struct as it can - only have fields. */ - ir_type **types; /**< A list of all types in the ir. */ - ir_mode **modes; /**< A list of all modes in the ir. */ - ir_op **opcodes; /**< A list of all opcodes in the ir. */ - - /* -- states of and access to generated information -- */ - irg_phase_state phase_state; /**< The state of construction. */ - - ip_view_state ip_view; /**< The state of interprocedural view. */ - - irg_outs_state outs_state; /**< The state of out edges of ir nodes. */ - ir_node **ip_outedges; /**< A huge Array that contains all out edges - in interprocedural view. */ - irg_outs_state trouts_state; /**< The state of out edges of type information. */ - - irg_callee_info_state callee_info_state; /**< Validity of callee information. - Contains the lowest value or all irgs. */ - ir_typeinfo_state typeinfo_state; /**< Validity of type information. */ - inh_transitive_closure_state inh_trans_closure_state; /**< State of transitive closure - of inheritance relations. */ - - irp_callgraph_state callgraph_state; /**< The state of the callgraph. */ - ir_loop *outermost_cg_loop; /**< For callgraph analysis: entry point - to looptree over callgraph. */ - int max_callgraph_loop_depth; /**< needed in callgraph. */ - int max_callgraph_recursion_depth; /**< needed in callgraph. */ - double max_method_execution_frequency; /**< needed in callgraph. */ - irp_temperature_state temperature_state; /**< accumulated temperatures computed? */ - exec_freq_state execfreq_state; /**< The state of execution frequency information */ - loop_nesting_depth_state lnd_state; /**< The state of loop nesting depth information. */ - ir_class_cast_state class_cast_state; /**< The state of cast operations in code. */ - ir_address_taken_computed_state globals_adr_taken_state; /**< Address taken state of the globals. */ - - ir_exc_region_t last_region_nr; /**< The last exception region number that was assigned. */ -#ifdef DEBUG_libfirm - long max_node_nr; /**< to generate unique numbers for nodes. */ -#endif -}; - /** Adds mode to the list of modes in irp. */ void add_irp_mode(ir_mode *mode); diff --git a/ir/ir/irtypes.h b/ir/ir/irtypes.h new file mode 100644 index 000000000..84c069004 --- /dev/null +++ b/ir/ir/irtypes.h @@ -0,0 +1,547 @@ +/* + * Copyright (C) 1995-2007 University of Karlsruhe. All right reserved. + * + * This file is part of libFirm. + * + * This file may be distributed and/or modified under the terms of the + * GNU General Public License version 2 as published by the Free Software + * Foundation and appearing in the file LICENSE.GPL included in the + * packaging of this file. + * + * Licensees holding valid libFirm Professional Edition licenses may use + * this file in accordance with the libFirm Commercial License. + * Agreement provided with the Software. + * + * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE + * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE. + */ + +/** + * @file + * @brief Definition of the Firm IR base types, concentrated here + * @author Michael Beck + * @version $Id$ + */ +#ifndef FIRM_IR_IRDEFS_H +#define FIRM_IR_IRDEFS_H + +#include "firm_types.h" +#include "firm_common_t.h" +#include "irdom_t.h" +#include "irmode.h" +#include "irnode.h" +#include "irgraph.h" +#include "iredgekinds.h" +#include "irtypeinfo.h" +#include "execution_frequency.h" +#include "irmemory.h" +#include "callgraph.h" +#include "field_temperature.h" + +#include "pset.h" +#include "set.h" +#include "list.h" + +/** The type of an ir_op. */ +struct ir_op { + unsigned code; /**< The unique opcode of the op. */ + ident *name; /**< The name of the op. */ + size_t attr_size; /**< Space needed in memory for private attributes. */ + op_pin_state op_pin_state_pinned; /**< How to deal with the node in CSE, PRE. */ + op_arity opar; /**< The arity of operator. */ + int op_index; /**< The index of the first data operand, 0 for most cases, 1 for Div etc. */ + unsigned flags; /**< Flags describing the behavior of the ir_op, a bitmasks of irop_flags. */ + void *tag; /**< Some custom pointer the op's creator can attach stuff to. */ + + ir_op_ops ops; /**< The operations of the this op. */ +}; + +/** + * Contains relevant information about a mode. + * + * Necessary information about a mode is stored in this struct + * which is used by the tarval module to perform calculations + * and comparisons of values of a such described mode. + * + * ATTRIBUTES: + * - modecode code: An unambiguous int (enum) for the mode + * - ident *name: Name of this mode. Two modes are different if the name is different. + * - mode_sort sort: sort of mode specifying possible usage categories + * - int size: size of the mode in Bits. + * - unsigned sign:1: signedness of this mode + * - ... more to come + * - modulo_shift specifies for modes of kind irms_int_number + * whether shift applies modulo to value of bits to shift + * + * SEE ALSO: + * The tech report 1999-44 describing FIRM and predefined modes + * tarval.h + */ +struct ir_mode { + firm_kind kind; /**< distinguishes this node from others */ + modecode code; /**< unambiguous identifier of a mode */ + ident *name; /**< Name ident of this mode */ + + /* ----------------------------------------------------------------------- */ + /* On changing this struct you have to evaluate the mode_are_equal function!*/ + mode_sort sort; /**< coarse classification of this mode: + int, float, reference ... + (see irmode.h) */ + mode_arithmetic arithmetic; /**< different arithmetic operations possible with a mode */ + int size; /**< size of the mode in Bits. */ + unsigned sign:1; /**< signedness of this mode */ + unsigned int modulo_shift; /**< number of bits a values of this mode will be shifted */ + unsigned vector_elem; /**< if this is not equal 1, this is a vector mode with + vector_elem number of elements, size contains the size + of all bits and must be dividable by vector_elem */ + + /* ----------------------------------------------------------------------- */ + tarval *min; /**< the minimum value that can be expressed */ + tarval *max; /**< the maximum value that can be expressed */ + tarval *null; /**< the value 0 */ + tarval *one; /**< the value 1 */ + tarval *minus_one; /**< the value -1 */ + ir_mode *eq_signed; /**< For pointer modes, the equivalent signed integer one. */ + ir_mode *eq_unsigned; /**< For pointer modes, the equivalent unsigned integer one. */ + void *link; /**< To store some intermediate information */ + const void *tv_priv; /**< tarval module will save private data here */ +}; + +/** ir node attributes **/ + +/** Block attributes */ +typedef struct { + /* General attributes */ + ir_graph *irg; /**< The graph this block belongs to. */ + unsigned long block_visited; /**< For the walker that walks over all blocks. */ + /* Attributes private to construction: */ + unsigned is_matured:1; /**< If set, all in-nodes of the block are fixed. */ + unsigned is_dead:1; /**< If set, the block is dead (and could be replace by a Bad. */ + unsigned is_mb_head:1; /**< Set if this block is a macroblock head. */ + ir_node **graph_arr; /**< An array to store all parameters. */ + /* Attributes holding analyses information */ + ir_dom_info dom; /**< Datastructure that holds information about dominators. + @@@ @todo + Eventually overlay with graph_arr as only valid + in different phases. Eventually inline the whole + datastructure. */ + ir_dom_info pdom; /**< Datastructure that holds information about post-dominators. */ + ir_node ** in_cg; /**< array with predecessors in + * interprocedural_view, if they differ + * from intraprocedural predecessors */ + int *backedge; /**< Field n set to true if pred n is backedge. + @@@ @todo Ev. replace by bit field! */ + int *cg_backedge; /**< Field n set to true if pred n is interprocedural backedge. + @@@ @todo Ev. replace by bit field! */ + ir_extblk *extblk; /**< The extended basic block this block belongs to. */ + ir_region *region; /**< The immediate structural region this block belongs to. */ + unsigned mb_depth; /**< The macroblock depth: A distance from the macroblock header */ + + struct list_head succ_head; /**< A list head for all successor edges of a block. */ +} block_attr; + +/** Cond attributes. */ +typedef struct { + cond_kind kind; /**< flavor of Cond */ + long default_proj; /**< only for non-binary Conds: biggest Proj number, i.e. the one used for default. */ + cond_jmp_predicate pred; /**< only for binary Conds: The jump predication. */ +} cond_attr; + +/** Const attributes. */ +typedef struct { + tarval *tv; /**< the target value */ + ir_type *tp; /**< the source type, for analyses. default: type_unknown. */ +} const_attr; + +/** SymConst attributes. */ +typedef struct { + symconst_symbol sym; // old tori + symconst_kind num; + ir_type *tp; /**< the source type, for analyses. default: type_unknown. */ +} symconst_attr; + +/** Sel attributes. */ +typedef struct { + ir_entity *ent; /**< entity to select */ +} sel_attr; + +/** Exception attributes. */ +typedef struct { + op_pin_state pin_state; /**< the pin state for operations that might generate a exception: + If it's know that no exception will be generated, could be set to + op_pin_state_floats. */ +#if PRECISE_EXC_CONTEXT + struct ir_node **frag_arr; /**< For Phi node construction in case of exception */ +#endif +} except_attr; + +/** Call attributes. */ +typedef struct { + except_attr exc; /**< the exception attribute. MUST be the first one. */ + ir_type *cld_tp; /**< type of called procedure */ + ir_entity ** callee_arr; /**< result of callee analysis */ +} call_attr; + +/** Alloc attributes. */ +typedef struct { + except_attr exc; /**< the exception attribute. MUST be the first one. */ + ir_type *type; /**< Type of the allocated object. */ + where_alloc where; /**< stack, heap or other managed part of memory */ +} alloc_attr; + +/** Free attributes. */ +typedef struct { + ir_type *type; /**< Type of the allocated object. */ + where_alloc where; /**< stack, heap or other managed part of memory */ +} free_attr; + +/** InstOf attributes. */ +typedef struct { + except_attr exc; /**< the exception attribute. MUST be the first one. */ + ir_type *type; /**< the type of which the object pointer must be */ +} io_attr; + +/** Filter attributes. */ +typedef struct { + long proj; /**< contains the result position to project (Proj) */ + ir_node ** in_cg; /**< array with interprocedural predecessors (Phi) */ + int *backedge; /**< Field n set to true if pred n is backedge. + @todo Ev. replace by bitfield! */ +} filter_attr; + +/** CallBegin attributes. */ +typedef struct { + ir_node * call; /**< Associated Call-operation. */ +} callbegin_attr; + +/** Cast attributes. */ +typedef struct { + ir_type *totype; /**< Type of the casted node. */ +} cast_attr; + +/** Load attributes. */ +typedef struct { + except_attr exc; /**< The exception attribute. MUST be the first one. */ + ir_mode *load_mode; /**< The mode of this Load operation. */ + ir_volatility volatility; /**< The volatility of a Load/Store operation. */ +} load_attr; + +/** Store attributes. */ +typedef struct { + except_attr exc; /**< the exception attribute. MUST be the first one. */ + ir_volatility volatility; /**< the volatility of a Store operation */ +} store_attr; + +typedef struct { + int pos; /**< For Phi0. Used to remember the value defined by + this Phi node. Needed when the Phi is completed + to call get_r_internal_value to find the + predecessors. If this attribute is set, the Phi + node takes the role of the obsolete Phi0 node, + therefore the name. */ +} phi0_attr; + +/**< Confirm attribute. */ +typedef struct { + pn_Cmp cmp; /**< The compare operation. */ +} confirm_attr; + +/** CopyB attribute. */ +typedef struct { + except_attr exc; /**< The exception attribute. MUST be the first one. */ + ir_type *data_type; /**< Type of the copied entity. */ +} copyb_attr; + +/** Bound attribute. */ +typedef struct { + except_attr exc; /**< The exception attribute. MUST be the first one. */ +} bound_attr; + +/** Conv attribute. */ +typedef struct { + char strict; /**< If set, this is a strict Conv that cannot be removed. */ +} conv_attr; + +/** Div/Mod/DivMod/Quot attribute. */ +typedef struct { + except_attr exc; /**< The exception attribute. MUST be the first one. */ + ir_mode *res_mode; /**< Result mode for the division. */ +} divmod_attr; + +/** Inline Assembler support attribute. */ +typedef struct { + op_pin_state pin_state; /**< the pin state for operations that might generate a exception */ + ident *asm_text; /**< The inline assembler text. */ + ir_asm_constraint *inputs; /**< Input constraints. */ + ir_asm_constraint *outputs; /**< Output constraints. */ + ident **clobber; /**< List of clobbered registers. */ +} asm_attr; + +/** Some IR-nodes just have one attribute, these are stored here, + some have more. Their name is 'irnodename_attr' */ +typedef union { + block_attr block; /**< For Block: Fields needed to construct it */ + cond_attr cond; /**< For Cond. */ + const_attr con; /**< For Const: contains the value of the constant and a type */ + symconst_attr symc; /**< For SymConst. */ + sel_attr sel; /**< For Sel. */ + call_attr call; /**< For Call: pointer to the type of the method to call */ + callbegin_attr callbegin; /**< For CallBegin. */ + alloc_attr alloc; /**< For Alloc. */ + free_attr free; /**< For Free. */ + io_attr instof; /**< For InstOf */ + cast_attr cast; /**< For Cast. */ + load_attr load; /**< For Load. */ + store_attr store; /**< For Store. */ + phi0_attr phi0; /**< for Phi0 nodes. */ + int *phi_backedge; /**< For Phi after construction. + Field n set to true if pred n is backedge. + @todo Ev. replace by bitfield! */ + long proj; /**< For Proj: contains the result position to project */ + confirm_attr confirm; /**< For Confirm: compare operation and region. */ + filter_attr filter; /**< For Filter */ + except_attr except; /**< For Phi node construction in case of exceptions */ + copyb_attr copyb; /**< For CopyB operation */ + bound_attr bound; /**< For Bound operation */ + conv_attr conv; /**< For Conv operation */ + divmod_attr divmod; /**< For Div/Mod/DivMod operation */ + asm_attr assem; /**< For ASM operation. */ +} attr; + +/** + * Edge info to put into an irn. + */ +typedef struct _irn_edge_kind_info_t { + struct list_head outs_head; /**< The list of all outs. */ + int out_count; /**< Number of outs in the list. */ +} irn_edge_info_t; + +typedef irn_edge_info_t irn_edges_info_t[EDGE_KIND_LAST]; + +/** + * The common structure of an irnode. + * If the node has some attributes, they are stored in the attr field. + */ +struct ir_node { + /* ------- Basics of the representation ------- */ + firm_kind kind; /**< Distinguishes this node from others. */ + ir_op *op; /**< The Opcode of this node. */ + ir_mode *mode; /**< The Mode of this node. */ + struct ir_node **in; /**< The array of predecessors / operands. */ + unsigned long visited; /**< The visited counter for walks of the graph. */ + unsigned node_idx; /**< The node index of this node in its graph. */ + void *link; /**< To attach additional information to the node, e.g. + used while construction to link Phi0 nodes and + during optimization to link to nodes that + shall replace a node. */ + /* ------- Fields for optimizations / analysis information ------- */ + struct ir_node **out; /**< @deprecated array of out edges. */ + struct dbg_info *dbi; /**< A pointer to information for debug support. */ + /* ------- For debugging ------- */ +#ifdef DEBUG_libfirm + int out_valid; + long node_nr; /**< A unique node number for each node to make output + readable. */ +#endif + /* ------- For analyses -------- */ + ir_loop *loop; /**< the loop the node is in. Access routines in irloop.h */ +#ifdef DO_HEAPANALYSIS + struct abstval *av; /**< Heapanalysis: The abstract value of this node. */ + struct section *sec; /**< Heapanalysis: The section of this node. */ +#endif + struct ir_node **deps; /**< Additional dependencies induced by state. */ + irn_edges_info_t edge_info; /**< Everlasting out edges. */ + /* ------- Opcode depending fields -------- */ + attr attr; /**< The set of attributes of this node. Depends on opcode. + Must be last field of struct ir_node. */ +}; + +/** + * Edge info to put into an irg. + */ +typedef struct _irg_edge_info_t { + set *edges; /**< a set containing all edges of a graph. */ + unsigned activated : 1; /**< set if edges are activated for the graph. */ +} irg_edge_info_t; + +typedef irg_edge_info_t irg_edges_info_t[EDGE_KIND_LAST]; + +/** + * Index constants for nodes that can be accessed through the graph itself. + */ +enum irg_anchors { + anchor_start_block = 0, /**< block the start node will belong to */ + anchor_start, /**< start node of this ir_graph */ + anchor_end_block, /**< block the end node will belong to */ + anchor_end, /**< end node of this ir_graph */ + anchor_end_reg, /**< end node of this ir_graph */ + anchor_end_except, /**< end node of this ir_graph */ + anchor_frame, /**< method's frame */ + anchor_globals, /**< pointer to the data segment containing all + globals as well as global procedures. */ + anchor_tls, /**< pointer to the thread local storage containing all + thread local data. */ + anchor_initial_mem, /**< initial memory of this graph */ + anchor_args, /**< methods arguments */ + anchor_value_param_base, /**< method value param base */ + anchor_bad, /**< bad node of this ir_graph, the one and + only in this graph */ + anchor_no_mem, /**< NoMem node of this ir_graph, the one and only in this graph */ + anchor_max +}; + +/** A callgraph entry for callees. */ +typedef struct cg_callee_entry { + ir_graph *irg; /**< The called irg. */ + ir_node **call_list; /**< The list of all calls to the irg. */ + int max_depth; /**< Maximum depth of all Call nodes to irg. */ +} cg_callee_entry; + +/** + * An ir_graph holds all information for a procedure. + */ +struct ir_graph { + firm_kind kind; /**< Always set to k_ir_graph. */ + /* -- Basics of the representation -- */ + ir_entity *ent; /**< The entity of this procedure, i.e., + the type of the procedure and the + class it belongs to. */ + ir_type *frame_type; /**< A class type representing the stack frame. + Can include "inner" methods. */ + ir_node *anchors[anchor_max]; /**< List of anchor nodes. */ + ir_node **proj_args; /**< Projs of the methods arguments. */ + struct obstack *obst; /**< The obstack where all of the ir_nodes live. */ + ir_node *current_block; /**< Current block for newly gen_*()-erated ir_nodes. */ + struct obstack *extbb_obst; /**< The obstack for extended basic block info. */ + + unsigned last_node_idx; /**< The last IR node index for this graph. */ + + /* -- Fields for graph properties -- */ + irg_inline_property inline_property; /**< How to handle inlineing. */ + unsigned additional_properties; /**< Additional graph properties. */ + + /* -- Fields indicating different states of irgraph -- */ + irg_phase_state phase_state; /**< Compiler phase. */ + op_pin_state irg_pinned_state; /**< Flag for status of nodes. */ + irg_outs_state outs_state; /**< Out edges. */ + irg_dom_state dom_state; /**< Dominator state information. */ + irg_dom_state pdom_state; /**< Post Dominator state information. */ + ir_typeinfo_state typeinfo_state; /**< Validity of type information. */ + irg_callee_info_state callee_info_state; /**< Validity of callee information. */ + irg_loopinfo_state loopinfo_state; /**< State of loop information. */ + ir_class_cast_state class_cast_state; /**< Kind of cast operations in code. */ + irg_extblk_info_state extblk_state; /**< State of extended basic block info. */ + exec_freq_state execfreq_state; /**< Execution frequency state. */ + ir_address_taken_computed_state adr_taken_state; /**< Address taken state. */ + unsigned mem_disambig_opt; /**< Options for the memory disambiguator. */ + unsigned fp_model; /**< floating point model of the graph. */ + + /* -- Fields for construction -- */ +#if USE_EXPLICIT_PHI_IN_STACK + struct Phi_in_stack *Phi_in_stack; /**< Needed for automatic Phi construction. */ +#endif + int n_loc; /**< Number of local variables in this + procedure including procedure parameters. */ + void **loc_descriptions; /**< Storage for local variable descriptions. */ + + /* -- Fields for optimizations / analysis information -- */ + pset *value_table; /**< Hash table for global value numbering (cse) + for optimizing use in iropt.c */ + ir_node **outs; /**< Space for the out arrays. */ + + ir_loop *loop; /**< The outermost loop for this graph. */ + void *link; /**< A void* field to link any information to + the node. */ + + ir_graph **callers; /**< For callgraph analysis: list of caller graphs. */ + unsigned char *caller_isbe; /**< For callgraph analysis: set if backedge. */ + cg_callee_entry **callees; /**< For callgraph analysis: list of callee calls */ + unsigned char *callee_isbe; /**< For callgraph analysis: set if backedge. */ + int callgraph_loop_depth; /**< For callgraph analysis */ + int callgraph_recursion_depth; /**< For callgraph analysis */ + double method_execution_frequency; /**< For callgraph analysis */ + + ir_loop *l; /**< For callgraph analysis. */ + + /* -- Fields for Walking the graph -- */ + unsigned long visited; /**< this flag is an identifier for + ir walk. it will be incremented + every time someone walks through + the graph */ + unsigned long block_visited; /**< same as visited, for a complete block */ + + unsigned estimated_node_count; /**< estimated number of nodes in this graph, + updated after every walk */ + irg_edges_info_t edge_info; /**< edge info for automatic outs */ + ir_node **idx_irn_map; /**< Array mapping node indexes to nodes. */ + +#ifdef DEBUG_libfirm + int n_outs; /**< Size wasted for outs */ + long graph_nr; /**< a unique graph number for each graph to make output + readable. */ +#endif + +#ifndef NDEBUG + unsigned using_visited : 1; /**< set to 1 if we are currently using the visited flag */ + unsigned using_block_visited : 1; /**< set to 1 if we are currently using the block_visited flag */ + unsigned using_irn_link : 1; /**< set to 1 if we are currently using the irn_link fields */ +#endif +}; + +/** ir_prog */ +struct ir_prog { + firm_kind kind; /**< must be k_ir_prog */ + ident *name; /**< A file name or the like. */ + ir_graph *main_irg; /**< The entry point to the compiled program + or NULL if no point exists. */ + ir_graph **graphs; /**< A list of all graphs in the ir. */ + ir_graph **pseudo_graphs; /**< A list of all pseudo graphs in the ir. See pseudo_irg.c */ + ir_graph *const_code_irg; /**< This ir graph gives the proper environment + to allocate nodes the represent values + of constant entities. It is not meant as + a procedure. */ + ir_type *glob_type; /**< The global type. Must be a class as it can + have fields and procedures. */ + ir_type *tls_type; /**< The thread local storage type. Must be a struct as it can + only have fields. */ + ir_type **types; /**< A list of all types in the ir. */ + ir_mode **modes; /**< A list of all modes in the ir. */ + ir_op **opcodes; /**< A list of all opcodes in the ir. */ + + /* -- states of and access to generated information -- */ + irg_phase_state phase_state; /**< The state of construction. */ + + ip_view_state ip_view; /**< The state of interprocedural view. */ + + irg_outs_state outs_state; /**< The state of out edges of ir nodes. */ + ir_node **ip_outedges; /**< A huge Array that contains all out edges + in interprocedural view. */ + irg_outs_state trouts_state; /**< The state of out edges of type information. */ + + irg_callee_info_state callee_info_state; /**< Validity of callee information. + Contains the lowest value or all irgs. */ + ir_typeinfo_state typeinfo_state; /**< Validity of type information. */ + inh_transitive_closure_state inh_trans_closure_state; /**< State of transitive closure + of inheritance relations. */ + + irp_callgraph_state callgraph_state; /**< The state of the callgraph. */ + ir_loop *outermost_cg_loop; /**< For callgraph analysis: entry point + to looptree over callgraph. */ + int max_callgraph_loop_depth; /**< needed in callgraph. */ + int max_callgraph_recursion_depth; /**< needed in callgraph. */ + double max_method_execution_frequency; /**< needed in callgraph. */ + irp_temperature_state temperature_state; /**< accumulated temperatures computed? */ + exec_freq_state execfreq_state; /**< The state of execution frequency information */ + loop_nesting_depth_state lnd_state; /**< The state of loop nesting depth information. */ + ir_class_cast_state class_cast_state; /**< The state of cast operations in code. */ + ir_address_taken_computed_state globals_adr_taken_state; /**< Address taken state of the globals. */ + + ir_exc_region_t last_region_nr; /**< The last exception region number that was assigned. */ +#ifdef DEBUG_libfirm + long max_node_nr; /**< to generate unique numbers for nodes. */ +#endif +}; + + +#endif