2 * Copyright (C) 1995-2011 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 Data modes of operations.
23 * @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Mathias Heil
42 #include "pattern_dmp.h"
44 /** Obstack to hold all modes. */
45 static struct obstack modes;
47 /** The list of all currently existing modes. */
48 static ir_mode **mode_list;
50 const char *get_mode_arithmetic_name(ir_mode_arithmetic ari)
52 #define X(a) case a: return #a
54 X(irma_uninitialized);
56 X(irma_twos_complement);
58 X(irma_x86_extended_float);
59 default: return "<unknown>";
64 static bool modes_are_equal(const ir_mode *m, const ir_mode *n)
66 return m->sort == n->sort &&
67 m->arithmetic == n->arithmetic &&
70 m->modulo_shift == n->modulo_shift;
74 * searches the modes obstack for the given mode and returns
75 * a pointer on an equal mode already in the array, NULL if
78 static ir_mode *find_mode(const ir_mode *m)
81 for (i = 0, n_modes = ARR_LEN(mode_list); i < n_modes; ++i) {
82 ir_mode *n = mode_list[i];
83 if (modes_are_equal(n, m))
90 * sets special values of modes
92 static void set_mode_values(ir_mode* mode)
94 switch (get_mode_sort(mode)) {
97 case irms_float_number:
98 mode->min = get_tarval_min(mode);
99 mode->max = get_tarval_max(mode);
100 mode->null = get_tarval_null(mode);
101 mode->one = get_tarval_one(mode);
102 mode->minus_one = get_tarval_minus_one(mode);
103 if (get_mode_sort(mode) != irms_float_number) {
104 mode->all_one = get_tarval_all_one(mode);
106 mode->all_one = tarval_bad;
110 case irms_internal_boolean:
111 mode->min = tarval_b_false;
112 mode->max = tarval_b_true;
113 mode->null = tarval_b_false;
114 mode->one = tarval_b_true;
115 mode->minus_one = tarval_bad;
116 mode->all_one = tarval_b_true;
119 case irms_control_flow:
125 mode->min = tarval_bad;
126 mode->max = tarval_bad;
127 mode->null = tarval_bad;
128 mode->one = tarval_bad;
129 mode->minus_one = tarval_bad;
135 * globals defined in irmode.h
138 /* --- Predefined modes --- */
140 /* FIRM internal modes: */
148 /* predefined numerical modes: */
153 ir_mode *mode_Bs; /* integral values, signed and unsigned */
154 ir_mode *mode_Bu; /* 8 bit */
155 ir_mode *mode_Hs; /* 16 bit */
157 ir_mode *mode_Is; /* 32 bit */
159 ir_mode *mode_Ls; /* 64 bit */
161 ir_mode *mode_LLs; /* 128 bit */
167 /* machine specific modes */
168 ir_mode *mode_P_code; /**< machine specific pointer mode for code addresses */
169 ir_mode *mode_P_data; /**< machine specific pointer mode for data addresses */
172 * functions defined in irmode.h
175 ir_mode *get_modeT(void) { return mode_T; }
176 ir_mode *get_modeF(void) { return mode_F; }
177 ir_mode *get_modeD(void) { return mode_D; }
178 ir_mode *get_modeQ(void) { return mode_Q; }
179 ir_mode *get_modeBs(void) { return mode_Bs; }
180 ir_mode *get_modeBu(void) { return mode_Bu; }
181 ir_mode *get_modeHs(void) { return mode_Hs; }
182 ir_mode *get_modeHu(void) { return mode_Hu; }
183 ir_mode *get_modeIs(void) { return mode_Is; }
184 ir_mode *get_modeIu(void) { return mode_Iu; }
185 ir_mode *get_modeLs(void) { return mode_Ls; }
186 ir_mode *get_modeLu(void) { return mode_Lu; }
187 ir_mode *get_modeLLs(void){ return mode_LLs; }
188 ir_mode *get_modeLLu(void){ return mode_LLu; }
189 ir_mode *get_modeb(void) { return mode_b; }
190 ir_mode *get_modeP(void) { return mode_P; }
191 ir_mode *get_modeX(void) { return mode_X; }
192 ir_mode *get_modeM(void) { return mode_M; }
193 ir_mode *get_modeBB(void) { return mode_BB; }
194 ir_mode *get_modeANY(void) { return mode_ANY; }
195 ir_mode *get_modeBAD(void) { return mode_BAD; }
198 ir_mode *(get_modeP_code)(void)
200 return get_modeP_code_();
203 ir_mode *(get_modeP_data)(void)
205 return get_modeP_data_();
208 void set_modeP_code(ir_mode *p)
210 assert(mode_is_reference(p));
214 void set_modeP_data(ir_mode *p)
216 assert(mode_is_reference(p));
222 * Creates a new mode.
224 static ir_mode *alloc_mode(const char *name, ir_mode_sort sort,
225 ir_mode_arithmetic arithmetic, unsigned bit_size,
226 int sign, unsigned modulo_shift)
228 ir_mode *mode_tmpl = OALLOCZ(&modes, ir_mode);
230 mode_tmpl->name = new_id_from_str(name);
231 mode_tmpl->sort = sort;
232 mode_tmpl->size = bit_size;
233 mode_tmpl->sign = sign ? 1 : 0;
234 mode_tmpl->modulo_shift = modulo_shift;
235 mode_tmpl->arithmetic = arithmetic;
236 mode_tmpl->link = NULL;
237 mode_tmpl->tv_priv = NULL;
241 static ir_mode *register_mode(ir_mode *mode)
243 /* does any of the existing modes have the same properties? */
244 ir_mode *old = find_mode(mode);
246 /* remove new mode from obstack */
247 obstack_free(&modes, mode);
251 mode->kind = k_ir_mode;
252 mode->type = new_type_primitive(mode);
253 ARR_APP1(ir_mode*, mode_list, mode);
255 set_mode_values(mode);
260 ir_mode *new_int_mode(const char *name, ir_mode_arithmetic arithmetic,
261 unsigned bit_size, int sign, unsigned modulo_shift)
263 ir_mode *result = alloc_mode(name, irms_int_number, arithmetic, bit_size,
265 return register_mode(result);
268 ir_mode *new_reference_mode(const char *name, ir_mode_arithmetic arithmetic,
269 unsigned bit_size, unsigned modulo_shift)
271 ir_mode *result = alloc_mode(name, irms_reference, arithmetic, bit_size,
273 return register_mode(result);
276 ir_mode *new_float_mode(const char *name, ir_mode_arithmetic arithmetic,
277 unsigned exponent_size, unsigned mantissa_size)
279 bool explicit_one = false;
280 unsigned bit_size = exponent_size + mantissa_size + 1;
283 if (arithmetic == irma_x86_extended_float) {
286 } else if (arithmetic != irma_ieee754) {
287 panic("Arithmetic %s invalid for float");
289 if (exponent_size >= 256)
290 panic("Exponents >= 256 bits not supported");
291 if (mantissa_size >= 256)
292 panic("Mantissa >= 256 bits not supported");
294 result = alloc_mode(name, irms_float_number, irma_ieee754, bit_size, 1, 0);
295 result->float_desc.exponent_size = exponent_size;
296 result->float_desc.mantissa_size = mantissa_size;
297 result->float_desc.explicit_one = explicit_one;
298 return register_mode(result);
301 /* Functions for the direct access to all attributes of an ir_mode */
302 ident *(get_mode_ident)(const ir_mode *mode)
304 return get_mode_ident_(mode);
307 const char *get_mode_name(const ir_mode *mode)
309 return get_id_str(mode->name);
312 unsigned (get_mode_size_bits)(const ir_mode *mode)
314 return get_mode_size_bits_(mode);
317 unsigned (get_mode_size_bytes)(const ir_mode *mode)
319 return get_mode_size_bytes_(mode);
322 int (get_mode_sign)(const ir_mode *mode)
324 return get_mode_sign_(mode);
327 ir_mode_arithmetic (get_mode_arithmetic)(const ir_mode *mode)
329 return get_mode_arithmetic_(mode);
333 /* Attribute modulo shift specifies for modes of kind irms_int_number
334 * whether shift applies modulo to value of bits to shift. Asserts
335 * if mode is not irms_int_number.
337 unsigned int (get_mode_modulo_shift)(const ir_mode *mode)
339 return get_mode_modulo_shift_(mode);
342 void *(get_mode_link)(const ir_mode *mode)
344 return get_mode_link_(mode);
347 void (set_mode_link)(ir_mode *mode, void *l)
349 set_mode_link_(mode, l);
352 ir_tarval *get_mode_min(ir_mode *mode)
355 assert(mode_is_data(mode));
360 ir_tarval *get_mode_max(ir_mode *mode)
363 assert(mode_is_data(mode));
368 ir_tarval *get_mode_null(ir_mode *mode)
371 assert(mode_is_datab(mode));
376 ir_tarval *get_mode_one(ir_mode *mode)
379 assert(mode_is_datab(mode));
384 ir_tarval *get_mode_minus_one(ir_mode *mode)
387 assert(mode_is_data(mode));
389 return mode->minus_one;
392 ir_tarval *get_mode_all_one(ir_mode *mode)
395 assert(mode_is_datab(mode));
396 return mode->all_one;
399 ir_tarval *get_mode_infinite(ir_mode *mode)
402 assert(mode_is_float(mode));
404 return get_tarval_plus_inf(mode);
407 ir_tarval *get_mode_NAN(ir_mode *mode)
410 assert(mode_is_float(mode));
412 return get_tarval_nan(mode);
415 int is_mode(const void *thing)
417 return get_kind(thing) == k_ir_mode;
420 int (mode_is_signed)(const ir_mode *mode)
422 return mode_is_signed_(mode);
425 int (mode_is_float)(const ir_mode *mode)
427 return mode_is_float_(mode);
430 int (mode_is_int)(const ir_mode *mode)
432 return mode_is_int_(mode);
435 int (mode_is_reference)(const ir_mode *mode)
437 return mode_is_reference_(mode);
440 int (mode_is_num)(const ir_mode *mode)
442 return mode_is_num_(mode);
445 int (mode_is_data)(const ir_mode *mode)
447 return mode_is_data_(mode);
450 int (mode_is_datab)(const ir_mode *mode)
452 return mode_is_datab_(mode);
455 int (mode_is_dataM)(const ir_mode *mode)
457 return mode_is_dataM_(mode);
460 unsigned (get_mode_mantissa_size)(const ir_mode *mode)
462 return get_mode_mantissa_size_(mode);
465 unsigned (get_mode_exponent_size)(const ir_mode *mode)
467 return get_mode_exponent_size_(mode);
470 /* Returns true if sm can be converted to lm without loss. */
471 int smaller_mode(const ir_mode *sm, const ir_mode *lm)
473 int sm_bits, lm_bits;
478 if (sm == lm) return 1;
480 sm_bits = get_mode_size_bits(sm);
481 lm_bits = get_mode_size_bits(lm);
483 switch (get_mode_sort(sm)) {
484 case irms_int_number:
485 switch (get_mode_sort(lm)) {
486 case irms_int_number:
487 if (get_mode_arithmetic(sm) != get_mode_arithmetic(lm))
490 /* only two complement implemented */
491 assert(get_mode_arithmetic(sm) == irma_twos_complement);
493 /* integers are convertable if
494 * - both have the same sign and lm is the larger one
495 * - lm is the signed one and is at least two bits larger
496 * (one for the sign, one for the highest bit of sm)
497 * - sm & lm are two_complement and lm has greater or equal number of bits
499 if (mode_is_signed(sm)) {
500 if (!mode_is_signed(lm))
502 return sm_bits <= lm_bits;
504 if (mode_is_signed(lm)) {
505 return sm_bits < lm_bits;
507 return sm_bits <= lm_bits;
510 case irms_float_number:
511 /* int to float works if the float is large enough */
519 case irms_float_number:
520 if (get_mode_arithmetic(sm) == get_mode_arithmetic(lm)) {
521 if ( (get_mode_sort(lm) == irms_float_number)
522 && (get_mode_size_bits(lm) >= get_mode_size_bits(sm)) )
528 /* do exist machines out there with different pointer lengths ?*/
531 case irms_internal_boolean:
532 return mode_is_int(lm);
542 /* Returns true if a value of mode sm can be converted into mode lm
543 and backwards without loss. */
544 int values_in_mode(const ir_mode *sm, const ir_mode *lm)
546 ir_mode_arithmetic arith;
551 if (sm == lm) return 1;
554 return mode_is_int(lm);
556 arith = get_mode_arithmetic(sm);
557 if (arith != get_mode_arithmetic(lm))
561 case irma_twos_complement:
563 return get_mode_size_bits(sm) <= get_mode_size_bits(lm);
570 /* Return the signed integer equivalent mode for an reference mode. */
571 ir_mode *get_reference_mode_signed_eq(ir_mode *mode)
573 assert(mode_is_reference(mode));
574 return mode->eq_signed;
577 /* Sets the signed integer equivalent mode for an reference mode. */
578 void set_reference_mode_signed_eq(ir_mode *ref_mode, ir_mode *int_mode)
580 assert(mode_is_reference(ref_mode));
581 assert(mode_is_int(int_mode));
582 ref_mode->eq_signed = int_mode;
585 /* Return the unsigned integer equivalent mode for an reference mode. */
586 ir_mode *get_reference_mode_unsigned_eq(ir_mode *mode)
588 assert(mode_is_reference(mode));
589 return mode->eq_unsigned;
592 /* Sets the unsigned integer equivalent mode for an reference mode. */
593 void set_reference_mode_unsigned_eq(ir_mode *ref_mode, ir_mode *int_mode)
595 assert(mode_is_reference(ref_mode));
596 assert(mode_is_int(int_mode));
597 ref_mode->eq_unsigned = int_mode;
600 static ir_mode *new_internal_mode(const char *name, ir_mode_sort sort)
602 ir_mode *mode = alloc_mode(name, sort, irma_none, 0, 0, 0);
603 return register_mode(mode);
606 /* initialization, build the default modes */
609 obstack_init(&modes);
610 mode_list = NEW_ARR_F(ir_mode*, 0);
612 /* initialize predefined modes */
613 mode_BB = new_internal_mode("BB", irms_block);
614 mode_X = new_internal_mode("X", irms_control_flow);
615 mode_M = new_internal_mode("M", irms_memory);
616 mode_T = new_internal_mode("T", irms_tuple);
617 mode_ANY = new_internal_mode("ANY", irms_any);
618 mode_BAD = new_internal_mode("BAD", irms_bad);
619 mode_b = new_internal_mode("b", irms_internal_boolean);
621 mode_F = new_float_mode("F", irma_ieee754, 8, 23);
622 mode_D = new_float_mode("D", irma_ieee754, 11, 52);
623 mode_Q = new_float_mode("Q", irma_ieee754, 15, 112);
625 mode_Bs = new_int_mode("Bs", irma_twos_complement, 8, 1, 32);
626 mode_Bu = new_int_mode("Bu", irma_twos_complement, 8, 0, 32);
627 mode_Hs = new_int_mode("Hs", irma_twos_complement, 16, 1, 32);
628 mode_Hu = new_int_mode("Hu", irma_twos_complement, 16, 0, 32);
629 mode_Is = new_int_mode("Is", irma_twos_complement, 32, 1, 32);
630 mode_Iu = new_int_mode("Iu", irma_twos_complement, 32, 0, 32);
631 mode_Ls = new_int_mode("Ls", irma_twos_complement, 64, 1, 64);
632 mode_Lu = new_int_mode("Lu", irma_twos_complement, 64, 0, 64);
633 mode_LLs = new_int_mode("LLs", irma_twos_complement, 128, 1, 128);
634 mode_LLu = new_int_mode("LLu", irma_twos_complement, 128, 0, 128);
636 mode_P = new_reference_mode("P", irma_twos_complement, 32, 32);
638 /* set the machine specific modes to the predefined ones */
639 mode_P_code = mode_P;
640 mode_P_data = mode_P;
643 /* find a signed mode for an unsigned integer mode */
644 ir_mode *find_unsigned_mode(const ir_mode *mode)
648 /* allowed for reference mode */
649 if (mode->sort == irms_reference)
650 n.sort = irms_int_number;
652 assert(n.sort == irms_int_number);
654 return find_mode(&n);
657 /* find an unsigned mode for a signed integer mode */
658 ir_mode *find_signed_mode(const ir_mode *mode)
662 assert(mode->sort == irms_int_number);
664 return find_mode(&n);
667 /* finds a integer mode with 2*n bits for an integer mode with n bits. */
668 ir_mode *find_double_bits_int_mode(const ir_mode *mode)
672 assert(mode->sort == irms_int_number && mode->arithmetic == irma_twos_complement);
674 n.size = 2*mode->size;
675 return find_mode(&n);
679 * Returns non-zero if the given mode honors signed zero's, i.e.,
680 * a +0 and a -0 exists and handled differently.
682 int mode_honor_signed_zeros(const ir_mode *mode)
684 /* for floating point, we know that IEEE 754 has +0 and -0,
685 * but always handles it identical.
688 mode->sort == irms_float_number &&
689 mode->arithmetic != irma_ieee754;
693 * Returns non-zero if the given mode might overflow on unary Minus.
695 * This does NOT happen on IEEE 754.
697 int mode_overflow_on_unary_Minus(const ir_mode *mode)
699 if (mode->sort == irms_float_number)
700 return mode->arithmetic == irma_ieee754 ? 0 : 1;
705 * Returns non-zero if the mode has a reversed wrap-around
706 * logic, especially (a + x) - x == a.
708 * This is normally true for integer modes, not for floating
711 int mode_wrap_around(const ir_mode *mode)
713 /* FIXME: better would be an extra mode property */
714 return mode_is_int(mode);
718 * Returns non-zero if the cast from mode src to mode dst is a
719 * reinterpret cast (ie. only the bit pattern is reinterpreted,
720 * no conversion is done)
722 int is_reinterpret_cast(const ir_mode *src, const ir_mode *dst)
724 ir_mode_arithmetic ma;
728 if (get_mode_size_bits(src) != get_mode_size_bits(dst))
730 ma = get_mode_arithmetic(src);
731 if (ma != get_mode_arithmetic(dst))
734 return ma == irma_twos_complement;
737 ir_type *(get_type_for_mode) (const ir_mode *mode)
739 return get_type_for_mode_(mode);
742 void finish_mode(void)
744 obstack_free(&modes, 0);
745 DEL_ARR_F(mode_list);