tv.h 19.3 KB
Newer Older
Christian Würdig's avatar
Christian Würdig committed
1
/*
Michael Beck's avatar
Michael Beck committed
2
 * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
Christian Würdig's avatar
Christian Würdig committed
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
 *
 * This file is part of libFirm.
 *
 * This file may be distributed and/or modified under the terms of the
 * GNU General Public License version 2 as published by the Free Software
 * Foundation and appearing in the file LICENSE.GPL included in the
 * packaging of this file.
 *
 * Licensees holding valid libFirm Professional Edition licenses may use
 * this file in accordance with the libFirm Commercial License.
 * Agreement provided with the Software.
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE.
 */

Michael Beck's avatar
Michael Beck committed
20
/**
Michael Beck's avatar
Michael Beck committed
21
22
23
24
25
26
27
28
 * @file
 * @brief    Representation of and static computations on target machine
 *           values.
 * @date     2003
 * @author   Mathias Heil
 * @version  $Id$
 * @summary
 *   Tarvals represent target machine values.  They are typed by modes.
29
 *   Tarvals only represent values of mode_sort:
Michael Beck's avatar
Michael Beck committed
30
31
32
33
34
 *    - int_number,
 *    - float_number,
 *    - boolean,
 *    - reference,
 *    - character
35
36
37
 *
 *   In case of references the module accepts an entity to represent the
 *   value.
Michael Beck's avatar
Michael Beck committed
38
 *   Furthermore, computations and conversions of these values can
39
40
41
42
43
44
 *   be performed.
 *
 * HISTORY
 *    The original tv module originated in the fiasco compiler written ...
 *    This is the new version, described in the tech report 1999-14 by ...
 *
Michael Beck's avatar
Michael Beck committed
45
 * @sa
46
47
 *    Techreport 1999-14
 *    irmode.h for the modes definitions
Michael Beck's avatar
Michael Beck committed
48
 *    irnode.h for the pn_Cmp table
Michael Beck's avatar
Michael Beck committed
49
50
51
52
53
54
 */
#ifndef FIRM_TV_TV_H
#define FIRM_TV_TV_H

#include "firm_types.h"
#include "irnode.h"
Christian Schäfer's avatar
Christian Schäfer committed
55

56
/* ************************ Constructors for tarvals ************************ */
57
58
59

/**
 * Constructor function for new tarvals.
60
 *
61
62
63
 * @param str   The string representing the target value
 * @param len   The length of the string
 * @param mode  The mode requested for the result tarval
64
 *
65
66
67
68
 * This function creates a new tarval representing the value represented
 * by a CString, aka char array. If a tarval representing this value already
 * exists, this tarval is returned instead of a new one. So tarvals are
 * directly comparable since their representation is unique.
69
 *
70
 * This function accepts the following strings:
71
 *
72
73
74
75
 * if mode is int_number:
 *  - 0(x|X)[0-9a-fA-F]+ (hexadecimal representation)
 *  - 0[0-7]*            (octal representation)
 *  - (+|-)?[1-9][0-9]*  (decimal representation)
76
 *
77
78
79
80
81
82
83
84
85
86
87
88
89
 * if mode if float_number:
 *  - (+|-)?(decimal int) (. (decimal int))? ((e|E)(+|-)?(decimal int))?
 *
 * if mode is boolean: true, True, TRUE ... False... 0, 1,
 *
 * if mode is reference: hexadecimal of decimal number as int
 *
 * if mode is character: hex or dec
 *
 * Leading and/or trailing spaces are ignored
 *
 * @return
 *   A tarval of proper type representing the requested value is returned.
90
91
92
93
 *   Tarvals are unique, so for any value/mode pair at most one tarval will
 *   exist, which will be returned upon further requests with an identical
 *   value/mode pair.
 *
94
95
96
 * @note
 *   If the string is not representable in the given mode an assertion is
 *   thrown in assert build.
97
 *
98
 * @sa
99
 *   irmode.h for predefined modes
100
101
102
 *   new_tarval_from_long()
 *   new_tarval_from_double()
 */
