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

Artigo
02/27/2024

A rotina CsqAcquireLock é usada pelo sistema para adquirir o bloqueio para uma fila IRP com segurança de cancelamento implementada pelo driver.

Sintaxe

IO_CSQ_ACQUIRE_LOCK IoCsqAcquireLock;

void IoCsqAcquireLock(
  [in]  PIO_CSQ Csq,
  [out] PKIRQL Irql
)
{...}

Parâmetros

[in] Csq

Ponteiro para a estrutura de IO_CSQ para a fila IRP cancel-safe.

[out] Irql

Ponteiro para uma variável que a rotina CsqAcquireLock pode usar para armazenar o IRQL atual. O sistema passa o valor armazenado CsqReleaseLock quando libera o bloqueio.

Retornar valor

Nenhum

Comentários

O driver especifica a rotina CsqAcquireLock para uma fila IRP cancel-safe quando inicializa a estrutura de IO_CSQ da fila. O driver especifica a rotina como o parâmetro CsqAcquireLock de IoCsqInitialize ou IoCsqInitializeEx quando inicializa IO_CSQ. Para obter mais informações, consulte Filas IRP cancel-safe.

O sistema chama essa rotina para adquirir um bloqueio na fila IRP do driver antes de tentar inserir ou remover um IRP da fila. O sistema chama a rotina CsqReleaseLock para liberar o bloqueio.

Se o driver usar um bloqueio de rotação para implementar o bloqueio para a fila, ele deverá armazenar o IRQL atual para quando liberar o bloqueio de rotação. O sistema passa um ponteiro para uma variável IRQL que o driver pode usar para armazenar o IRQL atual. O sistema passa o valor armazenado como o parâmetro Irql para CsqReleaseLock quando libera o bloqueio. Caso contrário, o driver poderá ignorar o parâmetro Irql . Para obter informações sobre bloqueios de rotação, consulte Spin Locks.

Os drivers podem usar qualquer mecanismo de bloqueio para bloquear a fila, como mutexes. Para obter mais informações sobre mutexes, consulte Objetos Mutex.

Exemplos

Para definir uma rotina de retorno de chamada CsqAcquireLock , 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 a encontrar erros e é um requisito para escrever drivers para o sistema operacional Windows.

Por exemplo, para definir uma rotina de retorno de chamada CsqAcquireLock chamada MyCsqAcquireLock, use o tipo IO_CSQ_ACQUIRE_LOCK conforme mostrado neste exemplo de código:

IO_CSQ_ACQUIRE_LOCK MyCsqAcquireLock;

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

_Use_decl_annotations_
VOID 
 MyCsqAcquireLock(
    PIO_CSQ  Csq,
    PKIRQL  Irql
    )
  {
      // Function body
  }

O tipo de função IO_CSQ_ACQUIRE_LOCK é 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 _Use_decl_annotations_ anotação à sua definição de função. A _Use_decl_annotations_ anotação garante que as anotações aplicadas ao tipo de função IO_CSQ_ACQUIRE_LOCK 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.