• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

nickg / nvc / 14464368876

15 Apr 2025 08:00AM UTC coverage: 92.312% (+0.003%) from 92.309%
14464368876

push

github

nickg
Locally static evaluation should not initialise user packages

9 of 9 new or added lines in 2 files covered. (100.0%)

177 existing lines in 4 files now uncovered.

69015 of 74763 relevant lines covered (92.31%)

420122.37 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

87.35
/src/eval.c
1
//
2
//  Copyright (C) 2013-2023  Nick Gasson
3
//
4
//  This program is free software: you can redistribute it and/or modify
5
//  it under the terms of the GNU General Public License as published by
6
//  the Free Software Foundation, either version 3 of the License, or
7
//  (at your option) any later version.
8
//
9
//  This program is distributed in the hope that it will be useful,
10
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
11
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12
//  GNU General Public License for more details.
13
//
14
//  You should have received a copy of the GNU General Public License
15
//  along with this program.  If not, see <http://www.gnu.org/licenses/>.
16
//
17

18
#include "util.h"
19
#include "common.h"
20
#include "diag.h"
21
#include "eval.h"
22
#include "hash.h"
23
#include "ident.h"
24
#include "jit/jit.h"
25
#include "jit/jit-ffi.h"
26
#include "lib.h"
27
#include "lower.h"
28
#include "option.h"
29
#include "phase.h"
30
#include "tree.h"
31
#include "type.h"
32
#include "vcode.h"
33

34
#include <assert.h>
35
#include <stdint.h>
36
#include <stdlib.h>
37
#include <stdarg.h>
38
#include <inttypes.h>
39
#include <string.h>
40

41
static const char *eval_expr_name(tree_t expr)
×
42
{
43
   const tree_kind_t kind = tree_kind(expr);
×
44
   if (kind == T_FCALL)
×
45
      return istr(tree_ident(expr));
×
46
   else
47
      return tree_kind_str(kind);
×
48
}
49

50
static tree_t eval_value_to_tree(jit_scalar_t value, type_t type,
11,467✔
51
                                 const loc_t *loc)
52
{
53
   tree_t tree = NULL;
11,467✔
54

55
   if (type_is_enum(type)) {
11,467✔
56
      type_t base = type_base_recur(type);
2,878✔
57
      if ((unsigned)value.integer >= type_enum_literals(base))
2,878✔
58
         fatal_at(loc, "enum position %"PRIi64" out of range for type %s",
×
59
                  value.integer, type_pp(base));
60

61
      tree_t lit = type_enum_literal(base, value.integer);
2,878✔
62

63
      tree = tree_new(T_REF);
2,878✔
64
      tree_set_ref(tree, lit);
2,878✔
65
      tree_set_ident(tree, tree_ident(lit));
2,878✔
66
   }
67
   else if (type_is_integer(type)) {
8,589✔
68
      tree = tree_new(T_LITERAL);
2,347✔
69
      tree_set_subkind(tree, L_INT);
2,347✔
70
      tree_set_ival(tree, value.integer);
2,347✔
71
   }
72
   else if (type_is_real(type)) {
6,242✔
73
      tree = tree_new(T_LITERAL);
6,123✔
74
      tree_set_subkind(tree, L_REAL);
6,123✔
75
      tree_set_dval(tree, value.real);
6,123✔
76
   }
77
   else if (type_is_physical(type)) {
119✔
78
      tree = tree_new(T_LITERAL);
119✔
79
      tree_set_subkind(tree, L_PHYSICAL);
119✔
80
      tree_set_ival(tree, value.integer);
119✔
81
   }
82
   else
83
      fatal_trace("cannot convert 0x%"PRIx64" to %s", value.integer,
84
                  type_pp(type));
85

86
   tree_set_type(tree, type);
11,467✔
87
   tree_set_loc(tree, loc);
11,467✔
88
   return tree;
11,467✔
89
}
90

