EbcVmTest.h

Go to the documentation of this file.

 
#ifndef _EBC_VM_TEST_PROTOCOL_H_
#define _EBC_VM_TEST_PROTOCOL_H_
 
//
// Define a protocol for an EBC VM test interface.
//
#define EFI_EBC_VM_TEST_PROTOCOL_GUID \
  { \
    0xAAEACCFD, 0xF27B, 0x4C17, { 0xB6, 0x10, 0x75, 0xCA, 0x1F, 0x2D, 0xFB, 0x52 } \
  }
 
//
// Define for forward reference.
//
typedef struct _EFI_EBC_VM_TEST_PROTOCOL EFI_EBC_VM_TEST_PROTOCOL;
 
//
// VM major/minor version
//
#define VM_MAJOR_VERSION  1
#define VM_MINOR_VERSION  0
 
//
// Bits in the VM->StopFlags field
//
#define STOPFLAG_APP_DONE         0x0001
#define STOPFLAG_BREAKPOINT       0x0002
#define STOPFLAG_INVALID_BREAK    0x0004
#define STOPFLAG_BREAK_ON_CALLEX  0x0008
 
//
// Masks for working with the VM flags register
//
#define VMFLAGS_CC         0x0001 // condition flag
#define VMFLAGS_STEP       0x0002 // step instruction mode
#define VMFLAGS_ALL_VALID  (VMFLAGS_CC | VMFLAGS_STEP)
 
//
// Macros for operating on the VM flags register
//
#define VMFLAG_SET(pVM, Flag)    (pVM->Flags |= (Flag))
#define VMFLAG_ISSET(pVM, Flag)  ((pVM->Flags & (Flag)) ? 1 : 0)
#define VMFLAG_CLEAR(pVM, Flag)  (pVM->Flags &= ~(Flag))
 
//
// Define a macro to get the operand. Then we can change it to be either a
// direct read or have it call a function to read memory.
//
#define GETOPERANDS(pVM)  (UINT8) (*(UINT8 *) (pVM->Ip + 1))
#define GETOPCODE(pVM)    (UINT8) (*(UINT8 *) pVM->Ip)
 
//
// Macros for operating on the VM GP registers
//
#define OPERAND1_REGDATA(pVM, Op)  pVM->Gpr[OPERAND1_REGNUM (Op)]
#define OPERAND2_REGDATA(pVM, Op)  pVM->Gpr[OPERAND2_REGNUM (Op)]
 
//
// Bits of exception flags field of VM context
//
#define EXCEPTION_FLAG_FATAL    0x80000000  // can't continue
#define EXCEPTION_FLAG_ERROR    0x40000000  // bad, but try to continue
#define EXCEPTION_FLAG_WARNING  0x20000000  // harmless problem
#define EXCEPTION_FLAG_NONE     0x00000000  // for normal return
 
typedef UINT8 *VMIP;
 
typedef INT64  VM_REGISTER;
typedef UINT32 EXCEPTION_FLAGS;
 
typedef struct {
  VM_REGISTER         Gpr[8];               
  UINT64              Flags;                
  VMIP                Ip;                   
  UINTN               LastException;
  EXCEPTION_FLAGS     ExceptionFlags;       
  UINT32              StopFlags;
  UINT32              CompilerVersion;        
  UINTN               HighStackBottom;        
  UINTN               LowStackTop;            
  UINT64              StackRetAddr;           
  UINTN               *StackMagicPtr;         
  EFI_HANDLE          ImageHandle;            
  EFI_SYSTEM_TABLE    *SystemTable;           
  UINTN               LastAddrConverted;      
  UINTN               LastAddrConvertedValue; 
  VOID                *FramePtr;
  VOID                *EntryPoint;          
  UINTN               ImageBase;
  VOID                *StackPool;
  VOID                *StackTop;
} VM_CONTEXT;
 
typedef
EFI_STATUS
(EFIAPI *EBC_VM_TEST_EXECUTE)(
  IN EFI_EBC_VM_TEST_PROTOCOL         *This,
  IN VM_CONTEXT                       *VmPtr,
  IN OUT UINTN                        *InstructionCount
  );
 
typedef
EFI_STATUS
(EFIAPI *EBC_VM_TEST_ASM)(
  IN EFI_EBC_VM_TEST_PROTOCOL         *This,
  IN CHAR16                           *AsmText,
  IN OUT INT8                         *Buffer,
  IN OUT UINTN                        *BufferLen
  );
 
typedef
EFI_STATUS
(EFIAPI *EBC_VM_TEST_DASM)(
  IN EFI_EBC_VM_TEST_PROTOCOL         *This,
  IN OUT CHAR16                       *AsmText,
  IN OUT INT8                         *Buffer,
  IN OUT UINTN                        *Len
  );
 
//
// Prototype for the actual EBC test protocol interface
//
struct _EFI_EBC_VM_TEST_PROTOCOL {
  EBC_VM_TEST_EXECUTE    Execute;
  EBC_VM_TEST_ASM        Assemble;
  EBC_VM_TEST_DASM       Disassemble;
};
 
extern EFI_GUID  gEfiEbcVmTestProtocolGuid;
 
#endif