StorPortEtwEvent2, fonction (storport.h)

Article
02/07/2025

Un miniport appelle StorPortEtwEvent2 pour consigner un événement ETW avec deux paramètres ETW à usage général vers un canal de trace de stockage.

Syntaxe

ULONG StorPortEtwEvent2(
  [in]          PVOID                                                        HwDeviceExtension,
  [in/optional] PSTOR_ADDRESS                                                Address,
  [in]          ULONG                                                        EventId,
  [in]          PWSTR                                                        EventDescription,
  [in]          ULONGLONG                                                    EventKeywords,
  [in]          STORPORT_ETW_LEVEL                                           EventLevel,
  [in]          STORPORT_ETW_EVENT_OPCODE                                    EventOpcode,
  [in/optional] PSCSI_REQUEST_BLOCK                                          Srb,
  [in/optional] _In_reads_or_z_opt_(STORPORT_ETW_MAX_PARAM_NAME_LENGTH)PWSTR Parameter1Name,
  [in]          ULONGLONG                                                    Parameter1Value,
  [in/optional] _In_reads_or_z_opt_(STORPORT_ETW_MAX_PARAM_NAME_LENGTH)PWSTR Parameter2Name,
  [in]          ULONGLONG                                                    Parameter2Value
);

Paramètres

[in] HwDeviceExtension

Pointeur vers l’extension de périphérique matériel pour l’adaptateur de bus hôte (HBA).

[in/optional] Address

Adresse de l’unité de stockage. Ce paramètre a la valeur NULL pour les périphériques d’adaptateur.

[in] EventId

Identificateur miniport défini pour identifier de manière unique le type d’événement.

[in] EventDescription

Chaîne requise qui décrit l’événement. La taille maximale de la chaîne est STORPORT_ETW_MAX_DESCRIPTION_LENGTH caractères, sans inclure la marque de fin Null.

[in] EventKeywords

Indicateurs de mot clé pour la catégorisation des événements. Définissez la valeur 0 si aucun mot clé n’est souhaité. Les mots clés sont une combinaison OR au niveau du bit des éléments suivants.

Valeur	Signification
STORPORT_ETW_EVENT_KEYWORD_IO	L’événement est lié aux opérations d’E/S de l’appareil.
STORPORT_ETW_EVENT_KEYWORD_PERFORMANCE	L’événement est lié aux performances.
STORPORT_ETW_EVENT_KEYWORD_POWER	L’événement est lié à l’alimentation de l’appareil.
STORPORT_ETW_EVENT_KEYWORD_ENUMERATION	L’événement est lié à l’énumération de l’appareil.

[in] EventLevel

Valeur STORPORT_ETW_LEVEL qui spécifie l’importance ou la gravité de l’événement.

[in] EventOpcode

Valeur STORPORT_ETW_EVENT_OPCODE qui spécifie la nature opérationnelle de l’événement.

[in/optional] Srb

Pointeur vers le SRB associé à l’événement journalisé. Si ce paramètre contient un SRB valide, ce pointeur SRB et le pointeur SRB associé sont enregistrés.

[in/optional] Parameter1Name

Description de la signification de Parameter1Value. La taille maximale de la chaîne est STORPORT_ETW_MAX_PARAM_NAME_LENGTH caractères, sans inclure la marque de fin Null.

[in] Parameter1Value

Valeur du paramètre 1.

[in/optional] Parameter2Name

Description de la signification de Parameter2Value. La taille maximale de la chaîne est STORPORT_ETW_MAX_PARAM_NAME_LENGTH caractères, sans inclure la marque de fin Null.

[in] Parameter2Value

Valeur du paramètre 2.

Valeur de retour

StorPortEtwEvent2 retourne l’un des codes d’état suivants :

Retourner le code	Description
STOR_STATUS_SUCCESS	L’événement a été correctement journalisé.
STOR_STATUS_NOT_IMPLEMENTED	Le suivi n’est pas activé pour les événements de stockage.
STOR_STATUS_INVALID_PARAMETER	L’un des paramètres n’est pas valide. Par exemple, HwDeviceExtension ou EventDescription sont NULL, EventDescription est supérieur à la longueur de nom maximale, ou un nom de paramètre ETW est supérieur à la longueur maximale du nom.

Remarques

Un miniport peut appeler StorPortEtwEvent2 pour journaliser deux paramètres ETW à usage général. Les paramètres ETW sont exprimés sous la forme de deux paires nom-valeur. Si un paramètre n’est pas nommé (ParamètreXName = NULL), la routine définit la valeur de paramètre correspondante sur 0.

Les événements générés à partir de pilotes miniport StorPort sont enregistrés sur le canal ETW « Microsoft-Windows-Storage-Storport/Diagnose ».