91
static void *thunk_result_cb(jit_scalar_t *args, void *user)
11,653✔
92
{
93
   tree_t expr = user;
11,653✔
94
   type_t type = tree_type(expr);
11,653✔
95
   const loc_t *loc = tree_loc(expr);
11,653✔
96

97
   if (type_is_array(type)) {
11,653✔
98
      assert(dimension_of(type) == 1);
198✔
99

100
      type_t elem = type_elem(type);
198✔
101
      assert(type_is_scalar(elem));
198✔
102

103
      type_t base = type_base_recur(elem);
198✔
104

105
      bool all_chars = true;
198✔
106
      tree_t *lits LOCAL = NULL;
396✔
107
      if (type_is_enum(elem)) {
198✔
108
         const int nlits = type_enum_literals(base);
193✔
109
         lits = xcalloc_array(nlits, sizeof(tree_t));
193✔
110
      }
111
      else
112
         all_chars = false;
113

114
      range_kind_t dir;
198✔
115
      int64_t length, ileft, iright;
198✔
116
      if (!type_const_bounds(type)) {
198✔
117
         length = ffi_array_length(args[2].integer);
197✔
118
         dir = ffi_array_dir(args[2].integer);
197✔
119
         ileft = args[1].integer;
197✔
120
         iright = ffi_array_right(args[1].integer, args[2].integer);
296✔
121
      }
122
      else {
123
         tree_t r = range_of(type, 0);
1✔
124
         if (!folded_length(r, &length))
1✔
125
            fatal_at(loc, "cannot determine static length of array");
×
126

127
         dir = tree_subkind(r);
1✔
128
         ileft = assume_int(tree_left(r));
1✔
129
         iright = assume_int(tree_right(r));
1✔
130
      }
131

132
      const int bytes = (type_bit_width(elem) + 7) / 8;
198✔
133
      tree_t *elts LOCAL = xmalloc_array(length, sizeof(tree_t));
396✔
134
      for (int i = 0; i < length; i++) {
2,384✔
135
#define UNPACK_VALUE(type) do {                                    \
136
            value.integer = ((type *)args[0].pointer)[i];          \
137
         } while (0);
138

139
         jit_scalar_t value = { .integer = 0 };
2,186✔
140
         FOR_ALL_SIZES(bytes, UNPACK_VALUE);
2,186✔
141

142
         if (lits != NULL) {
2,186✔
143
            assert(value.integer >= 0);
2,174✔
144

145
            if (lits[value.integer] == NULL) {
2,174✔
146
               tree_t li = type_enum_literal(base, value.integer);
365✔
147
               lits[value.integer] = make_ref(li);
365✔
148
               all_chars &= ident_char(tree_ident(li), 0) == '\'';
365✔
149
            }
150

151
            elts[i] = lits[value.integer];
2,174✔
152
         }
153
         else
154
            elts[i] = eval_value_to_tree(value, elem, loc);
12✔
155
      }
156

157
      type_t sub = type_new(T_SUBTYPE);
198✔
158
      type_set_base(sub, type);
198✔
159

160
      type_t index_type = index_type_of(type, 0);
198✔
161

162
      tree_t left = NULL, right = NULL;
198✔
163
      if (type_is_enum(index_type)) {
198✔
164
         left = get_enum_lit(expr, index_type, ileft);
×
165
         right = get_enum_lit(expr, index_type, iright);
×
166
      }
167
      else {
168
         left = get_int_lit(expr, index_type, ileft);
198✔
169
         right = get_int_lit(expr, index_type, iright);
198✔
170
      }
171

172
      tree_t r = tree_new(T_RANGE);
198✔
173
      tree_set_subkind(r, dir);
198✔
174
      tree_set_left(r, left);
198✔
175
      tree_set_right(r, right);
198✔
176
      tree_set_loc(r, loc);
198✔
177
      tree_set_type(r, index_type);
198✔
178

179
      tree_t c = tree_new(T_CONSTRAINT);
198✔
180
      tree_set_subkind(c, C_INDEX);
198✔
181
      tree_add_range(c, r);
198✔
182
      tree_set_loc(c, loc);
198✔
183

184
      type_set_constraint(sub, c);
198✔
185

186
      if (all_chars) {
198✔
187
         tree_t tree = tree_new(T_STRING);
192✔
188

189
         for (int i = 0; i < length; i++)
2,364✔
190
            tree_add_char(tree, elts[i]);
2,172✔
191

192
         tree_set_loc(tree, loc);
192✔
193
         tree_set_type(tree, sub);
192✔
194
         return tree;
192✔
195
      }
196
      else {
197
         tree_t tree = tree_new(T_AGGREGATE);
6✔
198
         tree_set_type(tree, sub);
6✔
199
         tree_set_loc(tree, loc);
6✔
200

201
         for (int i = 0; i < length; i++) {
20✔
202
            tree_t a = tree_new(T_ASSOC);
14✔
203
            tree_set_loc(a, loc);
14✔
204
            tree_set_subkind(a, A_POS);
14✔
205
            tree_set_pos(a, i);
14✔
206
            tree_set_value(a, elts[i]);
14✔
207

208
            tree_add_assoc(tree, a);
14✔
209
         }
210

211
         return tree;
212
      }
213
   }
