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

   1 /* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
   2  * All rights reserved.
   3  */
   4 /* $Id$ */
   5
   6 /**
   7  * @file irmode.h
   8  *    irmode -- Modes for ir operators
   9  *
  10  * @author Christian Schaefer, Matthias Heil
  11  *
  12  * This module specifies the modes that type the firm nodes.  It defines
  13  * a datasturcture that describes a mode and implements constructors and
  14  * access routines to this datastructure. Further it defines a set of
  15  * predefined modes.
  16  *
  17  * SEE ALSO:
  18  *    UKA tech report 1999-44 for more information about modes.
  19  *
  20  */
  21 #ifndef _IRMODE_H_
  22 #define _IRMODE_H_
  23
  24 #include "ident.h"
  25
  26 #ifndef _TARVAL_TYPEDEF_
  27 #define _TARVAL_TYPEDEF_
  28   typedef struct tarval tarval;
  29 #endif
  30
  31 /**
  32  * Contains relevant information about a mode.
  33  *
  34  * Neccessary information about a mode is stored in this struct
  35  * which is used by the tarval module to perform calculations
  36  * and comparisons of values of a such described mode.
  37  *
  38  * ATTRIBUTES:
  39  *  -  modecode code:           An unambigous int (enum) for the mode
  40  *  -  ident *name:             Name of this mode. Two modes are different if the name is different.
  41  *  -  mode_sort sort:          sort of mode specifying possible usage kategories
  42  *  -  int    size:             size of the mode in Bits.
  43  *  -  int    align:            byte alignment
  44  *  -  unsigned sign:1:         signedness of this mode
  45  *  -  ... more to come
  46  *
  47  * SEE ALSO:
  48  *    The tech report 1999-44 describing FIRM and predefined modes
  49  *    tarval.h
  50  */
  51 typedef struct ir_mode ir_mode;
  52
  53 /* ********** Predefined modes ********** */
  54
  55 /**
  56  * Predefined mode according to tech report 1999-14.
  57  */
  58 typedef enum { /* irm is short for `ir mode' */
  59   irm_BB,                       /**< basic block */
  60   irm_X,                        /**< execution */
  61   irm_F,                        /**< float(32) */
  62   irm_D,                        /**< double(64) */
  63   irm_E,                        /**< extended(80) */
  64   irm_Bs,                       /**< signed byte(8) */
  65   irm_Bu,                       /**< unsigned byte(8) */
  66   irm_Hs,                       /**< signed short(16) */
  67   irm_Hu,                       /**< unsigned short(16) */
  68   irm_Is,                       /**< signed int(32) */
  69   irm_Iu,                       /**< unsigned int(32) */
  70   irm_Ls,                       /**< signed long(64) */
  71   irm_Lu,                       /**< unsigned long(64) */
  72   irm_C,                        /**< character */
  73   irm_P,                        /**< pointer */
  74   irm_b,                        /**< internal boolean */
  75   irm_M,                        /**< memory */
  76   irm_T,                        /**< tuple */
  77   irm_U,                        /**< unicode character */
  78   irm_ANY,                      /**< undefined mode */
  79   irm_BAD,                      /**< bad mode */
  80   irm_max                       /**< maximum value for modecode */
  81 } modecode;
  82
  83 /** These values represent the different mode classes of value representations.
  84  */
  85 typedef enum {
  86   /* Predefined sorts of modes */
  87   irms_auxiliary,         /**< Only for Firm use. Not extensible. (irm_T, irm_ANY, irm_BAD) */
  88   /* irms_control_flow    **< Marks all control flow modes. Not extensible. (irm_BB, irm_X) */
  89   /* irms_memory          **< Marks the memory mode.  Not extensible. (irm_M) */
  90   irms_internal_boolean,  /**< Internal boolean representation.
  91                                Storing to memory impossible, convert first. (irm_b) */
  92   /** user-extensible sorts of modes **/
  93   irms_int_number,        /**< A mode to represent int numbers.
  94                                Integer computations can be performed. */
  95   irms_float_number,      /**< A mode to represent float numbers.
  96                                Floating point computations can be performed. */
  97   irms_reference,         /**< A mode to represent entities.
  98                                Restricted int computations can be performed */
  99   irms_character          /**< A mode to represent characters/symbols
 100                                ?? Are computations allowed? as int?? */
 101 } mode_sort;
 102
 103 /** These values represent the different arithmetic operations possible with a mode.
 104     Further arithmetics can be defined, e.g., for @@@ modes.
 105  */
 106 typedef enum {
 107   irma_uninitialized = 0,
 108   irma_none = 1,              /**< For modes for which no representation is specified.
 109                                    These are modes of sort auxiliary, internal_boolean and
 110                                    character. */
 111   irma_twos_complement = 2,   /**< Values of the mode are represented as two's complement.
 112                                    Only legal for modes of sort int_number and reference. */
 113   irma_ones_complement,       /**< Values of the mode are represented  as one's complement.
 114                                    Only legal for modes of sort int_number and reference. */
 115   irma_int_BCD,               /**< Values of the mode are represented as binary coded decimals.
 116                                    Only legal for modes of sort int_number and reference. */
 117   irma_ieee754 = 256,         /**< Values of the mode are represented according to ieee754
 118                                    floatingpoint standard.  Only legal for modes of sort float_number. */
 119   irma_float_BCD,             /**< Values of the mode are represented  as binary coded decimals
 120                                    according to @@@ which standars??? Only legal for modes of
 121                                    sort float_number. */
 122   irma_max
 123 } mode_arithmetic;
 124
 125
 126 /* ********** Constructor for user defined modes **************** */
 127 /**
 128  * Creates a new mode.
 129  *
 130  * @param name          the name of the mode to be created
 131  * @param sort          the mode_sort of the mode to be created
 132  * @param bit_size      number of bits this mode allocate
 133  * @param align         the byte alignment for an entity of this mode (in bits)
 134  * @param sign          non-zero if this is a signed mode
 135  *
 136  * This function constructs a new mode given by the parameters.
 137  * If the parameters match an already defined mode, this mode is returned
 138  * (including the default modes).
 139  * If the mode is newly allocated, a new unique mode_code is choosen.
 140  * Also, special value tarvals will be calculated such as null,
 141  * min, max and can be retrieved using the get_mode_* fuctions
 142  *
 143  * @return
 144  *      The new mode or NULL on error.
 145  *
 146  * @note
 147  *      It is allowed to construct the default modes. So, a call
 148  *      new_ir_mode("Is", irms_int_number, 32, 4, 1) will return mode_Is.
 149  */
 150 ir_mode *new_ir_mode(const char *name, mode_sort sort, int bit_size, int align, int sign);
 151
 152 /* ********** Access methods to read mode information *********** */
 153
 154 /** Returns the classification of the mode */
 155 modecode get_mode_modecode(const ir_mode *mode);
 156
 157 /** Returns the ident* of the mode */
 158 ident *get_mode_ident(const ir_mode *mode);
 159
 160 /** Returns the null-terminated name of this mode. */
 161 const char *get_mode_name(const ir_mode *mode);
 162
 163 /** Returns a coarse classification of the mode. */
 164 mode_sort get_mode_sort(const ir_mode *mode);
 165
 166 /** Returns the size of values of the mode in bits. */
 167 int get_mode_size_bits(const ir_mode *mode);
 168
 169 /** Returns the size of values of the mode in bytes.  If the size is not
 170     dividable by 8 returns -1. */
 171 int get_mode_size_bytes(const ir_mode *mode);
 172
 173 /** Returns the alignment of values of the mode in bytes. */
 174 int get_mode_align(const ir_mode *mode);
 175
 176 /** Returns the signess of a mode */
 177 int get_mode_sign (const ir_mode *mode);
 178
 179 /**
 180  * Returns the smallest representable value of a given mode.
 181  *
 182  * For modes of the sort float_number this is the most negative value
 183  * bigger than -infinit.
 184  */
 185 tarval *get_mode_min(ir_mode *mode);
 186
 187 /**
 188  * Returns the biggest representable value o f a given mode.
 189  *
 190  * For modes of the sort float_number this is the largest value lower
 191  * than infinit.
 192  */
 193 tarval *get_mode_max(ir_mode *mode);
 194
 195 /**
 196  * Returns the value Zero represented in this mode.
 197  *
 198  * Zero is the additive neutral element and as such
 199  * is defined only for modes allowing addition, i.e.
 200  * floats and ints, and references (NULL-Pointer)
 201  * else returns tarval_bad.
 202  */
 203 tarval *get_mode_null(ir_mode *mode);
 204
 205 /**
 206  * Returns the value One, represented in this mode.
 207  *
 208  * One, being the multiplicative neutral element,
 209  * is defined only for modes allowing multiplication,
 210  * i.e. ints and floats.
 211  */
 212 tarval *get_mode_one(ir_mode *mode);
 213
 214 /**
 215  * Returns the positive infinite value of a mode.
 216  *
 217  * This is only valid for float_numbers, other modes
 218  * will result in tarval_bad.
 219  */
 220 tarval *get_mode_infinite(ir_mode *mode);
 221
 222 /**
 223  * Returns the NAN value of a given mode.
 224  *
 225  * This is only valid for float_numbers, other modes
 226  * will result in tarval_bad.
 227  */
 228 tarval *get_mode_NAN(ir_mode *mode);
 229
 230 /* -- Auxiliary modes necessary for the Firm representation -- */
 231 extern ir_mode *mode_T;  /**< tuple (none) */
 232 extern ir_mode *mode_X;  /**< execution */
 233 extern ir_mode *mode_M;  /**< memory */
 234 extern ir_mode *mode_BB; /**< block */
 235
 236 /* -- A set of predifined, numerical modes according to Techreport 1999-44 -- */
 237 extern ir_mode *mode_F;  /**< signed float(32) */
 238 extern ir_mode *mode_D;  /**< signed double(64) */
 239 extern ir_mode *mode_E;  /**< signed extended(80) */
 240 extern ir_mode *mode_Bs; /**< signed byte (former char) */
 241 extern ir_mode *mode_Bu; /**< unsigned byte (former char) */
 242 extern ir_mode *mode_Hs; /**< signed short integer */
 243 extern ir_mode *mode_Hu; /**< unsigened short integer */
 244 extern ir_mode *mode_Is; /**< signed integer */
 245 extern ir_mode *mode_Iu; /**< unsigned integer */
 246 extern ir_mode *mode_Ls; /**< signed long integer */
 247 extern ir_mode *mode_Lu; /**< unsigned long integer */
 248
 249 extern ir_mode *mode_b;  /**< internal boolean */
 250 extern ir_mode *mode_C;  /**< 8 bit char */
 251 extern ir_mode *mode_U;  /**< 16 bit unicode char */
 252 extern ir_mode *mode_P;  /**< pointer */
 253
 254 extern ir_mode *mode_ANY;/**< undefined mode */
 255 extern ir_mode *mode_BAD;/**< bad mode */
 256
 257 /*@{*/
 258 /** Access routines for JNI Interface */
 259 ir_mode *get_modeT(void);
 260 ir_mode *get_modeF(void);
 261 ir_mode *get_modeD(void);
 262 ir_mode *get_modeE(void);
 263 ir_mode *get_modeBs(void);
 264 ir_mode *get_modeBu(void);
 265 ir_mode *get_modeHs(void);
 266 ir_mode *get_modeHu(void);
 267 ir_mode *get_modeIs(void);
 268 ir_mode *get_modeIu(void);
 269 ir_mode *get_modeLs(void);
 270 ir_mode *get_modeLu(void);
 271 ir_mode *get_modeC(void);
 272 ir_mode *get_modeU(void);
 273 ir_mode *get_modeP(void);
 274 ir_mode *get_modeb(void);
 275 ir_mode *get_modeX(void);
 276 ir_mode *get_modeM(void);
 277 ir_mode *get_modeBB(void);
 278 ir_mode *get_modeANY(void);
 279 ir_mode *get_modeBAD(void);
 280
 281 /**
 282    Functions to check, whether a modecode is signed, float, int, num, data,
 283    datab or dataM.
 284
 285    For more exact definitions read the corresponding pages
 286    in the firm documentation or the following enumeration
 287
 288    The set of "float" is defined as:
 289    float = {irm_F, irm_D, irm_E}
 290
 291    The set of "int" is defined as:
 292    int   = {irm_Bs, irm_Bu, irm_Hs, irm_Hu, irm_Is, irm_Iu, irm_Ls, irm_Lu}
 293
 294    The set of "num" is defined as:
 295    num   = {irm_F, irm_D, irm_E, irm_Bs, irm_Bu, irm_Hs, irm_Hu,
 296             irm_Is, irm_Iu, irm_Ls, irm_Lu}
 297             = {float || int}
 298
 299    The set of "data" is defined as:
 300    data  = {irm_F, irm_D, irm_E irm_Bs, irm_Bu, irm_Hs, irm_Hu,
 301             irm_Is, irm_Iu, irm_Ls, irm_Lu, irm_C, irm_U, irm_P}
 302             = {num || irm_C || irm_P}
 303
 304    The set of "datab" is defined as:
 305    datab = {irm_F, irm_D, irm_E, irm_Bs, irm_Bu, irm_Hs, irm_Hu,
 306             irm_Is, irm_Iu, irm_Ls, irm_Lu, irm_C, irm_U, irm_P, irm_b}
 307             = {data || irm_b }
 308
 309    The set of "dataM" is defined as:
 310    dataM = {irm_F, irm_D, irm_E, irm_Bs, irm_Bu, irm_Hs, irm_Hu,
 311             irm_Is, irm_Iu, irm_Ls, irm_Lu, irm_C, irm_U, irm_P, irm_M}
 312             = {data || irm_M}
 313 */
 314 /*@}*/
 315 /* Test for a certain class of modes. */
 316 int mode_is_signed (const ir_mode *mode);
 317 int mode_is_float (const ir_mode *mode);
 318 int mode_is_int (const ir_mode *mode);
 319 int mode_is_character (const ir_mode *mode);
 320 int mode_is_reference (const ir_mode *mode);
 321 int mode_is_num (const ir_mode *mode);
 322 int mode_is_data (const ir_mode *mode);
 323 int mode_is_datab (const ir_mode *mode);
 324 int mode_is_dataM (const ir_mode *mode);
 325
 326 /** Returns true if sm can be converted to lm without loss
 327    according to firm definiton */
 328 int smaller_mode(const ir_mode *sm, const ir_mode *lm);
 329
 330 /** mode module initialization, call once before use of any other function **/
 331 void init_mode (void);
 332
 333 #endif /* _IRMODE_H_ */