Función WdfIoTargetFormatRequestForRead (wdfiotarget.h)

Artículo
08/08/2023

[Se aplica a KMDF y UMDF]

El método WdfIoTargetFormatRequestForRead compila una solicitud de lectura para un destino de E/S, pero no envía la solicitud.

Sintaxis

NTSTATUS WdfIoTargetFormatRequestForRead(
  [in]           WDFIOTARGET       IoTarget,
  [in]           WDFREQUEST        Request,
  [in, optional] WDFMEMORY         OutputBuffer,
  [in, optional] PWDFMEMORY_OFFSET OutputBufferOffset,
  [in, optional] PLONGLONG         DeviceOffset
);

Parámetros

[in] IoTarget

Identificador de un objeto de destino de E/S local o remoto obtenido de una llamada anterior a WdfDeviceGetIoTarget o WdfIoTargetCreate, o desde un método que proporciona un destino de E/S especializado.

[in] Request

Identificador de un objeto de solicitud de marco. Para obtener más información, vea la sección Comentarios que se muestra más adelante.

[in, optional] OutputBuffer

Identificador de un objeto de memoria de marco. Este objeto representa un búfer que recibirá datos del destino de E/S. Este parámetro es opcional y puede ser NULL. Para obtener más información sobre este parámetro, vea la siguiente sección Comentarios.

[in, optional] OutputBufferOffset

Puntero a una estructura de WDFMEMORY_OFFSET asignada por el autor de la llamada que proporciona valores opcionales de desplazamiento de bytes y longitud. El marco usa estos valores para determinar la dirección y la longitud iniciales, dentro del búfer de salida, para la transferencia de datos. Si este puntero es NULL, la transferencia de datos comienza al principio del búfer de salida y el tamaño de la transferencia es el tamaño del búfer.

[in, optional] DeviceOffset

Puntero a una variable que especifica un desplazamiento inicial para la transferencia. El destino de E/S (es decir, el controlador inferior siguiente) define cómo usar este valor. Por ejemplo, los controladores de la pila de controladores de un disco pueden especificar un desplazamiento desde el principio del disco. El destino de E/S obtiene esta información en el miembro Parameters.Read.DeviceOffset de la estructura WDF_REQUEST_PARAMETERS de la solicitud. Este puntero es opcional. La mayoría de los controladores establecen este puntero en NULL.

Valor devuelto

WdfIoTargetFormatRequestForRead devuelve STATUS_SUCCESS si la operación se realiza correctamente. De lo contrario, este método podría devolver uno de los siguientes valores:

Código devuelto	Descripción
STATUS_INVALID_PARAMETER	Se ha detectado un parámetro no válido.
STATUS_INVALID_DEVICE_REQUEST	La longitud de la transferencia era mayor que la longitud del búfer o la solicitud de E/S ya estaba en cola en un destino de E/S.
STATUS_INSUFFICIENT_RESOURCES	El marco no pudo asignar recursos del sistema (normalmente memoria).
STATUS_REQUEST_NOT_ACCEPTED	El paquete de solicitud de E/S (IRP) que representa el parámetro Request no proporciona suficientes estructuras IO_STACK_LOCATION para permitir que el controlador reenvíe la solicitud.

Este método también podría devolver otros valores NTSTATUS.

Se produce una comprobación de errores si el controlador proporciona un identificador de objeto no válido.

Comentarios

Use el método WdfIoTargetFormatRequestForRead , seguido del método WdfRequestSend , para enviar solicitudes de lectura de forma sincrónica o asincrónica. Como alternativa, use el método WdfIoTargetSendReadSynchronously para enviar solicitudes de lectura de forma sincrónica.

Puede reenviar una solicitud de E/S que el controlador recibió en una cola de E/S o puede crear y enviar una nueva solicitud. En cualquier caso, el marco requiere un objeto de solicitud y un espacio de búfer.

Para reenviar una solicitud de E/S que el controlador recibió en una cola de E/S:

Especifique el identificador de la solicitud recibida para el parámetro Request del método Request del método WdfIoTargetFormatRequestForRead.
Use el búfer de salida de la solicitud recibida para el parámetro OutputBuffer del método OutputBuffer del método WdfIoTargetFormatRequestForRead.
El controlador debe llamar a WdfRequestRetrieveOutputMemory para obtener un identificador a un objeto de memoria del marco que representa el búfer de salida de la solicitud y debe usar ese identificador como el valor de OutputBuffer.

Para obtener más información sobre el reenvío de una solicitud de E/S, consulte Reenvío de solicitudes de E/S.

Los controladores suelen dividir las solicitudes de E/S recibidas en solicitudes más pequeñas que envían a un destino de E/S, por lo que el controlador podría crear nuevas solicitudes.

