Create a new node with the right mode instead of changing the mode.
[libfirm] / include / libfirm / irgraph.h
index 6a348c2..8307504 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
+ * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
  *
  * This file is part of libFirm.
  *
 
 #include <stddef.h>
 
-#include "firm_config.h"
 #include "firm_types.h"
-#include "irop.h"
-#include "iropt.h"
-#include "irextbb.h"
-#include "typerep.h"
 
 /**
  * @page ir_graph   The struct ir_graph
@@ -131,8 +126,6 @@ void      set_current_ir_graph(ir_graph *graph);
  * (get_irn_*, set_irn_*) is influenced by this flag. */
 int get_interprocedural_view(void);
 void set_interprocedural_view(int state);
-#else
-#define get_interprocedural_view()  0
 #endif
 
 /**
@@ -173,7 +166,7 @@ void set_interprocedural_view(int state);
  *
  * @see new_pseudo_ir_graph()
  */
-ir_graph *new_ir_graph (ir_entity *ent, int n_loc);
+ir_graph *new_ir_graph(ir_entity *ent, int n_loc);
 
 /** Frees the passed irgraph.
  * Deallocates all nodes in this graph and the ir_graph structure.
@@ -183,7 +176,7 @@ ir_graph *new_ir_graph (ir_entity *ent, int n_loc);
  * Does not free types, entities or modes that are used only by this
  * graph, nor the entity standing for this graph.
  */
-void free_ir_graph (ir_graph *irg);
+void free_ir_graph(ir_graph *irg);
 
 /* --- access routines for all ir_graph attributes --- */
 
@@ -193,102 +186,113 @@ void free_ir_graph (ir_graph *irg);
  *   @param thing     an arbitrary pointer
  *
  *   @return
- *       true if the thing is a ir graph, else false
+ *       true if the thing is a IR graph, else false
  */
 int      is_ir_graph(const void *thing);
 
-/* #define get_irg_entity get_irg_ent */
-/* #define set_irg_entity set_irg_ent */
-ir_entity *get_irg_entity (const ir_graph *irg);
-void       set_irg_entity (ir_graph *irg, ir_entity *ent);
+/** Returns the entity of an IR graph. */
+ir_entity *get_irg_entity(const ir_graph *irg);
+/** Sets the entity of an IR graph. */
+void       set_irg_entity(ir_graph *irg, ir_entity *ent);
+
+/** Returns the frame type of an IR graph. */
+ir_type *get_irg_frame_type(ir_graph *irg);
+/** Sets the frame type of an IR graph. */
+void     set_irg_frame_type(ir_graph *irg, ir_type *ftp);
 
-ir_type *get_irg_frame_type (ir_graph *irg);
-void     set_irg_frame_type (ir_graph *irg, ir_type *ftp);
+/** Returns the value parameter type of an IR graph. */
+ir_type *get_irg_value_param_type(ir_graph *irg);
 
-ir_node *get_irg_start_block (const ir_graph *irg);
-void     set_irg_start_block (ir_graph *irg, ir_node *node);
+/** Returns the start block of an IR graph. */
+ir_node *get_irg_start_block(const ir_graph *irg);
+/** Sets the start block of an IR graph. */
+void     set_irg_start_block(ir_graph *irg, ir_node *node);
 
-ir_node *get_irg_start (const ir_graph *irg);
-void     set_irg_start (ir_graph *irg, ir_node *node);
+/** Returns the Start node of an IR graph. */
+ir_node *get_irg_start(const ir_graph *irg);
+/** Sets the Start node of an IR graph. */
+void     set_irg_start(ir_graph *irg, ir_node *node);
 
-ir_node *get_irg_end_block (const ir_graph *irg);
-void     set_irg_end_block (ir_graph *irg, ir_node *node);
+/** Returns the end block of an IR graph. */
+ir_node *get_irg_end_block(const ir_graph *irg);
+/** Sets the end block of an IR graph. */
+void     set_irg_end_block(ir_graph *irg, ir_node *node);
 
