Skip to content

[CONTRACTS] DFCC loop assigns infererence with functions inlined #8490

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ void main()
data[4] = 0;

for(unsigned i = 0; i < SIZE; i++)
__CPROVER_loop_invariant(i <= SIZE)
__CPROVER_assigns(data[1], i) __CPROVER_loop_invariant(i <= SIZE)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this change now strictly necessary given the additional widening?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, new addition widening will infer object_whole(data), i which is not accurate for this test.

{
data[1] = i;
}
Expand Down
10 changes: 5 additions & 5 deletions regression/contracts-dfcc/loop_assigns_inference-01/test.desc
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
KNOWNBUG
CORE dfcc-only
main.c
--dfcc main --apply-loop-contracts
--dfcc main --apply-loop-contracts _ --no-standard-checks
^EXIT=0$
^SIGNAL=0$
^\[body_1.assigns.\d+\] .* Check that j is assignable: SUCCESS$
^\[body_2.assigns.\d+\] .* Check that \*i is assignable: SUCCESS$
^\[body_3.assigns.\d+\] .* Check that \*i is assignable: SUCCESS$
^\[incr.assigns.\d+\] .* Check that \*i is assignable: SUCCESS$
^\[main.\d+\] .* Check loop invariant before entry: SUCCESS$
^\[main.\d+\] .* Check that loop invariant is preserved: SUCCESS$
^\[main.loop_invariant_base.\d+\] line \d+ Check invariant before entry for loop .*: SUCCESS$
^\[main.loop_invariant_step.\d+\] line \d+ Check invariant after step for loop .*: SUCCESS$
^\[main.loop_step_unwinding.\d+\] line \d+ Check step was unwound for loop .*: SUCCESS$
^\[main.assertion.\d+\] .* assertion j == 9: SUCCESS$
^VERIFICATION SUCCESSFUL$
--
--
This test checks loop locals are correctly removed during assigns inference so
that the assign clause is correctly inferred.
This test failed when using dfcc for loop contracts.
22 changes: 22 additions & 0 deletions regression/contracts-dfcc/loop_assigns_inference-04/main.c
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
struct hole
{
int pos;
};

void set_len(struct hole *h, unsigned long int new_len)
{
h->pos = new_len;
}

int main()
{
int i = 0;
struct hole h;
h.pos = 0;
for(i = 0; i < 5; i++)
// __CPROVER_assigns(h.pos, i)
__CPROVER_loop_invariant(h.pos == i)
{
set_len(&h, h.pos + 1);
}
}
14 changes: 14 additions & 0 deletions regression/contracts-dfcc/loop_assigns_inference-04/test.desc
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
CORE dfcc-only
main.c
--dfcc main --apply-loop-contracts
^EXIT=0$
^SIGNAL=0$
^\[main.loop_invariant_base.\d+\] line \d+ Check invariant before entry for loop .*: SUCCESS$
^\[main.loop_invariant_base.\d+\] line \d+ Check invariant before entry for loop .*: SUCCESS$
^\[main.loop_invariant_step.\d+\] line \d+ Check invariant after step for loop .*: SUCCESS$
^\[main.loop_step_unwinding.\d+\] line \d+ Check step was unwound for loop .*: SUCCESS$
^\[set_len.assigns.\d+\] line \d+ Check that h\-\>pos is assignable: SUCCESS
^VERIFICATION SUCCESSFUL$
--
--
This test checks assigns h->pos is inferred correctly.
17 changes: 17 additions & 0 deletions regression/contracts-dfcc/loop_assigns_inference-05/main.c
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
#include <stdlib.h>

#define SIZE 8

