src/main/gov/nasa/jpf/listener/ConflictTracker.java

   1 /*
   2  * Copyright (C) 2014, United States Government, as represented by the
   3  * Administrator of the National Aeronautics and Space Administration.
   4  * All rights reserved.
   5  *
   6  * The Java Pathfinder core (jpf-core) platform is licensed under the
   7  * Apache License, Version 2.0 (the "License"); you may not use this file except
   8  * in compliance with the License. You may obtain a copy of the License at
   9  *
  10  *        http://www.apache.org/licenses/LICENSE-2.0.
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18 package gov.nasa.jpf.listener;
  19
  20 import gov.nasa.jpf.Config;
  21 import gov.nasa.jpf.JPF;
  22 import gov.nasa.jpf.ListenerAdapter;
  23 import gov.nasa.jpf.search.Search;
  24 import gov.nasa.jpf.jvm.bytecode.*;
  25 import gov.nasa.jpf.vm.*;
  26 import gov.nasa.jpf.vm.bytecode.LocalVariableInstruction;
  27 import gov.nasa.jpf.vm.bytecode.ReadInstruction;
  28 import gov.nasa.jpf.vm.bytecode.StoreInstruction;
  29 import gov.nasa.jpf.vm.bytecode.WriteInstruction;
  30
  31 import java.io.PrintWriter;
  32
  33 import java.util.*;
  34
  35 /**
  36  * Listener using data flow analysis to find conflicts between smartApps.
  37  **/
  38
  39 public class ConflictTracker extends ListenerAdapter {
  40
  41   private final PrintWriter out;
  42   private final HashSet<String> conflictSet = new HashSet<String>(); // Variables we want to track
  43   private final HashSet<String> appSet = new HashSet<String>(); // Apps we want to find their conflicts
  44   private final HashSet<String> manualSet = new HashSet<String>(); // Writer classes with manual inputs to detect direct-direct(No Conflict) interactions
  45   private final HashMap<Integer, Node> nodes = new HashMap<Integer, Node>(); // Nodes of a graph
  46   private ArrayList<NameValuePair> tempSetSet = new ArrayList<NameValuePair>();
  47   private long timeout;
  48   private long startTime;
  49   private Node parentNode = new Node(-2);
  50   private String operation;
  51   private String detail;
  52   private String errorMessage;
  53   private int depth;
  54   private int id;
  55   private boolean conflictFound = false;
  56   private boolean manual = false;
  57
  58   private final String SET_LOCATION_METHOD = "setLocationMode";
  59   private final String LOCATION_VAR = "locationMode";
  60
  61   public ConflictTracker(Config config, JPF jpf) {
  62     out = new PrintWriter(System.out, true);
  63
  64     String[] conflictVars = config.getStringArray("variables");
  65     // We are not tracking anything if it is null
  66     if (conflictVars != null) {
  67       for (String var : conflictVars) {
  68         conflictSet.add(var);
  69       }
  70     }
  71     String[] apps = config.getStringArray("apps");
  72     // We are not tracking anything if it is null
  73     if (apps != null) {
  74       for (String var : apps) {
  75         appSet.add(var);
  76       }
  77     }
  78     String[] manualClasses = config.getStringArray("manualClasses");
  79     // We are not tracking anything if it is null
  80     if (manualClasses != null) {
  81       for (String var : manualClasses) {
  82         manualSet.add(var);
  83       }
  84     }
  85
  86     // Timeout input from config is in minutes, so we need to convert into millis
  87     timeout = config.getInt("timeout", 0) * 60 * 1000;
  88     startTime = System.currentTimeMillis();
  89   }
  90
  91   boolean propagateTheChange(Node currentNode) {
  92         HashSet<Node> changed = new HashSet<Node>(currentNode.getSuccessors());
  93
  94         while(!changed.isEmpty()) {
  95                 // Get the first element of HashSet and remove it from the changed set
  96                 Node nodeToProcess = changed.iterator().next();
  97                 changed.remove(nodeToProcess);
  98
  99                 // Update the edge
 100                 boolean isChanged = updateEdge(currentNode, nodeToProcess);
 101
 102                 // Check for a conflict in this transition(currentNode -> nodeToProcess)
 103                 if (checkForConflict(nodeToProcess))
 104                         return true;
 105
 106                 // Checking if the out set has changed or not(Add its successors to the change list!)
 107                 if (isChanged) {
 108                         propagateTheChange(nodeToProcess);
 109                 }
 110       }
 111
 112       return false;
 113   }
 114
 115   String createErrorMessage(NameValuePair pair, HashMap<String, String> valueMap, HashMap<String, Integer> writerMap) {
 116         String message = "Conflict found between the two apps. App"+pair.getAppNum()+
 117                          " has written the value: "+pair.getValue()+
 118                          " to the variable: "+pair.getVarName()+" while App"+
 119                          writerMap.get(pair.getVarName())+" is overwriting the value: "
 120                          +valueMap.get(pair.getVarName())+" to the same variable!";
 121         System.out.println(message);
 122         return message;
 123   }
 124
 125   boolean checkForConflict(Node nodeToProcess) {
 126         HashMap<String, String> valueMap = new HashMap<String, String>(); // HashMap from varName to value
 127         HashMap<String, Integer> writerMap = new HashMap<String, Integer>(); // HashMap from varName to appNum
 128
 129         // Update the valueMap
 130         for (int i = 0;i < nodeToProcess.getSetSet().size();i++) {
 131                 NameValuePair nameValuePair = nodeToProcess.getSetSet().get(i);
 132
 133                 if (valueMap.containsKey(nameValuePair.getVarName())) {
 134                         // Check if we have a same writer
 135                         if (!writerMap.get(nameValuePair.getVarName()).equals(nameValuePair.getAppNum())) {
 136                                 // Check if we have a conflict or not
 137                                 if (!valueMap.get(nameValuePair.getVarName()).equals(nameValuePair.getValue())) {
 138                                         errorMessage = createErrorMessage(nameValuePair, valueMap, writerMap);
 139                                         return true;
 140                                 } else { // We have two writers writing the same value
 141                                         writerMap.put(nameValuePair.getVarName(), 3); // 3 represents both apps
 142                                 }
 143                         } else {
 144                                 // Check if we have more than one value with the same writer
 145                                 if (!valueMap.get(nameValuePair.getVarName()).equals(nameValuePair.getValue())) {
 146                                         valueMap.put(nameValuePair.getVarName(), "twoValue"); // We have one writer writing more than one value in a same event
 147                                 }
 148                         }
 149                 } else {
 150                         valueMap.put(nameValuePair.getVarName(), nameValuePair.getValue());
 151                         writerMap.put(nameValuePair.getVarName(), nameValuePair.getAppNum());
 152                 }
 153         }
 154
 155         // Comparing the outSet to setSet
 156         for (NameValuePair i : nodeToProcess.getOutSet()) {
 157                 if (valueMap.containsKey(i.getVarName())) {
 158                         String value = valueMap.get(i.getVarName());
 159                         Integer writer = writerMap.get(i.getVarName());
 160                         if ((value != null)&&(writer != null)) {
 161                                 if (!value.equals(i.getValue())&&!writer.equals(i.getAppNum())) { // We have different values
 162                                         errorMessage = createErrorMessage(i, valueMap, writerMap);
 163                                         return true;
 164                                 }
 165                         }
 166                 }
 167         }
 168
 169         return false;
 170   }
 171
 172   boolean updateEdge(Node parentNode, Node currentNode) {
 173         ArrayList<NameValuePair> setSet = currentNode.getSetSetMap().get(parentNode);
 174         HashSet<String> updatedVarNames = new HashSet<String>();
 175         boolean isChanged = false;
 176
 177         if (setSet != null) {
 178                 for (int i = 0;i < setSet.size();i++) {
 179                         updatedVarNames.add(setSet.get(i).getVarName());
 180                 }
 181         }
 182
 183         for (NameValuePair i : parentNode.getOutSet()) {
 184                 if (!updatedVarNames.contains(i.getVarName()))
 185                         isChanged |= currentNode.getOutSet().add(i);
 186         }
 187
 188         if (setSet != null) {
 189                 for (int i = 0;i < setSet.size();i++) {
 190                         if (currentNode.getOutSet().contains(setSet.get(i)))
 191                                 currentNode.getOutSet().remove(setSet.get(i));
 192                         isChanged |= currentNode.getOutSet().add(setSet.get(i));
 193                 }
 194         }
 195
 196         return isChanged;
 197   }
 198
 199   static class Node {
 200         Integer id;
 201         HashSet<Node> predecessors = new HashSet<Node>();
 202         HashSet<Node> successors = new HashSet<Node>();
 203         HashSet<NameValuePair> outSet = new HashSet<NameValuePair>();
 204         HashMap<Node, ArrayList<NameValuePair>> setSetMap = new HashMap<Node, ArrayList<NameValuePair>>();
 205         ArrayList<NameValuePair> setSet = new ArrayList<NameValuePair>();
 206
 207
 208         Node(Integer id) {
 209           this.id = id;
 210         }
 211
 212         void addPredecessor(Node node) {
 213           predecessors.add(node);
 214         }
 215
 216         void addSuccessor(Node node) {
 217           successors.add(node);
 218         }
 219
 220         void setSetSet(ArrayList<NameValuePair> setSet, boolean isManual) {
 221           if (isManual)
 222             this.setSet = new ArrayList<NameValuePair>();
 223
 224           for (int i = 0;i < setSet.size();i++) {
 225             this.setSet.add(new NameValuePair(setSet.get(i).getAppNum(), setSet.get(i).getValue(),
 226                                               setSet.get(i).getVarName(), setSet.get(i).getIsManual()));
 227             }
 228         }
 229
 230         Integer getId() {
 231                 return id;
 232         }
 233
 234         HashSet<Node> getPredecessors() {
 235                 return predecessors;
 236         }
 237
 238         HashSet<Node> getSuccessors() {
 239                 return successors;
 240         }
 241
 242         ArrayList<NameValuePair> getSetSet() {
 243                 return setSet;
 244         }
 245
 246         HashSet<NameValuePair> getOutSet() {
 247                 return outSet;
 248         }
 249
 250         HashMap<Node, ArrayList<NameValuePair>> getSetSetMap() {
 251                 return setSetMap;
 252         }
 253   }
 254
 255   static class NameValuePair {
 256         Integer appNum;
 257         String value;
 258         String varName;
 259         boolean isManual;
 260
 261         NameValuePair(Integer appNum, String value, String varName, boolean isManual) {
 262                 this.appNum = appNum;
 263                 this.value = value;
 264                 this.varName = varName;
 265                 this.isManual = isManual;
 266         }
 267
 268         void setAppNum(Integer appNum) {
 269                 this.appNum = appNum;
 270         }
 271
 272         void setValue(String value) {
 273                 this.value = value;
 274         }
 275
 276         void setVarName(String varName) {
 277                 this.varName = varName;
 278         }
 279
 280     void setIsManual(String varName) {
 281                 this.isManual = isManual;
 282         }
 283
 284         Integer getAppNum() {
 285                 return appNum;
 286         }
 287
 288         String getValue() {
 289                 return value;
 290         }
 291
 292         String getVarName() {
 293                 return varName;
 294         }
 295
 296         boolean getIsManual() {
 297                 return isManual;
 298         }
 299
 300         @Override
 301         public boolean equals(Object o) {
 302       if (o instanceof NameValuePair) {
 303         NameValuePair other = (NameValuePair) o;
 304         if (varName.equals(other.getVarName()))
 305           return appNum.equals(other.getAppNum());
 306       }
 307       return false;
 308         }
 309
 310         @Override
 311         public int hashCode() {
 312                 return appNum.hashCode() * 31 + varName.hashCode();
 313         }
 314   }
 315
 316   @Override
 317   public void stateRestored(Search search) {
 318     id = search.getStateId();
 319     depth = search.getDepth();
 320     operation = "restored";
 321     detail = null;
 322
 323     out.println("The state is restored to state with id: "+id+", depth: "+depth);
 324
 325     // Update the parent node
 326     if (nodes.containsKey(id)) {
 327           parentNode = nodes.get(id);
 328     } else {
 329           parentNode = new Node(id);
 330     }
 331   }
 332
 333   @Override
 334   public void searchStarted(Search search) {
 335     out.println("----------------------------------- search started");
 336   }
 337
 338
 339   @Override
 340   public void stateAdvanced(Search search) {
 341     String theEnd = null;
 342     id = search.getStateId();
 343     depth = search.getDepth();
 344     operation = "forward";
 345
 346     // Add the node to the list of nodes
 347     if (nodes.get(id) == null)
 348         nodes.put(id, new Node(id));
 349
 350     Node currentNode = nodes.get(id);
 351
 352     // Update the setSet for this new node
 353     currentNode.setSetSet(tempSetSet, manual);
 354     tempSetSet = new ArrayList<NameValuePair>();
 355     manual = false;
 356
 357     if (search.isNewState()) {
 358       detail = "new";
 359     } else {
 360       detail = "visited";
 361     }
 362
 363     if (search.isEndState()) {
 364       out.println("This is the last state!");
 365       theEnd = "end";
 366     }
 367
 368     out.println("The state is forwarded to state with id: "+id+", depth: "+depth+" which is "+detail+" state: "+"% "+theEnd);
 369
 370     // Updating the predecessors for this node
 371     // Check if parent node is already in successors of the current node or not
 372     if (!(currentNode.getPredecessors().contains(parentNode)))
 373         currentNode.addPredecessor(parentNode);
 374
 375     // Update the successors for this node
 376     // Check if current node is already in successors of the parent node or not
 377     if (!(parentNode.getSuccessors().contains(currentNode)))
 378         parentNode.addSuccessor(currentNode);
 379
 380
 381     // Update the setSetMap of the current node
 382     for (Node i : currentNode.getPredecessors()) {
 383         currentNode.getSetSetMap().put(i, i.getSetSet());
 384     }
 385
 386     // Update the edge and check if the outset of the current node is changed or not to propagate the change
 387     boolean isChanged = updateEdge(parentNode, currentNode);
 388
 389     // Check for the conflict in this edge
 390     conflictFound = checkForConflict(currentNode);
 391
 392     // Check if the outSet of this state has changed, update all of its successors' sets if any
 393     if (isChanged)
 394         conflictFound = conflictFound || propagateTheChange(currentNode);
 395
 396     // Update the parent node
 397     if (nodes.containsKey(id)) {
 398           parentNode = nodes.get(id);
 399     } else {
 400           parentNode = new Node(id);
 401     }
 402   }
 403
 404   @Override
 405   public void stateBacktracked(Search search) {
 406     id = search.getStateId();
 407     depth = search.getDepth();
 408     operation = "backtrack";
 409     detail = null;
 410
 411     out.println("The state is backtracked to state with id: "+id+", depth: "+depth);
 412
 413     // Update the parent node
 414     if (nodes.containsKey(id)) {
 415           parentNode = nodes.get(id);
 416     } else {
 417           parentNode = new Node(id);
 418     }
 419   }
 420
 421   @Override
 422   public void searchFinished(Search search) {
 423     out.println("----------------------------------- search finished");
 424   }
 425
 426   private String getValue(ThreadInfo ti, Instruction inst, byte type) {
 427     StackFrame frame;
 428     int lo, hi;
 429
 430     frame = ti.getTopFrame();
 431
 432     if ((inst instanceof JVMLocalVariableInstruction) ||
 433         (inst instanceof JVMFieldInstruction))
 434     {
 435       if (frame.getTopPos() < 0)
 436         return(null);
 437
 438       lo = frame.peek();
 439       hi = frame.getTopPos() >= 1 ? frame.peek(1) : 0;
 440
 441       return(decodeValue(type, lo, hi));
 442     }
 443
 444     if (inst instanceof JVMArrayElementInstruction)
 445       return(getArrayValue(ti, type));
 446
 447     return(null);
 448   }
 449
 450   private final static String decodeValue(byte type, int lo, int hi) {
 451     switch (type) {
 452       case Types.T_ARRAY:   return(null);
 453       case Types.T_VOID:    return(null);
 454
 455       case Types.T_BOOLEAN: return(String.valueOf(Types.intToBoolean(lo)));
 456       case Types.T_BYTE:    return(String.valueOf(lo));
 457       case Types.T_CHAR:    return(String.valueOf((char) lo));
 458       case Types.T_DOUBLE:  return(String.valueOf(Types.intsToDouble(lo, hi)));
 459       case Types.T_FLOAT:   return(String.valueOf(Types.intToFloat(lo)));
 460       case Types.T_INT:     return(String.valueOf(lo));
 461       case Types.T_LONG:    return(String.valueOf(Types.intsToLong(lo, hi)));
 462       case Types.T_SHORT:   return(String.valueOf(lo));
 463
 464       case Types.T_REFERENCE:
 465         ElementInfo ei = VM.getVM().getHeap().get(lo);
 466         if (ei == null)
 467           return(null);
 468
 469         ClassInfo ci = ei.getClassInfo();
 470         if (ci == null)
 471           return(null);
 472
 473         if (ci.getName().equals("java.lang.String"))
 474           return('"' + ei.asString() + '"');
 475
 476         return(ei.toString());
 477
 478       default:
 479         System.err.println("Unknown type: " + type);
 480         return(null);
 481      }
 482   }
 483
 484   private String getArrayValue(ThreadInfo ti, byte type) {
 485     StackFrame frame;
 486     int lo, hi;
 487
 488     frame = ti.getTopFrame();
 489     lo    = frame.peek();
 490     hi    = frame.getTopPos() >= 1 ? frame.peek(1) : 0;
 491
 492     return(decodeValue(type, lo, hi));
 493   }
 494
 495   private byte getType(ThreadInfo ti, Instruction inst) {
 496     StackFrame frame;
 497     FieldInfo fi;
 498     String type;
 499
 500     frame = ti.getTopFrame();
 501     if ((frame.getTopPos() >= 0) && (frame.isOperandRef())) {
 502       return (Types.T_REFERENCE);
 503     }
 504
 505     type = null;
 506
 507     if (inst instanceof JVMLocalVariableInstruction) {
 508       type = ((JVMLocalVariableInstruction) inst).getLocalVariableType();
 509     } else if (inst instanceof JVMFieldInstruction){
 510       fi = ((JVMFieldInstruction) inst).getFieldInfo();
 511       type = fi.getType();
 512     }
 513
 514     if (inst instanceof JVMArrayElementInstruction) {
 515       return (getTypeFromInstruction(inst));
 516     }
 517
 518     if (type == null) {
 519       return (Types.T_VOID);
 520     }
 521
 522     return (decodeType(type));
 523   }
 524
 525   private final static byte getTypeFromInstruction(Instruction inst) {
 526     if (inst instanceof JVMArrayElementInstruction)
 527       return(getTypeFromInstruction((JVMArrayElementInstruction) inst));
 528
 529     return(Types.T_VOID);
 530   }
 531
 532   private final static byte decodeType(String type) {
 533     if (type.charAt(0) == '?'){
 534       return(Types.T_REFERENCE);
 535     } else {
 536       return Types.getBuiltinType(type);
 537     }
 538   }
 539
 540   // Find the variable writer
 541   // It should be one of the apps listed in the .jpf file
 542   private String getWriter(List<StackFrame> sfList, HashSet<String> writerSet) {
 543     // Start looking from the top of the stack backward
 544     for(int i=sfList.size()-1; i>=0; i--) {
 545       MethodInfo mi = sfList.get(i).getMethodInfo();
 546       if(!mi.isJPFInternal()) {
 547         String method = mi.getStackTraceName();
 548         // Check against the writers in the writerSet
 549         for(String writer : writerSet) {
 550           if (method.contains(writer)) {
 551             return writer;
 552           }
 553         }
 554       }
 555     }
 556
 557     return null;
 558   }
 559
 560   private void writeWriterAndValue(String writer, String value, String var) {
 561     // Update the temporary Set set.
 562     NameValuePair temp = new NameValuePair(1, value, var, manual);
 563     if (writer.equals("App2"))
 564         temp = new NameValuePair(2, value, var, manual);
 565
 566     tempSetSet.add(temp);
 567   }
 568
 569   @Override
 570   public void instructionExecuted(VM vm, ThreadInfo ti, Instruction nextInsn, Instruction executedInsn) {
 571     if (timeout > 0) {
 572       if (System.currentTimeMillis() - startTime > timeout) {
 573         StringBuilder sbTimeOut = new StringBuilder();
 574         sbTimeOut.append("Execution timeout: " + (timeout / (60 * 1000)) + " minutes have passed!");
 575         Instruction nextIns = ti.createAndThrowException("java.lang.RuntimeException", sbTimeOut.toString());
 576         ti.setNextPC(nextIns);
 577       }
 578     }
 579
 580     if (conflictFound) {
 581       StringBuilder sb = new StringBuilder();
 582       sb.append(errorMessage);
 583       Instruction nextIns = ti.createAndThrowException("java.lang.RuntimeException", sb.toString());
 584       ti.setNextPC(nextIns);
 585     } else {
 586       if (conflictSet.contains(LOCATION_VAR)) {
 587         MethodInfo mi = executedInsn.getMethodInfo();
 588         // Find the last load before return and get the value here
 589         if (mi.getName().equals(SET_LOCATION_METHOD) &&
 590                 executedInsn instanceof ALOAD && nextInsn instanceof ARETURN) {
 591           byte type  = getType(ti, executedInsn);
 592           String value = getValue(ti, executedInsn, type);
 593
 594           // Extract the writer app name
 595           ClassInfo ci = mi.getClassInfo();
 596           String writer = ci.getName();
 597
 598           // Update the temporary Set set.
 599           writeWriterAndValue(writer, value, LOCATION_VAR);
 600         }
 601       } else {
 602         if (executedInsn instanceof WriteInstruction) {
 603           String varId = ((WriteInstruction) executedInsn).getFieldInfo().getFullName();
 604
 605           for (String var : conflictSet) {
 606             if (varId.contains(var)) {
 607               // Get variable info
 608               byte type = getType(ti, executedInsn);
 609               String value = getValue(ti, executedInsn, type);
 610               String writer = getWriter(ti.getStack(), appSet);
 611               // Just return if the writer is not one of the listed apps in the .jpf file
 612               if (writer == null)
 613                 return;
 614
 615               if (getWriter(ti.getStack(), manualSet) != null)
 616                 manual = true;
 617
 618               // Update the temporary Set set.
 619               writeWriterAndValue(writer, value, var);
 620             }
 621           }
 622         }
 623       }
 624     }
 625   }
 626 }