-ir_node *get_irg_end (const ir_graph *irg);
-void     set_irg_end (ir_graph *irg, ir_node *node);
+/** Returns the End node of an IR graph. */
+ir_node *get_irg_end(const ir_graph *irg);
+/** Sets the End node of an IR graph. */
+void     set_irg_end(ir_graph *irg, ir_node *node);
 
 /* The fields end_reg and end_except contain the end nodes of the
    interprocedural view.  If the view is not constructed they contain
    the normal end node. */
-ir_node *get_irg_end_reg (const ir_graph *irg);
-void     set_irg_end_reg (ir_graph *irg, ir_node *node);
-
-ir_node *get_irg_end_except (const ir_graph *irg);
-void     set_irg_end_except (ir_graph *irg, ir_node *node);
-
-/** Returns the node that represents the frame pointer. */
-ir_node *get_irg_frame (const ir_graph *irg);
-/** Sets the node that represents the frame pointer. */
-void     set_irg_frame (ir_graph *irg, ir_node *node);
-
-/** Returns the node that represents the global pointer. */
-ir_node *get_irg_globals (const ir_graph *irg);
-/** Sets the node that represents the global pointer. */
-void     set_irg_globals (ir_graph *irg, ir_node *node);
-
-/** Returns the node that represents the tls pointer. */
-ir_node *get_irg_tls (const ir_graph *irg);
-/** Sets the node that represents the tls pointer. */
-void     set_irg_tls (ir_graph *irg, ir_node *node);
-
-/** Returns the node that represents the initial memory. */
-ir_node *get_irg_initial_mem (const ir_graph *irg);
-/** Sets the node that represents the initial memory. */
-void     set_irg_initial_mem (ir_graph *irg, ir_node *node);
-
-/** Returns the node that represents the argument pointer. */
-ir_node *get_irg_args (const ir_graph *irg);
-/** Sets the node that represents the argument pointer. */
-void     set_irg_args (ir_graph *irg, ir_node *node);
-
-/** Returns the node that represents the value parameter base pointer. */
-ir_node *get_irg_value_param_base (const ir_graph *irg);
-/** Sets the node that represents the value parameter base pointer. */
-void     set_irg_value_param_base (ir_graph *irg, ir_node *node);
-
-/** Returns an array of the nodes of the argument pointer. */
-ir_node **get_irg_proj_args (const ir_graph *irg);
-/** Sets the array of the nodes of the argument pointer. */
-void     set_irg_proj_args (ir_graph *irg, ir_node **nodes);
-
-/** Returns the current block of a graph. */
-ir_node *get_irg_current_block (const ir_graph *irg);
-/** Sets the current block of a graph. */
-void     set_irg_current_block (ir_graph *irg, ir_node *node);
-
-/** Returns the Bad node.  Use new_Bad() instead!! */
-ir_node *get_irg_bad (const ir_graph *irg);
-void     set_irg_bad (ir_graph *irg, ir_node *node);
-
-/** Returns the NoMem node.  Use new_NoMem() instead!! */
-ir_node *get_irg_no_mem (const ir_graph *irg);
-void     set_irg_no_mem (ir_graph *irg, ir_node *node);
-
-/** Returns the number of value numbers of a graph. */
-int      get_irg_n_locs (ir_graph *irg);
-
-#ifdef DEBUG_libfirm
+ir_node *get_irg_end_reg(const ir_graph *irg);
+void     set_irg_end_reg(ir_graph *irg, ir_node *node);
+
+ir_node *get_irg_end_except(const ir_graph *irg);
+void     set_irg_end_except(ir_graph *irg, ir_node *node);
+
+/** Returns the node that represents the initial control flow of the given IR graph. */
+ir_node *get_irg_initial_exec(const ir_graph *irg);
+/** Sets the node that represents the initial control of the given IR graph. */
+void     set_irg_initial_exec(ir_graph *irg, ir_node *node);
+
+/** Returns the node that represents the frame pointer of the given IR graph. */
+ir_node *get_irg_frame(const ir_graph *irg);
+/** Sets the node that represents the frame pointer of the given IR graph. */
+void     set_irg_frame(ir_graph *irg, ir_node *node);
+
+/** Returns the node that represents the tls pointer of the given IR graph. */
+ir_node *get_irg_tls(const ir_graph *irg);
+/** Sets the node that represents the tls pointer of the given IR graph. */
+void     set_irg_tls(ir_graph *irg, ir_node *node);
+
+/** Returns the node that represents the initial memory of the given IR graph. */
+ir_node *get_irg_initial_mem(const ir_graph *irg);
+/** Sets the node that represents the initial memory of the given IR graph. */
+void     set_irg_initial_mem(ir_graph *irg, ir_node *node);
+
+/** Returns the node that represents the argument pointer of the given IR graph. */
+ir_node *get_irg_args(const ir_graph *irg);
+/** Sets the node that represents the argument pointer of the given IR graph. */
+void     set_irg_args(ir_graph *irg, ir_node *node);
+
+/** Returns the current block of an IR graph. */
+ir_node *get_irg_current_block(const ir_graph *irg);
+/** Sets the current block of an IR graph. */
+void     set_irg_current_block(ir_graph *irg, ir_node *node);
+
+/** Returns the Bad node of the given IR graph.  Use new_Bad() instead!! */
+ir_node *get_irg_bad(const ir_graph *irg);
+void     set_irg_bad(ir_graph *irg, ir_node *node);
+
+/** Returns the NoMem node of the given IR graph.  Use new_NoMem() instead!! */
+ir_node *get_irg_no_mem(const ir_graph *irg);
+void     set_irg_no_mem(ir_graph *irg, ir_node *node);
+
+/** Returns the number of value numbers of an IR graph. */
+int      get_irg_n_locs(ir_graph *irg);
+
 /** Returns the graph number. */
 long     get_irg_graph_nr(const ir_graph *irg);
