2 * Copyright (C) 1995-2008 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 */
56 static int num_modes = 0;
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)) {
136 case irms_int_number:
137 case irms_float_number:
138 mode->min = get_tarval_min(mode);
139 mode->max = get_tarval_max(mode);
140 mode->null = get_tarval_null(mode);
141 mode->one = get_tarval_one(mode);
142 mode->minus_one = get_tarval_minus_one(mode);
143 if(get_mode_sort(mode) != irms_float_number) {
144 mode->all_one = get_tarval_all_one(mode);
146 mode->all_one = tarval_bad;
150 case irms_internal_boolean:
151 mode->min = tarval_b_false;
152 mode->max = tarval_b_true;
153 mode->null = tarval_b_false;
154 mode->one = tarval_b_true;
155 mode->minus_one = tarval_bad;
156 mode->all_one = tarval_b_true;
161 case irms_control_flow:
162 mode->min = tarval_bad;
163 mode->max = tarval_bad;
164 mode->null = tarval_bad;
165 mode->one = tarval_bad;
166 mode->minus_one = tarval_bad;
172 * globals defined in irmode.h
175 /* --- Predefined modes --- */
177 /* FIRM internal modes: */
185 /* predefined numerical modes: */
186 ir_mode *mode_F; /* float */
187 ir_mode *mode_D; /* double */
188 ir_mode *mode_E; /* long double */
190 ir_mode *mode_Bs; /* integral values, signed and unsigned */
191 ir_mode *mode_Bu; /* 8 bit */
192 ir_mode *mode_Hs; /* 16 bit */
194 ir_mode *mode_Is; /* 32 bit */
196 ir_mode *mode_Ls; /* 64 bit */
198 ir_mode *mode_LLs; /* 128 bit */
204 /* machine specific modes */
205 ir_mode *mode_P_code; /**< machine specific pointer mode for code addresses */
206 ir_mode *mode_P_data; /**< machine specific pointer mode for data addresses */
209 * functions defined in irmode.h
212 /* JNI access functions */
213 ir_mode *get_modeT(void) { return mode_T; }
214 ir_mode *get_modeF(void) { return mode_F; }
215 ir_mode *get_modeD(void) { return mode_D; }
216 ir_mode *get_modeE(void) { return mode_E; }
217 ir_mode *get_modeBs(void) { return mode_Bs; }
218 ir_mode *get_modeBu(void) { return mode_Bu; }
219 ir_mode *get_modeHs(void) { return mode_Hs; }
220 ir_mode *get_modeHu(void) { return mode_Hu; }
221 ir_mode *get_modeIs(void) { return mode_Is; }
222 ir_mode *get_modeIu(void) { return mode_Iu; }
223 ir_mode *get_modeLs(void) { return mode_Ls; }
224 ir_mode *get_modeLu(void) { return mode_Lu; }
225 ir_mode *get_modeLLs(void){ return mode_LLs; }
226 ir_mode *get_modeLLu(void){ return mode_LLu; }
227 ir_mode *get_modeb(void) { return mode_b; }
228 ir_mode *get_modeP(void) { return mode_P; }
229 ir_mode *get_modeX(void) { return mode_X; }
230 ir_mode *get_modeM(void) { return mode_M; }
231 ir_mode *get_modeBB(void) { return mode_BB; }
232 ir_mode *get_modeANY(void) { return mode_ANY; }
233 ir_mode *get_modeBAD(void) { return mode_BAD; }
236 ir_mode *(get_modeP_code)(void) {
237 return _get_modeP_code();
240 ir_mode *(get_modeP_data)(void) {
241 return _get_modeP_data();
244 void set_modeP_code(ir_mode *p) {
245 assert(mode_is_reference(p));
249 void set_modeP_data(ir_mode *p) {
250 assert(mode_is_reference(p));
255 * Registers a new mode.
257 * @param new_mode The new mode template.
259 static ir_mode *register_mode(const ir_mode *new_mode) {
260 ir_mode *mode = NULL;
264 /* copy mode struct to modes array */
265 mode = (ir_mode *)obstack_copy(&modes, new_mode, sizeof(*mode));
267 mode->kind = k_ir_mode;
268 if (num_modes >= irm_max) {
269 mode->code = num_modes;
273 /* add the new mode to the irp list of modes */
276 set_mode_values(mode);
278 hook_new_mode(new_mode, mode);
283 * Creates a new mode.
285 ir_mode *new_ir_mode(const char *name, mode_sort sort, int bit_size, int sign,
286 mode_arithmetic arithmetic, unsigned int modulo_shift)
289 ir_mode *mode = NULL;
291 mode_tmpl.name = new_id_from_str(name);
292 mode_tmpl.sort = sort;
293 mode_tmpl.size = bit_size;
294 mode_tmpl.sign = sign ? 1 : 0;
295 mode_tmpl.modulo_shift = (mode_tmpl.sort == irms_int_number) ? modulo_shift : 0;
296 mode_tmpl.vector_elem = 1;
297 mode_tmpl.arithmetic = arithmetic;
298 mode_tmpl.link = NULL;
299 mode_tmpl.tv_priv = NULL;
301 mode = find_mode(&mode_tmpl);
303 hook_new_mode(&mode_tmpl, mode);
310 case irms_control_flow:
312 case irms_internal_boolean:
313 assert(0 && "internal modes cannot be user defined");
316 case irms_float_number:
317 case irms_int_number:
319 mode = register_mode(&mode_tmpl);
325 * Creates a new vector mode.
327 ir_mode *new_ir_vector_mode(const char *name, mode_sort sort, int bit_size, unsigned num_of_elem, int sign,
328 mode_arithmetic arithmetic, unsigned int modulo_shift)
331 ir_mode *mode = NULL;
333 mode_tmpl.name = new_id_from_str(name);
334 mode_tmpl.sort = sort;
335 mode_tmpl.size = bit_size * num_of_elem;
336 mode_tmpl.sign = sign ? 1 : 0;
337 mode_tmpl.modulo_shift = (mode_tmpl.sort == irms_int_number) ? modulo_shift : 0;
338 mode_tmpl.vector_elem = num_of_elem;
339 mode_tmpl.arithmetic = arithmetic;
340 mode_tmpl.link = NULL;
341 mode_tmpl.tv_priv = NULL;
343 mode = find_mode(&mode_tmpl);
345 hook_new_mode(&mode_tmpl, mode);
349 if (num_of_elem <= 1) {
350 assert(0 && "vector modes should have at least 2 elements");
357 case irms_control_flow:
359 case irms_internal_boolean:
360 assert(0 && "internal modes cannot be user defined");
364 assert(0 && "only integer and floating point modes can be vectorized");
367 case irms_float_number:
368 assert(0 && "not yet implemented");
371 case irms_int_number:
372 mode = register_mode(&mode_tmpl);
377 /* Functions for the direct access to all attributes of an ir_mode */
378 modecode (get_mode_modecode)(const ir_mode *mode) {
379 return _get_mode_modecode(mode);
382 ident *(get_mode_ident)(const ir_mode *mode) {
383 return _get_mode_ident(mode);
386 const char *get_mode_name(const ir_mode *mode) {
387 return get_id_str(mode->name);
390 mode_sort (get_mode_sort)(const ir_mode* mode) {
391 return _get_mode_sort(mode);
394 unsigned (get_mode_size_bits)(const ir_mode *mode) {
395 return _get_mode_size_bits(mode);
398 unsigned (get_mode_size_bytes)(const ir_mode *mode) {
399 return _get_mode_size_bytes(mode);
402 int (get_mode_sign)(const ir_mode *mode) {
403 return _get_mode_sign(mode);
406 mode_arithmetic (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.
415 unsigned int (get_mode_modulo_shift)(const ir_mode *mode) {
416 return _get_mode_modulo_shift(mode);
419 unsigned int (get_mode_n_vector_elems)(const ir_mode *mode) {
420 return _get_mode_vector_elems(mode);
423 void *(get_mode_link)(const ir_mode *mode) {
424 return _get_mode_link(mode);
427 void (set_mode_link)(ir_mode *mode, void *l) {
428 _set_mode_link(mode, l);
431 tarval *get_mode_min(ir_mode *mode) {
433 assert(get_mode_modecode(mode) < (modecode) num_modes);
434 assert(mode_is_data(mode));
439 tarval *get_mode_max(ir_mode *mode) {
441 assert(get_mode_modecode(mode) < (modecode) num_modes);
442 assert(mode_is_data(mode));
447 tarval *get_mode_null(ir_mode *mode) {
449 assert(get_mode_modecode(mode) < (modecode) num_modes);
450 assert(mode_is_datab(mode));
455 tarval *get_mode_one(ir_mode *mode) {
457 assert(get_mode_modecode(mode) < (modecode) num_modes);
458 assert(mode_is_datab(mode));
463 tarval *get_mode_minus_one(ir_mode *mode) {
465 assert(get_mode_modecode(mode) < (modecode) num_modes);
466 assert(mode_is_data(mode));
468 return mode->minus_one;
471 tarval *get_mode_all_one(ir_mode *mode) {
473 assert(get_mode_modecode(mode) < (modecode) num_modes);
474 assert(mode_is_datab(mode));
475 return mode->all_one;
478 tarval *get_mode_infinite(ir_mode *mode) {
480 assert(get_mode_modecode(mode) < (modecode) num_modes);
481 assert(mode_is_float(mode));
483 return get_tarval_plus_inf(mode);
486 tarval *get_mode_NAN(ir_mode *mode) {
488 assert(get_mode_modecode(mode) < (modecode) num_modes);
489 assert(mode_is_float(mode));
491 return get_tarval_nan(mode);
494 int is_mode(void *thing) {
495 if (get_kind(thing) == k_ir_mode)
501 int (mode_is_signed)(const ir_mode *mode) {
502 return _mode_is_signed(mode);
505 int (mode_is_float)(const ir_mode *mode) {
506 return _mode_is_float(mode);
509 int (mode_is_int)(const ir_mode *mode) {
510 return _mode_is_int(mode);
513 int (mode_is_reference)(const ir_mode *mode) {
514 return _mode_is_reference(mode);
517 int (mode_is_num)(const ir_mode *mode) {
518 return _mode_is_num(mode);
521 int (mode_is_data)(const ir_mode *mode) {
522 return _mode_is_data(mode);
525 int (mode_is_datab)(const ir_mode *mode) {
526 return _mode_is_datab(mode);
529 int (mode_is_dataM)(const ir_mode *mode) {
530 return _mode_is_dataM(mode);
533 int (mode_is_float_vector)(const ir_mode *mode) {
534 return _mode_is_float_vector(mode);
537 int (mode_is_int_vector)(const ir_mode *mode) {
538 return _mode_is_int_vector(mode);
541 /* Returns true if sm can be converted to lm without loss. */
542 int smaller_mode(const ir_mode *sm, const ir_mode *lm) {
543 int sm_bits, lm_bits;
548 if (sm == lm) return 1;
550 sm_bits = get_mode_size_bits(sm);
551 lm_bits = get_mode_size_bits(lm);
553 switch (get_mode_sort(sm)) {
554 case irms_int_number:
555 switch (get_mode_sort(lm)) {
556 case irms_int_number:
557 if(get_mode_arithmetic(sm) != get_mode_arithmetic(lm))
560 /* only two complement implemented */
561 assert(get_mode_arithmetic(sm)==irma_twos_complement);
563 /* integers are convertable if
564 * - both have the same sign and lm is the larger one
565 * - lm is the signed one and is at least two bits larger
566 * (one for the sign, one for the highest bit of sm)
567 * - sm & lm are two_complement and lm has greater or equal number of bits
569 if(mode_is_signed(sm)) {
570 if(!mode_is_signed(lm))
572 return sm_bits <= lm_bits;
574 if(mode_is_signed(lm)) {
575 return sm_bits < lm_bits;
577 return sm_bits <= lm_bits;
581 case irms_float_number:
582 /* int to float works if the float is large enough */
590 case irms_float_number:
591 if (get_mode_arithmetic(sm) == get_mode_arithmetic(lm)) {
592 if ( (get_mode_sort(lm) == irms_float_number)
593 && (get_mode_size_bits(lm) >= get_mode_size_bits(sm)) )
599 /* do exist machines out there with different pointer lenghts ?*/
602 case irms_internal_boolean:
603 return mode_is_int(lm);
613 /* Return the signed integer equivalent mode for an reference mode. */
614 ir_mode *get_reference_mode_signed_eq(ir_mode *mode) {
615 assert(mode_is_reference(mode));
616 return mode->eq_signed;
619 /* Sets the signed integer equivalent mode for an reference mode. */
620 void set_reference_mode_signed_eq(ir_mode *ref_mode, ir_mode *int_mode) {
621 assert(mode_is_reference(ref_mode));
622 assert(mode_is_int(int_mode));
623 ref_mode->eq_signed = int_mode;
626 /* Return the unsigned integer equivalent mode for an reference mode. */
627 ir_mode *get_reference_mode_unsigned_eq(ir_mode *mode) {
628 assert(mode_is_reference(mode));
629 return mode->eq_unsigned;
632 /* Sets the unsigned integer equivalent mode for an reference mode. */
633 void set_reference_mode_unsigned_eq(ir_mode *ref_mode, ir_mode *int_mode) {
634 assert(mode_is_reference(ref_mode));
635 assert(mode_is_int(int_mode));
636 ref_mode->eq_unsigned = int_mode;
639 /* initialization, build the default modes */
640 void init_mode(void) {
643 obstack_init(&modes);
646 /* initialize predefined modes */
649 newmode.arithmetic = irma_none;
652 newmode.modulo_shift = 0;
653 newmode.vector_elem = 0;
654 newmode.eq_signed = NULL;
655 newmode.eq_unsigned = NULL;
657 newmode.tv_priv = NULL;
659 /* Control Flow Modes*/
660 newmode.sort = irms_control_flow;
663 newmode.name = new_id_from_chars("BB", 2);
664 newmode.code = irm_BB;
666 mode_BB = register_mode(&newmode);
669 newmode.name = new_id_from_chars("X", 1);
670 newmode.code = irm_X;
672 mode_X = register_mode(&newmode);
675 newmode.sort = irms_memory;
678 newmode.name = new_id_from_chars("M", 1);
679 newmode.code = irm_M;
681 mode_M = register_mode(&newmode);
683 /* Auxiliary Modes */
684 newmode.sort = irms_auxiliary,
687 newmode.name = new_id_from_chars("T", 1);
688 newmode.code = irm_T;
690 mode_T = register_mode(&newmode);
693 newmode.name = new_id_from_chars("ANY", 3);
694 newmode.code = irm_ANY;
696 mode_ANY = register_mode(&newmode);
699 newmode.name = new_id_from_chars("BAD", 3);
700 newmode.code = irm_BAD;
702 mode_BAD = register_mode(&newmode);
704 /* Internal Boolean Modes */
705 newmode.sort = irms_internal_boolean;
708 newmode.name = new_id_from_chars("b", 1);
709 newmode.code = irm_b;
711 mode_b = register_mode(&newmode);
714 newmode.vector_elem = 1;
716 /* Float Number Modes */
717 newmode.sort = irms_float_number;
718 newmode.arithmetic = irma_ieee754;
721 newmode.name = new_id_from_chars("F", 1);
722 newmode.code = irm_F;
726 mode_F = register_mode(&newmode);
729 newmode.name = new_id_from_chars("D", 1);
730 newmode.code = irm_D;
734 mode_D = register_mode(&newmode);
737 newmode.name = new_id_from_chars("E", 1);
738 newmode.code = irm_E;
742 mode_E = register_mode(&newmode);
744 /* Integer Number Modes */
745 newmode.sort = irms_int_number;
746 newmode.arithmetic = irma_twos_complement;
749 newmode.name = new_id_from_chars("Bs", 2);
750 newmode.code = irm_Bs;
753 newmode.modulo_shift = 32;
755 mode_Bs = register_mode(&newmode);
758 newmode.name = new_id_from_chars("Bu", 2);
759 newmode.code = irm_Bu;
760 newmode.arithmetic = irma_twos_complement;
763 newmode.modulo_shift = 32;
765 mode_Bu = register_mode(&newmode);
767 /* signed short integer */
768 newmode.name = new_id_from_chars("Hs", 2);
769 newmode.code = irm_Hs;
772 newmode.modulo_shift = 32;
774 mode_Hs = register_mode(&newmode);
776 /* unsigned short integer */
777 newmode.name = new_id_from_chars("Hu", 2);
778 newmode.code = irm_Hu;
781 newmode.modulo_shift = 32;
783 mode_Hu = register_mode(&newmode);
786 newmode.name = new_id_from_chars("Is", 2);
787 newmode.code = irm_Is;
790 newmode.modulo_shift = 32;
792 mode_Is = register_mode(&newmode);
794 /* unsigned integer */
795 newmode.name = new_id_from_chars("Iu", 2);
796 newmode.code = irm_Iu;
799 newmode.modulo_shift = 32;
801 mode_Iu = register_mode(&newmode);
803 /* signed long integer */
804 newmode.name = new_id_from_chars("Ls", 2);
805 newmode.code = irm_Ls;
808 newmode.modulo_shift = 64;
810 mode_Ls = register_mode(&newmode);
812 /* unsigned long integer */
813 newmode.name = new_id_from_chars("Lu", 2);
814 newmode.code = irm_Lu;
817 newmode.modulo_shift = 64;
819 mode_Lu = register_mode(&newmode);
821 /* signed long long integer */
822 newmode.name = new_id_from_chars("LLs", 3);
823 newmode.code = irm_LLs;
826 newmode.modulo_shift = 128;
828 mode_LLs = register_mode(&newmode);
830 /* unsigned long long integer */
831 newmode.name = new_id_from_chars("LLu", 3);
832 newmode.code = irm_LLu;
835 newmode.modulo_shift = 128;
837 mode_LLu = register_mode(&newmode);
840 newmode.sort = irms_reference;
841 newmode.arithmetic = irma_twos_complement;
844 newmode.name = new_id_from_chars("P", 1);
845 newmode.code = irm_P;
848 newmode.modulo_shift = 0;
849 newmode.eq_signed = mode_Is;
850 newmode.eq_unsigned = mode_Iu;
852 mode_P = register_mode(&newmode);
854 /* set the machine specific modes to the predefined ones */
855 mode_P_code = mode_P;
856 mode_P_data = mode_P;
859 /* find a signed mode for an unsigned integer mode */
860 ir_mode *find_unsigned_mode(const ir_mode *mode) {
863 assert(mode->sort == irms_int_number);
865 return find_mode(&n);
868 /* find an unsigned mode for a signed integer mode */
869 ir_mode *find_signed_mode(const ir_mode *mode) {
872 assert(mode->sort == irms_int_number);
874 return find_mode(&n);
877 /* finds a integer mode with 2*n bits for an integer mode with n bits. */
878 ir_mode *find_double_bits_int_mode(const ir_mode *mode) {
881 assert(mode->sort == irms_int_number && mode->arithmetic == irma_twos_complement);
883 n.size = 2*mode->size;
884 return find_mode(&n);
888 * Returns non-zero if the given mode honors signed zero's, i.e.,
889 * a +0 and a -0 exists and handled differently.
891 int mode_honor_signed_zeros(const ir_mode *mode) {
892 /* for floating point, we know that IEEE 754 has +0 and -0,
893 * but always handles it identical.
896 mode->sort == irms_float_number &&
897 mode->arithmetic != irma_ieee754;
901 * Returns non-zero if the given mode might overflow on unary Minus.
903 * This does NOT happen on IEEE 754.
905 int mode_overflow_on_unary_Minus(const ir_mode *mode) {
906 if (mode->sort == irms_float_number)
907 return mode->arithmetic == irma_ieee754 ? 0 : 1;
912 * Returns non-zero if the mode has a reversed wrap-around
913 * logic, especially (a + x) - x == a.
915 * This is normally true for integer modes, not for floating
918 int mode_wrap_around(const ir_mode *mode) {
919 /* FIXME: better would be an extra mode property */
920 return mode_is_int(mode);
923 void finish_mode(void) {
924 obstack_free(&modes, 0);