stats.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Bitdefender
 * SPDX-License-Identifier: Apache-2.0
 */
#ifndef _STATS_H_
#define _STATS_H_

#include "introdefs.h"

typedef enum _STAT_ID
{
    statsEptViolation = 0,      
    statsEptRead,               
    statsEptWrite,              
    statsEptExecute,            
    statsEptKernel,             
    statsEptUser,               
    statsEptDecode,             
    statsEptLookup,             
    statsEptHandle,             
    statsEptRMW,                

    statsVmcall,                
    statsCrViolation,           
    statsMsrViolation,          
    statsXcrViolation,          
    statsTimer,                 
    statsInt3,                  
    statsDtrViolation,          
    statsEventInjection,        
    statsModuleLoadViolation,   

    statsDeleteRegion,          
    statsDeleteGva,             

    statsHookCommit,            

    statsPtWriteProc,           
    statsPtWriteEmu,            
    statsPtWriteTotal,          
    statsPtWriteHits,           
    statsPtWriteRelevant,       

    statsExceptionsUser,        
    statsExceptionsKern,        
    statsExceptionsGlobMatch,   

    statsUmCrash,               

    statsVasmon,                
    statsVadCommitExisting,     

    statsPtsIntegrity,          
    statsPtsFilterInt3,         
    statsPtsFilterVmcall,       
    statsPtsFilterInsSearch,    
    statsSwapgsInsSearch,       

    statsSelfMapEntryProtection,

    statsCopyMemoryTotal,       

    statsCopyMemoryRead,        
    statsCopyMemoryWrite,       
    statsCopyMemoryProtectedRead,
    statsCopyMemoryProtectedWrite,

    statsDepViolation,          

    statsStackTrace32,          
    statsStackTrace64,          
    statsStackTraceSpecialCase,

    statsDpiGatherInfo,         
    statsProcessCreationCheck,  

    statsDpiDebugFlag,          
    statsDpiStackPivot,         
    statsDpiStealToken,         
    statsDpiHeapSpray,          
    statsDpiTokenPrivs,         
    statsDpiThreadStart,        

    statsNtEatRead,             
    statsTokenWrites,           

    statsKmUmWrites,            

    statsMaxCounter
} STAT_ID;


#ifndef DEBUG
#define STATS_DISABLE_TIMER 1
#endif

#if defined(USER_MODE) && !defined(CFG_DISABLE_HIRES_COUNTERS) && !defined(STATS_DISABLE_TIMER)
# include <time.h>
# define STATS_HAS_HIGHRES_TIMER 1
#endif

#ifdef STATS_HAS_HIGHRES_TIMER
typedef struct timespec TIMESPEC;
#else
typedef QWORD TIMESPEC;
#endif

typedef struct _STAT_COUNTER
{
    QWORD       TotalCount; 

#ifndef STATS_DISABLE_TIMER
    TIMESPEC    Start;      

    QWORD       StartEventId;
    QWORD       Max;        
    QWORD       StatCalls;

    TIMESPEC    Total;      
#endif
} STAT_COUNTER, *PSTAT_COUNTER;

#ifdef STATS_DISABLE_TIMER
#define STATS_ENTER(id)
#define STATS_DISCARD(id)
#else
#define STATS_ENTER(id)                 IntStatStart(id)
#define STATS_DISCARD(id)               IntStatDiscard(id)
#endif

#define STATS_EXIT(id)                  IntStatStop(id)

void
IntStatsDumpAll(
    void
    );

#ifdef STATS_DISABLE_TIMER

extern STAT_COUNTER gCounters[statsMaxCounter];

__forceinline void
IntStatStart(
    _In_ STAT_ID StatId
    )
{
    UNREFERENCED_PARAMETER(StatId);
}

__forceinline void
IntStatStop(
    _In_ STAT_ID StatId
    )
{
    gCounters[StatId].TotalCount++;
}

#else

void
IntStatStart(
    _In_ STAT_ID StatId
    );

void
IntStatStop(
    _In_ STAT_ID StatId
    );

#endif // STATS_DISABLE_TIMER

void
IntStatDiscard(
    _In_ STAT_ID StatId
    );

void
IntStatsResetAll(
    void
    );

void
IntStatsReset(
    _In_ STAT_ID StatId
    );

void
IntStatsInit(
    void
    );

#endif // _STATS_H_