Control.h

Go to the documentation of this file.

#pragma once 

//#define DEBUG_CONTROL

#include <signal.h>

#include "FleetArgs.h"
#include "Timing.h"
#include "IO.h"

extern std::atomic<bool> CTRL_C; //volatile sig_atomic_t CTRL_C;

struct Control {
    unsigned long steps;
    time_ms runtime;
    size_t nthreads;
    unsigned long restart;

    timept start_time;
    
    // NOTE TODO: THE BELOW SHOULD BE UPDATED TO BE ATOMIC SINCE ITS ACCESSED BY MULTPLE THREADS 
    std::atomic<unsigned long> done_steps; // how many have we done -- updated by multiple threads

    bool break_CTRLC; // should we break on ctrl_c?



    Control(unsigned long st=FleetArgs::steps, 
            unsigned long t=FleetArgs::runtime,
            size_t thr=FleetArgs::nthreads, 
            unsigned long re=FleetArgs::restart) : 
                    steps(st), runtime(t), nthreads(thr), restart(re), break_CTRLC(true) {
        // We defaultly read arguments from FleetArgs
        
        start(); // just defaultly because it's easier
    }
    
    Control(const Control& c)  : steps(c.steps), runtime(c.runtime), nthreads(c.nthreads), restart(c.restart), break_CTRLC(true) {      
        
        // NOTE: this is weird if using multiple threads 
        done_steps = c.done_steps.load();
    }
    
    void start() {
        done_steps = 0;
        start_time = now();
    }
    

    bool running() {
        ++done_steps;
        
        if(break_CTRLC and CTRL_C) {
            #ifdef DEBUG_CONTROL
                std::cerr << "Control break on CTRL_C"  << std::endl;
            #endif          
            return false; 
        }
        
        if(steps > 0 and done_steps >= steps+1) {
            #ifdef DEBUG_CONTROL
                std::cerr << "Control break on steps"  << std::endl;
            #endif          
            return false;
        }
        
        if(runtime > 0 and time_since(start_time) >= runtime) {
            #ifdef DEBUG_CONTROL
                std::cerr << "Control break on runtime\t"<< runtime << std::endl;
            #endif  
            return false;
        }
            
        return true;            
    }
    
};

Control InnerControl(unsigned long st=FleetArgs::inner_steps, 
                     unsigned long t=FleetArgs::inner_runtime, 
                     size_t thr=1, 
                     unsigned long re=FleetArgs::inner_restart) {
    return {st,t,thr,re};
}