214
   else
215
      return eval_value_to_tree(args[0], tree_type(expr), tree_loc(expr));
11,455✔
216
}
217

218
static tree_t eval_do_fold(jit_t *jit, tree_t expr, lower_unit_t *parent,
12,379✔
219
                           unit_registry_t *registry, void *context)
220
{
221
   vcode_unit_t thunk;
12,379✔
222
   if (parent != NULL)
12,379✔
223
      thunk = lower_thunk_in_context(registry, expr, parent);
907✔
224
   else
225
      thunk = lower_global_thunk(registry, expr);
11,472✔
226

227
   if (thunk == NULL)
12,379✔
228
      return expr;
229

230
   const bool verbose = opt_get_verbose(OPT_EVAL_VERBOSE, NULL);
12,077✔
231

232
   tree_t result = jit_call_thunk(jit, thunk, context, thunk_result_cb, expr);
12,077✔
233

234
   vcode_unit_unref(thunk);
12,073✔
235
   thunk = NULL;
12,073✔
236

237
   if (result != NULL) {
12,073✔
238
      if (verbose) {
11,653✔
UNCOV
239
         LOCAL_TEXT_BUF tb = tb_new();
×
240
         capture_syntax(tb);
×
UNCOV
241
         dump(result);
×
UNCOV
242
         capture_syntax(NULL);
×
UNCOV
243
         tb_strip(tb);
×
244

UNCOV
245
         debugf("evaluating %s returned %s", eval_expr_name(expr), tb_get(tb));
×
246
      }
247

248
      return result;
11,653✔
249
   }
250
   else if (verbose) {
420✔
UNCOV
251
      diag_t *d = diag_new(DIAG_DEBUG, tree_loc(expr));
×
UNCOV
252
      diag_printf(d, "failed to evaluate %s", eval_expr_name(expr));
×
UNCOV
253
      diag_emit(d);
×
254
   }
255

256
   return expr;
257
}
258

259
tree_t eval_try_fold(jit_t *jit, tree_t expr, unit_registry_t *registry,
12,254✔
260
                     lower_unit_t *parent, void *context)
261
{
262
   const bool verbose = opt_get_verbose(OPT_EVAL_VERBOSE, NULL);
12,254✔
263
   jit_set_silent(jit, !verbose);
12,254✔
264

265
   tree_t result = eval_do_fold(jit, expr, parent, registry, context);
12,254✔
266

267
   jit_set_silent(jit, false);
12,250✔
268
   jit_reset_exit_status(jit);
12,250✔
269

270
   return result;
12,250✔
271
}
272

273
tree_t eval_must_fold(jit_t *jit, tree_t expr, unit_registry_t *registry,
125✔
274
                      lower_unit_t *parent, void *context)
275
{
276
   return eval_do_fold(jit, expr, parent, registry, context);
125✔
277
}
278

279
static bool eval_not_possible(tree_t t, const char *why)
10,659✔
280
{
281
   if (opt_get_verbose(OPT_EVAL_VERBOSE, NULL))
10,659✔
UNCOV
282
      warn_at(tree_loc(t), "%s prevents constant folding", why);
×
283

284
   return false;
10,659✔
285
}
286

