beifg: Factorise code to count interference components.
[libfirm] / ir / ir / irmode_t.h
1 /*
2  * This file is part of libFirm.
3  * Copyright (C) 2012 University of Karlsruhe.
4  */
5
6 /**
7  * @file
8  * @brief   Data modes of operations -- private header.
9  * @author  Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Mathias Heil,
10  *          Michael Beck
11  */
12 #ifndef FIRM_IR_IRMODE_T_H
13 #define FIRM_IR_IRMODE_T_H
14
15 #include <assert.h>
16 #include "irtypes.h"
17 #include "irmode.h"
18
19 #define get_modeP_code()               get_modeP_code_()
20 #define get_modeP_data()               get_modeP_data_()
21 #define get_mode_ident(mode)           get_mode_ident_(mode)
22 #define get_mode_sort(mode)            get_mode_sort_(mode)
23 #define get_mode_size_bits(mode)       get_mode_size_bits_(mode)
24 #define get_mode_size_bytes(mode)      get_mode_size_bytes_(mode)
25 #define get_mode_sign(mode)            get_mode_sign_(mode)
26 #define get_mode_arithmetic(mode)      get_mode_arithmetic_(mode)
27 #define get_mode_modulo_shift(mode)    get_mode_modulo_shift_(mode)
28 #define get_mode_link(mode)            get_mode_link_(mode)
29 #define set_mode_link(mode, l)         set_mode_link_(mode, l)
30 #define mode_is_signed(mode)           mode_is_signed_(mode)
31 #define mode_is_float(mode)            mode_is_float_(mode)
32 #define mode_is_int(mode)              mode_is_int_(mode)
33 #define mode_is_reference(mode)        mode_is_reference_(mode)
34 #define mode_is_num(mode)              mode_is_num_(mode)
35 #define mode_is_data(mode)             mode_is_data_(mode)
36 #define mode_is_datab(mode)            mode_is_datab_(mode)
37 #define mode_is_dataM(mode)            mode_is_dataM_(mode)
38 #define get_type_for_mode(mode)        get_type_for_mode_(mode)
39 #define get_mode_mantissa_size(mode)   get_mode_mantissa_size_(mode)
40 #define get_mode_exponent_size(mode)   get_mode_exponent_size_(mode)
41
42 static inline ir_mode *get_modeP_code_(void) { return mode_P_code; }
43
44 static inline ir_mode *get_modeP_data_(void) { return mode_P_data; }
45
46 static inline ident *get_mode_ident_(const ir_mode *mode) { return mode->name; }
47
48 static inline ir_mode_sort get_mode_sort_(const ir_mode *mode) { return mode->sort; }
49
50 static inline unsigned get_mode_size_bits_(const ir_mode *mode) { return mode->size; }
51
52 static inline unsigned get_mode_size_bytes_(const ir_mode *mode)
53 {
54         unsigned size = get_mode_size_bits_(mode);
55         if ((size & 7) != 0) return (unsigned) -1;
56         return size >> 3;
57 }
58
59 static inline int get_mode_sign_(const ir_mode *mode) { return mode->sign; }
60
61 static inline ir_mode_arithmetic get_mode_arithmetic_(const ir_mode *mode) { return mode->arithmetic; }
62
63 static inline unsigned int get_mode_modulo_shift_(const ir_mode *mode) { return mode->modulo_shift; }
64
65 static inline void *get_mode_link_(const ir_mode *mode) { return mode->link; }
66
67 static inline void set_mode_link_(ir_mode *mode, void *l) { mode->link = l; }
68
69 /* Functions to check, whether a mode is signed, float, int, num, data,
70    datab or dataM. For more exact definitions read the corresponding pages
71    in the firm documentation or the following enumeration
72
73    The set of "float" is defined as:
74    ---------------------------------
75    float = {irm_F, irm_D, irm_E}
76
77    The set of "int" is defined as:
78    -------------------------------
79    int   = {irm_Bs, irm_Bu, irm_Hs, irm_Hu, irm_Is, irm_Iu, irm_Ls, irm_Lu}
80
81    The set of "num" is defined as:
82    -------------------------------
83    num   = {irm_F, irm_D, irm_E, irm_Bs, irm_Bu, irm_Hs, irm_Hu,
84             irm_Is, irm_Iu, irm_Ls, irm_Lu}
85             = {float || int}
86
87    The set of "data" is defined as:
88    -------------------------------
89    data  = {irm_F, irm_D, irm_E irm_Bs, irm_Bu, irm_Hs, irm_Hu,
90             irm_Is, irm_Iu, irm_Ls, irm_Lu, irm_C, irm_U, irm_P}
91             = {num || irm_C || irm_U || irm_P}
92
93    The set of "datab" is defined as:
94    ---------------------------------
95    datab = {irm_F, irm_D, irm_E, irm_Bs, irm_Bu, irm_Hs, irm_Hu,
96             irm_Is, irm_Iu, irm_Ls, irm_Lu, irm_C, irm_U, irm_P, irm_b}
97             = {data || irm_b }
98
99    The set of "dataM" is defined as:
100    ---------------------------------
101    dataM = {irm_F, irm_D, irm_E, irm_Bs, irm_Bu, irm_Hs, irm_Hu,
102             irm_Is, irm_Iu, irm_Ls, irm_Lu, irm_C, irm_U, irm_P, irm_M}
103             = {data || irm_M}
104 */
105
106 static inline int mode_is_signed_(const ir_mode *mode)
107 {
108         return mode->sign;
109 }
110
111 static inline int mode_is_float_(const ir_mode *mode)
112 {
113         return (get_mode_sort(mode) == irms_float_number);
114 }
115
116 static inline int mode_is_int_(const ir_mode *mode)
117 {
118         return (get_mode_sort(mode) == irms_int_number);
119 }
120
121 static inline int mode_is_reference_(const ir_mode *mode)
122 {
123         return (get_mode_sort(mode) == irms_reference);
124 }
125
126 static inline int mode_is_num_(const ir_mode *mode)
127 {
128         return (get_mode_sort(mode) & irmsh_is_num);
129 }
130
131 static inline int mode_is_data_(const ir_mode *mode)
132 {
133         return (get_mode_sort(mode) & irmsh_is_data);
134 }
135
136 static inline int mode_is_datab_(const ir_mode *mode)
137 {
138         return (get_mode_sort(mode) & irmsh_is_datab);
139 }
140
141 static inline int mode_is_dataM_(const ir_mode *mode)
142 {
143         return (get_mode_sort(mode) & irmsh_is_dataM);
144 }
145
146 static inline ir_type *get_type_for_mode_(const ir_mode *mode)
147 {
148         return mode->type;
149 }
150
151 static inline unsigned get_mode_mantissa_size_(const ir_mode *mode)
152 {
153         return mode->float_desc.mantissa_size;
154 }
155
156 static inline unsigned get_mode_exponent_size_(const ir_mode *mode)
157 {
158         return mode->float_desc.exponent_size;
159 }
160
161 /** mode module initialization, call once before use of any other function **/
162 void init_mode(void);
163
164 /** mode module finalization. frees all memory.  */
165 void finish_mode(void);
166
167 #endif