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 default: return "<unknown>";
64 * Compare modes that don't need to have their code field
67 * TODO: Add other fields
69 static inline int modes_are_equal(const ir_mode *m, const ir_mode *n)
72 if (m->sort == n->sort &&
73 m->arithmetic == n->arithmetic &&
76 m->modulo_shift == n->modulo_shift &&
77 m->vector_elem == n->vector_elem)
84 * searches the modes obstack for the given mode and returns
85 * a pointer on an equal mode already in the array, NULL if
88 static ir_mode *find_mode(const ir_mode *m)
91 for (i = 0, n_modes = ARR_LEN(mode_list); i < n_modes; ++i) {
92 ir_mode *n = mode_list[i];
93 if (modes_are_equal(n, m))
100 * sets special values of modes
102 static void set_mode_values(ir_mode* mode)
104 switch (get_mode_sort(mode)) {
106 case irms_int_number:
107 case irms_float_number:
108 mode->min = get_tarval_min(mode);
109 mode->max = get_tarval_max(mode);
110 mode->null = get_tarval_null(mode);
111 mode->one = get_tarval_one(mode);
112 mode->minus_one = get_tarval_minus_one(mode);
113 if (get_mode_sort(mode) != irms_float_number) {
114 mode->all_one = get_tarval_all_one(mode);
116 mode->all_one = tarval_bad;
120 case irms_internal_boolean:
121 mode->min = tarval_b_false;
122 mode->max = tarval_b_true;
123 mode->null = tarval_b_false;
124 mode->one = tarval_b_true;
125 mode->minus_one = tarval_bad;
126 mode->all_one = tarval_b_true;
131 case irms_control_flow:
132 mode->min = tarval_bad;
133 mode->max = tarval_bad;
134 mode->null = tarval_bad;
135 mode->one = tarval_bad;
136 mode->minus_one = tarval_bad;
142 * globals defined in irmode.h
145 /* --- Predefined modes --- */
147 /* FIRM internal modes: */
155 /* predefined numerical modes: */
156 ir_mode *mode_F; /* float */
157 ir_mode *mode_D; /* double */
158 ir_mode *mode_E; /* long double */
160 ir_mode *mode_Bs; /* integral values, signed and unsigned */
161 ir_mode *mode_Bu; /* 8 bit */
162 ir_mode *mode_Hs; /* 16 bit */
164 ir_mode *mode_Is; /* 32 bit */
166 ir_mode *mode_Ls; /* 64 bit */
168 ir_mode *mode_LLs; /* 128 bit */
174 /* machine specific modes */
175 ir_mode *mode_P_code; /**< machine specific pointer mode for code addresses */
176 ir_mode *mode_P_data; /**< machine specific pointer mode for data addresses */
179 * functions defined in irmode.h
182 /* JNI access functions */
183 ir_mode *get_modeT(void) { return mode_T; }
184 ir_mode *get_modeF(void) { return mode_F; }
185 ir_mode *get_modeD(void) { return mode_D; }
186 ir_mode *get_modeE(void) { return mode_E; }
187 ir_mode *get_modeBs(void) { return mode_Bs; }
188 ir_mode *get_modeBu(void) { return mode_Bu; }
189 ir_mode *get_modeHs(void) { return mode_Hs; }
190 ir_mode *get_modeHu(void) { return mode_Hu; }
191 ir_mode *get_modeIs(void) { return mode_Is; }
192 ir_mode *get_modeIu(void) { return mode_Iu; }
193 ir_mode *get_modeLs(void) { return mode_Ls; }
194 ir_mode *get_modeLu(void) { return mode_Lu; }
195 ir_mode *get_modeLLs(void){ return mode_LLs; }
196 ir_mode *get_modeLLu(void){ return mode_LLu; }
197 ir_mode *get_modeb(void) { return mode_b; }
198 ir_mode *get_modeP(void) { return mode_P; }
199 ir_mode *get_modeX(void) { return mode_X; }
200 ir_mode *get_modeM(void) { return mode_M; }
201 ir_mode *get_modeBB(void) { return mode_BB; }
202 ir_mode *get_modeANY(void) { return mode_ANY; }
203 ir_mode *get_modeBAD(void) { return mode_BAD; }
206 ir_mode *(get_modeP_code)(void)
208 return _get_modeP_code();
211 ir_mode *(get_modeP_data)(void)
213 return _get_modeP_data();
216 void set_modeP_code(ir_mode *p)
218 assert(mode_is_reference(p));
222 void set_modeP_data(ir_mode *p)
224 assert(mode_is_reference(p));
230 * Registers a new mode.
232 * @param new_mode The new mode template.
234 static ir_mode *register_mode(const ir_mode *new_mode)
236 ir_mode *mode = NULL;
240 /* copy mode struct to modes array */
241 mode = (ir_mode *)obstack_copy(&modes, new_mode, sizeof(*mode));
242 ARR_APP1(ir_mode*, mode_list, mode);
244 mode->kind = k_ir_mode;
245 mode->type = new_type_primitive(mode);
247 /* add the new mode to the irp list of modes */
250 set_mode_values(mode);
252 hook_new_mode(new_mode, mode);
257 * Creates a new mode.
259 ir_mode *new_ir_mode(const char *name, ir_mode_sort sort, int bit_size, int sign,
260 ir_mode_arithmetic arithmetic, unsigned int modulo_shift)
263 ir_mode *mode = NULL;
265 mode_tmpl.name = new_id_from_str(name);
266 mode_tmpl.sort = sort;
267 mode_tmpl.size = bit_size;
268 mode_tmpl.sign = sign ? 1 : 0;
269 mode_tmpl.modulo_shift = (mode_tmpl.sort == irms_int_number ||
270 mode_tmpl.sort == irms_reference) ? modulo_shift : 0;
271 mode_tmpl.vector_elem = 1;
272 mode_tmpl.arithmetic = arithmetic;
273 mode_tmpl.link = NULL;
274 mode_tmpl.tv_priv = NULL;
276 mode = find_mode(&mode_tmpl);
278 hook_new_mode(&mode_tmpl, mode);
285 case irms_control_flow:
287 case irms_internal_boolean:
288 panic("internal modes cannot be user defined");
290 case irms_float_number:
291 case irms_int_number:
293 mode = register_mode(&mode_tmpl);
296 assert(mode != NULL);
301 * Creates a new vector mode.
303 ir_mode *new_ir_vector_mode(const char *name, ir_mode_sort sort, int bit_size, unsigned num_of_elem, int sign,
304 ir_mode_arithmetic arithmetic, unsigned int modulo_shift)
307 ir_mode *mode = NULL;
309 mode_tmpl.name = new_id_from_str(name);
310 mode_tmpl.sort = sort;
311 mode_tmpl.size = bit_size * num_of_elem;
312 mode_tmpl.sign = sign ? 1 : 0;
313 mode_tmpl.modulo_shift = (mode_tmpl.sort == irms_int_number) ? modulo_shift : 0;
314 mode_tmpl.vector_elem = num_of_elem;
315 mode_tmpl.arithmetic = arithmetic;
316 mode_tmpl.link = NULL;
317 mode_tmpl.tv_priv = NULL;
319 mode = find_mode(&mode_tmpl);
321 hook_new_mode(&mode_tmpl, mode);
325 if (num_of_elem <= 1) {
326 panic("vector modes should have at least 2 elements");
332 case irms_control_flow:
334 case irms_internal_boolean:
335 panic("internal modes cannot be user defined");
338 panic("only integer and floating point modes can be vectorized");
340 case irms_float_number:
341 panic("not yet implemented");
343 case irms_int_number:
344 mode = register_mode(&mode_tmpl);
346 assert(mode != NULL);
350 /* Functions for the direct access to all attributes of an ir_mode */
351 ident *(get_mode_ident)(const ir_mode *mode)
353 return _get_mode_ident(mode);
356 const char *get_mode_name(const ir_mode *mode)
358 return get_id_str(mode->name);
361 ir_mode_sort (get_mode_sort)(const ir_mode* mode)
363 return _get_mode_sort(mode);
366 unsigned (get_mode_size_bits)(const ir_mode *mode)
368 return _get_mode_size_bits(mode);
371 unsigned (get_mode_size_bytes)(const ir_mode *mode)
373 return _get_mode_size_bytes(mode);
376 int (get_mode_sign)(const ir_mode *mode)
378 return _get_mode_sign(mode);
381 ir_mode_arithmetic (get_mode_arithmetic)(const ir_mode *mode)
383 return get_mode_arithmetic(mode);
387 /* Attribute modulo shift specifies for modes of kind irms_int_number
388 * whether shift applies modulo to value of bits to shift. Asserts
389 * if mode is not irms_int_number.
391 unsigned int (get_mode_modulo_shift)(const ir_mode *mode)
393 return _get_mode_modulo_shift(mode);
396 unsigned int (get_mode_n_vector_elems)(const ir_mode *mode)
398 return _get_mode_vector_elems(mode);
401 void *(get_mode_link)(const ir_mode *mode)
403 return _get_mode_link(mode);
406 void (set_mode_link)(ir_mode *mode, void *l)
408 _set_mode_link(mode, l);
411 ir_tarval *get_mode_min(ir_mode *mode)
414 assert(mode_is_data(mode));
419 ir_tarval *get_mode_max(ir_mode *mode)
422 assert(mode_is_data(mode));
427 ir_tarval *get_mode_null(ir_mode *mode)
430 assert(mode_is_datab(mode));
435 ir_tarval *get_mode_one(ir_mode *mode)
438 assert(mode_is_datab(mode));
443 ir_tarval *get_mode_minus_one(ir_mode *mode)
446 assert(mode_is_data(mode));
448 return mode->minus_one;
451 ir_tarval *get_mode_all_one(ir_mode *mode)
454 assert(mode_is_datab(mode));
455 return mode->all_one;
458 ir_tarval *get_mode_infinite(ir_mode *mode)
461 assert(mode_is_float(mode));
463 return get_tarval_plus_inf(mode);
466 ir_tarval *get_mode_NAN(ir_mode *mode)
469 assert(mode_is_float(mode));
471 return get_tarval_nan(mode);
474 int is_mode(const void *thing)
476 return get_kind(thing) == k_ir_mode;
479 int (mode_is_signed)(const ir_mode *mode)
481 return _mode_is_signed(mode);
484 int (mode_is_float)(const ir_mode *mode)
486 return _mode_is_float(mode);
489 int (mode_is_int)(const ir_mode *mode)
491 return _mode_is_int(mode);
494 int (mode_is_reference)(const ir_mode *mode)
496 return _mode_is_reference(mode);
499 int (mode_is_num)(const ir_mode *mode)
501 return _mode_is_num(mode);
504 int (mode_is_data)(const ir_mode *mode)
506 return _mode_is_data(mode);
509 int (mode_is_datab)(const ir_mode *mode)
511 return _mode_is_datab(mode);
514 int (mode_is_dataM)(const ir_mode *mode)
516 return _mode_is_dataM(mode);
519 int (mode_is_float_vector)(const ir_mode *mode)
521 return _mode_is_float_vector(mode);
524 int (mode_is_int_vector)(const ir_mode *mode)
526 return _mode_is_int_vector(mode);
529 /* Returns true if sm can be converted to lm without loss. */
530 int smaller_mode(const ir_mode *sm, const ir_mode *lm)
532 int sm_bits, lm_bits;
537 if (sm == lm) return 1;
539 sm_bits = get_mode_size_bits(sm);
540 lm_bits = get_mode_size_bits(lm);
542 switch (get_mode_sort(sm)) {
543 case irms_int_number:
544 switch (get_mode_sort(lm)) {
545 case irms_int_number:
546 if (get_mode_arithmetic(sm) != get_mode_arithmetic(lm))
549 /* only two complement implemented */
550 assert(get_mode_arithmetic(sm) == irma_twos_complement);
552 /* integers are convertable if
553 * - both have the same sign and lm is the larger one
554 * - lm is the signed one and is at least two bits larger
555 * (one for the sign, one for the highest bit of sm)
556 * - sm & lm are two_complement and lm has greater or equal number of bits
558 if (mode_is_signed(sm)) {
559 if (!mode_is_signed(lm))
561 return sm_bits <= lm_bits;
563 if (mode_is_signed(lm)) {
564 return sm_bits < lm_bits;
566 return sm_bits <= lm_bits;
569 case irms_float_number:
570 /* int to float works if the float is large enough */
578 case irms_float_number:
579 if (get_mode_arithmetic(sm) == get_mode_arithmetic(lm)) {
580 if ( (get_mode_sort(lm) == irms_float_number)
581 && (get_mode_size_bits(lm) >= get_mode_size_bits(sm)) )
587 /* do exist machines out there with different pointer lengths ?*/
590 case irms_internal_boolean:
591 return mode_is_int(lm);
601 /* Returns true if a value of mode sm can be converted into mode lm
602 and backwards without loss. */
603 int values_in_mode(const ir_mode *sm, const ir_mode *lm)
605 ir_mode_arithmetic arith;
610 if (sm == lm) return 1;
613 return mode_is_int(lm);
615 arith = get_mode_arithmetic(sm);
616 if (arith != get_mode_arithmetic(lm))
620 case irma_twos_complement:
622 return get_mode_size_bits(sm) <= get_mode_size_bits(lm);
629 /* Return the signed integer equivalent mode for an reference mode. */
630 ir_mode *get_reference_mode_signed_eq(ir_mode *mode)
632 assert(mode_is_reference(mode));
633 return mode->eq_signed;
636 /* Sets the signed integer equivalent mode for an reference mode. */
637 void set_reference_mode_signed_eq(ir_mode *ref_mode, ir_mode *int_mode)
639 assert(mode_is_reference(ref_mode));
640 assert(mode_is_int(int_mode));
641 ref_mode->eq_signed = int_mode;
644 /* Return the unsigned integer equivalent mode for an reference mode. */
645 ir_mode *get_reference_mode_unsigned_eq(ir_mode *mode)
647 assert(mode_is_reference(mode));
648 return mode->eq_unsigned;
651 /* Sets the unsigned integer equivalent mode for an reference mode. */
652 void set_reference_mode_unsigned_eq(ir_mode *ref_mode, ir_mode *int_mode)
654 assert(mode_is_reference(ref_mode));
655 assert(mode_is_int(int_mode));
656 ref_mode->eq_unsigned = int_mode;
659 /* initialization, build the default modes */
664 obstack_init(&modes);
665 mode_list = NEW_ARR_F(ir_mode*, 0);
667 /* initialize predefined modes */
670 newmode.arithmetic = irma_none;
673 newmode.modulo_shift = 0;
674 newmode.vector_elem = 0;
675 newmode.eq_signed = NULL;
676 newmode.eq_unsigned = NULL;
678 newmode.tv_priv = NULL;
680 /* Control Flow Modes*/
681 newmode.sort = irms_control_flow;
684 newmode.name = new_id_from_chars("BB", 2);
685 mode_BB = register_mode(&newmode);
688 newmode.name = new_id_from_chars("X", 1);
689 mode_X = register_mode(&newmode);
692 newmode.sort = irms_memory;
695 newmode.name = new_id_from_chars("M", 1);
696 mode_M = register_mode(&newmode);
698 /* Auxiliary Modes */
699 newmode.sort = irms_auxiliary,
702 newmode.name = new_id_from_chars("T", 1);
703 mode_T = register_mode(&newmode);
706 newmode.name = new_id_from_chars("ANY", 3);
707 mode_ANY = register_mode(&newmode);
710 newmode.name = new_id_from_chars("BAD", 3);
711 mode_BAD = register_mode(&newmode);
713 /* Internal Boolean Modes */
714 newmode.sort = irms_internal_boolean;
717 newmode.name = new_id_from_chars("b", 1);
718 mode_b = register_mode(&newmode);
721 newmode.vector_elem = 1;
723 /* Float Number Modes */
724 newmode.sort = irms_float_number;
725 newmode.arithmetic = irma_ieee754;
728 newmode.name = new_id_from_chars("F", 1);
731 mode_F = register_mode(&newmode);
734 newmode.name = new_id_from_chars("D", 1);
737 mode_D = register_mode(&newmode);
740 newmode.name = new_id_from_chars("E", 1);
742 /* note that the tarval module is calculating with 80 bits, but we use
743 * 96 bits, as that is what will be stored to memory by most hardware */
745 mode_E = register_mode(&newmode);
747 /* Integer Number Modes */
748 newmode.sort = irms_int_number;
749 newmode.arithmetic = irma_twos_complement;
752 newmode.name = new_id_from_chars("Bs", 2);
755 newmode.modulo_shift = 32;
756 mode_Bs = register_mode(&newmode);
759 newmode.name = new_id_from_chars("Bu", 2);
760 newmode.arithmetic = irma_twos_complement;
763 newmode.modulo_shift = 32;
764 mode_Bu = register_mode(&newmode);
766 /* signed short integer */
767 newmode.name = new_id_from_chars("Hs", 2);
770 newmode.modulo_shift = 32;
771 mode_Hs = register_mode(&newmode);
773 /* unsigned short integer */
774 newmode.name = new_id_from_chars("Hu", 2);
777 newmode.modulo_shift = 32;
778 mode_Hu = register_mode(&newmode);
781 newmode.name = new_id_from_chars("Is", 2);
784 newmode.modulo_shift = 32;
785 mode_Is = register_mode(&newmode);
787 /* unsigned integer */
788 newmode.name = new_id_from_chars("Iu", 2);
791 newmode.modulo_shift = 32;
792 mode_Iu = register_mode(&newmode);
794 /* signed long integer */
795 newmode.name = new_id_from_chars("Ls", 2);
798 newmode.modulo_shift = 64;
799 mode_Ls = register_mode(&newmode);
801 /* unsigned long integer */
802 newmode.name = new_id_from_chars("Lu", 2);
805 newmode.modulo_shift = 64;
806 mode_Lu = register_mode(&newmode);
808 /* signed long long integer */
809 newmode.name = new_id_from_chars("LLs", 3);
812 newmode.modulo_shift = 128;
813 mode_LLs = register_mode(&newmode);
815 /* unsigned long long integer */
816 newmode.name = new_id_from_chars("LLu", 3);
819 newmode.modulo_shift = 128;
820 mode_LLu = register_mode(&newmode);
823 newmode.sort = irms_reference;
824 newmode.arithmetic = irma_twos_complement;
827 newmode.name = new_id_from_chars("P", 1);
830 newmode.modulo_shift = 32;
831 newmode.eq_signed = mode_Is;
832 newmode.eq_unsigned = mode_Iu;
833 mode_P = register_mode(&newmode);
835 /* set the machine specific modes to the predefined ones */
836 mode_P_code = mode_P;
837 mode_P_data = mode_P;
840 /* find a signed mode for an unsigned integer mode */
841 ir_mode *find_unsigned_mode(const ir_mode *mode)
845 /* allowed for reference mode */
846 if (mode->sort == irms_reference)
847 n.sort = irms_int_number;
849 assert(n.sort == irms_int_number);
851 return find_mode(&n);
854 /* find an unsigned mode for a signed integer mode */
855 ir_mode *find_signed_mode(const ir_mode *mode)
859 assert(mode->sort == irms_int_number);
861 return find_mode(&n);
864 /* finds a integer mode with 2*n bits for an integer mode with n bits. */
865 ir_mode *find_double_bits_int_mode(const ir_mode *mode)
869 assert(mode->sort == irms_int_number && mode->arithmetic == irma_twos_complement);
871 n.size = 2*mode->size;
872 return find_mode(&n);
876 * Returns non-zero if the given mode honors signed zero's, i.e.,
877 * a +0 and a -0 exists and handled differently.
879 int mode_honor_signed_zeros(const ir_mode *mode)
881 /* for floating point, we know that IEEE 754 has +0 and -0,
882 * but always handles it identical.
885 mode->sort == irms_float_number &&
886 mode->arithmetic != irma_ieee754;
890 * Returns non-zero if the given mode might overflow on unary Minus.
892 * This does NOT happen on IEEE 754.
894 int mode_overflow_on_unary_Minus(const ir_mode *mode)
896 if (mode->sort == irms_float_number)
897 return mode->arithmetic == irma_ieee754 ? 0 : 1;
902 * Returns non-zero if the mode has a reversed wrap-around
903 * logic, especially (a + x) - x == a.
905 * This is normally true for integer modes, not for floating
908 int mode_wrap_around(const ir_mode *mode)
910 /* FIXME: better would be an extra mode property */
911 return mode_is_int(mode);
915 * Returns non-zero if the cast from mode src to mode dst is a
916 * reinterpret cast (ie. only the bit pattern is reinterpreted,
917 * no conversion is done)
919 int is_reinterpret_cast(const ir_mode *src, const ir_mode *dst)
921 ir_mode_arithmetic ma;
925 if (get_mode_size_bits(src) != get_mode_size_bits(dst))
927 ma = get_mode_arithmetic(src);
928 if (ma != get_mode_arithmetic(dst))
931 return ma == irma_twos_complement;
934 ir_type *(get_type_for_mode) (const ir_mode *mode)
936 return get_type_for_mode_(mode);
939 void finish_mode(void)
941 obstack_free(&modes, 0);
942 DEL_ARR_F(mode_list);