Skip to content
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

Call goto-instrument with DFCC only once #3642

Merged
merged 4 commits into from
Oct 25, 2024
+40 −40
Merged

Call goto-instrument with DFCC only once #3642

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3e2e28e
Call DFCC only once
qinheping Oct 24, 2024
7e78b01
Combine two instrument_contracts functions
qinheping Oct 25, 2024
81d45c0
Merge branch 'main' into call_dfcc_once
qinheping Oct 25, 2024
728d985
Always assume mallo not fail in goto-instrument
qinheping Oct 25, 2024
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
80 changes: 40 additions & 40 deletions kani-driver/src/call_goto_instrument.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,16 +37,12 @@ impl KaniSession {
self.goto_sanity_check(output)?;
}

self.instrument_contracts(harness, output)?;

if self
let is_loop_contracts_enabled = self
.args
.common_args
.unstable_features
.contains(kani_metadata::UnstableFeature::LoopContracts)
{
self.instrument_loop_contracts(harness, output)?;
}
.contains(kani_metadata::UnstableFeature::LoopContracts);
self.instrument_contracts(harness, is_loop_contracts_enabled, output)?;

if self.args.checks.undefined_function_on() {
self.add_library(output)?;
Expand Down Expand Up @@ -172,42 +168,46 @@ impl KaniSession {
self.call_goto_instrument(args)
}

/// Make CBMC enforce a function contract.
pub fn instrument_contracts(&self, harness: &HarnessMetadata, file: &Path) -> Result<()> {
let Some(assigns) = harness.contract.as_ref() else { return Ok(()) };
/// Apply annotated function contracts and loop contracts with goto-instrument.
pub fn instrument_contracts(
&self,
harness: &HarnessMetadata,
is_loop_contracts_enabled: bool,
file: &Path,
) -> Result<()> {
// Do nothing if neither loop contracts nor function contracts is enabled.
if !is_loop_contracts_enabled && harness.contract.is_none() {
return Ok(());
}

let mut args: Vec<OsString> = vec![
"--dfcc".into(),
(&harness.mangled_name).into(),
"--enforce-contract".into(),
assigns.contracted_function_name.as_str().into(),
"--no-malloc-may-fail".into(),
file.into(),
file.into(),
];
if let Some(tracker) = &assigns.recursion_tracker {
args.push("--nondet-static-exclude".into());
args.push(tracker.as_str().into());
let mut args: Vec<OsString> =
vec!["--dfcc".into(), (&harness.mangled_name).into(), "--no-malloc-may-fail".into()];

if is_loop_contracts_enabled {
args.append(&mut vec![
"--apply-loop-contracts".into(),
"--loop-contracts-no-unwind".into(),
// Because loop contracts now are wrapped in a closure which will be a side-effect expression in CBMC even they
// may not contain side-effect. So we disable the side-effect check for now and will implement a better check
// instead of simply rejecting function calls and statement expressions.
// See issue: diffblue/cbmc#8393
"--disable-loop-contracts-side-effect-check".into(),
]);
}
self.call_goto_instrument(&args)
}

/// Apply annotated loop contracts.
pub fn instrument_loop_contracts(&self, harness: &HarnessMetadata, file: &Path) -> Result<()> {
let args: Vec<OsString> = vec![
"--dfcc".into(),
(&harness.mangled_name).into(),
"--apply-loop-contracts".into(),
"--loop-contracts-no-unwind".into(),
"--no-malloc-may-fail".into(),
// Because loop contracts now are wrapped in a closure which will be a side-effect expression in CBMC even they
// may not contain side-effect. So we disable the side-effect check for now and will implement a better check
// instead of simply rejecting function calls and statement expressions.
// See issue: diffblue/cbmc#8393
"--disable-loop-contracts-side-effect-check".into(),
file.into(),
file.into(),
];
if let Some(assigns) = harness.contract.as_ref() {
args.push("--enforce-contract".into());
args.push(assigns.contracted_function_name.as_str().into());

if let Some(tracker) = &assigns.recursion_tracker {
args.push("--nondet-static-exclude".into());
args.push(tracker.as_str().into());
}
}

args.push(file.into());
args.push(file.into());

self.call_goto_instrument(&args)
}

Expand Down
Loading