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.

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

Report invariants enforced by vacuous requirements #675

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from

Conversation

henkele
Copy link
Contributor

@henkele henkele commented Aug 27, 2024

This adds a ReqCheckVacuousResult to report invariants that are enforced by vacuous requirements.
A vacuous requirement enforces an invariant if there exists only one location in its PEA representation in which the maximal phase of its corresponding countertrace is not active.
Reporting such invariants may help to better understand vacuous results (e.g. as in #530) and their implications, as for example needed to approach #438.

Copy link
Member

@danieldietsch danieldietsch left a comment

Choose a reason for hiding this comment

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

Looks good. Only required changes:

  • the names in the copyright (it makes maintaining these things much easier)
  • save actions wrt. final

// Return a ReqCheckVacuousResult, i.e., a ReqCheckFailResult with additional
// VacuityAnnotation containing an invariant that might be enforced by the
// vacuous requirement.
VacuityAnnotation enforcedInv = VacuityAnnotation
Copy link
Member

Choose a reason for hiding this comment

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

Should be final -- do you have your save actions configured correctly?

if (pnr > 0) {
for (int i = 0; i < phases.size(); i++) {
final PhaseBits bits = phases.get(i).getPhaseBits();
if (bits == null || (bits.getActive() & 1 << pnr - 1) == 0) {
checkReached.add(genComparePhaseCounter(i, mSymbolTable.getPcName(aut), bl));
}
// Store state invariants of PEA locations where max DC phase is not active.
if (bits.getActive() < (1 << pnr - 1)) {
Copy link
Member

Choose a reason for hiding this comment

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

If the mask 1 << pnr - 1 is now used multiple times, perhaps give it its own variable and a nice name. I am struggling a bit to understand what exactly the condition here is -- its weird for me to see a mask used as mask and as comparison.

if (pnr > 0) {
for (int i = 0; i < phases.size(); i++) {
final PhaseBits bits = phases.get(i).getPhaseBits();
if (bits == null || (bits.getActive() & 1 << pnr - 1) == 0) {
checkReached.add(genComparePhaseCounter(i, mSymbolTable.getPcName(aut), bl));
}
// Store state invariants of PEA locations where max DC phase is not active.
if (bits.getActive() < (1 << pnr - 1)) {
enforcedInv.put(phases.get(i), phases.get(i).getStateInv());
Copy link
Member

Choose a reason for hiding this comment

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

As phases.get(i) is now also used multiple times, it would be nice to have a separate var for it as well

VacuityAnnotation enforcedInv = VacuityAnnotation
.getAnnotation(((BoogieIcfgLocation) element).getBoogieASTNode());
return new ReqCheckVacuousResult<>(element, plugin,
enforcedInv.getInvariant().toString());
Copy link
Member

Choose a reason for hiding this comment

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

It would be slightly cheaper to already check here if the invariant is different from CDD.TRUE and only then create the string, else use null.

@@ -0,0 +1,58 @@
/*
* Copyright (C) 2024 University of Freiburg
Copy link
Member

Choose a reason for hiding this comment

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

Please also add your name and email address if you create a new file.

public String getLongDescription() {
final StringBuilder sb = new StringBuilder();
sb.append(getShortDescription());
if (mEnforcedInvariant != CDD.TRUE.toString()) {
Copy link
Member

Choose a reason for hiding this comment

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

Check for null instead of CDD.TRUE.toString(), and move stringbuilder into the if, e.g.:

if (mEnforcedInvariant != null) {
  final StringBuilder sb = new StringBuilder();
  sb.append(getShortDescription());
  ...
  return sb...
else {
  return getShortDescription();
}

@@ -0,0 +1,61 @@
/*
* Copyright (C) 2024 University of Freiburg
*
Copy link
Member

Choose a reason for hiding this comment

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

Add your name+email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants