tv.h 24.8 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
57
#include "begin.h"

58
/* ************************ Constructors for tarvals ************************ */
59
60
61

/**
 * Constructor function for new tarvals.
62
 *
63
64
65
 * @param str   The string representing the target value
 * @param len   The length of the string
 * @param mode  The mode requested for the result tarval
66
 *
67
68
69
70
 * 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.
71
 *
72
 * This function accepts the following strings:
73
 *
74
75
76
77
 * 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)
78
 *
Christoph Mallon's avatar
Christoph Mallon committed
79
 * if mode is float_number:
80
81
82
83
84
85
86
87
88
89
90
91
 *  - (+|-)?(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.
92
93
94
95
 *   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.
 *
96
97
98
 * @note
 *   If the string is not representable in the given mode an assertion is
 *   thrown in assert build.
99
 *
100
 * @sa
101
 *   irmode.h for predefined modes
102
103
104
 *   new_tarval_from_long()
 *   new_tarval_from_double()
 */
105
106
FIRM_DLL tarval *new_tarval_from_str(const char *str, size_t len,
                                     ir_mode *mode);
Christian Schäfer's avatar
Christian Schäfer committed
107

108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
/**
 * Construct a new tarval from a given string.
 *
 * @param str   The string representing the target value
 * @param len   The length of the string
 * @param sign  is -1 or 1 depending on the numbers sign
 * @param base  number system base.
 *              binary(2), octal(8), decimal(10) and hexadecimal(16) numbers
 *              are supported.
 * @param mode  The mode requested for the result tarval
 *
 * @return
 *   A tarval with the given mode. If overflow settings are set to
 *   TV_OVERFLOW_BAD then a tarval_bad is returned if the number can't be
 *   represented in the given mode.
 *   Return bad if the number couldn't successfully be parsed.
 */
125
126
127
FIRM_DLL tarval *new_integer_tarval_from_str(const char *str, size_t len,
                                             char sign, unsigned char base,
                                             ir_mode *mode);
128

129
130
/**
 * Constructor function for new tarvals
131
 *
132
133
 * @param l     The long representing the value
 * @param mode  The mode requested for the result tarval
134
 *
135
136
137
138
 * 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.
139
 *
140
141
 * @return
 *   A tarval of proper type representing the requested value is returned.
142
143
144
145
 *   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.
 *
146
147
148
 * @note
 *   If the long is not representable in the given mode an assertion is
 *   thrown in assert build.
149
 *
150
 * @sa
151
 *   irmode.h for predefined modes
152
153
 *   new_tarval_from_str()
 *   new_tarval_from_double()
154
 *
155
 */
156
FIRM_DLL tarval *new_tarval_from_long(long l, ir_mode *mode);
157

Götz Lindenmaier's avatar
Götz Lindenmaier committed
158
159
/** Return value as long if possible.
 *
160
161
 * This returns a long int with the value represented value, or
 * gibberish, depending on the size of long int and the size of the
162
 * stored value. It works for e.g. 1 as mode_Ls, but might not work for
163
164
 * get_mode_max(mode_Ls).
 * This will overflow silently, so use only if you know what
165
 * you are doing! (better check with tarval_is_long()...)
Götz Lindenmaier's avatar
Götz Lindenmaier committed
166
 * Works only for int modes, even not for character modes!
167
 */
168
FIRM_DLL long get_tarval_long(tarval *tv);
169

170
/**
Götz Lindenmaier's avatar
Götz Lindenmaier committed
171
 * This validates if get_tarval_long() will return a satisfying
172
173
 * result. I.e. if tv is an int_number and between min, max
 * of long int (signed!)
174
175
 *
 * @param tv    the tarval
176
 */
177
FIRM_DLL int tarval_is_long(tarval *tv);
178

