nsz Git - libfirm/blob - ir/common/irtools.h

   1 /*
   2  * Copyright (C) 1995-2011 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   6  * This file may be distributed and/or modified under the terms of the
   7  * GNU General Public License version 2 as published by the Free Software
   8  * Foundation and appearing in the file LICENSE.GPL included in the
   9  * packaging of this file.
  10  *
  11  * Licensees holding valid libFirm Professional Edition licenses may use
  12  * this file in accordance with the libFirm Commercial License.
  13  * Agreement provided with the Software.
  14  *
  15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @brief     Some often needed tool-functions
  23  * @author    Michael Beck
  24  * @version   $Id$
  25  */
  26 #ifndef FIRM_COMMON_IRTOOLS_H
  27 #define FIRM_COMMON_IRTOOLS_H
  28
  29 #include "firm_types.h"
  30 #include "lc_opts.h"
  31 #include "pset.h"
  32
  33 /**
  34  * Return root commandlineoptions for libfirm library
  35  */
  36 lc_opt_entry_t *firm_opt_get_root(void);
  37
  38 /**
  39  * Dump a pset containing Firm objects.
  40  */
  41 void firm_pset_dump(pset *set);
  42
  43 /**
  44  * The famous clear_link() walker-function.
  45  * Sets all links fields of visited nodes to NULL.
  46  * Do not implement it by yourself, use this one.
  47  */
  48 void firm_clear_link(ir_node *n, void *env);
  49
  50 /**
  51  * The famous clear_link_and_block_lists() walker-function.
  52  * Sets all links fields of visited nodes to NULL.
  53  * Additionally, clear all Phi-lists of visited blocks.
  54  * Do not implement it by yourself, use this one.
  55  */
  56 void firm_clear_node_and_phi_links(ir_node *n, void *env);
  57
  58 /**
  59  * Walker function, sets all phi list heads fields of visited Blocks
  60  * to NULL.
  61  * Use in conjunction with firm_collect_block_phis().
  62  */
  63 void firm_clear_block_phis(ir_node *node, void *env);
  64
  65 /**
  66  * Walker function, links all visited Phi nodes into its block links.
  67  * Use in conjunction with firm_clear_block_phis().
  68  */
  69 void firm_collect_block_phis(ir_node *node, void *env);
  70
  71 /**
  72  * Creates an exact copy of a node with same inputs and attributes in the
  73  * same block.
  74  *
  75  * @param node   the node to copy
  76  */
  77 ir_node *exact_copy(const ir_node *node);
  78
  79 /**
  80  * Create an exact copy of a node with same inputs and attributes in the same
  81  * block but puts the node on a graph which might be different than the graph
  82  * of the original node.
  83  * Note: You have to fixup the inputs/block later
  84  */
  85 ir_node *irn_copy_into_irg(const ir_node *node, ir_graph *irg);
  86
  87 /**
  88  * This is a helper function used by some routines copying irg graphs
  89  * This assumes that we have "old" nodes which have been copied to "new"
  90  * nodes; The inputs of the new nodes still point to old nodes.
  91  *
  92  * Given an old(!) node this function rewires the matching new_node
  93  * so that all its inputs point to new nodes afterwards.
  94  */
  95 void irn_rewire_inputs(ir_node *node);
  96
  97 /**
  98  * @deprecated
  99  * Copies a node to a new irg. The Ins of the new node point to
 100  * the predecessors on the old irg.  n->link points to the new node.
 101  *
 102  * @param n    The node to be copied
 103  * @param irg  the new irg
 104  *
 105  * Does NOT copy standard nodes like Start, End etc that are fixed
 106  * in an irg. Instead, the corresponding nodes of the new irg are returned.
 107  * Note further, that the new nodes have no block.
 108  */
 109 void copy_irn_to_irg(ir_node *n, ir_graph *irg);
 110
 111 #endif