remove broken-for-verifier flag
[libfirm] / include / libfirm / irgraph.h
index fc4a952..ccb8395 100644 (file)
  *                   with a Sel node the pointer to a thread local variable.
  *
  * - args            The ir_node that produces the arguments of the method as
- *                   it's result.  This is a Proj node on the fourth output of
+ *                   its result.  This is a Proj node on the fourth output of
  *                   the start node.  This output is tagged as pn_Start_T_args.
  *
  * - proj_args       The proj nodes of the args node.
  *
- * - bad             The Bad node is an auxiliary node. It is needed only once,
- *                   so there is this globally reachable node.
- *
  * - no_mem          The NoMem node is an auxiliary node. It is needed only once,
  *                   so there is this globally reachable node.
  *
@@ -122,13 +119,6 @@ FIRM_API ir_graph *current_ir_graph;
 FIRM_API ir_graph *get_current_ir_graph(void);
 FIRM_API void set_current_ir_graph(ir_graph *graph);
 
-#ifdef INTERPROCEDURAL_VIEW
-/** This flag indicate the current view. The behavior of some methods
- * (get_irn_*, set_irn_*) is influenced by this flag. */
-FIRM_API int get_interprocedural_view(void);
-FIRM_API void set_interprocedural_view(int state);
-#endif
-
 /**
  * Create a new ir graph to build ir for a procedure.
  *
@@ -142,15 +132,14 @@ FIRM_API void set_interprocedural_view(int state);
  * represent a procedure in FIRM.
  *
  * It allocates an ir_graph and sets the field irg of the entity ent
- * as well as current_ir_graph to point to this graph.
- * Further it allocates the following nodes needed for every
- * procedure:
+ * to point to this graph. Further it allocates the following nodes needed
+ * for every procedure:
  *
- * - The start block containing a start node and Proj nodes for it's
+ * - The start block containing a start node and Proj nodes for its
  *   seven results (X, M, P, P, P, T, P).
  * - The end block containing an end node. This block is not matured
  *   after executing new_ir_graph() as predecessors need to be added to it.
- *   (Maturing a block means fixing it's number of predecessors.)
+ *   (Maturing a block means fixing its number of predecessors.)
  * - The current block, which is empty and also not matured.
  *
  * Further it enters the global store into the data structure of the start
@@ -201,9 +190,6 @@ FIRM_API ir_type *get_irg_frame_type(ir_graph *irg);
 /** Sets the frame type of an IR graph. */
 FIRM_API void set_irg_frame_type(ir_graph *irg, ir_type *ftp);
 
-/** Returns the value parameter type of an IR graph. */
-FIRM_API ir_type *get_irg_value_param_type(ir_graph *irg);
-
 /** Returns the start block of an IR graph. */
 FIRM_API ir_node *get_irg_start_block(const ir_graph *irg);
 /** Sets the start block of an IR graph. */
@@ -224,15 +210,6 @@ FIRM_API ir_node *get_irg_end(const ir_graph *irg);
 /** Sets the End node of an IR graph. */
 FIRM_API 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. */
-FIRM_API ir_node *get_irg_end_reg(const ir_graph *irg);
-FIRM_API void set_irg_end_reg(ir_graph *irg, ir_node *node);
-
-FIRM_API ir_node *get_irg_end_except(const ir_graph *irg);
-FIRM_API 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. */
 FIRM_API ir_node *get_irg_initial_exec(const ir_graph *irg);
@@ -244,11 +221,6 @@ FIRM_API ir_node *get_irg_frame(const ir_graph *irg);
 /** Sets the node that represents the frame pointer of the given IR graph. */
 FIRM_API void set_irg_frame(ir_graph *irg, ir_node *node);
 
-/** Returns the node that represents the tls pointer of the given IR graph. */
-FIRM_API ir_node *get_irg_tls(const ir_graph *irg);
-/** Sets the node that represents the tls pointer of the given IR graph. */
-FIRM_API void set_irg_tls(ir_graph *irg, ir_node *node);
-
 /** Returns the node that represents the initial memory of the given IR graph. */
 FIRM_API ir_node *get_irg_initial_mem(const ir_graph *irg);
 /** Sets the node that represents the initial memory of the given IR graph. */
@@ -259,16 +231,7 @@ FIRM_API ir_node *get_irg_args(const ir_graph *irg);
 /** Sets the node that represents the argument pointer of the given IR graph. */
 FIRM_API void set_irg_args(ir_graph *irg, ir_node *node);
 
-/** Returns the current block of an IR graph. */
-FIRM_API ir_node *get_irg_current_block(const ir_graph *irg);
-/** Sets the current block of an IR graph. */
-FIRM_API void set_irg_current_block(ir_graph *irg, ir_node *node);
-
-/** Returns the Bad node of the given IR graph.  Use new_Bad() instead!! */
-FIRM_API ir_node *get_irg_bad(const ir_graph *irg);
-FIRM_API void set_irg_bad(ir_graph *irg, ir_node *node);
-
-/** Returns the NoMem node of the given IR graph.  Use new_NoMem() instead!! */
+/** Returns the NoMem node of the given IR graph. */
 FIRM_API ir_node *get_irg_no_mem(const ir_graph *irg);
 FIRM_API void set_irg_no_mem(ir_graph *irg, ir_node *node);
 