179
180
/**
 * Constructor function for new tarvals.
181
 *
182
 * @param d     The (long) double representing the value
183
 * @param mode  The mode requested for the result tarval
184
 *
185
 * This function creates a new tarval representing the value represented
186
 * by a (long) double. If a tarval representing this value already exists,
187
188
189
 * 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.
190
 *
191
192
 * @return
 *   A tarval of proper type representing the requested value is returned.
193
194
195
196
 *   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.
 *
197
 * @note
198
 *   If the (long) double is not representable in the given mode an assertion
199
 *   is thrown. This will happen for any mode not of sort float_number.
200
 *
201
 * @sa
202
 *   irmode.h for predefined values
203
204
205
 *   new_tarval_from_str()
 *   new_tarval_from_long()
 */
206
FIRM_DLL tarval *new_tarval_from_double(long double d, ir_mode *mode);
207
208
209
210
211
212
213

/**
 * 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...)
214
215
 *
 * @param tv    the tarval
216
 */
217
FIRM_DLL long double get_tarval_double(tarval *tv);
218
219
220
221
222

/**
 * 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
223
224
 *
 * @param tv    the tarval
225
 */
226
FIRM_DLL int tarval_is_double(tarval *tv);
227

228
229
230

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

231
/*
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 * 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
252
253
 */

254
255
256
257
258
/**
 * Returns the mode of the tarval.
 *
 * @param tv    the tarval
 */
259
FIRM_DLL ir_mode *get_tarval_mode(const tarval *tv);
260

261
262
263
/** Returns the contents of the 'link' field of the tarval */
/* void *get_tarval_link (tarval*); */

264
265
/* Testing properties of the represented values */

Michael Beck's avatar
Michael Beck committed
266
267
/**
 * Returns 1 if tv is negative
268
 *
269
 * @param tv    the tarval
270
 */
271
FIRM_DLL int tarval_is_negative(tarval *tv);
272

Michael Beck's avatar
Michael Beck committed
273
274
275
/**
 * Returns 1 if tv is null
 *
276
 * @param tv    the tarval
Michael Beck's avatar
Michael Beck committed
277
 */
278
FIRM_DLL int tarval_is_null(tarval *tv);
Michael Beck's avatar
Michael Beck committed
279

Michael Beck's avatar
Michael Beck committed
280
281
282
/**
 * Returns 1 if tv is the "one"
 *
283
 * @param tv    the tarval
Michael Beck's avatar
Michael Beck committed
284
 */
285
FIRM_DLL int tarval_is_one(tarval *tv);
Michael Beck's avatar
Michael Beck committed
286

Michael Beck's avatar
Michael Beck committed
287
288
289
/**
 * Returns 1 if tv is the "minus one"
 *
290
 * @param tv    the tarval
Michael Beck's avatar
Michael Beck committed
291
 */
292
FIRM_DLL int tarval_is_minus_one(tarval *tv);
Michael Beck's avatar
Michael Beck committed
293

294
/**
295
296
 * returns non-zero if all bits in the tarval are set
 */
297
FIRM_DLL int tarval_is_all_one(tarval *tv);
298

299
300
301
302
/**
 * Return non-zero if the tarval is a constant (ie. NOT
 * a reserved tarval like bad, undef, reachable etc.)
 */
303
FIRM_DLL int tarval_is_constant(tarval *tv);
304

305
/** The 'bad' tarval. */
306
FIRM_DLL tarval *tarval_bad;
307
/** Returns the 'bad' tarval. */
308
FIRM_DLL tarval *get_tarval_bad(void);
309

310
/** The 'undefined' tarval. */
311
FIRM_DLL tarval *tarval_undefined;
312
/** Returns the 'undefined' tarval. */
313
FIRM_DLL tarval *get_tarval_undefined(void);
314
315

/** The mode_b tarval 'false'. */
316
FIRM_DLL tarval *tarval_b_false;
317
/** Returns the mode_b tarval 'false'. */
318
FIRM_DLL tarval *get_tarval_b_false(void);
319
320

