irnode_t.h

/*
 * Project:     libFIRM
 * File name:   ir/ir/irnode_t.h
 * Purpose:     Representation of an intermediate operation -- private header.
 * Author:      Martin Trapp, Christian Schaefer
 * Modified by: Goetz Lindenmaier
 * Created:
 * CVS-ID:      $Id$
 * Copyright:   (c) 1998-2003 Universität Karlsruhe
 * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
 */

/**
 * @file irnode_t.h
 *
 * Declarations of an ir node.
 *
 * @author Martin Trapp, Christian Schaefer
 */

# ifndef _IRNODE_T_H_
# define _IRNODE_T_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 "list.h"
#include "entity_t.h"
#include "type_t.h"
#include "tv_t.h"
#include "irextbb_t.h"


/** ir node attributes **/

/** Block attributes */
typedef struct {
  /* General attributes */
  ir_graph *irg;
  unsigned long block_visited;  /**< for the walker that walks over all blocks. */
  /* Attributes private to construction: */
  unsigned matured:1;         /**< if set, all in-nodes of the block are fixed */
  unsigned 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.
                 @@@ @todo
                 Eventually overlay with graph_arr as only valid
                 in different phases.  Eventually inline the whole
                 datastructure. */
  /*   exc_t exc;  */            /**< role of this block for exception handling */
  /*   ir_node *handler_entry; */    /**< handler entry block iff this block is part of a region */
  ir_node ** in_cg;           /**< array with predecessors in
                   * interprocedural_view, if they differ
                   * from intraprocedural predecessors */
  int *backedge;              /**< Field n set to true if pred n is backedge.
                     @@@ @todo Ev. replace by bitfield! */
  int *cg_backedge;           /**< Field n set to true if pred n is interprocedural backedge.
                     @@@ @todo Ev. replace by bitfield! */
  ir_extblk *extblk;          /**< the extended basic block this block belongs to */

  struct list_head succ_head; /**< A list head for all successor edges of a block. */

} block_attr;

/** Start attributes */
typedef struct {
  char dummy;
  /*   ir_graph *irg;   @@@ now in block */
} start_attr;

/** Cond attributes */
typedef struct {
  cond_kind kind;           /**< flavor of Cond */
  long default_proj;        /**< only for non-binary Conds: biggest Proj number, i.e. the one used for default. */
  cond_jmp_predicate pred;  /**< only for binary Conds: The jump predication. */
} cond_attr;

/** Const attributes */
typedef struct {
  tarval *tv;        /**< the target value */
  type   *tp;        /**< the source type, for analyses. default: type_unknown. */
} const_attr;

typedef struct {
  symconst_symbol sym;  // old tori
  symconst_kind num;
  type *tp;          /**< the source type, for analyses. default: type_unknown. */
} symconst_attr;

/** Sel attributes */
typedef struct {
  entity *ent;          /**< entity to select */
} sel_attr;

/** Exception attributes */
typedef struct {
  op_pin_state   pin_state;     /**< the pin state for operations that might generate a exception:
                                     If it's know that no exception will be generated, could be set to
                                     op_pin_state_floats. */
#if PRECISE_EXC_CONTEXT
  struct ir_node **frag_arr;    /**< For Phi node construction in case of exception */
#endif
} except_attr;

typedef struct {
  except_attr    exc;           /**< the exception attribute. MUST be the first one. */
  type *cld_tp;                 /**< type of called procedure */
  entity ** callee_arr;         /**< result of callee analysis */
} call_attr;

/** Alloc attributes */
typedef struct {
  except_attr    exc;           /**< the exception attribute. MUST be the first one. */
  type *type;                   /**< Type of the allocated object.  */
  where_alloc where;            /**< stack, heap or other managed part of memory */
} alloc_attr;

/** Free attributes */
typedef struct {
  type *type;                   /**< Type of the allocated object.  */
  where_alloc where;            /**< stack, heap or other managed part of memory */
} free_attr;

/** InstOf attributes */
typedef struct
{
  type *ent;
  int dfn;
} io_attr;

