1 /*
2 * Copyright (C) 1995-2011 University of Karlsruhe. All right reserved.
3 *
4 * This file is part of libFirm.
5 *
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
10 *
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
14 *
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17 * PURPOSE.
18 */
19
20 /**
21 * @file
22 * @brief Representation of and static computations on target machine
23 * values -- private header.
24 * @date 2003
25 * @author Mathias Heil
26 */
27 #ifndef FIRM_TV_TV_T_H
28 #define FIRM_TV_TV_T_H
29
30 #include "firm_common.h"
31
32 #include <assert.h>
33 #include "irmode.h"
34 #include "tv.h"
35
36 /** Debugging aid for the firmEvaluator: Marks for reserved tarvals values. */
37 enum reserved_id {
38 resid_tarval_bad = 1, /**< tarval_bad marker. */
39 resid_tarval_undefined = 2, /**< tarval_undefined marker. */
40 resid_tarval_b_false = 3, /**< tarval_b_false marker. */
41 resid_tarval_b_true = 4, /**< tarval_b_true marker. */
42 resid_tarval_unreachable = 5, /**< tarval_unreachable marker. */
43 resid_tarval_reachable = 6 /**< tarval_reachable marker. */
44 };
45
46 /**
47 * Initialization of the tarval module.
48 *
49 * Call before init_mode().
50 *
51 * @param null_value
52 * The reference mode NULL value, typical 0l
53 * @param support_quad_precision
54 * If non-zero, activate support for quad precision
55 */
56 void init_tarval_1(long null_value, int support_quad_precision);
57
58 /**
59 * Initialization of the tarval module.
60 *
61 * Call after init_mode().
62 */
63 void init_tarval_2(void);
64
65 /**
66 * Free all memory occupied by the tarval module.
67 */
68 void finish_tarval(void);
69
70 /**
71 * This struct represents the afore mentioned tarvals.
72 *
73 * A tarval struct consists of an internal representation of the
74 * value and some additional fields further describing the value.
75 *
76 * ATTRIBUTES:
77 * - ir_mode *mode The mode of the stored value
78 * - void *value The internal representation
79 *
80 * @sa
81 * irmode.h for predefined modes
82 */
83 struct ir_tarval {
84 firm_kind kind; /**< must be k_tarval */
85 ir_mode *mode; /**< the mode of the stored value */
86 const void *value; /**< the value stored in an internal way... */
87 size_t length; /**< the length of the stored value */
88 };
89
90 /* inline functions */
91 /*
92 * Access routines for tarval fields ========================================
93 */
_get_tarval_mode(const ir_tarval * tv)94 static inline ir_mode *_get_tarval_mode(const ir_tarval *tv)
95 {
96 assert(tv);
97 return tv->mode;
98 }
99
_get_tarval_bad(void)100 static inline ir_tarval *_get_tarval_bad(void)
101 {
102 return tarval_bad;
103 }
104
_get_tarval_undefined(void)105 static inline ir_tarval *_get_tarval_undefined(void)
106 {
107 return tarval_undefined;
108 }
109
_get_tarval_b_false(void)110 static inline ir_tarval *_get_tarval_b_false(void)
111 {
112 return tarval_b_false;
113 }
114
_get_tarval_b_true(void)115 static inline ir_tarval *_get_tarval_b_true(void)
116 {
117 return tarval_b_true;
118 }
119
_get_tarval_reachable(void)120 static inline ir_tarval *_get_tarval_reachable(void)
121 {
122 return tarval_reachable;
123 }
124
_get_tarval_unreachable(void)125 static inline ir_tarval *_get_tarval_unreachable(void)
126 {
127 return tarval_unreachable;
128 }
129
_is_tarval(const void * thing)130 static inline int _is_tarval(const void *thing)
131 {
132 return get_kind(thing) == k_tarval;
133 }
134
135 #define get_tarval_mode(tv) _get_tarval_mode(tv)
136 #define get_tarval_bad() _get_tarval_bad()
137 #define get_tarval_undefined() _get_tarval_undefined()
138 #define get_tarval_b_false() _get_tarval_b_false()
139 #define get_tarval_b_true() _get_tarval_b_true()
140 #define get_tarval_unreachable() _get_tarval_unreachable()
141 #define get_tarval_reachable() _get_tarval_reachable()
142 #define is_tarval(thing) _is_tarval(thing)
143
144 #endif /* FIRM_TV_TV_T_H */
145