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

   1 /*
   2  * Project:     libFIRM
   3  * File name:   ir/ir/irmode.h
   4  * Purpose:     Data modes of operations.
   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  * @file irmode.h
  15  *    irmode -- Modes for ir operators
  16  *
  17  * @author Christian Schaefer, Matthias Heil
  18  *
  19  * This module specifies the modes that type the firm nodes.  It defines
  20  * a datasturcture that describes a mode and implements constructors and
  21  * access routines to this datastructure. Further it defines a set of
  22  * predefined modes.
  23  *
  24  * SEE ALSO:
  25  *    UKA tech report 1999-44 for more information about modes.
  26  *
  27  */
  28
  29 #ifndef _IRMODE_H_
  30 #define _IRMODE_H_
  31
  32 #include "firm_types.h"
  33 #include "ident.h"
  34
  35 /**
  36  * Contains relevant information about a mode.
  37  *
  38  * Necessary information about a mode is stored in this struct
  39  * which is used by the tarval module to perform calculations
  40  * and comparisons of values of a such described mode.
  41  *
  42  * ATTRIBUTES:
  43  *  -  modecode code:           An unambiguous int (enum) for the mode
  44  *  -  ident *name:             Name of this mode. Two modes are different if the name is different.
  45  *  -  mode_sort sort:          sort of mode specifying possible usage categories
  46  *  -  int    size:             size of the mode in Bits.
  47  *  -  unsigned sign:1:         signedness of this mode
  48  *  -  ... more to come
  49  *  -  modulo_shift             specifies for modes of kind irms_int_number
  50  *                              whether shift applies modulo to value of bits to shift
  51  *
  52  * SEE ALSO:
  53  *    The tech report 1999-44 describing FIRM and predefined modes
  54  *    tarval.h
  55  */
  56 typedef struct ir_mode ir_mode;
  57
  58 /* ********** Predefined modes ********** */
  59
  60 /**
  61  * Predefined mode according to tech report 1999-14.
  62  */
  63 typedef enum { /* irm is short for `ir mode' */
  64   irm_BB,                       /**< basic block */
  65   irm_X,                        /**< execution */
  66   irm_F,                        /**< float(32) */
  67   irm_D,                        /**< double(64) */
  68   irm_E,                        /**< extended(80) */
  69   irm_Bs,                       /**< signed byte(8) */
  70   irm_Bu,                       /**< unsigned byte(8) */
  71   irm_Hs,                       /**< signed short(16) */
  72   irm_Hu,                       /**< unsigned short(16) */
  73   irm_Is,                       /**< signed int(32) */
  74   irm_Iu,                       /**< unsigned int(32) */
  75   irm_Ls,                       /**< signed long(64) */
  76   irm_Lu,                       /**< unsigned long(64) */
  77   irm_C,                        /**< character */
  78   irm_P,                        /**< pointer */
  79   irm_b,                        /**< internal boolean */
  80   irm_M,                        /**< memory */
  81   irm_T,                        /**< tuple */
  82   irm_U,                        /**< unicode character */
  83   irm_ANY,                      /**< undefined mode */
  84   irm_BAD,                      /**< bad mode */
  85   irm_max                       /**< maximum value for modecode */
  86 } modecode;
  87
  88 /** These values represent the different mode classes of value representations.
  89  */
  90 typedef enum {
  91   /* Predefined sorts of modes */
  92   irms_auxiliary,         /**< Only for Firm use. Not extensible. (irm_T) */
  93   irms_control_flow,      /**< Marks all control flow modes. Not extensible. (irm_BB, irm_X) */
  94   irms_memory,            /**< Marks the memory mode.  Not extensible. (irm_M) */
  95   irms_internal_boolean,  /**< Internal boolean representation.
  96                                Storing to memory impossible, convert first. (irm_b) */
  97                             /** user-extensible sorts of modes **/
  98   irms_int_number,        /**< A mode to represent int numbers.
  99                                Integer computations can be performed. */
 100   irms_float_number,      /**< A mode to represent float numbers.
 101                                Floating point computations can be performed. */
 102   irms_reference,         /**< A mode to represent entities.
 103                                Restricted int computations can be performed */
 104   irms_character          /**< A mode to represent characters/symbols
 105                                ?? Are computations allowed? as int?? */
 106 } mode_sort;
 107
 108 /** These values represent the different arithmetic operations possible with a mode.
 109     Further arithmetics can be defined, e.g., for @@@ modes.
 110  */
 111 typedef enum {
 112   irma_uninitialized = 0,
 113   irma_none = 1,              /**< For modes for which no representation is specified.
 114                                    These are modes of sort auxiliary, internal_boolean and
 115                                    character. */
 116   irma_twos_complement = 2,   /**< Values of the mode are represented as two's complement.
 117                                    Only legal for modes of sort int_number and reference. */
 118   irma_ones_complement,       /**< Values of the mode are represented  as one's complement.
 119                                    Only legal for modes of sort int_number and reference. */
 120   irma_int_BCD,               /**< Values of the mode are represented as binary coded decimals.
 121                                    Only legal for modes of sort int_number and reference. */
 122   irma_ieee754 = 256,         /**< Values of the mode are represented according to ieee754
 123                                    floatingpoint standard.  Only legal for modes of sort float_number. */
 124   irma_float_BCD,             /**< Values of the mode are represented  as binary coded decimals
 125                                    according to @@@ which standards??? Only legal for modes of
 126                                    sort float_number. */
 127   irma_max
 128 } mode_arithmetic;
 129
 130
 131 /* ********** Constructor for user defined modes **************** */
 132 /**
 133  * Creates a new mode.
 134  *
 135  * @param name          the name of the mode to be created
 136  * @param sort          the mode_sort of the mode to be created
 137  * @param bit_size      number of bits this mode allocate
 138  * @param sign          non-zero if this is a signed mode
 139  * @param arithmetic    arithmetic operations possible with a mode
 140  * @param modulo_shift  Is ignored for modes other than integer.
 141  *
 142  * This function constructs a new mode given by the parameters.
 143  * If the parameters match an already defined mode, this mode is returned
 144  * (including the default modes).
 145  * If the mode is newly allocated, a new unique mode_code is chosen.
 146  * Also, special value tarvals will be calculated such as null,
 147  * min, max and can be retrieved using the get_mode_* functions
 148  *
 149  * @return
 150  *      The new mode or NULL on error.
 151  *
 152  * @note
 153  *      It is allowed to construct the default modes. So, a call
 154  *      new_ir_mode("Is", irms_int_number, 32, 1, irma_twos_complement, 32) will return mode_Is.
 155  */
 156 ir_mode *new_ir_mode(const char *name, mode_sort sort, int bit_size, int sign, mode_arithmetic arithmetic, unsigned int modulo_shift);
 157
 158 /**
 159  * Creates a new vector mode.
 160  *
 161  * @param name                the name of the mode to be created
 162  * @param sort                the mode_sort of the mode to be created
 163  * @param bit_size          number of bits for one element of this mode
 164  * @param num_of_elem   number of elements in this vector mode
 165  * @param sign                non-zero if this is a signed mode
 166  * @param arithmetic    arithmetic operations possible with a mode
 167  * @param modulo_shift  Is ignored for modes other than integer.
 168  *
 169  * This function constructs a new vector mode given by the parameters.
 170  * If the parameters match an already defined mode, this mode is returned.
 171  * If the mode is newly allocated, a new unique mode_code is chosen.
 172  * Also, special value tarvals will be calculated such as null,
 173  * min, max and can be retrieved using the get_mode_* functions
 174  *
 175  * @return
 176  *      The new mode or NULL on error.
 177  */
 178 ir_mode *new_ir_vector_mode(const char *name, mode_sort sort, int bit_size, unsigned num_of_elem, int sign,
 179                      mode_arithmetic arithmetic, unsigned int modulo_shift );
 180
 181 /**
 182  *   Checks whether a pointer points to a mode.
 183  *
 184  *   @param thing     an arbitrary pointer
 185  *
 186  *   @return
 187  *       true if the thing is a mode, else false
 188  */
 189 int is_mode(void *thing);
 190
 191 /* ********** Access methods to read mode information *********** */
 192
 193 /** Returns the classification of the mode */
 194 modecode    get_mode_modecode(const ir_mode *mode);
 195
 196 /** Returns the ident* of the mode */
 197 ident      *get_mode_ident(const ir_mode *mode);
 198
 199 /** Returns the null-terminated name of this mode. */
 200 const char *get_mode_name(const ir_mode *mode);
 201
 202 /** Returns a coarse classification of the mode. */
 203 mode_sort   get_mode_sort(const ir_mode *mode);
 204
 205 /** Returns the size of values of the mode in bits. */
 206 int get_mode_size_bits(const ir_mode *mode);
 207
 208 /** Returns the size of values of the mode in bytes.
 209  *  If the size is not dividable by 8 returns -1. */
 210 int get_mode_size_bytes(const ir_mode *mode);
 211
 212 /** Returns the signess of a mode.
 213  *
 214  * Returns the signess of a mode: 1 if mode is signed. */
 215 int get_mode_sign(const ir_mode *mode);
 216
 217 /** Returns the arithmetic of a mode */
 218 int get_mode_arithmetic(const ir_mode *mode);
 219
 220 /** Get the modulo shift attribute.
 221  *
 222  *  Attribute modulo shift specifies for modes of kind irms_int_number
 223  *  whether shift applies modulo to value of bits to shift.  Zero for
 224  *  modes that are not integer.
 225  */
 226 unsigned int get_mode_modulo_shift(const ir_mode *mode);
 227
 228 /** Return the number of vector elements.
 229  *
 230  *  Attribute vector_elem specifies the number of vector elements of
 231  *  a vector mode. For non-vector modes it returns 1 for data and 0
 232  *  for all other modes
 233  */
 234 unsigned int get_mode_n_vector_elems(const ir_mode *mode);
 235
 236 /** Returns the stored intermediate information. */
 237 void *get_mode_link(const ir_mode *mode);
 238
 239 /** Stores new intermediate information. */
 240 void  set_mode_link(ir_mode *mode, void *l);
 241
 242 /**
 243  * Returns the smallest representable value of a given mode.
 244  *
 245  * For modes of the sort float_number this is the most negative value
 246  * bigger than -infinite.
 247  */
 248 tarval *get_mode_min(ir_mode *mode);
 249
 250 /**
 251  * Returns the biggest representable value o f a given mode.
 252  *
 253  * For modes of the sort float_number this is the largest value lower
 254  * than infinite.
 255  */
 256 tarval *get_mode_max(ir_mode *mode);
 257
 258 /**
 259  * Returns the value Zero represented in this mode.
 260  *
 261  * Zero is the additive neutral element and as such
 262  * is defined only for modes allowing addition, i.e.
 263  * op_pin_state_floats and ints, and references (NULL-Pointer)
 264  * else returns tarval_bad.
 265  */
 266 tarval *get_mode_null(ir_mode *mode);
 267
 268 /**
 269  * Returns the value One, represented in this mode.
 270  *
 271  * One, being the multiplicative neutral element,
 272  * is defined only for modes allowing multiplication,
 273  * i.e. ints and floats.
 274  */
 275 tarval *get_mode_one(ir_mode *mode);
 276
 277 /**
 278  * Returns the value Minus One, represented in this mode.
 279  *
 280  * Minus One is defined only for modes allowing
 281  * multiplication with signed values, i.e. signed ints and floats.
 282  */
 283 tarval *get_mode_minus_one(ir_mode *mode);
 284
 285 /**
 286  * Returns the positive infinite value of a mode.
 287  *
 288  * This is only valid for float_numbers, other modes
 289  * will result in tarval_bad.
 290  */
 291 tarval *get_mode_infinite(ir_mode *mode);
 292
 293 /**
 294  * Returns the NAN value of a given mode.
 295  *
 296  * This is only valid for float_numbers, other modes
 297  * will result in tarval_bad.
 298  */
 299 tarval *get_mode_NAN(ir_mode *mode);
 300
 301 extern ir_mode *mode_M;  /**< memory */
 302
 303 /* -- A set of predefined, numerical modes according to Techreport 1999-44 -- */
 304 extern ir_mode *mode_F;  /**< signed float(32) */
 305 extern ir_mode *mode_D;  /**< signed double(64) */
 306 extern ir_mode *mode_E;  /**< signed extended(80) */
 307 extern ir_mode *mode_Bs; /**< signed byte (former char) */
 308 extern ir_mode *mode_Bu; /**< unsigned byte (former char) */
 309 extern ir_mode *mode_Hs; /**< signed short integer */
 310 extern ir_mode *mode_Hu; /**< unsigned short integer */
 311 extern ir_mode *mode_Is; /**< signed integer */
 312 extern ir_mode *mode_Iu; /**< unsigned integer */
 313 extern ir_mode *mode_Ls; /**< signed long integer */
 314 extern ir_mode *mode_Lu; /**< unsigned long integer */
 315
 316 extern ir_mode *mode_C;  /**< 8 bit char */
 317 extern ir_mode *mode_U;  /**< 16 bit unicode char */
 318
 319 extern ir_mode *mode_P;  /**< pointer */
 320 extern ir_mode *mode_P_code; /**< A pointer mode that is set by the client of libfirm.  This mode
 321                                represents the pointer size of the target machine code addresses. Is initialized
 322                                to mode_P. */
 323 extern ir_mode *mode_P_data; /**< A pointer mode that is set by the client of libfirm.  This mode
 324                                represents the pointer size of the target machine data addresses. Is initialized
 325                                to mode_P. */
 326
 327 /* -- Auxiliary modes necessary for the Firm representation -- */
 328 extern ir_mode *mode_b;  /**< internal boolean */
 329
 330 extern ir_mode *mode_X;  /**< execution */
 331 extern ir_mode *mode_BB; /**< block */
 332
 333 extern ir_mode *mode_T;  /**< tuple (none) */
 334 extern ir_mode *mode_ANY;/**< undefined mode */
 335 extern ir_mode *mode_BAD;/**< bad mode */
 336
 337 /*@{*/
 338 /** Access routines for JNI Interface */
 339 ir_mode *get_modeF(void);
 340 ir_mode *get_modeD(void);
 341 ir_mode *get_modeE(void);
 342 ir_mode *get_modeBs(void);
 343 ir_mode *get_modeBu(void);
 344 ir_mode *get_modeHs(void);
 345 ir_mode *get_modeHu(void);
 346 ir_mode *get_modeIs(void);
 347 ir_mode *get_modeIu(void);
 348 ir_mode *get_modeLs(void);
 349 ir_mode *get_modeLu(void);
 350 ir_mode *get_modeC(void);
 351 ir_mode *get_modeU(void);
 352 ir_mode *get_modeP(void);
 353 ir_mode *get_modeb(void);
 354 ir_mode *get_modeX(void);
 355 ir_mode *get_modeBB(void);
 356 ir_mode *get_modeM(void);
 357 ir_mode *get_modeT(void);
 358 ir_mode *get_modeANY(void);
 359 ir_mode *get_modeBAD(void);
 360
 361 /** Returns the machine specific pointer mode for code addresses. */
 362 ir_mode *get_modeP_code(void);
 363
 364 /** Returns the machine specific pointer mode for data addresses. */
 365 ir_mode *get_modeP_data(void);
 366
 367 /**
 368  * Sets the machine specific pointer mode for code addresses.
 369  * If not set, the predefined mode mode_P will be used.
 370  */
 371 void set_modeP_code(ir_mode *p);
 372
 373 /**
 374  * Sets the machine specific pointer mode for data addresses.
 375  * If not set, the predefined mode mode_P will be used.
 376  */
 377 void set_modeP_data(ir_mode *p);
 378
 379 /**
 380    Functions to check, whether a modecode is signed, float, int, character,
 381    reference, num, numP, data, datab or dataM.
 382
 383    For more exact definitions read the corresponding pages
 384    in the firm documentation or the following enumeration
 385
 386    The set of "float" is defined as:
 387    float = {irm_F, irm_D, irm_E}
 388
 389    The set of "int" is defined as:
 390    int   = {irm_Bs, irm_Bu, irm_Hs, irm_Hu, irm_Is, irm_Iu, irm_Ls, irm_Lu}
 391
 392    The set of "character" is defined as:
 393    character  = {irm_C, irm_U}
 394
 395    The set of "reference" is defined as:
 396    reference  = {irm_P}
 397
 398    The set of "num" is defined as:
 399    num   = {float || int}
 400
 401    The set of "numP" is defined as:
 402    numP  =  {float || int || reference}
 403
 404    The set of "data" is defined as:
 405    data  =  {num || character || reference}
 406
 407    The set of "datab" is defined as:
 408    datab =  {data || irm_b }
 409
 410    The set of "dataM" is defined as:
 411    dataM =  {data || irm_M}
 412
 413    Vector "int" and "float" are defined by the arithmetic and vector_elem > 1.
 414 */
 415 /*@}*/
 416 /* Test for a certain class of modes. */
 417 int mode_is_signed (const ir_mode *mode);
 418 int mode_is_float (const ir_mode *mode);
 419 int mode_is_int (const ir_mode *mode);
 420 int mode_is_character (const ir_mode *mode);
 421 int mode_is_reference (const ir_mode *mode);
 422 int mode_is_num (const ir_mode *mode);
 423 int mode_is_numP (const ir_mode *mode);
 424 int mode_is_data (const ir_mode *mode);
 425 int mode_is_datab (const ir_mode *mode);
 426 int mode_is_dataM (const ir_mode *mode);
 427 int mode_is_float_vector (const ir_mode *mode);
 428 int mode_is_int_vector (const ir_mode *mode);
 429
 430 /** Returns true if sm can be converted to lm without loss
 431    according to firm definiton */
 432 int smaller_mode(const ir_mode *sm, const ir_mode *lm);
 433
 434 /**
 435  * Returns a matching unsigned mode for a given integer signed mode.
 436  * Returns NULL if no matching mode exists.
 437  */
 438 ir_mode *find_unsigned_mode(const ir_mode *mode);
 439
 440 /**
 441  * Returns a matching signed mode for a given integer unsigned mode.
 442  * Returns NULL if no matching mode exists.
 443  */
 444 ir_mode *find_signed_mode(const ir_mode *mode);
 445
 446 /**
 447  * Returns an integer mode with 2*n bits for a given integer mode with n bits.
 448  * Returns NULL if no matching mode exists.
 449  */
 450 ir_mode *find_double_bits_int_mode(const ir_mode *mode);
 451
 452 /**
 453  * Returns non-zero if the given mode honors signed zero's, i.e.,
 454  * a +0 and a -0 exists and handled differently.
 455  */
 456 int mode_honor_signed_zeros(const ir_mode *mode);
 457
 458 /**
 459  * Returns non-zero if the given mode might overflow on unary Minus.
 460  */
 461 int mode_overflow_on_unary_Minus(const ir_mode *mode);
 462
 463 /**
 464  * Returns non-zero if the mode has a reversed wrap-aound
 465  * logic, especially (a + x) - x == a.
 466  * This is normally true for integer modes, not for floating
 467  * point modes.
 468  */
 469 int mode_wrap_around(const ir_mode *mode);
 470
 471 #endif /* _IRMODE_H_ */