com.fluxtion.builder.debug.SepDebugger Maven / Gradle / Ivy

Go to download
/* 
 * Copyright (C) 2018 V12 Technology Ltd.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the Server Side Public License, version 1,
 * as published by MongoDB, Inc.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * Server Side Public License for more details.
 *
 * You should have received a copy of the Server Side Public License
 * along with this program.  If not, see 
 * .
 */
package com.fluxtion.builder.debug;

import com.fluxtion.api.event.Event;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.CopyOnWriteArraySet;
import java.util.concurrent.Semaphore;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.concurrent.atomic.LongAdder;

/**
 * Experimental feature - do not use
 * @author Greg Higgins
 */
public class SepDebugger {

    private final Semaphore stepSemaphore;
    private final AtomicBoolean stepping;
    private final AtomicBoolean recordStatistics;
    private final LongAdder adder;
    public final Map node2Statistics;
    private final CopyOnWriteArraySet listenerList;
    private Event currentEvent;

    public SepDebugger(SepInvocationListener invocationListener) {
        this.listenerList = new CopyOnWriteArraySet<>();
        if(invocationListener != null)
            listenerList.add(invocationListener);
        this.node2Statistics = new ConcurrentHashMap<>();
        this.stepSemaphore = new Semaphore(0);
        this.stepping = new AtomicBoolean(true);
        this.recordStatistics = new AtomicBoolean(true);
        this.adder = new LongAdder();
    }

    public SepDebugger() {
        this(new NullListener());
    }

    public int nodeInvocationCount() {
        return adder.intValue();
    }

    /**
     * resets the statistics for another run, but does not remove the node
     * mappings
     */
    public void resetStatistics() {
        for (NodeStatistic nodeHeuristic : node2Statistics.values()) {
            nodeHeuristic.resetStatistics();
        }
        adder.reset();
    }

    public void steppingOn(boolean steppingOn) {
        stepping.set(steppingOn);
        stepSemaphore.drainPermits();
        if (!steppingOn) {
            permitStep();
        }
    }

    public void statisticRecordingOn(boolean statisticsOn) {
        recordStatistics.set(statisticsOn);
    }

    /**
     * called by the debug controller to allow next step to happen.The stepper
     * will be blocked on the requestStep call until the permitStep function is
     * called.
     */
    public void permitStep() {
        stepSemaphore.release();
    }

    /**
     * called by the stepper to request permission for the next step to
     * happen.The stepper will be blocked on the requestStep call until the
     * permitStep function is called.
     */
    public void requestStep() throws InterruptedException {
        if (stepping.get()) {
            stepSemaphore.acquire();
        }
    }

    /**
     * removes all internal state from the SepDebugger.
     */
    public void resetDebugger() {
        node2Statistics.clear();
        stepping.set(true);
        recordStatistics.set(true);
        currentEvent = null;
    }

    public synchronized void nodeInvocation( Object node, String name) {
        try {
            for (SepInvocationListener invocationListener : listenerList) {
                invocationListener.nodePreInvocation(currentEvent, node, name);
            }
            requestStep();
        } catch (InterruptedException ex) {
            //decide what to do - probably just log
            return;
        }
        NodeStatistic heuristic = node2Statistics.get(name);
        if (heuristic == null) {
            heuristic = new NodeStatistic(name);
            node2Statistics.put(name, heuristic);
        }
        heuristic.incrementCallCount();
        adder.increment();
    }

    public void addSepInvocationListener(SepInvocationListener l) {
        listenerList.add(l);
    }

    public void removeSepInvocationListener(SepInvocationListener l) {
        listenerList.remove(l);
    }

    public void eventInvocation(Event event) {
        this.currentEvent = event;
        //TODO add stats for recording the event cound, both filtered and aggregated by ID
    }

    public Event getCurrentEvent() {
        return currentEvent;
    }
    
    private static final class NullListener implements SepInvocationListener {

        @Override
        public void nodePreInvocation(Event event, Object node, String nodeName) {
        }

    }
}