becopyheur2: Cache the admissible registers eagerly.

[libfirm] / ir / common / irtools.h

diff --git a/ir/common/irtools.h b/ir/common/irtools.h
index 279ab8f..d5735b6 100644 (file)
--- a/ir/common/irtools.h
+++ b/ir/common/irtools.h
@@ -1,23 +1,96 @@
 /*
- * Project:     libFIRM
- * File name:   ir/ir/irtools.h
- * Purpose:     Some often needed tool-functions
- * Author:      Michael Beck
- * Modified by:
- * Created:
- * CVS-ID:      $Id$
- * Copyright:   (c) 1999-2005 Universität Karlsruhe
- * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
+ * This file is part of libFirm.
+ * Copyright (C) 2012 University of Karlsruhe.
  */
-#ifndef _IRTOOLS_H_
-#define _IRTOOLS_H_
 
-#include "irnode.h"
+/**
+ * @file
+ * @brief     Some often needed tool-functions
+ * @author    Michael Beck
+ */
+#ifndef FIRM_COMMON_IRTOOLS_H
+#define FIRM_COMMON_IRTOOLS_H
+
+#include "firm_types.h"
+#include "lc_opts.h"
+#include "pset.h"
+
+/**
+ * Return root commandlineoptions for libfirm library
+ */
+lc_opt_entry_t *firm_opt_get_root(void);
+
+/**
+ * Dump a pset containing Firm objects.
+ */
+void firm_pset_dump(pset *set);
 
 /**
  * The famous clear_link() walker-function.
- * Do not implement it by yourself, use this one
+ * Sets all links fields of visited nodes to NULL.
+ * Do not implement it by yourself, use this one.
  */
 void firm_clear_link(ir_node *n, void *env);
 
-#endif /* _IRTOOLS_H_ */
+/**
+ * The famous clear_link_and_block_lists() walker-function.
+ * Sets all links fields of visited nodes to NULL.
+ * Additionally, clear all Phi-lists of visited blocks.
+ * Do not implement it by yourself, use this one.
+ */
+void firm_clear_node_and_phi_links(ir_node *n, void *env);
+
+/**
+ * Walker function, sets all phi list heads fields of visited Blocks
+ * to NULL.
+ * Use in conjunction with firm_collect_block_phis().
+ */
+void firm_clear_block_phis(ir_node *node, void *env);
+
+/**
+ * Walker function, links all visited Phi nodes into its block links.
+ * Use in conjunction with firm_clear_block_phis().
+ */
+void firm_collect_block_phis(ir_node *node, void *env);
+
+/**
+ * Creates an exact copy of a node with same inputs and attributes in the
+ * same block. The copied node will not be optimized (so no CSE is performed).
+ *
+ * @param node   the node to copy
+ */
+ir_node *exact_copy(const ir_node *node);
+
+/**
+ * Create an exact copy of a node with same inputs and attributes in the same
+ * block but puts the node on a graph which might be different than the graph
+ * of the original node.
+ * Note: You have to fixup the inputs/block later
+ */
+ir_node *irn_copy_into_irg(const ir_node *node, ir_graph *irg);
+
+/**
+ * This is a helper function used by some routines copying irg graphs
+ * This assumes that we have "old" nodes which have been copied to "new"
+ * nodes; The inputs of the new nodes still point to old nodes.
+ *
+ * Given an old(!) node this function rewires the matching new_node
+ * so that all its inputs point to new nodes afterwards.
+ */
+void irn_rewire_inputs(ir_node *node);
+
+/**
+ * @deprecated
+ * Copies a node to a new irg. The Ins of the new node point to
+ * the predecessors on the old irg.  n->link points to the new node.
+ *
+ * @param n    The node to be copied
+ * @param irg  the new irg
+ *
+ * Does NOT copy standard nodes like Start, End etc that are fixed
+ * in an irg. Instead, the corresponding nodes of the new irg are returned.
+ * Note further, that the new nodes have no block.
+ */
+void copy_irn_to_irg(ir_node *n, ir_graph *irg);
+
+#endif