src/main/gov/nasa/jpf/listener/DPORStateReducer.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.ReadInstruction;
  27 import gov.nasa.jpf.vm.bytecode.WriteInstruction;
  28 import gov.nasa.jpf.vm.choice.IntChoiceFromSet;
  29 import gov.nasa.jpf.vm.choice.IntIntervalGenerator;
  30
  31 import java.io.PrintWriter;
  32 import java.util.*;
  33
  34 // TODO: Fix for Groovy's model-checking
  35 // TODO: This is a setter to change the values of the ChoiceGenerator to implement POR
  36 /**
  37  * Simple tool to log state changes.
  38  *
  39  * This DPOR implementation is augmented by the algorithm presented in this SPIN paper:
  40  * http://spinroot.com/spin/symposia/ws08/spin2008_submission_33.pdf
  41  *
  42  * The algorithm is presented on page 11 of the paper. Basically, we create a graph G
  43  * (i.e., visible operation dependency graph)
  44  * that maps inter-related threads/sub-programs that trigger state changes.
  45  * The key to this approach is that we evaluate graph G in every iteration/recursion to
  46  * only update the backtrack sets of the threads/sub-programs that are reachable in graph G
  47  * from the currently running thread/sub-program.
  48  */
  49 public class DPORStateReducer extends ListenerAdapter {
  50
  51   // Information printout fields for verbose mode
  52   private boolean verboseMode;
  53   private boolean stateReductionMode;
  54   private final PrintWriter out;
  55   private String detail;
  56   private int depth;
  57   private int id;
  58   private Transition transition;
  59
  60   // DPOR-related fields
  61   // Basic information
  62   private Integer[] choices;
  63   private Integer[] refChoices; // Second reference to a copy of choices (choices may be modified for fair scheduling)
  64   private int choiceCounter;
  65   private int maxEventChoice;
  66   // Data structure to track the events seen by each state to track cycles (containing all events) for termination
  67   private HashSet<Integer> currVisitedStates; // States being visited in the current execution
  68   private HashSet<Integer> justVisitedStates; // States just visited in the previous choice/event
  69   private HashSet<Integer> prevVisitedStates; // States visited in the previous execution
  70   private HashMap<Integer, HashSet<Integer>> stateToEventMap;
  71   // Data structure to analyze field Read/Write accesses and conflicts
  72   private HashMap<Integer, LinkedList<Integer[]>> backtrackMap;   // Track created backtracking points
  73   private PriorityQueue<Integer> backtrackStateQ;                 // Heap that returns the latest state
  74   private ArrayList<BacktrackPoint> backtrackPointList;           // Record backtrack points (CG, state Id, and choice)
  75   private HashMap<Integer, HashSet<Integer>> conflictPairMap;     // Record conflicting events
  76   private HashSet<String> doneBacktrackSet;                       // Record state ID and trace already constructed
  77   private HashMap<Integer, ReadWriteSet> readWriteFieldsMap;      // Record fields that are accessed
  78   private HashMap<Integer, RestorableVMState> restorableStateMap; // Maps state IDs to the restorable state object
  79
  80   // Visible operation dependency graph implementation (SPIN paper) related fields
  81   private int prevChoiceValue;
  82   private HashMap<Integer, HashSet<Integer>> vodGraphMap; // Visible operation dependency graph (VOD graph)
  83
  84   // Boolean states
  85   private boolean isBooleanCGFlipped;
  86   private boolean isEndOfExecution;
  87
  88   public DPORStateReducer(Config config, JPF jpf) {
  89     verboseMode = config.getBoolean("printout_state_transition", false);
  90     stateReductionMode = config.getBoolean("activate_state_reduction", true);
  91     if (verboseMode) {
  92       out = new PrintWriter(System.out, true);
  93     } else {
  94       out = null;
  95     }
  96     isBooleanCGFlipped = false;
  97     restorableStateMap = new HashMap<>();
  98     initializeStatesVariables();
  99   }
 100
 101   @Override
 102   public void stateRestored(Search search) {
 103     if (verboseMode) {
 104       id = search.getStateId();
 105       depth = search.getDepth();
 106       transition = search.getTransition();
 107       detail = null;
 108       out.println("\n==> DEBUG: The state is restored to state with id: " + id + " -- Transition: " + transition +
 109               " and depth: " + depth + "\n");
 110     }
 111   }
 112
 113   @Override
 114   public void searchStarted(Search search) {
 115     if (verboseMode) {
 116       out.println("\n==> DEBUG: ----------------------------------- search started" + "\n");
 117     }
 118   }
 119
 120   @Override
 121   public void stateAdvanced(Search search) {
 122     if (verboseMode) {
 123       id = search.getStateId();
 124       depth = search.getDepth();
 125       transition = search.getTransition();
 126       if (search.isNewState()) {
 127         detail = "new";
 128       } else {
 129         detail = "visited";
 130       }
 131
 132       if (search.isEndState()) {
 133         out.println("\n==> DEBUG: This is the last state!\n");
 134         detail += " end";
 135       }
 136       out.println("\n==> DEBUG: The state is forwarded to state with id: " + id + " with depth: " + depth +
 137               " which is " + detail + " Transition: " + transition + "\n");
 138     }
 139     if (stateReductionMode) {
 140       updateStateInfo(search);
 141     }
 142   }
 143
 144   @Override
 145   public void stateBacktracked(Search search) {
 146     if (verboseMode) {
 147       id = search.getStateId();
 148       depth = search.getDepth();
 149       transition = search.getTransition();
 150       detail = null;
 151
 152       out.println("\n==> DEBUG: The state is backtracked to state with id: " + id + " -- Transition: " + transition +
 153               " and depth: " + depth + "\n");
 154     }
 155     if (stateReductionMode) {
 156       updateStateInfo(search);
 157     }
 158   }
 159
 160   @Override
 161   public void searchFinished(Search search) {
 162     if (verboseMode) {
 163       out.println("\n==> DEBUG: ----------------------------------- search finished" + "\n");
 164     }
 165   }
 166
 167   @Override
 168   public void choiceGeneratorRegistered(VM vm, ChoiceGenerator<?> nextCG, ThreadInfo currentThread, Instruction executedInstruction) {
 169     if (stateReductionMode) {
 170       // Initialize with necessary information from the CG
 171       if (nextCG instanceof IntChoiceFromSet) {
 172         IntChoiceFromSet icsCG = (IntChoiceFromSet) nextCG;
 173         if (!isEndOfExecution) {
 174           // Check if CG has been initialized, otherwise initialize it
 175           Integer[] cgChoices = icsCG.getAllChoices();
 176           // Record the events (from choices)
 177           if (choices == null) {
 178             choices = cgChoices;
 179             // Make a copy of choices as reference
 180             refChoices = copyChoices(choices);
 181             // Record the max event choice (the last element of the choice array)
 182             maxEventChoice = choices[choices.length - 1];
 183           }
 184           icsCG.setNewValues(choices);
 185           icsCG.reset();
 186           // Use a modulo since choiceCounter is going to keep increasing
 187           int choiceIndex = choiceCounter % choices.length;
 188           icsCG.advance(choices[choiceIndex]);
 189         } else {
 190           // Set done all CGs while transitioning to a new execution
 191           icsCG.setDone();
 192         }
 193       }
 194     }
 195   }
 196
 197   @Override
 198   public void choiceGeneratorAdvanced(VM vm, ChoiceGenerator<?> currentCG) {
 199
 200     if (stateReductionMode) {
 201       // Check the boolean CG and if it is flipped, we are resetting the analysis
 202       if (currentCG instanceof BooleanChoiceGenerator) {
 203         if (!isBooleanCGFlipped) {
 204           isBooleanCGFlipped = true;
 205         } else {
 206           // Allocate new objects for data structure when the boolean is flipped from "false" to "true"
 207           initializeStatesVariables();
 208         }
 209       }
 210       // Check every choice generated and ensure fair scheduling!
 211       if (currentCG instanceof IntChoiceFromSet) {
 212         IntChoiceFromSet icsCG = (IntChoiceFromSet) currentCG;
 213         // If this is a new CG then we need to update data structures
 214         resetStatesForNewExecution(icsCG, vm);
 215         // If we don't see a fair scheduling of events/choices then we have to enforce it
 216         fairSchedulingAndBacktrackPoint(icsCG, vm);
 217         // Map state to event
 218         mapStateToEvent(icsCG.getNextChoice());
 219         // Update the VOD graph always with the latest
 220         updateVODGraph(icsCG.getNextChoice());
 221         // Check if we have seen this state or this state contains cycles that involve all events
 222         if (terminateCurrentExecution()) {
 223           exploreNextBacktrackPoints(vm, icsCG);
 224         }
 225         justVisitedStates.clear();
 226         choiceCounter++;
 227       }
 228     }
 229   }
 230
 231   @Override
 232   public void instructionExecuted(VM vm, ThreadInfo ti, Instruction nextInsn, Instruction executedInsn) {
 233     if (stateReductionMode) {
 234       if (!isEndOfExecution) {
 235         // Has to be initialized and a integer CG
 236         ChoiceGenerator<?> cg = vm.getChoiceGenerator();
 237         if (cg instanceof IntChoiceFromSet || cg instanceof IntIntervalGenerator) {
 238           int currentChoice = choiceCounter - 1;  // Accumulative choice w.r.t the current trace
 239           if (currentChoice < 0) { // If choice is -1 then skip
 240             return;
 241           }
 242           currentChoice = checkAndAdjustChoice(currentChoice, vm);
 243           // Record accesses from executed instructions
 244           if (executedInsn instanceof JVMFieldInstruction) {
 245             // Analyze only after being initialized
 246             String fieldClass = ((JVMFieldInstruction) executedInsn).getFieldInfo().getFullName();
 247             // We don't care about libraries
 248             if (!isFieldExcluded(fieldClass)) {
 249               analyzeReadWriteAccesses(executedInsn, fieldClass, currentChoice);
 250             }
 251           } else if (executedInsn instanceof INVOKEINTERFACE) {
 252             // Handle the read/write accesses that occur through iterators
 253             analyzeReadWriteAccesses(executedInsn, ti, currentChoice);
 254           }
 255           // Analyze conflicts from next instructions
 256           if (nextInsn instanceof JVMFieldInstruction) {
 257             // Skip the constructor because it is called once and does not have shared access with other objects
 258             if (!nextInsn.getMethodInfo().getName().equals("<init>")) {
 259               String fieldClass = ((JVMFieldInstruction) nextInsn).getFieldInfo().getFullName();
 260               if (!isFieldExcluded(fieldClass)) {
 261                 // Check for conflict (go backward from current choice and get the first conflict)
 262                 for (int eventCounter = currentChoice - 1; eventCounter >= 0; eventCounter--) {
 263                   // Check for conflicts with Write fields for both Read and Write instructions
 264                   // Check and record a backtrack set for just once!
 265                   if (isConflictFound(nextInsn, eventCounter, currentChoice, fieldClass) &&
 266                       isNewConflict(currentChoice, eventCounter)) {
 267                     // Lines 4-8 of the algorithm in the paper page 11 (see the heading note above)
 268                     if (vm.isNewState() || isReachableInVODGraph(currentChoice)) {
 269                       createBacktrackingPoint(currentChoice, eventCounter);
 270                     }
 271                   }
 272                 }
 273               }
 274             }
 275           }
 276         }
 277       }
 278     }
 279   }
 280
 281
 282   // == HELPERS
 283
 284   // -- INNER CLASSES
 285
 286   // This class compactly stores Read and Write field sets
 287   // We store the field name and its object ID
 288   // Sharing the same field means the same field name and object ID
 289   private class ReadWriteSet {
 290     private HashMap<String, Integer> readSet;
 291     private HashMap<String, Integer> writeSet;
 292
 293     public ReadWriteSet() {
 294       readSet = new HashMap<>();
 295       writeSet = new HashMap<>();
 296     }
 297
 298     public void addReadField(String field, int objectId) {
 299       readSet.put(field, objectId);
 300     }
 301
 302     public void addWriteField(String field, int objectId) {
 303       writeSet.put(field, objectId);
 304     }
 305
 306     public boolean readFieldExists(String field) {
 307       return readSet.containsKey(field);
 308     }
 309
 310     public boolean writeFieldExists(String field) {
 311       return writeSet.containsKey(field);
 312     }
 313
 314     public int readFieldObjectId(String field) {
 315       return readSet.get(field);
 316     }
 317
 318     public int writeFieldObjectId(String field) {
 319       return writeSet.get(field);
 320     }
 321   }
 322
 323   // This class compactly stores backtrack points: 1) backtrack state ID, and 2) backtracking choices
 324   private class BacktrackPoint {
 325     private IntChoiceFromSet backtrackCG; // CG at this backtrack point
 326     private int stateId;                  // State at this backtrack point
 327     private int choice;                   // Choice chosen at this backtrack point
 328
 329     public BacktrackPoint(IntChoiceFromSet cg, int stId, int cho) {
 330       backtrackCG = cg;
 331       stateId = stId;
 332       choice = cho;
 333     }
 334
 335     public IntChoiceFromSet getBacktrackCG() { return backtrackCG; }
 336
 337     public int getStateId() {
 338       return stateId;
 339     }
 340
 341     public int getChoice() {
 342       return choice;
 343     }
 344   }
 345
 346   // -- CONSTANTS
 347   private final static String DO_CALL_METHOD = "doCall";
 348   // We exclude fields that come from libraries (Java and Groovy), and also the infrastructure
 349   private final static String[] EXCLUDED_FIELDS_CONTAINS_LIST = {"_closure"};
 350   private final static String[] EXCLUDED_FIELDS_ENDS_WITH_LIST =
 351           // Groovy library created fields
 352           {"stMC", "callSiteArray", "metaClass", "staticClassInfo", "__constructor__",
 353           // Infrastructure
 354           "sendEvent", "Object", "reference", "location", "app", "state", "log", "functionList", "objectList",
 355           "eventList", "valueList", "settings", "printToConsole", "app1", "app2"};
 356   private final static String[] EXCLUDED_FIELDS_STARTS_WITH_LIST =
 357           // Java and Groovy libraries
 358           { "java", "org", "sun", "com", "gov", "groovy"};
 359   private final static String[] EXCLUDED_FIELDS_READ_WRITE_INSTRUCTIONS_STARTS_WITH_LIST = {"Event"};
 360   private final static String GET_PROPERTY_METHOD =
 361           "invokeinterface org.codehaus.groovy.runtime.callsite.CallSite.callGetProperty";
 362   private final static String GROOVY_CALLSITE_LIB = "org.codehaus.groovy.runtime.callsite";
 363   private final static String JAVA_INTEGER = "int";
 364   private final static String JAVA_STRING_LIB = "java.lang.String";
 365
 366   // -- FUNCTIONS
 367   private void fairSchedulingAndBacktrackPoint(IntChoiceFromSet icsCG, VM vm) {
 368     // Check the next choice and if the value is not the same as the expected then force the expected value
 369     int choiceIndex = choiceCounter % refChoices.length;
 370     int nextChoice = icsCG.getNextChoice();
 371     if (refChoices[choiceIndex] != nextChoice) {
 372       int expectedChoice = refChoices[choiceIndex];
 373       int currCGIndex = icsCG.getNextChoiceIndex();
 374       if ((currCGIndex >= 0) && (currCGIndex < refChoices.length)) {
 375         icsCG.setChoice(currCGIndex, expectedChoice);
 376       }
 377     }
 378     // Record state ID and choice/event as backtrack point
 379     int stateId = vm.getStateId();
 380     backtrackPointList.add(new BacktrackPoint(icsCG, stateId, refChoices[choiceIndex]));
 381     // Store restorable state object for this state (always store the latest)
 382     RestorableVMState restorableState = vm.getRestorableState();
 383     restorableStateMap.put(stateId, restorableState);
 384   }
 385
 386   private Integer[] copyChoices(Integer[] choicesToCopy) {
 387
 388     Integer[] copyOfChoices = new Integer[choicesToCopy.length];
 389     System.arraycopy(choicesToCopy, 0, copyOfChoices, 0, choicesToCopy.length);
 390     return copyOfChoices;
 391   }
 392
 393   // --- Functions related to cycle detection
 394
 395   // Detect cycles in the current execution/trace
 396   // We terminate the execution iff:
 397   // (1) the state has been visited in the current execution
 398   // (2) the state has one or more cycles that involve all the events
 399   // With simple approach we only need to check for a re-visited state.
 400   // Basically, we have to check that we have executed all events between two occurrences of such state.
 401   private boolean containsCyclesWithAllEvents(int stId) {
 402
 403     // False if the state ID hasn't been recorded
 404     if (!stateToEventMap.containsKey(stId)) {
 405       return false;
 406     }
 407     HashSet<Integer> visitedEvents = stateToEventMap.get(stId);
 408     // Check if this set contains all the event choices
 409     // If not then this is not the terminating condition
 410     for(int i=0; i<=maxEventChoice; i++) {
 411       if (!visitedEvents.contains(i)) {
 412         return false;
 413       }
 414     }
 415     return true;
 416   }
 417
 418   private void initializeStatesVariables() {
 419     // DPOR-related
 420     choices = null;
 421     refChoices = null;
 422     choiceCounter = 0;
 423     maxEventChoice = 0;
 424     // Cycle tracking
 425     currVisitedStates = new HashSet<>();
 426     justVisitedStates = new HashSet<>();
 427     prevVisitedStates = new HashSet<>();
 428     stateToEventMap = new HashMap<>();
 429     // Backtracking
 430     backtrackMap = new HashMap<>();
 431     backtrackStateQ = new PriorityQueue<>(Collections.reverseOrder());
 432     backtrackPointList = new ArrayList<>();
 433     conflictPairMap = new HashMap<>();
 434     doneBacktrackSet = new HashSet<>();
 435     readWriteFieldsMap = new HashMap<>();
 436     // VOD graph
 437     prevChoiceValue = -1;
 438     vodGraphMap = new HashMap<>();
 439     // Booleans
 440     isEndOfExecution = false;
 441   }
 442
 443   private void mapStateToEvent(int nextChoiceValue) {
 444     // Update all states with this event/choice
 445     // This means that all past states now see this transition
 446     Set<Integer> stateSet = stateToEventMap.keySet();
 447     for(Integer stateId : stateSet) {
 448       HashSet<Integer> eventSet = stateToEventMap.get(stateId);
 449       eventSet.add(nextChoiceValue);
 450     }
 451   }
 452
 453   private boolean terminateCurrentExecution() {
 454     // We need to check all the states that have just been visited
 455     // Often a transition (choice/event) can result into forwarding/backtracking to a number of states
 456     for(Integer stateId : justVisitedStates) {
 457       if (prevVisitedStates.contains(stateId) || containsCyclesWithAllEvents(stateId)) {
 458         return true;
 459       }
 460     }
 461     return false;
 462   }
 463
 464   private void updateStateInfo(Search search) {
 465     // Update the state variables
 466     // Line 19 in the paper page 11 (see the heading note above)
 467     int stateId = search.getStateId();
 468     currVisitedStates.add(stateId);
 469     // Insert state ID into the map if it is new
 470     if (!stateToEventMap.containsKey(stateId)) {
 471       HashSet<Integer> eventSet = new HashSet<>();
 472       stateToEventMap.put(stateId, eventSet);
 473     }
 474     justVisitedStates.add(stateId);
 475   }
 476
 477   // --- Functions related to Read/Write access analysis on shared fields
 478
 479   private void addNewBacktrackPoint(int stateId, Integer[] newChoiceList) {
 480     // Insert backtrack point to the right state ID
 481     LinkedList<Integer[]> backtrackList;
 482     if (backtrackMap.containsKey(stateId)) {
 483       backtrackList = backtrackMap.get(stateId);
 484     } else {
 485       backtrackList = new LinkedList<>();
 486       backtrackMap.put(stateId, backtrackList);
 487     }
 488     backtrackList.addFirst(newChoiceList);
 489     // Add to priority queue
 490     if (!backtrackStateQ.contains(stateId)) {
 491       backtrackStateQ.add(stateId);
 492     }
 493   }
 494
 495   // Analyze Read/Write accesses that are directly invoked on fields
 496   private void analyzeReadWriteAccesses(Instruction executedInsn, String fieldClass, int currentChoice) {
 497     // Do the analysis to get Read and Write accesses to fields
 498     ReadWriteSet rwSet = getReadWriteSet(currentChoice);
 499     int objectId = ((JVMFieldInstruction) executedInsn).getFieldInfo().getClassInfo().getClassObjectRef();
 500     // Record the field in the map
 501     if (executedInsn instanceof WriteInstruction) {
 502       // Exclude certain field writes because of infrastructure needs, e.g., Event class field writes
 503       for (String str : EXCLUDED_FIELDS_READ_WRITE_INSTRUCTIONS_STARTS_WITH_LIST) {
 504         if (fieldClass.startsWith(str)) {
 505           return;
 506         }
 507       }
 508       rwSet.addWriteField(fieldClass, objectId);
 509     } else if (executedInsn instanceof ReadInstruction) {
 510       rwSet.addReadField(fieldClass, objectId);
 511     }
 512   }
 513
 514   // Analyze Read accesses that are indirect (performed through iterators)
 515   // These accesses are marked by certain bytecode instructions, e.g., INVOKEINTERFACE
 516   private void analyzeReadWriteAccesses(Instruction instruction, ThreadInfo ti, int currentChoice) {
 517     // Get method name
 518     INVOKEINTERFACE insn = (INVOKEINTERFACE) instruction;
 519     if (insn.toString().startsWith(GET_PROPERTY_METHOD) &&
 520             insn.getMethodInfo().getName().equals(DO_CALL_METHOD)) {
 521       // Extract info from the stack frame
 522       StackFrame frame = ti.getTopFrame();
 523       int[] frameSlots = frame.getSlots();
 524       // Get the Groovy callsite library at index 0
 525       ElementInfo eiCallsite = VM.getVM().getHeap().get(frameSlots[0]);
 526       if (!eiCallsite.getClassInfo().getName().startsWith(GROOVY_CALLSITE_LIB)) {
 527         return;
 528       }
 529       // Get the iterated object whose property is accessed
 530       ElementInfo eiAccessObj = VM.getVM().getHeap().get(frameSlots[1]);
 531       if (eiAccessObj == null) {
 532         return;
 533       }
 534       // We exclude library classes (they start with java, org, etc.) and some more
 535       String objClassName = eiAccessObj.getClassInfo().getName();
 536       if (excludeThisForItStartsWith(EXCLUDED_FIELDS_STARTS_WITH_LIST, objClassName) ||
 537           excludeThisForItStartsWith(EXCLUDED_FIELDS_READ_WRITE_INSTRUCTIONS_STARTS_WITH_LIST, objClassName)) {
 538         return;
 539       }
 540       // Extract fields from this object and put them into the read write
 541       int numOfFields = eiAccessObj.getNumberOfFields();
 542       for(int i=0; i<numOfFields; i++) {
 543         FieldInfo fieldInfo = eiAccessObj.getFieldInfo(i);
 544         if (fieldInfo.getType().equals(JAVA_STRING_LIB) || fieldInfo.getType().equals(JAVA_INTEGER)) {
 545           String fieldClass = fieldInfo.getFullName();
 546           ReadWriteSet rwSet = getReadWriteSet(currentChoice);
 547           int objectId = fieldInfo.getClassInfo().getClassObjectRef();
 548           // Record the field in the map
 549           rwSet.addReadField(fieldClass, objectId);
 550         }
 551       }
 552     }
 553   }
 554
 555   private int checkAndAdjustChoice(int currentChoice, VM vm) {
 556     // If current choice is not the same, then this is caused by the firing of IntIntervalGenerator
 557     // for certain method calls in the infrastructure, e.g., eventSince()
 558     int currChoiceInd = currentChoice % refChoices.length;
 559     int currChoiceFromCG = currChoiceInd;
 560     ChoiceGenerator<?> currentCG = vm.getChoiceGenerator();
 561     // This is the main event CG
 562     if (currentCG instanceof IntIntervalGenerator) {
 563       // This is the interval CG used in device handlers
 564       ChoiceGenerator<?> parentCG = ((IntIntervalGenerator) currentCG).getPreviousChoiceGenerator();
 565       int actualEvtNum = ((IntChoiceFromSet) parentCG).getNextChoice();
 566       // Find the index of the event/choice in refChoices
 567       for (int i = 0; i<refChoices.length; i++) {
 568         if (actualEvtNum == refChoices[i]) {
 569           currChoiceFromCG = i;
 570           break;
 571         }
 572       }
 573     }
 574     if (currChoiceInd != currChoiceFromCG) {
 575       currentChoice = (currentChoice - currChoiceInd) + currChoiceFromCG;
 576     }
 577     return currentChoice;
 578   }
 579
 580   private void createBacktrackingPoint(int currentChoice, int confEvtNum) {
 581
 582     // Create a new list of choices for backtrack based on the current choice and conflicting event number
 583     // E.g. if we have a conflict between 1 and 3, then we create the list {3, 1, 0, 2}
 584     // for the original set {0, 1, 2, 3}
 585     Integer[] newChoiceList = new Integer[refChoices.length];
 586     // Put the conflicting event numbers first and reverse the order
 587     int actualCurrCho = currentChoice % refChoices.length;
 588     // We use the actual choices here in case they have been modified/adjusted by the fair scheduling method
 589     newChoiceList[0] = choices[actualCurrCho];
 590     newChoiceList[1] = backtrackPointList.get(confEvtNum).getChoice();
 591     // Put the rest of the event numbers into the array starting from the minimum to the upper bound
 592     for (int i = 0, j = 2; i < refChoices.length; i++) {
 593       if (refChoices[i] != newChoiceList[0] && refChoices[i] != newChoiceList[1]) {
 594         newChoiceList[j] = refChoices[i];
 595         j++;
 596       }
 597     }
 598     // Get the backtrack CG for this backtrack point
 599     int stateId = backtrackPointList.get(confEvtNum).getStateId();
 600     // Check if this trace has been done starting from this state
 601     if (isTraceAlreadyConstructed(newChoiceList, stateId)) {
 602       return;
 603     }
 604     addNewBacktrackPoint(stateId, newChoiceList);
 605   }
 606
 607   private boolean excludeThisForItContains(String[] excludedStrings, String className) {
 608     for (String excludedField : excludedStrings) {
 609       if (className.contains(excludedField)) {
 610         return true;
 611       }
 612     }
 613     return false;
 614   }
 615
 616   private boolean excludeThisForItEndsWith(String[] excludedStrings, String className) {
 617     for (String excludedField : excludedStrings) {
 618       if (className.endsWith(excludedField)) {
 619         return true;
 620       }
 621     }
 622     return false;
 623   }
 624
 625   private boolean excludeThisForItStartsWith(String[] excludedStrings, String className) {
 626     for (String excludedField : excludedStrings) {
 627       if (className.startsWith(excludedField)) {
 628         return true;
 629       }
 630     }
 631     return false;
 632   }
 633
 634   private void exploreNextBacktrackPoints(VM vm, IntChoiceFromSet icsCG) {
 635
 636     // We can start exploring the next backtrack point after the current CG is advanced at least once
 637     if (choiceCounter > 0) {
 638       // Check if we are reaching the end of our execution: no more backtracking points to explore
 639       // cgMap, backtrackMap, backtrackStateQ are updated simultaneously (checking backtrackStateQ is enough)
 640       if (!backtrackStateQ.isEmpty()) {
 641         // Set done all the other backtrack points
 642         for (BacktrackPoint backtrackPoint : backtrackPointList) {
 643           backtrackPoint.getBacktrackCG().setDone();
 644         }
 645         // Reset the next backtrack point with the latest state
 646         int hiStateId = backtrackStateQ.peek();
 647         // Restore the state first if necessary
 648         if (vm.getStateId() != hiStateId) {
 649           RestorableVMState restorableState = restorableStateMap.get(hiStateId);
 650           vm.restoreState(restorableState);
 651         }
 652         // Set the backtrack CG
 653         IntChoiceFromSet backtrackCG = (IntChoiceFromSet) vm.getChoiceGenerator();
 654         setBacktrackCG(hiStateId, backtrackCG);
 655       } else {
 656         // Set done this last CG (we save a few rounds)
 657         icsCG.setDone();
 658       }
 659       // Save all the visited states when starting a new execution of trace
 660       prevVisitedStates.addAll(currVisitedStates);
 661       currVisitedStates.clear();
 662       // This marks a transitional period to the new CG
 663       isEndOfExecution = true;
 664     }
 665   }
 666
 667   private ReadWriteSet getReadWriteSet(int currentChoice) {
 668     // Do the analysis to get Read and Write accesses to fields
 669     ReadWriteSet rwSet;
 670     // We already have an entry
 671     if (readWriteFieldsMap.containsKey(currentChoice)) {
 672       rwSet = readWriteFieldsMap.get(currentChoice);
 673     } else { // We need to create a new entry
 674       rwSet = new ReadWriteSet();
 675       readWriteFieldsMap.put(currentChoice, rwSet);
 676     }
 677     return rwSet;
 678   }
 679
 680   private boolean isConflictFound(Instruction nextInsn, int eventCounter, int currentChoice, String fieldClass) {
 681
 682     int actualCurrCho = currentChoice % refChoices.length;
 683     // Skip if this event does not have any Read/Write set or the two events are basically the same event (number)
 684     if (!readWriteFieldsMap.containsKey(eventCounter) ||
 685          choices[actualCurrCho] == backtrackPointList.get(eventCounter).getChoice()) {
 686       return false;
 687     }
 688     ReadWriteSet rwSet = readWriteFieldsMap.get(eventCounter);
 689     int currObjId = ((JVMFieldInstruction) nextInsn).getFieldInfo().getClassInfo().getClassObjectRef();
 690     // Check for conflicts with Write fields for both Read and Write instructions
 691     if (((nextInsn instanceof WriteInstruction || nextInsn instanceof ReadInstruction) &&
 692           rwSet.writeFieldExists(fieldClass) && rwSet.writeFieldObjectId(fieldClass) == currObjId) ||
 693          (nextInsn instanceof WriteInstruction && rwSet.readFieldExists(fieldClass) &&
 694           rwSet.readFieldObjectId(fieldClass) == currObjId)) {
 695       return true;
 696     }
 697     return false;
 698   }
 699
 700   private boolean isFieldExcluded(String field) {
 701     // Check against "starts-with", "ends-with", and "contains" list
 702     if (excludeThisForItStartsWith(EXCLUDED_FIELDS_STARTS_WITH_LIST, field) ||
 703             excludeThisForItEndsWith(EXCLUDED_FIELDS_ENDS_WITH_LIST, field) ||
 704             excludeThisForItContains(EXCLUDED_FIELDS_CONTAINS_LIST, field)) {
 705       return true;
 706     }
 707
 708     return false;
 709   }
 710
 711   private boolean isNewConflict(int currentEvent, int eventNumber) {
 712     HashSet<Integer> conflictSet;
 713     if (!conflictPairMap.containsKey(currentEvent)) {
 714       conflictSet = new HashSet<>();
 715       conflictPairMap.put(currentEvent, conflictSet);
 716     } else {
 717       conflictSet = conflictPairMap.get(currentEvent);
 718     }
 719     // If this conflict has been recorded before, we return false because
 720     // we don't want to save this backtrack point twice
 721     if (conflictSet.contains(eventNumber)) {
 722       return false;
 723     }
 724     // If it hasn't been recorded, then do otherwise
 725     conflictSet.add(eventNumber);
 726     return true;
 727   }
 728
 729   private boolean isTraceAlreadyConstructed(Integer[] choiceList, int stateId) {
 730     // Concatenate state ID and only the first event in the string, e.g., "1:1 for the trace 10234 at state 1"
 731     // TODO: THIS IS AN OPTIMIZATION!
 732     // This is the optimized version because after we execute, e.g., the trace 1:10234, we don't need to try
 733     // another trace that starts with event 1 at state 1, e.g., the trace 1:13024
 734     // The second time this event 1 is explored, it will generate the same state as the first one
 735     StringBuilder sb = new StringBuilder();
 736     sb.append(stateId);
 737     sb.append(':');
 738     sb.append(choiceList[0]);
 739     // Check if the trace has been constructed as a backtrack point for this state
 740     if (doneBacktrackSet.contains(sb.toString())) {
 741       return true;
 742     }
 743     doneBacktrackSet.add(sb.toString());
 744     return false;
 745   }
 746
 747   private void resetStatesForNewExecution(IntChoiceFromSet icsCG, VM vm) {
 748     if (choices == null || choices != icsCG.getAllChoices()) {
 749       // Reset state variables
 750       choiceCounter = 0;
 751       choices = icsCG.getAllChoices();
 752       refChoices = copyChoices(choices);
 753       // Clearing data structures
 754       conflictPairMap.clear();
 755       readWriteFieldsMap.clear();
 756       stateToEventMap.clear();
 757       isEndOfExecution = false;
 758       backtrackPointList.clear();
 759     }
 760   }
 761
 762   private void setBacktrackCG(int stateId, IntChoiceFromSet backtrackCG) {
 763     // Set a backtrack CG based on a state ID
 764     LinkedList<Integer[]> backtrackChoices = backtrackMap.get(stateId);
 765     backtrackCG.setNewValues(backtrackChoices.removeLast());  // Get the last from the queue
 766     backtrackCG.setStateId(stateId);
 767     backtrackCG.reset();
 768     // Remove from the queue if we don't have more backtrack points for that state
 769     if (backtrackChoices.isEmpty()) {
 770       backtrackMap.remove(stateId);
 771       backtrackStateQ.remove(stateId);
 772     }
 773   }
 774
 775   // --- Functions related to the visible operation dependency graph implementation discussed in the SPIN paper
 776
 777   // This method checks whether a choice is reachable in the VOD graph from a reference choice (BFS algorithm)
 778   //private boolean isReachableInVODGraph(int checkedChoice, int referenceChoice) {
 779   private boolean isReachableInVODGraph(int currentChoice) {
 780     // Extract previous and current events
 781     int choiceIndex = currentChoice % refChoices.length;
 782     int prevChoIndex = (currentChoice - 1) % refChoices.length;
 783     int currEvent = refChoices[choiceIndex];
 784     int prevEvent = refChoices[prevChoIndex];
 785     // Record visited choices as we search in the graph
 786     HashSet<Integer> visitedChoice = new HashSet<>();
 787     visitedChoice.add(prevEvent);
 788     LinkedList<Integer> nodesToVisit = new LinkedList<>();
 789     // If the state doesn't advance as the threads/sub-programs are executed (basically there is no new state),
 790     // there is a chance that the graph doesn't have new nodes---thus this check will return a null.
 791     if (vodGraphMap.containsKey(prevEvent)) {
 792       nodesToVisit.addAll(vodGraphMap.get(prevEvent));
 793       while(!nodesToVisit.isEmpty()) {
 794         int choice = nodesToVisit.removeFirst();
 795         if (choice == currEvent) {
 796           return true;
 797         }
 798         if (visitedChoice.contains(choice)) { // If there is a loop then just continue the exploration
 799           continue;
 800         }
 801         // Continue searching
 802         visitedChoice.add(choice);
 803         HashSet<Integer> choiceNextNodes = vodGraphMap.get(choice);
 804         if (choiceNextNodes != null) {
 805           // Add only if there is a mapping for next nodes
 806           for (Integer nextNode : choiceNextNodes) {
 807             // Skip cycles
 808             if (nextNode == choice) {
 809               continue;
 810             }
 811             nodesToVisit.addLast(nextNode);
 812           }
 813         }
 814       }
 815     }
 816     return false;
 817   }
 818
 819   private void updateVODGraph(int currChoiceValue) {
 820     // Update the graph when we have the current choice value
 821     HashSet<Integer> choiceSet;
 822     if (vodGraphMap.containsKey(prevChoiceValue)) {
 823       // If the key already exists, just retrieve it
 824       choiceSet = vodGraphMap.get(prevChoiceValue);
 825     } else {
 826       // Create a new entry
 827       choiceSet = new HashSet<>();
 828       vodGraphMap.put(prevChoiceValue, choiceSet);
 829     }
 830     choiceSet.add(currChoiceValue);
 831     prevChoiceValue = currChoiceValue;
 832   }
 833 }