/** The mode_b tarval 'true'. */
321
FIRM_DLL tarval *tarval_b_true;
322
/** Returns the mode_b tarval 'true'. */
323
FIRM_DLL tarval *get_tarval_b_true(void);
324

325
/** The mode_X tarval 'unreachable'. */
326
FIRM_DLL tarval *tarval_unreachable;
327
/** Returns the mode_X tarval 'unreachable'. */
328
FIRM_DLL tarval *get_tarval_unreachable(void);
329
330

/** The mode_X tarval 'reachable'. */
331
FIRM_DLL tarval *tarval_reachable;
332
/** Returns the mode_X tarval 'reachable'. */
333
FIRM_DLL tarval *get_tarval_reachable(void);
334

335
336
337
338
339
340
341
342
343
344
/** 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()

345
346
347
348
/* 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
349
 * therefore the irmode functions should be preferred to the functions below. */
350
351

/** Returns the maximum value of a given mode. */
352
FIRM_DLL tarval *get_tarval_max(ir_mode *mode);
353
354

/** Returns the minimum value of a given mode. */
355
FIRM_DLL tarval *get_tarval_min(ir_mode *mode);
356

357
358
/** Returns the 0 value (additive neutral) of a given mode.
    For reference modes, the NULL value is returned (old tarval_P_void) */
359
FIRM_DLL tarval *get_tarval_null(ir_mode *mode);
360
361

/** Returns the 1 value (multiplicative neutral) of a given mode. */
362
FIRM_DLL tarval *get_tarval_one(ir_mode *mode);
363

364
365
/** Returns the -1 value (multiplicative neutral) of a given mode.
 *  Returns tarval bad for unsigned modes */
366
FIRM_DLL tarval *get_tarval_minus_one(ir_mode *mode);
367

Matthias Braun's avatar
Matthias Braun committed
368
369
/** returns the value where all bits are 1 of a given mode.
 * returns tarval_bad for float modes */
370
FIRM_DLL tarval *get_tarval_all_one(ir_mode *mode);
Matthias Braun's avatar
Matthias Braun committed
371

372
/** Return quite nan for float_number modes. */
373
FIRM_DLL tarval *get_tarval_nan(ir_mode *mode);
374
375

/** Return +inf for float_number modes. */
376
FIRM_DLL tarval *get_tarval_plus_inf(ir_mode *mode);
377

378
/** Return -inf for float_number modes. */
379
FIRM_DLL tarval *get_tarval_minus_inf(ir_mode *mode);
380
381

/* ******************** Arithmetic operations on tarvals ******************** */
382

383
typedef enum _tarval_int_overflow_mode_t {
384
385
386
	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 */
387
388
389
390
} tarval_int_overflow_mode_t;

/**
 * Sets the overflow mode for integer operations.
391
392
 *
 * @param ov_mode  one of teh overflow modes
393
 */
394
FIRM_DLL void tarval_set_integer_overflow_mode(tarval_int_overflow_mode_t ov_mode);
395
396
397
398

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

401
402
/**
 * Compares two tarvals
403
 *
Michael Beck's avatar
Michael Beck committed
404
 * Compare a with b and return a pn_Cmp describing the relation
Michael Beck's avatar
Michael Beck committed
405
 * between a and b.  This is either pn_Cmp_Uo, pn_Cmp_Lt, pn_Cmp_Eq, pn_Cmp_Gt,
406
 * or pn_Cmp_False if a or b are symbolic pointers which can not be compared at all.
407
 *
408
409
 * @param a   the first tarval to be compared
 * @param b   the second tarval to be compared
410
 *
411
 * @return
Michael Beck's avatar
Michael Beck committed
412
 *   The pn_Cmp best describing the relation between a and b is returned.
413
 *   This means the mode with the least bits set is returned, e.g. if the
Michael Beck's avatar
Michael Beck committed
414
 *   tarvals are equal the pn_Cmp 'pn_Cmp_Eq' is returned, not 'pn_Cmp_Ge' which
415
416
 *   indicates 'greater or equal'
 *
417
 * @sa
Michael Beck's avatar
Michael Beck committed
418
 *    irnode.h for the definition of pn_Cmp
419
 */
