2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
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.
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.
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
22 * @brief Representation of and static computations on target machine
23 * values -- private header.
25 * @author Mathias Heil
28 #ifndef FIRM_TV_TV_T_H
29 #define FIRM_TV_TV_T_H
31 #include "firm_config.h"
32 #include "firm_common.h"
38 /** Debugging aid for the firmEvaluator: Marks for reserved tarvals values. */
40 resid_tarval_bad = 1, /**< tarval_bad marker. */
41 resid_tarval_undefined = 2, /**< tarval_undefined marker. */
42 resid_tarval_b_false = 3, /**< tarval_b_false marker. */
43 resid_tarval_b_true = 4, /**< tarval_b_true marker. */
44 resid_tarval_unreachable = 5, /**< tarval_unreachable marker. */
45 resid_tarval_reachable = 6 /**< tarval_reachable marker. */
49 * Initialization of the tarval module.
51 * Call before init_mode().
53 * @param null_value The reference mode NULL value, typical 0l
55 void init_tarval_1(long null_value);
58 * Initialization of the tarval module.
60 * Call after init_mode().
62 void init_tarval_2(void);
65 * Free all memory occupied by the tarval module.
67 void finish_tarval(void);
70 * This struct represents the afore mentioned tarvals.
72 * A tarval struct consists of an internal representation of the
73 * value and some additional fields further describing the value.
76 * - ir_mode *mode The mode of the stored value
77 * - void *value The internal representation
80 * irmode.h for predefined modes
83 firm_kind kind; /**< must be k_tarval */
84 ir_mode *mode; /**< the mode of the stored value */
85 const void *value; /**< the value stored in an internal way... */
86 unsigned int length; /**< the length of the stored value */
89 /* inline functions */
91 * Access routines for tarval fields ========================================
93 static INLINE ir_mode *
94 _get_tarval_mode(const tarval *tv) {
99 static INLINE tarval *
100 _get_tarval_bad(void) {
104 static INLINE tarval *
105 _get_tarval_undefined(void) {
106 return tarval_undefined;
109 static INLINE tarval *
110 _get_tarval_b_false(void) {
111 return tarval_b_false;
114 static INLINE tarval *
115 _get_tarval_b_true(void) {
116 return tarval_b_true;
119 static INLINE tarval *
120 _get_tarval_reachable(void) {
121 return tarval_reachable;
124 static INLINE tarval *
125 _get_tarval_unreachable(void) {
126 return tarval_unreachable;
130 _is_tarval(const void *thing) {
131 return get_kind(thing) == k_tarval;
134 #define get_tarval_mode(tv) _get_tarval_mode(tv)
135 #define get_tarval_bad() _get_tarval_bad()
136 #define get_tarval_undefined() _get_tarval_undefined()
137 #define get_tarval_b_false() _get_tarval_b_false()
138 #define get_tarval_b_true() _get_tarval_b_true()
139 #define get_tarval_unreachable() _get_tarval_unreachable()
140 #define get_tarval_reachable() _get_tarval_reachable()
141 #define get_tarval_P_void() _get_tarval_P_void()
142 #define is_tarval(thing) _is_tarval(thing)
144 #endif /* FIRM_TV_TV_T_H */