All Downloads are FREE. Search and download functionalities are using the official Maven repository.

il.ac.bgu.cs.bp.bpjs.analysis.BProgramStateVisitedStateStore Maven / Gradle / Ivy

/*
 * The MIT License
 *
 * Copyright 2017 michael.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package il.ac.bgu.cs.bp.bpjs.analysis;

import il.ac.bgu.cs.bp.bpjs.model.BThreadSyncSnapshot;
import java.util.HashSet;
import java.util.Set;

/**
 *
 * A {@link VisitedStateStore} that stores the state of the {@code BThread}s in the node.
 * Ignores the last event that led to this node.
 * 
 * Client code can specify to use a hash of the state instead of the state itself. This 
 * may create false positives on hash collisions, but would make the dearch run faster and 
 * consume less memory.
 * 
 * @author michael
 */
public class BProgramStateVisitedStateStore implements VisitedStateStore {
    private final Set visited = new HashSet<>();
    
    private boolean useHash;
    
    public BProgramStateVisitedStateStore() {
        this(false);
    }
    
    public BProgramStateVisitedStateStore(boolean useHash) {
        this.useHash = useHash;
    }
    
    @Override
    public void store(Node nd) {
        visited.add( extractStatus(nd) );
    }

    @Override
    public boolean isVisited(Node nd) {
        return visited.contains( extractStatus(nd) );
    }   
    
    private Object extractStatus( Node nd ) {
        final Set bThreadSnapshots = nd.getSystemState().getBThreadSnapshots();
        return useHash ? hash(bThreadSnapshots) : bThreadSnapshots;
    }
    
    private long hash( Set snapshots ) {
        long hash = 0;
        for ( BThreadSyncSnapshot snp : snapshots ) {
            hash = hash ^ snp.getContinuationProgramState().hashCode();
        }
        return hash;
    }
    
    public boolean isUseHash() {
        return useHash;
    }

    public void setUseHash(boolean useHash) {
        this.useHash = useHash;
    }
    
    @Override
    public void clear() {
        visited.clear();
    }
    
    @Override
    public String toString() {
        return "[BProgramStateVisitedNodeStore usingHash:" + isUseHash() + ']';
    }
}