DkmCustomInstructionAddress Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
DkmCustomInstructionAddress is used for addresses from a custom runtime environment (not native or CLR-based). For example, this could be used in a custom interpreter or Just-In-Time compiler.
public ref class DkmCustomInstructionAddress : Microsoft::VisualStudio::Debugger::DkmInstructionAddress[Windows::Foundation::Metadata::WebHostHidden]
public ref class DkmCustomInstructionAddress : Microsoft::VisualStudio::Debugger::DkmInstructionAddress[Windows::Foundation::Metadata::WebHostHidden]
class DkmCustomInstructionAddress : Microsoft::VisualStudio::Debugger::DkmInstructionAddress[System.Runtime.InteropServices.Guid("9205f0c6-3471-83dc-bd08-54c4c7d5dbc8")]
public class DkmCustomInstructionAddress : Microsoft.VisualStudio.Debugger.DkmInstructionAddress[<System.Runtime.InteropServices.Guid("9205f0c6-3471-83dc-bd08-54c4c7d5dbc8")>]
type DkmCustomInstructionAddress = class
inherit DkmInstructionAddressPublic Class DkmCustomInstructionAddress
Inherits DkmInstructionAddress- Inheritance
- Attributes
Properties
| AdditionalData |
[Optional] Additional runtime-specific data associated with an address. This data will not be used when comparing addresses. |
| CPUInstructionPart |
[Optional] CPUInstructionPart provides the address that the CPU will execute. This is always provided for native instructions. It may be provided for CLR or custom addresses depending on how the address object was created. (Inherited from DkmInstructionAddress) |
| EntityId |
[Optional] This is a runtime-specific data structure which custom runtimes may use to store the location of this instruction. Along with 'offset', this field will used to compare two instructions from the same module. |
| ModuleInstance |
The module containing the InstructionPointer. |
| Offset |
Along with 'EntityId' the 'Offset' field is used to uniquely identity an instruction. This could hold a pointer value (such as a pointer to the instruction) or an offset from the start of the function/module. |
| Process |
DkmProcess represents a target process which is being debugged. The debugger debugs processes, so this is the basic unit of debugging. A DkmProcess can represent a system process or a virtual process such as minidumps. (Inherited from DkmInstructionAddress) |
| RuntimeInstance |
The DkmRuntimeInstance class represents an execution environment which is loaded into a DkmProcess and which contains code to be debugged. (Inherited from DkmInstructionAddress) |
| TagValue |
DkmInstructionAddress is an abstract base class. This enum indicates which derived class this object is an instance of. (Inherited from DkmInstructionAddress) |
Methods
| CompareTo(DkmInstructionAddress) |
Compares two instruction addresses and returns a value indicating whether one is less than, equal to, or greater than the other. The addresses must be from the same module. (Inherited from DkmInstructionAddress) |
| Create(DkmRuntimeInstance, DkmCustomModuleInstance, ReadOnlyCollection<Byte>, UInt64, ReadOnlyCollection<Byte>, DkmInstructionAddress+CPUInstruction) |
Create a new DkmCustomInstructionAddress object instance. |
| GetCurrentCPUAddress() |
Resolves a DkmInstructionAddress to a CPU InstructionAddress. This is the reverse mapping of ResolveCPUInstructionAddress. This API is currently only supported by CLR DkmRuntimeInstance objects. Location constraint: This API should generally be called on the client, but it can be called on the server for translating CLR addresses (but not native-compiled). (Inherited from DkmInstructionAddress) |
| GetCurrentCPUAddress(DkmWorkList, DkmCompletionRoutine<DkmGetCurrentCPUAddressAsyncResult>) |
Resolves a DkmInstructionAddress to a CPU InstructionAddress. This is the reverse mapping of ResolveCPUInstructionAddress. This API is currently only supported by CLR DkmRuntimeInstance objects. This method will append a new work item to the specified work list, and return once the work item has been appended. The actual processing of the work item is asynchronous. The caller will be notified that the request is complete through the completion routine. Location constraint: This API should generally be called on the client, but it can be called on the server for translating CLR addresses (but not native-compiled). (Inherited from DkmInstructionAddress) |
| GetSymbol() |
Convert a DkmInstructionAddress into a DkmInstructionSymbol. If the DkmInstructionAddress is not in a DkmModule then GetSymbol will return null (S_FALSE in native code). (Inherited from DkmInstructionAddress) |
| IsInSameFunction(DkmInstructionAddress) |
Compares two instruction addresses and determines if they are within the same function. Location constraint: API must be called from an IDE component (component level > 100,000). (Inherited from DkmInstructionAddress) |
| IsUserCode(DkmWorkList, DkmCompletionRoutine<DkmIsUserCodeAsyncResult>) |
Determines if a given instruction address is user code or not. This method will append a new work item to the specified work list, and return once the work item has been appended. The actual processing of the work item is asynchronous. The caller will be notified that the request is complete through the completion routine. Location constraint: Note: with Visual Studio 2017 Update 8, the CallDirection of the API was made 'Bidirectional' from 'Normal' and can now be called from any component. This API was introduced in Visual Studio 12 RTM (DkmApiVersion.VS12RTM). (Inherited from DkmInstructionAddress) |