Skip to content

plugins/ocp: Prevent Seg Fault during OCP Data Area 1 and 2 Telemetry log Parsing #2996

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
Dec 5, 2025
Merged

plugins/ocp: Prevent Seg Fault during OCP Data Area 1 and 2 Telemetry log Parsing #2996

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
2 changes: 1 addition & 1 deletion plugins/ocp/ocp-nvme.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
#if !defined(OCP_NVME) || defined(CMD_HEADER_MULTI_READ)
#define OCP_NVME

#define OCP_PLUGIN_VERSION "2.15.3"
#define OCP_PLUGIN_VERSION "2.16.0"
#include "cmd.h"

PLUGIN(NAME("ocp", "OCP cloud SSD extensions", OCP_PLUGIN_VERSION),
Expand Down
108 changes: 68 additions & 40 deletions plugins/ocp/ocp-telemetry-decode.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -674,9 +674,12 @@
}

#ifdef CONFIG_JSONC
void parse_time_stamp_event(struct nvme_ocp_telemetry_event_descriptor *pevent_descriptor,
struct json_object *pevent_descriptor_obj, __u8 *pevent_specific_data,
struct json_object *pevent_fifos_object, FILE *fp)
int parse_time_stamp_event(
struct nvme_ocp_telemetry_event_descriptor *pevent_descriptor,
struct json_object *pevent_descriptor_obj,
__u8 *pevent_specific_data,
struct json_object *pevent_fifos_object,
FILE *fp)
{
struct nvme_ocp_time_stamp_dbg_evt_class_format *ptime_stamp_event =
(struct nvme_ocp_time_stamp_dbg_evt_class_format *) pevent_specific_data;
Expand Down Expand Up @@ -704,7 +707,8 @@
parse_ocp_telemetry_string_log(0, vu_event_id,
pevent_descriptor->debug_event_class_type,
VU_EVENT_STRING, description_str);
}
} else if (pevent_descriptor->event_data_size < 2)
return -1;

if (pevent_fifos_object != NULL) {
json_add_formatted_var_size_str(pevent_descriptor_obj, STR_CLASS_SPECIFIC_DATA,
Expand Down Expand Up @@ -736,11 +740,16 @@
}
}
}

return 0;
}

void parse_pcie_event(struct nvme_ocp_telemetry_event_descriptor *pevent_descriptor,
struct json_object *pevent_descriptor_obj, __u8 *pevent_specific_data,
struct json_object *pevent_fifos_object, FILE *fp)
int parse_pcie_event(
struct nvme_ocp_telemetry_event_descriptor *pevent_descriptor,
struct json_object *pevent_descriptor_obj,
__u8 *pevent_specific_data,
struct json_object *pevent_fifos_object,
FILE *fp)
{
struct nvme_ocp_pcie_dbg_evt_class_format *ppcie_event =
(struct nvme_ocp_pcie_dbg_evt_class_format *) pevent_specific_data;
Expand Down Expand Up @@ -768,7 +777,8 @@
parse_ocp_telemetry_string_log(0, vu_event_id,
pevent_descriptor->debug_event_class_type,
VU_EVENT_STRING, description_str);
}
} else if (pevent_descriptor->event_data_size < 1)
return -1;

if (pevent_fifos_object != NULL) {
json_add_formatted_var_size_str(pevent_descriptor_obj, STR_CLASS_SPECIFIC_DATA,
Expand Down Expand Up @@ -800,11 +810,16 @@
}
}
}

return 0;
}

void parse_nvme_event(struct nvme_ocp_telemetry_event_descriptor *pevent_descriptor,
struct json_object *pevent_descriptor_obj, __u8 *pevent_specific_data,
struct json_object *pevent_fifos_object, FILE *fp)
int parse_nvme_event(
struct nvme_ocp_telemetry_event_descriptor *pevent_descriptor,
struct json_object *pevent_descriptor_obj,
__u8 *pevent_specific_data,
struct json_object *pevent_fifos_object,
FILE *fp)
{
struct nvme_ocp_nvme_dbg_evt_class_format *pnvme_event =
(struct nvme_ocp_nvme_dbg_evt_class_format *) pevent_specific_data;
Expand Down Expand Up @@ -833,7 +848,8 @@
pevent_descriptor->debug_event_class_type,
VU_EVENT_STRING,
description_str);
}
} else if (pevent_descriptor->event_data_size < 2)
return -1;

if (pevent_fifos_object != NULL) {
json_add_formatted_var_size_str(pevent_descriptor_obj, STR_CLASS_SPECIFIC_DATA,
Expand Down Expand Up @@ -865,6 +881,8 @@
}
}
}

return 0;
}

void parse_common_event(struct nvme_ocp_telemetry_event_descriptor *pevent_descriptor,
Expand Down Expand Up @@ -907,9 +925,12 @@
}
}

