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;
53 * Compare modes that don't need to have their code field
56 * TODO: Add other fields
58 static inline int modes_are_equal(const ir_mode *m, const ir_mode *n) {
60 if (m->sort == n->sort &&
61 m->arithmetic == n->arithmetic &&
64 m->modulo_shift == n->modulo_shift &&
65 m->vector_elem == n->vector_elem)
72 * searches the modes obstack for the given mode and returns
73 * a pointer on an equal mode already in the array, NULL if
76 static ir_mode *find_mode(const ir_mode *m) {
78 for (i = ARR_LEN(mode_list) - 1; i >= 0; --i) {
79 ir_mode *n = mode_list[i];
80 if (modes_are_equal(n, m))
86 #ifdef FIRM_STATISTICS
87 /* return the mode index, only needed for statistics */
88 int stat_find_mode_index(const ir_mode *m) {
90 for (i = ARR_LEN(mode_list) - 1; i >= 0; --i) {
91 ir_mode *n = mode_list[i];
92 if (modes_are_equal(n, m))
98 /* return the mode for a given index, only needed for statistics */
99 ir_mode *stat_mode_for_index(int idx) {
100 if (0 <= idx && idx < ARR_LEN(mode_list))
101 return mode_list[idx];
107 * sets special values of modes
109 static void set_mode_values(ir_mode* mode) {
110 switch (get_mode_sort(mode)) {
112 case irms_int_number:
113 case irms_float_number:
114 mode->min = get_tarval_min(mode);
115 mode->max = get_tarval_max(mode);
116 mode->null = get_tarval_null(mode);
117 mode->one = get_tarval_one(mode);
118 mode->minus_one = get_tarval_minus_one(mode);
119 if(get_mode_sort(mode) != irms_float_number) {
120 mode->all_one = get_tarval_all_one(mode);
122 mode->all_one = tarval_bad;
126 case irms_internal_boolean:
127 mode->min = tarval_b_false;
128 mode->max = tarval_b_true;
129 mode->null = tarval_b_false;
130 mode->one = tarval_b_true;
131 mode->minus_one = tarval_bad;
132 mode->all_one = tarval_b_true;
137 case irms_control_flow:
138 mode->min = tarval_bad;
139 mode->max = tarval_bad;
140 mode->null = tarval_bad;
141 mode->one = tarval_bad;
142 mode->minus_one = tarval_bad;
148 * globals defined in irmode.h
151 /* --- Predefined modes --- */
153 /* FIRM internal modes: */
161 /* predefined numerical modes: */
162 ir_mode *mode_F; /* float */
163 ir_mode *mode_D; /* double */
164 ir_mode *mode_E; /* long double */
166 ir_mode *mode_Bs; /* integral values, signed and unsigned */
167 ir_mode *mode_Bu; /* 8 bit */
168 ir_mode *mode_Hs; /* 16 bit */
170 ir_mode *mode_Is; /* 32 bit */
172 ir_mode *mode_Ls; /* 64 bit */
174 ir_mode *mode_LLs; /* 128 bit */
180 /* machine specific modes */
181 ir_mode *mode_P_code; /**< machine specific pointer mode for code addresses */
182 ir_mode *mode_P_data; /**< machine specific pointer mode for data addresses */
185 * functions defined in irmode.h
188 /* JNI access functions */
189 ir_mode *get_modeT(void) { return mode_T; }
190 ir_mode *get_modeF(void) { return mode_F; }
191 ir_mode *get_modeD(void) { return mode_D; }
192 ir_mode *get_modeE(void) { return mode_E; }
193 ir_mode *get_modeBs(void) { return mode_Bs; }
194 ir_mode *get_modeBu(void) { return mode_Bu; }
195 ir_mode *get_modeHs(void) { return mode_Hs; }
196 ir_mode *get_modeHu(void) { return mode_Hu; }
197 ir_mode *get_modeIs(void) { return mode_Is; }
198 ir_mode *get_modeIu(void) { return mode_Iu; }
199 ir_mode *get_modeLs(void) { return mode_Ls; }
200 ir_mode *get_modeLu(void) { return mode_Lu; }
201 ir_mode *get_modeLLs(void){ return mode_LLs; }
202 ir_mode *get_modeLLu(void){ return mode_LLu; }
203 ir_mode *get_modeb(void) { return mode_b; }
204 ir_mode *get_modeP(void) { return mode_P; }
205 ir_mode *get_modeX(void) { return mode_X; }
206 ir_mode *get_modeM(void) { return mode_M; }
207 ir_mode *get_modeBB(void) { return mode_BB; }
208 ir_mode *get_modeANY(void) { return mode_ANY; }
209 ir_mode *get_modeBAD(void) { return mode_BAD; }
212 ir_mode *(get_modeP_code)(void) {
213 return _get_modeP_code();
216 ir_mode *(get_modeP_data)(void) {
217 return _get_modeP_data();
220 void set_modeP_code(ir_mode *p) {
221 assert(mode_is_reference(p));
225 void set_modeP_data(ir_mode *p) {
226 assert(mode_is_reference(p));
231 * Registers a new mode.
233 * @param new_mode The new mode template.
235 static ir_mode *register_mode(const ir_mode *new_mode) {
236 ir_mode *mode = NULL;
240 /* copy mode struct to modes array */
241 mode = (ir_mode *)obstack_copy(&modes, new_mode, sizeof(*mode));
242 ARR_APP1(ir_mode*, mode_list, mode);
244 mode->kind = k_ir_mode;
245 if (num_modes >= irm_max) {
246 mode->code = num_modes;
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) ? modulo_shift : 0;
273 mode_tmpl.vector_elem = 1;
274 mode_tmpl.arithmetic = arithmetic;
275 mode_tmpl.link = NULL;
276 mode_tmpl.tv_priv = NULL;
278 mode = find_mode(&mode_tmpl);
280 hook_new_mode(&mode_tmpl, mode);
287 case irms_control_flow:
289 case irms_internal_boolean:
290 panic("internal modes cannot be user defined");
292 case irms_float_number:
293 case irms_int_number:
295 mode = register_mode(&mode_tmpl);
298 assert(mode != NULL);
303 * Creates a new vector mode.
305 ir_mode *new_ir_vector_mode(const char *name, ir_mode_sort sort, int bit_size, unsigned num_of_elem, int sign,
306 ir_mode_arithmetic arithmetic, unsigned int modulo_shift)
309 ir_mode *mode = NULL;
311 mode_tmpl.name = new_id_from_str(name);
312 mode_tmpl.sort = sort;
313 mode_tmpl.size = bit_size * num_of_elem;
314 mode_tmpl.sign = sign ? 1 : 0;
315 mode_tmpl.modulo_shift = (mode_tmpl.sort == irms_int_number) ? modulo_shift : 0;
316 mode_tmpl.vector_elem = num_of_elem;
317 mode_tmpl.arithmetic = arithmetic;
318 mode_tmpl.link = NULL;
319 mode_tmpl.tv_priv = NULL;
321 mode = find_mode(&mode_tmpl);
323 hook_new_mode(&mode_tmpl, mode);
327 if (num_of_elem <= 1) {
328 assert(0 && "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 ir_modecode (get_mode_modecode)(const ir_mode *mode) {
355 return _get_mode_modecode(mode);
358 ident *(get_mode_ident)(const ir_mode *mode) {
359 return _get_mode_ident(mode);
362 const char *get_mode_name(const ir_mode *mode) {
363 return get_id_str(mode->name);
366 ir_mode_sort (get_mode_sort)(const ir_mode* mode) {
367 return _get_mode_sort(mode);
370 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) {
375 return _get_mode_size_bytes(mode);
378 int (get_mode_sign)(const ir_mode *mode) {
379 return _get_mode_sign(mode);
382 ir_mode_arithmetic (get_mode_arithmetic)(const ir_mode *mode) {
383 return get_mode_arithmetic(mode);
387 /* Attribute modulo shift specifies for modes of kind irms_int_number
388 * whether shift applies modulo to value of bits to shift. Asserts
389 * if mode is not irms_int_number.
391 unsigned int (get_mode_modulo_shift)(const ir_mode *mode) {
392 return _get_mode_modulo_shift(mode);
395 unsigned int (get_mode_n_vector_elems)(const ir_mode *mode) {
396 return _get_mode_vector_elems(mode);
399 void *(get_mode_link)(const ir_mode *mode) {
400 return _get_mode_link(mode);
403 void (set_mode_link)(ir_mode *mode, void *l) {
404 _set_mode_link(mode, l);
407 tarval *get_mode_min(ir_mode *mode) {
409 assert(get_mode_modecode(mode) < (ir_modecode) num_modes);
410 assert(mode_is_data(mode));
415 tarval *get_mode_max(ir_mode *mode) {
417 assert(get_mode_modecode(mode) < (ir_modecode) num_modes);
418 assert(mode_is_data(mode));
423 tarval *get_mode_null(ir_mode *mode) {
425 assert(get_mode_modecode(mode) < (ir_modecode) num_modes);
426 assert(mode_is_datab(mode));
431 tarval *get_mode_one(ir_mode *mode) {
433 assert(get_mode_modecode(mode) < (ir_modecode) num_modes);
434 assert(mode_is_datab(mode));
439 tarval *get_mode_minus_one(ir_mode *mode) {
441 assert(get_mode_modecode(mode) < (ir_modecode) num_modes);
442 assert(mode_is_data(mode));
444 return mode->minus_one;
447 tarval *get_mode_all_one(ir_mode *mode) {
449 assert(get_mode_modecode(mode) < (ir_modecode) num_modes);
450 assert(mode_is_datab(mode));
451 return mode->all_one;
454 tarval *get_mode_infinite(ir_mode *mode) {
456 assert(get_mode_modecode(mode) < (ir_modecode) num_modes);
457 assert(mode_is_float(mode));
459 return get_tarval_plus_inf(mode);
462 tarval *get_mode_NAN(ir_mode *mode) {
464 assert(get_mode_modecode(mode) < (ir_modecode) num_modes);
465 assert(mode_is_float(mode));
467 return get_tarval_nan(mode);
470 int is_mode(void *thing) {
471 if (get_kind(thing) == k_ir_mode)
477 int (mode_is_signed)(const ir_mode *mode) {
478 return _mode_is_signed(mode);
481 int (mode_is_float)(const ir_mode *mode) {
482 return _mode_is_float(mode);
485 int (mode_is_int)(const ir_mode *mode) {
486 return _mode_is_int(mode);
489 int (mode_is_reference)(const ir_mode *mode) {
490 return _mode_is_reference(mode);
493 int (mode_is_num)(const ir_mode *mode) {
494 return _mode_is_num(mode);
497 int (mode_is_data)(const ir_mode *mode) {
498 return _mode_is_data(mode);
501 int (mode_is_datab)(const ir_mode *mode) {
502 return _mode_is_datab(mode);
505 int (mode_is_dataM)(const ir_mode *mode) {
506 return _mode_is_dataM(mode);
509 int (mode_is_float_vector)(const ir_mode *mode) {
510 return _mode_is_float_vector(mode);
513 int (mode_is_int_vector)(const ir_mode *mode) {
514 return _mode_is_int_vector(mode);
517 /* Returns true if sm can be converted to lm without loss. */
518 int smaller_mode(const ir_mode *sm, const ir_mode *lm) {
519 int sm_bits, lm_bits;
524 if (sm == lm) return 1;
526 sm_bits = get_mode_size_bits(sm);
527 lm_bits = get_mode_size_bits(lm);
529 switch (get_mode_sort(sm)) {
530 case irms_int_number:
531 switch (get_mode_sort(lm)) {
532 case irms_int_number:
533 if (get_mode_arithmetic(sm) != get_mode_arithmetic(lm))
536 /* only two complement implemented */
537 assert(get_mode_arithmetic(sm) == irma_twos_complement);
539 /* integers are convertable if
540 * - both have the same sign and lm is the larger one
541 * - lm is the signed one and is at least two bits larger
542 * (one for the sign, one for the highest bit of sm)
543 * - sm & lm are two_complement and lm has greater or equal number of bits
545 if (mode_is_signed(sm)) {
546 if (!mode_is_signed(lm))
548 return sm_bits <= lm_bits;
550 if (mode_is_signed(lm)) {
551 return sm_bits < lm_bits;
553 return sm_bits <= lm_bits;
557 case irms_float_number:
558 /* int to float works if the float is large enough */
566 case irms_float_number:
567 if (get_mode_arithmetic(sm) == get_mode_arithmetic(lm)) {
568 if ( (get_mode_sort(lm) == irms_float_number)
569 && (get_mode_size_bits(lm) >= get_mode_size_bits(sm)) )
575 /* do exist machines out there with different pointer lenghts ?*/
578 case irms_internal_boolean:
579 return mode_is_int(lm);
589 /* Returns true if a value of mode sm can be converted into mode lm
590 and backwards without loss. */
591 int values_in_mode(const ir_mode *sm, const ir_mode *lm) {
592 int sm_bits, lm_bits;
593 ir_mode_arithmetic arith;
598 if (sm == lm) return 1;
601 return mode_is_int(lm);
603 sm_bits = get_mode_size_bits(sm);
604 lm_bits = get_mode_size_bits(lm);
606 arith = get_mode_arithmetic(sm);
607 if (arith != get_mode_arithmetic(lm))
611 case irma_twos_complement:
613 return get_mode_size_bits(sm) <= get_mode_size_bits(lm);
620 /* Return the signed integer equivalent mode for an reference mode. */
621 ir_mode *get_reference_mode_signed_eq(ir_mode *mode) {
622 assert(mode_is_reference(mode));
623 return mode->eq_signed;
626 /* Sets the signed integer equivalent mode for an reference mode. */
627 void set_reference_mode_signed_eq(ir_mode *ref_mode, ir_mode *int_mode) {
628 assert(mode_is_reference(ref_mode));
629 assert(mode_is_int(int_mode));
630 ref_mode->eq_signed = int_mode;
633 /* Return the unsigned integer equivalent mode for an reference mode. */
634 ir_mode *get_reference_mode_unsigned_eq(ir_mode *mode) {
635 assert(mode_is_reference(mode));
636 return mode->eq_unsigned;
639 /* Sets the unsigned integer equivalent mode for an reference mode. */
640 void set_reference_mode_unsigned_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_unsigned = int_mode;
646 /* initialization, build the default modes */
647 void init_mode(void) {
650 obstack_init(&modes);
651 mode_list = NEW_ARR_F(ir_mode*, 0);
654 /* initialize predefined modes */
657 newmode.arithmetic = irma_none;
660 newmode.modulo_shift = 0;
661 newmode.vector_elem = 0;
662 newmode.eq_signed = NULL;
663 newmode.eq_unsigned = NULL;
665 newmode.tv_priv = NULL;
667 /* Control Flow Modes*/
668 newmode.sort = irms_control_flow;
671 newmode.name = new_id_from_chars("BB", 2);
672 newmode.code = irm_BB;
674 mode_BB = register_mode(&newmode);
677 newmode.name = new_id_from_chars("X", 1);
678 newmode.code = irm_X;
680 mode_X = register_mode(&newmode);
683 newmode.sort = irms_memory;
686 newmode.name = new_id_from_chars("M", 1);
687 newmode.code = irm_M;
689 mode_M = register_mode(&newmode);
691 /* Auxiliary Modes */
692 newmode.sort = irms_auxiliary,
695 newmode.name = new_id_from_chars("T", 1);
696 newmode.code = irm_T;
698 mode_T = register_mode(&newmode);
701 newmode.name = new_id_from_chars("ANY", 3);
702 newmode.code = irm_ANY;
704 mode_ANY = register_mode(&newmode);
707 newmode.name = new_id_from_chars("BAD", 3);
708 newmode.code = irm_BAD;
710 mode_BAD = register_mode(&newmode);
712 /* Internal Boolean Modes */
713 newmode.sort = irms_internal_boolean;
716 newmode.name = new_id_from_chars("b", 1);
717 newmode.code = irm_b;
719 mode_b = register_mode(&newmode);
722 newmode.vector_elem = 1;
724 /* Float Number Modes */
725 newmode.sort = irms_float_number;
726 newmode.arithmetic = irma_ieee754;
729 newmode.name = new_id_from_chars("F", 1);
730 newmode.code = irm_F;
734 mode_F = register_mode(&newmode);
737 newmode.name = new_id_from_chars("D", 1);
738 newmode.code = irm_D;
742 mode_D = register_mode(&newmode);
745 newmode.name = new_id_from_chars("E", 1);
746 newmode.code = irm_E;
750 mode_E = register_mode(&newmode);
752 /* Integer Number Modes */
753 newmode.sort = irms_int_number;
754 newmode.arithmetic = irma_twos_complement;
757 newmode.name = new_id_from_chars("Bs", 2);
758 newmode.code = irm_Bs;
761 newmode.modulo_shift = 32;
763 mode_Bs = register_mode(&newmode);
766 newmode.name = new_id_from_chars("Bu", 2);
767 newmode.code = irm_Bu;
768 newmode.arithmetic = irma_twos_complement;
771 newmode.modulo_shift = 32;
773 mode_Bu = register_mode(&newmode);
775 /* signed short integer */
776 newmode.name = new_id_from_chars("Hs", 2);
777 newmode.code = irm_Hs;
780 newmode.modulo_shift = 32;
782 mode_Hs = register_mode(&newmode);
784 /* unsigned short integer */
785 newmode.name = new_id_from_chars("Hu", 2);
786 newmode.code = irm_Hu;
789 newmode.modulo_shift = 32;
791 mode_Hu = register_mode(&newmode);
794 newmode.name = new_id_from_chars("Is", 2);
795 newmode.code = irm_Is;
798 newmode.modulo_shift = 32;
800 mode_Is = register_mode(&newmode);
802 /* unsigned integer */
803 newmode.name = new_id_from_chars("Iu", 2);
804 newmode.code = irm_Iu;
807 newmode.modulo_shift = 32;
809 mode_Iu = register_mode(&newmode);
811 /* signed long integer */
812 newmode.name = new_id_from_chars("Ls", 2);
813 newmode.code = irm_Ls;
816 newmode.modulo_shift = 64;
818 mode_Ls = register_mode(&newmode);
820 /* unsigned long integer */
821 newmode.name = new_id_from_chars("Lu", 2);
822 newmode.code = irm_Lu;
825 newmode.modulo_shift = 64;
827 mode_Lu = register_mode(&newmode);
829 /* signed long long integer */
830 newmode.name = new_id_from_chars("LLs", 3);
831 newmode.code = irm_LLs;
834 newmode.modulo_shift = 128;
836 mode_LLs = register_mode(&newmode);
838 /* unsigned long long integer */
839 newmode.name = new_id_from_chars("LLu", 3);
840 newmode.code = irm_LLu;
843 newmode.modulo_shift = 128;
845 mode_LLu = register_mode(&newmode);
848 newmode.sort = irms_reference;
849 newmode.arithmetic = irma_twos_complement;
852 newmode.name = new_id_from_chars("P", 1);
853 newmode.code = irm_P;
856 newmode.modulo_shift = 0;
857 newmode.eq_signed = mode_Is;
858 newmode.eq_unsigned = mode_Iu;
860 mode_P = register_mode(&newmode);
862 /* set the machine specific modes to the predefined ones */
863 mode_P_code = mode_P;
864 mode_P_data = mode_P;
867 /* find a signed mode for an unsigned integer mode */
868 ir_mode *find_unsigned_mode(const ir_mode *mode) {
871 /* allowed for reference mode */
872 if (mode->sort == irms_reference)
873 n.sort = irms_int_number;
875 assert(n.sort == irms_int_number);
877 return find_mode(&n);
880 /* find an unsigned mode for a signed integer mode */
881 ir_mode *find_signed_mode(const ir_mode *mode) {
884 assert(mode->sort == irms_int_number);
886 return find_mode(&n);
889 /* finds a integer mode with 2*n bits for an integer mode with n bits. */
890 ir_mode *find_double_bits_int_mode(const ir_mode *mode) {
893 assert(mode->sort == irms_int_number && mode->arithmetic == irma_twos_complement);
895 n.size = 2*mode->size;
896 return find_mode(&n);
900 * Returns non-zero if the given mode honors signed zero's, i.e.,
901 * a +0 and a -0 exists and handled differently.
903 int mode_honor_signed_zeros(const ir_mode *mode) {
904 /* for floating point, we know that IEEE 754 has +0 and -0,
905 * but always handles it identical.
908 mode->sort == irms_float_number &&
909 mode->arithmetic != irma_ieee754;
913 * Returns non-zero if the given mode might overflow on unary Minus.
915 * This does NOT happen on IEEE 754.
917 int mode_overflow_on_unary_Minus(const ir_mode *mode) {
918 if (mode->sort == irms_float_number)
919 return mode->arithmetic == irma_ieee754 ? 0 : 1;
924 * Returns non-zero if the mode has a reversed wrap-around
925 * logic, especially (a + x) - x == a.
927 * This is normally true for integer modes, not for floating
930 int mode_wrap_around(const ir_mode *mode) {
931 /* FIXME: better would be an extra mode property */
932 return mode_is_int(mode);
936 * Returns non-zero if the cast from mode src to mode dst is a
937 * reinterpret cast (ie. only the bit pattern is reinterpreted,
938 * no conversion is done)
940 int is_reinterpret_cast(const ir_mode *src, const ir_mode *dst) {
941 ir_mode_arithmetic ma;
945 if (get_mode_size_bits(src) != get_mode_size_bits(dst))
947 ma = get_mode_arithmetic(src);
948 if (ma != get_mode_arithmetic(dst))
951 return ma == irma_twos_complement || ma == irma_ones_complement;
954 void finish_mode(void) {
955 obstack_free(&modes, 0);
956 DEL_ARR_F(mode_list);