/** Filter attributes */
typedef struct {
  long proj;                 /**< contains the result position to project (Proj) */
  ir_node ** in_cg;          /**< array with interprocedural predecessors (Phi) */
  int *backedge;              /**< Field n set to true if pred n is backedge.
                     @todo Ev. replace by bitfield! */
} filter_attr;

/** EndReg/EndExcept attributes */
typedef struct {
  char dummy;
} end_attr;

/** CallBegin attributes */
typedef struct {
  ir_node * call;               /**< associated Call-operation */
} callbegin_attr;

/** Cast attributes */
typedef struct {
  type *totype;                 /**< type of the casted node */
} cast_attr;

/** Load attributes */
typedef struct {
  except_attr    exc;           /**< the exception attribute. MUST be the first one. */
  ir_mode        *load_mode;    /**< the mode of this Load operation */
  ent_volatility volatility;	  /**< the volatility of a Load/Store operation */
} load_attr;

/** Store attributes */
typedef struct {
  except_attr    exc;           /**< the exception attribute. MUST be the first one. */
  ent_volatility volatility;	  /**< the volatility of a Store operation */
} store_attr;

typedef pn_Cmp confirm_attr;    /**< Attribute to hold compare operation */

typedef struct {
  except_attr    exc;           /**< the exception attribute. MUST be the first one. */
  type           *data_type;    /**< type of the copied entity */
} copyb_attr;

/**
 * Edge info to put into an irn.
 */
typedef struct _irn_edge_info_t {
  struct list_head outs_head;  /**< The list of all outs */
  int out_count;               /**< number of outs in the list */
} irn_edge_info_t;


/** Some IR-nodes just have one attribute, these are stored here,
   some have more. Their name is 'irnodename_attr' */
typedef union {
  start_attr     start; /**< For Start */
  block_attr     block; /**< For Block: Fields needed to construct it */
  cond_attr      c;     /**< For Cond. */
  const_attr     con;   /**< For Const: contains the value of the constant and a type */
  symconst_attr  i;     /**< For SymConst. */
  sel_attr       s;     /**< For Sel. */
  call_attr      call;  /**< For Call: pointer to the type of the method to call */
  callbegin_attr callbegin; /**< For CallBegin */
  alloc_attr     a;    /**< For Alloc. */
  free_attr      f;    /**< For Free. */
  io_attr        io;    /**< For InstOf */
  cast_attr      cast;  /**< For Cast. */
  load_attr      load;  /**< For Load. */
  store_attr     store;  /**< For Store. */
  int            phi0_pos;  /**< For Phi. Used to remember the value defined by
                   this Phi node.  Needed when the Phi is completed
                   to call get_r_internal_value to find the
                   predecessors. If this attribute is set, the Phi
                   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! */
  long           proj;          /**< For Proj: contains the result position to project */
  confirm_attr   confirm_cmp;   /**< For Confirm: compare operation */
  filter_attr    filter;        /**< For Filter */
  end_attr       end;           /**< For EndReg, EndExcept */
  except_attr    except;        /**< For Phi node construction in case of exceptions */
  copyb_attr     copyb;         /**< For CopyB operation */
} attr;


/** common structure of an irnode
    if the node has some attributes, they are stored in attr */
struct ir_node {
  /* ------- Basics of the representation  ------- */
  firm_kind kind;          /**< distinguishes this node from others */
  ir_op *op;               /**< Opcode of this node. */
  ir_mode *mode;           /**< Mode of this node. */
  unsigned long visited;   /**< visited counter for walks of the graph */
  struct ir_node **in;     /**< array with predecessors / operands */
  void *link;              /**< to attach additional information to the node, e.g.
                              used while construction to link Phi0 nodes and
			      during optimization to link to nodes that
			      shall replace a node. */
  /* ------- Fields for optimizations / analysis information ------- */
  struct ir_node **out;    /**< @deprecated array of out edges. */
  struct dbg_info* dbi;    /**< A pointer to information for debug support. */
  /* ------- For debugging ------- */
#ifdef DEBUG_libfirm
	int out_valid;
  int node_nr;             /**< a unique node number for each node to make output
			      readable. */
#endif
  /* ------- For analyses -------- */
  ir_loop *loop;           /**< the loop the node is in. Access routines in irloop.h */
#ifdef  DO_HEAPANALYSIS
  struct abstval *av;
  struct section *sec;
#endif
#if FIRM_EDGES_INPLACE
  irn_edge_info_t edge_info;  /**< everlasting out edges */
#endif
  /* ------- Opcode depending fields -------- */
  attr attr;               /**< attribute of this node. Depends on opcode.
                              Must be last field of struct ir_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 */
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);
free_attr     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;

