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 */
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 */
379 (get_mode_modecode)(const ir_mode *mode) {
380 return _get_mode_modecode(mode);
384 (get_mode_ident)(const ir_mode *mode) {
385 return _get_mode_ident(mode);
389 get_mode_name(const ir_mode *mode) {
390 return get_id_str(mode->name);
394 (get_mode_sort)(const ir_mode* mode) {
395 return _get_mode_sort(mode);
399 (get_mode_size_bits)(const ir_mode *mode) {
400 return _get_mode_size_bits(mode);
404 (get_mode_size_bytes)(const ir_mode *mode) {
405 return _get_mode_size_bytes(mode);
409 (get_mode_sign)(const ir_mode *mode) {
410 return _get_mode_sign(mode);
414 (get_mode_arithmetic)(const ir_mode *mode) {
415 return get_mode_arithmetic(mode);
419 /* Attribute modulo shift specifies for modes of kind irms_int_number
420 * whether shift applies modulo to value of bits to shift. Asserts
421 * if mode is not irms_int_number.
424 (get_mode_modulo_shift)(const ir_mode *mode) {
425 return _get_mode_modulo_shift(mode);
429 (get_mode_n_vector_elems)(const ir_mode *mode) {
430 return _get_mode_vector_elems(mode);
434 (get_mode_link)(const ir_mode *mode) {
435 return _get_mode_link(mode);
439 (set_mode_link)(ir_mode *mode, void *l) {
440 _set_mode_link(mode, l);
444 get_mode_min(ir_mode *mode) {
446 assert(get_mode_modecode(mode) < (modecode) num_modes);
447 assert(mode_is_data(mode));
453 get_mode_max(ir_mode *mode) {
455 assert(get_mode_modecode(mode) < (modecode) num_modes);
456 assert(mode_is_data(mode));
462 get_mode_null(ir_mode *mode) {
464 assert(get_mode_modecode(mode) < (modecode) num_modes);
465 assert(mode_is_datab(mode));
471 get_mode_one(ir_mode *mode) {
473 assert(get_mode_modecode(mode) < (modecode) num_modes);
474 assert(mode_is_data(mode));
480 get_mode_minus_one(ir_mode *mode) {
482 assert(get_mode_modecode(mode) < (modecode) num_modes);
483 assert(mode_is_data(mode));
485 return mode->minus_one;
489 get_mode_all_one(ir_mode *mode) {
491 assert(get_mode_modecode(mode) < (modecode) num_modes);
492 assert(mode_is_data(mode) || mode == mode_b);
493 return mode->all_one;
497 get_mode_infinite(ir_mode *mode) {
499 assert(get_mode_modecode(mode) < (modecode) num_modes);
500 assert(mode_is_float(mode));
502 return get_tarval_plus_inf(mode);
506 get_mode_NAN(ir_mode *mode) {
508 assert(get_mode_modecode(mode) < (modecode) num_modes);
509 assert(mode_is_float(mode));
511 return get_tarval_nan(mode);
515 is_mode(void *thing) {
516 if (get_kind(thing) == k_ir_mode)
523 (mode_is_signed)(const ir_mode *mode) {
524 return _mode_is_signed(mode);
528 (mode_is_float)(const ir_mode *mode) {
529 return _mode_is_float(mode);
533 (mode_is_int)(const ir_mode *mode) {
534 return _mode_is_int(mode);
538 (mode_is_reference)(const ir_mode *mode) {
539 return _mode_is_reference(mode);
543 (mode_is_num)(const ir_mode *mode) {
544 return _mode_is_num(mode);
548 (mode_is_data)(const ir_mode *mode) {
549 return _mode_is_data(mode);
553 (mode_is_datab)(const ir_mode *mode) {
554 return _mode_is_datab(mode);
558 (mode_is_dataM)(const ir_mode *mode) {
559 return _mode_is_dataM(mode);
563 (mode_is_float_vector)(const ir_mode *mode) {
564 return _mode_is_float_vector(mode);
568 (mode_is_int_vector)(const ir_mode *mode) {
569 return _mode_is_int_vector(mode);
572 /* Returns true if sm can be converted to lm without loss. */
574 smaller_mode(const ir_mode *sm, const ir_mode *lm) {
575 int sm_bits, lm_bits;
580 if (sm == lm) return 1;
582 sm_bits = get_mode_size_bits(sm);
583 lm_bits = get_mode_size_bits(lm);
585 switch (get_mode_sort(sm)) {
586 case irms_int_number:
587 switch (get_mode_sort(lm)) {
588 case irms_int_number:
589 if(get_mode_arithmetic(sm) != get_mode_arithmetic(lm))
592 /* only two complement implemented */
593 assert(get_mode_arithmetic(sm)==irma_twos_complement);
595 /* integers are convertable if
596 * - both have the same sign and lm is the larger one
597 * - lm is the signed one and is at least two bits larger
598 * (one for the sign, one for the highest bit of sm)
599 * - sm & lm are two_complement and lm has greater or equal number of bits
601 if(mode_is_signed(sm)) {
602 if(!mode_is_signed(lm))
604 return sm_bits <= lm_bits;
606 if(mode_is_signed(lm)) {
607 return sm_bits < lm_bits;
609 return sm_bits <= lm_bits;
613 case irms_float_number:
614 /* int to float works if the float is large enough */
622 case irms_float_number:
623 if (get_mode_arithmetic(sm) == get_mode_arithmetic(lm)) {
624 if ( (get_mode_sort(lm) == irms_float_number)
625 && (get_mode_size_bits(lm) >= get_mode_size_bits(sm)) )
631 /* do exist machines out there with different pointer lenghts ?*/
634 case irms_internal_boolean:
635 return mode_is_int(lm);
645 /* Return the signed integer equivalent mode for an reference mode. */
646 ir_mode *get_reference_mode_signed_eq(ir_mode *mode) {
647 assert(mode_is_reference(mode));
648 return mode->eq_signed;
651 /* Sets the signed integer equivalent mode for an reference mode. */
652 void set_reference_mode_signed_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_signed = int_mode;
658 /* Return the unsigned integer equivalent mode for an reference mode. */
659 ir_mode *get_reference_mode_unsigned_eq(ir_mode *mode) {
660 assert(mode_is_reference(mode));
661 return mode->eq_unsigned;
664 /* Sets the unsigned integer equivalent mode for an reference mode. */
665 void set_reference_mode_unsigned_eq(ir_mode *ref_mode, ir_mode *int_mode) {
666 assert(mode_is_reference(ref_mode));
667 assert(mode_is_int(int_mode));
668 ref_mode->eq_unsigned = int_mode;
671 /* initialization, build the default modes */
676 obstack_init(&modes);
679 /* initialize predefined modes */
682 newmode.arithmetic = irma_none;
685 newmode.modulo_shift = 0;
686 newmode.vector_elem = 0;
687 newmode.eq_signed = NULL;
688 newmode.eq_unsigned = NULL;
690 newmode.tv_priv = NULL;
692 /* Control Flow Modes*/
693 newmode.sort = irms_control_flow;
696 newmode.name = new_id_from_chars("BB", 2);
697 newmode.code = irm_BB;
699 mode_BB = register_mode(&newmode);
702 newmode.name = new_id_from_chars("X", 1);
703 newmode.code = irm_X;
705 mode_X = register_mode(&newmode);
708 newmode.sort = irms_memory;
711 newmode.name = new_id_from_chars("M", 1);
712 newmode.code = irm_M;
714 mode_M = register_mode(&newmode);
716 /* Auxiliary Modes */
717 newmode.sort = irms_auxiliary,
720 newmode.name = new_id_from_chars("T", 1);
721 newmode.code = irm_T;
723 mode_T = register_mode(&newmode);
726 newmode.name = new_id_from_chars("ANY", 3);
727 newmode.code = irm_ANY;
729 mode_ANY = register_mode(&newmode);
732 newmode.name = new_id_from_chars("BAD", 3);
733 newmode.code = irm_BAD;
735 mode_BAD = register_mode(&newmode);
737 /* Internal Boolean Modes */
738 newmode.sort = irms_internal_boolean;
741 newmode.name = new_id_from_chars("b", 1);
742 newmode.code = irm_b;
744 mode_b = register_mode(&newmode);
747 newmode.vector_elem = 1;
749 /* Float Number Modes */
750 newmode.sort = irms_float_number;
751 newmode.arithmetic = irma_ieee754;
754 newmode.name = new_id_from_chars("F", 1);
755 newmode.code = irm_F;
759 mode_F = register_mode(&newmode);
762 newmode.name = new_id_from_chars("D", 1);
763 newmode.code = irm_D;
767 mode_D = register_mode(&newmode);
770 newmode.name = new_id_from_chars("E", 1);
771 newmode.code = irm_E;
775 mode_E = register_mode(&newmode);
777 /* Integer Number Modes */
778 newmode.sort = irms_int_number;
779 newmode.arithmetic = irma_twos_complement;
782 newmode.name = new_id_from_chars("Bs", 2);
783 newmode.code = irm_Bs;
786 newmode.modulo_shift = 32;
788 mode_Bs = register_mode(&newmode);
791 newmode.name = new_id_from_chars("Bu", 2);
792 newmode.code = irm_Bu;
793 newmode.arithmetic = irma_twos_complement;
796 newmode.modulo_shift = 32;
798 mode_Bu = register_mode(&newmode);
800 /* signed short integer */
801 newmode.name = new_id_from_chars("Hs", 2);
802 newmode.code = irm_Hs;
805 newmode.modulo_shift = 32;
807 mode_Hs = register_mode(&newmode);
809 /* unsigned short integer */
810 newmode.name = new_id_from_chars("Hu", 2);
811 newmode.code = irm_Hu;
814 newmode.modulo_shift = 32;
816 mode_Hu = register_mode(&newmode);
819 newmode.name = new_id_from_chars("Is", 2);
820 newmode.code = irm_Is;
823 newmode.modulo_shift = 32;
825 mode_Is = register_mode(&newmode);
827 /* unsigned integer */
828 newmode.name = new_id_from_chars("Iu", 2);
829 newmode.code = irm_Iu;
832 newmode.modulo_shift = 32;
834 mode_Iu = register_mode(&newmode);
836 /* signed long integer */
837 newmode.name = new_id_from_chars("Ls", 2);
838 newmode.code = irm_Ls;
841 newmode.modulo_shift = 64;
843 mode_Ls = register_mode(&newmode);
845 /* unsigned long integer */
846 newmode.name = new_id_from_chars("Lu", 2);
847 newmode.code = irm_Lu;
850 newmode.modulo_shift = 64;
852 mode_Lu = register_mode(&newmode);
854 /* signed long long integer */
855 newmode.name = new_id_from_chars("LLs", 3);
856 newmode.code = irm_LLs;
859 newmode.modulo_shift = 128;
861 mode_LLs = register_mode(&newmode);
863 /* unsigned long long integer */
864 newmode.name = new_id_from_chars("LLu", 3);
865 newmode.code = irm_LLu;
868 newmode.modulo_shift = 128;
870 mode_LLu = register_mode(&newmode);
873 newmode.sort = irms_reference;
874 newmode.arithmetic = irma_twos_complement;
877 newmode.name = new_id_from_chars("P", 1);
878 newmode.code = irm_P;
881 newmode.modulo_shift = 0;
882 newmode.eq_signed = mode_Is;
883 newmode.eq_unsigned = mode_Iu;
885 mode_P = register_mode(&newmode);
887 /* set the machine specific modes to the predefined ones */
888 mode_P_code = mode_P;
889 mode_P_data = mode_P;
892 /* find a signed mode for an unsigned integer mode */
893 ir_mode *find_unsigned_mode(const ir_mode *mode) {
896 assert(mode->sort == irms_int_number);
898 return find_mode(&n);
901 /* find an unsigned mode for a signed integer mode */
902 ir_mode *find_signed_mode(const ir_mode *mode) {
905 assert(mode->sort == irms_int_number);
907 return find_mode(&n);
910 /* finds a integer mode with 2*n bits for an integer mode with n bits. */
911 ir_mode *find_double_bits_int_mode(const ir_mode *mode) {
914 assert(mode->sort == irms_int_number && mode->arithmetic == irma_twos_complement);
916 n.size = 2*mode->size;
917 return find_mode(&n);
921 * Returns non-zero if the given mode honors signed zero's, i.e.,
922 * a +0 and a -0 exists and handled differently.
924 int mode_honor_signed_zeros(const ir_mode *mode) {
925 /* for floating point, we know that IEEE 754 has +0 and -0,
926 * but always handles it identical.
929 mode->sort == irms_float_number &&
930 mode->arithmetic != irma_ieee754;
934 * Returns non-zero if the given mode might overflow on unary Minus.
936 * This does NOT happen on IEEE 754.
938 int mode_overflow_on_unary_Minus(const ir_mode *mode) {
939 if (mode->sort == irms_float_number)
940 return mode->arithmetic == irma_ieee754 ? 0 : 1;
945 * Returns non-zero if the mode has a reversed wrap-around
946 * logic, especially (a + x) - x == a.
948 * This is normally true for integer modes, not for floating
951 int mode_wrap_around(const ir_mode *mode) {
952 /* FIXME: better would be an extra mode property */
953 return mode_is_int(mode);
956 void finish_mode(void) {
957 obstack_free(&modes, 0);