-#endif
 
 /**
  * Returns the graph number. This is a unique number for the graph and is
  * smaller than get_irp_last_idx()
- * Note: you cannot use this number for get_irp_irg
+ * Note: you cannot use this number for get_irp_irg()
  */
 int get_irg_idx(const ir_graph *irg);
 
+/**
+ * Get the node for an index.
+ * @param irg The graph.
+ * @param idx The index you want the node for.
+ * @return    The node with that index or NULL, if there is no node with that index.
+ * @note      The node you got might be dead.
+ */
+ir_node *get_idx_irn(ir_graph *irg, unsigned idx);
+
+
 /********************************************************************************/
 /* States of an ir_graph.                                                       */
 /********************************************************************************/
@@ -322,12 +326,13 @@ typedef enum {
        phase_backend    /**< The graph is taken by the backend.  Machine specific nodes may be present. */
 } irg_phase_state;
 
-/** returns the phase_state of an IR graph. */
-irg_phase_state get_irg_phase_state (const ir_graph *irg);
+/** Returns the phase_state of an IR graph. */
+irg_phase_state get_irg_phase_state(const ir_graph *irg);
 
-/** sets the phase state of an IR graph. */
+/** Sets the phase state of an IR graph. */
 void set_irg_phase_state(ir_graph *irg, irg_phase_state state);
 
+/** Sets the phase of the given IR graph to low. */
 #define set_irg_phase_low(irg) set_irg_phase_state(irg, phase_low)
 
 /** state: op_pin_state_pinned
@@ -337,7 +342,7 @@ void set_irg_phase_state(ir_graph *irg, irg_phase_state state);
    invalid block, i.e., the block is not a dominator of all the uses of
    the node.
    The enum op_pin_state is defined in irop.h. */
-op_pin_state get_irg_pinned (const ir_graph *irg);
+op_pin_state get_irg_pinned(const ir_graph *irg);
 
 /** state: outs_state
  *  Outs are the back edges or def-use edges of ir nodes.
@@ -389,13 +394,10 @@ typedef enum {
        loopinfo_cf               = 4,       /**< Loop information constructed for control flow only. */
        loopinfo_inter            = 8,       /**< Loop information for interprocedural view. */
 
