make opcode list global
[libfirm] / ir / ir / irmode.c
1 /*
2  * Copyright (C) 1995-2011 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
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.
10  *
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.
14  *
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
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @brief    Data modes of operations.
23  * @author   Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Mathias Heil
24  */
25 #include "config.h"
26
27 #include <stdlib.h>
28 #include <string.h>
29 #include <stddef.h>
30 #include <stdbool.h>
31
32 #include "irprog_t.h"
33 #include "irmode_t.h"
34 #include "ident.h"
35 #include "tv_t.h"
36 #include "obst.h"
37 #include "irhooks.h"
38 #include "irtools.h"
39 #include "array.h"
40 #include "error.h"
41 #include "pattern_dmp.h"
42
43 /** Obstack to hold all modes. */
44 static struct obstack modes;
45
46 /** The list of all currently existing modes. */
47 static ir_mode **mode_list;
48
49 static bool modes_are_equal(const ir_mode *m, const ir_mode *n)
50 {
51         return m->sort         == n->sort &&
52                m->arithmetic   == n->arithmetic &&
53                m->size         == n->size &&
54                m->sign         == n->sign &&
55                m->modulo_shift == n->modulo_shift;
56 }
57
58 /**
59  * searches the modes obstack for the given mode and returns
60  * a pointer on an equal mode already in the array, NULL if
61  * none found
62  */
63 static ir_mode *find_mode(const ir_mode *m)
64 {
65         size_t i, n_modes;
66         for (i = 0, n_modes = ARR_LEN(mode_list); i < n_modes; ++i) {
67                 ir_mode *n = mode_list[i];
68                 if (modes_are_equal(n, m))
69                         return n;
70         }
71         return NULL;
72 }
73
74 /**
75  * sets special values of modes
76  */
77 static void set_mode_values(ir_mode* mode)
78 {
79         switch (get_mode_sort(mode))    {
80         case irms_reference:
81         case irms_int_number:
82         case irms_float_number:
83                 mode->min  = get_tarval_min(mode);
84                 mode->max  = get_tarval_max(mode);
85                 mode->null = get_tarval_null(mode);
86                 mode->one  = get_tarval_one(mode);
87                 mode->minus_one = get_tarval_minus_one(mode);
88                 if (get_mode_sort(mode) != irms_float_number) {
89                         mode->all_one = get_tarval_all_one(mode);
90                 } else {
91                         mode->all_one = tarval_bad;
92                 }
93                 break;
94
95         case irms_internal_boolean:
96                 mode->min  = tarval_b_false;
97                 mode->max  = tarval_b_true;
98                 mode->null = tarval_b_false;
99                 mode->one  = tarval_b_true;
100                 mode->minus_one = tarval_bad;
101                 mode->all_one = tarval_b_true;
102                 break;
103
104         case irms_control_flow:
105         case irms_block:
106         case irms_tuple:
107         case irms_any:
108         case irms_bad:
109         case irms_memory:
110                 mode->min  = tarval_bad;
111                 mode->max  = tarval_bad;
112                 mode->null = tarval_bad;
113                 mode->one  = tarval_bad;
114                 mode->minus_one = tarval_bad;
115                 break;
116         }
117 }
118
119 ir_mode *mode_T;
120 ir_mode *mode_X;
121 ir_mode *mode_M;
122 ir_mode *mode_BB;
123 ir_mode *mode_ANY;
124 ir_mode *mode_BAD;
125
126 ir_mode *mode_F;
127 ir_mode *mode_D;
128 ir_mode *mode_Q;
129
130 ir_mode *mode_Bs;
131 ir_mode *mode_Bu;
132 ir_mode *mode_Hs;
133 ir_mode *mode_Hu;
134 ir_mode *mode_Is;
135 ir_mode *mode_Iu;
136 ir_mode *mode_Ls;
137 ir_mode *mode_Lu;
138 ir_mode *mode_LLs;
139 ir_mode *mode_LLu;
140
141 ir_mode *mode_b;
142 ir_mode *mode_P;
143
144 ir_mode *mode_P_code;
145 ir_mode *mode_P_data;
146
147 ir_mode *get_modeT(void) { return mode_T; }
148 ir_mode *get_modeF(void) { return mode_F; }
149 ir_mode *get_modeD(void) { return mode_D; }
150 ir_mode *get_modeQ(void) { return mode_Q; }
151 ir_mode *get_modeBs(void) { return mode_Bs; }
152 ir_mode *get_modeBu(void) { return mode_Bu; }
153 ir_mode *get_modeHs(void) { return mode_Hs; }
154 ir_mode *get_modeHu(void) { return mode_Hu; }
155 ir_mode *get_modeIs(void) { return mode_Is; }
156 ir_mode *get_modeIu(void) { return mode_Iu; }
157 ir_mode *get_modeLs(void) { return mode_Ls; }
158 ir_mode *get_modeLu(void) { return mode_Lu; }
159 ir_mode *get_modeLLs(void){ return mode_LLs; }
160 ir_mode *get_modeLLu(void){ return mode_LLu; }
161 ir_mode *get_modeb(void) { return mode_b; }
162 ir_mode *get_modeP(void) { return mode_P; }
163 ir_mode *get_modeX(void) { return mode_X; }
164 ir_mode *get_modeM(void) { return mode_M; }
165 ir_mode *get_modeBB(void) { return mode_BB; }
166 ir_mode *get_modeANY(void) { return mode_ANY; }
167 ir_mode *get_modeBAD(void) { return mode_BAD; }
168
169
170 ir_mode *(get_modeP_code)(void)
171 {
172         return get_modeP_code_();
173 }
174
175 ir_mode *(get_modeP_data)(void)
176 {
177         return get_modeP_data_();
178 }
179
180 void set_modeP_code(ir_mode *p)
181 {
182         assert(mode_is_reference(p));
183         mode_P_code = p;
184 }
185
186 void set_modeP_data(ir_mode *p)
187 {
188         assert(mode_is_reference(p));
189         mode_P_data = p;
190         mode_P = p;
191 }
192
193 /*
194  * Creates a new mode.
195  */
196 static ir_mode *alloc_mode(const char *name, ir_mode_sort sort,
197                            ir_mode_arithmetic arithmetic, unsigned bit_size,
198                            int sign, unsigned modulo_shift)
199 {
200         ir_mode *mode_tmpl = OALLOCZ(&modes, ir_mode);
201
202         mode_tmpl->name         = new_id_from_str(name);
203         mode_tmpl->sort         = sort;
204         mode_tmpl->size         = bit_size;
205         mode_tmpl->sign         = sign ? 1 : 0;
206         mode_tmpl->modulo_shift = modulo_shift;
207         mode_tmpl->arithmetic   = arithmetic;
208         mode_tmpl->link         = NULL;
209         mode_tmpl->tv_priv      = NULL;
210         return mode_tmpl;
211 }
212
213 static ir_mode *register_mode(ir_mode *mode)
214 {
215         /* does any of the existing modes have the same properties? */
216         ir_mode *old = find_mode(mode);
217         if (old != NULL) {
218                 /* remove new mode from obstack */
219                 obstack_free(&modes, mode);
220                 return old;
221         }
222
223         mode->kind = k_ir_mode;
224         mode->type = new_type_primitive(mode);
225         ARR_APP1(ir_mode*, mode_list, mode);
226         add_irp_mode(mode);
227         set_mode_values(mode);
228         hook_new_mode(mode);
229         return mode;
230 }
231
232 ir_mode *new_int_mode(const char *name, ir_mode_arithmetic arithmetic,
233                       unsigned bit_size, int sign, unsigned modulo_shift)
234 {
235         ir_mode *result = alloc_mode(name, irms_int_number, arithmetic, bit_size,
236                                      sign, modulo_shift);
237         return register_mode(result);
238 }
239
240 ir_mode *new_reference_mode(const char *name, ir_mode_arithmetic arithmetic,
241                             unsigned bit_size, unsigned modulo_shift)
242 {
243         ir_mode *result = alloc_mode(name, irms_reference, arithmetic, bit_size,
244                                      0, modulo_shift);
245         return register_mode(result);
246 }
247
248 ir_mode *new_float_mode(const char *name, ir_mode_arithmetic arithmetic,
249                         unsigned exponent_size, unsigned mantissa_size)
250 {
251         bool     explicit_one = false;
252         unsigned bit_size     = exponent_size + mantissa_size + 1;
253         ir_mode *result;
254
255         if (arithmetic == irma_x86_extended_float) {
256                 explicit_one = true;
257                 bit_size++;
258         } else if (arithmetic != irma_ieee754) {
259                 panic("Arithmetic %s invalid for float");
260         }
261         if (exponent_size >= 256)
262                 panic("Exponents >= 256 bits not supported");
263         if (mantissa_size >= 256)
264                 panic("Mantissa >= 256 bits not supported");
265
266         result = alloc_mode(name, irms_float_number, irma_x86_extended_float, bit_size, 1, 0);
267         result->float_desc.exponent_size = exponent_size;
268         result->float_desc.mantissa_size = mantissa_size;
269         result->float_desc.explicit_one  = explicit_one;
270         return register_mode(result);
271 }
272
273 ident *(get_mode_ident)(const ir_mode *mode)
274 {
275         return get_mode_ident_(mode);
276 }
277
278 const char *get_mode_name(const ir_mode *mode)
279 {
280         return get_id_str(mode->name);
281 }
282
283 unsigned (get_mode_size_bits)(const ir_mode *mode)
284 {
285         return get_mode_size_bits_(mode);
286 }
287
288 unsigned (get_mode_size_bytes)(const ir_mode *mode)
289 {
290         return get_mode_size_bytes_(mode);
291 }
292
293 int (get_mode_sign)(const ir_mode *mode)
294 {
295         return get_mode_sign_(mode);
296 }
297
298 ir_mode_arithmetic (get_mode_arithmetic)(const ir_mode *mode)
299 {
300         return get_mode_arithmetic_(mode);
301 }
302
303
304 unsigned int (get_mode_modulo_shift)(const ir_mode *mode)
305 {
306         return get_mode_modulo_shift_(mode);
307 }
308
309 void *(get_mode_link)(const ir_mode *mode)
310 {
311         return get_mode_link_(mode);
312 }
313
314 void (set_mode_link)(ir_mode *mode, void *l)
315 {
316         set_mode_link_(mode, l);
317 }
318
319 ir_tarval *get_mode_min(ir_mode *mode)
320 {
321         assert(mode);
322         assert(mode_is_data(mode));
323
324         return mode->min;
325 }
326
327 ir_tarval *get_mode_max(ir_mode *mode)
328 {
329         assert(mode);
330         assert(mode_is_data(mode));
331
332         return mode->max;
333 }
334
335 ir_tarval *get_mode_null(ir_mode *mode)
336 {
337         assert(mode);
338         assert(mode_is_datab(mode));
339
340         return mode->null;
341 }
342
343 ir_tarval *get_mode_one(ir_mode *mode)
344 {
345         assert(mode);
346         assert(mode_is_datab(mode));
347
348         return mode->one;
349 }
350
351 ir_tarval *get_mode_minus_one(ir_mode *mode)
352 {
353         assert(mode);
354         assert(mode_is_data(mode));
355
356         return mode->minus_one;
357 }
358
359 ir_tarval *get_mode_all_one(ir_mode *mode)
360 {
361         assert(mode);
362         assert(mode_is_datab(mode));
363         return mode->all_one;
364 }
365
366 ir_tarval *get_mode_infinite(ir_mode *mode)
367 {
368         assert(mode);
369         assert(mode_is_float(mode));
370
371         return get_tarval_plus_inf(mode);
372 }
373
374 ir_tarval *get_mode_NAN(ir_mode *mode)
375 {
376         assert(mode);
377         assert(mode_is_float(mode));
378
379         return get_tarval_nan(mode);
380 }
381
382 int is_mode(const void *thing)
383 {
384         return get_kind(thing) == k_ir_mode;
385 }
386
387 int (mode_is_signed)(const ir_mode *mode)
388 {
389         return mode_is_signed_(mode);
390 }
391
392 int (mode_is_float)(const ir_mode *mode)
393 {
394         return mode_is_float_(mode);
395 }
396
397 int (mode_is_int)(const ir_mode *mode)
398 {
399         return mode_is_int_(mode);
400 }
401
402 int (mode_is_reference)(const ir_mode *mode)
403 {
404         return mode_is_reference_(mode);
405 }
406
407 int (mode_is_num)(const ir_mode *mode)
408 {
409         return mode_is_num_(mode);
410 }
411
412 int (mode_is_data)(const ir_mode *mode)
413 {
414         return mode_is_data_(mode);
415 }
416
417 int (mode_is_datab)(const ir_mode *mode)
418 {
419         return mode_is_datab_(mode);
420 }
421
422 int (mode_is_dataM)(const ir_mode *mode)
423 {
424         return mode_is_dataM_(mode);
425 }
426
427 unsigned (get_mode_mantissa_size)(const ir_mode *mode)
428 {
429         return get_mode_mantissa_size_(mode);
430 }
431
432 unsigned (get_mode_exponent_size)(const ir_mode *mode)
433 {
434         return get_mode_exponent_size_(mode);
435 }
436
437 int smaller_mode(const ir_mode *sm, const ir_mode *lm)
438 {
439         int sm_bits, lm_bits;
440
441         assert(sm);
442         assert(lm);
443
444         if (sm == lm) return 1;
445
446         sm_bits = get_mode_size_bits(sm);
447         lm_bits = get_mode_size_bits(lm);
448
449         switch (get_mode_sort(sm)) {
450         case irms_int_number:
451                 switch (get_mode_sort(lm)) {
452                 case irms_int_number:
453                         if (get_mode_arithmetic(sm) != get_mode_arithmetic(lm))
454                                 return 0;
455
456                         /* only two complement implemented */
457                         assert(get_mode_arithmetic(sm) == irma_twos_complement);
458
459                         /* integers are convertable if
460                          *   - both have the same sign and lm is the larger one
461                          *   - lm is the signed one and is at least two bits larger
462                          *     (one for the sign, one for the highest bit of sm)
463                          *   - sm & lm are two_complement and lm has greater or equal number of bits
464                          */
465                         if (mode_is_signed(sm)) {
466                                 if (!mode_is_signed(lm))
467                                         return 0;
468                                 return sm_bits <= lm_bits;
469                         } else {
470                                 if (mode_is_signed(lm)) {
471                                         return sm_bits < lm_bits;
472                                 }
473                                 return sm_bits <= lm_bits;
474                         }
475
476                 case irms_float_number:
477                         /* int to float works if the float is large enough */
478                         return 0;
479
480                 default:
481                         break;
482                 }
483                 break;
484
485         case irms_float_number:
486                 if (get_mode_arithmetic(sm) == get_mode_arithmetic(lm)) {
487                         if ( (get_mode_sort(lm) == irms_float_number)
488                                 && (get_mode_size_bits(lm) >= get_mode_size_bits(sm)) )
489                                 return 1;
490                 }
491                 break;
492
493         case irms_reference:
494                 /* do exist machines out there with different pointer lengths ?*/
495                 return 0;
496
497         case irms_internal_boolean:
498                 return mode_is_int(lm);
499
500         default:
501                 break;
502         }
503
504         /* else */
505         return 0;
506 }
507
508 int values_in_mode(const ir_mode *sm, const ir_mode *lm)
509 {
510         ir_mode_arithmetic arith;
511
512         assert(sm);
513         assert(lm);
514
515         if (sm == lm) return 1;
516
517         if (sm == mode_b)
518                 return mode_is_int(lm);
519
520         arith = get_mode_arithmetic(sm);
521         if (arith != get_mode_arithmetic(lm))
522                 return 0;
523
524         switch (arith) {
525                 case irma_twos_complement:
526                 case irma_ieee754:
527                         return get_mode_size_bits(sm) <= get_mode_size_bits(lm);
528
529                 default:
530                         return 0;
531         }
532 }
533
534 ir_mode *get_reference_mode_signed_eq(ir_mode *mode)
535 {
536         assert(mode_is_reference(mode));
537         return mode->eq_signed;
538 }
539
540 void set_reference_mode_signed_eq(ir_mode *ref_mode, ir_mode *int_mode)
541 {
542         assert(mode_is_reference(ref_mode));
543         assert(mode_is_int(int_mode));
544         ref_mode->eq_signed = int_mode;
545 }
546
547 ir_mode *get_reference_mode_unsigned_eq(ir_mode *mode)
548 {
549         assert(mode_is_reference(mode));
550         return mode->eq_unsigned;
551 }
552
553 void set_reference_mode_unsigned_eq(ir_mode *ref_mode, ir_mode *int_mode)
554 {
555         assert(mode_is_reference(ref_mode));
556         assert(mode_is_int(int_mode));
557         ref_mode->eq_unsigned = int_mode;
558 }
559
560 static ir_mode *new_internal_mode(const char *name, ir_mode_sort sort)
561 {
562         ir_mode *mode = alloc_mode(name, sort, irma_none, 0, 0, 0);
563         return register_mode(mode);
564 }
565
566 void init_mode(void)
567 {
568         obstack_init(&modes);
569         mode_list = NEW_ARR_F(ir_mode*, 0);
570
571         /* initialize predefined modes */
572         mode_BB  = new_internal_mode("BB",  irms_block);
573         mode_X   = new_internal_mode("X",   irms_control_flow);
574         mode_M   = new_internal_mode("M",   irms_memory);
575         mode_T   = new_internal_mode("T",   irms_tuple);
576         mode_ANY = new_internal_mode("ANY", irms_any);
577         mode_BAD = new_internal_mode("BAD", irms_bad);
578         mode_b   = new_internal_mode("b",   irms_internal_boolean);
579
580         mode_F   = new_float_mode("F", irma_ieee754,  8, 23);
581         mode_D   = new_float_mode("D", irma_ieee754, 11, 52);
582         mode_Q   = new_float_mode("Q", irma_ieee754, 15, 112);
583
584         mode_Bs  = new_int_mode("Bs",  irma_twos_complement, 8,   1, 32);
585         mode_Bu  = new_int_mode("Bu",  irma_twos_complement, 8,   0, 32);
586         mode_Hs  = new_int_mode("Hs",  irma_twos_complement, 16,  1, 32);
587         mode_Hu  = new_int_mode("Hu",  irma_twos_complement, 16,  0, 32);
588         mode_Is  = new_int_mode("Is",  irma_twos_complement, 32,  1, 32);
589         mode_Iu  = new_int_mode("Iu",  irma_twos_complement, 32,  0, 32);
590         mode_Ls  = new_int_mode("Ls",  irma_twos_complement, 64,  1, 64);
591         mode_Lu  = new_int_mode("Lu",  irma_twos_complement, 64,  0, 64);
592         mode_LLs = new_int_mode("LLs", irma_twos_complement, 128, 1, 128);
593         mode_LLu = new_int_mode("LLu", irma_twos_complement, 128, 0, 128);
594
595         mode_P   = new_reference_mode("P", irma_twos_complement, 32, 32);
596         set_reference_mode_signed_eq(mode_P, mode_Is);
597         set_reference_mode_unsigned_eq(mode_P, mode_Iu);
598
599         /* set the machine specific modes to the predefined ones */
600         mode_P_code = mode_P;
601         mode_P_data = mode_P;
602 }
603
604 ir_mode *find_unsigned_mode(const ir_mode *mode)
605 {
606         ir_mode n = *mode;
607
608         /* allowed for reference mode */
609         if (mode->sort == irms_reference)
610                 n.sort = irms_int_number;
611
612         assert(n.sort == irms_int_number);
613         n.sign = 0;
614         return find_mode(&n);
615 }
616
617 ir_mode *find_signed_mode(const ir_mode *mode)
618 {
619         ir_mode n = *mode;
620
621         assert(mode->sort == irms_int_number);
622         n.sign = 1;
623         return find_mode(&n);
624 }
625
626 ir_mode *find_double_bits_int_mode(const ir_mode *mode)
627 {
628         ir_mode n = *mode;
629
630         assert(mode->sort == irms_int_number && mode->arithmetic == irma_twos_complement);
631
632         n.size = 2*mode->size;
633         return find_mode(&n);
634 }
635
636 int mode_honor_signed_zeros(const ir_mode *mode)
637 {
638         /* for floating point, we know that IEEE 754 has +0 and -0,
639          * but always handles it identical.
640          */
641         return
642                 mode->sort == irms_float_number &&
643                 mode->arithmetic != irma_ieee754;
644 }
645
646 int mode_overflow_on_unary_Minus(const ir_mode *mode)
647 {
648         if (mode->sort == irms_float_number)
649                 return mode->arithmetic == irma_ieee754 ? 0 : 1;
650         return 1;
651 }
652
653 int mode_wrap_around(const ir_mode *mode)
654 {
655         /* FIXME: better would be an extra mode property */
656         return mode_is_int(mode);
657 }
658
659 int is_reinterpret_cast(const ir_mode *src, const ir_mode *dst)
660 {
661         ir_mode_arithmetic ma;
662
663         if (src == dst)
664                 return 1;
665         if (get_mode_size_bits(src) != get_mode_size_bits(dst))
666                 return 0;
667         ma = get_mode_arithmetic(src);
668         if (ma != get_mode_arithmetic(dst))
669                 return 0;
670
671         return ma == irma_twos_complement;
672 }
673
674 ir_type *(get_type_for_mode) (const ir_mode *mode)
675 {
676         return get_type_for_mode_(mode);
677 }
678
679 void finish_mode(void)
680 {
681         obstack_free(&modes, 0);
682         DEL_ARR_F(mode_list);
683
684         mode_T   = NULL;
685         mode_X   = NULL;
686         mode_M   = NULL;
687         mode_BB  = NULL;
688         mode_ANY = NULL;
689         mode_BAD = NULL;
690
691         mode_F   = NULL;
692         mode_D   = NULL;
693
694         mode_Bs  = NULL;
695         mode_Bu  = NULL;
696         mode_Hs  = NULL;
697         mode_Hu  = NULL;
698         mode_Is  = NULL;
699         mode_Iu  = NULL;
700         mode_Ls  = NULL;
701         mode_Lu  = NULL;
702
703         mode_b   = NULL;
704
705         mode_P      = NULL;
706         mode_P_code = NULL;
707         mode_P_data = NULL;
708 }