documentation: Update information about ir_graph.
[libfirm] / include / libfirm / irgraph.h
index f24c386..28f7fe4 100644 (file)
  *
  * - ent             The entity describing this procedure.
  *
+ * - anchor          A node having several important nodes of the graph as its
+ *                   operands.  The operands of the anchor are described in the
+ *                   following.
+ *
  * The beginning and end of a graph:
  *
  * - start_block     This ir_node is the block that contains the unique
@@ -53,7 +57,7 @@
  *                   further nodes.
  * - end             This ir_node is the unique end node of the procedure.
  *
- * The following nodes are Projs from the Start node, held in ir_graph for
+ * The following nodes are Projs from the Start node, held by the anchor for
  * simple access:
  *
  * - frame           The ir_node producing the pointer to the stack frame of
  *                   edges. Therefore FIRM has to represent them in the stack
  *                   frame.
  *
- * - globals         This models a pointer to a space in the memory where
- *                   _all_ global things are held.  Select from this pointer
- *                   with a Sel node the pointer to a global variable /
- *                   procedure / compiler known function... .
- *
- * - tls             This models a pointer to a space in the memory where
- *                   thread local things are held.  Select from this pointer
- *                   with a Sel node the pointer to a thread local variable.
+ * - initial_mem     The memory monad passed to the function when calling it.
+ *                   This is Proj pn_Start_M of the Start node.
  *
  * - args            The ir_node that produces the arguments of the method as
- *                   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.
+ *                   its result.  This is Proj pn_Start_T_args of the Start
+ *                   node.
  *
  * - no_mem          The NoMem node is an auxiliary node. It is needed only once,
  *                   so there is this globally reachable node.
  *                   to this block.  It can be set with set_cur_block(block).
  *                   Only needed for ir construction.
  *
- * - params/n_loc    An int giving the number of local variables in this
- *                  procedure.  This is needed for ir construction. Name will
- *                   be changed.
+ * - n_loc           An int giving the number of local variables in this
+ *                   procedure.  This is needed for ir construction.
  *
  * - value_table     This hash table (pset) is used for global value numbering
  *                   for optimizing use in iropt.c.
  *
- * - Phi_in_stack;   a stack needed for automatic Phi construction, needed only
- *                   during ir construction.
- *
  * - visited         A int used as flag to traverse the ir_graph.
  *
  * - block_visited    A int used as a flag to traverse block nodes in the graph.
  * 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 its
- *   seven results (X, M, P, P, P, T, P).
+ * - The start block containing a start node and Proj nodes for its results.
  * - 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 its number of predecessors.)
  * block that contains all valid values in this block (set_store()).  This
  * data structure is used to build the Phi nodes and removed after
  * completion of the graph.  There is no path from end to start in the
- * graph after calling ir_graph.
+ * graph after calling new_ir_graph().
  *
  * The op_pin_state of the graph is set to "op_pin_state_pinned"
  * if no global cse was performed on the graph.
@@ -151,8 +142,7 @@ FIRM_API 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.
  * Sets the field irgraph in the corresponding entity to NULL.
- * Does not remove the irgraph from the list in irprog (requires
- * inefficient search, call remove_irp_irg by hand).
+ * Removes the irgraph from the list in irprog.
  * Does not free types, entities or modes that are used only by this
  * graph, nor the entity standing for this graph.
  */
@@ -248,38 +238,6 @@ FIRM_API size_t get_irg_idx(const ir_graph *irg);
  */
 FIRM_API ir_node *get_idx_irn(const ir_graph *irg, unsigned idx);
 
