nsz Git - libfirm/blob - include/libfirm/heights.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  */
  26 #ifndef FIRM_ANA_HEIGHTS_H
  27 #define FIRM_ANA_HEIGHTS_H
  28
  29 #include "firm_types.h"
  30 #include "begin.h"
  31
  32 /**
  33  * @ingroup irana
  34  * @defgroup ir_heights  Node Heights
  35  *
  36  * The height is a measure for the longest datadependencies path from a node to
  37  * the end of a basic block. This is usefull for scheduling heuristics and can
  38  * also be used to speedup reachability queries.
  39  *
  40  * @{
  41  */
  42
  43 /**
  44  * Get the height of a node inside a basic block.
  45  * The height of the node is the maximal number of edges between a sink node in
  46  * that block and the node itself (plus 1).
  47  * @param h    The heights object.
  48  * @param irn  The node.
  49  * @return     The height of the node.
  50  */
  51 FIRM_API unsigned get_irn_height(const ir_heights_t *h, const ir_node *irn);
  52
  53 /**
  54  * Check, if a certain node is reachable according to data dependence edges
  55  * from another node. Both nodes must be in the same block.
  56  * @param h The heights object.
  57  * @param n The first node.
  58  * @param m The other node.
  59  * @return  1, if n is data dependent on m, 0 if not.
  60  */
  61 FIRM_API int heights_reachable_in_block(ir_heights_t *h, const ir_node *n,
  62                                         const ir_node *m);
  63
  64 /**
  65  * Recompute the height information for a certain block.
  66  * This can be used to recompute the height information of a block.
  67  * @param h     The heights object.
  68  * @param block The block
  69  * @return The maximum over all heights in the block.
  70  */
  71 FIRM_API unsigned heights_recompute_block(ir_heights_t *h, ir_node *block);
  72
  73 /**
  74  * Make a new heights object.
  75  * This also computes the heights for each block in the graph.
  76  * @param irg The graph.
  77  */
  78 FIRM_API ir_heights_t *heights_new(ir_graph *irg);
  79
  80 /**
  81  * Free a heights object.
  82  * @param h The heights object.
  83  */
  84 FIRM_API void heights_free(ir_heights_t *h);
  85
  86 /** @} */
  87
  88 #include "end.h"
  89
  90 #endif