applicationExecutionManager.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2024 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/

#pragma once

#include <vrfQtProcessControl/vrfQtProcessControlDefines.h>
#include <vlpi/simulationAddress.h>
#include <map>
#include <set>
#include <memory>
#include <iostream>

enum DtVrfProcessErrorType {
   FailedToStart,
   Crashed,
   Timedout,
   ReadError,
   WriteError,
   UnknownError
};
struct DtVrfProcessError
{
   DtVrfProcessErrorType myErrorType;
   std::string myStdOut;
   std::string myStdError;
   int myExitCode;
};

class DtConnectionSettings;
class DtApplicationSet;
class DtVrfRemoteController;
typedef long long DtPidType;
enum ApplicationExecutionManagerState { Idle, ReadyToExecute, Executing, Running, Stopping};
class DT_DLL_vrfqtprocesscontrol DtApplicationExecutionManager
{
public:
   DtApplicationExecutionManager(std::shared_ptr<DtVrfRemoteController> remoteController, std::ostream& ostream = std::cout);
   virtual ~DtApplicationExecutionManager();

   virtual void initializeCallbacks();
   virtual void addApplication(
      const DtSimulationAddress& simAddr,
      const DtConnectionSettings* copyOnlyConnectionSettings,
      const DtApplicationSet& applicationSettings);

   virtual void execute();

   virtual bool haveProcessesQuit(const std::set<DtSimulationAddress>& simAddrs) const;

   virtual bool tick();
   virtual void requestStop();
   virtual void requestStop(const DtSimulationAddress& simAddr);

   virtual void terminate();

   virtual const std::map<DtSimulationAddress, DtPidType> pids() const;

   virtual void addError(const DtSimulationAddress& simAddress, const DtVrfProcessError& error);
   virtual void removeErrors(const DtSimulationAddress& simAddress);
   virtual void clearErrors();
   virtual const std::vector< std::pair<DtSimulationAddress, DtVrfProcessError> > errors() const;
   virtual void printErrors() const;
   virtual void printBackendStdOut(const DtSimulationAddress& backend) const;

protected:
   static void backendDiscoveredCallback(const DtSimulationAddress& addr, void* usr);
   static void backendRemovedCallback(const DtSimulationAddress& addr, void* usr);

   virtual void backendDiscovered(const DtSimulationAddress& addr);
   virtual void backendRemoved(const DtSimulationAddress& addr);
   virtual void addPidBySimulationAddressMapping(const DtSimulationAddress& simAddr, const DtPidType& pid);
   virtual void removePidBySimulationAddressMapping(const DtSimulationAddress& simAddr);
   virtual void addRunningStateBySimulationAddressMapping(const DtSimulationAddress& simAddr, const bool& isRunning);
   virtual void updateRunningStateBySimulationAddressMapping(const DtSimulationAddress& simAddr, const bool& isRunning);
   virtual void removeRunningStateBySimulationAddressMapping(const DtSimulationAddress& simAddr);

   virtual void addProcess(
      const DtSimulationAddress& simAddr,
      const DtConnectionSettings* copyOnlyConnectionSettings,
      const DtApplicationSet& applicationSettings) = 0;

   virtual void executeProcesses() = 0;
   virtual void executeProcess(const DtSimulationAddress& addr) = 0;

   virtual void terminateProcesses() = 0;
   virtual void terminateProcess(const DtSimulationAddress& addr) = 0;

   virtual bool checkProcessStates() = 0;
   virtual std::string backendStdOut(const DtSimulationAddress& addr) const = 0;
   std::map<DtSimulationAddress, DtPidType> myPidsBySimulationAddressMap;
   std::map<DtSimulationAddress, bool> myRunningStateBySimulationAddressMap;
   ApplicationExecutionManagerState myState;
   std::shared_ptr<DtVrfRemoteController> myRemoteController;

   std::vector< std::pair<DtSimulationAddress, DtVrfProcessError> > myErrors;
   static std::map<DtVrfProcessErrorType, const char*> theErrorMap;
   std::ostream& myDefaultOutputStream;
};