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
43 /** Obstack to hold all modes. */
44 static struct obstack modes;
46 /** The list of all currently existing modes. */
47 static ir_mode **mode_list;
49 const char *get_mode_arithmetic_name(ir_mode_arithmetic ari)
51 #define X(a) case a: return #a
53 X(irma_uninitialized);
55 X(irma_twos_complement);
56 X(irma_ones_complement);
60 default: return "<unknown>";
66 * Compare modes that don't need to have their code field
69 * TODO: Add other fields
71 static inline 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) {
91 for (i = ARR_LEN(mode_list) - 1; i >= 0; --i) {
92 ir_mode *n = mode_list[i];
93 if (modes_are_equal(n, m))
99 #ifdef FIRM_STATISTICS
100 /* return the mode index, only needed for statistics */
101 int stat_find_mode_index(const ir_mode *m) {
103 for (i = ARR_LEN(mode_list) - 1; i >= 0; --i) {
104 ir_mode *n = mode_list[i];
105 if (modes_are_equal(n, m))
111 /* return the mode for a given index, only needed for statistics */
112 ir_mode *stat_mode_for_index(int idx) {
113 if (0 <= idx && idx < ARR_LEN(mode_list))
114 return mode_list[idx];
120 * sets special values of modes
122 static void set_mode_values(ir_mode* mode) {
123 switch (get_mode_sort(mode)) {
125 case irms_int_number:
126 case irms_float_number:
127 mode->min = get_tarval_min(mode);
128 mode->max = get_tarval_max(mode);
129 mode->null = get_tarval_null(mode);
130 mode->one = get_tarval_one(mode);
131 mode->minus_one = get_tarval_minus_one(mode);
132 if(get_mode_sort(mode) != irms_float_number) {
133 mode->all_one = get_tarval_all_one(mode);
135 mode->all_one = tarval_bad;
139 case irms_internal_boolean:
140 mode->min = tarval_b_false;
141 mode->max = tarval_b_true;
142 mode->null = tarval_b_false;
143 mode->one = tarval_b_true;
144 mode->minus_one = tarval_bad;
145 mode->all_one = tarval_b_true;
150 case irms_control_flow:
151 mode->min = tarval_bad;
152 mode->max = tarval_bad;
153 mode->null = tarval_bad;
154 mode->one = tarval_bad;
155 mode->minus_one = tarval_bad;
161 * globals defined in irmode.h
164 /* --- Predefined modes --- */
166 /* FIRM internal modes: */
174 /* predefined numerical modes: */
175 ir_mode *mode_F; /* float */
176 ir_mode *mode_D; /* double */
177 ir_mode *mode_E; /* long double */
179 ir_mode *mode_Bs; /* integral values, signed and unsigned */
180 ir_mode *mode_Bu; /* 8 bit */
181 ir_mode *mode_Hs; /* 16 bit */
183 ir_mode *mode_Is; /* 32 bit */
185 ir_mode *mode_Ls; /* 64 bit */
187 ir_mode *mode_LLs; /* 128 bit */
193 /* machine specific modes */
194 ir_mode *mode_P_code; /**< machine specific pointer mode for code addresses */
195 ir_mode *mode_P_data; /**< machine specific pointer mode for data addresses */
198 * functions defined in irmode.h
201 /* JNI access functions */
202 ir_mode *get_modeT(void) { return mode_T; }
203 ir_mode *get_modeF(void) { return mode_F; }
204 ir_mode *get_modeD(void) { return mode_D; }
205 ir_mode *get_modeE(void) { return mode_E; }
206 ir_mode *get_modeBs(void) { return mode_Bs; }
207 ir_mode *get_modeBu(void) { return mode_Bu; }
208 ir_mode *get_modeHs(void) { return mode_Hs; }
209 ir_mode *get_modeHu(void) { return mode_Hu; }
210 ir_mode *get_modeIs(void) { return mode_Is; }
211 ir_mode *get_modeIu(void) { return mode_Iu; }
212 ir_mode *get_modeLs(void) { return mode_Ls; }
213 ir_mode *get_modeLu(void) { return mode_Lu; }
214 ir_mode *get_modeLLs(void){ return mode_LLs; }
215 ir_mode *get_modeLLu(void){ return mode_LLu; }
216 ir_mode *get_modeb(void) { return mode_b; }
217 ir_mode *get_modeP(void) { return mode_P; }
218 ir_mode *get_modeX(void) { return mode_X; }
219 ir_mode *get_modeM(void) { return mode_M; }
220 ir_mode *get_modeBB(void) { return mode_BB; }
221 ir_mode *get_modeANY(void) { return mode_ANY; }
222 ir_mode *get_modeBAD(void) { return mode_BAD; }
225 ir_mode *(get_modeP_code)(void) {
226 return _get_modeP_code();
229 ir_mode *(get_modeP_data)(void) {
230 return _get_modeP_data();
233 void set_modeP_code(ir_mode *p) {
234 assert(mode_is_reference(p));
238 void set_modeP_data(ir_mode *p) {
239 assert(mode_is_reference(p));
244 * Registers a new mode.
246 * @param new_mode The new mode template.
248 static ir_mode *register_mode(const ir_mode *new_mode) {
249 ir_mode *mode = NULL;
253 /* copy mode struct to modes array */
254 mode = (ir_mode *)obstack_copy(&modes, new_mode, sizeof(*mode));
255 ARR_APP1(ir_mode*, mode_list, mode);
257 mode->kind = k_ir_mode;
259 /* add the new mode to the irp list of modes */
262 set_mode_values(mode);
264 hook_new_mode(new_mode, mode);
269 * Creates a new mode.
271 ir_mode *new_ir_mode(const char *name, ir_mode_sort sort, int bit_size, int sign,
272 ir_mode_arithmetic arithmetic, unsigned int modulo_shift)
275 ir_mode *mode = NULL;
277 mode_tmpl.name = new_id_from_str(name);
278 mode_tmpl.sort = sort;
279 mode_tmpl.size = bit_size;
280 mode_tmpl.sign = sign ? 1 : 0;
281 mode_tmpl.modulo_shift = (mode_tmpl.sort == irms_int_number) ? modulo_shift : 0;
282 mode_tmpl.vector_elem = 1;
283 mode_tmpl.arithmetic = arithmetic;
284 mode_tmpl.link = NULL;
285 mode_tmpl.tv_priv = NULL;
287 mode = find_mode(&mode_tmpl);
289 hook_new_mode(&mode_tmpl, mode);
296 case irms_control_flow:
298 case irms_internal_boolean:
299 panic("internal modes cannot be user defined");
301 case irms_float_number:
302 case irms_int_number:
304 mode = register_mode(&mode_tmpl);
307 assert(mode != NULL);
312 * Creates a new vector mode.
314 ir_mode *new_ir_vector_mode(const char *name, ir_mode_sort sort, int bit_size, unsigned num_of_elem, int sign,
315 ir_mode_arithmetic arithmetic, unsigned int modulo_shift)
318 ir_mode *mode = NULL;
320 mode_tmpl.name = new_id_from_str(name);
321 mode_tmpl.sort = sort;
322 mode_tmpl.size = bit_size * num_of_elem;
323 mode_tmpl.sign = sign ? 1 : 0;
324 mode_tmpl.modulo_shift = (mode_tmpl.sort == irms_int_number) ? modulo_shift : 0;
325 mode_tmpl.vector_elem = num_of_elem;
326 mode_tmpl.arithmetic = arithmetic;
327 mode_tmpl.link = NULL;
328 mode_tmpl.tv_priv = NULL;
330 mode = find_mode(&mode_tmpl);
332 hook_new_mode(&mode_tmpl, mode);
336 if (num_of_elem <= 1) {
337 assert(0 && "vector modes should have at least 2 elements");
344 case irms_control_flow:
346 case irms_internal_boolean:
347 panic("internal modes cannot be user defined");
350 panic("only integer and floating point modes can be vectorized");
352 case irms_float_number:
353 panic("not yet implemented");
355 case irms_int_number:
356 mode = register_mode(&mode_tmpl);
358 assert(mode != NULL);
362 /* Functions for the direct access to all attributes of an ir_mode */
363 ident *(get_mode_ident)(const ir_mode *mode) {
364 return _get_mode_ident(mode);
367 const char *get_mode_name(const ir_mode *mode) {
368 return get_id_str(mode->name);
371 ir_mode_sort (get_mode_sort)(const ir_mode* mode) {
372 return _get_mode_sort(mode);
375 unsigned (get_mode_size_bits)(const ir_mode *mode) {
376 return _get_mode_size_bits(mode);
379 unsigned (get_mode_size_bytes)(const ir_mode *mode) {
380 return _get_mode_size_bytes(mode);
383 int (get_mode_sign)(const ir_mode *mode) {
384 return _get_mode_sign(mode);
387 ir_mode_arithmetic (get_mode_arithmetic)(const ir_mode *mode) {
388 return get_mode_arithmetic(mode);
392 /* Attribute modulo shift specifies for modes of kind irms_int_number
393 * whether shift applies modulo to value of bits to shift. Asserts
394 * if mode is not irms_int_number.
396 unsigned int (get_mode_modulo_shift)(const ir_mode *mode) {
397 return _get_mode_modulo_shift(mode);
400 unsigned int (get_mode_n_vector_elems)(const ir_mode *mode) {
401 return _get_mode_vector_elems(mode);
404 void *(get_mode_link)(const ir_mode *mode) {
405 return _get_mode_link(mode);
408 void (set_mode_link)(ir_mode *mode, void *l) {
409 _set_mode_link(mode, l);
412 tarval *get_mode_min(ir_mode *mode) {
414 assert(mode_is_data(mode));
419 tarval *get_mode_max(ir_mode *mode) {
421 assert(mode_is_data(mode));
426 tarval *get_mode_null(ir_mode *mode) {
428 assert(mode_is_datab(mode));
433 tarval *get_mode_one(ir_mode *mode) {
435 assert(mode_is_datab(mode));
440 tarval *get_mode_minus_one(ir_mode *mode) {
442 assert(mode_is_data(mode));
444 return mode->minus_one;
447 tarval *get_mode_all_one(ir_mode *mode) {
449 assert(mode_is_datab(mode));
450 return mode->all_one;
453 tarval *get_mode_infinite(ir_mode *mode) {
455 assert(mode_is_float(mode));
457 return get_tarval_plus_inf(mode);
460 tarval *get_mode_NAN(ir_mode *mode) {
462 assert(mode_is_float(mode));
464 return get_tarval_nan(mode);
467 int is_mode(const void *thing) {
468 return get_kind(thing) == k_ir_mode;
471 int (mode_is_signed)(const ir_mode *mode) {
472 return _mode_is_signed(mode);
475 int (mode_is_float)(const ir_mode *mode) {
476 return _mode_is_float(mode);
479 int (mode_is_int)(const ir_mode *mode) {
480 return _mode_is_int(mode);
483 int (mode_is_reference)(const ir_mode *mode) {
484 return _mode_is_reference(mode);
487 int (mode_is_num)(const ir_mode *mode) {
488 return _mode_is_num(mode);
491 int (mode_is_data)(const ir_mode *mode) {
492 return _mode_is_data(mode);
495 int (mode_is_datab)(const ir_mode *mode) {
496 return _mode_is_datab(mode);
499 int (mode_is_dataM)(const ir_mode *mode) {
500 return _mode_is_dataM(mode);
503 int (mode_is_float_vector)(const ir_mode *mode) {
504 return _mode_is_float_vector(mode);
507 int (mode_is_int_vector)(const ir_mode *mode) {
508 return _mode_is_int_vector(mode);
511 /* Returns true if sm can be converted to lm without loss. */
512 int smaller_mode(const ir_mode *sm, const ir_mode *lm) {
513 int sm_bits, lm_bits;
518 if (sm == lm) return 1;
520 sm_bits = get_mode_size_bits(sm);
521 lm_bits = get_mode_size_bits(lm);
523 switch (get_mode_sort(sm)) {
524 case irms_int_number:
525 switch (get_mode_sort(lm)) {
526 case irms_int_number:
527 if (get_mode_arithmetic(sm) != get_mode_arithmetic(lm))
530 /* only two complement implemented */
531 assert(get_mode_arithmetic(sm) == irma_twos_complement);
533 /* integers are convertable if
534 * - both have the same sign and lm is the larger one
535 * - lm is the signed one and is at least two bits larger
536 * (one for the sign, one for the highest bit of sm)
537 * - sm & lm are two_complement and lm has greater or equal number of bits
539 if (mode_is_signed(sm)) {
540 if (!mode_is_signed(lm))
542 return sm_bits <= lm_bits;
544 if (mode_is_signed(lm)) {
545 return sm_bits < lm_bits;
547 return sm_bits <= lm_bits;
551 case irms_float_number:
552 /* int to float works if the float is large enough */
560 case irms_float_number:
561 if (get_mode_arithmetic(sm) == get_mode_arithmetic(lm)) {
562 if ( (get_mode_sort(lm) == irms_float_number)
563 && (get_mode_size_bits(lm) >= get_mode_size_bits(sm)) )
569 /* do exist machines out there with different pointer lengths ?*/
572 case irms_internal_boolean:
573 return mode_is_int(lm);
583 /* Returns true if a value of mode sm can be converted into mode lm
584 and backwards without loss. */
585 int values_in_mode(const ir_mode *sm, const ir_mode *lm) {
586 int sm_bits, lm_bits;
587 ir_mode_arithmetic arith;
592 if (sm == lm) return 1;
595 return mode_is_int(lm);
597 sm_bits = get_mode_size_bits(sm);
598 lm_bits = get_mode_size_bits(lm);
600 arith = get_mode_arithmetic(sm);
601 if (arith != get_mode_arithmetic(lm))
605 case irma_twos_complement:
607 return get_mode_size_bits(sm) <= get_mode_size_bits(lm);
614 /* Return the signed integer equivalent mode for an reference mode. */
615 ir_mode *get_reference_mode_signed_eq(ir_mode *mode) {
616 assert(mode_is_reference(mode));
617 return mode->eq_signed;
620 /* Sets the signed integer equivalent mode for an reference mode. */
621 void set_reference_mode_signed_eq(ir_mode *ref_mode, ir_mode *int_mode) {
622 assert(mode_is_reference(ref_mode));
623 assert(mode_is_int(int_mode));
624 ref_mode->eq_signed = int_mode;
627 /* Return the unsigned integer equivalent mode for an reference mode. */
628 ir_mode *get_reference_mode_unsigned_eq(ir_mode *mode) {
629 assert(mode_is_reference(mode));
630 return mode->eq_unsigned;
633 /* Sets the unsigned integer equivalent mode for an reference mode. */
634 void set_reference_mode_unsigned_eq(ir_mode *ref_mode, ir_mode *int_mode) {
635 assert(mode_is_reference(ref_mode));
636 assert(mode_is_int(int_mode));
637 ref_mode->eq_unsigned = int_mode;
640 /* initialization, build the default modes */
641 void init_mode(void) {
644 obstack_init(&modes);
645 mode_list = NEW_ARR_F(ir_mode*, 0);
647 /* initialize predefined modes */
650 newmode.arithmetic = irma_none;
653 newmode.modulo_shift = 0;
654 newmode.vector_elem = 0;
655 newmode.eq_signed = NULL;
656 newmode.eq_unsigned = NULL;
658 newmode.tv_priv = NULL;
660 /* Control Flow Modes*/
661 newmode.sort = irms_control_flow;
664 newmode.name = new_id_from_chars("BB", 2);
665 mode_BB = register_mode(&newmode);
668 newmode.name = new_id_from_chars("X", 1);
669 mode_X = register_mode(&newmode);
672 newmode.sort = irms_memory;
675 newmode.name = new_id_from_chars("M", 1);
676 mode_M = register_mode(&newmode);
678 /* Auxiliary Modes */
679 newmode.sort = irms_auxiliary,
682 newmode.name = new_id_from_chars("T", 1);
683 mode_T = register_mode(&newmode);
686 newmode.name = new_id_from_chars("ANY", 3);
687 mode_ANY = register_mode(&newmode);
690 newmode.name = new_id_from_chars("BAD", 3);
691 mode_BAD = register_mode(&newmode);
693 /* Internal Boolean Modes */
694 newmode.sort = irms_internal_boolean;
697 newmode.name = new_id_from_chars("b", 1);
698 mode_b = register_mode(&newmode);
701 newmode.vector_elem = 1;
703 /* Float Number Modes */
704 newmode.sort = irms_float_number;
705 newmode.arithmetic = irma_ieee754;
708 newmode.name = new_id_from_chars("F", 1);
711 mode_F = register_mode(&newmode);
714 newmode.name = new_id_from_chars("D", 1);
717 mode_D = register_mode(&newmode);
720 newmode.name = new_id_from_chars("E", 1);
722 /* note that the tarval module is calculating with 80 bits, but we use
723 * 96 bits, as that is what will be stored to memory by most hardware */
725 mode_E = register_mode(&newmode);
727 /* Integer Number Modes */
728 newmode.sort = irms_int_number;
729 newmode.arithmetic = irma_twos_complement;
732 newmode.name = new_id_from_chars("Bs", 2);
735 newmode.modulo_shift = 32;
736 mode_Bs = register_mode(&newmode);
739 newmode.name = new_id_from_chars("Bu", 2);
740 newmode.arithmetic = irma_twos_complement;
743 newmode.modulo_shift = 32;
744 mode_Bu = register_mode(&newmode);
746 /* signed short integer */
747 newmode.name = new_id_from_chars("Hs", 2);
750 newmode.modulo_shift = 32;
751 mode_Hs = register_mode(&newmode);
753 /* unsigned short integer */
754 newmode.name = new_id_from_chars("Hu", 2);
757 newmode.modulo_shift = 32;
758 mode_Hu = register_mode(&newmode);
761 newmode.name = new_id_from_chars("Is", 2);
764 newmode.modulo_shift = 32;
765 mode_Is = register_mode(&newmode);
767 /* unsigned integer */
768 newmode.name = new_id_from_chars("Iu", 2);
771 newmode.modulo_shift = 32;
772 mode_Iu = register_mode(&newmode);
774 /* signed long integer */
775 newmode.name = new_id_from_chars("Ls", 2);
778 newmode.modulo_shift = 64;
779 mode_Ls = register_mode(&newmode);
781 /* unsigned long integer */
782 newmode.name = new_id_from_chars("Lu", 2);
785 newmode.modulo_shift = 64;
786 mode_Lu = register_mode(&newmode);
788 /* signed long long integer */
789 newmode.name = new_id_from_chars("LLs", 3);
792 newmode.modulo_shift = 128;
793 mode_LLs = register_mode(&newmode);
795 /* unsigned long long integer */
796 newmode.name = new_id_from_chars("LLu", 3);
799 newmode.modulo_shift = 128;
800 mode_LLu = register_mode(&newmode);
803 newmode.sort = irms_reference;
804 newmode.arithmetic = irma_twos_complement;
807 newmode.name = new_id_from_chars("P", 1);
810 newmode.modulo_shift = 0;
811 newmode.eq_signed = mode_Is;
812 newmode.eq_unsigned = mode_Iu;
813 mode_P = register_mode(&newmode);
815 /* set the machine specific modes to the predefined ones */
816 mode_P_code = mode_P;
817 mode_P_data = mode_P;
820 /* find a signed mode for an unsigned integer mode */
821 ir_mode *find_unsigned_mode(const ir_mode *mode) {
824 /* allowed for reference mode */
825 if (mode->sort == irms_reference)
826 n.sort = irms_int_number;
828 assert(n.sort == irms_int_number);
830 return find_mode(&n);
833 /* find an unsigned mode for a signed integer mode */
834 ir_mode *find_signed_mode(const ir_mode *mode) {
837 assert(mode->sort == irms_int_number);
839 return find_mode(&n);
842 /* finds a integer mode with 2*n bits for an integer mode with n bits. */
843 ir_mode *find_double_bits_int_mode(const ir_mode *mode) {
846 assert(mode->sort == irms_int_number && mode->arithmetic == irma_twos_complement);
848 n.size = 2*mode->size;
849 return find_mode(&n);
853 * Returns non-zero if the given mode honors signed zero's, i.e.,
854 * a +0 and a -0 exists and handled differently.
856 int mode_honor_signed_zeros(const ir_mode *mode) {
857 /* for floating point, we know that IEEE 754 has +0 and -0,
858 * but always handles it identical.
861 mode->sort == irms_float_number &&
862 mode->arithmetic != irma_ieee754;
866 * Returns non-zero if the given mode might overflow on unary Minus.
868 * This does NOT happen on IEEE 754.
870 int mode_overflow_on_unary_Minus(const ir_mode *mode) {
871 if (mode->sort == irms_float_number)
872 return mode->arithmetic == irma_ieee754 ? 0 : 1;
877 * Returns non-zero if the mode has a reversed wrap-around
878 * logic, especially (a + x) - x == a.
880 * This is normally true for integer modes, not for floating
883 int mode_wrap_around(const ir_mode *mode) {
884 /* FIXME: better would be an extra mode property */
885 return mode_is_int(mode);
889 * Returns non-zero if the cast from mode src to mode dst is a
890 * reinterpret cast (ie. only the bit pattern is reinterpreted,
891 * no conversion is done)
893 int is_reinterpret_cast(const ir_mode *src, const ir_mode *dst) {
894 ir_mode_arithmetic ma;
898 if (get_mode_size_bits(src) != get_mode_size_bits(dst))
900 ma = get_mode_arithmetic(src);
901 if (ma != get_mode_arithmetic(dst))
904 return ma == irma_twos_complement || ma == irma_ones_complement;
907 void finish_mode(void) {
908 obstack_free(&modes, 0);
909 DEL_ARR_F(mode_list);