Dump calling conventions for entities
[libfirm] / ir / ir / irop.h
index 90434cd..5e7b4a8 100644 (file)
@@ -1,31 +1,68 @@
 /*
-*  Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
-*  All rights reserved.
-*/
+ * Project:     libFIRM
+ * File name:   ir/ir/irop.h
+ * Purpose:     Representation of opcode of intermediate operation.
+ * 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.
+ */
 
 /**
-* @file irop.h
-*
-* Operators of firm nodes.
-*
-* @author Christian Schaefer
-*
-*  This module specifies the opcodes possible for ir nodes.  Their
-*  definition is close to the operations specified in UKA Tech-Report
-*  1999-14
-*/
-
-/* $Id$ */
+ * @file irop.h
+ *
+ * Operators of firm nodes.
+ *
+ * @author Christian Schaefer
+ *
+ *  This module specifies the opcodes possible for ir nodes.  Their
+ *  definition is close to the operations specified in UKA Tech-Report
+ *  1999-14
+ */
 
 # ifndef _IROP_H_
 # define _IROP_H_
 
 # include "ident.h"
 
-/** the opcodes */
+/** 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_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_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_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_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_Raise,
   iro_Const, iro_SymConst,
   iro_Sel,  iro_InstOf,
   iro_Call, iro_Add, iro_Sub, iro_Minus, iro_Mul, iro_Quot, iro_DivMod,
@@ -33,8 +70,10 @@ typedef enum {
   iro_Cmp,  iro_Shl, iro_Shr, iro_Shrs, iro_Rot, iro_Conv, iro_Cast,
   iro_Phi,
   iro_Load, iro_Store, iro_Alloc, iro_Free, iro_Sync,
-  iro_Proj, iro_Tuple, iro_Id, iro_Bad,
-  iro_Unknown, iro_Filter, iro_Break, iro_CallBegin, iro_EndReg, iro_EndExcept
+  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_MaxOpcode
 } opcode;
 
 typedef struct ir_op ir_op;
@@ -44,6 +83,7 @@ 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);
@@ -88,6 +128,7 @@ extern ir_op *op_Tuple;           ir_op *get_op_Tuple     (void);
 extern ir_op *op_Proj;            ir_op *get_op_Proj      (void);
 extern ir_op *op_Id;              ir_op *get_op_Id        (void);
 extern ir_op *op_Bad;             ir_op *get_op_Bad       (void);
+extern ir_op *op_Confirm;         ir_op *get_op_Confirm   (void);
 
 extern ir_op *op_Unknown;         ir_op *get_op_Unknown   (void);
 extern ir_op *op_Filter;          ir_op *get_op_Filter    (void);
@@ -96,37 +137,74 @@ extern ir_op *op_CallBegin;       ir_op *get_op_CallBegin (void);
 extern ir_op *op_EndReg;          ir_op *get_op_EndReg    (void);
 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);
 
 /** Returns the ident for the opcode name */
-ident *get_op_ident     (ir_op *op);
+ident *get_op_ident(const ir_op *op);
+
 /** Returns the string for the opcode. */
-const char *get_op_name (ir_op *op);
+const char *get_op_name(const ir_op *op);
 
 /** Returns the enum for the opcode */
-opcode get_op_code      (ir_op *op);
+opcode get_op_code(const ir_op *op);
 
-/** pinned states */
+/** op_pin_state_pinned states */
 typedef enum {
-  floats = 0,    /**< Nodes of this opcode can be placed in any basic block. */
-  pinned           /**< Nodes must remain in this basic block. */
-} op_pinned;
+  op_pin_state_floats = 0,    /**< Nodes of this opcode can be placed in any basic block. */
+  op_pin_state_pinned,        /**< Nodes must remain in this basic block. */
+  op_pin_state_exc_pinned,    /**< Node must be remain in this basic block if it can throw an
+                                   exception, else can float. Used internally. */
+  op_pin_state_mem_pinned     /**< Node must be remain in this basic block if it can throw an
+                                   exception or uses memory, else can float. Used internally. */
+} op_pin_state;
 
-/** gets pinned state of an opcoe */
-op_pinned get_op_pinned (ir_op *op);
+const char *get_op_pin_state_name(op_pin_state s);
+
+/** gets pinned state of an opcode */
+op_pin_state get_op_pinned(const ir_op *op);
 
 /** Sets pinned in the opcode.  Setting it to floating has no effect
    for Block, Phi and control flow nodes. */
-void      set_op_pinned(ir_op *op, op_pinned pinned);
+void set_op_pinned(ir_op *op, op_pin_state pinned);
 
-/** Returns true if op is one of Start, End, Jmp, Cond, Return, Raise or Bad. */
-int is_cfopcode(ir_op *op);
+/** Returns the next free IR opcode number, allows to register user ops */
+unsigned get_next_ir_opcode(void);
 
-/** Returns true if the operation manipulates interprocedural control flow:
-   CallBegin, EndReg, EndExcept */
-int is_ip_cfopcode(ir_op *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         whether operations of this opcode are op_pin_state_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 generated ir operation.
+ */
+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);
 
-/** Returns the attribute size of nodes of this opcode.
-   @note Use not encouraged, internal feature. */
-int    get_op_attr_size (ir_op *op);
+/**
+ * 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);
 
 # endif /* _IROP_H_ */