Skip to content

nvme-print: support PEL VS Events and Info #3082

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
igaw merged 1 commit into from
Feb 9, 2026
Merged

nvme-print: support PEL VS Events and Info #3082

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions libnvme/src/nvme/types.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4554,6 +4554,36 @@
NVME_PEL_EHAI_PIT_NOT_ASSOCIATED = 3,
};

/**
* enum nvme_pel_vsedt_code - Persistent Event Log - Vendor Specific Event Data Type Code

Check failure on line 4558 in libnvme/src/nvme/types.h

View workflow job for this annotation

GitHub Actions / checkpatch review 

WARNING: line length of 89 exceeds 80 columns
* @NVME_PEL_VSEDT_RSVD: Reserved
* @NVME_PEL_VSEDT_EVENT_NAME: Event Name
* @NVME_PEL_VSEDT_ASCII_STRING: ASCII String
* @NVME_PEL_VSEDT_BINARY: Binary
* @NVME_PEL_VSEDT_SIGNED_INT: Signed Integer
*/
enum nvme_pel_vsedt_code {
NVME_PEL_VSEDT_RSVD = 0,
NVME_PEL_VSEDT_EVENT_NAME = 1,
NVME_PEL_VSEDT_ASCII_STRING = 2,
NVME_PEL_VSEDT_BINARY = 3,
NVME_PEL_VSEDT_SIGNED_INT = 4,
};

/**
* struct nvme_vs_event_desc - Vendor Specific Event Descriptor
* @vsec: Vendor Specific Event Code
* @vsedt: Vendor Specific Event Data Type
* @uidx: UUID Index
* @vsedl: Vendor Specific Event Data Length
*/
struct nvme_vs_event_desc {
__le16 vsec;
__u8 vsedt;
__u8 uidx;
__le16 vsedl;
};

