group High-Level exception support ops together
[libfirm] / ir / ir / irop.h
index 3ab82d3..d711344 100644 (file)
  *  definition is close to the operations specified in UKA Tech-Report
  *  1999-14
  */
+#ifndef _IROP_H_
+#define _IROP_H_
 
-# ifndef _IROP_H_
-# define _IROP_H_
+#include "firm_types.h"
 
-# include "ident.h"
+#include <stdio.h>
+#include "ident.h"
 
 /** The allowed parities */
 typedef enum {
@@ -35,11 +37,11 @@ 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! */
-  oparity_any,                /**< other arity */
+                                                    Can change by optimizations...
+                                                    We must allocate a dynamic in array for the node! */
+  oparity_any                 /**< other arity */
 } op_arity;
 
 
@@ -55,14 +57,17 @@ typedef enum {
   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
+                                           kind of a constant */
+  irop_flag_keep        = 0x00000100  /**< this operation can be kept in End's keep-alive list */
 } irop_flags;
 
 /** The opcodes of the libFirm predefined operations. */
 typedef enum {
   iro_Block,
-  iro_Start, iro_End, iro_Jmp, 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,
@@ -70,7 +75,8 @@ typedef enum {
   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_NoMem, iro_Mux, iro_CopyB,
+  iro_InstOf, iro_Raise, iro_Bound,
   iro_MaxOpcode
 } opcode;
 
@@ -81,11 +87,10 @@ 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_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);
@@ -136,6 +141,11 @@ 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_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);
 
 /** Returns the ident for the opcode name */
 ident *get_op_ident(const ir_op *op);
@@ -168,6 +178,150 @@ 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.
+ */
+typedef void (*op_func)(void);
+
+/** The NULL-function. */
+#define NULL_FUNC       ((generic_func)(NULL))
+
+/**
+ * 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.
+ */
+void set_generic_function_ptr(ir_op *op, op_func func);
+
+/**
+ * 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);
+
+/**
+ * The equivalent node operation.
+ * This operation returns an equivalent node for the input node.
+ * It does not create new nodes.  It is therefore safe to free self
+ * if the node returned is not self.
+ * If a node returns a Tuple we can not just skip it.  If the size of the
+ * in array fits, we transform n into a tuple (e.g., possible for Div).
+ */
+typedef ir_node *(*equivalent_node_func)(ir_node *self);
+
+/**
+ * The transform node operation.
+ * This operation tries several [inplace] [optimizing] transformations
+ * and returns an equivalent node.
+ * The difference to equivalent_node() is that these
+ * transformations _do_ generate new nodes, and thus the old node must
+ * not be freed even if the equivalent node isn't the old one.
+ */
+typedef ir_node *(*transform_node_func)(ir_node *self);
+
+/**
+ * The node attribute compare operation.
+ * 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);
+
+/**
+ * The reassociation operation.
+ * Called from a walker.  Returns non-zero if
+ * a reassociation rule was applied.
+ * The pointer n is set to the newly created node, if some reassociation
+ * was applied.
+ */
+typedef int (*reassociate_func)(ir_node **n);
+
+/**
+ * The copy attribute operation.
+ * Copy the node attributes from a '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);
+
+/**
+ * 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.
+ * Return 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);
+
+/**
+ * The verify_node operation for Proj(X).
+ * Return 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);
+
+/**
+ * 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_reason_t;
+
+/**
+ * The dump_node operation.
+ * Writes several informations requested by reason to
+ * an output file
+ */
+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 */
+} ir_op_ops;
+
 /**
  * Creates a new ir operation.
  *
@@ -178,11 +332,19 @@ unsigned get_next_ir_opcode(void);
  * @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.
+ *
+ * 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(opcode code, const char *name, op_pin_state p,
-                  unsigned flags, op_arity opar, int op_index, size_t attr_size);
+                  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);
 
-# endif /* _IROP_H_ */
+#endif /* _IROP_H_ */