IO_CSQ_ACQUIRE_LOCK回调函数 (wdm.h)

项目
02/27/2024

系统使用 CsqAcquireLock 例程获取驱动程序实现的取消安全 IRP 队列的锁。

语法

IO_CSQ_ACQUIRE_LOCK IoCsqAcquireLock;

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

参数

[in] Csq

指向取消安全 IRP 队列的IO_CSQ 结构的指针。

[out] Irql

指向 CsqAcquireLock 例程可用于存储当前 IRQL 的变量的指针。当系统释放锁时，系统会传递存储的值 CsqReleaseLock 。

返回值

无

备注

驱动程序在初始化队列的IO_CSQ结构时为取消安全 IRP 队列指定 CsqAcquireLock 例程。驱动程序在初始化IO_CSQ时将例程指定为 IoCsqInitialize 或 IoCsqInitializeEx 的 CsqAcquireLock 参数。有关详细信息，请参阅取消安全 IRP 队列。

在尝试从队列中插入或删除 IRP 之前，系统会调用此例程来获取驱动程序的 IRP 队列上的锁。系统调用 CsqReleaseLock 例程来释放锁。

如果驱动程序使用旋转锁为队列实现锁定，则必须在释放旋转锁时存储当前 IRQL。系统将指针传递给驱动程序可用于存储当前 IRQL 的 IRQL 变量。当系统释放锁时，系统会将存储的值作为 Irql 参数传递给 CsqReleaseLock 。否则，驱动程序可以忽略 Irql 参数。有关旋转锁的信息，请参阅旋转锁。

驱动程序可以使用任何锁定机制来锁定队列，例如互斥体。有关互斥体的详细信息，请参阅互斥对象。

示例

若要定义 CsqAcquireLock 回调例程，必须先提供一个函数声明来标识要定义的回调例程的类型。 Windows 为驱动程序提供了一组回调函数类型。使用回调函数类型声明函数可帮助驱动程序的代码分析、静态驱动程序验证程序 (SDV) 和其他验证工具查找错误，这是为 Windows 操作系统编写驱动程序的要求。

例如，若要定义名为 MyCsqAcquireLock的 CsqAcquireLock 回调例程，请使用 IO_CSQ_ACQUIRE_LOCK 类型，如以下代码示例所示：

IO_CSQ_ACQUIRE_LOCK MyCsqAcquireLock;

然后，按如下所示实现回调例程：

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

IO_CSQ_ACQUIRE_LOCK函数类型在 Wdm.h 头文件中定义。若要在运行代码分析工具时更准确地识别错误，请务必将 _Use_decl_annotations_ 注释添加到函数定义。注释 _Use_decl_annotations_ 可确保使用应用于头文件中IO_CSQ_ACQUIRE_LOCK函数类型的注释。有关函数声明要求的详细信息，请参阅使用 WDM 驱动程序的函数角色类型声明函数。有关的信息 _Use_decl_annotations_，请参阅批注函数行为。