TraceController.hpp

//
//  Copyright PHOENIX CONTACT Electronics GmbH
//
#pragma once
#include "Arp/System/Core/Arp.h"
#include "Arp/System/Commons/Logging.h"
#include "Arp/System/Core/Singleton.hxx"
#include "Arp/System/Commons/Logging.h"
#include "Arp/System/Commons/Runtime/SharedLibrary.hpp"
#include "Arp/System/Commons/Chrono/Timer.hpp"

#include <list>

namespace Arp { namespace System { namespace Ve
{
class ITraceControllerService;
}}};

namespace Arp { namespace System { namespace Commons { namespace Diagnostics
{

using Arp::System::Commons::Runtime::SharedLibrary;
using namespace Arp::System::Commons::Chrono;

class TraceController : public Singleton<TraceController>, private Loggable<TraceController>
{

    friend class Singleton<TraceController>;

public: // typedefs

    typedef std::list<Arp::String> SessionList;

public: // operations

    bool IsSessionDaemonAlive(void) const;

    void LoadTracepointLibrary(void);

    void UnloadTracepointLibrary(void);

    bool LoadSessionConfiguration(const Arp::String& session, const Arp::String& config);

    SessionList ListSessions(void);

    bool StartSession(const Arp::String& session);

    bool StopSession(const Arp::String& session);

    bool DestroySession(const Arp::String& session);

    bool TriggerSavingTraceOutputs(const bool& stopTriggerSession);

    bool IsSessionInSnapshotMode(const Arp::String& session);

    bool IsSessionEnabled(const Arp::String& session);

    bool IsSessionLoaded(const Arp::String& session);

public: // getter/setter operations

    void SetTracesSavingConfigs(const Arp::String& triggerSession, const Arp::String& outPath, const Arp::uint32& maxDirectorySize, const Arp::uint32& savingDelayTimeout);

private: // construction/destruction

    TraceController(void);

    TraceController(const TraceController& arg) = delete;

    TraceController& operator=(const TraceController& arg) = delete;

    ~TraceController(void);

private: // methods
    void RunTraceSavingTimer(void);

    bool RecordSessionSnapshot(const Arp::String& session);

private: // typedefs/usings

    using ITraceControllerService = Arp::System::Ve::ITraceControllerService;

private: // fields

    ITraceControllerService *pInstance;

    SharedLibrary pTracingLibrary;

    // Traces Saving Configs
    Arp::uint32 savingDelayTimeout;
    Arp::String triggerSession;
    Arp::String savingOutputPath;
    Arp::uint32 maxDirectorySize;

    // Saving Delay Timer
    Timer savingDelayTimer;

    bool stopSession;
    std::atomic_flag triggerSavingWorking = ATOMIC_FLAG_INIT;

    bool tracepointLibLoaded;
};

// inline methods of class TraceController

}}}} // end of namespace Arp::System::Commons::Diagnostics