/*
- * 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-2006 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 _FIRM_COMMON_IRTOOLS_H_
-#define _FIRM_COMMON_IRTOOLS_H_
-#include "firm_config.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"
-#ifdef WITH_LIBCORE
-#include <libcore/lc_opts.h>
+/**
+ * Return root commandlineoptions for libfirm library
+ */
lc_opt_entry_t *firm_opt_get_root(void);
-#endif
-#include "pset.h"
+/**
+ * Dump a pset containing Firm objects.
+ */
+void firm_pset_dump(pset *set);
-#undef MIN
-#undef MAX
-#define MAX(x, y) ((x) > (y) ? (x) : (y))
-#define MIN(x, y) ((x) < (y) ? (x) : (y))
+/**
+ * The famous clear_link() walker-function.
+ * 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);
/**
- * Three valued compare as demanded by e.g. qsort(3)
- * @param c A number.
- * @param d Another number.
- * @return 0 if c == d, -1 if c < d, 1 if c > d.
+ * 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.
*/
-#define QSORT_CMP(c, d) (((c) > (d)) - ((c) < (d)))
+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);
/**
- * convert an integer into pointer
+ * Walker function, links all visited Phi nodes into its block links.
+ * Use in conjunction with firm_clear_block_phis().
*/
-#define INT_TO_PTR(v) ((void *)((char *)0 + (v)))
+void firm_collect_block_phis(ir_node *node, void *env);
/**
- * convert a pointer into an integer
+ * 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
*/
-#define PTR_TO_INT(v) ((int)((char *)(v) - (char *)0))
+ir_node *exact_copy(const ir_node *node);
/**
- * Dump a pset containing Firm objects.
+ * 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
*/
-void firm_pset_dump(pset *set);
+ir_node *irn_copy_into_irg(const ir_node *node, ir_graph *irg);
/**
- * The famous clear_link() walker-function.
- * Do not implement it by yourself, use this one
+ * 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 firm_clear_link(ir_node *n, void *env);
+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.
*
*/
void copy_irn_to_irg(ir_node *n, ir_graph *irg);
-/**
- * Creates an exact copy of a node.
- * The copy resists on the same graph in the same block.
- *
- * @param n the node to copy
- *
- * @note If the copy is not changed, the next CSE operation will
- * replace it by the original, so beware.
- */
-ir_node *exact_copy(const ir_node *n);
-
-#endif /* _FIRM_COMMON_IRTOOLS_H_ */
+#endif
projects / libfirm / blobdiff