//\r
#define VM_STACK_KEY_VALUE 0xDEADBEEF\r
\r
+/**\r
+ Create thunks for an EBC image entry point, or an EBC protocol service.\r
+\r
+ @param ImageHandle Image handle for the EBC image. If not null, then\r
+ we're creating a thunk for an image entry point.\r
+ @param EbcEntryPoint Address of the EBC code that the thunk is to call\r
+ @param Thunk Returned thunk we create here\r
+ @param Flags Flags indicating options for creating the thunk\r
+\r
+ @retval EFI_SUCCESS The thunk was created successfully.\r
+ @retval EFI_INVALID_PARAMETER The parameter of EbcEntryPoint is not 16-bit\r
+ aligned.\r
+ @retval EFI_OUT_OF_RESOURCES There is not enough memory to created the EBC\r
+ Thunk.\r
+ @retval EFI_BUFFER_TOO_SMALL EBC_THUNK_SIZE is not larger enough.\r
+\r
+**/\r
EFI_STATUS\r
EbcCreateThunks (\r
IN EFI_HANDLE ImageHandle,\r
)\r
;\r
\r
+/**\r
+ Add a thunk to our list of thunks for a given image handle.\r
+ Also flush the instruction cache since we've written thunk code\r
+ to memory that will be executed eventually.\r
+\r
+ @param ImageHandle The image handle to which the thunk is tied.\r
+ @param ThunkBuffer The buffer that has been created/allocated.\r
+ @param ThunkSize The size of the thunk memory allocated.\r
+\r
+ @retval EFI_OUT_OF_RESOURCES Memory allocation failed.\r
+ @retval EFI_SUCCESS The function completed successfully.\r
+\r
+**/\r
EFI_STATUS\r
EbcAddImageThunk (\r
IN EFI_HANDLE ImageHandle,\r
// The interpreter calls these when an exception is detected,\r
// or as a periodic callback.\r
//\r
+/**\r
+ The VM interpreter calls this function when an exception is detected.\r
+\r
+ @param ExceptionType Specifies the processor exception detected.\r
+ @param ExceptionFlags Specifies the exception context. \r
+ @param VmPtr Pointer to a VM context for passing info to the\r
+ EFI debugger.\r
+\r
+ @retval EFI_SUCCESS This function completed successfully.\r
+\r
+**/\r
EFI_STATUS\r
EbcDebugSignalException (\r
IN EFI_EXCEPTION_TYPE ExceptionType,\r
#define STACK_POOL_SIZE (1024 * 1020)\r
#define MAX_STACK_NUM 4\r
\r
-EFI_STATUS\r
-EbcDebugSignalPeriodic (\r
- IN VM_CONTEXT *VmPtr\r
- )\r
-;\r
-\r
//\r
// External low level functions that are native-processor dependent\r
-//\r
+// \r
+/** \r
+ The VM thunk code stuffs an EBC entry point into a processor \r
+ register. Since we can't use inline assembly to get it from\r
+ the interpreter C code, stuff it into the return value\r
+ register and return.\r
+ \r
+ @return The contents of the register in which the entry point is passed.\r
+ \r
+**/ \r
UINTN\r
+EFIAPI\r
EbcLLGetEbcEntryPoint (\r
VOID\r
)\r
;\r
\r
+/**\r
+ Returns the caller's value of the stack pointer.\r
+\r
+ We adjust it by 4 here because when they called us, the return address\r
+ is put on the stack, thereby lowering it by 4 bytes.\r
+\r
+ @return The current value of the stack pointer for the caller. \r
+\r
+**/\r
UINTN\r
+EFIAPI\r
EbcLLGetStackPointer (\r
VOID\r
)\r
;\r
\r
+/**\r
+ This function is called to execute an EBC CALLEX instruction.\r
+ This instruction requires that we thunk out to external native\r
+ code. For x64, we switch stacks, copy the arguments to the stack \r
+ and jump to the specified function.\r
+ On return, we restore the stack pointer to its original location.\r
+ Destroys no working registers.\r
+\r
+ @param CallAddr The function address.\r
+ @param EbcSp The new EBC stack pointer.\r
+ @param FramePtr The frame pointer.\r
+ \r
+**/\r
VOID\r
+EFIAPI\r
EbcLLCALLEXNative (\r
IN UINTN CallAddr,\r
IN UINTN EbcSp,\r
)\r
;\r
\r
+/**\r
+ This function is called to execute an EBC CALLEX instruction.\r
+ The function check the callee's content to see whether it is common native\r
+ code or a thunk to another piece of EBC code.\r
+ If the callee is common native code, use EbcLLCAllEXASM to manipulate,\r
+ otherwise, set the VM->IP to target EBC code directly to avoid another VM\r
+ be startup which cost time and stack space.\r
+\r
+ @param VmPtr Pointer to a VM context.\r
+ @param FuncAddr Callee's address\r
+ @param NewStackPointer New stack pointer after the call\r
+ @param FramePtr New frame pointer after the call\r
+ @param Size The size of call instruction\r
+\r
+**/\r
VOID\r
EbcLLCALLEX (\r
IN VM_CONTEXT *VmPtr,\r
- IN UINTN CallAddr,\r
- IN UINTN EbcSp,\r
+ IN UINTN FuncAddr,\r
+ IN UINTN NewStackPointer,\r
IN VOID *FramePtr,\r
IN UINT8 Size\r
)\r
;\r
\r
+/**\r
+ When EBC calls native, on return the VM has to stuff the return\r
+ value into a VM register. It's assumed here that the value is still\r
+ in the register, so simply return and the caller should get the\r
+ return result properly.\r
+\r
+ @return The unmodified value returned by the native code. \r
+\r
+**/\r
INT64\r
+EFIAPI\r
EbcLLGetReturnValue (\r
VOID\r
)\r
;\r
\r
+/**\r
+ Returns the stack index and buffer assosicated with the Handle parameter.\r
+\r
+ @param Handle The EFI handle as the index to the EBC stack. \r
+ @param StackBuffer A pointer to hold the returned stack buffer.\r
+ @param BufferIndex A pointer to hold the returned stack index.\r
+ \r
+ @retval EFI_OUT_OF_RESOURCES The Handle parameter does not correspond to any\r
+ existing EBC stack.\r
+ @retval EFI_SUCCESS The stack index and buffer were found and\r
+ returned to the caller.\r
+\r
+**/\r
EFI_STATUS\r
GetEBCStack(\r
- EFI_HANDLE Handle,\r
- VOID **StackBuffer,\r
- UINTN *BufferIndex\r
+ IN EFI_HANDLE Handle,\r
+ OUT VOID **StackBuffer,\r
+ OUT UINTN *BufferIndex\r
);\r
\r
+/**\r
+ Returns from the EBC stack by stack Index. \r
+ \r
+ @param Index Specifies which EBC stack to return from.\r
+ \r
+ @retval EFI_SUCCESS The function completed successfully.\r
+\r
+**/\r
EFI_STATUS\r
ReturnEBCStack(\r
- UINTN Index\r
+ IN UINTN Index\r
);\r
\r
+/**\r
+ Allocates memory to hold all the EBC stacks.\r
+\r
+ @retval EFI_SUCCESS The EBC stacks were allocated successfully. \r
+ @retval EFI_OUT_OF_RESOURCES Not enough memory available for EBC stacks.\r
+\r
+**/\r
EFI_STATUS\r
InitEBCStack (\r
VOID\r
);\r
\r
+/**\r
+ Free all EBC stacks allocated before.\r
+\r
+ @retval EFI_SUCCESS All the EBC stacks were freed.\r
+\r
+**/\r
EFI_STATUS\r
FreeEBCStack(\r
VOID\r
);\r
\r
+/**\r
+ Returns from the EBC stack associated with the Handle parameter. \r
+ \r
+ @param Handle Specifies the EFI handle to find the EBC stack with.\r
+ \r
+ @retval EFI_SUCCESS The function completed successfully.\r
+\r
+**/\r
EFI_STATUS\r
ReturnEBCStackByHandle(\r
- EFI_HANDLE Handle\r
+ IN EFI_HANDLE Handle\r
);\r
//\r
// Defines for a simple EBC debugger interface\r
\r
#define EBC_PROTOCOL_PRIVATE_DATA_SIGNATURE EFI_SIGNATURE_32 ('e', 'b', 'c', 'p')\r
\r
-struct _EBC_PROTOCOL_PRIVATE_DATA {\r
- UINT32 Signature;\r
- EFI_EBC_PROTOCOL EbcProtocol;\r
- UINTN StackBase;\r
- UINTN StackTop;\r
- UINTN StackSize;\r
-} ;\r
\r
#define EBC_PROTOCOL_PRIVATE_DATA_FROM_THIS(a) \\r
CR(a, EBC_PROTOCOL_PRIVATE_DATA, EbcProtocol, EBC_PROTOCOL_PRIVATE_DATA_SIGNATURE)\r
projects / mirror_edk2.git / blobdiff