#include <GdbStubInternal.h>

Functions
UINTN	MaxEfiException (VOID)

UINTN	MaxRegisterCount (VOID)

BOOLEAN	CheckIsa (IN EFI_INSTRUCTION_SET_ARCHITECTURE Isa)

UINTN *	FindPointerToRegister (IN EFI_SYSTEM_CONTEXT SystemContext, IN UINTN RegNumber)

CHAR8 *	BasicReadRegister (IN EFI_SYSTEM_CONTEXT SystemContext, IN UINTN RegNumber, IN CHAR8 *OutBufPtr)

VOID	ReadNthRegister (IN EFI_SYSTEM_CONTEXT SystemContext, IN CHAR8 *InBuffer)

VOID EFIAPI	ReadGeneralRegisters (IN EFI_SYSTEM_CONTEXT SystemContext)

CHAR8 *	BasicWriteRegister (IN EFI_SYSTEM_CONTEXT SystemContext, IN UINTN RegNumber, IN CHAR8 *InBufPtr)

VOID EFIAPI	WriteNthRegister (IN EFI_SYSTEM_CONTEXT SystemContext, IN CHAR8 *InBuffer)

VOID EFIAPI	WriteGeneralRegisters (IN EFI_SYSTEM_CONTEXT SystemContext, IN CHAR8 *InBuffer)

VOID	AddSingleStep (IN EFI_SYSTEM_CONTEXT SystemContext)

VOID	RemoveSingleStep (IN EFI_SYSTEM_CONTEXT SystemContext)

VOID EFIAPI	ContinueAtAddress (IN EFI_SYSTEM_CONTEXT SystemContext, IN CHAR8 *PacketData)

VOID EFIAPI	SingleStep (IN EFI_SYSTEM_CONTEXT SystemContext, IN CHAR8 *PacketData)

UINTN	GetBreakpointDataAddress (IN EFI_SYSTEM_CONTEXT SystemContext, IN UINTN BreakpointNumber)

UINTN	GetBreakpointDetected (IN EFI_SYSTEM_CONTEXT SystemContext)

BREAK_TYPE	GetBreakpointType (IN EFI_SYSTEM_CONTEXT SystemContext, IN UINTN BreakpointNumber)

UINTN	ConvertLengthData (IN UINTN Length)

EFI_STATUS	FindNextFreeDebugRegister (IN EFI_SYSTEM_CONTEXT SystemContext, OUT UINTN *Register)

EFI_STATUS	EnableDebugRegister (IN EFI_SYSTEM_CONTEXT SystemContext, IN UINTN Register, IN UINTN Address, IN UINTN Length, IN UINTN Type)

EFI_STATUS	FindMatchingDebugRegister (IN EFI_SYSTEM_CONTEXT SystemContext, IN UINTN Address, IN UINTN Length, IN UINTN Type, OUT UINTN *Register)

EFI_STATUS	DisableDebugRegister (IN EFI_SYSTEM_CONTEXT SystemContext, IN UINTN Register)

VOID EFIAPI	InsertBreakPoint (IN EFI_SYSTEM_CONTEXT SystemContext, IN CHAR8 *PacketData)

VOID EFIAPI	RemoveBreakPoint (IN EFI_SYSTEM_CONTEXT SystemContext, IN CHAR8 *PacketData)

VOID	InitializeProcessor (VOID)

BOOLEAN	ValidateAddress (IN VOID *Address)

BOOLEAN	ValidateException (IN EFI_EXCEPTION_TYPE ExceptionType, IN OUT EFI_SYSTEM_CONTEXT SystemContext)

Variables
EFI_EXCEPTION_TYPE_ENTRY	gExceptionType []

UINTN	gRegisterOffsets []

Detailed Description

Processor specific parts of the GDB stub

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file Processor.c.

Function Documentation

◆ AddSingleStep()

VOID AddSingleStep ( IN EFI_SYSTEM_CONTEXT SystemContext )

Insert Single Step in the SystemContext

Parameters

SystemContext Register content at time of the exception