287
bool eval_possible(tree_t t, unit_registry_t *ur, mir_context_t *mc)
64,331✔
288
{
289
   switch (tree_kind(t)) {
73,660✔
290
   case T_FCALL:
23,653✔
291
      {
292
         const tree_flags_t flags = tree_flags(t);
23,653✔
293
         if (!(flags & (TREE_F_LOCALLY_STATIC | TREE_F_GLOBALLY_STATIC)))
23,653✔
294
            return eval_not_possible(t, "non-static expression");
64✔
295

296
         tree_t decl = tree_ref(t);
23,589✔
297
         const subprogram_kind_t kind = tree_subkind(decl);
23,589✔
298
         if (tree_flags(decl) & TREE_F_IMPURE)
23,589✔
UNCOV
299
            return eval_not_possible(t, "call to impure function");
×
300
         else if (kind != S_USER && !is_open_coded_builtin(kind)
23,589✔
301
                  && unit_registry_get(ur, tree_ident2(decl)) == NULL
4,158✔
302
                  && mir_get_unit(mc, tree_ident2(decl)) == NULL)
207✔
303
            return eval_not_possible(t, "not yet lowered predef");
162✔
304
         else if (kind == S_USER && !is_package(tree_container(decl)))
23,427✔
305
            return eval_not_possible(t, "subprogram not in package");
835✔
306

307
         const int nparams = tree_params(t);
22,592✔
308
         for (int i = 0; i < nparams; i++) {
38,343✔
309
            tree_t p = tree_value(tree_param(t, i));
27,729✔
310
            if (!eval_possible(p, ur, mc))
27,729✔
311
               return false;
312
            else if (tree_kind(p) == T_FCALL && type_is_scalar(tree_type(p)))
15,887✔
313
               return false;  // Would have been folded already if possible
314
         }
315

316
         return true;
317
      }
318

319
   case T_LITERAL:
320
   case T_STRING:
321
   case T_OPEN:
322
      return true;
323

324
   case T_TYPE_CONV:
7,060✔
325
   case T_QUALIFIED:
326
      {
327
         tree_t value = tree_value(t);
7,060✔
328
         if (tree_kind(value) == T_FCALL)
7,060✔
329
            return false;   // Would have been folded already if possible
330

331
         return eval_possible(value, ur, mc);
332
      }
333

334
   case T_REF:
19,331✔
335
      {
336
         tree_t decl = tree_ref(t);
19,331✔
337
         switch (tree_kind(decl)) {
19,331✔
338
         case T_UNIT_DECL:
339
         case T_ENUM_LIT:
340
            return true;
341

342
         case T_CONST_DECL:
2,008✔
343
            if (tree_has_value(decl))
2,008✔
344
               return eval_possible(tree_value(decl), ur, mc);
1,987✔
345
            else
346
               return false;
347

348
         default:
9,376✔
349
            return eval_not_possible(t, "reference");
9,376✔
350
         }
351
      }
352

353
   case T_RECORD_REF:
397✔
354
      return eval_possible(tree_value(t), ur, mc);
397✔
355

356
   case T_ARRAY_REF:
969✔
357
      {
358
         const int nparams = tree_params(t);
969✔
359
         for (int i = 0; i < nparams; i++) {
1,898✔
360
            if (!eval_possible(tree_value(tree_param(t, i)), ur, mc))
1,004✔
361
               return false;
362
         }
363

364
         return eval_possible(tree_value(t), ur, mc);
894✔
365
      }
366

367
   case T_AGGREGATE:
1,694✔
368
      {
369
         const int nassocs = tree_assocs(t);
1,694✔
370
         for (int i = 0; i < nassocs; i++) {
10,601✔
371
            if (!eval_possible(tree_value(tree_assoc(t, i)), ur, mc))
8,940✔
372
               return false;
373
         }
374

375
         // Check for missing choices in constrained array aggregates
376
         type_t composite_type = tree_type(t);
1,661✔
377
         if (type_is_array(composite_type)
1,661✔
378
             && !type_is_unconstrained(composite_type)) {
1,563✔
379
            int64_t count = 0, elem_count = 0;
1,541✔
380
            bool known_elem_count = false;
1,541✔
381
            bool has_others = false;
1,541✔
382
            bool has_range = false;
1,541✔
383
            for (int i = 0; i < nassocs; i++) {
10,128✔
384
               tree_t a = tree_assoc(t, i);
8,587✔
385
               const assoc_kind_t akind = tree_subkind(a);
8,587✔
386

387
               switch (akind) {
8,587✔
388

389
               case A_NAMED:
8,486✔
390
               case A_POS:
391
                  known_elem_count = true;
8,486✔
392
                  elem_count = 1;
8,486✔
393
                  break;
8,486✔
394

395
               case A_RANGE:
53✔
396
                  known_elem_count = false;
53✔
397
                  has_range = true;
53✔
398
                  break;
53✔
399

400
               case A_OTHERS:
42✔
401
                  known_elem_count = false;
42✔
402
                  has_others = true;
42✔
403
                  break;
42✔
404

405
               case A_SLICE:
6✔
406
               case A_CONCAT:
407
                  {
408
                     type_t v_type = tree_type(tree_value(a));
6✔
409
                     known_elem_count = true;
6✔
410
                     if (type_is_unconstrained(v_type))
6✔
411
                        known_elem_count = false;
412
                     else if (!folded_length(range_of(v_type, 0), &elem_count))
6✔
UNCOV
413
                        known_elem_count = false;
×
414
                     break;
415
                  }
416
               }
417

418
               if (known_elem_count)
8,587✔
419
                  count += elem_count;
8,492✔
420
            }
421

422
            if (has_range)
1,541✔
423
               // Range could overlap, defer to bounds check
424
               return eval_not_possible(t, "range as choice");
54✔
425

426
            if (!has_others) {
1,488✔
427
               int64_t type_count;
1,446✔
428
               if (folded_length(range_of(composite_type, 0), &type_count))
1,446✔
429
                  if (count != type_count)
1,446✔
430
                     return eval_not_possible(t, "missing choice");
1✔
431
            }
432
         }
433

434
         return true;
435
      }
436

437
   case T_ATTR_REF:
3,364✔
438
      {
439
         if (tree_subkind(t) == ATTR_USER)
3,364✔
440
            return eval_not_possible(t, "user defined attribute");
×
441

442
         if (!eval_possible(tree_name(t), ur, mc))
3,364✔
443
            return false;
444

UNCOV
445
         const int nparams = tree_params(t);
×
UNCOV
446
         for (int i = 0; i < nparams; i++) {
×
UNCOV
447
            if (!eval_possible(tree_value(tree_param(t, i)), ur, mc))
×
448
               return false;
449
         }
450

451
         return true;
452
      }
453

454
   default:
168✔
455
      return eval_not_possible(t, tree_kind_str(tree_kind(t)));
168✔
456
   }
457
}
458