103
tarval *new_tarval_from_str(const char *str, size_t len, ir_mode *mode);
Christian Schäfer's avatar
Christian Schäfer committed
104

105
106
/**
 * Constructor function for new tarvals
107
 *
108
109
 * @param l     The long representing the value
 * @param mode  The mode requested for the result tarval
110
 *
111
112
113
114
 * This function creates a new tarval representing the value represented
 * by a long integer. If a tarval representing this value already exists,
 * this tarval is returned instead of a new one. So tarvals are directly
 * comparable since their representation is unique.
115
 *
116
117
 * @return
 *   A tarval of proper type representing the requested value is returned.
118
119
120
121
 *   Tarvals are unique, so for any value/mode pair at most one tarval will
 *   exist, which will be returned upon further requests with an identical
 *   value/mode pair.
 *
122
123
124
 * @note
 *   If the long is not representable in the given mode an assertion is
 *   thrown in assert build.
125
 *
126
 * @sa
127
 *   irmode.h for predefined modes
128
129
 *   new_tarval_from_str()
 *   new_tarval_from_double()
130
 *
131
 */
132
tarval *new_tarval_from_long(long l, ir_mode *mode);
133

Götz Lindenmaier's avatar
Götz Lindenmaier committed
134
135
/** Return value as long if possible.
 *
136
137
 * This returns a long int with the value represented value, or
 * gibberish, depending on the size of long int and the size of the
138
 * stored value. It works for e.g. 1 as mode_Ls, but might not work for
139
140
 * get_mode_max(mode_Ls).
 * This will overflow silently, so use only if you know what
141
 * you are doing! (better check with tarval_is_long()...)
Götz Lindenmaier's avatar
Götz Lindenmaier committed
142
 * Works only for int modes, even not for character modes!
143
 */
144
long get_tarval_long(tarval *tv);
145

146
/**
Götz Lindenmaier's avatar
Götz Lindenmaier committed
147
 * This validates if get_tarval_long() will return a satisfying
148
149
 * result. I.e. if tv is an int_number and between min, max
 * of long int (signed!)
150
151
 *
 * @param tv    the tarval
152
153
154
 */
int tarval_is_long(tarval *tv);

155
156
/**
 * Constructor function for new tarvals.
157
 *
158
 * @param d     The (long) double representing the value
159
 * @param mode  The mode requested for the result tarval
160
 *
161
 * This function creates a new tarval representing the value represented
162
 * by a (long) double. If a tarval representing this value already exists,
163
164
165
 * this tarval is returned instead of a new one. So tarvals are directly
 * comparable since their representation is unique.
 * Only modes of sort float_number can be constructed this way.
166
 *
167
168
 * @return
 *   A tarval of proper type representing the requested value is returned.
169
170
171
172
 *   Tarvals are unique, so for any value/mode pair at most one tarval will
 *   exist, which will be returned upon further requests with an identical
 *   value/mode pair.
 *
173
 * @note
174
 *   If the (long) double is not representable in the given mode an assertion
175
 *   is thrown. This will happen for any mode not of sort float_number.
176
 *
177
 * @sa
178
 *   irmode.h for predefined values
179
180
181
 *   new_tarval_from_str()
 *   new_tarval_from_long()
 */
182
tarval *new_tarval_from_double(long double d, ir_mode *mode);
183
184
185
186
187
188
189

/**
 * This returns a double with the value represented value, or
 * gibberish, depending on the size of double and the size of the
 * stored value.
 * This will overflow silently, so use only if you know what
 * you are doing! (better check with tarval_is_long...)
190
191
 *
 * @param tv    the tarval
192
 */
193
long double get_tarval_double(tarval *tv);
194
195
196
197
198

