Fungsi StorPortEtwEvent4 (storport.h)

Artikel
08/07/2023

StorPortEtwEvent4 mencatat peristiwa Pelacakan Peristiwa untuk Windows (ETW) dengan empat parameter ETW tujuan umum ke saluran pelacakan penyimpanan.

Sintaks

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

Parameter

[in] HwDeviceExtension

Penunjuk ke ekstensi perangkat miniport.

[in, optional] Address

Alamat perangkat unit penyimpanan. Parameter ini NULL untuk perangkat adaptor.

[in] EventId

Pengidentifikasi yang ditentukan miniport untuk peristiwa ETW.

[in] EventDescription

Teks deskripsi untuk peristiwa tersebut. String teks ini harus <= STORPORT_ETW_MAX_DESCRIPTION_LENGTH.

[in] EventKeywords

Bendera kata kunci untuk kategorisasi peristiwa. Atur ke 0 jika tidak ada kata kunci yang diinginkan. Kata kuncinya adalah kombinasi bitwise OR dari yang berikut ini.

Nilai	Makna
STORPORT_ETW_EVENT_KEYWORD_IO	Peristiwa ini terkait dengan operasi IO perangkat.
STORPORT_ETW_EVENT_KEYWORD_PERFORMANCE	Peristiwa ini terkait dengan performa.
STORPORT_ETW_EVENT_KEYWORD_POWER	Peristiwa ini terkait dengan daya perangkat.
STORPORT_ETW_EVENT_KEYWORD_ENUMERATION	Peristiwa ini terkait dengan enumerasi perangkat.

[in] EventLevel

Tingkat peristiwa. Nilai ini dapat menunjukkan pentingnya atau tingkat keparahan peristiwa. Ini adalah salah satu nilai berikut.

Nilai	Makna
StorportEtwLevelLogAlways	Catat peristiwa tanpa syarat. Peristiwa dicatat terlepas dari filter apa pun yang ditetapkan.
StorportEtwLevelCritical	Peristiwa tingkat kritis.
StorportEtwLevelError	Peristiwa tingkat kesalahan.
StorportEtwLevelWarning	Peristiwa tingkat peringatan.
StorportEtwLevelInformational	Peristiwa informasi.
StorportEtwLevelVerbose	Informasi peristiwa Verbose disediakan.

[in] EventOpcode

Sifat operasional peristiwa. Ini adalah salah satu nilai berikut.

Nilai	Makna
StorportEtwEventOpcodeInfo	Peristiwa informasi umum.
StorportEtwEventOpcodeStart	Perangkat atau unit sedang dimulai.
StorportEtwEventOpcodeStop	Perangkat atau unit berhenti. Peristiwa ini sesuai dengan peristiwa mulai terakhir yang belum dipasarkan.
StorportEtwEventOpcodeDC_Start	Peristiwa awal pengumpulan data. Ini adalah jenis peristiwa rundown.
StorportEtwEventOpcodeDC_Stop	Peristiwa penghentian pengumpulan data. Ini adalah jenis peristiwa rundown.
StorportEtwEventOpcodeExtension	Peristiwa ekstensi.
Balasan StorportEtwEventOpcodeReply	Peristiwa balasan.
StorportEtwEventOpcodeResume	Perangkat atau unit melanjutkan setelah ditangguhkan.
StorportEtwEventOpcodeSuspend	Perangkat atau unit ditangguhkan menunggu penyelesaian operasi lain.
StorportEtwEventOpcodeReceive	Transfer aktivitas diterima dari komponen lain.

[in, optional] Srb

Penunjuk ke SRB yang terkait dengan peristiwa yang dicatat. Jika parameter ini berisi SRB yang valid, penunjuk SRB ini dan penunjuk SRB terkait dicatat.

[in, optional] Parameter1Name

Deskripsi arti parameter1Value. String nama parameter ini harus <= STORPORT_ETW_MAX_PARAM_NAME_LENGTH.

[in] Parameter1Value

Nilai untuk parameter 1.

[in, optional] Parameter2Name

Deskripsi arti parameter2Value. String nama parameter ini harus <= STORPORT_ETW_MAX_PARAM_NAME_LENGTH.

[in] Parameter2Value

Nilai untuk parameter 2.

[in, optional] Parameter3Name

Deskripsi arti parameter3Value. String nama parameter ini harus <= STORPORT_ETW_MAX_PARAM_NAME_LENGTH.

[in] Parameter3Value

Nilai untuk parameter 3.

[in, optional] Parameter4Name

Deskripsi arti parameter4Value. String nama parameter ini harus <= STORPORT_ETW_MAX_PARAM_NAME_LENGTH.

[in] Parameter4Value

Nilai untuk parameter 4.

Mengembalikan nilai

StorPortEtwEvent4 mengembalikan salah satu kode status berikut:

Menampilkan kode	Deskripsi
STOR_STATUS_SUCCESS	Kejadian berhasil dicatat.
STOR_STATUS_NOT_IMPLEMENTED	Pelacakan tidak diaktifkan untuk peristiwa penyimpanan.
STOR_STATUS_INVALID_PARAMETER	Parameter tidak valid. Misalnya, HwDeviceExtension atau EventDescription adalah NULL, EventDescription lebih besar dari panjang nama maksimum, atau nama parameter ETW lebih besar dari panjang nama maksimum.

Keterangan

Miniport dapat memanggil StorPortEtwEvent4 untuk mencatat empat parameter ETW tujuan umum. Parameter ETW dinyatakan sebagai empat pasangan nilai nama. Jika parameter tidak diberi nama (ParameterXName = NULL), rutinitas akan mengatur nilai parameter yang sesuai ke 0.

Peristiwa yang dihasilkan dari driver miniport StorPort dicatat ke saluran ETW "Microsoft-Windows-Storage-Storport/Diagnose".