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
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
|
/*
* *****************************************************************************
*
* SPDX-License-Identifier: BSD-2-Clause
*
* Copyright (c) 2018-2023 Gavin D. Howard and contributors.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* *****************************************************************************
*
* The private header for the bc library.
*
*/
#ifndef LIBBC_PRIVATE_H
#define LIBBC_PRIVATE_H
#ifndef _WIN32
#include <pthread.h>
#endif // _WIN32
#include <bcl.h>
#include <num.h>
#include <vm.h>
#if BC_ENABLE_MEMCHECK
/**
* A typedef for Valgrind builds. This is to add a generation index for error
* checking.
*/
typedef struct BclNum
{
/// The number.
BcNum n;
/// The generation index.
size_t gen_idx;
} BclNum;
/**
* Clears the generation byte in a BclNumber and returns the value.
* @param n The BclNumber.
* @return The value of the index.
*/
#define BCL_NO_GEN(n) \
((n).i & ~(((size_t) UCHAR_MAX) << ((sizeof(size_t) - 1) * CHAR_BIT)))
/**
* Gets the generation index in a BclNumber.
* @param n The BclNumber.
* @return The generation index.
*/
#define BCL_GET_GEN(n) ((n).i >> ((sizeof(size_t) - 1) * CHAR_BIT))
/**
* Turns a BclNumber into a BcNum.
* @param c The context.
* @param n The BclNumber.
*/
#define BCL_NUM(c, n) ((BclNum*) bc_vec_item(&(c)->nums, BCL_NO_GEN(n)))
/**
* Clears the generation index top byte in the BclNumber.
* @param n The BclNumber.
*/
#define BCL_CLEAR_GEN(n) \
do \
{ \
(n).i &= ~(((size_t) UCHAR_MAX) << ((sizeof(size_t) - 1) * CHAR_BIT)); \
} \
while (0)
#define BCL_CHECK_NUM_GEN(c, bn) \
do \
{ \
size_t gen_ = BCL_GET_GEN(bn); \
BclNum* ptr_ = BCL_NUM(c, bn); \
if (BCL_NUM_ARRAY(ptr_) == NULL) \
{ \
bcl_nonexistentNum(); \
} \
if (gen_ != ptr_->gen_idx) \
{ \
bcl_invalidGeneration(); \
} \
} \
while (0)
#define BCL_CHECK_NUM_VALID(c, bn) \
do \
{ \
size_t idx_ = BCL_NO_GEN(bn); \
if ((c)->nums.len <= idx_) \
{ \
bcl_numIdxOutOfRange(); \
} \
BCL_CHECK_NUM_GEN(c, bn); \
} \
while (0)
/**
* Returns the limb array of the number.
* @param bn The number.
* @return The limb array.
*/
#define BCL_NUM_ARRAY(bn) ((bn)->n.num)
/**
* Returns the limb array of the number for a non-pointer.
* @param bn The number.
* @return The limb array.
*/
#define BCL_NUM_ARRAY_NP(bn) ((bn).n.num)
/**
* Returns the BcNum pointer.
* @param bn The number.
* @return The BcNum pointer.
*/
#define BCL_NUM_NUM(bn) (&(bn)->n)
/**
* Returns the BcNum pointer for a non-pointer.
* @param bn The number.
* @return The BcNum pointer.
*/
#define BCL_NUM_NUM_NP(bn) (&(bn).n)
// These functions only abort. They exist to give developers some idea of what
// went wrong when bugs are found, if they look at the Valgrind stack trace.
BC_NORETURN void
bcl_invalidGeneration(void);
BC_NORETURN void
bcl_nonexistentNum(void);
BC_NORETURN void
bcl_numIdxOutOfRange(void);
#else // BC_ENABLE_MEMCHECK
/**
* A typedef for non-Valgrind builds.
*/
typedef BcNum BclNum;
#define BCL_NO_GEN(n) ((n).i)
#define BCL_NUM(c, n) ((BclNum*) bc_vec_item(&(c)->nums, (n).i))
#define BCL_CLEAR_GEN(n) ((void) (n))
#define BCL_CHECK_NUM_GEN(c, bn)
#define BCL_CHECK_NUM_VALID(c, n)
#define BCL_NUM_ARRAY(bn) ((bn)->num)
#define BCL_NUM_ARRAY_NP(bn) ((bn).num)
#define BCL_NUM_NUM(bn) (bn)
#define BCL_NUM_NUM_NP(bn) (&(bn))
#endif // BC_ENABLE_MEMCHECK
/**
* A header that sets a jump.
* @param vm The thread data.
* @param l The label to jump to on error.
*/
#define BC_FUNC_HEADER(vm, l) \
do \
{ \
BC_SETJMP(vm, l); \
vm->err = BCL_ERROR_NONE; \
} \
while (0)
/**
* A footer for functions that do not return an error code.
*/
#define BC_FUNC_FOOTER_NO_ERR(vm) \
do \
{ \
BC_UNSETJMP(vm); \
} \
while (0)
/**
* A footer for functions that *do* return an error code.
* @param vm The thread data.
* @param e The error variable to set.
*/
#define BC_FUNC_FOOTER(vm, e) \
do \
{ \
e = vm->err; \
BC_FUNC_FOOTER_NO_ERR(vm); \
} \
while (0)
/**
* A footer that sets up n based the value of e and sets up the return value in
* idx.
* @param c The context.
* @param e The error.
* @param bn The number.
* @param idx The idx to set as the return value.
*/
#define BC_MAYBE_SETUP(c, e, bn, idx) \
do \
{ \
if (BC_ERR((e) != BCL_ERROR_NONE)) \
{ \
if (BCL_NUM_ARRAY_NP(bn) != NULL) bc_num_free(BCL_NUM_NUM_NP(bn)); \
idx.i = 0 - (size_t) (e); \
} \
else idx = bcl_num_insert(c, &(bn)); \
} \
while (0)
/**
* A header to check the context and return an error encoded in a number if it
* is bad.
* @param c The context.
*/
#define BC_CHECK_CTXT(vm, c) \
do \
{ \
c = bcl_contextHelper(vm); \
if (BC_ERR(c == NULL)) \
{ \
BclNumber n_num; \
n_num.i = 0 - (size_t) BCL_ERROR_INVALID_CONTEXT; \
return n_num; \
} \
} \
while (0)
/**
* A header to check the context and return an error directly if it is bad.
* @param c The context.
*/
#define BC_CHECK_CTXT_ERR(vm, c) \
do \
{ \
c = bcl_contextHelper(vm); \
if (BC_ERR(c == NULL)) \
{ \
return BCL_ERROR_INVALID_CONTEXT; \
} \
} \
while (0)
/**
* A header to check the context and abort if it is bad.
* @param c The context.
*/
#define BC_CHECK_CTXT_ASSERT(vm, c) \
do \
{ \
c = bcl_contextHelper(vm); \
assert(c != NULL); \
} \
while (0)
/**
* A header to check the number in the context and return an error encoded as a
* @param c The context.
* number if it is bad.
* @param n The BclNumber.
*/
#define BC_CHECK_NUM(c, n) \
do \
{ \
size_t no_gen_ = BCL_NO_GEN(n); \
if (BC_ERR(no_gen_ >= (c)->nums.len)) \
{ \
if ((n).i > 0 - (size_t) BCL_ERROR_NELEMS) return (n); \
else \
{ \
BclNumber n_num_; \
n_num_.i = 0 - (size_t) BCL_ERROR_INVALID_NUM; \
return n_num_; \
} \
} \
BCL_CHECK_NUM_GEN(c, n); \
} \
while (0)
//clang-format off
/**
* A header to check the number in the context and return an error directly if
* it is bad.
* @param c The context.
* @param n The BclNumber.
*/
#define BC_CHECK_NUM_ERR(c, n) \
do \
{ \
size_t no_gen_ = BCL_NO_GEN(n); \
if (BC_ERR(no_gen_ >= (c)->nums.len)) \
{ \
if ((n).i > 0 - (size_t) BCL_ERROR_NELEMS) \
{ \
return (BclError) (0 - (n).i); \
} \
else return BCL_ERROR_INVALID_NUM; \
} \
BCL_CHECK_NUM_GEN(c, n); \
} \
while (0)
//clang-format on
/**
* Grows the context's nums array if necessary.
* @param c The context.
*/
#define BCL_GROW_NUMS(c) \
do \
{ \
if ((c)->free_nums.len == 0) \
{ \
bc_vec_grow(&((c)->nums), 1); \
} \
} \
while (0)
/**
* Frees a BcNum for bcl. This is a destructor.
* @param num The BcNum to free, as a void pointer.
*/
void
bcl_num_destruct(void* num);
/// The actual context struct.
typedef struct BclCtxt
{
/// The context's scale.
size_t scale;
/// The context's ibase.
size_t ibase;
/// The context's obase.
size_t obase;
/// A vector of BcNum numbers.
BcVec nums;
/// A vector of BclNumbers. These are the indices in nums that are currently
/// not used (because they were freed).
BcVec free_nums;
} BclCtxt;
/**
* Returns the @a BcVm for the current thread.
* @return The vm for the current thread.
*/
BcVm*
bcl_getspecific(void);
#ifndef _WIN32
typedef pthread_key_t BclTls;
#else // _WIN32
typedef DWORD BclTls;
#endif // _WIN32
#endif // LIBBC_PRIVATE_H
|