Para crear una nueva solicitud de E/S:

Cree un nuevo objeto de solicitud y proporcione su identificador para el parámetro Request del método Request del método WdfIoTargetFormatRequestForRead.
Llame a WdfRequestCreate para preasignar uno o varios objetos de solicitud. Puede reutilizar estos objetos de solicitud llamando a WdfRequestReuse. La función de devolución de llamada EvtDriverDeviceAdd del controlador puede asignar previamente objetos de solicitud para un dispositivo.
Proporcione espacio de búfer y proporcione el identificador del búfer para el parámetro OutputBuffer del método OutputBuffer de WdfIoTargetFormatRequestForRead.
El controlador debe especificar este espacio en búfer como identificador WDFMEMORY para la memoria administrada por el marco. El controlador puede hacer lo siguiente:
- Llame a WdfMemoryCreate o WdfMemoryCreatePreallocated para crear un nuevo búfer de memoria, si desea que el controlador pase un nuevo búfer al destino de E/S.
- Llame a WdfRequestRetrieveOutputMemory para obtener un identificador para el objeto de memoria que representa el búfer de una solicitud de E/S recibida, si desea que el controlador pase el contenido de ese búfer al destino de E/S.
Tenga en cuenta que si el controlador llama a WdfRequestRetrieveOutputMemory y pasa el identificador de memoria a WdfIoTargetFormatRequestForRead, el controlador no debe completar la solicitud de E/S recibida hasta después de que el controlador elimine, reutilice o vuelva a formatear el nuevo objeto de solicitud creado por el controlador. (WdfIoTargetFormatRequestForRead incrementa el recuento de referencias del objeto de memoria. Al eliminar, reutilizar o volver a formatear un objeto de solicitud, se reduce el recuento de referencias del objeto de memoria).

Algunos destinos de E/S aceptan solicitudes de lectura que tienen un búfer de longitud cero. Para estos destinos de E/S, el controlador puede especificar NULL para el parámetro OutputBuffer .

Después de que un controlador llame a WdfIoTargetFormatRequestForRead para dar formato a una solicitud de E/S, debe llamar a WdfRequestSend para enviar la solicitud (de forma sincrónica o asincrónica) a un destino de E/S.

Varias llamadas a WdfIoTargetFormatRequestForRead que usan la misma solicitud no provocan asignaciones de recursos adicionales. Por lo tanto, para reducir la posibilidad de que WdfRequestCreate devuelva STATUS_INSUFFICIENT_RESOURCES, la función de devolución de llamada EvtDriverDeviceAdd del controlador puede llamar a WdfRequestCreate para asignar previamente uno o varios objetos de solicitud para un dispositivo. Posteriormente, el controlador puede reutilizar (llamar a WdfRequestReuse), formatear (llamar a WdfIoTargetFormatRequestForRead) y volver a enviar (llamar a WdfRequestSend) cada objeto de solicitud sin arriesgar un valor devuelto STATUS_INSUFFICIENT_RESOURCES desde una llamada posterior a WdfRequestCreate. Todas las llamadas posteriores a WdfIoTargetFormatRequestForRead para el objeto de solicitud reutilizado devolverán STATUS_SUCCESS, si los valores de parámetro no cambian. (Si el controlador no llama al mismo método de formato de solicitud cada vez, se pueden asignar recursos adicionales).

Para obtener información sobre cómo obtener información de estado una vez completada una solicitud de E/S, vea Obtener información de finalización.

Para obtener más información sobre WdfIoTargetFormatRequestForRead, vea Enviar solicitudes de E/S a destinos de E/S generales.

Para obtener más información sobre los destinos de E/S, consulte Uso de destinos de E/S.

Ejemplos

En el ejemplo de código siguiente se crea un objeto de memoria de marco para el búfer de salida de una solicitud de lectura, se da formato a la solicitud de lectura, se registra una función de devolución de llamada CompletionRoutine y se envía la solicitud de lectura a un destino de E/S.

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

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

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

status = WdfIoTargetFormatRequestForRead(
                                         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);
}

Requisitos

Requisito	Value
Plataforma de destino	Universal
Versión mínima de KMDF	1.0
Versión mínima de UMDF	2.0
Encabezado	wdfiotarget.h (incluya Wdf.h)
Library	Wdf01000.sys (KMDF); WUDFx02000.dll (UMDF)
IRQL	<=DISPATCH_LEVEL
Reglas de cumplimiento de DDI	DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf), RequestFormattedValid(kmdf), RequestSendAndForgetNoFormatting(kmdf), RequestSendAndForgetNoFormatting2(kmdf)