/**
 * This validates if tarval_to_double() will return a satisfying
 * result. I.e. if tv is an float_number and between min, max
 * of double
199
200
 *
 * @param tv    the tarval
201
 */
202
int tarval_is_double(tarval *tv);
203

204
205
206

/** ********** Access routines for tarval fields ********** **/

207
/*
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 * NAME
 *   get_tarval_mode
 *   get_tarval_ ...
 *
 * SYNOPSIS
 *   ir_mode *get_tarval_mode(tarval *tv)
 *   ...
 *
 * DESCRIPTION
 *    These are access function for tarval struct members. It is encouraged
 *   to use them instead of direct access to the struct fields.
 *
 * PARAMETERS
 *   tv - The tarval to access fields of
 *
 * RESULT
 *   get_tv_mode: The mode of the tarval
 *
 * SEE ALSO
 *   the struct tarval
228
229
 */

230
231
232
233
234
235
/**
 * Returns the mode of the tarval.
 *
 * @param tv    the tarval
 */
ir_mode *get_tarval_mode(const tarval *tv);
236

237
238
239
/** Returns the contents of the 'link' field of the tarval */
/* void *get_tarval_link (tarval*); */

240
241
/* Testing properties of the represented values */

Michael Beck's avatar
Michael Beck committed
242
243
/**
 * Returns 1 if tv is negative
244
 *
245
 * @param tv    the tarval
246
 */
247
int tarval_is_negative(tarval *tv);
248

Michael Beck's avatar
Michael Beck committed
249
250
251
/**
 * Returns 1 if tv is null
 *
252
 * @param tv    the tarval
Michael Beck's avatar
Michael Beck committed
253
 */
254
int tarval_is_null(tarval *tv);
Michael Beck's avatar
Michael Beck committed
255

Michael Beck's avatar
Michael Beck committed
256
257
258
/**
 * Returns 1 if tv is the "one"
 *
259
 * @param tv    the tarval
Michael Beck's avatar
Michael Beck committed
260
 */
261
int tarval_is_one(tarval *tv);
Michael Beck's avatar
Michael Beck committed
262

Michael Beck's avatar
Michael Beck committed
263
264
265
/**
 * Returns 1 if tv is the "minus one"
 *
266
 * @param tv    the tarval
Michael Beck's avatar
Michael Beck committed
267
 */
268
int tarval_is_minus_one(tarval *tv);
Michael Beck's avatar
Michael Beck committed
269

270
271
272
273
274
/*
 * returns non-zero if all bits in the tarval are set
 */
int tarval_is_all_one(tarval *tv);

275
276
277
278
/** The 'bad' tarval. */
extern tarval *tarval_bad;
/** Returns the 'bad tarval. */
tarval *get_tarval_bad(void);
279

280
281
282
283
284
285
286
/** The 'undefined' tarval. */
extern tarval *tarval_undefined;
/** Returns the 'undefined' tarval. */
tarval *get_tarval_undefined(void);

/** The mode_b tarval 'false'. */
extern tarval *tarval_b_false;
Michael Beck's avatar
Michael Beck committed
287

288
289
290
291
292
293
294
295
/** Returns the mode_b tarval 'false'. */
tarval *get_tarval_b_false(void);

/** The mode_b tarval 'true'. */
extern tarval *tarval_b_true;
/** Returns the mode_b tarval 'true'. */
tarval *get_tarval_b_true(void);

296
297
298
299
/* These functions calculate and return a tarval representing the requested
 * value.
 * The functions get_mode_{Max,Min,...} return tarvals retrieved from these
 * functions, but these are stored on initialization of the irmode module and
Michael Beck's avatar
Michael Beck committed
300
 * therefore the irmode functions should be preferred to the functions below. */
301
302

/** Returns the maximum value of a given mode. */
303
tarval *get_tarval_max(ir_mode *mode);
304
305

/** Returns the minimum value of a given mode. */
306
tarval *get_tarval_min(ir_mode *mode);
307

