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
41 #include "pattern_dmp.h"
43 /** Obstack to hold all modes. */
44 static struct obstack modes;
46 /** The list of all currently existing modes. */
47 static ir_mode **mode_list;
49 const char *get_mode_arithmetic_name(ir_mode_arithmetic ari)
51 #define X(a) case a: return #a
53 X(irma_uninitialized);
55 X(irma_twos_complement);
57 X(irma_x86_extended_float);
58 default: return "<unknown>";
63 static bool modes_are_equal(const ir_mode *m, const ir_mode *n)
65 return m->sort == n->sort &&
66 m->arithmetic == n->arithmetic &&
69 m->modulo_shift == n->modulo_shift;
73 * searches the modes obstack for the given mode and returns
74 * a pointer on an equal mode already in the array, NULL if
77 static ir_mode *find_mode(const ir_mode *m)
80 for (i = 0, n_modes = ARR_LEN(mode_list); i < n_modes; ++i) {
81 ir_mode *n = mode_list[i];
82 if (modes_are_equal(n, m))
89 * sets special values of modes
91 static void set_mode_values(ir_mode* mode)
93 switch (get_mode_sort(mode)) {
96 case irms_float_number:
97 mode->min = get_tarval_min(mode);
98 mode->max = get_tarval_max(mode);
99 mode->null = get_tarval_null(mode);
100 mode->one = get_tarval_one(mode);
101 mode->minus_one = get_tarval_minus_one(mode);
102 if (get_mode_sort(mode) != irms_float_number) {
103 mode->all_one = get_tarval_all_one(mode);
105 mode->all_one = tarval_bad;
109 case irms_internal_boolean:
110 mode->min = tarval_b_false;
111 mode->max = tarval_b_true;
112 mode->null = tarval_b_false;
113 mode->one = tarval_b_true;
114 mode->minus_one = tarval_bad;
115 mode->all_one = tarval_b_true;
118 case irms_control_flow:
124 mode->min = tarval_bad;
125 mode->max = tarval_bad;
126 mode->null = tarval_bad;
127 mode->one = tarval_bad;
128 mode->minus_one = tarval_bad;
134 * globals defined in irmode.h
137 /* --- Predefined modes --- */
139 /* FIRM internal modes: */
147 /* predefined numerical modes: */
152 ir_mode *mode_Bs; /* integral values, signed and unsigned */
153 ir_mode *mode_Bu; /* 8 bit */
154 ir_mode *mode_Hs; /* 16 bit */
156 ir_mode *mode_Is; /* 32 bit */
158 ir_mode *mode_Ls; /* 64 bit */
160 ir_mode *mode_LLs; /* 128 bit */
166 /* machine specific modes */
167 ir_mode *mode_P_code; /**< machine specific pointer mode for code addresses */
168 ir_mode *mode_P_data; /**< machine specific pointer mode for data addresses */
171 * functions defined in irmode.h
174 ir_mode *get_modeT(void) { return mode_T; }
175 ir_mode *get_modeF(void) { return mode_F; }
176 ir_mode *get_modeD(void) { return mode_D; }
177 ir_mode *get_modeQ(void) { return mode_Q; }
178 ir_mode *get_modeBs(void) { return mode_Bs; }
179 ir_mode *get_modeBu(void) { return mode_Bu; }
180 ir_mode *get_modeHs(void) { return mode_Hs; }
181 ir_mode *get_modeHu(void) { return mode_Hu; }
182 ir_mode *get_modeIs(void) { return mode_Is; }
183 ir_mode *get_modeIu(void) { return mode_Iu; }
184 ir_mode *get_modeLs(void) { return mode_Ls; }
185 ir_mode *get_modeLu(void) { return mode_Lu; }
186 ir_mode *get_modeLLs(void){ return mode_LLs; }
187 ir_mode *get_modeLLu(void){ return mode_LLu; }
188 ir_mode *get_modeb(void) { return mode_b; }
189 ir_mode *get_modeP(void) { return mode_P; }
190 ir_mode *get_modeX(void) { return mode_X; }
191 ir_mode *get_modeM(void) { return mode_M; }
192 ir_mode *get_modeBB(void) { return mode_BB; }
193 ir_mode *get_modeANY(void) { return mode_ANY; }
194 ir_mode *get_modeBAD(void) { return mode_BAD; }
197 ir_mode *(get_modeP_code)(void)
199 return get_modeP_code_();
202 ir_mode *(get_modeP_data)(void)
204 return get_modeP_data_();
207 void set_modeP_code(ir_mode *p)
209 assert(mode_is_reference(p));
213 void set_modeP_data(ir_mode *p)
215 assert(mode_is_reference(p));
221 * Creates a new mode.
223 static ir_mode *alloc_mode(const char *name, ir_mode_sort sort,
224 ir_mode_arithmetic arithmetic, unsigned bit_size,
225 int sign, unsigned modulo_shift)
227 ir_mode *mode_tmpl = OALLOCZ(&modes, ir_mode);
229 mode_tmpl->name = new_id_from_str(name);
230 mode_tmpl->sort = sort;
231 mode_tmpl->size = bit_size;
232 mode_tmpl->sign = sign ? 1 : 0;
233 mode_tmpl->modulo_shift = modulo_shift;
234 mode_tmpl->arithmetic = arithmetic;
235 mode_tmpl->link = NULL;
236 mode_tmpl->tv_priv = NULL;
240 static ir_mode *register_mode(ir_mode *mode)
242 /* does any of the existing modes have the same properties? */
243 ir_mode *old = find_mode(mode);
245 /* remove new mode from obstack */
246 obstack_free(&modes, mode);
250 mode->kind = k_ir_mode;
251 mode->type = new_type_primitive(mode);
252 ARR_APP1(ir_mode*, mode_list, mode);
254 set_mode_values(mode);
259 ir_mode *new_int_mode(const char *name, ir_mode_arithmetic arithmetic,
260 unsigned bit_size, int sign, unsigned modulo_shift)
262 ir_mode *result = alloc_mode(name, irms_int_number, arithmetic, bit_size,
264 return register_mode(result);
267 ir_mode *new_reference_mode(const char *name, ir_mode_arithmetic arithmetic,
268 unsigned bit_size, unsigned modulo_shift)
270 ir_mode *result = alloc_mode(name, irms_reference, arithmetic, bit_size,
272 return register_mode(result);
275 ir_mode *new_float_mode(const char *name, ir_mode_arithmetic arithmetic,
276 unsigned exponent_size, unsigned mantissa_size)
278 bool explicit_one = false;
279 unsigned bit_size = exponent_size + mantissa_size + 1;
282 if (arithmetic == irma_x86_extended_float) {
285 } else if (arithmetic != irma_ieee754) {
286 panic("Arithmetic %s invalid for float");
288 if (exponent_size >= 256)
289 panic("Exponents >= 256 bits not supported");
290 if (mantissa_size >= 256)
291 panic("Mantissa >= 256 bits not supported");
293 result = alloc_mode(name, irms_float_number, irma_x86_extended_float, bit_size, 1, 0);
294 result->float_desc.exponent_size = exponent_size;
295 result->float_desc.mantissa_size = mantissa_size;
296 result->float_desc.explicit_one = explicit_one;
297 return register_mode(result);
300 /* Functions for the direct access to all attributes of an ir_mode */
301 ident *(get_mode_ident)(const ir_mode *mode)
303 return get_mode_ident_(mode);
306 const char *get_mode_name(const ir_mode *mode)
308 return get_id_str(mode->name);
311 unsigned (get_mode_size_bits)(const ir_mode *mode)
313 return get_mode_size_bits_(mode);
316 unsigned (get_mode_size_bytes)(const ir_mode *mode)
318 return get_mode_size_bytes_(mode);
321 int (get_mode_sign)(const ir_mode *mode)
323 return get_mode_sign_(mode);
326 ir_mode_arithmetic (get_mode_arithmetic)(const ir_mode *mode)
328 return get_mode_arithmetic_(mode);
332 /* Attribute modulo shift specifies for modes of kind irms_int_number
333 * whether shift applies modulo to value of bits to shift. Asserts
334 * if mode is not irms_int_number.
336 unsigned int (get_mode_modulo_shift)(const ir_mode *mode)
338 return get_mode_modulo_shift_(mode);
341 void *(get_mode_link)(const ir_mode *mode)
343 return get_mode_link_(mode);
346 void (set_mode_link)(ir_mode *mode, void *l)
348 set_mode_link_(mode, l);
351 ir_tarval *get_mode_min(ir_mode *mode)
354 assert(mode_is_data(mode));
359 ir_tarval *get_mode_max(ir_mode *mode)
362 assert(mode_is_data(mode));
367 ir_tarval *get_mode_null(ir_mode *mode)
370 assert(mode_is_datab(mode));
375 ir_tarval *get_mode_one(ir_mode *mode)
378 assert(mode_is_datab(mode));
383 ir_tarval *get_mode_minus_one(ir_mode *mode)
386 assert(mode_is_data(mode));
388 return mode->minus_one;
391 ir_tarval *get_mode_all_one(ir_mode *mode)
394 assert(mode_is_datab(mode));
395 return mode->all_one;
398 ir_tarval *get_mode_infinite(ir_mode *mode)
401 assert(mode_is_float(mode));
403 return get_tarval_plus_inf(mode);
406 ir_tarval *get_mode_NAN(ir_mode *mode)
409 assert(mode_is_float(mode));
411 return get_tarval_nan(mode);
414 int is_mode(const void *thing)
416 return get_kind(thing) == k_ir_mode;
419 int (mode_is_signed)(const ir_mode *mode)
421 return mode_is_signed_(mode);
424 int (mode_is_float)(const ir_mode *mode)
426 return mode_is_float_(mode);
429 int (mode_is_int)(const ir_mode *mode)
431 return mode_is_int_(mode);
434 int (mode_is_reference)(const ir_mode *mode)
436 return mode_is_reference_(mode);
439 int (mode_is_num)(const ir_mode *mode)
441 return mode_is_num_(mode);
444 int (mode_is_data)(const ir_mode *mode)
446 return mode_is_data_(mode);
449 int (mode_is_datab)(const ir_mode *mode)
451 return mode_is_datab_(mode);
454 int (mode_is_dataM)(const ir_mode *mode)
456 return mode_is_dataM_(mode);
459 unsigned (get_mode_mantissa_size)(const ir_mode *mode)
461 return get_mode_mantissa_size_(mode);
464 unsigned (get_mode_exponent_size)(const ir_mode *mode)
466 return get_mode_exponent_size_(mode);
469 /* Returns true if sm can be converted to lm without loss. */
470 int smaller_mode(const ir_mode *sm, const ir_mode *lm)
472 int sm_bits, lm_bits;
477 if (sm == lm) return 1;
479 sm_bits = get_mode_size_bits(sm);
480 lm_bits = get_mode_size_bits(lm);
482 switch (get_mode_sort(sm)) {
483 case irms_int_number:
484 switch (get_mode_sort(lm)) {
485 case irms_int_number:
486 if (get_mode_arithmetic(sm) != get_mode_arithmetic(lm))
489 /* only two complement implemented */
490 assert(get_mode_arithmetic(sm) == irma_twos_complement);
492 /* integers are convertable if
493 * - both have the same sign and lm is the larger one
494 * - lm is the signed one and is at least two bits larger
495 * (one for the sign, one for the highest bit of sm)
496 * - sm & lm are two_complement and lm has greater or equal number of bits
498 if (mode_is_signed(sm)) {
499 if (!mode_is_signed(lm))
501 return sm_bits <= lm_bits;
503 if (mode_is_signed(lm)) {
504 return sm_bits < lm_bits;
506 return sm_bits <= lm_bits;
509 case irms_float_number:
510 /* int to float works if the float is large enough */
518 case irms_float_number:
519 if (get_mode_arithmetic(sm) == get_mode_arithmetic(lm)) {
520 if ( (get_mode_sort(lm) == irms_float_number)
521 && (get_mode_size_bits(lm) >= get_mode_size_bits(sm)) )
527 /* do exist machines out there with different pointer lengths ?*/
530 case irms_internal_boolean:
531 return mode_is_int(lm);
541 /* Returns true if a value of mode sm can be converted into mode lm
542 and backwards without loss. */
543 int values_in_mode(const ir_mode *sm, const ir_mode *lm)
545 ir_mode_arithmetic arith;
550 if (sm == lm) return 1;
553 return mode_is_int(lm);
555 arith = get_mode_arithmetic(sm);
556 if (arith != get_mode_arithmetic(lm))
560 case irma_twos_complement:
562 return get_mode_size_bits(sm) <= get_mode_size_bits(lm);
569 /* Return the signed integer equivalent mode for an reference mode. */
570 ir_mode *get_reference_mode_signed_eq(ir_mode *mode)
572 assert(mode_is_reference(mode));
573 return mode->eq_signed;
576 /* Sets the signed integer equivalent mode for an reference mode. */
577 void set_reference_mode_signed_eq(ir_mode *ref_mode, ir_mode *int_mode)
579 assert(mode_is_reference(ref_mode));
580 assert(mode_is_int(int_mode));
581 ref_mode->eq_signed = int_mode;
584 /* Return the unsigned integer equivalent mode for an reference mode. */
585 ir_mode *get_reference_mode_unsigned_eq(ir_mode *mode)
587 assert(mode_is_reference(mode));
588 return mode->eq_unsigned;
591 /* Sets the unsigned integer equivalent mode for an reference mode. */
592 void set_reference_mode_unsigned_eq(ir_mode *ref_mode, ir_mode *int_mode)
594 assert(mode_is_reference(ref_mode));
595 assert(mode_is_int(int_mode));
596 ref_mode->eq_unsigned = int_mode;
599 static ir_mode *new_internal_mode(const char *name, ir_mode_sort sort)
601 ir_mode *mode = alloc_mode(name, sort, irma_none, 0, 0, 0);
602 return register_mode(mode);
605 /* initialization, build the default modes */
608 obstack_init(&modes);
609 mode_list = NEW_ARR_F(ir_mode*, 0);
611 /* initialize predefined modes */
612 mode_BB = new_internal_mode("BB", irms_block);
613 mode_X = new_internal_mode("X", irms_control_flow);
614 mode_M = new_internal_mode("M", irms_memory);
615 mode_T = new_internal_mode("T", irms_tuple);
616 mode_ANY = new_internal_mode("ANY", irms_any);
617 mode_BAD = new_internal_mode("BAD", irms_bad);
618 mode_b = new_internal_mode("b", irms_internal_boolean);
620 mode_F = new_float_mode("F", irma_ieee754, 8, 23);
621 mode_D = new_float_mode("D", irma_ieee754, 11, 52);
622 mode_Q = new_float_mode("Q", irma_ieee754, 15, 112);
624 mode_Bs = new_int_mode("Bs", irma_twos_complement, 8, 1, 32);
625 mode_Bu = new_int_mode("Bu", irma_twos_complement, 8, 0, 32);
626 mode_Hs = new_int_mode("Hs", irma_twos_complement, 16, 1, 32);
627 mode_Hu = new_int_mode("Hu", irma_twos_complement, 16, 0, 32);
628 mode_Is = new_int_mode("Is", irma_twos_complement, 32, 1, 32);
629 mode_Iu = new_int_mode("Iu", irma_twos_complement, 32, 0, 32);
630 mode_Ls = new_int_mode("Ls", irma_twos_complement, 64, 1, 64);
631 mode_Lu = new_int_mode("Lu", irma_twos_complement, 64, 0, 64);
632 mode_LLs = new_int_mode("LLs", irma_twos_complement, 128, 1, 128);
633 mode_LLu = new_int_mode("LLu", irma_twos_complement, 128, 0, 128);
635 mode_P = new_reference_mode("P", irma_twos_complement, 32, 32);
636 set_reference_mode_signed_eq(mode_P, mode_Is);
637 set_reference_mode_unsigned_eq(mode_P, mode_Iu);
639 /* set the machine specific modes to the predefined ones */
640 mode_P_code = mode_P;
641 mode_P_data = mode_P;
644 /* find a signed mode for an unsigned integer mode */
645 ir_mode *find_unsigned_mode(const ir_mode *mode)
649 /* allowed for reference mode */
650 if (mode->sort == irms_reference)
651 n.sort = irms_int_number;
653 assert(n.sort == irms_int_number);
655 return find_mode(&n);
658 /* find an unsigned mode for a signed integer mode */
659 ir_mode *find_signed_mode(const ir_mode *mode)
663 assert(mode->sort == irms_int_number);
665 return find_mode(&n);
668 /* finds a integer mode with 2*n bits for an integer mode with n bits. */
669 ir_mode *find_double_bits_int_mode(const ir_mode *mode)
673 assert(mode->sort == irms_int_number && mode->arithmetic == irma_twos_complement);
675 n.size = 2*mode->size;
676 return find_mode(&n);
680 * Returns non-zero if the given mode honors signed zero's, i.e.,
681 * a +0 and a -0 exists and handled differently.
683 int mode_honor_signed_zeros(const ir_mode *mode)
685 /* for floating point, we know that IEEE 754 has +0 and -0,
686 * but always handles it identical.
689 mode->sort == irms_float_number &&
690 mode->arithmetic != irma_ieee754;
694 * Returns non-zero if the given mode might overflow on unary Minus.
696 * This does NOT happen on IEEE 754.
698 int mode_overflow_on_unary_Minus(const ir_mode *mode)
700 if (mode->sort == irms_float_number)
701 return mode->arithmetic == irma_ieee754 ? 0 : 1;
706 * Returns non-zero if the mode has a reversed wrap-around
707 * logic, especially (a + x) - x == a.
709 * This is normally true for integer modes, not for floating
712 int mode_wrap_around(const ir_mode *mode)
714 /* FIXME: better would be an extra mode property */
715 return mode_is_int(mode);
719 * Returns non-zero if the cast from mode src to mode dst is a
720 * reinterpret cast (ie. only the bit pattern is reinterpreted,
721 * no conversion is done)
723 int is_reinterpret_cast(const ir_mode *src, const ir_mode *dst)
725 ir_mode_arithmetic ma;
729 if (get_mode_size_bits(src) != get_mode_size_bits(dst))
731 ma = get_mode_arithmetic(src);
732 if (ma != get_mode_arithmetic(dst))
735 return ma == irma_twos_complement;
738 ir_type *(get_type_for_mode) (const ir_mode *mode)
740 return get_type_for_mode_(mode);
743 void finish_mode(void)
745 obstack_free(&modes, 0);
746 DEL_ARR_F(mode_list);