Driver test tools
Overview of the Driver test tools technology.
To develop Driver test tools, you need these headers:
For the programming guide, see Driver test tools.
Macros
| Title | Description |
|---|---|
| WppRecorderConfigure macro | The WppRecorderConfigure method enables or disables the default log to which WPP prints. |
| WppRecorderDumpLiveDriverData macro | The WppRecorderDumpLiveDriverData method gets the buffer associated with the specified Inflight Trace Recorder log. |
| WppRecorderGetTriageInfo macro | The WppRecorderGetTriageInfo. |
| WppRecorderLinkCounters macro | The WppRecorderLinkCounters. |
| WppRecorderLogCreate macro | The WppRecorderLogCreate method creates a buffer to contain the recorder log. |
| WppRecorderLogDelete macro | The WppRecorderLogDelete method deletes the specified recorder log. |
| WppRecorderLogSetIdentifier macro | The WppRecorderLogSetIdentifier method sets a string identifier for the recorder log. |
Enumerations
| FAULT_INFORMATION_ARCH Defines values for type of system architecture. |
| FAULT_INFORMATION_ARM64_TYPE Defines values for the type of fault. |
| PCW_CALLBACK_TYPE The PCW_CALLBACK_TYPE enumeration defines the notification type to send to the registered provider of the counterset. A provider passes a pointer to this enumeration as a parameter to the PcwCallback function. |
| WPP_RECORDER_TRI_STATE The WPP_RECORDER_TRI_STATE enumeration type defines three values that WPP uses for some structure members and function parameters. |
Functions
| ASSERTMSG ASSERTMSG tests an expression. If the expression is false, it breaks into the kernel debugger and sends it the specified message. |
| DbgBreakPoint The DbgBreakPoint routine breaks into the kernel debugger. |
| DbgBreakPointWithStatus The DbgBreakPointWithStatus routine breaks into the kernel debugger and sends the value of Status to the debugger. |
| DbgPrint The DbgPrint routine sends a message to the kernel debugger. |
| DbgPrintEx The DbgPrintEx routine sends a string to the kernel debugger if the conditions you specify are met. |
| DbgPrompt The DbgPrompt routine displays a caller-specified user prompt string on the kernel debugger's display device and obtains a user response string. |
| EtwActivityIdControl The EtwActivityIdControl function creates, queries, and sets the current activity identifier. |
| ETWENABLECALLBACK The EtwEnableCallback function is an optional driver-supplied callback function that is used to receive enable or disable notifications. |
| EtwEventEnabled The EtwEventEnabled function verifies whether an event is enabled. |
| EtwProviderEnabled The EtwProviderEnabled function verifies that a provider is enabled for event logging at a specified level and keyword. |
| EtwRegister The EtwRegister function registers the event provider and must be called before a provider can start tracing. |
| EtwUnregister The EtwUnregister function unregisters the event provider and must be called before the provider exits. |
| EtwWrite The EtwWrite function is a tracing function for publishing events in your kernel-mode driver code. |
| EtwWriteEx The EtwWriteEx function is a tracing function for publishing events that support filtering in your kernel-mode driver code. |
| EtwWriteString The EventWriteString function is a tracing function that you can use when no sophisticated data is required. This function is similar to a debug print statement. |
| EtwWriteTransfer The EtwWriteTransfer function marks an event that links two activities together; this type of event is referred to as a transfer event. |
| imp_WppRecorderGetCounterHandle The WppRecorderGetCounterHandle method. |
| imp_WppRecorderIsDefaultLogAvailable The WppRecorderIsDefaultLogAvailable method determines whether the default log is available. |
| imp_WppRecorderLogGetDefault The WppRecorderLogGetDefault method gets a handle to the default recorder log. |
| KdBreakPointWithStatus The KdBreakPointWithStatus macro breaks into the kernel debugger and sends the value of Status to the debugger. |
| KdChangeOption The KdChangeOption routine accesses and changes state in the kernel that is related to kernel debugging. |
| KdDisableDebugger The KdDisableDebugger routine disables the kernel debugger. |
| KdEnableDebugger The KdEnableDebugger routine re-enables the kernel debugger after a call to the KdDisableDebugger routine disables the kernel debugger. |
| KdPrint The KdPrint macro sends a message to the kernel debugger. |
| KdPrintEx The KdPrintEx macro sends a string to the kernel debugger if the conditions you specify are met.A call to KdPrintEx requires double parentheses. |
| KdRefreshDebuggerNotPresent The KdRefreshDebuggerNotPresent macro refreshes the value of the KD_DEBUGGER_NOT_PRESENT global kernel variable. |
| KeInitializeTriageDumpDataArray Initializes a triage dump data block array. |
| PCW_CALLBACK Providers can implement a PCW_CALLBACK function to receive notification when consumers perform certain actions, such as adding or removing counters from a query. |
| PcwAddInstance The PcwAddInstance function adds the specified instance of the counterset to the consumer buffer. |
| PcwCloseInstance The PcwCloseInstance function closes the specified instance of the counterset. |
| PcwCreateInstance The PcwCreateInstance function creates a new instance for the specified registered counterset. |
| PcwRegister The PcwRegister function registers the caller as a provider of the specified counterset. |
| PcwUnregister The PcwUnregister function unregisters the provider of the specified counterset. |
| RECORDER_CONFIGURE_PARAMS_INIT The RECORDER_CONFIGURE_PARAMS_INIT function is used to initialize the RECORDER_CONFIGURE_PARAMS structure. |
| RECORDER_LOG_CREATE_PARAMS_INIT The RECORDER_LOG_CREATE_PARAMS_INIT function is used to initialize the RECORDER_LOG_CREATE_PARAMS structure. |
| RECORDER_LOG_CREATE_PARAMS_INIT_APPEND_POINTER The RECORDER_LOG_CREATE_PARAMS_INIT_APPEND_POINTER method initializes the RECORDER_LOG_CREATE_PARAMS with the pointer to link logs. |
| SeEtwWriteKMCveEvent The SeEtwWriteKMCveEvent function is a tracing function for publishing events when an attempted security vulnerability exploit is detected in your kernel-mode drivers. |
| vDbgPrintEx The vDbgPrintEx routine sends a string to the kernel debugger if certain conditions are met. |
| vDbgPrintExWithPrefix The vDbgPrintExWithPrefix routine sends a string to the kernel debugger if certain conditions that you specify are met. This routine can append a prefix to debugger output to help organize debugging results. |
| WppRecorderConfigure Learn how the WppRecorderConfigure method enables or disables the default log to which WPP prints. |
| WppRecorderDumpLiveDriverData Learn how the WppRecorderDumpLiveDriverData method gets the buffer associated with the specified Inflight Trace Recorder log. |
| WppRecorderGetTriageInfo Learn about the WppRecorderGetTriageInfo method. |
| WppRecorderLinkCounters Learn how the WppRecorderLinkCounters method uses a sequence number to merge logs captured in different buffers by a driver. |
| WppRecorderLogCreate Learn how the WppRecorderLogCreate method creates a buffer to contain the recorder log. |
| WppRecorderLogDelete Learn how the WppRecorderLogDelete method deletes the specified recorder log. |
| WppRecorderLogDumpLiveData The WppRecorderLogDumpLiveData method returns an opaque pointer to a log buffer header and data so that they can be saved in a live crashdump. |
| WppRecorderLogSetIdentifier Learn how the WppRecorderLogSetIdentifier method sets a string identifier for the recorder log. |
Structures
| DEBUG_DEVICE_DESCRIPTOR Learn more about: DEBUG_DEVICE_DESCRIPTOR structure |
| DEBUG_TRANSPORT_DATA Describes debug-transport specific data for use by the transport. |
| FAULT_INFORMATION Contains information to set the fault report on a device. |
| FAULT_INFORMATION_ARM64 Contains fault information for an ARM64 system. |
| FAULT_INFORMATION_ARM64_FLAGS Defines fault information. |
| KBUGCHECK_CALLBACK_RECORD Learn more about: KBUGCHECK_CALLBACK_RECORD structure |
| KBUGCHECK_REASON_CALLBACK_RECORD Learn more about: KBUGCHECK_REASON_CALLBACK_RECORD structure |
| KBUGCHECK_REMOVE_PAGES Learn more about: KBUGCHECK_REMOVE_PAGES structure |
| KBUGCHECK_SECONDARY_DUMP_DATA_EX Learn more about: _KBUGCHECK_SECONDARY_DUMP_DATA_EX structure |
| KBUGCHECK_TRIAGE_DUMP_DATA Learn more about: _KBUGCHECK_TRIAGE_DUMP_DATA structure |
| KTRIAGE_DUMP_DATA_ARRAY Learn more about: _KTRIAGE_DUMP_DATA_ARRAY structure |
| MCG_CAP Learn more about: MCG_CAP structure |
| PCW_CALLBACK_INFORMATION The PCW_CALLBACK_INFORMATION union supplies details about the notification to send. A provider passes a pointer to this union as a parameter to the PcwCallback function. |
| PCW_COUNTER_DESCRIPTOR The PCW_COUNTER_DESCRIPTOR structure supplies details about the notification to send. |
| PCW_COUNTER_INFORMATION The PCW_COUNTER_INFORMATION structure describes attributes that identify a specific instance of a counterset. |
| PCW_DATA The PCW_DATA structure describes the array of data blocks that are associated with an instance. |
| PCW_MASK_INFORMATION The PCW_MASK_INFORMATION structure supplies details about the notification to send to the provider. This information is passed as part of the Info parameter to the PcwCallback function. This mask information is included in PCW_CALLBACK_INFORMATION. |
| PCW_REGISTRATION_INFORMATION The PCW_REGISTRATION_INFORMATION structure supplies details about the provider and the counterset. |
| RECORDER_CONFIGURE_PARAMS The RECORDER_CONFIGURE_PARAMS structure is an input parameter to the WppRecorderConfigure method to enable or disable the default log to which WPP prints. |
| RECORDER_LOG_CREATE_PARAMS The RECORDER_LOG_CREATE_PARAMS structure is an input parameter to the WppRecorderLogCreate method. |
| WPP_TRIAGE_INFO Used to locate the WPP log for WER reporting. |