s/irn_not_visited(x)/!irn_visited(x)/.
[libfirm] / include / libfirm / irop.h
index 1f92e19..182c259 100644 (file)
@@ -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.
  *
 #include <stdio.h>
 #include "ident.h"
 
-/** The allowed parities */
+/** The allowed arities. */
 typedef enum {
        oparity_invalid = 0,
-       oparity_unary,              /**< an unary operator -- considering 'numeric' arguments. */
-       oparity_binary,             /**< an binary operator  -- considering 'numeric' arguments.*/
-       oparity_trinary,            /**< an trinary operator  -- considering 'numeric' arguments.*/
-       oparity_zero,               /**< no operators, as e.g. Const. */
-       oparity_variable,           /**< arity not fixed by opcode, but statically
+       oparity_unary,              /**< An unary operator -- considering 'numeric' arguments. */
+       oparity_binary,             /**< A binary operator  -- considering 'numeric' arguments.*/
+       oparity_trinary,            /**< A trinary operator  -- considering 'numeric' arguments.*/
+       oparity_zero,               /**< A zero arity operator, e.g. a Const. */
+       oparity_variable,           /**< The arity is not fixed by opcode, but statically
                                         known.  E.g., number of arguments to call. */
-       oparity_dynamic,            /**< arity depends on state of firm representation.
-                                        Can change by optimizations...
+       oparity_dynamic,            /**< The arity depends on state of Firm representation.
+                                        Can be changed by optimizations...
                                         We must allocate a dynamic in array for the node! */
-       oparity_any                 /**< other arity */
+       oparity_any                 /**< Any other arity. */
 } op_arity;
 
 
@@ -70,9 +70,12 @@ typedef enum {
        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_machine     = 0x00000800, /**< This operation is a machine operation. */
-       irop_flag_machine_op  = 0x00001000, /**< This operation is a machine operand. */
-       irop_flag_user        = 0x00002000  /**< This flag and all higher ones are free for machine user. */
+       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_flags;
 
 /** The opcodes of the libFirm predefined operations. */
@@ -81,19 +84,43 @@ typedef enum {
        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_Quot, iro_DivMod,
+       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_Rot, iro_Conv, iro_Cast,
+       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_NoMem, iro_Mux, iro_Min, iro_Max, 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;
 
@@ -115,6 +142,7 @@ 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);
@@ -128,7 +156,7 @@ 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_Rot;             ir_op *get_op_Rot       (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);
@@ -158,7 +186,8 @@ 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_Min;             ir_op *get_op_Min       (void);
+extern ir_op *op_Max;             ir_op *get_op_Max       (void);
 extern ir_op *op_CopyB;           ir_op *get_op_CopyB     (void);
 
 extern ir_op *op_InstOf;          ir_op *get_op_InstOf    (void);
@@ -180,7 +209,7 @@ 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 */
+/** 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. */
@@ -190,23 +219,24 @@ typedef enum {
                                         exception or uses memory, else can float. Used internally. */
 } op_pin_state;
 
+/** Returns a human readable name of an op_pin_state. */
 const char *get_op_pin_state_name(op_pin_state s);
 
-/** gets pinned state of an opcode */
+/** Gets pinned state of an opcode. */
 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. */
+    for Block, Phi and control flow nodes. */
 void set_op_pinned(ir_op *op, op_pin_state pinned);
 
-/** Returns the next free IR opcode number, allows to register user ops */
+/** Returns the next free IR opcode number, allows to register user ops. */
 unsigned get_next_ir_opcode(void);
 
-/** Returns the next free n IR opcode number, allows to register a bunch of user ops */
+/** Returns the next free n IR opcode number, allows to register a bunch of user ops. */
 unsigned get_next_ir_opcodes(unsigned num);
 
 /**
- * A generic function pointer.
+ * A generic function pointer type.
  */
 typedef void (*op_func)(void);
 
@@ -214,21 +244,32 @@ typedef void (*op_func)(void);
 #define NULL_FUNC       ((generic_func)(NULL))
 
 /**
- * Returns the generic function pointer from an ir operation.
+ * Returns the generic function pointer from an IR operation.
  */
 op_func get_generic_function_ptr(const ir_op *op);
 
 /**
- * Store a generic function pointer into an ir operation.
+ * Store a generic function pointer into an IR operation.
  */
 void set_generic_function_ptr(ir_op *op, op_func func);
 
+/**
+ * Return the irop flags of an IR opcode.
+ */
+irop_flags get_op_flags(const ir_op *op);
+
+/**
+ * The hash operation.
+ * This operation calculates a hash value for a given IR node.
+ */
+typedef unsigned (*hash_func)(const ir_node *self);
+
 /**
  * The compute value operation.
  * This operation evaluates an IR node into a tarval if possible,
  * returning tarval_bad otherwise.
  */
-typedef tarval *(*computed_value_func)(ir_node *self);
+typedef tarval *(*computed_value_func)(const ir_node *self);
 
 /**
  * The equivalent node operation.
@@ -268,7 +309,7 @@ typedef int (*reassociate_func)(ir_node **n);
 
 /**
  * The copy attribute operation.
- * Copy the node attributes from a 'old' node to a 'new' one.
+ * 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);
 
@@ -314,10 +355,10 @@ typedef int (*verify_proj_node_func)(ir_node *self, ir_node *proj);
  * Reasons to call the dump_node operation:
  */
 typedef enum {
-       dump_node_opcode_txt,   /**< dump the opcode */
-       dump_node_mode_txt,     /**< dump the mode */
-       dump_node_nodeattr_txt, /**< dump node attributes to be shown in the label */
-       dump_node_info_txt      /**< dump node attributes into info1 */
+       dump_node_opcode_txt,   /**< Dump the opcode. */
+       dump_node_mode_txt,     /**< Dump the mode. */
+       dump_node_nodeattr_txt, /**< Dump node attributes to be shown in the label. */
+       dump_node_info_txt      /**< Dump node attributes into info1. */
 } dump_reason_t;
 
 /**
@@ -331,42 +372,47 @@ typedef int (*dump_node_func)(ir_node *self, FILE *F, dump_reason_t reason);
  * io_op Operations.
  */
 typedef struct {
-       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 */
+       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. */
+       equivalent_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_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. */
 } ir_op_ops;
 
 /**
- * Creates a new ir operation.
+ * Creates a new IR operation.
  *
  * @param code      the opcode, one of type \c opcode
  * @param name      the printable name of this opcode
  * @param p         whether operations of this opcode are op_pin_state_pinned or floating
- * @param flags     a bitmask of irop_flags describing the behavior of the ir operation
- * @param opar      the parity of this ir operation
+ * @param flags     a bitmask of irop_flags describing the behavior of the IR operation
+ * @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
+ * @param attr_size attribute size for this IR operation
  *
- * @return The generated ir operation.
+ * @return The generated IR operation.
  *
  * 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);
+       unsigned flags, op_arity opar, int op_index, size_t attr_size,
+       const ir_op_ops *ops);
 
 /** Returns the ir_op_ops of an ir_op. */
 const ir_op_ops *get_op_ops(const ir_op *op);