/** Set the get_type operation of an ir_op. */
ir_op *firm_set_default_get_type(ir_op *op);

/*-------------------------------------------------------------------*/
/*  These function are most used in libfirm.  Give them as static    */
/*  functions so they can be inlined.                                */
/*-------------------------------------------------------------------*/

/**
 * Checks whether a pointer points to a ir node.
 * Intern version for libFirm.
 */
static INLINE int
_is_ir_node (const void *thing) {
  return (get_kind(thing) == k_ir_node);
}

/**
 * Gets the op of a node.
 * Intern version for libFirm.
 */
static INLINE ir_op *
_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) {
  assert (k_ir_node == get_kind(node));
  assert (node->op);
  return node->op->code;
}

/**
 * Returns the number of predecessors without the block predecessor.
 * Intern version for libFirm.
 */
static INLINE int
_get_irn_intra_arity (const ir_node *node) {
  assert(node);
  return ARR_LEN(node->in) - 1;
}

/**
 * Returns the number of predecessors without the block predecessor.
 * Intern version for libFirm.
 */
static INLINE int
_get_irn_inter_arity (const ir_node *node) {
  assert(node);
  if (_get_irn_opcode(node) == iro_Filter) {
    assert(node->attr.filter.in_cg);
    return ARR_LEN(node->attr.filter.in_cg) - 1;
  } else if (_get_irn_opcode(node) == iro_Block && node->attr.block.in_cg) {
    return ARR_LEN(node->attr.block.in_cg) - 1;
  }
  return _get_irn_intra_arity(node);
}

/**
 * Returns the number of predecessors without the block predecessor.
 * Intern version for libFirm.
 */
extern int (*_get_irn_arity)(const ir_node *node);

/**
 * Intern version for libFirm.
 */
static INLINE ir_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]));
}

/**
 * Intern version for libFirm.
 */
static INLINE ir_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_op(node) == op_Filter) {
    assert(node->attr.filter.in_cg);
    return (node->attr.filter.in_cg[n + 1] = skip_Id(node->attr.filter.in_cg[n + 1]));
  } else if (_get_irn_op(node) == op_Block && node->attr.block.in_cg) {
    return (node->attr.block.in_cg[n + 1] = skip_Id(node->attr.block.in_cg[n + 1]));
  }

  return _get_irn_intra_n (node, n);
}

/**
 * Access to the predecessors of a node.
 * To iterate over the operands iterate from 0 to i < get_irn_arity(),
 * to iterate including the Block predecessor iterate from i = -1 to
 * i < get_irn_arity.
 * If it is a block, the entry -1 is NULL.
 * Intern version for libFirm.
 */
extern ir_node *(*_get_irn_n)(const ir_node *node, int n);

/**
 * Gets the mode of a node.
 * Intern version for libFirm.
 */
static INLINE ir_mode *
_get_irn_mode (const ir_node *node)
{
  assert (node);
  return node->mode;
}

/**
 * Sets the mode of a node.
 * Intern version of libFirm.
 */
static INLINE void
_set_irn_mode (ir_node *node, ir_mode *mode)
{
  assert (node);
  node->mode = mode;
}

/**
 * Gets the visited counter of a node.
 * Intern version for libFirm.
 */
static INLINE unsigned long
_get_irn_visited (const ir_node *node)
{
  assert (node);
  return node->visited;
}

