debugshare.h

Go to the documentation of this file.

/* SPDX-License-Identifier: MIT */
#ifndef AJA_DEBUGSHARE_H
#define AJA_DEBUGSHARE_H
#include "ajabase/common/export.h"
#include <stddef.h>
#include <stdint.h>
#include <string>
#include <vector>

typedef enum _AJADebugSeverity
{
    AJA_DebugSeverity_Emergency     = 0,    
    AJA_DebugSeverity_Alert         = 1,    
    AJA_DebugSeverity_Assert        = 2,    
    AJA_DebugSeverity_Error         = 3,    
    AJA_DebugSeverity_Warning       = 4,    
    AJA_DebugSeverity_Notice        = 5,    
    AJA_DebugSeverity_Info          = 6,    
    AJA_DebugSeverity_Debug         = 7,    
    AJA_DebugSeverity_Size          = 8     
} AJADebugSeverity;


typedef enum _AJADebugUnit
{
    AJA_DebugUnit_Unknown                   = 0,
    AJA_DebugUnit_Critical                  = 1,
    AJA_DebugUnit_DriverGeneric             = 2,
    AJA_DebugUnit_ServiceGeneric            = 3,
    AJA_DebugUnit_UserGeneric               = 4,
    AJA_DebugUnit_VideoGeneric              = 5,
    AJA_DebugUnit_AudioGeneric              = 6,
    AJA_DebugUnit_TimecodeGeneric           = 7,
    AJA_DebugUnit_AncGeneric                = 8,
    AJA_DebugUnit_RoutingGeneric            = 9,
    AJA_DebugUnit_StatsGeneric              = 10,
    AJA_DebugUnit_Enumeration               = 11,
    AJA_DebugUnit_Application               = 12,
    AJA_DebugUnit_QuickTime                 = 13,
    AJA_DebugUnit_ControlPanel              = 14,
    AJA_DebugUnit_Watcher                   = 15,
    AJA_DebugUnit_Plugins                   = 16,
    AJA_DebugUnit_CCLine21Decode            = 17,
    AJA_DebugUnit_CCLine21Encode            = 18,
    AJA_DebugUnit_CC608DataQueue            = 19,
    AJA_DebugUnit_CC608MsgQueue             = 20,
    AJA_DebugUnit_CC608Decode               = 21,
    AJA_DebugUnit_CC608DecodeChannel        = 22,
    AJA_DebugUnit_CC608DecodeScreen         = 23,
    AJA_DebugUnit_CC608Encode               = 24,
    AJA_DebugUnit_CC708Decode               = 25,
    AJA_DebugUnit_CC708Service              = 26,
    AJA_DebugUnit_CC708ServiceBlockQueue    = 27,
    AJA_DebugUnit_CC708Window               = 28,
    AJA_DebugUnit_CC708Encode               = 29,
    AJA_DebugUnit_CCFont                    = 30,
    AJA_DebugUnit_SMPTEAnc                  = 31,
    AJA_DebugUnit_AJAAncData                = 32,
    AJA_DebugUnit_AJAAncList                = 33,
    AJA_DebugUnit_Testing                   = 34,
    AJA_DebugUnit_PnP                       = 35,
    AJA_DebugUnit_Persistence               = 36,
    AJA_DebugUnit_Avid                      = 37,
    AJA_DebugUnit_DriverInterface           = 38,
    AJA_DebugUnit_AutoCirculate             = 39,
    AJA_DebugUnit_NMOS                      = 40,
    AJA_DebugUnit_App_DiskRead              = 41,
    AJA_DebugUnit_App_DiskWrite             = 42,
    AJA_DebugUnit_App_Decode                = 43,
    AJA_DebugUnit_App_Encode                = 44,
    AJA_DebugUnit_App_DMA                   = 45,
    AJA_DebugUnit_App_Screen                = 46,
    AJA_DebugUnit_App_User1                 = 47,
    AJA_DebugUnit_App_User2                 = 48,
    AJA_DebugUnit_Anc2110Xmit               = 49,
    AJA_DebugUnit_Anc2110Rcv                = 50,
    AJA_DebugUnit_DemoPlayout               = 51,
    AJA_DebugUnit_DemoCapture               = 52,
    AJA_DebugUnit_CSC                       = 53,
    AJA_DebugUnit_LUT                       = 54,
    AJA_DebugUnit_Cables                    = 55,
    AJA_DebugUnit_RPCServer                 = 56,
    AJA_DebugUnit_RPCClient                 = 57,
    AJA_DebugUnit_Firmware                  = 58,
    AJA_DebugUnit_App_Alloc                 = 59,
    AJA_DebugUnit_Stream                    = 60,

    // to add a new unit:
    //
    // if there is an unused unit below:
    //
    //   * rename the next available unused and move above this comment block
    //   * make sure the enum starts with "AJA_DebugUnit_"
    //   * update the value of AJA_DebugUnit_FirstUnused with the value of the new next available unused
    //
    // else if there are not any unused units below:
    //
    //   * add the new unit above this message block with the next available index
    //   * make sure the enum starts with "AJA_DebugUnit_"
    //   * increment AJA_DebugUnit_Size by 1
    //
    // if no more unused units
    //   * set AJA_DebugUnit_FirstUnused to the same value as AJA_DebugUnit_Size
    //
    AJA_DebugUnit_FirstUnused               = 61,
    AJA_DebugUnit_Unused_61                 = AJA_DebugUnit_FirstUnused,
    AJA_DebugUnit_Unused_62                 = 62,
    AJA_DebugUnit_Unused_63                 = 63,
    AJA_DebugUnit_Unused_64                 = 64,
    AJA_DebugUnit_Unused_65                 = 65,
    AJA_DebugUnit_Unused_66                 = 66,
    AJA_DebugUnit_Unused_67                 = 67,
    AJA_DebugUnit_Unused_68                 = 68,
    AJA_DebugUnit_Unused_69                 = 69,
    AJA_DebugUnit_Unused_70                 = 70,
    AJA_DebugUnit_Unused_71                 = 71,
    AJA_DebugUnit_Unused_72                 = 72,
    AJA_DebugUnit_Unused_73                 = 73,
    AJA_DebugUnit_Unused_74                 = 74,
    AJA_DebugUnit_Unused_75                 = 75,
    AJA_DebugUnit_Unused_76                 = 76,
    AJA_DebugUnit_Unused_77                 = 77,
    AJA_DebugUnit_Unused_78                 = 78,
    AJA_DebugUnit_Unused_79                 = 79,
    AJA_DebugUnit_Unused_80                 = 80,
    AJA_DebugUnit_Unused_81                 = 81,
    AJA_DebugUnit_Unused_82                 = 82,
    AJA_DebugUnit_Unused_83                 = 83,
    AJA_DebugUnit_Unused_84                 = 84,

    AJA_DebugUnit_Size                      = 85

} AJADebugUnit;


