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 "irprog_t.h"
26 # include "irmode_t.h"
38 /** dynamic array to hold all modes */
39 static struct obstack modes;
41 /** number of defined modes */
49 * Compare modes that don't need to have their code field
52 * TODO: Add other fields
54 INLINE static int modes_are_equal(const ir_mode *m, const ir_mode *n) {
56 if (m->sort == n->sort &&
57 m->arithmetic == n->arithmetic &&
60 m->modulo_shift == n->modulo_shift &&
61 m->vector_elem == n->vector_elem)
68 * calculates the next obstack address
70 static void *next_obstack_adr(struct obstack *o, void *p, size_t s) {
71 PTR_INT_TYPE adr = PTR_TO_INT((char *)p);
72 int mask = obstack_alignment_mask(o);
76 return INT_TO_PTR(adr & ~mask);
80 * searches the modes obstack for the given mode and returns
81 * a pointer on an equal mode already in the array, NULL if
84 static ir_mode *find_mode(const ir_mode *m) {
86 struct _obstack_chunk *p;
89 n = (ir_mode *)p->contents;
90 nn = next_obstack_adr(&modes, n, sizeof(*n));
91 for (; (char *)nn <= modes.next_free;) {
93 if (modes_are_equal(n, m))
97 nn = next_obstack_adr(&modes, n, sizeof(*n));
100 for (p = p->prev; p; p = p->prev) {
101 n = (ir_mode *)p->contents;
102 nn = next_obstack_adr(&modes, n, sizeof(*n));
103 for (; (char *)nn < p->limit;) {
105 if (modes_are_equal(n, m))
109 nn = next_obstack_adr(&modes, n, sizeof(*n));
117 * sets special values of modes
119 static void set_mode_values(ir_mode* mode) {
120 switch (get_mode_sort(mode)) {
122 case irms_int_number:
123 case irms_float_number:
124 mode->min = get_tarval_min(mode);
125 mode->max = get_tarval_max(mode);
126 mode->null = get_tarval_null(mode);
127 mode->one = get_tarval_one(mode);
128 mode->minus_one = get_tarval_minus_one(mode);
131 case irms_internal_boolean:
132 mode->min = tarval_b_false;
133 mode->max = tarval_b_true;
134 mode->null = tarval_b_false;
135 mode->one = tarval_b_true;
136 mode->minus_one = tarval_bad;
140 mode->min = tarval_bad;
141 mode->max = tarval_bad;
142 mode->null = get_tarval_null(mode);
143 mode->one = tarval_bad;
144 mode->minus_one = tarval_bad;
149 case irms_control_flow:
150 mode->min = tarval_bad;
151 mode->max = tarval_bad;
152 mode->null = tarval_bad;
153 mode->one = tarval_bad;
154 mode->minus_one = tarval_bad;
160 * globals defined in irmode.h
163 /* --- Predefined modes --- */
165 /* FIRM internal modes: */
173 /* predefined numerical modes: */
174 ir_mode *mode_F; /* float */
175 ir_mode *mode_D; /* double */
176 ir_mode *mode_E; /* long double */
178 ir_mode *mode_Bs; /* integral values, signed and unsigned */
179 ir_mode *mode_Bu; /* 8 bit */
180 ir_mode *mode_Hs; /* 16 bit */
182 ir_mode *mode_Is; /* 32 bit */
184 ir_mode *mode_Ls; /* 64 bit */
192 /* machine specific modes */
193 ir_mode *mode_P_code; /**< machine specific pointer mode for code addresses */
194 ir_mode *mode_P_data; /**< machine specific pointer mode for data addresses */
197 * functions defined in irmode.h
200 /* JNI access functions */
201 ir_mode *get_modeT(void) { return mode_T; }
202 ir_mode *get_modeF(void) { return mode_F; }
203 ir_mode *get_modeD(void) { return mode_D; }
204 ir_mode *get_modeE(void) { return mode_E; }
205 ir_mode *get_modeBs(void) { return mode_Bs; }
206 ir_mode *get_modeBu(void) { return mode_Bu; }
207 ir_mode *get_modeHs(void) { return mode_Hs; }
208 ir_mode *get_modeHu(void) { return mode_Hu; }
209 ir_mode *get_modeIs(void) { return mode_Is; }
210 ir_mode *get_modeIu(void) { return mode_Iu; }
211 ir_mode *get_modeLs(void) { return mode_Ls; }
212 ir_mode *get_modeLu(void) { return mode_Lu; }
213 ir_mode *get_modeC(void) { return mode_C; }
214 ir_mode *get_modeU(void) { return mode_U; }
215 ir_mode *get_modeb(void) { return mode_b; }
216 ir_mode *get_modeP(void) { return mode_P; }
217 ir_mode *get_modeX(void) { return mode_X; }
218 ir_mode *get_modeM(void) { return mode_M; }
219 ir_mode *get_modeBB(void) { return mode_BB; }
220 ir_mode *get_modeANY(void) { return mode_ANY; }
221 ir_mode *get_modeBAD(void) { return mode_BAD; }
224 ir_mode *(get_modeP_code)(void) {
225 return _get_modeP_code();
228 ir_mode *(get_modeP_data)(void) {
229 return _get_modeP_data();
232 void set_modeP_code(ir_mode *p) {
233 assert(mode_is_reference(p));
237 void set_modeP_data(ir_mode *p) {
238 assert(mode_is_reference(p));
243 * Registers a new mode.
245 * @param new_mode The new mode template.
247 static ir_mode *register_mode(const ir_mode *new_mode) {
248 ir_mode *mode = NULL;
252 /* copy mode struct to modes array */
253 mode = (ir_mode *)obstack_copy(&modes, new_mode, sizeof(*mode));
255 mode->kind = k_ir_mode;
256 if (num_modes >= irm_max) mode->code = num_modes;
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, 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);
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);
312 * Creates a new vector mode.
314 ir_mode *new_ir_vector_mode(const char *name, mode_sort sort, int bit_size, unsigned num_of_elem, int sign,
315 mode_arithmetic arithmetic, unsigned int modulo_shift)
318 ir_mode *mode = NULL;
320 mode_tmpl.name = new_id_from_str(name);
321 mode_tmpl.sort = sort;
322 mode_tmpl.size = bit_size * num_of_elem;
323 mode_tmpl.sign = sign ? 1 : 0;
324 mode_tmpl.modulo_shift = (mode_tmpl.sort == irms_int_number) ? modulo_shift : 0;
325 mode_tmpl.vector_elem = num_of_elem;
326 mode_tmpl.arithmetic = arithmetic;
327 mode_tmpl.link = NULL;
328 mode_tmpl.tv_priv = NULL;
330 mode = find_mode(&mode_tmpl);
332 hook_new_mode(&mode_tmpl, mode);
336 if (num_of_elem <= 1) {
337 assert(0 && "vector modes should have at least 2 elements");
344 case irms_control_flow:
346 case irms_internal_boolean:
347 assert(0 && "internal modes cannot be user defined");
352 assert(0 && "only integer and floating point modes can be vectorized");
355 case irms_float_number:
356 assert(0 && "not yet implemented");
359 case irms_int_number:
360 mode = register_mode(&mode_tmpl);
365 /* Functions for the direct access to all attributes of an ir_mode */
367 (get_mode_modecode)(const ir_mode *mode) {
368 return _get_mode_modecode(mode);
372 (get_mode_ident)(const ir_mode *mode) {
373 return _get_mode_ident(mode);
377 get_mode_name(const ir_mode *mode) {
378 return get_id_str(mode->name);
382 (get_mode_sort)(const ir_mode* mode) {
383 return _get_mode_sort(mode);
387 (get_mode_size_bits)(const ir_mode *mode) {
388 return _get_mode_size_bits(mode);
392 (get_mode_size_bytes)(const ir_mode *mode) {
393 return _get_mode_size_bytes(mode);
397 (get_mode_sign)(const ir_mode *mode) {
398 return _get_mode_sign(mode);
402 (get_mode_arithmetic)(const ir_mode *mode) {
403 return get_mode_arithmetic(mode);
407 /* Attribute modulo shift specifies for modes of kind irms_int_number
408 * whether shift applies modulo to value of bits to shift. Asserts
409 * if mode is not irms_int_number.
412 (get_mode_modulo_shift)(const ir_mode *mode) {
413 return _get_mode_modulo_shift(mode);
417 (get_mode_n_vector_elems)(const ir_mode *mode) {
418 return _get_mode_vector_elems(mode);
422 (get_mode_link)(const ir_mode *mode) {
423 return _get_mode_link(mode);
427 (set_mode_link)(ir_mode *mode, void *l) {
428 _set_mode_link(mode, l);
432 get_mode_min(ir_mode *mode) {
434 assert(get_mode_modecode(mode) < num_modes);
435 assert(mode_is_data(mode));
441 get_mode_max(ir_mode *mode) {
443 assert(get_mode_modecode(mode) < num_modes);
444 assert(mode_is_data(mode));
450 get_mode_null(ir_mode *mode) {
452 assert(get_mode_modecode(mode) < num_modes);
453 assert(mode_is_data(mode));
459 get_mode_one(ir_mode *mode) {
461 assert(get_mode_modecode(mode) < num_modes);
462 assert(mode_is_data(mode));
468 get_mode_minus_one(ir_mode *mode) {
470 assert(get_mode_modecode(mode) < num_modes);
471 assert(mode_is_data(mode));
473 return mode->minus_one;
477 get_mode_infinite(ir_mode *mode) {
479 assert(get_mode_modecode(mode) < num_modes);
480 assert(mode_is_float(mode));
482 return get_tarval_plus_inf(mode);
486 get_mode_NAN(ir_mode *mode) {
488 assert(get_mode_modecode(mode) < num_modes);
489 assert(mode_is_float(mode));
491 return get_tarval_nan(mode);
495 is_mode(void *thing) {
496 if (get_kind(thing) == k_ir_mode)
503 (mode_is_signed)(const ir_mode *mode) {
504 return _mode_is_signed(mode);
508 (mode_is_float)(const ir_mode *mode) {
509 return _mode_is_float(mode);
513 (mode_is_int)(const ir_mode *mode) {
514 return _mode_is_int(mode);
518 (mode_is_character)(const ir_mode *mode) {
519 return _mode_is_character(mode);
523 (mode_is_reference)(const ir_mode *mode) {
524 return _mode_is_reference(mode);
528 (mode_is_num)(const ir_mode *mode) {
529 return _mode_is_num(mode);
533 (mode_is_numP)(const ir_mode *mode) {
534 return _mode_is_numP(mode);
538 (mode_is_data)(const ir_mode *mode) {
539 return _mode_is_data(mode);
543 (mode_is_datab)(const ir_mode *mode) {
544 return _mode_is_datab(mode);
548 (mode_is_dataM)(const ir_mode *mode) {
549 return _mode_is_dataM(mode);
553 (mode_is_float_vector)(const ir_mode *mode) {
554 return _mode_is_float_vector(mode);
558 (mode_is_int_vector)(const ir_mode *mode) {
559 return _mode_is_int_vector(mode);
562 /* Returns true if sm can be converted to lm without loss. */
564 smaller_mode(const ir_mode *sm, const ir_mode *lm) {
565 int sm_bits, lm_bits;
570 if (sm == lm) return 1;
572 sm_bits = get_mode_size_bits(sm);
573 lm_bits = get_mode_size_bits(lm);
575 switch (get_mode_sort(sm)) {
576 case irms_int_number:
577 switch (get_mode_sort(lm)) {
578 case irms_int_number:
579 /* integers are convertable if
580 * - both have the same sign and lm is the larger one
581 * - lm is the signed one and is at least two bits larger
582 * (one for the sign, one for the highest bit of sm)
583 * - sm & lm are two_complement and lm has greater or equal number of bits
585 if ( get_mode_arithmetic(sm) == get_mode_arithmetic(lm)
586 && get_mode_arithmetic(sm) == irma_twos_complement) {
587 return lm_bits >= sm_bits;
588 } else if (mode_is_signed(sm)) {
589 if ( mode_is_signed(lm) && (lm_bits >= sm_bits) )
591 } else if (mode_is_signed(lm)) {
592 if (lm_bits > sm_bits + 1)
594 } else if (lm_bits >= sm_bits) {
599 case irms_float_number:
600 /* int to float works if the float is large enough */
608 case irms_float_number:
609 if (get_mode_arithmetic(sm) == get_mode_arithmetic(lm)) {
610 if ( (get_mode_sort(lm) == irms_float_number)
611 && (get_mode_size_bits(lm) >= get_mode_size_bits(sm)) )
617 /* do exist machines out there with different pointer lenghts ?*/
628 /* Return the signed integer equivalent mode for an reference mode. */
629 ir_mode *get_reference_mode_signed_eq(ir_mode *mode) {
630 assert(mode_is_reference(mode));
631 return mode->eq_signed;
634 /* Sets the signed integer equivalent mode for an reference mode. */
635 void set_reference_mode_signed_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_signed = int_mode;
641 /* Return the unsigned integer equivalent mode for an reference mode. */
642 ir_mode *get_reference_mode_unsigned_eq(ir_mode *mode) {
643 assert(mode_is_reference(mode));
644 return mode->eq_unsigned;
647 /* Sets the unsigned integer equivalent mode for an reference mode. */
648 void set_reference_mode_unsigned_eq(ir_mode *ref_mode, ir_mode *int_mode) {
649 assert(mode_is_reference(ref_mode));
650 assert(mode_is_int(int_mode));
651 ref_mode->eq_unsigned = int_mode;
654 /* initialization, build the default modes */
659 obstack_init(&modes);
662 /* initialize predefined modes */
665 newmode.arithmetic = irma_none;
668 newmode.modulo_shift = 0;
669 newmode.vector_elem = 0;
670 newmode.eq_signed = NULL;
671 newmode.eq_unsigned = NULL;
673 newmode.tv_priv = NULL;
675 /* Control Flow Modes*/
676 newmode.sort = irms_control_flow;
679 newmode.name = new_id_from_chars("BB", 2);
680 newmode.code = irm_BB;
682 mode_BB = register_mode(&newmode);
685 newmode.name = new_id_from_chars("X", 1);
686 newmode.code = irm_X;
688 mode_X = register_mode(&newmode);
691 newmode.sort = irms_memory;
694 newmode.name = new_id_from_chars("M", 1);
695 newmode.code = irm_M;
697 mode_M = register_mode(&newmode);
699 /* Auxiliary Modes */
700 newmode.sort = irms_auxiliary,
703 newmode.name = new_id_from_chars("T", 1);
704 newmode.code = irm_T;
706 mode_T = register_mode(&newmode);
709 newmode.name = new_id_from_chars("ANY", 3);
710 newmode.code = irm_ANY;
712 mode_ANY = register_mode(&newmode);
715 newmode.name = new_id_from_chars("BAD", 3);
716 newmode.code = irm_BAD;
718 mode_BAD = register_mode(&newmode);
720 /* Internal Boolean Modes */
721 newmode.sort = irms_internal_boolean;
724 newmode.name = new_id_from_chars("b", 1);
725 newmode.code = irm_b;
727 mode_b = register_mode(&newmode);
730 newmode.vector_elem = 1;
732 /* Float Number Modes */
733 newmode.sort = irms_float_number;
734 newmode.arithmetic = irma_ieee754;
737 newmode.name = new_id_from_chars("F", 1);
738 newmode.code = irm_F;
742 mode_F = register_mode(&newmode);
745 newmode.name = new_id_from_chars("D", 1);
746 newmode.code = irm_D;
750 mode_D = register_mode(&newmode);
753 newmode.name = new_id_from_chars("E", 1);
754 newmode.code = irm_E;
758 mode_E = register_mode(&newmode);
760 /* Integer Number Modes */
761 newmode.sort = irms_int_number;
762 newmode.arithmetic = irma_twos_complement;
765 newmode.name = new_id_from_chars("Bs", 2);
766 newmode.code = irm_Bs;
769 newmode.modulo_shift = 32;
771 mode_Bs = register_mode(&newmode);
774 newmode.name = new_id_from_chars("Bu", 2);
775 newmode.code = irm_Bu;
776 newmode.arithmetic = irma_twos_complement;
779 newmode.modulo_shift = 32;
781 mode_Bu = register_mode(&newmode);
783 /* signed short integer */
784 newmode.name = new_id_from_chars("Hs", 2);
785 newmode.code = irm_Hs;
788 newmode.modulo_shift = 32;
790 mode_Hs = register_mode(&newmode);
792 /* unsigned short integer */
793 newmode.name = new_id_from_chars("Hu", 2);
794 newmode.code = irm_Hu;
797 newmode.modulo_shift = 32;
799 mode_Hu = register_mode(&newmode);
802 newmode.name = new_id_from_chars("Is", 2);
803 newmode.code = irm_Is;
806 newmode.modulo_shift = 32;
808 mode_Is = register_mode(&newmode);
810 /* unsigned integer */
811 newmode.name = new_id_from_chars("Iu", 2);
812 newmode.code = irm_Iu;
815 newmode.modulo_shift = 32;
817 mode_Iu = register_mode(&newmode);
819 /* signed long integer */
820 newmode.name = new_id_from_chars("Ls", 2);
821 newmode.code = irm_Ls;
824 newmode.modulo_shift = 64;
826 mode_Ls = register_mode(&newmode);
828 /* unsigned long integer */
829 newmode.name = new_id_from_chars("Lu", 2);
830 newmode.code = irm_Lu;
833 newmode.modulo_shift = 64;
835 mode_Lu = register_mode(&newmode);
837 /* Character Modes */
838 newmode.sort = irms_character;
839 newmode.arithmetic = irma_twos_complement;
840 newmode.modulo_shift = 0;
843 newmode.name = new_id_from_chars("C", 1);
844 newmode.code = irm_C;
848 mode_C = register_mode(&newmode);
850 /* Unicode character */
851 newmode.name = new_id_from_chars("U", 1);
852 newmode.code = irm_U;
856 mode_U = register_mode(&newmode);
858 /* Reference Modes */
859 newmode.sort = irms_reference;
860 newmode.arithmetic = irma_twos_complement;
863 newmode.name = new_id_from_chars("P", 1);
864 newmode.code = irm_P;
867 newmode.modulo_shift = 0;
868 newmode.eq_signed = mode_Is;
869 newmode.eq_unsigned = mode_Iu;
871 mode_P = register_mode(&newmode);
873 /* set the machine specific modes to the predefined ones */
874 mode_P_code = mode_P;
875 mode_P_data = mode_P;
878 /* find a signed mode for an unsigned integer mode */
879 ir_mode *find_unsigned_mode(const ir_mode *mode) {
882 assert(mode->sort == irms_int_number);
884 return find_mode(&n);
887 /* find an unsigned mode for a signed integer mode */
888 ir_mode *find_signed_mode(const ir_mode *mode) {
891 assert(mode->sort == irms_int_number);
893 return find_mode(&n);
896 /* finds a integer mode with 2*n bits for an integer mode with n bits. */
897 ir_mode *find_double_bits_int_mode(const ir_mode *mode) {
900 assert(mode->sort == irms_int_number && mode->arithmetic == irma_twos_complement);
902 n.size = 2*mode->size;
903 return find_mode(&n);
907 * Returns non-zero if the given mode honors signed zero's, i.e.,
908 * a +0 and a -0 exists and handled differently.
910 int mode_honor_signed_zeros(const ir_mode *mode) {
911 /* for floating point, we know that IEEE 754 has +0 and -0,
912 * but always handles it identical.
915 mode->sort == irms_float_number &&
916 mode->arithmetic != irma_ieee754;
920 * Returns non-zero if the given mode might overflow on unary Minus.
922 * This does NOT happen on IEEE 754.
924 int mode_overflow_on_unary_Minus(const ir_mode *mode) {
925 if (mode->sort == irms_float_number)
926 return mode->arithmetic == irma_ieee754 ? 0 : 1;
931 * Returns non-zero if the mode has a reversed wrap-around
932 * logic, especially (a + x) - x == a.
934 * This is normally true for integer modes, not for floating
937 int mode_wrap_around(const ir_mode *mode) {
938 /* FIXME: better would be an extra mode property */
939 return mode_is_int(mode);
942 void finish_mode(void) {
943 obstack_free(&modes, 0);