Definition at line 329 of file Processor.c.

◆ BasicReadRegister()

CHAR8 * BasicReadRegister	(	IN EFI_SYSTEM_CONTEXT	SystemContext,
		IN UINTN	RegNumber,
		IN CHAR8 *	OutBufPtr
	)

Adds the RegNumber-th register's value to the output buffer, starting at the given OutBufPtr

Parameters

SystemContext	Register content at time of the exception
RegNumber	the number of the register that we want to read
OutBufPtr	pointer to the output buffer's end. the new data will be added from this point on.

Return values

the	pointer to the next character of the output buffer that is available to be written on.

Definition at line 130 of file Processor.c.

◆ BasicWriteRegister()

CHAR8 * BasicWriteRegister	(	IN EFI_SYSTEM_CONTEXT	SystemContext,
		IN UINTN	RegNumber,
		IN CHAR8 *	InBufPtr
	)

Adds the RegNumber-th register's value to the output buffer, starting at the given OutBufPtr

Parameters

SystemContext	Register content at time of the exception
RegNumber	the number of the register that we want to write
InBufPtr	pointer to the output buffer. the new data will be extracted from the input buffer from this point on.

Return values

the	pointer to the next character of the input buffer that can be used

Definition at line 211 of file Processor.c.

◆ CheckIsa()

BOOLEAN CheckIsa ( IN EFI_INSTRUCTION_SET_ARCHITECTURE Isa )

Check to see if the ISA is supported. ISA = Instruction Set Architecture

Return values

TRUE	if Isa is supported

Definition at line 96 of file Processor.c.

◆ ContinueAtAddress()

VOID EFIAPI ContinueAtAddress	(	IN EFI_SYSTEM_CONTEXT	SystemContext,
		IN CHAR8 *	PacketData
	)

‘c [addr ]’ Continue. addr is Address to resume. If addr is omitted, resume at current Address.

Parameters

SystemContext Register content at time of the exception

Definition at line 357 of file Processor.c.

◆ ConvertLengthData()

UINTN ConvertLengthData ( IN UINTN Length )

Parses Length and returns the length which DR7 LENn field accepts. For example: If we receive 1-Byte length then we should return 0. Zero gets written to DR7 LENn field.

Parameters

Length Breakpoint length in Bytes (1 byte, 2 byte, 4 byte)

Return values

Length Appropriate converted values which DR7 LENn field accepts.

Definition at line 503 of file Processor.c.

◆ DisableDebugRegister()

EFI_STATUS DisableDebugRegister	(	IN EFI_SYSTEM_CONTEXT	SystemContext,
		IN UINTN	Register
	)

Disables the particular debug register.

Parameters

SystemContext	Register content at time of the exception
Register	Register to be disabled

Return values

EFI_STATUS Appropriate status value.

Definition at line 713 of file Processor.c.

◆ EnableDebugRegister()

EFI_STATUS EnableDebugRegister	(	IN EFI_SYSTEM_CONTEXT	SystemContext,
		IN UINTN	Register,
		IN UINTN	Address,
		IN UINTN	Length,
		IN UINTN	Type
	)

Enables the debug register. Writes Address value to appropriate DR0-3 register. Sets LENn, Gn, RWn bits in DR7 register.

Parameters

SystemContext	Register content at time of the exception
Register	Register value (0 - 3)
Address	Breakpoint address value
Type	Breakpoint type (Instruction, Data write, Data read or write etc.)

Return values

EFI_STATUS Appropriate status value.

Definition at line 571 of file Processor.c.

◆ FindMatchingDebugRegister()

EFI_STATUS FindMatchingDebugRegister	(	IN EFI_SYSTEM_CONTEXT	SystemContext,
		IN UINTN	Address,
		IN UINTN	Length,
		IN UINTN	Type,
		OUT UINTN *	Register
	)

Returns register number 0 - 3 for the matching debug register. This function compares incoming Address, Type, Length and if there is a match then it returns the appropriate register number. In case of mismatch, function returns EFI_NOT_FOUND message.