308
309
/** Returns the 0 value (additive neutral) of a given mode.
    For reference modes, the NULL value is returned (old tarval_P_void) */
310
tarval *get_tarval_null(ir_mode *mode);
311
312

/** Returns the 1 value (multiplicative neutral) of a given mode. */
313
tarval *get_tarval_one(ir_mode *mode);
314

315
316
317
318
/** Returns the -1 value (multiplicative neutral) of a given mode.
 *  Returns tarval bad for unsigned modes */
tarval *get_tarval_minus_one(ir_mode *mode);

Matthias Braun's avatar
Matthias Braun committed
319
320
321
322
/** returns the value where all bits are 1 of a given mode.
 * returns tarval_bad for float modes */
tarval *get_tarval_all_one(ir_mode *mode);

323
/** Return quite nan for float_number modes. */
324
tarval *get_tarval_nan(ir_mode *mode);
325
326

/** Return +inf for float_number modes. */
327
tarval *get_tarval_plus_inf(ir_mode *mode);
328

329
330
331
332
/** Return -inf for float_number modes. */
tarval *get_tarval_minus_inf(ir_mode *mode);

/* ******************** Arithmetic operations on tarvals ******************** */
333

334
typedef enum _tarval_int_overflow_mode_t {
335
336
337
	TV_OVERFLOW_BAD,      /**< tarval module will return tarval_bad if a overflow occurs */
	TV_OVERFLOW_WRAP,     /**< tarval module will overflow will be ignored, wrap around occurs */
	TV_OVERFLOW_SATURATE  /**< tarval module will saturate the overflow */
338
339
340
341
342
343
344
345
346
347
348
349
} tarval_int_overflow_mode_t;

/**
 * Sets the overflow mode for integer operations.
 */
void tarval_set_integer_overflow_mode(tarval_int_overflow_mode_t ov_mode);

/**
 * Get the overflow mode for integer operations.
 */
tarval_int_overflow_mode_t tarval_get_integer_overflow_mode(void);

350
351
/**
 * Compares two tarvals
352
 *
Michael Beck's avatar
Michael Beck committed
353
 * Compare a with b and return a pn_Cmp describing the relation
Michael Beck's avatar
Michael Beck committed
354
 * between a and b.  This is either pn_Cmp_Uo, pn_Cmp_Lt, pn_Cmp_Eq, pn_Cmp_Gt,
355
 * or pn_Cmp_False if a or b are symbolic pointers which can not be compared at all.
356
 *
357
358
 * @param a   the first tarval to be compared
 * @param b   the second tarval to be compared
359
 *
360
 * @return
Michael Beck's avatar
Michael Beck committed
361
 *   The pn_Cmp best describing the relation between a and b is returned.
362
 *   This means the mode with the least bits set is returned, e.g. if the
Michael Beck's avatar
Michael Beck committed
363
 *   tarvals are equal the pn_Cmp 'pn_Cmp_Eq' is returned, not 'pn_Cmp_Ge' which
364
365
 *   indicates 'greater or equal'
 *
366
 * @sa
Michael Beck's avatar
Michael Beck committed
367
 *    irnode.h for the definition of pn_Cmp
368
 */
Michael Beck's avatar
Michael Beck committed
369
pn_Cmp tarval_cmp(tarval *a, tarval *b);
370

371
372
/**
 * Converts a tarval to another mode.
373
 *
Michael Beck's avatar
Michael Beck committed
374
 * Convert tarval 'src' to mode 'mode', this will succeed if and only if mode
375
376
 * 'mode' is wider than the mode of src, as defined in the firm documentation
 * and as returned by the function mode_is_smaller defined in irmode.h.
377
 *
378
379
 * @param src    The tarval to convert
 * @param mode   Tho mode to convert to
380
 *
381
382
 * @return
 *   If a tarval of mode 'mode' with the result of the conversion of the 'src'
383
384
385
 *   tarvals value already exists, it will be returned, else a new tarval is
 *   constructed and returned
 *
386
 * @note
387
 *    Illegal convertions will trigger a panic
388
 *
389
 * @sa
390
391
 *    FIRM documentation for conversion rules
 *    mode_is_smaller defined in irmode.h
392
 */
