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 */
186 ir_mode *mode_LLs; /* 128 bit */
194 /* machine specific modes */
195 ir_mode *mode_P_code; /**< machine specific pointer mode for code addresses */
196 ir_mode *mode_P_data; /**< machine specific pointer mode for data addresses */
199 * functions defined in irmode.h
202 /* JNI access functions */
203 ir_mode *get_modeT(void) { return mode_T; }
204 ir_mode *get_modeF(void) { return mode_F; }
205 ir_mode *get_modeD(void) { return mode_D; }
206 ir_mode *get_modeE(void) { return mode_E; }
207 ir_mode *get_modeBs(void) { return mode_Bs; }
208 ir_mode *get_modeBu(void) { return mode_Bu; }
209 ir_mode *get_modeHs(void) { return mode_Hs; }
210 ir_mode *get_modeHu(void) { return mode_Hu; }
211 ir_mode *get_modeIs(void) { return mode_Is; }
212 ir_mode *get_modeIu(void) { return mode_Iu; }
213 ir_mode *get_modeLs(void) { return mode_Ls; }
214 ir_mode *get_modeLu(void) { return mode_Lu; }
215 ir_mode *get_modeLLs(void){ return mode_LLs; }
216 ir_mode *get_modeLLu(void){ return mode_LLu; }
217 ir_mode *get_modeC(void) { return mode_C; }
218 ir_mode *get_modeU(void) { return mode_U; }
219 ir_mode *get_modeb(void) { return mode_b; }
220 ir_mode *get_modeP(void) { return mode_P; }
221 ir_mode *get_modeX(void) { return mode_X; }
222 ir_mode *get_modeM(void) { return mode_M; }
223 ir_mode *get_modeBB(void) { return mode_BB; }
224 ir_mode *get_modeANY(void) { return mode_ANY; }
225 ir_mode *get_modeBAD(void) { return mode_BAD; }
228 ir_mode *(get_modeP_code)(void) {
229 return _get_modeP_code();
232 ir_mode *(get_modeP_data)(void) {
233 return _get_modeP_data();
236 void set_modeP_code(ir_mode *p) {
237 assert(mode_is_reference(p));
241 void set_modeP_data(ir_mode *p) {
242 assert(mode_is_reference(p));
247 * Registers a new mode.
249 * @param new_mode The new mode template.
251 static ir_mode *register_mode(const ir_mode *new_mode) {
252 ir_mode *mode = NULL;
256 /* copy mode struct to modes array */
257 mode = (ir_mode *)obstack_copy(&modes, new_mode, sizeof(*mode));
259 mode->kind = k_ir_mode;
260 if (num_modes >= irm_max) mode->code = num_modes;
263 /* add the new mode to the irp list of modes */
266 set_mode_values(mode);
268 hook_new_mode(new_mode, mode);
273 * Creates a new mode.
275 ir_mode *new_ir_mode(const char *name, mode_sort sort, int bit_size, int sign,
276 mode_arithmetic arithmetic, unsigned int modulo_shift)
279 ir_mode *mode = NULL;
281 mode_tmpl.name = new_id_from_str(name);
282 mode_tmpl.sort = sort;
283 mode_tmpl.size = bit_size;
284 mode_tmpl.sign = sign ? 1 : 0;
285 mode_tmpl.modulo_shift = (mode_tmpl.sort == irms_int_number) ? modulo_shift : 0;
286 mode_tmpl.vector_elem = 1;
287 mode_tmpl.arithmetic = arithmetic;
288 mode_tmpl.link = NULL;
289 mode_tmpl.tv_priv = NULL;
291 mode = find_mode(&mode_tmpl);
293 hook_new_mode(&mode_tmpl, mode);
300 case irms_control_flow:
302 case irms_internal_boolean:
303 assert(0 && "internal modes cannot be user defined");
306 case irms_float_number:
307 case irms_int_number:
310 mode = register_mode(&mode_tmpl);
316 * Creates a new vector mode.
318 ir_mode *new_ir_vector_mode(const char *name, mode_sort sort, int bit_size, unsigned num_of_elem, int sign,
319 mode_arithmetic arithmetic, unsigned int modulo_shift)
322 ir_mode *mode = NULL;
324 mode_tmpl.name = new_id_from_str(name);
325 mode_tmpl.sort = sort;
326 mode_tmpl.size = bit_size * num_of_elem;
327 mode_tmpl.sign = sign ? 1 : 0;
328 mode_tmpl.modulo_shift = (mode_tmpl.sort == irms_int_number) ? modulo_shift : 0;
329 mode_tmpl.vector_elem = num_of_elem;
330 mode_tmpl.arithmetic = arithmetic;
331 mode_tmpl.link = NULL;
332 mode_tmpl.tv_priv = NULL;
334 mode = find_mode(&mode_tmpl);
336 hook_new_mode(&mode_tmpl, mode);
340 if (num_of_elem <= 1) {
341 assert(0 && "vector modes should have at least 2 elements");
348 case irms_control_flow:
350 case irms_internal_boolean:
351 assert(0 && "internal modes cannot be user defined");
356 assert(0 && "only integer and floating point modes can be vectorized");
359 case irms_float_number:
360 assert(0 && "not yet implemented");
363 case irms_int_number:
364 mode = register_mode(&mode_tmpl);
369 /* Functions for the direct access to all attributes of an ir_mode */
371 (get_mode_modecode)(const ir_mode *mode) {
372 return _get_mode_modecode(mode);
376 (get_mode_ident)(const ir_mode *mode) {
377 return _get_mode_ident(mode);
381 get_mode_name(const ir_mode *mode) {
382 return get_id_str(mode->name);
386 (get_mode_sort)(const ir_mode* mode) {
387 return _get_mode_sort(mode);
391 (get_mode_size_bits)(const ir_mode *mode) {
392 return _get_mode_size_bits(mode);
396 (get_mode_size_bytes)(const ir_mode *mode) {
397 return _get_mode_size_bytes(mode);
401 (get_mode_sign)(const ir_mode *mode) {
402 return _get_mode_sign(mode);
406 (get_mode_arithmetic)(const ir_mode *mode) {
407 return get_mode_arithmetic(mode);
411 /* Attribute modulo shift specifies for modes of kind irms_int_number
412 * whether shift applies modulo to value of bits to shift. Asserts
413 * if mode is not irms_int_number.
416 (get_mode_modulo_shift)(const ir_mode *mode) {
417 return _get_mode_modulo_shift(mode);
421 (get_mode_n_vector_elems)(const ir_mode *mode) {
422 return _get_mode_vector_elems(mode);
426 (get_mode_link)(const ir_mode *mode) {
427 return _get_mode_link(mode);
431 (set_mode_link)(ir_mode *mode, void *l) {
432 _set_mode_link(mode, l);
436 get_mode_min(ir_mode *mode) {
438 assert(get_mode_modecode(mode) < num_modes);
439 assert(mode_is_data(mode));
445 get_mode_max(ir_mode *mode) {
447 assert(get_mode_modecode(mode) < num_modes);
448 assert(mode_is_data(mode));
454 get_mode_null(ir_mode *mode) {
456 assert(get_mode_modecode(mode) < num_modes);
457 assert(mode_is_data(mode));
463 get_mode_one(ir_mode *mode) {
465 assert(get_mode_modecode(mode) < num_modes);
466 assert(mode_is_data(mode));
472 get_mode_minus_one(ir_mode *mode) {
474 assert(get_mode_modecode(mode) < num_modes);
475 assert(mode_is_data(mode));
477 return mode->minus_one;
481 get_mode_infinite(ir_mode *mode) {
483 assert(get_mode_modecode(mode) < num_modes);
484 assert(mode_is_float(mode));
486 return get_tarval_plus_inf(mode);
490 get_mode_NAN(ir_mode *mode) {
492 assert(get_mode_modecode(mode) < num_modes);
493 assert(mode_is_float(mode));
495 return get_tarval_nan(mode);
499 is_mode(void *thing) {
500 if (get_kind(thing) == k_ir_mode)
507 (mode_is_signed)(const ir_mode *mode) {
508 return _mode_is_signed(mode);
512 (mode_is_float)(const ir_mode *mode) {
513 return _mode_is_float(mode);
517 (mode_is_int)(const ir_mode *mode) {
518 return _mode_is_int(mode);
522 (mode_is_character)(const ir_mode *mode) {
523 return _mode_is_character(mode);
527 (mode_is_reference)(const ir_mode *mode) {
528 return _mode_is_reference(mode);
532 (mode_is_num)(const ir_mode *mode) {
533 return _mode_is_num(mode);
537 (mode_is_numP)(const ir_mode *mode) {
538 return _mode_is_numP(mode);
542 (mode_is_data)(const ir_mode *mode) {
543 return _mode_is_data(mode);
547 (mode_is_datab)(const ir_mode *mode) {
548 return _mode_is_datab(mode);
552 (mode_is_dataM)(const ir_mode *mode) {
553 return _mode_is_dataM(mode);
557 (mode_is_float_vector)(const ir_mode *mode) {
558 return _mode_is_float_vector(mode);
562 (mode_is_int_vector)(const ir_mode *mode) {
563 return _mode_is_int_vector(mode);
566 /* Returns true if sm can be converted to lm without loss. */
568 smaller_mode(const ir_mode *sm, const ir_mode *lm) {
569 int sm_bits, lm_bits;
574 if (sm == lm) return 1;
576 sm_bits = get_mode_size_bits(sm);
577 lm_bits = get_mode_size_bits(lm);
579 switch (get_mode_sort(sm)) {
580 case irms_int_number:
581 switch (get_mode_sort(lm)) {
582 case irms_int_number:
583 /* integers are convertable if
584 * - both have the same sign and lm is the larger one
585 * - lm is the signed one and is at least two bits larger
586 * (one for the sign, one for the highest bit of sm)
587 * - sm & lm are two_complement and lm has greater or equal number of bits
589 if ( get_mode_arithmetic(sm) == get_mode_arithmetic(lm)
590 && get_mode_arithmetic(sm) == irma_twos_complement) {
591 return lm_bits >= sm_bits;
592 } else if (mode_is_signed(sm)) {
593 if ( mode_is_signed(lm) && (lm_bits >= sm_bits) )
595 } else if (mode_is_signed(lm)) {
596 if (lm_bits > sm_bits + 1)
598 } else if (lm_bits >= sm_bits) {
603 case irms_float_number:
604 /* int to float works if the float is large enough */
612 case irms_float_number:
613 if (get_mode_arithmetic(sm) == get_mode_arithmetic(lm)) {
614 if ( (get_mode_sort(lm) == irms_float_number)
615 && (get_mode_size_bits(lm) >= get_mode_size_bits(sm)) )
621 /* do exist machines out there with different pointer lenghts ?*/
632 /* Return the signed integer equivalent mode for an reference mode. */
633 ir_mode *get_reference_mode_signed_eq(ir_mode *mode) {
634 assert(mode_is_reference(mode));
635 return mode->eq_signed;
638 /* Sets the signed integer equivalent mode for an reference mode. */
639 void set_reference_mode_signed_eq(ir_mode *ref_mode, ir_mode *int_mode) {
640 assert(mode_is_reference(ref_mode));
641 assert(mode_is_int(int_mode));
642 ref_mode->eq_signed = int_mode;
645 /* Return the unsigned integer equivalent mode for an reference mode. */
646 ir_mode *get_reference_mode_unsigned_eq(ir_mode *mode) {
647 assert(mode_is_reference(mode));
648 return mode->eq_unsigned;
651 /* Sets the unsigned integer equivalent mode for an reference mode. */
652 void set_reference_mode_unsigned_eq(ir_mode *ref_mode, ir_mode *int_mode) {
653 assert(mode_is_reference(ref_mode));
654 assert(mode_is_int(int_mode));
655 ref_mode->eq_unsigned = int_mode;
658 /* initialization, build the default modes */
663 obstack_init(&modes);
666 /* initialize predefined modes */
669 newmode.arithmetic = irma_none;
672 newmode.modulo_shift = 0;
673 newmode.vector_elem = 0;
674 newmode.eq_signed = NULL;
675 newmode.eq_unsigned = NULL;
677 newmode.tv_priv = NULL;
679 /* Control Flow Modes*/
680 newmode.sort = irms_control_flow;
683 newmode.name = new_id_from_chars("BB", 2);
684 newmode.code = irm_BB;
686 mode_BB = register_mode(&newmode);
689 newmode.name = new_id_from_chars("X", 1);
690 newmode.code = irm_X;
692 mode_X = register_mode(&newmode);
695 newmode.sort = irms_memory;
698 newmode.name = new_id_from_chars("M", 1);
699 newmode.code = irm_M;
701 mode_M = register_mode(&newmode);
703 /* Auxiliary Modes */
704 newmode.sort = irms_auxiliary,
707 newmode.name = new_id_from_chars("T", 1);
708 newmode.code = irm_T;
710 mode_T = register_mode(&newmode);
713 newmode.name = new_id_from_chars("ANY", 3);
714 newmode.code = irm_ANY;
716 mode_ANY = register_mode(&newmode);
719 newmode.name = new_id_from_chars("BAD", 3);
720 newmode.code = irm_BAD;
722 mode_BAD = register_mode(&newmode);
724 /* Internal Boolean Modes */
725 newmode.sort = irms_internal_boolean;
728 newmode.name = new_id_from_chars("b", 1);
729 newmode.code = irm_b;
731 mode_b = register_mode(&newmode);
734 newmode.vector_elem = 1;
736 /* Float Number Modes */
737 newmode.sort = irms_float_number;
738 newmode.arithmetic = irma_ieee754;
741 newmode.name = new_id_from_chars("F", 1);
742 newmode.code = irm_F;
746 mode_F = register_mode(&newmode);
749 newmode.name = new_id_from_chars("D", 1);
750 newmode.code = irm_D;
754 mode_D = register_mode(&newmode);
757 newmode.name = new_id_from_chars("E", 1);
758 newmode.code = irm_E;
762 mode_E = register_mode(&newmode);
764 /* Integer Number Modes */
765 newmode.sort = irms_int_number;
766 newmode.arithmetic = irma_twos_complement;
769 newmode.name = new_id_from_chars("Bs", 2);
770 newmode.code = irm_Bs;
773 newmode.modulo_shift = 32;
775 mode_Bs = register_mode(&newmode);
778 newmode.name = new_id_from_chars("Bu", 2);
779 newmode.code = irm_Bu;
780 newmode.arithmetic = irma_twos_complement;
783 newmode.modulo_shift = 32;
785 mode_Bu = register_mode(&newmode);
787 /* signed short integer */
788 newmode.name = new_id_from_chars("Hs", 2);
789 newmode.code = irm_Hs;
792 newmode.modulo_shift = 32;
794 mode_Hs = register_mode(&newmode);
796 /* unsigned short integer */
797 newmode.name = new_id_from_chars("Hu", 2);
798 newmode.code = irm_Hu;
801 newmode.modulo_shift = 32;
803 mode_Hu = register_mode(&newmode);
806 newmode.name = new_id_from_chars("Is", 2);
807 newmode.code = irm_Is;
810 newmode.modulo_shift = 32;
812 mode_Is = register_mode(&newmode);
814 /* unsigned integer */
815 newmode.name = new_id_from_chars("Iu", 2);
816 newmode.code = irm_Iu;
819 newmode.modulo_shift = 32;
821 mode_Iu = register_mode(&newmode);
823 /* signed long integer */
824 newmode.name = new_id_from_chars("Ls", 2);
825 newmode.code = irm_Ls;
828 newmode.modulo_shift = 64;
830 mode_Ls = register_mode(&newmode);
832 /* unsigned long integer */
833 newmode.name = new_id_from_chars("Lu", 2);
834 newmode.code = irm_Lu;
837 newmode.modulo_shift = 64;
839 mode_Lu = register_mode(&newmode);
841 /* signed long long integer */
842 newmode.name = new_id_from_chars("LLs", 3);
843 newmode.code = irm_LLs;
846 newmode.modulo_shift = 128;
848 mode_LLs = register_mode(&newmode);
850 /* unsigned long long integer */
851 newmode.name = new_id_from_chars("LLu", 3);
852 newmode.code = irm_LLu;
855 newmode.modulo_shift = 128;
857 mode_LLu = register_mode(&newmode);
859 /* Character Modes */
860 newmode.sort = irms_character;
861 newmode.arithmetic = irma_twos_complement;
862 newmode.modulo_shift = 0;
865 newmode.name = new_id_from_chars("C", 1);
866 newmode.code = irm_C;
870 mode_C = register_mode(&newmode);
872 /* Unicode character */
873 newmode.name = new_id_from_chars("U", 1);
874 newmode.code = irm_U;
878 mode_U = register_mode(&newmode);
880 /* Reference Modes */
881 newmode.sort = irms_reference;
882 newmode.arithmetic = irma_twos_complement;
885 newmode.name = new_id_from_chars("P", 1);
886 newmode.code = irm_P;
889 newmode.modulo_shift = 0;
890 newmode.eq_signed = mode_Is;
891 newmode.eq_unsigned = mode_Iu;
893 mode_P = register_mode(&newmode);
895 /* set the machine specific modes to the predefined ones */
896 mode_P_code = mode_P;
897 mode_P_data = mode_P;
900 /* find a signed mode for an unsigned integer mode */
901 ir_mode *find_unsigned_mode(const ir_mode *mode) {
904 assert(mode->sort == irms_int_number);
906 return find_mode(&n);
909 /* find an unsigned mode for a signed integer mode */
910 ir_mode *find_signed_mode(const ir_mode *mode) {
913 assert(mode->sort == irms_int_number);
915 return find_mode(&n);
918 /* finds a integer mode with 2*n bits for an integer mode with n bits. */
919 ir_mode *find_double_bits_int_mode(const ir_mode *mode) {
922 assert(mode->sort == irms_int_number && mode->arithmetic == irma_twos_complement);
924 n.size = 2*mode->size;
925 return find_mode(&n);
929 * Returns non-zero if the given mode honors signed zero's, i.e.,
930 * a +0 and a -0 exists and handled differently.
932 int mode_honor_signed_zeros(const ir_mode *mode) {
933 /* for floating point, we know that IEEE 754 has +0 and -0,
934 * but always handles it identical.
937 mode->sort == irms_float_number &&
938 mode->arithmetic != irma_ieee754;
942 * Returns non-zero if the given mode might overflow on unary Minus.
944 * This does NOT happen on IEEE 754.
946 int mode_overflow_on_unary_Minus(const ir_mode *mode) {
947 if (mode->sort == irms_float_number)
948 return mode->arithmetic == irma_ieee754 ? 0 : 1;
953 * Returns non-zero if the mode has a reversed wrap-around
954 * logic, especially (a + x) - x == a.
956 * This is normally true for integer modes, not for floating
959 int mode_wrap_around(const ir_mode *mode) {
960 /* FIXME: better would be an extra mode property */
961 return mode_is_int(mode);
964 void finish_mode(void) {
965 obstack_free(&modes, 0);