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

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