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) {
73 if (m->sort == n->sort &&
74 m->arithmetic == n->arithmetic &&
77 m->modulo_shift == n->modulo_shift &&
78 m->vector_elem == n->vector_elem)
85 * searches the modes obstack for the given mode and returns
86 * a pointer on an equal mode already in the array, NULL if
89 static ir_mode *find_mode(const ir_mode *m) {
91 for (i = ARR_LEN(mode_list) - 1; i >= 0; --i) {
92 ir_mode *n = mode_list[i];
93 if (modes_are_equal(n, m))
99 #ifdef FIRM_STATISTICS
100 /* return the mode index, only needed for statistics */
101 int stat_find_mode_index(const ir_mode *m) {
103 for (i = ARR_LEN(mode_list) - 1; i >= 0; --i) {
104 ir_mode *n = mode_list[i];
105 if (modes_are_equal(n, m))
111 /* return the mode for a given index, only needed for statistics */
112 ir_mode *stat_mode_for_index(int idx) {
113 if (0 <= idx && idx < ARR_LEN(mode_list))
114 return mode_list[idx];
120 * sets special values of modes
122 static void set_mode_values(ir_mode* mode) {
123 switch (get_mode_sort(mode)) {
125 case irms_int_number:
126 case irms_float_number:
127 mode->min = get_tarval_min(mode);
128 mode->max = get_tarval_max(mode);
129 mode->null = get_tarval_null(mode);
130 mode->one = get_tarval_one(mode);
131 mode->minus_one = get_tarval_minus_one(mode);
132 if(get_mode_sort(mode) != irms_float_number) {
133 mode->all_one = get_tarval_all_one(mode);
135 mode->all_one = tarval_bad;
139 case irms_internal_boolean:
140 mode->min = tarval_b_false;
141 mode->max = tarval_b_true;
142 mode->null = tarval_b_false;
143 mode->one = tarval_b_true;
144 mode->minus_one = tarval_bad;
145 mode->all_one = tarval_b_true;
150 case irms_control_flow:
151 mode->min = tarval_bad;
152 mode->max = tarval_bad;
153 mode->null = tarval_bad;
154 mode->one = tarval_bad;
155 mode->minus_one = tarval_bad;
161 * globals defined in irmode.h
164 /* --- Predefined modes --- */
166 /* FIRM internal modes: */
174 /* predefined numerical modes: */
175 ir_mode *mode_F; /* float */
176 ir_mode *mode_D; /* double */
177 ir_mode *mode_E; /* long double */
179 ir_mode *mode_Bs; /* integral values, signed and unsigned */
180 ir_mode *mode_Bu; /* 8 bit */
181 ir_mode *mode_Hs; /* 16 bit */
183 ir_mode *mode_Is; /* 32 bit */
185 ir_mode *mode_Ls; /* 64 bit */
187 ir_mode *mode_LLs; /* 128 bit */
193 /* machine specific modes */
194 ir_mode *mode_P_code; /**< machine specific pointer mode for code addresses */
195 ir_mode *mode_P_data; /**< machine specific pointer mode for data addresses */
198 * functions defined in irmode.h
201 /* JNI access functions */
202 ir_mode *get_modeT(void) { return mode_T; }
203 ir_mode *get_modeF(void) { return mode_F; }
204 ir_mode *get_modeD(void) { return mode_D; }
205 ir_mode *get_modeE(void) { return mode_E; }
206 ir_mode *get_modeBs(void) { return mode_Bs; }
207 ir_mode *get_modeBu(void) { return mode_Bu; }
208 ir_mode *get_modeHs(void) { return mode_Hs; }
209 ir_mode *get_modeHu(void) { return mode_Hu; }
210 ir_mode *get_modeIs(void) { return mode_Is; }
211 ir_mode *get_modeIu(void) { return mode_Iu; }
212 ir_mode *get_modeLs(void) { return mode_Ls; }
213 ir_mode *get_modeLu(void) { return mode_Lu; }
214 ir_mode *get_modeLLs(void){ return mode_LLs; }
215 ir_mode *get_modeLLu(void){ return mode_LLu; }
216 ir_mode *get_modeb(void) { return mode_b; }
217 ir_mode *get_modeP(void) { return mode_P; }
218 ir_mode *get_modeX(void) { return mode_X; }
219 ir_mode *get_modeM(void) { return mode_M; }
220 ir_mode *get_modeBB(void) { return mode_BB; }
221 ir_mode *get_modeANY(void) { return mode_ANY; }
222 ir_mode *get_modeBAD(void) { return mode_BAD; }
225 ir_mode *(get_modeP_code)(void) {
226 return _get_modeP_code();
229 ir_mode *(get_modeP_data)(void) {
230 return _get_modeP_data();
233 void set_modeP_code(ir_mode *p) {
234 assert(mode_is_reference(p));
238 void set_modeP_data(ir_mode *p) {
239 assert(mode_is_reference(p));
244 * Registers a new mode.
246 * @param new_mode The new mode template.
248 static ir_mode *register_mode(const ir_mode *new_mode) {
249 ir_mode *mode = NULL;
253 /* copy mode struct to modes array */
254 mode = (ir_mode *)obstack_copy(&modes, new_mode, sizeof(*mode));
255 ARR_APP1(ir_mode*, mode_list, mode);
257 mode->kind = k_ir_mode;
258 mode->type = new_type_primitive(mode);
260 /* add the new mode to the irp list of modes */
263 set_mode_values(mode);
265 hook_new_mode(new_mode, mode);
270 * Creates a new mode.
272 ir_mode *new_ir_mode(const char *name, ir_mode_sort sort, int bit_size, int sign,
273 ir_mode_arithmetic arithmetic, unsigned int modulo_shift)
276 ir_mode *mode = NULL;
278 mode_tmpl.name = new_id_from_str(name);
279 mode_tmpl.sort = sort;
280 mode_tmpl.size = bit_size;
281 mode_tmpl.sign = sign ? 1 : 0;
282 mode_tmpl.modulo_shift = (mode_tmpl.sort == irms_int_number ||
283 mode_tmpl.sort == irms_reference) ? modulo_shift : 0;
284 mode_tmpl.vector_elem = 1;
285 mode_tmpl.arithmetic = arithmetic;
286 mode_tmpl.link = NULL;
287 mode_tmpl.tv_priv = NULL;
289 mode = find_mode(&mode_tmpl);
291 hook_new_mode(&mode_tmpl, mode);
298 case irms_control_flow:
300 case irms_internal_boolean:
301 panic("internal modes cannot be user defined");
303 case irms_float_number:
304 case irms_int_number:
306 mode = register_mode(&mode_tmpl);
309 assert(mode != NULL);
314 * Creates a new vector mode.
316 ir_mode *new_ir_vector_mode(const char *name, ir_mode_sort sort, int bit_size, unsigned num_of_elem, int sign,
317 ir_mode_arithmetic arithmetic, unsigned int modulo_shift)
320 ir_mode *mode = NULL;
322 mode_tmpl.name = new_id_from_str(name);
323 mode_tmpl.sort = sort;
324 mode_tmpl.size = bit_size * num_of_elem;
325 mode_tmpl.sign = sign ? 1 : 0;
326 mode_tmpl.modulo_shift = (mode_tmpl.sort == irms_int_number) ? modulo_shift : 0;
327 mode_tmpl.vector_elem = num_of_elem;
328 mode_tmpl.arithmetic = arithmetic;
329 mode_tmpl.link = NULL;
330 mode_tmpl.tv_priv = NULL;
332 mode = find_mode(&mode_tmpl);
334 hook_new_mode(&mode_tmpl, mode);
338 if (num_of_elem <= 1) {
339 assert(0 && "vector modes should have at least 2 elements");
346 case irms_control_flow:
348 case irms_internal_boolean:
349 panic("internal modes cannot be user defined");
352 panic("only integer and floating point modes can be vectorized");
354 case irms_float_number:
355 panic("not yet implemented");
357 case irms_int_number:
358 mode = register_mode(&mode_tmpl);
360 assert(mode != NULL);
364 /* Functions for the direct access to all attributes of an ir_mode */
365 ident *(get_mode_ident)(const ir_mode *mode) {
366 return _get_mode_ident(mode);
369 const char *get_mode_name(const ir_mode *mode) {
370 return get_id_str(mode->name);
373 ir_mode_sort (get_mode_sort)(const ir_mode* mode) {
374 return _get_mode_sort(mode);
377 unsigned (get_mode_size_bits)(const ir_mode *mode) {
378 return _get_mode_size_bits(mode);
381 unsigned (get_mode_size_bytes)(const ir_mode *mode) {
382 return _get_mode_size_bytes(mode);
385 int (get_mode_sign)(const ir_mode *mode) {
386 return _get_mode_sign(mode);
389 ir_mode_arithmetic (get_mode_arithmetic)(const ir_mode *mode) {
390 return get_mode_arithmetic(mode);
394 /* Attribute modulo shift specifies for modes of kind irms_int_number
395 * whether shift applies modulo to value of bits to shift. Asserts
396 * if mode is not irms_int_number.
398 unsigned int (get_mode_modulo_shift)(const ir_mode *mode) {
399 return _get_mode_modulo_shift(mode);
402 unsigned int (get_mode_n_vector_elems)(const ir_mode *mode) {
403 return _get_mode_vector_elems(mode);
406 void *(get_mode_link)(const ir_mode *mode) {
407 return _get_mode_link(mode);
410 void (set_mode_link)(ir_mode *mode, void *l) {
411 _set_mode_link(mode, l);
414 tarval *get_mode_min(ir_mode *mode) {
416 assert(mode_is_data(mode));
421 tarval *get_mode_max(ir_mode *mode) {
423 assert(mode_is_data(mode));
428 tarval *get_mode_null(ir_mode *mode) {
430 assert(mode_is_datab(mode));
435 tarval *get_mode_one(ir_mode *mode) {
437 assert(mode_is_datab(mode));
442 tarval *get_mode_minus_one(ir_mode *mode) {
444 assert(mode_is_data(mode));
446 return mode->minus_one;
449 tarval *get_mode_all_one(ir_mode *mode) {
451 assert(mode_is_datab(mode));
452 return mode->all_one;
455 tarval *get_mode_infinite(ir_mode *mode) {
457 assert(mode_is_float(mode));
459 return get_tarval_plus_inf(mode);
462 tarval *get_mode_NAN(ir_mode *mode) {
464 assert(mode_is_float(mode));
466 return get_tarval_nan(mode);
469 int is_mode(const void *thing) {
470 return get_kind(thing) == k_ir_mode;
473 int (mode_is_signed)(const ir_mode *mode) {
474 return _mode_is_signed(mode);
477 int (mode_is_float)(const ir_mode *mode) {
478 return _mode_is_float(mode);
481 int (mode_is_int)(const ir_mode *mode) {
482 return _mode_is_int(mode);
485 int (mode_is_reference)(const ir_mode *mode) {
486 return _mode_is_reference(mode);
489 int (mode_is_num)(const ir_mode *mode) {
490 return _mode_is_num(mode);
493 int (mode_is_data)(const ir_mode *mode) {
494 return _mode_is_data(mode);
497 int (mode_is_datab)(const ir_mode *mode) {
498 return _mode_is_datab(mode);
501 int (mode_is_dataM)(const ir_mode *mode) {
502 return _mode_is_dataM(mode);
505 int (mode_is_float_vector)(const ir_mode *mode) {
506 return _mode_is_float_vector(mode);
509 int (mode_is_int_vector)(const ir_mode *mode) {
510 return _mode_is_int_vector(mode);
513 /* Returns true if sm can be converted to lm without loss. */
514 int smaller_mode(const ir_mode *sm, const ir_mode *lm) {
515 int sm_bits, lm_bits;
520 if (sm == lm) return 1;
522 sm_bits = get_mode_size_bits(sm);
523 lm_bits = get_mode_size_bits(lm);
525 switch (get_mode_sort(sm)) {
526 case irms_int_number:
527 switch (get_mode_sort(lm)) {
528 case irms_int_number:
529 if (get_mode_arithmetic(sm) != get_mode_arithmetic(lm))
532 /* only two complement implemented */
533 assert(get_mode_arithmetic(sm) == irma_twos_complement);
535 /* integers are convertable if
536 * - both have the same sign and lm is the larger one
537 * - lm is the signed one and is at least two bits larger
538 * (one for the sign, one for the highest bit of sm)
539 * - sm & lm are two_complement and lm has greater or equal number of bits
541 if (mode_is_signed(sm)) {
542 if (!mode_is_signed(lm))
544 return sm_bits <= lm_bits;
546 if (mode_is_signed(lm)) {
547 return sm_bits < lm_bits;
549 return sm_bits <= lm_bits;
553 case irms_float_number:
554 /* int to float works if the float is large enough */
562 case irms_float_number:
563 if (get_mode_arithmetic(sm) == get_mode_arithmetic(lm)) {
564 if ( (get_mode_sort(lm) == irms_float_number)
565 && (get_mode_size_bits(lm) >= get_mode_size_bits(sm)) )
571 /* do exist machines out there with different pointer lengths ?*/
574 case irms_internal_boolean:
575 return mode_is_int(lm);
585 /* Returns true if a value of mode sm can be converted into mode lm
586 and backwards without loss. */
587 int values_in_mode(const ir_mode *sm, const ir_mode *lm) {
588 int sm_bits, lm_bits;
589 ir_mode_arithmetic arith;
594 if (sm == lm) return 1;
597 return mode_is_int(lm);
599 sm_bits = get_mode_size_bits(sm);
600 lm_bits = get_mode_size_bits(lm);
602 arith = get_mode_arithmetic(sm);
603 if (arith != get_mode_arithmetic(lm))
607 case irma_twos_complement:
609 return get_mode_size_bits(sm) <= get_mode_size_bits(lm);
616 /* Return the signed integer equivalent mode for an reference mode. */
617 ir_mode *get_reference_mode_signed_eq(ir_mode *mode) {
618 assert(mode_is_reference(mode));
619 return mode->eq_signed;
622 /* Sets the signed integer equivalent mode for an reference mode. */
623 void set_reference_mode_signed_eq(ir_mode *ref_mode, ir_mode *int_mode) {
624 assert(mode_is_reference(ref_mode));
625 assert(mode_is_int(int_mode));
626 ref_mode->eq_signed = int_mode;
629 /* Return the unsigned integer equivalent mode for an reference mode. */
630 ir_mode *get_reference_mode_unsigned_eq(ir_mode *mode) {
631 assert(mode_is_reference(mode));
632 return mode->eq_unsigned;
635 /* Sets the unsigned integer equivalent mode for an reference mode. */
636 void set_reference_mode_unsigned_eq(ir_mode *ref_mode, ir_mode *int_mode) {
637 assert(mode_is_reference(ref_mode));
638 assert(mode_is_int(int_mode));
639 ref_mode->eq_unsigned = int_mode;
642 /* initialization, build the default modes */
643 void init_mode(void) {
646 obstack_init(&modes);
647 mode_list = NEW_ARR_F(ir_mode*, 0);
649 /* initialize predefined modes */
652 newmode.arithmetic = irma_none;
655 newmode.modulo_shift = 0;
656 newmode.vector_elem = 0;
657 newmode.eq_signed = NULL;
658 newmode.eq_unsigned = NULL;
660 newmode.tv_priv = NULL;
662 /* Control Flow Modes*/
663 newmode.sort = irms_control_flow;
666 newmode.name = new_id_from_chars("BB", 2);
667 mode_BB = register_mode(&newmode);
670 newmode.name = new_id_from_chars("X", 1);
671 mode_X = register_mode(&newmode);
674 newmode.sort = irms_memory;
677 newmode.name = new_id_from_chars("M", 1);
678 mode_M = register_mode(&newmode);
680 /* Auxiliary Modes */
681 newmode.sort = irms_auxiliary,
684 newmode.name = new_id_from_chars("T", 1);
685 mode_T = register_mode(&newmode);
688 newmode.name = new_id_from_chars("ANY", 3);
689 mode_ANY = register_mode(&newmode);
692 newmode.name = new_id_from_chars("BAD", 3);
693 mode_BAD = register_mode(&newmode);
695 /* Internal Boolean Modes */
696 newmode.sort = irms_internal_boolean;
699 newmode.name = new_id_from_chars("b", 1);
700 mode_b = register_mode(&newmode);
703 newmode.vector_elem = 1;
705 /* Float Number Modes */
706 newmode.sort = irms_float_number;
707 newmode.arithmetic = irma_ieee754;
710 newmode.name = new_id_from_chars("F", 1);
713 mode_F = register_mode(&newmode);
716 newmode.name = new_id_from_chars("D", 1);
719 mode_D = register_mode(&newmode);
722 newmode.name = new_id_from_chars("E", 1);
724 /* note that the tarval module is calculating with 80 bits, but we use
725 * 96 bits, as that is what will be stored to memory by most hardware */
727 mode_E = register_mode(&newmode);
729 /* Integer Number Modes */
730 newmode.sort = irms_int_number;
731 newmode.arithmetic = irma_twos_complement;
734 newmode.name = new_id_from_chars("Bs", 2);
737 newmode.modulo_shift = 32;
738 mode_Bs = register_mode(&newmode);
741 newmode.name = new_id_from_chars("Bu", 2);
742 newmode.arithmetic = irma_twos_complement;
745 newmode.modulo_shift = 32;
746 mode_Bu = register_mode(&newmode);
748 /* signed short integer */
749 newmode.name = new_id_from_chars("Hs", 2);
752 newmode.modulo_shift = 32;
753 mode_Hs = register_mode(&newmode);
755 /* unsigned short integer */
756 newmode.name = new_id_from_chars("Hu", 2);
759 newmode.modulo_shift = 32;
760 mode_Hu = register_mode(&newmode);
763 newmode.name = new_id_from_chars("Is", 2);
766 newmode.modulo_shift = 32;
767 mode_Is = register_mode(&newmode);
769 /* unsigned integer */
770 newmode.name = new_id_from_chars("Iu", 2);
773 newmode.modulo_shift = 32;
774 mode_Iu = register_mode(&newmode);
776 /* signed long integer */
777 newmode.name = new_id_from_chars("Ls", 2);
780 newmode.modulo_shift = 64;
781 mode_Ls = register_mode(&newmode);
783 /* unsigned long integer */
784 newmode.name = new_id_from_chars("Lu", 2);
787 newmode.modulo_shift = 64;
788 mode_Lu = register_mode(&newmode);
790 /* signed long long integer */
791 newmode.name = new_id_from_chars("LLs", 3);
794 newmode.modulo_shift = 128;
795 mode_LLs = register_mode(&newmode);
797 /* unsigned long long integer */
798 newmode.name = new_id_from_chars("LLu", 3);
801 newmode.modulo_shift = 128;
802 mode_LLu = register_mode(&newmode);
805 newmode.sort = irms_reference;
806 newmode.arithmetic = irma_twos_complement;
809 newmode.name = new_id_from_chars("P", 1);
812 newmode.modulo_shift = 32;
813 newmode.eq_signed = mode_Is;
814 newmode.eq_unsigned = mode_Iu;
815 mode_P = register_mode(&newmode);
817 /* set the machine specific modes to the predefined ones */
818 mode_P_code = mode_P;
819 mode_P_data = mode_P;
822 /* find a signed mode for an unsigned integer mode */
823 ir_mode *find_unsigned_mode(const ir_mode *mode) {
826 /* allowed for reference mode */
827 if (mode->sort == irms_reference)
828 n.sort = irms_int_number;
830 assert(n.sort == irms_int_number);
832 return find_mode(&n);
835 /* find an unsigned mode for a signed integer mode */
836 ir_mode *find_signed_mode(const ir_mode *mode) {
839 assert(mode->sort == irms_int_number);
841 return find_mode(&n);
844 /* finds a integer mode with 2*n bits for an integer mode with n bits. */
845 ir_mode *find_double_bits_int_mode(const ir_mode *mode) {
848 assert(mode->sort == irms_int_number && mode->arithmetic == irma_twos_complement);
850 n.size = 2*mode->size;
851 return find_mode(&n);
855 * Returns non-zero if the given mode honors signed zero's, i.e.,
856 * a +0 and a -0 exists and handled differently.
858 int mode_honor_signed_zeros(const ir_mode *mode) {
859 /* for floating point, we know that IEEE 754 has +0 and -0,
860 * but always handles it identical.
863 mode->sort == irms_float_number &&
864 mode->arithmetic != irma_ieee754;
868 * Returns non-zero if the given mode might overflow on unary Minus.
870 * This does NOT happen on IEEE 754.
872 int mode_overflow_on_unary_Minus(const ir_mode *mode) {
873 if (mode->sort == irms_float_number)
874 return mode->arithmetic == irma_ieee754 ? 0 : 1;
879 * Returns non-zero if the mode has a reversed wrap-around
880 * logic, especially (a + x) - x == a.
882 * This is normally true for integer modes, not for floating
885 int mode_wrap_around(const ir_mode *mode) {
886 /* FIXME: better would be an extra mode property */
887 return mode_is_int(mode);
891 * Returns non-zero if the cast from mode src to mode dst is a
892 * reinterpret cast (ie. only the bit pattern is reinterpreted,
893 * no conversion is done)
895 int is_reinterpret_cast(const ir_mode *src, const ir_mode *dst) {
896 ir_mode_arithmetic ma;
900 if (get_mode_size_bits(src) != get_mode_size_bits(dst))
902 ma = get_mode_arithmetic(src);
903 if (ma != get_mode_arithmetic(dst))
906 return ma == irma_twos_complement || ma == irma_ones_complement;
909 void finish_mode(void) {
910 obstack_free(&modes, 0);
911 DEL_ARR_F(mode_list);