/**
* struct nvme_fw_commit_event - Firmware Commit Event Data
* @old_fw_rev: Old Firmware Revision
Expand Down
89 changes: 85 additions & 4 deletions nvme-print-json.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1811,10 +1811,81 @@
obj_add_uint(valid_attrs, "threshold", thermal_exc_event->threshold);
}

static void json_pel_vs_event_data(struct json_object *valid_attrs, void *vsed,
__u8 vsedt, __u16 vsedl)
{
struct json_object *vs_data = json_create_object();
char *str;

switch (vsedt) {
case NVME_PEL_VSEDT_EVENT_NAME:
str = malloc(vsedl + 1);
if (str) {
memcpy(str, vsed, vsedl);
str[vsedl] = '\0';
obj_add_str(vs_data, "event_name", str);
free(str);
}
break;
case NVME_PEL_VSEDT_ASCII_STRING:
str = malloc(vsedl + 1);
if (str) {
memcpy(str, vsed, vsedl);
str[vsedl] = '\0';
obj_add_str(vs_data, "ascii_string_data", str);
free(str);
}
break;
case NVME_PEL_VSEDT_BINARY:
obj_d(vs_data, "binary_data", (unsigned char *)vsed, vsedl, 16, 1);

Check failure on line 1840 in nvme-print-json.c

View workflow job for this annotation

GitHub Actions / checkpatch review 

WARNING: line length of 83 exceeds 80 columns
break;
case NVME_PEL_VSEDT_SIGNED_INT:
obj_add_int(vs_data, "signed_integer_data", *(int64_t *)vsed);
break;
default:
obj_d(vs_data, "reserved_data_type_bin", (unsigned char *)vsed, vsedl, 16, 1);

Check failure on line 1846 in nvme-print-json.c

View workflow job for this annotation

GitHub Actions / checkpatch review 

WARNING: line length of 94 exceeds 80 columns
break;
}

obj_add_obj(valid_attrs, "vs_event_data", vs_data);
}

static void json_pel_vendor_specific_event(void *pevent_log_info, __u32 offset,
__u32 event_data_len, struct json_object *valid_attrs)

Check failure on line 1854 in nvme-print-json.c

View workflow job for this annotation

GitHub Actions / checkpatch review 

WARNING: line length of 97 exceeds 80 columns
{
__u32 progress = 0;
__u16 vsedl;
uint i;
struct nvme_vs_event_desc *vs_desc;
struct json_object *vs_events = json_create_array();

for (i = 0; progress < event_data_len; i++) {
struct json_object *vs_event = json_create_object();

vs_desc = pevent_log_info + offset + progress;
vsedl = le16_to_cpu(vs_desc->vsedl);

obj_add_uint(vs_event, "vs_event_descriptor_number", i);
obj_add_uint(vs_event, "vs_event_code", le16_to_cpu(vs_desc->vsec));

Check failure on line 1869 in nvme-print-json.c

View workflow job for this annotation

GitHub Actions / checkpatch review 

WARNING: line length of 84 exceeds 80 columns
obj_add_uint(vs_event, "vs_event_data_type", vs_desc->vsedt);
obj_add_uint(vs_event, "vs_event_uuid_index", vs_desc->uidx);
obj_add_uint(vs_event, "vs_event_data_len", vsedl);

if (vsedl)
json_pel_vs_event_data(vs_event, vs_desc + 1, vs_desc->vsedt, vsedl);

Check failure on line 1875 in nvme-print-json.c

View workflow job for this annotation

GitHub Actions / checkpatch review 

WARNING: line length of 93 exceeds 80 columns

array_add_obj(vs_events, vs_event);
progress += sizeof(*vs_desc) + vsedl;
}

obj_add_array(valid_attrs, "vs_event_entry", vs_events);
}

static void json_pevent_entry(void *pevent_log_info, __u8 action, __u32 size, const char *devname,
__u32 offset, struct json_object *valid)
{
int i;
__u16 vsil, el;
struct nvme_persistent_event_log *pevent_log_head = pevent_log_info;
struct nvme_persistent_event_entry *pevent_entry_head;
struct json_object *valid_attrs;
Expand All @@ -1824,8 +1895,10 @@
break;

pevent_entry_head = pevent_log_info + offset;
vsil = le16_to_cpu(pevent_entry_head->vsil);
el = le16_to_cpu(pevent_entry_head->el);

if (offset + pevent_entry_head->ehl + 3 + le16_to_cpu(pevent_entry_head->el) >=
if (offset + pevent_entry_head->ehl + 3 + el >=
size)
break;

Expand All @@ -1841,10 +1914,14 @@
obj_add_uint64(valid_attrs, "event_time_stamp",
le64_to_cpu(pevent_entry_head->ets));
obj_add_uint(valid_attrs, "port_id", le16_to_cpu(pevent_entry_head->pelpid));
obj_add_uint(valid_attrs, "vu_info_len", le16_to_cpu(pevent_entry_head->vsil));
obj_add_uint(valid_attrs, "event_len", le16_to_cpu(pevent_entry_head->el));
obj_add_uint(valid_attrs, "vu_info_len", vsil);
obj_add_uint(valid_attrs, "event_len", el);

if (vsil)
obj_d(valid_attrs, "vs_info_bin",
(void *)pevent_entry_head + 1, vsil, 16, 1);

offset += pevent_entry_head->ehl + 3;
offset += pevent_entry_head->ehl + vsil + 3;

switch (pevent_entry_head->etype) {
case NVME_PEL_SMART_HEALTH_EVENT:
Expand Down Expand Up @@ -1887,6 +1964,10 @@
case NVME_PEL_THERMAL_EXCURSION_EVENT:
json_pel_thermal_excursion(pevent_log_info, offset, valid_attrs);
break;
case NVME_PEL_VENDOR_SPECIFIC_EVENT:
json_pel_vendor_specific_event(pevent_log_info, offset, el - vsil,

Check failure on line 1968 in nvme-print-json.c

View workflow job for this annotation

GitHub Actions / checkpatch review 

WARNING: line length of 90 exceeds 80 columns
valid_attrs);
break;
default:
break;
}
Expand Down
72 changes: 67 additions & 5 deletions nvme-print-stdout.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,6 +312,8 @@
static void pel_event_header(int i, struct nvme_persistent_event_entry *pevent_entry_head,
int human)
{
__u16 vsil = le16_to_cpu(pevent_entry_head->vsil);

printf("Event Number: %u\n", i);
printf("Event Type: %s\n", nvme_pel_event_to_string(pevent_entry_head->etype));
printf("Event Type Revision: %u\n", pevent_entry_head->etype_rev);
Expand All @@ -324,8 +326,13 @@
printf("Controller Identifier: %u\n", le16_to_cpu(pevent_entry_head->cntlid));
printf("Event Timestamp: %"PRIu64"\n", le64_to_cpu(pevent_entry_head->ets));
printf("Port Identifier: %u\n", le16_to_cpu(pevent_entry_head->pelpid));
printf("Vendor Specific Information Length: %u\n", le16_to_cpu(pevent_entry_head->vsil));
printf("Vendor Specific Information Length: %u\n", vsil);
printf("Event Length: %u\n", le16_to_cpu(pevent_entry_head->el));

if (vsil) {
printf("Vendor Specific Information:\n");
d((void *)pevent_entry_head + 1, vsil, 16, 1);
}
}

static void pel_smart_health_event(void *pevent_log_info, __u32 offset, const char *devname)
Expand Down Expand Up @@ -493,11 +500,62 @@
printf("Threshold: %u\n", thermal_exc_event->threshold);
}

static void pel_vs_event_data(void *vsed, __u8 vsedt, __u16 vsedl)
{
printf("Vendor Specific Event Data:\n");
switch (vsedt) {
case NVME_PEL_VSEDT_EVENT_NAME:
printf("Event Name for Vendor Specific Event Code:\n");
printf("%.*s\n", vsedl, (char *)vsed);
break;
case NVME_PEL_VSEDT_ASCII_STRING:
printf("ASCII String Data:\n");
printf("%.*s\n", vsedl, (char *)vsed);
break;
case NVME_PEL_VSEDT_BINARY:
printf("Binary Data:\n");
d(vsed, vsedl, 16, 1);
break;
case NVME_PEL_VSEDT_SIGNED_INT:
printf("Signed Integer Data: %" PRId64 "\n", (int64_t)vsedt);
break;
default:
printf("Reserved data type. As Binary:\n");
d(vsed, vsedl, 16, 1);
}
}

static void pel_vendor_specific_event(void *pevent_log_info, __u32 offset,
__u32 event_data_len)
{
__u32 progress = 0;
__u16 vsedl;
int i;
struct nvme_vs_event_desc *vs_desc;

printf("Vendor Specific Event Entry:\n");
for (i = 0; progress < event_data_len; i++) {
vs_desc = pevent_log_info + offset + progress;
vsedl = le16_to_cpu(vs_desc->vsedl);

printf("Vendor Specific Event Descriptor %u:\n", i);
printf("Vendor Specific Event Code: %u\n", le16_to_cpu(vs_desc->vsec));

Check failure on line 542 in nvme-print-stdout.c

View workflow job for this annotation

GitHub Actions / checkpatch review 

WARNING: line length of 87 exceeds 80 columns
printf("Vendor Specific Event Data Type: %u\n", vs_desc->vsedt);
printf("Vendor Specific Event UIndex: %u\n", vs_desc->uidx);
printf("Vendor Specific Event Data Length: %u\n", vsedl);
if (vsedl)
pel_vs_event_data(vs_desc + 1, vs_desc->vsedt,
vsedl);
progress += sizeof(*vs_desc) + vsedl;
}
}

static void stdout_persistent_event_log(void *pevent_log_info, __u8 action, __u32 size,
const char *devname)
{
struct nvme_persistent_event_log *pevent_log_head;
__u32 offset = sizeof(*pevent_log_head);
__u16 vsil, el;
struct nvme_persistent_event_entry *pevent_entry_head;
int human = stdout_print_ops.flags & VERBOSE;

Expand All @@ -522,14 +580,15 @@
break;

pevent_entry_head = pevent_log_info + offset;
vsil = le16_to_cpu(pevent_entry_head->vsil);
el = le16_to_cpu(pevent_entry_head->el);

if ((offset + pevent_entry_head->ehl + 3 +
le16_to_cpu(pevent_entry_head->el)) >= size)
if ((offset + pevent_entry_head->ehl + 3 + el) >= size)
break;

pel_event_header(i, pevent_entry_head, human);

offset += pevent_entry_head->ehl + 3;
offset += pevent_entry_head->ehl + vsil + 3;

switch (pevent_entry_head->etype) {
case NVME_PEL_SMART_HEALTH_EVENT:
Expand Down Expand Up @@ -574,11 +633,14 @@
case NVME_PEL_SANITIZE_MEDIA_VERIF_EVENT:
printf("Sanitize Media Verification Event\n");
break;
case NVME_PEL_VENDOR_SPECIFIC_EVENT:
pel_vendor_specific_event(pevent_log_info, offset, el - vsil);

Check failure on line 637 in nvme-print-stdout.c

View workflow job for this annotation

GitHub Actions / checkpatch review 

WARNING: line length of 86 exceeds 80 columns
break;
default:
printf("Reserved Event\n\n");
break;
}
offset += le16_to_cpu(pevent_entry_head->el);
offset += el;
printf("\n");
}
}
Expand Down