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"
53 /** dynamic array to hold all modes */
54 static struct obstack modes;
56 /** number of defined modes */
57 static int num_modes = 0;
59 static ir_mode **mode_list;
66 * Compare modes that don't need to have their code field
69 * TODO: Add other fields
71 INLINE static int modes_are_equal(const ir_mode *m, const ir_mode *n) {
73 if (m->sort == n->sort &&
74 m->arithmetic == n->arithmetic &&
77 m->modulo_shift == n->modulo_shift &&
78 m->vector_elem == n->vector_elem)
85 * searches the modes obstack for the given mode and returns
86 * a pointer on an equal mode already in the array, NULL if
89 static ir_mode *find_mode(const ir_mode *m) {
90 unsigned len = ARR_LEN(mode_list);
93 for(i = 0; i < len; ++i) {
94 ir_mode *n = mode_list[i];
95 if (modes_are_equal(n, m))
103 * sets special values of modes
105 static void set_mode_values(ir_mode* mode) {
106 switch (get_mode_sort(mode)) {
108 case irms_int_number:
109 case irms_float_number:
110 mode->min = get_tarval_min(mode);
111 mode->max = get_tarval_max(mode);
112 mode->null = get_tarval_null(mode);
113 mode->one = get_tarval_one(mode);
114 mode->minus_one = get_tarval_minus_one(mode);
115 if(get_mode_sort(mode) != irms_float_number) {
116 mode->all_one = get_tarval_all_one(mode);
118 mode->all_one = tarval_bad;
122 case irms_internal_boolean:
123 mode->min = tarval_b_false;
124 mode->max = tarval_b_true;
125 mode->null = tarval_b_false;
126 mode->one = tarval_b_true;
127 mode->minus_one = tarval_bad;
128 mode->all_one = tarval_b_true;
133 case irms_control_flow:
134 mode->min = tarval_bad;
135 mode->max = tarval_bad;
136 mode->null = tarval_bad;
137 mode->one = tarval_bad;
138 mode->minus_one = tarval_bad;
144 * globals defined in irmode.h
147 /* --- Predefined modes --- */
149 /* FIRM internal modes: */
157 /* predefined numerical modes: */
158 ir_mode *mode_F; /* float */
159 ir_mode *mode_D; /* double */
160 ir_mode *mode_E; /* long double */
162 ir_mode *mode_Bs; /* integral values, signed and unsigned */
163 ir_mode *mode_Bu; /* 8 bit */
164 ir_mode *mode_Hs; /* 16 bit */
166 ir_mode *mode_Is; /* 32 bit */
168 ir_mode *mode_Ls; /* 64 bit */
170 ir_mode *mode_LLs; /* 128 bit */
176 /* machine specific modes */
177 ir_mode *mode_P_code; /**< machine specific pointer mode for code addresses */
178 ir_mode *mode_P_data; /**< machine specific pointer mode for data addresses */
181 * functions defined in irmode.h
184 /* JNI access functions */
185 ir_mode *get_modeT(void) { return mode_T; }
186 ir_mode *get_modeF(void) { return mode_F; }
187 ir_mode *get_modeD(void) { return mode_D; }
188 ir_mode *get_modeE(void) { return mode_E; }
189 ir_mode *get_modeBs(void) { return mode_Bs; }
190 ir_mode *get_modeBu(void) { return mode_Bu; }
191 ir_mode *get_modeHs(void) { return mode_Hs; }
192 ir_mode *get_modeHu(void) { return mode_Hu; }
193 ir_mode *get_modeIs(void) { return mode_Is; }
194 ir_mode *get_modeIu(void) { return mode_Iu; }
195 ir_mode *get_modeLs(void) { return mode_Ls; }
196 ir_mode *get_modeLu(void) { return mode_Lu; }
197 ir_mode *get_modeLLs(void){ return mode_LLs; }
198 ir_mode *get_modeLLu(void){ return mode_LLu; }
199 ir_mode *get_modeb(void) { return mode_b; }
200 ir_mode *get_modeP(void) { return mode_P; }
201 ir_mode *get_modeX(void) { return mode_X; }
202 ir_mode *get_modeM(void) { return mode_M; }
203 ir_mode *get_modeBB(void) { return mode_BB; }
204 ir_mode *get_modeANY(void) { return mode_ANY; }
205 ir_mode *get_modeBAD(void) { return mode_BAD; }
208 ir_mode *(get_modeP_code)(void) {
209 return _get_modeP_code();
212 ir_mode *(get_modeP_data)(void) {
213 return _get_modeP_data();
216 void set_modeP_code(ir_mode *p) {
217 assert(mode_is_reference(p));
221 void set_modeP_data(ir_mode *p) {
222 assert(mode_is_reference(p));
227 * Registers a new mode.
229 * @param new_mode The new mode template.
231 static ir_mode *register_mode(const ir_mode *new_mode) {
232 ir_mode *mode = NULL;
236 /* copy mode struct to modes array */
237 mode = (ir_mode *)obstack_copy(&modes, new_mode, sizeof(*mode));
238 ARR_APP1(ir_mode*, mode_list, mode);
240 mode->kind = k_ir_mode;
241 if (num_modes >= irm_max) {
242 mode->code = num_modes;
246 /* add the new mode to the irp list of modes */
249 set_mode_values(mode);
251 hook_new_mode(new_mode, mode);
256 * Creates a new mode.
258 ir_mode *new_ir_mode(const char *name, mode_sort sort, int bit_size, int sign,
259 mode_arithmetic arithmetic, unsigned int modulo_shift)
262 ir_mode *mode = NULL;
264 mode_tmpl.name = new_id_from_str(name);
265 mode_tmpl.sort = sort;
266 mode_tmpl.size = bit_size;
267 mode_tmpl.sign = sign ? 1 : 0;
268 mode_tmpl.modulo_shift = (mode_tmpl.sort == irms_int_number) ? modulo_shift : 0;
269 mode_tmpl.vector_elem = 1;
270 mode_tmpl.arithmetic = arithmetic;
271 mode_tmpl.link = NULL;
272 mode_tmpl.tv_priv = NULL;
274 mode = find_mode(&mode_tmpl);
276 hook_new_mode(&mode_tmpl, mode);
283 case irms_control_flow:
285 case irms_internal_boolean:
286 assert(0 && "internal modes cannot be user defined");
289 case irms_float_number:
290 case irms_int_number:
292 mode = register_mode(&mode_tmpl);
298 * Creates a new vector mode.
300 ir_mode *new_ir_vector_mode(const char *name, mode_sort sort, int bit_size, unsigned num_of_elem, int sign,
301 mode_arithmetic arithmetic, unsigned int modulo_shift)
304 ir_mode *mode = NULL;
306 mode_tmpl.name = new_id_from_str(name);
307 mode_tmpl.sort = sort;
308 mode_tmpl.size = bit_size * num_of_elem;
309 mode_tmpl.sign = sign ? 1 : 0;
310 mode_tmpl.modulo_shift = (mode_tmpl.sort == irms_int_number) ? modulo_shift : 0;
311 mode_tmpl.vector_elem = num_of_elem;
312 mode_tmpl.arithmetic = arithmetic;
313 mode_tmpl.link = NULL;
314 mode_tmpl.tv_priv = NULL;
316 mode = find_mode(&mode_tmpl);
318 hook_new_mode(&mode_tmpl, mode);
322 if (num_of_elem <= 1) {
323 assert(0 && "vector modes should have at least 2 elements");
330 case irms_control_flow:
332 case irms_internal_boolean:
333 assert(0 && "internal modes cannot be user defined");
337 assert(0 && "only integer and floating point modes can be vectorized");
340 case irms_float_number:
341 assert(0 && "not yet implemented");
344 case irms_int_number:
345 mode = register_mode(&mode_tmpl);
350 /* Functions for the direct access to all attributes of an ir_mode */
351 modecode (get_mode_modecode)(const ir_mode *mode) {
352 return _get_mode_modecode(mode);
355 ident *(get_mode_ident)(const ir_mode *mode) {
356 return _get_mode_ident(mode);
359 const char *get_mode_name(const ir_mode *mode) {
360 return get_id_str(mode->name);
363 mode_sort (get_mode_sort)(const ir_mode* mode) {
364 return _get_mode_sort(mode);
367 unsigned (get_mode_size_bits)(const ir_mode *mode) {
368 return _get_mode_size_bits(mode);
371 unsigned (get_mode_size_bytes)(const ir_mode *mode) {
372 return _get_mode_size_bytes(mode);
375 int (get_mode_sign)(const ir_mode *mode) {
376 return _get_mode_sign(mode);
379 mode_arithmetic (get_mode_arithmetic)(const ir_mode *mode) {
380 return get_mode_arithmetic(mode);
384 /* Attribute modulo shift specifies for modes of kind irms_int_number
385 * whether shift applies modulo to value of bits to shift. Asserts
386 * if mode is not irms_int_number.
388 unsigned int (get_mode_modulo_shift)(const ir_mode *mode) {
389 return _get_mode_modulo_shift(mode);
392 unsigned int (get_mode_n_vector_elems)(const ir_mode *mode) {
393 return _get_mode_vector_elems(mode);
396 void *(get_mode_link)(const ir_mode *mode) {
397 return _get_mode_link(mode);
400 void (set_mode_link)(ir_mode *mode, void *l) {
401 _set_mode_link(mode, l);
404 tarval *get_mode_min(ir_mode *mode) {
406 assert(get_mode_modecode(mode) < (modecode) num_modes);
407 assert(mode_is_data(mode));
412 tarval *get_mode_max(ir_mode *mode) {
414 assert(get_mode_modecode(mode) < (modecode) num_modes);
415 assert(mode_is_data(mode));
420 tarval *get_mode_null(ir_mode *mode) {
422 assert(get_mode_modecode(mode) < (modecode) num_modes);
423 assert(mode_is_datab(mode));
428 tarval *get_mode_one(ir_mode *mode) {
430 assert(get_mode_modecode(mode) < (modecode) num_modes);
431 assert(mode_is_datab(mode));
436 tarval *get_mode_minus_one(ir_mode *mode) {
438 assert(get_mode_modecode(mode) < (modecode) num_modes);
439 assert(mode_is_data(mode));
441 return mode->minus_one;
444 tarval *get_mode_all_one(ir_mode *mode) {
446 assert(get_mode_modecode(mode) < (modecode) num_modes);
447 assert(mode_is_datab(mode));
448 return mode->all_one;
451 tarval *get_mode_infinite(ir_mode *mode) {
453 assert(get_mode_modecode(mode) < (modecode) num_modes);
454 assert(mode_is_float(mode));
456 return get_tarval_plus_inf(mode);
459 tarval *get_mode_NAN(ir_mode *mode) {
461 assert(get_mode_modecode(mode) < (modecode) num_modes);
462 assert(mode_is_float(mode));
464 return get_tarval_nan(mode);
467 int is_mode(void *thing) {
468 if (get_kind(thing) == k_ir_mode)
474 int (mode_is_signed)(const ir_mode *mode) {
475 return _mode_is_signed(mode);
478 int (mode_is_float)(const ir_mode *mode) {
479 return _mode_is_float(mode);
482 int (mode_is_int)(const ir_mode *mode) {
483 return _mode_is_int(mode);
486 int (mode_is_reference)(const ir_mode *mode) {
487 return _mode_is_reference(mode);
490 int (mode_is_num)(const ir_mode *mode) {
491 return _mode_is_num(mode);
494 int (mode_is_data)(const ir_mode *mode) {
495 return _mode_is_data(mode);
498 int (mode_is_datab)(const ir_mode *mode) {
499 return _mode_is_datab(mode);
502 int (mode_is_dataM)(const ir_mode *mode) {
503 return _mode_is_dataM(mode);
506 int (mode_is_float_vector)(const ir_mode *mode) {
507 return _mode_is_float_vector(mode);
510 int (mode_is_int_vector)(const ir_mode *mode) {
511 return _mode_is_int_vector(mode);
514 /* Returns true if sm can be converted to lm without loss. */
515 int smaller_mode(const ir_mode *sm, const ir_mode *lm) {
516 int sm_bits, lm_bits;
521 if (sm == lm) return 1;
523 sm_bits = get_mode_size_bits(sm);
524 lm_bits = get_mode_size_bits(lm);
526 switch (get_mode_sort(sm)) {
527 case irms_int_number:
528 switch (get_mode_sort(lm)) {
529 case irms_int_number:
530 if(get_mode_arithmetic(sm) != get_mode_arithmetic(lm))
533 /* only two complement implemented */
534 assert(get_mode_arithmetic(sm)==irma_twos_complement);
536 /* integers are convertable if
537 * - both have the same sign and lm is the larger one
538 * - lm is the signed one and is at least two bits larger
539 * (one for the sign, one for the highest bit of sm)
540 * - sm & lm are two_complement and lm has greater or equal number of bits
542 if(mode_is_signed(sm)) {
543 if(!mode_is_signed(lm))
545 return sm_bits <= lm_bits;
547 if(mode_is_signed(lm)) {
548 return sm_bits < lm_bits;
550 return sm_bits <= lm_bits;
554 case irms_float_number:
555 /* int to float works if the float is large enough */
563 case irms_float_number:
564 if (get_mode_arithmetic(sm) == get_mode_arithmetic(lm)) {
565 if ( (get_mode_sort(lm) == irms_float_number)
566 && (get_mode_size_bits(lm) >= get_mode_size_bits(sm)) )
572 /* do exist machines out there with different pointer lenghts ?*/
575 case irms_internal_boolean:
576 return mode_is_int(lm);
586 /* Return the signed integer equivalent mode for an reference mode. */
587 ir_mode *get_reference_mode_signed_eq(ir_mode *mode) {
588 assert(mode_is_reference(mode));
589 return mode->eq_signed;
592 /* Sets the signed integer equivalent mode for an reference mode. */
593 void set_reference_mode_signed_eq(ir_mode *ref_mode, ir_mode *int_mode) {
594 assert(mode_is_reference(ref_mode));
595 assert(mode_is_int(int_mode));
596 ref_mode->eq_signed = int_mode;
599 /* Return the unsigned integer equivalent mode for an reference mode. */
600 ir_mode *get_reference_mode_unsigned_eq(ir_mode *mode) {
601 assert(mode_is_reference(mode));
602 return mode->eq_unsigned;
605 /* Sets the unsigned integer equivalent mode for an reference mode. */
606 void set_reference_mode_unsigned_eq(ir_mode *ref_mode, ir_mode *int_mode) {
607 assert(mode_is_reference(ref_mode));
608 assert(mode_is_int(int_mode));
609 ref_mode->eq_unsigned = int_mode;
612 /* initialization, build the default modes */
613 void init_mode(void) {
616 obstack_init(&modes);
617 mode_list = NEW_ARR_F(ir_mode*, 0);
620 /* initialize predefined modes */
623 newmode.arithmetic = irma_none;
626 newmode.modulo_shift = 0;
627 newmode.vector_elem = 0;
628 newmode.eq_signed = NULL;
629 newmode.eq_unsigned = NULL;
631 newmode.tv_priv = NULL;
633 /* Control Flow Modes*/
634 newmode.sort = irms_control_flow;
637 newmode.name = new_id_from_chars("BB", 2);
638 newmode.code = irm_BB;
640 mode_BB = register_mode(&newmode);
643 newmode.name = new_id_from_chars("X", 1);
644 newmode.code = irm_X;
646 mode_X = register_mode(&newmode);
649 newmode.sort = irms_memory;
652 newmode.name = new_id_from_chars("M", 1);
653 newmode.code = irm_M;
655 mode_M = register_mode(&newmode);
657 /* Auxiliary Modes */
658 newmode.sort = irms_auxiliary,
661 newmode.name = new_id_from_chars("T", 1);
662 newmode.code = irm_T;
664 mode_T = register_mode(&newmode);
667 newmode.name = new_id_from_chars("ANY", 3);
668 newmode.code = irm_ANY;
670 mode_ANY = register_mode(&newmode);
673 newmode.name = new_id_from_chars("BAD", 3);
674 newmode.code = irm_BAD;
676 mode_BAD = register_mode(&newmode);
678 /* Internal Boolean Modes */
679 newmode.sort = irms_internal_boolean;
682 newmode.name = new_id_from_chars("b", 1);
683 newmode.code = irm_b;
685 mode_b = register_mode(&newmode);
688 newmode.vector_elem = 1;
690 /* Float Number Modes */
691 newmode.sort = irms_float_number;
692 newmode.arithmetic = irma_ieee754;
695 newmode.name = new_id_from_chars("F", 1);
696 newmode.code = irm_F;
700 mode_F = register_mode(&newmode);
703 newmode.name = new_id_from_chars("D", 1);
704 newmode.code = irm_D;
708 mode_D = register_mode(&newmode);
711 newmode.name = new_id_from_chars("E", 1);
712 newmode.code = irm_E;
716 mode_E = register_mode(&newmode);
718 /* Integer Number Modes */
719 newmode.sort = irms_int_number;
720 newmode.arithmetic = irma_twos_complement;
723 newmode.name = new_id_from_chars("Bs", 2);
724 newmode.code = irm_Bs;
727 newmode.modulo_shift = 32;
729 mode_Bs = register_mode(&newmode);
732 newmode.name = new_id_from_chars("Bu", 2);
733 newmode.code = irm_Bu;
734 newmode.arithmetic = irma_twos_complement;
737 newmode.modulo_shift = 32;
739 mode_Bu = register_mode(&newmode);
741 /* signed short integer */
742 newmode.name = new_id_from_chars("Hs", 2);
743 newmode.code = irm_Hs;
746 newmode.modulo_shift = 32;
748 mode_Hs = register_mode(&newmode);
750 /* unsigned short integer */
751 newmode.name = new_id_from_chars("Hu", 2);
752 newmode.code = irm_Hu;
755 newmode.modulo_shift = 32;
757 mode_Hu = register_mode(&newmode);
760 newmode.name = new_id_from_chars("Is", 2);
761 newmode.code = irm_Is;
764 newmode.modulo_shift = 32;
766 mode_Is = register_mode(&newmode);
768 /* unsigned integer */
769 newmode.name = new_id_from_chars("Iu", 2);
770 newmode.code = irm_Iu;
773 newmode.modulo_shift = 32;
775 mode_Iu = register_mode(&newmode);
777 /* signed long integer */
778 newmode.name = new_id_from_chars("Ls", 2);
779 newmode.code = irm_Ls;
782 newmode.modulo_shift = 64;
784 mode_Ls = register_mode(&newmode);
786 /* unsigned long integer */
787 newmode.name = new_id_from_chars("Lu", 2);
788 newmode.code = irm_Lu;
791 newmode.modulo_shift = 64;
793 mode_Lu = register_mode(&newmode);
795 /* signed long long integer */
796 newmode.name = new_id_from_chars("LLs", 3);
797 newmode.code = irm_LLs;
800 newmode.modulo_shift = 128;
802 mode_LLs = register_mode(&newmode);
804 /* unsigned long long integer */
805 newmode.name = new_id_from_chars("LLu", 3);
806 newmode.code = irm_LLu;
809 newmode.modulo_shift = 128;
811 mode_LLu = register_mode(&newmode);
814 newmode.sort = irms_reference;
815 newmode.arithmetic = irma_twos_complement;
818 newmode.name = new_id_from_chars("P", 1);
819 newmode.code = irm_P;
822 newmode.modulo_shift = 0;
823 newmode.eq_signed = mode_Is;
824 newmode.eq_unsigned = mode_Iu;
826 mode_P = register_mode(&newmode);
828 /* set the machine specific modes to the predefined ones */
829 mode_P_code = mode_P;
830 mode_P_data = mode_P;
833 /* find a signed mode for an unsigned integer mode */
834 ir_mode *find_unsigned_mode(const ir_mode *mode) {
837 assert(mode->sort == irms_int_number);
839 return find_mode(&n);
842 /* find an unsigned mode for a signed integer mode */
843 ir_mode *find_signed_mode(const ir_mode *mode) {
846 assert(mode->sort == irms_int_number);
848 return find_mode(&n);
851 /* finds a integer mode with 2*n bits for an integer mode with n bits. */
852 ir_mode *find_double_bits_int_mode(const ir_mode *mode) {
855 assert(mode->sort == irms_int_number && mode->arithmetic == irma_twos_complement);
857 n.size = 2*mode->size;
858 return find_mode(&n);
862 * Returns non-zero if the given mode honors signed zero's, i.e.,
863 * a +0 and a -0 exists and handled differently.
865 int mode_honor_signed_zeros(const ir_mode *mode) {
866 /* for floating point, we know that IEEE 754 has +0 and -0,
867 * but always handles it identical.
870 mode->sort == irms_float_number &&
871 mode->arithmetic != irma_ieee754;
875 * Returns non-zero if the given mode might overflow on unary Minus.
877 * This does NOT happen on IEEE 754.
879 int mode_overflow_on_unary_Minus(const ir_mode *mode) {
880 if (mode->sort == irms_float_number)
881 return mode->arithmetic == irma_ieee754 ? 0 : 1;
886 * Returns non-zero if the mode has a reversed wrap-around
887 * logic, especially (a + x) - x == a.
889 * This is normally true for integer modes, not for floating
892 int mode_wrap_around(const ir_mode *mode) {
893 /* FIXME: better would be an extra mode property */
894 return mode_is_int(mode);
897 void finish_mode(void) {
898 obstack_free(&modes, 0);
899 DEL_ARR_F(mode_list);