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;
259 /* add the new mode to the irp list of modes */
262 set_mode_values(mode);
264 hook_new_mode(new_mode, mode);
269 * Creates a new mode.
271 ir_mode *new_ir_mode(const char *name, ir_mode_sort sort, int bit_size, int sign,
272 ir_mode_arithmetic arithmetic, unsigned int modulo_shift)
275 ir_mode *mode = NULL;
277 mode_tmpl.name = new_id_from_str(name);
278 mode_tmpl.sort = sort;
279 mode_tmpl.size = bit_size;
280 mode_tmpl.sign = sign ? 1 : 0;
281 mode_tmpl.modulo_shift = (mode_tmpl.sort == irms_int_number ||
282 mode_tmpl.sort == irms_reference) ? modulo_shift : 0;
283 mode_tmpl.vector_elem = 1;
284 mode_tmpl.arithmetic = arithmetic;
285 mode_tmpl.link = NULL;
286 mode_tmpl.tv_priv = NULL;
288 mode = find_mode(&mode_tmpl);
290 hook_new_mode(&mode_tmpl, mode);
297 case irms_control_flow:
299 case irms_internal_boolean:
300 panic("internal modes cannot be user defined");
302 case irms_float_number:
303 case irms_int_number:
305 mode = register_mode(&mode_tmpl);
308 assert(mode != NULL);
313 * Creates a new vector mode.
315 ir_mode *new_ir_vector_mode(const char *name, ir_mode_sort sort, int bit_size, unsigned num_of_elem, int sign,
316 ir_mode_arithmetic arithmetic, unsigned int modulo_shift)
319 ir_mode *mode = NULL;
321 mode_tmpl.name = new_id_from_str(name);
322 mode_tmpl.sort = sort;
323 mode_tmpl.size = bit_size * num_of_elem;
324 mode_tmpl.sign = sign ? 1 : 0;
325 mode_tmpl.modulo_shift = (mode_tmpl.sort == irms_int_number) ? modulo_shift : 0;
326 mode_tmpl.vector_elem = num_of_elem;
327 mode_tmpl.arithmetic = arithmetic;
328 mode_tmpl.link = NULL;
329 mode_tmpl.tv_priv = NULL;
331 mode = find_mode(&mode_tmpl);
333 hook_new_mode(&mode_tmpl, mode);
337 if (num_of_elem <= 1) {
338 assert(0 && "vector modes should have at least 2 elements");
345 case irms_control_flow:
347 case irms_internal_boolean:
348 panic("internal modes cannot be user defined");
351 panic("only integer and floating point modes can be vectorized");
353 case irms_float_number:
354 panic("not yet implemented");
356 case irms_int_number:
357 mode = register_mode(&mode_tmpl);
359 assert(mode != NULL);
363 /* Functions for the direct access to all attributes of an ir_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(mode_is_data(mode));
420 tarval *get_mode_max(ir_mode *mode) {
422 assert(mode_is_data(mode));
427 tarval *get_mode_null(ir_mode *mode) {
429 assert(mode_is_datab(mode));
434 tarval *get_mode_one(ir_mode *mode) {
436 assert(mode_is_datab(mode));
441 tarval *get_mode_minus_one(ir_mode *mode) {
443 assert(mode_is_data(mode));
445 return mode->minus_one;
448 tarval *get_mode_all_one(ir_mode *mode) {
450 assert(mode_is_datab(mode));
451 return mode->all_one;
454 tarval *get_mode_infinite(ir_mode *mode) {
456 assert(mode_is_float(mode));
458 return get_tarval_plus_inf(mode);
461 tarval *get_mode_NAN(ir_mode *mode) {
463 assert(mode_is_float(mode));
465 return get_tarval_nan(mode);
468 int is_mode(const void *thing) {
469 return get_kind(thing) == k_ir_mode;
472 int (mode_is_signed)(const ir_mode *mode) {
473 return _mode_is_signed(mode);
476 int (mode_is_float)(const ir_mode *mode) {
477 return _mode_is_float(mode);
480 int (mode_is_int)(const ir_mode *mode) {
481 return _mode_is_int(mode);
484 int (mode_is_reference)(const ir_mode *mode) {
485 return _mode_is_reference(mode);
488 int (mode_is_num)(const ir_mode *mode) {
489 return _mode_is_num(mode);
492 int (mode_is_data)(const ir_mode *mode) {
493 return _mode_is_data(mode);
496 int (mode_is_datab)(const ir_mode *mode) {
497 return _mode_is_datab(mode);
500 int (mode_is_dataM)(const ir_mode *mode) {
501 return _mode_is_dataM(mode);
504 int (mode_is_float_vector)(const ir_mode *mode) {
505 return _mode_is_float_vector(mode);
508 int (mode_is_int_vector)(const ir_mode *mode) {
509 return _mode_is_int_vector(mode);
512 /* Returns true if sm can be converted to lm without loss. */
513 int smaller_mode(const ir_mode *sm, const ir_mode *lm) {
514 int sm_bits, lm_bits;
519 if (sm == lm) return 1;
521 sm_bits = get_mode_size_bits(sm);
522 lm_bits = get_mode_size_bits(lm);
524 switch (get_mode_sort(sm)) {
525 case irms_int_number:
526 switch (get_mode_sort(lm)) {
527 case irms_int_number:
528 if (get_mode_arithmetic(sm) != get_mode_arithmetic(lm))
531 /* only two complement implemented */
532 assert(get_mode_arithmetic(sm) == irma_twos_complement);
534 /* integers are convertable if
535 * - both have the same sign and lm is the larger one
536 * - lm is the signed one and is at least two bits larger
537 * (one for the sign, one for the highest bit of sm)
538 * - sm & lm are two_complement and lm has greater or equal number of bits
540 if (mode_is_signed(sm)) {
541 if (!mode_is_signed(lm))
543 return sm_bits <= lm_bits;
545 if (mode_is_signed(lm)) {
546 return sm_bits < lm_bits;
548 return sm_bits <= lm_bits;
552 case irms_float_number:
553 /* int to float works if the float is large enough */
561 case irms_float_number:
562 if (get_mode_arithmetic(sm) == get_mode_arithmetic(lm)) {
563 if ( (get_mode_sort(lm) == irms_float_number)
564 && (get_mode_size_bits(lm) >= get_mode_size_bits(sm)) )
570 /* do exist machines out there with different pointer lengths ?*/
573 case irms_internal_boolean:
574 return mode_is_int(lm);
584 /* Returns true if a value of mode sm can be converted into mode lm
585 and backwards without loss. */
586 int values_in_mode(const ir_mode *sm, const ir_mode *lm) {
587 int sm_bits, lm_bits;
588 ir_mode_arithmetic arith;
593 if (sm == lm) return 1;
596 return mode_is_int(lm);
598 sm_bits = get_mode_size_bits(sm);
599 lm_bits = get_mode_size_bits(lm);
601 arith = get_mode_arithmetic(sm);
602 if (arith != get_mode_arithmetic(lm))
606 case irma_twos_complement:
608 return get_mode_size_bits(sm) <= get_mode_size_bits(lm);
615 /* Return the signed integer equivalent mode for an reference mode. */
616 ir_mode *get_reference_mode_signed_eq(ir_mode *mode) {
617 assert(mode_is_reference(mode));
618 return mode->eq_signed;
621 /* Sets the signed integer equivalent mode for an reference mode. */
622 void set_reference_mode_signed_eq(ir_mode *ref_mode, ir_mode *int_mode) {
623 assert(mode_is_reference(ref_mode));
624 assert(mode_is_int(int_mode));
625 ref_mode->eq_signed = int_mode;
628 /* Return the unsigned integer equivalent mode for an reference mode. */
629 ir_mode *get_reference_mode_unsigned_eq(ir_mode *mode) {
630 assert(mode_is_reference(mode));
631 return mode->eq_unsigned;
634 /* Sets the unsigned integer equivalent mode for an reference mode. */
635 void set_reference_mode_unsigned_eq(ir_mode *ref_mode, ir_mode *int_mode) {
636 assert(mode_is_reference(ref_mode));
637 assert(mode_is_int(int_mode));
638 ref_mode->eq_unsigned = int_mode;
641 /* initialization, build the default modes */
642 void init_mode(void) {
645 obstack_init(&modes);
646 mode_list = NEW_ARR_F(ir_mode*, 0);
648 /* initialize predefined modes */
651 newmode.arithmetic = irma_none;
654 newmode.modulo_shift = 0;
655 newmode.vector_elem = 0;
656 newmode.eq_signed = NULL;
657 newmode.eq_unsigned = NULL;
659 newmode.tv_priv = NULL;
661 /* Control Flow Modes*/
662 newmode.sort = irms_control_flow;
665 newmode.name = new_id_from_chars("BB", 2);
666 mode_BB = register_mode(&newmode);
669 newmode.name = new_id_from_chars("X", 1);
670 mode_X = register_mode(&newmode);
673 newmode.sort = irms_memory;
676 newmode.name = new_id_from_chars("M", 1);
677 mode_M = register_mode(&newmode);
679 /* Auxiliary Modes */
680 newmode.sort = irms_auxiliary,
683 newmode.name = new_id_from_chars("T", 1);
684 mode_T = register_mode(&newmode);
687 newmode.name = new_id_from_chars("ANY", 3);
688 mode_ANY = register_mode(&newmode);
691 newmode.name = new_id_from_chars("BAD", 3);
692 mode_BAD = register_mode(&newmode);
694 /* Internal Boolean Modes */
695 newmode.sort = irms_internal_boolean;
698 newmode.name = new_id_from_chars("b", 1);
699 mode_b = register_mode(&newmode);
702 newmode.vector_elem = 1;
704 /* Float Number Modes */
705 newmode.sort = irms_float_number;
706 newmode.arithmetic = irma_ieee754;
709 newmode.name = new_id_from_chars("F", 1);
712 mode_F = register_mode(&newmode);
715 newmode.name = new_id_from_chars("D", 1);
718 mode_D = register_mode(&newmode);
721 newmode.name = new_id_from_chars("E", 1);
723 /* note that the tarval module is calculating with 80 bits, but we use
724 * 96 bits, as that is what will be stored to memory by most hardware */
726 mode_E = register_mode(&newmode);
728 /* Integer Number Modes */
729 newmode.sort = irms_int_number;
730 newmode.arithmetic = irma_twos_complement;
733 newmode.name = new_id_from_chars("Bs", 2);
736 newmode.modulo_shift = 32;
737 mode_Bs = register_mode(&newmode);
740 newmode.name = new_id_from_chars("Bu", 2);
741 newmode.arithmetic = irma_twos_complement;
744 newmode.modulo_shift = 32;
745 mode_Bu = register_mode(&newmode);
747 /* signed short integer */
748 newmode.name = new_id_from_chars("Hs", 2);
751 newmode.modulo_shift = 32;
752 mode_Hs = register_mode(&newmode);
754 /* unsigned short integer */
755 newmode.name = new_id_from_chars("Hu", 2);
758 newmode.modulo_shift = 32;
759 mode_Hu = register_mode(&newmode);
762 newmode.name = new_id_from_chars("Is", 2);
765 newmode.modulo_shift = 32;
766 mode_Is = register_mode(&newmode);
768 /* unsigned integer */
769 newmode.name = new_id_from_chars("Iu", 2);
772 newmode.modulo_shift = 32;
773 mode_Iu = register_mode(&newmode);
775 /* signed long integer */
776 newmode.name = new_id_from_chars("Ls", 2);
779 newmode.modulo_shift = 64;
780 mode_Ls = register_mode(&newmode);
782 /* unsigned long integer */
783 newmode.name = new_id_from_chars("Lu", 2);
786 newmode.modulo_shift = 64;
787 mode_Lu = register_mode(&newmode);
789 /* signed long long integer */
790 newmode.name = new_id_from_chars("LLs", 3);
793 newmode.modulo_shift = 128;
794 mode_LLs = register_mode(&newmode);
796 /* unsigned long long integer */
797 newmode.name = new_id_from_chars("LLu", 3);
800 newmode.modulo_shift = 128;
801 mode_LLu = register_mode(&newmode);
804 newmode.sort = irms_reference;
805 newmode.arithmetic = irma_twos_complement;
808 newmode.name = new_id_from_chars("P", 1);
811 newmode.modulo_shift = 32;
812 newmode.eq_signed = mode_Is;
813 newmode.eq_unsigned = mode_Iu;
814 mode_P = register_mode(&newmode);
816 /* set the machine specific modes to the predefined ones */
817 mode_P_code = mode_P;
818 mode_P_data = mode_P;
821 /* find a signed mode for an unsigned integer mode */
822 ir_mode *find_unsigned_mode(const ir_mode *mode) {
825 /* allowed for reference mode */
826 if (mode->sort == irms_reference)
827 n.sort = irms_int_number;
829 assert(n.sort == irms_int_number);
831 return find_mode(&n);
834 /* find an unsigned mode for a signed integer mode */
835 ir_mode *find_signed_mode(const ir_mode *mode) {
838 assert(mode->sort == irms_int_number);
840 return find_mode(&n);
843 /* finds a integer mode with 2*n bits for an integer mode with n bits. */
844 ir_mode *find_double_bits_int_mode(const ir_mode *mode) {
847 assert(mode->sort == irms_int_number && mode->arithmetic == irma_twos_complement);
849 n.size = 2*mode->size;
850 return find_mode(&n);
854 * Returns non-zero if the given mode honors signed zero's, i.e.,
855 * a +0 and a -0 exists and handled differently.
857 int mode_honor_signed_zeros(const ir_mode *mode) {
858 /* for floating point, we know that IEEE 754 has +0 and -0,
859 * but always handles it identical.
862 mode->sort == irms_float_number &&
863 mode->arithmetic != irma_ieee754;
867 * Returns non-zero if the given mode might overflow on unary Minus.
869 * This does NOT happen on IEEE 754.
871 int mode_overflow_on_unary_Minus(const ir_mode *mode) {
872 if (mode->sort == irms_float_number)
873 return mode->arithmetic == irma_ieee754 ? 0 : 1;
878 * Returns non-zero if the mode has a reversed wrap-around
879 * logic, especially (a + x) - x == a.
881 * This is normally true for integer modes, not for floating
884 int mode_wrap_around(const ir_mode *mode) {
885 /* FIXME: better would be an extra mode property */
886 return mode_is_int(mode);
890 * Returns non-zero if the cast from mode src to mode dst is a
891 * reinterpret cast (ie. only the bit pattern is reinterpreted,
892 * no conversion is done)
894 int is_reinterpret_cast(const ir_mode *src, const ir_mode *dst) {
895 ir_mode_arithmetic ma;
899 if (get_mode_size_bits(src) != get_mode_size_bits(dst))
901 ma = get_mode_arithmetic(src);
902 if (ma != get_mode_arithmetic(dst))
905 return ma == irma_twos_complement || ma == irma_ones_complement;
908 void finish_mode(void) {
909 obstack_free(&modes, 0);
910 DEL_ARR_F(mode_list);