tv.h 22.5 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
 * @file
 * @brief    Representation of and static computations on target machine
 *           values.
 * @date     2003
 * @author   Mathias Heil
 * @version  $Id$
yb9976's avatar
yb9976 committed
27
 * @brief
Michael Beck's avatar
Michael Beck committed
28
 *   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
 *
Christoph Mallon's avatar
Christoph Mallon committed
77
 * if mode is float_number:
78
79
80
81
82
83
84
85
86
87
88
89
 *  - (+|-)?(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
279
280
/**
 * Return non-zero if the tarval is a constant (ie. NOT
 * a reserved tarval like bad, undef, reachable etc.)
 */
int tarval_is_constant(tarval *tv);

281
282
/** The 'bad' tarval. */
extern tarval *tarval_bad;
283
/** Returns the 'bad' tarval. */
284
tarval *get_tarval_bad(void);
285

286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
/** 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;
/** 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);

301
302
303
304
305
306
307
308
309
310
/** The mode_X tarval 'unreachable'. */
extern tarval *tarval_unreachable;
/** Returns the mode_X tarval 'unreachable'. */
tarval *get_tarval_unreachable(void);

/** The mode_X tarval 'reachable'. */
extern tarval *tarval_reachable;
/** Returns the mode_X tarval 'reachable'. */
tarval *get_tarval_reachable(void);

311
312
313
314
315
316
317
318
319
320
/** The 'top' tarval. This is just another name for the 'undefined' tarval. */
#define tarval_top          tarval_undefined
/** Returns the 'top' tarval. */
#define get_tarval_top()    get_tarval_undefined()

/** The 'bottom' tarval. This is just another name for the 'bad' tarval. */
#define tarval_bottom       tarval_bad
/** Returns the 'bottom' tarval. */
#define get_tarval_bottom() get_tarval_bad()

321
322
323
324
/* 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
325
 * therefore the irmode functions should be preferred to the functions below. */
326
327

/** Returns the maximum value of a given mode. */
328
tarval *get_tarval_max(ir_mode *mode);
329
330

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

333
334
/** Returns the 0 value (additive neutral) of a given mode.
    For reference modes, the NULL value is returned (old tarval_P_void) */
335
tarval *get_tarval_null(ir_mode *mode);
336
337

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

340
341
342
343
/** 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
344
345
346
347
/** 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);

348
/** Return quite nan for float_number modes. */
349
tarval *get_tarval_nan(ir_mode *mode);
350
351

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

354
355
356
357
/** Return -inf for float_number modes. */
tarval *get_tarval_minus_inf(ir_mode *mode);

/* ******************** Arithmetic operations on tarvals ******************** */
358

359
typedef enum _tarval_int_overflow_mode_t {
360
361
362
	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 */
363
364
365
366
} tarval_int_overflow_mode_t;

/**
 * Sets the overflow mode for integer operations.
367
368
 *
 * @param ov_mode  one of teh overflow modes
369
370
371
372
373
374
375
376
 */
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);

377
378
/**
 * Compares two tarvals
379
 *
Michael Beck's avatar
Michael Beck committed
380
 * Compare a with b and return a pn_Cmp describing the relation
Michael Beck's avatar
Michael Beck committed
381
 * between a and b.  This is either pn_Cmp_Uo, pn_Cmp_Lt, pn_Cmp_Eq, pn_Cmp_Gt,
382
 * or pn_Cmp_False if a or b are symbolic pointers which can not be compared at all.
383
 *
384
385
 * @param a   the first tarval to be compared
 * @param b   the second tarval to be compared
386
 *
387
 * @return
Michael Beck's avatar
Michael Beck committed
388
 *   The pn_Cmp best describing the relation between a and b is returned.
389
 *   This means the mode with the least bits set is returned, e.g. if the
Michael Beck's avatar
Michael Beck committed
390
 *   tarvals are equal the pn_Cmp 'pn_Cmp_Eq' is returned, not 'pn_Cmp_Ge' which
391
392
 *   indicates 'greater or equal'
 *
393
 * @sa
Michael Beck's avatar
Michael Beck committed
394
 *    irnode.h for the definition of pn_Cmp
395
 */
Michael Beck's avatar
Michael Beck committed
396
pn_Cmp tarval_cmp(tarval *a, tarval *b);
397