void parse_media_wear_event(struct nvme_ocp_telemetry_event_descriptor *pevent_descriptor,
struct json_object *pevent_descriptor_obj, __u8 *pevent_specific_data,
struct json_object *pevent_fifos_object, FILE *fp)
int parse_media_wear_event(
struct nvme_ocp_telemetry_event_descriptor *pevent_descriptor,
struct json_object *pevent_descriptor_obj,
__u8 *pevent_specific_data,
struct json_object *pevent_fifos_object,
FILE *fp)
{
struct nvme_ocp_media_wear_dbg_evt_class_format *pmedia_wear_event =
(struct nvme_ocp_media_wear_dbg_evt_class_format *) pevent_specific_data;
Expand Down Expand Up @@ -939,7 +960,8 @@
pevent_descriptor->debug_event_class_type,
VU_EVENT_STRING,
description_str);
}
} else if (pevent_descriptor->event_data_size < 3)
return -1;

if (pevent_fifos_object != NULL) {
json_add_formatted_var_size_str(pevent_descriptor_obj, STR_CLASS_SPECIFIC_DATA,
Expand Down Expand Up @@ -971,6 +993,8 @@
}
}
}

return 0;
}

int parse_event_fifo(unsigned int fifo_num, unsigned char *pfifo_start,
Expand All @@ -982,7 +1006,7 @@
return -1;
}

int status = 0;
int status = 0, ret = 0;
unsigned int event_fifo_number = fifo_num + 1;
char *description = (char *)malloc((40 + 1) * sizeof(char));

Expand Down Expand Up @@ -1095,21 +1119,21 @@