int main()
{
int i = 0;
int *j = malloc(SIZE * sizeof(int));
for(i = 0; i < SIZE; i++)
// __CPROVER_assigns(h.pos, i)
__CPROVER_loop_invariant(0 <= i && i <= SIZE)
{
int *k;
k = j + i;
*k = 1;
}
}
15 changes: 15 additions & 0 deletions regression/contracts-dfcc/loop_assigns_inference-05/test.desc
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
CORE dfcc-only
main.c
--no-malloc-may-fail --dfcc main --apply-loop-contracts
^EXIT=0$
^SIGNAL=0$
^\[main.loop_invariant_base.\d+\] line \d+ Check invariant before entry for loop .*: SUCCESS$
^\[main.loop_invariant_base.\d+\] line \d+ Check invariant before entry for loop .*: SUCCESS$
^\[main.loop_invariant_step.\d+\] line \d+ Check invariant after step for loop .*: SUCCESS$
^\[main.loop_step_unwinding.\d+\] line \d+ Check step was unwound for loop .*: SUCCESS$
^\[main.assigns.\d+\] line \d+ Check that \*k is assignable: SUCCESS
^VERIFICATION SUCCESSFUL$
--
--
This test checks assigns __CPROVER_object_whole(k) is inferred correctly,
which requires widening *k to the whole object.
37 changes: 26 additions & 11 deletions src/goto-instrument/contracts/dynamic-frames/dfcc_cfg_info.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -309,8 +309,7 @@ static struct contract_clausest default_loop_contract_clauses(
const dfcc_loop_nesting_grapht &loop_nesting_graph,
const std::size_t loop_id,
const irep_idt &function_id,
goto_functiont &goto_function,
local_may_aliast &local_may_alias,
const assignst &inferred_assigns,
const bool check_side_effect,
message_handlert &message_handler,
const namespacet &ns)
Expand Down Expand Up @@ -361,13 +360,11 @@ static struct contract_clausest default_loop_contract_clauses(
else
{
// infer assigns clause targets if none given
auto inferred = dfcc_infer_loop_assigns(
local_may_alias, goto_function, loop, message_handler, ns);
log.warning() << "No assigns clause provided for loop " << function_id
<< "." << loop.latch->loop_number << " at "
<< loop.head->source_location() << ". The inferred set {";
bool first = true;
for(const auto &expr : inferred)
for(const auto &expr : inferred_assigns)
{
if(!first)
{
Expand All @@ -379,7 +376,7 @@ static struct contract_clausest default_loop_contract_clauses(
log.warning() << "} might be incomplete or imprecise, please provide an "
"assigns clause if the analysis fails."
<< messaget::eom;
result.assigns.swap(inferred);
result.assigns = inferred_assigns;
}

if(result.decreases_clauses.empty())
Expand All @@ -400,7 +397,7 @@ static dfcc_loop_infot gen_dfcc_loop_info(
goto_functiont &goto_function,
const std::map<std::size_t, dfcc_loop_infot> &loop_info_map,
dirtyt &dirty,
local_may_aliast &local_may_alias,
const assignst &inferred_assigns,
const bool check_side_effect,
message_handlert &message_handler,
dfcc_libraryt &library,
Expand Down Expand Up @@ -436,8 +433,7 @@ static dfcc_loop_infot gen_dfcc_loop_info(
loop_nesting_graph,
loop_id,
function_id,
goto_function,
local_may_alias,
inferred_assigns,
check_side_effect,
message_handler,
ns);
Expand Down Expand Up @@ -488,6 +484,7 @@ static dfcc_loop_infot gen_dfcc_loop_info(
}

dfcc_cfg_infot::dfcc_cfg_infot(
goto_modelt &goto_model,
const irep_idt &function_id,
goto_functiont &goto_function,
const exprt &top_level_write_set,
Expand All @@ -506,6 +503,9 @@ dfcc_cfg_infot::dfcc_cfg_infot(
// Clean up possible fake loops that are due to do { ... } while(0);
simplify_gotos(goto_program, ns);

// From loop number to the inferred loop assigns.
std::map<std::size_t, assignst> inferred_loop_assigns_map;

if(loop_contract_config.apply_loop_contracts)
{
messaget log(message_handler);
Expand All @@ -526,9 +526,23 @@ dfcc_cfg_infot::dfcc_cfg_infot(

auto topsorted = loop_nesting_graph.topsort();

bool has_loops_with_contracts = false;
for(const auto idx : topsorted)
{
topsorted_loops.push_back(idx);
has_loops_with_contracts |= has_contract(
loop_nesting_graph[idx].latch, loop_contract_config.check_side_effect);
}

// We infer loop assigns for all loops in the function.
if(has_loops_with_contracts)
{
dfcc_infer_loop_assigns_for_function(
inferred_loop_assigns_map,
goto_model.goto_functions,
goto_function,
message_handler,
ns);
}
}

Expand All @@ -548,10 +562,11 @@ dfcc_cfg_infot::dfcc_cfg_infot(

// generate dfcc_cfg_loop_info for loops and add to loop_info_map
dirtyt dirty(goto_function);
local_may_aliast local_may_alias(goto_function);

for(const auto &loop_id : topsorted_loops)
{
auto inferred_loop_assigns =
inferred_loop_assigns_map[loop_nesting_graph[loop_id].latch->loop_number];
loop_info_map.insert(
{loop_id,
gen_dfcc_loop_info(
Expand All @@ -561,7 +576,7 @@ dfcc_cfg_infot::dfcc_cfg_infot(
goto_function,
loop_info_map,
dirty,
local_may_alias,
inferred_loop_assigns,
loop_contract_config.check_side_effect,
message_handler,
library,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ Date: March 2023
#include <util/std_expr.h>
#include <util/symbol_table.h>

#include <goto-programs/goto_model.h>
#include <goto-programs/goto_program.h>

#include <goto-instrument/contracts/loop_contract_config.h>
Expand Down Expand Up @@ -242,6 +243,7 @@ class dfcc_cfg_infot
{
public:
dfcc_cfg_infot(
goto_modelt &goto_model,
const irep_idt &function_id,
goto_functiont &goto_function,
const exprt &top_level_write_set,
Expand Down
Loading
Loading