4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Main routines for the EBC interpreter. Includes the initialization and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync main interpreter routines.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncare licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncwhich accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Bits of exception flags field of VM context
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EXCEPTION_FLAG_FATAL 0x80000000 // can't continue
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EXCEPTION_FLAG_ERROR 0x40000000 // bad, but try to continue
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EXCEPTION_FLAG_WARNING 0x20000000 // harmless problem
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EXCEPTION_FLAG_NONE 0x00000000 // for normal return
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Flags passed to the internal create-thunks function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define FLAG_THUNK_ENTRY_POINT 0x01 // thunk for an image entry point
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define FLAG_THUNK_PROTOCOL 0x00 // thunk for an EBC protocol service
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Put this value at the bottom of the VM's stack gap so we can check it on
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// occasion to make sure the stack has not been corrupted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Create thunks for an EBC image entry point, or an EBC protocol service.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ImageHandle Image handle for the EBC image. If not null, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync we're creating a thunk for an image entry point.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param EbcEntryPoint Address of the EBC code that the thunk is to call
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Thunk Returned thunk we create here
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Flags Flags indicating options for creating the thunk
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The thunk was created successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The parameter of EbcEntryPoint is not 16-bit
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There is not enough memory to created the EBC
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BUFFER_TOO_SMALL EBC_THUNK_SIZE is not larger enough.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Add a thunk to our list of thunks for a given image handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Also flush the instruction cache since we've written thunk code
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to memory that will be executed eventually.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ImageHandle The image handle to which the thunk is tied.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ThunkBuffer The buffer that has been created/allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ThunkSize The size of the thunk memory allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Memory allocation failed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The function completed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// The interpreter calls these when an exception is detected,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// or as a periodic callback.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The VM interpreter calls this function when an exception is detected.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ExceptionType Specifies the processor exception detected.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ExceptionFlags Specifies the exception context.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param VmPtr Pointer to a VM context for passing info to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI debugger.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS This function completed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Define a constant of how often to call the debugger periodic callback
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EBC_VM_PERIODIC_CALLBACK_RATE (1000 * EFI_TIMER_UNIT_1MS)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// External low level functions that are native-processor dependent
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The VM thunk code stuffs an EBC entry point into a processor
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync register. Since we can't use inline assembly to get it from
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the interpreter C code, stuff it into the return value
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync register and return.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The contents of the register in which the entry point is passed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function is called to execute an EBC CALLEX instruction.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This instruction requires that we thunk out to external native
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync code. For x64, we switch stacks, copy the arguments to the stack
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and jump to the specified function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync On return, we restore the stack pointer to its original location.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Destroys no working registers.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param CallAddr The function address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param EbcSp The new EBC stack pointer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FramePtr The frame pointer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The unmodified value returned by the native code.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function is called to execute an EBC CALLEX instruction.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The function check the callee's content to see whether it is common native
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync code or a thunk to another piece of EBC code.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the callee is common native code, use EbcLLCAllEXASM to manipulate,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync otherwise, set the VM->IP to target EBC code directly to avoid another VM
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync be startup which cost time and stack space.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param VmPtr Pointer to a VM context.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FuncAddr Callee's address
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param NewStackPointer New stack pointer after the call
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FramePtr New frame pointer after the call
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Size The size of call instruction
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns the stack index and buffer assosicated with the Handle parameter.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Handle The EFI handle as the index to the EBC stack.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param StackBuffer A pointer to hold the returned stack buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BufferIndex A pointer to hold the returned stack index.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The Handle parameter does not correspond to any
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync existing EBC stack.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The stack index and buffer were found and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync returned to the caller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns from the EBC stack by stack Index.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Index Specifies which EBC stack to return from.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The function completed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Allocates memory to hold all the EBC stacks.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The EBC stacks were allocated successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Not enough memory available for EBC stacks.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Free all EBC stacks allocated before.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS All the EBC stacks were freed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns from the EBC stack associated with the Handle parameter.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Handle Specifies the EFI handle to find the EBC stack with.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The function completed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EBC_PROTOCOL_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('e', 'b', 'c', 'p')
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CR(a, EBC_PROTOCOL_PRIVATE_DATA, EbcProtocol, EBC_PROTOCOL_PRIVATE_DATA_SIGNATURE)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#endif // #ifndef _EBC_INT_H_