-       loopinfo_for_firmjni      = 16,      /**< A hack for firmjni:  all enums must differ as they
-                                                 are used in a switch. */
-
        /** IntRAprocedural loop information constructed and valid. */
-       loopinfo_consistent         = loopinfo_constructed | loopinfo_for_firmjni | loopinfo_valid,
+       loopinfo_consistent         = loopinfo_constructed | loopinfo_valid,
        /** IntRAprocedural loop information constructed and invalid. */
-       loopinfo_inconsistent       = loopinfo_constructed | loopinfo_for_firmjni,
+       loopinfo_inconsistent       = loopinfo_constructed,
 
        /** IntERprocedural loop information constructed and valid. */
        loopinfo_ip_consistent      = loopinfo_constructed | loopinfo_inter | loopinfo_valid,
@@ -440,18 +442,18 @@ typedef enum {
        irg_callee_info_inconsistent
 } irg_callee_info_state;
 
-/** returns the callee_info_state of an IR graph. */
+/** Returns the callee_info_state of an IR graph. */
 irg_callee_info_state get_irg_callee_info_state(const ir_graph *irg);
 
-/** sets the callee_info_state of an IR graph. */
+/** Sets the callee_info_state of an IR graph. */
 void                  set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s);
 
 /** property:
- *  Tells how to handle an ir graph in inlineing.
+ *  Tells how to handle an ir graph in inlining.
  */
 typedef enum {
-       irg_inline_any,            /**< No restriction on inlineing. Default. */
-       irg_inline_forbidden,      /**< The graph may not be inlined. */
+       irg_inline_any,            /**< No restriction on inlining. Default. */
+       irg_inline_forbidden,      /**< The graph must not be inlined. */
        irg_inline_recomended,     /**< The graph should be inlined. */
        irg_inline_forced,         /**< The graph must be inlined. */
        irg_inline_forced_no_body  /**< The graph must be inlined. No body is allowed
@@ -485,55 +487,78 @@ void *get_irg_link (const ir_graph *irg);
 
 /** Increments visited flag by one.
  *  @see also: get_irn_visited() get_irg_block_visited(). */
-void          inc_irg_visited (ir_graph *irg);
-unsigned long get_irg_visited (const ir_graph *irg);
-void          set_irg_visited (ir_graph *irg, unsigned long i);
+void         inc_irg_visited(ir_graph *irg);
+ir_visited_t get_irg_visited(const ir_graph *irg);
+void         set_irg_visited(ir_graph *irg, ir_visited_t i);
 /** An interprocedural flag valid for all irgs.
  *  @see also: get_irn_visited() get_irg_block_visited(). */
-unsigned long get_max_irg_visited (void);
-void          set_max_irg_visited (int val);
-unsigned long inc_max_irg_visited (void);
+ir_visited_t get_max_irg_visited(void);
+void         set_max_irg_visited(int val);
+ir_visited_t inc_max_irg_visited(void);
 
 /** Increments block_visited by one.
  *  @see also: get_irn_visited() get_irg_block_visited(). */
-void          inc_irg_block_visited (ir_graph *irg);
-unsigned long get_irg_block_visited (const ir_graph *irg);
-void          set_irg_block_visited (ir_graph *irg, unsigned long i);
+void         inc_irg_block_visited(ir_graph *irg);
+ir_visited_t get_irg_block_visited(const ir_graph *irg);
+void         set_irg_block_visited(ir_graph *irg, ir_visited_t i);
 
 /**
  * Debug helpers: You can indicate whether you are currently using visited or
  * block_visited flags. If NDEBUG is not defined, then the compiler will abort
  * if 2 parties try to use the flags.
  */
+enum ir_resources_enum_t {
+       /* local (irg) resources */
+       IR_RESOURCE_BLOCK_VISITED = 1 << 0,  /**< Block visited flags are used. */
+       IR_RESOURCE_BLOCK_MARK    = 1 << 1,  /**< Block mark bits are used. */
+       IR_RESOURCE_IRN_VISITED   = 1 << 2,  /**< IR-node visited flags are used. */
+       IR_RESOURCE_IRN_LINK      = 1 << 3,  /**< IR-node link fields are used. */
+       IR_RESOURCE_LOOP_LINK     = 1 << 4,  /**< IR-loop link fields are used. */
+       IR_RESOURCE_PHI_LIST      = 1 << 5,  /**< Block Phi lists are used. */
+       IR_RESOURCE_IRG_LINK      = 1 << 6,  /**< IR-graph link fields used. */
+
+       /* global (irp) resources */
+       IR_RESOURCE_ENTITY_LINK   = 1 << 8,  /**< IR-entity link fields are used. */
+       IR_RESOURCE_TYPE_VISITED  = 1 << 9,  /**< type visited flags */
+
+       /* masks */
+       IR_RESOURCE_LOCAL_MASK    = 0x00FF,  /**< Mask for all local resources. */
+       IR_RESOURCE_GLOBAL_MASK   = 0xFF00   /**< Mask for all global resources. */
+};
+typedef unsigned ir_resources_t;
+
 #ifndef NDEBUG
-void     set_using_block_visited(ir_graph *irg);
-void     clear_using_block_visited(ir_graph *irg);
-int      using_block_visited(const ir_graph *irg);
-void     set_using_visited(ir_graph *irg);
-void     clear_using_visited(ir_graph *irg);
-int      using_visited(const ir_graph *irg);
-void     set_using_irn_link(ir_graph *irg);
-void     clear_using_irn_link(ir_graph *irg);
-int      using_irn_link(const ir_graph *irg);
+void ir_reserve_resources(ir_graph *irg, ir_resources_t resources);
+void ir_free_resources(ir_graph *irg, ir_resources_t resources);
+ir_resources_t ir_resources_reserved(const ir_graph *irg);
 #else
-static INLINE void set_using_block_visited(ir_graph *irg) { (void) irg; }
-static INLINE void clear_using_block_visited(ir_graph *irg) { (void) irg; }
-static INLINE int using_block_visited(const ir_graph *irg) { (void) irg; return 0; }
-static INLINE void set_using_visited(ir_graph *irg) { (void) irg; }
-static INLINE void clear_using_visited(ir_graph *irg) { (void) irg; }
-static INLINE int using_visited(const ir_graph *irg) { (void) irg; return 0; }
-static INLINE void set_using_irn_link(ir_graph *irg) { (void) irg; }
-static INLINE void clear_using_irn_link(ir_graph *irg) { (void) irg; }
-static INLINE int using_irn_link(const ir_graph *irg) { (void) irg; return 0; }
+#define ir_reserve_resources(irg,resources)  (void)0
+#define ir_free_resources(irg,resources)     (void)0
+#define ir_resources_reserved(irg)           0
 #endif
 
+/**
+ * Graph State
+ */
+typedef enum {
+       IR_GRAPH_STATE_KEEP_MUX = 1 << 0,  /**< should perform no further optimisations on Mux nodes */
+       IR_GRAPH_STATE_ARCH_DEP = 1 << 1,  /**< should not construct more nodes which irarch potentially breaks down */
+} ir_graph_state_t;
+
+/** set some state flags on the graph (this does not clear the other flags) */
+void set_irg_state(ir_graph *irg, ir_graph_state_t state);
+/** clear some state flags of the graph */
+void clear_irg_state(ir_graph *irg, ir_graph_state_t state);
+/** query wether a set of graph state flags are activated */
+int is_irg_state(const ir_graph *irg, ir_graph_state_t state);
+
 /** Normalization: Move Proj nodes into the same block as its predecessors */
 void normalize_proj_nodes(ir_graph *irg);
 
-/** set a description for local value n */
+/** Set a description for local value n. */
 void set_irg_loc_description(ir_graph *irg, int n, void *description);
 
-/** get the description for local value n */
+/** Get the description for local value n. */
 void *get_irg_loc_description(ir_graph *irg, int n);
 
 /** Returns a estimated node count of the irg. This count is updated