nsz Git - libfirm/blob - ir/tv/tv_t.h

   1 /*
   2  * Copyright (C) 1995-2011 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    Representation of and static computations on target machine
  23  *           values -- private header.
  24  * @date     2003
  25  * @author   Mathias Heil
  26  * @version  $Id$
  27  */
  28 #ifndef FIRM_TV_TV_T_H
  29 #define FIRM_TV_TV_T_H
  30
  31 #include "firm_common.h"
  32
  33 #include <assert.h>
  34 #include "irmode.h"
  35 #include "tv.h"
  36
  37 /** Debugging aid for the firmEvaluator: Marks for reserved tarvals values. */
  38 enum reserved_id {
  39         resid_tarval_bad         = 1,  /**< tarval_bad marker. */
  40         resid_tarval_undefined   = 2,  /**< tarval_undefined marker. */
  41         resid_tarval_b_false     = 3,  /**< tarval_b_false marker. */
  42         resid_tarval_b_true      = 4,  /**< tarval_b_true marker. */
  43         resid_tarval_unreachable = 5,  /**< tarval_unreachable marker. */
  44         resid_tarval_reachable   = 6   /**< tarval_reachable marker. */
  45 };
  46
  47 /**
  48  * Initialization of the tarval module.
  49  *
  50  * Call before init_mode().
  51  *
  52  * @param null_value
  53  *            The reference mode NULL value, typical 0l
  54  * @param support_quad_precision
  55  *            If non-zero, activate support for quad precision
  56  */
  57 void init_tarval_1(long null_value, int support_quad_precision);
  58
  59 /**
  60  * Initialization of the tarval module.
  61  *
  62  * Call after init_mode().
  63  */
  64 void init_tarval_2(void);
  65
  66 /**
  67  * Free all memory occupied by the tarval module.
  68  */
  69 void finish_tarval(void);
  70
  71 /**
  72  * This struct represents the afore mentioned tarvals.
  73  *
  74  * A tarval struct consists of an internal representation of the
  75  * value and some additional fields further describing the value.
  76  *
  77  * ATTRIBUTES:
  78  *   - ir_mode *mode     The mode of the stored value
  79  *   - void *value       The internal representation
  80  *
  81  * @sa
  82  *   irmode.h for predefined modes
  83  */
  84 struct ir_tarval {
  85         firm_kind  kind;    /**< must be k_tarval */
  86         ir_mode    *mode;   /**< the mode of the stored value */
  87         const void *value;  /**< the value stored in an internal way... */
  88         size_t     length;  /**< the length of the stored value */
  89 };
  90
  91 /* inline functions */
  92 /*
  93  * Access routines for tarval fields ========================================
  94  */
  95 static inline ir_mode *_get_tarval_mode(const ir_tarval *tv)
  96 {
  97         assert(tv);
  98         return tv->mode;
  99 }
 100
 101 static inline ir_tarval *_get_tarval_bad(void)
 102 {
 103         return tarval_bad;
 104 }
 105
 106 static inline ir_tarval *_get_tarval_undefined(void)
 107 {
 108         return tarval_undefined;
 109 }
 110
 111 static inline ir_tarval *_get_tarval_b_false(void)
 112 {
 113         return tarval_b_false;
 114 }
 115
 116 static inline ir_tarval *_get_tarval_b_true(void)
 117 {
 118         return tarval_b_true;
 119 }
 120
 121 static inline ir_tarval *_get_tarval_reachable(void)
 122 {
 123         return tarval_reachable;
 124 }
 125
 126 static inline ir_tarval *_get_tarval_unreachable(void)
 127 {
 128         return tarval_unreachable;
 129 }
 130
 131 static inline int _is_tarval(const void *thing)
 132 {
 133         return get_kind(thing) == k_tarval;
 134 }
 135
 136 #define get_tarval_mode(tv)      _get_tarval_mode(tv)
 137 #define get_tarval_bad()         _get_tarval_bad()
 138 #define get_tarval_undefined()   _get_tarval_undefined()
 139 #define get_tarval_b_false()     _get_tarval_b_false()
 140 #define get_tarval_b_true()      _get_tarval_b_true()
 141 #define get_tarval_unreachable() _get_tarval_unreachable()
 142 #define get_tarval_reachable()   _get_tarval_reachable()
 143 #define is_tarval(thing)         _is_tarval(thing)
 144
 145 #endif /* FIRM_TV_TV_T_H */