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
37 # include "irprog_t.h"
38 # include "irmode_t.h"
46 /** Obstack to hold all modes. */
47 static struct obstack modes;
49 /** Number of defined modes. */
50 static int num_modes = 0;
52 /** The list of all currently existing modes. */
53 static ir_mode **mode_list;
56 * Compare modes that don't need to have their code field
59 * TODO: Add other fields
61 static inline int modes_are_equal(const ir_mode *m, const ir_mode *n) {
63 if (m->sort == n->sort &&
64 m->arithmetic == n->arithmetic &&
67 m->modulo_shift == n->modulo_shift &&
68 m->vector_elem == n->vector_elem)
75 * searches the modes obstack for the given mode and returns
76 * a pointer on an equal mode already in the array, NULL if
79 static ir_mode *find_mode(const ir_mode *m) {
81 for (i = ARR_LEN(mode_list) - 1; i >= 0; --i) {
82 ir_mode *n = mode_list[i];
83 if (modes_are_equal(n, m))
89 #ifdef FIRM_STATISTICS
90 /* return the mode index, only needed for statistics */
91 int stat_find_mode_index(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 /* return the mode for a given index, only needed for statistics */
102 ir_mode *stat_mode_for_index(int idx) {
103 if (0 <= idx && idx < ARR_LEN(mode_list))
104 return mode_list[idx];
110 * sets special values of modes
112 static void set_mode_values(ir_mode* mode) {
113 switch (get_mode_sort(mode)) {
115 case irms_int_number:
116 case irms_float_number:
117 mode->min = get_tarval_min(mode);
118 mode->max = get_tarval_max(mode);
119 mode->null = get_tarval_null(mode);
120 mode->one = get_tarval_one(mode);
121 mode->minus_one = get_tarval_minus_one(mode);
122 if(get_mode_sort(mode) != irms_float_number) {
123 mode->all_one = get_tarval_all_one(mode);
125 mode->all_one = tarval_bad;
129 case irms_internal_boolean:
130 mode->min = tarval_b_false;
131 mode->max = tarval_b_true;
132 mode->null = tarval_b_false;
133 mode->one = tarval_b_true;
134 mode->minus_one = tarval_bad;
135 mode->all_one = tarval_b_true;
140 case irms_control_flow:
141 mode->min = tarval_bad;
142 mode->max = tarval_bad;
143 mode->null = tarval_bad;
144 mode->one = tarval_bad;
145 mode->minus_one = tarval_bad;
151 * globals defined in irmode.h
154 /* --- Predefined modes --- */
156 /* FIRM internal modes: */
164 /* predefined numerical modes: */
165 ir_mode *mode_F; /* float */
166 ir_mode *mode_D; /* double */
167 ir_mode *mode_E; /* long double */
169 ir_mode *mode_Bs; /* integral values, signed and unsigned */
170 ir_mode *mode_Bu; /* 8 bit */
171 ir_mode *mode_Hs; /* 16 bit */
173 ir_mode *mode_Is; /* 32 bit */
175 ir_mode *mode_Ls; /* 64 bit */
177 ir_mode *mode_LLs; /* 128 bit */
183 /* machine specific modes */
184 ir_mode *mode_P_code; /**< machine specific pointer mode for code addresses */
185 ir_mode *mode_P_data; /**< machine specific pointer mode for data addresses */
188 * functions defined in irmode.h
191 /* JNI access functions */
192 ir_mode *get_modeT(void) { return mode_T; }
193 ir_mode *get_modeF(void) { return mode_F; }
194 ir_mode *get_modeD(void) { return mode_D; }
195 ir_mode *get_modeE(void) { return mode_E; }
196 ir_mode *get_modeBs(void) { return mode_Bs; }
197 ir_mode *get_modeBu(void) { return mode_Bu; }
198 ir_mode *get_modeHs(void) { return mode_Hs; }
199 ir_mode *get_modeHu(void) { return mode_Hu; }
200 ir_mode *get_modeIs(void) { return mode_Is; }
201 ir_mode *get_modeIu(void) { return mode_Iu; }
202 ir_mode *get_modeLs(void) { return mode_Ls; }
203 ir_mode *get_modeLu(void) { return mode_Lu; }
204 ir_mode *get_modeLLs(void){ return mode_LLs; }
205 ir_mode *get_modeLLu(void){ return mode_LLu; }
206 ir_mode *get_modeb(void) { return mode_b; }
207 ir_mode *get_modeP(void) { return mode_P; }
208 ir_mode *get_modeX(void) { return mode_X; }
209 ir_mode *get_modeM(void) { return mode_M; }
210 ir_mode *get_modeBB(void) { return mode_BB; }
211 ir_mode *get_modeANY(void) { return mode_ANY; }
212 ir_mode *get_modeBAD(void) { return mode_BAD; }
215 ir_mode *(get_modeP_code)(void) {
216 return _get_modeP_code();
219 ir_mode *(get_modeP_data)(void) {
220 return _get_modeP_data();
223 void set_modeP_code(ir_mode *p) {
224 assert(mode_is_reference(p));
228 void set_modeP_data(ir_mode *p) {
229 assert(mode_is_reference(p));
234 * Registers a new mode.
236 * @param new_mode The new mode template.
238 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 if (num_modes >= irm_max) {
249 mode->code = num_modes;
253 /* add the new mode to the irp list of modes */
256 set_mode_values(mode);
258 hook_new_mode(new_mode, mode);
263 * Creates a new mode.
265 ir_mode *new_ir_mode(const char *name, ir_mode_sort sort, int bit_size, int sign,
266 ir_mode_arithmetic arithmetic, unsigned int modulo_shift)
269 ir_mode *mode = NULL;
271 mode_tmpl.name = new_id_from_str(name);
272 mode_tmpl.sort = sort;
273 mode_tmpl.size = bit_size;
274 mode_tmpl.sign = sign ? 1 : 0;
275 mode_tmpl.modulo_shift = (mode_tmpl.sort == irms_int_number) ? modulo_shift : 0;
276 mode_tmpl.vector_elem = 1;
277 mode_tmpl.arithmetic = arithmetic;
278 mode_tmpl.link = NULL;
279 mode_tmpl.tv_priv = NULL;
281 mode = find_mode(&mode_tmpl);
283 hook_new_mode(&mode_tmpl, mode);
290 case irms_control_flow:
292 case irms_internal_boolean:
293 panic("internal modes cannot be user defined");
295 case irms_float_number:
296 case irms_int_number:
298 mode = register_mode(&mode_tmpl);
301 assert(mode != NULL);
306 * Creates a new vector mode.
308 ir_mode *new_ir_vector_mode(const char *name, ir_mode_sort sort, int bit_size, unsigned num_of_elem, int sign,
309 ir_mode_arithmetic arithmetic, unsigned int modulo_shift)
312 ir_mode *mode = NULL;
314 mode_tmpl.name = new_id_from_str(name);
315 mode_tmpl.sort = sort;
316 mode_tmpl.size = bit_size * num_of_elem;
317 mode_tmpl.sign = sign ? 1 : 0;
318 mode_tmpl.modulo_shift = (mode_tmpl.sort == irms_int_number) ? modulo_shift : 0;
319 mode_tmpl.vector_elem = num_of_elem;
320 mode_tmpl.arithmetic = arithmetic;
321 mode_tmpl.link = NULL;
322 mode_tmpl.tv_priv = NULL;
324 mode = find_mode(&mode_tmpl);
326 hook_new_mode(&mode_tmpl, mode);
330 if (num_of_elem <= 1) {
331 assert(0 && "vector modes should have at least 2 elements");
338 case irms_control_flow:
340 case irms_internal_boolean:
341 panic("internal modes cannot be user defined");
344 panic("only integer and floating point modes can be vectorized");
346 case irms_float_number:
347 panic("not yet implemented");
349 case irms_int_number:
350 mode = register_mode(&mode_tmpl);
352 assert(mode != NULL);
356 /* Functions for the direct access to all attributes of an ir_mode */
357 ir_modecode (get_mode_modecode)(const ir_mode *mode) {
358 return _get_mode_modecode(mode);
361 ident *(get_mode_ident)(const ir_mode *mode) {
362 return _get_mode_ident(mode);
365 const char *get_mode_name(const ir_mode *mode) {
366 return get_id_str(mode->name);
369 ir_mode_sort (get_mode_sort)(const ir_mode* mode) {
370 return _get_mode_sort(mode);
373 unsigned (get_mode_size_bits)(const ir_mode *mode) {
374 return _get_mode_size_bits(mode);
377 unsigned (get_mode_size_bytes)(const ir_mode *mode) {
378 return _get_mode_size_bytes(mode);
381 int (get_mode_sign)(const ir_mode *mode) {
382 return _get_mode_sign(mode);
385 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) {
395 return _get_mode_modulo_shift(mode);
398 unsigned int (get_mode_n_vector_elems)(const ir_mode *mode) {
399 return _get_mode_vector_elems(mode);
402 void *(get_mode_link)(const ir_mode *mode) {
403 return _get_mode_link(mode);
406 void (set_mode_link)(ir_mode *mode, void *l) {
407 _set_mode_link(mode, l);
410 tarval *get_mode_min(ir_mode *mode) {
412 assert(get_mode_modecode(mode) < (ir_modecode) num_modes);
413 assert(mode_is_data(mode));
418 tarval *get_mode_max(ir_mode *mode) {
420 assert(get_mode_modecode(mode) < (ir_modecode) num_modes);
421 assert(mode_is_data(mode));
426 tarval *get_mode_null(ir_mode *mode) {
428 assert(get_mode_modecode(mode) < (ir_modecode) num_modes);
429 assert(mode_is_datab(mode));
434 tarval *get_mode_one(ir_mode *mode) {
436 assert(get_mode_modecode(mode) < (ir_modecode) num_modes);
437 assert(mode_is_datab(mode));
442 tarval *get_mode_minus_one(ir_mode *mode) {
444 assert(get_mode_modecode(mode) < (ir_modecode) num_modes);
445 assert(mode_is_data(mode));
447 return mode->minus_one;
450 tarval *get_mode_all_one(ir_mode *mode) {
452 assert(get_mode_modecode(mode) < (ir_modecode) num_modes);
453 assert(mode_is_datab(mode));
454 return mode->all_one;
457 tarval *get_mode_infinite(ir_mode *mode) {
459 assert(get_mode_modecode(mode) < (ir_modecode) num_modes);
460 assert(mode_is_float(mode));
462 return get_tarval_plus_inf(mode);
465 tarval *get_mode_NAN(ir_mode *mode) {
467 assert(get_mode_modecode(mode) < (ir_modecode) num_modes);
468 assert(mode_is_float(mode));
470 return get_tarval_nan(mode);
473 int is_mode(void *thing) {
474 if (get_kind(thing) == k_ir_mode)
480 int (mode_is_signed)(const ir_mode *mode) {
481 return _mode_is_signed(mode);
484 int (mode_is_float)(const ir_mode *mode) {
485 return _mode_is_float(mode);
488 int (mode_is_int)(const ir_mode *mode) {
489 return _mode_is_int(mode);
492 int (mode_is_reference)(const ir_mode *mode) {
493 return _mode_is_reference(mode);
496 int (mode_is_num)(const ir_mode *mode) {
497 return _mode_is_num(mode);
500 int (mode_is_data)(const ir_mode *mode) {
501 return _mode_is_data(mode);
504 int (mode_is_datab)(const ir_mode *mode) {
505 return _mode_is_datab(mode);
508 int (mode_is_dataM)(const ir_mode *mode) {
509 return _mode_is_dataM(mode);
512 int (mode_is_float_vector)(const ir_mode *mode) {
513 return _mode_is_float_vector(mode);
516 int (mode_is_int_vector)(const ir_mode *mode) {
517 return _mode_is_int_vector(mode);
520 /* Returns true if sm can be converted to lm without loss. */
521 int smaller_mode(const ir_mode *sm, const ir_mode *lm) {
522 int sm_bits, lm_bits;
527 if (sm == lm) return 1;
529 sm_bits = get_mode_size_bits(sm);
530 lm_bits = get_mode_size_bits(lm);
532 switch (get_mode_sort(sm)) {
533 case irms_int_number:
534 switch (get_mode_sort(lm)) {
535 case irms_int_number:
536 if (get_mode_arithmetic(sm) != get_mode_arithmetic(lm))
539 /* only two complement implemented */
540 assert(get_mode_arithmetic(sm) == irma_twos_complement);
542 /* integers are convertable if
543 * - both have the same sign and lm is the larger one
544 * - lm is the signed one and is at least two bits larger
545 * (one for the sign, one for the highest bit of sm)
546 * - sm & lm are two_complement and lm has greater or equal number of bits
548 if (mode_is_signed(sm)) {
549 if (!mode_is_signed(lm))
551 return sm_bits <= lm_bits;
553 if (mode_is_signed(lm)) {
554 return sm_bits < lm_bits;
556 return sm_bits <= lm_bits;
560 case irms_float_number:
561 /* int to float works if the float is large enough */
569 case irms_float_number:
570 if (get_mode_arithmetic(sm) == get_mode_arithmetic(lm)) {
571 if ( (get_mode_sort(lm) == irms_float_number)
572 && (get_mode_size_bits(lm) >= get_mode_size_bits(sm)) )
578 /* do exist machines out there with different pointer lenghts ?*/
581 case irms_internal_boolean:
582 return mode_is_int(lm);
592 /* Returns true if a value of mode sm can be converted into mode lm
593 and backwards without loss. */
594 int values_in_mode(const ir_mode *sm, const ir_mode *lm) {
595 int sm_bits, lm_bits;
596 ir_mode_arithmetic arith;
601 if (sm == lm) return 1;
604 return mode_is_int(lm);
606 sm_bits = get_mode_size_bits(sm);
607 lm_bits = get_mode_size_bits(lm);
609 arith = get_mode_arithmetic(sm);
610 if (arith != get_mode_arithmetic(lm))
614 case irma_twos_complement:
616 return get_mode_size_bits(sm) <= get_mode_size_bits(lm);
623 /* Return the signed integer equivalent mode for an reference mode. */
624 ir_mode *get_reference_mode_signed_eq(ir_mode *mode) {
625 assert(mode_is_reference(mode));
626 return mode->eq_signed;
629 /* Sets the signed integer equivalent mode for an reference mode. */
630 void set_reference_mode_signed_eq(ir_mode *ref_mode, ir_mode *int_mode) {
631 assert(mode_is_reference(ref_mode));
632 assert(mode_is_int(int_mode));
633 ref_mode->eq_signed = int_mode;
636 /* Return the unsigned integer equivalent mode for an reference mode. */
637 ir_mode *get_reference_mode_unsigned_eq(ir_mode *mode) {
638 assert(mode_is_reference(mode));
639 return mode->eq_unsigned;
642 /* Sets the unsigned integer equivalent mode for an reference mode. */
643 void set_reference_mode_unsigned_eq(ir_mode *ref_mode, ir_mode *int_mode) {
644 assert(mode_is_reference(ref_mode));
645 assert(mode_is_int(int_mode));
646 ref_mode->eq_unsigned = int_mode;
649 /* initialization, build the default modes */
650 void init_mode(void) {
653 obstack_init(&modes);
654 mode_list = NEW_ARR_F(ir_mode*, 0);
657 /* initialize predefined modes */
660 newmode.arithmetic = irma_none;
663 newmode.modulo_shift = 0;
664 newmode.vector_elem = 0;
665 newmode.eq_signed = NULL;
666 newmode.eq_unsigned = NULL;
668 newmode.tv_priv = NULL;
670 /* Control Flow Modes*/
671 newmode.sort = irms_control_flow;
674 newmode.name = new_id_from_chars("BB", 2);
675 newmode.code = irm_BB;
677 mode_BB = register_mode(&newmode);
680 newmode.name = new_id_from_chars("X", 1);
681 newmode.code = irm_X;
683 mode_X = register_mode(&newmode);
686 newmode.sort = irms_memory;
689 newmode.name = new_id_from_chars("M", 1);
690 newmode.code = irm_M;
692 mode_M = register_mode(&newmode);
694 /* Auxiliary Modes */
695 newmode.sort = irms_auxiliary,
698 newmode.name = new_id_from_chars("T", 1);
699 newmode.code = irm_T;
701 mode_T = register_mode(&newmode);
704 newmode.name = new_id_from_chars("ANY", 3);
705 newmode.code = irm_ANY;
707 mode_ANY = register_mode(&newmode);
710 newmode.name = new_id_from_chars("BAD", 3);
711 newmode.code = irm_BAD;
713 mode_BAD = register_mode(&newmode);
715 /* Internal Boolean Modes */
716 newmode.sort = irms_internal_boolean;
719 newmode.name = new_id_from_chars("b", 1);
720 newmode.code = irm_b;
722 mode_b = register_mode(&newmode);
725 newmode.vector_elem = 1;
727 /* Float Number Modes */
728 newmode.sort = irms_float_number;
729 newmode.arithmetic = irma_ieee754;
732 newmode.name = new_id_from_chars("F", 1);
733 newmode.code = irm_F;
737 mode_F = register_mode(&newmode);
740 newmode.name = new_id_from_chars("D", 1);
741 newmode.code = irm_D;
745 mode_D = register_mode(&newmode);
748 newmode.name = new_id_from_chars("E", 1);
749 newmode.code = irm_E;
753 mode_E = register_mode(&newmode);
755 /* Integer Number Modes */
756 newmode.sort = irms_int_number;
757 newmode.arithmetic = irma_twos_complement;
760 newmode.name = new_id_from_chars("Bs", 2);
761 newmode.code = irm_Bs;
764 newmode.modulo_shift = 32;
766 mode_Bs = register_mode(&newmode);
769 newmode.name = new_id_from_chars("Bu", 2);
770 newmode.code = irm_Bu;
771 newmode.arithmetic = irma_twos_complement;
774 newmode.modulo_shift = 32;
776 mode_Bu = register_mode(&newmode);
778 /* signed short integer */
779 newmode.name = new_id_from_chars("Hs", 2);
780 newmode.code = irm_Hs;
783 newmode.modulo_shift = 32;
785 mode_Hs = register_mode(&newmode);
787 /* unsigned short integer */
788 newmode.name = new_id_from_chars("Hu", 2);
789 newmode.code = irm_Hu;
792 newmode.modulo_shift = 32;
794 mode_Hu = register_mode(&newmode);
797 newmode.name = new_id_from_chars("Is", 2);
798 newmode.code = irm_Is;
801 newmode.modulo_shift = 32;
803 mode_Is = register_mode(&newmode);
805 /* unsigned integer */
806 newmode.name = new_id_from_chars("Iu", 2);
807 newmode.code = irm_Iu;
810 newmode.modulo_shift = 32;
812 mode_Iu = register_mode(&newmode);
814 /* signed long integer */
815 newmode.name = new_id_from_chars("Ls", 2);
816 newmode.code = irm_Ls;
819 newmode.modulo_shift = 64;
821 mode_Ls = register_mode(&newmode);
823 /* unsigned long integer */
824 newmode.name = new_id_from_chars("Lu", 2);
825 newmode.code = irm_Lu;
828 newmode.modulo_shift = 64;
830 mode_Lu = register_mode(&newmode);
832 /* signed long long integer */
833 newmode.name = new_id_from_chars("LLs", 3);
834 newmode.code = irm_LLs;
837 newmode.modulo_shift = 128;
839 mode_LLs = register_mode(&newmode);
841 /* unsigned long long integer */
842 newmode.name = new_id_from_chars("LLu", 3);
843 newmode.code = irm_LLu;
846 newmode.modulo_shift = 128;
848 mode_LLu = register_mode(&newmode);
851 newmode.sort = irms_reference;
852 newmode.arithmetic = irma_twos_complement;
855 newmode.name = new_id_from_chars("P", 1);
856 newmode.code = irm_P;
859 newmode.modulo_shift = 0;
860 newmode.eq_signed = mode_Is;
861 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) {
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) {
887 assert(mode->sort == irms_int_number);
889 return find_mode(&n);
892 /* finds a integer mode with 2*n bits for an integer mode with n bits. */
893 ir_mode *find_double_bits_int_mode(const ir_mode *mode) {
896 assert(mode->sort == irms_int_number && mode->arithmetic == irma_twos_complement);
898 n.size = 2*mode->size;
899 return find_mode(&n);
903 * Returns non-zero if the given mode honors signed zero's, i.e.,
904 * a +0 and a -0 exists and handled differently.
906 int mode_honor_signed_zeros(const ir_mode *mode) {
907 /* for floating point, we know that IEEE 754 has +0 and -0,
908 * but always handles it identical.
911 mode->sort == irms_float_number &&
912 mode->arithmetic != irma_ieee754;
916 * Returns non-zero if the given mode might overflow on unary Minus.
918 * This does NOT happen on IEEE 754.
920 int mode_overflow_on_unary_Minus(const ir_mode *mode) {
921 if (mode->sort == irms_float_number)
922 return mode->arithmetic == irma_ieee754 ? 0 : 1;
927 * Returns non-zero if the mode has a reversed wrap-around
928 * logic, especially (a + x) - x == a.
930 * This is normally true for integer modes, not for floating
933 int mode_wrap_around(const ir_mode *mode) {
934 /* FIXME: better would be an extra mode property */
935 return mode_is_int(mode);
939 * Returns non-zero if the cast from mode src to mode dst is a
940 * reinterpret cast (ie. only the bit pattern is reinterpreted,
941 * no conversion is done)
943 int is_reinterpret_cast(const ir_mode *src, const ir_mode *dst) {
944 ir_mode_arithmetic ma;
948 if (get_mode_size_bits(src) != get_mode_size_bits(dst))
950 ma = get_mode_arithmetic(src);
951 if (ma != get_mode_arithmetic(dst))
954 return ma == irma_twos_complement || ma == irma_ones_complement;
957 void finish_mode(void) {
958 obstack_free(&modes, 0);
959 DEL_ARR_F(mode_list);