3 * File name: ir/ir/irmode_t.h
4 * Purpose: Data modes of operations -- private header.
5 * Author: Martin Trapp, Christian Schaefer
6 * Modified by: Goetz Lindenmaier, Mathias Heil
9 * Copyright: (c) 1998-2003 Universität Karlsruhe
10 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
24 /** This struct is supposed to completely define a mode. **/
26 firm_kind kind; /**< distinguishes this node from others */
27 modecode code; /**< unambiguous identifier of a mode */
28 ident *name; /**< Name ident of this mode */
30 /* ----------------------------------------------------------------------- */
31 /* On changing this struct you have to evaluate the mode_are_equal function!*/
32 mode_sort sort; /**< coarse classification of this mode:
33 int, float, reference ...
35 mode_arithmetic arithmetic; /**< different arithmetic operations possible with a mode */
36 int size; /**< size of the mode in Bits. */
37 unsigned sign:1; /**< signedness of this mode */
38 unsigned int modulo_shift; /**< number of bits a valus of this mode will be shifted */
39 unsigned vector_elem; /**< if this is not equal 1, this is a vector mode with
40 vector_elem number of elements, size contains the size
41 of all bits and must be dividable by vector_elem */
43 /* ----------------------------------------------------------------------- */
44 tarval *min; /**< the minimum value that can be expressed */
45 tarval *max; /**< the maximum value that can be expressed */
46 tarval *null; /**< the value 0 */
47 tarval *one; /**< the value 1 */
48 tarval *minus_one; /**< the value -1 */
49 void *link; /**< To store some intermediate information */
50 const void *tv_priv; /**< tarval module will save private data here */
54 /* ------------------------------- *
56 * ------------------------------- */
57 extern ir_mode *mode_P_mach;
59 static INLINE ir_mode *
60 __get_modeP_mach(void) { return mode_P_mach; }
63 __set_modeP_mach(ir_mode *p) {
64 assert(mode_is_reference(p));
68 static INLINE modecode
69 __get_mode_modecode(const ir_mode *mode) { return mode->code; }
72 __get_mode_ident(const ir_mode *mode) { return mode->name; }
74 static INLINE mode_sort
75 __get_mode_sort(const ir_mode* mode) { return mode->sort; }
78 __get_mode_size_bits(const ir_mode *mode) { return mode->size; }
81 __get_mode_size_bytes(const ir_mode *mode) {
82 int size = __get_mode_size_bits(mode);
83 if ((size & 7) != 0) return -1;
88 __get_mode_sign(const ir_mode *mode) { return mode->sign; }
91 __get_mode_arithmetic(const ir_mode *mode) { return mode->arithmetic; }
93 static INLINE unsigned int
94 __get_mode_modulo_shift(const ir_mode *mode) { return mode->modulo_shift; }
96 static INLINE unsigned int
97 __get_mode_vector_elems(const ir_mode *mode) { return mode->vector_elem; }
100 __get_mode_link(const ir_mode *mode) { return mode->link; }
103 __set_mode_link(ir_mode *mode, void *l) { mode->link = l; }
105 /* Functions to check, whether a modecode is signed, float, int, num, data,
106 datab or dataM. For more exact definitions read the corresponding pages
107 in the firm documentation or the followingenumeration
109 The set of "float" is defined as:
110 ---------------------------------
111 float = {irm_F, irm_D, irm_E}
113 The set of "int" is defined as:
114 -------------------------------
115 int = {irm_Bs, irm_Bu, irm_Hs, irm_Hu, irm_Is, irm_Iu, irm_Ls, irm_Lu}
117 The set of "num" is defined as:
118 -------------------------------
119 num = {irm_F, irm_D, irm_E, irm_Bs, irm_Bu, irm_Hs, irm_Hu,
120 irm_Is, irm_Iu, irm_Ls, irm_Lu}
123 The set of "data" is defined as:
124 -------------------------------
125 data = {irm_F, irm_D, irm_E irm_Bs, irm_Bu, irm_Hs, irm_Hu,
126 irm_Is, irm_Iu, irm_Ls, irm_Lu, irm_C, irm_U, irm_P}
127 = {num || irm_C || irm_U || irm_P}
129 The set of "datab" is defined as:
130 ---------------------------------
131 datab = {irm_F, irm_D, irm_E, irm_Bs, irm_Bu, irm_Hs, irm_Hu,
132 irm_Is, irm_Iu, irm_Ls, irm_Lu, irm_C, irm_U, irm_P, irm_b}
135 The set of "dataM" is defined as:
136 ---------------------------------
137 dataM = {irm_F, irm_D, irm_E, irm_Bs, irm_Bu, irm_Hs, irm_Hu,
138 irm_Is, irm_Iu, irm_Ls, irm_Lu, irm_C, irm_U, irm_P, irm_M}
143 __mode_is_signed(const ir_mode *mode) {
149 __mode_is_float(const ir_mode *mode) {
151 return (__get_mode_sort(mode) == irms_float_number);
155 __mode_is_int(const ir_mode *mode) {
157 return (__get_mode_sort(mode) == irms_int_number);
161 __mode_is_character(const ir_mode *mode) {
163 return (__get_mode_sort(mode) == irms_character);
167 __mode_is_reference(const ir_mode *mode) {
169 return (__get_mode_sort(mode) == irms_reference);
173 __mode_is_num(const ir_mode *mode) {
175 return (__mode_is_int(mode) || __mode_is_float(mode));
179 __mode_is_numP(const ir_mode *mode) {
181 return (__mode_is_int(mode) || __mode_is_float(mode) || __mode_is_reference(mode));
185 __mode_is_data(const ir_mode *mode) {
187 return (__mode_is_num(mode) || __get_mode_sort(mode) == irms_character || __get_mode_sort(mode) == irms_reference);
191 __mode_is_datab(const ir_mode *mode) {
193 return (__mode_is_data(mode) || __get_mode_sort(mode) == irms_internal_boolean);
197 __mode_is_dataM(const ir_mode *mode) {
199 return (__mode_is_data(mode) || __get_mode_modecode(mode) == irm_M);
203 __mode_is_float_vector(const ir_mode *mode) {
205 return (__get_mode_sort(mode) == irms_float_number) && (__get_mode_vector_elems(mode) > 1);
209 __mode_is_int_vector(const ir_mode *mode) {
211 return (__get_mode_sort(mode) == irms_int_number) && (__get_mode_vector_elems(mode) > 1);
214 /** mode module initialization, call once before use of any other function **/
215 void init_mode(void);
217 /** mode module finalization. frees all memory. */
218 void finish_mode(void);
220 #define get_modeP_mach() __get_modeP_mach()
221 #define set_modeP_mach(p) __set_modeP_mach(p)
222 #define get_mode_modecode(mode) __get_mode_modecode(mode)
223 #define get_mode_ident(mode) __get_mode_ident(mode)
224 #define get_mode_sort(mode) __get_mode_sort(mode)
225 #define get_mode_size_bits(mode) __get_mode_size_bits(mode)
226 #define get_mode_size_bytes(mode) __get_mode_size_bytes(mode)
227 #define get_mode_sign(mode) __get_mode_sign(mode)
228 #define get_mode_arithmetic(mode) __get_mode_arithmetic(mode)
229 #define get_mode_modulo_shift(mode) __get_mode_modulo_shift(mode)
230 #define get_mode_n_vector_elems(mode) __get_mode_vector_elems(mode)
231 #define get_mode_link(mode) __get_mode_link(mode)
232 #define set_mode_link(mode, l) __set_mode_link(mode, l)
233 #define mode_is_signed(mode) __mode_is_signed(mode)
234 #define mode_is_float(mode) __mode_is_float(mode)
235 #define mode_is_int(mode) __mode_is_int(mode)
236 #define mode_is_character(mode) __mode_is_character(mode)
237 #define mode_is_reference(mode) __mode_is_reference(mode)
238 #define mode_is_num(mode) __mode_is_num(mode)
239 #define mode_is_numP(mode) __mode_is_numP(mode)
240 #define mode_is_data(mode) __mode_is_data(mode)
241 #define mode_is_datab(mode) __mode_is_datab(mode)
242 #define mode_is_dataM(mode) __mode_is_dataM(mode)
243 #define mode_is_float_vector(mode) __mode_is_float_vector(mode)
244 #define mode_is_int_vector(mode) __mode_is_int_vector(mode)
246 #endif /* _IRMODE_T_H_ */