@@ -283,7 +246,7 @@ FIRM_API long get_irg_graph_nr(const ir_graph *irg);
  * smaller than get_irp_last_idx()
  * Note: you cannot use this number for get_irp_irg()
  */
-FIRM_API int get_irg_idx(const ir_graph *irg);
+FIRM_API size_t get_irg_idx(const ir_graph *irg);
 
 /**
  * Get the node for an index.
@@ -293,7 +256,7 @@ FIRM_API int get_irg_idx(const ir_graph *irg);
  *            index.
  * @note      The node you got might be dead.
  */
-FIRM_API ir_node *get_idx_irn(ir_graph *irg, unsigned idx);
+FIRM_API ir_node *get_idx_irn(const ir_graph *irg, unsigned idx);
 
 
 /******************************************************************************/
@@ -335,9 +298,6 @@ FIRM_API irg_phase_state get_irg_phase_state(const ir_graph *irg);
 /** Sets the phase state of an IR graph. */
 FIRM_API 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
    The graph is "op_pin_state_pinned" if all nodes are associated with a basic block.
    It is in state "op_pin_state_floats" if nodes are in arbitrary blocks.  In state
@@ -356,36 +316,16 @@ typedef enum {
        outs_inconsistent  /**< Outs have been computed, memory is still allocated,
                                but the graph has been changed since. */
 } irg_outs_state;
-FIRM_API irg_outs_state get_irg_outs_state(const ir_graph *irg);
-FIRM_API void set_irg_outs_inconsistent(ir_graph *irg);
 
 /** state:  extended basic block state. */
 typedef enum {
-       extblk_none    = 0,  /**< No extended basic block information is constructed. Default. */
-       extblk_valid   = 1,  /**< Extended basic block information is valid. */
-       extblk_invalid = 2   /**< Extended basic block information is constructed but invalid. */
-} irg_extblk_state;
-FIRM_API irg_extblk_state get_irg_extblk_state(const ir_graph *irg);
+       ir_extblk_info_none    = 0,  /**< No extended basic block information is constructed. Default. */
+       ir_extblk_info_valid   = 1,  /**< Extended basic block information is valid. */
+       ir_extblk_info_invalid = 2   /**< Extended basic block information is constructed but invalid. */
+} irg_extblk_info_state;
+FIRM_API irg_extblk_info_state get_irg_extblk_state(const ir_graph *irg);
 FIRM_API void set_irg_extblk_inconsistent(ir_graph *irg);
 
-/** state: dom_state
- * Signals the state of the dominator / post dominator information.
- */
-typedef enum {
-       dom_none,             /**< dominator are not computed, no memory is allocated */
-       dom_consistent,       /**< dominator information is computed and correct */
-       dom_inconsistent      /**< dominator information is computed but the graph has been changed since */
-} irg_dom_state;
-
-/** returns the dominator state of an IR graph. */
-FIRM_API irg_dom_state get_irg_dom_state(const ir_graph *irg);
-
-/** returns the post dominator state of an IR graph. */
-FIRM_API irg_dom_state get_irg_postdom_state(const ir_graph *irg);
-
-/** sets the dominator and post dominator state of an IR graph to inconsistent. */
-FIRM_API void set_irg_doms_inconsistent(ir_graph *irg);
-
 /** state: loopinfo_state
  *  Loop information describes the loops within the control and
  *  data flow of the procedure.
@@ -472,19 +412,19 @@ FIRM_API void set_irg_inline_property(ir_graph *irg, irg_inline_property s);
  * Returns the mask of the additional graph properties.
  * The properties are automatically inherited from the method type
  * if they were not set using set_irg_additional_properties() or
- * set_irg_additional_property().
+ * set_irg_additional_properties().
  *
- * @return a bitset of mtp_additional_property values
+ * @return a bitset of mtp_additional_properties values
  */
-FIRM_API unsigned get_irg_additional_properties(const ir_graph *irg);
+FIRM_API mtp_additional_properties get_irg_additional_properties(const ir_graph *irg);
 
 /** Sets the mask of the additional graph properties. */
 FIRM_API void set_irg_additional_properties(ir_graph *irg,
-                                            unsigned property_mask);
+                                            mtp_additional_properties property_mask);
 
 /** Sets one additional graph property. */
-FIRM_API void set_irg_additional_property(ir_graph *irg,
-                                          mtp_additional_property flag);
+FIRM_API void add_irg_additional_properties(ir_graph *irg,
+                                            mtp_additional_properties flag);
 
 /** A void * field to link arbitrary information to the node. */
 FIRM_API void set_irg_link(ir_graph *irg, void *thing);
