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
39 # include "irprog_t.h"
40 # include "irmode_t.h"
48 /** Obstack to hold all modes. */
49 static struct obstack modes;
51 /** Number of defined modes. */
52 static int num_modes = 0;
54 /** The list of all currently existing modes. */
55 static ir_mode **mode_list;
58 * Compare modes that don't need to have their code field
61 * TODO: Add other fields
63 static INLINE int modes_are_equal(const ir_mode *m, const ir_mode *n) {
65 if (m->sort == n->sort &&
66 m->arithmetic == n->arithmetic &&
69 m->modulo_shift == n->modulo_shift &&
70 m->vector_elem == n->vector_elem)
77 * searches the modes obstack for the given mode and returns
78 * a pointer on an equal mode already in the array, NULL if
81 static ir_mode *find_mode(const ir_mode *m) {
83 for (i = ARR_LEN(mode_list) - 1; i >= 0; --i) {
84 ir_mode *n = mode_list[i];
85 if (modes_are_equal(n, m))
91 #ifdef FIRM_STATISTICS
92 /* return the mode index, only needed for statistics */
93 int stat_find_mode_index(const ir_mode *m) {
95 for (i = ARR_LEN(mode_list) - 1; i >= 0; --i) {
96 ir_mode *n = mode_list[i];
97 if (modes_are_equal(n, m))
103 /* return the mode for a given index, only needed for statistics */
104 ir_mode *stat_mode_for_index(int idx) {
105 if (0 <= idx && idx < ARR_LEN(mode_list))
106 return mode_list[idx];
112 * sets special values of modes
114 static void set_mode_values(ir_mode* mode) {
115 switch (get_mode_sort(mode)) {
117 case irms_int_number:
118 case irms_float_number:
119 mode->min = get_tarval_min(mode);
120 mode->max = get_tarval_max(mode);
121 mode->null = get_tarval_null(mode);
122 mode->one = get_tarval_one(mode);
123 mode->minus_one = get_tarval_minus_one(mode);
124 if(get_mode_sort(mode) != irms_float_number) {
125 mode->all_one = get_tarval_all_one(mode);
127 mode->all_one = tarval_bad;
131 case irms_internal_boolean:
132 mode->min = tarval_b_false;
133 mode->max = tarval_b_true;
134 mode->null = tarval_b_false;
135 mode->one = tarval_b_true;
136 mode->minus_one = tarval_bad;
137 mode->all_one = tarval_b_true;
142 case irms_control_flow:
143 mode->min = tarval_bad;
144 mode->max = tarval_bad;
145 mode->null = tarval_bad;
146 mode->one = tarval_bad;
147 mode->minus_one = tarval_bad;
153 * globals defined in irmode.h
156 /* --- Predefined modes --- */
158 /* FIRM internal modes: */
166 /* predefined numerical modes: */
167 ir_mode *mode_F; /* float */
168 ir_mode *mode_D; /* double */
169 ir_mode *mode_E; /* long double */
171 ir_mode *mode_Bs; /* integral values, signed and unsigned */
172 ir_mode *mode_Bu; /* 8 bit */
173 ir_mode *mode_Hs; /* 16 bit */
175 ir_mode *mode_Is; /* 32 bit */
177 ir_mode *mode_Ls; /* 64 bit */
179 ir_mode *mode_LLs; /* 128 bit */
185 /* machine specific modes */
186 ir_mode *mode_P_code; /**< machine specific pointer mode for code addresses */
187 ir_mode *mode_P_data; /**< machine specific pointer mode for data addresses */
190 * functions defined in irmode.h
193 /* JNI access functions */
194 ir_mode *get_modeT(void) { return mode_T; }
195 ir_mode *get_modeF(void) { return mode_F; }
196 ir_mode *get_modeD(void) { return mode_D; }
197 ir_mode *get_modeE(void) { return mode_E; }
198 ir_mode *get_modeBs(void) { return mode_Bs; }
199 ir_mode *get_modeBu(void) { return mode_Bu; }
200 ir_mode *get_modeHs(void) { return mode_Hs; }
201 ir_mode *get_modeHu(void) { return mode_Hu; }
202 ir_mode *get_modeIs(void) { return mode_Is; }
203 ir_mode *get_modeIu(void) { return mode_Iu; }
204 ir_mode *get_modeLs(void) { return mode_Ls; }
205 ir_mode *get_modeLu(void) { return mode_Lu; }
206 ir_mode *get_modeLLs(void){ return mode_LLs; }
207 ir_mode *get_modeLLu(void){ return mode_LLu; }
208 ir_mode *get_modeb(void) { return mode_b; }
209 ir_mode *get_modeP(void) { return mode_P; }
210 ir_mode *get_modeX(void) { return mode_X; }
211 ir_mode *get_modeM(void) { return mode_M; }
212 ir_mode *get_modeBB(void) { return mode_BB; }
213 ir_mode *get_modeANY(void) { return mode_ANY; }
214 ir_mode *get_modeBAD(void) { return mode_BAD; }
217 ir_mode *(get_modeP_code)(void) {
218 return _get_modeP_code();
221 ir_mode *(get_modeP_data)(void) {
222 return _get_modeP_data();
225 void set_modeP_code(ir_mode *p) {
226 assert(mode_is_reference(p));
230 void set_modeP_data(ir_mode *p) {
231 assert(mode_is_reference(p));
236 * Registers a new mode.
238 * @param new_mode The new mode template.
240 static ir_mode *register_mode(const ir_mode *new_mode) {
241 ir_mode *mode = NULL;
245 /* copy mode struct to modes array */
246 mode = (ir_mode *)obstack_copy(&modes, new_mode, sizeof(*mode));
247 ARR_APP1(ir_mode*, mode_list, mode);
249 mode->kind = k_ir_mode;
250 if (num_modes >= irm_max) {
251 mode->code = num_modes;
255 /* add the new mode to the irp list of modes */
258 set_mode_values(mode);
260 hook_new_mode(new_mode, mode);
265 * Creates a new mode.
267 ir_mode *new_ir_mode(const char *name, ir_mode_sort sort, int bit_size, int sign,
268 ir_mode_arithmetic arithmetic, unsigned int modulo_shift)
271 ir_mode *mode = NULL;
273 mode_tmpl.name = new_id_from_str(name);
274 mode_tmpl.sort = sort;
275 mode_tmpl.size = bit_size;
276 mode_tmpl.sign = sign ? 1 : 0;
277 mode_tmpl.modulo_shift = (mode_tmpl.sort == irms_int_number) ? modulo_shift : 0;
278 mode_tmpl.vector_elem = 1;
279 mode_tmpl.arithmetic = arithmetic;
280 mode_tmpl.link = NULL;
281 mode_tmpl.tv_priv = NULL;
283 mode = find_mode(&mode_tmpl);
285 hook_new_mode(&mode_tmpl, mode);
292 case irms_control_flow:
294 case irms_internal_boolean:
295 assert(0 && "internal modes cannot be user defined");
298 case irms_float_number:
299 case irms_int_number:
301 mode = register_mode(&mode_tmpl);
307 * Creates a new vector mode.
309 ir_mode *new_ir_vector_mode(const char *name, ir_mode_sort sort, int bit_size, unsigned num_of_elem, int sign,
310 ir_mode_arithmetic arithmetic, unsigned int modulo_shift)
313 ir_mode *mode = NULL;
315 mode_tmpl.name = new_id_from_str(name);
316 mode_tmpl.sort = sort;
317 mode_tmpl.size = bit_size * num_of_elem;
318 mode_tmpl.sign = sign ? 1 : 0;
319 mode_tmpl.modulo_shift = (mode_tmpl.sort == irms_int_number) ? modulo_shift : 0;
320 mode_tmpl.vector_elem = num_of_elem;
321 mode_tmpl.arithmetic = arithmetic;
322 mode_tmpl.link = NULL;
323 mode_tmpl.tv_priv = NULL;
325 mode = find_mode(&mode_tmpl);
327 hook_new_mode(&mode_tmpl, mode);
331 if (num_of_elem <= 1) {
332 assert(0 && "vector modes should have at least 2 elements");
339 case irms_control_flow:
341 case irms_internal_boolean:
342 assert(0 && "internal modes cannot be user defined");
346 assert(0 && "only integer and floating point modes can be vectorized");
349 case irms_float_number:
350 assert(0 && "not yet implemented");
353 case irms_int_number:
354 mode = register_mode(&mode_tmpl);
359 /* Functions for the direct access to all attributes of an ir_mode */
360 ir_modecode (get_mode_modecode)(const ir_mode *mode) {
361 return _get_mode_modecode(mode);
364 ident *(get_mode_ident)(const ir_mode *mode) {
365 return _get_mode_ident(mode);
368 const char *get_mode_name(const ir_mode *mode) {
369 return get_id_str(mode->name);
372 ir_mode_sort (get_mode_sort)(const ir_mode* mode) {
373 return _get_mode_sort(mode);
376 unsigned (get_mode_size_bits)(const ir_mode *mode) {
377 return _get_mode_size_bits(mode);
380 unsigned (get_mode_size_bytes)(const ir_mode *mode) {
381 return _get_mode_size_bytes(mode);
384 int (get_mode_sign)(const ir_mode *mode) {
385 return _get_mode_sign(mode);
388 ir_mode_arithmetic (get_mode_arithmetic)(const ir_mode *mode) {
389 return get_mode_arithmetic(mode);
393 /* Attribute modulo shift specifies for modes of kind irms_int_number
394 * whether shift applies modulo to value of bits to shift. Asserts
395 * if mode is not irms_int_number.
397 unsigned int (get_mode_modulo_shift)(const ir_mode *mode) {
398 return _get_mode_modulo_shift(mode);
401 unsigned int (get_mode_n_vector_elems)(const ir_mode *mode) {
402 return _get_mode_vector_elems(mode);
405 void *(get_mode_link)(const ir_mode *mode) {
406 return _get_mode_link(mode);
409 void (set_mode_link)(ir_mode *mode, void *l) {
410 _set_mode_link(mode, l);
413 tarval *get_mode_min(ir_mode *mode) {
415 assert(get_mode_modecode(mode) < (ir_modecode) num_modes);
416 assert(mode_is_data(mode));
421 tarval *get_mode_max(ir_mode *mode) {
423 assert(get_mode_modecode(mode) < (ir_modecode) num_modes);
424 assert(mode_is_data(mode));
429 tarval *get_mode_null(ir_mode *mode) {
431 assert(get_mode_modecode(mode) < (ir_modecode) num_modes);
432 assert(mode_is_datab(mode));
437 tarval *get_mode_one(ir_mode *mode) {
439 assert(get_mode_modecode(mode) < (ir_modecode) num_modes);
440 assert(mode_is_datab(mode));
445 tarval *get_mode_minus_one(ir_mode *mode) {
447 assert(get_mode_modecode(mode) < (ir_modecode) num_modes);
448 assert(mode_is_data(mode));
450 return mode->minus_one;
453 tarval *get_mode_all_one(ir_mode *mode) {
455 assert(get_mode_modecode(mode) < (ir_modecode) num_modes);
456 assert(mode_is_datab(mode));
457 return mode->all_one;
460 tarval *get_mode_infinite(ir_mode *mode) {
462 assert(get_mode_modecode(mode) < (ir_modecode) num_modes);
463 assert(mode_is_float(mode));
465 return get_tarval_plus_inf(mode);
468 tarval *get_mode_NAN(ir_mode *mode) {
470 assert(get_mode_modecode(mode) < (ir_modecode) num_modes);
471 assert(mode_is_float(mode));
473 return get_tarval_nan(mode);
476 int is_mode(void *thing) {
477 if (get_kind(thing) == k_ir_mode)
483 int (mode_is_signed)(const ir_mode *mode) {
484 return _mode_is_signed(mode);
487 int (mode_is_float)(const ir_mode *mode) {
488 return _mode_is_float(mode);
491 int (mode_is_int)(const ir_mode *mode) {
492 return _mode_is_int(mode);
495 int (mode_is_reference)(const ir_mode *mode) {
496 return _mode_is_reference(mode);
499 int (mode_is_num)(const ir_mode *mode) {
500 return _mode_is_num(mode);
503 int (mode_is_data)(const ir_mode *mode) {
504 return _mode_is_data(mode);
507 int (mode_is_datab)(const ir_mode *mode) {
508 return _mode_is_datab(mode);
511 int (mode_is_dataM)(const ir_mode *mode) {
512 return _mode_is_dataM(mode);
515 int (mode_is_float_vector)(const ir_mode *mode) {
516 return _mode_is_float_vector(mode);
519 int (mode_is_int_vector)(const ir_mode *mode) {
520 return _mode_is_int_vector(mode);
523 /* Returns true if sm can be converted to lm without loss. */
524 int smaller_mode(const ir_mode *sm, const ir_mode *lm) {
525 int sm_bits, lm_bits;
530 if (sm == lm) return 1;
532 sm_bits = get_mode_size_bits(sm);
533 lm_bits = get_mode_size_bits(lm);
535 switch (get_mode_sort(sm)) {
536 case irms_int_number:
537 switch (get_mode_sort(lm)) {
538 case irms_int_number:
539 if (get_mode_arithmetic(sm) != get_mode_arithmetic(lm))
542 /* only two complement implemented */
543 assert(get_mode_arithmetic(sm) == irma_twos_complement);
545 /* integers are convertable if
546 * - both have the same sign and lm is the larger one
547 * - lm is the signed one and is at least two bits larger
548 * (one for the sign, one for the highest bit of sm)
549 * - sm & lm are two_complement and lm has greater or equal number of bits
551 if (mode_is_signed(sm)) {
552 if (!mode_is_signed(lm))
554 return sm_bits <= lm_bits;
556 if (mode_is_signed(lm)) {
557 return sm_bits < lm_bits;
559 return sm_bits <= lm_bits;
563 case irms_float_number:
564 /* int to float works if the float is large enough */
572 case irms_float_number:
573 if (get_mode_arithmetic(sm) == get_mode_arithmetic(lm)) {
574 if ( (get_mode_sort(lm) == irms_float_number)
575 && (get_mode_size_bits(lm) >= get_mode_size_bits(sm)) )
581 /* do exist machines out there with different pointer lenghts ?*/
584 case irms_internal_boolean:
585 return mode_is_int(lm);
595 /* Returns true if a value of mode sm can be converted into mode lm
596 and backwards without loss. */
597 int values_in_mode(const ir_mode *sm, const ir_mode *lm) {
598 int sm_bits, lm_bits;
599 ir_mode_arithmetic arith;
604 if (sm == lm) return 1;
607 return mode_is_int(lm);
609 sm_bits = get_mode_size_bits(sm);
610 lm_bits = get_mode_size_bits(lm);
612 arith = get_mode_arithmetic(sm);
613 if (arith != get_mode_arithmetic(lm))
617 case irma_twos_complement:
619 return get_mode_size_bits(sm) <= get_mode_size_bits(lm);
626 /* Return the signed integer equivalent mode for an reference mode. */
627 ir_mode *get_reference_mode_signed_eq(ir_mode *mode) {
628 assert(mode_is_reference(mode));
629 return mode->eq_signed;
632 /* Sets the signed integer equivalent mode for an reference mode. */
633 void set_reference_mode_signed_eq(ir_mode *ref_mode, ir_mode *int_mode) {
634 assert(mode_is_reference(ref_mode));
635 assert(mode_is_int(int_mode));
636 ref_mode->eq_signed = int_mode;
639 /* Return the unsigned integer equivalent mode for an reference mode. */
640 ir_mode *get_reference_mode_unsigned_eq(ir_mode *mode) {
641 assert(mode_is_reference(mode));
642 return mode->eq_unsigned;
645 /* Sets the unsigned integer equivalent mode for an reference mode. */
646 void set_reference_mode_unsigned_eq(ir_mode *ref_mode, ir_mode *int_mode) {
647 assert(mode_is_reference(ref_mode));
648 assert(mode_is_int(int_mode));
649 ref_mode->eq_unsigned = int_mode;
652 /* initialization, build the default modes */
653 void init_mode(void) {
656 obstack_init(&modes);
657 mode_list = NEW_ARR_F(ir_mode*, 0);
660 /* initialize predefined modes */
663 newmode.arithmetic = irma_none;
666 newmode.modulo_shift = 0;
667 newmode.vector_elem = 0;
668 newmode.eq_signed = NULL;
669 newmode.eq_unsigned = NULL;
671 newmode.tv_priv = NULL;
673 /* Control Flow Modes*/
674 newmode.sort = irms_control_flow;
677 newmode.name = new_id_from_chars("BB", 2);
678 newmode.code = irm_BB;
680 mode_BB = register_mode(&newmode);
683 newmode.name = new_id_from_chars("X", 1);
684 newmode.code = irm_X;
686 mode_X = register_mode(&newmode);
689 newmode.sort = irms_memory;
692 newmode.name = new_id_from_chars("M", 1);
693 newmode.code = irm_M;
695 mode_M = register_mode(&newmode);
697 /* Auxiliary Modes */
698 newmode.sort = irms_auxiliary,
701 newmode.name = new_id_from_chars("T", 1);
702 newmode.code = irm_T;
704 mode_T = register_mode(&newmode);
707 newmode.name = new_id_from_chars("ANY", 3);
708 newmode.code = irm_ANY;
710 mode_ANY = register_mode(&newmode);
713 newmode.name = new_id_from_chars("BAD", 3);
714 newmode.code = irm_BAD;
716 mode_BAD = register_mode(&newmode);
718 /* Internal Boolean Modes */
719 newmode.sort = irms_internal_boolean;
722 newmode.name = new_id_from_chars("b", 1);
723 newmode.code = irm_b;
725 mode_b = register_mode(&newmode);
728 newmode.vector_elem = 1;
730 /* Float Number Modes */
731 newmode.sort = irms_float_number;
732 newmode.arithmetic = irma_ieee754;
735 newmode.name = new_id_from_chars("F", 1);
736 newmode.code = irm_F;
740 mode_F = register_mode(&newmode);
743 newmode.name = new_id_from_chars("D", 1);
744 newmode.code = irm_D;
748 mode_D = register_mode(&newmode);
751 newmode.name = new_id_from_chars("E", 1);
752 newmode.code = irm_E;
756 mode_E = register_mode(&newmode);
758 /* Integer Number Modes */
759 newmode.sort = irms_int_number;
760 newmode.arithmetic = irma_twos_complement;
763 newmode.name = new_id_from_chars("Bs", 2);
764 newmode.code = irm_Bs;
767 newmode.modulo_shift = 32;
769 mode_Bs = register_mode(&newmode);
772 newmode.name = new_id_from_chars("Bu", 2);
773 newmode.code = irm_Bu;
774 newmode.arithmetic = irma_twos_complement;
777 newmode.modulo_shift = 32;
779 mode_Bu = register_mode(&newmode);
781 /* signed short integer */
782 newmode.name = new_id_from_chars("Hs", 2);
783 newmode.code = irm_Hs;
786 newmode.modulo_shift = 32;
788 mode_Hs = register_mode(&newmode);
790 /* unsigned short integer */
791 newmode.name = new_id_from_chars("Hu", 2);
792 newmode.code = irm_Hu;
795 newmode.modulo_shift = 32;
797 mode_Hu = register_mode(&newmode);
800 newmode.name = new_id_from_chars("Is", 2);
801 newmode.code = irm_Is;
804 newmode.modulo_shift = 32;
806 mode_Is = register_mode(&newmode);
808 /* unsigned integer */
809 newmode.name = new_id_from_chars("Iu", 2);
810 newmode.code = irm_Iu;
813 newmode.modulo_shift = 32;
815 mode_Iu = register_mode(&newmode);
817 /* signed long integer */
818 newmode.name = new_id_from_chars("Ls", 2);
819 newmode.code = irm_Ls;
822 newmode.modulo_shift = 64;
824 mode_Ls = register_mode(&newmode);
826 /* unsigned long integer */
827 newmode.name = new_id_from_chars("Lu", 2);
828 newmode.code = irm_Lu;
831 newmode.modulo_shift = 64;
833 mode_Lu = register_mode(&newmode);
835 /* signed long long integer */
836 newmode.name = new_id_from_chars("LLs", 3);
837 newmode.code = irm_LLs;
840 newmode.modulo_shift = 128;
842 mode_LLs = register_mode(&newmode);
844 /* unsigned long long integer */
845 newmode.name = new_id_from_chars("LLu", 3);
846 newmode.code = irm_LLu;
849 newmode.modulo_shift = 128;
851 mode_LLu = register_mode(&newmode);
854 newmode.sort = irms_reference;
855 newmode.arithmetic = irma_twos_complement;
858 newmode.name = new_id_from_chars("P", 1);
859 newmode.code = irm_P;
862 newmode.modulo_shift = 0;
863 newmode.eq_signed = mode_Is;
864 newmode.eq_unsigned = mode_Iu;
866 mode_P = register_mode(&newmode);
868 /* set the machine specific modes to the predefined ones */
869 mode_P_code = mode_P;
870 mode_P_data = mode_P;
873 /* find a signed mode for an unsigned integer mode */
874 ir_mode *find_unsigned_mode(const ir_mode *mode) {
877 /* allowed for reference mode */
878 if (mode->sort == irms_reference)
879 n.sort = irms_int_number;
881 assert(n.sort == irms_int_number);
883 return find_mode(&n);
886 /* find an unsigned mode for a signed integer mode */
887 ir_mode *find_signed_mode(const ir_mode *mode) {
890 assert(mode->sort == irms_int_number);
892 return find_mode(&n);
895 /* finds a integer mode with 2*n bits for an integer mode with n bits. */
896 ir_mode *find_double_bits_int_mode(const ir_mode *mode) {
899 assert(mode->sort == irms_int_number && mode->arithmetic == irma_twos_complement);
901 n.size = 2*mode->size;
902 return find_mode(&n);
906 * Returns non-zero if the given mode honors signed zero's, i.e.,
907 * a +0 and a -0 exists and handled differently.
909 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) {
924 if (mode->sort == irms_float_number)
925 return mode->arithmetic == irma_ieee754 ? 0 : 1;
930 * Returns non-zero if the mode has a reversed wrap-around
931 * logic, especially (a + x) - x == a.
933 * This is normally true for integer modes, not for floating
936 int mode_wrap_around(const ir_mode *mode) {
937 /* FIXME: better would be an extra mode property */
938 return mode_is_int(mode);
942 * Returns non-zero if the cast from mode src to mode dst is a
943 * reinterpret cast (ie. only the bit pattern is reinterpreted,
944 * no conversion is done)
946 int is_reinterpret_cast(const ir_mode *src, const ir_mode *dst) {
947 ir_mode_arithmetic ma;
951 if (get_mode_size_bits(src) != get_mode_size_bits(dst))
953 ma = get_mode_arithmetic(src);
954 if (ma != get_mode_arithmetic(dst))
957 return ma == irma_twos_complement || ma == irma_ones_complement;
960 void finish_mode(void) {
961 obstack_free(&modes, 0);
962 DEL_ARR_F(mode_list);