-/* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe 3 2002/02/28 13:33:52
- * All rights reserved.
+/*
+ * Project: libFIRM
+ * File name: ir/ir/irnode.h
+ * Purpose: Representation of an intermediate operation.
+ * 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.
*/
-/* $Id$ */
-
# ifndef _IRNODE_H_
# define _IRNODE_H_
/** Projection numbers of compare: use for Proj nodes! */
+/* @@@ there are numbers with normalized names below! */
typedef enum {
False = 0, /**< false */
Eq, /**< equal */
Ne, /**< unordered, less or greater = not equal */
True = 15 /**< true */
/* not_mask = Leg*/ /* bits to flip to negate comparison * @@ hack for jni interface */
-} pnc_number;
+} pnc_number; /* pnc: Projection Number Cmp */
#define not_mask Leg
# include "tv.h"
# include "irmode.h"
# include "type.h"
# include "dbginfo.h"
-# include "exc.h"
+//# include "exc.h"
/**
* @file irnode.h
INLINE ir_node *get_irn_n (ir_node *node, int n);
INLINE void set_irn_n (ir_node *node, int n, ir_node *in);
/** Sets the mode struct of node */
-INLINE void set_irn_mode (ir_node *node, ir_mode *mode);
+INLINE void set_irn_mode (ir_node *node, ir_mode *mode);
/** Gets the mode struct. */
INLINE ir_mode *get_irn_mode (const ir_node *node);
/** Gets the mode-enum modecode. */
/** Outputs a unique number for this node if libfirm is compiled for
debugging, (configure with --enable-debug) else returns 0. */
-INLINE long get_irn_node_nr(const ir_node *node);
+INLINE long get_irn_node_nr(const ir_node *node);
/** Returns the ir_graph this node belongs to. Only valid for
- * CallBegin, EndReg and EndExcept */
-INLINE ir_graph *get_irn_irg(ir_node *node);
+ * CallBegin, EndReg, EndExcept and Start */
+INLINE ir_graph *get_irn_irg(ir_node *node);
/**
* irnode constructor.
*
*/
-/* this works for all except Block */
+/* This works for all except Block. To express the difference to
+ * access routines that work for all nodes we use infix "nodes". */
+#define get_nodes_block get_nodes_Block
INLINE ir_node *get_nodes_Block (ir_node *node);
+#define set_nodes_block set_nodes_Block
INLINE void set_nodes_Block (ir_node *node, ir_node *block);
/** Projection numbers for result of Start node: use for Proj nodes! */
+/* @@@ old name convention! */
typedef enum {
pns_initial_exec, /**< Projection on an executable, the initial control
flow. */
pns_global_store, /**< Projection on the global store */
pns_frame_base, /**< Projection on the frame base */
pns_globals, /**< Projection on the pointer to the data segment
- containing _all_ global entities. */
+ containing _all_ global entities. */
pns_args, /**< Projection on all arguments */
pns_value_arg_base /**< Pointer to region of compound value arguments as defined by
type of this method. */
-} pns_number;
+} pns_number; /* pns: Projection Number Start */
+typedef enum {
+ pn_Start_X_initial_exec, /**< Projection on the initial control flow. */
+ pn_Start_M, /**< Projection on the initial memory. */
+ pn_Start_P_frame_base, /**< Projection on the frame base pointer. */
+ pn_Start_P_globals, /**< Projection on the pointer to the data segment
+ containing _all_ global entities. */
+ pn_Start_T_args, /**< Projection on all arguments. */
+ pn_Start_P_value_arg_base /**< Pointer to region of compound value arguments as defined by
+ type of this method. */
+} pn_Start; /* Projection numbers for Start. */
+
/* @@@ no more supported */
INLINE ir_node **get_Block_cfgpred_arr (ir_node *node);
* predecessors are removed, the node has the same predecessors in
* both views.
* @@@ Maybe better: arity is zero if no cg preds. */
-void set_Block_cg_cfgpred_arr(ir_node * node, int arity, ir_node ** in);
-void set_Block_cg_cfgpred(ir_node * node, int pos, ir_node * pred);
+void set_Block_cg_cfgpred_arr(ir_node * node, int arity, ir_node ** in);
+void set_Block_cg_cfgpred(ir_node * node, int pos, ir_node * pred);
/* @@@ not supported */
-ir_node ** get_Block_cg_cfgpred_arr(ir_node * node);
+ir_node **get_Block_cg_cfgpred_arr(ir_node * node);
/* Returns the number of interproc predecessors. 0 if none. */
-int get_Block_cg_n_cfgpreds(ir_node * node);
-ir_node * get_Block_cg_cfgpred(ir_node * node, int pos);
+int get_Block_cg_n_cfgpreds(ir_node * node);
+ir_node *get_Block_cg_cfgpred(ir_node * node, int pos);
/* frees the memory. */
-void remove_Block_cg_cfgpred_arr(ir_node * node);
+void remove_Block_cg_cfgpred_arr(ir_node * node);
+
+/* Start references the irg it is in. */
+ir_graph *get_Start_irg(ir_node *node);
+void set_Start_irg(ir_node *node, ir_graph *irg);
INLINE int get_End_n_keepalives(ir_node *end);
INLINE ir_node *get_End_keepalive(ir_node *end, int pos);
INLINE cond_kind get_Cond_kind (ir_node *node);
INLINE void set_Cond_kind (ir_node *node, cond_kind kind);
+typedef enum {
+ pn_Cond_false, /**< Control flow if operand is "false". */
+ pn_Cond_true /**< Control flow if operand is "true". */
+} pn_Cond; /* Projection numbers for Cond. */
+
INLINE ir_node *get_Return_mem (ir_node *node);
INLINE void set_Return_mem (ir_node *node, ir_node *mem);
INLINE ir_node **get_Return_res_arr (ir_node *node);
INLINE ir_node *get_Raise_exo_ptr (ir_node *node); /* PoinTeR to EXception Object */
INLINE void set_Raise_exo_ptr (ir_node *node, ir_node *exoptr);
+typedef enum {
+ pn_Raise_X, /**< Execution result. */
+ pn_Raise_M /**< Memory result. */
+} pn_Raise; /* Projection numbers for Raise. */
+
INLINE tarval *get_Const_tarval (ir_node *node);
INLINE void set_Const_tarval (ir_node *node, tarval *con);
+/* The source language type. Must be an atomic type. Mode of type must
+ be mode of node. For tarvals from entities type must be pointer to
+ entity type. */
+INLINE type *get_Const_type (ir_node *node);
+INLINE void set_Const_type (ir_node *node, type *tp);
/** This enum names the three different kinds of symbolic Constants
represented by SymConst. The content of the attribute type_or_id
INLINE entity *get_Sel_entity (ir_node *node); /* entity to select */
INLINE void set_Sel_entity (ir_node *node, entity *ent);
-/* @@@ ajacs specific node -- not supported */
-type *get_InstOf_ent (ir_node *node);
-void set_InstOf_ent (ir_node *node, type *ent);
-ir_node *get_InstOf_obj (ir_node *node);
-void set_InstOf_obj (ir_node *node, ir_node *obj);
-ir_node *get_InstOf_store (ir_node *node);
-void set_InstOf_store (ir_node *node, ir_node *obj);
+/** Projection numbers for result of Call node: use for Proj nodes! */
+/* @@@ old name convention! */
+typedef enum {
+ pncl_memory = 0, /**< The memory result. */
+ pncl_exc_target = 1, /**< The control flow result branching to the exception handler */
+ pncl_result_tuple = 2, /**< The tuple containing all (0, 1, 2, ...) results */
+ pncl_exc_memory = 3, /**< The memory result in case the called method terminated with
+ an exception */
+ pncl_value_res_base = 4 /**< A pointer to the memory region containing copied results
+ passed by value (for compound result types). */
+} pncl_number; /* pncl: Projection Number CaLl */
+
+typedef enum {
+ pn_Call_M_regular = 0, /**< The memory result. */
+ pn_Call_T_result = 2, /**< The tuple containing all (0, 1, 2, ...) results */
+ pn_Call_P_value_res_base = 4,/**< A pointer to the memory region containing copied results
+ passed by value (for compound result types). */
+ pn_Call_X_except = 1, /**< The control flow result branching to the exception handler */
+ pn_Call_M_except = 3 /**< The memory result in case the called method terminated with
+ an exception */
+} pn_Call; /* Projection numbers for Call. */
INLINE ir_node *get_Call_mem (ir_node *node);
INLINE void set_Call_mem (ir_node *node, ir_node *mem);
INLINE int get_Call_arity (ir_node *node);
/* Set, get and remove the callee-analysis. */
-int get_Call_n_callees(ir_node * node);
-entity * get_Call_callee(ir_node * node, int pos);
-void set_Call_callee_arr(ir_node * node, int n, entity ** arr);
-void remove_Call_callee_arr(ir_node * node);
+int get_Call_n_callees (ir_node * node);
+entity *get_Call_callee (ir_node * node, int pos);
+void set_Call_callee_arr (ir_node * node, int n, entity ** arr);
+void remove_Call_callee_arr(ir_node * node);
-ir_node * get_CallBegin_ptr (ir_node *node);
-void set_CallBegin_ptr (ir_node *node, ir_node *ptr);
-ir_graph *get_CallBegin_irg (ir_node *node);
-ir_node *get_CallBegin_call (ir_node *node);
-void set_CallBegin_call (ir_node *node, ir_node *call);
+ir_node *get_CallBegin_ptr (ir_node *node);
+void set_CallBegin_ptr (ir_node *node, ir_node *ptr);
+ir_graph *get_CallBegin_irg (ir_node *node);
+ir_node *get_CallBegin_call (ir_node *node);
+void set_CallBegin_call (ir_node *node, ir_node *call);
/* For unary and binary arithmetic operations the access to the
operands can be factored out. Left is the first, right the
second arithmetic value as listed in tech report 1999-44.
- unops are: Minus, Abs, Not, Conv
+ unops are: Minus, Abs, Not, Conv, Cast
binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
Shr, Shrs, Rot, Cmp */
INLINE int is_unop (ir_node *node);
INLINE ir_node *get_Quot_mem (ir_node *node);
INLINE void set_Quot_mem (ir_node *node, ir_node *mem);
+typedef enum {
+ pn_Quot_X_except, /**< Execution result if exception occured. */
+ pn_Quot_M, /**< Memory result. */
+ pn_Quot_res /**< Result of computation. */
+} pn_Quot; /* Projection numbers for Quot. */
+
INLINE ir_node *get_DivMod_left (ir_node *node);
INLINE void set_DivMod_left (ir_node *node, ir_node *left);
INLINE ir_node *get_DivMod_right (ir_node *node);
INLINE ir_node *get_DivMod_mem (ir_node *node);
INLINE void set_DivMod_mem (ir_node *node, ir_node *mem);
+typedef enum {
+ pn_DivMod_X_except, /**< Execution result if exception occured. */
+ pn_DivMod_M, /**< Memory result. */
+ pn_DivMod_res_div, /**< Result of computation a / b. */
+ pn_DivMod_res_mod /**< Result of computation a % b. */
+} pn_DivMod; /* Projection numbers for DivMod. */
+
INLINE ir_node *get_Div_left (ir_node *node);
INLINE void set_Div_left (ir_node *node, ir_node *left);
INLINE ir_node *get_Div_right (ir_node *node);
INLINE ir_node *get_Div_mem (ir_node *node);
INLINE void set_Div_mem (ir_node *node, ir_node *mem);
+typedef enum {
+ pn_Div_X_except, /**< Execution result if exception occured. */
+ pn_Div_M, /**< Memory result. */
+ pn_Div_res /**< Result of computation. */
+} pn_Div; /* Projection numbers for Div. */
+
INLINE ir_node *get_Mod_left (ir_node *node);
INLINE void set_Mod_left (ir_node *node, ir_node *left);
INLINE ir_node *get_Mod_right (ir_node *node);
INLINE ir_node *get_Mod_mem (ir_node *node);
INLINE void set_Mod_mem (ir_node *node, ir_node *mem);
+typedef enum {
+ pn_Mod_X_except, /**< Execution result if exception occured. */
+ pn_Mod_M, /**< Memory result. */
+ pn_Mod_res /**< Result of computation. */
+} pn_Mod; /* Projection numbers for Mod. */
+
INLINE ir_node *get_Abs_op (ir_node *node);
INLINE void set_Abs_op (ir_node *node, ir_node *op);
INLINE ir_node *get_Not_op (ir_node *node);
INLINE void set_Not_op (ir_node *node, ir_node *op);
-INLINE const char *get_pnc_string(int pnc);
+/* Projection numbers for Cmp are defined several times.
+ The bit patterns are used for variouse tests, so don't change.
+ The "unordered" values are possible results of comparing
+ floating point numbers. */
+typedef enum {
+ pn_Cmp_False = 0, /**< false */
+ pn_Cmp_Eq, /**< equal */
+ pn_Cmp_Lt, /**< less */
+ pn_Cmp_Le, /**< less or equal */
+ pn_Cmp_Gt, /**< greater */
+ pn_Cmp_Ge, /**< greater or equal */
+ pn_Cmp_Lg, /**< less or greater */
+ pn_Cmp_Leg = 7, /**< less, equal or greater = ordered */
+ pn_Cmp_Uo, /**< unordered */
+ pn_Cmp_Ue, /**< unordered or equal */
+ pn_Cmp_Ul, /**< unordered or less */
+ pn_Cmp_Ule, /**< unordered, less or equal */
+ pn_Cmp_Ug, /**< unordered or greater */
+ pn_Cmp_Uge, /**< unordered, greater or equal */
+ pn_Cmp_Ne, /**< unordered, less or greater = not equal */
+ pn_Cmp_True = 15 /**< true */
+ /* not_mask = Leg*/ /* bits to flip to negate comparison * @@ hack for jni interface */
+} pn_Cmp; /* Projection numbers for Cmp */
+//#define not_mask pn_Cmp_Leg
-INLINE int get_negated_pnc(int pnc);
+INLINE const char *get_pnc_string(int pnc);
+INLINE int get_negated_pnc(int pnc);
INLINE ir_node *get_Cmp_left (ir_node *node);
INLINE void set_Cmp_left (ir_node *node, ir_node *left);
INLINE ir_node *get_Cmp_right (ir_node *node);
INLINE ir_node *get_Conv_op (ir_node *node);
INLINE void set_Conv_op (ir_node *node, ir_node *op);
+/* Does Cast need a mem operator?
+ * Cast should only depend on the type, not on the state of an
+ * entity. But: we initialzie various fields after Alloc, that
+ * are accessed in the cast. This required some precaution, to
+ * get the right memory into the Loads generated from the cast.
+ */
+INLINE ir_node *get_Cast_op (ir_node *node);
+INLINE void set_Cast_op (ir_node *node, ir_node *op);
+INLINE type *get_Cast_type (ir_node *node);
+INLINE void set_Cast_type (ir_node *node, type *to_tp);
+
INLINE ir_node **get_Phi_preds_arr (ir_node *node);
INLINE int get_Phi_n_preds (ir_node *node);
INLINE ir_node *get_Phi_pred (ir_node *node, int pos);
int get_Filter_n_cg_preds(ir_node *node);
ir_node * get_Filter_cg_pred(ir_node *node, int pos);
+typedef enum {
+ pn_Load_X_except, /**< Execution result if exception occured. */
+ pn_Load_M, /**< Memory result. */
+ pn_Load_res /**< Result of load operation. */
+} pn_Load; /* Projection numbers for Load. */
+
INLINE ir_node *get_Load_mem (ir_node *node);
INLINE void set_Load_mem (ir_node *node, ir_node *mem);
INLINE ir_node *get_Load_ptr (ir_node *node);
INLINE void set_Load_ptr (ir_node *node, ir_node *ptr);
+typedef enum {
+ pn_Store_X_except, /**< Execution result if exception occured. */
+ pn_Store_M /**< Memory result. */
+} pn_Store; /* Projection numbers for Store. */
+
INLINE ir_node *get_Store_mem (ir_node *node);
INLINE void set_Store_mem (ir_node *node, ir_node *mem);
INLINE ir_node *get_Store_ptr (ir_node *node);
INLINE ir_node *get_Store_value (ir_node *node);
INLINE void set_Store_value (ir_node *node, ir_node *value);
+typedef enum {
+ pn_Alloc_X, /**< Execution result if exception occured. */
+ pn_Alloc_M, /**< Memory result. */
+ pn_Alloc_res /**< Result of allocation. */
+} pn_Alloc; /* Projection numbers for Alloc. */
+
INLINE ir_node *get_Alloc_mem (ir_node *node);
INLINE void set_Alloc_mem (ir_node *node, ir_node *mem);
INLINE ir_node *get_Alloc_size (ir_node *node);
INLINE ir_node *get_Proj_pred (ir_node *node);
INLINE void set_Proj_pred (ir_node *node, ir_node *pred);
+/* Why long? shouldn't int be enough, and smaller? Or even byte? */
INLINE long get_Proj_proj (ir_node *node);
INLINE void set_Proj_proj (ir_node *node, long proj);
/* !!!!!!!!! @@@
Don't format with "\", firmjni gets problems */
/** Output location */
-#define DDM(X) printf("%s(l.%i).\n", __MYFUNC__, __LINE__);
+#define DDM printf("%s(l.%i).\n", __MYFUNC__, __LINE__);
/** Output the firm kind of the node */
-#define DDMK(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, print_firm_kind(X), (X));
+#define DDMK(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, print_firm_kind(X), (void *)(X));
/** Output information about a node */
-#define DDMN(X) printf("%s(l.%i) %s%s: %ld (%p)\n", __MYFUNC__, __LINE__, get_irn_opname(X), get_mode_name(get_irn_mode(X)), get_irn_node_nr(X), (X))
+#define DDMN(X) printf("%s(l.%i) %s%s: %ld (%p)\n", __MYFUNC__, __LINE__, get_irn_opname(X), get_mode_name(get_irn_mode(X)), get_irn_node_nr(X), (void *)(X))
/** Output information about a node and its block */
#define DDMNB(X) printf("%s%s: %ld (in block %ld)\n", get_irn_opname(X), get_mode_name(get_irn_mode(X)), get_irn_node_nr(X), get_irn_node_nr(get_nodes_Block(X)))
/** Output information about a type */
-#define DDMT(X) printf("%s(l.%i) %s %s: %ld (%p)\n", __MYFUNC__, __LINE__, get_type_tpop_name(X), get_type_name(X), get_type_nr(X), (X))
+#define DDMT(X) printf("%s(l.%i) %s %s: %ld (%p)\n", __MYFUNC__, __LINE__, get_type_tpop_name(X), get_type_name(X), get_type_nr(X), (void *)(X))
/** Output information about an entity */
-#define DDME(X) printf("%s(l.%i) %s: %ld (%p\n", __MYFUNC__, __LINE__, get_entity_name(X), get_entity_nr(X), (X))
+#define DDME(X) printf("%s(l.%i) %s: %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(X), get_entity_nr(X), (void *)(X))
+/** Output information about an entity and its type */
+#define DDMET(X) printf("%s(l.%i) %s (typ: %s): %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(X), get_type_name(get_entity_type(X)), get_entity_nr(X), (void *)(X))
/** Output information about an entity and its owner */
-#define DDMEO(X) printf("%s(l.%i) %s (own: %s): %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(X), get_type_name(get_entity_owner(X)), get_entity_nr(X), (X))
+#define DDMEO(X) printf("%s(l.%i) %s (own: %s): %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(X), get_type_name(get_entity_owner(X)), get_entity_nr(X), (void *)(X))
/** Output information about a graph */
-#define DDMG(X) printf("%s(l.%i) %s: %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(get_irg_ent(X)), get_irg_graph_nr(X), (X))
+#define DDMG(X) printf("%s(l.%i) %s: %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(get_irg_ent(X)), get_irg_graph_nr(X), (void *)(X))
/** Output information about an ident */
-#define DDMI(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, id_to_str(X), (X))
+#define DDMI(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, id_to_str(X), (void *)(X))
/** Output information about a mode */
-#define DDMM(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, get_mode_name(X), (X))
+#define DDMM(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, get_mode_name(X), (void *)(X))
/** Output information about a loop */
-#define DDML(X) printf("%s(l.%i) loop with depth %d: %p\n", __MYFUNC__, __LINE__, get_loop_depth(X), (X))
+#define DDML(X) printf("%s(l.%i) loop with depth %d: %p\n", __MYFUNC__, __LINE__, get_loop_depth(X), (void *)(X))
/** Output information about a tarVal */
-#define DDMV(X) printf("%s(l.%i) tarval: ",__MYFUNC__, __LINE__); tarval_printf(X); printf(" (%p)\n", (X));
+#define DDMV(X) printf("%s(l.%i) tarval: ",__MYFUNC__, __LINE__); tarval_printf(X); printf(" (%p)\n", (void *)(X));
/*@}*/ /* end of ir_node group definition */