420
FIRM_DLL pn_Cmp tarval_cmp(tarval *a, tarval *b);
421

422
423
/**
 * Converts a tarval to another mode.
424
 *
Michael Beck's avatar
Michael Beck committed
425
 * Convert tarval 'src' to mode 'mode', this will succeed if and only if mode
426
427
 * '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.
428
 *
429
430
 * @param src    The tarval to convert
 * @param mode   Tho mode to convert to
431
 *
432
433
 * @return
 *   If a tarval of mode 'mode' with the result of the conversion of the 'src'
434
435
436
 *   tarvals value already exists, it will be returned, else a new tarval is
 *   constructed and returned
 *
437
 * @note
438
 *    Illegal convertions will trigger a panic
439
 *
440
 * @sa
441
442
 *    FIRM documentation for conversion rules
 *    mode_is_smaller defined in irmode.h
443
 */
444
FIRM_DLL tarval *tarval_convert_to(tarval *src, ir_mode *mode);
445

446
447
448
/*
 * These function implement basic computations representable as opcodes
 * in FIRM nodes.
449
450
451
452
453
454
 *
 * PARAMETERS
 *    tarval_neg:
 *    traval_abs:
 *      a - the tarval to operate on
 *
Michael Beck's avatar
Michael Beck committed
455
 *    all others:
456
457
458
459
 *      a - the first operand tarval
 *      b - the second operand tarval
 *
 * RESULT
Michael Beck's avatar
Michael Beck committed
460
 *    If necessary a new tarval is constructed for the resulting value,
461
462
463
464
 *   or the one already carrying the computation result is retrieved and
 *   returned as result.
 *
 * NOTES
465
 *   The order the arguments are given in is important, imagine postfix
466
 *   notation.
467
468
469
470
 *   Illegal operations will trigger an assertion.
 *   The sort member of the struct mode defines which operations are valid
 */

471
472
473
474
475
476
477
/**
 * Bitwise Negation of a tarval.
 *
 * @param a  the first tarval
 *
 * @return ~a or tarval_bad
 */
478
FIRM_DLL tarval *tarval_not(tarval *a);
479

480
481
482
483
484
485
486
/**
 * Arithmetic Negation of a tarval.
 *
 * @param a  the first tarval
 *
 * @return -a or tarval_bad
 */
487
FIRM_DLL tarval *tarval_neg(tarval *a);
488

489
490
491
492
493
494
495
496
/**
 * Addition of two tarvals.
 *
 * @param a  the first tarval
 * @param b  the second tarval
 *
 * @return a + b or tarval_bad
 */
497
FIRM_DLL tarval *tarval_add(tarval *a, tarval *b);
498

499
500
501
502
503
504
505
506
507
/**
 * 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
 */
508
FIRM_DLL tarval *tarval_sub(tarval *a, tarval *b, ir_mode *dst_mode);
509

510
511
512
513
514
515
516
517
/**
 * Multiplication of tarvals.
 *
 * @param a  the first tarval
 * @param b  the second tarval
 *
 * @return a * b or tarval_bad
 */
518
FIRM_DLL tarval *tarval_mul(tarval *a, tarval *b);
519

520
521
522
523
524
525
526
527
/**
 * Division of two floating point tarvals.
 *
 * @param a  the first tarval
 * @param b  the second tarval
 *
 * @return a / b or tarval_bad
 */
528
FIRM_DLL tarval *tarval_quo(tarval *a, tarval *b);
529

530
531
532
533
534
535
536
537
/**
 * Integer division of two tarvals.
 *
 * @param a  the first tarval
 * @param b  the second tarval
 *
 * @return a / b or tarval_bad
 */
538
FIRM_DLL tarval *tarval_div(tarval *a, tarval *b);
539

