Функция StorPortEtwEvent4 (storport.h)

Статья
02/07/2025

Минипорт вызывает StorPortEtwEvent4 для регистрации события ETW с четырьмя параметрами трассировки для общего назначения в канал трассировки хранилища.

Синтаксис

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
);

Параметры

[in] HwDeviceExtension

Указатель на расширение аппаратного устройства для адаптера шины узла (HBA).

[in/optional] Address

Адрес устройства единицы хранения. Этот параметр имеет значение NULL для устройств адаптера.

[in] EventId

Минипорт-определенный идентификатор для уникального определения типа события.

[in] EventDescription

Требуемая строка, описывающая событие. Максимальный размер строки — это STORPORT_ETW_MAX_DESCRIPTION_LENGTH символов, не включая терминатор NULL.

[in] EventKeywords

Флаги ключевых слов для классификации событий. Установите значение 0, если ключевое слово не требуется. Ключевые слова — это побитовая комбинация OR из следующих значений.

Ценность	Значение
STORPORT_ETW_EVENT_KEYWORD_IO	Это событие связано с операциями ввода-вывода устройства.
STORPORT_ETW_EVENT_KEYWORD_PERFORMANCE	Событие связано с производительностью.
STORPORT_ETW_EVENT_KEYWORD_POWER	Это событие связано с питанием устройства.
STORPORT_ETW_EVENT_KEYWORD_ENUMERATION	Событие связано с перечислением устройств.

[in] EventLevel

Значение STORPORT_ETW_LEVEL, указывающее важность или серьезность события.

[in] EventOpcode

Значение STORPORT_ETW_EVENT_OPCODE, указывающее операционный характер события.

[in/optional] Srb

Указатель на SRB, связанный с зарегистрированным событием. Если этот параметр содержит допустимый SRB, этот указатель SRB и связанный указатель SRB регистрируются.

[in/optional] Parameter1Name

Описание значения Parameter1Value. Максимальный размер строки — STORPORT_ETW_MAX_PARAM_NAME_LENGTH символов, не включая терминатор NULL.

[in] Parameter1Value

Значение параметра 1.

[in/optional] Parameter2Name

Описание значения Parameter2Value. Максимальный размер строки — STORPORT_ETW_MAX_PARAM_NAME_LENGTH символов, не включая терминатор NULL.

[in] Parameter2Value

Значение параметра 2.

[in/optional] Parameter3Name

Описание значения Parameter3Value. Максимальный размер строки — STORPORT_ETW_MAX_PARAM_NAME_LENGTH символов, не включая терминатор NULL.

[in] Parameter3Value

Значение параметра 3.

[in/optional] Parameter4Name

Описание значения Parameter4Value. Максимальный размер строки — STORPORT_ETW_MAX_PARAM_NAME_LENGTH символов, не включая терминатор NULL.

[in] Parameter4Value

Значение параметра 4.

Возвращаемое значение

StorPortEtwEvent4 возвращает один из следующих кодов состояния:

Возвращаемый код	Описание
STOR_STATUS_SUCCESS	Событие успешно зарегистрировано.
STOR_STATUS_NOT_IMPLEMENTED	Трассировка не включена для событий хранилища.
STOR_STATUS_INVALID_PARAMETER	Один из параметров недопустим. Например, HwDeviceExtension или EventDescription имеют значение NULL, EventDescription превышает максимальную длину имени или имя параметра ETW больше максимальной длины имени.

Замечания

Минипорт может вызывать StorPortEtwEvent4 для регистрации четырех параметров ETW общего назначения. Параметры ETW выражаются как четыре пары "имя-значение". Если параметр не называется (параметрXName = NULL), подпрограмма присвоит соответствующему значению параметра значение 0.

События, созданные из драйверов минипорта StorPort, регистрируются в канале ETW Microsoft-Windows-Storage-Storport/Diagnose.

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows 8.1
целевая платформа	Всеобщий
заголовка	storport.h (include Storport.h)
IRQL	<= DISPATCH_LEVEL