459
static void *case_result_cb(jit_scalar_t *args, void *user)
9✔
460
{
461
   jit_scalar_t *result = user;
9✔
462
   result->integer = args[0].integer;
9✔
463
   return result;
9✔
464
}
465

466
tree_t eval_case(jit_t *jit, tree_t stmt, lower_unit_t *parent, void *context)
9✔
467
{
468
   assert(tree_kind(stmt) == T_CASE_GENERATE);
9✔
469

470
   vcode_unit_t thunk = lower_case_generate_thunk(parent, stmt);
9✔
471

472
   jit_scalar_t result = { .integer = -1 };
9✔
473
   if (jit_call_thunk(jit, thunk, context, case_result_cb, &result) == NULL)
9✔
UNCOV
474
      error_at(tree_loc(tree_value(stmt)), "generate expression is not static");
×
475

476
   vcode_unit_unref(thunk);
9✔
477

478
   if (result.integer == -1)
9✔
479
      return NULL;
480
   else
481
      return tree_stmt(stmt, result.integer);
9✔
482
}
483

UNCOV
484
void *eval_instance(jit_t *jit, ident_t name, void *context)
×
485
{
486
   jit_handle_t h = jit_lazy_compile(jit, name);
×
UNCOV
487
   if (h == JIT_HANDLE_INVALID)
×
488
      fatal_trace("failed to compile instance %s", istr(name));
489

UNCOV
490
   jit_scalar_t result;
×
UNCOV
491
   if (!jit_try_call(jit, h, &result, context, context))
×
492
      return NULL;
493

UNCOV
494
   return result.pointer;
×
495
}
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc