X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=include%2Flibfirm%2Firop.h;h=32891a358bb9bca4d9a6a7c8b9c19df6abe628c2;hb=c32482bc042c9f0591bec432ccb6dfcadbad4cb7;hp=ef2dbe6228ab2affe7f22a486e1079076230ba69;hpb=34042b2302b082639a44734b3dc31b9d0f2017eb;p=libfirm diff --git a/include/libfirm/irop.h b/include/libfirm/irop.h index ef2dbe622..32891a358 100644 --- a/include/libfirm/irop.h +++ b/include/libfirm/irop.h @@ -1,5 +1,5 @@ /* - * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved. + * Copyright (C) 1995-2011 University of Karlsruhe. All right reserved. * * This file is part of libFirm. * @@ -21,21 +21,27 @@ * @file * @brief Representation of opcode of intermediate operation. * @author Christian Schaefer, Goetz Lindenmaier, Michael Beck - * @version $Id$ - * @summary - * Operators of firm nodes. - * - * This module specifies the opcodes possible for ir nodes. Their - * definition is close to the operations specified in UKA Tech-Report - * 1999-14 + * @brief Operators of firm nodes. */ #ifndef FIRM_IR_IROP_H #define FIRM_IR_IROP_H -#include "firm_types.h" - #include +#include "firm_types.h" #include "ident.h" +#include "begin.h" +#include "opcodes.h" + +/** + * @ingroup ir_node + * @defgroup ir_op Node Opcodes + * + * This module specifies the opcodes possible for ir nodes. Their + * definition is close to the operations specified in UKA Tech-Report + * 1999-14 + * + * @{ + */ /** The allowed arities. */ typedef enum { @@ -55,184 +61,53 @@ typedef enum { /** The irop flags */ typedef enum { - irop_flag_none = 0x00000000, /**< Nothing. */ - irop_flag_labeled = 0x00000001, /**< If set, output edge labels on in-edges in vcg graph. */ - irop_flag_commutative = 0x00000002, /**< This operation is commutative. */ - irop_flag_cfopcode = 0x00000004, /**< This operation is a control flow operation. */ - irop_flag_ip_cfopcode = 0x00000008, /**< This operation manipulates the interprocedural control flow. */ - irop_flag_fragile = 0x00000010, /**< Set if the operation can change the control flow because - of an exception. */ - irop_flag_forking = 0x00000020, /**< Forking control flow at this operation. */ - irop_flag_highlevel = 0x00000040, /**< This operation is a pure high-level one and can be - skipped in low-level optimizations. */ - irop_flag_constlike = 0x00000080, /**< This operation has no arguments and is some - kind of a constant. */ - irop_flag_always_opt = 0x00000100, /**< This operation must always be optimized .*/ - irop_flag_keep = 0x00000200, /**< This operation can be kept in End's keep-alive list. */ - irop_flag_start_block = 0x00000400, /**< This operation is always placed in the Start block. */ - irop_flag_uses_memory = 0x00000800, /**< This operation has a memory input and may change the memory state. */ - irop_flag_dump_noblock = 0x00001000, /**< node should be dumped outside any blocks */ - irop_flag_dump_noinput = 0x00002000, /**< node is a placeholder for "no input" */ - irop_flag_machine = 0x00010000, /**< This operation is a machine operation. */ - irop_flag_machine_op = 0x00020000, /**< This operation is a machine operand. */ - irop_flag_user = 0x00040000 /**< This flag and all higher ones are free for machine user. */ + irop_flag_none = 0, /**< Nothing. */ + irop_flag_commutative = 1U << 0, /**< This operation is commutative. */ + irop_flag_cfopcode = 1U << 1, /**< This operation is a control flow operation. */ + irop_flag_fragile = 1U << 2, /**< Set if the operation can change the + control flow because of an exception. + */ + irop_flag_forking = 1U << 3, /**< Forking control flow at this operation. */ + irop_flag_highlevel = 1U << 4, /**< This operation is a pure high-level one and can be + skipped in low-level optimizations. */ + irop_flag_constlike = 1U << 5, /**< This operation has no arguments and is some + kind of a constant. */ + irop_flag_keep = 1U << 6, /**< This operation can be kept in End's keep-alive list. */ + irop_flag_start_block = 1U << 7, /**< This operation is always placed in the Start block. */ + irop_flag_uses_memory = 1U << 8, /**< This operation has a memory input and may change the memory state. */ + irop_flag_dump_noblock = 1U << 9, /**< node should be dumped outside any blocks */ + irop_flag_cse_neutral = 1U << 10, /**< This operation is CSE neutral to its users. */ + /** This operation jumps to an unknown destination. The CFG is a + * conservative aproximation in this case. You cannot change the destination + * of an unknown_jump */ + irop_flag_unknown_jump = 1U << 11, } irop_flags; - -/** The opcodes of the libFirm predefined operations. */ -typedef enum { - iro_Block, - iro_Start, iro_End, iro_Jmp, iro_IJmp, iro_Cond, iro_Return, - iro_Const, iro_SymConst, - iro_Sel, - iro_Call, iro_Add, iro_Sub, iro_Minus, iro_Mul, iro_Mulh, iro_Quot, iro_DivMod, - iro_Div, iro_Mod, iro_Abs, iro_And, iro_Or, iro_Eor, iro_Not, - iro_Cmp, iro_Shl, iro_Shr, iro_Shrs, iro_Rotl, iro_Conv, iro_Cast, - iro_Carry, iro_Borrow, - iro_Phi, - iro_Load, iro_Store, iro_Alloc, iro_Free, iro_Sync, - iro_Proj, iro_Tuple, iro_Id, iro_Bad, iro_Confirm, - iro_Unknown, iro_Filter, iro_Break, iro_CallBegin, iro_EndReg, iro_EndExcept, - iro_NoMem, iro_Mux, iro_Psi, iro_CopyB, - iro_InstOf, iro_Raise, iro_Bound, - iro_Pin, - iro_ASM, - iro_Anchor, - /* first not middleend node number */ - iro_Last = iro_Anchor, - /* first backend node number */ - beo_First, - /* backend specific nodes */ - beo_Spill = beo_First, - beo_Reload, - beo_Perm, - beo_MemPerm, - beo_Copy, - beo_Keep, - beo_CopyKeep, - beo_Call, - beo_Return, - beo_AddSP, - beo_SubSP, - beo_IncSP, - beo_RegParams, - beo_FrameAddr, - beo_Barrier, - beo_Unwind, - /* last backend node number */ - beo_Last = beo_Unwind, - /* first unfixed number. Dynamic node numbers start here */ - iro_MaxOpcode -} ir_opcode; - -extern ir_op *op_Block; ir_op *get_op_Block (void); - -extern ir_op *op_Start; ir_op *get_op_Start (void); -extern ir_op *op_End; ir_op *get_op_End (void); -extern ir_op *op_Jmp; ir_op *get_op_Jmp (void); -extern ir_op *op_IJmp; ir_op *get_op_IJmp (void); -extern ir_op *op_Cond; ir_op *get_op_Cond (void); -extern ir_op *op_Return; ir_op *get_op_Return (void); -extern ir_op *op_Sel; ir_op *get_op_Sel (void); - -extern ir_op *op_Const; ir_op *get_op_Const (void); -extern ir_op *op_SymConst; ir_op *get_op_SymConst (void); - -extern ir_op *op_Call; ir_op *get_op_Call (void); -extern ir_op *op_Add; ir_op *get_op_Add (void); -extern ir_op *op_Sub; ir_op *get_op_Sub (void); -extern ir_op *op_Minus; ir_op *get_op_Minus (void); -extern ir_op *op_Mul; ir_op *get_op_Mul (void); -extern ir_op *op_Mulh; ir_op *get_op_Mulh (void); -extern ir_op *op_Quot; ir_op *get_op_Quot (void); -extern ir_op *op_DivMod; ir_op *get_op_DivMod (void); -extern ir_op *op_Div; ir_op *get_op_Div (void); -extern ir_op *op_Mod; ir_op *get_op_Mod (void); -extern ir_op *op_Abs; ir_op *get_op_Abs (void); -extern ir_op *op_And; ir_op *get_op_And (void); -extern ir_op *op_Or; ir_op *get_op_Or (void); -extern ir_op *op_Eor; ir_op *get_op_Eor (void); -extern ir_op *op_Not; ir_op *get_op_Not (void); -extern ir_op *op_Cmp; ir_op *get_op_Cmp (void); -extern ir_op *op_Shl; ir_op *get_op_Shl (void); -extern ir_op *op_Shr; ir_op *get_op_Shr (void); -extern ir_op *op_Shrs; ir_op *get_op_Shrs (void); -extern ir_op *op_Rotl; ir_op *get_op_Rotl (void); -extern ir_op *op_Conv; ir_op *get_op_Conv (void); -extern ir_op *op_Cast; ir_op *get_op_Cast (void); -extern ir_op *op_Carry; ir_op *get_op_Carry (void); -extern ir_op *op_Borrow; ir_op *get_op_Borrow (void); - -extern ir_op *op_Phi; ir_op *get_op_Phi (void); - -extern ir_op *op_Load; ir_op *get_op_Load (void); -extern ir_op *op_Store; ir_op *get_op_Store (void); -extern ir_op *op_Alloc; ir_op *get_op_Alloc (void); -extern ir_op *op_Free; ir_op *get_op_Free (void); - -extern ir_op *op_Sync; ir_op *get_op_Sync (void); - -extern ir_op *op_Tuple; ir_op *get_op_Tuple (void); -extern ir_op *op_Proj; ir_op *get_op_Proj (void); -extern ir_op *op_Id; ir_op *get_op_Id (void); -extern ir_op *op_Bad; ir_op *get_op_Bad (void); -extern ir_op *op_Confirm; ir_op *get_op_Confirm (void); - -extern ir_op *op_Unknown; ir_op *get_op_Unknown (void); -extern ir_op *op_Filter; ir_op *get_op_Filter (void); -extern ir_op *op_Break; ir_op *get_op_Break (void); -extern ir_op *op_CallBegin; ir_op *get_op_CallBegin (void); -extern ir_op *op_EndReg; ir_op *get_op_EndReg (void); -extern ir_op *op_EndExcept; ir_op *get_op_EndExcept (void); - -extern ir_op *op_NoMem; ir_op *get_op_NoMem (void); -extern ir_op *op_Mux; ir_op *get_op_Mux (void); -extern ir_op *op_Psi; ir_op *get_op_Psi (void); -extern ir_op *op_CopyB; ir_op *get_op_CopyB (void); - -extern ir_op *op_InstOf; ir_op *get_op_InstOf (void); -extern ir_op *op_Raise; ir_op *get_op_Raise (void); -extern ir_op *op_Bound; ir_op *get_op_Bound (void); - -extern ir_op *op_Pin; ir_op *get_op_Pin (void); - -extern ir_op *op_ASM; ir_op *get_op_ASM (void); - -extern ir_op *op_Anchor; ir_op *get_op_Anchor (void); +ENUM_BITSET(irop_flags) /** Returns the ident for the opcode name */ -ident *get_op_ident(const ir_op *op); +FIRM_API ident *get_op_ident(const ir_op *op); /** Returns the string for the opcode. */ -const char *get_op_name(const ir_op *op); +FIRM_API const char *get_op_name(const ir_op *op); /** Returns the enum for the opcode */ -unsigned get_op_code(const ir_op *op); - -/** op_pin_state_pinned states. */ -typedef enum { - op_pin_state_floats = 0, /**< Nodes of this opcode can be placed in any basic block. */ - op_pin_state_pinned = 1, /**< Nodes must remain in this basic block. */ - op_pin_state_exc_pinned, /**< Node must be remain in this basic block if it can throw an - exception, else can float. Used internally. */ - op_pin_state_mem_pinned /**< Node must be remain in this basic block if it can throw an - exception or uses memory, else can float. Used internally. */ -} op_pin_state; +FIRM_API unsigned get_op_code(const ir_op *op); /** Returns a human readable name of an op_pin_state. */ -const char *get_op_pin_state_name(op_pin_state s); +FIRM_API const char *get_op_pin_state_name(op_pin_state s); -/** Gets pinned state of an opcode. */ -op_pin_state get_op_pinned(const ir_op *op); +/** Returns pinned state of an opcode. */ +FIRM_API op_pin_state get_op_pinned(const ir_op *op); /** Sets pinned in the opcode. Setting it to floating has no effect for Block, Phi and control flow nodes. */ -void set_op_pinned(ir_op *op, op_pin_state pinned); +FIRM_API void set_op_pinned(ir_op *op, op_pin_state pinned); /** Returns the next free IR opcode number, allows to register user ops. */ -unsigned get_next_ir_opcode(void); +FIRM_API unsigned get_next_ir_opcode(void); /** Returns the next free n IR opcode number, allows to register a bunch of user ops. */ -unsigned get_next_ir_opcodes(unsigned num); +FIRM_API unsigned get_next_ir_opcodes(unsigned num); /** * A generic function pointer type. @@ -245,17 +120,17 @@ typedef void (*op_func)(void); /** * Returns the generic function pointer from an IR operation. */ -op_func get_generic_function_ptr(const ir_op *op); +FIRM_API op_func get_generic_function_ptr(const ir_op *op); /** - * Store a generic function pointer into an IR operation. + * Stores a generic function pointer into an IR operation. */ -void set_generic_function_ptr(ir_op *op, op_func func); +FIRM_API void set_generic_function_ptr(ir_op *op, op_func func); /** - * Return the irop flags of an IR opcode. + * Returns the irop flags of an IR opcode. */ -irop_flags get_op_flags(const ir_op *op); +FIRM_API irop_flags get_op_flags(const ir_op *op); /** * The hash operation. @@ -268,7 +143,7 @@ typedef unsigned (*hash_func)(const ir_node *self); * This operation evaluates an IR node into a tarval if possible, * returning tarval_bad otherwise. */ -typedef tarval *(*computed_value_func)(ir_node *self); +typedef ir_tarval *(*computed_value_func)(const ir_node *self); /** * The equivalent node operation. @@ -295,7 +170,7 @@ typedef ir_node *(*transform_node_func)(ir_node *self); * Compares the nodes attributes of two nodes of identical opcode * and returns 0 if the attributes are identical, 1 if they differ. */ -typedef int (*node_cmp_attr_func)(ir_node *a, ir_node *b); +typedef int (*node_cmp_attr_func)(const ir_node *a, const ir_node *b); /** * The reassociation operation. @@ -310,45 +185,39 @@ typedef int (*reassociate_func)(ir_node **n); * The copy attribute operation. * Copy the node attributes from an 'old' node to a 'new' one. */ -typedef void (*copy_attr_func)(const ir_node *old_node, ir_node *new_node); - -/** - * The get_type operation. - * Return the type of the node self. - */ -typedef ir_type *(*get_type_func)(ir_node *self); +typedef void (*copy_attr_func)(ir_graph *irg, const ir_node *old_node, ir_node *new_node); /** * The get_type_attr operation. Used to traverse all types that can be * accessed from an ir_graph. - * Return the type attribute of the node self. + * Returns the type attribute of the node self. */ -typedef ir_type *(*get_type_attr_func)(ir_node *self); +typedef ir_type *(*get_type_attr_func)(const ir_node *self); /** * The get_entity_attr operation. Used to traverse all entities that can be * accessed from an ir_graph. - * Return the entity attribute of the node self. + * Returns the entity attribute of the node self. */ -typedef ir_entity *(*get_entity_attr_func)(ir_node *self); +typedef ir_entity *(*get_entity_attr_func)(const ir_node *self); /** * The verify_node operation. - * Return non-zero if the node verification is ok, else 0. + * Returns non-zero if the node verification is ok, else 0. * Depending on the node verification settings, may even assert. * * @see do_node_verification() */ -typedef int (*verify_node_func)(ir_node *self, ir_graph *irg); +typedef int (*verify_node_func)(const ir_node *node); /** * The verify_node operation for Proj(X). - * Return non-zero if the node verification is ok, else 0. + * Returns non-zero if the node verification is ok, else 0. * Depending on the node verification settings, may even assert. * * @see do_node_verification() */ -typedef int (*verify_proj_node_func)(ir_node *self, ir_node *proj); +typedef int (*verify_proj_node_func)(const ir_node *proj); /** * Reasons to call the dump_node operation: @@ -365,27 +234,29 @@ typedef enum { * Writes several informations requested by reason to * an output file */ -typedef int (*dump_node_func)(ir_node *self, FILE *F, dump_reason_t reason); +typedef void (*dump_node_func)(FILE *out, const ir_node *self, dump_reason_t reason); /** * io_op Operations. */ typedef struct { - hash_func hash; /**< Calculate a hash value for an IR node. */ - computed_value_func computed_value; /**< Evaluates a node into a tarval if possible. */ - equivalent_node_func equivalent_node; /**< Optimizes the node by returning an equivalent one. */ - transform_node_func transform_node; /**< Optimizes the node by transforming it. */ - node_cmp_attr_func node_cmp_attr; /**< Compares two node attributes. */ - reassociate_func reassociate; /**< Reassociate a tree. */ - copy_attr_func copy_attr; /**< Copy node attributes. */ - get_type_func get_type; /**< Return the type of a node. */ - get_type_attr_func get_type_attr; /**< Return the type attribute of a node. */ - get_entity_attr_func get_entity_attr; /**< Return the entity attribute of a node. */ - verify_node_func verify_node; /**< Verify the node. */ - verify_proj_node_func verify_proj_node; /**< Verify the Proj node. */ - dump_node_func dump_node; /**< Dump a node. */ - op_func generic; /**< A generic function pointer. */ - const arch_irn_ops_t *be_ops; /**< callbacks used by the backend. */ + hash_func hash; /**< Calculate a hash value for an IR node. */ + computed_value_func computed_value; /**< Evaluates a node into a tarval if possible. */ + computed_value_func computed_value_Proj; /**< Evaluates a Proj node into a tarval if possible. */ + equivalent_node_func equivalent_node; /**< Optimizes the node by returning an equivalent one. */ + equivalent_node_func equivalent_node_Proj; /**< Optimizes the Proj node by returning an equivalent one. */ + transform_node_func transform_node; /**< Optimizes the node by transforming it. */ + transform_node_func transform_node_Proj; /**< Optimizes the Proj node by transforming it. */ + node_cmp_attr_func node_cmp_attr; /**< Compares two node attributes. */ + reassociate_func reassociate; /**< Reassociate a tree. */ + copy_attr_func copy_attr; /**< Copy node attributes. */ + get_type_attr_func get_type_attr; /**< Returns the type attribute of a node. */ + get_entity_attr_func get_entity_attr; /**< Returns the entity attribute of a node. */ + verify_node_func verify_node; /**< Verify the node. */ + verify_proj_node_func verify_proj_node; /**< Verify the Proj node. */ + dump_node_func dump_node; /**< Dump a node. */ + op_func generic; /**< A generic function pointer. */ + const arch_irn_ops_t *be_ops; /**< callbacks used by the backend. */ } ir_op_ops; /** @@ -398,7 +269,6 @@ typedef struct { * @param opar the parity of this IR operation * @param op_index if the parity is oparity_unary, oparity_binary or oparity_trinary the index * of the left operand - * @param ops operations for this opcode, iff NULL default operations are used * @param attr_size attribute size for this IR operation * * @return The generated IR operation. @@ -406,11 +276,41 @@ typedef struct { * This function can create all standard Firm opcode as well as new ones. * The behavior of new opcode depends on the operations \c ops and the \c flags. */ -ir_op *new_ir_op(unsigned code, const char *name, op_pin_state p, - unsigned flags, op_arity opar, int op_index, size_t attr_size, - const ir_op_ops *ops); +FIRM_API ir_op *new_ir_op(unsigned code, const char *name, op_pin_state p, + irop_flags flags, op_arity opar, int op_index, + size_t attr_size); + +/** Returns one more than the highest opcode code in use. */ +FIRM_API unsigned ir_get_n_opcodes(void); + +/** + * Returns the opcode with code @p code. + * + * @p code has to be smaller than get_irp_n_opcode(), returns NULL if + * no opcode with the code exists. + */ +FIRM_API ir_op *ir_get_opcode(unsigned code); + +/** Sets the generic function pointer of all opcodes to NULL */ +FIRM_API void ir_clear_opcodes_generic_func(void); + +/** + * Sets memory input of operation using memory + */ +FIRM_API void ir_op_set_memory_index(ir_op *op, int memory_index); + +/** + * Sets proj-number for X_regular and X_except projs of fragile nodes. + * Note: should only be used immediately after new_ir_op + */ +FIRM_API void ir_op_set_fragile_indices(ir_op *op, int pn_x_regular, + int pn_x_except); /** Returns the ir_op_ops of an ir_op. */ -const ir_op_ops *get_op_ops(const ir_op *op); +FIRM_API const ir_op_ops *get_op_ops(const ir_op *op); + +/** @} */ + +#include "end.h" #endif