#define AJA_DEBUG_DESTINATION_NONE      0           
#define AJA_DEBUG_DESTINATION_DEBUG     0x00000001  
#define AJA_DEBUG_DESTINATION_CONSOLE   0x00000002  
#define AJA_DEBUG_DESTINATION_LOG       0x00000004  
#define AJA_DEBUG_DESTINATION_DRIVER    0x00000008  


#define AJA_DEBUG_MAGIC_ID              AJA_FOURCC('D','B','U','G') 
#define AJA_DEBUG_VERSION               110                 
#define AJA_DEBUG_UNIT_ARRAY_SIZE       65536               
#define AJA_DEBUG_SEVERITY_ARRAY_SIZE   64                  
#define AJA_DEBUG_MAX_NUM_STATS         256                 
#define AJA_DEBUG_STAT_DEQUE_SIZE       11
#define AJA_DEBUG_MESSAGE_MAX_SIZE      512                 
#define AJA_DEBUG_MESSAGE_RING_SIZE     4096                
#define AJA_DEBUG_FILE_NAME_MAX_SIZE    512                 
#define AJA_DEBUG_SHARE_NAME            "aja-shm-debug"     
#define AJA_DEBUG_TICK_RATE             1000000             
#define AJA_DEBUG_STATE_FILE_VERSION    510                 


// using a 16 byte alignment for arm64 atomic operations to work properly
#pragma pack(push, 16)

typedef struct _AJADebugMessage
{
    uint64_t    sequenceNumber;                             
    int64_t     time;                                       
    int64_t     wallTime;                                   
    int32_t     groupIndex;                                 
    uint32_t    destinationMask;                            
    int32_t     severity;                                   
    int32_t     lineNumber;                                 
    uint64_t    pid;                                        
    uint64_t    tid;                                        
    char        fileName[AJA_DEBUG_FILE_NAME_MAX_SIZE];     
    char        messageText[AJA_DEBUG_MESSAGE_MAX_SIZE];    
} AJADebugMessage;


