WdfIoTargetFormatRequestForWrite 函数 (wdfiotarget.h)

  • 项目

[适用于 KMDF 和 UMDF]

WdfIoTargetFormatRequestForWrite 方法为 I/O 目标生成写入请求，但不发送请求。

语法

NTSTATUS WdfIoTargetFormatRequestForWrite(
  [in]           WDFIOTARGET       IoTarget,
  [in]           WDFREQUEST        Request,
  [in, optional] WDFMEMORY         InputBuffer,
  [in, optional] PWDFMEMORY_OFFSET InputBufferOffset,
  [in, optional] PLONGLONG         DeviceOffset
);

参数

[in] IoTarget

本地或远程 I/O 目标对象的句柄，该对象是从上一次调用 WdfDeviceGetIoTarget 或 WdfIoTargetCreate 获取的，或者从专用 I/O 目标提供的方法获取的。

[in] Request

框架请求对象的句柄。 有关更多信息，请参见下面的“备注”部分。

[in, optional] InputBuffer

框架内存对象的句柄。 此对象表示包含将发送到 I/O 目标的数据的缓冲区。 此参数是可选的，可以为 NULL。 有关此参数的详细信息，请参阅以下“备注”部分。

[in, optional] InputBufferOffset

指向调用方分配 的WDFMEMORY_OFFSET 结构的指针，该结构提供可选的字节偏移量和长度值。 框架使用这些值来确定输入缓冲区内数据传输的起始地址和长度。 如果此指针为 NULL，则数据传输从输入缓冲区的开头开始，传输大小为缓冲区大小。

[in, optional] DeviceOffset

指向位置的指针，该位置指定传输的起始偏移量。 I/O 目标 (即下一个较低的驱动程序) 定义如何使用此值。 例如，磁盘的驱动程序堆栈中的驱动程序可能会指定与磁盘开头的偏移量。 I/O 目标在请求WDF_REQUEST_PARAMETERS结构的 Parameters.Write.DeviceOffset 成员中获取此信息。 此指针是可选的。 大多数驱动程序将此指针设置为 NULL。

返回值

如果操作成功，WdfIoTargetFormatRequestForWrite 将返回STATUS_SUCCESS。 否则，此方法可能会返回以下值之一：

返回代码 说明
STATUS_INVALID_PARAMETER
 检测到参数无效。
STATUS_INVALID_DEVICE_REQUEST
 传输长度大于缓冲区长度，或者 I/O 请求已排队到 I/O 目标。
STATUS_INSUFFICIENT_RESOURCES
 框架无法分配系统资源 (通常是内存) 。
STATUS_REQUEST_NOT_ACCEPTED
 Request 参数表示的 I/O 请求数据包 (IRP) 不提供足够的IO_STACK_LOCATION结构来允许驱动程序转发请求。
 

此方法还可能返回其他 NTSTATUS 值。

如果驱动程序提供无效的对象句柄，则会发生 bug 检查。

注解

使用 WdfIoTargetFormatRequestForWrite 方法（后跟 WdfRequestSend 方法）以同步或异步方式发送写入请求。 或者，使用 WdfIoTargetSendWriteSynchronously 方法以同步方式发送写入请求。

可以转发驱动程序在 I/O 队列中收到的 I/O 请求，也可以创建并发送新请求。 在任一情况下，框架都需要请求对象和一些缓冲区空间。

转发驱动程序在 I/O 队列中收到的 I/O 请求：

  1. 为 WdfIoTargetFormatRequestForWrite 方法的 Request 参数指定接收的请求句柄。
  2. 将接收的请求的输入缓冲区用于 WdfIoTargetFormatRequestForWrite 方法的 InputBuffer 参数。

    驱动程序必须调用 WdfRequestRetrieveInputMemory 以获取表示请求输入缓冲区的框架内存对象的句柄，并且必须使用该句柄作为 InputBuffer 的值。

有关转发 I/O 请求的详细信息，请参阅 转发 I/O 请求。

驱动程序通常将收到的 I/O 请求划分为发送到 I/O 目标的较小请求，因此驱动程序可能会创建新请求。

