Função StorPortNvmeMiniportEvent (storport.h)

Artigo
02/07/2025

Um driver de miniporto NVMe chama a função StorPortNvmeMiniportEvent para registrar um evento ETW em um canal específico com até oito parâmetros de finalidade geral adicionais.

Sintaxe

ULONG StorPortNvmeMiniportEvent(
  PVOID                                                        HwDeviceExtension,
  PVOID                                                        ControllerHandle,
  ULONG                                                        NamespaceId,
  STORPORT_ETW_EVENT_CHANNEL                                   EventChannel,
  ULONG                                                        EventId,
  PWSTR                                                        EventDescription,
  ULONGLONG                                                    EventKeywords,
  STORPORT_ETW_LEVEL                                           EventLevel,
  STORPORT_ETW_EVENT_OPCODE                                    EventOpcode,
  _In_reads_or_z_opt_(STORPORT_ETW_MAX_PARAM_NAME_LENGTH)PWSTR Parameter1Name,
  ULONGLONG                                                    Parameter1Value,
  _In_reads_or_z_opt_(STORPORT_ETW_MAX_PARAM_NAME_LENGTH)PWSTR Parameter2Name,
  ULONGLONG                                                    Parameter2Value,
  _In_reads_or_z_opt_(STORPORT_ETW_MAX_PARAM_NAME_LENGTH)PWSTR Parameter3Name,
  ULONGLONG                                                    Parameter3Value,
  _In_reads_or_z_opt_(STORPORT_ETW_MAX_PARAM_NAME_LENGTH)PWSTR Parameter4Name,
  ULONGLONG                                                    Parameter4Value,
  _In_reads_or_z_opt_(STORPORT_ETW_MAX_PARAM_NAME_LENGTH)PWSTR Parameter5Name,
  ULONGLONG                                                    Parameter5Value,
  _In_reads_or_z_opt_(STORPORT_ETW_MAX_PARAM_NAME_LENGTH)PWSTR Parameter6Name,
  ULONGLONG                                                    Parameter6Value,
  _In_reads_or_z_opt_(STORPORT_ETW_MAX_PARAM_NAME_LENGTH)PWSTR Parameter7Name,
  ULONGLONG                                                    Parameter7Value,
  _In_reads_or_z_opt_(STORPORT_ETW_MAX_PARAM_NAME_LENGTH)PWSTR Parameter8Name,
  ULONGLONG                                                    Parameter8Value
);

Parâmetros

HwDeviceExtension

[in] Um ponteiro para a extensão do dispositivo de hardware para o HBA (adaptador de barramento de host).

ControllerHandle

[in/optional] Para um miniporto NVMe (NVMe-oF) de malha, se o evento for específico do controlador, ControllerHandle será o identificador do Storport para o controlador NVMe; caso contrário, o valor será NULL.

NamespaceId

[in] Se o evento for específico do namespace, NamespaceId será o identificador de namespace; caso contrário, deve ser zero.

EventChannel

[in] Um valor de enumeração STORPORT_ETW_EVENT_CHANNEL que especifica o canal ETW em que o evento é registrado.

EventId

[in] Identificador de evento específico de minipoort para identificar exclusivamente o tipo de evento.

EventDescription

[in] Cadeia de caracteres necessária que descreve o evento. O tamanho máximo da cadeia de caracteres é STORPORT_ETW_MAX_DESCRIPTION_LENGTH caracteres, não incluindo o terminador nulo.

EventKeywords

[in] A máscara de bits de STORPORT_ETW_EVENT_CHANNEL_XXX valores para caracterizar ainda mais o evento. Defina como zero se nenhuma palavra-chave for necessária.

EventLevel

[in] Um valor STORPORT_ETW_LEVEL que especifica o nível do evento.

EventOpcode

[in] Um valor de enumeração STORPORT_ETW_EVENT_OPCODE que especifica o opcode do evento.

Parameter1Name

[in] Uma cadeia de caracteres curta que dá significado a Parameter1Value. Se Parameter1Name for NULL ou uma cadeia de caracteres vazia, Parameter1Value será ignorada. O tamanho máximo da cadeia de caracteres é STORPORT_ETW_MAX_PARAM_NAME_LENGTH caracteres, não incluindo o terminador nulo.

Parameter1Value

[in] O valor do primeiro parâmetro. Se Parameter1Name for NULL ou uma cadeia de caracteres vazia, Storport registrará esse valor como zero.

Parameter2Name

