在框架外部处理 WDM IRP
当 I/O 管理器将 I/O 请求数据包 (IRP) 传送到基于框架的驱动程序时,框架会截获 IRP,然后执行以下操作之一:
- 处理 IRP。 例如,框架处理包含 IRP_MJ_PNP 和 IRP_MJ_POWER 主要 I/O 函数代码的 IRP。 处理这些 IRP 时,框架可能通过调用驱动程序的事件回调函数来与驱动程序通信;
- 为 IRP 创建一个框架请求对象,并将请求对象传递到驱动程序的 I/O 队列之一,以便驱动程序可以接收它,通常在请求处理程序中对其进行处理。 框架以这种方式处理读取、写入和设备 I/O 控制请求;
- 如果驱动程序是Filter驱动程序,请将 IRP 传递给下一个较低的驱动程序 ;如果驱动程序不是筛选器驱动程序,则以状态值STATUS_INVALID_DEVICE_REQUEST 完成 IRP,因为 IRP 包含框架不支持的 I/O 函数代码;
有时,驱动程序必须处理框架不支持的 I/O 函数代码。
在极少数情况下,驱动程序可能需要在框架处理 IRP 之前对其进行预处理,或者驱动程序可能需要在框架和较低级别的驱动程序处理完 IRP 之后对其进行后处理。
作为预处理的一部分,驱动程序可能需要将 IRP 转发到特定的 I/O 队列。
对 IRP 进行预处理和后处理
如果驱动程序必须在框架处理 IRP 之前或之后截获 IRP (IRP) I/O 请求数据包,则驱动程序可以调用 WdfDeviceInitAssignWdmIrpPreprocessCallback ,为主要 I/O 函数代码注册 EvtDeviceWdmIrpPreprocess 事件回调函数,或者为与主要代码关联的特定次要 I/O 函数代码注册 EvtDeviceWdmIrpPreprocess 事件回调函数。 随后,每当驱动程序收到包含指定的主要和次要函数代码的 IRP 时,框架就会调用驱动程序的 EvtDeviceWdmIrpPreprocess 回调函数。
EvtDeviceWdmIrpPreprocess 回调函数可以执行预处理 IRP 所需的一切操作,然后它必须调用 WdfDeviceWdmDispatchPreprocessedIrp 将 IRP 返回到框架,除非驱动程序正在处理框架不支持的 IRP。
在驱动程序调用 WdfDeviceWdmDispatchPreprocessedIrp 后,框架将处理 IRP 的方式与驱动程序未提供 EvtDeviceWdmIrpPreprocess 回调函数时处理 IRP 的方式相同。 如果 IRP 的 I/O 函数代码是框架传递给驱动程序的函数代码,驱动程序将再次接收 IRP 作为请求对象。
如果驱动程序需要在较低级别的驱动程序完成 IRP 后处理 IRP,驱动程序的 EvtDeviceWdmIrpPreprocess 回调函数可以调用 IoSetCompletionRoutine 来设置 IoCompletion 例程,然后再调用 WdfDeviceWdmDispatchPreprocessedIrp。
在驱动程序调用 WdfDeviceInitAssignWdmIrpPreprocessCallback 后,框架使 I/O 管理器向所有 IRP 添加额外的 I/O 堆栈位置 ,以便 EvtDeviceWdmIrpPrepPreprocess 回调函数可以设置 IoCompletion 例程。 回调函数必须在调用 WdfDeviceWdmDispatchPreprocessedIrp 之前更新 IRP 的 I/O 堆栈位置指针。
调用 WdfDeviceWdmDispatchPreprocessedIrp
由于 I/O 管理器将其他 I/O 堆栈位置添加到 IRP, 因此 EvtDeviceWdmIrpPreprocess 回调函数必须调用 IoSkipCurrentIrpStackLocation 或 IoCopyCurrentIrpStackLocationToNext (,以在 IRP) 中设置下一个 I/O 堆栈位置,然后再调用 WdfDeviceWdmDispatchPreprocessedIrp。
如果驱动程序正在预处理 IRP,但未对 IRP 进行后处理,则驱动程序无需为 IRP 设置 IoCompletion 例程,并且可以调用 IoSkipCurrentIrpStackLocation,如以下代码示例所示。
NTSTATUS
EvtDeviceMyIrpPreprocess(
IN WDFDEVICE Device,
IN OUT PIRP Irp
)
{
//
// Perform IRP preprocessing operations here.
//
...
//
// Deliver the IRP back to the framework.
//
IoSkipCurrentIrpStackLocation(Irp);
return WdfDeviceWdmDispatchPreprocessedIrp(Device, Irp);
}
如果驱动程序正在对 IRP 进行后处理,则驱动程序必须调用 IoCopyCurrentIrpStackLocationToNext,然后它必须调用 IoSetCompletionRoutine 来为 IRP 设置 IoCompletion 例程,如以下代码示例所示。
NTSTATUS
EvtDeviceMyIrpPreprocess(
IN WDFDEVICE Device,
IN OUT PIRP Irp
)
{
//
// Perform IRP preprocessing operations here, if needed.
//
...
//
// Set a completion routine and deliver the IRP back to
// the framework.
//
IoCopyCurrentIrpStackLocationToNext(Irp);
IoSetCompletionRoutine(
Irp,
MyIrpCompletionRoutine,
NULL,
TRUE,
TRUE,
TRUE
);
return WdfDeviceWdmDispatchPreprocessedIrp(Device, Irp);
}
驱动程序不得调用 IoCopyCurrentIrpStackLocationToNext ,因此不得设置 IoCompletion 例程,如果驱动程序的 EvtDeviceWdmIrpPrepPreprocess 函数接收的设备对象表示 (PDO) 的物理设备对象,并且 IRP 的主要函数代码IRP_MJ_PNP或IRP_MJ_POWER。 否则, 驱动程序验证程序 将报告错误。
将 IRP 调度到 I/O 队列
基于框架的驱动程序可以动态指定传入 IRP 的目标队列。 若要将 IRP 调度到特定队列,驱动程序必须调用 WdfDeviceWdmDispatchIrpToIoQueue 方法。
通常,驱动程序从其 EvtDeviceWdmIrpPrepPreprocess 或 EvtDeviceWdmIrpDispatch 回调函数调用 WdfDeviceWdmDispatchIrpToIoQueue。 为了获得最佳性能,大多数驱动程序不提供这两个回调函数。
注意 UMDF 驱动程序可以提供 EvtDeviceWdmIrpDispatch 回调函数,但只有 KMDF 驱动程序可以提供 EvtDeviceWdmIrpPreprocess。
如果驱动程序已提供 EvtDeviceWdmIrpPrepPreprocess,则可以使用它来动态选择队列。 如果没有,请提供 EvtDeviceWdmIrpDispatch ,并从该回调函数中调用 WdfDeviceWdmDispatchIrpToIoQueue 。
此外,还应注意以下事项:
- 将 IRP 调度到 I/O 队列的另一种方法是 创建默认队列 ,然后从队列的处理程序中调用 WdfRequestForwardToIoQueue。 此方法从 KMDF 1.0 开始可用,但不适用于 前进进度队列 ,并且通常速度较慢。 请考虑改用 WdfDeviceWdmDispatchIrpToIoQueue;
- 调用 WdfDeviceConfigureWdmIrpDispatchCallback 以注册 EvtDeviceWdmIrpDispatch 回调函数时,驱动程序必须将 MajorFunction 参数设置为下列参数之一:IRP_MJ_DEVICE_CONTROL、IRP_MJ_INTERNAL_DEVICE_CONTROL、IRP_MJ_READ、IRP_MJ_WRITE。 虽然此要求不适用于 EvtDeviceWdmIrpPreprocess,但只能将这些类型的 IRP 动态调度到指定的队列;
- 转到 EvtDeviceWdmIrpPreprocess 的 IRP 具有额外的堆栈位置。 转到 EvtDeviceWdmIrpDispatch (且没有以前调用 EvtDeviceWdmIrpPreprocess) 的 IRP 不会;
- EvtDeviceWdmIrpPreprocess 不便于发送驱动程序定义的上下文信息,而 EvtDeviceWdmIrpDispatch 则有助于发送;
调度未预处理的 IRP
若要从驱动程序的 EvtDeviceWdmIrpDispatch 回调函数调度 IRP,请使用以下过程:
- 从其 EvtDriverDeviceAdd 回调函数中,驱动程序调用 WdfDeviceConfigureWdmIrpDispatchCallback 来注册 EvtDeviceWdmIrpDispatch 回调函数。如果目标是父设备的 I/O 队列,KMDF 驱动程序必须先调用 WdfPdoInitAllowForwardingRequestToParent ,然后才能调用 WdfDeviceCreate。 如果 KMDF 驱动程序还提供了 EvtDeviceWdmIrpPreprocess 回调函数,则框架会在 IRP 到达时首先调用该函数。 回调函数预处理请求后,它会调用 WdfDeviceWdmDispatchPreprocessedIrp 将 IRP 返回到框架;
- 框架调用驱动程序的 EvtDeviceWdmIrpDispatch 回调函数;
- 在 EvtDeviceWdmIrpDispatch 中,驱动程序可以调用 WdfDeviceWdmDispatchIrpToIoQueue 或 WdfDeviceWdmDispatchIrp,但不能同时调用两者。 KMDF 驱动程序具有其他选项,即不调用这两种方法,而是完成 IRP 或将其标记为挂起;
- 如果 KMDF 驱动程序已设置WDF_DISPATCH_IRP_TO_IO_QUEUE_INVOKE_INCALLERCTX_CALLBACK标志,并且尚未为目标 I/O 队列启用有保证的向前进度,则框架会调用驱动程序的 EvtIoInCallerContext(如果提供)。 预处理请求后,回调函数必须通过调用 WdfDeviceEnqueueRequest 将其排队,或通过调用 WdfRequestComplete 完成该请求;
调度预处理的 IRP
若要将驱动程序的 EvtDeviceWdmIrpPreprocess 回调函数中的 IRP 调度到特定的 I/O 队列,请使用以下过程:
- 驱动程序通过调用 WdfDeviceInitAssignWdmIrpPreprocessCallback 来注册 EvtDeviceWdmIrpPreprocess 回调函数;
- 如果目标是父设备的 I/O 队列,驱动程序将调用 WdfPdoInitAllowForwardingRequestToParent;
- 在 EvtDeviceWdmIrpPreprocess 中,调用 WdfDeviceWdmDispatchIrpToIoQueue , 标志 设置为 WDF_DISPATCH_IRP_TO_IO_QUEUE_PREPROCESSED_IRP;
- 如果驱动程序已设置WDF_DISPATCH_IRP_TO_IO_QUEUE_INVOKE_INCALLERCTX_CALLBACK标志,并且尚未为目标 I/O 队列启用有保证的向前进度,则框架会调用驱动程序的 EvtIoInCallerContext(如果提供)。 回调函数完成对请求的预处理后,必须通过调用 WdfDeviceEnqueueRequest 将其 排队,或通过调用 WdfRequestComplete 完成该请求;
处理框架不支持的 IRP
框架不支持具有以下主要 IRP 代码的 I/O 请求:
IRP_MJ_CREATE_MAILSLOT
IRP_MJ_CREATE_NAMED_PIPE
IRP_MJ_DEVICE_CHANGE
IRP_MJ_DIRECTORY_CONTROL
IRP_MJ_FILE_SYSTEM_CONTROL
IRP_MJ_FLUSH_BUFFERS
IRP_MJ_LOCK_CONTROL
IRP_MJ_QUERY_EA
IRP_MJ_QUERY_INFORMATION
IRP_MJ_QUERY_QUOTA
IRP_MJ_QUERY_SECURITY
IRP_MJ_QUERY_VOLUME_INFORMATION
IRP_MJ_SET_EA
IRP_MJ_SET_INFORMATION
IRP_MJ_SET_QUOTA
IRP_MJ_SET_SECURITY
IRP_MJ_SET_VOLUME_INFORMATION
如果框架收到包含其中一个 I/O 函数代码的 IRP,则框架不会处理 IRP。 如果驱动程序是Filter驱动程序,框架会将 IRP 传递给驱动程序堆栈中下一个较低的驱动程序。 如果驱动程序不是Filter驱动程序,框架会调用 IoCompleteRequest 以完成状态值为 STATUS_INVALID_DEVICE_REQUEST 的 IRP。
如果驱动程序必须处理包含其中任何 I/O 函数代码的 IRP,则驱动程序必须调用 WdfDeviceInitAssignWdmIrpPreprocessCallback ,以便为 I/O 函数代码注册 EvtDeviceWdmIrpPreprocess 事件回调函数。
当驱动程序收到包含驱动程序为其注册 EvtDeviceWdmIrpPreprocess 回调函数的 I/O 函数代码的 IRP 时,框架会将 IRP 传递给回调函数。 然后,回调函数必须遵循 处理 IRP 的 WDM 规则来处理 IRP。 驱动程序必须调用 IoCompleteRequest 来完成 IRP,或者必须调用 IoCallDriver 才能将 IRP 传递给下一个较低的驱动程序。
获取 WDM 信息
框架提供了多种对象方法,使驱动程序能够获取 WDM 定义的信息。
获取有关驱动程序及其设备的 WDM 信息
若要获取有关驱动程序及其设备的 WDM 信息,驱动程序可以调用以下方法:
WdfFdoInitWdmGetPhysicalDevice:检索表示设备物理设备对象的 DEVICE_OBJECT 结构 (PDO) 。 驱动程序可以在驱动程序为设备创建框架设备对象之前调用此方法。
WdfDeviceWdmGetPhysicalDevice:检索表示设备 PDO 的 WDM DEVICE_OBJECT结构。 驱动程序可以在为设备创建框架设备对象后调用此方法。
WdfDeviceWdmGetDeviceObject:返回与指定的框架设备对象关联的 WDM 设备对象。
WdfDeviceWdmGetAttachedDevice:返回 设备堆栈中下一个较低的 WDM 设备对象。
WdfWdmDeviceGetWdfDeviceHandle:返回与指定的 WDM 设备对象关联的框架设备对象的句柄。
WdfWdmDriverGetWdfDriverHandle:返回与指定的 WDM 驱动程序对象关联的框架驱动程序对象的句柄。
获取有关 I/O 请求的 WDM 信息
若要获取有关 I/O 请求的 WDM 信息,驱动程序可以调用以下方法:
WdfRequestWdmGetIrp:返回与指定的框架请求对象关联的 WDM IRP 结构;另一方面,在框架外部接收 WDM IRP 的驱动程序可以通过调用 WdfRequestCreateFromIrp。
WdfRequestGetParameters:检索与指定的框架请求对象关联的参数。 其中大多数参数来自请求的 WDM I/O 堆栈位置。
WdfRequestRetrieveOutputWdmMdl:表示 I/O 请求的输出缓冲区的 MDL检索内存描述符列表。
WdfRequestRetrieveInputWdmMdl:检索表示 I/O 请求输入缓冲区的 MDL。
WdfRequestFormatRequestUsingCurrentType:将调用驱动程序的 I/O 堆栈位置的内容复制到驱动程序的本地 I/O 目标的 I/O 堆栈位置。
WdfRequestWdmFormatUsingStackLocation:为驱动程序的本地 I/O 目标设置 I/O 堆栈位置的内容。
获取有关 I/O 目标的 WDM 信息
若要获取有关 I/O 目标的 WDM 信息,驱动程序可以调用以下方法:
WdfIoTargetWdmGetTargetDeviceObject:返回指向与本地或远程 I/O 目标关联的 WDM 设备对象的指针。
WdfIoTargetWdmGetTargetFileObject:返回指向与远程 I/O 目标关联的 WDM FILE_OBJECT 结构的指针。
WdfIoTargetWdmGetTargetFileHandle:返回与远程 I/O 目标关联的文件的句柄。
WdfIoTargetWdmGetTargetPhysicalDevice:返回指向 WDM 物理设备对象的指针, 表示远程 I/O 目标设备的 PDO。
获取有关中断和 DPC 的 WDM 信息
若要获取有关中断和延迟过程调用 (DPC) 的 WDM 信息,驱动程序可以调用以下方法:
WdfInterruptWdmGetInterrupt:返回指向与指定框架中断对象关联的 WDM KINTERRUPT 结构的指针。
WdfDpcWdmGetDpc:返回指向与指定框架 DPC 对象关联的 WDM KDPC 结构的指针。
获取有关 USB I/O 目标的 WDM 信息
若要获取有关 USB I/O 目标的 WDM 信息,驱动程序可以调用以下方法:
WdfUsbTargetPipeWdmGetPipeHandle:返回与指定的框架管道对象关联的USBD_PIPE_HANDLE类型句柄。
获取有关注册表的 WDM 信息
若要获取有关注册表的 WDM 信息,驱动程序可以调用以下方法:
WdfRegistryWdmGetHandle:返回框架注册表项对象表示的注册表项的 WDM 句柄。
获取有关文件对象的 WDM 信息
若要获取有关文件对象的 WDM 信息,驱动程序可以调用以下方法:
WdfFileObjectWdmGetFileObject:返回与指定的框架文件对象关联的 WDM FILE_OBJECT 结构。