Função StorPortEtwEvent4 (storport.h)

Artigo
08/07/2023

StorPortEtwEvent4 registra um evento ETW (Rastreamento de Eventos para Windows) com quatro parâmetros ETW de uso geral em um canal de rastreamento de armazenamento.

Sintaxe

ULONG StorPortEtwEvent4(
  [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,
  [in, optional] _In_reads_or_z_opt_(STORPORT_ETW_MAX_PARAM_NAME_LENGTH)PWSTR Parameter3Name,
  [in]           ULONGLONG                                                    Parameter3Value,
  [in, optional] _In_reads_or_z_opt_(STORPORT_ETW_MAX_PARAM_NAME_LENGTH)PWSTR Parameter4Name,
  [in]           ULONGLONG                                                    Parameter4Value
);

Parâmetros

[in] HwDeviceExtension

Um ponteiro para a extensão de dispositivo do miniporte.

[in, optional] Address

O endereço do dispositivo da unidade de armazenamento. Esse parâmetro é NULL para dispositivos adaptador.

[in] EventId

Um identificador definido pelo miniporto para o evento ETW.

[in] EventDescription

O texto de descrição do evento. Essa cadeia de caracteres de texto deve ser <= STORPORT_ETW_MAX_DESCRIPTION_LENGTH.

[in] EventKeywords

Sinalizadores de palavra-chave para categorização de eventos. Defina como 0 se nenhuma palavra-chave for desejada. As palavras-chave são uma combinação OR bit a bit do seguinte.

Valor	Significado
STORPORT_ETW_EVENT_KEYWORD_IO	O evento está relacionado a operações de E/S do dispositivo.
STORPORT_ETW_EVENT_KEYWORD_PERFORMANCE	O evento está relacionado ao desempenho.
STORPORT_ETW_EVENT_KEYWORD_POWER	O evento está relacionado à energia do dispositivo.
STORPORT_ETW_EVENT_KEYWORD_ENUMERATION	O evento está relacionado à enumeração do dispositivo.

[in] EventLevel

O nível de evento. Esse valor pode indicar a importância ou a gravidade do evento. Esse é um dos valores a seguir.

Valor	Significado
StorportEtwLevelLogAlways	Registre o evento incondicionalmente. O evento é registrado independentemente de qualquer conjunto de filtros.
StorportEtwLevelCritical	Evento de nível crítico.
StorportEtwLevelError	Evento de nível de erro.
StorportEtwLevelWarning	Evento de nível de aviso.
StorportEtwLevelInformational	Evento informativo.
StorportEtwLevelVerbose	Informações detalhadas do evento fornecidas.

[in] EventOpcode

A natureza operacional do evento. Esse é um dos valores a seguir.

Valor	Significado
StorportEtwEventOpcodeInfo	Evento informativo geral.
StorportEtwEventOpcodeStart	Dispositivo ou unidade estava sendo iniciado.
StorportEtwEventOpcodeStop	Dispositivo ou unidade estava parando. O evento corresponde ao último evento inicial não pago.
StorportEtwEventOpcodeDC_Start	Um evento inicial de coleta de dados. São tipos de evento rundown.
StorportEtwEventOpcodeDC_Stop	Um evento de interrupção da coleta de dados. São tipos de evento rundown.
StorportEtwEventOpcodeExtension	Um evento de extensão.
StorportEtwEventOpcodeReply	Um evento de resposta.
StorportEtwEventOpcodeResume	O dispositivo ou unidade foi retomado após a suspensão.
StorportEtwEventOpcodeSuspend	O dispositivo ou unidade está suspenso até a conclusão de outra operação.
StorportEtwEventOpcodeReceive	A transferência de atividade é recebida de outro componente.

[in, optional] Srb

Um ponteiro para o SRB associado ao evento registrado. Se esse parâmetro contiver um SRB válido, esse ponteiro SRB e o ponteiro SRB associado serão registrados.

[in, optional] Parameter1Name

Uma descrição do significado de Parameter1Value. Essa cadeia de caracteres de nome de parâmetro deve ser <= STORPORT_ETW_MAX_PARAM_NAME_LENGTH.

[in] Parameter1Value

O valor do parâmetro 1.

[in, optional] Parameter2Name

Uma descrição do significado de Parameter2Value. Essa cadeia de caracteres de nome de parâmetro deve ser <= STORPORT_ETW_MAX_PARAM_NAME_LENGTH.

[in] Parameter2Value

O valor do parâmetro 2.

[in, optional] Parameter3Name

Uma descrição do significado de Parameter3Value. Essa cadeia de caracteres de nome de parâmetro deve ser <= STORPORT_ETW_MAX_PARAM_NAME_LENGTH.

[in] Parameter3Value

O valor do parâmetro 3.

[in, optional] Parameter4Name

Uma descrição do significado de Parameter4Value. Essa cadeia de caracteres de nome de parâmetro deve ser <= STORPORT_ETW_MAX_PARAM_NAME_LENGTH.

[in] Parameter4Value

O valor do parâmetro 4.

Retornar valor

StorPortEtwEvent4 retorna um dos seguintes códigos de status:

Código de retorno	Descrição
STOR_STATUS_SUCCESS	O evento foi registrado com êxito.
STOR_STATUS_NOT_IMPLEMENTED	O rastreamento não está habilitado para eventos de armazenamento.
STOR_STATUS_INVALID_PARAMETER	Um parâmetro é inválido. Por exemplo, HwDeviceExtension ou EventDescription são NULL, EventDescription é maior que o tamanho máximo do nome ou um nome de parâmetro ETW é maior que o tamanho máximo do nome.

Comentários

Um miniporto pode chamar StorPortEtwEvent4 para registrar quatro parâmetros ETW de uso geral. Os parâmetros ETW são expressos como quatro pares nome-valor. Se um parâmetro não for nomeado (Nomedo Parâmetro X= NULL), a rotina definirá o valor do parâmetro correspondente como 0.

Os eventos gerados a partir de drivers de miniporto storport são registrados no canal ETW "Microsoft-Windows-Storage-Storport/Diagnos".