-/* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe 3 2002/02/28 13:33:52
-* All rights reserved.
-*/
-
-/**
- * @file irnode.h
- *
- * Declarations of an ir node.
- *
- * author Martin Trapp, Christian Schaefer
+/*
+ * 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_
+#include <stddef.h>
+
+# include "pnc.h"
+# include "tv.h"
# include "irgraph.h"
# include "entity.h"
# include "firm_common.h"
# include "irop.h"
# include "irmode.h"
-# include "tv.h"
# include "type.h"
# include "dbginfo.h"
-# include "exc.h"
-/* The type definiton of ir_node is also in irgraph.h to resolve
- recursion between irnode.h and irgraph.h */
-/*
+/**
+ * @file irnode.h
*
- * NAME ir_node - a datatype representing a Firm node
+ * @author Martin Trapp, Christian Schaefer
*
- * Not properly documented ;-)
+ * Declarations of an ir node.
+ */
+
+/**
+ * @defgroup ir_node Declarations of an ir node.
+ *
+ * The type definition of ir_node is also in irgraph.h to resolve
+ * recursion between irnode.h and irgraph.h
*
- * @param The common fields are:
+ * ir_node - a datatype representing a Firm node
*
- * @param firm_kind A firm_kind tag containing k_type. This is useful
- * for dynamically checking whether a node is a ir_node.
- * @param arity The number of predecessors in the Firm graph.
- * @param in A list with the predecessors in the Firm graph. There are
- * routines to access individual elements and to obtain the
- * array. The method returning the array should not be used.
- * @param mode The mode of the node. There are routines to get the mode but
- * also to access the mode's fields directly.
- * @param opcode The opcode of the node. There are routines to get the opcode but
- * also to access the opcode's fields directly.
- * @param node_nr A unique number for the node. Available only if debugging is
- * turned on.
+ * The common fields are:
+ *
+ * - firm_kind - A firm_kind tag containing k_type. This is useful
+ * for dynamically checking whether a node is a ir_node.
+ * - arity - The number of predecessors in the Firm graph.
+ * - in - A list with the predecessors in the Firm graph. There are
+ * routines to access individual elements and to obtain the
+ * array. The method returning the array should not be used.
+ * - mode - The mode of the node. There are routines to get the mode
+ * but also to access the mode's fields directly.
+ * - opcode - The opcode of the node. There are routines to get the opcode
+ * but also to access the opcode's fields directly.
+ * - node_nr - A unique number for the node. Available only if debugging
+ * is turned on.
+ * @{
*/
+
#ifndef _IR_NODE_TYPEDEF_
#define _IR_NODE_TYPEDEF_
typedef struct ir_node ir_node;
#endif
+#ifdef __cplusplus
+extern "C" {
+#endif
+
/**
- you can work on the graph without considering the different types
- of nodes, it's just a big graph. **/
+ * you can work on the graph without considering the different types
+ * of nodes, it's just a big graph.
+ */
-/** returns the number of predecessors without the block predecessor: */
-int get_irn_arity (ir_node *node);
+/**
+ * Checks whether a pointer points to a ir node.
+ *
+ * @param thing an arbitrary pointer
+ * @return non-zero if the thing is a ir mode, else zero
+ */
+int is_ir_node (const void *thing);
+
+/**
+ * Returns the number of predecessors without the block predecessor.
+ *
+ * @param node the IR-node
+ */
+int get_irn_arity (const ir_node *node);
+int get_irn_intra_arity (const ir_node *node);
+int get_irn_inter_arity (const ir_node *node);
/** Replaces the old in array by a new one that will contain the ins given in
the parameters. Conserves the block predecessor. It copies the array passed.
- This function is necessary to ajust in arrays of blocks, calls and phis.
+ This function is necessary to adjust in arrays of blocks, calls and phis.
Assumes that current_ir_graph is set to the graph containing "node".
"in" must contain all predecessors except the block that are required for
the nodes opcode. */
-INLINE void set_irn_in (ir_node *node, int arity,
- ir_node *in[]);
+void set_irn_in (ir_node *node, int arity, ir_node *in[]);
+
/* to iterate through the predecessors without touching the array. No
order of predecessors guaranteed.
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. */
/* Access predecessor n */
-/* get_irn_n removes Id predecessors. */
-INLINE ir_node *get_irn_n (ir_node *node, int n);
-INLINE void set_irn_n (ir_node *node, int n, ir_node *in);
-/* Get the mode struct. */
-INLINE ir_mode *get_irn_mode (ir_node *node);
-/* Get the mode-enum modecode */
-INLINE modecode get_irn_modecode (ir_node *node);
-/* Get the ident for a string representation of the mode */
-INLINE ident *get_irn_modeident (ir_node *node);
-/* Access the opcode struct of the node */
-INLINE ir_op *get_irn_op (ir_node *node);
-INLINE void set_irn_op (ir_node *node, ir_op *op);
-/* Get the opcode-enum of the node */
-INLINE opcode get_irn_opcode (ir_node *node);
-/* Get the ident for a string representation of the opcode */
-INLINE ident *get_irn_opident (ir_node *node);
-/* Get the string representation of the opcode */
-INLINE const char *get_irn_opname (ir_node *node);
-INLINE void set_irn_visited (ir_node *node, unsigned long visited);
-INLINE unsigned long get_irn_visited (ir_node *node);
-/* Sets visited to get_irg_visited(current_ir_graph) */
-INLINE void mark_irn_visited (ir_node *node);
-/* Returns 1 if visited < get_irg_visited(current_ir_graph). */
-INLINE int irn_not_visited (ir_node *node);
-/* Returns 1 if visited >= get_irg_visited(current_ir_graph). */
-INLINE int irn_visited (ir_node *node);
-INLINE void set_irn_link (ir_node *node, void *link);
-INLINE void *get_irn_link (ir_node *node);
-
-/** 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(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);
+
+/**
+ * Get the n-th predecessor of a node.
+ * This function removes Id predecessors.
+ */
+ir_node *get_irn_n (const ir_node *node, int n);
+ir_node *get_irn_intra_n (const ir_node *node, int n);
+ir_node *get_irn_inter_n (const ir_node *node, int n);
+
+/** Replace the n-th predecessor of a node with a new one. */
+void set_irn_n (ir_node *node, int n, ir_node *in);
+/* Sets the mode struct of node. */
+void set_irn_mode (ir_node *node, ir_mode *mode);
+/** Gets the mode struct of a node. */
+ir_mode *get_irn_mode (const ir_node *node);
+/** Gets the mode-enum modecode. */
+modecode get_irn_modecode (const ir_node *node);
+/** Gets the ident for a string representation of the mode .*/
+ident *get_irn_modeident (const ir_node *node);
+/** Gets the string representation of the mode .*/
+const char *get_irn_modename (const ir_node *node);
+/** Gets the opcode struct of the node. */
+ir_op *get_irn_op (const ir_node *node);
+/** Sets the opcode struct of the node. */
+void set_irn_op (ir_node *node, ir_op *op);
+/** Gets the opcode-enum of the node. */
+opcode get_irn_opcode (const ir_node *node);
+/** Get the string representation of the opcode. */
+const char *get_irn_opname (const ir_node *node);
+/** Get the ident for a string representation of the opcode. */
+ident *get_irn_opident (const ir_node *node);
+/** Gets the visited counter of a node. */
+unsigned long get_irn_visited (const ir_node *node);
+/** Sets the visited counter of a node. */
+void set_irn_visited (ir_node *node, unsigned long visited);
+/** Sets visited to get_irg_visited(current_ir_graph). */
+void mark_irn_visited (ir_node *node);
+/** Returns 1 if visited < get_irg_visited(current_ir_graph). */
+int irn_not_visited (const ir_node *node);
+/** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
+int irn_visited (const ir_node *node);
+
+/**
+ * Sets the link of a node.
+ * Only allowed if the graph is NOT in phase_building.
+ */
+void set_irn_link (ir_node *node, void *link);
+
+/** Returns the link of a node. */
+void *get_irn_link (const ir_node *node);
+
+/** Returns the ir_graph this node belongs to. Only valid if irg
+ * is in state op_pin_state_pinned (irg is only stored in the block. */
+ir_graph *get_irn_irg (const ir_node *node);
+
+/** Outputs a unique number for this node if libFIRM is compiled for
+ debugging, (configure with --enable-debug) else returns address
+ of node cast to long. */
+long get_irn_node_nr (const ir_node *node);
+
+/** Returns the pinned state of a node. */
+op_pin_state get_irn_pinned (const ir_node *node);
+
+/** Set pin state for nodes with op pin state op_pin_state_exc_pinned */
+void set_irn_pinned(ir_node *node, op_pin_state state);
/**
* irnode constructor.
* Create a new irnode in irg, with an op, mode, arity and
* some incoming irnodes.
- * If arity is negative, a node with a dynamic array is created.
+ * This constructor is used in every specified irnode constructor.
+ *
+ * @param db Debug info.
+ * @param irg IR-graph on with this new node should be constructed.
+ * @param op The opcode of the new node.
+ * @param mode The mode of the new node.
+ * @param arity The arity of the new node, may be <0 if yet.
+ * @param in An array of arity predecessor nodes.
*/
-INLINE ir_node *
+ir_node *
new_ir_node (dbg_info *db,
- ir_graph *irg,
- ir_node *block,
- ir_op *op,
- ir_mode *mode,
- int arity,
- ir_node *in[]);
-
-/*
+ ir_graph *irg,
+ ir_node *block,
+ ir_op *op,
+ ir_mode *mode,
+ int arity,
+ ir_node *in[]);
+
+/** Return the block the node belongs to.
*
- * NAME access functions for node fields.
+ * This works for all except Block. It can return Blocks or the Bad node.
*
- * Not properly documented ;-)
- *
- */
+ * To express the difference to access routines that work for all
+ * nodes we use infix "nodes" and do not name this function
+ * get_irn_block. */
+ir_node *get_nodes_block (const ir_node *node);
-/* this works for all except Block */
-INLINE ir_node *get_nodes_Block (ir_node *node);
-INLINE void set_nodes_Block (ir_node *node, ir_node *block);
+/** Sets the Block of a node. */
+void set_nodes_block (ir_node *node, ir_node *block);
-/** Projection numbers for result of Start node: use for Proj nodes! */
+/**
+ * @function get_irn_block()
+ * @see get_nodes_block()
+ */
+/**
+ * Projection numbers for result of Start node: use for Proj nodes!
+ */
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. */
- pns_args /**< Projection on all arguments */
-} pns_number;
+ 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_max /**< number of projections from a Start */
+} pn_Start; /* Projection numbers for Start. */
+
+
+/** Test whether arbitrary node is frame pointer.
+ *
+ * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
+ * from Start. If so returns frame type, else Null. */
+type *is_frame_pointer(ir_node *n);
+
+/** Test whether arbitrary node is globals pointer.
+ *
+ * Test whether arbitrary node is globals pointer, i.e. Proj(pn_Start_P_globals)
+ * from Start. If so returns global type, else Null. */
+type *is_globals_pointer(ir_node *n);
+
+/** Test whether arbitrary node is value arg base.
+ *
+ * Test whether arbitrary node is value arg base, i.e. Proj(pn_Start_P_value_arg_base)
+ * from Start. If so returns 1, else 0. */
+int is_value_arg_pointer(ir_node *n);
+
/* @@@ no more supported */
-INLINE ir_node **get_Block_cfgpred_arr (ir_node *node);
-int get_Block_n_cfgpreds (ir_node *node);
-INLINE ir_node *get_Block_cfgpred (ir_node *node, int pos);
-INLINE void set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
-INLINE bool get_Block_matured (ir_node *node);
-INLINE void set_Block_matured (ir_node *node, bool matured);
-INLINE unsigned long get_Block_block_visited (ir_node *node);
-INLINE void set_Block_block_visited (ir_node *node, unsigned long visit);
+ir_node **get_Block_cfgpred_arr (ir_node *node);
+int get_Block_n_cfgpreds (ir_node *node);
+ir_node *get_Block_cfgpred (ir_node *node, int pos);
+void set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
+bool get_Block_matured (ir_node *node);
+void set_Block_matured (ir_node *node, bool matured);
+unsigned long get_Block_block_visited (ir_node *node);
+void set_Block_block_visited (ir_node *node, unsigned long visit);
+ir_node *set_Block_dead(ir_node *block);
+int is_Block_dead(const ir_node *block);
+
/* For this current_ir_graph must be set. */
-INLINE void mark_Block_block_visited(ir_node *node);
-INLINE int Block_not_block_visited(ir_node *node);
+void mark_Block_block_visited(ir_node *node);
+int Block_not_block_visited(ir_node *node);
/* Set and remove interprocedural predecessors. If the interprocedural
* 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);
-/* 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);
+ir_node **get_Block_cg_cfgpred_arr(ir_node * node);
+/** Returns the number of interprocedural predecessors. 0 if none. */
+int get_Block_cg_n_cfgpreds(ir_node * node);
+/** Return the interprocedural predecessor at position pos. */
+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);
+
+/** Return the number of Keep alive node. */
+int get_End_n_keepalives(ir_node *end);
-INLINE int get_End_n_keepalives(ir_node *end);
-INLINE ir_node *get_End_keepalive(ir_node *end, int pos);
-INLINE void add_End_keepalive (ir_node *end, ir_node *ka);
-INLINE void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
-/* Some parts of the End node are allocated seperately -- their memory
+/** Return the Keep alive node a position pos. */
+ir_node *get_End_keepalive(ir_node *end, int pos);
+
+/** Keep alive dedicated nodes. These must be either PhiM or Block nodes. */
+void add_End_keepalive (ir_node *end, ir_node *ka);
+
+/** Set the Keep alive node at position pos. */
+void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
+
+/** Some parts of the End node are allocated separately -- their memory
is not recovered by dead_node_elimination if a End node is dead.
- free_End frees these data structures. */
-INLINE void free_End (ir_node *end);
+ free_End() frees these data structures. */
+void free_End (ir_node *end);
-ir_graph *get_EndReg_irg (ir_node *end);
-ir_graph *get_EndExcept_irg (ir_node *end);
/* We distinguish three kinds of Cond nodes. These can be distinguished
by the mode of the selector operand and an internal flag of type cond_kind.
We differ two flavours of this Cond. The first, the dense Cond, passes
control along output i if the selector value is i, 0 <= i <= n. If the
selector value is >n it passes control along output n.
- The second Cond flavor differes in the treatment of cases not specified in
+ The second Cond flavor diffirences in the treatment of cases not specified in
the source program. It magically knows about the existence of Proj nodes.
It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
exists. Else it passes control along output n (even if this Proj does not
typedef enum {
dense, /**< Default. Missing Proj nodes are dead control flow. */
fragmentary /**< Special. No control flow optimizations allowed. Missing
- Proj nodes mean default control flow, i.e., Proj(n). */
+ Proj nodes mean default control flow, i.e., Proj(n). */
} cond_kind;
-INLINE ir_node *get_Cond_selector (ir_node *node);
-INLINE void set_Cond_selector (ir_node *node, ir_node *selector);
-INLINE cond_kind get_Cond_kind (ir_node *node);
-INLINE void set_Cond_kind (ir_node *node, cond_kind kind);
+ir_node *get_Cond_selector (ir_node *node);
+void set_Cond_selector (ir_node *node, ir_node *selector);
+cond_kind get_Cond_kind (ir_node *node);
+void set_Cond_kind (ir_node *node, cond_kind kind);
+long get_Cond_defaultProj (ir_node *node);
+
+/**
+ * Projection numbers for conditions.
+ */
+typedef enum {
+ pn_Cond_false, /**< Control flow if operand is "false". */
+ pn_Cond_true, /**< Control flow if operand is "true". */
+ pn_Cond_max /**< number of projections from a Cond */
+} pn_Cond; /* Projection numbers for Cond. */
+
+ir_node *get_Return_mem (ir_node *node);
+void set_Return_mem (ir_node *node, ir_node *mem);
+ir_node **get_Return_res_arr (ir_node *node);
+int get_Return_n_ress (ir_node *node);
+ir_node *get_Return_res (ir_node *node, int pos);
+void set_Return_res (ir_node *node, int pos, ir_node *res);
+
+ir_node *get_Raise_mem (ir_node *node);
+void set_Raise_mem (ir_node *node, ir_node *mem);
+ir_node *get_Raise_exo_ptr (ir_node *node); /* PoinTeR to EXception Object */
+void set_Raise_exo_ptr (ir_node *node, ir_node *exoptr);
+
+/**
+ * Projection numbers for Raise.
+ */
+typedef enum {
+ pn_Raise_X, /**< Execution result. */
+ pn_Raise_M, /**< Memory result. */
+ pn_Raise_max /**< number of projections from a Raise */
+} pn_Raise; /* Projection numbers for Raise. */
+
+typedef enum {
+ CNST_NULL = TV_CLASSIFY_NULL, /**< The node is a const(0). */
+ CNST_ONE = TV_CLASSIFY_ONE, /**< The node is a const(1). */
+ CNST_ALL_ONE = TV_CLASSIFY_ALL_ONE, /**< The node is a const(11111...). */
+ CNST_OTHER = TV_CLASSIFY_OTHER, /**< The tarvel of the const has another value. */
+ CNST_SYMCONST, /**< The node is symconst. */
+ CNST_NO_CONST /**< The node is no const at all. */
+} cnst_classify_t;
-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 int get_Return_n_ress (ir_node *node);
-INLINE ir_node *get_Return_res (ir_node *node, int pos);
-INLINE void set_Return_res (ir_node *node, int pos, ir_node *res);
+tarval *get_Const_tarval (ir_node *node);
+void set_Const_tarval (ir_node *node, tarval *con);
+
+/**
+ * Classify a node concerning constant properties.
+ * @param irn A node to check for.
+ * @return Constant properties of that node.
+ */
+cnst_classify_t classify_Const(ir_node *irn);
-INLINE ir_node *get_Raise_mem (ir_node *node);
-INLINE void set_Raise_mem (ir_node *node, ir_node *mem);
-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);
+/** Returns the source language type of a Const node.
+ * Must be an atomic type. Mode of type must be mode of node.
+ */
+type *get_Const_type (ir_node *node);
-INLINE tarval *get_Const_tarval (ir_node *node);
-INLINE void set_Const_tarval (ir_node *node, tarval *con);
+/** Sets the source language type of a Const node. */
+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
depends on this tag. Use the proper access routine after testing
this flag. */
typedef enum {
- type_tag, /**< The SymConst is a type tag for the given type.
- Type_or_id_p is type *. */
- size, /**< The SymConst is the size of the given type.
- Type_or_id_p is type *. */
- linkage_ptr_info /**< The SymConst is a symbolic pointer to be filled in
- by the linker. Type_or_id_p is ident *. */
+ symconst_type_tag, /**< The SymConst is a type tag for the given type.
+ Type_or_id_p is type *. */
+ symconst_size, /**< The SymConst is the size of the given type.
+ Type_or_id_p is type *. */
+ symconst_addr_name, /**< The SymConst is a symbolic pointer to be filled in
+ by the linker. The pointer is represented by a string.
+ Type_or_id_p is ident *. */
+ symconst_addr_ent /**< The SymConst is a symbolic pointer to be filled in
+ by the linker. The pointer is represented by an entity.
+ Type_or_id_p is entity *. */
} symconst_kind;
-typedef union type_or_id * type_or_id_p;
-INLINE symconst_kind get_SymConst_kind (ir_node *node);
-INLINE void set_SymConst_kind (ir_node *node, symconst_kind num);
-/* Only to access SymConst of kind type_tag or size. Else assertion: */
-INLINE type *get_SymConst_type (ir_node *node);
-INLINE void set_SymConst_type (ir_node *node, type *tp);
-/* Only to access SymConst of kind linkage_ptr_info. Else assertion: */
-INLINE ident *get_SymConst_ptrinfo (ir_node *node);
-INLINE void set_SymConst_ptrinfo (ir_node *node, ident *ptrinfo);
-/* Sets both: type and ptrinfo. Needed to treat the node independent of
- its semantics. Does a memcpy for the memory tori points to. */
-INLINE type_or_id_p get_SymConst_type_or_id (ir_node *node);
-INLINE void set_SymConst_type_or_id (ir_node *node, type_or_id_p tori);
-
-INLINE ir_node *get_Sel_mem (ir_node *node);
-INLINE void set_Sel_mem (ir_node *node, ir_node *mem);
-INLINE ir_node *get_Sel_ptr (ir_node *node); /* ptr to the object to select from */
-INLINE void set_Sel_ptr (ir_node *node, ir_node *ptr);
-INLINE ir_node **get_Sel_index_arr (ir_node *node);
-INLINE int get_Sel_n_indexs (ir_node *node);
-INLINE ir_node *get_Sel_index (ir_node *node, int pos);
-INLINE void set_Sel_index (ir_node *node, int pos, ir_node *index);
-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);
-
-INLINE ir_node *get_Call_mem (ir_node *node);
-INLINE void set_Call_mem (ir_node *node, ir_node *mem);
-INLINE ir_node *get_Call_ptr (ir_node *node);
-INLINE void set_Call_ptr (ir_node *node, ir_node *ptr);
-INLINE ir_node **get_Call_param_arr (ir_node *node);
-INLINE int get_Call_n_params (ir_node *node);
-INLINE ir_node *get_Call_param (ir_node *node, int pos);
-INLINE void set_Call_param (ir_node *node, int pos, ir_node *param);
-INLINE type *get_Call_type (ir_node *node);
-INLINE void set_Call_type (ir_node *node, type *tp);
-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);
-
-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);
+
+/** SymConst attributes
+ This union contains the symbolic information represented by the node */
+union symconst_symbol {
+ type *type_p;
+ ident *ident_p;
+ entity *entity_p;
+};
+
+typedef union symconst_symbol symconst_symbol;
+
+
+/** Get the kind of the SymConst. */
+symconst_kind get_SymConst_kind (const ir_node *node);
+/** Set the kind of the SymConst. */
+void set_SymConst_kind (ir_node *node, symconst_kind num);
+
+/** Only to access SymConst of kind type_tag or size. Else assertion: */
+type *get_SymConst_type (ir_node *node);
+void set_SymConst_type (ir_node *node, type *tp);
+
+/** Only to access SymConst of kind addr_name. Else assertion: */
+ident *get_SymConst_name (ir_node *node);
+void set_SymConst_name (ir_node *node, ident *name);
+
+/** Only to access SymConst of kind addr_ent. Else assertion: */
+entity *get_SymConst_entity (ir_node *node);
+void set_SymConst_entity (ir_node *node, entity *ent);
+
+/** Sets both: type and ptrinfo. Needed to treat the node independent of
+ its semantics. Does a memcpy for the memory sym points to. */
+/* write 'union': firmjni then does not create a method... */
+union symconst_symbol get_SymConst_symbol (ir_node *node);
+void set_SymConst_symbol (ir_node *node,
+ union symconst_symbol sym);
+
+/** Access the type of the value represented by the SymConst.
+ *
+ * Example: primitive type int for SymConst size. */
+type *get_SymConst_value_type (ir_node *node);
+void set_SymConst_value_type (ir_node *node, type *tp);
+
+ir_node *get_Sel_mem (ir_node *node);
+void set_Sel_mem (ir_node *node, ir_node *mem);
+ir_node *get_Sel_ptr (ir_node *node); /* ptr to the object to select from */
+void set_Sel_ptr (ir_node *node, ir_node *ptr);
+ir_node **get_Sel_index_arr (ir_node *node);
+int get_Sel_n_indexs (ir_node *node);
+ir_node *get_Sel_index (ir_node *node, int pos);
+void set_Sel_index (ir_node *node, int pos, ir_node *index);
+entity *get_Sel_entity (ir_node *node); /* entity to select */
+void set_Sel_entity (ir_node *node, entity *ent);
+
+/**
+ * Projection numbers for result of Call node: use for Proj nodes!
+ */
+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_max = 5 /**< number of projections from a Call */
+} pn_Call; /* Projection numbers for Call. */
+
+ir_node *get_Call_mem (ir_node *node);
+void set_Call_mem (ir_node *node, ir_node *mem);
+ir_node *get_Call_ptr (ir_node *node);
+void set_Call_ptr (ir_node *node, ir_node *ptr);
+ir_node **get_Call_param_arr (ir_node *node);
+/** Gets the number of parameters of a call. */
+int get_Call_n_params (ir_node *node);
+/** Gets the call parameter at position pos. */
+ir_node *get_Call_param (ir_node *node, int pos);
+/** Sets the call parameter at position pos. */
+void set_Call_param (ir_node *node, int pos, ir_node *param);
+/** Gets the type of a call. */
+type *get_Call_type (ir_node *node);
+/** Sets the type of a call. */
+void set_Call_type (ir_node *node, type *tp);
+/** Gets the arity of a call. Identical to get_Call_n_params(). */
+int get_Call_arity (ir_node *node);
+
+/** Set, get and remove the callee information for a Call node.
+ *
+ * The callee information lists all method entities that can be called
+ * from this node. If the address expression can not be analyzed fully,
+ * e.g., as entities can be called that are not in the compilation unit,
+ * the array contains the unknown_entity. The array contains only entities
+ * with peculiarity_existent, but with all kinds of visibility. The entities
+ * not necessarily contain an irg.
+ *
+ * The array is only accessible if callee information is valid. See flag
+ * in graph.
+ *
+ * The memory allocated for the array is managed automatically, i.e., it must
+ * not be freed if the Call node is removed from the graph.
+ *
+ * @param node A Call node.
+ */
+int Call_has_callees (ir_node *node);
+int get_Call_n_callees (ir_node *node);
+entity *get_Call_callee (ir_node *node, int pos);
+
+/** Set the full callee array.
+ *
+ * The passed array is copied. Assumes current_ir_graph set properly! */
+void set_Call_callee_arr (ir_node *node, const 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_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_unop_op (ir_node *node);
-INLINE void set_unop_op (ir_node *node, ir_node *op);
-INLINE int is_binop (ir_node *node);
-INLINE ir_node *get_binop_left (ir_node *node);
-INLINE void set_binop_left (ir_node *node, ir_node *left);
-INLINE ir_node *get_binop_right (ir_node *node);
-INLINE void set_binop_right (ir_node *node, ir_node *right);
-
-INLINE ir_node *get_Add_left (ir_node *node);
-INLINE void set_Add_left (ir_node *node, ir_node *left);
-INLINE ir_node *get_Add_right (ir_node *node);
-INLINE void set_Add_right (ir_node *node, ir_node *right);
-
-INLINE ir_node *get_Sub_left (ir_node *node);
-INLINE void set_Sub_left (ir_node *node, ir_node *left);
-INLINE ir_node *get_Sub_right (ir_node *node);
-INLINE void set_Sub_right (ir_node *node, ir_node *right);
-
-INLINE ir_node *get_Minus_op (ir_node *node);
-INLINE void set_Minus_op (ir_node *node, ir_node *op);
-
-INLINE ir_node *get_Mul_left (ir_node *node);
-INLINE void set_Mul_left (ir_node *node, ir_node *left);
-INLINE ir_node *get_Mul_right (ir_node *node);
-INLINE void set_Mul_right (ir_node *node, ir_node *right);
-
-INLINE ir_node *get_Quot_left (ir_node *node);
-INLINE void set_Quot_left (ir_node *node, ir_node *left);
-INLINE ir_node *get_Quot_right (ir_node *node);
-INLINE void set_Quot_right (ir_node *node, ir_node *right);
-INLINE ir_node *get_Quot_mem (ir_node *node);
-INLINE void set_Quot_mem (ir_node *node, ir_node *mem);
-
-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 void set_DivMod_right (ir_node *node, ir_node *right);
-INLINE ir_node *get_DivMod_mem (ir_node *node);
-INLINE void set_DivMod_mem (ir_node *node, ir_node *mem);
-
-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 void set_Div_right (ir_node *node, ir_node *right);
-INLINE ir_node *get_Div_mem (ir_node *node);
-INLINE void set_Div_mem (ir_node *node, ir_node *mem);
-
-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 void set_Mod_right (ir_node *node, ir_node *right);
-INLINE ir_node *get_Mod_mem (ir_node *node);
-INLINE void set_Mod_mem (ir_node *node, ir_node *mem);
-
-INLINE ir_node *get_Abs_op (ir_node *node);
-INLINE void set_Abs_op (ir_node *node, ir_node *op);
-
-INLINE ir_node *get_And_left (ir_node *node);
-INLINE void set_And_left (ir_node *node, ir_node *left);
-INLINE ir_node *get_And_right (ir_node *node);
-INLINE void set_And_right (ir_node *node, ir_node *right);
-
-INLINE ir_node *get_Or_left (ir_node *node);
-INLINE void set_Or_left (ir_node *node, ir_node *left);
-INLINE ir_node *get_Or_right (ir_node *node);
-INLINE void set_Or_right (ir_node *node, ir_node *right);
-
-INLINE ir_node *get_Eor_left (ir_node *node);
-INLINE void set_Eor_left (ir_node *node, ir_node *left);
-INLINE ir_node *get_Eor_right (ir_node *node);
-INLINE void set_Eor_right (ir_node *node, ir_node *right);
-
-INLINE ir_node *get_Not_op (ir_node *node);
-INLINE void set_Not_op (ir_node *node, ir_node *op);
-
-/** Projection numbers of compare: use for Proj nodes! */
+int is_unop (const ir_node *node);
+ir_node *get_unop_op (ir_node *node);
+void set_unop_op (ir_node *node, ir_node *op);
+int is_binop (const ir_node *node);
+ir_node *get_binop_left (ir_node *node);
+void set_binop_left (ir_node *node, ir_node *left);
+ir_node *get_binop_right (ir_node *node);
+void set_binop_right (ir_node *node, ir_node *right);
+
+ir_node *get_Add_left (ir_node *node);
+void set_Add_left (ir_node *node, ir_node *left);
+ir_node *get_Add_right (ir_node *node);
+void set_Add_right (ir_node *node, ir_node *right);
+
+ir_node *get_Sub_left (ir_node *node);
+void set_Sub_left (ir_node *node, ir_node *left);
+ir_node *get_Sub_right (ir_node *node);
+void set_Sub_right (ir_node *node, ir_node *right);
+
+ir_node *get_Minus_op (ir_node *node);
+void set_Minus_op (ir_node *node, ir_node *op);
+
+ir_node *get_Mul_left (ir_node *node);
+void set_Mul_left (ir_node *node, ir_node *left);
+ir_node *get_Mul_right (ir_node *node);
+void set_Mul_right (ir_node *node, ir_node *right);
+
+ir_node *get_Quot_left (ir_node *node);
+void set_Quot_left (ir_node *node, ir_node *left);
+ir_node *get_Quot_right (ir_node *node);
+void set_Quot_right (ir_node *node, ir_node *right);
+ir_node *get_Quot_mem (ir_node *node);
+void set_Quot_mem (ir_node *node, ir_node *mem);
+
+/**
+ * Projection numbers for Quot: use for Proj nodes!
+ */
typedef enum {
- False, /**< false */
- Eq, /**< equal */
- Lt, /**< less */
- Le, /**< less or equal */
- Gt, /**< greater */
- Ge, /**< greater or equal */
- Lg, /**< less or greater */
- Leg, /**< less, equal or greater = ordered */
- Uo, /**< unordered */
- Ue, /**< unordered or equal */
- Ul, /**< unordered or less */
- Ule, /**< unordered, less or equal */
- Ug, /**< unordered or greater */
- Uge, /**< unordered, greater or equal */
- Ne, /**< unordered, less or greater = not equal */
- True /**< true */
- /* not_mask = Leg*/ /* bits to flip to negate comparison * @@ hack for jni interface */
-} pnc_number;
-#define not_mask Leg
-INLINE 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 void set_Cmp_right (ir_node *node, ir_node *right);
-
-INLINE ir_node *get_Shl_left (ir_node *node);
-INLINE void set_Shl_left (ir_node *node, ir_node *left);
-INLINE ir_node *get_Shl_right (ir_node *node);
-INLINE void set_Shl_right (ir_node *node, ir_node *right);
-
-INLINE ir_node *get_Shr_left (ir_node *node);
-INLINE void set_Shr_left (ir_node *node, ir_node *left);
-INLINE ir_node *get_Shr_right (ir_node *node);
-INLINE void set_Shr_right (ir_node *node, ir_node *right);
-
-INLINE ir_node *get_Shrs_left (ir_node *node);
-INLINE void set_Shrs_left (ir_node *node, ir_node *left);
-INLINE ir_node *get_Shrs_right (ir_node *node);
-INLINE void set_Shrs_right (ir_node *node, ir_node *right);
-
-INLINE ir_node *get_Rot_left (ir_node *node);
-INLINE void set_Rot_left (ir_node *node, ir_node *left);
-INLINE ir_node *get_Rot_right (ir_node *node);
-INLINE void set_Rot_right (ir_node *node, ir_node *right);
-
-INLINE ir_node *get_Conv_op (ir_node *node);
-INLINE void set_Conv_op (ir_node *node, ir_node *op);
-
-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);
-INLINE void set_Phi_pred (ir_node *node, int pos, ir_node *pred);
-
-INLINE ir_node *get_Filter_pred(ir_node *node);
-INLINE void set_Filter_pred(ir_node *node, ir_node *pred);
-INLINE long get_Filter_proj(ir_node *node);
-INLINE void set_Filter_proj(ir_node *node, long proj);
-/* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
- * @@@ Maybe better: arity is zero if no cg preds. */
-void set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
-void set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
-int get_Filter_n_cg_preds(ir_node *node);
-ir_node * get_Filter_cg_pred(ir_node *node, int pos);
-
-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);
-
-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 void set_Store_ptr (ir_node *node, ir_node *ptr);
-INLINE ir_node *get_Store_value (ir_node *node);
-INLINE void set_Store_value (ir_node *node, ir_node *value);
-
-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 void set_Alloc_size (ir_node *node, ir_node *size);
-INLINE type *get_Alloc_type (ir_node *node);
-INLINE void set_Alloc_type (ir_node *node, type *tp);
-
-/** allocation place. */
+ pn_Quot_M, /**< Memory result. */
+ pn_Quot_X_except, /**< Execution result if exception occurred. */
+ pn_Quot_res, /**< Result of computation. */
+ pn_Quot_max /**< number of projections from a Quot */
+} pn_Quot; /* Projection numbers for Quot. */
+
+ir_node *get_DivMod_left (ir_node *node);
+void set_DivMod_left (ir_node *node, ir_node *left);
+ir_node *get_DivMod_right (ir_node *node);
+void set_DivMod_right (ir_node *node, ir_node *right);
+ir_node *get_DivMod_mem (ir_node *node);
+void set_DivMod_mem (ir_node *node, ir_node *mem);
+
+/**
+ * Projection numbers for DivMod: use for Proj nodes!
+ */
typedef enum {
- stack_alloc, /**< Alloc allocates the object on the stack. */
- heap_alloc /**< Alloc allocates the object on the heap. */
-} where_alloc;
+ pn_DivMod_M, /**< Memory result. */
+ pn_DivMod_X_except, /**< Execution result if exception occurred. */
+ pn_DivMod_res_div, /**< Result of computation a / b. */
+ pn_DivMod_res_mod, /**< Result of computation a % b. */
+ pn_DivMod_max /**< number of projections from a DivMod */
+} pn_DivMod; /* Projection numbers for DivMod. */
+
+ir_node *get_Div_left (ir_node *node);
+void set_Div_left (ir_node *node, ir_node *left);
+ir_node *get_Div_right (ir_node *node);
+void set_Div_right (ir_node *node, ir_node *right);
+ir_node *get_Div_mem (ir_node *node);
+void set_Div_mem (ir_node *node, ir_node *mem);
-INLINE where_alloc get_Alloc_where (ir_node *node);
-INLINE void set_Alloc_where (ir_node *node, where_alloc where);
+/**
+ * Projection numbers for Div: use for Proj nodes!
+ */
+typedef enum {
+ pn_Div_M, /**< Memory result. */
+ pn_Div_X_except, /**< Execution result if exception occurred. */
+ pn_Div_res /**< Result of computation. */
+} pn_Div; /* Projection numbers for Div. */
+
+ir_node *get_Mod_left (ir_node *node);
+void set_Mod_left (ir_node *node, ir_node *left);
+ir_node *get_Mod_right (ir_node *node);
+void set_Mod_right (ir_node *node, ir_node *right);
+ir_node *get_Mod_mem (ir_node *node);
+void set_Mod_mem (ir_node *node, ir_node *mem);
-INLINE ir_node *get_Free_mem (ir_node *node);
-INLINE void set_Free_mem (ir_node *node, ir_node *mem);
-INLINE ir_node *get_Free_ptr (ir_node *node);
-INLINE void set_Free_ptr (ir_node *node, ir_node *ptr);
-INLINE ir_node *get_Free_size (ir_node *node);
-INLINE void set_Free_size (ir_node *node, ir_node *size);
-INLINE type *get_Free_type (ir_node *node);
-INLINE void set_Free_type (ir_node *node, type *tp);
+/**
+ * Projection numbers for Mod: use for Proj nodes!
+ */
+typedef enum {
+ pn_Mod_M, /**< Memory result. */
+ pn_Mod_X_except, /**< Execution result if exception occurred. */
+ pn_Mod_res, /**< Result of computation. */
+ pn_Mod_max /**< number of projections from a Mod */
+} pn_Mod; /* Projection numbers for Mod. */
-INLINE ir_node **get_Sync_preds_arr (ir_node *node);
-INLINE int get_Sync_n_preds (ir_node *node);
-INLINE ir_node *get_Sync_pred (ir_node *node, int pos);
-INLINE void set_Sync_pred (ir_node *node, int pos, ir_node *pred);
+ir_node *get_Abs_op (ir_node *node);
+void set_Abs_op (ir_node *node, ir_node *op);
-INLINE ir_node *get_Proj_pred (ir_node *node);
-INLINE void set_Proj_pred (ir_node *node, ir_node *pred);
-INLINE long get_Proj_proj (ir_node *node);
-INLINE void set_Proj_proj (ir_node *node, long proj);
+ir_node *get_And_left (ir_node *node);
+void set_And_left (ir_node *node, ir_node *left);
+ir_node *get_And_right (ir_node *node);
+void set_And_right (ir_node *node, ir_node *right);
-INLINE ir_node **get_Tuple_preds_arr (ir_node *node);
-INLINE int get_Tuple_n_preds (ir_node *node);
-INLINE ir_node *get_Tuple_pred (ir_node *node, int pos);
-INLINE void set_Tuple_pred (ir_node *node, int pos, ir_node *pred);
+ir_node *get_Or_left (ir_node *node);
+void set_Or_left (ir_node *node, ir_node *left);
+ir_node *get_Or_right (ir_node *node);
+void set_Or_right (ir_node *node, ir_node *right);
-INLINE ir_node *get_Id_pred (ir_node *node);
-INLINE void set_Id_pred (ir_node *node, ir_node *pred);
+ir_node *get_Eor_left (ir_node *node);
+void set_Eor_left (ir_node *node, ir_node *left);
+ir_node *get_Eor_right (ir_node *node);
+void set_Eor_right (ir_node *node, ir_node *right);
+
+ir_node *get_Not_op (ir_node *node);
+void set_Not_op (ir_node *node, ir_node *op);
+
+/**
+ * Projection numbers for Cmp are defined several times.
+ * The bit patterns are used for various tests, so don't change.
+ * The "unordered" values are possible results of comparing
+ * floating point numbers.
+ * Note that the encoding is imported, so do NOT change the order.
+ */
+typedef enum {
+ pn_Cmp_False = 0, /**< false */
+ pn_Cmp_Eq = 1, /**< equal */
+ pn_Cmp_Lt = 2, /**< less */
+ pn_Cmp_Le = pn_Cmp_Eq|pn_Cmp_Lt, /**< less or equal */
+ pn_Cmp_Gt = 4, /**< greater */
+ pn_Cmp_Ge = pn_Cmp_Eq|pn_Cmp_Gt, /**< greater or equal */
+ pn_Cmp_Lg = pn_Cmp_Lt|pn_Cmp_Gt, /**< less or greater */
+ pn_Cmp_Leg = pn_Cmp_Lt|pn_Cmp_Eq|pn_Cmp_Gt, /**< less, equal or greater = ordered */
+ pn_Cmp_Uo = 8, /**< unordered */
+ pn_Cmp_Ue = pn_Cmp_Uo|pn_Cmp_Eq, /**< unordered or equal */
+ pn_Cmp_Ul = pn_Cmp_Uo|pn_Cmp_Lt, /**< unordered or less */
+ pn_Cmp_Ule = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Lt, /**< unordered, less or equal */
+ pn_Cmp_Ug = pn_Cmp_Uo|pn_Cmp_Gt, /**< unordered or greater */
+ pn_Cmp_Uge = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Gt, /**< unordered, greater or equal */
+ pn_Cmp_Ne = pn_Cmp_Uo|pn_Cmp_Lt|pn_Cmp_Gt, /**< 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 */
+
+const char *get_pnc_string(int pnc);
+int get_negated_pnc(int pnc);
+ir_node *get_Cmp_left (ir_node *node);
+void set_Cmp_left (ir_node *node, ir_node *left);
+ir_node *get_Cmp_right (ir_node *node);
+void set_Cmp_right (ir_node *node, ir_node *right);
+
+ir_node *get_Shl_left (ir_node *node);
+void set_Shl_left (ir_node *node, ir_node *left);
+ir_node *get_Shl_right (ir_node *node);
+void set_Shl_right (ir_node *node, ir_node *right);
+
+ir_node *get_Shr_left (ir_node *node);
+void set_Shr_left (ir_node *node, ir_node *left);
+ir_node *get_Shr_right (ir_node *node);
+void set_Shr_right (ir_node *node, ir_node *right);
+
+ir_node *get_Shrs_left (ir_node *node);
+void set_Shrs_left (ir_node *node, ir_node *left);
+ir_node *get_Shrs_right (ir_node *node);
+void set_Shrs_right (ir_node *node, ir_node *right);
+
+ir_node *get_Rot_left (ir_node *node);
+void set_Rot_left (ir_node *node, ir_node *left);
+ir_node *get_Rot_right (ir_node *node);
+void set_Rot_right (ir_node *node, ir_node *right);
+
+ir_node *get_Conv_op (ir_node *node);
+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 initialize 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.
+ */
+ir_node *get_Cast_op (ir_node *node);
+void set_Cast_op (ir_node *node, ir_node *op);
+type *get_Cast_type (ir_node *node);
+void set_Cast_type (ir_node *node, type *to_tp);
+
+/** Returns true if n is Phi or Filter in interprocedural_view.
+ Returns false if irg in phase building and the Phi has zero
+ predecessors: it's a Phi0. */
+int is_Phi (const ir_node *n);
+/** Returns true if irg in phase building and the Phi has zero
+ predecessors: it's a Phi0. */
+int is_Phi0 (const ir_node *n);
+/* These routines also work for Filter nodes in interprocedural view. */
+ir_node **get_Phi_preds_arr (ir_node *node);
+int get_Phi_n_preds (ir_node *node);
+ir_node *get_Phi_pred (ir_node *node, int pos);
+void set_Phi_pred (ir_node *node, int pos, ir_node *pred);
+
+ir_node *get_Filter_pred(ir_node *node);
+void set_Filter_pred(ir_node *node, ir_node *pred);
+long get_Filter_proj(ir_node *node);
+void set_Filter_proj(ir_node *node, long proj);
+/* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
+ * @@@ Maybe better: arity is zero if no cg preds. */
+void set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
+void set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
+int get_Filter_n_cg_preds(ir_node *node);
+ir_node *get_Filter_cg_pred(ir_node *node, int pos);
+
+/** Return true if parameter is a memory operation.
+ *
+ * A memory operation is an operation that changes the
+ * memory. I.e., a Load or a Store operation.
+ */
+int is_memop(ir_node *node);
+ir_node *get_memop_mem (ir_node *node);
+void set_memop_mem (ir_node *node, ir_node *mem);
+ir_node *get_memop_ptr (ir_node *node);
+void set_memop_ptr (ir_node *node, ir_node *ptr);
+
+/**
+ * Projection numbers for Load: use for Proj nodes!
+ */
+typedef enum {
+ pn_Load_M, /**< Memory result. */
+ pn_Load_X_except, /**< Execution result if exception occurred. */
+ pn_Load_res, /**< Result of load operation. */
+ pn_Load_max /**< number of projections from a Load */
+} pn_Load; /* Projection numbers for Load. */
+
+ir_node *get_Load_mem (ir_node *node);
+void set_Load_mem (ir_node *node, ir_node *mem);
+ir_node *get_Load_ptr (ir_node *node);
+void set_Load_ptr (ir_node *node, ir_node *ptr);
+ir_mode *get_Load_mode (ir_node *node);
+void set_Load_mode (ir_node *node, ir_mode *mode);
+ent_volatility get_Load_volatility (ir_node *node);
+void set_Load_volatility (ir_node *node, ent_volatility volatility);
+
+/**
+ * Projection numbers for Store: use for Proj nodes!
+ */
+typedef enum {
+ pn_Store_M, /**< Memory result. */
+ pn_Store_X_except, /**< Execution result if exception occurred. */
+ pn_Store_max /**< number of projections from a Store */
+} pn_Store; /* Projection numbers for Store. */
+
+ir_node *get_Store_mem (ir_node *node);
+void set_Store_mem (ir_node *node, ir_node *mem);
+ir_node *get_Store_ptr (ir_node *node);
+void set_Store_ptr (ir_node *node, ir_node *ptr);
+ir_node *get_Store_value (ir_node *node);
+void set_Store_value (ir_node *node, ir_node *value);
+ent_volatility get_Store_volatility (ir_node *node);
+void set_Store_volatility (ir_node *node, ent_volatility volatility);
+
+/**
+ * Projection numbers for Alloc: use for Proj nodes!
+ */
+typedef enum {
+ pn_Alloc_M, /**< Memory result. */
+ pn_Alloc_X_except, /**< Execution result if exception occurred. */
+ pn_Alloc_res, /**< Result of allocation. */
+ pn_Alloc_max /**< number of projections from an Alloc */
+} pn_Alloc; /* Projection numbers for Alloc. */
+
+ir_node *get_Alloc_mem (ir_node *node);
+void set_Alloc_mem (ir_node *node, ir_node *mem);
+ir_node *get_Alloc_size (ir_node *node);
+void set_Alloc_size (ir_node *node, ir_node *size);
+type *get_Alloc_type (ir_node *node);
+void set_Alloc_type (ir_node *node, type *tp);
+
+/** The allocation place. */
+typedef enum {
+ stack_alloc, /**< Alloc allocates the object on the stack. */
+ heap_alloc /**< Alloc allocates the object on the heap. */
+} where_alloc;
+
+where_alloc get_Alloc_where (ir_node *node);
+void set_Alloc_where (ir_node *node, where_alloc where);
+
+ir_node *get_Free_mem (ir_node *node);
+void set_Free_mem (ir_node *node, ir_node *mem);
+ir_node *get_Free_ptr (ir_node *node);
+void set_Free_ptr (ir_node *node, ir_node *ptr);
+ir_node *get_Free_size (ir_node *node);
+void set_Free_size (ir_node *node, ir_node *size);
+type *get_Free_type (ir_node *node);
+void set_Free_type (ir_node *node, type *tp);
+
+where_alloc get_Free_where (ir_node *node);
+void set_Free_where (ir_node *node, where_alloc where);
+
+ir_node **get_Sync_preds_arr (ir_node *node);
+int get_Sync_n_preds (ir_node *node);
+ir_node *get_Sync_pred (ir_node *node, int pos);
+void set_Sync_pred (ir_node *node, int pos, ir_node *pred);
+
+ir_node *get_Proj_pred (ir_node *node);
+void set_Proj_pred (ir_node *node, ir_node *pred);
+long get_Proj_proj (ir_node *node);
+void set_Proj_proj (ir_node *node, long proj);
+
+ir_node **get_Tuple_preds_arr (ir_node *node);
+int get_Tuple_n_preds (ir_node *node);
+ir_node *get_Tuple_pred (ir_node *node, int pos);
+void set_Tuple_pred (ir_node *node, int pos, ir_node *pred);
+
+ir_node *get_Id_pred (ir_node *node);
+void set_Id_pred (ir_node *node, ir_node *pred);
+
+/** Confirm has a single result and returns 'value' unchanged.
+ * The node expresses a restriction on 'value':
+ * 'value' 'cmp' 'bound' == true. */
+ir_node *get_Confirm_value (ir_node *node);
+void set_Confirm_value (ir_node *node, ir_node *value);
+ir_node *get_Confirm_bound (ir_node *node);
+void set_Confirm_bound (ir_node *node, ir_node *bound);
+pn_Cmp get_Confirm_cmp (ir_node *node);
+void set_Confirm_cmp (ir_node *node, pn_Cmp cmp);
+
+ir_node *get_Mux_sel (ir_node *node);
+void set_Mux_sel (ir_node *node, ir_node *sel);
+ir_node *get_Mux_false (ir_node *node);
+void set_Mux_false (ir_node *node, ir_node *ir_false);
+ir_node *get_Mux_true (ir_node *node);
+void set_Mux_true (ir_node *node, ir_node *ir_true);
/*
*/
/** returns operand of node if node is a Proj. */
-INLINE ir_node *skip_Proj (ir_node *node);
+ir_node *skip_Proj (ir_node *node);
/** returns operand of node if node is a Id */
-INLINE ir_node *skip_nop (ir_node *node);
-INLINE ir_node *skip_Id (ir_node *node); /* Same as skip_nop. */
+ir_node *skip_Id (ir_node *node); /* Same as skip_nop. */
/* returns corresponding operand of Tuple if node is a Proj from
a Tuple. */
-INLINE ir_node *skip_Tuple (ir_node *node);
+ir_node *skip_Tuple (ir_node *node);
+/** returns operand of node if node is a Cast */
+ir_node *skip_Cast (ir_node *node);
/** returns true if node is a Bad node. */
-INLINE int is_Bad (ir_node *node);
+int is_Bad (const ir_node *node);
/** returns true if the node is not a Block */
-INLINE int is_no_Block (ir_node *node);
+int is_no_Block (const ir_node *node);
/** returns true if the node is a Block */
-INLINE int is_Block (ir_node *node);
+int is_Block (const ir_node *node);
+/** returns true if node is a Unknown node. */
+int is_Unknown (const ir_node *node);
/** returns true if node is a Proj node or a Filter node in
* intraprocedural view */
-INLINE int is_Proj (ir_node *node);
+int is_Proj (const ir_node *node);
/** Returns true if the operation manipulates control flow:
Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
-int is_cfop(ir_node *node);
+int is_cfop(const ir_node *node);
/** Returns true if the operation manipulates interprocedural control flow:
- CallBegin, EndReg, EndExcept */
-int is_ip_cfop(ir_node *node);
+ CallBegin, EndReg, EndExcept */
+int is_ip_cfop(const ir_node *node);
/** Returns true if the operation can change the control flow because
- of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
- Bad. */
-ir_graph *get_ip_cfop_irg(ir_node *n);
-
-int is_fragile_op(ir_node *node);
+ of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
+ Bad. Raise is not fragile, but a unconditional jump. */
+int is_fragile_op(const ir_node *node);
/** Returns the memory operand of fragile operations. */
ir_node *get_fragile_op_mem(ir_node *node);
+/** Returns true if the operation is a forking control flow
+ * operation: Cond. */
+int is_forking_op(const ir_node *node);
-#include "ident.h"
+/**
+ * Access custom node data.
+ * The data must have been registered with
+ * register_additional_node_data() before.
+ * @param node The ir node to get the data from.
+ * @param type The type of the data you registered.
+ * @param off The value returned by register_additional_node_data().
+ * @return A pointer of type @p type.
+ */
+#define get_irn_data(node,type,off) \
+ (assert(off > 0 && "Invalid node data offset"), (type *) ((char *) (node) - (off)))
-/*@{*/
-/** Makros for debugging the libfirm */
-#ifdef __GNUC__
-/*
- * GNU C has the __FUNCTION__ extension
+/**
+ * Get the pointer to the node some custom data belongs to.
+ * @param data The pointer to the custom data.
+ * @param off The number as returned by register_additional_node_data().
+ * @return A pointer to the ir node the custom data belongs to.
+ */
+#define get_irn_data_base(data,off) \
+ (assert(off > 0 && "Invalid node data offset"), (ir_node *) ((char *) (data) + (off)))
+
+/**
+ * Request additional data to be allocated with an ir node.
+ * @param size The size of the additional data required.
+ * @return A positive number, if the operation was successful, which
+ * must be passed to the access macro get_irn_data(), 0 if the
+ * registration failed.
*/
-#define DDMSG printf("%s(l.%i)\n", __FUNCTION__, __LINE__)
-#define DDMSG1(X) printf("%s(l.%i) %s\n", __FUNCTION__, __LINE__, id_to_str(get_irn_opident(X)))
-#define DDMSG2(X) printf("%s(l.%i) %s%s: %ld\n", __FUNCTION__, __LINE__, id_to_str(get_irn_opident(X)), id_to_str(get_irn_modeident(X)), get_irn_node_nr(X))
-#define DDMSG3(X) printf("%s(l.%i) %s: %p\n", __FUNCTION__, __LINE__, print_firm_kind(X), (X))
-#define DDMSG4(X) xprintf("%s(l.%i) %I %I: %p\n", __FUNCTION__, __LINE__, get_type_tpop_nameid(X), get_type_ident(X), (X))
-#define DDMSG5(X) printf("%s%s: %ld", id_to_str(get_irn_opident(X)), id_to_str(get_irn_modeident(X)), get_irn_node_nr(X))
+unsigned register_additional_node_data(unsigned size);
-#define DDMN(X) xprintf("%s(l.%i) %I%I: %ld (%p)\n", __FUNCTION__, __LINE__, get_irn_opident(X), get_irn_modeident(X), get_irn_node_nr(X), (X))
-#define DDMNB(X) xprintf("%I%I: %ld (in block %ld)\n", get_irn_opident(X), get_irn_modeident(X), get_irn_node_nr(X), get_irn_node_nr(get_nodes_Block(X)))
-#define DDMT(X) xprintf("%s(l.%i) %I %I: %p\n", __FUNCTION__, __LINE__, get_type_tpop_nameid(X), get_type_ident(X), (X))
-#define DDME(X) xprintf("%s(l.%i) %I: %p\n", __FUNCTION__, __LINE__, get_entity_ident(X), (X))
-#define DDMEO(X) xprintf("%s(l.%i) %I (own: %I): %p\n", __FUNCTION__, __LINE__, get_entity_ident(X), get_type_ident(get_entity_owner(X)), (X))
-#define DDMG(X) xprintf("%s(l.%i) %I: %p\n", __FUNCTION__, __LINE__, get_irg_ent(get_entity_ident(X)), (X))
+/*-----------------------------------------------------------------*/
+/** Debug aides **/
+/*-----------------------------------------------------------------*/
-#else
-/*
- * use Filename instead
- */
-#define DDMSG printf("%s(l.%i)\n", __FILE__, __LINE__)
-#define DDMSG1(X) printf("%s(l.%i) %s\n", __FILE__, __LINE__, id_to_str(get_irn_opident(X)))
-#define DDMSG2(X) printf("%s(l.%i) %s%s: %ld\n", __FILE__, __LINE__, id_to_str(get_irn_opident(X)), id_to_str(get_irn_modeident(X)), get_irn_node_nr(X))
-#define DDMSG3(X) printf("%s(l.%i) %s: %p\n", __FILE__, __LINE__, print_firm_kind(X), (X))
-#define DDMSG4(X) xprintf("%s(l.%i) %I %I: %p\n", __FILE__, __LINE__, get_type_tpop_nameid(X), get_type_ident(X), (X))
-#define DDMSG5(X) printf("%s%s: %ld", id_to_str(get_irn_opident(X)), id_to_str(get_irn_modeident(X)), get_irn_node_nr(X))
+/** Debug print the node.
+ *
+ * Writes the node, all its attributes and the predecessors to stdout if DEBUG_libfirm
+ * is set. Else does nothing. */
+void dump_irn(ir_node *n);
-#define DDMN(X) xprintf("%s(l.%i) %I%I: %ld (%p)\n", __FILE__, __LINE__, get_irn_opident(X), get_irn_modeident(X), get_irn_node_nr(X), (X))
-#define DDMNB(X) xprintf("%I%I: %ld (in block %ld)\n", get_irn_opident(X), get_irn_modeident(X), get_irn_node_nr(X), get_irn_node_nr(get_nodes_Block(X)))
-#define DDMT(X) xprintf("%s(l.%i) %I %I: %p\n", __FILE__, __LINE__, get_type_tpop_nameid(X), get_type_ident(X), (X))
-#define DDME(X) xprintf("%s(l.%i) %I: %p\n", __FILE__, __LINE__, get_entity_ident(X), (X))
-#define DDMG(X) xprintf("%s(l.%i) %I: %p\n", __FILE__, __LINE__, get_irg_ent(get_entity_ident(X)), (X))
-#define DDMI(X) xprintf("%s(l.%i) %I: %p\n", __FILE__, __LINE__, (X), (X))
+#include "ident.h"
-#endif /* __GNUC__ */
-/*@}*/
+#ifdef __GNUC__
+/* GNU C has the __FUNCTION__ extension */
+#define __MYFUNC__ __FUNCTION__
+#else
+/* use Filename instead */
+#define __MYFUNC__ __FILE__
+#endif
+/* !!!!!!!!! @@@
+ Don't format with "\", firmjni gets problems */
+/** Output location */
+#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), (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), (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), (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), (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), (void *)(X))
+/** Output information about a graph */
+#define DDMG(X) printf("%s(l.%i) graph %s: %ld (%p) in %s %s.\n", __MYFUNC__, __LINE__, get_entity_name(get_irg_entity(X)), get_irg_graph_nr(X), (void *)(X), get_type_tpop_name(get_entity_owner(get_irg_entity(X))), get_type_name(get_entity_owner(get_irg_entity(X))))
+/** Output information about an ident */
+#define DDMI(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, get_id_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), (void *)(X))
+/** Output information about a loop */
+#define DDML(X) printf("%s(l.%i) loop with depth %d: %d\n", __MYFUNC__, __LINE__, get_loop_depth(X), get_loop_loop_nr(X))
+/** Output information about a tarVal */
+#define DDMV(X) printf("%s(l.%i) tarval: ",__MYFUNC__, __LINE__); tarval_printf(X); printf(" (%p)\n", (void *)(X));
+
+/*@}*/ /* end of ir_node group definition */
+
+
+#ifdef __cplusplus
+}
+#endif
# endif /* _IRNODE_H_ */
projects / libfirm / blobdiff