Función StorPortNvmeMiniportEvent (storport.h)

Artículo
02/07/2025

Un controlador de miniport nvMe llama a la función StorPortNvmeMiniportEvent para registrar un evento ETW en un canal específico con hasta ocho parámetros de uso general adicionales.

Sintaxis

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] Puntero a la extensión de dispositivo de hardware para el adaptador de bus host (HBA).

ControllerHandle

[in/optional] Para un miniporte NVMe de tejido (NVMe-oF), si el evento es específico del controlador, controllerHandle es el identificador de Storport para el controlador NVMe; de lo contrario, el valor es NULL.

NamespaceId

[in] Si el evento es específico del espacio de nombres, namespaceId es el identificador del espacio de nombres; de lo contrario, debe ser cero.

EventChannel

[in] Valor de enumeración STORPORT_ETW_EVENT_CHANNEL que especifica el canal ETW donde se registra el evento.

EventId

[in] Identificador de evento específico de minipoort para identificar de forma única el tipo de evento.

EventDescription

[in] Cadena necesaria que describe el evento. El tamaño máximo de la cadena es STORPORT_ETW_MAX_DESCRIPTION_LENGTH caracteres, no incluido el terminador NULL.

EventKeywords

[in] Máscara de bits de STORPORT_ETW_EVENT_CHANNEL_valores XXX para caracterizar aún más el evento. Establézcalo en cero si no se necesitan palabras clave.

EventLevel

[in] Valor de STORPORT_ETW_LEVEL que especifica el nivel del evento.

EventOpcode

[in] Valor de enumeración STORPORT_ETW_EVENT_OPCODE que especifica el código de operación del evento.

Parameter1Name

[in] Cadena corta que da significado a Parameter1Value. Si parameter1Name es NULL o una cadena vacía, se omite Parameter1Value. El tamaño máximo de la cadena es STORPORT_ETW_MAX_PARAM_NAME_LENGTH caracteres, no incluido el terminador NULL.

Parameter1Value

[in] Valor del primer parámetro. Si Parameter1Name es NULL o una cadena vacía, Storport registrará este valor como cero.

Parameter2Name

[in] Cadena corta que da significado a Parameter2Value. Si parameter2Name es NULL o una cadena vacía, se omite Parameter2Value. El tamaño máximo de la cadena es STORPORT_ETW_MAX_PARAM_NAME_LENGTH caracteres, no incluido el terminador NULL.

Parameter2Value

[in] Valor del segundo parámetro. Si Parameter2Name es NULL o una cadena vacía, Storport registrará este valor como cero.

Parameter3Name

[in] Cadena corta que da significado a Parameter3Value. Si Parameter3Name es NULL o una cadena vacía, se omite Parameter3Value. El tamaño máximo de la cadena es STORPORT_ETW_MAX_PARAM_NAME_LENGTH caracteres, no incluido el terminador NULL.

Parameter3Value

[in] Valor del tercer parámetro. Si Parameter3Name es NULL o una cadena vacía, Storport registrará este valor como cero.

Parameter4Name

[in] Cadena corta que da significado a Parameter4Value. Si Parameter4Name es NULL o una cadena vacía, se omite Parameter4Value. El tamaño máximo de la cadena es STORPORT_ETW_MAX_PARAM_NAME_LENGTH caracteres, no incluido el terminador NULL.

Parameter4Value

[in] Valor del cuarto parámetro. Si Parameter4Name es NULL o una cadena vacía, Storport registrará este valor como cero.

Parameter5Name

[in] Cadena corta que da significado a Parameter5Value. Si parameter5Name es NULL o una cadena vacía, se omite parameter5Value. El tamaño máximo de la cadena es STORPORT_ETW_MAX_PARAM_NAME_LENGTH caracteres, no incluido el terminador NULL.

Parameter5Value

[in] Valor del quinto parámetro. Si Parameter5Name es NULL o una cadena vacía, Storport registrará este valor como cero.

Parameter6Name

[in] Cadena corta que da significado a Parameter6Value. Si parameter6Name es NULL o una cadena vacía, se omite Parameter6Value. El tamaño máximo de la cadena es STORPORT_ETW_MAX_PARAM_NAME_LENGTH caracteres, no incluido el terminador NULL.

Parameter6Value

[in] Valor del sexto parámetro. Si Parameter6Name es NULL o una cadena vacía, Storport registrará este valor como cero.

Parameter7Name

[in] Cadena corta que da significado a Parameter7Value. Si Parameter7Name es NULL o una cadena vacía, se omite Parameter7Value. El tamaño máximo de la cadena es STORPORT_ETW_MAX_PARAM_NAME_LENGTH caracteres, no incluido el terminador NULL.

Parameter7Value

[in] Valor del séptimo parámetro. Si Parameter7Name es NULL o una cadena vacía, Storport registrará este valor como cero.

Parameter8Name

[in] Cadena corta que da significado a Parameter8Value. Si parameter8Name es NULL o una cadena vacía, se omite Parameter8Value. El tamaño máximo de la cadena es STORPORT_ETW_MAX_PARAM_NAME_LENGTH caracteres, no incluido el terminador NULL.

Parameter8Value

[in] Valor del octavo parámetro. Si Parameter8Name es NULL o una cadena vacía, Storport registrará este valor como cero.

Valor devuelto

StorPortNvmeMiniportEvent devuelve un STOR_STATUS_SUCCESS si el evento se registra correctamente. De lo contrario, devuelve un valor como:

Código devuelto	Descripción
STOR_STATUS_NOT_IMPLEMENTED	Esta función no se implementa en el sistema operativo activo.
STOR_STATUS_INVALID_PARAMETER	Se produce un error en la operación con este valor devuelto si uno o varios de los parámetros no son válidos.
STOR_STATUS_UNSUCCESSFUL	Error en la operación por otros motivos internos.

Observaciones

Un miniport puede llamar a StorPortNvmeMiniportEvent para registrar ocho parámetros ETW de uso general. Los parámetros ETW se expresan como ocho pares nombre-valor. Si no se llama a un parámetro (ParameterXName = NULL), la rutina establecerá el valor de parámetro correspondiente en 0.

Los eventos generados a partir de controladores de miniport storport se registran en el canal especificado por EventChannel.