398
399
/**
 * Converts a tarval to another mode.
400
 *
Michael Beck's avatar
Michael Beck committed
401
 * Convert tarval 'src' to mode 'mode', this will succeed if and only if mode
402
403
 * '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.
404
 *
405
406
 * @param src    The tarval to convert
 * @param mode   Tho mode to convert to
407
 *
408
409
 * @return
 *   If a tarval of mode 'mode' with the result of the conversion of the 'src'
410
411
412
 *   tarvals value already exists, it will be returned, else a new tarval is
 *   constructed and returned
 *
413
 * @note
414
 *    Illegal convertions will trigger a panic
415
 *
416
 * @sa
417
418
 *    FIRM documentation for conversion rules
 *    mode_is_smaller defined in irmode.h
419
 */
Michael Beck's avatar
Michael Beck committed
420
tarval *tarval_convert_to(tarval *src, ir_mode *mode);
421

422
423
424
/*
 * These function implement basic computations representable as opcodes
 * in FIRM nodes.
425
426
427
428
429
430
 *
 * PARAMETERS
 *    tarval_neg:
 *    traval_abs:
 *      a - the tarval to operate on
 *
Michael Beck's avatar
Michael Beck committed
431
 *    all others:
432
433
434
435
 *      a - the first operand tarval
 *      b - the second operand tarval
 *
 * RESULT
Michael Beck's avatar
Michael Beck committed
436
 *    If necessary a new tarval is constructed for the resulting value,
437
438
439
440
 *   or the one already carrying the computation result is retrieved and
 *   returned as result.
 *
 * NOTES
441
 *   The order the arguments are given in is important, imagine postfix
442
 *   notation.
443
444
445
446
 *   Illegal operations will trigger an assertion.
 *   The sort member of the struct mode defines which operations are valid
 */

447
448
449
450
451
452
453
/**
 * Bitwise Negation of a tarval.
 *
 * @param a  the first tarval
 *
 * @return ~a or tarval_bad
 */
454
455
tarval *tarval_not(tarval *a);

456
457
458
459
460
461
462
/**
 * Arithmetic Negation of a tarval.
 *
 * @param a  the first tarval
 *
 * @return -a or tarval_bad
 */
463
464
tarval *tarval_neg(tarval *a);

465
466
467
468
469
470
471
472
/**
 * Addition of two tarvals.
 *
 * @param a  the first tarval
 * @param b  the second tarval
 *
 * @return a + b or tarval_bad
 */
473
474
tarval *tarval_add(tarval *a, tarval *b);

475
476
477
478
479
480
481
482
483
484
/**
 * Subtraction from a tarval.
 *
 * @param a         the first tarval
 * @param b         the second tarval
 * @param dst_mode  the mode of the result, needed for mode_P - mode_P, else NULL
 *
 * @return a - b or tarval_bad
 */
tarval *tarval_sub(tarval *a, tarval *b, ir_mode *dst_mode);
485

486
487
488
489
490
491
492
493
/**
 * Multiplication of tarvals.
 *
 * @param a  the first tarval
 * @param b  the second tarval
 *
 * @return a * b or tarval_bad
 */
494
495
tarval *tarval_mul(tarval *a, tarval *b);

496
497
498
499
500
501
502
503
/**
 * Division of two floating point tarvals.
 *
 * @param a  the first tarval
 * @param b  the second tarval
 *
 * @return a / b or tarval_bad
 */
504
505
tarval *tarval_quo(tarval *a, tarval *b);

506
507
508
509
510
511
512
513
/**
 * Integer division of two tarvals.
 *
 * @param a  the first tarval
 * @param b  the second tarval
 *
 * @return a / b or tarval_bad
 */
514
515
tarval *tarval_div(tarval *a, tarval *b);

516
517
518
519
520
521
522
523
/**
 * Remainder of integer division.
 *
 * @param a  the first tarval
 * @param b  the second tarval
 *
 * @return a % b or tarval_bad
 */
524
525
tarval *tarval_mod(tarval *a, tarval *b);

526
527
528
529
530
531
532
533
534
/**
 * Integer division AND remainder.
 *
 * @param a        the first tarval
 * @param b        the second tarval
 * @param mod_res  after return, contains the remainder result, a % b or tarval_bad
 *
 * @return a / b or tarval_bad
 */
Michael Beck's avatar
Michael Beck committed
535
536
tarval *tarval_divmod(tarval *a, tarval *b, tarval **mod_res);

537
538
539
540
541
542
543
/**
 * Absolute value of a tarval.
 *
 * @param a  the first tarval
 *
 * @return |a| or tarval_bad
 */
544
545
tarval *tarval_abs(tarval *a);

