RTTracer.h

/*******************************************************************************
 * Licensed Materials - Property of HCL
 * (c) Copyright HCL Technologies Ltd. 2025.  All Rights Reserved.
 *******************************************************************************/
#ifndef __RTTracer_h__
#define __RTTracer_h__ included
 
#include <fstream>
#include <string>
#include <RTJsonResult.h>
#include <RTStreamBuffer.h>
#if RTUseCPP11
#include <chrono>
#endif
 
class RTActor;
class RTMessage;
class RTProtocol;
 
class RTTracer: public RTStreamBuffer {
public:
    static RTS_INLINE void flushTrace(void);
 
    static RTS_INLINE bool isEnabled(void);
 
    static void setEnabled(bool);
 
    static bool configure(const char* configFile = nullptr);
 
    static RTS_INLINE bool isConfigured(void);
 
    static RTS_INLINE void note(const std::string& text);
 
    enum TraceEventKind {
        Initialize,         // Synchronous initialization of parts
        Send,               // Asynchronous send of a message
        Invoke,             // Synchronous invoke of a message (explicit reply)
        InvokeWithoutReply, // Synchronous invoke of a message (implicit reply)
        Reply,              // Synchronous reply of a message
        Pause,              // Pause tracing
        Flush               // Flush the trace file
    };
 
#if RTUseCPP11
    typedef std::chrono::system_clock::time_point TraceTime;
#endif
 
    struct TraceInfo {
        const RTActor* sender;
        const RTProtocol* fromPort;
        int fromIndex;
#if RTUseCPP11
        TraceTime t2;
#endif
 
        TraceInfo();
    };
 
    static RTTracer& instance();
 
protected:
    enum {
        TIME1 = 0x10,           // 0001 0000
        TIME2 = 0x20,           // 0010 0000
        TIME3 = 0x40,           // 0100 0000
        TIME_ABSOLUTE = 0x80,   // 1000 0000
        PRECISION_MASK = 0x0F,  // 0000 1111
        PRECISION_NANO = 0x09,  // 0000 1001
        PRECISION_MICRO = 0x06, // 0000 0110
        PRECISION_MILLI = 0x03  // 0000 0011
    };
 
    static RTJsonResult jsonConfig;
    static std::string _applicationName; // Name of traced application
    static std::string _traceFileName; // Name of generated trace file
#if RTTRACER_FLUSH_COUNT
    static int _messagesSinceFlush;
#endif
    static bool _enabled;
    static bool _configured;
    static bool _overwriteFile;
 
#if RTUseCPP11
    static TraceTime _start;
    static int _timestamps;
    void printTimestamp(const TraceTime& timestamp);
#endif
 
    std::string _traceFile;
    std::ofstream _file;
 
    RTTracer(void);
    ~RTTracer(void);
 
    static std::string initTraceFile(void);
 
    static void getSenderInfo(const RTMessage*, TraceInfo*);
 
    static RTS_INLINE void traceMS(const RTMessage*, TraceEventKind traceEventKind, const TraceInfo* = nullptr);
 
    void traceMessage(const RTMessage*, TraceEventKind traceEventKind, const TraceInfo*);
    void traceNote(const std::string& text);
    void traceNote_nolock(const std::string& text);
    int flush(void) override;
 
    friend class RTActor;
    friend class RTMessage;
    friend class RTProtocol;
};
 
#define TRACE_TIME1 "time1_send"
#define TRACE_TIME2 "time2_receive"
#define TRACE_TIME3 "time3_handle"
 
#if RTS_INLINES
#include <RTTracer.inl>
#endif
 
#endif