2 * Copyright (C) 1995-2008 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 = ARR_LEN(mode_list) - 1; i >= 0; --i) {
95 ir_mode *n = mode_list[i];
96 if (modes_are_equal(n, m))
102 #ifdef FIRM_STATISTICS
103 /* return the mode index, only needed for statistics */
104 int stat_find_mode_index(const ir_mode *m)
107 for (i = ARR_LEN(mode_list) - 1; i >= 0; --i) {
108 ir_mode *n = mode_list[i];
109 if (modes_are_equal(n, m))
115 /* return the mode for a given index, only needed for statistics */
116 ir_mode *stat_mode_for_index(int idx)
118 if (0 <= idx && idx < ARR_LEN(mode_list))
119 return mode_list[idx];
125 * sets special values of modes
127 static void set_mode_values(ir_mode* mode)
129 switch (get_mode_sort(mode)) {
131 case irms_int_number:
132 case irms_float_number:
133 mode->min = get_tarval_min(mode);
134 mode->max = get_tarval_max(mode);
135 mode->null = get_tarval_null(mode);
136 mode->one = get_tarval_one(mode);
137 mode->minus_one = get_tarval_minus_one(mode);
138 if (get_mode_sort(mode) != irms_float_number) {
139 mode->all_one = get_tarval_all_one(mode);
141 mode->all_one = tarval_bad;
145 case irms_internal_boolean:
146 mode->min = tarval_b_false;
147 mode->max = tarval_b_true;
148 mode->null = tarval_b_false;
149 mode->one = tarval_b_true;
150 mode->minus_one = tarval_bad;
151 mode->all_one = tarval_b_true;
156 case irms_control_flow:
157 mode->min = tarval_bad;
158 mode->max = tarval_bad;
159 mode->null = tarval_bad;
160 mode->one = tarval_bad;
161 mode->minus_one = tarval_bad;
167 * globals defined in irmode.h
170 /* --- Predefined modes --- */
172 /* FIRM internal modes: */
180 /* predefined numerical modes: */
181 ir_mode *mode_F; /* float */
182 ir_mode *mode_D; /* double */
183 ir_mode *mode_E; /* long double */
185 ir_mode *mode_Bs; /* integral values, signed and unsigned */
186 ir_mode *mode_Bu; /* 8 bit */
187 ir_mode *mode_Hs; /* 16 bit */
189 ir_mode *mode_Is; /* 32 bit */
191 ir_mode *mode_Ls; /* 64 bit */
193 ir_mode *mode_LLs; /* 128 bit */
199 /* machine specific modes */
200 ir_mode *mode_P_code; /**< machine specific pointer mode for code addresses */
201 ir_mode *mode_P_data; /**< machine specific pointer mode for data addresses */
204 * functions defined in irmode.h
207 /* JNI access functions */
208 ir_mode *get_modeT(void) { return mode_T; }
209 ir_mode *get_modeF(void) { return mode_F; }
210 ir_mode *get_modeD(void) { return mode_D; }
211 ir_mode *get_modeE(void) { return mode_E; }
212 ir_mode *get_modeBs(void) { return mode_Bs; }
213 ir_mode *get_modeBu(void) { return mode_Bu; }
214 ir_mode *get_modeHs(void) { return mode_Hs; }
215 ir_mode *get_modeHu(void) { return mode_Hu; }
216 ir_mode *get_modeIs(void) { return mode_Is; }
217 ir_mode *get_modeIu(void) { return mode_Iu; }
218 ir_mode *get_modeLs(void) { return mode_Ls; }
219 ir_mode *get_modeLu(void) { return mode_Lu; }
220 ir_mode *get_modeLLs(void){ return mode_LLs; }
221 ir_mode *get_modeLLu(void){ return mode_LLu; }
222 ir_mode *get_modeb(void) { return mode_b; }
223 ir_mode *get_modeP(void) { return mode_P; }
224 ir_mode *get_modeX(void) { return mode_X; }
225 ir_mode *get_modeM(void) { return mode_M; }
226 ir_mode *get_modeBB(void) { return mode_BB; }
227 ir_mode *get_modeANY(void) { return mode_ANY; }
228 ir_mode *get_modeBAD(void) { return mode_BAD; }
231 ir_mode *(get_modeP_code)(void)
233 return _get_modeP_code();
236 ir_mode *(get_modeP_data)(void)
238 return _get_modeP_data();
241 void set_modeP_code(ir_mode *p)
243 assert(mode_is_reference(p));
247 void set_modeP_data(ir_mode *p)
249 assert(mode_is_reference(p));
254 * Registers a new mode.
256 * @param new_mode The new mode template.
258 static ir_mode *register_mode(const ir_mode *new_mode)
260 ir_mode *mode = NULL;
264 /* copy mode struct to modes array */
265 mode = (ir_mode *)obstack_copy(&modes, new_mode, sizeof(*mode));
266 ARR_APP1(ir_mode*, mode_list, mode);
268 mode->kind = k_ir_mode;
269 mode->type = new_type_primitive(mode);
271 /* add the new mode to the irp list of modes */
274 set_mode_values(mode);
276 hook_new_mode(new_mode, mode);
281 * Creates a new mode.
283 ir_mode *new_ir_mode(const char *name, ir_mode_sort sort, int bit_size, int sign,
284 ir_mode_arithmetic arithmetic, unsigned int modulo_shift)
287 ir_mode *mode = NULL;
289 mode_tmpl.name = new_id_from_str(name);
290 mode_tmpl.sort = sort;
291 mode_tmpl.size = bit_size;
292 mode_tmpl.sign = sign ? 1 : 0;
293 mode_tmpl.modulo_shift = (mode_tmpl.sort == irms_int_number ||
294 mode_tmpl.sort == irms_reference) ? modulo_shift : 0;
295 mode_tmpl.vector_elem = 1;
296 mode_tmpl.arithmetic = arithmetic;
297 mode_tmpl.link = NULL;
298 mode_tmpl.tv_priv = NULL;
300 mode = find_mode(&mode_tmpl);
302 hook_new_mode(&mode_tmpl, mode);
309 case irms_control_flow:
311 case irms_internal_boolean:
312 panic("internal modes cannot be user defined");
314 case irms_float_number:
315 case irms_int_number:
317 mode = register_mode(&mode_tmpl);
320 assert(mode != NULL);
325 * Creates a new vector mode.
327 ir_mode *new_ir_vector_mode(const char *name, ir_mode_sort sort, int bit_size, unsigned num_of_elem, int sign,
328 ir_mode_arithmetic arithmetic, unsigned int modulo_shift)
331 ir_mode *mode = NULL;
333 mode_tmpl.name = new_id_from_str(name);
334 mode_tmpl.sort = sort;
335 mode_tmpl.size = bit_size * num_of_elem;
336 mode_tmpl.sign = sign ? 1 : 0;
337 mode_tmpl.modulo_shift = (mode_tmpl.sort == irms_int_number) ? modulo_shift : 0;
338 mode_tmpl.vector_elem = num_of_elem;
339 mode_tmpl.arithmetic = arithmetic;
340 mode_tmpl.link = NULL;
341 mode_tmpl.tv_priv = NULL;
343 mode = find_mode(&mode_tmpl);
345 hook_new_mode(&mode_tmpl, mode);
349 if (num_of_elem <= 1) {
350 assert(0 && "vector modes should have at least 2 elements");
357 case irms_control_flow:
359 case irms_internal_boolean:
360 panic("internal modes cannot be user defined");
363 panic("only integer and floating point modes can be vectorized");
365 case irms_float_number:
366 panic("not yet implemented");
368 case irms_int_number:
369 mode = register_mode(&mode_tmpl);
371 assert(mode != NULL);
375 /* Functions for the direct access to all attributes of an ir_mode */
376 ident *(get_mode_ident)(const ir_mode *mode)
378 return _get_mode_ident(mode);
381 const char *get_mode_name(const ir_mode *mode)
383 return get_id_str(mode->name);
386 ir_mode_sort (get_mode_sort)(const ir_mode* mode)
388 return _get_mode_sort(mode);
391 unsigned (get_mode_size_bits)(const ir_mode *mode)
393 return _get_mode_size_bits(mode);
396 unsigned (get_mode_size_bytes)(const ir_mode *mode)
398 return _get_mode_size_bytes(mode);
401 int (get_mode_sign)(const ir_mode *mode)
403 return _get_mode_sign(mode);
406 ir_mode_arithmetic (get_mode_arithmetic)(const ir_mode *mode)
408 return get_mode_arithmetic(mode);
412 /* Attribute modulo shift specifies for modes of kind irms_int_number
413 * whether shift applies modulo to value of bits to shift. Asserts
414 * if mode is not irms_int_number.
416 unsigned int (get_mode_modulo_shift)(const ir_mode *mode)
418 return _get_mode_modulo_shift(mode);
421 unsigned int (get_mode_n_vector_elems)(const ir_mode *mode)
423 return _get_mode_vector_elems(mode);
426 void *(get_mode_link)(const ir_mode *mode)
428 return _get_mode_link(mode);
431 void (set_mode_link)(ir_mode *mode, void *l)
433 _set_mode_link(mode, l);
436 tarval *get_mode_min(ir_mode *mode)
439 assert(mode_is_data(mode));
444 tarval *get_mode_max(ir_mode *mode)
447 assert(mode_is_data(mode));
452 tarval *get_mode_null(ir_mode *mode)
455 assert(mode_is_datab(mode));
460 tarval *get_mode_one(ir_mode *mode)
463 assert(mode_is_datab(mode));
468 tarval *get_mode_minus_one(ir_mode *mode)
471 assert(mode_is_data(mode));
473 return mode->minus_one;
476 tarval *get_mode_all_one(ir_mode *mode)
479 assert(mode_is_datab(mode));
480 return mode->all_one;
483 tarval *get_mode_infinite(ir_mode *mode)
486 assert(mode_is_float(mode));
488 return get_tarval_plus_inf(mode);
491 tarval *get_mode_NAN(ir_mode *mode)
494 assert(mode_is_float(mode));
496 return get_tarval_nan(mode);
499 int is_mode(const void *thing)
501 return get_kind(thing) == k_ir_mode;
504 int (mode_is_signed)(const ir_mode *mode)
506 return _mode_is_signed(mode);
509 int (mode_is_float)(const ir_mode *mode)
511 return _mode_is_float(mode);
514 int (mode_is_int)(const ir_mode *mode)
516 return _mode_is_int(mode);
519 int (mode_is_reference)(const ir_mode *mode)
521 return _mode_is_reference(mode);
524 int (mode_is_num)(const ir_mode *mode)
526 return _mode_is_num(mode);
529 int (mode_is_data)(const ir_mode *mode)
531 return _mode_is_data(mode);
534 int (mode_is_datab)(const ir_mode *mode)
536 return _mode_is_datab(mode);
539 int (mode_is_dataM)(const ir_mode *mode)
541 return _mode_is_dataM(mode);
544 int (mode_is_float_vector)(const ir_mode *mode)
546 return _mode_is_float_vector(mode);
549 int (mode_is_int_vector)(const ir_mode *mode)
551 return _mode_is_int_vector(mode);
554 /* Returns true if sm can be converted to lm without loss. */
555 int smaller_mode(const ir_mode *sm, const ir_mode *lm)
557 int sm_bits, lm_bits;
562 if (sm == lm) return 1;
564 sm_bits = get_mode_size_bits(sm);
565 lm_bits = get_mode_size_bits(lm);
567 switch (get_mode_sort(sm)) {
568 case irms_int_number:
569 switch (get_mode_sort(lm)) {
570 case irms_int_number:
571 if (get_mode_arithmetic(sm) != get_mode_arithmetic(lm))
574 /* only two complement implemented */
575 assert(get_mode_arithmetic(sm) == irma_twos_complement);
577 /* integers are convertable if
578 * - both have the same sign and lm is the larger one
579 * - lm is the signed one and is at least two bits larger
580 * (one for the sign, one for the highest bit of sm)
581 * - sm & lm are two_complement and lm has greater or equal number of bits
583 if (mode_is_signed(sm)) {
584 if (!mode_is_signed(lm))
586 return sm_bits <= lm_bits;
588 if (mode_is_signed(lm)) {
589 return sm_bits < lm_bits;
591 return sm_bits <= lm_bits;
595 case irms_float_number:
596 /* int to float works if the float is large enough */
604 case irms_float_number:
605 if (get_mode_arithmetic(sm) == get_mode_arithmetic(lm)) {
606 if ( (get_mode_sort(lm) == irms_float_number)
607 && (get_mode_size_bits(lm) >= get_mode_size_bits(sm)) )
613 /* do exist machines out there with different pointer lengths ?*/
616 case irms_internal_boolean:
617 return mode_is_int(lm);
627 /* Returns true if a value of mode sm can be converted into mode lm
628 and backwards without loss. */
629 int values_in_mode(const ir_mode *sm, const ir_mode *lm)
631 int sm_bits, lm_bits;
632 ir_mode_arithmetic arith;
637 if (sm == lm) return 1;
640 return mode_is_int(lm);
642 sm_bits = get_mode_size_bits(sm);
643 lm_bits = get_mode_size_bits(lm);
645 arith = get_mode_arithmetic(sm);
646 if (arith != get_mode_arithmetic(lm))
650 case irma_twos_complement:
652 return get_mode_size_bits(sm) <= get_mode_size_bits(lm);
659 /* Return the signed integer equivalent mode for an reference mode. */
660 ir_mode *get_reference_mode_signed_eq(ir_mode *mode)
662 assert(mode_is_reference(mode));
663 return mode->eq_signed;
666 /* Sets the signed integer equivalent mode for an reference mode. */
667 void set_reference_mode_signed_eq(ir_mode *ref_mode, ir_mode *int_mode)
669 assert(mode_is_reference(ref_mode));
670 assert(mode_is_int(int_mode));
671 ref_mode->eq_signed = int_mode;
674 /* Return the unsigned integer equivalent mode for an reference mode. */
675 ir_mode *get_reference_mode_unsigned_eq(ir_mode *mode)
677 assert(mode_is_reference(mode));
678 return mode->eq_unsigned;
681 /* Sets the unsigned integer equivalent mode for an reference mode. */
682 void set_reference_mode_unsigned_eq(ir_mode *ref_mode, ir_mode *int_mode)
684 assert(mode_is_reference(ref_mode));
685 assert(mode_is_int(int_mode));
686 ref_mode->eq_unsigned = int_mode;
689 /* initialization, build the default modes */
694 obstack_init(&modes);
695 mode_list = NEW_ARR_F(ir_mode*, 0);
697 /* initialize predefined modes */
700 newmode.arithmetic = irma_none;
703 newmode.modulo_shift = 0;
704 newmode.vector_elem = 0;
705 newmode.eq_signed = NULL;
706 newmode.eq_unsigned = NULL;
708 newmode.tv_priv = NULL;
710 /* Control Flow Modes*/
711 newmode.sort = irms_control_flow;
714 newmode.name = new_id_from_chars("BB", 2);
715 mode_BB = register_mode(&newmode);
718 newmode.name = new_id_from_chars("X", 1);
719 mode_X = register_mode(&newmode);
722 newmode.sort = irms_memory;
725 newmode.name = new_id_from_chars("M", 1);
726 mode_M = register_mode(&newmode);
728 /* Auxiliary Modes */
729 newmode.sort = irms_auxiliary,
732 newmode.name = new_id_from_chars("T", 1);
733 mode_T = register_mode(&newmode);
736 newmode.name = new_id_from_chars("ANY", 3);
737 mode_ANY = register_mode(&newmode);
740 newmode.name = new_id_from_chars("BAD", 3);
741 mode_BAD = register_mode(&newmode);
743 /* Internal Boolean Modes */
744 newmode.sort = irms_internal_boolean;
747 newmode.name = new_id_from_chars("b", 1);
748 mode_b = register_mode(&newmode);
751 newmode.vector_elem = 1;
753 /* Float Number Modes */
754 newmode.sort = irms_float_number;
755 newmode.arithmetic = irma_ieee754;
758 newmode.name = new_id_from_chars("F", 1);
761 mode_F = register_mode(&newmode);
764 newmode.name = new_id_from_chars("D", 1);
767 mode_D = register_mode(&newmode);
770 newmode.name = new_id_from_chars("E", 1);
772 /* note that the tarval module is calculating with 80 bits, but we use
773 * 96 bits, as that is what will be stored to memory by most hardware */
775 mode_E = register_mode(&newmode);
777 /* Integer Number Modes */
778 newmode.sort = irms_int_number;
779 newmode.arithmetic = irma_twos_complement;
782 newmode.name = new_id_from_chars("Bs", 2);
785 newmode.modulo_shift = 32;
786 mode_Bs = register_mode(&newmode);
789 newmode.name = new_id_from_chars("Bu", 2);
790 newmode.arithmetic = irma_twos_complement;
793 newmode.modulo_shift = 32;
794 mode_Bu = register_mode(&newmode);
796 /* signed short integer */
797 newmode.name = new_id_from_chars("Hs", 2);
800 newmode.modulo_shift = 32;
801 mode_Hs = register_mode(&newmode);
803 /* unsigned short integer */
804 newmode.name = new_id_from_chars("Hu", 2);
807 newmode.modulo_shift = 32;
808 mode_Hu = register_mode(&newmode);
811 newmode.name = new_id_from_chars("Is", 2);
814 newmode.modulo_shift = 32;
815 mode_Is = register_mode(&newmode);
817 /* unsigned integer */
818 newmode.name = new_id_from_chars("Iu", 2);
821 newmode.modulo_shift = 32;
822 mode_Iu = register_mode(&newmode);
824 /* signed long integer */
825 newmode.name = new_id_from_chars("Ls", 2);
828 newmode.modulo_shift = 64;
829 mode_Ls = register_mode(&newmode);
831 /* unsigned long integer */
832 newmode.name = new_id_from_chars("Lu", 2);
835 newmode.modulo_shift = 64;
836 mode_Lu = register_mode(&newmode);
838 /* signed long long integer */
839 newmode.name = new_id_from_chars("LLs", 3);
842 newmode.modulo_shift = 128;
843 mode_LLs = register_mode(&newmode);
845 /* unsigned long long integer */
846 newmode.name = new_id_from_chars("LLu", 3);
849 newmode.modulo_shift = 128;
850 mode_LLu = register_mode(&newmode);
853 newmode.sort = irms_reference;
854 newmode.arithmetic = irma_twos_complement;
857 newmode.name = new_id_from_chars("P", 1);
860 newmode.modulo_shift = 32;
861 newmode.eq_signed = mode_Is;
862 newmode.eq_unsigned = mode_Iu;
863 mode_P = register_mode(&newmode);
865 /* set the machine specific modes to the predefined ones */
866 mode_P_code = mode_P;
867 mode_P_data = mode_P;
870 /* find a signed mode for an unsigned integer mode */
871 ir_mode *find_unsigned_mode(const ir_mode *mode)
875 /* allowed for reference mode */
876 if (mode->sort == irms_reference)
877 n.sort = irms_int_number;
879 assert(n.sort == irms_int_number);
881 return find_mode(&n);
884 /* find an unsigned mode for a signed integer mode */
885 ir_mode *find_signed_mode(const ir_mode *mode)
889 assert(mode->sort == irms_int_number);
891 return find_mode(&n);
894 /* finds a integer mode with 2*n bits for an integer mode with n bits. */
895 ir_mode *find_double_bits_int_mode(const ir_mode *mode)
899 assert(mode->sort == irms_int_number && mode->arithmetic == irma_twos_complement);
901 n.size = 2*mode->size;
902 return find_mode(&n);
906 * Returns non-zero if the given mode honors signed zero's, i.e.,
907 * a +0 and a -0 exists and handled differently.
909 int mode_honor_signed_zeros(const ir_mode *mode)
911 /* for floating point, we know that IEEE 754 has +0 and -0,
912 * but always handles it identical.
915 mode->sort == irms_float_number &&
916 mode->arithmetic != irma_ieee754;
920 * Returns non-zero if the given mode might overflow on unary Minus.
922 * This does NOT happen on IEEE 754.
924 int mode_overflow_on_unary_Minus(const ir_mode *mode)
926 if (mode->sort == irms_float_number)
927 return mode->arithmetic == irma_ieee754 ? 0 : 1;
932 * Returns non-zero if the mode has a reversed wrap-around
933 * logic, especially (a + x) - x == a.
935 * This is normally true for integer modes, not for floating
938 int mode_wrap_around(const ir_mode *mode)
940 /* FIXME: better would be an extra mode property */
941 return mode_is_int(mode);
945 * Returns non-zero if the cast from mode src to mode dst is a
946 * reinterpret cast (ie. only the bit pattern is reinterpreted,
947 * no conversion is done)
949 int is_reinterpret_cast(const ir_mode *src, const ir_mode *dst)
951 ir_mode_arithmetic ma;
955 if (get_mode_size_bits(src) != get_mode_size_bits(dst))
957 ma = get_mode_arithmetic(src);
958 if (ma != get_mode_arithmetic(dst))
961 return ma == irma_twos_complement || ma == irma_ones_complement;
964 void finish_mode(void)
966 obstack_free(&modes, 0);
967 DEL_ARR_F(mode_list);