546
547
548
549
550
551
552
553
/**
 * Bitwise and of two integer tarvals.
 *
 * @param a  the first tarval
 * @param b  the second tarval
 *
 * @return a & b or tarval_bad
 */
554
555
tarval *tarval_and(tarval *a, tarval *b);

556
557
558
559
560
561
562
563
/**
 * Bitwise or of two integer tarvals.
 *
 * @param a  the first tarval
 * @param b  the second tarval
 *
 * @return a | b or tarval_bad
 */
564
tarval *tarval_or(tarval *a, tarval *b);
565

566
567
568
569
570
571
572
573
/**
 * Bitwise exclusive or of two integer tarvals.
 *
 * @param a  the first tarval
 * @param b  the second tarval
 *
 * @return a ^ b or tarval_bad
 */
574
575
tarval *tarval_eor(tarval *a, tarval *b);

576
577
578
579
580
581
582
583
/**
 * Logical Left shift.
 *
 * @param a  the first tarval
 * @param b  the second tarval
 *
 * @return a << b or tarval_bad
 */
584
585
tarval *tarval_shl(tarval *a, tarval *b);

586
587
588
589
590
591
592
593
/**
 * Unsigned (logical) right shift.
 *
 * @param a  the first tarval
 * @param b  the second tarval
 *
 * @return a >>u b or tarval_bad
 */
594
595
tarval *tarval_shr(tarval *a, tarval *b);

596
597
598
599
600
601
602
603
/**
 * Signed (arithmetic) right shift.
 *
 * @param a  the first tarval
 * @param b  the second tarval
 *
 * @return a >>s b or tarval_bad
 */
604
605
tarval *tarval_shrs(tarval *a, tarval *b);

606
607
608
609
610
611
/**
 * Rotation to left.
 *
 * @param a  the first tarval
 * @param b  the second tarval
 *
612
 * @return a \<\<L\>\> b or tarval_bad
613
 */
614
tarval *tarval_rotl(tarval *a, tarval *b);
615

616
617
618
/**
 * Returns the carry flag of the last operation.
 */
619
620
int tarval_carry(void);

621
622
/* *********** Output of tarvals *********** */

Michael Beck's avatar
Michael Beck committed
623
624
625
626
627
628
/**
 * 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
629
 * However, we can do this in the tarval much simpler...
Michael Beck's avatar
Michael Beck committed
630
 */
631
typedef enum {
632
633
634
635
636
637
638
	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)*/
639
} tv_output_mode;
Michael Beck's avatar
Michael Beck committed
640
641
642

/**
 * This structure contains helper information to format the output
Götz Lindenmaier's avatar
Götz Lindenmaier committed
643
 * of a tarval of a mode.
Michael Beck's avatar
Michael Beck committed
644
645
 */
typedef struct tarval_mode_info {
646
647
648
649
650
	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
651
652
653
654
655
} tarval_mode_info;

/**
 * Specify the output options of one mode.
 *
Michael Beck's avatar
Michael Beck committed
656
 * This functions stores the mode info, so DO NOT DESTROY it.
Michael Beck's avatar
Michael Beck committed
657
 *
658
659
 * @param mode      a ir_mode that should be associated
 * @param modeinfo  the output format info
Michael Beck's avatar
Michael Beck committed
660
 *
Michael Beck's avatar
fixed:    
Michael Beck committed
661
 * @return zero on success.
Michael Beck's avatar
Michael Beck committed
662
 */
663
int  set_tarval_mode_output_option(ir_mode *mode, const tarval_mode_info *modeinfo);
Michael Beck's avatar
Michael Beck committed
664

Michael Beck's avatar
fixed:    
Michael Beck committed
665
666
667
/**
 * Returns the output options of one mode.
 *
Michael Beck's avatar
Michael Beck committed
668
 * This functions returns the mode info of a given mode.
Michael Beck's avatar
fixed:    
Michael Beck committed
669
 *
670
 * @param mode      a ir_mode that should be associated
Michael Beck's avatar
fixed:    
Michael Beck committed
671
672
673
 *
 * @return the output option
 */
674
const tarval_mode_info *get_tarval_mode_output_option(ir_mode *mode);
Michael Beck's avatar
fixed:    
Michael Beck committed
675

