File: merge.cpp

package info (click to toggle)
cbmc 6.6.0-4
  • links: PTS
  • area: main
  • in suites: forky, sid, trixie
  • size: 153,852 kB
  • sloc: cpp: 386,459; ansic: 114,466; java: 28,405; python: 6,003; yacc: 4,552; makefile: 4,041; lex: 2,487; xml: 2,388; sh: 2,050; perl: 557; pascal: 184; javascript: 163; ada: 36
file content (520 lines) | stat: -rw-r--r-- 17,169 bytes parent folder | download
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
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
/*******************************************************************\

 Module: Unit tests for full_array_abstract_objectt::merge

 Author: DiffBlue Limited.

\*******************************************************************/

#include <testing-utils/use_catch.h>
#include <typeinfo>

#include <analyses/variable-sensitivity/abstract_environment.h>
#include <analyses/variable-sensitivity/abstract_object.h>
#include <analyses/variable-sensitivity/full_array_abstract_object/array_builder.h>
#include <analyses/variable-sensitivity/variable_sensitivity_object_factory.h>
#include <analyses/variable-sensitivity/variable_sensitivity_test_helpers.h>

#include <util/arith_tools.h>
#include <util/bitvector_types.h>
#include <util/namespace.h>
#include <util/std_expr.h>
#include <util/symbol_table.h>

