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(*mode));
258 mode->kind = k_ir_mode;
259 if (num_modes >= irm_max) mode->code = num_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, mode_sort sort, int bit_size, int sign,
272 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) ? modulo_shift : 0;
282 mode_tmpl.vector_elem = 1;
283 mode_tmpl.arithmetic = arithmetic;
284 mode_tmpl.link = NULL;
285 mode_tmpl.tv_priv = NULL;
287 mode = find_mode(&mode_tmpl);
289 hook_new_mode(&mode_tmpl, mode);
297 case irms_control_flow:
299 case irms_internal_boolean:
300 assert(0 && "internal modes cannot be user defined");
303 case irms_float_number:
304 case irms_int_number:
307 mode = register_mode(&mode_tmpl);
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");
346 case irms_control_flow:
348 case irms_internal_boolean:
349 assert(0 && "internal modes cannot be user defined");
354 assert(0 && "only integer and floating point modes can be vectorized");
357 case irms_float_number:
358 assert(0 && "not yet implemented");
361 case irms_int_number:
362 mode = register_mode(&mode_tmpl);
367 /* Functions for the direct access to all attributes od a ir_mode */
369 (get_mode_modecode)(const ir_mode *mode)
372 return _get_mode_modecode(mode);
376 (get_mode_ident)(const ir_mode *mode)
379 return _get_mode_ident(mode);
383 get_mode_name(const ir_mode *mode)
386 return get_id_str(mode->name);
390 (get_mode_sort)(const ir_mode* mode)
393 return _get_mode_sort(mode);
397 (get_mode_size_bits)(const ir_mode *mode)
400 return _get_mode_size_bits(mode);
404 (get_mode_size_bytes)(const ir_mode *mode) {
406 return _get_mode_size_bytes(mode);
410 (get_mode_sign)(const ir_mode *mode)
413 return _get_mode_sign(mode);
417 (get_mode_arithmetic)(const ir_mode *mode)
420 return get_mode_arithmetic(mode);
424 /* Attribute modulo shift specifies for modes of kind irms_int_number
425 * whether shift applies modulo to value of bits to shift. Asserts
426 * if mode is not irms_int_number.
429 (get_mode_modulo_shift)(const ir_mode *mode) {
430 return _get_mode_modulo_shift(mode);
434 (get_mode_n_vector_elems)(const ir_mode *mode) {
435 return _get_mode_vector_elems(mode);
439 (get_mode_link)(const ir_mode *mode)
442 return _get_mode_link(mode);
446 (set_mode_link)(ir_mode *mode, void *l)
448 _set_mode_link(mode, l);
452 get_mode_min (ir_mode *mode)
456 assert(get_mode_modecode(mode) < num_modes);
457 assert(mode_is_data(mode));
463 get_mode_max (ir_mode *mode)
467 assert(get_mode_modecode(mode) < num_modes);
468 assert(mode_is_data(mode));
474 get_mode_null (ir_mode *mode)
478 assert(get_mode_modecode(mode) < num_modes);
479 assert(mode_is_data(mode));
485 get_mode_one (ir_mode *mode)
489 assert(get_mode_modecode(mode) < num_modes);
490 assert(mode_is_data(mode));
496 get_mode_minus_one (ir_mode *mode)
500 assert(get_mode_modecode(mode) < num_modes);
501 assert(mode_is_data(mode));
503 return mode->minus_one;
507 get_mode_infinite(ir_mode *mode)
511 assert(get_mode_modecode(mode) < num_modes);
512 assert(mode_is_float(mode));
514 return get_tarval_plus_inf(mode);
518 get_mode_NAN(ir_mode *mode)
522 assert(get_mode_modecode(mode) < num_modes);
523 assert(mode_is_float(mode));
525 return get_tarval_nan(mode);
529 is_mode (void *thing) {
530 if (get_kind(thing) == k_ir_mode)
537 (mode_is_signed)(const ir_mode *mode) {
539 return _mode_is_signed(mode);
543 (mode_is_float)(const ir_mode *mode) {
545 return _mode_is_float(mode);
549 (mode_is_int)(const ir_mode *mode) {
551 return _mode_is_int(mode);
555 (mode_is_character)(const ir_mode *mode) {
557 return _mode_is_character(mode);
561 (mode_is_reference)(const ir_mode *mode) {
563 return _mode_is_reference(mode);
567 (mode_is_num)(const ir_mode *mode) {
569 return _mode_is_num(mode);
573 (mode_is_numP)(const ir_mode *mode) {
575 return _mode_is_numP(mode);
579 (mode_is_data)(const ir_mode *mode) {
581 return _mode_is_data(mode);
585 (mode_is_datab)(const ir_mode *mode) {
587 return _mode_is_datab(mode);
591 (mode_is_dataM)(const ir_mode *mode) {
593 return _mode_is_dataM(mode);
597 (mode_is_float_vector)(const ir_mode *mode) {
599 return _mode_is_float_vector(mode);
603 (mode_is_int_vector)(const ir_mode *mode) {
605 return _mode_is_int_vector(mode);
608 /* Returns true if sm can be converted to lm without loss. */
610 smaller_mode(const ir_mode *sm, const ir_mode *lm)
612 int sm_bits, lm_bits;
618 if (sm == lm) return 1;
620 sm_bits = get_mode_size_bits(sm);
621 lm_bits = get_mode_size_bits(lm);
623 switch(get_mode_sort(sm))
625 case irms_int_number:
626 switch(get_mode_sort(lm))
628 case irms_int_number:
629 /* integers are convertable if
630 * - both have the same sign and lm is the larger one
631 * - lm is the signed one and is at least two bits larger
632 * (one for the sign, one for the highest bit of sm)
633 * - sm & lm are two_complement and lm has greater or equal number of bits
635 if ( get_mode_arithmetic(sm) == get_mode_arithmetic(lm)
636 && get_mode_arithmetic(sm) == irma_twos_complement) {
637 return lm_bits >= sm_bits;
639 else if (mode_is_signed(sm))
641 if ( mode_is_signed(lm) && (lm_bits >= sm_bits) )
644 else if (mode_is_signed(lm))
646 if (lm_bits > sm_bits + 1)
649 else if (lm_bits >= sm_bits)
655 case irms_float_number:
656 /* int to float works if the float is large enough */
664 case irms_float_number:
665 if (get_mode_arithmetic(sm) == get_mode_arithmetic(lm)) {
666 if ( (get_mode_sort(lm) == irms_float_number)
667 && (get_mode_size_bits(lm) >= get_mode_size_bits(sm)) )
673 /* do exist machines out there with different pointer lenghts ?*/
684 /* initialization, build the default modes */
690 /* init flexible array */
692 obstack_init(&modes);
695 /* initialize predefined modes */
698 newmode.arithmetic = irma_none;
701 newmode.modulo_shift = 0;
702 newmode.vector_elem = 0;
704 newmode.tv_priv = NULL;
706 /* Control Flow Modes*/
707 newmode.sort = irms_control_flow;
710 newmode.name = new_id_from_chars("BB", 2);
711 newmode.code = irm_BB;
713 mode_BB = register_mode(&newmode);
716 newmode.name = new_id_from_chars("X", 1);
717 newmode.code = irm_X;
719 mode_X = register_mode(&newmode);
722 newmode.sort = irms_memory;
725 newmode.name = new_id_from_chars("M", 1);
726 newmode.code = irm_M;
728 mode_M = register_mode(&newmode);
730 /* Auxiliary Modes */
731 newmode.sort = irms_auxiliary,
734 newmode.name = new_id_from_chars("T", 1);
735 newmode.code = irm_T;
737 mode_T = register_mode(&newmode);
740 newmode.name = new_id_from_chars("ANY", 3);
741 newmode.code = irm_ANY;
743 mode_ANY = register_mode(&newmode);
746 newmode.name = new_id_from_chars("BAD", 3);
747 newmode.code = irm_BAD;
749 mode_BAD = register_mode(&newmode);
751 /* Internal Boolean Modes */
752 newmode.sort = irms_internal_boolean;
755 newmode.name = new_id_from_chars("b", 1);
756 newmode.code = irm_b;
758 mode_b = register_mode(&newmode);
761 newmode.vector_elem = 1;
763 /* Float Number Modes */
764 newmode.sort = irms_float_number;
765 newmode.arithmetic = irma_ieee754;
768 newmode.name = new_id_from_chars("F", 1);
769 newmode.code = irm_F;
773 mode_F = register_mode(&newmode);
776 newmode.name = new_id_from_chars("D", 1);
777 newmode.code = irm_D;
781 mode_D = register_mode(&newmode);
784 newmode.name = new_id_from_chars("E", 1);
785 newmode.code = irm_E;
789 mode_E = register_mode(&newmode);
791 /* Integer Number Modes */
792 newmode.sort = irms_int_number;
793 newmode.arithmetic = irma_twos_complement;
796 newmode.name = new_id_from_chars("Bs", 2);
797 newmode.code = irm_Bs;
800 newmode.modulo_shift = 32;
802 mode_Bs = register_mode(&newmode);
805 newmode.name = new_id_from_chars("Bu", 2);
806 newmode.code = irm_Bu;
807 newmode.arithmetic = irma_twos_complement;
810 newmode.modulo_shift = 32;
812 mode_Bu = register_mode(&newmode);
814 /* signed short integer */
815 newmode.name = new_id_from_chars("Hs", 2);
816 newmode.code = irm_Hs;
819 newmode.modulo_shift = 32;
821 mode_Hs = register_mode(&newmode);
823 /* unsigned short integer */
824 newmode.name = new_id_from_chars("Hu", 2);
825 newmode.code = irm_Hu;
828 newmode.modulo_shift = 32;
830 mode_Hu = register_mode(&newmode);
833 newmode.name = new_id_from_chars("Is", 2);
834 newmode.code = irm_Is;
837 newmode.modulo_shift = 32;
839 mode_Is = register_mode(&newmode);
841 /* unsigned integer */
842 newmode.name = new_id_from_chars("Iu", 2);
843 newmode.code = irm_Iu;
846 newmode.modulo_shift = 32;
848 mode_Iu = register_mode(&newmode);
850 /* signed long integer */
851 newmode.name = new_id_from_chars("Ls", 2);
852 newmode.code = irm_Ls;
855 newmode.modulo_shift = 64;
857 mode_Ls = register_mode(&newmode);
859 /* unsigned long integer */
860 newmode.name = new_id_from_chars("Lu", 2);
861 newmode.code = irm_Lu;
864 newmode.modulo_shift = 64;
866 mode_Lu = register_mode(&newmode);
868 /* Character Modes */
869 newmode.sort = irms_character;
870 newmode.arithmetic = irma_none;
873 newmode.name = new_id_from_chars("C", 1);
874 newmode.code = irm_C;
877 newmode.modulo_shift = 32;
879 mode_C = register_mode(&newmode);
881 /* Unicode character */
882 newmode.name = new_id_from_chars("U", 1);
883 newmode.code = irm_U;
886 newmode.modulo_shift = 32;
888 mode_U = register_mode(&newmode);
890 /* Reference Modes */
891 newmode.sort = irms_reference;
892 newmode.arithmetic = irma_twos_complement;
895 newmode.name = new_id_from_chars("P", 1);
896 newmode.code = irm_P;
899 newmode.modulo_shift = 0;
901 mode_P = register_mode(&newmode);
903 /* set the machine specific modes to the predefined ones */
904 mode_P_mach = mode_P;
907 /* find a signed mode for an unsigned integer mode */
908 ir_mode *find_unsigned_mode(const ir_mode *mode) {
911 if (mode->sort != irms_int_number);
913 return find_mode(&n);
916 /* find an unsigned mode for a signed integer mode */
917 ir_mode *find_signed_mode(const ir_mode *mode) {
920 assert(mode->sort == irms_int_number);
922 return find_mode(&n);
925 /* finds a integer mode with 2*n bits for an integer mode with n bits. */
926 ir_mode *find_double_bits_int_mode(const ir_mode *mode) {
929 assert(mode->sort == irms_int_number && mode->arithmetic == irma_twos_complement);
931 n.size = 2*mode->size;
932 return find_mode(&n);
936 * Returns non-zero if the given mode honors signed zero's, i.e.,
937 * a +0 and a -0 exists and handled differently.
939 int mode_honor_signed_zeros(const ir_mode *mode)
941 /* for floating point, we know that IEEE 754 has +0 and -0,
942 * but always handles it identical.
944 if (mode->sort == irms_float_number)
945 return mode->arithmetic == irma_ieee754 ? 0 : 1;
950 * Returns non-zero if the given mode might overflow on unary Minus.
952 * This does NOT happen on IEEE 754.
954 int mode_overflow_on_unary_Minus(const ir_mode *mode)
956 if (mode->sort == irms_float_number)
957 return mode->arithmetic == irma_ieee754 ? 0 : 1;
962 * Returns non-zero if the mode has a reversed wrap-aound
963 * logic, especially (a + x) - x == a.
965 * This is normally true for integer modes, not for floating
968 int mode_wrap_around(const ir_mode *mode) {
969 /* FIXME: better would be an extra mode property */
970 return mode_is_int(mode);
973 void finish_mode(void) {
974 obstack_free(&modes, 0);