Michael Beck's avatar
Michael Beck committed
393
tarval *tarval_convert_to(tarval *src, ir_mode *mode);
394

395
396
397
/*
 * These function implement basic computations representable as opcodes
 * in FIRM nodes.
398
399
400
401
402
403
 *
 * PARAMETERS
 *    tarval_neg:
 *    traval_abs:
 *      a - the tarval to operate on
 *
Michael Beck's avatar
Michael Beck committed
404
 *    all others:
405
406
407
408
 *      a - the first operand tarval
 *      b - the second operand tarval
 *
 * RESULT
Michael Beck's avatar
Michael Beck committed
409
 *    If necessary a new tarval is constructed for the resulting value,
410
411
412
413
 *   or the one already carrying the computation result is retrieved and
 *   returned as result.
 *
 * NOTES
414
 *   The order the arguments are given in is important, imagine postfix
415
 *   notation.
416
417
418
419
 *   Illegal operations will trigger an assertion.
 *   The sort member of the struct mode defines which operations are valid
 */

420
/** Bitwise Negation of a tarval. */
421
422
tarval *tarval_not(tarval *a);

423
/** Arithmetic Negation of a tarval. */
424
425
426
427
428
429
430
431
432
433
434
tarval *tarval_neg(tarval *a);

/** Addition of two tarvals. */
tarval *tarval_add(tarval *a, tarval *b);

/** Subtraction from a tarval. */
tarval *tarval_sub(tarval *a, tarval *b);

/** Multiplication of tarvals. */
tarval *tarval_mul(tarval *a, tarval *b);

435
/** 'Exact' division of two tarvals. */
436
437
tarval *tarval_quo(tarval *a, tarval *b);

438
/** Integer division of two tarvals. */
439
440
441
442
443
tarval *tarval_div(tarval *a, tarval *b);

/** Remainder of integer division. */
tarval *tarval_mod(tarval *a, tarval *b);

Michael Beck's avatar
Michael Beck committed
444
445
446
/** Integer division AND remainder. */
tarval *tarval_divmod(tarval *a, tarval *b, tarval **mod_res);

447
/** Absolute value of a tarval. */
448
449
450
451
452
453
tarval *tarval_abs(tarval *a);

/** Bitwise and. */
tarval *tarval_and(tarval *a, tarval *b);

/** Bitwise or. */
454
tarval *tarval_or(tarval *a, tarval *b);
455
456
457
458
459
460
461
462
463
464
465
466
467

/** Bitwise exclusive or. */
tarval *tarval_eor(tarval *a, tarval *b);

/** Left shift. */
tarval *tarval_shl(tarval *a, tarval *b);

/** Unsigned (logical) right shift. */
tarval *tarval_shr(tarval *a, tarval *b);

/** Signed (arithmetic) right shift. */
tarval *tarval_shrs(tarval *a, tarval *b);

468
469
/** Rotation to left. */
tarval *tarval_rotl(tarval *a, tarval *b);
470

471
472
473
/**
 * Returns the carry flag of the last operation.
 */
474
475
int tarval_carry(void);

476
477
/* *********** Output of tarvals *********** */

Michael Beck's avatar
Michael Beck committed
478
479
480
481
482
483
/**
 * The output mode for tarval values.
 *
 * Some modes allow more that one representation, for instance integers
 * can be represented hex or decimal. Of course it would be enough to have
 * one and let every backend convert it into the 'right' one.
Michael Beck's avatar
Michael Beck committed
484
 * However, we can do this in the tarval much simpler...
Michael Beck's avatar
Michael Beck committed
485
 */
