Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/47512/?format=api
{ "id": 47512, "url": "https://patches.dpdk.org/api/patches/47512/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/patch/20181027091750.17254-4-harry.van.haaren@intel.com/", "project": { "id": 1, "url": "https://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": "<20181027091750.17254-4-harry.van.haaren@intel.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20181027091750.17254-4-harry.van.haaren@intel.com", "date": "2018-10-27T09:17:41", "name": "[v10,03/12] telemetry: initial telemetry infrastructure", "commit_ref": null, "pull_url": null, "state": "accepted", "archived": true, "hash": "dc32d5f557ab83691448b568815037a846ede066", "submitter": { "id": 317, "url": "https://patches.dpdk.org/api/people/317/?format=api", "name": "Van Haaren, Harry", "email": "harry.van.haaren@intel.com" }, "delegate": null, "mbox": "https://patches.dpdk.org/project/dpdk/patch/20181027091750.17254-4-harry.van.haaren@intel.com/mbox/", "series": [ { "id": 2132, "url": "https://patches.dpdk.org/api/series/2132/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/list/?series=2132", "date": "2018-10-27T09:17:38", "name": "Introduce Telemetry Library", "version": 10, "mbox": "https://patches.dpdk.org/series/2132/mbox/" } ], "comments": "https://patches.dpdk.org/api/patches/47512/comments/", "check": "success", "checks": "https://patches.dpdk.org/api/patches/47512/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@dpdk.org", "Delivered-To": "patchwork@dpdk.org", "Received": [ "from [92.243.14.124] (localhost [127.0.0.1])\n\tby dpdk.org (Postfix) with ESMTP id 09AEC532C;\n\tSat, 27 Oct 2018 11:19:44 +0200 (CEST)", "from mga18.intel.com (mga18.intel.com [134.134.136.126])\n\tby dpdk.org (Postfix) with ESMTP id 00BF34C8C\n\tfor <dev@dpdk.org>; Sat, 27 Oct 2018 11:19:30 +0200 (CEST)", "from orsmga008.jf.intel.com ([10.7.209.65])\n\tby orsmga106.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384;\n\t27 Oct 2018 02:19:30 -0700", "from silpixa00399779.ir.intel.com (HELO\n\tsilpixa00399779.ger.corp.intel.com) ([10.237.223.188])\n\tby orsmga008.jf.intel.com with ESMTP; 27 Oct 2018 02:19:28 -0700" ], "X-Amp-Result": "SKIPPED(no attachment in message)", "X-Amp-File-Uploaded": "False", "X-ExtLoop1": "1", "X-IronPort-AV": "E=Sophos;i=\"5.54,431,1534834800\"; d=\"scan'208\";a=\"84903873\"", "From": "Harry van Haaren <harry.van.haaren@intel.com>", "To": "dev@dpdk.org", "Cc": "thomas@monjalon.net, bruce.richardson@intel.com,\n\tstephen@networkplumber.org, gaetan.rivet@6wind.com,\n\tshreyansh.jain@nxp.com, \n\tmattias.ronnblom@ericsson.com, Ciara Power <ciara.power@intel.com>,\n\tBrian Archbold <brian.archbold@intel.com>,\n\tKevin Laatz <kevin.laatz@intel.com>,\n\tRadu Nicolau <radu.nicolau@intel.com>", "Date": "Sat, 27 Oct 2018 10:17:41 +0100", "Message-Id": "<20181027091750.17254-4-harry.van.haaren@intel.com>", "X-Mailer": "git-send-email 2.17.1", "In-Reply-To": "<20181027091750.17254-1-harry.van.haaren@intel.com>", "References": "<20181026235933.79779-1-harry.van.haaren@intel.com>\n\t<20181027091750.17254-1-harry.van.haaren@intel.com>", "Subject": "[dpdk-dev] [PATCH v10 03/12] telemetry: initial telemetry\n\tinfrastructure", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.15", "Precedence": "list", "List-Id": "DPDK patches and discussions <dev.dpdk.org>", "List-Unsubscribe": "<https://mails.dpdk.org/options/dev>,\n\t<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\t<mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org", "Sender": "\"dev\" <dev-bounces@dpdk.org>" }, "content": "From: Ciara Power <ciara.power@intel.com>\n\nThis patch adds the infrastructure and initial code for the telemetry\nlibrary.\n\nThe telemetry init is registered with eal_init(). We can then check to see\nif --telemetry was passed as an eal option. If --telemetry was parsed, then\nwe call telemetry init at the end of eal init.\n\nControl threads are used to get CPU cycles for telemetry, which are\nconfigured in this patch also.\n\nSigned-off-by: Ciara Power <ciara.power@intel.com>\nSigned-off-by: Brian Archbold <brian.archbold@intel.com>\nSigned-off-by: Kevin Laatz <kevin.laatz@intel.com>\nSigned-off-by: Radu Nicolau <radu.nicolau@intel.com>\nAcked-by: Harry van Haaren <harry.van.haaren@intel.com>\n\n---\n\nv10:\n - change position of Telemetry in index Doxygen index (Thomas)\n - Add MAINTAINER file entry for lib/telemetry files (Thomas)\n - Removed -ljansson from mk/rte.app.mk (Thomas)\n - Removed pkg-config jansson check in mk/rte.vars.mk (Thomas)\n - Set CONFIG_TELEMETRY=N by default (Thomas)\n---\n MAINTAINERS | 3 +\n config/common_base | 5 +\n doc/api/doxy-api-index.md | 1 +\n doc/api/doxy-api.conf.in | 1 +\n lib/Makefile | 2 +\n lib/librte_telemetry/Makefile | 27 ++++\n lib/librte_telemetry/meson.build | 7 +\n lib/librte_telemetry/rte_telemetry.c | 123 ++++++++++++++++++\n lib/librte_telemetry/rte_telemetry.h | 51 ++++++++\n lib/librte_telemetry/rte_telemetry_internal.h | 32 +++++\n .../rte_telemetry_version.map | 8 ++\n lib/meson.build | 2 +-\n mk/rte.app.mk | 3 +-\n 13 files changed, 263 insertions(+), 2 deletions(-)\n create mode 100644 lib/librte_telemetry/Makefile\n create mode 100644 lib/librte_telemetry/meson.build\n create mode 100644 lib/librte_telemetry/rte_telemetry.c\n create mode 100644 lib/librte_telemetry/rte_telemetry.h\n create mode 100644 lib/librte_telemetry/rte_telemetry_internal.h\n create mode 100644 lib/librte_telemetry/rte_telemetry_version.map", "diff": "diff --git a/MAINTAINERS b/MAINTAINERS\nindex 17ee5b9d3..a50214d7a 100644\n--- a/MAINTAINERS\n+++ b/MAINTAINERS\n@@ -1208,6 +1208,9 @@ F: test/bpf/\n F: test/test/test_bpf.c\n F: doc/guides/prog_guide/bpf_lib.rst\n \n+Telemetry - EXPERIMENTAL\n+M: Kevin Laatz <kevin.laatz@intel.com>\n+F: lib/librte_telemetry/\n \n Test Applications\n -----------------\ndiff --git a/config/common_base b/config/common_base\nindex 38beaabb3..4ba8f651d 100644\n--- a/config/common_base\n+++ b/config/common_base\n@@ -756,6 +756,11 @@ CONFIG_RTE_LIBRTE_CMDLINE_DEBUG=n\n CONFIG_RTE_LIBRTE_HASH=y\n CONFIG_RTE_LIBRTE_HASH_DEBUG=n\n \n+#\n+# Compile librte_telemetry\n+#\n+CONFIG_RTE_LIBRTE_TELEMETRY=n\n+\n #\n # Compile librte_efd\n #\ndiff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md\nindex a3039d168..cd2b7e413 100644\n--- a/doc/api/doxy-api-index.md\n+++ b/doc/api/doxy-api-index.md\n@@ -29,6 +29,7 @@ The public API headers are grouped by topics:\n [metrics] (@ref rte_metrics.h),\n [bitrate] (@ref rte_bitrate.h),\n [latency] (@ref rte_latencystats.h),\n+ [telemetry] (@ref rte_telemetry.h),\n [devargs] (@ref rte_devargs.h),\n [PCI] (@ref rte_pci.h),\n [vfio] (@ref rte_vfio.h)\ndiff --git a/doc/api/doxy-api.conf.in b/doc/api/doxy-api.conf.in\nindex 3b652ac9c..77ba327a8 100644\n--- a/doc/api/doxy-api.conf.in\n+++ b/doc/api/doxy-api.conf.in\n@@ -56,6 +56,7 @@ INPUT = @TOPDIR@/doc/api/doxy-api-index.md \\\n @TOPDIR@/lib/librte_sched \\\n @TOPDIR@/lib/librte_security \\\n @TOPDIR@/lib/librte_table \\\n+ @TOPDIR@/lib/librte_telemetry \\\n @TOPDIR@/lib/librte_timer \\\n @TOPDIR@/lib/librte_vhost\n INPUT += @API_EXAMPLES@\ndiff --git a/lib/Makefile b/lib/Makefile\nindex 062cbdfd7..b7370ef97 100644\n--- a/lib/Makefile\n+++ b/lib/Makefile\n@@ -106,6 +106,8 @@ DEPDIRS-librte_gso := librte_eal librte_mbuf librte_ethdev librte_net\n DEPDIRS-librte_gso += librte_mempool\n DIRS-$(CONFIG_RTE_LIBRTE_BPF) += librte_bpf\n DEPDIRS-librte_bpf := librte_eal librte_mempool librte_mbuf librte_ethdev\n+DIRS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += librte_telemetry\n+DEPDIRS-librte_telemetry := librte_eal librte_metrics librte_ethdev\n \n ifeq ($(CONFIG_RTE_EXEC_ENV_LINUXAPP),y)\n DIRS-$(CONFIG_RTE_LIBRTE_KNI) += librte_kni\ndiff --git a/lib/librte_telemetry/Makefile b/lib/librte_telemetry/Makefile\nnew file mode 100644\nindex 000000000..a2d4ff166\n--- /dev/null\n+++ b/lib/librte_telemetry/Makefile\n@@ -0,0 +1,27 @@\n+# SPDX-License-Identifier: BSD-3-Clause\n+# Copyright(c) 2018 Intel Corporation\n+\n+include $(RTE_SDK)/mk/rte.vars.mk\n+\n+# library name\n+LIB = librte_telemetry.a\n+\n+CFLAGS += -O3\n+CFLAGS += -I$(SRCDIR)\n+CFLAGS += -DALLOW_EXPERIMENTAL_API\n+\n+LDLIBS += -lrte_eal -lrte_ethdev\n+LDLIBS += -lrte_metrics\n+LDLIBS += -lpthread\n+\n+EXPORT_MAP := rte_telemetry_version.map\n+\n+LIBABIVER := 1\n+\n+# library source files\n+SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) := rte_telemetry.c\n+\n+# export include files\n+SYMLINK-$(CONFIG_RTE_LIBRTE_TELEMETRY)-include := rte_telemetry.h\n+\n+include $(RTE_SDK)/mk/rte.lib.mk\ndiff --git a/lib/librte_telemetry/meson.build b/lib/librte_telemetry/meson.build\nnew file mode 100644\nindex 000000000..7716076a9\n--- /dev/null\n+++ b/lib/librte_telemetry/meson.build\n@@ -0,0 +1,7 @@\n+# SPDX-License-Identifier: BSD-3-Clause\n+# Copyright(c) 2018 Intel Corporation\n+\n+sources = files('rte_telemetry.c')\n+headers = files('rte_telemetry.h', 'rte_telemetry_internal.h')\n+deps += ['metrics', 'ethdev']\n+cflags += '-DALLOW_EXPERIMENTAL_API'\ndiff --git a/lib/librte_telemetry/rte_telemetry.c b/lib/librte_telemetry/rte_telemetry.c\nnew file mode 100644\nindex 000000000..7f4ad0342\n--- /dev/null\n+++ b/lib/librte_telemetry/rte_telemetry.c\n@@ -0,0 +1,123 @@\n+/* SPDX-License-Identifier: BSD-3-Clause\n+ * Copyright(c) 2018 Intel Corporation\n+ */\n+\n+#include <unistd.h>\n+#include <pthread.h>\n+\n+#include <rte_eal.h>\n+#include <rte_ethdev.h>\n+#include <rte_metrics.h>\n+#include <rte_option.h>\n+\n+#include \"rte_telemetry.h\"\n+#include \"rte_telemetry_internal.h\"\n+\n+#define SLEEP_TIME 10\n+\n+static telemetry_impl *static_telemetry;\n+\n+static int32_t\n+rte_telemetry_run(void *userdata)\n+{\n+\tstruct telemetry_impl *telemetry = userdata;\n+\n+\tif (telemetry == NULL) {\n+\t\tTELEMETRY_LOG_WARN(\"TELEMETRY could not be initialised\");\n+\t\treturn -1;\n+\t}\n+\n+\treturn 0;\n+}\n+\n+static void\n+*rte_telemetry_run_thread_func(void *userdata)\n+{\n+\tint ret;\n+\tstruct telemetry_impl *telemetry = userdata;\n+\n+\tif (telemetry == NULL) {\n+\t\tTELEMETRY_LOG_ERR(\"%s passed a NULL instance\", __func__);\n+\t\tpthread_exit(0);\n+\t}\n+\n+\twhile (telemetry->thread_status) {\n+\t\trte_telemetry_run(telemetry);\n+\t\tret = usleep(SLEEP_TIME);\n+\t\tif (ret < 0)\n+\t\t\tTELEMETRY_LOG_ERR(\"Calling thread could not be put to sleep\");\n+\t}\n+\tpthread_exit(0);\n+}\n+\n+int32_t __rte_experimental\n+rte_telemetry_init()\n+{\n+\tint ret;\n+\tpthread_attr_t attr;\n+\tconst char *telemetry_ctrl_thread = \"telemetry\";\n+\n+\tif (static_telemetry) {\n+\t\tTELEMETRY_LOG_WARN(\"TELEMETRY structure already initialised\");\n+\t\treturn -EALREADY;\n+\t}\n+\n+\tstatic_telemetry = calloc(1, sizeof(struct telemetry_impl));\n+\tif (static_telemetry == NULL) {\n+\t\tTELEMETRY_LOG_ERR(\"Memory could not be allocated\");\n+\t\treturn -ENOMEM;\n+\t}\n+\n+\tstatic_telemetry->socket_id = rte_socket_id();\n+\trte_metrics_init(static_telemetry->socket_id);\n+\n+\tret = pthread_attr_init(&attr);\n+\tif (ret != 0) {\n+\t\tTELEMETRY_LOG_ERR(\"Pthread attribute init failed\");\n+\t\treturn -EPERM;\n+\t}\n+\n+\tret = rte_ctrl_thread_create(&static_telemetry->thread_id,\n+\t\ttelemetry_ctrl_thread, &attr, rte_telemetry_run_thread_func,\n+\t\t(void *)static_telemetry);\n+\tstatic_telemetry->thread_status = 1;\n+\n+\tif (ret < 0) {\n+\t\tret = rte_telemetry_cleanup();\n+\t\tif (ret < 0)\n+\t\t\tTELEMETRY_LOG_ERR(\"TELEMETRY cleanup failed\");\n+\t\treturn -EPERM;\n+\t}\n+\n+\treturn 0;\n+}\n+\n+int32_t __rte_experimental\n+rte_telemetry_cleanup(void)\n+{\n+\tstruct telemetry_impl *telemetry = static_telemetry;\n+\ttelemetry->thread_status = 0;\n+\tpthread_join(telemetry->thread_id, NULL);\n+\tfree(telemetry);\n+\tstatic_telemetry = NULL;\n+\treturn 0;\n+}\n+\n+int telemetry_log_level;\n+RTE_INIT(rte_telemetry_register);\n+\n+static struct rte_option option = {\n+\t.opt_str = \"--telemetry\",\n+\t.cb = &rte_telemetry_init,\n+\t.enabled = 0\n+};\n+\n+static void\n+rte_telemetry_register(void)\n+{\n+\ttelemetry_log_level = rte_log_register(\"lib.telemetry\");\n+\tif (telemetry_log_level >= 0)\n+\t\trte_log_set_level(telemetry_log_level, RTE_LOG_ERR);\n+\n+\trte_option_register(&option);\n+}\ndiff --git a/lib/librte_telemetry/rte_telemetry.h b/lib/librte_telemetry/rte_telemetry.h\nnew file mode 100644\nindex 000000000..97674ae2d\n--- /dev/null\n+++ b/lib/librte_telemetry/rte_telemetry.h\n@@ -0,0 +1,51 @@\n+/* SPDX-License-Identifier: BSD-3-Clause\n+ * Copyright(c) 2018 Intel Corporation\n+ */\n+\n+#include <stdint.h>\n+\n+#ifndef _RTE_TELEMETRY_H_\n+#define _RTE_TELEMETRY_H_\n+\n+/**\n+ * @file\n+ * RTE Telemetry\n+ *\n+ * The telemetry library provides a method to retrieve statistics from\n+ * DPDK by sending a JSON encoded message over a socket. DPDK will send\n+ * a JSON encoded response containing telemetry data.\n+ ***/\n+\n+/**\n+ * @warning\n+ * @b EXPERIMENTAL: this API may change without prior notice\n+ *\n+ * Initialize Telemetry\n+ *\n+ * @return\n+ * 0 on successful initialisation.\n+ * @return\n+ * -ENOMEM on memory allocation error\n+ * @return\n+ * -EPERM on unknown error failure\n+ * @return\n+ * -EALREADY if Telemetry is already initialised.\n+ */\n+int32_t __rte_experimental\n+rte_telemetry_init(void);\n+\n+/**\n+ * @warning\n+ * @b EXPERIMENTAL: this API may change without prior notice\n+ *\n+ * Clean up and free memory.\n+ *\n+ * @return\n+ * 0 on success\n+ * @return\n+ * -EPERM on failure\n+ */\n+int32_t __rte_experimental\n+rte_telemetry_cleanup(void);\n+\n+#endif\ndiff --git a/lib/librte_telemetry/rte_telemetry_internal.h b/lib/librte_telemetry/rte_telemetry_internal.h\nnew file mode 100644\nindex 000000000..4e810a84c\n--- /dev/null\n+++ b/lib/librte_telemetry/rte_telemetry_internal.h\n@@ -0,0 +1,32 @@\n+/* SPDX-License-Identifier: BSD-3-Clause\n+ * Copyright(c) 2018 Intel Corporation\n+ */\n+\n+#include <rte_log.h>\n+\n+#ifndef _RTE_TELEMETRY_INTERNAL_H_\n+#define _RTE_TELEMETRY_INTERNAL_H_\n+\n+/* Logging Macros */\n+extern int telemetry_log_level;\n+\n+#define TELEMETRY_LOG(level, fmt, args...) \\\n+\trte_log(RTE_LOG_ ##level, telemetry_log_level, \"%s(): \"fmt \"\\n\", \\\n+\t\t__func__, ##args)\n+\n+#define TELEMETRY_LOG_ERR(fmt, args...) \\\n+\tTELEMETRY_LOG(ERR, fmt, ## args)\n+\n+#define TELEMETRY_LOG_WARN(fmt, args...) \\\n+\tTELEMETRY_LOG(WARNING, fmt, ## args)\n+\n+#define TELEMETRY_LOG_INFO(fmt, args...) \\\n+\tTELEMETRY_LOG(INFO, fmt, ## args)\n+\n+typedef struct telemetry_impl {\n+\tpthread_t thread_id;\n+\tint thread_status;\n+\tuint32_t socket_id;\n+} telemetry_impl;\n+\n+#endif\ndiff --git a/lib/librte_telemetry/rte_telemetry_version.map b/lib/librte_telemetry/rte_telemetry_version.map\nnew file mode 100644\nindex 000000000..bbcd9a796\n--- /dev/null\n+++ b/lib/librte_telemetry/rte_telemetry_version.map\n@@ -0,0 +1,8 @@\n+EXPERIMENTAL {\n+\tglobal:\n+\n+\trte_telemetry_cleanup;\n+\trte_telemetry_init;\n+\n+\tlocal: *;\n+};\ndiff --git a/lib/meson.build b/lib/meson.build\nindex 2b903fa37..9d1f353d2 100644\n--- a/lib/meson.build\n+++ b/lib/meson.build\n@@ -25,7 +25,7 @@ libraries = [ 'compat', # just a header, used for versioning\n \t# add pkt framework libs which use other libs from above\n \t'port', 'table', 'pipeline',\n \t# flow_classify lib depends on pkt framework table lib\n-\t'flow_classify', 'bpf']\n+\t'flow_classify', 'bpf', 'telemetry']\n \n default_cflags = machine_args\n if cc.has_argument('-Wno-format-truncation')\ndiff --git a/mk/rte.app.mk b/mk/rte.app.mk\nindex c0036daf8..a14e83c71 100644\n--- a/mk/rte.app.mk\n+++ b/mk/rte.app.mk\n@@ -51,7 +51,6 @@ _LDLIBS-$(CONFIG_RTE_LIBRTE_ACL) += --whole-archive\n _LDLIBS-$(CONFIG_RTE_LIBRTE_ACL) += -lrte_acl\n _LDLIBS-$(CONFIG_RTE_LIBRTE_ACL) += --no-whole-archive\n _LDLIBS-$(CONFIG_RTE_LIBRTE_JOBSTATS) += -lrte_jobstats\n-_LDLIBS-$(CONFIG_RTE_LIBRTE_METRICS) += -lrte_metrics\n _LDLIBS-$(CONFIG_RTE_LIBRTE_BITRATE) += -lrte_bitratestats\n _LDLIBS-$(CONFIG_RTE_LIBRTE_LATENCY_STATS) += -lrte_latencystats\n _LDLIBS-$(CONFIG_RTE_LIBRTE_POWER) += -lrte_power\n@@ -80,6 +79,8 @@ _LDLIBS-$(CONFIG_RTE_LIBRTE_SECURITY) += -lrte_security\n _LDLIBS-$(CONFIG_RTE_LIBRTE_COMPRESSDEV) += -lrte_compressdev\n _LDLIBS-$(CONFIG_RTE_LIBRTE_EVENTDEV) += -lrte_eventdev\n _LDLIBS-$(CONFIG_RTE_LIBRTE_RAWDEV) += -lrte_rawdev\n+_LDLIBS-$(CONFIG_RTE_LIBRTE_METRICS) += -lrte_metrics\n+_LDLIBS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += -lrte_telemetry\n _LDLIBS-$(CONFIG_RTE_LIBRTE_TIMER) += -lrte_timer\n _LDLIBS-$(CONFIG_RTE_LIBRTE_MEMPOOL) += -lrte_mempool\n _LDLIBS-$(CONFIG_RTE_DRIVER_MEMPOOL_RING) += -lrte_mempool_ring\n", "prefixes": [ "v10", "03/12" ] }