Fungsi StorPortEtwLogByteStream (storport.h)

Artikel
08/07/2023

StorPortEtwLogByteStream mencatat peristiwa Pelacakan Peristiwa untuk Windows (ETW) dengan parameter aliran byte tujuan umum ke saluran yang ditentukan.

Sintaks

ULONG StorPortEtwLogByteStream(
  [in]           PVOID                      HwDeviceExtension,
  [in, optional] PSTOR_ADDRESS              Address,
  [in]           STORPORT_ETW_EVENT_CHANNEL EventChannel,
  [in]           ULONG                      EventId,
  [in]           PWSTR                      EventDescription,
  [in]           ULONGLONG                  EventKeywords,
  [in]           STORPORT_ETW_LEVEL         EventLevel,
  [in]           STORPORT_ETW_EVENT_OPCODE  EventOpcode,
  [in]           USHORT                     DataLength,
  [in]           PUCHAR                     Data
);

Parameter

[in] HwDeviceExtension

Penunjuk ke ekstensi perangkat miniport.

[in, optional] Address

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

[in] EventChannel

Nilai STORPORT_ETW_EVENT_CHANNEL yang mengidentifikasi saluran ETW untuk mencatat peristiwa.

[in] EventId

ID peristiwa yang ditentukan miniport yang mengidentifikasi peristiwa secara unik.

[in] EventDescription

String pendek yang menjelaskan peristiwa. EventDescription diperlukan dan harus <= STORPORT_ETW_MAX_DESCRIPTION_LENGTH karakter, tidak termasuk terminator NULL.

[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] DataLength

Panjang, dalam byte, dari aliran byte yang ditikam Data , di mana 1 <= DataLength<= STORPORT_ETW_MAX_BYTE_STREAM_LENGTH.

[in] Data

Arahkan ke aliran byte ETW kustom miniport.

Mengembalikan nilai

StorPortEtwLogByteStream mengembalikan salah satu kode status berikut:

Menampilkan kode	Deskripsi
STOR_STATUS_SUCCESS	Peristiwa berhasil dicatat ke saluran ETW yang ditentukan.
STOR_STATUS_INVALID_PARAMETER	Parameter tidak valid. Misalnya, HwDeviceExtension, EventDescription, atau Data adalah NULL, DataLength lebih besar dari panjang nama maksimum, EventChannel adalah nilai yang tidak valid.
STOR_STATUS_UNSUCCESSFUL	Dikembalikan karena alasan internal lainnya.

Keterangan

Miniport dapat memanggil StorPortEtwLogByteStream untuk mencatat peristiwa ETW ke saluran tertentu dengan parameter aliran byte tujuan umum.

StorPortEtwLogByteStream berguna ketika miniport perlu mencatat konteks di luar yang diizinkan di StorPortEtwEvent2, StorPortEtwEvent4, atau StorPortEtwEvent8. Misalnya, miniport dapat mencatat struktur data internalnya sebagai aliran byte yang kemudian dapat digunakan untuk tujuan diagnostik saat masalah dilaporkan.