GCC Code Coverage Report
Directory: . Exec Total Coverage
File: src/expr/node_builder.cpp Lines: 278 366 76.0 %
Date: 2021-08-14 Branches: 201 1174 17.1 %

Line Exec Source
1
/******************************************************************************
2
 * Top contributors (to current version):
3
 *   Andres Noetzli, Morgan Deters, Mathias Preiner
4
 *
5
 * This file is part of the cvc5 project.
6
 *
7
 * Copyright (c) 2009-2021 by the authors listed in the file AUTHORS
8
 * in the top-level source directory and their institutional affiliations.
9
 * All rights reserved.  See the file COPYING in the top-level source
10
 * directory for licensing information.
11
 * ****************************************************************************
12
 *
13
 * A builder interface for Nodes.
14
 */
15
16
#include "expr/node_builder.h"
17
18
#include <memory>
19
20
namespace cvc5 {
21
22
39942916
NodeBuilder::NodeBuilder()
23
39942916
    : d_nv(&d_inlineNv),
24
39942916
      d_nm(NodeManager::currentNM()),
25
119828748
      d_nvMaxChildren(default_nchild_thresh)
26
{
27
39942916
  d_inlineNv.d_id = 0;
28
39942916
  d_inlineNv.d_rc = 0;
29
39942916
  d_inlineNv.d_kind = expr::NodeValue::kindToDKind(kind::UNDEFINED_KIND);
30
39942916
  d_inlineNv.d_nchildren = 0;
31
39942916
}
32
33
36398382
NodeBuilder::NodeBuilder(Kind k)
34
36398382
    : d_nv(&d_inlineNv),
35
36398382
      d_nm(NodeManager::currentNM()),
36
109195146
      d_nvMaxChildren(default_nchild_thresh)
37
{
38
36398382
  Assert(k != kind::NULL_EXPR && k != kind::UNDEFINED_KIND)
39
      << "illegal Node-building kind";
40
41
36398382
  d_inlineNv.d_id = 1;  // have a kind already
42
36398382
  d_inlineNv.d_rc = 0;
43
36398382
  d_inlineNv.d_kind = expr::NodeValue::kindToDKind(k);
44
36398382
  d_inlineNv.d_nchildren = 0;
45
36398382
}
46
47
2
NodeBuilder::NodeBuilder(NodeManager* nm)
48
2
    : d_nv(&d_inlineNv), d_nm(nm), d_nvMaxChildren(default_nchild_thresh)
49
{
50
2
  d_inlineNv.d_id = 0;
51
2
  d_inlineNv.d_rc = 0;
52
2
  d_inlineNv.d_kind = expr::NodeValue::kindToDKind(kind::UNDEFINED_KIND);
53
2
  d_inlineNv.d_nchildren = 0;
54
2
}
55
56
182887135
NodeBuilder::NodeBuilder(NodeManager* nm, Kind k)
57
182887135
    : d_nv(&d_inlineNv), d_nm(nm), d_nvMaxChildren(default_nchild_thresh)
58
{
59
182887135
  Assert(k != kind::NULL_EXPR && k != kind::UNDEFINED_KIND)
60
      << "illegal Node-building kind";
61
62
182887135
  d_inlineNv.d_id = 1;  // have a kind already
63
182887135
  d_inlineNv.d_rc = 0;
64
182887135
  d_inlineNv.d_kind = expr::NodeValue::kindToDKind(k);
65
182887135
  d_inlineNv.d_nchildren = 0;
66
182887135
}
67
68
45899299
NodeBuilder::NodeBuilder(const NodeBuilder& nb)
69
45899299
    : d_nv(&d_inlineNv), d_nm(nb.d_nm), d_nvMaxChildren(default_nchild_thresh)
70
{
71
45899299
  d_inlineNv.d_id = nb.d_nv->d_id;
72
45899299
  d_inlineNv.d_rc = 0;
73
45899299
  d_inlineNv.d_kind = nb.d_nv->d_kind;
74
45899299
  d_inlineNv.d_nchildren = 0;
75
76
45899299
  internalCopy(nb);
77
45899299
}
78
79
610255468
NodeBuilder::~NodeBuilder()
80
{
81
305127734
  if (CVC5_PREDICT_FALSE(nvIsAllocated()))
82
  {
83
9563
    dealloc();
84
  }
85
305118171
  else if (CVC5_PREDICT_FALSE(!isUsed()))
86
  {
87
77306187
    decrRefCounts();
88
  }
89
305127734
}
90
91
1844913373
Kind NodeBuilder::getKind() const
92
{
93
1844913373
  Assert(!isUsed()) << "NodeBuilder is one-shot only; "
94
                       "attempt to access it after conversion";
95
1844913373
  return d_nv->getKind();
96
}
97
98
681334509
kind::MetaKind NodeBuilder::getMetaKind() const
99
{
100
681334509
  Assert(!isUsed()) << "NodeBuilder is one-shot only; "
101
                       "attempt to access it after conversion";
102
681334509
  Assert(getKind() != kind::UNDEFINED_KIND)
103
      << "The metakind of a NodeBuilder is undefined "
104
         "until a Kind is set";
105
681334509
  return d_nv->getMetaKind();
106
}
107
108
457015461
unsigned NodeBuilder::getNumChildren() const
109
{
110
457015461
  Assert(!isUsed()) << "NodeBuilder is one-shot only; "
111
                       "attempt to access it after conversion";
112
457015461
  Assert(getKind() != kind::UNDEFINED_KIND)
113
      << "The number of children of a NodeBuilder is undefined "
114
         "until a Kind is set";
115
457015461
  return d_nv->getNumChildren();
116
}
117
118
Node NodeBuilder::getOperator() const
119
{
120
  Assert(!isUsed()) << "NodeBuilder is one-shot only; "
121
                       "attempt to access it after conversion";
122
  Assert(getKind() != kind::UNDEFINED_KIND)
123
      << "NodeBuilder operator access is not permitted "
124
         "until a Kind is set";
125
  Assert(getMetaKind() == kind::metakind::PARAMETERIZED)
126
      << "NodeBuilder operator access is only permitted "
127
         "on parameterized kinds, not `"
128
      << getKind() << "'";
129
  return Node(d_nv->getOperator());
130
}
131
132
2631058
Node NodeBuilder::getChild(int i) const
133
{
134
2631058
  Assert(!isUsed()) << "NodeBuilder is one-shot only; "
135
                       "attempt to access it after conversion";
136
2631058
  Assert(getKind() != kind::UNDEFINED_KIND)
137
      << "NodeBuilder child access is not permitted "
138
         "until a Kind is set";
139
2631058
  Assert(i >= 0 && unsigned(i) < d_nv->getNumChildren())
140
      << "index out of range for NodeBuilder::getChild()";
141
2631058
  return Node(d_nv->getChild(i));
142
}
143
144
2623332
Node NodeBuilder::operator[](int i) const { return getChild(i); }
145
146
104890
void NodeBuilder::clear(Kind k)
147
{
148
104890
  Assert(k != kind::NULL_EXPR) << "illegal Node-building clear kind";
149
150
104890
  if (CVC5_PREDICT_FALSE(nvIsAllocated()))
151
  {
152
6
    dealloc();
153
  }
154
104884
  else if (CVC5_PREDICT_FALSE(!isUsed()))
155
  {
156
104878
    decrRefCounts();
157
  }
158
  else
159
  {
160
6
    setUnused();
161
  }
162
163
104890
  d_inlineNv.d_kind = expr::NodeValue::kindToDKind(k);
164
104890
  for (expr::NodeValue::nv_iterator i = d_inlineNv.nv_begin();
165
104890
       i != d_inlineNv.nv_end();
166
       ++i)
167
  {
168
    (*i)->dec();
169
  }
170
104890
  d_inlineNv.d_nchildren = 0;
171
  // keep track of whether or not we hvae a kind already
172
104890
  d_inlineNv.d_id = (k == kind::UNDEFINED_KIND) ? 0 : 1;
173
104890
}
174
175
11276570
NodeBuilder& NodeBuilder::operator<<(const Kind& k)
176
{
177
11276570
  Assert(!isUsed()) << "NodeBuilder is one-shot only; "
178
                       "attempt to access it after conversion";
179
11276570
  Assert(getKind() == kind::UNDEFINED_KIND || d_nv->d_id == 0)
180
      << "can't redefine the Kind of a NodeBuilder";
181
11276570
  Assert(d_nv->d_id == 0)
182
      << "internal inconsistency with NodeBuilder: d_id != 0";
183
11276570
  AssertArgument(
184
      k != kind::UNDEFINED_KIND && k != kind::NULL_EXPR && k < kind::LAST_KIND,
185
      k,
186
      "illegal node-building kind");
187
  // This test means: we didn't have a Kind at the beginning (on
188
  // NodeBuilder construction or at the last clear()), but we do
189
  // now.  That means we appended a Kind with operator<<(Kind),
190
  // which now (lazily) we'll collapse.
191
11276570
  if (CVC5_PREDICT_FALSE(d_nv->d_id == 0 && getKind() != kind::UNDEFINED_KIND))
192
  {
193
    Node n2 = operator Node();
194
    clear();
195
    append(n2);
196
  }
197
11276570
  else if (d_nv->d_nchildren == 0)
198
  {
199
11276542
    d_nv->d_id = 1;  // remember that we had a kind from the start
200
  }
201
11276570
  d_nv->d_kind = expr::NodeValue::kindToDKind(k);
202
11276570
  return *this;
203
}
204
205
419984443
NodeBuilder& NodeBuilder::operator<<(TNode n)
206
{
207
419984443
  Assert(!isUsed()) << "NodeBuilder is one-shot only; "
208
                       "attempt to access it after conversion";
209
  // This test means: we didn't have a Kind at the beginning (on
210
  // NodeBuilder construction or at the last clear()), but we do
211
  // now.  That means we appended a Kind with operator<<(Kind),
212
  // which now (lazily) we'll collapse.
213
419984443
  if (CVC5_PREDICT_FALSE(d_nv->d_id == 0 && getKind() != kind::UNDEFINED_KIND))
214
  {
215
12
    Node n2 = operator Node();
216
6
    clear();
217
6
    append(n2);
218
  }
219
419984443
  return append(n);
220
}
221
222
120643
NodeBuilder& NodeBuilder::operator<<(TypeNode n)
223
{
224
120643
  Assert(!isUsed()) << "NodeBuilder is one-shot only; "
225
                       "attempt to access it after conversion";
226
  // This test means: we didn't have a Kind at the beginning (on
227
  // NodeBuilder construction or at the last clear()), but we do
228
  // now.  That means we appended a Kind with operator<<(Kind),
229
  // which now (lazily) we'll collapse.
230
120643
  if (CVC5_PREDICT_FALSE(d_nv->d_id == 0 && getKind() != kind::UNDEFINED_KIND))
231
  {
232
    Node n2 = operator Node();
233
    clear();
234
    append(n2);
235
  }
236
120643
  return append(n);
237
}
238
239
72490
NodeBuilder& NodeBuilder::append(const std::vector<TypeNode>& children)
240
{
241
72490
  Assert(!isUsed()) << "NodeBuilder is one-shot only; "
242
                       "attempt to access it after conversion";
243
72490
  return append(children.begin(), children.end());
244
}
245
246
495491938
NodeBuilder& NodeBuilder::append(TNode n)
247
{
248
495491938
  Assert(!isUsed()) << "NodeBuilder is one-shot only; "
249
                       "attempt to access it after conversion";
250
495491938
  Assert(!n.isNull()) << "Cannot use NULL Node as a child of a Node";
251
495491938
  if (n.getKind() == kind::BUILTIN)
252
  {
253
    return *this << NodeManager::operatorToKind(n);
254
  }
255
495491938
  allocateNvIfNecessaryForAppend();
256
495491938
  expr::NodeValue* nv = n.d_nv;
257
495491938
  nv->inc();
258
495491938
  d_nv->d_children[d_nv->d_nchildren++] = nv;
259
495491938
  Assert(d_nv->d_nchildren <= d_nvMaxChildren);
260
495491938
  return *this;
261
}
262
263
358723
NodeBuilder& NodeBuilder::append(const TypeNode& typeNode)
264
{
265
358723
  Assert(!isUsed()) << "NodeBuilder is one-shot only; "
266
                       "attempt to access it after conversion";
267
358723
  Assert(!typeNode.isNull()) << "Cannot use NULL Node as a child of a Node";
268
358723
  allocateNvIfNecessaryForAppend();
269
358723
  expr::NodeValue* nv = typeNode.d_nv;
270
358723
  nv->inc();
271
358723
  d_nv->d_children[d_nv->d_nchildren++] = nv;
272
358723
  Assert(d_nv->d_nchildren <= d_nvMaxChildren);
273
358723
  return *this;
274
}
275
276
3036212
void NodeBuilder::realloc(size_t toSize)
277
{
278
3036212
  AlwaysAssert(toSize > d_nvMaxChildren)
279
      << "attempt to realloc() a NodeBuilder to a smaller/equal size!";
280
3036212
  Assert(toSize < (static_cast<size_t>(1) << expr::NodeValue::NBITS_NCHILDREN))
281
      << "attempt to realloc() a NodeBuilder to size " << toSize
282
      << " (beyond hard limit of " << expr::NodeValue::MAX_CHILDREN << ")";
283
284
3036212
  if (CVC5_PREDICT_FALSE(nvIsAllocated()))
285
  {
286
    // Ensure d_nv is not modified on allocation failure
287
1076500
    expr::NodeValue* newBlock = (expr::NodeValue*)std::realloc(
288
1076500
        d_nv, sizeof(expr::NodeValue) + (sizeof(expr::NodeValue*) * toSize));
289
1076500
    if (newBlock == nullptr)
290
    {
291
      // In this case, d_nv was NOT freed.  If we throw, the
292
      // deallocation should occur on destruction of the NodeBuilder.
293
      throw std::bad_alloc();
294
    }
295
1076500
    d_nvMaxChildren = toSize;
296
1076500
    Assert(d_nvMaxChildren == toSize);  // overflow check
297
    // Here, the copy (between two heap-allocated buffers) has already
298
    // been done for us by the std::realloc().
299
1076500
    d_nv = newBlock;
300
  }
301
  else
302
  {
303
    // Ensure d_nv is not modified on allocation failure
304
1959712
    expr::NodeValue* newBlock = (expr::NodeValue*)std::malloc(
305
1959712
        sizeof(expr::NodeValue) + (sizeof(expr::NodeValue*) * toSize));
306
1959712
    if (newBlock == nullptr)
307
    {
308
      throw std::bad_alloc();
309
    }
310
1959712
    d_nvMaxChildren = toSize;
311
1959712
    Assert(d_nvMaxChildren == toSize);  // overflow check
312
313
1959712
    d_nv = newBlock;
314
1959712
    d_nv->d_id = d_inlineNv.d_id;
315
1959712
    d_nv->d_rc = 0;
316
1959712
    d_nv->d_kind = d_inlineNv.d_kind;
317
1959712
    d_nv->d_nchildren = d_inlineNv.d_nchildren;
318
319
3919424
    std::copy(d_inlineNv.d_children,
320
1959712
              d_inlineNv.d_children + d_inlineNv.d_nchildren,
321
1959712
              d_nv->d_children);
322
323
    // ensure "inline" children don't get decremented in dtor
324
1959712
    d_inlineNv.d_nchildren = 0;
325
  }
326
3036212
}
327
328
1191929
void NodeBuilder::dealloc()
329
{
330
1191929
  Assert(nvIsAllocated())
331
      << "Internal error: NodeBuilder: dealloc() called without a "
332
         "private NodeBuilder-allocated buffer";
333
334
44429068
  for (expr::NodeValue::nv_iterator i = d_nv->nv_begin(); i != d_nv->nv_end();
335
       ++i)
336
  {
337
43237139
    (*i)->dec();
338
  }
339
340
1191929
  free(d_nv);
341
1191929
  d_nv = &d_inlineNv;
342
1191929
  d_nvMaxChildren = default_nchild_thresh;
343
1191929
}
344
345
275981531
void NodeBuilder::decrRefCounts()
346
{
347
275981531
  Assert(!nvIsAllocated())
348
      << "Internal error: NodeBuilder: decrRefCounts() called with a "
349
         "private NodeBuilder-allocated buffer";
350
351
647934726
  for (expr::NodeValue::nv_iterator i = d_inlineNv.nv_begin();
352
647934726
       i != d_inlineNv.nv_end();
353
       ++i)
354
  {
355
371953195
    (*i)->dec();
356
  }
357
358
275981531
  d_inlineNv.d_nchildren = 0;
359
275981531
}
360
361
155378
TypeNode NodeBuilder::constructTypeNode() { return TypeNode(constructNV()); }
362
363
227656612
Node NodeBuilder::constructNode()
364
{
365
227656612
  Node n(constructNV());
366
227657066
  maybeCheckType(n);
367
227656158
  return n;
368
}
369
370
Node* NodeBuilder::constructNodePtr()
371
{
372
  std::unique_ptr<Node> np(new Node(constructNV()));
373
  maybeCheckType(*np.get());
374
  return np.release();
375
}
376
377
45704259
NodeBuilder::operator Node() { return constructNode(); }
378
379
NodeBuilder::operator TypeNode() { return constructTypeNode(); }
380
381
227811990
expr::NodeValue* NodeBuilder::constructNV()
382
{
383
227811990
  Assert(!isUsed()) << "NodeBuilder is one-shot only; "
384
                       "attempt to access it after conversion";
385
227811990
  Assert(getKind() != kind::UNDEFINED_KIND)
386
      << "Can't make an expression of an undefined kind!";
387
388
  // NOTE: The comments in this function refer to the cases in the
389
  // file comments at the top of this file.
390
391
  // Case 0: If a VARIABLE
392
455623980
  if (getMetaKind() == kind::metakind::VARIABLE
393
227811990
      || getMetaKind() == kind::metakind::NULLARY_OPERATOR)
394
  {
395
    /* 0. If a VARIABLE, treat similarly to 1(b), except that we know
396
     * there are no children (no reference counts to reason about),
397
     * and we don't keep VARIABLE-kinded Nodes in the NodeManager
398
     * pool. */
399
400
1053267
    Assert(!nvIsAllocated())
401
        << "internal NodeBuilder error: "
402
           "VARIABLE-kinded NodeBuilder is heap-allocated !?";
403
1053267
    Assert(d_inlineNv.d_nchildren == 0)
404
        << "improperly-formed VARIABLE-kinded NodeBuilder: "
405
           "no children permitted";
406
407
    // we have to copy the inline NodeValue out
408
    expr::NodeValue* nv =
409
1053267
        (expr::NodeValue*)std::malloc(sizeof(expr::NodeValue));
410
1053267
    if (nv == nullptr)
411
    {
412
      throw std::bad_alloc();
413
    }
414
    // there are no children, so we don't have to worry about
415
    // reference counts in this case.
416
1053267
    nv->d_nchildren = 0;
417
1053267
    nv->d_kind = d_nv->d_kind;
418
1053267
    nv->d_id = d_nm->next_id++;  // FIXME multithreading
419
1053267
    nv->d_rc = 0;
420
1053267
    setUsed();
421
1053267
    if (Debug.isOn("gc"))
422
    {
423
      Debug("gc") << "creating node value " << nv << " [" << nv->d_id << "]: ";
424
      nv->printAst(Debug("gc"));
425
      Debug("gc") << std::endl;
426
    }
427
1053267
    return nv;
428
  }
429
430
  // check that there are the right # of children for this kind
431
226758723
  Assert(getMetaKind() != kind::metakind::CONSTANT)
432
      << "Cannot make Nodes with NodeBuilder that have CONSTANT-kinded kinds";
433
226758723
  Assert(getNumChildren() >= kind::metakind::getMinArityForKind(getKind()))
434
      << "Nodes with kind " << getKind() << " must have at least "
435
      << kind::metakind::getMinArityForKind(getKind())
436
      << " children (the one under "
437
         "construction has "
438
      << getNumChildren() << ")";
439
226758723
  Assert(getNumChildren() <= kind::metakind::getMaxArityForKind(getKind()))
440
      << "Nodes with kind " << getKind() << " must have at most "
441
      << kind::metakind::getMaxArityForKind(getKind())
442
      << " children (the one under "
443
         "construction has "
444
      << getNumChildren() << ")";
445
446
  // Implementation differs depending on whether the NodeValue was
447
  // malloc'ed or not and whether or not it's in the already-been-seen
448
  // NodeManager pool of Nodes.  See implementation notes at the top
449
  // of this file.
450
451
226758723
  if (CVC5_PREDICT_TRUE(!nvIsAllocated()))
452
  {
453
    /** Case 1.  d_nv points to d_inlineNv: it is the backing store
454
     ** allocated "inline" in this NodeBuilder. **/
455
456
    // Lookup the expression value in the pool we already have
457
224808580
    expr::NodeValue* poolNv = d_nm->poolLookup(&d_inlineNv);
458
    // If something else is there, we reuse it
459
224808580
    if (poolNv != nullptr)
460
    {
461
      /* Subcase (a): The Node under construction already exists in
462
       * the NodeManager's pool. */
463
464
      /* 1(a). Reference-counts for all children in d_inlineNv must be
465
       * decremented, and the NodeBuilder must be marked as "used" and
466
       * the number of children set to zero so that we don't decrement
467
       * them again on destruction.  The existing NodeManager pool
468
       * entry is returned.
469
       */
470
198570466
      decrRefCounts();
471
198570466
      d_inlineNv.d_nchildren = 0;
472
198570466
      setUsed();
473
198570466
      return poolNv;
474
    }
475
    else
476
    {
477
      /* Subcase (b): The Node under construction is NOT already in
478
       * the NodeManager's pool. */
479
480
      /* 1(b). A new heap-allocated NodeValue must be constructed and
481
       * all settings and children from d_inlineNv copied into it.
482
       * This new NodeValue is put into the NodeManager's pool.  The
483
       * NodeBuilder is marked as "used" and the number of children in
484
       * d_inlineNv set to zero so that we don't decrement child
485
       * reference counts on destruction (the child reference counts
486
       * have been "taken over" by the new NodeValue).  We return a
487
       * Node wrapper for this new NodeValue, which increments its
488
       * reference count. */
489
490
      // create the canonical expression value for this node
491
26238114
      expr::NodeValue* nv = (expr::NodeValue*)std::malloc(
492
          sizeof(expr::NodeValue)
493
52476228
          + (sizeof(expr::NodeValue*) * d_inlineNv.d_nchildren));
494
26238114
      if (nv == nullptr)
495
      {
496
        throw std::bad_alloc();
497
      }
498
26238114
      nv->d_nchildren = d_inlineNv.d_nchildren;
499
26238114
      nv->d_kind = d_inlineNv.d_kind;
500
26238114
      nv->d_id = d_nm->next_id++;  // FIXME multithreading
501
26238114
      nv->d_rc = 0;
502
503
52476228
      std::copy(d_inlineNv.d_children,
504
26238114
                d_inlineNv.d_children + d_inlineNv.d_nchildren,
505
26238114
                nv->d_children);
506
507
26238114
      d_inlineNv.d_nchildren = 0;
508
26238114
      setUsed();
509
510
      // poolNv = nv;
511
26238114
      d_nm->poolInsert(nv);
512
26238114
      if (Debug.isOn("gc"))
513
      {
514
        Debug("gc") << "creating node value " << nv << " [" << nv->d_id
515
                    << "]: ";
516
        nv->printAst(Debug("gc"));
517
        Debug("gc") << std::endl;
518
      }
519
26238114
      return nv;
520
    }
521
  }
522
  else
523
  {
524
    /** Case 2. d_nv does NOT point to d_inlineNv: it is a new, larger
525
     ** buffer that was heap-allocated by this NodeBuilder. **/
526
527
    // Lookup the expression value in the pool we already have (with insert)
528
1950143
    expr::NodeValue* poolNv = d_nm->poolLookup(d_nv);
529
    // If something else is there, we reuse it
530
1950143
    if (poolNv != nullptr)
531
    {
532
      /* Subcase (a): The Node under construction already exists in
533
       * the NodeManager's pool. */
534
535
      /* 2(a). Reference-counts for all children in d_nv must be
536
       * decremented.  The NodeBuilder is marked as "used" and the
537
       * heap-allocated d_nv deleted.  d_nv is repointed to d_inlineNv
538
       * so that destruction of the NodeBuilder doesn't cause any
539
       * problems.  The existing NodeManager pool entry is
540
       * returned. */
541
542
1182360
      dealloc();
543
1182360
      setUsed();
544
1182360
      return poolNv;
545
    }
546
    else
547
    {
548
      /* Subcase (b) The Node under construction is NOT already in the
549
       * NodeManager's pool. */
550
551
      /* 2(b). The heap-allocated d_nv is "cropped" to the correct
552
       * size (based on the number of children it _actually_ has).
553
       * d_nv is repointed to d_inlineNv so that destruction of the
554
       * NodeBuilder doesn't cause any problems, and the (old) value
555
       * it had is placed into the NodeManager's pool and returned in
556
       * a Node wrapper. */
557
558
767783
      crop();
559
767783
      expr::NodeValue* nv = d_nv;
560
767783
      nv->d_id = d_nm->next_id++;  // FIXME multithreading
561
767783
      d_nv = &d_inlineNv;
562
767783
      d_nvMaxChildren = default_nchild_thresh;
563
767783
      setUsed();
564
565
      // poolNv = nv;
566
767783
      d_nm->poolInsert(nv);
567
1535566
      Debug("gc") << "creating node value " << nv << " [" << nv->d_id
568
767783
                  << "]: " << *nv << "\n";
569
767783
      return nv;
570
    }
571
  }
572
}
573
574
45899299
void NodeBuilder::internalCopy(const NodeBuilder& nb)
575
{
576
45899299
  if (nb.isUsed())
577
  {
578
    setUsed();
579
    return;
580
  }
581
582
45899299
  bool realloced CVC5_UNUSED = false;
583
45899299
  if (nb.d_nvMaxChildren > d_nvMaxChildren)
584
  {
585
9557
    realloced = true;
586
9557
    realloc(nb.d_nvMaxChildren);
587
  }
588
589
45899299
  Assert(nb.d_nvMaxChildren <= d_nvMaxChildren);
590
45899299
  Assert(nb.d_nv->nv_end() >= nb.d_nv->nv_begin());
591
45899299
  Assert((size_t)(nb.d_nv->nv_end() - nb.d_nv->nv_begin()) <= d_nvMaxChildren)
592
      << "realloced:" << (realloced ? "true" : "false")
593
      << ", d_nvMax:" << d_nvMaxChildren
594
      << ", size:" << nb.d_nv->nv_end() - nb.d_nv->nv_begin()
595
      << ", nc:" << nb.d_nv->getNumChildren();
596
45899299
  std::copy(nb.d_nv->nv_begin(), nb.d_nv->nv_end(), d_nv->nv_begin());
597
598
45899299
  d_nv->d_nchildren = nb.d_nv->d_nchildren;
599
600
48114657
  for (expr::NodeValue::nv_iterator i = d_nv->nv_begin(); i != d_nv->nv_end();
601
       ++i)
602
  {
603
2215358
    (*i)->inc();
604
  }
605
}
606
607
#ifdef CVC5_DEBUG
608
227656612
inline void NodeBuilder::maybeCheckType(const TNode n) const
609
{
610
  /* force an immediate type check, if early type checking is
611
     enabled and the current node isn't a variable or constant */
612
227656612
  kind::MetaKind mk = n.getMetaKind();
613
227656612
  if (mk != kind::metakind::VARIABLE && mk != kind::metakind::NULLARY_OPERATOR
614
226603345
      && mk != kind::metakind::CONSTANT)
615
  {
616
226603799
    d_nm->getType(n, true);
617
  }
618
227656158
}
619
#endif /* CVC5_DEBUG */
620
621
4751464957
bool NodeBuilder::isUsed() const { return CVC5_PREDICT_FALSE(d_nv == nullptr); }
622
623
227811990
void NodeBuilder::setUsed()
624
{
625
227811990
  Assert(!isUsed()) << "Internal error: bad `used' state in NodeBuilder!";
626
227811990
  Assert(d_inlineNv.d_nchildren == 0
627
         && d_nvMaxChildren == default_nchild_thresh)
628
      << "Internal error: bad `inline' state in NodeBuilder!";
629
227811990
  d_nv = nullptr;
630
227811990
}
631
632
6
void NodeBuilder::setUnused()
633
{
634
6
  Assert(isUsed()) << "Internal error: bad `used' state in NodeBuilder!";
635
6
  Assert(d_inlineNv.d_nchildren == 0
636
         && d_nvMaxChildren == default_nchild_thresh)
637
      << "Internal error: bad `inline' state in NodeBuilder!";
638
6
  d_nv = &d_inlineNv;
639
6
}
640
641
814022069
bool NodeBuilder::nvIsAllocated() const
642
{
643
814022069
  return CVC5_PREDICT_FALSE(d_nv != &d_inlineNv)
644
814022069
         && CVC5_PREDICT_TRUE(d_nv != nullptr);
645
}
646
647
495850661
bool NodeBuilder::nvNeedsToBeAllocated() const
648
{
649
495850661
  return CVC5_PREDICT_FALSE(d_nv->d_nchildren == d_nvMaxChildren);
650
}
651
652
3026635
void NodeBuilder::realloc()
653
{
654
3026635
  size_t newSize = 2 * size_t(d_nvMaxChildren);
655
3026635
  size_t hardLimit = expr::NodeValue::MAX_CHILDREN;
656
3026635
  realloc(CVC5_PREDICT_FALSE(newSize > hardLimit) ? hardLimit : newSize);
657
3026635
}
658
659
495850661
void NodeBuilder::allocateNvIfNecessaryForAppend()
660
{
661
495850661
  if (CVC5_PREDICT_FALSE(nvNeedsToBeAllocated()))
662
  {
663
3026635
    realloc();
664
  }
665
495850661
}
666
667
767783
void NodeBuilder::crop()
668
{
669
1535566
  if (CVC5_PREDICT_FALSE(nvIsAllocated())
670
767783
      && CVC5_PREDICT_TRUE(d_nvMaxChildren > d_nv->d_nchildren))
671
  {
672
    // Ensure d_nv is not modified on allocation failure
673
751068
    expr::NodeValue* newBlock = (expr::NodeValue*)std::realloc(
674
751068
        d_nv,
675
        sizeof(expr::NodeValue)
676
1502136
            + (sizeof(expr::NodeValue*) * d_nv->d_nchildren));
677
751068
    if (newBlock == nullptr)
678
    {
679
      // In this case, d_nv was NOT freed.  If we throw, the
680
      // deallocation should occur on destruction of the
681
      // NodeBuilder.
682
      throw std::bad_alloc();
683
    }
684
751068
    d_nv = newBlock;
685
751068
    d_nvMaxChildren = d_nv->d_nchildren;
686
  }
687
767783
}
688
689
NodeBuilder& NodeBuilder::collapseTo(Kind k)
690
{
691
  AssertArgument(
692
      k != kind::UNDEFINED_KIND && k != kind::NULL_EXPR && k < kind::LAST_KIND,
693
      k,
694
      "illegal collapsing kind");
695
696
  if (getKind() != k)
697
  {
698
    Node n = operator Node();
699
    clear();
700
    d_nv->d_kind = expr::NodeValue::kindToDKind(k);
701
    d_nv->d_id = 1;  // have a kind already
702
    return append(n);
703
  }
704
  return *this;
705
}
706
707
std::ostream& operator<<(std::ostream& out, const NodeBuilder& nb)
708
{
709
  return out << *nb.d_nv;
710
}
711
712
29340
}  // namespace cvc5