nsz Git - libfirm/blob - include/libfirm/interval_analysis.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      Decompost control flow graph into acylic, hierarchic intervals.
  23  * @author     Goetz Lindenmaier
  24  * @date       5.11.2004
  25  * @version    $Id$
  26  * @brief
  27  *  Decompost control flow graph into acylic, hierarchic intervals.
  28  *
  29  *  The analysis is based on the control flow looptree.  An intervall
  30  *  are basically all nodes in a single ir_loop entry, i.e., basic
  31  *  blocks and inner loop nodes.  The analysis computes a new set of
  32  *  edges that link all nodes of a loop to an acyclic graph.
  33  *
  34  *  The interval analysis counts the number of exception control flow
  35  *  operations leaving a block.  This depends on stuff computed in
  36  *  execution_freqencies.
  37  */
  38 #ifndef FIRM_ANA_INTERVAL_ANALYSIS_H
  39 #define FIRM_ANA_INTERVAL_ANALYSIS_H
  40
  41 #include "firm_types.h"
  42 #include "begin.h"
  43
  44 /** The ins of regions:  regions are loops or blocks.
  45  *
  46  *  @todo: we should make a type for the regions, or reuse loop_element.
  47  */
  48 FIRM_API int get_region_n_ins(void *region);
  49 FIRM_API void *get_region_in(void *region, int pos);
  50 FIRM_API void add_region_in(void *region, void *in);
  51
  52
  53 /** The number of out edges of a region.
  54  *
  55  *  This number is useful for evaluation of execution frequencies.
  56  */
  57 FIRM_API int get_region_n_outs(void *region);
  58
  59 /** The number of exception out edges of a region.
  60  *
  61  *  This number is useful for evaluation of execution frequencies.
  62  */
  63 FIRM_API int get_region_n_exc_outs(void *region);
  64
  65 /** The control flow operation corresponding to the loop-region in at
  66  *  position pos.
  67  */
  68 FIRM_API void *get_loop_cfop(void *region, int pos);
  69
  70
  71 /** The algorithm to construct the interval graph.
  72  *
  73  *  Constructs the cf loop tree and leaves a valid version of it.
  74  *
  75  *  @todo: @@@ add flag that states correctness of interval analysis information
  76  *  to irg.
  77  **/
  78 FIRM_API void construct_intervals(ir_graph *irg);
  79
  80 /** frees interval information of all graphs. */
  81 FIRM_API void free_intervals(void);
  82
  83 /** dump a graph with the intervals. File name suffix "-interval". */
  84 FIRM_API void dump_interval_graph(ir_graph *irg, const char *suffix);
  85
  86 #include "end.h"
  87
  88 #endif