1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
|
#ifndef __SAIL_LIB
#define __SAIL_LIB
#include <stddef.h>
#include <stdint.h>
#include <stdbool.h>
void *sail_malloc(size_t);
void sail_free(void *);
void sail_match_failure(char *message);
/*
* The Sail compiler expects functions to follow a specific naming
* convention for allocation, deallocation, and (deep)-copying. These
* macros implement this naming convention.
*/
#define CREATE(type) create_ ## type
#define RECREATE(type) recreate_ ## type
#define CREATE_OF(type1, type2) create_ ## type1 ## _of_ ## type2
#define RECREATE_OF(type1, type2) recreate_ ## type1 ## _of_ ## type2
#define CONVERT_OF(type1, type2) convert_ ## type1 ## _of_ ## type2
#define COPY(type) copy_ ## type
#define KILL(type) kill_ ## type
#define UNDEFINED(type) undefined_ ## type
#define EQUAL(type) eq_ ## type
#define SAIL_BUILTIN_TYPE(type)\
void create_ ## type(type *);\
void recreate_ ## type(type *);\
void copy_ ## type(type *, const type);\
void kill_ ## type(type *);
/* ***** Sail unit type ***** */
typedef int unit;
#define UNIT 0
unit UNDEFINED(unit)(const unit);
bool EQUAL(unit)(const unit, const unit);
unit skip(const unit);
unit sail_exit(const unit);
/* ***** Sail booleans ***** */
/*
* and_bool and or_bool are special-cased by the compiler to ensure
* short-circuiting evaluation.
*/
bool not(const bool);
bool EQUAL(bool)(const bool, const bool);
bool UNDEFINED(bool)(const unit);
/* ***** Sail strings ***** */
/*
* Sail strings are just C strings.
*/
typedef char *sail_string;
SAIL_BUILTIN_TYPE(sail_string);
void undefined_string(sail_string *str, const unit u);
bool eq_string(const sail_string, const sail_string);
bool EQUAL(sail_string)(const sail_string, const sail_string);
void concat_str(sail_string *stro, const sail_string str1, const sail_string str2);
bool string_startswith(sail_string s, sail_string prefix);
unit sail_assert(bool, sail_string);
/* ***** Sail integers ***** */
typedef int64_t mach_int;
bool EQUAL(mach_int)(const mach_int, const mach_int);
typedef __int128 sail_int;
uint64_t sail_int_get_ui(const sail_int);
void dec_str(sail_string *str, const sail_int n);
void hex_str(sail_string *str, const sail_int n);
#define SAIL_INT_FUNCTION(fname, rtype, ...) rtype fname(__VA_ARGS__)
// SAIL_BUILTIN_TYPE(sail_int);
sail_int CREATE_OF(sail_int, mach_int)(const mach_int);
mach_int CREATE_OF(mach_int, sail_int)(const sail_int);
mach_int CONVERT_OF(mach_int, sail_int)(const sail_int);
sail_int CONVERT_OF(sail_int, mach_int)(const mach_int);
sail_int CONVERT_OF(sail_int, sail_string)(const sail_string);
/*
* Comparison operators for integers
*/
bool eq_int(const sail_int, const sail_int);
bool EQUAL(sail_int)(const sail_int, const sail_int);
bool lt(const sail_int, const sail_int);
bool gt(const sail_int, const sail_int);
bool lteq(const sail_int, const sail_int);
bool gteq(const sail_int, const sail_int);
/*
* Left and right shift for integers
*/
mach_int shl_mach_int(const mach_int, const mach_int);
mach_int shr_mach_int(const mach_int, const mach_int);
SAIL_INT_FUNCTION(shl_int, sail_int, const sail_int, const sail_int);
SAIL_INT_FUNCTION(shr_int, sail_int, const sail_int, const sail_int);
/*
* undefined_int and undefined_range can't use the UNDEFINED(TYPE)
* macro, because they're slightly magical. They take extra parameters
* to ensure that no undefined int can violate any type-guaranteed
* constraints.
*/
SAIL_INT_FUNCTION(undefined_int, sail_int, const int);
SAIL_INT_FUNCTION(undefined_range, sail_int, const sail_int, const sail_int);
/*
* Arithmetic operations in integers. We include functions for both
* truncating towards zero, and rounding towards -infinity (floor) as
* fdiv/fmod and tdiv/tmod respectively.
*/
SAIL_INT_FUNCTION(add_int, sail_int, const sail_int, const sail_int);
SAIL_INT_FUNCTION(sub_int, sail_int, const sail_int, const sail_int);
SAIL_INT_FUNCTION(sub_nat, sail_int, const sail_int, const sail_int);
SAIL_INT_FUNCTION(mult_int, sail_int, const sail_int, const sail_int);
SAIL_INT_FUNCTION(ediv_int, sail_int, const sail_int, const sail_int);
SAIL_INT_FUNCTION(emod_int, sail_int, const sail_int, const sail_int);
SAIL_INT_FUNCTION(tdiv_int, sail_int, const sail_int, const sail_int);
SAIL_INT_FUNCTION(tmod_int, sail_int, const sail_int, const sail_int);
//SAIL_INT_FUNCTION(fdiv_int, sail_int, const sail_int, const sail_int);
//SAIL_INT_FUNCTION(fmod_int, sail_int, const sail_int, const sail_int);
SAIL_INT_FUNCTION(max_int, sail_int, const sail_int, const sail_int);
SAIL_INT_FUNCTION(min_int, sail_int, const sail_int, const sail_int);
SAIL_INT_FUNCTION(neg_int, sail_int, const sail_int);
SAIL_INT_FUNCTION(abs_int, sail_int, const sail_int);
SAIL_INT_FUNCTION(pow_int, sail_int, const sail_int, const sail_int);
SAIL_INT_FUNCTION(pow2, sail_int, const sail_int);
SAIL_INT_FUNCTION(make_the_value, sail_int, const sail_int);
SAIL_INT_FUNCTION(size_itself_int, sail_int, const sail_int);
/* ***** Sail bitvectors ***** */
typedef uint64_t fbits;
bool eq_bit(const fbits a, const fbits b);
bool EQUAL(fbits)(const fbits, const fbits);
typedef struct {
uint64_t len;
uint64_t bits;
} sbits;
// For backwards compatability
typedef uint64_t mach_bits;
typedef sbits lbits;
lbits append_64(const lbits, const uint64_t);
lbits add_bits_int(const lbits, const sail_int);
lbits sub_bits_int(const lbits, const sail_int);
lbits UNDEFINED(lbits)(bool);
lbits vector_subrange_lbits(const lbits, const sail_int, const sail_int);
lbits vector_update_subrange_lbits(const lbits, const sail_int, const sail_int, const lbits);
lbits slice(const lbits, const sail_int, const sail_int);
lbits set_slice(const sail_int, const sail_int, const lbits, const sail_int, const lbits);
lbits get_slice_int(const sail_int, const sail_int, const sail_int);
lbits zeros(const sail_int);
lbits zero_extend(const lbits, const sail_int);
bool eq_bits(const lbits, const lbits);
bool neq_bits(const lbits, const lbits);
lbits not_bits(const lbits);
lbits xor_bits(const lbits, const lbits);
lbits or_bits(const lbits, const lbits);
lbits and_bits(const lbits, const lbits);
lbits add_bits(const lbits, const lbits);
lbits sub_bits(const lbits, const lbits);
lbits append(const lbits, const lbits);
lbits replicate_bits(const lbits, const sail_int);
sbits CREATE_OF(sbits, lbits)(const lbits op, const bool direction);
fbits CREATE_OF(fbits, lbits)(const lbits op, const bool direction);
sbits CREATE_OF(sbits, fbits)(const fbits op, const uint64_t len, const bool direction);
/* Bitvector conversions */
lbits CONVERT_OF(lbits, fbits)(const fbits, const uint64_t, const bool);
lbits CONVERT_OF(lbits, sbits)(const sbits, const bool);
fbits CONVERT_OF(fbits, lbits)(const lbits, const bool);
fbits CONVERT_OF(fbits, sbits)(const sbits, const bool);
sbits CONVERT_OF(sbits, fbits)(const fbits, const uint64_t, const bool);
sbits CONVERT_OF(sbits, lbits)(const lbits, const bool);
fbits UNDEFINED(fbits)(const unit);
sbits undefined_sbits(void);
/*
* Wrapper around >> operator to avoid UB when shift amount is greater
* than or equal to 64.
*/
fbits safe_rshift(const fbits, const fbits);
fbits fast_zero_extend(const sbits op, const uint64_t n);
fbits fast_sign_extend(const fbits op, const uint64_t n, const uint64_t m);
fbits fast_sign_extend2(const sbits op, const uint64_t m);
sail_int length_lbits(const lbits op);
bool eq_bits(const lbits op1, const lbits op2);
bool EQUAL(lbits)(const lbits op1, const lbits op2);
bool neq_bits(const lbits op1, const lbits op2);
fbits bitvector_access(const lbits op, const sail_int n_mpz);
sail_int sail_unsigned(const lbits op);
sail_int sail_signed(const lbits op);
mach_int fast_signed(const fbits, const uint64_t);
mach_int fast_unsigned(const fbits);
sbits append_sf(const sbits, const fbits, const uint64_t);
sbits append_fs(const fbits, const uint64_t, const sbits);
sbits append_ss(const sbits, const sbits);
fbits fast_replicate_bits(const fbits shift, const fbits v, const mach_int times);
sail_int set_slice_int(const sail_int, const sail_int, const sail_int, const lbits);
fbits fast_update_subrange(const fbits op,
const mach_int n,
const mach_int m,
const fbits slice);
sbits sslice(const fbits op, const mach_int start, const mach_int len);
bool eq_sbits(const sbits op1, const sbits op2);
bool neq_sbits(const sbits op1, const sbits op2);
sbits not_sbits(const sbits op);
sbits xor_sbits(const sbits op1, const sbits op2);
sbits or_sbits(const sbits op1, const sbits op2);
sbits and_sbits(const sbits op1, const sbits op2);
sbits add_sbits(const sbits op1, const sbits op2);
sbits sub_sbits(const sbits op1, const sbits op2);
/* ***** Sail reals ***** */
typedef double real;
SAIL_BUILTIN_TYPE(real);
void CREATE_OF(real, sail_string)(real *rop, const sail_string op);
void CONVERT_OF(real, sail_string)(real *rop, const sail_string op);
void UNDEFINED(real)(real *rop, unit u);
void neg_real(real *rop, const real op);
void mult_real(real *rop, const real op1, const real op2);
void sub_real(real *rop, const real op1, const real op2);
void add_real(real *rop, const real op1, const real op2);
void div_real(real *rop, const real op1, const real op2);
void sqrt_real(real *rop, const real op);
void abs_real(real *rop, const real op);
SAIL_INT_FUNCTION(round_up, sail_int, const real);
SAIL_INT_FUNCTION(round_down, sail_int, const real);
void to_real(real *rop, const sail_int op);
bool EQUAL(real)(const real op1, const real op2);
bool lt_real(const real op1, const real op2);
bool gt_real(const real op1, const real op2);
bool lteq_real(const real op1, const real op2);
bool gteq_real(const real op1, const real op2);
void real_power(real *rop, const real base, const sail_int exp);
unit print_real(const sail_string, const real);
unit prerr_real(const sail_string, const real);
void random_real(real *rop, unit);
/* ***** String utilities ***** */
SAIL_INT_FUNCTION(string_length, sail_int, sail_string);
void string_drop(sail_string *dst, sail_string s, sail_int len);
void string_take(sail_string *dst, sail_string s, sail_int len);
/* ***** Printing ***** */
void string_of_int(sail_string *str, const sail_int i);
void string_of_lbits(sail_string *str, const lbits op);
void string_of_fbits(sail_string *str, const fbits op);
void decimal_string_of_lbits(sail_string *str, const lbits op);
void decimal_string_of_fbits(sail_string *str, const fbits op);
unit print_bits(const sail_string str, const lbits op);
unit prerr_bits(const sail_string str, const lbits op);
unit print(const sail_string str);
unit print_endline(const sail_string str);
unit prerr(const sail_string str);
unit prerr_endline(const sail_string str);
unit print_int(const sail_string str, const sail_int op);
unit prerr_int(const sail_string str, const sail_int op);
unit sail_putchar(const sail_int op);
/* ***** Misc ***** */
sail_int get_time_ns(const unit);
#endif
|
