plugins/solidigm: Added wildcard and filters to telemetry parsing.

Added support to jq filter directly in configuration file.
Added wildcard support for Telemetry Object version.

Signed-off-by: Leonardo da Cunha <[email protected]>

Author: lgdacunh

plugins/solidigm/solidigm-nvme.h

@@ -13,7 +13,7 @@
 
 #include "cmd.h"
 
-#define SOLIDIGM_PLUGIN_VERSION "1.16"
+#define SOLIDIGM_PLUGIN_VERSION "1.17"
 
 PLUGIN(NAME("solidigm", "Solidigm vendor specific extensions", SOLIDIGM_PLUGIN_VERSION),
 	COMMAND_LIST(

plugins/solidigm/solidigm-telemetry.c

@@ -52,6 +52,7 @@ struct config {
 	int  data_area;
 	char *cfg_file;
 	char *binary_file;
+	char *jq_filter;
 };
 
 static void cleanup_json_object(struct json_object **jobj_ptr)
@@ -68,6 +69,7 @@ int solidigm_get_telemetry_log(int argc, char **argv, struct command *acmd, stru
 	const char *dgen = "Pick which telemetry data area to report. Default is 3 to fetch areas 1-3. Valid options are 1, 2, 3, 4.";
 	const char *cfile = "JSON configuration file";
 	const char *sfile = "binary file containing log dump";
+	const char *jqfilt = "JSON config entry name containing jq filter";
 	bool has_binary_file = false;
 	_cleanup_nvme_global_ctx_ struct nvme_global_ctx *ctx = NULL;
 	_cleanup_nvme_transport_handle_ struct nvme_transport_handle *hdl = NULL;
@@ -93,6 +95,7 @@ int solidigm_get_telemetry_log(int argc, char **argv, struct command *acmd, stru
 		OPT_UINT("data-area",       'd', &cfg.data_area, dgen),
 		OPT_FILE("config-file",     'j', &cfg.cfg_file, cfile),
 		OPT_FILE("source-file",     's', &cfg.binary_file, sfile),
+		OPT_STR("jq-filter",        'q', &cfg.jq_filter, jqfilt),
 		OPT_INCR("verbose",         'v', &nvme_cfg.verbose, verbose),
 		OPT_END()
 	};
@@ -144,19 +147,14 @@ int solidigm_get_telemetry_log(int argc, char **argv, struct command *acmd, stru
 			nvme_show_status(err);
 			return err;
 		}
-		struct json_tokener *jstok = json_tokener_new();
-
-		configuration = json_tokener_parse_ex(jstok, conf_str, length);
-		if (jstok->err != json_tokener_success)	{
-			SOLIDIGM_LOG_WARNING("Parsing error on JSON configuration file %s: %s (at offset %d)",
-					     cfg.cfg_file,
-					     json_tokener_error_desc(jstok->err),
-					     jstok->char_offset);
-			json_tokener_free(jstok);
+		configuration = json_tokener_parse(conf_str);
+		if (!configuration) {
+			SOLIDIGM_LOG_WARNING(
+				"Failed to parse JSON configuration file %s",
+				cfg.cfg_file);
 			err = EINVAL;
 			return err;
 		}
-		json_tokener_free(jstok);
 		tl.configuration = configuration;
 	}
 
@@ -196,7 +194,56 @@ int solidigm_get_telemetry_log(int argc, char **argv, struct command *acmd, stru
 	tl.log = tlog;
 	solidigm_telemetry_log_data_areas_parse(&tl, cfg.data_area);
 
-	json_print_object(tl.root, NULL);
+	/* Check if jq filter is requested and available */
+	if (cfg.jq_filter && configuration) {
+		struct json_object *jq_filter_obj = NULL;
+
+		if (json_object_object_get_ex(configuration, cfg.jq_filter,
+					      &jq_filter_obj)) {
+			const char *jq_filter_str;
+
+			jq_filter_str = json_object_get_string(jq_filter_obj);
+			if (jq_filter_str) {
+				/* Get JSON string representation */
+				const char *json_str;
+				char cmd[1024];
+				FILE *jq_pipe;
+
+				json_str = json_object_to_json_string(tl.root);
+
+				/* Create jq command and pipe JSON through it */
+				snprintf(cmd, sizeof(cmd), "jq -r '%s'",
+					 jq_filter_str);
+				jq_pipe = popen(cmd, "w");
+				if (jq_pipe) {
+					fprintf(jq_pipe, "%s", json_str);
+					err = pclose(jq_pipe);
+					if (err != 0)
+						err = -EINVAL;
+				} else {
+					SOLIDIGM_LOG_WARNING(
+						"Failed to execute jq command");
+					err = -ENOENT;
+				}
+			} else {
+				SOLIDIGM_LOG_WARNING(
+					"jq filter entry '%s' is not a valid string",
+					cfg.jq_filter);
+				err = -EINVAL;
+			}
+		} else {
+			SOLIDIGM_LOG_WARNING(
+				"jq filter entry '%s' not found in configuration file",
+				cfg.jq_filter);
+			err = -ENOENT;
+		}
+	} else {
+		/*
+		 * No jq filter requested or no config file,
+		 * use normal JSON output
+		 */
+		json_print_object(tl.root, NULL);
+	}
 	printf("\n");
 
 	return err;

plugins/solidigm/solidigm-telemetry/config.c

@@ -9,6 +9,7 @@
 #include <string.h>
 #include <stdbool.h>
 #include <json.h>
+#include <stdint.h>
 #include "config.h"
 
 // max 16 bit unsigned integer number 65535
@@ -27,11 +28,29 @@ static bool config_get_by_version(const struct json_object *obj, int version_maj
 	snprintf(str_subkey, sizeof(str_subkey), "%d", version_minor);
 	struct json_object *major_obj = NULL;
 
-	if (!json_object_object_get_ex(obj, str_key, &major_obj))
-		return false;
-	if (!json_object_object_get_ex(major_obj, str_subkey, value))
-		return false;
-	return value != NULL;
+	/* Try exact major version match first */
+	if (json_object_object_get_ex(obj, str_key, &major_obj)) {
+		/* Try exact minor version match first */
+		if (json_object_object_get_ex(major_obj, str_subkey, value))
+			return value != NULL;
+
+		/* Try wildcard minor version if exact match failed */
+		if (json_object_object_get_ex(major_obj, "*", value))
+			return value != NULL;
+	}
+
+	/* Try wildcard major version if exact major version not found */
+	if (json_object_object_get_ex(obj, "*", &major_obj)) {
+		/* Try exact minor version match */
+		if (json_object_object_get_ex(major_obj, str_subkey, value))
+			return value != NULL;
+
+		/* Try wildcard minor version */
+		if (json_object_object_get_ex(major_obj, "*", value))
+			return value != NULL;
+	}
+
+	return false;
 }
 
 bool sldm_config_get_struct_by_key_version(const struct json_object *config, char *key,