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);
154 /** Return value as long if possible.
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!
164 long tarval_to_long(tarval *tv);
165 #define get_tarval_long tarval_to_long
168 * This validates if tarval_to_long() will return a satisfying
169 * result. I.e. if tv is an int_number and between min, max
170 * of long int (signed!)
172 int tarval_is_long(tarval *tv);
175 * Constructor function for new tarvals.
177 * @param d The (long) double representing the value
178 * @param mode The mode requested for the result tarval
180 * This function creates a new tarval representing the value represented
181 * by a (long) double. If a tarval representing this value already exists,
182 * this tarval is returned instead of a new one. So tarvals are directly
183 * comparable since their representation is unique.
184 * Only modes of sort float_number can be constructed this way.
187 * A tarval of proper type representing the requested value is returned.
188 * Tarvals are unique, so for any value/mode pair at most one tarval will
189 * exist, which will be returned upon further requests with an identical
193 * If the (long) double is not representable in the given mode an assertion
194 * is thrown. This will happen for any mode not of sort float_number.
197 * irmode.h for predefined values
198 * new_tarval_from_str()
199 * new_tarval_from_long()
201 tarval *new_tarval_from_double(long double d, ir_mode *mode);
204 * This returns a double with the value represented value, or
205 * gibberish, depending on the size of double and the size of the
207 * This will overflow silently, so use only if you know what
208 * you are doing! (better check with tarval_is_long...)
210 long double tarval_to_double(tarval *tv);
213 * This validates if tarval_to_double() will return a satisfying
214 * result. I.e. if tv is an float_number and between min, max
217 int tarval_is_double(tarval *tv);
220 * Construct a tarval that represents the address of the entity.
222 * The address must be constant, the entity must have as owner the global type.
223 * We no more support this function: Use the new SymConst instead.
225 tarval *new_tarval_from_entity (entity *ent, ir_mode *mode);
228 * Returns the associated entity of a tarval. Asserts if tarval does not
231 #define get_tarval_entity tarval_to_entity
232 entity *tarval_to_entity(tarval *tv);
235 * Returns non-zero if a the given tarval represents an entity.
237 int tarval_is_entity(tarval *tv);
239 /** ********** Access routines for tarval fields ********** **/
247 * ir_mode *get_tarval_mode(tarval *tv)
251 * These are access function for tarval struct members. It is encouraged
252 * to use them instead of direct access to the struct fields.
255 * tv - The tarval to access fields of
258 * get_tv_mode: The mode of the tarval
264 /** Returns the mode of the tarval. */
265 ir_mode *get_tarval_mode (tarval *tv);
267 /* Testing properties of the represented values */
270 * Returns 1 if tv is negative
272 * @param a the tarval
274 int tarval_is_negative(tarval *a);
277 * Returns 1 if tv is null
279 * @param a the tarval
281 int tarval_is_null(tarval *a);
284 * Returns 1 if tv is the "one"
286 * @param a the tarval
288 int tarval_is_one(tarval *a);
290 /** The 'bad' tarval. */
291 extern tarval *tarval_bad;
292 /** Returns the 'bad tarval. */
293 tarval *get_tarval_bad(void);
295 /** The 'undefined' tarval. */
296 extern tarval *tarval_undefined;
297 /** Returns the 'undefined' tarval. */
298 tarval *get_tarval_undefined(void);
300 /** The mode_b tarval 'false'. */
301 extern tarval *tarval_b_false;
302 /** Returns the mode_b tarval 'false'. */
303 tarval *get_tarval_b_false(void);
305 /** The mode_b tarval 'true'. */
306 extern tarval *tarval_b_true;
307 /** Returns the mode_b tarval 'true'. */
308 tarval *get_tarval_b_true(void);
310 /** The 'void' pointer tarval. */
311 extern tarval *tarval_P_void;
312 /** Returns the 'void' pointer tarval. */
313 tarval *get_tarval_P_void(void);
315 /* These functions calculate and return a tarval representing the requested
317 * The functions get_mode_{Max,Min,...} return tarvals retrieved from these
318 * functions, but these are stored on initialization of the irmode module and
319 * therefore the irmode functions should be prefered to the functions below. */
321 /** Returns the maximum value of a given mode. */
322 tarval *get_tarval_max(ir_mode *mode);
324 /** Returns the minimum value of a given mode. */
325 tarval *get_tarval_min(ir_mode *mode);
327 /** Returns the 0 value (additive neutral) of a given mode. */
328 tarval *get_tarval_null(ir_mode *mode);
330 /** Returns the 1 value (multiplicative neutral) of a given mode. */
331 tarval *get_tarval_one(ir_mode *mode);
333 /** Return quite nan for float_number modes. */
334 tarval *get_tarval_nan(ir_mode *mode);
336 /** Return +inf for float_number modes. */
337 tarval *get_tarval_inf(ir_mode *mode);
339 /* ******************** Arithmethic operations on tarvals ******************** */
342 * Compares two tarvals
344 * Compare a with b and return a pnc_number describing the relation
345 * between a and b. This is either Uo, Lt, Eq, Gt, or False if a or b
346 * are symbolic pointers which can not be compared at all.
348 * @param a A tarval to be compared
349 * @param b A tarval to be compared
352 * The pnc_number best describing the relation between a and b is returned.
353 * This means the mode with the least bits set is returned, e.g. if the
354 * tarvals are equal the pnc_number 'Eq' is returned, not 'Ge' which
355 * indicates 'greater or equal'
358 * irnode.h for the definition of pnc_numbers
360 pnc_number tarval_cmp(tarval *a, tarval *b);
363 * Converts a tarval to another mode.
365 * Convert tarval 'src' to mode 'mode', this will suceed if and only if mode
366 * 'mode' is wider than the mode of src, as defined in the firm documentation
367 * and as returned by the function mode_is_smaller defined in irmode.h.
369 * @param src The tarval to convert
370 * @param mode Tho mode to convert to
373 * If a tarval of mode 'mode' with the result of the conversion of the 'src'
374 * tarvals value already exists, it will be returned, else a new tarval is
375 * constructed and returned
378 * Illegal conversations will trigger an assertion
381 * FIRM documentation for conversion rules
382 * mode_is_smaller defined in irmode.h
384 tarval *tarval_convert_to(tarval *src, ir_mode *m);
387 * These function implement basic computations representable as opcodes
393 * a - the tarval to operate on
396 * a - the first operand tarval
397 * b - the second operand tarval
400 * If neccessary a new tarval is constructed for the resulting value,
401 * or the one already carrying the computation result is retrieved and
402 * returned as result.
405 * The order the arguments are given in is important, imagine postfix
407 * Illegal operations will trigger an assertion.
408 * The sort member of the struct mode defines which operations are valid
411 /** bitwise Negation of a tarval. */
412 tarval *tarval_not(tarval *a);
414 /** arithmetic Negation of a tarval. */
415 tarval *tarval_neg(tarval *a);
417 /** Addition of two tarvals. */
418 tarval *tarval_add(tarval *a, tarval *b);
420 /** Subtraction from a tarval. */
421 tarval *tarval_sub(tarval *a, tarval *b);
423 /** Multiplication of tarvals. */
424 tarval *tarval_mul(tarval *a, tarval *b);
426 /** 'Exact' division. */
427 tarval *tarval_quo(tarval *a, tarval *b);
429 /** Integer division. */
430 tarval *tarval_div(tarval *a, tarval *b);
432 /** Remainder of integer division. */
433 tarval *tarval_mod(tarval *a, tarval *b);
435 /** Absolute value. */
436 tarval *tarval_abs(tarval *a);
439 tarval *tarval_and(tarval *a, tarval *b);
442 tarval *tarval_or(tarval *a, tarval *b);
444 /** Bitwise exclusive or. */
445 tarval *tarval_eor(tarval *a, tarval *b);
448 tarval *tarval_shl(tarval *a, tarval *b);
450 /** Unsigned (logical) right shift. */
451 tarval *tarval_shr(tarval *a, tarval *b);
453 /** Signed (arithmetic) right shift. */
454 tarval *tarval_shrs(tarval *a, tarval *b);
457 tarval *tarval_rot(tarval *a, tarval *b);
459 /* *********** Output of tarvals *********** */
462 * The output mode for tarval values.
464 * Some modes allow more that one representation, for instance integers
465 * can be represented hex or decimal. Of course it would be enough to have
466 * one and let every backend convert it into the 'right' one.
467 * However, we can do this in the tarval much simplier...
470 TVO_NATIVE, /**< the default output mode, depends on the mode */
471 TVO_HEX, /**< use hex representation, always possible */
472 TVO_DECIMAL, /**< use decimal representation */
473 TVO_OCTAL, /**< use octal representation */
474 TVO_BINARY, /**< use binary representation */
475 TVO_FLOAT, /**< use floating point representation (i.e 1.342e-2)*/
476 TVO_HEXFLOAT /**< use hexadecimal floating point representation (i.e 0x1.ea32p-12)*/
480 * This structure contains helper information to format the output
481 * of a tarval of a mode.
483 typedef struct tarval_mode_info {
484 tv_output_mode mode_output; /**< if != TVO_NATIVE select a special mode */
485 const char *mode_prefix; /**< if set, this prefix will be printed
486 before a value of this mode */
487 const char *mode_suffix; /**< if set, this suffix will be printed
488 after a value of this mode */
492 * Specify the output options of one mode.
494 * This functions stores the modinfo, so DO NOT DESTROY it.
496 * @param mode a ir_mode that should be associated
497 * @param modeinfo the output format info
499 * @return zero on success.
501 int tarval_set_mode_output_option(ir_mode *mode, const tarval_mode_info *modeinfo);
504 * Returns the output options of one mode.
506 * This functions returns the modinfo of a given mode.
508 * @param mode a ir_mode that should be associated
510 * @return the output option
512 const tarval_mode_info *tarval_get_mode_output_option(ir_mode *mode);
515 * Returns Bit representation of a tarval value, as string of '0' and '1'
517 * @param tv The tarval
519 * This function returns a printable bit representation of any value
520 * stored as tarval. This representation is a null terminated C string.
523 * As usual in C a pointer to a char is returned. The length of the
524 * returned string if fixed, just read as many chars as the mode defines
528 * The string is allocated using malloc() and is free()ed on the next call
530 * The string consists of the ascii characters '0' and '1' and is
534 * irmode.h for the definition of the ir_mode struct
535 * the size member of aforementioned struct
537 char *tarval_bitpattern(tarval *tv);
540 * Returns the bitpattern of the bytes_ofs byte.
542 * This function succeeds even if the mode of the tarval uses lesser bits
543 * than requested, in that case the bitpattern is filled with zero bits.
545 * To query a 32bit value the following code can be used:
547 * val0 = tarval_sub_bits(tv, 0);
548 * val1 = tarval_sub_bits(tv, 1);
549 * val2 = tarval_sub_bits(tv, 2);
550 * val3 = tarval_sub_bits(tv, 3);
552 * Because this is the bit representation of the target machine, only the following
553 * operations are legal on the result:
555 * - concatenation (endian dependance MUST be handled by the CALLER)
556 * - bitwise logical operations to select/mask bits
558 * @param tv the tarval
559 * @param byte_ofs the byte offset
562 * The result of this funcion is undefined if the mode is neither integer nor float.
564 unsigned char tarval_sub_bits(tarval *tv, unsigned byte_ofs);
567 * Return values of tarval classify
569 typedef enum _tarval_classification_t {
570 TV_CLASSIFY_NULL = 0, /**< the tarval represents the additive neutral element */
571 TV_CLASSIFY_ONE = +1, /**< the tarval represents the multiplicative neutral element */
572 TV_CLASSIFY_ALL_ONE = -1, /**< the tarval represents the bitwise-and neutral element */
573 TV_CLASSIFY_OTHER = 2 /**< all other tarvals */
574 } tarval_classification_t;
577 * Identifying tarvals values for algebraic simplifications.
580 * - TV_CLASSIFY_NULL for additive neutral,
581 * - TV_CLASSIFY_ONE for multiplicative neutral,
582 * - TV_CLASSIFY_ALL_ONE for bitwise-and neutral
583 * - TV_CLASSIFY_OTHER else
585 tarval_classification_t tarval_classify(tarval *tv);
588 * Initialization of the tarval module.
590 * Call before init_mode().
592 void init_tarval_1(void);
595 * Initialization of the tarval module.
597 * Call after init_mode().
599 void init_tarval_2(void);
601 void finish_tarval(void);
604 * Output of tarvals to a buffer.
606 int tarval_snprintf(char *buf, size_t buflen, tarval *tv);
609 * Output of tarvals to stdio.
611 int tarval_printf(tarval *tv);