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