X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=include%2Flibfirm%2Firop.h;h=21d413a12a36d2d3615fbcc59c954f8b95b8fdb5;hb=0578be52ff08bd852fee2b596dec194c031a79ee;hp=5c1112f5b06d0a1d646a56f0fafcbd473acf0449;hpb=8e4e49e66d1d578b31a5ffce9bb6ff94ba985dfb;p=libfirm diff --git a/include/libfirm/irop.h b/include/libfirm/irop.h index 5c1112f5b..21d413a12 100644 --- a/include/libfirm/irop.h +++ b/include/libfirm/irop.h @@ -21,12 +21,7 @@ * @file * @brief Representation of opcode of intermediate operation. * @author Christian Schaefer, Goetz Lindenmaier, Michael Beck - * @brief - * 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 @@ -37,6 +32,17 @@ #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 { oparity_invalid = 0, @@ -56,29 +62,27 @@ typedef enum { /** The irop flags */ typedef enum { irop_flag_none = 0, /**< Nothing. */ - irop_flag_labeled = 1U << 0, /**< If set, output edge labels on in-edges in vcg graph. */ - irop_flag_commutative = 1U << 1, /**< This operation is commutative. */ - irop_flag_cfopcode = 1U << 2, /**< This operation is a control flow operation. */ - irop_flag_fragile = 1U << 3, /**< Set if the operation can change the + 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 << 4, /**< Forking control flow at this operation. */ - irop_flag_highlevel = 1U << 5, /**< This operation is a pure high-level one and can be + 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 << 6, /**< This operation has no arguments and is some + irop_flag_constlike = 1U << 5, /**< This operation has no arguments and is some kind of a constant. */ - irop_flag_always_opt = 1U << 7, /**< This operation must always be optimized .*/ - irop_flag_keep = 1U << 8, /**< This operation can be kept in End's keep-alive list. */ - irop_flag_start_block = 1U << 9, /**< This operation is always placed in the Start block. */ - irop_flag_uses_memory = 1U << 10, /**< This operation has a memory input and may change the memory state. */ - irop_flag_dump_noblock = 1U << 11, /**< node should be dumped outside any blocks */ - irop_flag_dump_noinput = 1U << 12, /**< node is a placeholder for "no input" */ - irop_flag_cse_neutral = 1U << 13, /**< This operation is CSE neutral to its users. */ + 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 << 14, + irop_flag_unknown_jump = 1U << 11, } irop_flags; +ENUM_BITSET(irop_flags) /** Returns the ident for the opcode name */ FIRM_API ident *get_op_ident(const ir_op *op); @@ -92,7 +96,7 @@ FIRM_API unsigned get_op_code(const ir_op *op); /** Returns a human readable name of an op_pin_state. */ FIRM_API const char *get_op_pin_state_name(op_pin_state s); -/** Gets pinned state of an opcode. */ +/** 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 @@ -119,12 +123,12 @@ typedef void (*op_func)(void); 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. */ 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. */ FIRM_API irop_flags get_op_flags(const ir_op *op); @@ -186,20 +190,20 @@ typedef void (*copy_attr_func)(ir_graph *irg, const ir_node *old_node, ir_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)(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)(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() @@ -208,7 +212,7 @@ 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() @@ -242,12 +246,12 @@ typedef struct { 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. */ - equivalent_node_func transform_node_Proj; /**< Optimizes the Proj 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; /**< Return the type attribute of a node. */ - get_entity_attr_func get_entity_attr; /**< Return the entity attribute of a node. */ + 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. */ @@ -265,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. @@ -274,18 +277,39 @@ typedef struct { * The behavior of new opcode depends on the operations \c ops and the \c flags. */ FIRM_API 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); + 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); /** - * Set proj-number for X_regular and X_except projs of fragile nodes. + * 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 fragile_mem_index, - int pn_x_regular, int pn_x_except); +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. */ -FIRM_API const ir_op_ops *get_op_ops(const ir_op *op); +FIRM_API ir_op_ops *get_op_ops(ir_op *op); + +/** @} */ #include "end.h"