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 /** Number of defined modes. */
47 static int num_modes = 0;
49 /** The list of all currently existing modes. */
50 static ir_mode **mode_list;
52 const char *get_mode_arithmetic_name(ir_mode_arithmetic ari)
54 #define X(a) case a: return #a
56 X(irma_uninitialized);
58 X(irma_twos_complement);
59 X(irma_ones_complement);
63 default: return "<unknown>";
69 * Compare modes that don't need to have their code field
72 * TODO: Add other fields
74 static inline int modes_are_equal(const ir_mode *m, const ir_mode *n) {
76 if (m->sort == n->sort &&
77 m->arithmetic == n->arithmetic &&
80 m->modulo_shift == n->modulo_shift &&
81 m->vector_elem == n->vector_elem)
88 * searches the modes obstack for the given mode and returns
89 * a pointer on an equal mode already in the array, NULL if
92 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) {
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) {
116 if (0 <= idx && idx < ARR_LEN(mode_list))
117 return mode_list[idx];
123 * sets special values of modes
125 static void set_mode_values(ir_mode* mode) {
126 switch (get_mode_sort(mode)) {
128 case irms_int_number:
129 case irms_float_number:
130 mode->min = get_tarval_min(mode);
131 mode->max = get_tarval_max(mode);
132 mode->null = get_tarval_null(mode);
133 mode->one = get_tarval_one(mode);
134 mode->minus_one = get_tarval_minus_one(mode);
135 if(get_mode_sort(mode) != irms_float_number) {
136 mode->all_one = get_tarval_all_one(mode);
138 mode->all_one = tarval_bad;
142 case irms_internal_boolean:
143 mode->min = tarval_b_false;
144 mode->max = tarval_b_true;
145 mode->null = tarval_b_false;
146 mode->one = tarval_b_true;
147 mode->minus_one = tarval_bad;
148 mode->all_one = tarval_b_true;
153 case irms_control_flow:
154 mode->min = tarval_bad;
155 mode->max = tarval_bad;
156 mode->null = tarval_bad;
157 mode->one = tarval_bad;
158 mode->minus_one = tarval_bad;
164 * globals defined in irmode.h
167 /* --- Predefined modes --- */
169 /* FIRM internal modes: */
177 /* predefined numerical modes: */
178 ir_mode *mode_F; /* float */
179 ir_mode *mode_D; /* double */
180 ir_mode *mode_E; /* long double */
182 ir_mode *mode_Bs; /* integral values, signed and unsigned */
183 ir_mode *mode_Bu; /* 8 bit */
184 ir_mode *mode_Hs; /* 16 bit */
186 ir_mode *mode_Is; /* 32 bit */
188 ir_mode *mode_Ls; /* 64 bit */
190 ir_mode *mode_LLs; /* 128 bit */
196 /* machine specific modes */
197 ir_mode *mode_P_code; /**< machine specific pointer mode for code addresses */
198 ir_mode *mode_P_data; /**< machine specific pointer mode for data addresses */
201 * functions defined in irmode.h
204 /* JNI access functions */
205 ir_mode *get_modeT(void) { return mode_T; }
206 ir_mode *get_modeF(void) { return mode_F; }
207 ir_mode *get_modeD(void) { return mode_D; }
208 ir_mode *get_modeE(void) { return mode_E; }
209 ir_mode *get_modeBs(void) { return mode_Bs; }
210 ir_mode *get_modeBu(void) { return mode_Bu; }
211 ir_mode *get_modeHs(void) { return mode_Hs; }
212 ir_mode *get_modeHu(void) { return mode_Hu; }
213 ir_mode *get_modeIs(void) { return mode_Is; }
214 ir_mode *get_modeIu(void) { return mode_Iu; }
215 ir_mode *get_modeLs(void) { return mode_Ls; }
216 ir_mode *get_modeLu(void) { return mode_Lu; }
217 ir_mode *get_modeLLs(void){ return mode_LLs; }
218 ir_mode *get_modeLLu(void){ return mode_LLu; }
219 ir_mode *get_modeb(void) { return mode_b; }
220 ir_mode *get_modeP(void) { return mode_P; }
221 ir_mode *get_modeX(void) { return mode_X; }
222 ir_mode *get_modeM(void) { return mode_M; }
223 ir_mode *get_modeBB(void) { return mode_BB; }
224 ir_mode *get_modeANY(void) { return mode_ANY; }
225 ir_mode *get_modeBAD(void) { return mode_BAD; }
228 ir_mode *(get_modeP_code)(void) {
229 return _get_modeP_code();
232 ir_mode *(get_modeP_data)(void) {
233 return _get_modeP_data();
236 void set_modeP_code(ir_mode *p) {
237 assert(mode_is_reference(p));
241 void set_modeP_data(ir_mode *p) {
242 assert(mode_is_reference(p));
247 * Registers a new mode.
249 * @param new_mode The new mode template.
251 static ir_mode *register_mode(const ir_mode *new_mode) {
252 ir_mode *mode = NULL;
256 /* copy mode struct to modes array */
257 mode = (ir_mode *)obstack_copy(&modes, new_mode, sizeof(*mode));
258 ARR_APP1(ir_mode*, mode_list, mode);
260 mode->kind = k_ir_mode;
261 if (num_modes >= irm_max) {
262 mode->code = num_modes;
266 /* add the new mode to the irp list of modes */
269 set_mode_values(mode);
271 hook_new_mode(new_mode, mode);
276 * Creates a new mode.
278 ir_mode *new_ir_mode(const char *name, ir_mode_sort sort, int bit_size, int sign,
279 ir_mode_arithmetic arithmetic, unsigned int modulo_shift)
282 ir_mode *mode = NULL;
284 mode_tmpl.name = new_id_from_str(name);
285 mode_tmpl.sort = sort;
286 mode_tmpl.size = bit_size;
287 mode_tmpl.sign = sign ? 1 : 0;
288 mode_tmpl.modulo_shift = (mode_tmpl.sort == irms_int_number) ? modulo_shift : 0;
289 mode_tmpl.vector_elem = 1;
290 mode_tmpl.arithmetic = arithmetic;
291 mode_tmpl.link = NULL;
292 mode_tmpl.tv_priv = NULL;
294 mode = find_mode(&mode_tmpl);
296 hook_new_mode(&mode_tmpl, mode);
303 case irms_control_flow:
305 case irms_internal_boolean:
306 panic("internal modes cannot be user defined");
308 case irms_float_number:
309 case irms_int_number:
311 mode = register_mode(&mode_tmpl);
314 assert(mode != NULL);
319 * Creates a new vector mode.
321 ir_mode *new_ir_vector_mode(const char *name, ir_mode_sort sort, int bit_size, unsigned num_of_elem, int sign,
322 ir_mode_arithmetic arithmetic, unsigned int modulo_shift)
325 ir_mode *mode = NULL;
327 mode_tmpl.name = new_id_from_str(name);
328 mode_tmpl.sort = sort;
329 mode_tmpl.size = bit_size * num_of_elem;
330 mode_tmpl.sign = sign ? 1 : 0;
331 mode_tmpl.modulo_shift = (mode_tmpl.sort == irms_int_number) ? modulo_shift : 0;
332 mode_tmpl.vector_elem = num_of_elem;
333 mode_tmpl.arithmetic = arithmetic;
334 mode_tmpl.link = NULL;
335 mode_tmpl.tv_priv = NULL;
337 mode = find_mode(&mode_tmpl);
339 hook_new_mode(&mode_tmpl, mode);
343 if (num_of_elem <= 1) {
344 assert(0 && "vector modes should have at least 2 elements");
351 case irms_control_flow:
353 case irms_internal_boolean:
354 panic("internal modes cannot be user defined");
357 panic("only integer and floating point modes can be vectorized");
359 case irms_float_number:
360 panic("not yet implemented");
362 case irms_int_number:
363 mode = register_mode(&mode_tmpl);
365 assert(mode != NULL);
369 /* Functions for the direct access to all attributes of an ir_mode */
370 ir_modecode (get_mode_modecode)(const ir_mode *mode) {
371 return _get_mode_modecode(mode);
374 ident *(get_mode_ident)(const ir_mode *mode) {
375 return _get_mode_ident(mode);
378 const char *get_mode_name(const ir_mode *mode) {
379 return get_id_str(mode->name);
382 ir_mode_sort (get_mode_sort)(const ir_mode* mode) {
383 return _get_mode_sort(mode);
386 unsigned (get_mode_size_bits)(const ir_mode *mode) {
387 return _get_mode_size_bits(mode);
390 unsigned (get_mode_size_bytes)(const ir_mode *mode) {
391 return _get_mode_size_bytes(mode);
394 int (get_mode_sign)(const ir_mode *mode) {
395 return _get_mode_sign(mode);
398 ir_mode_arithmetic (get_mode_arithmetic)(const ir_mode *mode) {
399 return get_mode_arithmetic(mode);
403 /* Attribute modulo shift specifies for modes of kind irms_int_number
404 * whether shift applies modulo to value of bits to shift. Asserts
405 * if mode is not irms_int_number.
407 unsigned int (get_mode_modulo_shift)(const ir_mode *mode) {
408 return _get_mode_modulo_shift(mode);
411 unsigned int (get_mode_n_vector_elems)(const ir_mode *mode) {
412 return _get_mode_vector_elems(mode);
415 void *(get_mode_link)(const ir_mode *mode) {
416 return _get_mode_link(mode);
419 void (set_mode_link)(ir_mode *mode, void *l) {
420 _set_mode_link(mode, l);
423 tarval *get_mode_min(ir_mode *mode) {
425 assert(get_mode_modecode(mode) < (ir_modecode) num_modes);
426 assert(mode_is_data(mode));
431 tarval *get_mode_max(ir_mode *mode) {
433 assert(get_mode_modecode(mode) < (ir_modecode) num_modes);
434 assert(mode_is_data(mode));
439 tarval *get_mode_null(ir_mode *mode) {
441 assert(get_mode_modecode(mode) < (ir_modecode) num_modes);
442 assert(mode_is_datab(mode));
447 tarval *get_mode_one(ir_mode *mode) {
449 assert(get_mode_modecode(mode) < (ir_modecode) num_modes);
450 assert(mode_is_datab(mode));
455 tarval *get_mode_minus_one(ir_mode *mode) {
457 assert(get_mode_modecode(mode) < (ir_modecode) num_modes);
458 assert(mode_is_data(mode));
460 return mode->minus_one;
463 tarval *get_mode_all_one(ir_mode *mode) {
465 assert(get_mode_modecode(mode) < (ir_modecode) num_modes);
466 assert(mode_is_datab(mode));
467 return mode->all_one;
470 tarval *get_mode_infinite(ir_mode *mode) {
472 assert(get_mode_modecode(mode) < (ir_modecode) num_modes);
473 assert(mode_is_float(mode));
475 return get_tarval_plus_inf(mode);
478 tarval *get_mode_NAN(ir_mode *mode) {
480 assert(get_mode_modecode(mode) < (ir_modecode) num_modes);
481 assert(mode_is_float(mode));
483 return get_tarval_nan(mode);
486 int is_mode(const void *thing) {
487 return get_kind(thing) == k_ir_mode;
490 int (mode_is_signed)(const ir_mode *mode) {
491 return _mode_is_signed(mode);
494 int (mode_is_float)(const ir_mode *mode) {
495 return _mode_is_float(mode);
498 int (mode_is_int)(const ir_mode *mode) {
499 return _mode_is_int(mode);
502 int (mode_is_reference)(const ir_mode *mode) {
503 return _mode_is_reference(mode);
506 int (mode_is_num)(const ir_mode *mode) {
507 return _mode_is_num(mode);
510 int (mode_is_data)(const ir_mode *mode) {
511 return _mode_is_data(mode);
514 int (mode_is_datab)(const ir_mode *mode) {
515 return _mode_is_datab(mode);
518 int (mode_is_dataM)(const ir_mode *mode) {
519 return _mode_is_dataM(mode);
522 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) {
527 return _mode_is_int_vector(mode);
530 /* Returns true if sm can be converted to lm without loss. */
531 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;
570 case irms_float_number:
571 /* int to float works if the float is large enough */
579 case irms_float_number:
580 if (get_mode_arithmetic(sm) == get_mode_arithmetic(lm)) {
581 if ( (get_mode_sort(lm) == irms_float_number)
582 && (get_mode_size_bits(lm) >= get_mode_size_bits(sm)) )
588 /* do exist machines out there with different pointer lengths ?*/
591 case irms_internal_boolean:
592 return mode_is_int(lm);
602 /* Returns true if a value of mode sm can be converted into mode lm
603 and backwards without loss. */
604 int values_in_mode(const ir_mode *sm, const ir_mode *lm) {
605 int sm_bits, lm_bits;
606 ir_mode_arithmetic arith;
611 if (sm == lm) return 1;
614 return mode_is_int(lm);
616 sm_bits = get_mode_size_bits(sm);
617 lm_bits = get_mode_size_bits(lm);
619 arith = get_mode_arithmetic(sm);
620 if (arith != get_mode_arithmetic(lm))
624 case irma_twos_complement:
626 return get_mode_size_bits(sm) <= get_mode_size_bits(lm);
633 /* Return the signed integer equivalent mode for an reference mode. */
634 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) {
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) {
648 assert(mode_is_reference(mode));
649 return mode->eq_unsigned;
652 /* Sets the unsigned integer equivalent mode for an reference mode. */
653 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 */
660 void init_mode(void) {
663 obstack_init(&modes);
664 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 newmode.code = irm_BB;
687 mode_BB = register_mode(&newmode);
690 newmode.name = new_id_from_chars("X", 1);
691 newmode.code = irm_X;
693 mode_X = register_mode(&newmode);
696 newmode.sort = irms_memory;
699 newmode.name = new_id_from_chars("M", 1);
700 newmode.code = irm_M;
702 mode_M = register_mode(&newmode);
704 /* Auxiliary Modes */
705 newmode.sort = irms_auxiliary,
708 newmode.name = new_id_from_chars("T", 1);
709 newmode.code = irm_T;
711 mode_T = register_mode(&newmode);
714 newmode.name = new_id_from_chars("ANY", 3);
715 newmode.code = irm_ANY;
717 mode_ANY = register_mode(&newmode);
720 newmode.name = new_id_from_chars("BAD", 3);
721 newmode.code = irm_BAD;
723 mode_BAD = register_mode(&newmode);
725 /* Internal Boolean Modes */
726 newmode.sort = irms_internal_boolean;
729 newmode.name = new_id_from_chars("b", 1);
730 newmode.code = irm_b;
732 mode_b = register_mode(&newmode);
735 newmode.vector_elem = 1;
737 /* Float Number Modes */
738 newmode.sort = irms_float_number;
739 newmode.arithmetic = irma_ieee754;
742 newmode.name = new_id_from_chars("F", 1);
743 newmode.code = irm_F;
747 mode_F = register_mode(&newmode);
750 newmode.name = new_id_from_chars("D", 1);
751 newmode.code = irm_D;
755 mode_D = register_mode(&newmode);
758 newmode.name = new_id_from_chars("E", 1);
759 newmode.code = irm_E;
761 /* note that the tarval module is calculating with 80 bits, but we use
762 * 96 bits, as that is what will be stored to memory by most hardware */
765 mode_E = register_mode(&newmode);
767 /* Integer Number Modes */
768 newmode.sort = irms_int_number;
769 newmode.arithmetic = irma_twos_complement;
772 newmode.name = new_id_from_chars("Bs", 2);
773 newmode.code = irm_Bs;
776 newmode.modulo_shift = 32;
778 mode_Bs = register_mode(&newmode);
781 newmode.name = new_id_from_chars("Bu", 2);
782 newmode.code = irm_Bu;
783 newmode.arithmetic = irma_twos_complement;
786 newmode.modulo_shift = 32;
788 mode_Bu = register_mode(&newmode);
790 /* signed short integer */
791 newmode.name = new_id_from_chars("Hs", 2);
792 newmode.code = irm_Hs;
795 newmode.modulo_shift = 32;
797 mode_Hs = register_mode(&newmode);
799 /* unsigned short integer */
800 newmode.name = new_id_from_chars("Hu", 2);
801 newmode.code = irm_Hu;
804 newmode.modulo_shift = 32;
806 mode_Hu = register_mode(&newmode);
809 newmode.name = new_id_from_chars("Is", 2);
810 newmode.code = irm_Is;
813 newmode.modulo_shift = 32;
815 mode_Is = register_mode(&newmode);
817 /* unsigned integer */
818 newmode.name = new_id_from_chars("Iu", 2);
819 newmode.code = irm_Iu;
822 newmode.modulo_shift = 32;
824 mode_Iu = register_mode(&newmode);
826 /* signed long integer */
827 newmode.name = new_id_from_chars("Ls", 2);
828 newmode.code = irm_Ls;
831 newmode.modulo_shift = 64;
833 mode_Ls = register_mode(&newmode);
835 /* unsigned long integer */
836 newmode.name = new_id_from_chars("Lu", 2);
837 newmode.code = irm_Lu;
840 newmode.modulo_shift = 64;
842 mode_Lu = register_mode(&newmode);
844 /* signed long long integer */
845 newmode.name = new_id_from_chars("LLs", 3);
846 newmode.code = irm_LLs;
849 newmode.modulo_shift = 128;
851 mode_LLs = register_mode(&newmode);
853 /* unsigned long long integer */
854 newmode.name = new_id_from_chars("LLu", 3);
855 newmode.code = irm_LLu;
858 newmode.modulo_shift = 128;
860 mode_LLu = register_mode(&newmode);
863 newmode.sort = irms_reference;
864 newmode.arithmetic = irma_twos_complement;
867 newmode.name = new_id_from_chars("P", 1);
868 newmode.code = irm_P;
871 newmode.modulo_shift = 0;
872 newmode.eq_signed = mode_Is;
873 newmode.eq_unsigned = mode_Iu;
875 mode_P = register_mode(&newmode);
877 /* set the machine specific modes to the predefined ones */
878 mode_P_code = mode_P;
879 mode_P_data = mode_P;
882 /* find a signed mode for an unsigned integer mode */
883 ir_mode *find_unsigned_mode(const ir_mode *mode) {
886 /* allowed for reference mode */
887 if (mode->sort == irms_reference)
888 n.sort = irms_int_number;
890 assert(n.sort == irms_int_number);
892 return find_mode(&n);
895 /* find an unsigned mode for a signed integer mode */
896 ir_mode *find_signed_mode(const ir_mode *mode) {
899 assert(mode->sort == irms_int_number);
901 return find_mode(&n);
904 /* finds a integer mode with 2*n bits for an integer mode with n bits. */
905 ir_mode *find_double_bits_int_mode(const ir_mode *mode) {
908 assert(mode->sort == irms_int_number && mode->arithmetic == irma_twos_complement);
910 n.size = 2*mode->size;
911 return find_mode(&n);
915 * Returns non-zero if the given mode honors signed zero's, i.e.,
916 * a +0 and a -0 exists and handled differently.
918 int mode_honor_signed_zeros(const ir_mode *mode) {
919 /* for floating point, we know that IEEE 754 has +0 and -0,
920 * but always handles it identical.
923 mode->sort == irms_float_number &&
924 mode->arithmetic != irma_ieee754;
928 * Returns non-zero if the given mode might overflow on unary Minus.
930 * This does NOT happen on IEEE 754.
932 int mode_overflow_on_unary_Minus(const ir_mode *mode) {
933 if (mode->sort == irms_float_number)
934 return mode->arithmetic == irma_ieee754 ? 0 : 1;
939 * Returns non-zero if the mode has a reversed wrap-around
940 * logic, especially (a + x) - x == a.
942 * This is normally true for integer modes, not for floating
945 int mode_wrap_around(const ir_mode *mode) {
946 /* FIXME: better would be an extra mode property */
947 return mode_is_int(mode);
951 * Returns non-zero if the cast from mode src to mode dst is a
952 * reinterpret cast (ie. only the bit pattern is reinterpreted,
953 * no conversion is done)
955 int is_reinterpret_cast(const ir_mode *src, const ir_mode *dst) {
956 ir_mode_arithmetic ma;
960 if (get_mode_size_bits(src) != get_mode_size_bits(dst))
962 ma = get_mode_arithmetic(src);
963 if (ma != get_mode_arithmetic(dst))
966 return ma == irma_twos_complement || ma == irma_ones_complement;
969 void finish_mode(void) {
970 obstack_free(&modes, 0);
971 DEL_ARR_F(mode_list);