2 * Copyright (C) 1995-2007 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"
52 /** dynamic array to hold all modes */
53 static struct obstack modes;
55 /** number of defined modes */
63 * Compare modes that don't need to have their code field
66 * TODO: Add other fields
68 INLINE static int modes_are_equal(const ir_mode *m, const ir_mode *n) {
70 if (m->sort == n->sort &&
71 m->arithmetic == n->arithmetic &&
74 m->modulo_shift == n->modulo_shift &&
75 m->vector_elem == n->vector_elem)
82 * calculates the next obstack address
84 static void *next_obstack_adr(struct obstack *o, void *p, size_t s) {
85 PTR_INT_TYPE adr = PTR_TO_INT((char *)p);
86 int mask = obstack_alignment_mask(o);
90 return INT_TO_PTR(adr & ~mask);
94 * searches the modes obstack for the given mode and returns
95 * a pointer on an equal mode already in the array, NULL if
98 static ir_mode *find_mode(const ir_mode *m) {
100 struct _obstack_chunk *p;
103 n = (ir_mode *)p->contents;
104 nn = next_obstack_adr(&modes, n, sizeof(*n));
105 for (; (char *)nn <= modes.next_free;) {
107 if (modes_are_equal(n, m))
111 nn = next_obstack_adr(&modes, n, sizeof(*n));
114 for (p = p->prev; p; p = p->prev) {
115 n = (ir_mode *)p->contents;
116 nn = next_obstack_adr(&modes, n, sizeof(*n));
117 for (; (char *)nn < p->limit;) {
119 if (modes_are_equal(n, m))
123 nn = next_obstack_adr(&modes, n, sizeof(*n));
131 * sets special values of modes
133 static void set_mode_values(ir_mode* mode) {
134 switch (get_mode_sort(mode)) {
136 case irms_int_number:
137 case irms_float_number:
138 mode->min = get_tarval_min(mode);
139 mode->max = get_tarval_max(mode);
140 mode->null = get_tarval_null(mode);
141 mode->one = get_tarval_one(mode);
142 mode->minus_one = get_tarval_minus_one(mode);
145 case irms_internal_boolean:
146 mode->min = tarval_b_false;
147 mode->max = tarval_b_true;
148 mode->null = tarval_b_false;
149 mode->one = tarval_b_true;
150 mode->minus_one = tarval_bad;
154 mode->min = tarval_bad;
155 mode->max = tarval_bad;
156 mode->null = get_tarval_null(mode);
157 mode->one = tarval_bad;
158 mode->minus_one = tarval_bad;
163 case irms_control_flow:
164 mode->min = tarval_bad;
165 mode->max = tarval_bad;
166 mode->null = tarval_bad;
167 mode->one = tarval_bad;
168 mode->minus_one = tarval_bad;
174 * globals defined in irmode.h
177 /* --- Predefined modes --- */
179 /* FIRM internal modes: */
187 /* predefined numerical modes: */
188 ir_mode *mode_F; /* float */
189 ir_mode *mode_D; /* double */
190 ir_mode *mode_E; /* long double */
192 ir_mode *mode_Bs; /* integral values, signed and unsigned */
193 ir_mode *mode_Bu; /* 8 bit */
194 ir_mode *mode_Hs; /* 16 bit */
196 ir_mode *mode_Is; /* 32 bit */
198 ir_mode *mode_Ls; /* 64 bit */
200 ir_mode *mode_LLs; /* 128 bit */
208 /* machine specific modes */
209 ir_mode *mode_P_code; /**< machine specific pointer mode for code addresses */
210 ir_mode *mode_P_data; /**< machine specific pointer mode for data addresses */
213 * functions defined in irmode.h
216 /* JNI access functions */
217 ir_mode *get_modeT(void) { return mode_T; }
218 ir_mode *get_modeF(void) { return mode_F; }
219 ir_mode *get_modeD(void) { return mode_D; }
220 ir_mode *get_modeE(void) { return mode_E; }
221 ir_mode *get_modeBs(void) { return mode_Bs; }
222 ir_mode *get_modeBu(void) { return mode_Bu; }
223 ir_mode *get_modeHs(void) { return mode_Hs; }
224 ir_mode *get_modeHu(void) { return mode_Hu; }
225 ir_mode *get_modeIs(void) { return mode_Is; }
226 ir_mode *get_modeIu(void) { return mode_Iu; }
227 ir_mode *get_modeLs(void) { return mode_Ls; }
228 ir_mode *get_modeLu(void) { return mode_Lu; }
229 ir_mode *get_modeLLs(void){ return mode_LLs; }
230 ir_mode *get_modeLLu(void){ return mode_LLu; }
231 ir_mode *get_modeC(void) { return mode_C; }
232 ir_mode *get_modeU(void) { return mode_U; }
233 ir_mode *get_modeb(void) { return mode_b; }
234 ir_mode *get_modeP(void) { return mode_P; }
235 ir_mode *get_modeX(void) { return mode_X; }
236 ir_mode *get_modeM(void) { return mode_M; }
237 ir_mode *get_modeBB(void) { return mode_BB; }
238 ir_mode *get_modeANY(void) { return mode_ANY; }
239 ir_mode *get_modeBAD(void) { return mode_BAD; }
242 ir_mode *(get_modeP_code)(void) {
243 return _get_modeP_code();
246 ir_mode *(get_modeP_data)(void) {
247 return _get_modeP_data();
250 void set_modeP_code(ir_mode *p) {
251 assert(mode_is_reference(p));
255 void set_modeP_data(ir_mode *p) {
256 assert(mode_is_reference(p));
261 * Registers a new mode.
263 * @param new_mode The new mode template.
265 static ir_mode *register_mode(const ir_mode *new_mode) {
266 ir_mode *mode = NULL;
270 /* copy mode struct to modes array */
271 mode = (ir_mode *)obstack_copy(&modes, new_mode, sizeof(*mode));
273 mode->kind = k_ir_mode;
274 if (num_modes >= irm_max) mode->code = num_modes;
277 /* add the new mode to the irp list of modes */
280 set_mode_values(mode);
282 hook_new_mode(new_mode, mode);
287 * Creates a new mode.
289 ir_mode *new_ir_mode(const char *name, mode_sort sort, int bit_size, int sign,
290 mode_arithmetic arithmetic, unsigned int modulo_shift)
293 ir_mode *mode = NULL;
295 mode_tmpl.name = new_id_from_str(name);
296 mode_tmpl.sort = sort;
297 mode_tmpl.size = bit_size;
298 mode_tmpl.sign = sign ? 1 : 0;
299 mode_tmpl.modulo_shift = (mode_tmpl.sort == irms_int_number) ? modulo_shift : 0;
300 mode_tmpl.vector_elem = 1;
301 mode_tmpl.arithmetic = arithmetic;
302 mode_tmpl.link = NULL;
303 mode_tmpl.tv_priv = NULL;
305 mode = find_mode(&mode_tmpl);
307 hook_new_mode(&mode_tmpl, mode);
314 case irms_control_flow:
316 case irms_internal_boolean:
317 assert(0 && "internal modes cannot be user defined");
320 case irms_float_number:
321 case irms_int_number:
324 mode = register_mode(&mode_tmpl);
330 * Creates a new vector mode.
332 ir_mode *new_ir_vector_mode(const char *name, mode_sort sort, int bit_size, unsigned num_of_elem, int sign,
333 mode_arithmetic arithmetic, unsigned int modulo_shift)
336 ir_mode *mode = NULL;
338 mode_tmpl.name = new_id_from_str(name);
339 mode_tmpl.sort = sort;
340 mode_tmpl.size = bit_size * num_of_elem;
341 mode_tmpl.sign = sign ? 1 : 0;
342 mode_tmpl.modulo_shift = (mode_tmpl.sort == irms_int_number) ? modulo_shift : 0;
343 mode_tmpl.vector_elem = num_of_elem;
344 mode_tmpl.arithmetic = arithmetic;
345 mode_tmpl.link = NULL;
346 mode_tmpl.tv_priv = NULL;
348 mode = find_mode(&mode_tmpl);
350 hook_new_mode(&mode_tmpl, mode);
354 if (num_of_elem <= 1) {
355 assert(0 && "vector modes should have at least 2 elements");
362 case irms_control_flow:
364 case irms_internal_boolean:
365 assert(0 && "internal modes cannot be user defined");
370 assert(0 && "only integer and floating point modes can be vectorized");
373 case irms_float_number:
374 assert(0 && "not yet implemented");
377 case irms_int_number:
378 mode = register_mode(&mode_tmpl);
383 /* Functions for the direct access to all attributes of an ir_mode */
385 (get_mode_modecode)(const ir_mode *mode) {
386 return _get_mode_modecode(mode);
390 (get_mode_ident)(const ir_mode *mode) {
391 return _get_mode_ident(mode);
395 get_mode_name(const ir_mode *mode) {
396 return get_id_str(mode->name);
400 (get_mode_sort)(const ir_mode* mode) {
401 return _get_mode_sort(mode);
405 (get_mode_size_bits)(const ir_mode *mode) {
406 return _get_mode_size_bits(mode);
410 (get_mode_size_bytes)(const ir_mode *mode) {
411 return _get_mode_size_bytes(mode);
415 (get_mode_sign)(const ir_mode *mode) {
416 return _get_mode_sign(mode);
420 (get_mode_arithmetic)(const ir_mode *mode) {
421 return get_mode_arithmetic(mode);
425 /* Attribute modulo shift specifies for modes of kind irms_int_number
426 * whether shift applies modulo to value of bits to shift. Asserts
427 * if mode is not irms_int_number.
430 (get_mode_modulo_shift)(const ir_mode *mode) {
431 return _get_mode_modulo_shift(mode);
435 (get_mode_n_vector_elems)(const ir_mode *mode) {
436 return _get_mode_vector_elems(mode);
440 (get_mode_link)(const ir_mode *mode) {
441 return _get_mode_link(mode);
445 (set_mode_link)(ir_mode *mode, void *l) {
446 _set_mode_link(mode, l);
450 get_mode_min(ir_mode *mode) {
452 assert(get_mode_modecode(mode) < num_modes);
453 assert(mode_is_data(mode));
459 get_mode_max(ir_mode *mode) {
461 assert(get_mode_modecode(mode) < num_modes);
462 assert(mode_is_data(mode));
468 get_mode_null(ir_mode *mode) {
470 assert(get_mode_modecode(mode) < num_modes);
471 assert(mode_is_data(mode));
477 get_mode_one(ir_mode *mode) {
479 assert(get_mode_modecode(mode) < num_modes);
480 assert(mode_is_data(mode));
486 get_mode_minus_one(ir_mode *mode) {
488 assert(get_mode_modecode(mode) < num_modes);
489 assert(mode_is_data(mode));
491 return mode->minus_one;
495 get_mode_infinite(ir_mode *mode) {
497 assert(get_mode_modecode(mode) < num_modes);
498 assert(mode_is_float(mode));
500 return get_tarval_plus_inf(mode);
504 get_mode_NAN(ir_mode *mode) {
506 assert(get_mode_modecode(mode) < num_modes);
507 assert(mode_is_float(mode));
509 return get_tarval_nan(mode);
513 is_mode(void *thing) {
514 if (get_kind(thing) == k_ir_mode)
521 (mode_is_signed)(const ir_mode *mode) {
522 return _mode_is_signed(mode);
526 (mode_is_float)(const ir_mode *mode) {
527 return _mode_is_float(mode);
531 (mode_is_int)(const ir_mode *mode) {
532 return _mode_is_int(mode);
536 (mode_is_character)(const ir_mode *mode) {
537 return _mode_is_character(mode);
541 (mode_is_reference)(const ir_mode *mode) {
542 return _mode_is_reference(mode);
546 (mode_is_num)(const ir_mode *mode) {
547 return _mode_is_num(mode);
551 (mode_is_numP)(const ir_mode *mode) {
552 return _mode_is_numP(mode);
556 (mode_is_data)(const ir_mode *mode) {
557 return _mode_is_data(mode);
561 (mode_is_datab)(const ir_mode *mode) {
562 return _mode_is_datab(mode);
566 (mode_is_dataM)(const ir_mode *mode) {
567 return _mode_is_dataM(mode);
571 (mode_is_float_vector)(const ir_mode *mode) {
572 return _mode_is_float_vector(mode);
576 (mode_is_int_vector)(const ir_mode *mode) {
577 return _mode_is_int_vector(mode);
580 /* Returns true if sm can be converted to lm without loss. */
582 smaller_mode(const ir_mode *sm, const ir_mode *lm) {
583 int sm_bits, lm_bits;
588 if (sm == lm) return 1;
590 sm_bits = get_mode_size_bits(sm);
591 lm_bits = get_mode_size_bits(lm);
593 switch (get_mode_sort(sm)) {
594 case irms_int_number:
595 switch (get_mode_sort(lm)) {
596 case irms_int_number:
597 /* integers are convertable if
598 * - both have the same sign and lm is the larger one
599 * - lm is the signed one and is at least two bits larger
600 * (one for the sign, one for the highest bit of sm)
601 * - sm & lm are two_complement and lm has greater or equal number of bits
603 if ( get_mode_arithmetic(sm) == get_mode_arithmetic(lm)
604 && get_mode_arithmetic(sm) == irma_twos_complement) {
605 return lm_bits >= sm_bits;
606 } else if (mode_is_signed(sm)) {
607 if ( mode_is_signed(lm) && (lm_bits >= sm_bits) )
609 } else if (mode_is_signed(lm)) {
610 if (lm_bits > sm_bits + 1)
612 } else if (lm_bits >= sm_bits) {
617 case irms_float_number:
618 /* int to float works if the float is large enough */
626 case irms_float_number:
627 if (get_mode_arithmetic(sm) == get_mode_arithmetic(lm)) {
628 if ( (get_mode_sort(lm) == irms_float_number)
629 && (get_mode_size_bits(lm) >= get_mode_size_bits(sm)) )
635 /* do exist machines out there with different pointer lenghts ?*/
646 /* Return the signed integer equivalent mode for an reference mode. */
647 ir_mode *get_reference_mode_signed_eq(ir_mode *mode) {
648 assert(mode_is_reference(mode));
649 return mode->eq_signed;
652 /* Sets the signed integer equivalent mode for an reference mode. */
653 void set_reference_mode_signed_eq(ir_mode *ref_mode, ir_mode *int_mode) {
654 assert(mode_is_reference(ref_mode));
655 assert(mode_is_int(int_mode));
656 ref_mode->eq_signed = int_mode;
659 /* Return the unsigned integer equivalent mode for an reference mode. */
660 ir_mode *get_reference_mode_unsigned_eq(ir_mode *mode) {
661 assert(mode_is_reference(mode));
662 return mode->eq_unsigned;
665 /* Sets the unsigned integer equivalent mode for an reference mode. */
666 void set_reference_mode_unsigned_eq(ir_mode *ref_mode, ir_mode *int_mode) {
667 assert(mode_is_reference(ref_mode));
668 assert(mode_is_int(int_mode));
669 ref_mode->eq_unsigned = int_mode;
672 /* initialization, build the default modes */
677 obstack_init(&modes);
680 /* initialize predefined modes */
683 newmode.arithmetic = irma_none;
686 newmode.modulo_shift = 0;
687 newmode.vector_elem = 0;
688 newmode.eq_signed = NULL;
689 newmode.eq_unsigned = NULL;
691 newmode.tv_priv = NULL;
693 /* Control Flow Modes*/
694 newmode.sort = irms_control_flow;
697 newmode.name = new_id_from_chars("BB", 2);
698 newmode.code = irm_BB;
700 mode_BB = register_mode(&newmode);
703 newmode.name = new_id_from_chars("X", 1);
704 newmode.code = irm_X;
706 mode_X = register_mode(&newmode);
709 newmode.sort = irms_memory;
712 newmode.name = new_id_from_chars("M", 1);
713 newmode.code = irm_M;
715 mode_M = register_mode(&newmode);
717 /* Auxiliary Modes */
718 newmode.sort = irms_auxiliary,
721 newmode.name = new_id_from_chars("T", 1);
722 newmode.code = irm_T;
724 mode_T = register_mode(&newmode);
727 newmode.name = new_id_from_chars("ANY", 3);
728 newmode.code = irm_ANY;
730 mode_ANY = register_mode(&newmode);
733 newmode.name = new_id_from_chars("BAD", 3);
734 newmode.code = irm_BAD;
736 mode_BAD = register_mode(&newmode);
738 /* Internal Boolean Modes */
739 newmode.sort = irms_internal_boolean;
742 newmode.name = new_id_from_chars("b", 1);
743 newmode.code = irm_b;
745 mode_b = register_mode(&newmode);
748 newmode.vector_elem = 1;
750 /* Float Number Modes */
751 newmode.sort = irms_float_number;
752 newmode.arithmetic = irma_ieee754;
755 newmode.name = new_id_from_chars("F", 1);
756 newmode.code = irm_F;
760 mode_F = register_mode(&newmode);
763 newmode.name = new_id_from_chars("D", 1);
764 newmode.code = irm_D;
768 mode_D = register_mode(&newmode);
771 newmode.name = new_id_from_chars("E", 1);
772 newmode.code = irm_E;
776 mode_E = register_mode(&newmode);
778 /* Integer Number Modes */
779 newmode.sort = irms_int_number;
780 newmode.arithmetic = irma_twos_complement;
783 newmode.name = new_id_from_chars("Bs", 2);
784 newmode.code = irm_Bs;
787 newmode.modulo_shift = 32;
789 mode_Bs = register_mode(&newmode);
792 newmode.name = new_id_from_chars("Bu", 2);
793 newmode.code = irm_Bu;
794 newmode.arithmetic = irma_twos_complement;
797 newmode.modulo_shift = 32;
799 mode_Bu = register_mode(&newmode);
801 /* signed short integer */
802 newmode.name = new_id_from_chars("Hs", 2);
803 newmode.code = irm_Hs;
806 newmode.modulo_shift = 32;
808 mode_Hs = register_mode(&newmode);
810 /* unsigned short integer */
811 newmode.name = new_id_from_chars("Hu", 2);
812 newmode.code = irm_Hu;
815 newmode.modulo_shift = 32;
817 mode_Hu = register_mode(&newmode);
820 newmode.name = new_id_from_chars("Is", 2);
821 newmode.code = irm_Is;
824 newmode.modulo_shift = 32;
826 mode_Is = register_mode(&newmode);
828 /* unsigned integer */
829 newmode.name = new_id_from_chars("Iu", 2);
830 newmode.code = irm_Iu;
833 newmode.modulo_shift = 32;
835 mode_Iu = register_mode(&newmode);
837 /* signed long integer */
838 newmode.name = new_id_from_chars("Ls", 2);
839 newmode.code = irm_Ls;
842 newmode.modulo_shift = 64;
844 mode_Ls = register_mode(&newmode);
846 /* unsigned long integer */
847 newmode.name = new_id_from_chars("Lu", 2);
848 newmode.code = irm_Lu;
851 newmode.modulo_shift = 64;
853 mode_Lu = register_mode(&newmode);
855 /* signed long long integer */
856 newmode.name = new_id_from_chars("LLs", 3);
857 newmode.code = irm_LLs;
860 newmode.modulo_shift = 128;
862 mode_LLs = register_mode(&newmode);
864 /* unsigned long long integer */
865 newmode.name = new_id_from_chars("LLu", 3);
866 newmode.code = irm_LLu;
869 newmode.modulo_shift = 128;
871 mode_LLu = register_mode(&newmode);
873 /* Character Modes */
874 newmode.sort = irms_character;
875 newmode.arithmetic = irma_twos_complement;
876 newmode.modulo_shift = 0;
879 newmode.name = new_id_from_chars("C", 1);
880 newmode.code = irm_C;
884 mode_C = register_mode(&newmode);
886 /* Unicode character */
887 newmode.name = new_id_from_chars("U", 1);
888 newmode.code = irm_U;
892 mode_U = register_mode(&newmode);
894 /* Reference Modes */
895 newmode.sort = irms_reference;
896 newmode.arithmetic = irma_twos_complement;
899 newmode.name = new_id_from_chars("P", 1);
900 newmode.code = irm_P;
903 newmode.modulo_shift = 0;
904 newmode.eq_signed = mode_Is;
905 newmode.eq_unsigned = mode_Iu;
907 mode_P = register_mode(&newmode);
909 /* set the machine specific modes to the predefined ones */
910 mode_P_code = mode_P;
911 mode_P_data = mode_P;
914 /* find a signed mode for an unsigned integer mode */
915 ir_mode *find_unsigned_mode(const ir_mode *mode) {
918 assert(mode->sort == irms_int_number);
920 return find_mode(&n);
923 /* find an unsigned mode for a signed integer mode */
924 ir_mode *find_signed_mode(const ir_mode *mode) {
927 assert(mode->sort == irms_int_number);
929 return find_mode(&n);
932 /* finds a integer mode with 2*n bits for an integer mode with n bits. */
933 ir_mode *find_double_bits_int_mode(const ir_mode *mode) {
936 assert(mode->sort == irms_int_number && mode->arithmetic == irma_twos_complement);
938 n.size = 2*mode->size;
939 return find_mode(&n);
943 * Returns non-zero if the given mode honors signed zero's, i.e.,
944 * a +0 and a -0 exists and handled differently.
946 int mode_honor_signed_zeros(const ir_mode *mode) {
947 /* for floating point, we know that IEEE 754 has +0 and -0,
948 * but always handles it identical.
951 mode->sort == irms_float_number &&
952 mode->arithmetic != irma_ieee754;
956 * Returns non-zero if the given mode might overflow on unary Minus.
958 * This does NOT happen on IEEE 754.
960 int mode_overflow_on_unary_Minus(const ir_mode *mode) {
961 if (mode->sort == irms_float_number)
962 return mode->arithmetic == irma_ieee754 ? 0 : 1;
967 * Returns non-zero if the mode has a reversed wrap-around
968 * logic, especially (a + x) - x == a.
970 * This is normally true for integer modes, not for floating
973 int mode_wrap_around(const ir_mode *mode) {
974 /* FIXME: better would be an extra mode property */
975 return mode_is_int(mode);
978 void finish_mode(void) {
979 obstack_free(&modes, 0);