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