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 int align; /**< mode alignment in Bits. */
38 unsigned sign:1; /**< signedness of this mode */
39 unsigned int modulo_shift; /**< number of bits a valus of this mode will be shifted */
40 unsigned vector_elem; /**< if this is not equal 1, this is a vector mode with
41 vector_elem number of elements, size contains the size
42 of all bits and must be dividable by vector_elem */
44 /* ----------------------------------------------------------------------- */
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_align_bits(const ir_mode *mode) { return mode->align; }
91 __get_mode_align_bytes(const ir_mode *mode) {
92 int align = __get_mode_align_bits(mode);
93 if ((align & 7) != 0) return -1;
98 __get_mode_sign(const ir_mode *mode) { return mode->sign; }
101 __get_mode_arithmetic(const ir_mode *mode) { return mode->arithmetic; }
103 static INLINE unsigned int
104 __get_mode_modulo_shift(const ir_mode *mode) { return mode->modulo_shift; }
106 static INLINE unsigned int
107 __get_mode_vector_elems(const ir_mode *mode) { return mode->vector_elem; }
110 __get_mode_link(const ir_mode *mode) { return mode->link; }
113 __set_mode_link(ir_mode *mode, void *l) { mode->link = l; }
115 /* Functions to check, whether a modecode is signed, float, int, num, data,
116 datab or dataM. For more exact definitions read the corresponding pages
117 in the firm documentation or the followingenumeration
119 The set of "float" is defined as:
120 ---------------------------------
121 float = {irm_F, irm_D, irm_E}
123 The set of "int" is defined as:
124 -------------------------------
125 int = {irm_Bs, irm_Bu, irm_Hs, irm_Hu, irm_Is, irm_Iu, irm_Ls, irm_Lu}
127 The set of "num" is defined as:
128 -------------------------------
129 num = {irm_F, irm_D, irm_E, irm_Bs, irm_Bu, irm_Hs, irm_Hu,
130 irm_Is, irm_Iu, irm_Ls, irm_Lu}
133 The set of "data" is defined as:
134 -------------------------------
135 data = {irm_F, irm_D, irm_E irm_Bs, irm_Bu, irm_Hs, irm_Hu,
136 irm_Is, irm_Iu, irm_Ls, irm_Lu, irm_C, irm_U, irm_P}
137 = {num || irm_C || irm_U || irm_P}
139 The set of "datab" is defined as:
140 ---------------------------------
141 datab = {irm_F, irm_D, irm_E, irm_Bs, irm_Bu, irm_Hs, irm_Hu,
142 irm_Is, irm_Iu, irm_Ls, irm_Lu, irm_C, irm_U, irm_P, irm_b}
145 The set of "dataM" is defined as:
146 ---------------------------------
147 dataM = {irm_F, irm_D, irm_E, irm_Bs, irm_Bu, irm_Hs, irm_Hu,
148 irm_Is, irm_Iu, irm_Ls, irm_Lu, irm_C, irm_U, irm_P, irm_M}
153 __mode_is_signed(const ir_mode *mode) {
159 __mode_is_float(const ir_mode *mode) {
161 return (__get_mode_sort(mode) == irms_float_number);
165 __mode_is_int(const ir_mode *mode) {
167 return (__get_mode_sort(mode) == irms_int_number);
171 __mode_is_character(const ir_mode *mode) {
173 return (__get_mode_sort(mode) == irms_character);
177 __mode_is_reference(const ir_mode *mode) {
179 return (__get_mode_sort(mode) == irms_reference);
183 __mode_is_num(const ir_mode *mode) {
185 return (__mode_is_int(mode) || __mode_is_float(mode));
189 __mode_is_numP(const ir_mode *mode) {
191 return (__mode_is_int(mode) || __mode_is_float(mode) || __mode_is_reference(mode));
195 __mode_is_data(const ir_mode *mode) {
197 return (__mode_is_num(mode) || __get_mode_sort(mode) == irms_character || __get_mode_sort(mode) == irms_reference);
201 __mode_is_datab(const ir_mode *mode) {
203 return (__mode_is_data(mode) || __get_mode_sort(mode) == irms_internal_boolean);
207 __mode_is_dataM(const ir_mode *mode) {
209 return (__mode_is_data(mode) || __get_mode_modecode(mode) == irm_M);
213 __mode_is_float_vector(const ir_mode *mode) {
215 return (__get_mode_sort(mode) == irms_float_number) && (__get_mode_vector_elems(mode) > 1);
219 __mode_is_int_vector(const ir_mode *mode) {
221 return (__get_mode_sort(mode) == irms_int_number) && (__get_mode_vector_elems(mode) > 1);
224 /** mode module initialization, call once before use of any other function **/
225 void init_mode(void);
227 /** mode module finalization. frees all memory. */
228 void finish_mode(void);
230 #define get_modeP_mach() __get_modeP_mach()
231 #define set_modeP_mach(p) __set_modeP_mach(p)
232 #define get_mode_modecode(mode) __get_mode_modecode(mode)
233 #define get_mode_ident(mode) __get_mode_ident(mode)
234 #define get_mode_sort(mode) __get_mode_sort(mode)
235 #define get_mode_size_bits(mode) __get_mode_size_bits(mode)
236 #define get_mode_size_bytes(mode) __get_mode_size_bytes(mode)
237 #define get_mode_align(mode) __get_mode_align(mode)
238 #define get_mode_sign(mode) __get_mode_sign(mode)
239 #define get_mode_arithmetic(mode) __get_mode_arithmetic(mode)
240 #define get_mode_modulo_shift(mode) __get_mode_modulo_shift(mode)
241 #define get_mode_n_vector_elems(mode) __get_mode_vector_elems(mode)
242 #define get_mode_link(mode) __get_mode_link(mode)
243 #define set_mode_link(mode, l) __set_mode_link(mode, l)
244 #define mode_is_signed(mode) __mode_is_signed(mode)
245 #define mode_is_float(mode) __mode_is_float(mode)
246 #define mode_is_int(mode) __mode_is_int(mode)
247 #define mode_is_character(mode) __mode_is_character(mode)
248 #define mode_is_reference(mode) __mode_is_reference(mode)
249 #define mode_is_num(mode) __mode_is_num(mode)
250 #define mode_is_numP(mode) __mode_is_numP(mode)
251 #define mode_is_data(mode) __mode_is_data(mode)
252 #define mode_is_datab(mode) __mode_is_datab(mode)
253 #define mode_is_dataM(mode) __mode_is_dataM(mode)
254 #define mode_is_float_vector(mode) __mode_is_float_vector(mode)
255 #define mode_is_int_vector(mode) __mode_is_int_vector(mode)
257 #endif /* _IRMODE_T_H_ */