/**
 * Sets the visited counter of a node.
 * Intern version for libFirm.
 */
static INLINE void
_set_irn_visited (ir_node *node, unsigned long visited)
{
  assert (node);
  node->visited = visited;
}

/**
 * Mark a node as visited in a graph.
 * Intern version for libFirm.
 */
static INLINE void
_mark_irn_visited (ir_node *node) {
  assert (node);
  node->visited = current_ir_graph->visited;
}

/**
 * Returns non-zero if a node of was visited.
 * Intern version for libFirm.
 */
static INLINE int
_irn_visited(const ir_node *node) {
  assert (node);
  return (node->visited >= current_ir_graph->visited);
}

/**
 * Returns non-zero if a node of was NOT visited.
 * Intern version for libFirm.
 */
static INLINE int
_irn_not_visited(const ir_node *node) {
  assert (node);
  return (node->visited < current_ir_graph->visited);
}

/**
 * Sets the link of a node.
 * Intern version of libFirm.
 */
static INLINE void
_set_irn_link(ir_node *node, void *link) {
  assert (node);
  /* Link field is used for Phi construction and various optimizations
     in iropt. */
  assert(get_irg_phase_state(current_ir_graph) != phase_building);

  node->link = link;
}

/**
 * Returns the link of a node.
 * Intern version of libFirm.
 */
static INLINE void *
_get_irn_link(const ir_node *node) {
  assert (node && _is_ir_node(node));
  return node->link;
}

/**
 * Returns whether the node _always_ must be pinned.
 * I.e., the node is not floating after global cse.
 *
 * Intern version of libFirm.
 */
static INLINE op_pin_state
_get_irn_pinned(const ir_node *node) {
  op_pin_state state;
  assert(node && _is_ir_node(node));
  /* Check opcode */
  state = _get_op_pinned(_get_irn_op(node));

  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 op_pin_state
_is_irn_pinned_in_irg(const ir_node *node) {
  if (get_irg_pinned(get_irn_irg(node)) == op_pin_state_floats)
    return get_irn_pinned(node);
  return op_pin_state_pinned;
}

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_Const(const ir_node *node) {
  assert(node);
  return (node && _get_irn_op(node) == op_Const);
}

static INLINE int
_is_Unknown (const ir_node *node) {
  assert(node);
  return (node && _get_irn_op(node) == op_Unknown);
}

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 int
_get_Block_n_cfgpreds (ir_node *node) {
  assert(_is_Block(node));
  return _get_irn_arity(node);
}

static INLINE ir_node *
_get_Block_cfgpred (ir_node *node, int pos) {
  assert(0 <= pos && pos < get_irn_arity(node));
  assert(_is_Block(node));
  return _get_irn_n(node, pos);
}

/* Get the predecessor block.
 *
 *  Returns the block corresponding to the predecessor pos.
 *
 *  There are several ambiguities we resolve with this function:
 *  - The direct predecessor can be a Proj, which is not pinned.
 *    We walk from the predecessor to the next pinned node
 *    (skip_Proj) and return the block that node is in.
 *  - If we encounter the Bad node, this function does not return
 *    Start, but the Bad node.
 */
static INLINE ir_node  *
_get_Block_cfgpred_block(ir_node *node, int pos) {
  ir_node *res = skip_Proj(get_Block_cfgpred(node, pos));
  if (!is_Bad(res))
    res = get_nodes_block(res);
  return res;
}

static INLINE unsigned long
_get_Block_block_visited (ir_node *node) {
  assert (node->op == op_Block);
  return node->attr.block.block_visited;
}

static INLINE void
_set_Block_block_visited (ir_node *node, unsigned long visit) {
  assert (node->op == op_Block);
  node->attr.block.block_visited = visit;
}

/* For this current_ir_graph must be set. */
static INLINE void
_mark_Block_block_visited (ir_node *node) {
  assert (node->op == op_Block);
  node->attr.block.block_visited = get_irg_block_visited(current_ir_graph);
}

static INLINE int
_Block_not_block_visited(ir_node *node) {
  assert (node->op == op_Block);
  return (node->attr.block.block_visited < get_irg_block_visited(current_ir_graph));
}

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;
  }
}