540
541
542
543
544
545
546
547
/**
 * Remainder of integer division.
 *
 * @param a  the first tarval
 * @param b  the second tarval
 *
 * @return a % b or tarval_bad
 */
548
FIRM_DLL tarval *tarval_mod(tarval *a, tarval *b);
549

550
551
552
553
554
555
556
557
558
/**
 * 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
 */
559
FIRM_DLL tarval *tarval_divmod(tarval *a, tarval *b, tarval **mod_res);
Michael Beck's avatar
Michael Beck committed
560

561
562
563
564
565
566
567
/**
 * Absolute value of a tarval.
 *
 * @param a  the first tarval
 *
 * @return |a| or tarval_bad
 */
568
FIRM_DLL tarval *tarval_abs(tarval *a);
569

570
571
572
573
574
575
576
577
/**
 * Bitwise and of two integer tarvals.
 *
 * @param a  the first tarval
 * @param b  the second tarval
 *
 * @return a & b or tarval_bad
 */
578
FIRM_DLL tarval *tarval_and(tarval *a, tarval *b);
579

580
581
582
583
584
585
586
587
/**
 * Bitwise and not of two integer tarvals.
 *
 * @param a  the first tarval
 * @param b  the second tarval
 *
 * @return a & ~b or tarval_bad
 */
588
FIRM_DLL tarval *tarval_andnot(tarval *a, tarval *b);
589

590
591
592
593
594
595
596
597
/**
 * Bitwise or of two integer tarvals.
 *
 * @param a  the first tarval
 * @param b  the second tarval
 *
 * @return a | b or tarval_bad
 */
598
FIRM_DLL tarval *tarval_or(tarval *a, tarval *b);
599

600
601
602
603
604
605
606
607
/**
 * Bitwise exclusive or of two integer tarvals.
 *
 * @param a  the first tarval
 * @param b  the second tarval
 *
 * @return a ^ b or tarval_bad
 */
608
FIRM_DLL tarval *tarval_eor(tarval *a, tarval *b);
609

610
611
612
613
614
615
616
617
/**
 * Logical Left shift.
 *
 * @param a  the first tarval
 * @param b  the second tarval
 *
 * @return a << b or tarval_bad
 */
618
FIRM_DLL tarval *tarval_shl(tarval *a, tarval *b);
619

620
621
622
623
624
625
626
627
/**
 * Unsigned (logical) right shift.
 *
 * @param a  the first tarval
 * @param b  the second tarval
 *
 * @return a >>u b or tarval_bad
 */
628
FIRM_DLL tarval *tarval_shr(tarval *a, tarval *b);
629

630
631
632
633
634
635
636
637
/**
 * Signed (arithmetic) right shift.
 *
 * @param a  the first tarval
 * @param b  the second tarval
 *
 * @return a >>s b or tarval_bad
 */
638
FIRM_DLL tarval *tarval_shrs(tarval *a, tarval *b);
639

640
641
642
643
644
645
/**
 * Rotation to left.
 *
 * @param a  the first tarval
 * @param b  the second tarval
 *
646
 * @return a \<\<L\>\> b or tarval_bad
647
 */
648
FIRM_DLL tarval *tarval_rotl(tarval *a, tarval *b);
649

650
651
652
/**
 * Returns the carry flag of the last operation.
 */
653
FIRM_DLL int tarval_carry(void);
654

655
656
/* *********** Output of tarvals *********** */

Michael Beck's avatar
Michael Beck committed
657
658
659
660
661
662
/**
 * 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
663
 * However, we can do this in the tarval much simpler...
Michael Beck's avatar
Michael Beck committed
664
 */
665
typedef enum {
666
667
668
669
670
671
672
	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)*/
673
} tv_output_mode;
Michael Beck's avatar
Michael Beck committed
674
675
676