[in] Uma cadeia de caracteres curta que dá significado a Parameter2Value . Se Parameter2Name for NULL ou uma cadeia de caracteres vazia, Parameter2Value será ignorado. O tamanho máximo da cadeia de caracteres é STORPORT_ETW_MAX_PARAM_NAME_LENGTH caracteres, não incluindo o terminador nulo.

Parameter2Value

[in] O valor do segundo parâmetro. Se Parameter2Name for NULL ou uma cadeia de caracteres vazia, Storport registrará esse valor como zero.

Parameter3Name

[in] Uma cadeia de caracteres curta que dá significado a Parameter3Value. Se Parameter3Name for NULL ou uma cadeia de caracteres vazia, Parameter3Value será ignorado. O tamanho máximo da cadeia de caracteres é STORPORT_ETW_MAX_PARAM_NAME_LENGTH caracteres, não incluindo o terminador nulo.

Parameter3Value

[in] O valor do terceiro parâmetro. Se Parameter3Name for NULL ou uma cadeia de caracteres vazia, Storport registrará esse valor como zero.

Parameter4Name

[in] Uma cadeia de caracteres curta que dá significado a Parameter4Value. Se Parameter4Name for NULL ou uma cadeia de caracteres vazia, Parameter4Value será ignorada. O tamanho máximo da cadeia de caracteres é STORPORT_ETW_MAX_PARAM_NAME_LENGTH caracteres, não incluindo o terminador nulo.

Parameter4Value

[in] O valor do quarto parâmetro. Se Parameter4Name for NULL ou uma cadeia de caracteres vazia, Storport registrará esse valor como zero.

Parameter5Name

[in] Uma cadeia de caracteres curta que dá significado a Parameter5Value . Se Parameter5Name for NULL ou uma cadeia de caracteres vazia, Parameter5Value será ignorada. O tamanho máximo da cadeia de caracteres é STORPORT_ETW_MAX_PARAM_NAME_LENGTH caracteres, não incluindo o terminador nulo.

Parameter5Value

[in] O valor do quinto parâmetro. Se Parameter5Name for NULL ou uma cadeia de caracteres vazia, Storport registrará esse valor como zero.

Parameter6Name

[in] Uma cadeia de caracteres curta que dá significado a Parameter6Value. Se Parameter6Name for NULL ou uma cadeia de caracteres vazia, Parameter6Value será ignorada. O tamanho máximo da cadeia de caracteres é STORPORT_ETW_MAX_PARAM_NAME_LENGTH caracteres, não incluindo o terminador nulo.

Parameter6Value

[in] O valor do sexto parâmetro. Se Parameter6Name for NULL ou uma cadeia de caracteres vazia, Storport registrará esse valor como zero.

Parameter7Name

[in] Uma cadeia de caracteres curta que dá significado a Parameter7Value . Se Parameter7Name for NULL ou uma cadeia de caracteres vazia, Parameter7Value será ignorada. O tamanho máximo da cadeia de caracteres é STORPORT_ETW_MAX_PARAM_NAME_LENGTH caracteres, não incluindo o terminador nulo.

Parameter7Value

[in] O valor do sétimo parâmetro. Se Parameter7Name for NULL ou uma cadeia de caracteres vazia, Storport registrará esse valor como zero.

Parameter8Name

[in] Uma cadeia de caracteres curta que dá significado a Parameter8Value. Se Parameter8Name for NULL ou uma cadeia de caracteres vazia, Parameter8Value será ignorado. O tamanho máximo da cadeia de caracteres é STORPORT_ETW_MAX_PARAM_NAME_LENGTH caracteres, não incluindo o terminador nulo.

Parameter8Value

[in] O valor do oitavo parâmetro. Se Parameter8Name for NULL ou uma cadeia de caracteres vazia, Storport registrará esse valor como zero.

Valor de retorno

StorPortNvmeMiniportEvent retornará um STOR_STATUS_SUCCESS se o evento for registrado com êxito. Caso contrário, ele retornará um valor como:

Código de retorno	Descrição
STOR_STATUS_NOT_IMPLEMENTED	Essa função não é implementada no sistema operacional ativo.
STOR_STATUS_INVALID_PARAMETER	A operação falhará com esse valor retornado se um ou mais dos parâmetros forem inválidos.
STOR_STATUS_UNSUCCESSFUL	A operação falhou por outros motivos internos.

Observações

Um miniporto pode chamar StorPortNvmeMiniportEvent para registrar oito parâmetros ETW de uso geral. Os parâmetros ETW são expressos como oito pares nome-valor. Se um parâmetro não for nomeado (ParameterXName = 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 especificado por EventChannel.