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