676
677
/**
 * Returns Bit representation of a tarval value, as string of '0' and '1'
678
 *
679
 * @param tv   The tarval
680
 *
681
682
 * This function returns a printable bit representation of any value
 * stored as tarval. This representation is a null terminated C string.
683
 *
684
685
 * @return
 *   As usual in C a pointer to a char is returned. The length of the
686
687
688
 *   returned string if fixed, just read as many chars as the mode defines
 *   as size.
 *
689
690
691
 * @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
692
 *   The string consists of the ASCII characters '0' and '1' and is
693
 *   null terminated
694
 *
695
 * @sa
696
697
 *    irmode.h for the definition of the ir_mode struct
 *    the size member of aforementioned struct
698
 */
699
char *get_tarval_bitpattern(tarval *tv);
700

701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
/**
 * 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
717
 * - concatenation (endian dependence MUST be handled by the CALLER)
718
 * - bitwise logical operations to select/mask bits
719
 *
720
721
 * @param tv        the tarval
 * @param byte_ofs  the byte offset
722
723
 *
 * @note
Michael Beck's avatar
Michael Beck committed
724
 *   The result of this function is undefined if the mode is neither integer nor float.
725
 */
726
unsigned char get_tarval_sub_bits(tarval *tv, unsigned byte_ofs);
727

728
729
730
/**
 * Returns non-zero if a given (integer) tarval has only one single bit
 * set.
731
732
 *
 * @param tv    the tarval
733
 */
Michael Beck's avatar
Michael Beck committed
734
int tarval_is_single_bit(tarval *tv);
735

736
/**
737
738
739
740
741
 * Output a tarval to a string buffer.
 *
 * @param buf     the output buffer
 * @param buflen  the length of the buffer
 * @param tv      the tarval
742
743
 */
int tarval_snprintf(char *buf, size_t buflen, tarval *tv);
744

745
/**
746
747
748
 * Output a tarval to stdio.
 *
 * @param tv    the tarval
749
750
751
 */
int tarval_printf(tarval *tv);

Michael Beck's avatar
Michael Beck committed
752
753
754
/**
 * Returns non-zero if the mantissa of a floating point IEEE-754
 * tarval is zero (i.e. 1.0Exxx)
755
756
 *
 * @param tv    the tarval
Michael Beck's avatar
Michael Beck committed
757
758
759
760
761
762
 */
int tarval_ieee754_zero_mantissa(tarval *tv);

/**
 * Returns the exponent of a floating point IEEE-754
 * tarval.
763
764
 *
 * @param tv    the tarval
Michael Beck's avatar
Michael Beck committed
765
766
767
 */
int tarval_ieee754_get_exponent(tarval *tv);

768
769
770
771
772
/**
 * Check if the tarval can be converted to the given mode without
 * precision loss.
 *
 * @param tv    the tarval
773
 * @param mode  the mode to convert to
774
775
776
 */
int tarval_ieee754_can_conv_lossless(tarval *tv, ir_mode *mode);

777
778
779
780
781
782
783
784
785
/**
 * 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);

786
787
788
789
790
/**
 *  Returns non-zero if the result of the last IEEE-754 operation was exact.
 */
unsigned tarval_ieee754_get_exact(void);

791
792
793
794
795
796
/**
 * Return the size of the mantissa in bits (including possible
 * implicit bits) for the given mode.
 */
unsigned tarval_ieee754_get_mantissa_size(const ir_mode *mode);

797
798
799
/**
 * Enable/Disable floating point constant folding.
 */
800
801
802
803
void tarval_enable_fp_ops(int enable);

/** returns 0/1 if floating point folding is enable/disabled */
int tarval_fp_ops_enabled(void);
804

805
806
/**
 * Check if its the a floating point NaN.
807
808
 *
 * @param tv    the tarval
809
810
811
812
813
 */
int tarval_is_NaN(tarval *tv);

/**
 * Check if its the a floating point +inf.
814
815
 *
 * @param tv    the tarval
816
817
818
819
820
 */
int tarval_is_plus_inf(tarval *tv);

/**
 * Check if its the a floating point -inf.
821
822
 *
 * @param tv    the tarval
823
824
825
826
827
 */
int tarval_is_minus_inf(tarval *tv);

/**
 * Check if the tarval represents a finite value, ie neither NaN nor inf.
828
829
 *
 * @param tv    the tarval
830
831
832
 */
int tarval_is_finite(tarval *tv);

Michael Beck's avatar
Michael Beck committed
833
834
835
836
837
838
839
840
841
842
/**
 *   Checks whether a pointer points to a tarval.
 *
 *   @param thing     an arbitrary pointer
 *
 *   @return
 *       true if the thing is a tarval, else false
 */
int is_tarval(const void *thing);

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