创建新的 I/O 请求：

  1. 创建新的请求对象，并为 WdfIoTargetFormatRequestForWrite 方法的 Request 参数提供其 句 柄。

    调用 WdfRequestCreate 以预分配一个或多个请求对象。 可以通过调用 WdfRequestReuse 来重复使用这些请求对象。 驱动程序的 EvtDriverDeviceAdd 回调函数可以为设备预分配请求对象。

  2. 提供缓冲区空间，并为 WdfIoTargetFormatRequestForWrite 方法的 InputBuffer 参数提供缓冲区的句柄。

    驱动程序必须将此缓冲区空间指定为框架托管内存的 WDFMEMORY 句柄。 驱动程序可以执行以下任一操作：

    请注意，如果驱动程序调用 WdfRequestRetrieveInputMemory 并将内存句柄传递给 WdfIoTargetFormatRequestForWrite，则在驱动程序删除、重用或重新设置驱动程序创建的新请求对象之前，驱动程序不得完成收到的 I/O 请求。 (WdfIoTargetFormatRequestForWrite 递增内存对象的引用计数。删除、重用或重新格式化请求对象会递减内存对象的引用计数。)
某些 I/O 目标接受长度为零的缓冲区的写入请求。 对于此类 I/O 目标，驱动程序可以为 InputBuffer 参数指定 NULL。

在驱动程序调用 WdfIoTargetFormatRequestForWrite 来格式化 I/O 请求后，它必须调用 WdfRequestSend 以同步或异步方式将请求 () 发送到 I/O 目标。

对使用同一请求的 WdfIoTargetFormatRequestForWrite 的多次调用不会导致额外的资源分配。 因此，为了降低 WdfRequestCreate 返回STATUS_INSUFFICIENT_RESOURCES的可能性，驱动程序的 EvtDriverDeviceAdd 回调函数可以调用 WdfRequestCreate 来预分配设备的一个或多个请求对象。 随后，驱动程序可以重复使用 (调用 WdfRequestReuse) 、重新设置格式 (调用 WdfIoTargetFormatRequestForWrite) ，并重新发送 (调用 WdfRequestSend) 每个请求对象，而不会STATUS_INSUFFICIENT_RESOURCES以后调用 WdfRequestCreate 返回值的风险。 如果参数值不更改，则对重用请求对象的 WdfIoTargetFormatRequestForWrite 的所有后续调用都将返回STATUS_SUCCESS。 (如果驱动程序每次都不调用相同的请求格式设置方法，可能会分配其他资源。)

有关在 I/O 请求完成后获取状态信息的信息，请参阅 获取完成信息。

有关 WdfIoTargetFormatRequestForWrite 的详细信息，请参阅 向常规 I/O 目标发送 I/O 请求。

有关 I/O 目标的详细信息，请参阅 使用 I/O 目标。

示例

下面的代码示例为写入请求的输入缓冲区创建框架内存对象，设置写入请求的格式，注册 CompletionRoutine 回调函数，并将写入请求发送到 I/O 目标。

WDFREQUEST  request;
NTSTATUS  status;
WDFMEMORY  memory;
WDF_OBJECT_ATTRIBUTES  attributes;

WDF_OBJECT_ATTRIBUTES_INIT(&attributes);
status = WdfMemoryCreate(
                         &attributes,
                         NonPagedPool,
                         DRIVER_TAG,
                         WRITE_BUF_SIZE,
                         &memory,
                         NULL
                         );

if (!NT_SUCCESS(status)) {
    return status;
}

status = WdfIoTargetFormatRequestForWrite(
                                          IoTarget,
                                          request,
                                          memory,
                                          NULL,
                                          NULL
                                          );
if (!NT_SUCCESS(status)) {
        return status;
}
WdfRequestSetCompletionRoutine(
                               request,
                               MyReadRequestCompletionRoutine,
                               targetInfo
                               );
if (WdfRequestSend(
                   request,
                   IoTarget,
                   WDF_NO_SEND_OPTIONS
                   ) == FALSE) {
        status = WdfRequestGetStatus(request);
}

要求

要求 值
目标平台 通用
最低 KMDF 版本 1.0
最低 UMDF 版本 2.0
标头 wdfiotarget.h (包括 Wdf.h)
Library Wdf01000.sys (KMDF) ;WUDFx02000.dll (UMDF)
IRQL <=DISPATCH_LEVEL
DDI 符合性规则 DriverCreate (kmdf) ， KmdfIrql (kmdf) ， KmdfIrql2 (kmdf) ， KmdfIrqlExplicit (kmdf) ， RequestFormattedValid (kmdf) 、 RequestSendAndForgetNoFormatting (kmdf) 、 RequestSendAndForgetNoFormatting2 (kmdf)

另请参阅

EvtDriverDeviceAdd

WDFMEMORY_OFFSET

WDF_REQUEST_PARAMETERS

WdfDeviceGetIoTarget

WdfIoTargetCreate

WdfIoTargetSendWriteSynchronously

WdfMemoryCreate

WdfMemoryCreatePreallocated

WdfRequestCreate

WdfRequestRetrieveInputMemory

WdfRequestReuse

WdfRequestSend