3 * File name: ir/tv/tv.h
4 * Purpose: Representation of and static computations on target machine
10 * Copyright: (c) 2003 Universität Karlsruhe
11 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
17 * Declarations for Target Values.
25 # include "irnode.h" /* for pnc_number enum */
31 * tv -- TargetValue, short tarval.
32 * Internal representation for machine values.
38 * Tarvals represent target machine values. They are typed by modes.
39 * Tarvals only represent values of mode_sort:
46 * In case of references the module accepts an entity to represent the
48 * Furthermore, computations and conversions of these values can
52 * This module is closely related to the irmode module, as the modes
53 * defined there are thoroughly used throughout the whole module.
54 * Also, the comparison functions rely on the definition of comparison
55 * values in the irnode module.
58 * The original tv module originated in the fiasco compiler written ...
59 * This is the new version, described in the tech report 1999-14 by ...
63 * irmode.h for the modes definitions
64 * irnode.h for the pnc_numbers table
66 * tarval_init1 and tarval_init2 for initialization of the
71 #ifndef _TARVAL_TYPEDEF_
72 #define _TARVAL_TYPEDEF_
73 typedef struct tarval tarval;
76 /* ************************ Constructors for tarvals ************************ */
79 * Constructor function for new tarvals.
81 * @param str The string representing the target value
82 * @param len The length of the string
83 * @param mode The mode requested for the result tarval
85 * This function creates a new tarval representing the value represented
86 * by a CString, aka char array. If a tarval representing this value already
87 * exists, this tarval is returned instead of a new one. So tarvals are
88 * directly comparable since their representation is unique.
90 * This function accepts the following strings:
92 * if mode is int_number:
93 * - 0(x|X)[0-9a-fA-F]+ (hexadecimal representation)
94 * - 0[0-7]* (octal representation)
95 * - (+|-)?[1-9][0-9]* (decimal representation)
97 * if mode if float_number:
98 * - (+|-)?(decimal int) (. (decimal int))? ((e|E)(+|-)?(decimal int))?
100 * if mode is boolean: true, True, TRUE ... False... 0, 1,
102 * if mode is reference: hexadecimal of decimal number as int
104 * if mode is character: hex or dec
106 * Leading and/or trailing spaces are ignored
109 * A tarval of proper type representing the requested value is returned.
110 * Tarvals are unique, so for any value/mode pair at most one tarval will
111 * exist, which will be returned upon further requests with an identical
115 * If the string is not representable in the given mode an assertion is
116 * thrown in assert build.
119 * irmode.h for predefined modes
120 * new_tarval_from_long()
121 * new_tarval_from_double()
123 tarval *new_tarval_from_str(const char *str, size_t len, ir_mode *mode);
126 * Constructor function for new tarvals
128 * @param l The long representing the value
129 * @param mode The mode requested for the result tarval
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.
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
143 * If the long is not representable in the given mode an assertion is
144 * thrown in assert build.
147 * irmode.h for predefined modes
148 * new_tarval_from_str()
149 * new_tarval_from_double()
152 tarval *new_tarval_from_long(long l, ir_mode *mode);
155 * This returns a long int with the value represented value, or
156 * gibberish, depending on the size of long int and the size of the
157 * stored value. It works for e.g. 1 as mode_Ls, but might not work for
158 * get_mode_max(mode_Ls).
159 * This will overflow silently, so use only if you know what
160 * you are doing! (better check with tarval_is_long()...)
162 long tarval_to_long(tarval *tv);
165 * This validates if tarval_to_long() will return a satisfying
166 * result. I.e. if tv is an int_number and between min, max
167 * of long int (signed!)
169 int tarval_is_long(tarval *tv);
172 * Constructor function for new tarvals.
174 * @param d The (long) double representing the value
175 * @param mode The mode requested for the result tarval
177 * This function creates a new tarval representing the value represented
178 * by a (long) double. If a tarval representing this value already exists,
179 * this tarval is returned instead of a new one. So tarvals are directly
180 * comparable since their representation is unique.
181 * Only modes of sort float_number can be constructed this way.
184 * A tarval of proper type representing the requested value is returned.
185 * Tarvals are unique, so for any value/mode pair at most one tarval will
186 * exist, which will be returned upon further requests with an identical
190 * If the (long) double is not representable in the given mode an assertion
191 * is thrown. This will happen for any mode not of sort float_number.
194 * irmode.h for predefined values
195 * new_tarval_from_str()
196 * new_tarval_from_long()
198 tarval *new_tarval_from_double(long double d, ir_mode *mode);
201 * This returns a double with the value represented value, or
202 * gibberish, depending on the size of double and the size of the
204 * This will overflow silently, so use only if you know what
205 * you are doing! (better check with tarval_is_long...)
207 long double tarval_to_double(tarval *tv);
210 * This validates if tarval_to_double() will return a satisfying
211 * result. I.e. if tv is an float_number and between min, max
214 int tarval_is_double(tarval *tv);
217 * Construct a tarval that represents the address of the entity.
219 * The address must be constant, the entity must have as owner the global type.
221 tarval *new_tarval_from_entity (entity *ent, ir_mode *mode);
224 * Returns the associated entity of a tarval. Asserts if tarval does not
227 #define get_tarval_entity tarval_to_entity
228 entity *tarval_to_entity(tarval *tv);
231 * Returns non-zero if a the given tarval represents an entity.
233 int tarval_is_entity(tarval *tv);
235 /** ********** Access routines for tarval fields ********** **/
243 * ir_mode *get_tarval_mode(tarval *tv)
247 * These are access function for tarval struct members. It is encouraged
248 * to use them instead of direct access to the struct fields.
251 * tv - The tarval to access fields of
254 * get_tv_mode: The mode of the tarval
260 /** Returns the mode of the tarval. */
261 ir_mode *get_tarval_mode (tarval *tv);
263 /* Testing properties of the represented values */
266 * Returns 1 if tv is negative
268 * @param a the tarval
270 int tarval_is_negative(tarval *a);
273 * Returns 1 if tv is null
275 * @param a the tarval
277 int tarval_is_null(tarval *a);
280 * Returns 1 if tv is the "one"
282 * @param a the tarval
284 int tarval_is_one(tarval *a);
286 /** The 'bad' tarval. */
287 extern tarval *tarval_bad;
288 /** Returns the 'bad tarval. */
289 tarval *get_tarval_bad(void);
291 /** The 'undefined' tarval. */
292 extern tarval *tarval_undefined;
293 /** Returns the 'undefined' tarval. */
294 tarval *get_tarval_undefined(void);
296 /** The mode_b tarval 'false'. */
297 extern tarval *tarval_b_false;
298 /** Returns the mode_b tarval 'false'. */
299 tarval *get_tarval_b_false(void);
301 /** The mode_b tarval 'true'. */
302 extern tarval *tarval_b_true;
303 /** Returns the mode_b tarval 'true'. */
304 tarval *get_tarval_b_true(void);
306 /** The 'void' pointer tarval. */
307 extern tarval *tarval_P_void;
308 /** Returns the 'void' pointer tarval. */
309 tarval *get_tarval_P_void(void);
311 /* These functions calculate and return a tarval representing the requested
313 * The functions get_mode_{Max,Min,...} return tarvals retrieved from these
314 * functions, but these are stored on initialization of the irmode module and
315 * therefore the irmode functions should be prefered to the functions below. */
317 /** Returns the maximum value of a given mode. */
318 tarval *get_tarval_max(ir_mode *mode);
320 /** Returns the minimum value of a given mode. */
321 tarval *get_tarval_min(ir_mode *mode);
323 /** Returns the 0 value (additive neutral) of a given mode. */
324 tarval *get_tarval_null(ir_mode *mode);
326 /** Returns the 1 value (multiplicative neutral) of a given mode. */
327 tarval *get_tarval_one(ir_mode *mode);
329 /** Return quite nan for float_number modes. */
330 tarval *get_tarval_nan(ir_mode *mode);
332 /** Return +inf for float_number modes. */
333 tarval *get_tarval_inf(ir_mode *mode);
335 /* ******************** Arithmethic operations on tarvals ******************** */
338 * Compares two tarvals
340 * Compare a with b and return a pnc_number describing the relation
341 * between a and b. This is either Uo, Lt, Eq, Gt, or False if a or b
342 * are symbolic pointers which can not be compared at all.
344 * @param a A tarval to be compared
345 * @param b A tarval to be compared
348 * The pnc_number best describing the relation between a and b is returned.
349 * This means the mode with the least bits set is returned, e.g. if the
350 * tarvals are equal the pnc_number 'Eq' is returned, not 'Ge' which
351 * indicates 'greater or equal'
354 * irnode.h for the definition of pnc_numbers
356 pnc_number tarval_cmp(tarval *a, tarval *b);
359 * Converts a tarval to another mode.
361 * Convert tarval 'src' to mode 'mode', this will suceed if and only if mode
362 * 'mode' is wider than the mode of src, as defined in the firm documentation
363 * and as returned by the function mode_is_smaller defined in irmode.h.
365 * @param src The tarval to convert
366 * @param mode Tho mode to convert to
369 * If a tarval of mode 'mode' with the result of the conversion of the 'src'
370 * tarvals value already exists, it will be returned, else a new tarval is
371 * constructed and returned
374 * Illegal conversations will trigger an assertion
377 * FIRM documentation for conversion rules
378 * mode_is_smaller defined in irmode.h
380 tarval *tarval_convert_to(tarval *src, ir_mode *m);
383 * These function implement basic computations representable as opcodes
389 * a - the tarval to operate on
392 * a - the first operand tarval
393 * b - the second operand tarval
396 * If neccessary a new tarval is constructed for the resulting value,
397 * or the one already carrying the computation result is retrieved and
398 * returned as result.
401 * The order the arguments are given in is important, imagine postfix
403 * Illegal operations will trigger an assertion.
404 * The sort member of the struct mode defines which operations are valid
407 /** bitwise Negation of a tarval. */
408 tarval *tarval_not(tarval *a);
410 /** arithmetic Negation of a tarval. */
411 tarval *tarval_neg(tarval *a);
413 /** Addition of two tarvals. */
414 tarval *tarval_add(tarval *a, tarval *b);
416 /** Subtraction from a tarval. */
417 tarval *tarval_sub(tarval *a, tarval *b);
419 /** Multiplication of tarvals. */
420 tarval *tarval_mul(tarval *a, tarval *b);
422 /** 'Exact' division. */
423 tarval *tarval_quo(tarval *a, tarval *b);
425 /** Integer division. */
426 tarval *tarval_div(tarval *a, tarval *b);
428 /** Remainder of integer division. */
429 tarval *tarval_mod(tarval *a, tarval *b);
431 /** Absolute value. */
432 tarval *tarval_abs(tarval *a);
435 tarval *tarval_and(tarval *a, tarval *b);
438 tarval *tarval_or(tarval *a, tarval *b);
440 /** Bitwise exclusive or. */
441 tarval *tarval_eor(tarval *a, tarval *b);
444 tarval *tarval_shl(tarval *a, tarval *b);
446 /** Unsigned (logical) right shift. */
447 tarval *tarval_shr(tarval *a, tarval *b);
449 /** Signed (arithmetic) right shift. */
450 tarval *tarval_shrs(tarval *a, tarval *b);
453 tarval *tarval_rot(tarval *a, tarval *b);
455 /* *********** Output of tarvals *********** */
458 * The output mode for tarval values.
460 * Some modes allow more that one representation, for instance integers
461 * can be represented hex or decimal. Of course it would be enough to have
462 * one and let every backend convert it into the 'right' one.
463 * However, we can do this in the tarval much simplier...
466 TVO_NATIVE, /**< the default output mode, depends on the mode */
467 TVO_HEX, /**< use hex representation, always possible */
468 TVO_DECIMAL, /**< use decimal representation */
469 TVO_OCTAL, /**< use octal representation */
470 TVO_BINARY, /**< use binary representation */
471 TVO_FLOAT, /**< use floating point representation (i.e 1.342e-2)*/
472 TVO_HEXFLOAT /**< use hexadecimal floating point representation (i.e 0x1.ea32p-12)*/
476 * This structure contains helper information to format the output
477 * of a tarval of a mode.
479 typedef struct tarval_mode_info {
480 tv_output_mode mode_output; /**< if != TVO_NATIVE select a special mode */
481 const char *mode_prefix; /**< if set, this prefix will be printed
482 before a value of this mode */
483 const char *mode_suffix; /**< if set, this suffix will be printed
484 after a value of this mode */
488 * Specify the output options of one mode.
490 * This functions stores the modinfo, so DO NOT DESTROY it.
492 * @param mode a ir_mode that should be associated
493 * @param modeinfo the output format info
495 * @return zero on success.
497 int tarval_set_mode_output_option(ir_mode *mode, const tarval_mode_info *modeinfo);
500 * Returns the output options of one mode.
502 * This functions returns the modinfo of a given mode.
504 * @param mode a ir_mode that should be associated
506 * @return the output option
508 const tarval_mode_info *tarval_get_mode_output_option(ir_mode *mode);
511 * Returns Bit representation of a tarval value, as string of '0' and '1'
513 * @param tv The tarval
515 * This function returns a printable bit representation of any value
516 * stored as tarval. This representation is a null terminated C string.
519 * As usual in C a pointer to a char is returned. The length of the
520 * returned string if fixed, just read as many chars as the mode defines
524 * The string is allocated using malloc() and is free()ed on the next call
526 * The string consists of the ascii characters '0' and '1' and is
530 * irmode.h for the definition of the ir_mode struct
531 * the size member of aforementioned struct
533 char *tarval_bitpattern(tarval *tv);
536 * Returns the bitpattern of the bytes_ofs byte.
538 * This function succeeds even if the mode of the tarval uses lesser bits
539 * than requested, in that case the bitpattern is filled with zero bits.
541 * To query a 32bit value the following code can be used:
543 * val0 = tarval_sub_bits(tv, 0);
544 * val1 = tarval_sub_bits(tv, 1);
545 * val2 = tarval_sub_bits(tv, 2);
546 * val3 = tarval_sub_bits(tv, 3);
548 * Because this is the bit representation of the target machine, only the following
549 * operations are legal on the result:
551 * - concatenation (endian dependance MUST be handled by the CALLER)
552 * - bitwise logical operations to select/mask bits
554 * @param tv the tarval
555 * @param byte_ofs the byte offset
558 * The result of this funcion is undefined if the mode is neither integer nor float.
560 unsigned char tarval_sub_bits(tarval *tv, unsigned byte_ofs);
563 * Return values of tarval classify
565 typedef enum _tarval_classification_t {
566 TV_CLASSIFY_NULL = 0, /**< the tarval represents the additive neutral element */
567 TV_CLASSIFY_ONE = +1, /**< the tarval represents the multiplicative neutral element */
568 TV_CLASSIFY_ALL_ONE = -1, /**< the tarval represents the bitwise-and neutral element */
569 TV_CLASSIFY_OTHER = 2, /*<< all other tarvals */
570 } tarval_classification_t;
573 * Identifying tarvals values for algebraic simplifications.
576 * - TV_CLASSIFY_NULL for additive neutral,
577 * - TV_CLASSIFY_ONE for multiplicative neutral,
578 * - TV_CLASSIFY_ALL_ONE for bitwise-and neutral
579 * - TV_CLASSIFY_OTHER else
581 tarval_classification_t tarval_classify(tarval *tv);
584 * Initialization of the tarval module.
586 * Call before init_mode().
588 void init_tarval_1(void);
591 * Initialization of the tarval module.
593 * Call after init_mode().
595 void init_tarval_2(void);
598 * Output of tarvals to a buffer.
600 int tarval_snprintf(char *buf, size_t buflen, tarval *tv);
603 * Output of tarvals to stdio.
605 int tarval_printf(tarval *tv);