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);
57 X(irma_ones_complement);
61 default: return "<unknown>";
67 * Compare modes that don't need to have their code field
70 * TODO: Add other fields
72 static inline int modes_are_equal(const ir_mode *m, const ir_mode *n)
75 if (m->sort == n->sort &&
76 m->arithmetic == n->arithmetic &&
79 m->modulo_shift == n->modulo_shift &&
80 m->vector_elem == n->vector_elem)
87 * searches the modes obstack for the given mode and returns
88 * a pointer on an equal mode already in the array, NULL if
91 static ir_mode *find_mode(const ir_mode *m)
94 for (i = 0, n_modes = ARR_LEN(mode_list); i < n_modes; ++i) {
95 ir_mode *n = mode_list[i];
96 if (modes_are_equal(n, m))
103 * sets special values of modes
105 static void set_mode_values(ir_mode* mode)
107 switch (get_mode_sort(mode)) {
109 case irms_int_number:
110 case irms_float_number:
111 mode->min = get_tarval_min(mode);
112 mode->max = get_tarval_max(mode);
113 mode->null = get_tarval_null(mode);
114 mode->one = get_tarval_one(mode);
115 mode->minus_one = get_tarval_minus_one(mode);
116 if (get_mode_sort(mode) != irms_float_number) {
117 mode->all_one = get_tarval_all_one(mode);
119 mode->all_one = tarval_bad;
123 case irms_internal_boolean:
124 mode->min = tarval_b_false;
125 mode->max = tarval_b_true;
126 mode->null = tarval_b_false;
127 mode->one = tarval_b_true;
128 mode->minus_one = tarval_bad;
129 mode->all_one = tarval_b_true;
134 case irms_control_flow:
135 mode->min = tarval_bad;
136 mode->max = tarval_bad;
137 mode->null = tarval_bad;
138 mode->one = tarval_bad;
139 mode->minus_one = tarval_bad;
145 * globals defined in irmode.h
148 /* --- Predefined modes --- */
150 /* FIRM internal modes: */
158 /* predefined numerical modes: */
159 ir_mode *mode_F; /* float */
160 ir_mode *mode_D; /* double */
161 ir_mode *mode_E; /* long double */
163 ir_mode *mode_Bs; /* integral values, signed and unsigned */
164 ir_mode *mode_Bu; /* 8 bit */
165 ir_mode *mode_Hs; /* 16 bit */
167 ir_mode *mode_Is; /* 32 bit */
169 ir_mode *mode_Ls; /* 64 bit */
171 ir_mode *mode_LLs; /* 128 bit */
177 /* machine specific modes */
178 ir_mode *mode_P_code; /**< machine specific pointer mode for code addresses */
179 ir_mode *mode_P_data; /**< machine specific pointer mode for data addresses */
182 * functions defined in irmode.h
185 /* JNI access functions */
186 ir_mode *get_modeT(void) { return mode_T; }
187 ir_mode *get_modeF(void) { return mode_F; }
188 ir_mode *get_modeD(void) { return mode_D; }
189 ir_mode *get_modeE(void) { return mode_E; }
190 ir_mode *get_modeBs(void) { return mode_Bs; }
191 ir_mode *get_modeBu(void) { return mode_Bu; }
192 ir_mode *get_modeHs(void) { return mode_Hs; }
193 ir_mode *get_modeHu(void) { return mode_Hu; }
194 ir_mode *get_modeIs(void) { return mode_Is; }
195 ir_mode *get_modeIu(void) { return mode_Iu; }
196 ir_mode *get_modeLs(void) { return mode_Ls; }
197 ir_mode *get_modeLu(void) { return mode_Lu; }
198 ir_mode *get_modeLLs(void){ return mode_LLs; }
199 ir_mode *get_modeLLu(void){ return mode_LLu; }
200 ir_mode *get_modeb(void) { return mode_b; }
201 ir_mode *get_modeP(void) { return mode_P; }
202 ir_mode *get_modeX(void) { return mode_X; }
203 ir_mode *get_modeM(void) { return mode_M; }
204 ir_mode *get_modeBB(void) { return mode_BB; }
205 ir_mode *get_modeANY(void) { return mode_ANY; }
206 ir_mode *get_modeBAD(void) { return mode_BAD; }
209 ir_mode *(get_modeP_code)(void)
211 return _get_modeP_code();
214 ir_mode *(get_modeP_data)(void)
216 return _get_modeP_data();
219 void set_modeP_code(ir_mode *p)
221 assert(mode_is_reference(p));
225 void set_modeP_data(ir_mode *p)
227 assert(mode_is_reference(p));
232 * Registers a new mode.
234 * @param new_mode The new mode template.
236 static ir_mode *register_mode(const ir_mode *new_mode)
238 ir_mode *mode = NULL;
242 /* copy mode struct to modes array */
243 mode = (ir_mode *)obstack_copy(&modes, new_mode, sizeof(*mode));
244 ARR_APP1(ir_mode*, mode_list, mode);
246 mode->kind = k_ir_mode;
247 mode->type = new_type_primitive(mode);
249 /* add the new mode to the irp list of modes */
252 set_mode_values(mode);
254 hook_new_mode(new_mode, mode);
259 * Creates a new mode.
261 ir_mode *new_ir_mode(const char *name, ir_mode_sort sort, int bit_size, int sign,
262 ir_mode_arithmetic arithmetic, unsigned int modulo_shift)
265 ir_mode *mode = NULL;
267 mode_tmpl.name = new_id_from_str(name);
268 mode_tmpl.sort = sort;
269 mode_tmpl.size = bit_size;
270 mode_tmpl.sign = sign ? 1 : 0;
271 mode_tmpl.modulo_shift = (mode_tmpl.sort == irms_int_number ||
272 mode_tmpl.sort == irms_reference) ? modulo_shift : 0;
273 mode_tmpl.vector_elem = 1;
274 mode_tmpl.arithmetic = arithmetic;
275 mode_tmpl.link = NULL;
276 mode_tmpl.tv_priv = NULL;
278 mode = find_mode(&mode_tmpl);
280 hook_new_mode(&mode_tmpl, mode);
287 case irms_control_flow:
289 case irms_internal_boolean:
290 panic("internal modes cannot be user defined");
292 case irms_float_number:
293 case irms_int_number:
295 mode = register_mode(&mode_tmpl);
298 assert(mode != NULL);
303 * Creates a new vector mode.
305 ir_mode *new_ir_vector_mode(const char *name, ir_mode_sort sort, int bit_size, unsigned num_of_elem, int sign,
306 ir_mode_arithmetic arithmetic, unsigned int modulo_shift)
309 ir_mode *mode = NULL;
311 mode_tmpl.name = new_id_from_str(name);
312 mode_tmpl.sort = sort;
313 mode_tmpl.size = bit_size * num_of_elem;
314 mode_tmpl.sign = sign ? 1 : 0;
315 mode_tmpl.modulo_shift = (mode_tmpl.sort == irms_int_number) ? modulo_shift : 0;
316 mode_tmpl.vector_elem = num_of_elem;
317 mode_tmpl.arithmetic = arithmetic;
318 mode_tmpl.link = NULL;
319 mode_tmpl.tv_priv = NULL;
321 mode = find_mode(&mode_tmpl);
323 hook_new_mode(&mode_tmpl, mode);
327 if (num_of_elem <= 1) {
328 panic("vector modes should have at least 2 elements");
334 case irms_control_flow:
336 case irms_internal_boolean:
337 panic("internal modes cannot be user defined");
340 panic("only integer and floating point modes can be vectorized");
342 case irms_float_number:
343 panic("not yet implemented");
345 case irms_int_number:
346 mode = register_mode(&mode_tmpl);
348 assert(mode != NULL);
352 /* Functions for the direct access to all attributes of an ir_mode */
353 ident *(get_mode_ident)(const ir_mode *mode)
355 return _get_mode_ident(mode);
358 const char *get_mode_name(const ir_mode *mode)
360 return get_id_str(mode->name);
363 ir_mode_sort (get_mode_sort)(const ir_mode* mode)
365 return _get_mode_sort(mode);
368 unsigned (get_mode_size_bits)(const ir_mode *mode)
370 return _get_mode_size_bits(mode);
373 unsigned (get_mode_size_bytes)(const ir_mode *mode)
375 return _get_mode_size_bytes(mode);
378 int (get_mode_sign)(const ir_mode *mode)
380 return _get_mode_sign(mode);
383 ir_mode_arithmetic (get_mode_arithmetic)(const ir_mode *mode)
385 return get_mode_arithmetic(mode);
389 /* Attribute modulo shift specifies for modes of kind irms_int_number
390 * whether shift applies modulo to value of bits to shift. Asserts
391 * if mode is not irms_int_number.
393 unsigned int (get_mode_modulo_shift)(const ir_mode *mode)
395 return _get_mode_modulo_shift(mode);
398 unsigned int (get_mode_n_vector_elems)(const ir_mode *mode)
400 return _get_mode_vector_elems(mode);
403 void *(get_mode_link)(const ir_mode *mode)
405 return _get_mode_link(mode);
408 void (set_mode_link)(ir_mode *mode, void *l)
410 _set_mode_link(mode, l);
413 ir_tarval *get_mode_min(ir_mode *mode)
416 assert(mode_is_data(mode));
421 ir_tarval *get_mode_max(ir_mode *mode)
424 assert(mode_is_data(mode));
429 ir_tarval *get_mode_null(ir_mode *mode)
432 assert(mode_is_datab(mode));
437 ir_tarval *get_mode_one(ir_mode *mode)
440 assert(mode_is_datab(mode));
445 ir_tarval *get_mode_minus_one(ir_mode *mode)
448 assert(mode_is_data(mode));
450 return mode->minus_one;
453 ir_tarval *get_mode_all_one(ir_mode *mode)
456 assert(mode_is_datab(mode));
457 return mode->all_one;
460 ir_tarval *get_mode_infinite(ir_mode *mode)
463 assert(mode_is_float(mode));
465 return get_tarval_plus_inf(mode);
468 ir_tarval *get_mode_NAN(ir_mode *mode)
471 assert(mode_is_float(mode));
473 return get_tarval_nan(mode);
476 int is_mode(const void *thing)
478 return get_kind(thing) == k_ir_mode;
481 int (mode_is_signed)(const ir_mode *mode)
483 return _mode_is_signed(mode);
486 int (mode_is_float)(const ir_mode *mode)
488 return _mode_is_float(mode);
491 int (mode_is_int)(const ir_mode *mode)
493 return _mode_is_int(mode);
496 int (mode_is_reference)(const ir_mode *mode)
498 return _mode_is_reference(mode);
501 int (mode_is_num)(const ir_mode *mode)
503 return _mode_is_num(mode);
506 int (mode_is_data)(const ir_mode *mode)
508 return _mode_is_data(mode);
511 int (mode_is_datab)(const ir_mode *mode)
513 return _mode_is_datab(mode);
516 int (mode_is_dataM)(const ir_mode *mode)
518 return _mode_is_dataM(mode);
521 int (mode_is_float_vector)(const ir_mode *mode)
523 return _mode_is_float_vector(mode);
526 int (mode_is_int_vector)(const ir_mode *mode)
528 return _mode_is_int_vector(mode);
531 /* Returns true if sm can be converted to lm without loss. */
532 int smaller_mode(const ir_mode *sm, const ir_mode *lm)
534 int sm_bits, lm_bits;
539 if (sm == lm) return 1;
541 sm_bits = get_mode_size_bits(sm);
542 lm_bits = get_mode_size_bits(lm);
544 switch (get_mode_sort(sm)) {
545 case irms_int_number:
546 switch (get_mode_sort(lm)) {
547 case irms_int_number:
548 if (get_mode_arithmetic(sm) != get_mode_arithmetic(lm))
551 /* only two complement implemented */
552 assert(get_mode_arithmetic(sm) == irma_twos_complement);
554 /* integers are convertable if
555 * - both have the same sign and lm is the larger one
556 * - lm is the signed one and is at least two bits larger
557 * (one for the sign, one for the highest bit of sm)
558 * - sm & lm are two_complement and lm has greater or equal number of bits
560 if (mode_is_signed(sm)) {
561 if (!mode_is_signed(lm))
563 return sm_bits <= lm_bits;
565 if (mode_is_signed(lm)) {
566 return sm_bits < lm_bits;
568 return sm_bits <= lm_bits;
571 case irms_float_number:
572 /* int to float works if the float is large enough */
580 case irms_float_number:
581 if (get_mode_arithmetic(sm) == get_mode_arithmetic(lm)) {
582 if ( (get_mode_sort(lm) == irms_float_number)
583 && (get_mode_size_bits(lm) >= get_mode_size_bits(sm)) )
589 /* do exist machines out there with different pointer lengths ?*/
592 case irms_internal_boolean:
593 return mode_is_int(lm);
603 /* Returns true if a value of mode sm can be converted into mode lm
604 and backwards without loss. */
605 int values_in_mode(const ir_mode *sm, const ir_mode *lm)
607 ir_mode_arithmetic arith;
612 if (sm == lm) return 1;
615 return mode_is_int(lm);
617 arith = get_mode_arithmetic(sm);
618 if (arith != get_mode_arithmetic(lm))
622 case irma_twos_complement:
624 return get_mode_size_bits(sm) <= get_mode_size_bits(lm);
631 /* Return the signed integer equivalent mode for an reference mode. */
632 ir_mode *get_reference_mode_signed_eq(ir_mode *mode)
634 assert(mode_is_reference(mode));
635 return mode->eq_signed;
638 /* Sets the signed integer equivalent mode for an reference mode. */
639 void set_reference_mode_signed_eq(ir_mode *ref_mode, ir_mode *int_mode)
641 assert(mode_is_reference(ref_mode));
642 assert(mode_is_int(int_mode));
643 ref_mode->eq_signed = int_mode;
646 /* Return the unsigned integer equivalent mode for an reference mode. */
647 ir_mode *get_reference_mode_unsigned_eq(ir_mode *mode)
649 assert(mode_is_reference(mode));
650 return mode->eq_unsigned;
653 /* Sets the unsigned integer equivalent mode for an reference mode. */
654 void set_reference_mode_unsigned_eq(ir_mode *ref_mode, ir_mode *int_mode)
656 assert(mode_is_reference(ref_mode));
657 assert(mode_is_int(int_mode));
658 ref_mode->eq_unsigned = int_mode;
661 /* initialization, build the default modes */
666 obstack_init(&modes);
667 mode_list = NEW_ARR_F(ir_mode*, 0);
669 /* initialize predefined modes */
672 newmode.arithmetic = irma_none;
675 newmode.modulo_shift = 0;
676 newmode.vector_elem = 0;
677 newmode.eq_signed = NULL;
678 newmode.eq_unsigned = NULL;
680 newmode.tv_priv = NULL;
682 /* Control Flow Modes*/
683 newmode.sort = irms_control_flow;
686 newmode.name = new_id_from_chars("BB", 2);
687 mode_BB = register_mode(&newmode);
690 newmode.name = new_id_from_chars("X", 1);
691 mode_X = register_mode(&newmode);
694 newmode.sort = irms_memory;
697 newmode.name = new_id_from_chars("M", 1);
698 mode_M = register_mode(&newmode);
700 /* Auxiliary Modes */
701 newmode.sort = irms_auxiliary,
704 newmode.name = new_id_from_chars("T", 1);
705 mode_T = register_mode(&newmode);
708 newmode.name = new_id_from_chars("ANY", 3);
709 mode_ANY = register_mode(&newmode);
712 newmode.name = new_id_from_chars("BAD", 3);
713 mode_BAD = register_mode(&newmode);
715 /* Internal Boolean Modes */
716 newmode.sort = irms_internal_boolean;
719 newmode.name = new_id_from_chars("b", 1);
720 mode_b = register_mode(&newmode);
723 newmode.vector_elem = 1;
725 /* Float Number Modes */
726 newmode.sort = irms_float_number;
727 newmode.arithmetic = irma_ieee754;
730 newmode.name = new_id_from_chars("F", 1);
733 mode_F = register_mode(&newmode);
736 newmode.name = new_id_from_chars("D", 1);
739 mode_D = register_mode(&newmode);
742 newmode.name = new_id_from_chars("E", 1);
744 /* note that the tarval module is calculating with 80 bits, but we use
745 * 96 bits, as that is what will be stored to memory by most hardware */
747 mode_E = register_mode(&newmode);
749 /* Integer Number Modes */
750 newmode.sort = irms_int_number;
751 newmode.arithmetic = irma_twos_complement;
754 newmode.name = new_id_from_chars("Bs", 2);
757 newmode.modulo_shift = 32;
758 mode_Bs = register_mode(&newmode);
761 newmode.name = new_id_from_chars("Bu", 2);
762 newmode.arithmetic = irma_twos_complement;
765 newmode.modulo_shift = 32;
766 mode_Bu = register_mode(&newmode);
768 /* signed short integer */
769 newmode.name = new_id_from_chars("Hs", 2);
772 newmode.modulo_shift = 32;
773 mode_Hs = register_mode(&newmode);
775 /* unsigned short integer */
776 newmode.name = new_id_from_chars("Hu", 2);
779 newmode.modulo_shift = 32;
780 mode_Hu = register_mode(&newmode);
783 newmode.name = new_id_from_chars("Is", 2);
786 newmode.modulo_shift = 32;
787 mode_Is = register_mode(&newmode);
789 /* unsigned integer */
790 newmode.name = new_id_from_chars("Iu", 2);
793 newmode.modulo_shift = 32;
794 mode_Iu = register_mode(&newmode);
796 /* signed long integer */
797 newmode.name = new_id_from_chars("Ls", 2);
800 newmode.modulo_shift = 64;
801 mode_Ls = register_mode(&newmode);
803 /* unsigned long integer */
804 newmode.name = new_id_from_chars("Lu", 2);
807 newmode.modulo_shift = 64;
808 mode_Lu = register_mode(&newmode);
810 /* signed long long integer */
811 newmode.name = new_id_from_chars("LLs", 3);
814 newmode.modulo_shift = 128;
815 mode_LLs = register_mode(&newmode);
817 /* unsigned long long integer */
818 newmode.name = new_id_from_chars("LLu", 3);
821 newmode.modulo_shift = 128;
822 mode_LLu = register_mode(&newmode);
825 newmode.sort = irms_reference;
826 newmode.arithmetic = irma_twos_complement;
829 newmode.name = new_id_from_chars("P", 1);
832 newmode.modulo_shift = 32;
833 newmode.eq_signed = mode_Is;
834 newmode.eq_unsigned = mode_Iu;
835 mode_P = register_mode(&newmode);
837 /* set the machine specific modes to the predefined ones */
838 mode_P_code = mode_P;
839 mode_P_data = mode_P;
842 /* find a signed mode for an unsigned integer mode */
843 ir_mode *find_unsigned_mode(const ir_mode *mode)
847 /* allowed for reference mode */
848 if (mode->sort == irms_reference)
849 n.sort = irms_int_number;
851 assert(n.sort == irms_int_number);
853 return find_mode(&n);
856 /* find an unsigned mode for a signed integer mode */
857 ir_mode *find_signed_mode(const ir_mode *mode)
861 assert(mode->sort == irms_int_number);
863 return find_mode(&n);
866 /* finds a integer mode with 2*n bits for an integer mode with n bits. */
867 ir_mode *find_double_bits_int_mode(const ir_mode *mode)
871 assert(mode->sort == irms_int_number && mode->arithmetic == irma_twos_complement);
873 n.size = 2*mode->size;
874 return find_mode(&n);
878 * Returns non-zero if the given mode honors signed zero's, i.e.,
879 * a +0 and a -0 exists and handled differently.
881 int mode_honor_signed_zeros(const ir_mode *mode)
883 /* for floating point, we know that IEEE 754 has +0 and -0,
884 * but always handles it identical.
887 mode->sort == irms_float_number &&
888 mode->arithmetic != irma_ieee754;
892 * Returns non-zero if the given mode might overflow on unary Minus.
894 * This does NOT happen on IEEE 754.
896 int mode_overflow_on_unary_Minus(const ir_mode *mode)
898 if (mode->sort == irms_float_number)
899 return mode->arithmetic == irma_ieee754 ? 0 : 1;
904 * Returns non-zero if the mode has a reversed wrap-around
905 * logic, especially (a + x) - x == a.
907 * This is normally true for integer modes, not for floating
910 int mode_wrap_around(const ir_mode *mode)
912 /* FIXME: better would be an extra mode property */
913 return mode_is_int(mode);
917 * Returns non-zero if the cast from mode src to mode dst is a
918 * reinterpret cast (ie. only the bit pattern is reinterpreted,
919 * no conversion is done)
921 int is_reinterpret_cast(const ir_mode *src, const ir_mode *dst)
923 ir_mode_arithmetic ma;
927 if (get_mode_size_bits(src) != get_mode_size_bits(dst))
929 ma = get_mode_arithmetic(src);
930 if (ma != get_mode_arithmetic(dst))
933 return ma == irma_twos_complement || ma == irma_ones_complement;
936 ir_type *(get_type_for_mode) (const ir_mode *mode)
938 return get_type_for_mode_(mode);
941 void finish_mode(void)
943 obstack_free(&modes, 0);
944 DEL_ARR_F(mode_list);