src/main/gov/nasa/jpf/listener/DPORStateReducerEfficient.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.jvm.bytecode.INVOKEINTERFACE;
  24 import gov.nasa.jpf.jvm.bytecode.JVMFieldInstruction;
  25 import gov.nasa.jpf.search.Search;
  26 import gov.nasa.jpf.vm.*;
  27 import gov.nasa.jpf.vm.bytecode.ReadInstruction;
  28 import gov.nasa.jpf.vm.bytecode.WriteInstruction;
  29 import gov.nasa.jpf.vm.choice.IntChoiceFromSet;
  30 import gov.nasa.jpf.vm.choice.IntIntervalGenerator;
  31
  32 import java.io.FileWriter;
  33 import java.io.IOException;
  34 import java.io.PrintWriter;
  35 import java.util.*;
  36 import java.util.logging.Logger;
  37
  38 /**
  39  * This a DPOR implementation for event-driven applications with loops that create cycles of state matching
  40  * In this new DPOR algorithm/implementation, each run is terminated iff:
  41  * - we find a state that matches a state in a previous run, or
  42  * - we have a matched state in the current run that consists of cycles that contain all choices/events.
  43  */
  44 public class DPORStateReducerEfficient extends ListenerAdapter {
  45
  46   // Information printout fields for verbose mode
  47   private boolean verboseMode;
  48   private boolean stateReductionMode;
  49   private final PrintWriter out;
  50   private PrintWriter fileWriter;
  51   private String detail;
  52   private int depth;
  53   private int id;
  54   private Transition transition;
  55
  56   // DPOR-related fields
  57   // Basic information
  58   private Integer[] choices;
  59   private Integer[] refChoices; // Second reference to a copy of choices (choices may be modified for fair scheduling)
  60   private int choiceCounter;
  61   private int maxEventChoice;
  62   // Data structure to track the events seen by each state to track cycles (containing all events) for termination
  63   private HashSet<Integer> currVisitedStates;   // States being visited in the current execution
  64   private HashSet<Integer> justVisitedStates;   // States just visited in the previous choice/event
  65   private HashSet<Integer> prevVisitedStates;   // States visited in the previous execution
  66   private HashSet<ClassInfo> nonRelevantClasses;// Class info objects of non-relevant classes
  67   private HashSet<FieldInfo> nonRelevantFields; // Field info objects of non-relevant fields
  68   private HashSet<FieldInfo> relevantFields;    // Field info objects of relevant fields
  69   private HashMap<Integer, HashSet<Integer>> stateToEventMap;
  70   // Data structure to analyze field Read/Write accesses and conflicts
  71   private HashMap<Integer, LinkedList<BacktrackExecution>> backtrackMap;  // Track created backtracking points
  72   private PriorityQueue<Integer> backtrackStateQ;                 // Heap that returns the latest state
  73   private Execution currentExecution;                             // Holds the information about the current execution
  74   private HashMap<Integer, HashSet<Integer>> doneBacktrackMap;    // Record state ID and trace already constructed
  75   private HashMap<Integer, RestorableVMState> restorableStateMap; // Maps state IDs to the restorable state object
  76   private RGraph rGraph;                                          // R-Graph for past executions
  77
  78   // Boolean states
  79   private boolean isBooleanCGFlipped;
  80   private boolean isEndOfExecution;
  81
  82   // Statistics
  83   private int numOfTransitions;
  84
  85   public DPORStateReducerEfficient(Config config, JPF jpf) {
  86     verboseMode = config.getBoolean("printout_state_transition", false);
  87     stateReductionMode = config.getBoolean("activate_state_reduction", true);
  88     if (verboseMode) {
  89       out = new PrintWriter(System.out, true);
  90     } else {
  91       out = null;
  92     }
  93     String outputFile = config.getString("file_output");
  94     if (!outputFile.isEmpty()) {
  95       try {
  96         fileWriter = new PrintWriter(new FileWriter(outputFile, true), true);
  97       } catch (IOException e) {
  98       }
  99     }
 100     isBooleanCGFlipped = false;
 101                 numOfTransitions = 0;
 102                 nonRelevantClasses = new HashSet<>();
 103                 nonRelevantFields = new HashSet<>();
 104                 relevantFields = new HashSet<>();
 105     restorableStateMap = new HashMap<>();
 106     initializeStatesVariables();
 107   }
 108
 109   @Override
 110   public void stateRestored(Search search) {
 111     if (verboseMode) {
 112       id = search.getStateId();
 113       depth = search.getDepth();
 114       transition = search.getTransition();
 115       detail = null;
 116       out.println("\n==> DEBUG: The state is restored to state with id: " + id + " -- Transition: " + transition +
 117               " and depth: " + depth + "\n");
 118     }
 119   }
 120
 121   @Override
 122   public void searchStarted(Search search) {
 123     if (verboseMode) {
 124       out.println("\n==> DEBUG: ----------------------------------- search started" + "\n");
 125     }
 126   }
 127
 128   @Override
 129   public void stateAdvanced(Search search) {
 130     if (verboseMode) {
 131       id = search.getStateId();
 132       depth = search.getDepth();
 133       transition = search.getTransition();
 134       if (search.isNewState()) {
 135         detail = "new";
 136       } else {
 137         detail = "visited";
 138       }
 139
 140       if (search.isEndState()) {
 141         out.println("\n==> DEBUG: This is the last state!\n");
 142         detail += " end";
 143       }
 144       out.println("\n==> DEBUG: The state is forwarded to state with id: " + id + " with depth: " + depth +
 145               " which is " + detail + " Transition: " + transition + "\n");
 146     }
 147     if (stateReductionMode) {
 148       updateStateInfo(search);
 149     }
 150   }
 151
 152   @Override
 153   public void stateBacktracked(Search search) {
 154     if (verboseMode) {
 155       id = search.getStateId();
 156       depth = search.getDepth();
 157       transition = search.getTransition();
 158       detail = null;
 159
 160       out.println("\n==> DEBUG: The state is backtracked to state with id: " + id + " -- Transition: " + transition +
 161               " and depth: " + depth + "\n");
 162     }
 163     if (stateReductionMode) {
 164       updateStateInfo(search);
 165     }
 166   }
 167
 168   static Logger log = JPF.getLogger("report");
 169
 170   @Override
 171   public void searchFinished(Search search) {
 172     if (verboseMode) {
 173       out.println("\n==> DEBUG: ----------------------------------- search finished");
 174       out.println("\n==> DEBUG: State reduction mode  : " + stateReductionMode);
 175       out.println("\n==> DEBUG: Number of transitions : " + numOfTransitions);
 176       out.println("\n==> DEBUG: ----------------------------------- search finished" + "\n");
 177
 178       fileWriter.println("==> DEBUG: State reduction mode  : " + stateReductionMode);
 179       fileWriter.println("==> DEBUG: Number of transitions : " + numOfTransitions);
 180       fileWriter.println();
 181       fileWriter.close();
 182     }
 183   }
 184
 185   @Override
 186   public void choiceGeneratorRegistered(VM vm, ChoiceGenerator<?> nextCG, ThreadInfo currentThread, Instruction executedInstruction) {
 187     if (stateReductionMode) {
 188       // Initialize with necessary information from the CG
 189       if (nextCG instanceof IntChoiceFromSet) {
 190         IntChoiceFromSet icsCG = (IntChoiceFromSet) nextCG;
 191         // Tell JPF that we are performing DPOR
 192         icsCG.setDpor();
 193         if (!isEndOfExecution) {
 194           // Check if CG has been initialized, otherwise initialize it
 195           Integer[] cgChoices = icsCG.getAllChoices();
 196           // Record the events (from choices)
 197           if (choices == null) {
 198             choices = cgChoices;
 199             // Make a copy of choices as reference
 200             refChoices = copyChoices(choices);
 201             // Record the max event choice (the last element of the choice array)
 202             maxEventChoice = choices[choices.length - 1];
 203           }
 204           icsCG.setNewValues(choices);
 205           icsCG.reset();
 206           // Use a modulo since choiceCounter is going to keep increasing
 207           int choiceIndex = choiceCounter % choices.length;
 208           icsCG.advance(choices[choiceIndex]);
 209         } else {
 210           // Set done all CGs while transitioning to a new execution
 211           icsCG.setDone();
 212         }
 213       }
 214     }
 215   }
 216
 217   @Override
 218   public void choiceGeneratorAdvanced(VM vm, ChoiceGenerator<?> currentCG) {
 219     if (stateReductionMode) {
 220       // Check the boolean CG and if it is flipped, we are resetting the analysis
 221       if (currentCG instanceof BooleanChoiceGenerator) {
 222         if (!isBooleanCGFlipped) {
 223           isBooleanCGFlipped = true;
 224         } else {
 225           // Allocate new objects for data structure when the boolean is flipped from "false" to "true"
 226           initializeStatesVariables();
 227         }
 228       }
 229       // Check every choice generated and ensure fair scheduling!
 230       if (currentCG instanceof IntChoiceFromSet) {
 231         IntChoiceFromSet icsCG = (IntChoiceFromSet) currentCG;
 232         // If this is a new CG then we need to update data structures
 233         resetStatesForNewExecution(icsCG, vm);
 234         // If we don't see a fair scheduling of events/choices then we have to enforce it
 235         ensureFairSchedulingAndSetupTransition(icsCG, vm);
 236         // Update backtrack set of an executed event (transition): one transition before this one
 237         updateBacktrackSet(currentExecution, choiceCounter - 1);
 238         // Explore the next backtrack point:
 239         // 1) if we have seen this state or this state contains cycles that involve all events, and
 240         // 2) after the current CG is advanced at least once
 241         if (terminateCurrentExecution() && choiceCounter > 0) {
 242           exploreNextBacktrackPoints(vm, icsCG);
 243         } else {
 244           numOfTransitions++;
 245         }
 246         // Map state to event
 247         mapStateToEvent(icsCG.getNextChoice());
 248         justVisitedStates.clear();
 249         choiceCounter++;
 250       }
 251     } else {
 252       numOfTransitions++;
 253     }
 254   }
 255
 256   @Override
 257   public void instructionExecuted(VM vm, ThreadInfo ti, Instruction nextInsn, Instruction executedInsn) {
 258     if (stateReductionMode) {
 259       if (!isEndOfExecution) {
 260         // Has to be initialized and a integer CG
 261         ChoiceGenerator<?> cg = vm.getChoiceGenerator();
 262         if (cg instanceof IntChoiceFromSet || cg instanceof IntIntervalGenerator) {
 263           int currentChoice = choiceCounter - 1;  // Accumulative choice w.r.t the current trace
 264           if (currentChoice < 0) { // If choice is -1 then skip
 265             return;
 266           }
 267           currentChoice = checkAndAdjustChoice(currentChoice, vm);
 268           // Record accesses from executed instructions
 269           if (executedInsn instanceof JVMFieldInstruction) {
 270             // We don't care about libraries
 271             if (!isFieldExcluded(executedInsn)) {
 272               analyzeReadWriteAccesses(executedInsn, currentChoice);
 273             }
 274           } else if (executedInsn instanceof INVOKEINTERFACE) {
 275             // Handle the read/write accesses that occur through iterators
 276             analyzeReadWriteAccesses(executedInsn, ti, currentChoice);
 277           }
 278         }
 279       }
 280     }
 281   }
 282
 283
 284   // == HELPERS
 285
 286   // -- INNER CLASSES
 287
 288   // This class compactly stores backtrack execution:
 289   // 1) backtrack choice list, and
 290   // 2) first backtrack point (linking with predecessor execution)
 291   private class BacktrackExecution {
 292     private Integer[] choiceList;
 293     private TransitionEvent firstTransition;
 294
 295     public BacktrackExecution(Integer[] choList, TransitionEvent fTransition) {
 296       choiceList = choList;
 297       firstTransition = fTransition;
 298     }
 299
 300     public Integer[] getChoiceList() {
 301       return choiceList;
 302     }
 303
 304     public TransitionEvent getFirstTransition() {
 305       return firstTransition;
 306     }
 307   }
 308
 309   // This class stores a representation of an execution
 310   // TODO: We can modify this class to implement some optimization (e.g., clock-vector)
 311   // TODO: We basically need to keep track of:
 312   // TODO:    (1) last read/write access to each memory location
 313   // TODO:    (2) last state with two or more incoming events/transitions
 314   private class Execution {
 315     private HashMap<IntChoiceFromSet, Integer> cgToChoiceMap;   // Map between CG to choice numbers for O(1) access
 316     private ArrayList<TransitionEvent> executionTrace;          // The BacktrackPoint objects of this execution
 317     private boolean isNew;                                      // Track if this is the first time it is accessed
 318     private HashMap<Integer, ReadWriteSet> readWriteFieldsMap;  // Record fields that are accessed
 319
 320     public Execution() {
 321       cgToChoiceMap = new HashMap<>();
 322       executionTrace = new ArrayList<>();
 323       isNew = true;
 324       readWriteFieldsMap = new HashMap<>();
 325     }
 326
 327     public void addTransition(TransitionEvent newBacktrackPoint) {
 328       executionTrace.add(newBacktrackPoint);
 329     }
 330
 331     public void clearCGToChoiceMap() {
 332       cgToChoiceMap = null;
 333     }
 334
 335     public int getChoiceFromCG(IntChoiceFromSet icsCG) {
 336       return cgToChoiceMap.get(icsCG);
 337     }
 338
 339     public ArrayList<TransitionEvent> getExecutionTrace() {
 340       return executionTrace;
 341     }
 342
 343     public TransitionEvent getFirstTransition() {
 344       return executionTrace.get(0);
 345     }
 346
 347     public TransitionEvent getLastTransition() {
 348       return executionTrace.get(executionTrace.size() - 1);
 349     }
 350
 351     public HashMap<Integer, ReadWriteSet> getReadWriteFieldsMap() {
 352       return readWriteFieldsMap;
 353     }
 354
 355     public boolean isNew() {
 356       if (isNew) {
 357         // Right after this is accessed, it is no longer new
 358         isNew = false;
 359         return true;
 360       }
 361       return false;
 362     }
 363
 364     public void mapCGToChoice(IntChoiceFromSet icsCG, int choice) {
 365       cgToChoiceMap.put(icsCG, choice);
 366     }
 367   }
 368
 369   // This class compactly stores a predecessor
 370   // 1) a predecessor execution
 371   // 2) the predecessor choice in that predecessor execution
 372   private class Predecessor {
 373     private int choice;           // Predecessor choice
 374     private Execution execution;  // Predecessor execution
 375
 376     public Predecessor(Execution predExec, int predChoice) {
 377       choice = predChoice;
 378       execution = predExec;
 379     }
 380
 381     public int getChoice() {
 382       return choice;
 383     }
 384
 385     public Execution getExecution() {
 386       return execution;
 387     }
 388   }
 389
 390   // This class represents a R-Graph (in the paper it is a state transition graph R)
 391   // This implementation stores reachable transitions from and connects with past executions
 392   private class RGraph {
 393     private int hiStateId;                                     // Maximum state Id
 394     private HashMap<Integer, HashSet<TransitionEvent>> graph;  // Reachable transitions from past executions
 395     // TODO: THIS IS THE ACCESS SUMMARY
 396     private HashMap<Integer, HashMap<Integer, SummaryNode>> graphSummary;
 397
 398     public RGraph() {
 399       hiStateId = 0;
 400       graph = new HashMap<>();
 401       graphSummary = new HashMap<>();
 402     }
 403
 404     public void addReachableTransition(int stateId, TransitionEvent transition) {
 405       // Record transition into graph
 406       HashSet<TransitionEvent> transitionSet;
 407       if (graph.containsKey(stateId)) {
 408         transitionSet = graph.get(stateId);
 409       } else {
 410         transitionSet = new HashSet<>();
 411         graph.put(stateId, transitionSet);
 412       }
 413       // Insert into the set if it does not contain it yet
 414       if (!transitionSet.contains(transition)) {
 415         transitionSet.add(transition);
 416       }
 417       // Update highest state ID
 418       if (hiStateId < stateId) {
 419         hiStateId = stateId;
 420       }
 421     }
 422
 423     public HashSet<TransitionEvent> getReachableTransitionsAtState(int stateId) {
 424       if (!graph.containsKey(stateId)) {
 425         // This is a loop from a transition to itself, so just return the current transition
 426         HashSet<TransitionEvent> transitionSet = new HashSet<>();
 427         transitionSet.add(currentExecution.getLastTransition());
 428         return transitionSet;
 429       }
 430       return graph.get(stateId);
 431     }
 432
 433     public HashSet<TransitionEvent> getReachableTransitions(int stateId) {
 434       HashSet<TransitionEvent> reachableTransitions = new HashSet<>();
 435       // All transitions from states higher than the given state ID (until the highest state ID) are reachable
 436       for(int stId = stateId; stId <= hiStateId; stId++) {
 437         // We might encounter state IDs from the first round of Boolean CG
 438         // The second round of Boolean CG should consider these new states
 439         if (graph.containsKey(stId)) {
 440           reachableTransitions.addAll(graph.get(stId));
 441         }
 442       }
 443       return reachableTransitions;
 444     }
 445
 446     public HashMap<Integer, SummaryNode> getReachableTransitionsSummary(int stateId) {
 447       // Just return an empty map if the state ID is not recorded yet
 448       // This means that there is no reachable transition from this state
 449       if (!graphSummary.containsKey(stateId)) {
 450         return new HashMap<>();
 451       }
 452       return graphSummary.get(stateId);
 453     }
 454
 455     private ReadWriteSet performUnion(ReadWriteSet recordedRWSet, ReadWriteSet rwSet) {
 456       // Combine the same write accesses and record in the recordedRWSet
 457       HashMap<String, Integer> recordedWriteMap = recordedRWSet.getWriteMap();
 458       HashMap<String, Integer> writeMap = rwSet.getWriteMap();
 459       for(Map.Entry<String, Integer> entry : recordedWriteMap.entrySet()) {
 460         String writeField = entry.getKey();
 461         // Remove the entry from rwSet if both field and object ID are the same
 462         if (writeMap.containsKey(writeField) &&
 463                 (writeMap.get(writeField) == recordedWriteMap.get(writeField))) {
 464           writeMap.remove(writeField);
 465         }
 466       }
 467       // Then add everything into the recorded map because these will be traversed
 468       recordedWriteMap.putAll(writeMap);
 469       // Combine the same read accesses and record in the recordedRWSet
 470       HashMap<String, Integer> recordedReadMap = recordedRWSet.getReadMap();
 471       HashMap<String, Integer> readMap = rwSet.getReadMap();
 472       for(Map.Entry<String, Integer> entry : recordedReadMap.entrySet()) {
 473         String readField = entry.getKey();
 474         // Remove the entry from rwSet if both field and object ID are the same
 475         if (readMap.containsKey(readField) &&
 476                 (readMap.get(readField) == recordedReadMap.get(readField))) {
 477           readMap.remove(readField);
 478         }
 479       }
 480       // Then add everything into the recorded map because these will be traversed
 481       recordedReadMap.putAll(readMap);
 482
 483       return rwSet;
 484     }
 485
 486     public ReadWriteSet recordTransitionSummary(int stateId, TransitionEvent transition, ReadWriteSet rwSet) {
 487       // Record transition into graphSummary
 488       // TransitionMap maps event (choice) number to a R/W set
 489       HashMap<Integer, SummaryNode> transitionSummary;
 490       if (graphSummary.containsKey(stateId)) {
 491         transitionSummary = graphSummary.get(stateId);
 492       } else {
 493         transitionSummary = new HashMap<>();
 494         graphSummary.put(stateId, transitionSummary);
 495       }
 496       int choice = transition.getChoice();
 497       SummaryNode summaryNode;
 498       // Insert transition into the map if we haven't had this event number recorded
 499       if (!transitionSummary.containsKey(choice)) {
 500         summaryNode = new SummaryNode(transition, rwSet.getCopy());
 501         transitionSummary.put(choice, summaryNode);
 502       } else {
 503         summaryNode = transitionSummary.get(choice);
 504         // Perform union and subtraction between the recorded and the given R/W sets
 505         rwSet = performUnion(summaryNode.getReadWriteSet(), rwSet);
 506       }
 507       return rwSet;
 508     }
 509   }
 510
 511   // This class compactly stores Read and Write field sets
 512   // We store the field name and its object ID
 513   // Sharing the same field means the same field name and object ID
 514   private class ReadWriteSet {
 515     private HashMap<String, Integer> readMap;
 516     private HashMap<String, Integer> writeMap;
 517
 518     public ReadWriteSet() {
 519       readMap = new HashMap<>();
 520       writeMap = new HashMap<>();
 521     }
 522
 523     public void addReadField(String field, int objectId) {
 524       readMap.put(field, objectId);
 525     }
 526
 527     public void addWriteField(String field, int objectId) {
 528       writeMap.put(field, objectId);
 529     }
 530
 531     public void removeReadField(String field) {
 532       readMap.remove(field);
 533     }
 534
 535     public void removeWriteField(String field) {
 536       writeMap.remove(field);
 537     }
 538
 539     public boolean isEmpty() {
 540       return readMap.isEmpty() && writeMap.isEmpty();
 541     }
 542
 543     public ReadWriteSet getCopy() {
 544       ReadWriteSet copyRWSet = new ReadWriteSet();
 545       // Copy the maps in the set into the new object copy
 546       copyRWSet.setReadMap(new HashMap<>(this.getReadMap()));
 547       copyRWSet.setWriteMap(new HashMap<>(this.getWriteMap()));
 548       return copyRWSet;
 549     }
 550
 551     public Set<String> getReadSet() {
 552       return readMap.keySet();
 553     }
 554
 555     public Set<String> getWriteSet() {
 556       return writeMap.keySet();
 557     }
 558
 559     public boolean readFieldExists(String field) {
 560       return readMap.containsKey(field);
 561     }
 562
 563     public boolean writeFieldExists(String field) {
 564       return writeMap.containsKey(field);
 565     }
 566
 567     public int readFieldObjectId(String field) {
 568       return readMap.get(field);
 569     }
 570
 571     public int writeFieldObjectId(String field) {
 572       return writeMap.get(field);
 573     }
 574
 575     private HashMap<String, Integer> getReadMap() {
 576       return readMap;
 577     }
 578
 579     private HashMap<String, Integer> getWriteMap() {
 580       return writeMap;
 581     }
 582
 583     private void setReadMap(HashMap<String, Integer> rMap) {
 584       readMap = rMap;
 585     }
 586
 587     private void setWriteMap(HashMap<String, Integer> wMap) {
 588       writeMap = wMap;
 589     }
 590   }
 591
 592   // This class provides a data structure to store TransitionEvent and ReadWriteSet for a summary
 593   private class SummaryNode {
 594     private TransitionEvent transitionEvent;
 595     private ReadWriteSet readWriteSet;
 596
 597     public SummaryNode(TransitionEvent transEvent, ReadWriteSet rwSet) {
 598       transitionEvent = transEvent;
 599       readWriteSet = rwSet;
 600     }
 601
 602     public TransitionEvent getTransitionEvent() {
 603       return transitionEvent;
 604     }
 605
 606     public ReadWriteSet getReadWriteSet() {
 607       return readWriteSet;
 608     }
 609   }
 610
 611   // This class compactly stores transitions:
 612   // 1) CG,
 613   // 2) state ID,
 614   // 3) choice,
 615   // 4) predecessors (for backward DFS).
 616   private class TransitionEvent {
 617     private int choice;                        // Choice chosen at this transition
 618     private int choiceCounter;                 // Choice counter at this transition
 619     private Execution execution;               // The execution where this transition belongs
 620     private HashSet<Predecessor> predecessors; // Maps incoming events/transitions (execution and choice)
 621     private HashMap<Execution, HashSet<Integer>> recordedPredecessors;
 622                                                // Memorize event and choice number to not record them twice
 623     private int stateId;                       // State at this transition
 624     private IntChoiceFromSet transitionCG;     // CG at this transition
 625
 626     public TransitionEvent() {
 627       choice = 0;
 628       choiceCounter = 0;
 629       execution = null;
 630       predecessors = new HashSet<>();
 631       recordedPredecessors = new HashMap<>();
 632       stateId = 0;
 633       transitionCG = null;
 634     }
 635
 636     public int getChoice() {
 637       return choice;
 638     }
 639
 640     public int getChoiceCounter() {
 641       return choiceCounter;
 642     }
 643
 644     public Execution getExecution() {
 645       return execution;
 646     }
 647
 648     public HashSet<Predecessor> getPredecessors() {
 649       return predecessors;
 650     }
 651
 652     public int getStateId() {
 653       return stateId;
 654     }
 655
 656     public IntChoiceFromSet getTransitionCG() { return transitionCG; }
 657
 658     private boolean isRecordedPredecessor(Execution execution, int choice) {
 659       // See if we have recorded this predecessor earlier
 660       HashSet<Integer> recordedChoices;
 661       if (recordedPredecessors.containsKey(execution)) {
 662         recordedChoices = recordedPredecessors.get(execution);
 663         if (recordedChoices.contains(choice)) {
 664           return true;
 665         }
 666       } else {
 667         recordedChoices = new HashSet<>();
 668         recordedPredecessors.put(execution, recordedChoices);
 669       }
 670       // Record the choice if we haven't seen it
 671       recordedChoices.add(choice);
 672
 673       return false;
 674     }
 675
 676     public void recordPredecessor(Execution execution, int choice) {
 677       if (!isRecordedPredecessor(execution, choice)) {
 678         predecessors.add(new Predecessor(execution, choice));
 679       }
 680     }
 681
 682     public void setChoice(int cho) {
 683       choice = cho;
 684     }
 685
 686     public void setChoiceCounter(int choCounter) {
 687       choiceCounter = choCounter;
 688     }
 689
 690     public void setExecution(Execution exec) {
 691       execution = exec;
 692     }
 693
 694     public void setPredecessors(HashSet<Predecessor> preds) {
 695       predecessors = new HashSet<>(preds);
 696     }
 697
 698     public void setStateId(int stId) {
 699       stateId = stId;
 700     }
 701
 702     public void setTransitionCG(IntChoiceFromSet cg) {
 703       transitionCG = cg;
 704     }
 705   }
 706
 707   // -- CONSTANTS
 708   private final static String DO_CALL_METHOD = "doCall";
 709   // We exclude fields that come from libraries (Java and Groovy), and also the infrastructure
 710   private final static String[] EXCLUDED_FIELDS_CONTAINS_LIST = {"_closure"};
 711   private final static String[] EXCLUDED_FIELDS_ENDS_WITH_LIST =
 712           // Groovy library created fields
 713           {"stMC", "callSiteArray", "metaClass", "staticClassInfo", "__constructor__",
 714           // Infrastructure
 715           "sendEvent", "Object", "reference", "location", "app", "state", "log", "functionList", "objectList",
 716           "eventList", "valueList", "settings", "printToConsole", "app1", "app2"};
 717   private final static String[] EXCLUDED_FIELDS_STARTS_WITH_LIST =
 718           // Java and Groovy libraries
 719           { "java", "org", "sun", "com", "gov", "groovy"};
 720   private final static String[] EXCLUDED_FIELDS_READ_WRITE_INSTRUCTIONS_STARTS_WITH_LIST = {"Event"};
 721   private final static String GET_PROPERTY_METHOD =
 722           "invokeinterface org.codehaus.groovy.runtime.callsite.CallSite.callGetProperty";
 723   private final static String GROOVY_CALLSITE_LIB = "org.codehaus.groovy.runtime.callsite";
 724   private final static String JAVA_INTEGER = "int";
 725   private final static String JAVA_STRING_LIB = "java.lang.String";
 726
 727   // -- FUNCTIONS
 728   private Integer[] copyChoices(Integer[] choicesToCopy) {
 729
 730     Integer[] copyOfChoices = new Integer[choicesToCopy.length];
 731     System.arraycopy(choicesToCopy, 0, copyOfChoices, 0, choicesToCopy.length);
 732     return copyOfChoices;
 733   }
 734
 735   private void ensureFairSchedulingAndSetupTransition(IntChoiceFromSet icsCG, VM vm) {
 736     // Check the next choice and if the value is not the same as the expected then force the expected value
 737     int choiceIndex = choiceCounter % refChoices.length;
 738     int nextChoice = icsCG.getNextChoice();
 739     if (refChoices[choiceIndex] != nextChoice) {
 740       int expectedChoice = refChoices[choiceIndex];
 741       int currCGIndex = icsCG.getNextChoiceIndex();
 742       if ((currCGIndex >= 0) && (currCGIndex < refChoices.length)) {
 743         icsCG.setChoice(currCGIndex, expectedChoice);
 744       }
 745     }
 746     // Get state ID and associate it with this transition
 747     int stateId = vm.getStateId();
 748     TransitionEvent transition = setupTransition(icsCG, stateId, choiceIndex);
 749     // Add new transition to the current execution and map it in R-Graph
 750     for (Integer stId : justVisitedStates) {  // Map this transition to all the previously passed states
 751       rGraph.addReachableTransition(stId, transition);
 752     }
 753     currentExecution.mapCGToChoice(icsCG, choiceCounter);
 754     // Store restorable state object for this state (always store the latest)
 755     if (!restorableStateMap.containsKey(stateId)) {
 756       RestorableVMState restorableState = vm.getRestorableState();
 757       restorableStateMap.put(stateId, restorableState);
 758     }
 759   }
 760
 761   private TransitionEvent setupTransition(IntChoiceFromSet icsCG, int stateId, int choiceIndex) {
 762     // Get a new transition
 763     TransitionEvent transition;
 764     if (currentExecution.isNew()) {
 765       // We need to handle the first transition differently because this has a predecessor execution
 766       transition = currentExecution.getFirstTransition();
 767     } else {
 768       transition = new TransitionEvent();
 769       currentExecution.addTransition(transition);
 770       transition.recordPredecessor(currentExecution, choiceCounter - 1);
 771     }
 772     transition.setExecution(currentExecution);
 773     transition.setTransitionCG(icsCG);
 774     transition.setStateId(stateId);
 775     transition.setChoice(refChoices[choiceIndex]);
 776     transition.setChoiceCounter(choiceCounter);
 777
 778     return transition;
 779   }
 780
 781   // --- Functions related to cycle detection and reachability graph
 782
 783   // Detect cycles in the current execution/trace
 784   // We terminate the execution iff:
 785   // (1) the state has been visited in the current execution
 786   // (2) the state has one or more cycles that involve all the events
 787   // With simple approach we only need to check for a re-visited state.
 788   // Basically, we have to check that we have executed all events between two occurrences of such state.
 789   private boolean completeFullCycle(int stId) {
 790     // False if the state ID hasn't been recorded
 791     if (!stateToEventMap.containsKey(stId)) {
 792       return false;
 793     }
 794     HashSet<Integer> visitedEvents = stateToEventMap.get(stId);
 795     // Check if this set contains all the event choices
 796     // If not then this is not the terminating condition
 797     for(int i=0; i<=maxEventChoice; i++) {
 798       if (!visitedEvents.contains(i)) {
 799         return false;
 800       }
 801     }
 802     return true;
 803   }
 804
 805   private void initializeStatesVariables() {
 806     // DPOR-related
 807     choices = null;
 808     refChoices = null;
 809     choiceCounter = 0;
 810     maxEventChoice = 0;
 811     // Cycle tracking
 812     currVisitedStates = new HashSet<>();
 813     justVisitedStates = new HashSet<>();
 814     prevVisitedStates = new HashSet<>();
 815     stateToEventMap = new HashMap<>();
 816     // Backtracking
 817     backtrackMap = new HashMap<>();
 818     backtrackStateQ = new PriorityQueue<>(Collections.reverseOrder());
 819     currentExecution = new Execution();
 820     currentExecution.addTransition(new TransitionEvent()); // Always start with 1 backtrack point
 821     doneBacktrackMap = new HashMap<>();
 822     rGraph = new RGraph();
 823     // Booleans
 824     isEndOfExecution = false;
 825   }
 826
 827   private void mapStateToEvent(int nextChoiceValue) {
 828     // Update all states with this event/choice
 829     // This means that all past states now see this transition
 830     Set<Integer> stateSet = stateToEventMap.keySet();
 831     for(Integer stateId : stateSet) {
 832       HashSet<Integer> eventSet = stateToEventMap.get(stateId);
 833       eventSet.add(nextChoiceValue);
 834     }
 835   }
 836
 837   private boolean terminateCurrentExecution() {
 838     // We need to check all the states that have just been visited
 839     // Often a transition (choice/event) can result into forwarding/backtracking to a number of states
 840     for(Integer stateId : justVisitedStates) {
 841       if (prevVisitedStates.contains(stateId) || completeFullCycle(stateId)) {
 842         return true;
 843       }
 844     }
 845     return false;
 846   }
 847
 848   private void updateStateInfo(Search search) {
 849     // Update the state variables
 850     int stateId = search.getStateId();
 851     // Insert state ID into the map if it is new
 852     if (!stateToEventMap.containsKey(stateId)) {
 853       HashSet<Integer> eventSet = new HashSet<>();
 854       stateToEventMap.put(stateId, eventSet);
 855     }
 856     analyzeReachabilityAndCreateBacktrackPoints(search.getVM(), stateId);
 857     justVisitedStates.add(stateId);
 858     if (!prevVisitedStates.contains(stateId)) {
 859       // It is a currently visited states if the state has not been seen in previous executions
 860       currVisitedStates.add(stateId);
 861     }
 862   }
 863
 864   // --- Functions related to Read/Write access analysis on shared fields
 865
 866   private void addNewBacktrackPoint(int stateId, Integer[] newChoiceList, TransitionEvent conflictTransition) {
 867     // Insert backtrack point to the right state ID
 868     LinkedList<BacktrackExecution> backtrackExecList;
 869     if (backtrackMap.containsKey(stateId)) {
 870       backtrackExecList = backtrackMap.get(stateId);
 871     } else {
 872       backtrackExecList = new LinkedList<>();
 873       backtrackMap.put(stateId, backtrackExecList);
 874     }
 875     // Add the new backtrack execution object
 876     TransitionEvent backtrackTransition = new TransitionEvent();
 877     backtrackTransition.setPredecessors(conflictTransition.getPredecessors());
 878     backtrackExecList.addFirst(new BacktrackExecution(newChoiceList, backtrackTransition));
 879     // Add to priority queue
 880     if (!backtrackStateQ.contains(stateId)) {
 881       backtrackStateQ.add(stateId);
 882     }
 883   }
 884
 885   // Analyze Read/Write accesses that are directly invoked on fields
 886   private void analyzeReadWriteAccesses(Instruction executedInsn, int currentChoice) {
 887     // Get the field info
 888     FieldInfo fieldInfo = ((JVMFieldInstruction) executedInsn).getFieldInfo();
 889     // Analyze only after being initialized
 890     String fieldClass = fieldInfo.getFullName();
 891     // Do the analysis to get Read and Write accesses to fields
 892     ReadWriteSet rwSet = getReadWriteSet(currentChoice);
 893     int objectId = fieldInfo.getClassInfo().getClassObjectRef();
 894     // Record the field in the map
 895     if (executedInsn instanceof WriteInstruction) {
 896       // We first check the non-relevant fields set
 897       if (!nonRelevantFields.contains(fieldInfo)) {
 898         // Exclude certain field writes because of infrastructure needs, e.g., Event class field writes
 899         for (String str : EXCLUDED_FIELDS_READ_WRITE_INSTRUCTIONS_STARTS_WITH_LIST) {
 900           if (fieldClass.startsWith(str)) {
 901             nonRelevantFields.add(fieldInfo);
 902             return;
 903           }
 904         }
 905       } else {
 906         // If we have this field in the non-relevant fields set then we return right away
 907         return;
 908       }
 909       rwSet.addWriteField(fieldClass, objectId);
 910     } else if (executedInsn instanceof ReadInstruction) {
 911       rwSet.addReadField(fieldClass, objectId);
 912     }
 913   }
 914
 915   // Analyze Read accesses that are indirect (performed through iterators)
 916   // These accesses are marked by certain bytecode instructions, e.g., INVOKEINTERFACE
 917   private void analyzeReadWriteAccesses(Instruction instruction, ThreadInfo ti, int currentChoice) {
 918     // Get method name
 919     INVOKEINTERFACE insn = (INVOKEINTERFACE) instruction;
 920     if (insn.toString().startsWith(GET_PROPERTY_METHOD) &&
 921             insn.getMethodInfo().getName().equals(DO_CALL_METHOD)) {
 922       // Extract info from the stack frame
 923       StackFrame frame = ti.getTopFrame();
 924       int[] frameSlots = frame.getSlots();
 925       // Get the Groovy callsite library at index 0
 926       ElementInfo eiCallsite = VM.getVM().getHeap().get(frameSlots[0]);
 927       if (!eiCallsite.getClassInfo().getName().startsWith(GROOVY_CALLSITE_LIB)) {
 928         return;
 929       }
 930       // Get the iterated object whose property is accessed
 931       ElementInfo eiAccessObj = VM.getVM().getHeap().get(frameSlots[1]);
 932       if (eiAccessObj == null) {
 933         return;
 934       }
 935       // We exclude library classes (they start with java, org, etc.) and some more
 936       ClassInfo classInfo = eiAccessObj.getClassInfo();
 937       String objClassName = classInfo.getName();
 938       // Check if this class info is part of the non-relevant classes set already
 939       if (!nonRelevantClasses.contains(classInfo)) {
 940         if (excludeThisForItStartsWith(EXCLUDED_FIELDS_READ_WRITE_INSTRUCTIONS_STARTS_WITH_LIST, objClassName) ||
 941                 excludeThisForItStartsWith(EXCLUDED_FIELDS_STARTS_WITH_LIST, objClassName)) {
 942           nonRelevantClasses.add(classInfo);
 943           return;
 944         }
 945       } else {
 946         // If it is part of the non-relevant classes set then return immediately
 947         return;
 948       }
 949       // Extract fields from this object and put them into the read write
 950       int numOfFields = eiAccessObj.getNumberOfFields();
 951       for(int i=0; i<numOfFields; i++) {
 952         FieldInfo fieldInfo = eiAccessObj.getFieldInfo(i);
 953         if (fieldInfo.getType().equals(JAVA_STRING_LIB) || fieldInfo.getType().equals(JAVA_INTEGER)) {
 954           String fieldClass = fieldInfo.getFullName();
 955           ReadWriteSet rwSet = getReadWriteSet(currentChoice);
 956           int objectId = fieldInfo.getClassInfo().getClassObjectRef();
 957           // Record the field in the map
 958           rwSet.addReadField(fieldClass, objectId);
 959         }
 960       }
 961     }
 962   }
 963
 964   private int checkAndAdjustChoice(int currentChoice, VM vm) {
 965     // If current choice is not the same, then this is caused by the firing of IntIntervalGenerator
 966     // for certain method calls in the infrastructure, e.g., eventSince()
 967     ChoiceGenerator<?> currentCG = vm.getChoiceGenerator();
 968     // This is the main event CG
 969     if (currentCG instanceof IntIntervalGenerator) {
 970       // This is the interval CG used in device handlers
 971       ChoiceGenerator<?> parentCG = ((IntIntervalGenerator) currentCG).getPreviousChoiceGenerator();
 972       // Iterate until we find the IntChoiceFromSet CG
 973       while (!(parentCG instanceof IntChoiceFromSet)) {
 974         parentCG = ((IntIntervalGenerator) parentCG).getPreviousChoiceGenerator();
 975       }
 976       // Find the choice related to the IntIntervalGenerator CG from the map
 977       currentChoice = currentExecution.getChoiceFromCG((IntChoiceFromSet) parentCG);
 978     }
 979     return currentChoice;
 980   }
 981
 982   private void createBacktrackingPoint(Execution execution, int currentChoice,
 983                                        Execution conflictExecution, int conflictChoice) {
 984     // Create a new list of choices for backtrack based on the current choice and conflicting event number
 985     // E.g. if we have a conflict between 1 and 3, then we create the list {3, 1, 0, 2}
 986     // for the original set {0, 1, 2, 3}
 987
 988     // execution/currentChoice represent the event/transaction that will be put into the backtracking set of
 989     // conflictExecution/conflictChoice
 990     Integer[] newChoiceList = new Integer[refChoices.length];
 991     ArrayList<TransitionEvent> currentTrace = execution.getExecutionTrace();
 992     ArrayList<TransitionEvent> conflictTrace = conflictExecution.getExecutionTrace();
 993     int currChoice = currentTrace.get(currentChoice).getChoice();
 994     int stateId = conflictTrace.get(conflictChoice).getStateId();
 995     // Check if this trace has been done from this state
 996     if (isTraceAlreadyConstructed(currChoice, stateId)) {
 997       return;
 998     }
 999     // Put the conflicting event numbers first and reverse the order
1000     newChoiceList[0] = currChoice;
1001     // Put the rest of the event numbers into the array starting from the minimum to the upper bound
1002     for (int i = 0, j = 1; i < refChoices.length; i++) {
1003       if (refChoices[i] != newChoiceList[0]) {
1004         newChoiceList[j] = refChoices[i];
1005         j++;
1006       }
1007     }
1008     // Predecessor of the new backtrack point is the same as the conflict point's
1009     addNewBacktrackPoint(stateId, newChoiceList, conflictTrace.get(conflictChoice));
1010   }
1011
1012   private boolean excludeThisForItContains(String[] excludedStrings, String className) {
1013     for (String excludedField : excludedStrings) {
1014       if (className.contains(excludedField)) {
1015         return true;
1016       }
1017     }
1018     return false;
1019   }
1020
1021   private boolean excludeThisForItEndsWith(String[] excludedStrings, String className) {
1022     for (String excludedField : excludedStrings) {
1023       if (className.endsWith(excludedField)) {
1024         return true;
1025       }
1026     }
1027     return false;
1028   }
1029
1030   private boolean excludeThisForItStartsWith(String[] excludedStrings, String className) {
1031     for (String excludedField : excludedStrings) {
1032       if (className.startsWith(excludedField)) {
1033         return true;
1034       }
1035     }
1036     return false;
1037   }
1038
1039   private void exploreNextBacktrackPoints(VM vm, IntChoiceFromSet icsCG) {
1040                 // Check if we are reaching the end of our execution: no more backtracking points to explore
1041                 // cgMap, backtrackMap, backtrackStateQ are updated simultaneously (checking backtrackStateQ is enough)
1042                 if (!backtrackStateQ.isEmpty()) {
1043                         // Set done all the other backtrack points
1044                         for (TransitionEvent backtrackTransition : currentExecution.getExecutionTrace()) {
1045         backtrackTransition.getTransitionCG().setDone();
1046                         }
1047                         // Reset the next backtrack point with the latest state
1048                         int hiStateId = backtrackStateQ.peek();
1049                         // Restore the state first if necessary
1050                         if (vm.getStateId() != hiStateId) {
1051                                 RestorableVMState restorableState = restorableStateMap.get(hiStateId);
1052                                 vm.restoreState(restorableState);
1053                         }
1054                         // Set the backtrack CG
1055                         IntChoiceFromSet backtrackCG = (IntChoiceFromSet) vm.getChoiceGenerator();
1056                         setBacktrackCG(hiStateId, backtrackCG);
1057                 } else {
1058                         // Set done this last CG (we save a few rounds)
1059                         icsCG.setDone();
1060                 }
1061                 // Save all the visited states when starting a new execution of trace
1062                 prevVisitedStates.addAll(currVisitedStates);
1063                 // This marks a transitional period to the new CG
1064                 isEndOfExecution = true;
1065   }
1066
1067   private boolean isConflictFound(Execution execution, int reachableChoice, Execution conflictExecution, int conflictChoice,
1068                                   ReadWriteSet currRWSet) {
1069     // conflictExecution/conflictChoice represent a predecessor event/transaction that can potentially have a conflict
1070     ArrayList<TransitionEvent> executionTrace = execution.getExecutionTrace();
1071     ArrayList<TransitionEvent> conflictTrace = conflictExecution.getExecutionTrace();
1072     HashMap<Integer, ReadWriteSet> confRWFieldsMap = conflictExecution.getReadWriteFieldsMap();
1073     // Skip if this event does not have any Read/Write set or the two events are basically the same event (number)
1074     if (!confRWFieldsMap.containsKey(conflictChoice) ||
1075             executionTrace.get(reachableChoice).getChoice() == conflictTrace.get(conflictChoice).getChoice()) {
1076       return false;
1077     }
1078     // R/W set of choice/event that may have a potential conflict
1079     ReadWriteSet confRWSet = confRWFieldsMap.get(conflictChoice);
1080     // Check for conflicts with Read and Write fields for Write instructions
1081     Set<String> currWriteSet = currRWSet.getWriteSet();
1082     for(String writeField : currWriteSet) {
1083       int currObjId = currRWSet.writeFieldObjectId(writeField);
1084       if ((confRWSet.readFieldExists(writeField) && confRWSet.readFieldObjectId(writeField) == currObjId) ||
1085           (confRWSet.writeFieldExists(writeField) && confRWSet.writeFieldObjectId(writeField) == currObjId)) {
1086         // Remove this from the write set as we are tracking per memory location
1087         currRWSet.removeWriteField(writeField);
1088         return true;
1089       }
1090     }
1091     // Check for conflicts with Write fields for Read instructions
1092     Set<String> currReadSet = currRWSet.getReadSet();
1093     for(String readField : currReadSet) {
1094       int currObjId = currRWSet.readFieldObjectId(readField);
1095       if (confRWSet.writeFieldExists(readField) && confRWSet.writeFieldObjectId(readField) == currObjId) {
1096         // Remove this from the read set as we are tracking per memory location
1097         currRWSet.removeReadField(readField);
1098         return true;
1099       }
1100     }
1101     // Return false if no conflict is found
1102     return false;
1103   }
1104
1105   private ReadWriteSet getReadWriteSet(int currentChoice) {
1106     // Do the analysis to get Read and Write accesses to fields
1107     ReadWriteSet rwSet;
1108     // We already have an entry
1109     HashMap<Integer, ReadWriteSet> currReadWriteFieldsMap = currentExecution.getReadWriteFieldsMap();
1110     if (currReadWriteFieldsMap.containsKey(currentChoice)) {
1111       rwSet = currReadWriteFieldsMap.get(currentChoice);
1112     } else { // We need to create a new entry
1113       rwSet = new ReadWriteSet();
1114       currReadWriteFieldsMap.put(currentChoice, rwSet);
1115     }
1116     return rwSet;
1117   }
1118
1119   private boolean isFieldExcluded(Instruction executedInsn) {
1120     // Get the field info
1121     FieldInfo fieldInfo = ((JVMFieldInstruction) executedInsn).getFieldInfo();
1122     // Check if the non-relevant fields set already has it
1123     if (nonRelevantFields.contains(fieldInfo)) {
1124       return true;
1125     }
1126     // Check if the relevant fields set already has it
1127     if (relevantFields.contains(fieldInfo)) {
1128       return false;
1129     }
1130     // Analyze only after being initialized
1131     String field = fieldInfo.getFullName();
1132     // Check against "starts-with", "ends-with", and "contains" list
1133     if (excludeThisForItStartsWith(EXCLUDED_FIELDS_STARTS_WITH_LIST, field) ||
1134             excludeThisForItEndsWith(EXCLUDED_FIELDS_ENDS_WITH_LIST, field) ||
1135             excludeThisForItContains(EXCLUDED_FIELDS_CONTAINS_LIST, field)) {
1136       nonRelevantFields.add(fieldInfo);
1137       return true;
1138     }
1139     relevantFields.add(fieldInfo);
1140     return false;
1141   }
1142
1143   // Check if this trace is already constructed
1144   private boolean isTraceAlreadyConstructed(int firstChoice, int stateId) {
1145     // Concatenate state ID and only the first event in the string, e.g., "1:1 for the trace 10234 at state 1"
1146     // Check if the trace has been constructed as a backtrack point for this state
1147     // TODO: THIS IS AN OPTIMIZATION!
1148     HashSet<Integer> choiceSet;
1149     if (doneBacktrackMap.containsKey(stateId)) {
1150       choiceSet = doneBacktrackMap.get(stateId);
1151       if (choiceSet.contains(firstChoice)) {
1152         return true;
1153       }
1154     } else {
1155       choiceSet = new HashSet<>();
1156       doneBacktrackMap.put(stateId, choiceSet);
1157     }
1158     choiceSet.add(firstChoice);
1159
1160     return false;
1161   }
1162
1163   // Reset data structure for each new execution
1164   private void resetStatesForNewExecution(IntChoiceFromSet icsCG, VM vm) {
1165     if (choices == null || choices != icsCG.getAllChoices()) {
1166       // Reset state variables
1167       choiceCounter = 0;
1168       choices = icsCG.getAllChoices();
1169       refChoices = copyChoices(choices);
1170       // Clear data structures
1171       currVisitedStates = new HashSet<>();
1172       stateToEventMap = new HashMap<>();
1173       isEndOfExecution = false;
1174     }
1175   }
1176
1177   // Set a backtrack point for a particular state
1178   private void setBacktrackCG(int stateId, IntChoiceFromSet backtrackCG) {
1179     // Set a backtrack CG based on a state ID
1180     LinkedList<BacktrackExecution> backtrackExecutions = backtrackMap.get(stateId);
1181     BacktrackExecution backtrackExecution = backtrackExecutions.removeLast();
1182     backtrackCG.setNewValues(backtrackExecution.getChoiceList());  // Get the last from the queue
1183     backtrackCG.setStateId(stateId);
1184     backtrackCG.reset();
1185     // Update current execution with this new execution
1186     Execution newExecution = new Execution();
1187     TransitionEvent firstTransition = backtrackExecution.getFirstTransition();
1188     newExecution.addTransition(firstTransition);
1189     // Try to free some memory since this map is only used for the current execution
1190     currentExecution.clearCGToChoiceMap();
1191     currentExecution = newExecution;
1192     // Remove from the queue if we don't have more backtrack points for that state
1193     if (backtrackExecutions.isEmpty()) {
1194       backtrackMap.remove(stateId);
1195       backtrackStateQ.remove(stateId);
1196     }
1197   }
1198
1199   // Update backtrack sets
1200   // 1) recursively, and
1201   // 2) track accesses per memory location (per shared variable/field)
1202   private void updateBacktrackSet(Execution execution, int currentChoice) {
1203     // Copy ReadWriteSet object
1204     HashMap<Integer, ReadWriteSet> currRWFieldsMap = execution.getReadWriteFieldsMap();
1205     ReadWriteSet currRWSet = currRWFieldsMap.get(currentChoice);
1206     if (currRWSet == null) {
1207       return;
1208     }
1209     currRWSet = currRWSet.getCopy();
1210     // Memorize visited TransitionEvent object while performing backward DFS to avoid getting caught up in a cycle
1211     HashSet<TransitionEvent> visited = new HashSet<>();
1212     // Update backtrack set recursively
1213     // TODO: The following is the call to the original version of the method
1214 //    updateBacktrackSetRecursive(execution, currentChoice, execution, currentChoice, currRWSet, visited);
1215     // TODO: The following is the call to the version of the method with pushing up happens-before transitions
1216     updateBacktrackSetRecursive(execution, currentChoice, execution, currentChoice, currRWSet, visited);
1217   }
1218
1219 //  TODO: This is the original version of the recursive method
1220 //  private void updateBacktrackSetRecursive(Execution execution, int currentChoice,
1221 //                                           Execution conflictExecution, int conflictChoice,
1222 //                                           ReadWriteSet currRWSet, HashSet<TransitionEvent> visited) {
1223 //    // Halt when we have found the first read/write conflicts for all memory locations
1224 //    if (currRWSet.isEmpty()) {
1225 //      return;
1226 //    }
1227 //    TransitionEvent confTrans = conflictExecution.getExecutionTrace().get(conflictChoice);
1228 //    // Halt when we have visited this transition (in a cycle)
1229 //    if (visited.contains(confTrans)) {
1230 //      return;
1231 //    }
1232 //    visited.add(confTrans);
1233 //    // Explore all predecessors
1234 //    for (Predecessor predecessor : confTrans.getPredecessors()) {
1235 //      // Get the predecessor (previous conflict choice)
1236 //      conflictChoice = predecessor.getChoice();
1237 //      conflictExecution = predecessor.getExecution();
1238 //      // Check if a conflict is found
1239 //      if (isConflictFound(execution, currentChoice, conflictExecution, conflictChoice, currRWSet)) {
1240 //        createBacktrackingPoint(execution, currentChoice, conflictExecution, conflictChoice);
1241 //      }
1242 //      // Continue performing DFS if conflict is not found
1243 //      updateBacktrackSetRecursive(execution, currentChoice, conflictExecution, conflictChoice, currRWSet, visited);
1244 //    }
1245 //  }
1246
1247   // TODO: This is the version of the method with pushing up happens-before transitions
1248   private void updateBacktrackSetRecursive(Execution execution, int currentChoice,
1249                                            Execution conflictExecution, int conflictChoice,
1250                                            ReadWriteSet currRWSet, HashSet<TransitionEvent> visited) {
1251     TransitionEvent currTrans = execution.getExecutionTrace().get(currentChoice);
1252     // TODO: THIS IS THE ACCESS SUMMARY
1253     TransitionEvent confTrans = conflictExecution.getExecutionTrace().get(conflictChoice);
1254     // Record this transition into rGraph summary
1255     currRWSet = rGraph.recordTransitionSummary(currTrans.getStateId(), confTrans, currRWSet);
1256     // Halt when we have found the first read/write conflicts for all memory locations
1257     if (currRWSet.isEmpty()) {
1258       return;
1259     }
1260     if (visited.contains(currTrans)) {
1261       return;
1262     }
1263     visited.add(currTrans);
1264     // Explore all predecessors
1265     for (Predecessor predecessor : currTrans.getPredecessors()) {
1266       // Get the predecessor (previous conflict choice)
1267       int predecessorChoice = predecessor.getChoice();
1268       Execution predecessorExecution = predecessor.getExecution();
1269       // Push up one happens-before transition
1270       int newConflictChoice = conflictChoice;
1271       Execution newConflictExecution = conflictExecution;
1272       // Check if a conflict is found
1273       if (isConflictFound(conflictExecution, conflictChoice, predecessorExecution, predecessorChoice, currRWSet)) {
1274         createBacktrackingPoint(conflictExecution, conflictChoice, predecessorExecution, predecessorChoice);
1275         newConflictChoice = conflictChoice;
1276         newConflictExecution = conflictExecution;
1277       }
1278       // Continue performing DFS if conflict is not found
1279       updateBacktrackSetRecursive(predecessorExecution, predecessorChoice, newConflictExecution, newConflictChoice,
1280               currRWSet, visited);
1281     }
1282     // Remove the transition after being explored
1283     // TODO: Seems to cause a lot of loops---commented out for now
1284     //visited.remove(confTrans);
1285   }
1286
1287   // --- Functions related to the reachability analysis when there is a state match
1288
1289   /*private void analyzeReachabilityAndCreateBacktrackPoints(VM vm, int stateId) {
1290     // Perform this analysis only when:
1291     // 1) this is not during a switch to a new execution,
1292     // 2) at least 2 choices/events have been explored (choiceCounter > 1),
1293     // 3) state > 0 (state 0 is for boolean CG)
1294     if (!isEndOfExecution && choiceCounter > 1 && stateId > 0) {
1295       if (currVisitedStates.contains(stateId) || prevVisitedStates.contains(stateId)) {
1296         // Update reachable transitions in the graph with a predecessor
1297         HashSet<TransitionEvent> reachableTransitions = rGraph.getReachableTransitionsAtState(stateId);
1298         for(TransitionEvent transition : reachableTransitions) {
1299           transition.recordPredecessor(currentExecution, choiceCounter - 1);
1300         }
1301         updateBacktrackSetsFromPreviousExecution(stateId);
1302       }
1303     }
1304   }
1305
1306   // Update the backtrack sets from previous executions
1307   private void updateBacktrackSetsFromPreviousExecution(int stateId) {
1308     // Collect all the reachable transitions from R-Graph
1309     HashSet<TransitionEvent> reachableTransitions = rGraph.getReachableTransitions(stateId);
1310     for(TransitionEvent transition : reachableTransitions) {
1311       Execution execution = transition.getExecution();
1312       int currentChoice = transition.getChoiceCounter();
1313       updateBacktrackSet(execution, currentChoice);
1314     }
1315   }*/
1316
1317   // TODO: THIS IS THE ACCESS SUMMARY
1318   private void analyzeReachabilityAndCreateBacktrackPoints(VM vm, int stateId) {
1319     // Perform this analysis only when:
1320     // 1) this is not during a switch to a new execution,
1321     // 2) at least 2 choices/events have been explored (choiceCounter > 1),
1322     // 3) state > 0 (state 0 is for boolean CG)
1323     if (!isEndOfExecution && choiceCounter > 1 && stateId > 0) {
1324       if (currVisitedStates.contains(stateId) || prevVisitedStates.contains(stateId)) {
1325         // Update reachable transitions in the graph with a predecessor
1326         HashSet<TransitionEvent> reachableTransitions = rGraph.getReachableTransitionsAtState(stateId);
1327         for(TransitionEvent transition : reachableTransitions) {
1328           transition.recordPredecessor(currentExecution, choiceCounter - 1);
1329         }
1330         updateBacktrackSetsFromPreviousExecution(currentExecution, choiceCounter - 1, stateId);
1331       }
1332     }
1333   }
1334
1335   private void updateBacktrackSetsFromPreviousExecution(Execution execution, int currentChoice, int stateId) {
1336     // Collect all the reachable transitions from R-Graph
1337     HashMap<Integer, SummaryNode> reachableTransitions = rGraph.getReachableTransitionsSummary(stateId);
1338     for(Map.Entry<Integer, SummaryNode> transition : reachableTransitions.entrySet()) {
1339       SummaryNode summaryNode = transition.getValue();
1340       TransitionEvent reachableTransition = summaryNode.getTransitionEvent();
1341       Execution conflictExecution = reachableTransition.getExecution();
1342       int conflictChoice = reachableTransition.getChoiceCounter();
1343       // Copy ReadWriteSet object
1344       ReadWriteSet currRWSet = summaryNode.getReadWriteSet();
1345       currRWSet = currRWSet.getCopy();
1346       // Memorize visited TransitionEvent object while performing backward DFS to avoid getting caught up in a cycle
1347       HashSet<TransitionEvent> visited = new HashSet<>();
1348       updateBacktrackSetRecursive(execution, currentChoice, conflictExecution, conflictChoice, currRWSet, visited);
1349     }
1350   }
1351 }