486
typedef enum {
487
488
489
490
491
492
493
	TVO_NATIVE,       /**< the default output mode, depends on the mode */
	TVO_HEX,          /**< use hex representation, always possible */
	TVO_DECIMAL,      /**< use decimal representation */
	TVO_OCTAL,        /**< use octal representation */
	TVO_BINARY,       /**< use binary representation */
	TVO_FLOAT,        /**< use floating point representation (i.e 1.342e-2)*/
	TVO_HEXFLOAT      /**< use hexadecimal floating point representation (i.e 0x1.ea32p-12)*/
494
} tv_output_mode;
Michael Beck's avatar
Michael Beck committed
495
496
497

/**
 * This structure contains helper information to format the output
Götz Lindenmaier's avatar
Götz Lindenmaier committed
498
 * of a tarval of a mode.
Michael Beck's avatar
Michael Beck committed
499
500
 */
typedef struct tarval_mode_info {
501
502
503
504
505
	tv_output_mode mode_output;  /**< if != TVO_NATIVE select a special mode */
	const char *mode_prefix;     /**< if set, this prefix will be printed
	                                  before a value of this mode */
	const char *mode_suffix;     /**< if set, this suffix will be printed
	                                  after a value of this mode */
Michael Beck's avatar
Michael Beck committed
506
507
508
509
510
} tarval_mode_info;

/**
 * Specify the output options of one mode.
 *
Michael Beck's avatar
Michael Beck committed
511
 * This functions stores the mode info, so DO NOT DESTROY it.
Michael Beck's avatar
Michael Beck committed
512
 *
513
514
 * @param mode      a ir_mode that should be associated
 * @param modeinfo  the output format info
Michael Beck's avatar
Michael Beck committed
515
 *
Michael Beck's avatar
fixed:    
Michael Beck committed
516
 * @return zero on success.
Michael Beck's avatar
Michael Beck committed
517
 */
518
int  set_tarval_mode_output_option(ir_mode *mode, const tarval_mode_info *modeinfo);
Michael Beck's avatar
Michael Beck committed
519

Michael Beck's avatar
fixed:    
Michael Beck committed
520
521
522
/**
 * Returns the output options of one mode.
 *
Michael Beck's avatar
Michael Beck committed
523
 * This functions returns the mode info of a given mode.
Michael Beck's avatar
fixed:    
Michael Beck committed
524
 *
525
 * @param mode      a ir_mode that should be associated
Michael Beck's avatar
fixed:    
Michael Beck committed
526
527
528
 *
 * @return the output option
 */
529
const tarval_mode_info *get_tarval_mode_output_option(ir_mode *mode);
Michael Beck's avatar
fixed:    
Michael Beck committed
530

531
532
/**
 * Returns Bit representation of a tarval value, as string of '0' and '1'
533
 *
534
 * @param tv   The tarval
535
 *
536
537
 * This function returns a printable bit representation of any value
 * stored as tarval. This representation is a null terminated C string.
538
 *
539
540
 * @return
 *   As usual in C a pointer to a char is returned. The length of the
541
542
543
 *   returned string if fixed, just read as many chars as the mode defines
 *   as size.
 *
544
545
546
 * @note
 *   The string is allocated using malloc() and is free()ed on the next call
 *   of this function.
Michael Beck's avatar
Michael Beck committed
547
 *   The string consists of the ASCII characters '0' and '1' and is
548
 *   null terminated
549
 *
550
 * @sa
551
552
 *    irmode.h for the definition of the ir_mode struct
 *    the size member of aforementioned struct
553
 */
554
char *get_tarval_bitpattern(tarval *tv);
555

