0947191063c6e263c8f75d92bde59fadae7893ca
[libfirm] / ir / ir / irmode.h
1 /* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
2 ** All rights reserved.
3 **
4 ** Authors: Christian Schaefer
5 **
6 irmode.h Modes for ir operators.
7
8 This module specifies the modes that type the firm nodes.  See
9 UKA tech report 1999-14 for more information about modes.
10
11
12 @@@ This file is at the level of the original fiasco.  It needs to be ported
13 to the version of the tech report!!! This will be done with the
14 reimplementation of the tarval module.
15 */
16
17 /* $Id$ */
18
19 # ifndef _IRMODE_H_
20 # define _IRMODE_H_
21
22 #include "ident.h"
23 #include <stdbool.h>
24
25 # define target_bits 8
26
27 # define NUM_MODES 20
28
29 #ifndef _TARVAL_TYPEDEF_
30 #define _TARVAL_TYPEDEF_
31 typedef struct tarval tarval;
32 #endif
33
34 typedef enum { /* irm is short for `ir mode' */
35   /*  according to tech report 1999-14: */
36   irm_BB, irm_X,                 // basic block, execution
37   irm_F, irm_D, irm_E,           // float(32), double(64), extended(80)
38   irm_Bs, irm_Bu, irm_Hs, irm_Hu, irm_Is, irm_Iu, irm_Ls, irm_Lu,
39                                  // byte(8), short(16), int(32), long(64)
40   irm_C,                         // character
41   irm_P,                         // pointer
42   irm_b,                         // internal boolean
43   irm_M,                         // memory
44   irm_T,                         // tuple
45   irm_max
46 } modecode;
47
48 typedef struct ir_mode ir_mode;
49
50 extern ir_mode *mode_T;  /* tuple (none) */
51 extern ir_mode *mode_F;  /* signed float(32) */
52 extern ir_mode *mode_D;  /* signed double(64) */
53 extern ir_mode *mode_E;  /* signed extended(80) */
54 extern ir_mode *mode_Bs; /* signed byte (former char) */
55 extern ir_mode *mode_Bu;  /* unsigned byte (former char) */
56 extern ir_mode *mode_Hs; /* signed short integer */
57 extern ir_mode *mode_Hu; /* unsigened short integer */
58 extern ir_mode *mode_Is; /* signed integer */
59 extern ir_mode *mode_Iu; /* unsigned integer */
60 extern ir_mode *mode_Ls; /* signed long integer */
61 extern ir_mode *mode_Lu; /* unsigned long integer */
62 extern ir_mode *mode_C;  /* char */
63 extern ir_mode *mode_P;  /* pointer */
64 extern ir_mode *mode_b;  /* internal boolean */
65 extern ir_mode *mode_X;  /* execution */
66 extern ir_mode *mode_M;  /* memory */
67 extern ir_mode *mode_BB; /* block */
68
69 /* Access routines for JNI Interface */
70 ir_mode *get_modeT();
71 ir_mode *get_modeF();
72 ir_mode *get_modeD();
73 ir_mode *get_modeE();
74 ir_mode *get_modeBs();
75 ir_mode *get_modeBu();
76 ir_mode *get_modeHs();
77 ir_mode *get_modeHu();
78 ir_mode *get_modeIs();
79 ir_mode *get_modeIu();
80 ir_mode *get_modeLs();
81 ir_mode *get_modeLu();
82 ir_mode *get_modeC();
83 ir_mode *get_modeP();
84 ir_mode *get_modeb();
85 ir_mode *get_modeX();
86 ir_mode *get_modeM();
87 ir_mode *get_modeBB();
88
89 /* An enum for this mode */
90 modecode get_mode_modecode (ir_mode *mode);
91 /* void  set_mode_modecode (ir_mode *mode, modecode code);  */
92
93 /* The ident of this mode */
94 ident   *get_mode_ident    (ir_mode *mode);
95 /* void  set_mode_ident    (ir_mode *mode, ident *id);    */
96
97 /* The name of this mode */
98 const char *get_mode_name  (ir_mode *mode);
99 /* void  set_mode_name     (ir_mode *mode, char *name);    */
100
101 /* The size of values of the mode in bytes. */
102 int      get_mode_size     (ir_mode *mode);
103 /* void  set_mode_size     (ir_mode *mode, int size);       */
104
105 /* The alignment of values of the mode. */
106 int      get_mode_ld_align (ir_mode *mode);
107 /* void  set_mode_ld_align (ir_mode *mode, int ld_align); */
108
109 /* The smallest representable value */
110 tarval  *get_mode_min      (ir_mode *mode);
111 /* void  set_mode_min      (ir_mode *mode, tarval *min); */
112
113 /* The biggest representable value */
114 tarval  *get_mode_max      (ir_mode *mode);
115 /* void  set_mode_max      (ir_mode *mode, tarval *max); */
116
117 /* The value Zero represented in this mode */
118 tarval  *get_mode_null     (ir_mode *mode);
119 /* void  set_mode_null     (ir_mode *mode, tarval *null); */
120
121 /* Returns 1 if mode is signed, else 0. */
122 unsigned get_mode_fsigned  (ir_mode *mode);
123 /* void  set_mode_fsigned  (ir_mode *mode, unsigned fsigned); */
124
125 /* Returns 1 if mode is float, else 0. */
126 unsigned get_mode_ffloat   (ir_mode *mode);
127 /* void  set_mode_ffloat   (ir_mode *mode, unsigned ffloat); */
128
129
130 /* Test for a certain class of modes. */
131 int mode_is_signed (ir_mode *mode);
132 int mode_is_float (ir_mode *mode);
133 int mode_is_int (ir_mode *mode);
134 int mode_is_num (ir_mode *mode);
135 int mode_is_data (ir_mode *mode);
136 int mode_is_datab (ir_mode *mode);
137 int mode_is_dataM (ir_mode *mode);
138
139 /* Returns true if sm can be converted to lm without loss
140    according to firm definiton */
141 bool smaller_mode(ir_mode *sm, ir_mode *lm);
142
143 # endif /* _IRMODE_H_ */