typedef enum _AJADebugStats
{
    AJA_DebugStat_ReadRegister              = 0,
    AJA_DebugStat_WriteRegister,
    AJA_DebugStat_WaitForInterruptIn1,
    AJA_DebugStat_WaitForInterruptIn2,
    AJA_DebugStat_WaitForInterruptIn3,
    AJA_DebugStat_WaitForInterruptIn4,
    AJA_DebugStat_WaitForInterruptIn5,
    AJA_DebugStat_WaitForInterruptIn6,
    AJA_DebugStat_WaitForInterruptIn7,
    AJA_DebugStat_WaitForInterruptIn8,
    AJA_DebugStat_WaitForInterruptOut1,
    AJA_DebugStat_WaitForInterruptUartRx1,
    AJA_DebugStat_WaitForInterruptUartTx1,
    AJA_DebugStat_WaitForInterruptUartRx2,
    AJA_DebugStat_WaitForInterruptUartTx2,
    AJA_DebugStat_WaitForInterruptOthers,
    AJA_DebugStat_GetInterruptCount,
    AJA_DebugStat_DMATransfer,
    AJA_DebugStat_DMATransferEx,
    AJA_DebugStat_DMATransferP2P,
    AJA_DebugStat_AutoCirculate,
    AJA_DebugStat_AutoCirculateXfer,
    AJA_DebugStat_NTV2Message,
    AJA_DebugStat_HEVCSendMessage,
    AJA_DebugStat_ACXferRPCEncode,
    AJA_DebugStat_ACXferRPCDecode,
    AJA_DebugStat_NUM_STATS
} AJADebugStats;


class AJA_EXPORT AJADebugStat
{
    public:
        uint32_t            fMin;                               
        uint32_t            fMax;                               
        uint32_t volatile   fCount;                             
        uint64_t            fLastTimeStamp;                     
        uint32_t            fValues[AJA_DEBUG_STAT_DEQUE_SIZE]; 
    //  Instance Methods
    public:
        inline AJADebugStat()       {Reset();}

        inline void Reset (void)
        {
            fMin = 0xFFFFFFFF;
            fMax = fCount = 0;
            fLastTimeStamp = 0;
            for (size_t n(0);  n < AJA_DEBUG_STAT_DEQUE_SIZE;  n++)
                fValues[n] = 0;
        }
        bool operator == (const AJADebugStat & inRHS) const;        
        inline bool operator != (const AJADebugStat & inRHS) const  {return !(*this == inRHS);} 
        double Average(void) const; 
        uint64_t Sum (size_t inNum = AJA_DEBUG_STAT_DEQUE_SIZE) const;      
        uint32_t Minimum (size_t inNum = AJA_DEBUG_STAT_DEQUE_SIZE) const;  
        uint32_t Maximum (size_t inNum = AJA_DEBUG_STAT_DEQUE_SIZE) const;  
        void Start (void);  
        bool Stop (void);   
        bool IncrementCount (const uint32_t inIncrement = 1, const bool inRollOver = true);

        bool DecrementCount (const uint32_t inDecrement = 1, const bool inRollUnder = true);

        inline bool IsSimpleCounter (void) const    {return fMin == 0xFFFFFFFF  &&  !fMax;} 
        void SetValue (const uint32_t inValue); 
        inline uint32_t GetCurrentValue (void) const    {return fCount ? fValues[CurrentValueIndex()] : 0;} 
        inline int CurrentValueIndex (void) const   {return fCount ? int((fCount - 1) % AJA_DEBUG_STAT_DEQUE_SIZE) : 9999;} 
        inline uint32_t GetValue (void) const   {return IsSimpleCounter()  ?  fCount  :  GetCurrentValue();}    
    //  Class Methods
    public:
        static std::string StatKeyName (const int inKey);
        static inline bool StatKeyHasName (const int inKey)     {return !StatKeyName(inKey).empty();}
        static bool SetStatKeyName (const int inKey, const std::string & inName);
        static std::vector<int> NamedStatKeys (void);
};  //  AJADebugStat


typedef struct _AJADebugShare
{
    uint32_t            magicId;                                    
    uint32_t            version;                                    
    uint64_t volatile   writeIndex;                                 
    int32_t volatile    clientRefCount;                             
    uint32_t            messageRingCapacity;                        
    uint32_t            messageTextCapacity;                        
    uint32_t            messageFileNameCapacity;                    
    uint32_t            unitArraySize;                              
    uint64_t volatile   statsMessagesAccepted;                      
    uint64_t volatile   statsMessagesIgnored;                       
    uint32_t            statCapacity;                               
    uint32_t volatile   statAllocChanges;                           
    uint64_t            statAllocMask[AJA_DEBUG_MAX_NUM_STATS/64];  
    uint32_t            reserved[128 - 1 - 1 - 2*AJA_DEBUG_MAX_NUM_STATS/64];   
    uint32_t            unitArray[AJA_DEBUG_UNIT_ARRAY_SIZE];       
    AJADebugMessage     messageRing[AJA_DEBUG_MESSAGE_RING_SIZE];   
    AJADebugStat        stats[AJA_DEBUG_MAX_NUM_STATS];             
} AJADebugShare;

#pragma pack(pop)

#endif  //  AJA_DEBUGSHARE_H