static INLINE tarval *_get_Const_tarval (ir_node *node) {
  assert (_get_irn_op(node) == op_Const);
  return node->attr.con.tv;
}

static INLINE cnst_classify_t _classify_Const(ir_node *node) {
  ir_op *op;
  assert(_is_ir_node(node));

  op = _get_irn_op(node);

  if(op == op_Const)
    return classify_tarval(_get_Const_tarval(node));
  else if(op == op_SymConst)
    return CNST_SYMCONST;

  return CNST_NO_CONST;
}

static INLINE int _is_irn_forking(const ir_node *node) {
  return is_op_forking(_get_irn_op(node));
}

static INLINE type *_get_irn_type(ir_node *node) {
  return _get_irn_op(node)->get_type(node);
}

static INLINE int _is_irn_constlike(const ir_node *node) {
  return is_op_constlike(_get_irn_op(node));
}

static INLINE cond_jmp_predicate _get_Cond_jmp_pred(ir_node *node) {
  assert (_get_irn_op(node) == op_Cond);
  return node->attr.c.pred;
}

static INLINE void _set_Cond_jmp_pred(ir_node *node, cond_jmp_predicate pred) {
  assert (_get_irn_op(node) == op_Cond);
  node->attr.c.pred = pred;
}

/* 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)
#define get_irn_inter_arity(node)             _get_irn_inter_arity(node)
#define get_irn_arity(node)                   _get_irn_arity(node)
#define get_irn_intra_n(node, n)              _get_irn_intra_n(node, n)
#define get_irn_inter_n(node, n)              _get_irn_inter_n(node, n)
#define get_irn_n(node, n)                    _get_irn_n(node, n)
#define get_irn_mode(node)                    _get_irn_mode(node)
#define set_irn_mode(node, mode)              _set_irn_mode(node, mode)
#define get_irn_op(node)                      _get_irn_op(node)
#define get_irn_opcode(node)                  _get_irn_opcode(node)
#define get_irn_visited(node)                 _get_irn_visited(node)
#define set_irn_visited(node, v)              _set_irn_visited(node, v)
#define mark_irn_visited(node)                _mark_irn_visited(node)
#define irn_visited(node)                     _irn_visited(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 get_irn_pinned(node)                  _get_irn_pinned(node)
#define is_irn_pinned_in_irg(node)            _is_irn_pinned_in_irg(node)
#define is_unop(node)                         _is_unop(node)
#define is_binop(node)                        _is_binop(node)
#define is_Const(node)                        _is_Const(node)
#define is_Unknown(node)                      _is_Unknown(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 get_Block_n_cfgpreds(node)            _get_Block_n_cfgpreds(node)
#define get_Block_cfgpred(node, pos)          _get_Block_cfgpred(node, pos)
#define get_Block_cfgpred_block(node, pos)    _get_Block_cfgpred_block(node, pos)
#define get_Block_block_visited(node)         _get_Block_block_visited(node)
#define set_Block_block_visited(node, visit)  _set_Block_block_visited(node, visit)
#define mark_Block_block_visited(node)        _mark_Block_block_visited(node)
#define Block_not_block_visited(node)         _Block_not_block_visited(node)
#define set_Block_dead(block)                 _set_Block_dead(block)
#define is_Block_dead(block)                  _is_Block_dead(block)
#define get_Const_tarval(node)                _get_Const_tarval(node)
#define classify_Const(node)                  _classify_Const(node)
#define is_irn_forking(node)                  _is_irn_forking(node)
#define get_irn_type(node)                    _get_irn_type(node)
#define is_irn_constlike(node)                _is_irn_constlike(node)
#define get_Cond_jmp_pred(node)               _get_Cond_jmp_pred(node)
#define set_Cond_jmp_pred(node, pred)         _set_Cond_jmp_pred(node, pred)

# endif /* _IRNODE_T_H_ */