Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/115380/?format=api
{ "id": 115380, "url": "http://patchwork.dpdk.org/api/patches/115380/?format=api", "web_url": "http://patchwork.dpdk.org/project/dpdk/patch/20220824162442.631456-4-kevin.laatz@intel.com/", "project": { "id": 1, "url": "http://patchwork.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": "<20220824162442.631456-4-kevin.laatz@intel.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20220824162442.631456-4-kevin.laatz@intel.com", "date": "2022-08-24T16:24:42", "name": "[v2,3/3] doc: add howto guide for lcore poll busyness", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": true, "hash": "14cdc94b83396023e6b58254f1cbf7d7e50e37c1", "submitter": { "id": 921, "url": "http://patchwork.dpdk.org/api/people/921/?format=api", "name": "Kevin Laatz", "email": "kevin.laatz@intel.com" }, "delegate": null, "mbox": "http://patchwork.dpdk.org/project/dpdk/patch/20220824162442.631456-4-kevin.laatz@intel.com/mbox/", "series": [ { "id": 24002, "url": "http://patchwork.dpdk.org/api/series/24002/?format=api", "web_url": "http://patchwork.dpdk.org/project/dpdk/list/?series=24002", "date": "2022-07-15T13:12:44", "name": "[v1,1/2] eal: add lcore busyness telemetry", "version": 1, "mbox": "http://patchwork.dpdk.org/series/24002/mbox/" } ], "comments": "http://patchwork.dpdk.org/api/patches/115380/comments/", "check": "fail", "checks": "http://patchwork.dpdk.org/api/patches/115380/checks/", "tags": {}, "related": [], "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 DA2A6A0543;\n\tWed, 24 Aug 2022 18:22:02 +0200 (CEST)", "from [217.70.189.124] (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id 7425A40DDE;\n\tWed, 24 Aug 2022 18:22:02 +0200 (CEST)", "from mga03.intel.com (mga03.intel.com [134.134.136.65])\n by mails.dpdk.org (Postfix) with ESMTP id 6B9554067B\n for <dev@dpdk.org>; Wed, 24 Aug 2022 18:22:01 +0200 (CEST)", "from fmsmga003.fm.intel.com ([10.253.24.29])\n by orsmga103.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384;\n 24 Aug 2022 09:21:55 -0700", "from silpixa00401122.ir.intel.com ([10.237.213.42])\n by FMSMGA003.fm.intel.com with ESMTP; 24 Aug 2022 09:21:53 -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=1661358121; x=1692894121;\n h=from:to:cc:subject:date:message-id:in-reply-to:\n references:mime-version:content-transfer-encoding;\n bh=CzZi+HjlAulJGNYdg6frUjBQkcK74Sy42zSNa22KgOY=;\n b=DKWqoP58TqAYhu5Q/RZGNxmq2DYzYxGsIg4NcnKUKX9NDELvzNQhuCY3\n PYg3ygewwPIAUqCc9fjiXjJRlbTqanuKpxgbSFjjY+/Jmx13UiVKoq1rz\n IjWrRfjEJ0+hKdlIo2AqZkYDo8DOh6dUBXVTRA7DWpVTHjr90OqD7oRIU\n fSRtgn7Pkz5jrKV0qXRpsYUG6YJW/DCuMK4d1QKlB/oiV6wVcbYIFrD3+\n voeBz9y7VO84jcamt6YuB2Muk7dVO7NLByuZmY48N2dcq6HHO0FrZALsR\n 9exCqlKZHVkbZm9UwuIHI0R9Cy1wUyNYu99Sc4S8td4ahzbN1EKZO9Ysz A==;", "X-IronPort-AV": [ "E=McAfee;i=\"6500,9779,10449\"; a=\"295291916\"", "E=Sophos;i=\"5.93,260,1654585200\"; d=\"scan'208\";a=\"295291916\"", "E=Sophos;i=\"5.93,260,1654585200\"; d=\"scan'208\";a=\"699128531\"" ], "X-ExtLoop1": "1", "From": "Kevin Laatz <kevin.laatz@intel.com>", "To": "dev@dpdk.org", "Cc": "anatoly.burakov@intel.com,\n\tKevin Laatz <kevin.laatz@intel.com>", "Subject": "[PATCH v2 3/3] doc: add howto guide for lcore poll busyness", "Date": "Wed, 24 Aug 2022 17:24:42 +0100", "Message-Id": "<20220824162442.631456-4-kevin.laatz@intel.com>", "X-Mailer": "git-send-email 2.31.1", "In-Reply-To": "<20220824162442.631456-1-kevin.laatz@intel.com>", "References": "\n <24c49429394294cfbf0d9c506b205029bac77c8b.1657890378.git.anatoly.burakov@intel.com>\n <20220824162442.631456-1-kevin.laatz@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 <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": "Add a new section to the howto guides for using the new lcore poll\nbusyness telemetry endpoints and describe general usage.\n\nSigned-off-by: Kevin Laatz <kevin.laatz@intel.com>\n---\n doc/guides/howto/lcore_busyness.rst | 79 +++++++++++++++++++++++++++++\n 1 file changed, 79 insertions(+)\n create mode 100644 doc/guides/howto/lcore_busyness.rst", "diff": "diff --git a/doc/guides/howto/lcore_busyness.rst b/doc/guides/howto/lcore_busyness.rst\nnew file mode 100644\nindex 0000000000..c8ccd3f513\n--- /dev/null\n+++ b/doc/guides/howto/lcore_busyness.rst\n@@ -0,0 +1,79 @@\n+.. SPDX-License-Identifier: BSD-3-Clause\n+ Copyright(c) 2022 Intel Corporation.\n+\n+Lcore Poll Busyness Telemetry\n+========================\n+\n+The lcore poll busyness telemetry provides a built-in, generic method of gathering\n+lcore utilization metrics for running applications. These metrics are exposed\n+via a new telemetry endpoint.\n+\n+Since most DPDK APIs poll for packets, the poll busyness is calculated based on\n+APIs receiving packets. Empty polls are considered as idle, while non-empty polls\n+are considered busy. Using the amount of cycles spent processing empty polls, the\n+busyness can be calculated and recorded.\n+\n+Application Specified Busyness\n+------------------------------\n+\n+Improved accuracy of the reported busyness may need more contextual awareness\n+from the application. For example, a pipelined application may make a number of\n+calls to rx_burst before processing packets. Any processing done on this 'bulk'\n+would need to be marked as \"busy\" cycles, not just the last received burst. This\n+type of awareness is only available within the application.\n+\n+Applications can be modified to incorporate the extra contextual awareness in\n+order to improve the reported busyness by marking areas of code as \"busy\" or\n+\"idle\" appropriately. This can be done by inserting the timestamping macro::\n+\n+ RTE_LCORE_TELEMETRY_TIMESTAMP(0) /* to mark section as idle */\n+ RTE_LCORE_TELEMETRY_TIMESTAMP(32) /* where 32 is nb_pkts to mark section as busy (non-zero is busy) */\n+\n+All cycles since the last state change will be counted towards the current state's\n+counter.\n+\n+Consuming the Telemetry\n+-----------------------\n+\n+The telemetry gathered for lcore poll busyness can be read from the `telemetry.py`\n+script via the new `/eal/lcore/poll_busyness` endpoint::\n+\n+ $ ./usertools/dpdk-telemetry.py\n+ --> /eal/lcore/poll_busyness\n+ {\"/eal/lcore/poll_busyness\": {\"12\": -1, \"13\": 85, \"14\": 84}}\n+\n+* Cores not collecting busyness will report \"-1\". E.g. control cores or inactive cores.\n+* All enabled cores will report their busyness in the range 0-100.\n+\n+Disabling Lcore Poll Busyness Telemetry\n+----------------------------------\n+\n+Some applications may not want lcore poll busyness telemetry to be tracked, for\n+example performance critical applications or applications that are already being\n+monitored by other tools gathering similar or more application specific information.\n+\n+For those applications, there are two ways in which this telemetry can be disabled.\n+\n+At compile time\n+^^^^^^^^^^^^^^^\n+\n+Support can be disabled at compile time via the meson option. It is enabled by\n+default.::\n+\n+ $ meson configure -Denable_lcore_poll_busyness=false\n+\n+At run time\n+^^^^^^^^^^^\n+\n+Support can also be disabled during runtime. This comes at the cost of an\n+additional branch, however no additional function calls are performed.\n+\n+To disable support at runtime, a call can be made to the\n+`/eal/lcore/poll_busyness_disable` endpoint::\n+\n+ $ ./usertools/dpdk-telemetry.py\n+ --> /eal/lcore/poll_busyness_disable\n+ {\"/eal/lcore/poll_busyness_disable\": {\"busyness_enabled\": 0}}\n+\n+It can be re-enabled at run time with the `/eal/lcore/poll_busyness_enable`\n+endpoint.\n", "prefixes": [ "v2", "3/3" ] }