@@ -512,25 +452,17 @@ FIRM_API void set_irg_block_visited(ir_graph *irg, ir_visited_t i);
  * 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 {
+typedef enum ir_resources_t {
        /* local (irg) resources */
+       IR_RESOURCE_NONE          = 0,
        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;
+       IR_RESOURCE_PHI_LIST      = 1 << 5   /**< Block Phi lists are used. */
+} ir_resources_t;
+ENUM_BITSET(ir_resources_t)
 
 #ifndef NDEBUG
 FIRM_API void ir_reserve_resources(ir_graph *irg, ir_resources_t resources);
@@ -543,23 +475,79 @@ FIRM_API ir_resources_t ir_resources_reserved(const ir_graph *irg);
 #endif
 
 /**
- * Graph State
+ * graph state. This is used for 2 things:
+ * - stating properties about a graph
+ * - disallow certain transformations for the graph (typically highlevel
+ *   constructs are disallowed after lowering them)
  */
 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 */
+       /**
+        * Should not construct more nodes which irarch potentially breaks down
+        */
+       IR_GRAPH_STATE_ARCH_DEP                  = 1U << 0,
+       /**
+        * mode_b nodes have been lowered so you should not create any new nodes
+        * with mode_b (except for Cmp)
+        */
+       IR_GRAPH_STATE_MODEB_LOWERED             = 1U << 1,
+       /**
+        * There are normalisations where there is no "best" representative.
+        * In this case we first normalise into 1 direction (!NORMALISATION2) and
+        * later in the other (NORMALISATION2).
+        */
+       IR_GRAPH_STATE_NORMALISATION2            = 1U << 2,
+       /**
+        * Define the semantic of Load(Sel(x)), if x has a bit offset (Bitfields!).
+        * Normally, the frontend is responsible for bitfield masking operations.
+        * Set IMPLICIT_BITFIELD_MASKING, if the lowering phase must insert masking
+        * operations.
+        */
+       IR_GRAPH_STATE_IMPLICIT_BITFIELD_MASKING = 1U << 3,
+       /**
+        * Allow localopts to remove edges to unreachable code.
+        * Warning: It is only safe to enable this when you are sure that you
+        * apply all localopts to the fixpunkt. (=in optimize_graph_df)
+        */
+       IR_GRAPH_STATE_OPTIMIZE_UNREACHABLE_CODE = 1U << 4,
+       /** graph contains no critical edges */
+       IR_GRAPH_STATE_NO_CRITICAL_EDGES         = 1U << 5,
+       /** graph contains no Bad nodes */
+       IR_GRAPH_STATE_NO_BADS                   = 1U << 6,
+       /**
+        * there exists no (obviously) unreachable code in the graph.
+        * Unreachable in this context is code that you can't reach by following
+        * execution flow from the start block.
+        */
+       IR_GRAPH_STATE_NO_UNREACHABLE_CODE       = 1U << 7,
+       /** graph contains at most one return */
+       IR_GRAPH_STATE_ONE_RETURN                = 1U << 8,
+       /** dominance information about the graph is valid */
+       IR_GRAPH_STATE_CONSISTENT_DOMINANCE      = 1U << 9,
+       /** postdominance information about the graph is valid */
+       IR_GRAPH_STATE_CONSISTENT_POSTDOMINANCE  = 1U << 10,
+       /**
+        * out edges (=iredges) are enable and there is no dead code that can be
+        * reached by following them
+        */
+       IR_GRAPH_STATE_CONSISTENT_OUT_EDGES      = 1U << 11,
+       /** outs (irouts) are computed and up to date */
+       IR_GRAPH_STATE_CONSISTENT_OUTS           = 1U << 12,
+       /** loopinfo is computed and up to date */
+       IR_GRAPH_STATE_CONSISTENT_LOOPINFO       = 1U << 13,
+       /** entity usage information is computed and up to date */
+       IR_GRAPH_STATE_CONSISTENT_ENTITY_USAGE   = 1U << 14,
+       /** extended basic blocks have been formed and are up to date */
+       IR_GRAPH_STATE_VALID_EXTENDED_BLOCKS     = 1U << 15,
 } ir_graph_state_t;
+ENUM_BITSET(ir_graph_state_t)
 
 /** set some state flags on the graph (this does not clear the other flags) */
 FIRM_API void set_irg_state(ir_graph *irg, ir_graph_state_t state);
 /** clear some state flags of the graph */
 FIRM_API void clear_irg_state(ir_graph *irg, ir_graph_state_t state);
-/** query wether a set of graph state flags are activated */
+/** query whether a set of graph state flags are activated */
 FIRM_API int is_irg_state(const ir_graph *irg, ir_graph_state_t state);
 
-/** Normalization: Move Proj nodes into the same block as its predecessors */
-FIRM_API void normalize_proj_nodes(ir_graph *irg);
-
 /** Set a description for local value n. */
 FIRM_API void set_irg_loc_description(ir_graph *irg, int n, void *description);