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