-/* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
-** All rights reserved.
-**
-** Authors: Martin Trapp, Christian Schaefer
-**
-** declarations of an ir node
-*/
+/*
+ * 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.
+ */
# ifndef _IRNODE_H_
# define _IRNODE_H_
+/**
+ * Projection numbers of compare: use for Proj nodes!
+ * @remark there are numbers with normalized names below!
+ */
+typedef enum {
+ False = 0, /**< false */
+ Eq, /**< equal */
+ Lt, /**< less */
+ Le, /**< less or equal */
+ Gt, /**< greater */
+ Ge, /**< greater or equal */
+ Lg, /**< less or greater */
+ Leg = 7, /**< 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 = 15 /**< true */
+ /* not_mask = Leg*/ /* bits to flip to negate comparison * @@ hack for jni interface */
+} pnc_number; /* pnc: Projection Number Cmp */
+#define not_mask Leg
+
+# include "tv.h"
# include "irgraph.h"
# include "entity.h"
-# include "common.h"
+# include "firm_common.h"
# include "irop.h"
# include "irmode.h"
-# include "tv.h"
# include "type.h"
+# include "dbginfo.h"
+/* # include "exc.h" */
+
+/**
+ * @file irnode.h
+ *
+ * @author Martin Trapp, Christian Schaefer
+ *
+ * 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
+ *
+ * ir_node - a datatype representing a Firm node
+ *
+ * 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.
+ * @{
+ */
-
-/** Global flags. Set these by autoconf?? **/
-/* If this is defined debuging aids are created, e.g. a field in
- ir_node uniquely numbering the nodes. */
-/* @@@???? this is also set in firm.h */
-#define DEBUG_libfirm
-#ifdef DEBUG_libfirm
-#include "irprog.h"
-#endif
-
-/* projection numbers of compare. */
-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 */
-} pnc_number;
-
-inline char *
-get_pnc_string(int pnc);
-
-int
-get_negated_pnc(int pnc);
-
-
-/* projection numbers for result of Start node. */
-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;
-
-/** ir node attributes **/
-/* Block attributes */
-typedef struct {
- unsigned long block_visited; /* for the walker that walks over all blocks. */
- /* Attributes private to construction: */
- bool matured; /* if set, all in-nodes of the block are fixed */
- struct ir_node **graph_arr; /* array to store all parameters */
-} block_attr;
-
-/* SymConst attributes */
-/* 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. */
-typedef enum {
- type_tag, /* The SymConst is a type tag for the given type.
- Type_or_id is type */
- size, /* The SymConst is the size of the given type.
- Type_or_id is type */
- linkage_ptr_info /* The SymConst is a symbolic pointer to be filled in
- by the linker. Type_or_id is ident */
-} symconst_kind;
-
-/* This union contains the symbolic information represented by the node */
-typedef union {
- type *typ;
- ident *ptrinfo;
-} type_or_id;
-
-typedef struct {
- type_or_id tori;
- symconst_kind num;
-} symconst_attr;
-
-/* Sel attributes */
-typedef enum {
- static_linkage, /* entity is used internal and not visible out of this
- file/class. */
- external_linkage, /* */
- no_linkage
-} linkage_type;
-
-typedef struct {
- entity *ent; /* entity to select */
- linkage_type ltyp; /* linkage type of the entity */
-} sel_attr;
-
-/* Alloc attributes */
-typedef enum {
- stack_alloc, /* Alloc allocates the object on the stack. */
- heap_alloc /* Alloc allocates the object on the heap. */
-} where_alloc;
-
-typedef struct {
- type *type; /* Type of the allocated object. */
- where_alloc where; /* stack, heap or other managed part of memory */
-} alloc_attr;
-
-/* Some irnodes just have one attribute, these are stored here,
- some have more. Their name is 'irnodename_attr' */
-typedef union {
- block_attr block; /* For Block: Fields needed to construct it */
- struct tarval *con; /* For Const: contains the value of the constant */
- symconst_attr i; /* For SymConst. */
- sel_attr s; /* For Sel. */
- type_method *call; /* For Call: pointer to the type of the method to call */
- long proj; /* For Proj: contains the result position to project */
- alloc_attr a; /* For Alloc. */
- type *f; /* For Free. */
- int phi0_pos; /* For Phi. Used to remember the value defined by
- this Phi node. Needed when the Phi is completed
- to call get_r_internal_value to find the
- predecessors. If this attribute is set, the Phi
- node takes the role of the obsolete Phi0 node,
- therefore the name. */
-} attr;
-
-
-/* common structure of an irnode */
-/* if the node has some attributes, they are stored in attr */
-
-struct ir_node {
- firm_kind kind; /* distinguishes this node from others */
- ir_op *op; /* Opcode of this node. */
- ir_mode *mode; /* Mode of this node. */
- unsigned long visited; /* visited counter for walks of the graph */
- struct ir_node **in; /* array with predecessors / operands */
- struct ir_node *link; /* for linking nodes somehow to a list, e.g.
- used while construction to link Phi0 nodes and
- during optimization to link to nodes that
- shall replace a node. */
-#ifdef DEBUG_libfirm
- int node_nr; /* a unique node number for each node to make output
- readable. */
-#endif
- attr attr; /* attribute of this node. Depends on opcode. */
- /* Must be last field of struct ir_node. */
-};
-
-
-/* The typedefiniton of ir_node is also in irgraph.h to resolve
- recursion between irnode.h and irgraph.h */
#ifndef _IR_NODE_TYPEDEF_
#define _IR_NODE_TYPEDEF_
typedef struct ir_node ir_node;
#endif
-/* 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. */
-
-inline ir_node *
-new_ir_node (ir_graph *irg,
- ir_node *block,
- ir_op *op,
- ir_mode *mode,
- int arity,
- ir_node **in);
-
-
-/* Print IR-Nodes with attributes */
-/* @@@@ brauchen wir dienoch? dann fliegt ev. das xprint raus?*/
-int ir_node_print (XP_PAR1, const xprintf_info *, XP_PARN);
-
-
-/** manipulate the fields of ir_node **/
-
-/* returns the number of predecessors without the block predecessor: */
-int get_irn_arity (ir_node *node);
-/* returns the array with the ins: */
-inline ir_node **get_irn_in (ir_node *node);
+/**
+ * you can work on the graph without considering the different types
+ * of nodes, it's just a big graph.
+ */
+
+/**
+ * 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 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. */
+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 includind the Block predecessor iterate from i = -1 to
+ to iterate including the Block predecessor iterate from i = -1 to
i < get_irn_arity. */
/* Access predecessor n */
-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_modename (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_opname (ir_node *node);
-inline void set_irn_visited (ir_node *node, unsigned long visited);
-inline unsigned long get_irn_visited (ir_node *node);
-inline void set_irn_link (ir_node *node, ir_node *link);
-inline ir_node *get_irn_link (ir_node *node);
-
-#ifdef DEBUG_libfirm
-/* Outputs a unique number for this node */
-inline long get_irn_node_nr(ir_node *node);
-#endif
-/** access attributes directly **/
-inline tarval *get_irn_const_attr (ir_node *node);
-inline long get_irn_proj_attr (ir_node *node);
-inline alloc_attr get_irn_alloc_attr (ir_node *node);
-inline type *get_irn_free_attr (ir_node *node);
-inline symconst_attr get_irn_symconst_attr (ir_node *node);
-type_method *get_irn_call_attr (ir_node *node);
-sel_attr get_irn_sel_attr (ir_node *node);
-int get_irn_phi_attr (ir_node *node);
-block_attr get_irn_return_attr (ir_node *node);
-
-/** manipulate fields of individual nodes **/
-
-/* 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);
-inline ir_node **get_Block_cfgpred_arr (ir_node *node);
+/**
+ * Get the n-th predecessor of a node.
+ * This function removes Id predecessors.
+ */
+ir_node *get_irn_n (ir_node *node, int n);
+ir_node *get_irn_intra_n (ir_node *node, int n);
+ir_node *get_irn_inter_n (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 pinned (irg is only stored in the block. */
+ir_graph *get_irn_irg (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);
+
+
+/**
+ * irnode constructor.
+ * Create a new irnode in irg, with an op, mode, arity and
+ * some incoming irnodes.
+ * 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.
+ */
+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[]);
+
+/*
+ *
+ * NAME access functions for node fields.
+ *
+ * Not properly documented ;-)
+ *
+ */
+
+/** This works for all except Block. 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. */
+#define get_nodes_block get_nodes_Block
+ir_node *get_nodes_Block (ir_node *node);
+#define set_nodes_block set_nodes_Block
+void set_nodes_Block (ir_node *node, ir_node *block);
+
+/**
+ * @function get_irn_block
+ * @see get_nodes_block()
+ */
+
+/**
+ * Projection numbers for result of Start node: use for Proj nodes!
+ */
+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. */
+
+/**
+ * Projection numbers for result of Start node: use for Proj nodes!
+ * @remark This is the old name convention, don't use anymore.
+ */
+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_value_arg_base /**< Pointer to region of compound value arguments as defined by
+ type of this method. */
+} pns_number; /* pns: Projection Number 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 */
+ir_node **get_Block_cfgpred_arr (ir_node *node);
int get_Block_n_cfgpreds (ir_node *node);
-/* inline void set_Block_n_cfgpreds (ir_node *node, int n_preds); */
-
-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);
-inline ir_node *get_Block_graph_arr (ir_node *node, int pos);
-inline void set_Block_graph_arr (ir_node *node, int pos, ir_node *value);
-
-inline ir_node *get_Cond_selector (ir_node *node);
-inline void set_Cond_selector (ir_node *node, ir_node *selector);
-
-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_res (ir_node *node);
-/*inline void set_Return_n_res (ir_node *node, int results); */
-inline ir_node *get_Return_res (ir_node *node, int pos);
-inline void set_Return_res (ir_node *node, int pos, ir_node *res);
-
-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);
-
-inline tarval *get_Const_tarval (ir_node *node);
-inline void set_Const_tarval (ir_node *node, tarval *con);
-
-inline symconst_kind get_SymConst_kind (ir_node *node);
-inline void set_SymConst_kind (ir_node *node, symconst_kind num);
-inline type *get_SymConst_type (ir_node *node);
-inline void set_SymConst_type (ir_node *node, type *type);
-inline ident *get_SymConst_ptrinfo (ir_node *node);
-inline void set_SymConst_ptrinfo (ir_node *node, ident *ptrinfo);
-
-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_index (ir_node *node);
-/*inline void set_Sel_n_index (ir_node *node, int n_index); */
-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);
-inline linkage_type get_Sel_linkage_type (ir_node *node);
-inline void set_Sel_linkage_type (ir_node *node, linkage_type lt);
-
-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_arity (ir_node *node);
-/* inline void set_Call_arity (ir_node *node, ir_node *arity); */
-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_method *get_Call_type (ir_node *node);
-inline void set_Call_type (ir_node *node, type_method *type);
+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);
+/* For this current_ir_graph must be set. */
+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);
+/* @@@ not supported */
+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);
+ir_node *get_Block_cg_cfgpred(ir_node * node, int pos);
+/* frees the memory. */
+void remove_Block_cg_cfgpred_arr(ir_node * node);
+
+/* Start references the irg it is in.
+ @@@ old -- use get_irn_irg instead! */
+ir_graph *get_Start_irg(ir_node *node);
+
+int get_End_n_keepalives(ir_node *end);
+ir_node *get_End_keepalive(ir_node *end, int pos);
+void add_End_keepalive (ir_node *end, ir_node *ka);
+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. */
+void free_End (ir_node *end);
+
+/* @@@ old -- use get_irn_irg instead! */
+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.
+ First we distinguish binary Conds and switch Conds.
+ A binary Cond has as selector a boolean value. Proj(0) projects the control
+ flow for case "False", Proj(1) the control flow for "True". A binary Cond
+ is recognized by the boolean selector.
+ The switch Cond has as selector an unsigned integer. It produces as result
+ an n+1 Tuple (cf0, ... , cfn) of control flows.
+ 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 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
+ exist.) This Cond we call "fragmentary". There is a special constructor
+ new_defaultProj that automatically sets the flavor.
+ The two switch flavors are distinguished by a flag of type cond_kind.
+ Default flavor is "dense"
+*/
+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). */
+} cond_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; /* 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; /* Projection numbers for Raise. */
+
+tarval *get_Const_tarval (ir_node *node);
+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. */
+type *get_Const_type (ir_node *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_kind;
+
+typedef union type_or_id * type_or_id_p;
+symconst_kind get_SymConst_kind (const ir_node *node);
+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 linkage_ptr_info. Else assertion: */
+ident *get_SymConst_ptrinfo (ir_node *node);
+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. */
+type_or_id_p get_SymConst_type_or_id (ir_node *node);
+void set_SymConst_type_or_id (ir_node *node, type_or_id_p tori);
+
+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!
+ *
+ * @remark 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 */
+
+/**
+ * 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; /* 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-analysis.
+ The array is only accessible if information is valid.
+ It contains NULL for called methods that are not within
+ the compilation unit. */
+int Call_has_callees (ir_node *node);
+int get_Call_n_callees (ir_node * node);
+entity *get_Call_callee (ir_node * node, int pos);
+/* assumes current_ir_graph set properly! */
+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);
+/* @@@ old -- use get_irn_irg instead! */
+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_FuncCall_ptr (ir_node *node);
+void set_FuncCall_ptr (ir_node *node, ir_node *ptr);
+ir_node **get_FuncCall_param_arr (ir_node *node);
+/** Gets the number of parameters of a func call. */
+int get_FuncCall_n_params (ir_node *node);
+/** Gets the func call parameter at position pos. */
+ir_node *get_FuncCall_param (ir_node *node, int pos);
+/** Sets the func call parameter at position pos. */
+void set_FuncCall_param (ir_node *node, int pos, ir_node *param);
+/** Gets the type of a func call. */
+type *get_FuncCall_type (ir_node *node);
+/** Sets the type of a func call. */
+void set_FuncCall_type (ir_node *node, type *tp);
+/** Gets the arity of a func call. Identical to get_FuncCall_n_params(). */
+int get_FuncCall_arity (ir_node *node);
+
+/* Set, get and remove the callee-analysis.
+ The array is only accessible if information is valid.
+ It contains NULL for called methods that are not within
+ the compilation unit. */
+int FuncCall_has_callees (ir_node *node);
+int get_FuncCall_n_callees (ir_node * node);
+entity *get_FuncCall_callee (ir_node * node, int pos);
+/* assumes current_ir_graph set properly! */
+void set_FuncCall_callee_arr (ir_node * node, int n, entity ** arr);
+void remove_FuncCall_callee_arr(ir_node * node);
/* 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);
-
-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 void set_Phi_n_preds (ir_node *node, int n_preds); */
-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_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 *type);
-inline where_alloc get_Alloc_where (ir_node *node);
-inline void set_Alloc_where (ir_node *node, where_alloc where);
-
-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 *type);
-
-inline ir_node **get_Sync_preds_arr (ir_node *node);
-inline int get_Sync_n_preds (ir_node *node);
-/* inline void set_Sync_n_preds (ir_node *node, int n_preds); */
-inline ir_node *get_Sync_pred (ir_node *node, int pos);
-inline void set_Sync_pred (ir_node *node, int pos, ir_node *pred);
-
-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);
-
-inline ir_node **get_Tuple_preds_arr (ir_node *node);
-inline int get_Tuple_n_preds (ir_node *node);
-/* inline void set_Tuple_n_preds (ir_node *node, int n_preds); */
-inline ir_node *get_Tuple_pred (ir_node *node, int pos);
-inline void set_Tuple_pred (ir_node *node, int pos, ir_node *pred);
-
-inline ir_node *get_Id_pred (ir_node *node);
-inline void set_Id_pred (ir_node *node, ir_node *pred);
-
-
-
-/******************************************************************/
-/* Auxiliary routines */
-/******************************************************************/
-
-/* returns operand of node if node is a Proj. */
-inline ir_node *skip_Proj (ir_node *node);
-/* returns operand of node if node is a Id */
-inline ir_node *skip_nop (ir_node *node);
-/* returns true if node is a Bad node. */
-inline int is_Bad (ir_node *node);
-/* returns true if the node is not a Block */
-inline int is_no_Block (ir_node *node);
-/* Returns true if the operation manipulates control flow:
- Start, End, Jmp, Cond, Return, Raise */
+int is_unop (ir_node *node);
+ir_node *get_unop_op (ir_node *node);
+void set_unop_op (ir_node *node, ir_node *op);
+int is_binop (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 {
+ pn_Quot_M, /**< Memory result. */
+ pn_Quot_X_except, /**< Execution result if exception occured. */
+ pn_Quot_res /**< Result of computation. */
+} 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 {
+ pn_DivMod_M, /**< Memory result. */
+ pn_DivMod_X_except, /**< Execution result if exception occured. */
+ pn_DivMod_res_div, /**< Result of computation a / b. */
+ pn_DivMod_res_mod /**< Result of computation a % b. */
+} 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);
+
+/**
+ * Projection numbers for Div: use for Proj nodes!
+ */
+typedef enum {
+ pn_Div_M, /**< Memory result. */
+ pn_Div_X_except, /**< Execution result if exception occured. */
+ 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);
+
+/**
+ * Projection numbers for Mod: use for Proj nodes!
+ */
+typedef enum {
+ pn_Mod_M, /**< Memory result. */
+ pn_Mod_X_except, /**< Execution result if exception occured. */
+ pn_Mod_res /**< Result of computation. */
+} pn_Mod; /* Projection numbers for Mod. */
+
+ir_node *get_Abs_op (ir_node *node);
+void set_Abs_op (ir_node *node, ir_node *op);
+
+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);
+
+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);
+
+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.
+ */
+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 */
+
+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 initialze 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. */
+int is_Phi (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);
+
+/**
+ * Projection numbers for Load: use for Proj nodes!
+ */
+typedef enum {
+ pn_Load_M, /**< Memory result. */
+ pn_Load_X_except, /**< Execution result if exception occured. */
+ pn_Load_res /**< Result of load operation. */
+} 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);
+
+/**
+ * Projection numbers for Store: use for Proj nodes!
+ */
+typedef enum {
+ pn_Store_M, /**< Memory result. */
+ pn_Store_X_except /**< Execution result if exception occured. */
+} 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);
+
+/**
+ * Projection numbers for Alloc: use for Proj nodes!
+ */
+typedef enum {
+ pn_Alloc_M, /**< Memory result. */
+ pn_Alloc_X_except, /**< Execution result if exception occured. */
+ pn_Alloc_res /**< Result of allocation. */
+} 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);
+
+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);
+/* Why long? shouldn't int be enough, and smaller? Or even byte? */
+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);
+
+/*
+ *
+ * NAME Auxiliary routines
+ *
+ * Not properly documented ;-)
+ *
+ */
+
+/** returns operand of node if node is a Proj. */
+ir_node *skip_Proj (ir_node *node);
+/** returns operand of node if node is a Id */
+ir_node *skip_nop (ir_node *node);
+ir_node *skip_Id (ir_node *node); /* Same as skip_nop. */
+/* returns corresponding operand of Tuple if node is a Proj from
+ a Tuple. */
+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. */
+int is_Bad (ir_node *node);
+/** returns true if the node is not a Block */
+int is_no_Block (ir_node *node);
+/** returns true if the node is a Block */
+int is_Block (ir_node *node);
+/** returns true if node is a Unknown node. */
+int is_Unknown (ir_node *node);
+/** returns true if node is a Proj node or a Filter node in
+ * intraprocedural view */
+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);
-/* Returns true if the operation can change the control flow because
- of an exception. */
-int is_fragile_op(ir_node *node);
+/* @@@ old -- use get_irn_irg instead! */
+ir_graph *get_ip_cfop_irg(ir_node *n);
+/** Returns true if the operation manipulates interprocedural control flow:
+ CallBegin, EndReg, EndExcept */
+int is_ip_cfop(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. */
+int is_fragile_op(ir_node *node);
+/** Returns the memory operand of fragile operations. */
+ir_node *get_fragile_op_mem(ir_node *node);
-/* Makros for debugging the libfirm */
-#ifdef DEBUG_libfirm
#include "ident.h"
-#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_opname(X)))
-#define DDMSG2(X) printf("%s(l.%i) %s: %ld\n", __FUNCTION__, __LINE__, \
- ID_TO_STR(get_irn_opname(X)), get_irn_node_nr(X))
-
+#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) %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), (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 */
+
+
# endif /* _IRNODE_H_ */
projects / libfirm / blobdiff