added and fixed comments
[libfirm] / ir / ir / irnode_t.h
index 7552ed1..084c963 100644 (file)
@@ -10,7 +10,6 @@
  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
  */
 
-
 /**
  * @file irnode_t.h
  *
  * @author Martin Trapp, Christian Schaefer
  */
 
-
 # ifndef _IRNODE_T_H_
 # define _IRNODE_T_H_
 
-#ifdef HAVE_CONFIG_H
-#include "config.h"
-#endif
-
-# include "irnode.h"
-# include "irop_t.h"
-# include "irgraph_t.h"
-# include "irflag_t.h"
-# include "firm_common_t.h"
-# include "irdom_t.h" /* For size of struct dom_info. */
-# include "dbginfo.h"
-# include "irloop.h"
-# include "array.h"
+#include "firm_config.h"
+#include "irnode.h"
+#include "irop_t.h"
+#include "irgraph_t.h"
+#include "irflag_t.h"
+#include "firm_common_t.h"
+#include "irdom_t.h" /* For size of struct dom_info. */
+#include "dbginfo.h"
+#include "irloop.h"
+#include "array.h"
 
 #include "set.h"
 #include "entity_t.h"
 #include "type_t.h"
 
+
 /** ir node attributes **/
 
 /** Block attributes */
@@ -49,7 +45,8 @@ typedef struct {
   ir_graph *irg;
   unsigned long block_visited;  /**< for the walker that walks over all blocks. */
   /* Attributes private to construction: */
-  bool matured;               /**< if set, all in-nodes of the block are fixed */
+  int matured:1;                /**< if set, all in-nodes of the block are fixed */
+  int dead:1;                   /**< if set, the block is dead (and could be replace by a Bad */
   struct ir_node **graph_arr; /**< array to store all parameters */
   /* Attributes holding analyses information */
   struct dom_info dom;        /**< Datastructure that holds information about dominators.
@@ -139,16 +136,10 @@ typedef struct {
 /** EndReg/EndExcept attributes */
 typedef struct {
   char dummy;
-  /*   ir_graph * irg; */           /**< ir_graph this node belongs to (for */
-  /*                               * navigating in interprocedural graphs)  */
-  /*                       @@@ now in block */
 } end_attr;
 
 /** CallBegin attributes */
 typedef struct {
-  /*   ir_graph * irg; */           /**< ir_graph this node belongs to (for */
-  /*                   * navigating in interprocedural graphs) */
-  /*                            @@@ now in block */
   ir_node * call;            /**< associated Call-operation */
 } callbegin_attr;
 
@@ -196,8 +187,8 @@ typedef union {
                    node takes the role of the obsolete Phi0 node,
                    therefore the name. */
   int *phi_backedge;    /**< For Phi after construction.
-               Field n set to true if pred n is backedge.
-               @todo Ev. replace by bitfield! */
+                          Field n set to true if pred n is backedge.
+                          @todo Ev. replace by bitfield! */
   long           proj;  /**< For Proj: contains the result position to project */
   confirm_attr   confirm_cmp;   /**< For Confirm: compare operation */
   filter_attr    filter;    /**< For Filter */
@@ -240,33 +231,32 @@ struct ir_node {
 };
 
 
-/** Copies all attributes stored in the old node  to the new node.
-    Assumes both have the same opcode and sufficient size. */
-void
-copy_attrs(const ir_node *old_node, ir_node *new_node);
-
-
 /** Returns the array with the ins.  The content of the array may not be
    changed.  */
 ir_node     **get_irn_in            (const ir_node *node);
 
 /** @{ */
 /** access attributes directly */
-INLINE const_attr    get_irn_const_attr    (ir_node *node);
-INLINE long          get_irn_proj_attr     (ir_node *node);
-INLINE alloc_attr    get_irn_alloc_attr    (ir_node *node);
-INLINE type         *get_irn_free_attr     (ir_node *node);
-INLINE symconst_attr get_irn_symconst_attr (ir_node *node);
-type                *get_irn_call_attr     (ir_node *node);
-type                *get_irn_funccall_attr (ir_node *node);
-sel_attr             get_irn_sel_attr      (ir_node *node);
-int                  get_irn_phi_attr      (ir_node *node);
-block_attr           get_irn_block_attr    (ir_node *node);
-load_attr            get_irn_load_attr     (ir_node *node);
-store_attr           get_irn_store_attr    (ir_node *node);
-except_attr          get_irn_except_attr   (ir_node *node);
+const_attr    get_irn_const_attr    (ir_node *node);
+long          get_irn_proj_attr     (ir_node *node);
+alloc_attr    get_irn_alloc_attr    (ir_node *node);
+type         *get_irn_free_attr     (ir_node *node);
+symconst_attr get_irn_symconst_attr (ir_node *node);
+type         *get_irn_call_attr     (ir_node *node);
+type         *get_irn_funccall_attr (ir_node *node);
+sel_attr      get_irn_sel_attr      (ir_node *node);
+int           get_irn_phi_attr      (ir_node *node);
+block_attr    get_irn_block_attr    (ir_node *node);
+load_attr     get_irn_load_attr     (ir_node *node);
+store_attr    get_irn_store_attr    (ir_node *node);
+except_attr   get_irn_except_attr   (ir_node *node);
 /** @} */
 
+/*
+ * The amount of additional space for custom data to be allocated upon creating a new node.
+ */
+extern unsigned firm_add_node_size;
+
 /*-------------------------------------------------------------------*/
 /*  These function are most used in libfirm.  Give them as static    */
 /*  functions so they can be inlined.                                */
@@ -286,19 +276,27 @@ __is_ir_node (const void *thing) {
  * Intern version for libFirm.
  */
 static INLINE ir_op *
-__get_irn_op (const ir_node *node)
-{
+__get_irn_op (const ir_node *node) {
   assert (node);
   return node->op;
 }
 
+/** Copies all attributes stored in the old node  to the new node.
+    Assumes both have the same opcode and sufficient size. */
+static INLINE void
+copy_node_attr(const ir_node *old_node, ir_node *new_node) {
+  ir_op *op = __get_irn_op(old_node);
+
+  /* must always exist */
+  op->copy_attr(old_node, new_node);
+}
+
 /**
  * Gets the opcode of a node.
  * Intern version for libFirm.
  */
 static INLINE opcode
-__get_irn_opcode (const ir_node *node)
-{
+__get_irn_opcode (const ir_node *node) {
   assert (k_ir_node == get_kind(node));
   assert (node -> op);
   return node->op->code;
@@ -340,8 +338,8 @@ extern int (*__get_irn_arity)(const ir_node *node);
  * Intern version for libFirm.
  */
 static INLINE ir_node *
-__get_irn_intra_n (ir_node *node, int n) {
-  assert(node); assert(-1 <= n && n < __get_irn_arity(node));
+__get_irn_intra_n (const ir_node *node, int n) {
+  assert(node); assert(-1 <= n && n < __get_irn_intra_arity(node));
 
   return (node->in[n + 1] = skip_Id(node->in[n + 1]));
 }
@@ -350,8 +348,8 @@ __get_irn_intra_n (ir_node *node, int n) {
  * Intern version for libFirm.
  */
 static INLINE ir_node*
-__get_irn_inter_n (ir_node *node, int n) {
-  assert(node); assert(-1 <= n && n < __get_irn_arity(node));
+__get_irn_inter_n (const ir_node *node, int n) {
+  assert(node); assert(-1 <= n && n < __get_irn_inter_arity(node));
 
   /* handle Filter and Block specially */
   if (__get_irn_opcode(node) == iro_Filter) {
@@ -372,7 +370,7 @@ __get_irn_inter_n (ir_node *node, int n) {
  * If it is a block, the entry -1 is NULL.
  * Intern version for libFirm.
  */
-extern ir_node *(*__get_irn_n)(ir_node *node, int n);
+extern ir_node *(*__get_irn_n)(const ir_node *node, int n);
 
 /**
  * Gets the mode of a node.
@@ -468,7 +466,7 @@ __set_irn_link(ir_node *node, void *link) {
  */
 static INLINE void *
 __get_irn_link(const ir_node *node) {
-  assert (node);
+  assert (node && is_ir_node(node));
   return node->link;
 }
 
@@ -478,12 +476,62 @@ __get_irn_link(const ir_node *node) {
  */
 static INLINE op_pin_state
 __get_irn_pinned(const ir_node *node) {
+  assert(node && is_ir_node(node));
   op_pin_state state = __get_op_pinned(__get_irn_op(node));
-  if (state == op_pin_state_exc_pinned)
+  if (state >= op_pin_state_exc_pinned)
     return get_opt_fragile_ops() ? node->attr.except.pin_state : op_pin_state_pinned;
   return state;
 }
 
+static INLINE int
+__is_unop(const ir_node *node) {
+  assert(node && is_ir_node(node));
+  return (node->op->opar == oparity_unary);
+}
+
+static INLINE int
+__is_binop(const ir_node *node) {
+  assert(node && is_ir_node(node));
+  return (node->op->opar == oparity_binary);
+}
+
+static INLINE int
+__is_Bad(const ir_node *node) {
+  assert(node);
+  return (node && __get_irn_op(node) == op_Bad);
+}
+
+static INLINE int
+__is_no_Block(const ir_node *node) {
+  assert(node && is_ir_node(node));
+  return (__get_irn_op(node) != op_Block);
+}
+
+static INLINE int
+__is_Block(const ir_node *node) {
+  assert(node && is_ir_node(node));
+  return (__get_irn_op(node) == op_Block);
+}
+
+static INLINE ir_node *
+__set_Block_dead(ir_node *block) {
+  assert(__get_irn_op(block) == op_Block);
+  block->attr.block.dead = 1;
+  return block;
+}
+
+static INLINE int
+__is_Block_dead(const ir_node *block) {
+  ir_op * op = __get_irn_op(block);
+
+  if (op == op_Bad)
+    return 1;
+  else {
+    assert(op == op_Block);
+    return block->attr.block.dead;
+  }
+}
+
 /* this section MUST contain all inline functions */
 #define is_ir_node(thing)          __is_ir_node(thing)
 #define get_irn_intra_arity(node)  __get_irn_intra_arity(node)
@@ -503,5 +551,12 @@ __get_irn_pinned(const ir_node *node) {
 #define irn_not_visited(node)      __irn_not_visited(node)
 #define set_irn_link(node, link)   __set_irn_link(node, link)
 #define get_irn_link(node)         __get_irn_link(node)
+#define is_unop(node)              __is_unop(node)
+#define is_binop(node)             __is_binop(node)
+#define is_Bad(node)               __is_Bad(node)
+#define is_no_Block(node)          __is_no_Block(node)
+#define is_Block(node)             __is_Block(node)
+#define set_Block_dead(block)      __set_Block_dead(block)
+#define is_Block_dead(block)       __is_Block_dead(block)
 
 # endif /* _IRNODE_T_H_ */