IO_CSQ_ACQUIRE_LOCK fonction de rappel (wdm.h)

Article
02/27/2024

La routine CsqAcquireLock est utilisée par le système pour acquérir le verrou d’une file d’attente IRP à annuler et implémentée par un pilote.

Syntaxe

IO_CSQ_ACQUIRE_LOCK IoCsqAcquireLock;

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

Paramètres

[in] Csq

Pointeur vers la structure IO_CSQ de la file d’attente cancel-safe IRP.

[out] Irql

Pointeur vers une variable que la routine CsqAcquireLock peut utiliser pour stocker l’IRQL actuel. Le système transmet la valeur stockée CsqReleaseLock lorsqu’il libère le verrou.

Valeur de retour

None

Remarques

Le pilote spécifie la routine CsqAcquireLock pour une file d’attente IRP cancel-safe lorsqu’il initialise la structure IO_CSQ de la file d’attente. Le pilote spécifie la routine comme paramètre CsqAcquireLock de IoCsqInitialize ou IoCsqInitializeEx lorsqu’il initialise IO_CSQ. Pour plus d’informations, consultez Annuler les files d’attente IRP sécurisées.

Le système appelle cette routine pour acquérir un verrou sur la file d’attente IRP du pilote avant d’essayer d’insérer ou de supprimer un IRP de la file d’attente. Le système appelle la routine CsqReleaseLock pour libérer le verrou.

Si le pilote utilise un verrou de rotation pour implémenter le verrouillage de la file d’attente, il doit stocker l’IRQL actuel pour quand il libère le verrou de rotation. Le système transmet un pointeur à une variable IRQL que le pilote peut utiliser pour stocker l’IRQL actuel. Le système transmet la valeur stockée en tant que paramètre Irql à CsqReleaseLock lorsqu’il libère le verrou. Sinon, le pilote peut ignorer le paramètre Irql . Pour plus d’informations sur les verrous de rotation, consultez Verrous de rotation.

Les pilotes peuvent utiliser n’importe quel mécanisme de verrouillage pour verrouiller la file d’attente, comme les mutex. Pour plus d’informations sur les mutex, consultez Mutex Objects.

Exemples

Pour définir une routine de rappel CsqAcquireLock , vous devez d’abord fournir une déclaration de fonction qui identifie le type de routine de rappel que vous définissez. Windows fournit un ensemble de types de fonctions de rappel pour les pilotes. La déclaration d’une fonction à l’aide des types de fonction de rappel permet à l’analyse du code pour les pilotes, au vérificateur de pilotes statiques (SDV) et à d’autres outils de vérification de trouver des erreurs. Il s’agit d’une exigence pour l’écriture de pilotes pour le système d’exploitation Windows.

Par exemple, pour définir une routine de rappel CsqAcquireLock nommée MyCsqAcquireLock, utilisez le type IO_CSQ_ACQUIRE_LOCK comme indiqué dans cet exemple de code :

IO_CSQ_ACQUIRE_LOCK MyCsqAcquireLock;

Ensuite, implémentez votre routine de rappel comme suit :

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

Le type de fonction IO_CSQ_ACQUIRE_LOCK est défini dans le fichier d’en-tête Wdm.h. Pour identifier plus précisément les erreurs lors de l’exécution des outils d’analyse du code, veillez à ajouter l’annotation _Use_decl_annotations_ à votre définition de fonction. L’annotation _Use_decl_annotations_ garantit que les annotations appliquées au type de fonction IO_CSQ_ACQUIRE_LOCK dans le fichier d’en-tête sont utilisées. Pour plus d’informations sur la configuration requise pour les déclarations de fonction, consultez Déclaration de fonctions à l’aide de types de rôles de fonction pour les pilotes WDM. Pour plus d’informations sur _Use_decl_annotations_, consultez Annotating Function Behavior.