SCENARIO(
  "merge_constant_array_abstract_object",
  "[core]"
  "[analyses][variable-sensitivity][full_array_abstract_object][merge]")
{
  GIVEN("Two arrays of size 3, whose first elements are the same")
  {
    const typet type = signedbv_typet(32);

    // int val2[3] = {1, 2, 3}
    auto val1 = std::vector<int>{1, 2, 3};
    // int val2[3] = {1, 4, 5}
    auto val2 = std::vector<int>{1, 4, 5};

    // index_exprt for reading from an array
    const index_exprt i0 = index_exprt(
      exprt(ID_nil, array_typet(typet(), nil_exprt())), from_integer(0, type));
    const index_exprt i1 = index_exprt(
      exprt(ID_nil, array_typet(typet(), nil_exprt())), from_integer(1, type));
    const index_exprt i2 = index_exprt(
      exprt(ID_nil, array_typet(typet(), nil_exprt())), from_integer(2, type));

    auto object_factory = variable_sensitivity_object_factoryt::configured_with(
      vsd_configt::constant_domain());
    abstract_environmentt environment(object_factory);
    environment.make_top();
    symbol_tablet symbol_table;
    namespacet ns(symbol_table);

    WHEN("Merging two constant array AOs with the same array")
    {
      auto op1 = build_array(val1, environment, ns);
      auto op2 = build_array(val1, environment, ns);

      auto result = abstract_objectt::merge(op1, op2, widen_modet::no);

      THEN("The original constant array AO should be returned")
      {
        // Correctness of merge
        REQUIRE_FALSE(result.modified);
        REQUIRE_FALSE(result.object->is_top());
        REQUIRE_FALSE(result.object->is_bottom());
        for(int i = 0; i != 3; ++i)
          EXPECT_INDEX(result.object, i, val1[i], environment, ns);

        // Is optimal
        REQUIRE(result.object == op1);
      }
    }
    WHEN("Merging two constant array AOs with different value arrays")
    {
      auto op1 = build_array(val1, environment, ns);
      auto op2 = build_array(val2, environment, ns);

      auto result = abstract_objectt::merge(op1, op2, widen_modet::no);

      THEN(
        "A new constant array AO whose first value is the same and "
        "the other two are top")
      {
        // Correctness of merge
        REQUIRE(result.modified);
        REQUIRE_FALSE(result.object->is_top());
        REQUIRE_FALSE(result.object->is_bottom());
        EXPECT_INDEX(result.object, 0, val1[0], environment, ns);
        EXPECT_INDEX_TOP(result.object, 1, environment, ns);
        EXPECT_INDEX_TOP(result.object, 1, environment, ns);

        // Since it has modified, we definitely shouldn't be reusing the pointer
        REQUIRE_FALSE(result.object == op1);
      }
    }
    WHEN(
      "Merging a constant array AO with a value "
      "with a constant array AO set to top")
    {
      auto op1 = build_array(val1, environment, ns);
      auto op2 = build_top_array();

      auto result = abstract_objectt::merge(op1, op2, widen_modet::no);

      THEN("A new constant array AO set to top should be returned")
      {
        // Correctness of merge
        REQUIRE(result.modified);
        REQUIRE(result.object->is_top());
        REQUIRE_FALSE(result.object->is_bottom());
        for(int i = 0; i != 3; ++i)
          EXPECT_INDEX_TOP(result.object, i, environment, ns);

        // We can't reuse the abstract object as the value has changed
        REQUIRE(result.object != op1);
      }
    }
    WHEN(
      "Merging a constant array AO with a value "
      "with a constant array AO set to bottom")
    {
      auto op1 = build_array(val1, environment, ns);
      auto op2 = build_bottom_array();

      auto result = abstract_objectt::merge(op1, op2, widen_modet::no);

      THEN("The original const AO should be returned")
      {
        // Correctness of merge
        REQUIRE_FALSE(result.modified);
        REQUIRE_FALSE(result.object->is_top());
        REQUIRE_FALSE(result.object->is_bottom());
        for(int i = 0; i != 3; ++i)
          EXPECT_INDEX(result.object, i, val1[i], environment, ns);

        // Is optimal
        REQUIRE(result.object == op1);
      }
    }
    WHEN(
      "Merging a constant array AO set to top "
      "with a constant array AO with a value")
    {
      auto op1 = build_top_array();
      auto op2 = build_array(val1, environment, ns);

      auto result = abstract_objectt::merge(op1, op2, widen_modet::no);

      THEN("The original constant array AO should be returned")
      {
        // Correctness of merge
        REQUIRE_FALSE(result.modified);
        REQUIRE(result.object->is_top());
        REQUIRE_FALSE(result.object->is_bottom());
        for(int i = 0; i != 3; ++i)
          EXPECT_INDEX_TOP(result.object, i, environment, ns);

        // Is optimal
        REQUIRE(result.object == op1);
      }
    }
    WHEN(
      "Merging a constant array AO set to top "
      "with a constant array AO set to top")
    {
      auto op1 = build_top_array();
      auto op2 = build_top_array();

      auto result = abstract_objectt::merge(op1, op2, widen_modet::no);

      THEN("The original constant array AO should be returned")
      {
        // Correctness of merge
        REQUIRE_FALSE(result.modified);
        REQUIRE(result.object->is_top());
        REQUIRE_FALSE(result.object->is_bottom());
        for(int i = 0; i != 3; ++i)
          EXPECT_INDEX_TOP(result.object, i, environment, ns);

        // Is optimal
        REQUIRE(result.object == op1);
      }
    }
    WHEN(
      "Merging a constant array AO set to top "
      "with a constant array AO set to bottom")
    {
      auto op1 = build_top_array();
      auto op2 = build_bottom_array();

      auto result = abstract_objectt::merge(op1, op2, widen_modet::no);

      THEN("The original constant array AO should be returned")
      {
        // Correctness of merge
        REQUIRE_FALSE(result.modified);
        REQUIRE(result.object->is_top());
        REQUIRE_FALSE(result.object->is_bottom());
        for(int i = 0; i != 3; ++i)
          EXPECT_INDEX_TOP(result.object, i, environment, ns);

        // Is optimal
        REQUIRE(result.object == op1);
      }
    }
    WHEN(
      "Merging a constant array AO set to bottom "
      "with a constant array AO with a value")
    {
      auto op1 = build_bottom_array();
      auto op2 = build_array(val1, environment, ns);

      auto result = abstract_objectt::merge(op1, op2, widen_modet::no);

      THEN("A new AO should be returned with op2s valuee")
      {
        // Correctness of merge
        REQUIRE(result.modified);
        REQUIRE_FALSE(result.object->is_top());
        REQUIRE_FALSE(result.object->is_bottom());
        for(int i = 0; i != 3; ++i)
          EXPECT_INDEX(result.object, i, val1[i], environment, ns);

        // Is optimal
        REQUIRE(result.object != op1);
      }
    }
    WHEN(
      "Merging a constant array AO set to bottom "
      "with a constant array AO set to top")
    {
      auto op1 = build_bottom_array();
      auto op2 = build_top_array();

      auto result = abstract_objectt::merge(op1, op2, widen_modet::no);

      THEN("A new constant array AO should be returned set to top ")
      {
        // Correctness of merge
        REQUIRE(result.modified);
        REQUIRE(result.object->is_top());
        REQUIRE_FALSE(result.object->is_bottom());
        for(int i = 0; i != 3; ++i)
          EXPECT_INDEX_TOP(result.object, i, environment, ns);

        // Is optimal
        REQUIRE(result.object != op1);
      }
    }
    WHEN(
      "Merging a constant array AO set to bottom "
      "with a constant array AO set to bottom")
    {
      auto op1 = build_bottom_array();
      auto op2 = build_bottom_array();

      auto result = abstract_objectt::merge(op1, op2, widen_modet::no);

      THEN("The original bottom AO should be returned")
      {
        // Correctness of merge
        REQUIRE_FALSE(result.modified);
        REQUIRE_FALSE(result.object->is_top());
        REQUIRE(result.object->is_bottom());

        // Is optimal
        REQUIRE(result.object == op1);
      }
    }
    WHEN(
      "Merging constant array AO with value "
      "with a abstract object set to top")
    {
      const auto &op1 = build_array(val1, environment, ns);
      const auto &op2 =
        std::make_shared<abstract_objectt>(op1->type(), true, false);

      auto result = abstract_objectt::merge(op1, op2, widen_modet::no);

      THEN("We should get a new AO of the same type but set to top")
      {
        // Though we may become top or bottom, the type should be unchanged
        REQUIRE(result.object);

        // Correctness of merge
        REQUIRE(result.modified);
        REQUIRE(result.object->is_top());
        REQUIRE_FALSE(result.object->is_bottom());

        // Since it has modified, we definitely shouldn't be reusing the pointer
        REQUIRE_FALSE(result.object == op1);
      }
    }
    WHEN(
      "Merging constant array AO with value "
      "with a abstract object set to bottom")
    {
      const auto &op1 = build_array(val1, environment, ns);
      const auto &op2 =
        std::make_shared<abstract_objectt>(op1->type(), false, true);

      auto result = abstract_objectt::merge(op1, op2, widen_modet::no);

      THEN("We should get the same constant array AO back")
      {
        // Correctness of merge
        REQUIRE_FALSE(result.modified);
        REQUIRE_FALSE(result.object->is_top());
        REQUIRE_FALSE(result.object->is_bottom());
        for(int i = 0; i != 3; ++i)
          EXPECT_INDEX(result.object, i, val1[i], environment, ns);

        // Is optimal
        REQUIRE(result.object == op1);
      }
    }
    WHEN(
      "Merging constant array AO set to top "
      "with a abstract object set to top")
    {
      const auto &op1 = build_top_array();
      const auto &op2 =
        std::make_shared<abstract_objectt>(op1->type(), true, false);

      auto result = abstract_objectt::merge(op1, op2, widen_modet::no);

      THEN("We should get the same abstract object back")
      {
        // Simple correctness of merge
        REQUIRE_FALSE(result.modified);
        REQUIRE(result.object->is_top());
        REQUIRE_FALSE(result.object->is_bottom());

        // Is optimal
        REQUIRE(result.object == op1);
      }
    }
    WHEN(
      "Merging constant array AO set to top "
      "with a abstract object set to bottom")
    {
      const auto &op1 = build_top_array();
      const auto &op2 =
        std::make_shared<abstract_objectt>(op1->type(), false, true);

      auto result = abstract_objectt::merge(op1, op2, widen_modet::no);
      THEN("Should get the same abstract object back")
      {
        // Simple correctness of merge
        REQUIRE_FALSE(result.modified);
        REQUIRE(result.object->is_top());
        REQUIRE_FALSE(result.object->is_bottom());

        // Is optimal
        REQUIRE(result.object == op1);
      }
    }
    WHEN(
      "Merging constant array AO set to bottom "
      " with a abstract object set to top")
    {
      const auto &op1 = build_bottom_array();
      const auto &op2 =
        std::make_shared<abstract_objectt>(op1->type(), true, false);

      auto result = abstract_objectt::merge(op1, op2, widen_modet::no);
      THEN("Return a new top abstract object of the same type")
      {
        // Simple correctness of merge
        REQUIRE(result.modified);
        REQUIRE(result.object->is_top());
        REQUIRE_FALSE(result.object->is_bottom());

        // We don't optimize for returning the second parameter if we can

        // Is type still correct
        const auto &cast_result =
          std::dynamic_pointer_cast<const full_array_abstract_objectt>(
            result.object);
        // Though we may become top or bottom, the type should be unchanged
        REQUIRE(cast_result);
      }
    }
    WHEN("Merging constant array AO set to bottom with a AO set to bottom")
    {
      const auto &op1 = build_bottom_array();
      const auto &op2 =
        std::make_shared<abstract_objectt>(op1->type(), false, true);

      auto result = abstract_objectt::merge(op1, op2, widen_modet::no);
      THEN("Return the original abstract object")
      {
        // Simple correctness of merge
        REQUIRE_FALSE(result.modified);
        REQUIRE_FALSE(result.object->is_top());
        REQUIRE(result.object->is_bottom());

        // Optimization check
        REQUIRE(result.object == op1);

        // Is type still correct
        const auto &cast_result =
          std::dynamic_pointer_cast<const full_array_abstract_objectt>(
            result.object);
        // Though we may become top or bottom, the type should be unchanged
        REQUIRE(cast_result);
      }
    }
    WHEN("Merging AO set to top with a constant array AO with a value")
    {
      const auto &op2 = build_array(val1, environment, ns);
      const auto &op1 =
        std::make_shared<abstract_objectt>(op2->type(), true, false);

      auto result = abstract_objectt::merge(op1, op2, widen_modet::no);
      THEN("The original AO should be returned")
      {
        // Simple correctness of merge
        REQUIRE_FALSE(result.modified);
        REQUIRE(result.object->is_top());
        REQUIRE_FALSE(result.object->is_bottom());

        // Is optimal
        REQUIRE(result.object == op1);
      }
    }
    WHEN("Merging AO set to top with a constant array AO set to top")
    {
      const auto &op2 = build_top_array();
      const auto &op1 =
        std::make_shared<abstract_objectt>(op2->type(), true, false);

      auto result = abstract_objectt::merge(op1, op2, widen_modet::no);
      THEN("The original AO should be returned")
      {
        // Simple correctness of merge
        REQUIRE_FALSE(result.modified);
        REQUIRE(result.object->is_top());
        REQUIRE_FALSE(result.object->is_bottom());

        // Is optimal
        REQUIRE(result.object == op1);
      }
    }
    WHEN("Merging AO set to top with a constant array AO set to bottom")
    {
      const auto &op2 = build_bottom_array();
      const auto &op1 =
        std::make_shared<abstract_objectt>(op2->type(), true, false);

      auto result = abstract_objectt::merge(op1, op2, widen_modet::no);
      THEN("The original AO should be returned")
      {
        // Simple correctness of merge
        REQUIRE_FALSE(result.modified);
        REQUIRE(result.object->is_top());
        REQUIRE_FALSE(result.object->is_bottom());

        // Is optimal
        REQUIRE(result.object == op1);
      }
    }
    WHEN("Merging AO set to bottom with a constant array AO with a value")
    {
      const auto &op2 = build_array(val1, environment, ns);
      const auto &op1 =
        std::make_shared<abstract_objectt>(op2->type(), false, true);

      auto result = abstract_objectt::merge(op1, op2, widen_modet::no);

      THEN("The a new top AO should be returned")
      {
        // Simple correctness of merge
        REQUIRE(result.modified);
        REQUIRE(
          typeid(result.object.get()) == typeid(const abstract_objectt *));
        REQUIRE(result.object->is_top());
        REQUIRE_FALSE(result.object->is_bottom());
      }

      // We don't optimize for returning the second parameter if we can
    }
    WHEN("Merging AO set to bottom with a constant array AO set to top")
    {
      const auto &op2 = build_array(val1, environment, ns);
      const auto &op1 =
        std::make_shared<abstract_objectt>(op2->type(), false, true);

      auto result = abstract_objectt::merge(op1, op2, widen_modet::no);

      THEN("The a new top AO should be returned")
      {
        // Simple correctness of merge
        REQUIRE(result.modified);
        REQUIRE(result.object->is_top());
        REQUIRE_FALSE(result.object->is_bottom());

        // We don't optimize for returning the second parameter if we can
      }
    }
    WHEN("Merging AO set to bottom with a constant array AO set to bottom")
    {
      const auto &op2 = build_bottom_array();
      const auto &op1 =
        std::make_shared<abstract_objectt>(op2->type(), false, true);

      auto result = abstract_objectt::merge(op1, op2, widen_modet::no);

      THEN("The original AO should be returned")
      {
        // Simple correctness of merge
        REQUIRE_FALSE(result.modified);
        REQUIRE_FALSE(result.object->is_top());
        REQUIRE(result.object->is_bottom());

        REQUIRE(result.object == op1);
      }
    }
  }
}