Parameters

SystemContext	Register content at time of the exception
Address	Breakpoint address value
Length	Breakpoint length value
Type	Breakpoint type (Instruction, Data write, Data read or write etc.)
Register	Register value to be returned

Return values

EFI_STATUS Appropriate status value.

Definition at line 648 of file Processor.c.

◆ FindNextFreeDebugRegister()

EFI_STATUS FindNextFreeDebugRegister	(	IN EFI_SYSTEM_CONTEXT	SystemContext,
		OUT UINTN *	Register
	)

Finds the next free debug register. If all the registers are occupied then EFI_OUT_OF_RESOURCES is returned.

Parameters

SystemContext	Register content at time of the exception
Register	Register value (0 - 3 for the first free debug register)

Return values

EFI_STATUS Appropriate status value.

Definition at line 533 of file Processor.c.

◆ FindPointerToRegister()

UINTN * FindPointerToRegister	(	IN EFI_SYSTEM_CONTEXT	SystemContext,
		IN UINTN	RegNumber
	)

This takes in the register number and the System Context, and returns a pointer to the RegNumber-th register in gdb ordering It is, by default, set to find the register pointer of the X64 member

Parameters

SystemContext	Register content at time of the exception
RegNumber	The register to which we want to find a pointer

Return values

the	pointer to the RegNumber-th pointer

Definition at line 111 of file Processor.c.

◆ GetBreakpointDataAddress()

UINTN GetBreakpointDataAddress	(	IN EFI_SYSTEM_CONTEXT	SystemContext,
		IN UINTN	BreakpointNumber
	)

Returns breakpoint data address from DR0-DR3 based on the input breakpoint number

Parameters

SystemContext	Register content at time of the exception
BreakpointNumber	Breakpoint number

Return values

Address Data address from DR0-DR3 based on the breakpoint number.

Definition at line 399 of file Processor.c.

◆ GetBreakpointDetected()

UINTN GetBreakpointDetected ( IN EFI_SYSTEM_CONTEXT SystemContext )

Returns currently detected breakpoint value based on the register DR6 B0-B3 field. If no breakpoint is detected then it returns 0.

Parameters

SystemContext Register content at time of the exception

Return values

{1-4}	Currently detected breakpoint value
0	No breakpoint detected.

Definition at line 433 of file Processor.c.

◆ GetBreakpointType()

BREAK_TYPE GetBreakpointType	(	IN EFI_SYSTEM_CONTEXT	SystemContext,
		IN UINTN	BreakpointNumber
	)

Returns Breakpoint type (InstructionExecution, DataWrite, DataRead or DataReadWrite) based on the Breakpoint number

Parameters

SystemContext	Register content at time of the exception
BreakpointNumber	Breakpoint number

Return values

BREAK_TYPE Breakpoint type value read from register DR7 RWn field. For unknown value, it returns NotSupported.

Definition at line 469 of file Processor.c.

◆ InitializeProcessor()

VOID InitializeProcessor ( VOID )

Definition at line 924 of file Processor.c.

◆ InsertBreakPoint()

VOID EFIAPI InsertBreakPoint	(	IN EFI_SYSTEM_CONTEXT	SystemContext,
		IN CHAR8 *	PacketData
	)

‘Z1, [addr], [length]’ ‘Z2, [addr], [length]’ ‘Z3, [addr], [length]’ ‘Z4, [addr], [length]’

Insert hardware breakpoint/watchpoint at address addr of size length

Parameters

SystemContext	Register content at time of the exception
*PacketData	Pointer to the Payload data for the packet

Definition at line 768 of file Processor.c.

◆ MaxEfiException()

UINTN MaxEfiException ( VOID )

Return the number of entries in the gExceptionType[]

Return values

UINTN,the number of entries in the gExceptionType[] array.

Definition at line 69 of file Processor.c.

◆ MaxRegisterCount()

UINTN MaxRegisterCount ( VOID )

Return the number of entries in the gRegisters[]

Return values

UINTN,the number of entries (registers) in the gRegisters[] array.

