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
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);
56 X(irma_ones_complement);
60 default: return "<unknown>";
66 * Compare modes that don't need to have their code field
69 * TODO: Add other fields
71 static inline int modes_are_equal(const ir_mode *m, const ir_mode *n)
74 if (m->sort == n->sort &&
75 m->arithmetic == n->arithmetic &&
78 m->modulo_shift == n->modulo_shift &&
79 m->vector_elem == n->vector_elem)
86 * searches the modes obstack for the given mode and returns
87 * a pointer on an equal mode already in the array, NULL if
90 static ir_mode *find_mode(const ir_mode *m)
93 for (i = ARR_LEN(mode_list) - 1; i >= 0; --i) {
94 ir_mode *n = mode_list[i];
95 if (modes_are_equal(n, m))
101 #ifdef FIRM_STATISTICS
102 /* return the mode index, only needed for statistics */
103 int stat_find_mode_index(const ir_mode *m)
106 for (i = ARR_LEN(mode_list) - 1; i >= 0; --i) {
107 ir_mode *n = mode_list[i];
108 if (modes_are_equal(n, m))
114 /* return the mode for a given index, only needed for statistics */
115 ir_mode *stat_mode_for_index(int idx)
117 if (0 <= idx && idx < ARR_LEN(mode_list))
118 return mode_list[idx];
124 * sets special values of modes
126 static void set_mode_values(ir_mode* mode)
128 switch (get_mode_sort(mode)) {
130 case irms_int_number:
131 case irms_float_number:
132 mode->min = get_tarval_min(mode);
133 mode->max = get_tarval_max(mode);
134 mode->null = get_tarval_null(mode);
135 mode->one = get_tarval_one(mode);
136 mode->minus_one = get_tarval_minus_one(mode);
137 if (get_mode_sort(mode) != irms_float_number) {
138 mode->all_one = get_tarval_all_one(mode);
140 mode->all_one = tarval_bad;
144 case irms_internal_boolean:
145 mode->min = tarval_b_false;
146 mode->max = tarval_b_true;
147 mode->null = tarval_b_false;
148 mode->one = tarval_b_true;
149 mode->minus_one = tarval_bad;
150 mode->all_one = tarval_b_true;
155 case irms_control_flow:
156 mode->min = tarval_bad;
157 mode->max = tarval_bad;
158 mode->null = tarval_bad;
159 mode->one = tarval_bad;
160 mode->minus_one = tarval_bad;
166 * globals defined in irmode.h
169 /* --- Predefined modes --- */
171 /* FIRM internal modes: */
179 /* predefined numerical modes: */
180 ir_mode *mode_F; /* float */
181 ir_mode *mode_D; /* double */
182 ir_mode *mode_E; /* long double */
184 ir_mode *mode_Bs; /* integral values, signed and unsigned */
185 ir_mode *mode_Bu; /* 8 bit */
186 ir_mode *mode_Hs; /* 16 bit */
188 ir_mode *mode_Is; /* 32 bit */
190 ir_mode *mode_Ls; /* 64 bit */
192 ir_mode *mode_LLs; /* 128 bit */
198 /* machine specific modes */
199 ir_mode *mode_P_code; /**< machine specific pointer mode for code addresses */
200 ir_mode *mode_P_data; /**< machine specific pointer mode for data addresses */
203 * functions defined in irmode.h
206 /* JNI access functions */
207 ir_mode *get_modeT(void) { return mode_T; }
208 ir_mode *get_modeF(void) { return mode_F; }
209 ir_mode *get_modeD(void) { return mode_D; }
210 ir_mode *get_modeE(void) { return mode_E; }
211 ir_mode *get_modeBs(void) { return mode_Bs; }
212 ir_mode *get_modeBu(void) { return mode_Bu; }
213 ir_mode *get_modeHs(void) { return mode_Hs; }
214 ir_mode *get_modeHu(void) { return mode_Hu; }
215 ir_mode *get_modeIs(void) { return mode_Is; }
216 ir_mode *get_modeIu(void) { return mode_Iu; }
217 ir_mode *get_modeLs(void) { return mode_Ls; }
218 ir_mode *get_modeLu(void) { return mode_Lu; }
219 ir_mode *get_modeLLs(void){ return mode_LLs; }
220 ir_mode *get_modeLLu(void){ return mode_LLu; }
221 ir_mode *get_modeb(void) { return mode_b; }
222 ir_mode *get_modeP(void) { return mode_P; }
223 ir_mode *get_modeX(void) { return mode_X; }
224 ir_mode *get_modeM(void) { return mode_M; }
225 ir_mode *get_modeBB(void) { return mode_BB; }
226 ir_mode *get_modeANY(void) { return mode_ANY; }
227 ir_mode *get_modeBAD(void) { return mode_BAD; }
230 ir_mode *(get_modeP_code)(void)
232 return _get_modeP_code();
235 ir_mode *(get_modeP_data)(void)
237 return _get_modeP_data();
240 void set_modeP_code(ir_mode *p)
242 assert(mode_is_reference(p));
246 void set_modeP_data(ir_mode *p)
248 assert(mode_is_reference(p));
253 * Registers a new mode.
255 * @param new_mode The new mode template.
257 static ir_mode *register_mode(const ir_mode *new_mode)
259 ir_mode *mode = NULL;
263 /* copy mode struct to modes array */
264 mode = (ir_mode *)obstack_copy(&modes, new_mode, sizeof(*mode));
265 ARR_APP1(ir_mode*, mode_list, mode);
267 mode->kind = k_ir_mode;
268 mode->type = new_type_primitive(mode);
270 /* add the new mode to the irp list of modes */
273 set_mode_values(mode);
275 hook_new_mode(new_mode, mode);
280 * Creates a new mode.
282 ir_mode *new_ir_mode(const char *name, ir_mode_sort sort, int bit_size, int sign,
283 ir_mode_arithmetic arithmetic, unsigned int modulo_shift)
286 ir_mode *mode = NULL;
288 mode_tmpl.name = new_id_from_str(name);
289 mode_tmpl.sort = sort;
290 mode_tmpl.size = bit_size;
291 mode_tmpl.sign = sign ? 1 : 0;
292 mode_tmpl.modulo_shift = (mode_tmpl.sort == irms_int_number ||
293 mode_tmpl.sort == irms_reference) ? modulo_shift : 0;
294 mode_tmpl.vector_elem = 1;
295 mode_tmpl.arithmetic = arithmetic;
296 mode_tmpl.link = NULL;
297 mode_tmpl.tv_priv = NULL;
299 mode = find_mode(&mode_tmpl);
301 hook_new_mode(&mode_tmpl, mode);
308 case irms_control_flow:
310 case irms_internal_boolean:
311 panic("internal modes cannot be user defined");
313 case irms_float_number:
314 case irms_int_number:
316 mode = register_mode(&mode_tmpl);
319 assert(mode != NULL);
324 * Creates a new vector mode.
326 ir_mode *new_ir_vector_mode(const char *name, ir_mode_sort sort, int bit_size, unsigned num_of_elem, int sign,
327 ir_mode_arithmetic arithmetic, unsigned int modulo_shift)
330 ir_mode *mode = NULL;
332 mode_tmpl.name = new_id_from_str(name);
333 mode_tmpl.sort = sort;
334 mode_tmpl.size = bit_size * num_of_elem;
335 mode_tmpl.sign = sign ? 1 : 0;
336 mode_tmpl.modulo_shift = (mode_tmpl.sort == irms_int_number) ? modulo_shift : 0;
337 mode_tmpl.vector_elem = num_of_elem;
338 mode_tmpl.arithmetic = arithmetic;
339 mode_tmpl.link = NULL;
340 mode_tmpl.tv_priv = NULL;
342 mode = find_mode(&mode_tmpl);
344 hook_new_mode(&mode_tmpl, mode);
348 if (num_of_elem <= 1) {
349 assert(0 && "vector modes should have at least 2 elements");
356 case irms_control_flow:
358 case irms_internal_boolean:
359 panic("internal modes cannot be user defined");
362 panic("only integer and floating point modes can be vectorized");
364 case irms_float_number:
365 panic("not yet implemented");
367 case irms_int_number:
368 mode = register_mode(&mode_tmpl);
370 assert(mode != NULL);
374 /* Functions for the direct access to all attributes of an ir_mode */
375 ident *(get_mode_ident)(const ir_mode *mode)
377 return _get_mode_ident(mode);
380 const char *get_mode_name(const ir_mode *mode)
382 return get_id_str(mode->name);
385 ir_mode_sort (get_mode_sort)(const ir_mode* mode)
387 return _get_mode_sort(mode);
390 unsigned (get_mode_size_bits)(const ir_mode *mode)
392 return _get_mode_size_bits(mode);
395 unsigned (get_mode_size_bytes)(const ir_mode *mode)
397 return _get_mode_size_bytes(mode);
400 int (get_mode_sign)(const ir_mode *mode)
402 return _get_mode_sign(mode);
405 ir_mode_arithmetic (get_mode_arithmetic)(const ir_mode *mode)
407 return get_mode_arithmetic(mode);
411 /* Attribute modulo shift specifies for modes of kind irms_int_number
412 * whether shift applies modulo to value of bits to shift. Asserts
413 * if mode is not irms_int_number.
415 unsigned int (get_mode_modulo_shift)(const ir_mode *mode)
417 return _get_mode_modulo_shift(mode);
420 unsigned int (get_mode_n_vector_elems)(const ir_mode *mode)
422 return _get_mode_vector_elems(mode);
425 void *(get_mode_link)(const ir_mode *mode)
427 return _get_mode_link(mode);
430 void (set_mode_link)(ir_mode *mode, void *l)
432 _set_mode_link(mode, l);
435 tarval *get_mode_min(ir_mode *mode)
438 assert(mode_is_data(mode));
443 tarval *get_mode_max(ir_mode *mode)
446 assert(mode_is_data(mode));
451 tarval *get_mode_null(ir_mode *mode)
454 assert(mode_is_datab(mode));
459 tarval *get_mode_one(ir_mode *mode)
462 assert(mode_is_datab(mode));
467 tarval *get_mode_minus_one(ir_mode *mode)
470 assert(mode_is_data(mode));
472 return mode->minus_one;
475 tarval *get_mode_all_one(ir_mode *mode)
478 assert(mode_is_datab(mode));
479 return mode->all_one;
482 tarval *get_mode_infinite(ir_mode *mode)
485 assert(mode_is_float(mode));
487 return get_tarval_plus_inf(mode);
490 tarval *get_mode_NAN(ir_mode *mode)
493 assert(mode_is_float(mode));
495 return get_tarval_nan(mode);
498 int is_mode(const void *thing)
500 return get_kind(thing) == k_ir_mode;
503 int (mode_is_signed)(const ir_mode *mode)
505 return _mode_is_signed(mode);
508 int (mode_is_float)(const ir_mode *mode)
510 return _mode_is_float(mode);
513 int (mode_is_int)(const ir_mode *mode)
515 return _mode_is_int(mode);
518 int (mode_is_reference)(const ir_mode *mode)
520 return _mode_is_reference(mode);
523 int (mode_is_num)(const ir_mode *mode)
525 return _mode_is_num(mode);
528 int (mode_is_data)(const ir_mode *mode)
530 return _mode_is_data(mode);
533 int (mode_is_datab)(const ir_mode *mode)
535 return _mode_is_datab(mode);
538 int (mode_is_dataM)(const ir_mode *mode)
540 return _mode_is_dataM(mode);
543 int (mode_is_float_vector)(const ir_mode *mode)
545 return _mode_is_float_vector(mode);
548 int (mode_is_int_vector)(const ir_mode *mode)
550 return _mode_is_int_vector(mode);
553 /* Returns true if sm can be converted to lm without loss. */
554 int smaller_mode(const ir_mode *sm, const ir_mode *lm)
556 int sm_bits, lm_bits;
561 if (sm == lm) return 1;
563 sm_bits = get_mode_size_bits(sm);
564 lm_bits = get_mode_size_bits(lm);
566 switch (get_mode_sort(sm)) {
567 case irms_int_number:
568 switch (get_mode_sort(lm)) {
569 case irms_int_number:
570 if (get_mode_arithmetic(sm) != get_mode_arithmetic(lm))
573 /* only two complement implemented */
574 assert(get_mode_arithmetic(sm) == irma_twos_complement);
576 /* integers are convertable if
577 * - both have the same sign and lm is the larger one
578 * - lm is the signed one and is at least two bits larger
579 * (one for the sign, one for the highest bit of sm)
580 * - sm & lm are two_complement and lm has greater or equal number of bits
582 if (mode_is_signed(sm)) {
583 if (!mode_is_signed(lm))
585 return sm_bits <= lm_bits;
587 if (mode_is_signed(lm)) {
588 return sm_bits < lm_bits;
590 return sm_bits <= lm_bits;
594 case irms_float_number:
595 /* int to float works if the float is large enough */
603 case irms_float_number:
604 if (get_mode_arithmetic(sm) == get_mode_arithmetic(lm)) {
605 if ( (get_mode_sort(lm) == irms_float_number)
606 && (get_mode_size_bits(lm) >= get_mode_size_bits(sm)) )
612 /* do exist machines out there with different pointer lengths ?*/
615 case irms_internal_boolean:
616 return mode_is_int(lm);
626 /* Returns true if a value of mode sm can be converted into mode lm
627 and backwards without loss. */
628 int values_in_mode(const ir_mode *sm, const ir_mode *lm)
630 int sm_bits, lm_bits;
631 ir_mode_arithmetic arith;
636 if (sm == lm) return 1;
639 return mode_is_int(lm);
641 sm_bits = get_mode_size_bits(sm);
642 lm_bits = get_mode_size_bits(lm);
644 arith = get_mode_arithmetic(sm);
645 if (arith != get_mode_arithmetic(lm))
649 case irma_twos_complement:
651 return get_mode_size_bits(sm) <= get_mode_size_bits(lm);
658 /* Return the signed integer equivalent mode for an reference mode. */
659 ir_mode *get_reference_mode_signed_eq(ir_mode *mode)
661 assert(mode_is_reference(mode));
662 return mode->eq_signed;
665 /* Sets the signed integer equivalent mode for an reference mode. */
666 void set_reference_mode_signed_eq(ir_mode *ref_mode, ir_mode *int_mode)
668 assert(mode_is_reference(ref_mode));
669 assert(mode_is_int(int_mode));
670 ref_mode->eq_signed = int_mode;
673 /* Return the unsigned integer equivalent mode for an reference mode. */
674 ir_mode *get_reference_mode_unsigned_eq(ir_mode *mode)
676 assert(mode_is_reference(mode));
677 return mode->eq_unsigned;
680 /* Sets the unsigned integer equivalent mode for an reference mode. */
681 void set_reference_mode_unsigned_eq(ir_mode *ref_mode, ir_mode *int_mode)
683 assert(mode_is_reference(ref_mode));
684 assert(mode_is_int(int_mode));
685 ref_mode->eq_unsigned = int_mode;
688 /* initialization, build the default modes */
693 obstack_init(&modes);
694 mode_list = NEW_ARR_F(ir_mode*, 0);
696 /* initialize predefined modes */
699 newmode.arithmetic = irma_none;
702 newmode.modulo_shift = 0;
703 newmode.vector_elem = 0;
704 newmode.eq_signed = NULL;
705 newmode.eq_unsigned = NULL;
707 newmode.tv_priv = NULL;
709 /* Control Flow Modes*/
710 newmode.sort = irms_control_flow;
713 newmode.name = new_id_from_chars("BB", 2);
714 mode_BB = register_mode(&newmode);
717 newmode.name = new_id_from_chars("X", 1);
718 mode_X = register_mode(&newmode);
721 newmode.sort = irms_memory;
724 newmode.name = new_id_from_chars("M", 1);
725 mode_M = register_mode(&newmode);
727 /* Auxiliary Modes */
728 newmode.sort = irms_auxiliary,
731 newmode.name = new_id_from_chars("T", 1);
732 mode_T = register_mode(&newmode);
735 newmode.name = new_id_from_chars("ANY", 3);
736 mode_ANY = register_mode(&newmode);
739 newmode.name = new_id_from_chars("BAD", 3);
740 mode_BAD = register_mode(&newmode);
742 /* Internal Boolean Modes */
743 newmode.sort = irms_internal_boolean;
746 newmode.name = new_id_from_chars("b", 1);
747 mode_b = register_mode(&newmode);
750 newmode.vector_elem = 1;
752 /* Float Number Modes */
753 newmode.sort = irms_float_number;
754 newmode.arithmetic = irma_ieee754;
757 newmode.name = new_id_from_chars("F", 1);
760 mode_F = register_mode(&newmode);
763 newmode.name = new_id_from_chars("D", 1);
766 mode_D = register_mode(&newmode);
769 newmode.name = new_id_from_chars("E", 1);
771 /* note that the tarval module is calculating with 80 bits, but we use
772 * 96 bits, as that is what will be stored to memory by most hardware */
774 mode_E = register_mode(&newmode);
776 /* Integer Number Modes */
777 newmode.sort = irms_int_number;
778 newmode.arithmetic = irma_twos_complement;
781 newmode.name = new_id_from_chars("Bs", 2);
784 newmode.modulo_shift = 32;
785 mode_Bs = register_mode(&newmode);
788 newmode.name = new_id_from_chars("Bu", 2);
789 newmode.arithmetic = irma_twos_complement;
792 newmode.modulo_shift = 32;
793 mode_Bu = register_mode(&newmode);
795 /* signed short integer */
796 newmode.name = new_id_from_chars("Hs", 2);
799 newmode.modulo_shift = 32;
800 mode_Hs = register_mode(&newmode);
802 /* unsigned short integer */
803 newmode.name = new_id_from_chars("Hu", 2);
806 newmode.modulo_shift = 32;
807 mode_Hu = register_mode(&newmode);
810 newmode.name = new_id_from_chars("Is", 2);
813 newmode.modulo_shift = 32;
814 mode_Is = register_mode(&newmode);
816 /* unsigned integer */
817 newmode.name = new_id_from_chars("Iu", 2);
820 newmode.modulo_shift = 32;
821 mode_Iu = register_mode(&newmode);
823 /* signed long integer */
824 newmode.name = new_id_from_chars("Ls", 2);
827 newmode.modulo_shift = 64;
828 mode_Ls = register_mode(&newmode);
830 /* unsigned long integer */
831 newmode.name = new_id_from_chars("Lu", 2);
834 newmode.modulo_shift = 64;
835 mode_Lu = register_mode(&newmode);
837 /* signed long long integer */
838 newmode.name = new_id_from_chars("LLs", 3);
841 newmode.modulo_shift = 128;
842 mode_LLs = register_mode(&newmode);
844 /* unsigned long long integer */
845 newmode.name = new_id_from_chars("LLu", 3);
848 newmode.modulo_shift = 128;
849 mode_LLu = register_mode(&newmode);
852 newmode.sort = irms_reference;
853 newmode.arithmetic = irma_twos_complement;
856 newmode.name = new_id_from_chars("P", 1);
859 newmode.modulo_shift = 32;
860 newmode.eq_signed = mode_Is;
861 newmode.eq_unsigned = mode_Iu;
862 mode_P = register_mode(&newmode);
864 /* set the machine specific modes to the predefined ones */
865 mode_P_code = mode_P;
866 mode_P_data = mode_P;
869 /* find a signed mode for an unsigned integer mode */
870 ir_mode *find_unsigned_mode(const ir_mode *mode)
874 /* allowed for reference mode */
875 if (mode->sort == irms_reference)
876 n.sort = irms_int_number;
878 assert(n.sort == irms_int_number);
880 return find_mode(&n);
883 /* find an unsigned mode for a signed integer mode */
884 ir_mode *find_signed_mode(const ir_mode *mode)
888 assert(mode->sort == irms_int_number);
890 return find_mode(&n);
893 /* finds a integer mode with 2*n bits for an integer mode with n bits. */
894 ir_mode *find_double_bits_int_mode(const ir_mode *mode)
898 assert(mode->sort == irms_int_number && mode->arithmetic == irma_twos_complement);
900 n.size = 2*mode->size;
901 return find_mode(&n);
905 * Returns non-zero if the given mode honors signed zero's, i.e.,
906 * a +0 and a -0 exists and handled differently.
908 int mode_honor_signed_zeros(const ir_mode *mode)
910 /* for floating point, we know that IEEE 754 has +0 and -0,
911 * but always handles it identical.
914 mode->sort == irms_float_number &&
915 mode->arithmetic != irma_ieee754;
919 * Returns non-zero if the given mode might overflow on unary Minus.
921 * This does NOT happen on IEEE 754.
923 int mode_overflow_on_unary_Minus(const ir_mode *mode)
925 if (mode->sort == irms_float_number)
926 return mode->arithmetic == irma_ieee754 ? 0 : 1;
931 * Returns non-zero if the mode has a reversed wrap-around
932 * logic, especially (a + x) - x == a.
934 * This is normally true for integer modes, not for floating
937 int mode_wrap_around(const ir_mode *mode)
939 /* FIXME: better would be an extra mode property */
940 return mode_is_int(mode);
944 * Returns non-zero if the cast from mode src to mode dst is a
945 * reinterpret cast (ie. only the bit pattern is reinterpreted,
946 * no conversion is done)
948 int is_reinterpret_cast(const ir_mode *src, const ir_mode *dst)
950 ir_mode_arithmetic ma;
954 if (get_mode_size_bits(src) != get_mode_size_bits(dst))
956 ma = get_mode_arithmetic(src);
957 if (ma != get_mode_arithmetic(dst))
960 return ma == irma_twos_complement || ma == irma_ones_complement;
963 void finish_mode(void)
965 obstack_free(&modes, 0);
966 DEL_ARR_F(mode_list);