icache.h

Go to the documentation of this file.

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

#include "introtypes.h"
#include "bddisasm.h"


typedef struct _INS_CACHE_INV_ENTRY
{
    LIST_ENTRY          Link;           
    QWORD               Gva;            
    QWORD               Gpa;            
    QWORD               Cr3;            
    void                *WriteHook;     
    void                *SwapHook;      
    DWORD               RefCount;       
    BOOLEAN             Spill;
} INS_CACHE_INV_ENTRY, *PINS_CACHE_INV_ENTRY;


typedef struct _INS_CACHE_ENTRY
{
    INSTRUX             Instruction;    
    QWORD               Gva;            
    QWORD               Cr3;            
    DWORD               RefCount;       
    INS_CACHE_INV_ENTRY *Invd1;         
    INS_CACHE_INV_ENTRY *Invd2;         
    BOOLEAN             Valid;          
    BOOLEAN             Pinned;         
    BOOLEAN             Global;         
} INS_CACHE_ENTRY, *PINS_CACHE_ENTRY;


typedef struct _INS_CACHE_LINE
{
    INS_CACHE_ENTRY     *Entries;       
} INS_CACHE_LINE, *PINS_CACHE_LINE;


typedef struct _INS_CACHE
{
    DWORD               LinesCount;     
    DWORD               EntriesCount;   
    DWORD               InvCount;       

    DWORD               HitCount;       
    DWORD               MissCount;      
    DWORD               FillRate;       
    DWORD               FlushCount;     
    DWORD               ReplaceCount;   
    DWORD               PageFlushCount; 
    BOOLEAN             Dirty;          
    BOOLEAN             Disabled;       
    BYTE                _Reserved1[2];  
    INS_CACHE_LINE      *Lines;         
    LIST_HEAD           *InsInvGva;     
} INS_CACHE, *PINS_CACHE;


#define IC_ANY_VAS      0


//
// API
//
INTSTATUS
IntIcLookupInstruction(
    _In_ PINS_CACHE Cache,
    _Out_ PINSTRUX Instrux,
    _In_ QWORD Gva,
    _In_ QWORD Cr3
    );

INTSTATUS
IntIcFlush(
    _In_ PINS_CACHE Cache
    );

INTSTATUS
IntIcFlushAddress(
    _In_ PINS_CACHE Cache,
    _In_ QWORD Gva,
    _In_ QWORD Cr3
    );

INTSTATUS
IntIcFlushGvaPage(
    _In_ PINS_CACHE Cache,
    _In_ QWORD Gva,
    _In_ QWORD Cr3,
    _In_ BOOLEAN Spill
    );

INTSTATUS
IntIcFlushGpaPage(
    _In_ PINS_CACHE Cache,
    _In_ QWORD Gpa
    );

INTSTATUS
IntIcFlushVaSpace(
    _In_ PINS_CACHE Cache,
    _In_ QWORD Cr3
    );

INTSTATUS
IntIcAddInstruction(
    _In_ PINS_CACHE Cache,
    _In_ PINSTRUX Instruction,
    _In_ QWORD Gva,
    _In_ QWORD Cr3,
    _In_ BOOLEAN Global
    );

INTSTATUS
IntIcCreate(
    _Inout_ INS_CACHE **Cache,
    _In_ DWORD LinesCount,
    _In_ DWORD EntriesCount,
    _In_ DWORD InvCount
    );

INTSTATUS
IntIcDestroy(
    _Inout_ PINS_CACHE *Cache
    );

void
IntIcDumpIcache(
    void
    );

#endif // _ICACHE_H_