-
-/** The states of an ir graph.
- *
- * state phase values: phase_building, phase_high, phase_low, phase_backend.
- *
- * The graph is in phase_building during construction of the irgraph.
- * The construction is finished by a call to finalize_cons().
- *
- * Finalize_cons() sets the state to phase_high.  All standard Firm nodes are
- * allowed.
- *
- * To get the irgraph into phase_low all Sel nodes must be removed and
- * replaced by explicit address computations.  SymConst size and
- * type tag nodes must be removed (@@@ really?).  Initialization of
- * memory allocated by Alloc must be explicit.  @@@ More conditions?
- *
- * phase_backend is set if architecture specific machine nodes are inserted
- * (and probably most standard Firm are removed).
- */
-typedef enum {
-       phase_building,  /**< The graph is still being constructed. */
-       phase_high,      /**< The construction of the graph is finish, high level nodes may be present. */
-       phase_low,       /**< High level nodes are removed. */
-       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. */
-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);
-
 /** 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
@@ -308,41 +266,6 @@ FIRM_API irg_callee_info_state get_irg_callee_info_state(const ir_graph *irg);
 /** Sets the callee_info_state of an IR graph. */
 FIRM_API void set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s);
 
-/** property:
- *  Tells how to handle an ir graph in inlining.
- */
-typedef enum {
-       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
-                                       to be emitted. */
-} irg_inline_property;
-
-/** Returns the inline property of a graph. */
-FIRM_API irg_inline_property get_irg_inline_property(const ir_graph *irg);
-/** Sets the inline property of a graph. */
-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_properties().
- *
- * @return a bitset of mtp_additional_properties values
- */
-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,
-                                            mtp_additional_properties property_mask);
-
-/** Sets one additional graph property. */
-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);
 /** Return void* field previously set by set_irg_link() */
@@ -439,7 +362,23 @@ typedef enum ir_graph_constraints_t {
         * 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_CONSTRAINT_OPTIMIZE_UNREACHABLE_CODE = 1U << 4,
+       IR_GRAPH_CONSTRAINT_OPTIMIZE_UNREACHABLE_CODE = 1U << 3,
+       /**
+        * The graph is being constructed: We have a current_block set,
+        * and blocks contain mapping of variable numbers to current
+        * values.
+        */
+       IR_GRAPH_CONSTRAINT_CONSTRUCTION              = 1U << 4,
+       /**
+        * Intermediate language constructs not supported by the backend have
+        * been lowered.
+        */
+       IR_GRAPH_CONSTRAINT_TARGET_LOWERED            = 1U << 5,
+       /**
+        * We have a backend graph: all data values have register constraints
+        * annotated.
+        */
+       IR_GRAPH_CONSTRAINT_BACKEND                   = 1U << 6,
 } ir_graph_constraints_t;
 ENUM_BITSET(ir_graph_constraints_t)
 
@@ -536,11 +475,6 @@ FIRM_API void set_irg_loc_description(ir_graph *irg, int n, void *description);
 /** Returns the description for local value n. */
 FIRM_API void *get_irg_loc_description(ir_graph *irg, int n);
 
-/** Returns a estimated node count of the irg. This count is updated
- * after every irg_walk_graph().
- */
-FIRM_API unsigned get_irg_estimated_node_cnt(const ir_graph *irg);
-
 /** Returns the last irn index for this graph. */
 FIRM_API unsigned get_irg_last_idx(const ir_graph *irg);
 
@@ -563,36 +497,6 @@ FIRM_API void assure_irg_properties(ir_graph *irg, ir_graph_properties_t props);
  */
 FIRM_API void confirm_irg_properties(ir_graph *irg, ir_graph_properties_t props);
 
-/**
- * Accesses custom graph data.
- * The data must have been registered with
- * register_additional_graph_data() before.
- * @param graph The graph to get the data from.
- * @param type The type of the data you registered.
- * @param off The value returned by register_additional_graph_data().
- * @return A pointer of type @p type.
- */
-#define get_irg_data(graph,type,off) \
-       (assert(off > 0 && "Invalid graph data offset"), (type *) ((char *) (graph) - (off)))
-
-/**
- * Returns 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_graph_data().
- * @return A pointer to the ir node the custom data belongs to.
- */
-#define get_irg_data_base(data,off) \
-       (assert(off > 0 && "Invalid graph data offset"), (ir_graph *) ((char *) (data) + (off)))
-
-/**
- * Requests additional data to be allocated with an ir graph.
- * @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_irg_data(), 0 if the
- * registration failed.
- */
-FIRM_API size_t register_additional_graph_data(size_t size);
-
 /** @} */
 
 #include "end.h"