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

   1 /*
   2  * Copyright (C) 1995-2010 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   Analyse the graph with value range propagation
  23  * @author  Jonas Fietz
  24  * @version $Id$
  25  *
  26  */
  27 #ifndef VRP_H
  28 #define VRP_H
  29
  30 #include "firm_types.h"
  31 #include "begin.h"
  32
  33 enum range_types {
  34         VRP_UNDEFINED, /**< No information could be derived so far */
  35         VRP_RANGE,     /**< bottom and top form a range, including both values */
  36         VRP_ANTIRANGE, /**< range from bottom to top cannot be, but borders might
  37                             be */
  38         VRP_VARYING    /**< information cannot be derived */
  39 };
  40
  41 /** VRP information */
  42 typedef struct {
  43         int valid;                   /**< This node has valid vrp information */
  44         ir_tarval *bits_set;         /**< The bits which, by analysis, are  definitely set.
  45                                           0: may be not set, 1: definitely set*/
  46         ir_tarval *bits_not_set;     /**< The bits which by analysis are definitely
  47                                           not set, 1 for may be set, 0: definitely not set  */
  48         enum range_types range_type; /**< The range represented by range_top, range_bottom */
  49         ir_tarval *range_bottom;
  50         ir_tarval *range_top;
  51 } vrp_attr;
  52
  53 /**
  54  * Set vrp data on the graph irg
  55  * @param irg graph on which to set vrp data
  56  */
  57 FIRM_API void set_vrp_data(ir_graph *irg);
  58
  59 /**
  60  * Test, if the two nodes can be compared with their vrp information
  61  *
  62  * @param left: the left node
  63  * @param right: the right node
  64  *
  65  * @return the pn_Cmp, if one can be derived
  66  */
  67 FIRM_API pn_Cmp vrp_cmp(const ir_node *left, const ir_node *right);
  68
  69 /*
  70  * Return the vrp data for this node
  71  *
  72  * @param n: the node for which to return the vrp information
  73  *
  74  * @return a pointer to the vrp data or NULL if there is none
  75  */
  76 FIRM_API vrp_attr *vrp_get_info(const ir_node *n);
  77
  78 #include "end.h"
  79
  80 #endif