From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 54645A00C4; Mon, 25 Jul 2022 18:37:09 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 9845742B90; Mon, 25 Jul 2022 18:36:36 +0200 (CEST) Received: from mga09.intel.com (mga09.intel.com [134.134.136.24]) by mails.dpdk.org (Postfix) with ESMTP id 5BF8142B90 for ; Mon, 25 Jul 2022 18:36:35 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1658766995; x=1690302995; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=8l1EE9X+6YNZwhHtAXzkAYONZuImJwtH8hLQmxTo+5w=; b=QpBGcHeexOsijciFyA0tt29F+bZSwqt+SqwXEqkYChbfIb9QkUUbAmBK TYhHnWRL6QkVR8TDzjid9eOXsTgXBoPcTm0A4nf/eedaziY6WL+7lpTs4 V59WhnsovCND3Jsg3A+ze7C3kb6c2DrP958HLeLkAGOoSnIUiIlKYN8IU wH0ZBKwW0tIjZNqMnpI57qSQbPqX6X6coUuAHTfRi/MRIBrQzXkCoGdzr ModkD81t+o/MX0w0dwReH1TFoBmXVBWJS49rYkYjjT61yoCkX0vadmlwE QdNIOYKgICl8atlsw/cDwmgUqcaCJWTVa2d6HyC4Vx+NALTBuT/rZsp1X A==; X-IronPort-AV: E=McAfee;i="6400,9594,10419"; a="288499142" X-IronPort-AV: E=Sophos;i="5.93,193,1654585200"; d="scan'208";a="288499142" Received: from orsmga006.jf.intel.com ([10.7.209.51]) by orsmga102.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 25 Jul 2022 09:36:35 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.93,193,1654585200"; d="scan'208";a="575122764" Received: from silpixa00401385.ir.intel.com (HELO silpixa00401385.ger.corp.intel.com.) ([10.237.223.47]) by orsmga006.jf.intel.com with ESMTP; 25 Jul 2022 09:36:33 -0700 From: Bruce Richardson To: dev@dpdk.org Cc: Bruce Richardson , Ciara Power Subject: [PATCH v2 12/13] telemetry: eliminate duplicate code for json output Date: Mon, 25 Jul 2022 17:35:41 +0100 Message-Id: <20220725163543.875775-13-bruce.richardson@intel.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20220725163543.875775-1-bruce.richardson@intel.com> References: <20220623164245.561371-1-bruce.richardson@intel.com> <20220725163543.875775-1-bruce.richardson@intel.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org When preparing the json response to a telemetry socket query, the code for prefixing the command name, and appending the file "}" on the end of the response was duplicated for multiple reply types. Taking this code out of the switch statement reduces the duplication and makes the code more maintainable. For completeness of testing, add in a test case to validate the "null" response type - the only leg of the switch statment not already covered by an existing test case in the telemetry_data tests. Signed-off-by: Bruce Richardson --- app/test/test_telemetry_data.c | 7 +++++++ lib/telemetry/telemetry.c | 35 ++++++++++++---------------------- 2 files changed, 19 insertions(+), 23 deletions(-) diff --git a/app/test/test_telemetry_data.c b/app/test/test_telemetry_data.c index cfa4d636f0..d0fc78474e 100644 --- a/app/test/test_telemetry_data.c +++ b/app/test/test_telemetry_data.c @@ -93,6 +93,12 @@ check_output(const char *func_name, const char *expected) return strncmp(expected, buf, sizeof(buf)); } +static int +test_null_return(void) +{ + return CHECK_OUTPUT("null"); +} + static int test_simple_string(void) { @@ -419,6 +425,7 @@ telemetry_data_autotest(void) return -1; test_case test_cases[] = { + test_null_return, test_simple_string, test_case_array_string, test_case_array_int, test_case_array_u64, diff --git a/lib/telemetry/telemetry.c b/lib/telemetry/telemetry.c index 03651e947d..cf60d27bd4 100644 --- a/lib/telemetry/telemetry.c +++ b/lib/telemetry/telemetry.c @@ -233,27 +233,22 @@ output_json(const char *cmd, const struct rte_tel_data *d, int s) RTE_BUILD_BUG_ON(sizeof(out_buf) < MAX_CMD_LEN + RTE_TEL_MAX_SINGLE_STRING_LEN + 10); + + prefix_used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":", + MAX_CMD_LEN, cmd); + cb_data_buf = &out_buf[prefix_used]; + buf_len = sizeof(out_buf) - prefix_used - 1; /* space for '}' */ + switch (d->type) { case RTE_TEL_NULL: - used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":null}", - MAX_CMD_LEN, cmd ? cmd : "none"); + used = strlcpy(cb_data_buf, "null", buf_len); break; - case RTE_TEL_STRING: - prefix_used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":", - MAX_CMD_LEN, cmd); - cb_data_buf = &out_buf[prefix_used]; - buf_len = sizeof(out_buf) - prefix_used - 1; /* space for '}' */ + case RTE_TEL_STRING: used = rte_tel_json_str(cb_data_buf, buf_len, 0, d->data.str); - used += prefix_used; - used += strlcat(out_buf + used, "}", sizeof(out_buf) - used); break; - case RTE_TEL_DICT: - prefix_used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":", - MAX_CMD_LEN, cmd); - cb_data_buf = &out_buf[prefix_used]; - buf_len = sizeof(out_buf) - prefix_used - 1; /* space for '}' */ + case RTE_TEL_DICT: used = rte_tel_json_empty_obj(cb_data_buf, buf_len, 0); for (i = 0; i < d->data_len; i++) { const struct tel_dict_entry *v = &d->data.dict[i]; @@ -289,18 +284,12 @@ output_json(const char *cmd, const struct rte_tel_data *d, int s) } } } - used += prefix_used; - used += strlcat(out_buf + used, "}", sizeof(out_buf) - used); break; + case RTE_TEL_ARRAY_STRING: case RTE_TEL_ARRAY_INT: case RTE_TEL_ARRAY_U64: case RTE_TEL_ARRAY_CONTAINER: - prefix_used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":", - MAX_CMD_LEN, cmd); - cb_data_buf = &out_buf[prefix_used]; - buf_len = sizeof(out_buf) - prefix_used - 1; /* space for '}' */ - used = rte_tel_json_empty_array(cb_data_buf, buf_len, 0); for (i = 0; i < d->data_len; i++) if (d->type == RTE_TEL_ARRAY_STRING) @@ -328,10 +317,10 @@ output_json(const char *cmd, const struct rte_tel_data *d, int s) if (!rec_data->keep) rte_tel_data_free(rec_data->data); } - used += prefix_used; - used += strlcat(out_buf + used, "}", sizeof(out_buf) - used); break; } + used += prefix_used; + used += strlcat(out_buf + used, "}", sizeof(out_buf) - used); if (write(s, out_buf, used) < 0) perror("Error writing to socket"); } -- 2.34.1