hu.bme.mit.theta.xcfa.cli.utils.WitnessWriter Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of theta-xcfa-cli Show documentation
Show all versions of theta-xcfa-cli Show documentation
Xcfa Cli subproject in the Theta model checking framework
/*
* Copyright 2024 Budapest University of Technology and Economics
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package hu.bme.mit.theta.xcfa.cli.utils;
import hu.bme.mit.theta.common.visualization.Edge;
import hu.bme.mit.theta.common.visualization.Graph;
import hu.bme.mit.theta.common.visualization.Node;
import hu.bme.mit.theta.common.visualization.writer.AbstractGraphWriter;
import java.io.IOException;
import java.io.InputStream;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.security.DigestInputStream;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.TimeZone;
/**
* Class for writing graphs in the SV-Comp witness format. it accepts a graph, which will be the
* content of the witness (labels of the graph have to already be in the witness format)
* Limitations: - All node attributes, except labels are ignored. - Composite nodes are ignored
* (handled the same as simple nodes. - All edge attributes, except labels are ignored.
*/
public final class WitnessWriter extends AbstractGraphWriter {
private final String programHash;
private final boolean isViolationWitness;
private final String toolName = "theta"; // TODO maybe we should add the version number to this field as well
private final String sourceCodeLang = "C";
private final String architecture; // TODO add 64bit option later
private final String specification;
private final String programFile;
public static WitnessWriter createViolationWitnessWriter(String programFile,
String specification, boolean is64bit) {
return new WitnessWriter(programFile, specification, true, is64bit);
}
public static WitnessWriter createCorrectnessWitnessWriter(String programFile,
String specification, boolean is64bit) {
return new WitnessWriter(programFile, specification, false, is64bit);
}
private WitnessWriter(String programFile, String specification, boolean isViolationWitness,
boolean is64bit) {
programHash = createTaskHash(programFile);
this.isViolationWitness = isViolationWitness;
this.specification = specification;
this.programFile = programFile;
if (is64bit) {
this.architecture = "64bit";
} else {
this.architecture = "32bit";
}
}
@Override
public String writeString(Graph graph) {
final StringBuilder sb = new StringBuilder();
printKeys(sb);
sb.append("").append(System.lineSeparator());
printGraphKeyValues(sb);
graph.getRootNodes().forEach(n -> printNode(n, sb));
for (final Node node : graph.getNodes()) {
printEdges(node, sb);
}
sb.append(" ");
sb.append(System.lineSeparator());
sb.append("");
return sb.toString();
}
// TODO should this be a bit more flexible or should we add keys we don't use for now, but we might use in the future?
private void printKeys(StringBuilder sb) {
sb.append("").append(System.lineSeparator());
sb.append(
"")
.append(System.lineSeparator());
appendKeyLine(sb, "sourcecodelang", "string", "graph", "sourcecodelang");
appendKeyLine(sb, "creationtime", "string", "graph", "creationtime");
appendKeyLine(sb, "witness-type", "string", "graph", "witness-type");
appendKeyLine(sb, "producer", "string", "graph", "producer");
appendKeyLine(sb, "architecture", "string", "graph", "architecture");
appendKeyLine(sb, "programHash", "string", "graph", "programhash");
appendKeyLine(sb, "programfile", "string", "graph", "programfile");
appendKeyLine(sb, "specification", "string", "graph", "specification");
appendKeyLine(sb, "startline", "string", "edge", "startline");
appendKeyLine(sb, "endline", "string", "edge", "endline");
appendKeyLine(sb, "startoffset", "string", "edge", "startoffset");
appendKeyLine(sb, "assumption", "string", "edge", "assumption");
appendKeyLine(sb, "control", "string", "edge", "control");
// these two are for us, they aren't sv-comp witness keys
appendKeyLine(sb, "stmt", "string", "edge", "stmt");
appendKeyLine(sb, "expl-state", "string", "node", "expl-state");
if (isViolationWitness) {
appendKeyWithDefaultValue(sb, "entry", "string", "node", "entry", "false");
appendKeyWithDefaultValue(sb, "violation", "string", "node", "violation", "false");
} else {
appendKeyWithDefaultValue(sb, "invariant", "string", "node", "invariant", "true");
}
}
private void printGraphKeyValues(StringBuilder sb) {
if (isViolationWitness) {
appendDataNode(sb, "witness-type", "violation_witness");
} else {
appendDataNode(sb, "witness-type", "correctness_witness");
}
appendDataNode(sb, "producer", toolName);
appendDataNode(sb, "sourcecodelang", sourceCodeLang);
appendDataNode(sb, "specification", specification);
appendDataNode(sb, "programfile", programFile);
appendDataNode(sb, "programhash", programHash);
appendDataNode(sb, "architecture", architecture);
TimeZone tz = TimeZone.getTimeZone("UTC");
DateFormat df = new SimpleDateFormat(
"yyyy-MM-dd'T'HH:mm:ss'Z'"); // Quoted "Z" to indicate UTC, no timezone offset
df.setTimeZone(tz);
String ISOdate = df.format(new Date());
appendDataNode(sb, "creationtime", ISOdate);
}
private void appendDataNode(StringBuilder sb, String key, String value) {
sb.append("").append(value).append("")
.append(System.lineSeparator());
}
private void appendKeyLine(StringBuilder sb, String attrName, String attrType,
String forElement, String id) {
sb.append("");
sb.append(System.lineSeparator());
sb.append("\t");
sb.append(defaultValue);
sb.append(" \n");
sb.append(System.lineSeparator());
sb.append(" ");
sb.append(System.lineSeparator());
}
private void printNode(final Node node, final StringBuilder sb) {
if (node.getAttributes().getLabel().equals("")) {
sb.append("")
.append(System.lineSeparator());
} else {
sb.append("")
.append(System.lineSeparator());
sb.append(node.getAttributes().getLabel()).append(System.lineSeparator()); // TODO tabs?
sb.append(" ").append(System.lineSeparator());
}
}
private void printEdges(final Node node, final StringBuilder sb) {
for (final Edge edge : node.getOutEdges()) {
sb.append("")
.append(System.lineSeparator());
sb.append(edge.getAttributes().getLabel()).append(System.lineSeparator()); // TODO tabs?
sb.append(" ").append(System.lineSeparator());
}
}
public static String createTaskHash(String programFile) {
MessageDigest md = null;
try {
md = MessageDigest.getInstance("SHA-256");
} catch (NoSuchAlgorithmException e) {
e.printStackTrace();
}
try (InputStream is = Files.newInputStream(Paths.get(programFile));
DigestInputStream dis = new DigestInputStream(is, md)) {
while (dis.read() != -1) {
}
} catch (IOException e) {
e.printStackTrace();
}
assert md != null;
byte[] digest = md.digest();
return bytesToHex(digest);
}
// source: https://www.baeldung.com/sha-256-hashing-java
private static String bytesToHex(byte[] hash) {
StringBuilder hexString = new StringBuilder(2 * hash.length);
for (int i = 0; i < hash.length; i++) {
String hex = Integer.toHexString(0xff & hash[i]);
if (hex.length() == 1) {
hexString.append('0');
}
hexString.append(hex);
}
return hexString.toString();
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy