3 * File name: ir/ir/irmode.c
4 * Purpose: Data modes of operations.
5 * Author: Martin Trapp, Christian Schaefer
6 * Modified by: Goetz Lindenmaier, Mathias Heil
9 * Copyright: (c) 1998-2003 Universität Karlsruhe
10 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
25 # include "irmode_t.h"
32 static long long count = 0;
33 # define ANNOUNCE() printf(__FILE__": call no. %lld (%s)\n", count++, __FUNCTION__)
35 # define ANNOUNCE() ((void)0)
43 /** dynamic array to hold all modes */
44 static struct obstack modes;
46 /** number of defined modes */
54 * Compare modes that don't need to have their code field
57 * TODO: Add other fields
59 INLINE static int modes_are_equal(const ir_mode *m, const ir_mode *n)
62 if (m->sort == n->sort &&
63 m->arithmetic == n->arithmetic &&
66 m->modulo_shift == n->modulo_shift &&
67 m->vector_elem == n->vector_elem)
74 * calculates the next obstack address
76 static void *next_obstack_adr(struct obstack *o, void *p, size_t s)
78 PTR_INT_TYPE adr = __PTR_TO_INT((char *)p);
79 int mask = obstack_alignment_mask(o);
83 return __INT_TO_PTR(adr & ~mask);
87 * searches the modes obstack for the given mode and returns
88 * a pointer on an equal mode already in the array, NULL if
91 static ir_mode *find_mode(const ir_mode *m)
94 struct _obstack_chunk *p;
97 n = (ir_mode *)p->contents;
98 nn = next_obstack_adr(&modes, n, sizeof(*n));
99 for (; (char *)nn <= modes.next_free;) {
101 if (modes_are_equal(n, m))
105 nn = next_obstack_adr(&modes, n, sizeof(*n));
108 for (p = p->prev; p; p = p->prev) {
109 n = (ir_mode *)p->contents;
110 nn = next_obstack_adr(&modes, n, sizeof(*n));
111 for (; (char *)nn < p->limit;) {
113 if (modes_are_equal(n, m))
117 nn = next_obstack_adr(&modes, n, sizeof(*n));
125 * sets special values of modes
127 static void set_mode_values(ir_mode* mode)
129 switch (get_mode_sort(mode))
132 case irms_int_number:
133 case irms_float_number:
134 mode->min = get_tarval_min(mode);
135 mode->max = get_tarval_max(mode);
136 mode->null = get_tarval_null(mode);
137 mode->one = get_tarval_one(mode);
138 mode->minus_one = get_tarval_minus_one(mode);
141 case irms_internal_boolean:
142 mode->min = tarval_b_false;
143 mode->max = tarval_b_true;
144 mode->null = tarval_b_false;
145 mode->one = tarval_b_true;
146 mode->minus_one = tarval_bad;
150 mode->min = tarval_bad;
151 mode->max = tarval_bad;
152 mode->null = get_tarval_null(mode);
153 mode->one = tarval_bad;
154 mode->minus_one = tarval_bad;
159 case irms_control_flow:
160 mode->min = tarval_bad;
161 mode->max = tarval_bad;
162 mode->null = tarval_bad;
163 mode->one = tarval_bad;
164 mode->minus_one = tarval_bad;
170 * globals defined in irmode.h
173 /* --- Predefined modes --- */
175 /* FIRM internal modes: */
183 /* predefined numerical modes: */
184 ir_mode *mode_F; /* float */
185 ir_mode *mode_D; /* double */
186 ir_mode *mode_E; /* long double */
188 ir_mode *mode_Bs; /* integral values, signed and unsigned */
189 ir_mode *mode_Bu; /* 8 bit */
190 ir_mode *mode_Hs; /* 16 bit */
192 ir_mode *mode_Is; /* 32 bit */
194 ir_mode *mode_Ls; /* 64 bit */
202 /* machine specific modes */
203 ir_mode *mode_P_mach; /* machine specific pointer mode */
206 * functions defined in irmode.h
209 /* JNI access functions */
210 INLINE ir_mode *get_modeT(void) { ANNOUNCE(); return mode_T; }
211 INLINE ir_mode *get_modeF(void) { ANNOUNCE(); return mode_F; }
212 INLINE ir_mode *get_modeD(void) { ANNOUNCE(); return mode_D; }
213 INLINE ir_mode *get_modeE(void) { ANNOUNCE(); return mode_E; }
214 INLINE ir_mode *get_modeBs(void) { ANNOUNCE(); return mode_Bs; }
215 INLINE ir_mode *get_modeBu(void) { ANNOUNCE(); return mode_Bu; }
216 INLINE ir_mode *get_modeHs(void) { ANNOUNCE(); return mode_Hs; }
217 INLINE ir_mode *get_modeHu(void) { ANNOUNCE(); return mode_Hu; }
218 INLINE ir_mode *get_modeIs(void) { ANNOUNCE(); return mode_Is; }
219 INLINE ir_mode *get_modeIu(void) { ANNOUNCE(); return mode_Iu; }
220 INLINE ir_mode *get_modeLs(void) { ANNOUNCE(); return mode_Ls; }
221 INLINE ir_mode *get_modeLu(void) { ANNOUNCE(); return mode_Lu; }
222 INLINE ir_mode *get_modeC(void) { ANNOUNCE(); return mode_C; }
223 INLINE ir_mode *get_modeU(void) { ANNOUNCE(); return mode_U; }
224 INLINE ir_mode *get_modeb(void) { ANNOUNCE(); return mode_b; }
225 INLINE ir_mode *get_modeP(void) { ANNOUNCE(); return mode_P; }
226 INLINE ir_mode *get_modeX(void) { ANNOUNCE(); return mode_X; }
227 INLINE ir_mode *get_modeM(void) { ANNOUNCE(); return mode_M; }
228 INLINE ir_mode *get_modeBB(void) { ANNOUNCE(); return mode_BB; }
229 INLINE ir_mode *get_modeANY(void) { ANNOUNCE(); return mode_ANY; }
230 INLINE ir_mode *get_modeBAD(void) { ANNOUNCE(); return mode_BAD; }
233 ir_mode *(get_modeP_mach)(void) {
235 return __get_modeP_mach();
238 void (set_modeP_mach)(ir_mode *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)
250 ir_mode *mode = NULL;
255 /* copy mode struct to modes array */
256 mode = (ir_mode*)obstack_copy(&modes, new_mode, sizeof(ir_mode));
258 mode->kind = k_ir_mode;
259 if (num_modes >= irm_max) mode->code = num_modes;
262 set_mode_values(mode);
268 * Creates a new mode.
270 ir_mode *new_ir_mode(const char *name, mode_sort sort, int bit_size, int sign,
271 mode_arithmetic arithmetic, unsigned int modulo_shift )
274 ir_mode *mode = NULL;
276 mode_tmpl.name = new_id_from_str(name);
277 mode_tmpl.sort = sort;
278 mode_tmpl.size = bit_size;
279 mode_tmpl.sign = sign ? 1 : 0;
280 mode_tmpl.modulo_shift = (mode_tmpl.sort == irms_int_number) ? modulo_shift : 0;
281 mode_tmpl.vector_elem = 1;
282 mode_tmpl.arithmetic = arithmetic;
283 mode_tmpl.link = NULL;
284 mode_tmpl.tv_priv = NULL;
286 mode = find_mode(&mode_tmpl);
288 hook_new_mode(&mode_tmpl, mode);
296 case irms_control_flow:
298 case irms_internal_boolean:
299 assert(0 && "internal modes cannot be user defined");
302 case irms_float_number:
303 case irms_int_number:
306 mode = register_mode(&mode_tmpl);
308 hook_new_mode(&mode_tmpl, mode);
313 * Creates a new vector mode.
315 ir_mode *new_ir_vector_mode(const char *name, mode_sort sort, int bit_size, unsigned num_of_elem, int sign,
316 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");
339 hook_new_mode(&mode_tmpl, mode);
347 case irms_control_flow:
349 case irms_internal_boolean:
350 assert(0 && "internal modes cannot be user defined");
355 assert(0 && "only integer and floating point modes can be vectorized");
358 case irms_float_number:
359 assert(0 && "not yet implemented");
362 case irms_int_number:
363 mode = register_mode(&mode_tmpl);
365 hook_new_mode(&mode_tmpl, mode);
369 /* Functions for the direct access to all attributes od a ir_mode */
371 (get_mode_modecode)(const ir_mode *mode)
374 return __get_mode_modecode(mode);
378 (get_mode_ident)(const ir_mode *mode)
381 return __get_mode_ident(mode);
385 get_mode_name(const ir_mode *mode)
388 return get_id_str(mode->name);
392 (get_mode_sort)(const ir_mode* mode)
395 return __get_mode_sort(mode);
399 (get_mode_size_bits)(const ir_mode *mode)
402 return __get_mode_size_bits(mode);
406 (get_mode_size_bytes)(const ir_mode *mode) {
408 return __get_mode_size_bytes(mode);
412 (get_mode_sign)(const ir_mode *mode)
415 return __get_mode_sign(mode);
419 (get_mode_arithmetic)(const ir_mode *mode)
422 return get_mode_arithmetic(mode);
426 /* Attribute modulo shift specifies for modes of kind irms_int_number
427 * whether shift applies modulo to value of bits to shift. Asserts
428 * if mode is not irms_int_number.
431 (get_mode_modulo_shift)(const ir_mode *mode) {
432 return __get_mode_modulo_shift(mode);
436 (get_mode_n_vector_elems)(const ir_mode *mode) {
437 return __get_mode_vector_elems(mode);
441 (get_mode_link)(const ir_mode *mode)
444 return __get_mode_link(mode);
448 (set_mode_link)(ir_mode *mode, void *l)
450 __set_mode_link(mode, l);
454 get_mode_min (ir_mode *mode)
458 assert(get_mode_modecode(mode) < num_modes);
459 assert(mode_is_data(mode));
465 get_mode_max (ir_mode *mode)
469 assert(get_mode_modecode(mode) < num_modes);
470 assert(mode_is_data(mode));
476 get_mode_null (ir_mode *mode)
480 assert(get_mode_modecode(mode) < num_modes);
481 assert(mode_is_data(mode));
487 get_mode_one (ir_mode *mode)
491 assert(get_mode_modecode(mode) < num_modes);
492 assert(mode_is_data(mode));
498 get_mode_minus_one (ir_mode *mode)
502 assert(get_mode_modecode(mode) < num_modes);
503 assert(mode_is_data(mode));
505 return mode->minus_one;
509 get_mode_infinite(ir_mode *mode)
513 assert(get_mode_modecode(mode) < num_modes);
514 assert(mode_is_float(mode));
516 return get_tarval_plus_inf(mode);
520 get_mode_NAN(ir_mode *mode)
524 assert(get_mode_modecode(mode) < num_modes);
525 assert(mode_is_float(mode));
527 return get_tarval_nan(mode);
531 is_mode (void *thing) {
532 if (get_kind(thing) == k_ir_mode)
539 (mode_is_signed)(const ir_mode *mode) {
541 return __mode_is_signed(mode);
545 (mode_is_float)(const ir_mode *mode) {
547 return __mode_is_float(mode);
551 (mode_is_int)(const ir_mode *mode) {
553 return __mode_is_int(mode);
557 (mode_is_character)(const ir_mode *mode) {
559 return __mode_is_character(mode);
563 (mode_is_reference)(const ir_mode *mode) {
565 return __mode_is_reference(mode);
569 (mode_is_num)(const ir_mode *mode) {
571 return __mode_is_num(mode);
575 (mode_is_numP)(const ir_mode *mode) {
577 return __mode_is_numP(mode);
581 (mode_is_data)(const ir_mode *mode) {
583 return __mode_is_data(mode);
587 (mode_is_datab)(const ir_mode *mode) {
589 return __mode_is_datab(mode);
593 (mode_is_dataM)(const ir_mode *mode) {
595 return __mode_is_dataM(mode);
599 (mode_is_float_vector)(const ir_mode *mode) {
601 return __mode_is_float_vector(mode);
605 (mode_is_int_vector)(const ir_mode *mode) {
607 return __mode_is_int_vector(mode);
610 /* Returns true if sm can be converted to lm without loss. */
612 smaller_mode(const ir_mode *sm, const ir_mode *lm)
614 int sm_bits, lm_bits;
620 if (sm == lm) return 1;
622 sm_bits = get_mode_size_bits(sm);
623 lm_bits = get_mode_size_bits(lm);
625 switch(get_mode_sort(sm))
627 case irms_int_number:
628 switch(get_mode_sort(lm))
630 case irms_int_number:
631 /* integers are convertable if
632 * - both have the same sign and lm is the larger one
633 * - lm is the signed one and is at least two bits larger
634 * (one for the sign, one for the highest bit of sm)
635 * - sm & lm are two_complement and lm has greater or equal number of bits
637 if ( get_mode_arithmetic(sm) == get_mode_arithmetic(lm)
638 && get_mode_arithmetic(sm) == irma_twos_complement) {
639 return lm_bits >= sm_bits;
641 else if (mode_is_signed(sm))
643 if ( mode_is_signed(lm) && (lm_bits >= sm_bits) )
646 else if (mode_is_signed(lm))
648 if (lm_bits > sm_bits + 1)
651 else if (lm_bits >= sm_bits)
657 case irms_float_number:
658 /* int to float works if the float is large enough */
666 case irms_float_number:
667 if (get_mode_arithmetic(sm) == get_mode_arithmetic(lm)) {
668 if ( (get_mode_sort(lm) == irms_float_number)
669 && (get_mode_size_bits(lm) >= get_mode_size_bits(sm)) )
675 /* do exist machines out there with different pointer lenghts ?*/
686 /* initialization, build the default modes */
692 /* init flexible array */
694 obstack_init(&modes);
697 /* initialize predefined modes */
700 newmode.arithmetic = irma_none;
703 newmode.modulo_shift = 0;
704 newmode.vector_elem = 0;
706 newmode.tv_priv = NULL;
708 /* Control Flow Modes*/
709 newmode.sort = irms_control_flow;
712 newmode.name = new_id_from_chars("BB", 2);
713 newmode.code = irm_BB;
715 mode_BB = register_mode(&newmode);
718 newmode.name = new_id_from_chars("X", 1);
719 newmode.code = irm_X;
721 mode_X = register_mode(&newmode);
724 newmode.sort = irms_memory;
727 newmode.name = new_id_from_chars("M", 1);
728 newmode.code = irm_M;
730 mode_M = register_mode(&newmode);
732 /* Auxiliary Modes */
733 newmode.sort = irms_auxiliary,
736 newmode.name = new_id_from_chars("T", 1);
737 newmode.code = irm_T;
739 mode_T = register_mode(&newmode);
742 newmode.name = new_id_from_chars("ANY", 3);
743 newmode.code = irm_ANY;
745 mode_ANY = register_mode(&newmode);
748 newmode.name = new_id_from_chars("BAD", 3);
749 newmode.code = irm_BAD;
751 mode_BAD = register_mode(&newmode);
753 /* Internal Boolean Modes */
754 newmode.sort = irms_internal_boolean;
757 newmode.name = new_id_from_chars("b", 1);
758 newmode.code = irm_b;
760 mode_b = register_mode(&newmode);
763 newmode.vector_elem = 1;
765 /* Float Number Modes */
766 newmode.sort = irms_float_number;
767 newmode.arithmetic = irma_ieee754;
770 newmode.name = new_id_from_chars("F", 1);
771 newmode.code = irm_F;
775 mode_F = register_mode(&newmode);
778 newmode.name = new_id_from_chars("D", 1);
779 newmode.code = irm_D;
783 mode_D = register_mode(&newmode);
786 newmode.name = new_id_from_chars("E", 1);
787 newmode.code = irm_E;
791 mode_E = register_mode(&newmode);
793 /* Integer Number Modes */
794 newmode.sort = irms_int_number;
795 newmode.arithmetic = irma_twos_complement;
798 newmode.name = new_id_from_chars("Bs", 2);
799 newmode.code = irm_Bs;
802 newmode.modulo_shift = 32;
804 mode_Bs = register_mode(&newmode);
807 newmode.name = new_id_from_chars("Bu", 2);
808 newmode.code = irm_Bu;
809 newmode.arithmetic = irma_twos_complement;
812 newmode.modulo_shift = 32;
814 mode_Bu = register_mode(&newmode);
816 /* signed short integer */
817 newmode.name = new_id_from_chars("Hs", 2);
818 newmode.code = irm_Hs;
821 newmode.modulo_shift = 32;
823 mode_Hs = register_mode(&newmode);
825 /* unsigned short integer */
826 newmode.name = new_id_from_chars("Hu", 2);
827 newmode.code = irm_Hu;
830 newmode.modulo_shift = 32;
832 mode_Hu = register_mode(&newmode);
835 newmode.name = new_id_from_chars("Is", 2);
836 newmode.code = irm_Is;
839 newmode.modulo_shift = 32;
841 mode_Is = register_mode(&newmode);
843 /* unsigned integer */
844 newmode.name = new_id_from_chars("Iu", 2);
845 newmode.code = irm_Iu;
848 newmode.modulo_shift = 32;
850 mode_Iu = register_mode(&newmode);
852 /* signed long integer */
853 newmode.name = new_id_from_chars("Ls", 2);
854 newmode.code = irm_Ls;
857 newmode.modulo_shift = 64;
859 mode_Ls = register_mode(&newmode);
861 /* unsigned long integer */
862 newmode.name = new_id_from_chars("Lu", 2);
863 newmode.code = irm_Lu;
866 newmode.modulo_shift = 64;
868 mode_Lu = register_mode(&newmode);
870 /* Character Modes */
871 newmode.sort = irms_character;
872 newmode.arithmetic = irma_none;
875 newmode.name = new_id_from_chars("C", 1);
876 newmode.code = irm_C;
879 newmode.modulo_shift = 32;
881 mode_C = register_mode(&newmode);
883 /* Unicode character */
884 newmode.name = new_id_from_chars("U", 1);
885 newmode.code = irm_U;
888 newmode.modulo_shift = 32;
890 mode_U = register_mode(&newmode);
892 /* Reference Modes */
893 newmode.sort = irms_reference;
894 newmode.arithmetic = irma_twos_complement;
897 newmode.name = new_id_from_chars("P", 1);
898 newmode.code = irm_P;
901 newmode.modulo_shift = 0;
903 mode_P = register_mode(&newmode);
905 /* set the machine specific modes to the predefined ones */
906 mode_P_mach = mode_P;
909 /* find a signed mode for an unsigned integer mode */
910 ir_mode *find_unsigned_mode(const ir_mode *mode) {
913 if (mode->sort != irms_int_number);
915 return find_mode(&n);
918 /* find an unsigned mode for a signed integer mode */
919 ir_mode *find_signed_mode(const ir_mode *mode) {
922 assert(mode->sort == irms_int_number);
924 return find_mode(&n);
927 /* finds a integer mode with 2*n bits for an integer mode with n bits. */
928 ir_mode *find_double_bits_int_mode(const ir_mode *mode) {
931 assert(mode->sort == irms_int_number && mode->arithmetic == irma_twos_complement);
933 n.size = 2*mode->size;
934 return find_mode(&n);
938 * Returns non-zero if the given mode honors signed zero's, i.e.,
939 * a +0 and a -0 exists and handled differently.
941 int mode_honor_signed_zeros(const ir_mode *mode)
943 /* for floating point, we know that IEEE 754 has +0 and -0,
944 * but always handles it identical.
946 if (mode->sort == irms_float_number)
947 return mode->arithmetic == irma_ieee754 ? 0 : 1;
952 * Returns non-zero if the given mode might overflow on unary Minus.
954 * This does NOT happen on IEEE 754.
956 int mode_overflow_on_unary_Minus(const ir_mode *mode)
958 if (mode->sort == irms_float_number)
959 return mode->arithmetic == irma_ieee754 ? 0 : 1;
963 void finish_mode(void) {
964 obstack_free(&modes, 0);