556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
/**
 * Returns the bitpattern of the bytes_ofs byte.
 *
 * This function succeeds even if the mode of the tarval uses lesser bits
 * than requested, in that case the bitpattern is filled with zero bits.
 *
 * To query a 32bit value the following code can be used:
 *
 * val0 = tarval_sub_bits(tv, 0);
 * val1 = tarval_sub_bits(tv, 1);
 * val2 = tarval_sub_bits(tv, 2);
 * val3 = tarval_sub_bits(tv, 3);
 *
 * Because this is the bit representation of the target machine, only the following
 * operations are legal on the result:
 *
Michael Beck's avatar
Michael Beck committed
572
 * - concatenation (endian dependence MUST be handled by the CALLER)
573
 * - bitwise logical operations to select/mask bits
574
 *
575
576
 * @param tv        the tarval
 * @param byte_ofs  the byte offset
577
578
 *
 * @note
Michael Beck's avatar
Michael Beck committed
579
 *   The result of this function is undefined if the mode is neither integer nor float.
580
 */
581
unsigned char get_tarval_sub_bits(tarval *tv, unsigned byte_ofs);
582

583
584
585
/**
 * Returns non-zero if a given (integer) tarval has only one single bit
 * set.
586
587
 *
 * @param tv    the tarval
588
 */
Michael Beck's avatar
Michael Beck committed
589
int tarval_is_single_bit(tarval *tv);
590

591
/**
592
593
594
595
596
 * Output a tarval to a string buffer.
 *
 * @param buf     the output buffer
 * @param buflen  the length of the buffer
 * @param tv      the tarval
597
598
 */
int tarval_snprintf(char *buf, size_t buflen, tarval *tv);
599

600
/**
601
602
603
 * Output a tarval to stdio.
 *
 * @param tv    the tarval
604
605
606
 */
int tarval_printf(tarval *tv);

Michael Beck's avatar
Michael Beck committed
607
608
609
/**
 * Returns non-zero if the mantissa of a floating point IEEE-754
 * tarval is zero (i.e. 1.0Exxx)
610
611
 *
 * @param tv    the tarval
Michael Beck's avatar
Michael Beck committed
612
613
614
615
616
617
 */
int tarval_ieee754_zero_mantissa(tarval *tv);

/**
 * Returns the exponent of a floating point IEEE-754
 * tarval.
618
619
 *
 * @param tv    the tarval
Michael Beck's avatar
Michael Beck committed
620
621
622
 */
int tarval_ieee754_get_exponent(tarval *tv);

623
624
625
626
627
628
629
630
631
/**
 * Check if the tarval can be converted to the given mode without
 * precision loss.
 *
 * @param tv    the tarval
 * param  mode  the mode to convert to
 */
int tarval_ieee754_can_conv_lossless(tarval *tv, ir_mode *mode);

632
633
634
635
636
637
638
639
640
/**
 * Set the immediate precision for IEEE-754 results. Set this to
 * 0 to get the same precision as the operands.
 * For x87 compatibility, set this to 80.
 *
 * @return the old setting
 */
unsigned tarval_ieee754_set_immediate_precision(unsigned bits);

641
642
643
644
645
/**
 *  Returns non-zero if the result of the last IEEE-754 operation was exact.
 */
unsigned tarval_ieee754_get_exact(void);

646
647
648
649
650
/**
 * Enable/Disable floating point constant folding.
 */
int tarval_enable_fp_ops(int enable);

651
652
/**
 * Check if its the a floating point NaN.
653
654
 *
 * @param tv    the tarval
655
656
657
658
659
 */
int tarval_is_NaN(tarval *tv);

/**
 * Check if its the a floating point +inf.
660
661
 *
 * @param tv    the tarval
662
663
664
665
666
 */
int tarval_is_plus_inf(tarval *tv);

/**
 * Check if its the a floating point -inf.
667
668
 *
 * @param tv    the tarval
669
670
671
672
673
 */
int tarval_is_minus_inf(tarval *tv);

/**
 * Check if the tarval represents a finite value, ie neither NaN nor inf.
674
675
 *
 * @param tv    the tarval
676
677
678
 */
int tarval_is_finite(tarval *tv);

Michael Beck's avatar
Michael Beck committed
679
#endif  /* FIRM_TV_TV_H */