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

[アーティクル]
02/26/2024

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 構造体の最大量。プロバイダーは、この量を超えないようにする必要があります。 1 つの 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

次の方法で共有

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

構文

パラメーター

戻り値

注釈

例

要件

フィードバック

その他のリソース