Skip to content

Interpreter: replace assert by invariants #1281

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.

Sign up for GitHub

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 1 commit into from
Aug 29, 2017
Merged

Interpreter: replace assert by invariants #1281

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 10 additions & 7 deletions src/goto-programs/interpreter.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Author: Daniel Kroening, kroening@kroening.com
#include <algorithm>
#include <string.h>

#include <util/invariant.h>
#include <util/std_types.h>
#include <util/symbol_table.h>
#include <util/ieee_float.h>
Expand Down Expand Up @@ -380,7 +381,9 @@ void interpretert::execute_other()
const irep_idt &statement=pc->code.get_statement();
if(statement==ID_expression)
{
assert(pc->code.operands().size()==1);
DATA_INVARIANT(
pc->code.operands().size()==1,
"expression statement expected to have one operand");
mp_vectort rhs;
Copy link
Member

Choose a reason for hiding this comment

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

I would actually prefer to_code_expression(pc->code).expression() instead of the invariant/assertion here

evaluate(pc->code.op0(), rhs);
}
Expand Down Expand Up @@ -409,7 +412,7 @@ void interpretert::execute_other()

void interpretert::execute_decl()
{
assert(pc->code.get_statement()==ID_decl);
PRECONDITION(pc->code.get_statement()==ID_decl);
}

/// retrieves the member at offset
Expand Down Expand Up @@ -515,7 +518,7 @@ exprt interpretert::get_value(
std::size_t offset)
{
const typet real_type=ns.follow(type);
assert(!rhs.empty());
PRECONDITION(!rhs.empty());

if(real_type.id()==ID_struct)
{
Expand Down Expand Up @@ -807,7 +810,6 @@ void interpretert::execute_function_call()
const code_typet::parametert &a=parameters[i];
exprt symbol_expr(ID_symbol, a.type());
symbol_expr.set(ID_identifier, a.get_identifier());
assert(i<argument_values.size());
assign(evaluate_address(symbol_expr), argument_values[i]);
}

Expand All @@ -822,8 +824,8 @@ void interpretert::execute_function_call()
if(it!=function_input_vars.end())
{
mp_vectort value;
assert(!it->second.empty());
assert(!it->second.front().return_assignments.empty());
PRECONDITION(!it->second.empty());
PRECONDITION(!it->second.front().return_assignments.empty());
evaluate(it->second.front().return_assignments.back().value, value);
if(return_value_address>0)
{
Expand Down Expand Up @@ -1011,7 +1013,8 @@ size_t interpretert::get_size(const typet &type)
// overflow behaviour.
exprt size_const=from_integer(i[0], size_expr.type());
mp_integer size_mp;
assert(!to_integer(size_const, size_mp));
bool ret=to_integer(size_const, size_mp);
CHECK_RETURN(!ret);
return subtype_size*integer2unsigned(size_mp);
Copy link
Member

Choose a reason for hiding this comment

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

A classic.

}
return subtype_size;
Expand Down
5 changes: 3 additions & 2 deletions src/goto-programs/interpreter_class.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Author: Daniel Kroening, kroening@kroening.com
#include <stack>

#include <util/arith_tools.h>
#include <util/invariant.h>
#include <util/sparse_vector.h>

#include "goto_functions.h"
Expand Down Expand Up @@ -113,7 +114,7 @@ class interpretert:public messaget
auto lower_bound=inverse_memory_map.lower_bound(address);
if(lower_bound->first!=address)
{
assert(lower_bound!=inverse_memory_map.begin());
CHECK_RETURN(lower_bound!=inverse_memory_map.begin());
--lower_bound;
}
return *lower_bound;
Expand All @@ -131,7 +132,7 @@ class interpretert:public messaget

std::size_t base_address_to_alloc_size(std::size_t address) const
{
assert(address_to_offset(address)==0);
PRECONDITION(address_to_offset(address)==0);
auto upper_bound=inverse_memory_map.upper_bound(address);
std::size_t next_alloc_address=
upper_bound==inverse_memory_map.end() ?
Expand Down
12 changes: 7 additions & 5 deletions src/goto-programs/interpreter_evaluate.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ Author: Daniel Kroening, kroening@kroening.com

#include "interpreter_class.h"

#include <cassert>
#include <iostream>
#include <sstream>

#include <util/ieee_float.h>
#include <util/invariant.h>
#include <util/fixedbv.h>
#include <util/std_expr.h>
#include <util/pointer_offset_size.h>
Expand Down Expand Up @@ -911,7 +911,7 @@ void interpretert::evaluate(
if(expr.op0().id()==ID_array)
{
const auto &ops=expr.op0().operands();
assert(read_from_index.is_long());
DATA_INVARIANT(read_from_index.is_long(), "index is too large");
if(read_from_index>=0 && read_from_index<ops.size())
{
evaluate(ops[read_from_index.to_long()], dest);
Expand All @@ -924,12 +924,14 @@ void interpretert::evaluate(
// This sort of construct comes from boolbv_get, but doesn't seem
// to have an exprt yet. Its operands are a list of key-value pairs.
const auto &ops=expr.op0().operands();
assert(ops.size()%2==0);
DATA_INVARIANT(
ops.size()%2==0,
"array-list has odd number of operands");
for(size_t listidx=0; listidx!=ops.size(); listidx+=2)
{
mp_vectort elem_idx;
evaluate(ops[listidx], elem_idx);
assert(elem_idx.size()==1);
CHECK_RETURN(elem_idx.size()==1);
if(elem_idx[0]==read_from_index)
{
evaluate(ops[listidx+1], dest);
Expand Down Expand Up @@ -1177,7 +1179,7 @@ mp_integer interpretert::evaluate_address(
if(expr.operands().size()!=1)
throw "typecast expects one operand";

assert(expr.type().id()==ID_pointer);
PRECONDITION(expr.type().id()==ID_pointer);

return evaluate_address(expr.op0(), fail_quietly);
}
Expand Down
9 changes: 5 additions & 4 deletions src/util/sparse_vector.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,10 @@ Author: Romain Brenguier
#ifndef CPROVER_UTIL_SPARSE_VECTOR_H
#define CPROVER_UTIL_SPARSE_VECTOR_H

#include "invariant.h"

#include <cstdint>
#include <map>
#include <assert.h>

template<class T> class sparse_vectort
{
Expand All @@ -29,13 +30,13 @@ template<class T> class sparse_vectort

const T &operator[](uint64_t idx) const
{
assert(idx<_size && "index out of range");
INVARIANT(idx<_size, "index out of range");
return underlying[idx];
Copy link
Member

Choose a reason for hiding this comment

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

These are really preconditions...

}

T &operator[](uint64_t idx)
{
assert(idx<_size && "index out of range");
INVARIANT(idx<_size, "index out of range");
return underlying[idx];
}

Expand All @@ -46,7 +47,7 @@ template<class T> class sparse_vectort

void resize(uint64_t new_size)
{
assert(new_size>=_size && "sparse vector can't be shrunk (yet)");
INVARIANT(new_size>=_size, "sparse vector can't be shrunk (yet)");
_size=new_size;
}

Expand Down