nsz Git - libfirm/blob - include/libfirm/tv.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    Representation of and static computations on target machine
  23  *           values.
  24  * @date     2003
  25  * @author   Mathias Heil
  26  * @brief    target machine values.
  27  */
  28 #ifndef FIRM_TV_TV_H
  29 #define FIRM_TV_TV_H
  30
  31 #include <stddef.h>
  32 #include "firm_types.h"
  33
  34 #include "begin.h"
  35
  36 /** @defgroup ir_tarval  Target Machine Values
  37  *
  38  * Tarvals only represent values of mode_sort:
  39  *    - int_number,
  40  *    - float_number,
  41  *    - boolean,
  42  *    - reference,
  43  *    - character
  44  *
  45  *   In case of references the module accepts an entity to represent the
  46  *   value. Furthermore, computations and conversions of these values can
  47  *   be performed.
  48  *
  49  * @sa
  50  *    Techreport 1999-14
  51  *    irmode.h for the modes definitions
  52  *
  53  * @{
  54  */
  55
  56 /**
  57  * Constructor function for new tarvals.
  58  *
  59  * @param str   The string representing the target value
  60  * @param len   The length of the string
  61  * @param mode  The mode requested for the result tarval
  62  *
  63  * This function creates a new tarval representing the value represented
  64  * by a CString, aka char array. If a tarval representing this value already
  65  * exists, this tarval is returned instead of a new one. So tarvals are
  66  * directly comparable since their representation is unique.
  67  *
  68  * This function accepts the following strings:
  69  *
  70  * if mode is int_number:
  71  *  - 0(x|X)[0-9a-fA-F]+ (hexadecimal representation)
  72  *  - 0[0-7]*            (octal representation)
  73  *  - (+|-)?[1-9][0-9]*  (decimal representation)
  74  *
  75  * if mode is float_number:
  76  *  - (+|-)?(decimal int) (. (decimal int))? ((e|E)(+|-)?(decimal int))?
  77  *
  78  * if mode is boolean: true, True, TRUE ... False... 0, 1,
  79  *
  80  * if mode is reference: hexadecimal of decimal number as int
  81  *
  82  * if mode is character: hex or dec
  83  *
  84  * Leading and/or trailing spaces are ignored
  85  *
  86  * @return
  87  *   A tarval of proper type representing the requested value is returned.
  88  *   Tarvals are unique, so for any value/mode pair at most one tarval will
  89  *   exist, which will be returned upon further requests with an identical
  90  *   value/mode pair.
  91  *
  92  * @note
  93  *   If the string is not representable in the given mode an assertion is
  94  *   thrown in assert build.
  95  *
  96  * @sa
  97  *   irmode.h for predefined modes
  98  *   new_tarval_from_long()
  99  *   new_tarval_from_double()
 100  */
 101 FIRM_API ir_tarval *new_tarval_from_str(const char *str, size_t len,
 102                                         ir_mode *mode);
 103
 104 /**
 105  * Construct a new tarval from a given string.
 106  *
 107  * @param str   The string representing the target value
 108  * @param len   The length of the string
 109  * @param sign  is -1 or 1 depending on the numbers sign
 110  * @param base  number system base.
 111  *              binary(2), octal(8), decimal(10) and hexadecimal(16) numbers
 112  *              are supported.
 113  * @param mode  The mode requested for the result tarval
 114  *
 115  * @return
 116  *   A tarval with the given mode. If overflow settings are set to
 117  *   TV_OVERFLOW_BAD then a tarval_bad is returned if the number can't be
 118  *   represented in the given mode.
 119  *   Returns bad if the number couldn't successfully be parsed.
 120  */
 121 FIRM_API ir_tarval *new_integer_tarval_from_str(const char *str, size_t len,
 122                                                 char sign, unsigned char base,
 123                                                 ir_mode *mode);
 124
 125 /**
 126  * Constructor function for new tarvals
 127  *
 128  * @param l     The long representing the value
 129  * @param mode  The mode requested for the result tarval
 130  *
 131  * This function creates a new tarval representing the value represented
 132  * by a long integer. If a tarval representing this value already exists,
 133  * this tarval is returned instead of a new one. So tarvals are directly
 134  * comparable since their representation is unique.
 135  *
 136  * @return
 137  *   A tarval of proper type representing the requested value is returned.
 138  *   Tarvals are unique, so for any value/mode pair at most one tarval will
 139  *   exist, which will be returned upon further requests with an identical
 140  *   value/mode pair.
 141  *
 142  * @note
 143  *   If the long is not representable in the given mode an assertion is
 144  *   thrown in assert build.
 145  *
 146  * @sa
 147  *   irmode.h for predefined modes
 148  *   new_tarval_from_str()
 149  *   new_tarval_from_double()
 150  *
 151  */
 152 FIRM_API ir_tarval *new_tarval_from_long(long l, ir_mode *mode);
 153
 154 /** Returns value as long if possible.
 155  *
 156  * This returns a long int with the value represented value, or
 157  * gibberish, depending on the size of long int and the size of the
 158  * stored value. It works for e.g. 1 as mode_Ls, but might not work for
 159  * get_mode_max(mode_Ls).
 160  * This will overflow silently, so use only if you know what
 161  * you are doing! (better check with tarval_is_long()...)
 162  * Works only for int modes, even not for character modes!
 163  */
 164 FIRM_API long get_tarval_long(ir_tarval *tv);
 165
 166 /**
 167  * This validates if get_tarval_long() will return a satisfying
 168  * result. I.e. if tv is an int_number and between min, max
 169  * of long int (signed!)
 170  *
 171  * @param tv    the tarval
 172  */
 173 FIRM_API int tarval_is_long(ir_tarval *tv);
 174
 175 /**
 176  * Constructor function for new tarvals.
 177  *
 178  * @param d     The (long) double representing the value
 179  * @param mode  The mode requested for the result tarval
 180  *
 181  * This function creates a new tarval representing the value represented
 182  * by a (long) double. If a tarval representing this value already exists,
 183  * this tarval is returned instead of a new one. So tarvals are directly
 184  * comparable since their representation is unique.
 185  * Only modes of sort float_number can be constructed this way.
 186  *
 187  * @return
 188  *   A tarval of proper type representing the requested value is returned.
 189  *   Tarvals are unique, so for any value/mode pair at most one tarval will
 190  *   exist, which will be returned upon further requests with an identical
 191  *   value/mode pair.
 192  *
 193  * @note
 194  *   If the (long) double is not representable in the given mode an assertion
 195  *   is thrown. This will happen for any mode not of sort float_number.
 196  *
 197  * @sa
 198  *   irmode.h for predefined values
 199  *   new_tarval_from_str()
 200  *   new_tarval_from_long()
 201  */
 202 FIRM_API ir_tarval *new_tarval_from_double(double d, ir_mode *mode);
 203
 204 /**
 205  * same as new_tarval_from_double(), but with a long double argument
 206  */
 207 FIRM_API ir_tarval *new_tarval_from_long_double(long double d, ir_mode *mode);
 208
 209 /**
 210  * This returns a double with the value represented value, or
 211  * gibberish, depending on the size of double and the size of the
 212  * stored value.
 213  * This will overflow silently, so use only if you know what
 214  * you are doing! (better check with tarval_is_long...)
 215  *
 216  * @param tv    the tarval
 217  */
 218 FIRM_API double get_tarval_double(ir_tarval *tv);
 219
 220 /**
 221  * same as get_tarval_double but returns a long double value
 222  */
 223 FIRM_API long double get_tarval_long_double(ir_tarval *tv);
 224
 225 /**
 226  * This validates if tarval_to_double() will return a satisfying
 227  * result. I.e. if tv is an float_number and between min, max
 228  * of double
 229  *
 230  * @param tv    the tarval
 231  */
 232 FIRM_API int tarval_is_double(ir_tarval *tv);
 233
 234 /**
 235  * Returns the mode of the tarval.
 236  *
 237  * @param tv    the tarval
 238  */
 239 FIRM_API ir_mode *get_tarval_mode(const ir_tarval *tv);
 240
 241 /**
 242  * Returns 1 if tv is negative
 243  *
 244  * @param tv    the tarval
 245  */
 246 FIRM_API int tarval_is_negative(ir_tarval *tv);
 247
 248 /**
 249  * Returns 1 if tv is null
 250  *
 251  * @param tv    the tarval
 252  */
 253 FIRM_API int tarval_is_null(ir_tarval *tv);
 254
 255 /**
 256  * Returns 1 if tv is the "one"
 257  *
 258  * @param tv    the tarval
 259  */
 260 FIRM_API int tarval_is_one(ir_tarval *tv);
 261
 262 /**
 263  * Returns 1 if tv is the "minus one"
 264  *
 265  * @param tv    the tarval
 266  */
 267 FIRM_API int tarval_is_minus_one(ir_tarval *tv);
 268
 269 /**
 270  * returns non-zero if all bits in the tarval are set
 271  */
 272 FIRM_API int tarval_is_all_one(ir_tarval *tv);
 273
 274 /**
 275  * Returns non-zero if the tarval is a constant (ie. NOT
 276  * a reserved tarval like bad, undef, reachable etc.)
 277  */
 278 FIRM_API int tarval_is_constant(ir_tarval *tv);
 279
 280 /** The 'bad' tarval. */
 281 FIRM_API ir_tarval *tarval_bad;
 282 /** Returns the 'bad' tarval. */
 283 FIRM_API ir_tarval *get_tarval_bad(void);
 284
 285 /** The 'undefined' tarval. */
 286 FIRM_API ir_tarval *tarval_undefined;
 287 /** Returns the 'undefined' tarval. */
 288 FIRM_API ir_tarval *get_tarval_undefined(void);
 289
 290 /** The mode_b tarval 'false'. */
 291 FIRM_API ir_tarval *tarval_b_false;
 292 /** Returns the mode_b tarval 'false'. */
 293 FIRM_API ir_tarval *get_tarval_b_false(void);
 294
 295 /** The mode_b tarval 'true'. */
 296 FIRM_API ir_tarval *tarval_b_true;
 297 /** Returns the mode_b tarval 'true'. */
 298 FIRM_API ir_tarval *get_tarval_b_true(void);
 299
 300 /** The mode_X tarval 'unreachable'. */
 301 FIRM_API ir_tarval *tarval_unreachable;
 302 /** Returns the mode_X tarval 'unreachable'. */
 303 FIRM_API ir_tarval *get_tarval_unreachable(void);
 304
 305 /** The mode_X tarval 'reachable'. */
 306 FIRM_API ir_tarval *tarval_reachable;
 307 /** Returns the mode_X tarval 'reachable'. */
 308 FIRM_API ir_tarval *get_tarval_reachable(void);
 309
 310 /** The 'top' tarval. This is just another name for the 'undefined' tarval. */
 311 #define tarval_top          tarval_undefined
 312 /** Returns the 'top' tarval. */
 313 #define get_tarval_top()    get_tarval_undefined()
 314
 315 /** The 'bottom' tarval. This is just another name for the 'bad' tarval. */
 316 #define tarval_bottom       tarval_bad
 317 /** Returns the 'bottom' tarval. */
 318 #define get_tarval_bottom() get_tarval_bad()
 319
 320 /** Returns the maximum value of a given mode. */
 321 FIRM_API ir_tarval *get_tarval_max(ir_mode *mode);
 322
 323 /** Returns the minimum value of a given mode. */
 324 FIRM_API ir_tarval *get_tarval_min(ir_mode *mode);
 325
 326 /** Returns the 0 value (additive neutral) of a given mode.
 327     For reference modes, the NULL value is returned (old tarval_P_void) */
 328 FIRM_API ir_tarval *get_tarval_null(ir_mode *mode);
 329
 330 /** Returns the 1 value (multiplicative neutral) of a given mode. */
 331 FIRM_API ir_tarval *get_tarval_one(ir_mode *mode);
 332
 333 /** Returns the -1 value (multiplicative neutral) of a given mode.
 334  *  Returns tarval bad for unsigned modes */
 335 FIRM_API ir_tarval *get_tarval_minus_one(ir_mode *mode);
 336
 337 /** returns the value where all bits are 1 of a given mode.
 338  * returns tarval_bad for float modes */
 339 FIRM_API ir_tarval *get_tarval_all_one(ir_mode *mode);
 340
 341 /** Returns quite nan for float_number modes. */
 342 FIRM_API ir_tarval *get_tarval_nan(ir_mode *mode);
 343
 344 /** Returns +inf for float_number modes. */
 345 FIRM_API ir_tarval *get_tarval_plus_inf(ir_mode *mode);
 346
 347 /** Returns -inf for float_number modes. */
 348 FIRM_API ir_tarval *get_tarval_minus_inf(ir_mode *mode);
 349
 350 /** Modes for handling integer overflows. */
 351 typedef enum tarval_int_overflow_mode_t {
 352         TV_OVERFLOW_BAD,      /**< tarval module will return tarval_bad if a overflow occurs */
 353         TV_OVERFLOW_WRAP,     /**< tarval module will overflow will be ignored, wrap around occurs */
 354         TV_OVERFLOW_SATURATE  /**< tarval module will saturate the overflow */
 355 } tarval_int_overflow_mode_t;
 356
 357 /**
 358  * Sets the overflow mode for integer operations.
 359  *
 360  * @param ov_mode  one of the overflow modes
 361  */
 362 FIRM_API void tarval_set_integer_overflow_mode(tarval_int_overflow_mode_t ov_mode);
 363
 364 /**
 365  * Returns the overflow mode for integer operations.
 366  */
 367 FIRM_API tarval_int_overflow_mode_t tarval_get_integer_overflow_mode(void);
 368
 369 /**
 370  * Compares two tarvals
 371  *
 372  * Compare a with b and return their relation.
 373  * This is either ir_rel_unordered, ir_rel_less, ir_rel_greater, ir_rel_equal
 374  * or ir_rel_false if a or b are symbolic pointers which can not be compared at
 375  * all.
 376  *
 377  * @param a   the first tarval to be compared
 378  * @param b   the second tarval to be compared
 379  */
 380 FIRM_API ir_relation tarval_cmp(ir_tarval *a, ir_tarval *b);
 381
 382 /**
 383  * Converts a tarval to another mode.
 384  *
 385  * Convert tarval 'src' to mode 'mode', this will succeed if and only if mode
 386  * 'mode' is wider than the mode of src, as defined in the firm documentation
 387  * and as returned by the function mode_is_smaller defined in irmode.h.
 388  *
 389  * @param src    The tarval to convert
 390  * @param mode   Tho mode to convert to
 391  *
 392  * @return
 393  *   If a tarval of mode 'mode' with the result of the conversion of the 'src'
 394  *   tarvals value already exists, it will be returned, else a new tarval is
 395  *   constructed and returned
 396  *
 397  * @note
 398  *    Illegal convertions will trigger a panic
 399  *
 400  * @sa
 401  *    FIRM documentation for conversion rules
 402  *    mode_is_smaller defined in irmode.h
 403  */
 404 FIRM_API ir_tarval *tarval_convert_to(ir_tarval *src, ir_mode *mode);
 405
 406 /*
 407  * These function implement basic computations representable as opcodes
 408  * in FIRM nodes.
 409  *
 410  * PARAMETERS
 411  *    tarval_neg:
 412  *    traval_abs:
 413  *      a - the tarval to operate on
 414  *
 415  *    all others:
 416  *      a - the first operand tarval
 417  *      b - the second operand tarval
 418  *
 419  * RESULT
 420  *    If necessary a new tarval is constructed for the resulting value,
 421  *   or the one already carrying the computation result is retrieved and
 422  *   returned as result.
 423  *
 424  * NOTES
 425  *   The order the arguments are given in is important, imagine postfix
 426  *   notation.
 427  *   Illegal operations will trigger an assertion.
 428  *   The sort member of the struct mode defines which operations are valid
 429  */
 430
 431 /**
 432  * Bitwise Negation of a tarval.
 433  *
 434  * @param a  the first tarval
 435  *
 436  * @return ~a or tarval_bad
 437  */
 438 FIRM_API ir_tarval *tarval_not(ir_tarval *a);
 439
 440 /**
 441  * Arithmetic Negation of a tarval.
 442  *
 443  * @param a  the first tarval
 444  *
 445  * @return -a or tarval_bad
 446  */
 447 FIRM_API ir_tarval *tarval_neg(ir_tarval *a);
 448
 449 /**
 450  * Addition of two tarvals.
 451  *
 452  * @param a  the first tarval
 453  * @param b  the second tarval
 454  *
 455  * @return a + b or tarval_bad
 456  */
 457 FIRM_API ir_tarval *tarval_add(ir_tarval *a, ir_tarval *b);
 458
 459 /**
 460  * Subtraction from a tarval.
 461  *
 462  * @param a         the first tarval
 463  * @param b         the second tarval
 464  * @param dst_mode  the mode of the result, needed for mode_P - mode_P, else NULL
 465  *
 466  * @return a - b or tarval_bad
 467  */
 468 FIRM_API ir_tarval *tarval_sub(ir_tarval *a, ir_tarval *b, ir_mode *dst_mode);
 469
 470 /**
 471  * Multiplication of tarvals.
 472  *
 473  * @param a  the first tarval
 474  * @param b  the second tarval
 475  *
 476  * @return a * b or tarval_bad
 477  */
 478 FIRM_API ir_tarval *tarval_mul(ir_tarval *a, ir_tarval *b);
 479
 480 /**
 481  * Integer division of two tarvals.
 482  *
 483  * @param a  the first tarval
 484  * @param b  the second tarval
 485  *
 486  * @return a / b or tarval_bad
 487  */
 488 FIRM_API ir_tarval *tarval_div(ir_tarval *a, ir_tarval *b);
 489
 490 /**
 491  * Remainder of integer division.
 492  *
 493  * @param a  the first tarval
 494  * @param b  the second tarval
 495  *
 496  * @return a % b or tarval_bad
 497  */
 498 FIRM_API ir_tarval *tarval_mod(ir_tarval *a, ir_tarval *b);
 499
 500 /**
 501  * Integer division AND remainder.
 502  *
 503  * @param a        the first tarval
 504  * @param b        the second tarval
 505  * @param mod_res  after return, contains the remainder result, a % b or tarval_bad
 506  *
 507  * @return a / b or tarval_bad
 508  */
 509 FIRM_API ir_tarval *tarval_divmod(ir_tarval *a, ir_tarval *b, ir_tarval **mod_res);
 510
 511 /**
 512  * Absolute value of a tarval.
 513  *
 514  * @param a  the first tarval
 515  *
 516  * @return |a| or tarval_bad
 517  */
 518 FIRM_API ir_tarval *tarval_abs(ir_tarval *a);
 519
 520 /**
 521  * Bitwise and of two integer tarvals.
 522  *
 523  * @param a  the first tarval
 524  * @param b  the second tarval
 525  *
 526  * @return a & b or tarval_bad
 527  */
 528 FIRM_API ir_tarval *tarval_and(ir_tarval *a, ir_tarval *b);
 529
 530 /**
 531  * Bitwise and not of two integer tarvals.
 532  *
 533  * @param a  the first tarval
 534  * @param b  the second tarval
 535  *
 536  * @return a & ~b or tarval_bad
 537  */
 538 FIRM_API ir_tarval *tarval_andnot(ir_tarval *a, ir_tarval *b);
 539
 540 /**
 541  * Bitwise or of two integer tarvals.
 542  *
 543  * @param a  the first tarval
 544  * @param b  the second tarval
 545  *
 546  * @return a | b or tarval_bad
 547  */
 548 FIRM_API ir_tarval *tarval_or(ir_tarval *a, ir_tarval *b);
 549
 550 /**
 551  * Bitwise exclusive or of two integer tarvals.
 552  *
 553  * @param a  the first tarval
 554  * @param b  the second tarval
 555  *
 556  * @return a ^ b or tarval_bad
 557  */
 558 FIRM_API ir_tarval *tarval_eor(ir_tarval *a, ir_tarval *b);
 559
 560 /**
 561  * Logical Left shift.
 562  *
 563  * @param a  the first tarval
 564  * @param b  the second tarval
 565  *
 566  * @return a << b or tarval_bad
 567  */
 568 FIRM_API ir_tarval *tarval_shl(ir_tarval *a, ir_tarval *b);
 569
 570 /**
 571  * Unsigned (logical) right shift.
 572  *
 573  * @param a  the first tarval
 574  * @param b  the second tarval
 575  *
 576  * @return a >>u b or tarval_bad
 577  */
 578 FIRM_API ir_tarval *tarval_shr(ir_tarval *a, ir_tarval *b);
 579
 580 /**
 581  * Signed (arithmetic) right shift.
 582  *
 583  * @param a  the first tarval
 584  * @param b  the second tarval
 585  *
 586  * @return a >>s b or tarval_bad
 587  */
 588 FIRM_API ir_tarval *tarval_shrs(ir_tarval *a, ir_tarval *b);
 589
 590 /**
 591  * Rotation to left.
 592  *
 593  * @param a  the first tarval
 594  * @param b  the second tarval
 595  *
 596  * @return a \<\<L\>\> b or tarval_bad
 597  */
 598 FIRM_API ir_tarval *tarval_rotl(ir_tarval *a, ir_tarval *b);
 599
 600 /**
 601  * Returns the carry flag of the last operation.
 602  */
 603 FIRM_API int tarval_carry(void);
 604
 605 /**
 606  * The output mode for tarval values.
 607  *
 608  * Some modes allow more that one representation, for instance integers
 609  * can be represented hex or decimal. Of course it would be enough to have
 610  * one and let every backend convert it into the 'right' one.
 611  * However, we can do this in the tarval much simpler...
 612  */
 613 typedef enum {
 614         TVO_NATIVE,  /**< the default output mode, depends on the mode */
 615         TVO_HEX,     /**< use hex representation, always possible */
 616         TVO_DECIMAL, /**< use decimal representation */
 617         TVO_OCTAL,   /**< use octal representation */
 618         TVO_BINARY,  /**< use binary representation */
 619         TVO_FLOAT,   /**< use floating point representation (i.e 1.342e-2)*/
 620         TVO_HEXFLOAT /**< use hexadecimal floating point representation
 621                           (i.e 0x1.ea32p-12)*/
 622 } tv_output_mode;
 623
 624 /**
 625  * This structure contains helper information to format the output
 626  * of a tarval of a mode.
 627  */
 628 typedef struct tarval_mode_info {
 629         tv_output_mode mode_output;  /**< if != TVO_NATIVE select a special mode */
 630         const char *mode_prefix;     /**< if set, this prefix will be printed
 631                                           before a value of this mode */
 632         const char *mode_suffix;     /**< if set, this suffix will be printed
 633                                           after a value of this mode */
 634 } tarval_mode_info;
 635
 636 /**
 637  * Specify the output options of one mode.
 638  *
 639  * This functions stores the mode info, so DO NOT DESTROY it.
 640  *
 641  * @param mode      a ir_mode that should be associated
 642  * @param modeinfo  the output format info
 643  *
 644  * @return zero on success.
 645  */
 646 FIRM_API int set_tarval_mode_output_option(ir_mode *mode,
 647                                            const tarval_mode_info *modeinfo);
 648
 649 /**
 650  * Returns the output options of one mode.
 651  *
 652  * This functions returns the mode info of a given mode.
 653  *
 654  * @param mode      a ir_mode that should be associated
 655  *
 656  * @return the output option
 657  */
 658 FIRM_API const tarval_mode_info *get_tarval_mode_output_option(ir_mode *mode);
 659
 660 /**
 661  * Returns Bit representation of a tarval value, as string of '0' and '1'
 662  *
 663  * @param tv   The tarval
 664  *
 665  * This function returns a printable bit representation of any value
 666  * stored as tarval. This representation is a null terminated C string.
 667  *
 668  * @return
 669  *   As usual in C a pointer to a char is returned. The length of the
 670  *   returned string if fixed, just read as many chars as the mode defines
 671  *   as size.
 672  *
 673  * @note
 674  *   The string is allocated using malloc() and is free()ed on the next call
 675  *   of this function.
 676  *   The string consists of the ASCII characters '0' and '1' and is
 677  *   null terminated
 678  *
 679  * @sa
 680  *    irmode.h for the definition of the ir_mode struct
 681  *    the size member of aforementioned struct
 682  */
 683 FIRM_API char *get_tarval_bitpattern(ir_tarval *tv);
 684
 685 /**
 686  * Returns the bitpattern of the bytes_ofs byte.
 687  *
 688  * This function succeeds even if the mode of the tarval uses lesser bits
 689  * than requested, in that case the bitpattern is filled with zero bits.
 690  *
 691  * To query a 32bit value the following code can be used:
 692  *
 693  * val0 = tarval_sub_bits(tv, 0);  <- lowest bits
 694  * val1 = tarval_sub_bits(tv, 1);
 695  * val2 = tarval_sub_bits(tv, 2);
 696  * val3 = tarval_sub_bits(tv, 3);  <- highest bits
 697  *
 698  * Because this is the bit representation of the target machine, only the
 699  * following operations are legal on the result:
 700  *
 701  * - concatenation (endian dependence MUST be handled by the CALLER)
 702  * - bitwise logical operations to select/mask bits
 703  *
 704  * @param tv        the tarval
 705  * @param byte_ofs  the byte offset from lower to higher
 706  *
 707  * @note
 708  *   The result of this function is undefined if the mode is neither integer
 709  *   nor float.
 710  */
 711 FIRM_API unsigned char get_tarval_sub_bits(ir_tarval *tv, unsigned byte_ofs);
 712
 713 /**
 714  * Returns non-zero if a given (integer) tarval has only one single bit
 715  * set.
 716  *
 717  * @param tv    the tarval
 718  */
 719 FIRM_API int tarval_is_single_bit(ir_tarval *tv);
 720
 721 /**
 722  * Returns the number of set bits in a given (integer) tarval.
 723  *
 724  * @param tv    the tarval
 725  *
 726  * @return number of set bits or -1 on error
 727  */
 728 FIRM_API int get_tarval_popcount(ir_tarval *tv);
 729
 730 /**
 731  * Returns the number of the lowest set bit in a given (integer) tarval.
 732  *
 733  * @param tv    the tarval
 734  *
 735  * @return number of lowest set bit or -1 on error
 736  */
 737 FIRM_API int get_tarval_lowest_bit(ir_tarval *tv);
 738
 739 /**
 740  * Output a tarval to a string buffer.
 741  *
 742  * @param buf     the output buffer
 743  * @param buflen  the length of the buffer
 744  * @param tv      the tarval
 745  */
 746 FIRM_API int tarval_snprintf(char *buf, size_t buflen, ir_tarval *tv);
 747
 748 /**
 749  * Output a tarval to stdio.
 750  *
 751  * @param tv    the tarval
 752  */
 753 FIRM_API int tarval_printf(ir_tarval *tv);
 754
 755 /**
 756  * Returns non-zero if the mantissa of a floating point tarval is zero
 757  * (i.e. 1.0Exxx)
 758  *
 759  * @param tv    the tarval
 760  */
 761 FIRM_API int tarval_zero_mantissa(ir_tarval *tv);
 762
 763 /**
 764  * Returns the exponent of a floating point IEEE-754
 765  * tarval.
 766  *
 767  * @param tv    the tarval
 768  */
 769 FIRM_API int tarval_get_exponent(ir_tarval *tv);
 770
 771 /**
 772  * Check if the tarval can be converted to the given mode without
 773  * precision loss.
 774  *
 775  * @param tv    the tarval
 776  * @param mode  the mode to convert to
 777  */
 778 FIRM_API int tarval_ieee754_can_conv_lossless(ir_tarval *tv, ir_mode *mode);
 779
 780 /**
 781  * Returns non-zero if the result of the last IEEE-754 operation was exact.
 782  */
 783 FIRM_API unsigned tarval_ieee754_get_exact(void);
 784
 785 /**
 786  * Enable/Disable floating point constant folding.
 787  */
 788 FIRM_API void tarval_enable_fp_ops(int enable);
 789
 790 /** returns 0/1 if floating point folding is enable/disabled */
 791 FIRM_API int tarval_fp_ops_enabled(void);
 792
 793 /**
 794  * Check if its the a floating point NaN.
 795  *
 796  * @param tv    the tarval
 797  */
 798 FIRM_API int tarval_is_NaN(ir_tarval *tv);
 799
 800 /**
 801  * Check if its the a floating point +inf.
 802  *
 803  * @param tv    the tarval
 804  */
 805 FIRM_API int tarval_is_plus_inf(ir_tarval *tv);
 806
 807 /**
 808  * Check if its the a floating point -inf.
 809  *
 810  * @param tv    the tarval
 811  */
 812 FIRM_API int tarval_is_minus_inf(ir_tarval *tv);
 813
 814 /**
 815  * Check if the tarval represents a finite value, ie neither NaN nor inf.
 816  *
 817  * @param tv    the tarval
 818  */
 819 FIRM_API int tarval_is_finite(ir_tarval *tv);
 820
 821 /**
 822  *   Checks whether a pointer points to a tarval.
 823  *
 824  *   @param thing     an arbitrary pointer
 825  *
 826  *   @return
 827  *       true if the thing is a tarval, else false
 828  */
 829 FIRM_API int is_tarval(const void *thing);
 830
 831 /** @} */
 832
 833 #include "end.h"
 834
 835 #endif