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));
233 * Registers a new mode.
235 * @param new_mode The new mode template.
237 static ir_mode *register_mode(const ir_mode *new_mode)
239 ir_mode *mode = NULL;
243 /* copy mode struct to modes array */
244 mode = (ir_mode *)obstack_copy(&modes, new_mode, sizeof(*mode));
245 ARR_APP1(ir_mode*, mode_list, mode);
247 mode->kind = k_ir_mode;
248 mode->type = new_type_primitive(mode);
250 /* add the new mode to the irp list of modes */
253 set_mode_values(mode);
255 hook_new_mode(new_mode, mode);
260 * Creates a new mode.
262 ir_mode *new_ir_mode(const char *name, ir_mode_sort sort, int bit_size, int sign,
263 ir_mode_arithmetic arithmetic, unsigned int modulo_shift)
266 ir_mode *mode = NULL;
268 mode_tmpl.name = new_id_from_str(name);
269 mode_tmpl.sort = sort;
270 mode_tmpl.size = bit_size;
271 mode_tmpl.sign = sign ? 1 : 0;
272 mode_tmpl.modulo_shift = (mode_tmpl.sort == irms_int_number ||
273 mode_tmpl.sort == irms_reference) ? modulo_shift : 0;
274 mode_tmpl.vector_elem = 1;
275 mode_tmpl.arithmetic = arithmetic;
276 mode_tmpl.link = NULL;
277 mode_tmpl.tv_priv = NULL;
279 mode = find_mode(&mode_tmpl);
281 hook_new_mode(&mode_tmpl, mode);
288 case irms_control_flow:
290 case irms_internal_boolean:
291 panic("internal modes cannot be user defined");
293 case irms_float_number:
294 case irms_int_number:
296 mode = register_mode(&mode_tmpl);
299 assert(mode != NULL);
304 * Creates a new vector mode.
306 ir_mode *new_ir_vector_mode(const char *name, ir_mode_sort sort, int bit_size, unsigned num_of_elem, int sign,
307 ir_mode_arithmetic arithmetic, unsigned int modulo_shift)
310 ir_mode *mode = NULL;
312 mode_tmpl.name = new_id_from_str(name);
313 mode_tmpl.sort = sort;
314 mode_tmpl.size = bit_size * num_of_elem;
315 mode_tmpl.sign = sign ? 1 : 0;
316 mode_tmpl.modulo_shift = (mode_tmpl.sort == irms_int_number) ? modulo_shift : 0;
317 mode_tmpl.vector_elem = num_of_elem;
318 mode_tmpl.arithmetic = arithmetic;
319 mode_tmpl.link = NULL;
320 mode_tmpl.tv_priv = NULL;
322 mode = find_mode(&mode_tmpl);
324 hook_new_mode(&mode_tmpl, mode);
328 if (num_of_elem <= 1) {
329 panic("vector modes should have at least 2 elements");
335 case irms_control_flow:
337 case irms_internal_boolean:
338 panic("internal modes cannot be user defined");
341 panic("only integer and floating point modes can be vectorized");
343 case irms_float_number:
344 panic("not yet implemented");
346 case irms_int_number:
347 mode = register_mode(&mode_tmpl);
349 assert(mode != NULL);
353 /* Functions for the direct access to all attributes of an ir_mode */
354 ident *(get_mode_ident)(const ir_mode *mode)
356 return _get_mode_ident(mode);
359 const char *get_mode_name(const ir_mode *mode)
361 return get_id_str(mode->name);
364 ir_mode_sort (get_mode_sort)(const ir_mode* mode)
366 return _get_mode_sort(mode);
369 unsigned (get_mode_size_bits)(const ir_mode *mode)
371 return _get_mode_size_bits(mode);
374 unsigned (get_mode_size_bytes)(const ir_mode *mode)
376 return _get_mode_size_bytes(mode);
379 int (get_mode_sign)(const ir_mode *mode)
381 return _get_mode_sign(mode);
384 ir_mode_arithmetic (get_mode_arithmetic)(const ir_mode *mode)
386 return get_mode_arithmetic(mode);
390 /* Attribute modulo shift specifies for modes of kind irms_int_number
391 * whether shift applies modulo to value of bits to shift. Asserts
392 * if mode is not irms_int_number.
394 unsigned int (get_mode_modulo_shift)(const ir_mode *mode)
396 return _get_mode_modulo_shift(mode);
399 unsigned int (get_mode_n_vector_elems)(const ir_mode *mode)
401 return _get_mode_vector_elems(mode);
404 void *(get_mode_link)(const ir_mode *mode)
406 return _get_mode_link(mode);
409 void (set_mode_link)(ir_mode *mode, void *l)
411 _set_mode_link(mode, l);
414 ir_tarval *get_mode_min(ir_mode *mode)
417 assert(mode_is_data(mode));
422 ir_tarval *get_mode_max(ir_mode *mode)
425 assert(mode_is_data(mode));
430 ir_tarval *get_mode_null(ir_mode *mode)
433 assert(mode_is_datab(mode));
438 ir_tarval *get_mode_one(ir_mode *mode)
441 assert(mode_is_datab(mode));
446 ir_tarval *get_mode_minus_one(ir_mode *mode)
449 assert(mode_is_data(mode));
451 return mode->minus_one;
454 ir_tarval *get_mode_all_one(ir_mode *mode)
457 assert(mode_is_datab(mode));
458 return mode->all_one;
461 ir_tarval *get_mode_infinite(ir_mode *mode)
464 assert(mode_is_float(mode));
466 return get_tarval_plus_inf(mode);
469 ir_tarval *get_mode_NAN(ir_mode *mode)
472 assert(mode_is_float(mode));
474 return get_tarval_nan(mode);
477 int is_mode(const void *thing)
479 return get_kind(thing) == k_ir_mode;
482 int (mode_is_signed)(const ir_mode *mode)
484 return _mode_is_signed(mode);
487 int (mode_is_float)(const ir_mode *mode)
489 return _mode_is_float(mode);
492 int (mode_is_int)(const ir_mode *mode)
494 return _mode_is_int(mode);
497 int (mode_is_reference)(const ir_mode *mode)
499 return _mode_is_reference(mode);
502 int (mode_is_num)(const ir_mode *mode)
504 return _mode_is_num(mode);
507 int (mode_is_data)(const ir_mode *mode)
509 return _mode_is_data(mode);
512 int (mode_is_datab)(const ir_mode *mode)
514 return _mode_is_datab(mode);
517 int (mode_is_dataM)(const ir_mode *mode)
519 return _mode_is_dataM(mode);
522 int (mode_is_float_vector)(const ir_mode *mode)
524 return _mode_is_float_vector(mode);
527 int (mode_is_int_vector)(const ir_mode *mode)
529 return _mode_is_int_vector(mode);
532 /* Returns true if sm can be converted to lm without loss. */
533 int smaller_mode(const ir_mode *sm, const ir_mode *lm)
535 int sm_bits, lm_bits;
540 if (sm == lm) return 1;
542 sm_bits = get_mode_size_bits(sm);
543 lm_bits = get_mode_size_bits(lm);
545 switch (get_mode_sort(sm)) {
546 case irms_int_number:
547 switch (get_mode_sort(lm)) {
548 case irms_int_number:
549 if (get_mode_arithmetic(sm) != get_mode_arithmetic(lm))
552 /* only two complement implemented */
553 assert(get_mode_arithmetic(sm) == irma_twos_complement);
555 /* integers are convertable if
556 * - both have the same sign and lm is the larger one
557 * - lm is the signed one and is at least two bits larger
558 * (one for the sign, one for the highest bit of sm)
559 * - sm & lm are two_complement and lm has greater or equal number of bits
561 if (mode_is_signed(sm)) {
562 if (!mode_is_signed(lm))
564 return sm_bits <= lm_bits;
566 if (mode_is_signed(lm)) {
567 return sm_bits < lm_bits;
569 return sm_bits <= lm_bits;
572 case irms_float_number:
573 /* int to float works if the float is large enough */
581 case irms_float_number:
582 if (get_mode_arithmetic(sm) == get_mode_arithmetic(lm)) {
583 if ( (get_mode_sort(lm) == irms_float_number)
584 && (get_mode_size_bits(lm) >= get_mode_size_bits(sm)) )
590 /* do exist machines out there with different pointer lengths ?*/
593 case irms_internal_boolean:
594 return mode_is_int(lm);
604 /* Returns true if a value of mode sm can be converted into mode lm
605 and backwards without loss. */
606 int values_in_mode(const ir_mode *sm, const ir_mode *lm)
608 ir_mode_arithmetic arith;
613 if (sm == lm) return 1;
616 return mode_is_int(lm);
618 arith = get_mode_arithmetic(sm);
619 if (arith != get_mode_arithmetic(lm))
623 case irma_twos_complement:
625 return get_mode_size_bits(sm) <= get_mode_size_bits(lm);
632 /* Return the signed integer equivalent mode for an reference mode. */
633 ir_mode *get_reference_mode_signed_eq(ir_mode *mode)
635 assert(mode_is_reference(mode));
636 return mode->eq_signed;
639 /* Sets the signed integer equivalent mode for an reference mode. */
640 void set_reference_mode_signed_eq(ir_mode *ref_mode, ir_mode *int_mode)
642 assert(mode_is_reference(ref_mode));
643 assert(mode_is_int(int_mode));
644 ref_mode->eq_signed = int_mode;
647 /* Return the unsigned integer equivalent mode for an reference mode. */
648 ir_mode *get_reference_mode_unsigned_eq(ir_mode *mode)
650 assert(mode_is_reference(mode));
651 return mode->eq_unsigned;
654 /* Sets the unsigned integer equivalent mode for an reference mode. */
655 void set_reference_mode_unsigned_eq(ir_mode *ref_mode, ir_mode *int_mode)
657 assert(mode_is_reference(ref_mode));
658 assert(mode_is_int(int_mode));
659 ref_mode->eq_unsigned = int_mode;
662 /* initialization, build the default modes */
667 obstack_init(&modes);
668 mode_list = NEW_ARR_F(ir_mode*, 0);
670 /* initialize predefined modes */
673 newmode.arithmetic = irma_none;
676 newmode.modulo_shift = 0;
677 newmode.vector_elem = 0;
678 newmode.eq_signed = NULL;
679 newmode.eq_unsigned = NULL;
681 newmode.tv_priv = NULL;
683 /* Control Flow Modes*/
684 newmode.sort = irms_control_flow;
687 newmode.name = new_id_from_chars("BB", 2);
688 mode_BB = register_mode(&newmode);
691 newmode.name = new_id_from_chars("X", 1);
692 mode_X = register_mode(&newmode);
695 newmode.sort = irms_memory;
698 newmode.name = new_id_from_chars("M", 1);
699 mode_M = register_mode(&newmode);
701 /* Auxiliary Modes */
702 newmode.sort = irms_auxiliary,
705 newmode.name = new_id_from_chars("T", 1);
706 mode_T = register_mode(&newmode);
709 newmode.name = new_id_from_chars("ANY", 3);
710 mode_ANY = register_mode(&newmode);
713 newmode.name = new_id_from_chars("BAD", 3);
714 mode_BAD = register_mode(&newmode);
716 /* Internal Boolean Modes */
717 newmode.sort = irms_internal_boolean;
720 newmode.name = new_id_from_chars("b", 1);
721 mode_b = register_mode(&newmode);
724 newmode.vector_elem = 1;
726 /* Float Number Modes */
727 newmode.sort = irms_float_number;
728 newmode.arithmetic = irma_ieee754;
731 newmode.name = new_id_from_chars("F", 1);
734 mode_F = register_mode(&newmode);
737 newmode.name = new_id_from_chars("D", 1);
740 mode_D = register_mode(&newmode);
743 newmode.name = new_id_from_chars("E", 1);
745 /* note that the tarval module is calculating with 80 bits, but we use
746 * 96 bits, as that is what will be stored to memory by most hardware */
748 mode_E = register_mode(&newmode);
750 /* Integer Number Modes */
751 newmode.sort = irms_int_number;
752 newmode.arithmetic = irma_twos_complement;
755 newmode.name = new_id_from_chars("Bs", 2);
758 newmode.modulo_shift = 32;
759 mode_Bs = register_mode(&newmode);
762 newmode.name = new_id_from_chars("Bu", 2);
763 newmode.arithmetic = irma_twos_complement;
766 newmode.modulo_shift = 32;
767 mode_Bu = register_mode(&newmode);
769 /* signed short integer */
770 newmode.name = new_id_from_chars("Hs", 2);
773 newmode.modulo_shift = 32;
774 mode_Hs = register_mode(&newmode);
776 /* unsigned short integer */
777 newmode.name = new_id_from_chars("Hu", 2);
780 newmode.modulo_shift = 32;
781 mode_Hu = register_mode(&newmode);
784 newmode.name = new_id_from_chars("Is", 2);
787 newmode.modulo_shift = 32;
788 mode_Is = register_mode(&newmode);
790 /* unsigned integer */
791 newmode.name = new_id_from_chars("Iu", 2);
794 newmode.modulo_shift = 32;
795 mode_Iu = register_mode(&newmode);
797 /* signed long integer */
798 newmode.name = new_id_from_chars("Ls", 2);
801 newmode.modulo_shift = 64;
802 mode_Ls = register_mode(&newmode);
804 /* unsigned long integer */
805 newmode.name = new_id_from_chars("Lu", 2);
808 newmode.modulo_shift = 64;
809 mode_Lu = register_mode(&newmode);
811 /* signed long long integer */
812 newmode.name = new_id_from_chars("LLs", 3);
815 newmode.modulo_shift = 128;
816 mode_LLs = register_mode(&newmode);
818 /* unsigned long long integer */
819 newmode.name = new_id_from_chars("LLu", 3);
822 newmode.modulo_shift = 128;
823 mode_LLu = register_mode(&newmode);
826 newmode.sort = irms_reference;
827 newmode.arithmetic = irma_twos_complement;
830 newmode.name = new_id_from_chars("P", 1);
833 newmode.modulo_shift = 32;
834 newmode.eq_signed = mode_Is;
835 newmode.eq_unsigned = mode_Iu;
836 mode_P = register_mode(&newmode);
838 /* set the machine specific modes to the predefined ones */
839 mode_P_code = mode_P;
840 mode_P_data = mode_P;
843 /* find a signed mode for an unsigned integer mode */
844 ir_mode *find_unsigned_mode(const ir_mode *mode)
848 /* allowed for reference mode */
849 if (mode->sort == irms_reference)
850 n.sort = irms_int_number;
852 assert(n.sort == irms_int_number);
854 return find_mode(&n);
857 /* find an unsigned mode for a signed integer mode */
858 ir_mode *find_signed_mode(const ir_mode *mode)
862 assert(mode->sort == irms_int_number);
864 return find_mode(&n);
867 /* finds a integer mode with 2*n bits for an integer mode with n bits. */
868 ir_mode *find_double_bits_int_mode(const ir_mode *mode)
872 assert(mode->sort == irms_int_number && mode->arithmetic == irma_twos_complement);
874 n.size = 2*mode->size;
875 return find_mode(&n);
879 * Returns non-zero if the given mode honors signed zero's, i.e.,
880 * a +0 and a -0 exists and handled differently.
882 int mode_honor_signed_zeros(const ir_mode *mode)
884 /* for floating point, we know that IEEE 754 has +0 and -0,
885 * but always handles it identical.
888 mode->sort == irms_float_number &&
889 mode->arithmetic != irma_ieee754;
893 * Returns non-zero if the given mode might overflow on unary Minus.
895 * This does NOT happen on IEEE 754.
897 int mode_overflow_on_unary_Minus(const ir_mode *mode)
899 if (mode->sort == irms_float_number)
900 return mode->arithmetic == irma_ieee754 ? 0 : 1;
905 * Returns non-zero if the mode has a reversed wrap-around
906 * logic, especially (a + x) - x == a.
908 * This is normally true for integer modes, not for floating
911 int mode_wrap_around(const ir_mode *mode)
913 /* FIXME: better would be an extra mode property */
914 return mode_is_int(mode);
918 * Returns non-zero if the cast from mode src to mode dst is a
919 * reinterpret cast (ie. only the bit pattern is reinterpreted,
920 * no conversion is done)
922 int is_reinterpret_cast(const ir_mode *src, const ir_mode *dst)
924 ir_mode_arithmetic ma;
928 if (get_mode_size_bits(src) != get_mode_size_bits(dst))
930 ma = get_mode_arithmetic(src);
931 if (ma != get_mode_arithmetic(dst))
934 return ma == irma_twos_complement || ma == irma_ones_complement;
937 ir_type *(get_type_for_mode) (const ir_mode *mode)
939 return get_type_for_mode_(mode);
942 void finish_mode(void)
944 obstack_free(&modes, 0);
945 DEL_ARR_F(mode_list);