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);
140 case irms_internal_boolean:
141 mode->min = tarval_b_false;
142 mode->max = tarval_b_true;
143 mode->null = tarval_b_false;
144 mode->one = tarval_b_true;
148 mode->min = tarval_bad;
149 mode->max = tarval_bad;
150 mode->null = (get_mode_modecode(mode) == irm_P) ? tarval_P_void : tarval_bad;
151 mode->one = tarval_bad;
156 case irms_control_flow:
157 mode->min = tarval_bad;
158 mode->max = tarval_bad;
159 mode->null = tarval_bad;
160 mode->one = tarval_bad;
166 * globals defined in irmode.h
169 /* --- Predefined modes --- */
171 /* FIRM internal modes: */
179 /* predefined numerical modes: */
180 ir_mode *mode_F; /* float */
181 ir_mode *mode_D; /* double */
182 ir_mode *mode_E; /* long double */
184 ir_mode *mode_Bs; /* integral values, signed and unsigned */
185 ir_mode *mode_Bu; /* 8 bit */
186 ir_mode *mode_Hs; /* 16 bit */
188 ir_mode *mode_Is; /* 32 bit */
190 ir_mode *mode_Ls; /* 64 bit */
198 /* machine specific modes */
199 ir_mode *mode_P_mach; /* machine specific pointer mode */
202 * functions defined in irmode.h
205 /* JNI access functions */
206 INLINE ir_mode *get_modeT(void) { ANNOUNCE(); return mode_T; }
207 INLINE ir_mode *get_modeF(void) { ANNOUNCE(); return mode_F; }
208 INLINE ir_mode *get_modeD(void) { ANNOUNCE(); return mode_D; }
209 INLINE ir_mode *get_modeE(void) { ANNOUNCE(); return mode_E; }
210 INLINE ir_mode *get_modeBs(void) { ANNOUNCE(); return mode_Bs; }
211 INLINE ir_mode *get_modeBu(void) { ANNOUNCE(); return mode_Bu; }
212 INLINE ir_mode *get_modeHs(void) { ANNOUNCE(); return mode_Hs; }
213 INLINE ir_mode *get_modeHu(void) { ANNOUNCE(); return mode_Hu; }
214 INLINE ir_mode *get_modeIs(void) { ANNOUNCE(); return mode_Is; }
215 INLINE ir_mode *get_modeIu(void) { ANNOUNCE(); return mode_Iu; }
216 INLINE ir_mode *get_modeLs(void) { ANNOUNCE(); return mode_Ls; }
217 INLINE ir_mode *get_modeLu(void) { ANNOUNCE(); return mode_Lu; }
218 INLINE ir_mode *get_modeC(void) { ANNOUNCE(); return mode_C; }
219 INLINE ir_mode *get_modeU(void) { ANNOUNCE(); return mode_U; }
220 INLINE ir_mode *get_modeb(void) { ANNOUNCE(); return mode_b; }
221 INLINE ir_mode *get_modeP(void) { ANNOUNCE(); return mode_P; }
222 INLINE ir_mode *get_modeX(void) { ANNOUNCE(); return mode_X; }
223 INLINE ir_mode *get_modeM(void) { ANNOUNCE(); return mode_M; }
224 INLINE ir_mode *get_modeBB(void) { ANNOUNCE(); return mode_BB; }
225 INLINE ir_mode *get_modeANY(void) { ANNOUNCE(); return mode_ANY; }
226 INLINE ir_mode *get_modeBAD(void) { ANNOUNCE(); return mode_BAD; }
229 ir_mode *(get_modeP_mach)(void) {
231 return __get_modeP_mach();
234 void (set_modeP_mach)(ir_mode *p) {
240 * Registers a new mode.
242 * @param new_mode The new mode template.
244 static ir_mode *register_mode(const ir_mode* new_mode)
246 ir_mode *mode = NULL;
251 /* copy mode struct to modes array */
252 mode = (ir_mode*)obstack_copy(&modes, new_mode, sizeof(ir_mode));
254 mode->kind = k_ir_mode;
255 if (num_modes >= irm_max) mode->code = num_modes;
258 set_mode_values(mode);
264 * Creates a new mode.
266 ir_mode *new_ir_mode(const char *name, mode_sort sort, int bit_size, int sign,
267 mode_arithmetic arithmetic, unsigned int modulo_shift )
270 ir_mode *mode = NULL;
272 mode_tmpl.name = new_id_from_str(name);
273 mode_tmpl.sort = sort;
274 mode_tmpl.size = bit_size;
275 mode_tmpl.sign = sign ? 1 : 0;
276 mode_tmpl.modulo_shift = (mode_tmpl.sort == irms_int_number) ? modulo_shift : 0;
277 mode_tmpl.vector_elem = 1;
278 mode_tmpl.arithmetic = arithmetic;
279 mode_tmpl.link = NULL;
280 mode_tmpl.tv_priv = NULL;
282 mode = find_mode(&mode_tmpl);
284 hook_new_mode(&mode_tmpl, mode);
292 case irms_control_flow:
294 case irms_internal_boolean:
295 assert(0 && "internal modes cannot be user defined");
298 case irms_float_number:
299 case irms_int_number:
302 mode = register_mode(&mode_tmpl);
304 hook_new_mode(&mode_tmpl, mode);
309 * Creates a new vector mode.
311 ir_mode *new_ir_vector_mode(const char *name, mode_sort sort, int bit_size, unsigned num_of_elem, int sign,
312 mode_arithmetic arithmetic, unsigned int modulo_shift )
315 ir_mode *mode = NULL;
317 mode_tmpl.name = new_id_from_str(name);
318 mode_tmpl.sort = sort;
319 mode_tmpl.size = bit_size * num_of_elem;
320 mode_tmpl.sign = sign ? 1 : 0;
321 mode_tmpl.modulo_shift = (mode_tmpl.sort == irms_int_number) ? modulo_shift : 0;
322 mode_tmpl.vector_elem = num_of_elem;
323 mode_tmpl.arithmetic = arithmetic;
324 mode_tmpl.link = NULL;
325 mode_tmpl.tv_priv = NULL;
327 mode = find_mode(&mode_tmpl);
329 hook_new_mode(&mode_tmpl, mode);
333 if (num_of_elem <= 1) {
334 assert(0 && "vector modes should have at least 2 elements");
335 hook_new_mode(&mode_tmpl, mode);
343 case irms_control_flow:
345 case irms_internal_boolean:
346 assert(0 && "internal modes cannot be user defined");
351 assert(0 && "only integer and floating point modes can be vectorized");
354 case irms_float_number:
355 assert(0 && "not yet implemented");
358 case irms_int_number:
359 mode = register_mode(&mode_tmpl);
361 hook_new_mode(&mode_tmpl, mode);
365 /* Functions for the direct access to all attributes od a ir_mode */
367 (get_mode_modecode)(const ir_mode *mode)
370 return __get_mode_modecode(mode);
374 (get_mode_ident)(const ir_mode *mode)
377 return __get_mode_ident(mode);
381 get_mode_name(const ir_mode *mode)
384 return get_id_str(mode->name);
388 (get_mode_sort)(const ir_mode* mode)
391 return __get_mode_sort(mode);
395 (get_mode_size_bits)(const ir_mode *mode)
398 return __get_mode_size_bits(mode);
402 (get_mode_size_bytes)(const ir_mode *mode) {
404 return __get_mode_size_bytes(mode);
408 (get_mode_sign)(const ir_mode *mode)
411 return __get_mode_sign(mode);
415 (get_mode_arithmetic)(const ir_mode *mode)
418 return get_mode_arithmetic(mode);
422 /* Attribute modulo shift specifies for modes of kind irms_int_number
423 * whether shift applies modulo to value of bits to shift. Asserts
424 * if mode is not irms_int_number.
427 (get_mode_modulo_shift)(const ir_mode *mode) {
428 return __get_mode_modulo_shift(mode);
432 (get_mode_n_vector_elems)(const ir_mode *mode) {
433 return __get_mode_vector_elems(mode);
437 (get_mode_link)(const ir_mode *mode)
440 return __get_mode_link(mode);
444 (set_mode_link)(ir_mode *mode, void *l)
446 __set_mode_link(mode, l);
450 get_mode_min (ir_mode *mode)
454 assert(get_mode_modecode(mode) < num_modes);
455 assert(mode_is_data(mode));
461 get_mode_max (ir_mode *mode)
465 assert(get_mode_modecode(mode) < num_modes);
466 assert(mode_is_data(mode));
472 get_mode_null (ir_mode *mode)
476 assert(get_mode_modecode(mode) < num_modes);
477 assert(mode_is_data(mode));
483 get_mode_one (ir_mode *mode)
487 assert(get_mode_modecode(mode) < num_modes);
488 assert(mode_is_data(mode));
494 get_mode_infinite(ir_mode *mode)
498 assert(get_mode_modecode(mode) < num_modes);
499 assert(mode_is_float(mode));
501 return get_tarval_plus_inf(mode);
505 get_mode_NAN(ir_mode *mode)
509 assert(get_mode_modecode(mode) < num_modes);
510 assert(mode_is_float(mode));
512 return get_tarval_nan(mode);
516 is_mode (void *thing) {
517 if (get_kind(thing) == k_ir_mode)
524 (mode_is_signed)(const ir_mode *mode) {
526 return __mode_is_signed(mode);
530 (mode_is_float)(const ir_mode *mode) {
532 return __mode_is_float(mode);
536 (mode_is_int)(const ir_mode *mode) {
538 return __mode_is_int(mode);
542 (mode_is_character)(const ir_mode *mode) {
544 return __mode_is_character(mode);
548 (mode_is_reference)(const ir_mode *mode) {
550 return __mode_is_reference(mode);
554 (mode_is_num)(const ir_mode *mode) {
556 return __mode_is_num(mode);
560 (mode_is_numP)(const ir_mode *mode) {
562 return __mode_is_numP(mode);
566 (mode_is_data)(const ir_mode *mode) {
568 return __mode_is_data(mode);
572 (mode_is_datab)(const ir_mode *mode) {
574 return __mode_is_datab(mode);
578 (mode_is_dataM)(const ir_mode *mode) {
580 return __mode_is_dataM(mode);
584 (mode_is_float_vector)(const ir_mode *mode) {
586 return __mode_is_float_vector(mode);
590 (mode_is_int_vector)(const ir_mode *mode) {
592 return __mode_is_int_vector(mode);
595 /* Returns true if sm can be converted to lm without loss. */
597 smaller_mode(const ir_mode *sm, const ir_mode *lm)
599 int sm_bits, lm_bits;
605 if (sm == lm) return 1;
607 sm_bits = get_mode_size_bits(sm);
608 lm_bits = get_mode_size_bits(lm);
610 switch(get_mode_sort(sm))
612 case irms_int_number:
613 switch(get_mode_sort(lm))
615 case irms_int_number:
616 /* integers are convertable if
617 * - both have the same sign and lm is the larger one
618 * - lm is the signed one and is at least two bits larger
619 * (one for the sign, one for the highest bit of sm)
620 * - sm & lm are two_complement and lm has greater or equal number of bits
622 if ( get_mode_arithmetic(sm) == get_mode_arithmetic(lm)
623 && get_mode_arithmetic(sm) == irma_twos_complement) {
624 return lm_bits >= sm_bits;
626 else if (mode_is_signed(sm))
628 if ( mode_is_signed(lm) && (lm_bits >= sm_bits) )
631 else if (mode_is_signed(lm))
633 if (lm_bits > sm_bits + 1)
636 else if (lm_bits >= sm_bits)
642 case irms_float_number:
643 /* int to float works if the float is large enough */
651 case irms_float_number:
652 if (get_mode_arithmetic(sm) == get_mode_arithmetic(lm)) {
653 if ( (get_mode_sort(lm) == irms_float_number)
654 && (get_mode_size_bits(lm) >= get_mode_size_bits(sm)) )
660 /* do exist machines out there with different pointer lenghts ?*/
671 /* initialization, build the default modes */
677 /* init flexible array */
679 obstack_init(&modes);
682 /* initialize predefined modes */
685 newmode.arithmetic = irma_none;
688 newmode.modulo_shift = 0;
689 newmode.vector_elem = 0;
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 /* Character Modes */
856 newmode.sort = irms_character;
857 newmode.arithmetic = irma_none;
860 newmode.name = new_id_from_chars("C", 1);
861 newmode.code = irm_C;
864 newmode.modulo_shift = 32;
866 mode_C = register_mode(&newmode);
868 /* Unicode character */
869 newmode.name = new_id_from_chars("U", 1);
870 newmode.code = irm_U;
873 newmode.modulo_shift = 32;
875 mode_U = register_mode(&newmode);
877 /* Reference Modes */
878 newmode.sort = irms_reference;
879 newmode.arithmetic = irma_twos_complement;
882 newmode.name = new_id_from_chars("P", 1);
883 newmode.code = irm_P;
886 newmode.modulo_shift = 0;
888 mode_P = register_mode(&newmode);
890 /* set the machine specific modes to the predifined ones */
891 mode_P_mach = mode_P;
894 /* find a signed mode for an unsigned integer mode */
895 ir_mode *find_unsigned_mode(const ir_mode *mode) {
898 if (mode->sort != irms_int_number);
900 return find_mode(&n);
903 /* find an unsigned mode for a signed integer mode */
904 ir_mode *find_signed_mode(const ir_mode *mode) {
907 assert(mode->sort == irms_int_number);
909 return find_mode(&n);
912 /* finds a integer mode with 2*n bits for an integer mode with n bits. */
913 ir_mode *find_double_bits_int_mode(const ir_mode *mode) {
916 assert(mode->sort == irms_int_number && mode->arithmetic == irma_twos_complement);
918 n.size = 2*mode->size;
919 return find_mode(&n);
923 * Returns non-zero if the given mode honors signed zero's, i.e.,
924 * a +0 and a -0 exists and handled differently.
926 int mode_honor_signed_zeros(const ir_mode *mode)
928 /* for floating point, we know that IEEE 754 has +0 and -0,
929 * but always handles it identical.
931 if (mode->sort == irms_float_number)
932 return mode->arithmetic == irma_ieee754 ? 0 : 1;
937 * Returns non-zero if the given mode might overflow on unary Minus.
939 * This does NOT happen on IEEE 754.
941 int mode_overflow_on_unary_Minus(const ir_mode *mode)
943 if (mode->sort == irms_float_number)
944 return mode->arithmetic == irma_ieee754 ? 0 : 1;
948 void finish_mode(void) {
949 obstack_free(&modes, 0);