2 * Copyright (C) 1995-2007 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * @brief Data modes of operations.
23 * @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Mathias Heil
39 # include "irprog_t.h"
40 # include "irmode_t.h"
52 /** dynamic array to hold all modes */
53 static struct obstack modes;
55 /** number of defined modes */
63 * Compare modes that don't need to have their code field
66 * TODO: Add other fields
68 INLINE static int modes_are_equal(const ir_mode *m, const ir_mode *n) {
70 if (m->sort == n->sort &&
71 m->arithmetic == n->arithmetic &&
74 m->modulo_shift == n->modulo_shift &&
75 m->vector_elem == n->vector_elem)
82 * calculates the next obstack address
84 static void *next_obstack_adr(struct obstack *o, void *p, size_t s) {
85 PTR_INT_TYPE adr = PTR_TO_INT((char *)p);
86 int mask = obstack_alignment_mask(o);
90 return INT_TO_PTR(adr & ~mask);
94 * searches the modes obstack for the given mode and returns
95 * a pointer on an equal mode already in the array, NULL if
98 static ir_mode *find_mode(const ir_mode *m) {
100 struct _obstack_chunk *p;
103 n = (ir_mode *)p->contents;
104 nn = next_obstack_adr(&modes, n, sizeof(*n));
105 for (; (char *)nn <= modes.next_free;) {
107 if (modes_are_equal(n, m))
111 nn = next_obstack_adr(&modes, n, sizeof(*n));
114 for (p = p->prev; p; p = p->prev) {
115 n = (ir_mode *)p->contents;
116 nn = next_obstack_adr(&modes, n, sizeof(*n));
117 for (; (char *)nn < p->limit;) {
119 if (modes_are_equal(n, m))
123 nn = next_obstack_adr(&modes, n, sizeof(*n));
131 * sets special values of modes
133 static void set_mode_values(ir_mode* mode) {
134 switch (get_mode_sort(mode)) {
135 case irms_int_number:
136 case irms_float_number:
137 mode->min = get_tarval_min(mode);
138 mode->max = get_tarval_max(mode);
139 mode->null = get_tarval_null(mode);
140 mode->one = get_tarval_one(mode);
141 mode->minus_one = get_tarval_minus_one(mode);
144 case irms_internal_boolean:
145 mode->min = tarval_b_false;
146 mode->max = tarval_b_true;
147 mode->null = tarval_b_false;
148 mode->one = tarval_b_true;
149 mode->minus_one = tarval_bad;
153 mode->min = tarval_bad;
154 mode->max = tarval_bad;
155 mode->null = get_tarval_null(mode);
156 mode->one = tarval_bad;
157 mode->minus_one = tarval_bad;
162 case irms_control_flow:
163 mode->min = tarval_bad;
164 mode->max = tarval_bad;
165 mode->null = tarval_bad;
166 mode->one = tarval_bad;
167 mode->minus_one = tarval_bad;
173 * globals defined in irmode.h
176 /* --- Predefined modes --- */
178 /* FIRM internal modes: */
186 /* predefined numerical modes: */
187 ir_mode *mode_F; /* float */
188 ir_mode *mode_D; /* double */
189 ir_mode *mode_E; /* long double */
191 ir_mode *mode_Bs; /* integral values, signed and unsigned */
192 ir_mode *mode_Bu; /* 8 bit */
193 ir_mode *mode_Hs; /* 16 bit */
195 ir_mode *mode_Is; /* 32 bit */
197 ir_mode *mode_Ls; /* 64 bit */
199 ir_mode *mode_LLs; /* 128 bit */
205 /* machine specific modes */
206 ir_mode *mode_P_code; /**< machine specific pointer mode for code addresses */
207 ir_mode *mode_P_data; /**< machine specific pointer mode for data addresses */
210 * functions defined in irmode.h
213 /* JNI access functions */
214 ir_mode *get_modeT(void) { return mode_T; }
215 ir_mode *get_modeF(void) { return mode_F; }
216 ir_mode *get_modeD(void) { return mode_D; }
217 ir_mode *get_modeE(void) { return mode_E; }
218 ir_mode *get_modeBs(void) { return mode_Bs; }
219 ir_mode *get_modeBu(void) { return mode_Bu; }
220 ir_mode *get_modeHs(void) { return mode_Hs; }
221 ir_mode *get_modeHu(void) { return mode_Hu; }
222 ir_mode *get_modeIs(void) { return mode_Is; }
223 ir_mode *get_modeIu(void) { return mode_Iu; }
224 ir_mode *get_modeLs(void) { return mode_Ls; }
225 ir_mode *get_modeLu(void) { return mode_Lu; }
226 ir_mode *get_modeLLs(void){ return mode_LLs; }
227 ir_mode *get_modeLLu(void){ return mode_LLu; }
228 ir_mode *get_modeb(void) { return mode_b; }
229 ir_mode *get_modeP(void) { return mode_P; }
230 ir_mode *get_modeX(void) { return mode_X; }
231 ir_mode *get_modeM(void) { return mode_M; }
232 ir_mode *get_modeBB(void) { return mode_BB; }
233 ir_mode *get_modeANY(void) { return mode_ANY; }
234 ir_mode *get_modeBAD(void) { return mode_BAD; }
237 ir_mode *(get_modeP_code)(void) {
238 return _get_modeP_code();
241 ir_mode *(get_modeP_data)(void) {
242 return _get_modeP_data();
245 void set_modeP_code(ir_mode *p) {
246 assert(mode_is_reference(p));
250 void set_modeP_data(ir_mode *p) {
251 assert(mode_is_reference(p));
256 * Registers a new mode.
258 * @param new_mode The new mode template.
260 static ir_mode *register_mode(const ir_mode *new_mode) {
261 ir_mode *mode = NULL;
265 /* copy mode struct to modes array */
266 mode = (ir_mode *)obstack_copy(&modes, new_mode, sizeof(*mode));
268 mode->kind = k_ir_mode;
269 if (num_modes >= irm_max) mode->code = num_modes;
272 /* add the new mode to the irp list of modes */
275 set_mode_values(mode);
277 hook_new_mode(new_mode, mode);
282 * Creates a new mode.
284 ir_mode *new_ir_mode(const char *name, mode_sort sort, int bit_size, int sign,
285 mode_arithmetic arithmetic, unsigned int modulo_shift)
288 ir_mode *mode = NULL;
290 mode_tmpl.name = new_id_from_str(name);
291 mode_tmpl.sort = sort;
292 mode_tmpl.size = bit_size;
293 mode_tmpl.sign = sign ? 1 : 0;
294 mode_tmpl.modulo_shift = (mode_tmpl.sort == irms_int_number) ? modulo_shift : 0;
295 mode_tmpl.vector_elem = 1;
296 mode_tmpl.arithmetic = arithmetic;
297 mode_tmpl.link = NULL;
298 mode_tmpl.tv_priv = NULL;
300 mode = find_mode(&mode_tmpl);
302 hook_new_mode(&mode_tmpl, mode);
309 case irms_control_flow:
311 case irms_internal_boolean:
312 assert(0 && "internal modes cannot be user defined");
315 case irms_float_number:
316 case irms_int_number:
318 mode = register_mode(&mode_tmpl);
324 * Creates a new vector mode.
326 ir_mode *new_ir_vector_mode(const char *name, mode_sort sort, int bit_size, unsigned num_of_elem, int sign,
327 mode_arithmetic arithmetic, unsigned int modulo_shift)
330 ir_mode *mode = NULL;
332 mode_tmpl.name = new_id_from_str(name);
333 mode_tmpl.sort = sort;
334 mode_tmpl.size = bit_size * num_of_elem;
335 mode_tmpl.sign = sign ? 1 : 0;
336 mode_tmpl.modulo_shift = (mode_tmpl.sort == irms_int_number) ? modulo_shift : 0;
337 mode_tmpl.vector_elem = num_of_elem;
338 mode_tmpl.arithmetic = arithmetic;
339 mode_tmpl.link = NULL;
340 mode_tmpl.tv_priv = NULL;
342 mode = find_mode(&mode_tmpl);
344 hook_new_mode(&mode_tmpl, mode);
348 if (num_of_elem <= 1) {
349 assert(0 && "vector modes should have at least 2 elements");
356 case irms_control_flow:
358 case irms_internal_boolean:
359 assert(0 && "internal modes cannot be user defined");
363 assert(0 && "only integer and floating point modes can be vectorized");
366 case irms_float_number:
367 assert(0 && "not yet implemented");
370 case irms_int_number:
371 mode = register_mode(&mode_tmpl);
376 /* Functions for the direct access to all attributes of an ir_mode */
378 (get_mode_modecode)(const ir_mode *mode) {
379 return _get_mode_modecode(mode);
383 (get_mode_ident)(const ir_mode *mode) {
384 return _get_mode_ident(mode);
388 get_mode_name(const ir_mode *mode) {
389 return get_id_str(mode->name);
393 (get_mode_sort)(const ir_mode* mode) {
394 return _get_mode_sort(mode);
398 (get_mode_size_bits)(const ir_mode *mode) {
399 return _get_mode_size_bits(mode);
403 (get_mode_size_bytes)(const ir_mode *mode) {
404 return _get_mode_size_bytes(mode);
408 (get_mode_sign)(const ir_mode *mode) {
409 return _get_mode_sign(mode);
413 (get_mode_arithmetic)(const ir_mode *mode) {
414 return get_mode_arithmetic(mode);
418 /* Attribute modulo shift specifies for modes of kind irms_int_number
419 * whether shift applies modulo to value of bits to shift. Asserts
420 * if mode is not irms_int_number.
423 (get_mode_modulo_shift)(const ir_mode *mode) {
424 return _get_mode_modulo_shift(mode);
428 (get_mode_n_vector_elems)(const ir_mode *mode) {
429 return _get_mode_vector_elems(mode);
433 (get_mode_link)(const ir_mode *mode) {
434 return _get_mode_link(mode);
438 (set_mode_link)(ir_mode *mode, void *l) {
439 _set_mode_link(mode, l);
443 get_mode_min(ir_mode *mode) {
445 assert(get_mode_modecode(mode) < (modecode) num_modes);
446 assert(mode_is_data(mode));
452 get_mode_max(ir_mode *mode) {
454 assert(get_mode_modecode(mode) < (modecode) num_modes);
455 assert(mode_is_data(mode));
461 get_mode_null(ir_mode *mode) {
463 assert(get_mode_modecode(mode) < (modecode) num_modes);
464 assert(mode_is_data(mode));
470 get_mode_one(ir_mode *mode) {
472 assert(get_mode_modecode(mode) < (modecode) num_modes);
473 assert(mode_is_data(mode));
479 get_mode_minus_one(ir_mode *mode) {
481 assert(get_mode_modecode(mode) < (modecode) num_modes);
482 assert(mode_is_data(mode));
484 return mode->minus_one;
488 get_mode_infinite(ir_mode *mode) {
490 assert(get_mode_modecode(mode) < (modecode) num_modes);
491 assert(mode_is_float(mode));
493 return get_tarval_plus_inf(mode);
497 get_mode_NAN(ir_mode *mode) {
499 assert(get_mode_modecode(mode) < (modecode) num_modes);
500 assert(mode_is_float(mode));
502 return get_tarval_nan(mode);
506 is_mode(void *thing) {
507 if (get_kind(thing) == k_ir_mode)
514 (mode_is_signed)(const ir_mode *mode) {
515 return _mode_is_signed(mode);
519 (mode_is_float)(const ir_mode *mode) {
520 return _mode_is_float(mode);
524 (mode_is_int)(const ir_mode *mode) {
525 return _mode_is_int(mode);
529 (mode_is_reference)(const ir_mode *mode) {
530 return _mode_is_reference(mode);
534 (mode_is_num)(const ir_mode *mode) {
535 return _mode_is_num(mode);
539 (mode_is_data)(const ir_mode *mode) {
540 return _mode_is_data(mode);
544 (mode_is_datab)(const ir_mode *mode) {
545 return _mode_is_datab(mode);
549 (mode_is_dataM)(const ir_mode *mode) {
550 return _mode_is_dataM(mode);
554 (mode_is_float_vector)(const ir_mode *mode) {
555 return _mode_is_float_vector(mode);
559 (mode_is_int_vector)(const ir_mode *mode) {
560 return _mode_is_int_vector(mode);
563 /* Returns true if sm can be converted to lm without loss. */
565 smaller_mode(const ir_mode *sm, const ir_mode *lm) {
566 int sm_bits, lm_bits;
571 if (sm == lm) return 1;
573 sm_bits = get_mode_size_bits(sm);
574 lm_bits = get_mode_size_bits(lm);
576 switch (get_mode_sort(sm)) {
577 case irms_int_number:
578 switch (get_mode_sort(lm)) {
579 case irms_int_number:
580 /* integers are convertable if
581 * - both have the same sign and lm is the larger one
582 * - lm is the signed one and is at least two bits larger
583 * (one for the sign, one for the highest bit of sm)
584 * - sm & lm are two_complement and lm has greater or equal number of bits
586 if ( get_mode_arithmetic(sm) == get_mode_arithmetic(lm)
587 && get_mode_arithmetic(sm) == irma_twos_complement) {
588 return lm_bits >= sm_bits;
589 } else if (mode_is_signed(sm)) {
590 if ( mode_is_signed(lm) && (lm_bits >= sm_bits) )
592 } else if (mode_is_signed(lm)) {
593 if (lm_bits > sm_bits + 1)
595 } else if (lm_bits >= sm_bits) {
600 case irms_float_number:
601 /* int to float works if the float is large enough */
609 case irms_float_number:
610 if (get_mode_arithmetic(sm) == get_mode_arithmetic(lm)) {
611 if ( (get_mode_sort(lm) == irms_float_number)
612 && (get_mode_size_bits(lm) >= get_mode_size_bits(sm)) )
618 /* do exist machines out there with different pointer lenghts ?*/
629 /* Return the signed integer equivalent mode for an reference mode. */
630 ir_mode *get_reference_mode_signed_eq(ir_mode *mode) {
631 assert(mode_is_reference(mode));
632 return mode->eq_signed;
635 /* Sets the signed integer equivalent mode for an reference mode. */
636 void set_reference_mode_signed_eq(ir_mode *ref_mode, ir_mode *int_mode) {
637 assert(mode_is_reference(ref_mode));
638 assert(mode_is_int(int_mode));
639 ref_mode->eq_signed = int_mode;
642 /* Return the unsigned integer equivalent mode for an reference mode. */
643 ir_mode *get_reference_mode_unsigned_eq(ir_mode *mode) {
644 assert(mode_is_reference(mode));
645 return mode->eq_unsigned;
648 /* Sets the unsigned integer equivalent mode for an reference mode. */
649 void set_reference_mode_unsigned_eq(ir_mode *ref_mode, ir_mode *int_mode) {
650 assert(mode_is_reference(ref_mode));
651 assert(mode_is_int(int_mode));
652 ref_mode->eq_unsigned = int_mode;
655 /* initialization, build the default modes */
660 obstack_init(&modes);
663 /* initialize predefined modes */
666 newmode.arithmetic = irma_none;
669 newmode.modulo_shift = 0;
670 newmode.vector_elem = 0;
671 newmode.eq_signed = NULL;
672 newmode.eq_unsigned = NULL;
674 newmode.tv_priv = NULL;
676 /* Control Flow Modes*/
677 newmode.sort = irms_control_flow;
680 newmode.name = new_id_from_chars("BB", 2);
681 newmode.code = irm_BB;
683 mode_BB = register_mode(&newmode);
686 newmode.name = new_id_from_chars("X", 1);
687 newmode.code = irm_X;
689 mode_X = register_mode(&newmode);
692 newmode.sort = irms_memory;
695 newmode.name = new_id_from_chars("M", 1);
696 newmode.code = irm_M;
698 mode_M = register_mode(&newmode);
700 /* Auxiliary Modes */
701 newmode.sort = irms_auxiliary,
704 newmode.name = new_id_from_chars("T", 1);
705 newmode.code = irm_T;
707 mode_T = register_mode(&newmode);
710 newmode.name = new_id_from_chars("ANY", 3);
711 newmode.code = irm_ANY;
713 mode_ANY = register_mode(&newmode);
716 newmode.name = new_id_from_chars("BAD", 3);
717 newmode.code = irm_BAD;
719 mode_BAD = register_mode(&newmode);
721 /* Internal Boolean Modes */
722 newmode.sort = irms_internal_boolean;
725 newmode.name = new_id_from_chars("b", 1);
726 newmode.code = irm_b;
728 mode_b = register_mode(&newmode);
731 newmode.vector_elem = 1;
733 /* Float Number Modes */
734 newmode.sort = irms_float_number;
735 newmode.arithmetic = irma_ieee754;
738 newmode.name = new_id_from_chars("F", 1);
739 newmode.code = irm_F;
743 mode_F = register_mode(&newmode);
746 newmode.name = new_id_from_chars("D", 1);
747 newmode.code = irm_D;
751 mode_D = register_mode(&newmode);
754 newmode.name = new_id_from_chars("E", 1);
755 newmode.code = irm_E;
759 mode_E = register_mode(&newmode);
761 /* Integer Number Modes */
762 newmode.sort = irms_int_number;
763 newmode.arithmetic = irma_twos_complement;
766 newmode.name = new_id_from_chars("Bs", 2);
767 newmode.code = irm_Bs;
770 newmode.modulo_shift = 32;
772 mode_Bs = register_mode(&newmode);
775 newmode.name = new_id_from_chars("Bu", 2);
776 newmode.code = irm_Bu;
777 newmode.arithmetic = irma_twos_complement;
780 newmode.modulo_shift = 32;
782 mode_Bu = register_mode(&newmode);
784 /* signed short integer */
785 newmode.name = new_id_from_chars("Hs", 2);
786 newmode.code = irm_Hs;
789 newmode.modulo_shift = 32;
791 mode_Hs = register_mode(&newmode);
793 /* unsigned short integer */
794 newmode.name = new_id_from_chars("Hu", 2);
795 newmode.code = irm_Hu;
798 newmode.modulo_shift = 32;
800 mode_Hu = register_mode(&newmode);
803 newmode.name = new_id_from_chars("Is", 2);
804 newmode.code = irm_Is;
807 newmode.modulo_shift = 32;
809 mode_Is = register_mode(&newmode);
811 /* unsigned integer */
812 newmode.name = new_id_from_chars("Iu", 2);
813 newmode.code = irm_Iu;
816 newmode.modulo_shift = 32;
818 mode_Iu = register_mode(&newmode);
820 /* signed long integer */
821 newmode.name = new_id_from_chars("Ls", 2);
822 newmode.code = irm_Ls;
825 newmode.modulo_shift = 64;
827 mode_Ls = register_mode(&newmode);
829 /* unsigned long integer */
830 newmode.name = new_id_from_chars("Lu", 2);
831 newmode.code = irm_Lu;
834 newmode.modulo_shift = 64;
836 mode_Lu = register_mode(&newmode);
838 /* signed long long integer */
839 newmode.name = new_id_from_chars("LLs", 3);
840 newmode.code = irm_LLs;
843 newmode.modulo_shift = 128;
845 mode_LLs = register_mode(&newmode);
847 /* unsigned long long integer */
848 newmode.name = new_id_from_chars("LLu", 3);
849 newmode.code = irm_LLu;
852 newmode.modulo_shift = 128;
854 mode_LLu = register_mode(&newmode);
857 newmode.sort = irms_reference;
858 newmode.arithmetic = irma_twos_complement;
861 newmode.name = new_id_from_chars("P", 1);
862 newmode.code = irm_P;
865 newmode.modulo_shift = 0;
866 newmode.eq_signed = mode_Is;
867 newmode.eq_unsigned = mode_Iu;
869 mode_P = register_mode(&newmode);
871 /* set the machine specific modes to the predefined ones */
872 mode_P_code = mode_P;
873 mode_P_data = mode_P;
876 /* find a signed mode for an unsigned integer mode */
877 ir_mode *find_unsigned_mode(const ir_mode *mode) {
880 assert(mode->sort == irms_int_number);
882 return find_mode(&n);
885 /* find an unsigned mode for a signed integer mode */
886 ir_mode *find_signed_mode(const ir_mode *mode) {
889 assert(mode->sort == irms_int_number);
891 return find_mode(&n);
894 /* finds a integer mode with 2*n bits for an integer mode with n bits. */
895 ir_mode *find_double_bits_int_mode(const ir_mode *mode) {
898 assert(mode->sort == irms_int_number && mode->arithmetic == irma_twos_complement);
900 n.size = 2*mode->size;
901 return find_mode(&n);
905 * Returns non-zero if the given mode honors signed zero's, i.e.,
906 * a +0 and a -0 exists and handled differently.
908 int mode_honor_signed_zeros(const ir_mode *mode) {
909 /* for floating point, we know that IEEE 754 has +0 and -0,
910 * but always handles it identical.
913 mode->sort == irms_float_number &&
914 mode->arithmetic != irma_ieee754;
918 * Returns non-zero if the given mode might overflow on unary Minus.
920 * This does NOT happen on IEEE 754.
922 int mode_overflow_on_unary_Minus(const ir_mode *mode) {
923 if (mode->sort == irms_float_number)
924 return mode->arithmetic == irma_ieee754 ? 0 : 1;
929 * Returns non-zero if the mode has a reversed wrap-around
930 * logic, especially (a + x) - x == a.
932 * This is normally true for integer modes, not for floating
935 int mode_wrap_around(const ir_mode *mode) {
936 /* FIXME: better would be an extra mode property */
937 return mode_is_int(mode);
940 void finish_mode(void) {
941 obstack_free(&modes, 0);