Definition at line 82 of file Processor.c.

◆ ReadGeneralRegisters()

VOID EFIAPI ReadGeneralRegisters ( IN EFI_SYSTEM_CONTEXT SystemContext )

‘g’ Reads the general registers into an output buffer and sends it as a packet

Parameters

SystemContext Register content at time of the exception

Definition at line 184 of file Processor.c.

◆ ReadNthRegister()

VOID ReadNthRegister	(	IN EFI_SYSTEM_CONTEXT	SystemContext,
		IN CHAR8 *	InBuffer
	)

‘p n’ Reads the n-th register's value into an output buffer and sends it as a packet

Parameters

SystemContext	Register content at time of the exception
InBuffer	Pointer to the input buffer received from gdb server

Definition at line 154 of file Processor.c.

◆ RemoveBreakPoint()

VOID EFIAPI RemoveBreakPoint	(	IN EFI_SYSTEM_CONTEXT	SystemContext,
		IN CHAR8 *	PacketData
	)

‘z1, [addr], [length]’ ‘z2, [addr], [length]’ ‘z3, [addr], [length]’ ‘z4, [addr], [length]’

Remove hardware breakpoint/watchpoint at address addr of size length

Parameters

*PacketData Pointer to the Payload data for the packet

Definition at line 852 of file Processor.c.

◆ RemoveSingleStep()

VOID RemoveSingleStep ( IN EFI_SYSTEM_CONTEXT SystemContext )

Remove Single Step in the SystemContext

Parameters

SystemContext Register content at time of the exception

Definition at line 342 of file Processor.c.

◆ SingleStep()

VOID EFIAPI SingleStep	(	IN EFI_SYSTEM_CONTEXT	SystemContext,
		IN CHAR8 *	PacketData
	)

‘s [addr ]’ Single step. addr is the Address at which to resume. If addr is omitted, resume at same Address.

Parameters

SystemContext Register content at time of the exception

Definition at line 375 of file Processor.c.

◆ ValidateAddress()

BOOLEAN ValidateAddress ( IN VOID * Address )

Definition at line 931 of file Processor.c.

◆ ValidateException()

BOOLEAN ValidateException	(	IN EFI_EXCEPTION_TYPE	ExceptionType,
		IN OUT EFI_SYSTEM_CONTEXT	SystemContext
	)

Definition at line 939 of file Processor.c.

◆ WriteGeneralRegisters()

VOID EFIAPI WriteGeneralRegisters	(	IN EFI_SYSTEM_CONTEXT	SystemContext,
		IN CHAR8 *	InBuffer
	)

‘G XX...’ Writes the new values received into the input buffer to the general registers

Parameters

SystemContext	Register content at time of the exception
InBuffer	Pointer to the input buffer received from gdb server

pointer to the input buffer

Definition at line 294 of file Processor.c.

◆ WriteNthRegister()

VOID EFIAPI WriteNthRegister	(	IN EFI_SYSTEM_CONTEXT	SystemContext,
		IN CHAR8 *	InBuffer
	)

‘P n...=r...’ Writes the new value of n-th register received into the input buffer to the n-th register

Parameters

SystemContext	Register content at time of the exception
InBuffer	Pointer to the input buffer received from gdb server

Definition at line 255 of file Processor.c.

Variable Documentation

◆ gExceptionType

EFI_EXCEPTION_TYPE_ENTRY gExceptionType[]

Initial value:

