is_irn_always_opt() added
[libfirm] / ir / ir / irop.h
index 2395ed3..6540751 100644 (file)
  *  definition is close to the operations specified in UKA Tech-Report
  *  1999-14
  */
-#ifndef _IROP_H_
-#define _IROP_H_
+#ifndef _FIRM_IR_IROP_H_
+#define _FIRM_IR_IROP_H_
 
 #include "firm_types.h"
+
+#include <stdio.h>
 #include "ident.h"
 
 /** The allowed parities */
@@ -35,10 +37,10 @@ typedef enum {
   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
-                                                          known.  E.g., number of arguments to call. */
+                                   known.  E.g., number of arguments to call. */
   oparity_dynamic,            /**< arity depends on state of firm representation.
-                                                    Can change by optimizations...
-                                                    We must allocate a dynamic in array for the node! */
+                                   Can change by optimizations...
+                                   We must allocate a dynamic in array for the node! */
   oparity_any                 /**< other arity */
 } op_arity;
 
@@ -46,37 +48,48 @@ 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,  /**< operation is commutative */
+  irop_flag_labeled     = 0x00000001, /**< if set, Output edge labels on in-edges in vcg graph */
+  irop_flag_commutative = 0x00000002, /**< operation is commutative */
   irop_flag_cfopcode    = 0x00000004, /**< is a control flow operation */
-  irop_flag_ip_cfopcode = 0x00000008,  /**< operation manipulates interprocedural control flow */
-  irop_flag_fragile     = 0x00000010,  /**< set if the operation can change the control flow because
-                                             of an exception */
+  irop_flag_ip_cfopcode = 0x00000008, /**< operation manipulates interprocedural control flow */
+  irop_flag_fragile     = 0x00000010, /**< set if the operation can change the control flow because
+                                           of an exception */
   irop_flag_forking     = 0x00000020, /**< the operation is a forking control flow */
   irop_flag_highlevel   = 0x00000040, /**< the operation is a pure high-level one and can be
                                            skipped in low-level optimizations */
-  irop_flag_constlike   = 0x00000080  /**< the operation has no arguments and is some
+  irop_flag_constlike   = 0x00000080, /**< the 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_machine     = 0x00000400, /**< this operation is a machine operation */
+  irop_flag_machine_op  = 0x00000800, /**< this operation is a machine operand */
+  irop_flag_user        = 0x00001000  /**< this flag and all higher one are free for machine user */
 } 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_Raise,
+  iro_Start, iro_End, iro_Jmp, iro_IJmp, iro_Cond, iro_Return,
   iro_Const, iro_SymConst,
-  iro_Sel,  iro_InstOf,
+  iro_Sel,
   iro_Call, iro_Add, iro_Sub, iro_Minus, iro_Mul, 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_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_CopyB,
+  iro_NoMem, iro_Mux, iro_Psi, iro_CopyB,
+  iro_InstOf, iro_Raise, iro_Bound,
+  iro_Pin,
   iro_MaxOpcode
 } opcode;
 
+#ifndef _IR_OP_TYPEDEF_
+#define _IR_OP_TYPEDEF_
 typedef struct ir_op ir_op;
+#endif
 
 extern ir_op *op_Block;           ir_op *get_op_Block     (void);
 
@@ -86,9 +99,7 @@ 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_Raise;           ir_op *get_op_Raise     (void);
 extern ir_op *op_Sel;             ir_op *get_op_Sel       (void);
-extern ir_op *op_InstOf;          ir_op *get_op_InstOf    (void);
 
 extern ir_op *op_Const;           ir_op *get_op_Const     (void);
 extern ir_op *op_SymConst;        ir_op *get_op_SymConst  (void);
@@ -114,6 +125,8 @@ 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_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);
 
@@ -139,8 +152,15 @@ 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);
+
 /** Returns the ident for the opcode name */
 ident *get_op_ident(const ir_op *op);
 
@@ -172,6 +192,9 @@ 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);
 
+/** 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.
  */
@@ -243,7 +266,21 @@ 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 type *(*get_type_func)(ir_node *self);
+typedef ir_type *(*get_type_func)(ir_node *self);
+
+/**
+ * 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.
+ */
+typedef ir_type *(*get_type_attr_func)(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.
+ */
+typedef entity *(*get_entity_attr_func)(ir_node *self);
 
 /**
  * The verify_node operation.
@@ -269,7 +306,8 @@ typedef int (*verify_proj_node_func)(ir_node *self, ir_node *proj);
 typedef enum {
   dump_node_opcode_txt,   /**< dump the opcode */
   dump_node_mode_txt,     /**< dump the mode */
-  dump_node_nodeattr_txt  /**< dump the node attributes */
+  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;
 
 /**
@@ -283,13 +321,15 @@ 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. */
+  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 */
@@ -321,4 +361,4 @@ ir_op * new_ir_op(opcode code, const char *name, op_pin_state p,
 /** Returns the ir_op_ops of an ir_op. */
 const ir_op_ops *get_op_ops(const ir_op *op);
 
-#endif /* _IROP_H_ */
+#endif /* _FIRM_IR_IROP_H_ */