Initial revision
[libfirm] / ir / tv / tv.h
1 /* Declarations for Target Values.
2    Copyright (C) 1995, 1996 Christian von Roques */
3
4 #ifndef _TV_H
5 #define _TV_H
6
7 # include "irmode.h"
8 # include "entity.h"
9 # include "label.h"
10 # include "xprintf.h"
11
12 typedef struct tarval tarval;
13
14 #include <gmp.h>
15 #undef __need_size_t            /* erroneously defined by 1.3.2's gmp.h */
16 /* #include "deftab.h" */
17
18 /* how to represent target types on host */
19 typedef float tarval_f;
20 typedef double tarval_d;
21 typedef long tarval_chil;
22 typedef unsigned long tarval_CHIL;
23 typedef MP_INT tarval_Z;
24 typedef struct {
25   /* if ent then xname is missing or mangled from ent,
26      else if xname then xname is a linker symbol that is not mangled
27        from an entity,
28      else this is tarval_p_void.
29      if this tarval describes a symbolic address of another tarval, tv points
30      to this val */
31   const char *xname;
32   entity *ent;
33   tarval *tv;
34 } tarval_p;
35 typedef struct {
36   unsigned char *p;             /* may contain embedded 0, not 0-terminated */
37   size_t n;
38 } tarval_s;
39 typedef tarval_s tarval_B;
40
41 struct tarval {
42   union {
43     tarval_f f;                 /* float */
44     tarval_d d;                 /* double */
45     tarval_chil chil;           /* signed integral */
46     tarval_CHIL CHIL;           /* unsigned integral */
47     tarval_Z Z;                 /* universal int */
48     tarval_p p;                 /* pointer */
49     bool b;                     /* boolean */
50     tarval_B B;                 /* universal bits */
51     tarval_s s;                 /* string */
52   } u;
53   label lab;                    /* value's label in the constant segment */
54   ir_mode *mode;
55   bool used;                    /* labeled tv is used (default) */
56 };
57
58 extern tarval *tarval_bad;
59 extern tarval *tarval_b_false;
60 extern tarval *tarval_b_true;
61 extern tarval *tarval_d_NaN;
62 extern tarval *tarval_d_Inf;
63 extern tarval *tarval_p_void;
64 extern tarval *tarval_mode_null[];
65 extern tarval *tarval_mode_min[];
66 extern tarval *tarval_mode_max[];
67
68 void tarval_init_1 (void);
69 void tarval_init_2 (void);
70
71 /* Hash function on tarvals */
72 unsigned tarval_hash (tarval *);
73
74 /************************* Constructors for tarvals *************************/
75 tarval *tarval_Z_from_str (const char *, size_t, int base);
76 tarval *tarval_B_from_str (const char *, size_t);
77 tarval *tarval_d_from_str (const char *, size_t);
78 tarval *tarval_s_from_str (const char *, size_t);
79 tarval *tarval_S_from_str (const char *, size_t);
80 tarval *tarval_from_long (ir_mode *, long);
81 tarval *tarval_p_from_str (const char *);
82 tarval *tarval_p_from_entity (entity *);
83
84 tarval *tarval_convert_to (tarval *, ir_mode *);
85
86 /* Building an irm_C, irm_s, irm_S or irm_B target value step by step. */
87 void tarval_start (void);
88 void tarval_append (const char *, size_t);
89 void tarval_append1 (char);
90 tarval *tarval_finish_as (ir_mode *);
91 tarval *tarval_cancel (void); /* returns tarval_bad */
92
93 \f
94 /* The flags for projecting a comparison result */
95 typedef enum {
96   irpn_False=0,         /* false */
97   irpn_Eq,              /* equal */
98   irpn_Lt,              /* less */
99   irpn_Le,              /* less or equal */
100   irpn_Gt,              /* greater */
101   irpn_Ge,              /* greater of equal */
102   irpn_Lg,              /* less or greater */
103   irpn_Leg,             /* less, equal or greater = ordered */
104   irpn_Uo,              /* unordered */
105   irpn_Ue,              /* unordered or equal */
106   irpn_Ul,              /* unordered or less */
107   irpn_Ule,             /* unordered, less or equal */
108   irpn_Ug,              /* unordered or greater */
109   irpn_Uge,             /* unordered, greater or equal */
110   irpn_Ne,              /* unordered, less or greater = not equal */
111   irpn_True,            /* true */
112   irpn_notmask = irpn_Leg
113 } ir_pncmp;
114
115 /********************* Arithmethic operations on tarvals *********************/
116 /* Compare a with b and return an ir_pncmp describing the relation
117    between a and b.  This is either Uo, Lt, Eq, Gt, or False if a or b
118    are symbolic pointers which can not be compared at all. */
119 ir_pncmp tarval_comp (tarval *a, tarval *b);
120
121 tarval *tarval_neg (tarval *a);
122 tarval *tarval_add (tarval *, tarval *);
123 tarval *tarval_sub (tarval *, tarval *);
124 tarval *tarval_mul (tarval *, tarval *);
125 tarval *tarval_quo (tarval *, tarval *);
126 tarval *tarval_div (tarval *, tarval *);
127 tarval *tarval_mod (tarval *, tarval *);
128 tarval *tarval_and (tarval *, tarval *);
129 tarval *tarval_or  (tarval *, tarval *);
130 tarval *tarval_eor (tarval *, tarval *);
131 tarval *tarval_shl (tarval *, tarval *);
132 tarval *tarval_shr (tarval *, tarval *);
133
134 /* Identifying some tarvals */
135 long tarval_classify (tarval *);
136 long tarval_ord (tarval *, int *fail);
137
138 int tarval_print (XP_PAR1, const xprintf_info *, XP_PARN);
139
140
141      /* Labeling of tarvals */
142 label tarval_label (tarval *);
143 void tarval_forall_labeled (int (*) (tarval *, void *), void *);
144
145
146 /* return a mode-specific value */
147
148 tarval_f tv_val_f (tarval *tv);
149 tarval_d tv_val_d (tarval *tv);
150 tarval_chil tv_val_chil (tarval *tv);
151 tarval_CHIL tv_val_CHIL (tarval *tv);
152 tarval_Z tv_val_Z (tarval *tv);
153 tarval_p tv_val_p (tarval *tv);
154 bool tv_val_b (tarval *tv);
155 tarval_B tv_val_B (tarval *tv);
156 tarval_s tv_val_s (tarval *tv);
157
158 #ifdef NDEBUG
159 #define TARVAL_VRFY(val) ((void)0)
160 #else
161 #define TARVAL_VRFY(val) _tarval_vrfy ((val))
162 extern void _tarval_vrfy (const tarval *);
163 #endif
164
165 #ifdef STATS
166 void tarval_stats (void);
167 #else
168 #define tarval_stats() ((void)0)
169 #endif
170
171 ir_mode *get_tv_mode (tarval *tv);
172
173 #endif