NDIS_PD_POST_AND_DRAIN_BUFFER_LIST回调函数 (ndis.h)

  • 项目

PacketDirect (PD) 平台调用支持 PD 的微型端口驱动程序的 PDPostAndDrainBufferList 函数，以将 PD_BUFFER 结构发布到 PD 传输/接收队列，并清空任何以前发布的 已完成PD_BUFFER 结构。

注意 必须使用 NDIS_PD_POST_AND_DRAIN_BUFFER_LIST 类型声明函数。 有关详细信息，请参阅以下示例部分。

 

语法

NDIS_PD_POST_AND_DRAIN_BUFFER_LIST NdisPdPostAndDrainBufferList;

VOID() NdisPdPostAndDrainBufferList(
  [in, out] NDIS_PD_QUEUE *Queue,
  [in, out] PD_BUFFER **PostBufferListHead,
  [in, out] PD_BUFFER ***DrainBufferListTail,
  [in]      ULONG MaxDrainCount
)
{...}

参数

[in, out] Queue

指向传输或接收队列的指针，该队列将接收已发布的缓冲区，并将删除已完成的缓冲区。

[in, out] PostBufferListHead

帖子列表的负责人。 提供程序删除此列表中的缓冲区，并将其添加到 队列中。

[in, out] DrainBufferListTail

排空列表的尾部。 提供程序从 队列 中删除任何已完成的缓冲区，并将其添加到此列表中。

[in] MaxDrainCount

要排出的最大 PD_BUFFER 结构量。 提供程序必须确保不超过此数量。 构成单个 L2 数据包计数的一组部分 PD_BUFFER 结构为 1。

返回值

此回调函数不返回值。

注解

提供程序从 PostBufferList 中删除缓冲区并将其放入队列，从列表中的头缓冲区开始，并前进到下一个缓冲区，直到 PostBufferList 为空或队列已满 (或接近满) 。 提供程序会高级到 PostListHead，并将新的列表头返回到调用方。 提供程序还会从队列中删除任何已完成的缓冲区，并将其插入到 DrainBufferList 的尾部，并将新的 DrainBufferList 尾部返回到客户端。

注意 提供程序应尽可能多地清空缓冲区，以便为要发布的缓冲区打开空间。 PostBufferList 和 DrainBufferList 保证是不连续的缓冲区列表 (客户端永远不会提供缓冲区列表的标头作为 PostBufferListHead，并且该列表的尾部与 DrainBufferListTail) 。
 
客户端还可以传递空的发布缓冲区列表，以仅清空已完成的缓冲区，而不发布任何新缓冲区。 客户端还可以将 MaxDrainCount 设置为 0，以便仅发布新缓冲区，而不会耗尽任何已完成的缓冲区。 在极少数情况下，客户端可能会同时调用空后缓冲区列表和 MaxDrainCount 为 0 的调用。 提供程序不得采用其他方式并正确处理此类调用，例如无操作。

示例

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

例如，若要定义名为“MyPDPostAndDrainBufferList”的 PDPostAndDrainBufferList 函数，请使用 NDIS_PD_POST_AND_DRAIN_BUFFER_LIST 类型，如以下代码示例所示：

NDIS_PD_POST_AND_DRAIN_BUFFER_LIST MyPDPostAndDrainBufferList;

然后，按如下所示实现函数：

_Use_decl_annotations_
VOID
 MyPDPostAndDrainBufferList(
    NDIS_PD_QUEUE*  Queue,
    PD_BUFFER**  PostBufferListHead,
    PD_BUFFER*** DrainBufferListTail,
    ULONG  MaxDrainCount
    )
  {...}

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

有关 Use_decl_annotations的信息，请参阅 批注函数行为。

下面是一个示例代码片段，用于说明此函数的指针间接关系。

PD_BUFFER* PostHead = NULL;
PD_BUFFER** PostTail = &PostHead;
PD_BUFFER* DrainHead = NULL;
PD_BUFFER** DrainTail = &DrainHead;

PD_BUFFER* bufX = <allocated PD_BUFFER>;

bufX->NextPDBuffer = NULL;
*PostTail = bufX;
PostTail = &bufX->NextPDBuffer;

// BEFORE:
//PostHead == bufX
//PostTail == &bufZ->NextPDBuffer
//DrainHead == NULL
//DrainTail == &DrainHead

NDIS_PD_POST_AND_DRAIN_BUFFER_LIST(
          Queue,
          &PostHead,
          &DrainTail,
          32);

// AFTER:
//PostHead == bufY
//PostTail == &bufZ->NextPDBuffer
//DrainHead == buf1
//DrainTail == &buf5->NextPDBuffer

要求

要求 值
最低受支持的客户端 Windows 10
最低受支持的服务器 Windows Server 2016
目标平台 Windows
标头 ndis.h
IRQL <= DISPATCH_LEVEL