NDIS_PD_QUERY_QUEUE_DEPTH コールバック関数 (ndis.h)

  • [アーティクル]

PacketDirect (PD) プラットフォームは、PD 対応ミニポート ドライバーの PDQueryQueueDepth 関数を呼び出して、Queue にポストされる未処理の PD_BUFFER 構造体の数を返 します。

メモNDIS_PD_QUERY_QUEUE_DEPTH型を使用して関数を宣言する必要があります。 詳細については、次の例に関するセクションを参照してください。

 

構文

NDIS_PD_QUERY_QUEUE_DEPTH NdisPdQueryQueueDepth;

VOID() NdisPdQueryQueueDepth(
  [in]  const NDIS_PD_QUEUE *Queue,
  [out] ULONG64 *Depth
)
{...}

パラメーター

[in] Queue

送信キューまたは受信キューへのポインター。

[out] Depth

受信キューでは、受信パケットを配置するために使用できる PD_BUFFER 構造体の数です。 たとえば、10 個のバッファーがポストされ、受信パケットを配置するためにプロバイダーによって 10 個のうち 3 個が既にフェッチされている場合、この値は 7 である必要があります。 送信キューでは、プロバイダーが送信のためにキューからまだフェッチしていない PD_BUFFER 構造体の数です。

戻り値

このコールバック関数は値を返しません。

注釈

メモ IHV パートナーの場合: キューの深さを監視する機能は、クライアントが輻輳のビルドアップにアクセスし、予防措置を取るために非常に重要です。 送信キューのキューの深さが増すのは、送信リンクの輻輳が増加する兆候です。 RX キューのキューの深さが低下することは、クライアントが受信リンクで受信パケットを十分に高速に処理できないことを示しています。 クライアントは、キューの深さの状態を頻繁に監視する必要がある場合があります (たとえば、ポストと操作ごとにキューの深さを取得するため、キューの深さを照会するコスト (CPU サイクル) は、1 回の PDPostAndDrainBufferList 呼び出しのコストと比較して目立つ必要はありません。
 

例

PDQueryQueueDepth 関数を定義するには、まず、定義する関数の型を識別する関数宣言を指定する必要があります。 Windows には、ドライバーの関数型のセットが用意されています。 関数の種類を使用して関数を宣言すると、 ドライバーのコード分析、 静的ドライバー検証ツール (SDV)、およびその他の検証ツールでエラーが検出され、Windows オペレーティング システム用のドライバーを記述するための要件になります。

たとえば、" MyPDQueryQueueDepth" という名前の PDQueryQueueDepth 関数を定義するには、次のコード例に示すように 、NDIS_PD_QUERY_QUEUE_DEPTH 型を使用します。

NDIS_PD_QUERY_QUEUE_DEPTH MyPDQueryQueueDepth;

次に、次のように関数を実装します。

_Use_decl_annotations_
VOID
 MyPDQueryQueueDepth(
    CONST NDIS_PD_QUEUE*  Queue,
    ULONG64*  Depth
    )
  {...}

NDIS_PD_QUERY_QUEUE_DEPTH関数の種類は、Ntddndis.h ヘッダー ファイルで定義されています。 コード分析ツールを実行するときにエラーをより正確に識別するには、 Use_decl_annotations 注釈を関数定義に追加してください。 Use_decl_annotations注釈を使用すると、ヘッダー ファイル内のNDIS_PD_QUERY_QUEUE_DEPTH関数型に適用される注釈が確実に使用されます。 関数宣言の要件の詳細については、「NDIS ドライバーの関数 ロール型を使用して関数を宣言する」を参照してください。

Use_decl_annotationsの詳細については、「関数の動作に注釈を付ける」を参照してください。

要件

要件 値
サポートされている最小のクライアント Windows 10
サポートされている最小のサーバー Windows Server 2016
対象プラットフォーム Windows
ヘッダー ndis.h
IRQL <= DISPATCH_LEVEL