= {
  { EXCEPT_X64_DIVIDE_ERROR,    GDB_SIGFPE  },
  { EXCEPT_X64_DEBUG,           GDB_SIGTRAP },
  { EXCEPT_X64_NMI,             GDB_SIGEMT  },
  { EXCEPT_X64_BREAKPOINT,      GDB_SIGTRAP },
  { EXCEPT_X64_OVERFLOW,        GDB_SIGSEGV },
  { EXCEPT_X64_BOUND,           GDB_SIGSEGV },
  { EXCEPT_X64_INVALID_OPCODE,  GDB_SIGILL  },
  { EXCEPT_X64_DOUBLE_FAULT,    GDB_SIGEMT  },
  { EXCEPT_X64_STACK_FAULT,     GDB_SIGSEGV },
  { EXCEPT_X64_GP_FAULT,        GDB_SIGSEGV },
  { EXCEPT_X64_PAGE_FAULT,      GDB_SIGSEGV },
  { EXCEPT_X64_FP_ERROR,        GDB_SIGEMT  },
  { EXCEPT_X64_ALIGNMENT_CHECK, GDB_SIGEMT  },
  { EXCEPT_X64_MACHINE_CHECK,   GDB_SIGEMT  }
}

Definition at line 15 of file Processor.c.

◆ gRegisterOffsets

UINTN gRegisterOffsets[]

Initial value:

= {
  OFFSET_OF (EFI_SYSTEM_CONTEXT_X64, Rax),
  OFFSET_OF (EFI_SYSTEM_CONTEXT_X64, Rcx),
  OFFSET_OF (EFI_SYSTEM_CONTEXT_X64, Rdx),
  OFFSET_OF (EFI_SYSTEM_CONTEXT_X64, Rbx),
  OFFSET_OF (EFI_SYSTEM_CONTEXT_X64, Rsp),
  OFFSET_OF (EFI_SYSTEM_CONTEXT_X64, Rbp),
  OFFSET_OF (EFI_SYSTEM_CONTEXT_X64, Rsi),
  OFFSET_OF (EFI_SYSTEM_CONTEXT_X64, Rdi),
  OFFSET_OF (EFI_SYSTEM_CONTEXT_X64, Rip),
  OFFSET_OF (EFI_SYSTEM_CONTEXT_X64, Rflags),
  OFFSET_OF (EFI_SYSTEM_CONTEXT_X64, Cs),
  OFFSET_OF (EFI_SYSTEM_CONTEXT_X64, Ss),
  OFFSET_OF (EFI_SYSTEM_CONTEXT_X64, Ds),
  OFFSET_OF (EFI_SYSTEM_CONTEXT_X64, Es),
  OFFSET_OF (EFI_SYSTEM_CONTEXT_X64, Fs),
  OFFSET_OF (EFI_SYSTEM_CONTEXT_X64, Gs),
  OFFSET_OF (EFI_SYSTEM_CONTEXT_X64, R8),
  OFFSET_OF (EFI_SYSTEM_CONTEXT_X64, R9),
  OFFSET_OF (EFI_SYSTEM_CONTEXT_X64, R10),
  OFFSET_OF (EFI_SYSTEM_CONTEXT_X64, R11),
  OFFSET_OF (EFI_SYSTEM_CONTEXT_X64, R12),
  OFFSET_OF (EFI_SYSTEM_CONTEXT_X64, R13),
  OFFSET_OF (EFI_SYSTEM_CONTEXT_X64, R14),
 
}

Definition at line 36 of file Processor.c.

Functions

Variables

Detailed Description

Function Documentation

◆ AddSingleStep()

◆ BasicReadRegister()

◆ BasicWriteRegister()

◆ CheckIsa()

◆ ContinueAtAddress()

◆ ConvertLengthData()

◆ DisableDebugRegister()

◆ EnableDebugRegister()

◆ FindMatchingDebugRegister()

◆ FindNextFreeDebugRegister()

◆ FindPointerToRegister()

◆ GetBreakpointDataAddress()

◆ GetBreakpointDetected()

◆ GetBreakpointType()

◆ InitializeProcessor()

◆ InsertBreakPoint()

◆ MaxEfiException()

◆ MaxRegisterCount()

◆ ReadGeneralRegisters()

◆ ReadNthRegister()

◆ RemoveBreakPoint()

◆ RemoveSingleStep()

◆ SingleStep()

◆ ValidateAddress()

◆ ValidateException()

◆ WriteGeneralRegisters()

◆ WriteNthRegister()

Variable Documentation

◆ gExceptionType

◆ gRegisterOffsets