nsz Git - libfirm/blob - include/libfirm/height.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   Compute heights of nodes inside basic blocks
  23  * @author  Sebastian Hack
  24  * @date    19.04.2006
  25  * @version $Id$
  26  */
  27 #ifndef FIRM_ANA_HEIGHTS_H
  28 #define FIRM_ANA_HEIGHTS_H
  29
  30 #include "firm_types.h"
  31 #include "begin.h"
  32
  33 typedef struct _heights_t heights_t;
  34
  35 /**
  36  * Get the height of a node inside a basic block.
  37  * The height of the node is the maximal number of edges between a sink node in
  38  * that block and the node itself (plus 1).
  39  * @param h    The heights object.
  40  * @param irn  The node.
  41  * @return     The height of the node.
  42  */
  43 FIRM_API unsigned get_irn_height(const heights_t *h, const ir_node *irn);
  44
  45 /**
  46  * Check, if a certain node is reachable according to data dependence edges from another node.
  47  * @param h The heights object.
  48  * @param n The first node.
  49  * @param m The other node.
  50  * @return  1, if n is data dependent on m, 0 if not.
  51  */
  52 FIRM_API int heights_reachable_in_block(heights_t *h, const ir_node *n,
  53                                         const ir_node *m);
  54
  55 /**
  56  * Recompute the height information.
  57  * This can be used to recompute the height information if the graph has changed since the last computation.
  58  * @param h The heights object.
  59  */
  60 FIRM_API void heights_recompute(heights_t *h);
  61
  62 /**
  63  * Recompute the height information for a certain block.
  64  * This can be used to recompute the height information of a block.
  65  * @param h     The heights object.
  66  * @param block The block
  67  * @return The maximum over all heights in the block.
  68  */
  69 FIRM_API unsigned heights_recompute_block(heights_t *h, ir_node *block);
  70
  71 /**
  72  * Make a new heights object.
  73  * This also computes the heights for each block in the graph.
  74  * @param irg The graph.
  75  */
  76 FIRM_API heights_t *heights_new(ir_graph *irg);
  77
  78 /**
  79  * Free a heights object.
  80  * @param h The heights object.
  81  */
  82 FIRM_API void heights_free(heights_t *h);
  83
  84 #include "end.h"
  85
  86 #endif