FILTER_RESTART回调函数 (ndis.h)

项目
08/07/2023

FilterRestart 函数为指定的筛选器模块启动重启操作。

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

语法

FILTER_RESTART FilterRestart;

NDIS_STATUS FilterRestart(
  [in] NDIS_HANDLE FilterModuleContext,
  [in] PNDIS_FILTER_RESTART_PARAMETERS RestartParameters
)
{...}

参数

[in] FilterModuleContext

筛选器驱动程序应重启的筛选器模块上下文区域的句柄。筛选器驱动程序在 FilterAttach 函数中创建并初始化了此上下文区域。

[in] RestartParameters

指向的指针 NDIS_FILTER_RESTART_PARAMETERS 结构，用于定义筛选器模块的重启参数。

返回值

FilterRestart 返回以下状态值之一：

返回代码	说明
NDIS_STATUS_SUCCESS	FilterRestart 已成功重启指定的筛选器模块。
NDIS_STATUS_PENDING	筛选器驱动程序将在完成重启操作后通过调用 NdisFRestartComplete 函数异步完成请求。
NDIS_STATUS_RESOURCES	FilterRestart 由于资源不足而失败。
NDIS_STATUS_FAILURE	上述状态值均未应用。筛选器驱动程序应将 NdisWriteEventLogEntry 函数与指定失败原因的参数一起调用。

注解

FilterRestart 是筛选器驱动程序的必需函数。当筛选器模块处于“暂停”状态时，NDIS 可以调用 FilterRestart。筛选器模块在 FilterRestart 执行开始时进入“正在重启”状态。

当 NDIS 调用 FilterRestart 时，筛选器驱动程序：

必须完成重启正常发送和接收操作所需的操作。
（可选）读取或写入配置参数。
（可选）重新分配缓冲池。
（可选）修改在 的 RestartAttributes 成员中指定的重启属性 NDIS_FILTER_RESTART_PARAMETERS 结构。如果 RestartAttributes 中的指针为 NULL，则筛选器驱动程序不应修改或添加到重启属性列表。如果 RestartAttributes 中的指针为非 NULL，则指向重启属性列表中的第一个NDIS_RESTART_ATTRIBUTES 结构。如果筛选器驱动程序未重启，则不应修改任何属性。
（可选）使用 OID 请求在基础驱动程序中查询或设置信息。筛选器驱动程序不应针对重启属性列表中已提供的信息发出 OID 请求。
返回NDIS_STATUS_SUCCESS或失败状态。

如果筛选器驱动程序修改重启属性列表，则筛选器驱动程序：

如果无法识别的 Oid 成员中的 OID，则不应修改任何媒体特定的属性 NDIS_RESTART_ATTRIBUTES 结构。
可将特定于媒体的新属性添加到重启属性列表中。在这种情况下，筛选器驱动程序必须分配新的NDIS_RESTART_ATTRIBUTES结构，例如，使用 NdisAllocateMemoryWithTagPriority 函数 -- 并为新属性提供内存空间。将重启属性传播到过度覆盖的驱动程序后，NDIS 将释放筛选器驱动程序的属性内存。
可以修改重启属性列表中特定于媒体的属性。如果筛选器驱动程序需要更多的内存空间，可以使用 NdisFreeMemory 函数释放NDIS_RESTART_ATTRIBUTES结构，并分配新结构以包含修改后的信息。将重启属性传播到过度覆盖的驱动程序后，NDIS 将释放筛选器驱动程序的属性内存。
如果NDIS_RESTART_ATTRIBUTES结构中的 Oid 成员为 OID_GEN_MINIPORT_RESTART_ATTRIBUTES，请确保 NDIS_RESTART_GENERAL_ATTRIBUTES 结构包含筛选器驱动程序所需的信息。若要确保NDIS_RESTART_GENERAL_ATTRIBUTES结构包含所需信息，应在 NDIS_RESTART_GENERAL_ATTRIBUTES 结构的 Header 成员中指定的 NDIS_OBJECT_HEADER 结构中检查 Revision 成员。
注意筛选器驱动程序可以修改NDIS_RESTART_GENERAL_ATTRIBUTES结构中的任何成员。如果筛选器驱动程序应修改的某些属性未包含在 NDIS 提供的结构的修订中，则筛选器驱动程序应依赖过度配置驱动程序来对缺少的属性发出 OID 请求。筛选器驱动程序可以在完成 OID 请求时修改属性。
如果筛选器驱动程序更改了重启属性，则必须提供 FilterOidRequest 函数。筛选器驱动程序必须确保过度驱动程序在重启属性中接收的信息与它们为响应 OID 请求而接收的信息一致。

筛选器驱动程序返回其状态或调用 NdisFRestartComplete 函数后，重启操作完成。如果操作成功完成，筛选器模块将处于 “正在运行” 状态，并恢复正常的发送和接收处理。如果重启操作失败，筛选器模块将返回到 “已暂停” 状态。

NDIS 在 IRQL = PASSIVE_LEVEL 调用 FilterRestart 。

示例

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

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

FILTER_RESTART MyRestart;

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

_Use_decl_annotations_
NDIS_STATUS
 MyRestart(
    NDIS_HANDLE  FilterModuleContext,
    PNDIS_FILTER_RESTART_PARAMETERS  FilterRestartParameters
    )
  {...}

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

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