/**
 * This structure contains helper information to format the output
Götz Lindenmaier's avatar
Götz Lindenmaier committed
677
 * of a tarval of a mode.
Michael Beck's avatar
Michael Beck committed
678
679
 */
typedef struct tarval_mode_info {
680
681
682
683
684
	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
685
686
687
688
689
} tarval_mode_info;

/**
 * Specify the output options of one mode.
 *
Michael Beck's avatar
Michael Beck committed
690
 * This functions stores the mode info, so DO NOT DESTROY it.
Michael Beck's avatar
Michael Beck committed
691
 *
692
693
 * @param mode      a ir_mode that should be associated
 * @param modeinfo  the output format info
Michael Beck's avatar
Michael Beck committed
694
 *
Michael Beck's avatar
fixed:    
Michael Beck committed
695
 * @return zero on success.
Michael Beck's avatar
Michael Beck committed
696
 */
697
698
FIRM_DLL int set_tarval_mode_output_option(ir_mode *mode,
                                           const tarval_mode_info *modeinfo);
Michael Beck's avatar
Michael Beck committed
699

Michael Beck's avatar
fixed:    
Michael Beck committed
700
701
702
/**
 * Returns the output options of one mode.
 *
Michael Beck's avatar
Michael Beck committed
703
 * This functions returns the mode info of a given mode.
Michael Beck's avatar
fixed:    
Michael Beck committed
704
 *
705
 * @param mode      a ir_mode that should be associated
Michael Beck's avatar
fixed:    
Michael Beck committed
706
707
708
 *
 * @return the output option
 */
709
FIRM_DLL const tarval_mode_info *get_tarval_mode_output_option(ir_mode *mode);
Michael Beck's avatar
fixed:    
Michael Beck committed
710

711
712
/**
 * Returns Bit representation of a tarval value, as string of '0' and '1'
713
 *
714
 * @param tv   The tarval
715
 *
716
717
 * This function returns a printable bit representation of any value
 * stored as tarval. This representation is a null terminated C string.
718
 *
719
720
 * @return
 *   As usual in C a pointer to a char is returned. The length of the
721
722
723
 *   returned string if fixed, just read as many chars as the mode defines
 *   as size.
 *
724
725
726
 * @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
727
 *   The string consists of the ASCII characters '0' and '1' and is
728
 *   null terminated
729
 *
730
 * @sa
731
732
 *    irmode.h for the definition of the ir_mode struct
 *    the size member of aforementioned struct
733
 */
734
FIRM_DLL char *get_tarval_bitpattern(tarval *tv);
735

736
737
738
739
740
741
742
743
/**
 * 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:
 *
744
 * val0 = tarval_sub_bits(tv, 0);  <- lowest bits
745
746
 * val1 = tarval_sub_bits(tv, 1);
 * val2 = tarval_sub_bits(tv, 2);
747
 * val3 = tarval_sub_bits(tv, 3);  <- highest bits
748
749
750
751
 *
 * 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
752
 * - concatenation (endian dependence MUST be handled by the CALLER)
753
 * - bitwise logical operations to select/mask bits
754
 *
755
 * @param tv        the tarval
756
 * @param byte_ofs  the byte offset from lower to higher
757
758
 *
 * @note
Michael Beck's avatar
Michael Beck committed
759
 *   The result of this function is undefined if the mode is neither integer nor float.
760
 */
761
FIRM_DLL unsigned char get_tarval_sub_bits(tarval *tv, unsigned byte_ofs);
762

763
764
765
/**
 * Returns non-zero if a given (integer) tarval has only one single bit
 * set.
766
767
 *
 * @param tv    the tarval
768
 */
769
FIRM_DLL int tarval_is_single_bit(tarval *tv);
770

771
772
773
774
775
776
777
/**
 * Return the number of set bits in a given (integer) tarval.
 *
 * @param tv    the tarval
 *
 * @return number of set bits or -1 on error
 */
778
FIRM_DLL int get_tarval_popcount(tarval *tv);
779
780
781
782
783
784
785
786

