DRIVER_CANCEL função de retorno de chamada (wdm.h)

Artigo
02/07/2025

A rotina Cancelar cancela uma operação de E/S.

Sintaxe

DRIVER_CANCEL DriverCancel;

void DriverCancel(
  [in, out] _DEVICE_OBJECT *DeviceObject,
  [in, out] _IRP *Irp
)
{...}

Parâmetros

[in, out] DeviceObject

Ponteiro fornecido pelo chamador para uma estrutura de DEVICE_OBJECT. Esse é o objeto do dispositivo de destino, criado anteriormente pela rotina de addDevice do driver.

[in, out] Irp

Ponteiro fornecido pelo chamador para uma estrutura de IRP que descreve a operação de E/S a ser cancelada.

Valor de retorno

Nenhum

Observações

Quando um driver ou outro componente do sistema chama IoCancelIrp, o gerente de E/S chama a rotina de Cancelar do IRP, se um tiver sido registrado para o IRP.

Para registrar uma rotina Cancelar para um IRP, um driver pode usar um dos dois métodos a seguir:

Um driver que fornece uma rotina de do StartIo e usa a fila de dispositivos fornecida pelo gerente de E/S pode especificar uma rotina Cancelar ao chamar IoStartPacket.
Um driver que cria e gerencia filas de dispositivo suplementares pode registrar uma rotina Cancelar chamando IoSetCancelRoutine.

Somente uma rotina de Cancelar pode ser registrada para um IRP ao mesmo tempo.

O gerente de E/S chama IoAcquireCancelSpinLock antes de chamar a rotina de cancelar de um driver, de modo que a rotina Cancelar deve chamar IoReleaseCancelSpinLock em algum momento. A rotina não deve manter o bloqueio de rotação por mais tempo do que o necessário.

A rotina Cancelar é executada em um contexto de thread arbitrário em IRQL = DISPATCH_LEVEL até chamar IoReleaseCancelSpinLock, que altera o IRQL para um valor fornecido pelo chamador. O driver deve especificar > CancelIrql para esse valor.

A rotina Cancelar deve definir o membro status do bloco de status de E/S como STATUS_CANCELLED e definir seu membro de Informações como zero. Em seguida, a rotina deve concluir o IRP especificado chamando IoCompleteRequest.

Para obter informações detalhadas sobre como implementar a rotina de cancelar de do driver, consulte Canceling IRPs.

Exemplos

Para definir um Cancelar rotina de retorno de chamada, primeiro você deve fornecer uma declaração de função que identifique o tipo de rotina de retorno de chamada que você está definindo. O Windows fornece um conjunto de tipos de função de retorno de chamada para drivers. Declarar uma função usando os tipos de função de retorno de chamada ajuda a análise de código para drivers, SDV (Verificador de Driver Estático) e outras ferramentas de verificação encontram erros e é um requisito para gravar drivers para o sistema operacional Windows.

Por exemplo, para definir um Cancelar rotina de retorno de chamada denominada MyCancel, use o tipo DRIVER_CANCEL conforme mostrado neste exemplo de código:

DRIVER_CANCEL MyCancel;

Em seguida, implemente sua rotina de retorno de chamada da seguinte maneira:

_Use_decl_annotations_
VOID
  MyCancel(
    struct _DEVICE_OBJECT  *DeviceObject,
    struct _IRP  *Irp
    )
  {
      // Function body
  }

O tipo de função DRIVER_CANCEL é definido no arquivo de cabeçalho Wdm.h. Para identificar erros com mais precisão ao executar as ferramentas de análise de código, adicione a anotação _Use_decl_annotations_ à sua definição de função. A anotação _Use_decl_annotations_ garante que as anotações aplicadas ao tipo de função DRIVER_CANCEL no arquivo de cabeçalho sejam usadas. Para obter mais informações sobre os requisitos para declarações de função, consulte Declarando funções usando tipos de função de função para drivers WDM. Para obter informações sobre _Use_decl_annotations_, consulte Anotando o comportamento da função.

Requisitos

Requisito	Valor
da Plataforma de Destino	Área de trabalho
cabeçalho	wdm.h (include Wdm.h, Ntddk.h, Ntifs.h)
IRQL	Chamado em DISPATCH_LEVEL (consulte a seção Comentários).

Compartilhar via