nsz Git - libfirm/blob - include/libfirm/irgmod.h

   1 /*
   2  * Copyright (C) 1995-2008 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    Support for ir graph modification.
  23  * @author   Martin Trapp, Christian Schaefer, Goetz Lindenmaier
  24  * @version  $Id$
  25  */
  26 #ifndef FIRM_IR_IRGMOD_H
  27 #define FIRM_IR_IRGMOD_H
  28
  29 #include "firm_types.h"
  30 #include "begin.h"
  31
  32 /**
  33  * Exchanges two nodes by conserving edges leaving old (i.e.,
  34  * pointers pointing to old).
  35  * The nodes op will be changed to op_Deleted and you must not do anything with
  36  * the node anymore except testing its op.
  37  */
  38 FIRM_API void exchange(ir_node *old, ir_node *nw);
  39
  40 /** Turns a node into a "useless" Tuple.
  41  *
  42  *  Turns a node into a "useless" Tuple.  The Tuple node just forms a tuple
  43  *  from several inputs. All predecessors of the tuple are set to bad and
  44  *  should be replaced if necssary. The block predecessor remains the same.
  45  *  This is useful if a node returning a tuple is removed, but the Projs
  46  *  extracting values from the tuple are not available.
  47  *
  48  *  @param node The node to be turned into a tuple.
  49  *  @param arity The number of values formed into a Tuple.
  50  */
  51 FIRM_API void turn_into_tuple(ir_node *node, int arity);
  52
  53 /** Walks over the passed IR graph and collects all Phi nodes as a
  54   * list in their corresponding block (using get_Block_phis() API).
  55   * Further it collects all Proj nodes in a list of the node producing
  56   * the tuple. In case of nested tuples the Projs are collected in the
  57   * node producing the outermost Tuple.
  58   * All other link fields are cleared afterwards.
  59   */
  60 FIRM_API void collect_phiprojs(ir_graph *irg);
  61
  62 /** Parts a block into two.  This is useful to insert other blocks within a
  63  *  given block.
  64  *
  65  * Adds a new block (new_block) in the control flow before the block
  66  * (old_block) of node.  Moves node and its predecessors from old_block to
  67  * new_block.  Moves all Projs that depend on moved nodes and are in old_block
  68  * to new_block. Moves all Phi nodes from old_block to new_block.  To achieve
  69  * this the routine assumes that all Phi nodes are in the Phi list (see
  70  * get_Block_phis()) of old_block.
  71  * Further it assumes that all Proj nodes are accessible by the link field of
  72  * the nodes producing the Tuple. This can be established by collect_phiprojs().
  73  * part_block() conserves this property.
  74  * Adds a Jmp node to new_block that jumps to old_block.
  75  *
  76  * @param node   The node were to break the block
  77  */
  78 FIRM_API void part_block(ir_node *node);
  79
  80 /**
  81  * Same as part_block() but works with out-edges so you don't have to call
  82  * collect_phiprojs.
  83  * This variant also removes all predecessors of the old block and returns
  84  * it. You are responsible to add control flow predecessors to it.
  85  */
  86 FIRM_API ir_node *part_block_edges(ir_node *node);
  87
  88 /**
  89  * Kill a node by setting its predecessors to Bad and finally
  90  * exchange the node by Bad itself.
  91  */
  92 FIRM_API void kill_node(ir_node *node);
  93
  94 #include "end.h"
  95
  96 #endif