Cover Detail
Show a cover letter.
GET /api/covers/113353/?format=api
{ "id": 113353, "url": "http://patches.dpdk.org/api/covers/113353/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/cover/20220623164245.561371-1-bruce.richardson@intel.com/", "project": { "id": 1, "url": "http://patches.dpdk.org/api/projects/1/?format=api", "name": "DPDK", "link_name": "dpdk", "list_id": "dev.dpdk.org", "list_email": "dev@dpdk.org", "web_url": "http://core.dpdk.org", "scm_url": "git://dpdk.org/dpdk", "webscm_url": "http://git.dpdk.org/dpdk", "list_archive_url": "https://inbox.dpdk.org/dev", "list_archive_url_format": "https://inbox.dpdk.org/dev/{}", "commit_url_format": "" }, "msgid": "<20220623164245.561371-1-bruce.richardson@intel.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20220623164245.561371-1-bruce.richardson@intel.com", "date": "2022-06-23T16:42:39", "name": "[RFC,0/6] add json string escaping to telemetry", "submitter": { "id": 20, "url": "http://patches.dpdk.org/api/people/20/?format=api", "name": "Bruce Richardson", "email": "bruce.richardson@intel.com" }, "mbox": "http://patches.dpdk.org/project/dpdk/cover/20220623164245.561371-1-bruce.richardson@intel.com/mbox/", "series": [ { "id": 23739, "url": "http://patches.dpdk.org/api/series/23739/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=23739", "date": "2022-06-23T16:42:39", "name": "add json string escaping to telemetry", "version": 1, "mbox": "http://patches.dpdk.org/series/23739/mbox/" } ], "comments": "http://patches.dpdk.org/api/covers/113353/comments/", "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@inbox.dpdk.org", "Delivered-To": "patchwork@inbox.dpdk.org", "Received": [ "from mails.dpdk.org (mails.dpdk.org [217.70.189.124])\n\tby inbox.dpdk.org (Postfix) with ESMTP id D4FD3A0093;\n\tThu, 23 Jun 2022 18:43:00 +0200 (CEST)", "from [217.70.189.124] (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id 7761C4067B;\n\tThu, 23 Jun 2022 18:43:00 +0200 (CEST)", "from mga12.intel.com (mga12.intel.com [192.55.52.136])\n by mails.dpdk.org (Postfix) with ESMTP id A76FC40146\n for <dev@dpdk.org>; Thu, 23 Jun 2022 18:42:58 +0200 (CEST)", "from fmsmga005.fm.intel.com ([10.253.24.32])\n by fmsmga106.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384;\n 23 Jun 2022 09:42:56 -0700", "from silpixa00401385.ir.intel.com (HELO\n silpixa00401385.ger.corp.intel.com.) ([10.237.223.125])\n by fmsmga005.fm.intel.com with ESMTP; 23 Jun 2022 09:42:55 -0700" ], "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/simple;\n d=intel.com; i=@intel.com; q=dns/txt; s=Intel;\n t=1656002578; x=1687538578;\n h=from:to:cc:subject:date:message-id:mime-version:\n content-transfer-encoding;\n bh=V0pAORNgNQMChPn+RoVFDNUp7/WM3Ly24hT2VKutCUs=;\n b=lSyfyTN+QvqSu6K1Wp2Q0PxNOUJojizy7Hb6CLOysomgusyQr1y0RX45\n L85rx9cYY52TTluB0EiT2J4UhKp/YvIwJc00Fh6hDZZej3n+3xGL0wy4L\n LS+rbxSczxoGRzOOqyzLdnAjxZ5bz+v0uUZ0uG37dT6g5ps0yyij0+FcR\n kkqFbJDdJJcJbVrUOVFFZgLVSbPjJgcf2YRkzxLmQITgl/SQout843O9F\n /r8P6o+HSuIknUNG25sHXa7+LbrkNqCoFpIM9XiMX2jGBaxJXjdYRHqBY\n b+rw9UHHOt/QlYCIgbExzDwD/DduPosyubwdveaZWw353oV8opi6Y873Q A==;", "X-IronPort-AV": [ "E=McAfee;i=\"6400,9594,10386\"; a=\"260589061\"", "E=Sophos;i=\"5.92,216,1650956400\"; d=\"scan'208\";a=\"260589061\"", "E=Sophos;i=\"5.92,216,1650956400\"; d=\"scan'208\";a=\"915267922\"" ], "X-ExtLoop1": "1", "From": "Bruce Richardson <bruce.richardson@intel.com>", "To": "dev@dpdk.org", "Cc": "ciara.power@intel.com, fengchengwen@huawei.com, mb@smartsharesystems.com,\n 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>,\n <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>,\n <mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org" }, "content": "This RFC shows one possible approach for escaping strings for the json\noutput of telemetry library. For now this RFC supports escaping strings\nfor the cases of returning a single string, or returning an array of\nstrings. Not done is escaping of strings in objs/dicts [see more below\non TODO]\n\nAs well as telemetry lib changes, this patchset includes unit tests for\nthe above and also little bit of cleanup to the json tests.\n\nTODO:\nBeyond what is here in this RFC:\n\n1. we need to decide what to do about name/value pairs. Personally, I\n think we should add the restriction to the \"rte_tel_data_add_obj_*\" APIs\n to only allow a defined subset of characters in names: e.g. alphanumeric\n chars, underscore and dash. That means that we only need to escape\n the data part in the case of string returns.\n\n2. once agreed, need to implement a patch to escape strings in\n dicts/objs\n\n3. need to add a patch to escape the input command if it contains\n invalid chars\n\n4. some small refactoring of the main telemetry.c json-encoding function\n may be possible.\n\nBruce Richardson (6):\n test/telemetry_json: print success or failure per subtest\n telemetry: fix escaping of invalid json characters\n telemetry: use json string function for string outputs\n test/telemetry_json: add test for string character escaping\n telemetry: add escaping of strings in arrays\n test/telemetry-json: add test case for escaping strings in arrays\n\n app/test/test_telemetry_json.c | 74 +++++++++++++++++++++++++++++-----\n lib/telemetry/telemetry.c | 11 +++--\n lib/telemetry/telemetry_json.h | 62 ++++++++++++++++++++++++++--\n 3 files changed, 132 insertions(+), 15 deletions(-)\n\n--\n2.34.1" }