switch (pevent_descriptor->debug_event_class_type) {
case TIME_STAMP_CLASS_TYPE:
parse_time_stamp_event(pevent_descriptor,
ret = parse_time_stamp_event(pevent_descriptor,
pevent_descriptor_obj,
pevent_specific_data,
pevent_fifos_object,
fp);
break;
case PCIE_CLASS_TYPE:
parse_pcie_event(pevent_descriptor,
ret = parse_pcie_event(pevent_descriptor,
pevent_descriptor_obj,
pevent_specific_data,
pevent_fifos_object,
fp);
break;
case NVME_CLASS_TYPE:
parse_nvme_event(pevent_descriptor,
ret = parse_nvme_event(pevent_descriptor,
pevent_descriptor_obj,
pevent_specific_data,
pevent_fifos_object,
Expand All @@ -1125,9 +1149,10 @@
pevent_specific_data,
pevent_fifos_object,
fp);
ret = 0;
break;
case MEDIA_WEAR_CLASS_TYPE:
parse_media_wear_event(pevent_descriptor,
ret = parse_media_wear_event(pevent_descriptor,
pevent_descriptor_obj,
pevent_specific_data,
pevent_fifos_object,
Expand All @@ -1138,6 +1163,20 @@
break;
}

if (ret) {
fprintf(stderr,
"ERROR : OCP : Invalid NVMe Event FIFO entry\n");
fprintf(stderr,
"FIFO: %d, offset: 0x%x\n",
fifo_num, offset_to_move);
fprintf(stderr,
"Type: 0x%x, ID: 0x%x, Size: 0x%x\n",
pevent_descriptor->debug_event_class_type,

Check failure on line 1174 in plugins/ocp/ocp-telemetry-decode.c

View workflow job for this annotation

GitHub Actions / checkpatch review 

WARNING: line length of 82 exceeds 80 columns
pevent_descriptor->event_id,
pevent_descriptor->event_data_size);
goto free_desc;
}

if (pevent_descriptor_obj != NULL && pevent_fifo_array != NULL)
json_array_add_value_object(pevent_fifo_array,
pevent_descriptor_obj);
Expand Down Expand Up @@ -1214,8 +1253,9 @@
json_object_add_value_array(pevent_fifos_object, event_fifo_name,
pevent_fifo_array);

free_desc:
free(description);
return 0;
return ret;
}

int parse_event_fifos(struct json_object *root, struct nvme_ocp_telemetry_offsets *poffsets,
Expand Down Expand Up @@ -1610,10 +1650,8 @@
fprintf(fp, "%s\n", STR_DA_1_EVENT_FIFO_INFO);
fprintf(fp, STR_LINE);
status = parse_event_fifos(NULL, &offsets, fp);
if (status != 0) {
nvme_show_error("status: %d\n", status);
if (status != 0)
return -1;
}

//Set the DA to 2
if (options->data_area == 2) {
Expand All @@ -1632,10 +1670,8 @@
fprintf(fp, "%s\n", STR_DA_2_EVENT_FIFO_INFO);
fprintf(fp, STR_LINE);
status = parse_event_fifos(NULL, &offsets, fp);
if (status != 0) {
nvme_show_error("status: %d\n", status);
if (status != 0)
return -1;
}
}

fprintf(fp, STR_LINE);
Expand Down Expand Up @@ -1719,10 +1755,8 @@
printf("%s\n", STR_DA_1_EVENT_FIFO_INFO);
printf(STR_LINE);
status = parse_event_fifos(NULL, &offsets, NULL);
if (status != 0) {
nvme_show_error("status: %d\n", status);
if (status != 0)
return -1;
}

//Set the DA to 2
if (options->data_area == 2) {
Expand All @@ -1740,10 +1774,8 @@
printf("%s\n", STR_DA_2_EVENT_FIFO_INFO);
printf(STR_LINE);
status = parse_event_fifos(NULL, &offsets, NULL);
if (status != 0) {
nvme_show_error("status: %d\n", status);
if (status != 0)
return -1;
}
}

printf(STR_LINE);
Expand Down Expand Up @@ -1826,10 +1858,8 @@

//Data Area 1 Event FIFOs
status = parse_event_fifos(root, &offsets, NULL);
if (status != 0) {
nvme_show_error("status: %d\n", status, NULL);
if (status != 0)
return -1;
}

if (options->data_area == 2) {
//Set the DA to 2
Expand All @@ -1843,10 +1873,8 @@

//Data Area 2 Event FIFOs
status = parse_event_fifos(root, &offsets, NULL);
if (status != 0) {
nvme_show_error("status: %d\n", status);
if (status != 0)
return -1;
}
}

if (options->output_file != NULL) {
Expand Down
44 changes: 28 additions & 16 deletions plugins/ocp/ocp-telemetry-decode.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1389,11 +1389,14 @@ int get_vu_event_id_ascii_string(int identifier, int debug_event_class, char *de
* @param pevent_fifos_object, event fifos json object pointer
* @param fp, input file pointer
*
* @return
* @return 0 success
*/
void parse_time_stamp_event(struct nvme_ocp_telemetry_event_descriptor *pevent_descriptor,
struct json_object *pevent_descriptor_obj, __u8 *pevent_specific_data,
struct json_object *pevent_fifos_object, FILE *fp);
int parse_time_stamp_event(
struct nvme_ocp_telemetry_event_descriptor *pevent_descriptor,
struct json_object *pevent_descriptor_obj,
__u8 *pevent_specific_data,
struct json_object *pevent_fifos_object,
FILE *fp);

/**
* @brief parses a pcie event fifo data to text or json formats
Expand All @@ -1404,11 +1407,14 @@ void parse_time_stamp_event(struct nvme_ocp_telemetry_event_descriptor *pevent_d
* @param pevent_fifos_object, event fifos json object pointer
* @param fp, input file pointer
*
* @return
* @return 0 success
*/
void parse_pcie_event(struct nvme_ocp_telemetry_event_descriptor *pevent_descriptor,
struct json_object *pevent_descriptor_obj, __u8 *pevent_specific_data,
struct json_object *pevent_fifos_object, FILE *fp);
int parse_pcie_event(
struct nvme_ocp_telemetry_event_descriptor *pevent_descriptor,
struct json_object *pevent_descriptor_obj,
__u8 *pevent_specific_data,
struct json_object *pevent_fifos_object,
FILE *fp);

/**
* @brief parses a nvme event fifo data to text or json formats
Expand All @@ -1419,11 +1425,14 @@ void parse_pcie_event(struct nvme_ocp_telemetry_event_descriptor *pevent_descrip
* @param pevent_fifos_object, event fifos json object pointer
* @param fp, input file pointer
*
* @return
* @return 0 success
*/
void parse_nvme_event(struct nvme_ocp_telemetry_event_descriptor *pevent_descriptor,
struct json_object *pevent_descriptor_obj, __u8 *pevent_specific_data,
struct json_object *pevent_fifos_object, FILE *fp);
int parse_nvme_event(
struct nvme_ocp_telemetry_event_descriptor *pevent_descriptor,
struct json_object *pevent_descriptor_obj,
__u8 *pevent_specific_data,
struct json_object *pevent_fifos_object,
FILE *fp);

/**
* @brief parses common event fifo data to text or json formats
Expand All @@ -1449,9 +1458,12 @@ void parse_common_event(struct nvme_ocp_telemetry_event_descriptor *pevent_descr
* @param pevent_fifos_object, event fifos json object pointer
* @param fp, input file pointer
*
* @return
* @return 0 success
*/
void parse_media_wear_event(struct nvme_ocp_telemetry_event_descriptor *pevent_descriptor,
struct json_object *pevent_descriptor_obj, __u8 *pevent_specific_data,
struct json_object *pevent_fifos_object, FILE *fp);
int parse_media_wear_event(
struct nvme_ocp_telemetry_event_descriptor *pevent_descriptor,
struct json_object *pevent_descriptor_obj,
__u8 *pevent_specific_data,
struct json_object *pevent_fifos_object,
FILE *fp);
#endif /* OCP_TELEMETRY_DECODE_H */