NDIS_PD_POST_AND_DRAIN_BUFFER_LIST fonction de rappel (ndis.h)

Article
08/07/2023

La plateforme PacketDirect (PD) appelle la fonction PDPostAndDrainBufferList d’un pilote miniport compatible PD pour publier des structures PD_BUFFER dans les files d’attente de transmission/réception de PD et vider toutes les structures PD_BUFFER précédemment publiées qui ont été terminées.

Note Vous devez déclarer la fonction à l’aide du type NDIS_PD_POST_AND_DRAIN_BUFFER_LIST . Pour plus d’informations, consultez la section Exemples suivante.

Syntaxe

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
)
{...}

Paramètres

[in, out] Queue

Pointeur vers la file d’attente de transmission ou de réception qui recevra les mémoires tampons publiées et dont les mémoires tampons terminées seront supprimées.

[in, out] PostBufferListHead

Tête de liste post. Le fournisseur supprime les mémoires tampons de cette liste et les ajoute à la file d’attente.

[in, out] DrainBufferListTail

Fin de la liste de drains. Le fournisseur supprime toutes les mémoires tampons terminées de la file d’attente et les ajoute à cette liste.

[in] MaxDrainCount

Quantité maximale de structures PD_BUFFER à drainer. Le fournisseur doit s’assurer de ne pas dépasser ce montant. Un ensemble de structures de PD_BUFFER partielles qui composent un seul nombre de paquets L2 est 1.

Valeur retournée

Cette fonction de rappel ne retourne pas de valeur.

Remarques

Le fournisseur supprime les mémoires tampons de PostBufferList et les place dans la file d’attente, en commençant par la mémoire tampon principale dans la liste et en passant à la mémoire tampon suivante jusqu’à ce que PostBufferList soit vide ou que la file d’attente soit pleine (ou presque complète). Le fournisseur a avancé vers PostListHead et retourne le nouvel en-tête de liste à l’appelant. Le fournisseur supprime également les mémoires tampons terminées de la file d’attente et les insère dans la queue de DrainBufferList et retourne la nouvelle queue DrainBufferList au client.

Note Le fournisseur doit vider autant de mémoires tampons que possible afin d’ouvrir de la place pour les mémoires tampons affichées. PostBufferList et DrainBufferList sont garantis pour être des listes de mémoires tampons disjointes (le client ne fournit jamais le chef d’une liste de mémoires tampons comme PostBufferListHead et la fin de cette même liste que DrainBufferListTail).

Le client peut également passer une liste de mémoires tampons post vide pour simplement vider les mémoires tampons terminées sans publier de nouvelles mémoires tampons. Le client peut également définir MaxDrainCount sur 0 pour publier simplement de nouvelles mémoires tampons sans vider les mémoires tampons terminées. Dans de rares cas, le client peut appeler l’appel avec une liste de mémoires tampons post vide et maxDrainCount sur 0. Le fournisseur ne doit pas supposer le contraire et ne doit pas gérer correctement un tel appel, par exemple une absence d’opération.

Exemples

Pour définir une fonction PDPostAndDrainBufferList , vous devez d’abord fournir une déclaration de fonction qui identifie le type de fonction que vous définissez. Windows fournit un ensemble de types de fonctions pour les pilotes. La déclaration d’une fonction à l’aide des types de fonction permet à l’analyse du code pour les pilotes, le vérificateur de pilotes statique (SDV) et d’autres outils de vérification de trouver les erreurs, et il s’agit d’une exigence pour l’écriture de pilotes pour le système d’exploitation Windows.

Par exemple, pour définir une fonction PDPostAndDrainBufferList nommée « MyPDPostAndDrainBufferList », utilisez le type NDIS_PD_POST_AND_DRAIN_BUFFER_LIST comme indiqué dans cet exemple de code :

NDIS_PD_POST_AND_DRAIN_BUFFER_LIST MyPDPostAndDrainBufferList;

Ensuite, implémentez votre fonction comme suit :

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

Le type de fonction NDIS_PD_POST_AND_DRAIN_BUFFER_LIST est défini dans le fichier d’en-tête Ntddndis.h. Pour identifier plus précisément les erreurs lors de l’exécution des outils d’analyse du code, veillez à ajouter l’annotation Use_decl_annotations à votre définition de fonction. L’annotation Use_decl_annotations garantit que les annotations appliquées au type de fonction NDIS_PD_POST_AND_DRAIN_BUFFER_LIST dans le fichier d’en-tête sont utilisées. Pour plus d’informations sur la configuration requise pour les déclarations de fonction, consultez Déclaration de fonctions à l’aide de types de rôles de fonction pour les pilotes NDIS.

Pour plus d’informations sur Use_decl_annotations, consultez Annotating Function Behavior.

Voici un exemple d’extrait de code qui illustre les indirections de pointeur pour cette fonction.

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

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 10
Serveur minimal pris en charge	Windows Server 2016
Plateforme cible	Windows
En-tête	ndis.h
IRQL	<= DISPATCH_LEVEL

Partager via