cleaned up doxygen comments
[libfirm] / ir / ir / irop_t.h
index 214d4ba..cca5987 100644 (file)
 /*
- * Project:     libFIRM
- * File name:   ir/ir/irop_t.h
- * Purpose:     Representation of opcode of intermediate operation -- private header.
- * Author:      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.
- */
-
-
-# ifndef _IROP_T_H_
-# define _IROP_T_H_
-
-# include "irop.h"
-# include "tv.h"
-
-/** The allowed parities */
-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
-                 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 */
-} op_arity;
-
-
-/** The irop flags */
-typedef enum {
-  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_flags;
-
-
-/**
- * The compute value operation.
- * This operation evaluates an IR node into a tarval if possible,
- * returning tarval_bad otherwise.
+ * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
+ *
+ * This file is part of libFirm.
+ *
+ * This file may be distributed and/or modified under the terms of the
+ * GNU General Public License version 2 as published by the Free Software
+ * Foundation and appearing in the file LICENSE.GPL included in the
+ * packaging of this file.
+ *
+ * Licensees holding valid libFirm Professional Edition licenses may use
+ * this file in accordance with the libFirm Commercial License.
+ * Agreement provided with the Software.
+ *
+ * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
+ * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE.
  */
-typedef tarval *(*computed_value_func)(ir_node *n);
 
 /**
- * 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 n
- * if the node returned is not n.
- * 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).
+ * @file
+ * @brief    Representation of opcode of intermediate operation -- private header.
+ * @author   Christian Schaefer, Goetz Lindenmaier
+ * @version  $Id$
  */
-typedef ir_node *(*equivalent_node_func)(ir_node *n);
+#ifndef FIRM_IR_IROP_T_H
+#define FIRM_IR_IROP_T_H
 
-/**
- * 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 *n);
+#include "firm_config.h"
+#include "irop.h"
+#include "tv.h"
+#include "irnode.h"
 
-/**
- * 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 type of an ir_op. */
 struct ir_op {
-  opcode code;            /**< the unique opcode of the op */
-  ident *name;            /**< the name of the op */
-  size_t attr_size;       /**< Space needed in memory for private attributes */
-  op_pinned pinned;       /**< How to deal with the node in cse, pre. */
-  op_arity opar;          /**< arity of operator. */
-  int op_index;           /**< the index of the first data operand, 0 for most cases, 1 for Div etc. */
-  unsigned flags;         /**< flags describing the behavior of the ir_op, a bitmaks of irop_flags */
-
-  /* CallBacks */
-  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. */
+  ir_opcode code;         /**< The unique opcode of the op. */
+  ident *name;            /**< The name of the op. */
+  size_t attr_size;       /**< Space needed in memory for private attributes. */
+  op_pin_state op_pin_state_pinned; /**< How to deal with the node in CSE, PRE. */
+  op_arity opar;          /**< The arity of operator. */
+  int op_index;           /**< The index of the first data operand, 0 for most cases, 1 for Div etc. */
+  unsigned flags;         /**< Flags describing the behavior of the ir_op, a bitmasks of irop_flags. */
+  void *tag;              /**< Some custom pointer the op's creator can attach stuff to. */
+
+  ir_op_ops ops;          /**< The operations of the this op. */
 };
 
-/**
- * Creates a new ir operation.
- *
- * @param code      the opcode, one of type \c opcode
- * @param name      the printable name of this opcode
- * @param p         wheater operations of this opcode are 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 op_index  if the parity is oparity_unary, oparity_binary or oparity_trinary the index
- *                  of the left operand
- * @param attr_size attribute size for this ir operation
- *
- * @return The genenerated ir operation.
- */
-ir_op * new_ir_op(opcode code, const char *name, op_pinned p,
-           unsigned flags, op_arity opar, int op_index, size_t attr_size);
-
 /**
  * Frees a newly created ir operation.
  */
@@ -123,64 +57,131 @@ void init_op(void);
 /** Free memory used by irop module. */
 void finish_op(void);
 
-# ifndef INLINE
-# ifdef USE_GCC_INLINE
-# define INLINE __extension__ ((__inline__))
-# else /* defined USE_GCC_INLINE */
-# define INLINE
-# endif /* define USE_GCC_INLINE */
-# endif /* defined INLINE */
-
-/** Returns the attribute size of nodes of this opcode.
-   @note Use not encouraged, internal feature. */
-INLINE int get_op_attr_size (const ir_op *op)
-# ifdef USE_GCC_INLINE
-{
+/**
+ * Copies simply all attributes stored in the old node to the new node.
+ * Assumes both have the same opcode and sufficient size.
+ *
+ * @param old_node  the old node from which the attributes are read
+ * @param new_node  the new node to which the attributes are written
+ */
+void default_copy_attr(const ir_node *old_node, ir_node *new_node);
+
+/**
+ * Returns the attribute size of nodes of this opcode.
+ * @note Use not encouraged, internal feature.
+ */
+static INLINE size_t get_op_attr_size (const ir_op *op) {
   return op->attr_size;
 }
-# else /* defined USE_GCC_INLINE */
-;
-# endif /* not defined USE_GCC_INLINE */
 
-/** Returns non-zero if op is one of Start, End, Jmp, Cond, Return, Raise or Bad. */
-INLINE int is_cfopcode(const ir_op *op)
-# ifdef USE_GCC_INLINE
-{
+/**
+ * Returns non-zero if op is a control flow opcode,
+ * like Start, End, Jmp, Cond, Return, Raise or Bad.
+ */
+static INLINE int is_cfopcode(const ir_op *op) {
   return op->flags & irop_flag_cfopcode;
 }
-# else /* defined USE_GCC_INLINE */
-;
-# endif /* not defined USE_GCC_INLINE */
 
-/** Returns true if the operation manipulates interprocedural control flow:
-   CallBegin, EndReg, EndExcept */
-INLINE int is_ip_cfopcode(const ir_op *op)
-# ifdef USE_GCC_INLINE
-{
+/**
+ * Returns non-zero if the operation manipulates interprocedural control flow:
+ * CallBegin, EndReg, EndExcept
+ */
+static INLINE int is_ip_cfopcode(const ir_op *op) {
   return op->flags & irop_flag_ip_cfopcode;
 }
-# else /* defined USE_GCC_INLINE */
-;
-# endif /* not defined USE_GCC_INLINE */
 
-/* Returns non-zero if operation is commutative */
-INLINE int is_op_commutative(const ir_op *op)
-# ifdef USE_GCC_INLINE
-{
+/** Returns non-zero if operation is commutative */
+static INLINE int is_op_commutative(const ir_op *op) {
   return op->flags & irop_flag_commutative;
 }
-# else /* defined USE_GCC_INLINE */
-;
-# endif /* not defined USE_GCC_INLINE */
 
-/* Returns non-zero if operation is fragile */
-INLINE int is_op_fragile(const ir_op *op)
-# ifdef USE_GCC_INLINE
-{
+/** Returns non-zero if operation is fragile */
+static INLINE int is_op_fragile(const ir_op *op) {
   return op->flags & irop_flag_fragile;
 }
-# else /* defined USE_GCC_INLINE */
-;
-# endif /* not defined USE_GCC_INLINE */
 
-#endif /* _IROP_T_H_ */
+/** Returns non-zero if operation is forking control flow */
+static INLINE int is_op_forking(const ir_op *op) {
+  return op->flags & irop_flag_forking;
+}
+
+/** Returns non-zero if operation is a high-level op */
+static INLINE int is_op_highlevel(const ir_op *op) {
+  return op->flags & irop_flag_highlevel;
+}
+
+/** Returns non-zero if operation is a const-like op */
+static INLINE int is_op_constlike(const ir_op *op) {
+  return op->flags & irop_flag_constlike;
+}
+
+/** Returns non-zero if operation must always be optimized */
+static INLINE int is_op_always_opt(const ir_op *op) {
+  return op->flags & irop_flag_always_opt;
+}
+
+/** Returns non-zero if operation is a keep-like op */
+static INLINE int is_op_keep(const ir_op *op) {
+  return op->flags & irop_flag_keep;
+}
+
+/** Returns non-zero if operation must always be placed in the start block. */
+static INLINE int is_op_start_block_placed(const ir_op *op) {
+  return op->flags & irop_flag_start_block;
+}
+
+/** Returns non-zero if operation is a machine operation */
+static INLINE int is_op_machine(const ir_op *op) {
+  return op->flags & irop_flag_machine;
+}
+
+/** Returns non-zero if operation is a machine operand */
+static INLINE int is_op_machine_operand(const ir_op *op) {
+  return op->flags & irop_flag_machine_op;
+}
+
+/** Returns non-zero if operation is a machine user op number n */
+static INLINE int is_op_machine_user(const ir_op *op, unsigned n) {
+  return op->flags & (irop_flag_user << n);
+}
+
+static INLINE ir_opcode _get_op_code(const ir_op *op) {
+  return op->code;
+}
+
+static INLINE ident *_get_op_ident(const ir_op *op){
+  return op->name;
+}
+
+static INLINE op_pin_state _get_op_pinned(const ir_op *op) {
+  return op->op_pin_state_pinned;
+}
+
+static INLINE void _set_generic_function_ptr(ir_op *op, op_func func) {
+  op->ops.generic = func;
+}
+
+static INLINE op_func _get_generic_function_ptr(const ir_op *op) {
+  return op->ops.generic;
+}
+
+static INLINE const ir_op_ops *_get_op_ops(const ir_op *op) {
+  return &op->ops;
+}
+
+static INLINE void _set_op_tag(ir_op *op, void *tag) {
+       op->tag = tag;
+}
+
+static INLINE void *_get_op_tag(ir_op *op) {
+       return op->tag;
+}
+
+#define get_op_code(op)         _get_op_code(op)
+#define get_op_ident(op)        _get_op_ident(op)
+#define get_op_pinned(op)       _get_op_pinned(op)
+#define get_op_ops(op)          _get_op_ops(op)
+#define set_op_tag(op, tag)     _set_op_tag((op), (tag))
+#define get_op_tag(op)          _get_op_tag(op)
+
+#endif