/**
 * Return the number of the lowest set bit in a given (integer) tarval.
 *
 * @param tv    the tarval
 *
 * @return number of lowest set bit or -1 on error
 */
787
FIRM_DLL int get_tarval_lowest_bit(tarval *tv);
788

789
/**
790
791
792
793
794
 * Output a tarval to a string buffer.
 *
 * @param buf     the output buffer
 * @param buflen  the length of the buffer
 * @param tv      the tarval
795
 */
796
FIRM_DLL int tarval_snprintf(char *buf, size_t buflen, tarval *tv);
797

798
/**
799
800
801
 * Output a tarval to stdio.
 *
 * @param tv    the tarval
802
 */
803
FIRM_DLL int tarval_printf(tarval *tv);
804

Michael Beck's avatar
Michael Beck committed
805
806
807
/**
 * Returns non-zero if the mantissa of a floating point IEEE-754
 * tarval is zero (i.e. 1.0Exxx)
808
809
 *
 * @param tv    the tarval
Michael Beck's avatar
Michael Beck committed
810
 */
811
FIRM_DLL int tarval_ieee754_zero_mantissa(tarval *tv);
Michael Beck's avatar
Michael Beck committed
812
813
814
815

/**
 * Returns the exponent of a floating point IEEE-754
 * tarval.
816
817
 *
 * @param tv    the tarval
Michael Beck's avatar
Michael Beck committed
818
 */
819
FIRM_DLL int tarval_ieee754_get_exponent(tarval *tv);
Michael Beck's avatar
Michael Beck committed
820

821
822
823
824
825
/**
 * Check if the tarval can be converted to the given mode without
 * precision loss.
 *
 * @param tv    the tarval
826
 * @param mode  the mode to convert to
827
 */
828
FIRM_DLL int tarval_ieee754_can_conv_lossless(tarval *tv, ir_mode *mode);
829

830
831
832
833
834
835
836
/**
 * 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
 */
837
FIRM_DLL unsigned tarval_ieee754_set_immediate_precision(unsigned bits);
838

839
840
841
/**
 *  Returns non-zero if the result of the last IEEE-754 operation was exact.
 */
842
FIRM_DLL unsigned tarval_ieee754_get_exact(void);
843

844
845
846
847
/**
 * Return the size of the mantissa in bits (including possible
 * implicit bits) for the given mode.
 */
848
FIRM_DLL unsigned tarval_ieee754_get_mantissa_size(const ir_mode *mode);
849

850
851
852
/**
 * Enable/Disable floating point constant folding.
 */
853
FIRM_DLL void tarval_enable_fp_ops(int enable);
854
855

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

858
859
/**
 * Check if its the a floating point NaN.
860
861
 *
 * @param tv    the tarval
862
 */
863
FIRM_DLL int tarval_is_NaN(tarval *tv);
864
865
866

/**
 * Check if its the a floating point +inf.
867
868
 *
 * @param tv    the tarval
869
 */
870
FIRM_DLL int tarval_is_plus_inf(tarval *tv);
871
872
873

/**
 * Check if its the a floating point -inf.
874
875
 *
 * @param tv    the tarval
876
 */
877
FIRM_DLL int tarval_is_minus_inf(tarval *tv);
878
879
880

/**
 * Check if the tarval represents a finite value, ie neither NaN nor inf.
881
882
 *
 * @param tv    the tarval
883
 */
884
FIRM_DLL int tarval_is_finite(tarval *tv);
885

Michael Beck's avatar
Michael Beck committed
886
887
888
889
890
891
892
893
/**
 *   Checks whether a pointer points to a tarval.
 *
 *   @param thing     an arbitrary pointer
 *
 *   @return
 *       true if the thing is a tarval, else false
 */
894
895
896
FIRM_DLL int is_tarval(const void *thing);

#include "end.h"
Michael Beck's avatar
Michael Beck committed
897

898
#endif