nsz Git - libfirm/blob - ir/ir/irmode_t.h

   1 /*
   2  * Project:     libFIRM
   3  * File name:   ir/ir/irmode_t.h
   4  * Purpose:     Data modes of operations -- private header.
   5  * Author:      Martin Trapp, Christian Schaefer
   6  * Modified by: Goetz Lindenmaier, Mathias Heil
   7  * Created:
   8  * CVS-ID:      $Id$
   9  * Copyright:   (c) 1998-2003 Universität Karlsruhe
  10  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
  11  */
  12
  13
  14 /**
  15  * @file irmode_t.h
  16  */
  17
  18 # ifndef _IRMODE_T_H_
  19 # define _IRMODE_T_H_
  20
  21 # include "irmode.h"
  22 # include "tv.h"
  23
  24 /** This struct is supposed to completely define a mode. **/
  25 struct ir_mode {
  26   firm_kind         kind;       /**< distinguishes this node from others */
  27   modecode          code;       /**< unambiguous identifier of a mode */
  28   ident             *name;      /**< Name ident of this mode */
  29
  30   /* ----------------------------------------------------------------------- */
  31   /* On changing this struct you have to evaluate the mode_are_equal function!*/
  32   mode_sort         sort;          /**< coarse classification of this mode:
  33                                      int, float, reference ...
  34                                      (see irmode.h) */
  35   mode_arithmetic   arithmetic;    /**< different arithmetic operations possible with a mode */
  36   int               size;          /**< size of the mode in Bits. */
  37   unsigned          sign:1;        /**< signedness of this mode */
  38   unsigned int      modulo_shift;  /**< number of bits a values of this mode will be shifted */
  39   unsigned          vector_elem;   /**< if this is not equal 1, this is a vector mode with
  40                                         vector_elem number of elements, size contains the size
  41                                         of all bits and must be dividable by vector_elem */
  42
  43   /* ----------------------------------------------------------------------- */
  44   tarval            *min;       /**< the minimum value that can be expressed */
  45   tarval            *max;       /**< the maximum value that can be expressed */
  46   tarval            *null;      /**< the value 0 */
  47   tarval            *one;       /**< the value 1 */
  48   tarval            *minus_one; /**< the value -1 */
  49   void              *link;      /**< To store some intermediate information */
  50   const void        *tv_priv;   /**< tarval module will save private data here */
  51 };
  52
  53
  54 /* ------------------------------- *
  55  * inline functions                *
  56  * ------------------------------- */
  57 extern ir_mode *mode_P_code, *mode_P_data;
  58
  59 static INLINE ir_mode *
  60 _get_modeP_code(void) { return mode_P_code; }
  61
  62 static INLINE ir_mode *
  63 _get_modeP_data(void) { return mode_P_data; }
  64
  65 static INLINE modecode
  66 _get_mode_modecode(const ir_mode *mode) { return mode->code; }
  67
  68 static INLINE ident *
  69 _get_mode_ident(const ir_mode *mode) { return mode->name; }
  70
  71 static INLINE mode_sort
  72 _get_mode_sort(const ir_mode* mode) { return mode->sort; }
  73
  74 static INLINE int
  75 _get_mode_size_bits(const ir_mode *mode) { return mode->size; }
  76
  77 static INLINE int
  78 _get_mode_size_bytes(const ir_mode *mode) {
  79   int size = _get_mode_size_bits(mode);
  80   if ((size & 7) != 0) return -1;
  81   return size >> 3;
  82 }
  83
  84 static INLINE int
  85 _get_mode_sign(const ir_mode *mode) { return mode->sign; }
  86
  87 static INLINE int
  88 _get_mode_arithmetic(const ir_mode *mode) { return mode->arithmetic; }
  89
  90 static INLINE unsigned int
  91 _get_mode_modulo_shift(const ir_mode *mode) { return mode->modulo_shift; }
  92
  93 static INLINE unsigned int
  94 _get_mode_vector_elems(const ir_mode *mode) { return mode->vector_elem; }
  95
  96 static INLINE void *
  97 _get_mode_link(const ir_mode *mode) { return mode->link; }
  98
  99 static INLINE void
 100 _set_mode_link(ir_mode *mode, void *l) { mode->link = l; }
 101
 102 /* Functions to check, whether a modecode is signed, float, int, num, data,
 103    datab or dataM. For more exact definitions read the corresponding pages
 104    in the firm documentation or the followingenumeration
 105
 106    The set of "float" is defined as:
 107    ---------------------------------
 108    float = {irm_F, irm_D, irm_E}
 109
 110    The set of "int" is defined as:
 111    -------------------------------
 112    int   = {irm_Bs, irm_Bu, irm_Hs, irm_Hu, irm_Is, irm_Iu, irm_Ls, irm_Lu}
 113
 114    The set of "num" is defined as:
 115    -------------------------------
 116    num   = {irm_F, irm_D, irm_E, irm_Bs, irm_Bu, irm_Hs, irm_Hu,
 117             irm_Is, irm_Iu, irm_Ls, irm_Lu}
 118             = {float || int}
 119
 120    The set of "data" is defined as:
 121    -------------------------------
 122    data  = {irm_F, irm_D, irm_E irm_Bs, irm_Bu, irm_Hs, irm_Hu,
 123             irm_Is, irm_Iu, irm_Ls, irm_Lu, irm_C, irm_U, irm_P}
 124             = {num || irm_C || irm_U || irm_P}
 125
 126    The set of "datab" is defined as:
 127    ---------------------------------
 128    datab = {irm_F, irm_D, irm_E, irm_Bs, irm_Bu, irm_Hs, irm_Hu,
 129             irm_Is, irm_Iu, irm_Ls, irm_Lu, irm_C, irm_U, irm_P, irm_b}
 130             = {data || irm_b }
 131
 132    The set of "dataM" is defined as:
 133    ---------------------------------
 134    dataM = {irm_F, irm_D, irm_E, irm_Bs, irm_Bu, irm_Hs, irm_Hu,
 135             irm_Is, irm_Iu, irm_Ls, irm_Lu, irm_C, irm_U, irm_P, irm_M}
 136             = {data || irm_M}
 137 */
 138
 139 static INLINE int
 140 _mode_is_signed(const ir_mode *mode) {
 141   assert(mode);
 142   return mode->sign;
 143 }
 144
 145 static INLINE int
 146 _mode_is_float(const ir_mode *mode) {
 147   assert(mode);
 148   return (_get_mode_sort(mode) == irms_float_number);
 149 }
 150
 151 static INLINE int
 152 _mode_is_int(const ir_mode *mode) {
 153   assert(mode);
 154   return (_get_mode_sort(mode) == irms_int_number);
 155 }
 156
 157 static INLINE int
 158 _mode_is_character(const ir_mode *mode) {
 159   assert(mode);
 160   return (_get_mode_sort(mode) == irms_character);
 161 }
 162
 163 static INLINE int
 164 _mode_is_reference(const ir_mode *mode) {
 165   assert(mode);
 166   return (_get_mode_sort(mode) == irms_reference);
 167 }
 168
 169 static INLINE int
 170 _mode_is_num(const ir_mode *mode) {
 171   assert(mode);
 172   return (_mode_is_int(mode) || _mode_is_float(mode));
 173 }
 174
 175 static INLINE int
 176 _mode_is_numP(const ir_mode *mode) {
 177   assert(mode);
 178   return (_mode_is_int(mode) || _mode_is_float(mode) || _mode_is_reference(mode));
 179 }
 180
 181 static INLINE int
 182 _mode_is_data(const ir_mode *mode) {
 183   assert(mode);
 184   return (_mode_is_num(mode) || _get_mode_sort(mode) == irms_character || _get_mode_sort(mode) == irms_reference);
 185 }
 186
 187 static INLINE int
 188 _mode_is_datab(const ir_mode *mode) {
 189   assert(mode);
 190   return (_mode_is_data(mode) || _get_mode_sort(mode) == irms_internal_boolean);
 191 }
 192
 193 static INLINE int
 194 _mode_is_dataM(const ir_mode *mode) {
 195   assert(mode);
 196   return (_mode_is_data(mode) || _get_mode_modecode(mode) == irm_M);
 197 }
 198
 199 static INLINE int
 200 _mode_is_float_vector(const ir_mode *mode) {
 201   assert(mode);
 202   return (_get_mode_sort(mode) == irms_float_number) && (_get_mode_vector_elems(mode) > 1);
 203 }
 204
 205 static INLINE int
 206 _mode_is_int_vector(const ir_mode *mode) {
 207   assert(mode);
 208   return (_get_mode_sort(mode) == irms_int_number) && (_get_mode_vector_elems(mode) > 1);
 209 }
 210
 211 /** mode module initialization, call once before use of any other function **/
 212 void init_mode(void);
 213
 214 /** mode module finalization. frees all memory.  */
 215 void finish_mode(void);
 216
 217 #define get_modeP_code()               _get_modeP_code()
 218 #define get_modeP_data()               _get_modeP_data()
 219 #define get_mode_modecode(mode)        _get_mode_modecode(mode)
 220 #define get_mode_ident(mode)           _get_mode_ident(mode)
 221 #define get_mode_sort(mode)            _get_mode_sort(mode)
 222 #define get_mode_size_bits(mode)       _get_mode_size_bits(mode)
 223 #define get_mode_size_bytes(mode)      _get_mode_size_bytes(mode)
 224 #define get_mode_sign(mode)            _get_mode_sign(mode)
 225 #define get_mode_arithmetic(mode)      _get_mode_arithmetic(mode)
 226 #define get_mode_modulo_shift(mode)    _get_mode_modulo_shift(mode)
 227 #define get_mode_n_vector_elems(mode)  _get_mode_vector_elems(mode)
 228 #define get_mode_link(mode)            _get_mode_link(mode)
 229 #define set_mode_link(mode, l)         _set_mode_link(mode, l)
 230 #define mode_is_signed(mode)           _mode_is_signed(mode)
 231 #define mode_is_float(mode)            _mode_is_float(mode)
 232 #define mode_is_int(mode)              _mode_is_int(mode)
 233 #define mode_is_character(mode)        _mode_is_character(mode)
 234 #define mode_is_reference(mode)        _mode_is_reference(mode)
 235 #define mode_is_num(mode)              _mode_is_num(mode)
 236 #define mode_is_numP(mode)             _mode_is_numP(mode)
 237 #define mode_is_data(mode)             _mode_is_data(mode)
 238 #define mode_is_datab(mode)            _mode_is_datab(mode)
 239 #define mode_is_dataM(mode)            _mode_is_dataM(mode)
 240 #define mode_is_float_vector(mode)     _mode_is_float_vector(mode)
 241 #define mode_is_int_vector(mode)       _mode_is_int_vector(mode)
 242
 243 #endif /* _IRMODE_T_H_ */