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