From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: <dev-bounces@dpdk.org> Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id D4FD3A0093; Thu, 23 Jun 2022 18:43:00 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 7761C4067B; Thu, 23 Jun 2022 18:43:00 +0200 (CEST) Received: from mga12.intel.com (mga12.intel.com [192.55.52.136]) by mails.dpdk.org (Postfix) with ESMTP id A76FC40146 for <dev@dpdk.org>; Thu, 23 Jun 2022 18:42:58 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1656002578; x=1687538578; h=from:to:cc:subject:date:message-id:mime-version: content-transfer-encoding; bh=V0pAORNgNQMChPn+RoVFDNUp7/WM3Ly24hT2VKutCUs=; b=lSyfyTN+QvqSu6K1Wp2Q0PxNOUJojizy7Hb6CLOysomgusyQr1y0RX45 L85rx9cYY52TTluB0EiT2J4UhKp/YvIwJc00Fh6hDZZej3n+3xGL0wy4L LS+rbxSczxoGRzOOqyzLdnAjxZ5bz+v0uUZ0uG37dT6g5ps0yyij0+FcR kkqFbJDdJJcJbVrUOVFFZgLVSbPjJgcf2YRkzxLmQITgl/SQout843O9F /r8P6o+HSuIknUNG25sHXa7+LbrkNqCoFpIM9XiMX2jGBaxJXjdYRHqBY b+rw9UHHOt/QlYCIgbExzDwD/DduPosyubwdveaZWw353oV8opi6Y873Q A==; X-IronPort-AV: E=McAfee;i="6400,9594,10386"; a="260589061" X-IronPort-AV: E=Sophos;i="5.92,216,1650956400"; d="scan'208";a="260589061" Received: from fmsmga005.fm.intel.com ([10.253.24.32]) by fmsmga106.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 23 Jun 2022 09:42:56 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.92,216,1650956400"; d="scan'208";a="915267922" Received: from silpixa00401385.ir.intel.com (HELO silpixa00401385.ger.corp.intel.com.) ([10.237.223.125]) by fmsmga005.fm.intel.com with ESMTP; 23 Jun 2022 09:42:55 -0700 From: Bruce Richardson <bruce.richardson@intel.com> To: dev@dpdk.org Cc: ciara.power@intel.com, fengchengwen@huawei.com, mb@smartsharesystems.com, Bruce Richardson <bruce.richardson@intel.com> Subject: [RFC PATCH 0/6] add json string escaping to telemetry Date: Thu, 23 Jun 2022 17:42:39 +0100 Message-Id: <20220623164245.561371-1-bruce.richardson@intel.com> X-Mailer: git-send-email 2.34.1 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 <dev.dpdk.org> List-Unsubscribe: <https://mails.dpdk.org/options/dev>, <mailto:dev-request@dpdk.org?subject=unsubscribe> List-Archive: <http://mails.dpdk.org/archives/dev/> List-Post: <mailto:dev@dpdk.org> List-Help: <mailto:dev-request@dpdk.org?subject=help> List-Subscribe: <https://mails.dpdk.org/listinfo/dev>, <mailto:dev-request@dpdk.org?subject=subscribe> Errors-To: dev-bounces@dpdk.org This RFC shows one possible approach for escaping strings for the json output of telemetry library. For now this RFC supports escaping strings for the cases of returning a single string, or returning an array of strings. Not done is escaping of strings in objs/dicts [see more below on TODO] As well as telemetry lib changes, this patchset includes unit tests for the above and also little bit of cleanup to the json tests. TODO: Beyond what is here in this RFC: 1. we need to decide what to do about name/value pairs. Personally, I think we should add the restriction to the "rte_tel_data_add_obj_*" APIs to only allow a defined subset of characters in names: e.g. alphanumeric chars, underscore and dash. That means that we only need to escape the data part in the case of string returns. 2. once agreed, need to implement a patch to escape strings in dicts/objs 3. need to add a patch to escape the input command if it contains invalid chars 4. some small refactoring of the main telemetry.c json-encoding function may be possible. Bruce Richardson (6): test/telemetry_json: print success or failure per subtest telemetry: fix escaping of invalid json characters telemetry: use json string function for string outputs test/telemetry_json: add test for string character escaping telemetry: add escaping of strings in arrays test/telemetry-json: add test case for escaping strings in arrays app/test/test_telemetry_json.c | 74 +++++++++++++++++++++++++++++----- lib/telemetry/telemetry.c | 11 +++-- lib/telemetry/telemetry_json.h | 62 ++++++++++++++++++++++++++-- 3 files changed, 132 insertions(+), 15 deletions(-) -- 2.34.1