update and simplify telemetry library.
Subsystems (2)
cover update and simplify telemetry library.
This patchset extensively reworks the telemetry library adding new functionality and simplifying much of the existing code, while maintaining backward compatibility.
This work is based on the previously sent RFC for a "process info"
library: https://patchwork.dpdk.org/project/dpdk/list/?series=7741
However, rather than creating a new library, this patchset takes that work and merges it into the existing telemetry library, as mentioned above.
The telemetry library as shipped in 19.11 is based upon the metrics library and outputs all statistics based on that as a source. However, this limits the telemetry output to only port-level statistics information, rather than allowing it to be used as a general scheme for telemetry information across all DPDK libraries.
With this patchset applied, rather than the telemetry library being responsible for pulling ethdev stats and pushing them into the metrics library for retrieval later, each library e.g. ethdev, rawdev, and even the metrics library itself (for backwards compatiblity) now handle their own stats. Any library or app can register a callback function with telemetry, which will be called if requested by the client connected via the telemetry socket. The callback function in the library/app then formats its stats, or other data, into a JSON string, and returns it to telemetry to be sent to the client.
To maintain backward compatibility, e.g. to allow the dpdk telemetry collectd plugin to continue to work, some of the existing telemetry code is kept, but is moved into the metrics library, and callbacks are registered with telemetry for the legacy commands that were supported previously.
The new version of the library, apart from the legacy interface support for backward compatibility, does not have an external dependency on the Jansson library, allowing the library to be enabled by default.
Note: In this version of the patchset, telemetry output is provided by the ethdev, rawdev and eal libraries, but this may be expanded further in later versions which are planned ahead of the merge deadline for 20.05
Bruce Richardson (5):
telemetry: invert dependency on metrics
telemetry: introduce new telemetry functionality
ethdev: add callback support for telemetry
usertools: add new telemetry python script
eal: add eal telemetry callbacks
Ciara Power (7):
telemetry: move code to metrics for later reuse
metrics: reduce code taken from telemetry
rawdev: add callback support for telemetry examples/l3fwd-power: enable use of new telemetry
telemetry: introduce telemetry backward compatibility
telemetry: remove existing telemetry files
lib: add telemetry as eal dependency
config/common_base | 2 +- examples/l3fwd-power/Makefile | 4 + examples/l3fwd-power/main.c | 62 +- examples/l3fwd-power/meson.build | 4 + lib/Makefile | 10 +- lib/librte_eal/common/eal_common_options.c | 79 + lib/librte_eal/common/eal_internal_cfg.h | 1 + lib/librte_eal/common/eal_options.h | 7 + lib/librte_eal/freebsd/eal/Makefile | 1 + lib/librte_eal/freebsd/eal/eal.c | 14 + lib/librte_eal/freebsd/eal/meson.build | 2 +- lib/librte_eal/linux/eal/Makefile | 1 + lib/librte_eal/linux/eal/eal.c | 14 + lib/librte_eal/linux/eal/meson.build | 2 +- lib/librte_eal/meson.build | 2 +- lib/librte_ethdev/Makefile | 4 + lib/librte_ethdev/meson.build | 4 + lib/librte_ethdev/rte_ethdev.c | 79 + lib/librte_metrics/Makefile | 14 + lib/librte_metrics/meson.build | 10 + lib/librte_metrics/rte_metrics.c | 6 +- lib/librte_metrics/rte_metrics.h | 5 +- lib/librte_metrics/rte_metrics_telemetry.c | 539 +++++ lib/librte_metrics/rte_metrics_telemetry.h | 65 + lib/librte_metrics/rte_metrics_version.map | 7 + lib/librte_rawdev/Makefile | 5 + lib/librte_rawdev/meson.build | 5 + lib/librte_rawdev/rte_rawdev.c | 88 + lib/librte_telemetry/Makefile | 12 +- lib/librte_telemetry/meson.build | 18 +- lib/librte_telemetry/rte_telemetry.c | 1895 ----------------- lib/librte_telemetry/rte_telemetry.h | 53 +- lib/librte_telemetry/rte_telemetry_internal.h | 112 - lib/librte_telemetry/rte_telemetry_legacy.h | 48 + lib/librte_telemetry/rte_telemetry_parser.c | 682 ------ lib/librte_telemetry/rte_telemetry_parser.h | 15 - .../rte_telemetry_parser_test.c | 533 ----- .../rte_telemetry_socket_tests.h | 36 - .../rte_telemetry_version.map | 5 +- lib/librte_telemetry/telemetry.c | 290 +++ lib/librte_telemetry/telemetry_legacy.c | 226 ++ lib/meson.build | 3 +- mk/rte.app.mk | 9 +- mk/rte.vars.mk | 2 + usertools/test_new_telemetry.py | 30 + 45 files changed, 1659 insertions(+), 3346 deletions(-) create mode 100644 lib/librte_metrics/rte_metrics_telemetry.c create mode 100644 lib/librte_metrics/rte_metrics_telemetry.h delete mode 100644 lib/librte_telemetry/rte_telemetry.c delete mode 100644 lib/librte_telemetry/rte_telemetry_internal.h create mode 100644 lib/librte_telemetry/rte_telemetry_legacy.h delete mode 100644 lib/librte_telemetry/rte_telemetry_parser.c delete mode 100644 lib/librte_telemetry/rte_telemetry_parser.h delete mode 100644 lib/librte_telemetry/rte_telemetry_parser_test.c delete mode 100644 lib/librte_telemetry/rte_telemetry_socket_tests.h create mode 100644 lib/librte_telemetry/telemetry.c create mode 100644 lib/librte_telemetry/telemetry_legacy.c create mode 100755 usertools/test_new_telemetry.py
Signature · 1 line
2.17.1
PATCH 1/12 telemetry: move code to metrics for later reuse
This commit moves some of the telemetry library code to a new file in the metrics library. No modifications are made to the moved code, except what is needed to allow it to compile and run. The additional code in metrics is built only when the Jansson library is present. Telemetry functions as normal, using the functions from the metrics_telemetry file. This move will enable code be reused by the new version of telemetry in a later commit, to support backward compatibility with the existing telemetry usage.
--- lib/Makefile | 2 +- lib/librte_metrics/Makefile | 13 + lib/librte_metrics/meson.build | 9 + lib/librte_metrics/rte_metrics.c | 1 - lib/librte_metrics/rte_metrics.h | 3 +- lib/librte_metrics/rte_metrics_telemetry.c | 719 ++++++++++++++++++ lib/librte_metrics/rte_metrics_telemetry.h | 71 ++ lib/librte_metrics/rte_metrics_version.map | 7 + lib/librte_telemetry/rte_telemetry.c | 550 +------------- lib/librte_telemetry/rte_telemetry_internal.h | 32 +- lib/librte_telemetry/rte_telemetry_parser.c | 270 +------ mk/rte.app.mk | 2 + mk/rte.vars.mk | 2 + 13 files changed, 864 insertions(+), 817 deletions(-) create mode 100644 lib/librte_metrics/rte_metrics_telemetry.c create mode 100644 lib/librte_metrics/rte_metrics_telemetry.h
lib/Makefile +1 -1
@@ -71,7 +71,7 @@ DEPDIRS-librte_gro := librte_eal librte_mbuf librte_ethdev librte_net DIRS-$(CONFIG_RTE_LIBRTE_JOBSTATS) += librte_jobstats DEPDIRS-librte_jobstats := librte_eal DIRS-$(CONFIG_RTE_LIBRTE_METRICS) += librte_metrics -DEPDIRS-librte_metrics := librte_eal +DEPDIRS-librte_metrics := librte_eal librte_ethdev DIRS-$(CONFIG_RTE_LIBRTE_BITRATE) += librte_bitratestats DEPDIRS-librte_bitratestats := librte_eal librte_metrics librte_ethdev DIRS-$(CONFIG_RTE_LIBRTE_LATENCY_STATS) += librte_latencystats
lib/librte_metrics/Makefile +13 -0
@@ -7,6 +7,7 @@ include $(RTE_SDK)/mk/rte.vars.mk LIB = librte_metrics.a CFLAGS += $(WERROR_FLAGS) -I$(SRCDIR) -O3 +CFLAGS += -DALLOW_EXPERIMENTAL_API LDLIBS += -lrte_eal EXPORT_MAP := rte_metrics_version.map
@@ -14,6 +15,18 @@ EXPORT_MAP := rte_metrics_version.map # all source are stored in SRCS-y SRCS-$(CONFIG_RTE_LIBRTE_METRICS) := rte_metrics.c +JANSSON_CFLAGS=$(shell $(PKG_CONFIG) --cflags jansson 2> /dev/null) +JANSSON_LINK=$(shell $(PKG_CONFIG) --libs jansson 2> /dev/null) +ifneq ($(JANSSON_LINK),) +SRCS-y += rte_metrics_telemetry.c +SYMLINK-$(CONFIG_RTE_LIBRTE_METRICS)-include += rte_metrics_telemetry.h + +LDLIBS += -lrte_ethdev +LDLIBS += $(JANSSON_LINK) + +CFLAGS += $(JANSSON_CFLAGS) +endif + # Install header file SYMLINK-$(CONFIG_RTE_LIBRTE_METRICS)-include += rte_metrics.h
lib/librte_metrics/meson.build +9 -0
@@ -1,5 +1,14 @@ # SPDX-License-Identifier: BSD-3-Clause # Copyright(c) 2017 Intel Corporation +allow_experimental_apis = true sources = files('rte_metrics.c') headers = files('rte_metrics.h') + +jansson = dependency('jansson', required: false) +if jansson.found() + ext_deps += jansson + sources += files('rte_metrics_telemetry.c') + headers = files('rte_metrics_telemetry.h') + deps += ['ethdev'] +endif
lib/librte_metrics/rte_metrics.c +0 -1
@@ -13,7 +13,6 @@#include <rte_memzone.h> #include <rte_spinlock.h> -#define RTE_METRICS_MAX_METRICS 256#define RTE_METRICS_MEMZONE_NAME "RTE_METRICS"/**
lib/librte_metrics/rte_metrics.h +1 -2
@@ -32,6 +32,7 @@ extern "C" {/** Maximum length of metric name (including null-terminator) */ #define RTE_METRICS_MAX_NAME_LEN 64 +#define RTE_METRICS_MAX_METRICS 256/** * Global metric special id.
@@ -43,7 +44,6 @@ extern "C" {*/ #define RTE_METRICS_GLOBAL -1 -/** * A name-key lookup for metrics. *
@@ -71,7 +71,6 @@ struct rte_metric_value {uint64_t value; }; -/** * Initializes metric module. This function must be called from * a primary process before metrics are used.
lib/librte_metrics/rte_metrics_telemetry.c new file +719 -0
719 lines not on this page · raw message
lib/librte_metrics/rte_metrics_telemetry.h new file +71 -0
71 lines not on this page · raw message
lib/librte_metrics/rte_metrics_version.map +7 -0
@@ -16,4 +16,11 @@ EXPERIMENTAL { global: rte_metrics_deinit; + rte_metrics_tel_encode_json_format; + rte_metrics_tel_reg_all_ethdev; + rte_metrics_tel_get_global_stats; + rte_metrics_tel_get_port_stats_ids; + rte_metrics_tel_get_ports_stats_json; + rte_metrics_tel_extract_data; + };
lib/librte_telemetry/rte_telemetry.c +20 -530
597 lines not on this page · raw message
lib/librte_telemetry/rte_telemetry_internal.h +2 -30
@@ -4,6 +4,8 @@#include <rte_log.h> #include <rte_tailq.h> +#include <rte_metrics.h> +#include <rte_metrics_telemetry.h> #ifndef _RTE_TELEMETRY_INTERNAL_H_#define _RTE_TELEMETRY_INTERNAL_H_
@@ -50,28 +52,6 @@ enum rte_telemetry_parser_actions { ACTION_DELETE = 2 }; -enum rte_telemetry_stats_type { -PORT_STATS =0 , -GLOBAL_STATS =1 -}; - -/* @internal */ -struct telemetry_encode_param { -enum rte_telemetry_stats_type type; -union { -struct port_param { -int num_metric_ids; -uint32_t metric_ids[MAX_METRICS ]; -int num_port_ids; -uint32_t port_ids[RTE_MAX_ETHPORTS ]; - } pp; -struct global_param { -int num_metric_ids; -uint32_t metric_ids[MAX_METRICS ]; - } gp; - }; -}; -int32_t rte_telemetry_parse_client_message (struct telemetry_impl *telemetry,char *buf);
@@ -87,14 +67,6 @@ int32_t rte_telemetry_unregister_client(struct telemetry_impl *telemetry, const char *client_path); -/** -* This is a wrapper for the ethdev api rte_eth_find_next(). -* If rte_eth_find_next() returns the same port id that we passed it, -* then we know that that port is active. -*/ -int32_t -rte_telemetry_is_port_active (int port_id); -int32_t rte_telemetry_send_ports_stats_values (struct telemetry_encode_param *ep,struct telemetry_impl *telemetry);
lib/librte_telemetry/rte_telemetry_parser.c +17 -253
344 lines not on this page · raw message
mk/rte.app.mk +2 -0
@@ -55,7 +55,9 @@ _LDLIBS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += -lrte_telemetry -ljansson _LDLIBS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += --no-whole-archive _LDLIBS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += --as-needed _LDLIBS-$(CONFIG_RTE_LIBRTE_JOBSTATS) += -lrte_jobstats +_LDLIBS-$(CONFIG_RTE_LIBRTE_METRICS) += --whole-archive _LDLIBS-$(CONFIG_RTE_LIBRTE_METRICS) += -lrte_metrics +_LDLIBS-$(CONFIG_RTE_LIBRTE_METRICS) += --no-whole-archive _LDLIBS-$(CONFIG_RTE_LIBRTE_BITRATE) += -lrte_bitratestats _LDLIBS-$(CONFIG_RTE_LIBRTE_LATENCY_STATS) += -lrte_latencystats _LDLIBS-$(CONFIG_RTE_LIBRTE_POWER) += -lrte_power
mk/rte.vars.mk +2 -0
@@ -100,3 +100,5 @@ include $(RTE_SDK)/mk/target/$(RTE_TARGET)/rte.vars.mk else include $(RTE_SDK)/mk/target/generic/rte.vars.mk endif + +PKG_CONFIG?=$(CROSS)pkg-config
Signature · 1 line
2.17.1
PATCH 2/12 metrics: reduce code taken from telemetry
In reply to Ciara PowerThe telemetry code that was moved into the metrics library can be shortened, while still maintaining the same functionality.
--- lib/librte_metrics/rte_metrics_telemetry.c | 476 ++++---------------- lib/librte_metrics/rte_metrics_telemetry.h | 18 +- lib/librte_telemetry/rte_telemetry.c | 11 - lib/librte_telemetry/rte_telemetry_parser.c | 12 +- 4 files changed, 96 insertions(+), 421 deletions(-)
lib/librte_metrics/rte_metrics_telemetry.c +89 -387
@@ -23,33 +23,12 @@ int metrics_log_level; #define METRICS_LOG_WARN(fmt, args...) \ METRICS_LOG(WARNING, fmt, ## args) -static int32_t -rte_metrics_tel_is_port_active (int port_id) -{ -int ret; - - ret =rte_eth_find_next (port_id); -if (ret == port_id) -return 1 ; - -METRICS_LOG_ERR ("port_id: %d is invalid, not active" , - port_id); - -return 0 ; -} -static int32_t rte_metrics_tel_reg_port_ethdev_to_metrics (uint16_t port_id) { -int ret, num_xstats, ret_val, i; -struct rte_eth_xstat *eth_xstats =NULL ; +int ret, num_xstats, i;struct rte_eth_xstat_name *eth_xstats_names =NULL ; -if (!rte_eth_dev_is_valid_port (port_id)) { -METRICS_LOG_ERR ("port_id: %d is invalid" , port_id); -return -EINVAL ; - } - num_xstats =rte_eth_xstats_get (port_id,NULL ,0 );if (num_xstats <0 ) { METRICS_LOG_ERR("rte_eth_xstats_get(%u) failed: %d",
@@ -57,53 +36,32 @@ rte_metrics_tel_reg_port_ethdev_to_metrics(uint16_t port_id)return -EPERM ; } - eth_xstats =malloc (sizeof (struct rte_eth_xstat ) * num_xstats); -if (eth_xstats ==NULL ) { -METRICS_LOG_ERR ("Failed to malloc memory for xstats" ); -return -ENOMEM ; - } - - ret =rte_eth_xstats_get (port_id, eth_xstats, num_xstats);const char *xstats_names[num_xstats]; eth_xstats_names =malloc (sizeof (struct rte_eth_xstat_name ) * num_xstats); -if (ret <0 || ret > num_xstats) { -METRICS_LOG_ERR ("rte_eth_xstats_get(%u) len%i failed: %d" , - port_id, num_xstats, ret); - ret_val = -EPERM ; - goto free_xstats; - } -if (eth_xstats_names ==NULL ) {METRICS_LOG_ERR ("Failed to malloc memory for xstats_names" ); - ret_val = -ENOMEM ; + ret = -ENOMEM ; goto free_xstats; } - ret =rte_eth_xstats_get_names (port_id, eth_xstats_names, num_xstats); -if (ret <0 || ret > num_xstats) { -METRICS_LOG_ERR ("rte_eth_xstats_get_names(%u) len%i failed: %d" , - port_id, num_xstats, ret); - ret_val = -EPERM ; +if (rte_eth_xstats_get_names (port_id, + eth_xstats_names, num_xstats) != num_xstats) { +METRICS_LOG_ERR ("rte_eth_xstats_get_names(%u) len %d failed" , + port_id, num_xstats); + ret = -EPERM ; goto free_xstats; }for (i =0 ; i < num_xstats; i++) - xstats_names[i] = eth_xstats_names[eth_xstats[i].id].name; - - ret_val =rte_metrics_reg_names (xstats_names, num_xstats); -if (ret_val <0 ) { + xstats_names[i] = eth_xstats_names[i].name; + ret =rte_metrics_reg_names (xstats_names, num_xstats); +if (ret <0 )METRICS_LOG_ERR ("rte_metrics_reg_names failed - metrics may already be registered" ); - ret_val =-1 ; - goto free_xstats; - } - - goto free_xstats; free_xstats: -free (eth_xstats);free (eth_xstats_names); -return ret_val; +return ret; }int32_t
@@ -113,20 +71,18 @@ rte_metrics_tel_reg_all_ethdev(int *metrics_register_done, int *reg_index_list)const void *dev_ops;int reg_index; } drv_idx[RTE_MAX_ETHPORTS] = { {0} }; -int nb_drv_idx =0 ; -uint16_t pid; -int ret; +int ret, nb_drv_idx =0 ; +uint16_t d; -RTE_ETH_FOREACH_DEV (pid) { +RTE_ETH_FOREACH_DEV (d) {int i;/* Different device types have different numbers of stats, so * first check if the stats for this type of device have * already been registered */ for (i =0 ; i < nb_drv_idx; i++) { -if (rte_eth_devices[pid].dev_ops == - drv_idx[i].dev_ops) { - reg_index_list[pid] = drv_idx[i].reg_index; +if (rte_eth_devices[d].dev_ops == drv_idx[i].dev_ops) { + reg_index_list[d] = drv_idx[i].reg_index;break ; } }
@@ -134,17 +90,16 @@ rte_metrics_tel_reg_all_ethdev(int *metrics_register_done, int *reg_index_list)continue ;/* we found a match, go to next port */ /* No match, register a new set of xstats for this port */ - ret =rte_metrics_tel_reg_port_ethdev_to_metrics (pid); + ret =rte_metrics_tel_reg_port_ethdev_to_metrics (d);if (ret <0 ) { -METRICS_LOG_ERR ("Failed to register ethdev metrics" ); -return -1 ; +METRICS_LOG_ERR ("Failed to register ethdev to metrics" ); +return ret; } - reg_index_list[pid] = ret; - drv_idx[nb_drv_idx].dev_ops = rte_eth_devices[pid].dev_ops; + reg_index_list[d] = ret; + drv_idx[nb_drv_idx].dev_ops = rte_eth_devices[d].dev_ops; drv_idx[nb_drv_idx].reg_index = ret; nb_drv_idx++; } - *metrics_register_done =1 ;return 0 ; }
@@ -155,28 +110,17 @@ rte_metrics_tel_update_metrics_ethdev(uint16_t port_id, int reg_start_index)int ret, num_xstats, i;struct rte_eth_xstat *eth_xstats; -if (!rte_eth_dev_is_valid_port (port_id)) { -METRICS_LOG_ERR ("port_id: %d is invalid" , port_id); -return -EINVAL ; - } - - ret =rte_metrics_tel_is_port_active (port_id); -if (ret <1 ) -return -EINVAL ; - num_xstats =rte_eth_xstats_get (port_id,NULL ,0 );if (num_xstats <0 ) {METRICS_LOG_ERR ("rte_eth_xstats_get(%u) failed: %d" , port_id, num_xstats);return -EPERM ; } - eth_xstats =malloc (sizeof (struct rte_eth_xstat ) * num_xstats);if (eth_xstats ==NULL ) {METRICS_LOG_ERR ("Failed to malloc memory for xstats" );return -ENOMEM ; } - ret =rte_eth_xstats_get (port_id, eth_xstats, num_xstats);if (ret <0 || ret > num_xstats) {free (eth_xstats);
@@ -188,223 +132,96 @@ rte_metrics_tel_update_metrics_ethdev(uint16_t port_id, int reg_start_index)uint64_t xstats_values[num_xstats];for (i =0 ; i < num_xstats; i++) xstats_values[i] = eth_xstats[i].value; - - ret =rte_metrics_update_values (port_id, reg_start_index, xstats_values, - num_xstats); -if (ret <0 ) { +if (rte_metrics_update_values (port_id, reg_start_index, xstats_values, + num_xstats) <0 ) {METRICS_LOG_ERR ("Could not update metrics values" );free (eth_xstats);return -EPERM ; } -free (eth_xstats);return 0 ; } -static int -rte_metrics_tel_get_metrics (uint32_t port_id,struct rte_metric_value - *metrics,struct rte_metric_name *names,int num_metrics) -{ -int ret, num_values; - -if (num_metrics <0 ) { -METRICS_LOG_ERR ("Invalid metrics count" ); -return -EINVAL ; - }else if (num_metrics ==0 ) { -METRICS_LOG_ERR ("No metrics to display (none have been registered)" ); -return -EPERM ; - } - -if (metrics ==NULL ) { -METRICS_LOG_ERR ("Metrics must be initialised." ); -return -EINVAL ; - } - -if (names ==NULL ) { -METRICS_LOG_ERR ("Names must be initialised." ); -return -EINVAL ; - } - - ret =rte_metrics_get_names (names, num_metrics); -if (ret <0 || ret > num_metrics) { -METRICS_LOG_ERR ("Cannot get metrics names" ); -return -EPERM ; - } - - num_values =rte_metrics_get_values (port_id,NULL ,0 ); - ret =rte_metrics_get_values (port_id, metrics, num_values); -if (ret <0 || ret > num_values) { -METRICS_LOG_ERR ("Cannot get metrics values" ); -return -EPERM ; - } - -return 0 ; -} -static int32_t -rte_metrics_tel_json_format_stat (json_t *stats,const char *metric_name, -uint64_t metric_value) -{ -int ret; -json_t *stat =json_object (); - -if (stat ==NULL ) { -METRICS_LOG_ERR ("Could not create stat JSON object" ); -return -EPERM ; - } - - ret =json_object_set_new (stat,"name" ,json_string (metric_name)); -if (ret <0 ) { -METRICS_LOG_ERR ("Stat Name field cannot be set" ); -return -EPERM ; - } - - ret =json_object_set_new (stat,"value" ,json_integer (metric_value)); -if (ret <0 ) { -METRICS_LOG_ERR ("Stat Value field cannot be set" ); -return -EPERM ; - } - - ret =json_array_append_new (stats, stat); -if (ret <0 ) { -METRICS_LOG_ERR ("Stat cannot be added to stats json array" ); -return -EPERM ; - } - -return 0 ; -} - -static int32_t -rte_metrics_tel_json_format_port (uint32_t port_id,json_t *ports, +rte_metrics_tel_format_port (uint32_t pid,json_t *ports,uint32_t *metric_ids,int num_metric_ids) { -struct rte_metric_value *metrics =0 ; -struct rte_metric_name *names =0 ; -int num_metrics, ret; +struct rte_metric_value *metrics =NULL ; +struct rte_metric_name *names =NULL ; +int num_metrics, i, ret = -EPERM ;/* most error cases return EPERM */ json_t *port, *stats; -int i; num_metrics =rte_metrics_get_names (NULL ,0 );if (num_metrics <0 ) {METRICS_LOG_ERR ("Cannot get metrics count" ); - goto einval_fail; +return -EINVAL ; }else if (num_metrics ==0 ) {METRICS_LOG_ERR ("No metrics to display (none have been registered)" ); - goto eperm_fail; +return -EPERM ; } metrics =malloc (sizeof (struct rte_metric_value ) * num_metrics); names =malloc (sizeof (struct rte_metric_name ) * num_metrics);if (metrics ==NULL || names ==NULL ) {METRICS_LOG_ERR ("Cannot allocate memory" ); -free (metrics); -free (names);return -ENOMEM ; } - ret =rte_metrics_tel_get_metrics (port_id, metrics, names, - num_metrics); -if (ret <0 ) { -free (metrics); -free (names); -METRICS_LOG_ERR ("rte_metrics_tel_get_metrics failed" ); -return ret; +if (rte_metrics_get_names (names, num_metrics) != num_metrics || +rte_metrics_get_values (pid, metrics, num_metrics) + != num_metrics) { +METRICS_LOG_ERR ("Error getting metrics" ); + goto fail; } - port =json_object (); stats =json_array (); -if (port ==NULL || stats ==NULL ) { -METRICS_LOG_ERR ("Could not create port/stats JSON objects" ); - goto eperm_fail; - } - - ret =json_object_set_new (port,"port" ,json_integer (port_id)); -if (ret <0 ) { -METRICS_LOG_ERR ("Port field cannot be set" ); - goto eperm_fail; +if (stats ==NULL ) { +METRICS_LOG_ERR ("Could not create stats JSON object" ); + goto fail; } -for (i =0 ; i < num_metric_ids; i++) { -int metric_id = metric_ids[i]; -int metric_index =-1 ; -int metric_name_key =-1 ; +for (i =0 ; i < num_metrics; i++) {int32_t j; -uint64_t metric_value; - -if (metric_id >= num_metrics) { -METRICS_LOG_ERR ("Metric_id: %d is not valid" , - metric_id); - goto einval_fail; - } - -for (j =0 ; j < num_metrics; j++) { -if (metrics[j].key == metric_id) { - metric_name_key = metrics[j].key; - metric_index = j; +for (j =0 ; j < num_metric_ids; j++) +if (metrics[i].key == metric_ids[j])break ; - } - } - -const char *metric_name = names[metric_name_key].name; - metric_value = metrics[metric_index].value; -if (metric_name_key <0 || metric_index <0 ) { -METRICS_LOG_ERR ("Could not get metric name/index" ); - goto eperm_fail; - } +if (num_metric_ids >0 && j == num_metric_ids) +continue ;/* can't find this id */ - ret =rte_metrics_tel_json_format_stat (stats, metric_name, - metric_value); -if (ret <0 ) { +json_t *stat =json_pack ("{s,s,s,I}" , +"name" , names[metrics[i].key].name, +"value" , metrics[i].value); +if (stat ==NULL ||json_array_append_new (stats, stat) <0 ) {METRICS_LOG_ERR ("Format stat with id: %u failed" , - metric_id); -free (metrics); -free (names); -return ret; + metrics[i].key); + goto fail; } } -if (json_array_size (stats) ==0 ) - ret =json_object_set_new (port,"stats" ,json_null ()); -else - ret =json_object_set_new (port,"stats" , stats); - -if (ret <0 ) { -METRICS_LOG_ERR ("Stats object cannot be set" ); - goto eperm_fail; - } - - ret =json_array_append_new (ports, port); -if (ret <0 ) { -METRICS_LOG_ERR ("Port object cannot be added to ports array" ); - goto eperm_fail; + port =json_pack ("{s,i,s,o}" ,"port" , pid,"stats" , +json_array_size (stats) ? stats :json_null ()); +if (port ==NULL ||json_array_append_new (ports, port) <0 ) { +METRICS_LOG_ERR ("Error creating port and adding to ports" ); + goto fail; }free (metrics);free (names);return 0 ; -eperm_fail: -free (metrics); -free (names); -return -EPERM ; - -einval_fail: +fail:free (metrics);free (names); -return -EINVAL ; +return ret; }int32_t rte_metrics_tel_encode_json_format (struct telemetry_encode_param *ep,char **json_buffer) { -int ret;json_t *root, *ports; -int i; -uint32_t port_id; -int num_port_ids; -int num_metric_ids; +int ret, i; ports =json_array ();if (ports ==NULL ) {
@@ -413,28 +230,15 @@ rte_metrics_tel_encode_json_format(struct telemetry_encode_param *ep, }if (ep->type ==PORT_STATS ) { - num_port_ids = ep->pp.num_port_ids; - num_metric_ids = ep->pp.num_metric_ids; - -if (num_port_ids <=0 || num_metric_ids <=0 ) { -METRICS_LOG_ERR ("Please provide port and metric ids to query" ); +if (ep->pp.num_port_ids <=0 ) { +METRICS_LOG_ERR ("Please provide port/metric ids" );return -EINVAL ; } -for (i =0 ; i < num_port_ids; i++) { - port_id = ep->pp.port_ids[i]; -if (!rte_eth_dev_is_valid_port (port_id)) { -METRICS_LOG_ERR ("Port: %d invalid" , - port_id); -return -EINVAL ; - } - } - -for (i =0 ; i < num_port_ids; i++) { - port_id = ep->pp.port_ids[i]; - ret =rte_metrics_tel_json_format_port (port_id, +for (i =0 ; i < ep->pp.num_port_ids; i++) { + ret =rte_metrics_tel_format_port (ep->pp.port_ids[i], ports, &ep->pp.metric_ids[0 ], - num_metric_ids); + ep->pp.num_metric_ids);if (ret <0 ) {METRICS_LOG_ERR ("Format port in JSON failed" );return ret;
@@ -442,34 +246,21 @@ rte_metrics_tel_encode_json_format(struct telemetry_encode_param *ep, } }else if (ep->type ==GLOBAL_STATS ) {/* Request Global Metrics */ - ret =rte_metrics_tel_json_format_port (RTE_METRICS_GLOBAL , - ports, &ep->gp.metric_ids[0 ], - ep->gp.num_metric_ids); + ret =rte_metrics_tel_format_port (RTE_METRICS_GLOBAL , + ports,NULL ,0 );if (ret <0 ) { -METRICS_LOG_ERR (" Request Global Metrics Failed" ); +METRICS_LOG_ERR ("Request Global Metrics Failed" );return ret; } }else { -METRICS_LOG_ERR (" Invalid metrics type in encode params" ); +METRICS_LOG_ERR ("Invalid metrics type in encode params" );return -EINVAL ; } - root =json_object (); + root =json_pack ("{s,s,s,o}" ,"status_code" ,"Status OK: 200" , +"data" , ports);if (root ==NULL ) { -METRICS_LOG_ERR ("Could not create root JSON object" ); -return -EPERM ; - } - - ret =json_object_set_new (root,"status_code" , -json_string ("Status OK: 200" )); -if (ret <0 ) { -METRICS_LOG_ERR ("Status code field cannot be set" ); -return -EPERM ; - } - - ret =json_object_set_new (root,"data" , ports); -if (ret <0 ) { -METRICS_LOG_ERR ("Data field cannot be set" ); +METRICS_LOG_ERR ("Root, Status or data field cannot be set" );return -EPERM ; }
@@ -478,42 +269,6 @@ rte_metrics_tel_encode_json_format(struct telemetry_encode_param *ep,return 0 ; } -int32_t -rte_metrics_tel_get_global_stats (struct telemetry_encode_param *ep) -{ -int num_metrics, ret, i; -struct rte_metric_value *values; - - num_metrics =rte_metrics_get_values (RTE_METRICS_GLOBAL ,NULL ,0 ); -if (num_metrics <0 ) { -METRICS_LOG_ERR ("Cannot get metrics count" ); -return -EINVAL ; - }else if (num_metrics ==0 ) { -METRICS_LOG_ERR ("No metrics to display (none have been registered)" ); -return -EPERM ; - } - - values =malloc (sizeof (struct rte_metric_value ) * num_metrics); -if (values ==NULL ) { -METRICS_LOG_ERR ("Cannot allocate memory" ); -return -ENOMEM ; - } - - ret =rte_metrics_get_values (RTE_METRICS_GLOBAL , values, num_metrics); -if (ret <0 ) { -METRICS_LOG_ERR ("Could not get stat values" ); -free (values); -return -EINVAL ; - } -for (i =0 ; i < num_metrics; i++) - ep->gp.metric_ids[i] = values[i].key; - - ep->gp.num_metric_ids = num_metrics; - ep->type =GLOBAL_STATS ; -free (values); -return 0 ; -} -int32_t rte_metrics_tel_get_ports_stats_json (struct telemetry_encode_param *ep,int *reg_index,char **json_buffer)
@@ -547,24 +302,7 @@ rte_metrics_tel_get_ports_stats_json(struct telemetry_encode_param *ep,int32_t rte_metrics_tel_get_port_stats_ids (struct telemetry_encode_param *ep) { -int ret, num_metrics, i, p; -struct rte_metric_value *values; -uint64_t num_port_ids =0 ; - - num_metrics =rte_metrics_get_values (0 ,NULL ,0 ); -if (num_metrics <0 ) { -METRICS_LOG_ERR ("Cannot get metrics count" ); -return -EINVAL ; - }else if (num_metrics ==0 ) { -METRICS_LOG_ERR ("No metrics to display (none have been registered)" ); -return -EPERM ; - } - - values =malloc (sizeof (struct rte_metric_value ) * num_metrics); -if (values ==NULL ) { -METRICS_LOG_ERR ("Cannot allocate memory" ); -return -ENOMEM ; - } +int p, num_port_ids =0 ;RTE_ETH_FOREACH_DEV (p) { ep->pp.port_ids[num_port_ids] = p;
@@ -573,51 +311,26 @@ rte_metrics_tel_get_port_stats_ids(struct telemetry_encode_param *ep)if (!num_port_ids) {METRICS_LOG_ERR ("No active ports" ); - goto fail; - } - - ret =rte_metrics_get_values (ep->pp.port_ids[0 ], values, num_metrics); -if (ret <0 ) { -METRICS_LOG_ERR ("Could not get stat values" ); - goto fail; +return -EINVAL ; } -for (i =0 ; i < num_metrics; i++) - ep->pp.metric_ids[i] = values[i].key; ep->pp.num_port_ids = num_port_ids; - ep->pp.num_metric_ids = num_metrics; + ep->pp.num_metric_ids =0 ; ep->type =PORT_STATS ;return 0 ; - -fail: -free (values); -return -EINVAL ; }static int32_t rte_metrics_tel_stat_names_to_ids (const char *const *stat_names, -uint32_t *stat_ids,uint64_t num_stat_names) +uint32_t *stat_ids,int num_stat_names) {struct rte_metric_name *names; -int ret, num_metrics; -uint32_t i, k; - -if (stat_names ==NULL ) { -METRICS_LOG_WARN ("Invalid stat_names argument" ); -return -EINVAL ; - } - -if (num_stat_names <=0 ) { -METRICS_LOG_WARN ("Invalid num_stat_names argument" ); -return -EINVAL ; - } +int num_metrics; +int i, j, nb_stat_ids =0 ; num_metrics =rte_metrics_get_names (NULL ,0 ); -if (num_metrics <0 ) { -METRICS_LOG_ERR ("Cannot get metrics count" ); -return -EPERM ; - }else if (num_metrics ==0 ) { -METRICS_LOG_WARN ("No metrics have been registered" ); +if (num_metrics <=0 ) { +METRICS_LOG_ERR ("Error getting metrics count - no metrics may be registered" );return -EPERM ; }
@@ -627,29 +340,25 @@ rte_metrics_tel_stat_names_to_ids(const char * const *stat_names,return -ENOMEM ; } - ret =rte_metrics_get_names (names, num_metrics); -if (ret <0 || ret > num_metrics) { +if (rte_metrics_get_names (names, num_metrics) != num_metrics) {METRICS_LOG_ERR ("Cannot get metrics names" );free (names);return -EPERM ; } - k =0 ; -for (i =0 ; i < (uint32_t )num_stat_names; i++) { -uint32_t j; -for (j =0 ; j < (uint32_t )num_metrics; j++) { +for (i =0 ; i < num_stat_names; i++) { +for (j =0 ; j < num_metrics; j++) {if (strcmp (stat_names[i], names[j].name) ==0 ) { - stat_ids[k] = j; - k++; + stat_ids[nb_stat_ids++] = j;break ; } } - } - -if (k != num_stat_names) { -METRICS_LOG_WARN ("Invalid stat names provided" ); -free (names); -return -EINVAL ; +if (j == num_metrics) { +METRICS_LOG_WARN ("Invalid stat name %s\n" , + stat_names[i]); +free (names); +return -EINVAL ; + } }free (names);
@@ -670,28 +379,21 @@ rte_metrics_tel_extract_data(struct telemetry_encode_param *ep, json_t *data)memset (ep,0 ,sizeof (*ep)); ep->pp.num_port_ids =json_array_size (port_ids_json); ep->pp.num_metric_ids = num_stat_names; -if (!json_is_object (data)) { +if (!json_is_object (data) || !json_is_array (port_ids_json) || + !json_is_array (stat_names_json)) {METRICS_LOG_WARN ("Invalid data provided for this command" );return -EINVAL ; } -if (!json_is_array (port_ids_json) || - !json_is_array (stat_names_json)) { -METRICS_LOG_WARN ("Invalid input data array(s)" ); -return -EINVAL ; - } - json_array_foreach(port_ids_json, index, value) {if (!json_is_integer (value)) {METRICS_LOG_WARN ("Port ID given is not valid" );return -EINVAL ; } ep->pp.port_ids[index] =json_integer_value (value); - ret =rte_metrics_tel_is_port_active (ep->pp.port_ids[index]); -if (ret <1 ) +if (rte_eth_dev_is_valid_port (ep->pp.port_ids[index]) <1 )return -EINVAL ; } - json_array_foreach(stat_names_json, index, value) {if (!json_is_string (value)) {METRICS_LOG_WARN ("Stat Name given is not a string" );
lib/librte_metrics/rte_metrics_telemetry.h +6 -12
@@ -21,18 +21,12 @@ enum rte_telemetry_stats_type {struct telemetry_encode_param {enum rte_telemetry_stats_type type; -union { -struct port_param { -int num_metric_ids; -uint32_t metric_ids[RTE_METRICS_MAX_METRICS ]; -int num_port_ids; -uint32_t port_ids[RTE_MAX_ETHPORTS ]; - } pp; -struct global_param { -int num_metric_ids; -uint32_t metric_ids[RTE_METRICS_MAX_METRICS ]; - } gp; - }; +struct port_param { +int num_metric_ids; +uint32_t metric_ids[RTE_METRICS_MAX_METRICS ]; +int num_port_ids; +uint32_t port_ids[RTE_MAX_ETHPORTS ]; + } pp; };struct telemetry_metrics_data {
lib/librte_telemetry/rte_telemetry.c +0 -11
@@ -145,11 +145,6 @@ rte_telemetry_send_global_stats_values(struct telemetry_encode_param *ep,return -1 ; } -if (ep->gp.num_metric_ids <0 ) { -TELEMETRY_LOG_ERR ("Invalid num_metric_ids, must be positive" ); - goto einval_fail; - } - ret =rte_metrics_tel_encode_json_format (ep, &json_buffer);if (ret <0 ) {TELEMETRY_LOG_ERR ("JSON encode function failed" );
@@ -166,12 +161,6 @@ rte_telemetry_send_global_stats_values(struct telemetry_encode_param *ep, }return 0 ; - -einval_fail: - ret =rte_telemetry_send_error_response (telemetry, -EINVAL ); -if (ret <0 ) -TELEMETRY_LOG_ERR ("Could not send error" ); -return -1 ; }int32_t
lib/librte_telemetry/rte_telemetry_parser.c +1 -11
@@ -225,9 +225,8 @@ rte_telemetry_command_global_stat_values(struct telemetry_impl *telemetry, int action, json_t *data) { int ret; -struct telemetry_encode_param ep; +struct telemetry_encode_param ep = { .type =GLOBAL_STATS }; -memset (&ep,0 ,sizeof (ep));if (telemetry ==NULL ) {TELEMETRY_LOG_ERR ("Invalid telemetry argument" );return -1 ;
@@ -249,15 +248,6 @@ rte_telemetry_command_global_stat_values(struct telemetry_impl *telemetry,return -1 ; } - ret =rte_metrics_tel_get_global_stats (&ep); -if (ret <0 ) { -TELEMETRY_LOG_ERR ("Could not get global stat values" ); - ret =rte_telemetry_send_error_response (telemetry, ret); -if (ret <0 ) -TELEMETRY_LOG_ERR ("Could not send error" ); -return -1 ; - } - ret =rte_telemetry_send_global_stats_values (&ep, telemetry);if (ret <0 ) {TELEMETRY_LOG_ERR ("Sending global stats values failed" );
Signature · 1 line
2.17.1
PATCH 3/12 telemetry: invert dependency on metrics
In reply to Ciara PowerFrom: Bruce Richardson <[email protected]>
Rather than having the telemetry library depend on the metrics lib we invert the dependency so that metrics instead depends on telemetry lib, and registers the needed functions with it at init time. This prepares the way for a cleaner telemetry architecture to be applied in later patches.
--- lib/Makefile | 7 +++-- lib/librte_metrics/Makefile | 1 + lib/librte_metrics/meson.build | 2 +- lib/librte_metrics/rte_metrics.c | 5 ++++ lib/librte_metrics/rte_metrics.h | 2 ++ lib/librte_metrics/rte_metrics_telemetry.c | 14 +++++++++ lib/librte_telemetry/Makefile | 3 +- lib/librte_telemetry/meson.build | 2 +- lib/librte_telemetry/rte_telemetry.c | 19 ++++++++---- lib/librte_telemetry/rte_telemetry_internal.h | 30 +++++++++++++++++++ lib/librte_telemetry/rte_telemetry_parser.c | 5 ++-- .../rte_telemetry_version.map | 1 + lib/meson.build | 3 +- mk/rte.app.mk | 6 +--- 14 files changed, 80 insertions(+), 20 deletions(-)
lib/Makefile +5 -2
@@ -22,6 +22,8 @@ DIRS-$(CONFIG_RTE_LIBRTE_CFGFILE) += librte_cfgfile DEPDIRS-librte_cfgfile := librte_eal DIRS-$(CONFIG_RTE_LIBRTE_CMDLINE) += librte_cmdline DEPDIRS-librte_cmdline := librte_eal librte_net +DIRS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += librte_telemetry +DEPDIRS-librte_telemetry := librte_eal DIRS-$(CONFIG_RTE_LIBRTE_ETHER) += librte_ethdev DEPDIRS-librte_ethdev := librte_net librte_eal librte_mempool librte_ring DEPDIRS-librte_ethdev += librte_mbuf
@@ -72,6 +74,9 @@ DIRS-$(CONFIG_RTE_LIBRTE_JOBSTATS) += librte_jobstats DEPDIRS-librte_jobstats := librte_eal DIRS-$(CONFIG_RTE_LIBRTE_METRICS) += librte_metrics DEPDIRS-librte_metrics := librte_eal librte_ethdev +ifeq ($(CONFIG_RTE_LIBRTE_TELEMETRY),y) +DEPDIRS-librte_metrics += librte_telemetry +endif DIRS-$(CONFIG_RTE_LIBRTE_BITRATE) += librte_bitratestats DEPDIRS-librte_bitratestats := librte_eal librte_metrics librte_ethdev DIRS-$(CONFIG_RTE_LIBRTE_LATENCY_STATS) += librte_latencystats
@@ -114,8 +119,6 @@ DEPDIRS-librte_bpf := librte_eal librte_mempool librte_mbuf librte_ethdev DIRS-$(CONFIG_RTE_LIBRTE_IPSEC) += librte_ipsec DEPDIRS-librte_ipsec := librte_eal librte_mbuf librte_cryptodev librte_security \ librte_net -DIRS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += librte_telemetry -DEPDIRS-librte_telemetry := librte_eal librte_metrics librte_ethdev DIRS-$(CONFIG_RTE_LIBRTE_RCU) += librte_rcu DEPDIRS-librte_rcu := librte_eal
lib/librte_metrics/Makefile +1 -0
@@ -25,6 +25,7 @@ LDLIBS += -lrte_ethdev LDLIBS += $(JANSSON_LINK) CFLAGS += $(JANSSON_CFLAGS) +CFLAGS += -I$(RTE_SDK)/lib/librte_telemetry/ endif # Install header file
lib/librte_metrics/meson.build +1 -1
@@ -10,5 +10,5 @@ if jansson.found() ext_deps += jansson sources += files('rte_metrics_telemetry.c') headers = files('rte_metrics_telemetry.h') - deps += ['ethdev'] + deps += ['ethdev', 'telemetry'] endif
lib/librte_metrics/rte_metrics.c +5 -0
@@ -13,6 +13,8 @@#include <rte_memzone.h> #include <rte_spinlock.h> +int metrics_initialized; +#define RTE_METRICS_MEMZONE_NAME "RTE_METRICS"/**
@@ -60,6 +62,8 @@ rte_metrics_init(int socket_id)struct rte_metrics_data_s *stats;const struct rte_memzone *memzone; +if (metrics_initialized) +return ;if (rte_eal_process_type () !=RTE_PROC_PRIMARY )return ;
@@ -73,6 +77,7 @@ rte_metrics_init(int socket_id) stats = memzone->addr;memset (stats,0 ,sizeof (struct rte_metrics_data_s ));rte_spinlock_init (&stats->lock); + metrics_initialized =1 ; }int
lib/librte_metrics/rte_metrics.h +2 -0
@@ -30,6 +30,8 @@extern "C" {#endif +extern int metrics_initialized; +/** Maximum length of metric name (including null-terminator) */ #define RTE_METRICS_MAX_NAME_LEN 64#define RTE_METRICS_MAX_METRICS 256
lib/librte_metrics/rte_metrics_telemetry.c +14 -0
@@ -6,6 +6,9 @@#include <rte_ethdev.h> #include <rte_string_fns.h> +#ifdef RTE_LIBRTE_TELEMETRY +#include <rte_telemetry_internal.h> +#endif #include "rte_metrics.h" #include "rte_metrics_telemetry.h"
@@ -74,6 +77,7 @@ rte_metrics_tel_reg_all_ethdev(int *metrics_register_done, int *reg_index_list)int ret, nb_drv_idx =0 ;uint16_t d; +rte_metrics_init (rte_socket_id ());RTE_ETH_FOREACH_DEV (d) {int i;/* Different device types have different numbers of stats, so
@@ -415,6 +419,16 @@ rte_metrics_tel_extract_data(struct telemetry_encode_param *ep, json_t *data)RTE_INIT (metrics_ctor) { +#ifdef RTE_LIBRTE_TELEMETRY +static const struct metrics_functions fns = { + .reg_all_ethdev = rte_metrics_tel_reg_all_ethdev, + .encode_json_format = rte_metrics_tel_encode_json_format, + .get_port_stats_ids = rte_metrics_tel_get_port_stats_ids, + .get_ports_stats_json = rte_metrics_tel_get_ports_stats_json, + .extract_data = rte_metrics_tel_extract_data + }; +rte_telemetry_set_metrics_fns (&fns);/* assign them to telemetry lib */ +#endif metrics_log_level =rte_log_register ("lib.metrics" );if (metrics_log_level >=0 )rte_log_set_level (metrics_log_level,RTE_LOG_ERR );
lib/librte_telemetry/Makefile +2 -1
@@ -9,8 +9,9 @@ LIB = librte_telemetry.a CFLAGS += -O3 CFLAGS += $(WERROR_FLAGS) -I$(SRCDIR) CFLAGS += -DALLOW_EXPERIMENTAL_API +CFLAGS += -I$(RTE_SDK)/lib/librte_metrics/ -LDLIBS += -lrte_eal -lrte_ethdev +LDLIBS += -lrte_eal LDLIBS += -lrte_metrics LDLIBS += -lpthread LDLIBS += -ljansson
lib/librte_telemetry/meson.build +1 -1
@@ -3,8 +3,8 @@ sources = files('rte_telemetry.c', 'rte_telemetry_parser.c', 'rte_telemetry_parser_test.c') headers = files('rte_telemetry.h', 'rte_telemetry_internal.h', 'rte_telemetry_parser.h') -deps += ['metrics', 'ethdev'] cflags += '-DALLOW_EXPERIMENTAL_API' +includes += include_directories('../librte_metrics') jansson = dependency('jansson', required: false) if jansson.found()
lib/librte_telemetry/rte_telemetry.c +13 -6
@@ -10,10 +10,10 @@#include <jansson.h> #include <rte_eal.h> -#include <rte_ethdev.h> #include <rte_metrics.h> #include <rte_option.h> #include <rte_string_fns.h> +#include <rte_lcore.h> #include "rte_telemetry.h" #include "rte_telemetry_internal.h"
@@ -43,6 +43,15 @@ struct json_data {int stat_value; }; +/* global array of functions pointers to metrics library */ +const struct metrics_functions *metrics_fns; + +void +rte_telemetry_set_metrics_fns (const struct metrics_functions *fns) +{ + metrics_fns = fns; +} +static void rte_telemetry_get_runtime_dir (char *socket_path,size_t size) {
@@ -145,7 +154,7 @@ rte_telemetry_send_global_stats_values(struct telemetry_encode_param *ep,return -1 ; } - ret =rte_metrics_tel_encode_json_format (ep, &json_buffer); + ret = metrics_fns->encode_json_format (ep, &json_buffer);if (ret <0 ) {TELEMETRY_LOG_ERR ("JSON encode function failed" ); ret =rte_telemetry_send_error_response (telemetry, ret);
@@ -190,7 +199,7 @@ rte_telemetry_send_ports_stats_values(struct telemetry_encode_param *ep, goto einval_fail; } - ret =rte_metrics_tel_get_ports_stats_json (ep, telemetry->reg_index, + ret = metrics_fns->get_ports_stats_json (ep, telemetry->reg_index, &json_buffer);if (ret <0 ) { TELEMETRY_LOG_ERR("Function for get_ports_stats_json"
@@ -222,8 +231,7 @@ rte_telemetry_initial_accept(struct telemetry_impl *telemetry)int ret;int selftest =0 ; - ret =rte_metrics_tel_reg_all_ethdev ( - &telemetry->metrics_register_done, + ret = metrics_fns->reg_all_ethdev (&telemetry->metrics_register_done, telemetry->reg_index);if (ret <0 ) {TELEMETRY_LOG_ERR ("Failed to register ethdev metrics" );
@@ -467,7 +475,6 @@ rte_telemetry_init(void) } static_telemetry->socket_id =rte_socket_id (); -rte_metrics_init (static_telemetry->socket_id); ret =pthread_attr_init (&attr);if (ret !=0 ) {
lib/librte_telemetry/rte_telemetry_internal.h +30 -0
@@ -10,6 +10,36 @@#ifndef _RTE_TELEMETRY_INTERNAL_H_#define _RTE_TELEMETRY_INTERNAL_H_ +/* function types for the functions coming from metrics library */ +typedef int32_t (*metrics_tel_reg_all_ethdev_t )(int *metrics_register_done, +int *reg_index_list); + +typedef int32_t (*metrics_tel_encode_json_format_t )( +struct telemetry_encode_param *ep,char **json_buffer); + +typedef int32_t (*metrics_tel_get_port_stats_ids_t )( +struct telemetry_encode_param *ep); + +typedef int32_t (*metrics_tel_get_ports_stats_json_t )( +struct telemetry_encode_param *ep, +int *reg_index,char **json_buffer); + +typedef int32_t (*metrics_tel_extract_data_t )(struct telemetry_encode_param *ep, +json_t *data); + +struct metrics_functions { +metrics_tel_reg_all_ethdev_t reg_all_ethdev; +metrics_tel_encode_json_format_t encode_json_format; +metrics_tel_get_port_stats_ids_t get_port_stats_ids; +metrics_tel_get_ports_stats_json_t get_ports_stats_json; +metrics_tel_extract_data_t extract_data; +}; +extern const struct metrics_functions *metrics_fns; + +/* API for use by metrics libraries to provide the functions to use */ +__rte_experimental +void rte_telemetry_set_metrics_fns(const struct metrics_functions *fns); +/* Logging Macros */ extern int telemetry_log_level;
lib/librte_telemetry/rte_telemetry_parser.c +2 -3
@@ -10,7 +10,6 @@#include <rte_metrics.h> #include <rte_common.h> -#include <rte_ethdev.h> #include <rte_metrics_telemetry.h> #include "rte_telemetry_internal.h"
@@ -202,7 +201,7 @@ rte_telemetry_command_ports_all_stat_values(struct telemetry_impl *telemetry,return -1 ; } - ret =rte_metrics_tel_get_port_stats_ids (&ep); + ret = metrics_fns->get_port_stats_ids (&ep);if (ret <0 ) {TELEMETRY_LOG_ERR ("Could not get ports stat values" ); ret =rte_telemetry_send_error_response (telemetry, ret);
@@ -276,7 +275,7 @@ rte_telemetry_command_ports_stats_values_by_name(struct telemetry_implreturn -1 ; } - ret =rte_metrics_tel_extract_data (&ep, data); + ret = metrics_fns->extract_data (&ep, data);if (ret <0 ) {TELEMETRY_LOG_ERR ("Extracting JSON data failed" ); ret =rte_telemetry_send_error_response (telemetry, ret);
lib/librte_telemetry/rte_telemetry_version.map +1 -0
@@ -5,6 +5,7 @@ EXPERIMENTAL { rte_telemetry_init; rte_telemetry_parse; rte_telemetry_selftest; + rte_telemetry_set_metrics_fns; local: *; };
lib/meson.build +2 -1
@@ -11,6 +11,7 @@ libraries = [ 'kvargs', # eal depends on kvargs 'eal', # everything depends on eal + 'telemetry', 'ring', 'mempool', 'mbuf', 'net', 'meter', 'ethdev', 'pci', # core 'cmdline', 'metrics', # bitrate/latency stats depends on this
@@ -30,7 +31,7 @@ libraries = [ # add pkt framework libs which use other libs from above 'port', 'table', 'pipeline', # flow_classify lib depends on pkt framework table lib - 'flow_classify', 'bpf', 'telemetry'] + 'flow_classify', 'bpf'] if is_windows libraries = ['kvargs','eal'] # only supported libraries for windows
mk/rte.app.mk +1 -5
@@ -49,11 +49,6 @@ _LDLIBS-$(CONFIG_RTE_LIBRTE_FIB) += -lrte_fib _LDLIBS-$(CONFIG_RTE_LIBRTE_RIB) += -lrte_rib _LDLIBS-$(CONFIG_RTE_LIBRTE_LPM) += -lrte_lpm _LDLIBS-$(CONFIG_RTE_LIBRTE_ACL) += -lrte_acl -_LDLIBS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += --no-as-needed -_LDLIBS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += --whole-archive -_LDLIBS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += -lrte_telemetry -ljansson -_LDLIBS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += --no-whole-archive -_LDLIBS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += --as-needed _LDLIBS-$(CONFIG_RTE_LIBRTE_JOBSTATS) += -lrte_jobstats _LDLIBS-$(CONFIG_RTE_LIBRTE_METRICS) += --whole-archive _LDLIBS-$(CONFIG_RTE_LIBRTE_METRICS) += -lrte_metrics
@@ -95,6 +90,7 @@ _LDLIBS-$(CONFIG_RTE_DRIVER_MEMPOOL_RING) += -lrte_mempool_ring _LDLIBS-$(CONFIG_RTE_LIBRTE_OCTEONTX2_MEMPOOL) += -lrte_mempool_octeontx2 _LDLIBS-$(CONFIG_RTE_LIBRTE_RING) += -lrte_ring _LDLIBS-$(CONFIG_RTE_LIBRTE_PCI) += -lrte_pci +_LDLIBS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += -lrte_telemetry -ljansson _LDLIBS-$(CONFIG_RTE_LIBRTE_EAL) += -lrte_eal _LDLIBS-$(CONFIG_RTE_LIBRTE_CMDLINE) += -lrte_cmdline _LDLIBS-$(CONFIG_RTE_LIBRTE_REORDER) += -lrte_reorder
Signature · 1 line
2.17.1
PATCH 4/12 telemetry: introduce new telemetry functionality
In reply to Ciara PowerFrom: Bruce Richardson <[email protected]>
This patch introduces a new telemetry connection socket and handling functionality. Like the existing telemetry implementation (which is unaffected by this change) it uses a unix socket, but unlike the existing one it does not have a fixed list of commands - instead libraries or applications can register telemetry commands and callbacks to provide a full-extensible solution for all kinds of telemetry across DPDK.
--- lib/librte_telemetry/Makefile | 4 + lib/librte_telemetry/meson.build | 6 +- lib/librte_telemetry/rte_telemetry.c | 3 + lib/librte_telemetry/rte_telemetry.h | 59 ++++ .../rte_telemetry_version.map | 2 + lib/librte_telemetry/telemetry.c | 257 ++++++++++++++++++ 6 files changed, 330 insertions(+), 1 deletion(-) create mode 100644 lib/librte_telemetry/telemetry.c
lib/librte_telemetry/Makefile +4 -0
@@ -10,6 +10,9 @@ CFLAGS += -O3 CFLAGS += $(WERROR_FLAGS) -I$(SRCDIR) CFLAGS += -DALLOW_EXPERIMENTAL_API CFLAGS += -I$(RTE_SDK)/lib/librte_metrics/ +CFLAGS += -I$(RTE_SDK)/lib/librte_eal/common/include +CFLAGS += -I$(RTE_SDK)/lib/librte_eal/common/include/arch/$(ARCH_DIR)/ +CFLAGS += -pthread LDLIBS += -lrte_eal LDLIBS += -lrte_metrics
@@ -22,6 +25,7 @@ EXPORT_MAP := rte_telemetry_version.map SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) := rte_telemetry.c SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += rte_telemetry_parser.c SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += rte_telemetry_parser_test.c +SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += telemetry.c # export include files SYMLINK-$(CONFIG_RTE_LIBRTE_TELEMETRY)-include := rte_telemetry.h
lib/librte_telemetry/meson.build +5 -1
@@ -1,7 +1,11 @@ # SPDX-License-Identifier: BSD-3-Clause # Copyright(c) 2018 Intel Corporation -sources = files('rte_telemetry.c', 'rte_telemetry_parser.c', 'rte_telemetry_parser_test.c') +includes = [global_inc] +includes += include_directories('../librte_eal/common/include/arch/' + arch_subdir) + +sources = files('rte_telemetry.c', 'rte_telemetry_parser.c', 'rte_telemetry_parser_test.c', + 'telemetry.c') headers = files('rte_telemetry.h', 'rte_telemetry_internal.h', 'rte_telemetry_parser.h') cflags += '-DALLOW_EXPERIMENTAL_API' includes += include_directories('../librte_metrics')
lib/librte_telemetry/rte_telemetry.c +3 -0
@@ -503,6 +503,9 @@ rte_telemetry_init(void)return -EPERM ; } +if (rte_telemetry_new_init () !=0 ) +return -1 ; +return 0 ; }
lib/librte_telemetry/rte_telemetry.h +59 -0
79 lines not on this page · raw message
lib/librte_telemetry/rte_telemetry_version.map +2 -0
@@ -6,6 +6,8 @@ EXPERIMENTAL { rte_telemetry_parse; rte_telemetry_selftest; rte_telemetry_set_metrics_fns; + rte_telemetry_new_init; + rte_telemetry_register_cmd; local: *; };
lib/librte_telemetry/telemetry.c new file +257 -0
257 lines not on this page · raw message
Signature · 1 line
2.17.1
PATCH 5/12 ethdev: add callback support for telemetry
In reply to Ciara PowerFrom: Bruce Richardson <[email protected]>
The ethdev library now registers commands with telemetry, and implements the callback functions. These commands allow the list of ethdev ports and the stats for a port to be queried.
--- lib/librte_ethdev/Makefile | 4 ++ lib/librte_ethdev/meson.build | 4 ++ lib/librte_ethdev/rte_ethdev.c | 79 ++++++++++++++++++++++++++++++++++ 3 files changed, 87 insertions(+)
lib/librte_ethdev/Makefile +4 -0
@@ -24,6 +24,10 @@ SRCS-y += rte_tm.c SRCS-y += rte_mtr.c SRCS-y += ethdev_profile.c +ifeq ($(CONFIG_RTE_LIBRTE_TELEMETRY),y) +LDLIBS += -lrte_telemetry +endif + # # Export include files #
lib/librte_ethdev/meson.build +4 -0
@@ -26,3 +26,7 @@ headers = files('rte_ethdev.h', 'rte_tm_driver.h') deps += ['net', 'kvargs', 'meter'] + +if dpdk_conf.has('RTE_LIBRTE_TELEMETRY') + deps += ['telemetry'] +endif
lib/librte_ethdev/rte_ethdev.c +79 -0
94 lines not on this page · raw message
Signature · 1 line
2.17.1
PATCH 6/12 usertools: add new telemetry python script
In reply to Ciara PowerFrom: Bruce Richardson <[email protected]>
This patch adds a python script that can be used with the new telemetry socket. It connects as a client to the socket, and allows the user send a command and see the JSON response.
The example usage below shows the script connecting to the new telemetry socket, and sending two basic ethdev commands entered by the user. The response for each command is shown below the user input.
Connecting to /var/run/dpdk/rte/dpdk_telemetry.19707 --> /
{"/": ["/", "/ethdev/list", "/ethdev/stats"]}
--> /ethdev/list
{"/ethdev/list": [0, 1]}
--> /ethdev/stats,0
{"/ethdev/stats": {"rx_good_packets": 0, "tx_good_packets": 0, <snip>
"tx_priority7_xon_to_xoff_packets": 0}}
---
This is a temporary script for testing purposes. Later versions of the patchset will include a production ready version, which may be merged into the existing dpdk_telemetry script.
--- usertools/test_new_telemetry.py | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100755 usertools/test_new_telemetry.py
usertools/test_new_telemetry.py new file +30 -0
@@ -0,0 +1,30 @@ +#! /usr/bin/python3 +# SPDX-License-Identifier: BSD-3-Clause +# Copyright(c) 2020 Intel Corporation + +import socket +import os +import glob +import json + +def handle_socket(path): + print("Connecting to " + path) + try: + fd.connect(path) + except OSError: + return + text = input('--> ') + while (text != "quit"): + fd.send(text.encode()) + reply = json.loads(fd.recv(1024 * 12).decode()) + print(json.dumps(reply)) + text = input('--> ') + fd.close() + +fd = socket.socket(socket.AF_UNIX, socket.SOCK_SEQPACKET) +# Path to sockets for processes run as a root user +for f in glob.glob('/var/run/dpdk/*/dpdk_telemetry.*'): + handle_socket(f) +# Path to sockets for processes run as a regular user +for f in glob.glob('/run/user/%d/dpdk/*/dpdk_telemetry.*' % os.getuid()): + handle_socket(f)
Signature · 1 line
2.17.1
PATCH 7/12 rawdev: add callback support for telemetry
In reply to Ciara PowerThe rawdev library now registers commands with telemetry, and implements the corresponding callback functions. These allow a list of rawdev devices and stats for a rawdev port to be queried.
An example usage, with ioat rawdev driver instances, is shown below:
Connecting to /var/run/dpdk/rte/dpdk_telemetry.22345 --> /
{"/": ["/", "/ethdev/list", "/ethdev/stats", "/rawdev/list",
"/rawdev/stats"]}
--> /rawdev/list
{"/rawdev/list": [0, 1, 2, 3, 4, 5]}
--> /rawdev/stats,0
{"/rawdev/stats": {"failed_enqueues": 0, "successful_enqueues": 0,
"copies_started": 0, "copies_completed": 0}}
--- lib/librte_rawdev/Makefile | 5 ++ lib/librte_rawdev/meson.build | 5 ++ lib/librte_rawdev/rte_rawdev.c | 88 ++++++++++++++++++++++++++++++++++ 3 files changed, 98 insertions(+)
lib/librte_rawdev/Makefile +5 -0
@@ -11,6 +11,11 @@ CFLAGS += -O3 CFLAGS += $(WERROR_FLAGS) LDLIBS += -lrte_eal +ifeq ($(CONFIG_RTE_LIBRTE_TELEMETRY),y) +CFLAGS += -DALLOW_EXPERIMENTAL_API +LDLIBS += -lrte_telemetry +endif + # library source files SRCS-y += rte_rawdev.c
lib/librte_rawdev/meson.build +5 -0
@@ -3,3 +3,8 @@ sources = files('rte_rawdev.c') headers = files('rte_rawdev.h', 'rte_rawdev_pmd.h') + +if dpdk_conf.has('RTE_LIBRTE_TELEMETRY') + allow_experimental_apis = true + deps += ['telemetry'] +endif
lib/librte_rawdev/rte_rawdev.c +88 -0
103 lines not on this page · raw message
Signature · 1 line
2.17.1
PATCH 8/12 examples/l3fwd-power: enable use of new telemetry
In reply to Ciara PowerThe l3fwd-power example app now registers a stats command with telemetry, and provides a callback function to handle formatting the power stats.
An example usage is shown below:
Connecting to /var/run/dpdk/rte/dpdk_telemetry.23863
--> /
{"/": ["/", "/ethdev/list", "/ethdev/stats", "/l3fwd-power/stats"]} --> /l3fwd-power/stats
{"/l3fwd-power/stats": {"empty_poll": 281625000, "full_poll": 0,
"busy_percent": 0}}
The existing stats tracking done by the app using the metrics library is unaffected. This will still be used to ensure backward compatibility.
--- examples/l3fwd-power/Makefile | 4 +++ examples/l3fwd-power/main.c | 62 ++++++++++++++++++++++++-------- examples/l3fwd-power/meson.build | 4 +++ 3 files changed, 56 insertions(+), 14 deletions(-)
examples/l3fwd-power/Makefile +4 -0
@@ -68,6 +68,10 @@ ifeq ($(CONFIG_RTE_TOOLCHAIN_GCC),y) CFLAGS_main.o += -Wno-return-type endif +ifeq ($(CONFIG_RTE_LIBRTE_TELEMETRY),y) +LDLIBS += -lrte_telemetry +endif + include $(RTE_SDK)/mk/rte.extapp.mk endif endif
examples/l3fwd-power/main.c +48 -14
116 lines not on this page · raw message
examples/l3fwd-power/meson.build +4 -0
@@ -16,3 +16,7 @@ deps += ['power', 'timer', 'lpm', 'hash', 'metrics'] sources = files( 'main.c', 'perf_core.c' ) + +if dpdk_conf.has('RTE_LIBRTE_TELEMETRY') + deps += ['telemetry'] +endif
Signature · 1 line
2.17.1
PATCH 9/12 telemetry: introduce telemetry backward compatibility
In reply to Ciara PowerThe new telemetry will now open a socket using the old telemetry path, to ensure backward compatibility. This is not yet initialised, as it would clash with the existing telemetry, to be removed in a later patch. This means that both old and new telemetry socket interfaces are handled in a common way.
--- lib/librte_metrics/Makefile | 2 +- lib/librte_metrics/meson.build | 1 + lib/librte_metrics/rte_metrics_telemetry.c | 113 +++++++++ lib/librte_telemetry/Makefile | 1 + lib/librte_telemetry/meson.build | 4 +- lib/librte_telemetry/rte_telemetry.h | 1 + lib/librte_telemetry/rte_telemetry_legacy.h | 48 ++++ .../rte_telemetry_version.map | 2 + lib/librte_telemetry/telemetry.c | 32 +++ lib/librte_telemetry/telemetry_legacy.c | 226 ++++++++++++++++++ 10 files changed, 427 insertions(+), 3 deletions(-) create mode 100644 lib/librte_telemetry/rte_telemetry_legacy.h create mode 100644 lib/librte_telemetry/telemetry_legacy.c
lib/librte_metrics/Makefile +1 -1
@@ -21,7 +21,7 @@ ifneq ($(JANSSON_LINK),) SRCS-y += rte_metrics_telemetry.c SYMLINK-$(CONFIG_RTE_LIBRTE_METRICS)-include += rte_metrics_telemetry.h -LDLIBS += -lrte_ethdev +LDLIBS += -lrte_ethdev -lrte_telemetry LDLIBS += $(JANSSON_LINK) CFLAGS += $(JANSSON_CFLAGS)
lib/librte_metrics/meson.build +1 -0
@@ -11,4 +11,5 @@ if jansson.found() sources += files('rte_metrics_telemetry.c') headers = files('rte_metrics_telemetry.h') deps += ['ethdev', 'telemetry'] + includes += include_directories('../librte_telemetry') endif
lib/librte_metrics/rte_metrics_telemetry.c +113 -0
131 lines not on this page · raw message
lib/librte_telemetry/Makefile +1 -0
@@ -26,6 +26,7 @@ SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) := rte_telemetry.c SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += rte_telemetry_parser.c SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += rte_telemetry_parser_test.c SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += telemetry.c +SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += telemetry_legacy.c # export include files SYMLINK-$(CONFIG_RTE_LIBRTE_TELEMETRY)-include := rte_telemetry.h
lib/librte_telemetry/meson.build +2 -2
@@ -4,8 +4,8 @@ includes = [global_inc] includes += include_directories('../librte_eal/common/include/arch/' + arch_subdir) -sources = files('rte_telemetry.c', 'rte_telemetry_parser.c', 'rte_telemetry_parser_test.c', - 'telemetry.c') +sources = files('rte_telemetry.c','rte_telemetry_parser.c', 'rte_telemetry_parser_test.c', + 'telemetry.c', 'telemetry_legacy.c') headers = files('rte_telemetry.h', 'rte_telemetry_internal.h', 'rte_telemetry_parser.h') cflags += '-DALLOW_EXPERIMENTAL_API' includes += include_directories('../librte_metrics')
lib/librte_telemetry/rte_telemetry.h +1 -0
@@ -125,4 +125,5 @@ int rte_telemetry_register_cmd(const char *cmd, telemetry_cb fn);*/ __rte_experimental int rte_telemetry_new_init(void); +#endif
lib/librte_telemetry/rte_telemetry_legacy.h new file +48 -0
48 lines not on this page · raw message
lib/librte_telemetry/rte_telemetry_version.map +2 -0
@@ -8,6 +8,8 @@ EXPERIMENTAL { rte_telemetry_set_metrics_fns; rte_telemetry_new_init; rte_telemetry_register_cmd; + rte_telemetry_legacy_init; + rte_telemetry_legacy_register; local: *; };
lib/librte_telemetry/telemetry.c +32 -0
@@ -15,6 +15,7 @@#include <rte_spinlock.h> #include "rte_telemetry.h" +#include "rte_telemetry_legacy.h" #define MAX_CMD_LEN 56
@@ -36,6 +37,7 @@ struct socket {handler fn; };static struct socket v2_socket;/* socket for v2 telemetry */ +static struct socket v1_socket;/* socket for v1 telemetry */ static char telemetry_log_error[1024 ];/* Will contain error on init failure */ /* list of command callbacks, with one command registered by default */ static struct cmd_callback callbacks[TELEMETRY_MAX_CALLBACKS ] = {
@@ -182,6 +184,8 @@ unlink_sockets(void) {if (v2_socket.path[0 ])unlink (v2_socket.path); +if (v1_socket.path[0 ]) +unlink (v1_socket.path); } static int
@@ -221,6 +225,34 @@ create_socket(char *path)return -1 ; } +static int __rte_unused /* will be used in future commit */ +telemetry_legacy_init (const char *runtime_dir,const char **err_str) +{ +pthread_t t_old; + +if (num_legacy_callbacks ==1 ) { + *err_str ="No legacy callbacks - error creating legacy socket" ; +return -1 ; + } + + v1_socket.fn = legacy_client_handler; +if ((size_t )snprintf (v1_socket.path,sizeof (v1_socket.path), +"%s/telemetry" , runtime_dir) + >=sizeof (v1_socket.path)) { +snprintf (telemetry_log_error,sizeof (telemetry_log_error), +"Error with socket binding, path too long" ); +return -1 ; + } + v1_socket.sock =create_socket (v1_socket.path); +if (v1_socket.sock <0 ) { + *err_str = telemetry_log_error; +return -1 ; + } +pthread_create (&t_old,NULL , socket_listener, &v1_socket); + +return 0 ; +} +static int telemetry_v2_init (const char *runtime_dir,const char **err_str) {
lib/librte_telemetry/telemetry_legacy.c new file +226 -0
226 lines not on this page · raw message
Signature · 1 line
2.17.1
PATCH 10/12 telemetry: remove existing telemetry files
In reply to Ciara PowerThis patch removes the existing telemetry files, which are now redundant as the new version of telemetry has backward compatibility for their functionality.
--- lib/librte_metrics/rte_metrics_telemetry.c | 9 - lib/librte_telemetry/Makefile | 5 - lib/librte_telemetry/meson.build | 15 +- lib/librte_telemetry/rte_telemetry.c | 1384 ----------------- lib/librte_telemetry/rte_telemetry.h | 57 +- lib/librte_telemetry/rte_telemetry_internal.h | 114 -- lib/librte_telemetry/rte_telemetry_parser.c | 435 ------ lib/librte_telemetry/rte_telemetry_parser.h | 15 - .../rte_telemetry_parser_test.c | 533 ------- .../rte_telemetry_socket_tests.h | 36 - .../rte_telemetry_version.map | 6 - lib/librte_telemetry/telemetry.c | 19 +- 12 files changed, 24 insertions(+), 2604 deletions(-) delete mode 100644 lib/librte_telemetry/rte_telemetry.c delete mode 100644 lib/librte_telemetry/rte_telemetry_internal.h delete mode 100644 lib/librte_telemetry/rte_telemetry_parser.c delete mode 100644 lib/librte_telemetry/rte_telemetry_parser.h delete mode 100644 lib/librte_telemetry/rte_telemetry_parser_test.c delete mode 100644 lib/librte_telemetry/rte_telemetry_socket_tests.h
lib/librte_metrics/rte_metrics_telemetry.c +0 -9
@@ -7,7 +7,6 @@#include <rte_ethdev.h> #include <rte_string_fns.h> #ifdef RTE_LIBRTE_TELEMETRY -#include <rte_telemetry_internal.h> #include <rte_telemetry_legacy.h> #endif
@@ -527,14 +526,6 @@ handle_ports_stats_values_by_name(const char *cmd __rte_unused,RTE_INIT (metrics_ctor) {#ifdef RTE_LIBRTE_TELEMETRY -static const struct metrics_functions fns = { - .reg_all_ethdev = rte_metrics_tel_reg_all_ethdev, - .encode_json_format = rte_metrics_tel_encode_json_format, - .get_port_stats_ids = rte_metrics_tel_get_port_stats_ids, - .get_ports_stats_json = rte_metrics_tel_get_ports_stats_json, - .extract_data = rte_metrics_tel_extract_data - }; -rte_telemetry_set_metrics_fns (&fns);/* assign them to telemetry lib */ rte_telemetry_legacy_register ("ports_all_stat_values" ,DATA_NOT_REQ , handle_ports_all_stats_values); rte_telemetry_legacy_register("global_stat_values", DATA_NOT_REQ,
lib/librte_telemetry/Makefile +0 -5
@@ -15,16 +15,11 @@ CFLAGS += -I$(RTE_SDK)/lib/librte_eal/common/include/arch/$(ARCH_DIR)/ CFLAGS += -pthread LDLIBS += -lrte_eal -LDLIBS += -lrte_metrics LDLIBS += -lpthread -LDLIBS += -ljansson EXPORT_MAP := rte_telemetry_version.map # library source files -SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) := rte_telemetry.c -SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += rte_telemetry_parser.c -SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += rte_telemetry_parser_test.c SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += telemetry.c SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += telemetry_legacy.c
lib/librte_telemetry/meson.build +3 -12
@@ -4,17 +4,8 @@ includes = [global_inc] includes += include_directories('../librte_eal/common/include/arch/' + arch_subdir) -sources = files('rte_telemetry.c','rte_telemetry_parser.c', 'rte_telemetry_parser_test.c', - 'telemetry.c', 'telemetry_legacy.c') -headers = files('rte_telemetry.h', 'rte_telemetry_internal.h', 'rte_telemetry_parser.h') +sources = files('telemetry.c', 'telemetry_legacy.c') +headers = files('rte_telemetry.h') cflags += '-DALLOW_EXPERIMENTAL_API' includes += include_directories('../librte_metrics') - -jansson = dependency('jansson', required: false) -if jansson.found() - ext_deps += jansson - dpdk_app_link_libraries += ['telemetry'] -else - build = false - reason = 'missing dependency "jansson"' -endif +dpdk_app_link_libraries += ['telemetry']
lib/librte_telemetry/rte_telemetry.c deleted +0 -1384
1,384 lines not on this page · raw message
lib/librte_telemetry/rte_telemetry.h +4 -53
81 lines not on this page · raw message
lib/librte_telemetry/rte_telemetry_internal.h deleted +0 -114
114 lines not on this page · raw message
lib/librte_telemetry/rte_telemetry_parser.c deleted +0 -435
435 lines not on this page · raw message
lib/librte_telemetry/rte_telemetry_parser.h deleted +0 -15
@@ -1,15 +0,0 @@ -/* SPDX-License-Identifier: BSD-3-Clause -* Copyright(c) 2018 Intel Corporation -*/ - -#include "rte_telemetry_internal.h" -#include "rte_compat.h" - -#ifndef _RTE_TELEMETRY_PARSER_H_ -#define _RTE_TELEMETRY_PARSER_H_ - -__rte_experimental -int32_t -rte_telemetry_parse (struct telemetry_impl *telemetry,char *socket_rx_data); - -#endif
lib/librte_telemetry/rte_telemetry_parser_test.c deleted +0 -533
533 lines not on this page · raw message
lib/librte_telemetry/rte_telemetry_socket_tests.h deleted +0 -36
@@ -1,36 +0,0 @@ -/* SPDX-License-Identifier: BSD-3-Clause -* Copyright(c) 2018 Intel Corporation -*/ - -#include <stdbool.h> - -#include "rte_telemetry_internal.h" - -#ifndef _RTE_TELEMETRY_SOCKET_TESTING_H_ -#define _RTE_TELEMETRY_SOCKET_TESTING_H_ - -int32_t -rte_telemetry_json_socket_message_test (struct telemetry_impl *telemetry, -int fd); - -int32_t -rte_telemetry_invalid_json_test (struct telemetry_impl *telemetry,int fd); - -int32_t -rte_telemetry_valid_json_test (struct telemetry_impl *telemetry,int fd); - -int32_t -rte_telemetry_json_contents_test (struct telemetry_impl *telemetry,int fd); - -int32_t -rte_telemetry_json_empty_test (struct telemetry_impl *telemetry,int fd); - -int32_t -rte_telemetry_socket_register_test (struct telemetry_impl *telemetry,int *fd, -int send_fd,int recv_fd); - -int32_t -rte_telemetry_socket_test_setup (struct telemetry_impl *telemetry,int *send_fd, -int *recv_fd); - -#endif
lib/librte_telemetry/rte_telemetry_version.map +0 -6
@@ -1,14 +1,8 @@ EXPERIMENTAL { global: - rte_telemetry_cleanup; rte_telemetry_init; - rte_telemetry_parse; - rte_telemetry_selftest; - rte_telemetry_set_metrics_fns; - rte_telemetry_new_init; rte_telemetry_register_cmd; - rte_telemetry_legacy_init; rte_telemetry_legacy_register; local: *;
lib/librte_telemetry/telemetry.c +17 -2
@@ -13,6 +13,7 @@#include <rte_string_fns.h> #include <rte_common.h> #include <rte_spinlock.h> +#include <rte_option.h> #include "rte_telemetry.h" #include "rte_telemetry_legacy.h"
@@ -225,7 +226,7 @@ create_socket(char *path)return -1 ; } -static int __rte_unused /* will be used in future commit */ +static int telemetry_legacy_init (const char *runtime_dir,const char **err_str) {pthread_t t_old;
@@ -278,12 +279,26 @@ telemetry_v2_init(const char *runtime_dir, const char **err_str) }int32_t -rte_telemetry_new_init (void ) +rte_telemetry_init (void ) {const char *error_str;if (telemetry_v2_init (rte_eal_get_runtime_dir (), &error_str) !=0 ) {printf ("Error initialising telemetry - %s" , error_str);return -1 ; } +if (telemetry_legacy_init (rte_eal_get_runtime_dir (), &error_str) + !=0 ) +printf ("No telemetry legacy support- %s" , error_str);return 0 ; } + +static struct rte_option option = { + .name ="telemetry" , + .usage ="Enable telemetry backend" , + .cb = &rte_telemetry_init, + .enabled =0 +}; + +RTE_INIT (telemetry_register_op) { +rte_option_register (&option); +}
Signature · 1 line
2.17.1
PATCH 11/12 lib: add telemetry as eal dependency
In reply to Ciara PowerThis patch moves telemetry further down the build, and adds it as a dependency for EAL. Telemetry is now configured to build by default, and has EAL flags, shown below:
"--telemetry" = Enables telemetry (this is default if no flags given) "--no-telemetry" = Disables telemetry
When telemetry is enabled, it will attempt to open the new socket version, and also the legacy support socket (this will depend on Jansson external dependency, as before).
--- config/common_base | 2 +- lib/Makefile | 5 ++--- lib/librte_eal/common/eal_common_options.c | 9 ++++++++ lib/librte_eal/common/eal_internal_cfg.h | 1 + lib/librte_eal/common/eal_options.h | 4 ++++ lib/librte_eal/freebsd/eal/Makefile | 1 + lib/librte_eal/freebsd/eal/eal.c | 9 ++++++++ lib/librte_eal/freebsd/eal/meson.build | 2 +- lib/librte_eal/linux/eal/Makefile | 1 + lib/librte_eal/linux/eal/eal.c | 9 ++++++++ lib/librte_eal/linux/eal/meson.build | 2 +- lib/librte_eal/meson.build | 2 +- lib/librte_telemetry/Makefile | 1 - lib/librte_telemetry/meson.build | 1 - lib/librte_telemetry/rte_telemetry.h | 2 +- lib/librte_telemetry/telemetry.c | 24 +++++----------------- lib/meson.build | 2 +- mk/rte.app.mk | 3 ++- 18 files changed, 49 insertions(+), 31 deletions(-)
config/common_base +1 -1
@@ -919,7 +919,7 @@ CONFIG_RTE_LIBRTE_LATENCY_STATS=y # # Compile librte_telemetry # -CONFIG_RTE_LIBRTE_TELEMETRY=n +CONFIG_RTE_LIBRTE_TELEMETRY=y # # Compile librte_rcu
lib/Makefile +2 -3
@@ -4,8 +4,9 @@ include $(RTE_SDK)/mk/rte.vars.mk DIRS-$(CONFIG_RTE_LIBRTE_KVARGS) += librte_kvargs +DIRS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += librte_telemetry DIRS-$(CONFIG_RTE_LIBRTE_EAL) += librte_eal -DEPDIRS-librte_eal := librte_kvargs +DEPDIRS-librte_eal := librte_kvargs librte_telemetry DIRS-$(CONFIG_RTE_LIBRTE_PCI) += librte_pci DEPDIRS-librte_pci := librte_eal DIRS-$(CONFIG_RTE_LIBRTE_RING) += librte_ring
@@ -22,8 +23,6 @@ DIRS-$(CONFIG_RTE_LIBRTE_CFGFILE) += librte_cfgfile DEPDIRS-librte_cfgfile := librte_eal DIRS-$(CONFIG_RTE_LIBRTE_CMDLINE) += librte_cmdline DEPDIRS-librte_cmdline := librte_eal librte_net -DIRS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += librte_telemetry -DEPDIRS-librte_telemetry := librte_eal DIRS-$(CONFIG_RTE_LIBRTE_ETHER) += librte_ethdev DEPDIRS-librte_ethdev := librte_net librte_eal librte_mempool librte_ring DEPDIRS-librte_ethdev += librte_mbuf
lib/librte_eal/common/eal_common_options.c +9 -0
@@ -86,6 +86,8 @@ eal_long_options[] = { {OPT_LEGACY_MEM, 0, NULL, OPT_LEGACY_MEM_NUM }, {OPT_SINGLE_FILE_SEGMENTS, 0, NULL, OPT_SINGLE_FILE_SEGMENTS_NUM}, {OPT_MATCH_ALLOCATIONS, 0, NULL, OPT_MATCH_ALLOCATIONS_NUM}, + {OPT_TELEMETRY, 0, NULL, OPT_TELEMETRY_NUM }, + {OPT_NO_TELEMETRY, 0, NULL, OPT_NO_TELEMETRY_NUM }, {0, 0, NULL, 0 } };
@@ -1455,6 +1457,11 @@ eal_parse_common_option(int opt, const char *optarg,return -1 ; }break ; +case OPT_TELEMETRY_NUM : +break ; +case OPT_NO_TELEMETRY_NUM : + conf->no_telemetry =1 ; +break ;/* don't know what to do, leave this to caller */ default :
@@ -1698,6 +1705,8 @@ eal_common_usage(void)" --" OPT_IN_MEMORY " Operate entirely in memory. This will\n" " disable secondary process support\n" " --" OPT_BASE_VIRTADDR " Base virtual address\n" +" --" OPT_TELEMETRY " Enable telemetry support (on by default)\n" +" --" OPT_NO_TELEMETRY " Disable telemetry support\n" "\nEAL options for DEBUG use only:\n" " --" OPT_HUGE_UNLINK " Unlink hugepage files after init\n" " --" OPT_NO_HUGE " Use malloc instead of hugetlbfs\n"
lib/librte_eal/common/eal_internal_cfg.h +1 -0
@@ -82,6 +82,7 @@ struct internal_config {rte_cpuset_t ctrl_cpuset;/**< cpuset for ctrl threads */ volatile unsigned int init_complete;/**< indicates whether EAL has completed initialization */ +unsigned int no_telemetry;/**< true to disable Telemetry */ };extern struct internal_config internal_config;/**< Global EAL configuration. */
lib/librte_eal/common/eal_options.h +4 -0
@@ -69,6 +69,10 @@ enum {OPT_IOVA_MODE_NUM , #define OPT_MATCH_ALLOCATIONS "match-allocations"OPT_MATCH_ALLOCATIONS_NUM , +#define OPT_TELEMETRY "telemetry" +OPT_TELEMETRY_NUM , +#define OPT_NO_TELEMETRY "no-telemetry" +OPT_NO_TELEMETRY_NUM , OPT_LONG_MAX_NUM };
lib/librte_eal/freebsd/eal/Makefile +1 -0
@@ -19,6 +19,7 @@ LDLIBS += -lexecinfo LDLIBS += -lpthread LDLIBS += -lgcc_s LDLIBS += -lrte_kvargs +LDLIBS += -lrte_telemetry EXPORT_MAP := ../../rte_eal_version.map
lib/librte_eal/freebsd/eal/eal.c +9 -0
@@ -44,6 +44,7 @@#include <rte_option.h> #include <rte_atomic.h> #include <malloc_heap.h> +#include <rte_telemetry.h> #include "eal_private.h" #include "eal_thread.h"
@@ -952,6 +953,14 @@ rte_eal_init(int argc, char **argv)rte_eal_init_alert ("Cannot clear runtime directory\n" );return -1 ; } +if (!internal_config.no_telemetry) { +const char *error_str; +if (rte_telemetry_init (rte_eal_get_runtime_dir (), + &error_str) !=0 ) { +rte_eal_init_alert (error_str); +return -1 ; + } + }eal_mcfg_complete ();
lib/librte_eal/freebsd/eal/meson.build +1 -1
@@ -19,4 +19,4 @@ env_sources = files('eal_alarm.c', 'eal_dev.c' ) -deps += ['kvargs'] +deps += ['kvargs', 'telemetry']
lib/librte_eal/linux/eal/Makefile +1 -0
@@ -23,6 +23,7 @@ LDLIBS += -lpthread LDLIBS += -lgcc_s LDLIBS += -lrt LDLIBS += -lrte_kvargs +LDLIBS += -lrte_telemetry ifeq ($(CONFIG_RTE_EAL_NUMA_AWARE_HUGEPAGES),y) LDLIBS += -lnuma endif
lib/librte_eal/linux/eal/eal.c +9 -0
@@ -51,6 +51,7 @@#include <malloc_heap.h> #include <rte_vfio.h> #include <rte_option.h> +#include <rte_telemetry.h> #include "eal_private.h" #include "eal_thread.h"
@@ -1291,6 +1292,14 @@ rte_eal_init(int argc, char **argv)rte_eal_init_alert ("Cannot clear runtime directory\n" );return -1 ; } +if (!internal_config.no_telemetry) { +const char *error_str; +if (rte_telemetry_init (rte_eal_get_runtime_dir (), + &error_str) !=0 ) { +rte_eal_init_alert (error_str); +return -1 ; + } + }eal_mcfg_complete ();
lib/librte_eal/linux/eal/meson.build +1 -1
@@ -25,7 +25,7 @@ env_sources = files('eal_alarm.c', 'eal_dev.c', ) -deps += ['kvargs'] +deps += ['kvargs', 'telemetry'] if has_libnuma == 1 dpdk_conf.set10('RTE_EAL_NUMA_AWARE_HUGEPAGES', true) endif
lib/librte_eal/meson.build +1 -1
@@ -13,7 +13,7 @@ dpdk_conf.set('RTE_EXEC_ENV_' + exec_env.to_upper(), 1) subdir(exec_env + '/eal') allow_experimental_apis = true -deps += 'kvargs' +deps += ['kvargs', 'telemetry'] if dpdk_conf.has('RTE_USE_LIBBSD') ext_deps += libbsd endif
lib/librte_telemetry/Makefile +0 -1
@@ -14,7 +14,6 @@ CFLAGS += -I$(RTE_SDK)/lib/librte_eal/common/include CFLAGS += -I$(RTE_SDK)/lib/librte_eal/common/include/arch/$(ARCH_DIR)/ CFLAGS += -pthread -LDLIBS += -lrte_eal LDLIBS += -lpthread EXPORT_MAP := rte_telemetry_version.map
lib/librte_telemetry/meson.build +0 -1
@@ -8,4 +8,3 @@ sources = files('telemetry.c', 'telemetry_legacy.c') headers = files('rte_telemetry.h') cflags += '-DALLOW_EXPERIMENTAL_API' includes += include_directories('../librte_metrics') -dpdk_app_link_libraries += ['telemetry']
lib/librte_telemetry/rte_telemetry.h +1 -1
@@ -75,6 +75,6 @@ int rte_telemetry_register_cmd(const char *cmd, telemetry_cb fn);* -1 on failure. */ __rte_experimental -int rte_telemetry_init(void); +int rte_telemetry_init(const char *runtime_dir, const char **err_str);#endif
lib/librte_telemetry/telemetry.c +5 -19
@@ -13,7 +13,6 @@#include <rte_string_fns.h> #include <rte_common.h> #include <rte_spinlock.h> -#include <rte_option.h> #include "rte_telemetry.h" #include "rte_telemetry_legacy.h"
@@ -279,26 +278,13 @@ telemetry_v2_init(const char *runtime_dir, const char **err_str) }int32_t -rte_telemetry_init (void ) +rte_telemetry_init (const char *runtime_dir,const char **err_str) { -const char *error_str; -if (telemetry_v2_init (rte_eal_get_runtime_dir (), &error_str) !=0 ) { -printf ("Error initialising telemetry - %s" , error_str); +if (telemetry_v2_init (runtime_dir, err_str) !=0 ) { +printf ("Error initialising telemetry - %s" , *err_str);return -1 ; } -if (telemetry_legacy_init (rte_eal_get_runtime_dir (), &error_str) - !=0 ) -printf ("No telemetry legacy support- %s" , error_str); +if (telemetry_legacy_init (runtime_dir, err_str) !=0 ) +printf ("No telemetry legacy support- %s" , *err_str);return 0 ; } - -static struct rte_option option = { - .name ="telemetry" , - .usage ="Enable telemetry backend" , - .cb = &rte_telemetry_init, - .enabled =0 -}; - -RTE_INIT (telemetry_register_op) { -rte_option_register (&option); -}
lib/meson.build +1 -1
@@ -10,8 +10,8 @@ # core libs which are widely reused, so their deps are kept to a minimum. libraries = [ 'kvargs', # eal depends on kvargs + 'telemetry', # basic info querying capability about dpdk processes 'eal', # everything depends on eal - 'telemetry', 'ring', 'mempool', 'mbuf', 'net', 'meter', 'ethdev', 'pci', # core 'cmdline', 'metrics', # bitrate/latency stats depends on this
mk/rte.app.mk +2 -1
@@ -52,6 +52,7 @@ _LDLIBS-$(CONFIG_RTE_LIBRTE_ACL) += -lrte_acl _LDLIBS-$(CONFIG_RTE_LIBRTE_JOBSTATS) += -lrte_jobstats _LDLIBS-$(CONFIG_RTE_LIBRTE_METRICS) += --whole-archive _LDLIBS-$(CONFIG_RTE_LIBRTE_METRICS) += -lrte_metrics +_LDLIBS-y += $(shell $(PKG_CONFIG) --libs jansson 2> /dev/null) _LDLIBS-$(CONFIG_RTE_LIBRTE_METRICS) += --no-whole-archive _LDLIBS-$(CONFIG_RTE_LIBRTE_BITRATE) += -lrte_bitratestats _LDLIBS-$(CONFIG_RTE_LIBRTE_LATENCY_STATS) += -lrte_latencystats
@@ -74,6 +75,7 @@ _LDLIBS-$(CONFIG_RTE_LIBRTE_HASH) += -lrte_hash _LDLIBS-$(CONFIG_RTE_LIBRTE_MEMBER) += -lrte_member _LDLIBS-$(CONFIG_RTE_LIBRTE_VHOST) += -lrte_vhost _LDLIBS-$(CONFIG_RTE_LIBRTE_KVARGS) += -lrte_kvargs +_LDLIBS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += -lrte_telemetry _LDLIBS-$(CONFIG_RTE_LIBRTE_MBUF) += -lrte_mbuf _LDLIBS-$(CONFIG_RTE_LIBRTE_NET) += -lrte_net _LDLIBS-$(CONFIG_RTE_LIBRTE_ETHER) += -lrte_ethdev
@@ -90,7 +92,6 @@ _LDLIBS-$(CONFIG_RTE_DRIVER_MEMPOOL_RING) += -lrte_mempool_ring _LDLIBS-$(CONFIG_RTE_LIBRTE_OCTEONTX2_MEMPOOL) += -lrte_mempool_octeontx2 _LDLIBS-$(CONFIG_RTE_LIBRTE_RING) += -lrte_ring _LDLIBS-$(CONFIG_RTE_LIBRTE_PCI) += -lrte_pci -_LDLIBS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += -lrte_telemetry -ljansson _LDLIBS-$(CONFIG_RTE_LIBRTE_EAL) += -lrte_eal _LDLIBS-$(CONFIG_RTE_LIBRTE_CMDLINE) += -lrte_cmdline _LDLIBS-$(CONFIG_RTE_LIBRTE_REORDER) += -lrte_reorder
Signature · 1 line
2.17.1
Re: [dpdk-dev] [PATCH 11/12] lib: add telemetry as eal dependency
Quoted 7 lines · Ciara Power
This patch moves telemetry further down the build, and adds it as a dependency for EAL. Telemetry is now configured to build by default, and has EAL flags, shown below:
"--telemetry" = Enables telemetry (this is default if no flags given) "--no-telemetry" = Disables telemetry
Quoted 8 lines
When telemetry is enabled, it will attempt to open the new socket version, and also the legacy support socket (this will depend on Jansson external dependency, as before).
Signed-off-by Ciara Power <[email protected]>Signed-off-by Bruce Richardson <[email protected]>--- config/common_base | 2 +-
I think, update to doc/guides/linux_gsg/eal_args.include.rst file is missing.
Quoted 17 lines
lib/Makefile | 5 ++--- lib/librte_eal/common/eal_common_options.c | 9 ++++++++ lib/librte_eal/common/eal_internal_cfg.h | 1 + lib/librte_eal/common/eal_options.h | 4 ++++ lib/librte_eal/freebsd/eal/Makefile | 1 + lib/librte_eal/freebsd/eal/eal.c | 9 ++++++++ lib/librte_eal/freebsd/eal/meson.build | 2 +- lib/librte_eal/linux/eal/Makefile | 1 + lib/librte_eal/linux/eal/eal.c | 9 ++++++++ lib/librte_eal/linux/eal/meson.build | 2 +- lib/librte_eal/meson.build | 2 +- lib/librte_telemetry/Makefile | 1 - lib/librte_telemetry/meson.build | 1 - lib/librte_telemetry/rte_telemetry.h | 2 +- lib/librte_telemetry/telemetry.c | 24 +++++----------------- lib/meson.build | 2 +- mk/rte.app.mk | 3 ++-
Re: [dpdk-dev] [PATCH 11/12] lib: add telemetry as eal dependency
Quoted 12 lines · Jerin Jacob
Quoted 11 lines · Ciara Power
This patch moves telemetry further down the build, and adds it as a dependency for EAL. Telemetry is now configured to build by default, and has EAL flags, shown below:
"--telemetry" = Enables telemetry (this is default if no flags given) "--no-telemetry" = Disables telemetryWhen telemetry is enabled, it will attempt to open the new socket version, and also the legacy support socket (this will depend on Jansson external dependency, as before).
Quoted 7 lines
Quoted 4 lines
Signed-off-by Ciara Power <[email protected]>Signed-off-by Bruce Richardson <[email protected]>--- config/common_base | 2 +-I think, update to
doc/guides/linux_gsg/eal_args.include.rstfile is missing.
Yes.
I think doc updates generally are missing from this set, but we felt it worthwhile to get a version out now for initial reviews. We'll get the doc updates in a v2, along with some other enhancements to this work.
/Bruce
PATCH 12/12 eal: add eal telemetry callbacks
In reply to Ciara PowerFrom: Bruce Richardson <[email protected]>
EAL now registers commands to provide some basic info from EAL.
Example:
Connecting to /var/run/dpdk/rte/dpdk_telemetry.66307
--> /
{"/": ["/", "/eal/app_params", "/eal/params", "/eal/version",
"/ethdev/list", "/ethdev/stats", "/rawdev/list", "/rawdev/stats"]}
--> /eal/app_params
{"/eal/app_params": ["-i"]}
--> /eal/params
{"/eal/params": ["./app/dpdk-testpmd", "--telemetry"]} --> /eal/version
{"/eal/version": "DPDK 20.05.0-rc0"}
--- lib/librte_eal/common/eal_common_options.c | 70 ++++++++++++++++++++++ lib/librte_eal/common/eal_options.h | 3 + lib/librte_eal/freebsd/eal/eal.c | 5 ++ lib/librte_eal/linux/eal/eal.c | 5 ++ 4 files changed, 83 insertions(+)
lib/librte_eal/common/eal_common_options.c +70 -0
@@ -29,6 +29,7 @@#include <rte_version.h> #include <rte_devargs.h> #include <rte_memcpy.h> +#include <rte_telemetry.h> #include "eal_internal_cfg.h" #include "eal_options.h"
@@ -132,6 +133,75 @@ static int master_lcore_parsed;static int mem_parsed;static int core_parsed; +static char **eal_args; +static char **eal_app_args; + +#define EAL_PARAM_REQ "/eal/params" +#define EAL_APP_PARAM_REQ "/eal/app_params" + +/* callback handler for telemetry library to report out EAL flags */ +int +handle_eal_info_request(const char *cmd, const char *params __rte_unused, +char *buffer,int buf_len) +{ +char **args; +int used =0 ; +int i =0 ; + +if (strcmp (cmd,EAL_PARAM_REQ ) ==0 ) + args = eal_args; +else if (strcmp (cmd,EAL_APP_PARAM_REQ ) ==0 ) + args = eal_app_args; +else /* version */ +return snprintf (buffer, buf_len,"\"%s\"" ,rte_version ()); + +if (args ==NULL || args[0 ] ==NULL ) +return snprintf (buffer, buf_len,"[]" );/* empty list */ + + used =strlcpy (buffer,"[" , buf_len); +while (args[i] !=NULL ) + used +=snprintf (buffer + used, buf_len - used,"\"%s\"," , + args[i++]); + buffer[used -1 ] =']' ; +return used; +} + +int +eal_save_args (int argc,char **argv) +{ +int i, j; + +/* clone argv to report out later. We overprovision, but +* this does not waste huge amounts of memory +*/ + eal_args =calloc (argc +1 ,sizeof (*eal_args)); +if (eal_args ==NULL ) +return -1 ; + +for (i =0 ; i < argc; i++) { + eal_args[i] =strdup (argv[i]); +if (strcmp (argv[i],"--" ) ==0 ) +break ; + } + eal_args[i++] =NULL ;/* always finish with NULL */ +rte_telemetry_register_cmd (EAL_PARAM_REQ , handle_eal_info_request); + +/* allow reporting of any app args we know about too */ +if (i == argc) +return 0 ; + + eal_app_args =calloc (argc - i +1 ,sizeof (*eal_args)); +if (eal_app_args ==NULL ) +return -1 ; + +for (j =0 ; i < argc; j++, i++) + eal_app_args[j] =strdup (argv[i]); + eal_app_args[j] =NULL ; +rte_telemetry_register_cmd (EAL_APP_PARAM_REQ , handle_eal_info_request); + +return 0 ; +} +static int eal_option_device_add (enum rte_devtype type,const char *optarg) {
lib/librte_eal/common/eal_options.h +3 -0
@@ -88,5 +88,8 @@ int eal_check_common_options(struct internal_config *internal_cfg);void eal_common_usage (void );enum rte_proc_type_t eal_proc_type_detect (void );int eal_plugins_init (void ); +int eal_save_args (int argc,char **argv); +int handle_eal_info_request(const char *cmd, const char *params __rte_unused, +char *buffer,int buf_len);#endif /* EAL_OPTIONS_H */
lib/librte_eal/freebsd/eal/eal.c +5 -0
@@ -725,6 +725,9 @@ rte_eal_init(int argc, char **argv)eal_reset_internal_config (&internal_config); +/* clone argv to report out later in telemetry */ +eal_save_args (argc, argv); +/* set log level as early as possible */ eal_log_level_parse (argc, argv);
@@ -960,6 +963,8 @@ rte_eal_init(int argc, char **argv)rte_eal_init_alert (error_str);return -1 ; } +rte_telemetry_register_cmd ("/eal/version" , + handle_eal_info_request); }eal_mcfg_complete ();
lib/librte_eal/linux/eal/eal.c +5 -0
@@ -992,6 +992,9 @@ rte_eal_init(int argc, char **argv)/* set log level as early as possible */ eal_log_level_parse (argc, argv); +/* clone argv to report out later in telemetry */ +eal_save_args (argc, argv); +if (rte_eal_cpu_init () <0 ) {rte_eal_init_alert ("Cannot detect lcores." ); rte_errno =ENOTSUP ;
@@ -1299,6 +1302,8 @@ rte_eal_init(int argc, char **argv)rte_eal_init_alert (error_str);return -1 ; } +rte_telemetry_register_cmd ("/eal/version" , + handle_eal_info_request); }eal_mcfg_complete ();
Signature · 1 line
2.17.1
Hello,
Quoted 33 lines · Ciara Power
This patchset extensively reworks the telemetry library adding new functionality and simplifying much of the existing code, while maintaining backward compatibility.
This work is based on the previously sent RFC for a "process info"
library: https://patchwork.dpdk.org/project/dpdk/list/?series=7741
However, rather than creating a new library, this patchset takes that work and merges it into the existing telemetry library, as mentioned above.The telemetry library as shipped in 19.11 is based upon the metrics library and outputs all statistics based on that as a source. However, this limits the telemetry output to only port-level statistics information, rather than allowing it to be used as a general scheme for telemetry information across all DPDK libraries.
With this patchset applied, rather than the telemetry library being responsible for pulling ethdev stats and pushing them into the metrics library for retrieval later, each library e.g. ethdev, rawdev, and even the metrics library itself (for backwards compatiblity) now handle their own stats. Any library or app can register a callback function with telemetry, which will be called if requested by the client connected via the telemetry socket. The callback function in the library/app then formats its stats, or other data, into a JSON string, and returns it to telemetry to be sent to the client.
To maintain backward compatibility, e.g. to allow the dpdk telemetry collectd plugin to continue to work, some of the existing telemetry code is kept, but is moved into the metrics library, and callbacks are registered with telemetry for the legacy commands that were supported previously.
Quoted 8 lines
The new version of the library, apart from the legacy interface support for backward compatibility, does not have an external dependency on the Jansson library, allowing the library to be enabled by default.
Note: In this version of the patchset, telemetry output is provided by the ethdev, rawdev and eal libraries, but this may be expanded further in later versions which are planned ahead of the merge deadline for 20.05
This patchset does not apply on current master.
Could you rebase it?
CI reported a build failure for Windows, please have a look.
Is there a reason to keep a separate telemetry library rather than integrate this framework into EAL?
This series removes the only user of the experimental rte_option API, which can be removed afaiu.
Thanks.
Signature · 1 line
David Marchand
Quoted 46 lines · David Marchand
Hello,
Quoted 33 lines · Ciara Power
This patchset extensively reworks the telemetry library adding new functionality and simplifying much of the existing code, while maintaining backward compatibility.
This work is based on the previously sent RFC for a "process info"
library: https://patchwork.dpdk.org/project/dpdk/list/?series=7741
However, rather than creating a new library, this patchset takes that work and merges it into the existing telemetry library, as mentioned above.The telemetry library as shipped in 19.11 is based upon the metrics library and outputs all statistics based on that as a source. However, this limits the telemetry output to only port-level statistics information, rather than allowing it to be used as a general scheme for telemetry information across all DPDK libraries.
With this patchset applied, rather than the telemetry library being responsible for pulling ethdev stats and pushing them into the metrics library for retrieval later, each library e.g. ethdev, rawdev, and even the metrics library itself (for backwards compatiblity) now handle their own stats. Any library or app can register a callback function with telemetry, which will be called if requested by the client connected via the telemetry socket. The callback function in the library/app then formats its stats, or other data, into a JSON string, and returns it to telemetry to be sent to the client.
To maintain backward compatibility, e.g. to allow the dpdk telemetry collectd plugin to continue to work, some of the existing telemetry code is kept, but is moved into the metrics library, and callbacks are registered with telemetry for the legacy commands that were supported previously.
Quoted 8 lines
The new version of the library, apart from the legacy interface support for backward compatibility, does not have an external dependency on the Jansson library, allowing the library to be enabled by default.
Note: In this version of the patchset, telemetry output is provided by the ethdev, rawdev and eal libraries, but this may be expanded further in later versions which are planned ahead of the merge deadline for 20.05
Quoted 5 lines
This patchset does not apply on current master.
Could you rebase it?CI reported a build failure for Windows, please have a look.
Yep, we spotted that and will fix in V2 (which naturally will also be rebased).
Quoted 3 lines
Is there a reason to keep a separate telemetry library rather than integrate this framework into EAL?
No reason this could not be done, however, since telemetry library is already separate, and EAL is already pretty crowded, I think keeping this separate might lead to easier maintenance.
However, if people generally prefer it just merged into EAL, that can be done also.
Quoted 3 lines
This series removes the only user of the experimental
rte_optionAPI, which can be removed afaiu.
Yep, that's something we spotted and intended to flag for discussion on the V2 patchset.
My slight concern would be that having extra args for particular additional libraries is something we might want in the future, so we should think carefully before removing it. However, since overall I like shorter code, I'd personally vote in favour of removal. :-)
Regards,
/Bruce
Quoted 12 lines
From: dev [mailto:[email protected]] On Behalf Of Bruce Richardson
Sent: Wednesday, April 1, 2020 6:16 PMQuoted 3 lines · David Marchand
Hello,
On Thu, Mar 19, 2020 at 6:35 PM Ciara Power <[email protected]>
Quoted 4 lines · wrote:
Quoted 4 lines
This patchset extensively reworks the telemetry library adding new functionality and simplifying much of the existing code, while maintaining backward compatibility.
[...]
Quoted 12 lines
Quoted 3 lines
Is there a reason to keep a separate telemetry library rather than integrate this framework into EAL?
No reason this could not be done, however, since telemetry library is already separate, and EAL is already pretty crowded, I think keeping this
separate might lead to easier maintenance.However, if people generally prefer it just merged into EAL, that can be
done also.
No! EAL is the Environment Abstraction Layer. EAL should only provide the common abstraction interface for the different hardware/hypervisors and operating systems that may lie beneath the DPDK application, and nothing else.
If there is consensus that everyone absolutely needs some feature, which is not an abstraction of the underlying execution environment, it should be in a "Common" (or "Framework" or "Support") library instead.
EAL is already way too bloated.
Take Service Cores for instance: It doesn't provide a shim for the underlying execution environment; it provides a process scheduling framework, which is optional for the DPDK application to use or not.
The same goes for the Trace library. Not a shim, but a framework library.
Logging is even worse: It logs to a file, but if it was truly an environment abstraction, it would log to the Event Log on Windows. In other words... Logging is not implemented as an environment abstraction, but at the preference of its implementer. I would consider it a core/framework library, not an EAL library.
Med venlig hilsen / kind regards
- Morten Brørup
02/04/2020 10:30, Morten Brørup:
Quoted 28 lines
Quoted 12 lines
From: dev [mailto:[email protected]] On Behalf Of Bruce Richardson
Sent: Wednesday, April 1, 2020 6:16 PMQuoted 3 lines · David Marchand
Hello,
On Thu, Mar 19, 2020 at 6:35 PM Ciara Power <[email protected]>
Quoted 4 lines · wrote:
Quoted 4 lines
This patchset extensively reworks the telemetry library adding new functionality and simplifying much of the existing code, while maintaining backward compatibility.
[...]
Quoted 12 lines
Quoted 3 lines
Is there a reason to keep a separate telemetry library rather than integrate this framework into EAL?
No reason this could not be done, however, since telemetry library is already separate, and EAL is already pretty crowded, I think keeping this
separate might lead to easier maintenance.However, if people generally prefer it just merged into EAL, that can be
done also.
Quoted 5 lines
No! EAL is the Environment Abstraction Layer. EAL should only provide the common abstraction interface for the different hardware/hypervisors and operating systems that may lie beneath the DPDK application, and nothing else.
If there is consensus that everyone absolutely needs some feature, which is not an abstraction of the underlying execution environment, it should be in a "Common" (or "Framework" or "Support") library instead.
EAL is already way too bloated.
I agree. We should move some features from EAL to a separate library.
Quoted 5 lines
Take Service Cores for instance: It doesn't provide a shim for the underlying execution environment; it provides a process scheduling framework, which is optional for the DPDK application to use or not.
The same goes for the Trace library. Not a shim, but a framework library.
Logging is even worse: It logs to a file, but if it was truly an environment abstraction, it would log to the Event Log on Windows. In other words... Logging is not implemented as an environment abstraction, but at the preference of its implementer. I would consider it a core/framework library, not an EAL library.
Logging should be an OS abstraction, yes.
So logging must stay in EAL.
Quoted 36 lines · Ciara Power
This patchset extensively reworks the telemetry library adding new functionality and simplifying much of the existing code, while maintaining backward compatibility.
This work is based on the previously sent RFC for a "process info"
library: https://patchwork.dpdk.org/project/dpdk/list/?series=7741
However, rather than creating a new library, this patchset takes that work and merges it into the existing telemetry library, as mentioned above.The telemetry library as shipped in 19.11 is based upon the metrics library and outputs all statistics based on that as a source. However, this limits the telemetry output to only port-level statistics information, rather than allowing it to be used as a general scheme for telemetry information across all DPDK libraries.
With this patchset applied, rather than the telemetry library being responsible for pulling ethdev stats and pushing them into the metrics library for retrieval later, each library e.g. ethdev, rawdev, and even the metrics library itself (for backwards compatiblity) now handle their own stats. Any library or app can register a callback function with telemetry, which will be called if requested by the client connected via the telemetry socket. The callback function in the library/app then formats its stats, or other data, into a JSON string, and returns it to telemetry to be sent to the client.
To maintain backward compatibility, e.g. to allow the dpdk telemetry collectd plugin to continue to work, some of the existing telemetry code is kept, but is moved into the metrics library, and callbacks are registered with telemetry for the legacy commands that were supported previously.
Quoted 9 lines
The new version of the library, apart from the legacy interface support for backward compatibility, does not have an external dependency on the Jansson library, allowing the library to be enabled by default.
Note: In this version of the patchset, telemetry output is provided by the ethdev, rawdev and eal libraries, but this may be expanded further in later versions which are planned ahead of the merge deadline for 20.05
I am looking at the patch and noticed we are adding new lines to the JSON output, they are not required. The spaces in the text could be removed as well as it will reduce the amount of data being sent. The output can be put into a JSON formatter to see the data better if needed.
Some required information I believe needs to be added to the patch.
- Command to get the Link status of a port Speed/Duplex/LinkState via a new command ‘/ethdev/linkstate,X’ or I added it to the /ethdev/list command. I also added the total devices and available devices via the DPDK APIs.
{
"/ethdev/list": {
"ports": [{
"port": 0,
"duplex": "Full",
"state": "UP",
"rate": 40000
}, {
"port": 1,
"duplex": "Full",
"state": "UP",
"rate": 100000
}, {
"port": 2,
"duplex": "Full",
"state": "UP",
"rate": 40000
}, {
"port": 3,
"duplex": "Full",
"state": "UP",
"rate": 100000
}],
"avail": 4,
"total": 4
}
}The next one is the format of the /ethdev/stats are not very usable as most of the fields are not supported in drivers.
{
"/ethdev/stats": {
"rx_good_packets": 0,
"tx_good_packets": 0,
"rx_good_bytes": 0,
"tx_good_bytes": 0,
"rx_missed_errors": 0,
"rx_errors": 0,
"tx_errors": 0,
"rx_mbuf_allocation_errors": 0,
"rx_q0packets": 0,
"rx_q0bytes": 0,
"rx_q0errors": 0,
"tx_q0packets": 0,
"tx_q0bytes": 0,
"rx_unicast_packets": 0,
"rx_multicast_packets": 0,
"rx_broadcast_packets": 0,
"rx_dropped_packets": 0,
"rx_unknown_protocol_packets": 5,
"tx_unicast_packets": 0,
"tx_multicast_packets": 0,
"tx_broadcast_packets": 0,
"tx_dropped_packets": 0,
"tx_link_down_dropped": 0,
"rx_crc_errors": 0,
"rx_illegal_byte_errors": 0,
"rx_error_bytes": 0,
"mac_local_errors": 0,
"mac_remote_errors": 0,
"rx_length_errors": 0,
"tx_xon_packets": 0,
"rx_xon_packets": 0,
"tx_xoff_packets": 0,
"rx_xoff_packets": 0,
"rx_size_64_packets": 0,
"rx_size_65_to_127_packets": 5,
"rx_size_128_to_255_packets": 0,
"rx_size_256_to_511_packets": 0,
"rx_size_512_to_1023_packets": 0,
"rx_size_1024_to_1522_packets": 0,
"rx_size_1523_to_max_packets": 0,
"rx_undersized_errors": 0,
"rx_oversize_errors": 0,
"rx_mac_short_dropped": 0,
"rx_fragmented_errors": 0,
"rx_jabber_errors": 0,
"tx_size_64_packets": 0,
"tx_size_65_to_127_packets": 6,
"tx_size_128_to_255_packets": 0,
"tx_size_256_to_511_packets": 0,
"tx_size_512_to_1023_packets": 0,
"tx_size_1024_to_1522_packets": 0,
"tx_size_1523_to_max_packets": 0,
"rx_flow_director_atr_match_packets": 0,
"rx_flow_director_sb_match_packets": 0,
"tx_low_power_idle_status": 0,
"rx_low_power_idle_status": 0,
"tx_low_power_idle_count": 0,
"rx_low_power_idle_count": 0,
"rx_priority0_xon_packets": 0,
"rx_priority1_xon_packets": 0,
"rx_priority2_xon_packets": 0,
"rx_priority3_xon_packets": 0,
"rx_priority4_xon_packets": 0,
"rx_priority5_xon_packets": 0,
"rx_priority6_xon_packets": 0,
"rx_priority7_xon_packets": 0,
"rx_priority0_xoff_packets": 0,
"rx_priority1_xoff_packets": 0,
"rx_priority2_xoff_packets": 0,
"rx_priority3_xoff_packets": 0,
"rx_priority4_xoff_packets": 0,
"rx_priority5_xoff_packets": 0,
"rx_priority6_xoff_packets": 0,
"rx_priority7_xoff_packets": 0,
"tx_priority0_xon_packets": 0,
"tx_priority1_xon_packets": 0,
"tx_priority2_xon_packets": 0,
"tx_priority3_xon_packets": 0,
"tx_priority4_xon_packets": 0,
"tx_priority5_xon_packets": 0,
"tx_priority6_xon_packets": 0,
"tx_priority7_xon_packets": 0,
"tx_priority0_xoff_packets": 0,
"tx_priority1_xoff_packets": 0,
"tx_priority2_xoff_packets": 0,
"tx_priority3_xoff_packets": 0,
"tx_priority4_xoff_packets": 0,
"tx_priority5_xoff_packets": 0,
"tx_priority6_xoff_packets": 0,
"tx_priority7_xoff_packets": 0,
"tx_priority0_xon_to_xoff_packets": 0,
"tx_priority1_xon_to_xoff_packets": 0,
"tx_priority2_xon_to_xoff_packets": 0,
"tx_priority3_xon_to_xoff_packets": 0,
"tx_priority4_xon_to_xoff_packets": 0,
"tx_priority5_xon_to_xoff_packets": 0,
"tx_priority6_xon_to_xoff_packets": 0,
"tx_priority7_xon_to_xoff_packets": 0
}
}Most of the fields above are device dependent and very difficult to this data from device to device. The array based information like queue stats needs to be an array in json. The packet size counters are great, but not all of the ports support hardware versions. I would like to see us add these to all PMDs even if we have to do them in software and then added to the basic /ethdev/stats output.
I create a simpler layout with just the basic values from the dpdk stats get API. Even the queue data is not valid for most ports, but I hope we can add software support to drivers that do not have hardware queue stats. The following is much easier to parse and use then the above format. Note I added the portid value to structure. I used my own names for the fields, just easier to type, but we can use the ones above.
{
“/ethdev/stats”: {
"portid": 0,
"ipackets": 0,
"opackets": 0,
"ibytes": 0,
"obytes": 0,
"imissed": 0,
"ierrors": 0,
"oerrors": 0,
"rx_nombuf": 0,
"q_ipackets": [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
"q_opackets": [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
"q_ibytes": [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
"q_obytes": [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
"q_errors": [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
}
}If we need device specific data then we need to create a new command to dump this data instead e.g. ‘/ethdev/xstats,X'.
—Keith
Quoted 41 lines · Keith
Quoted 41 lines
On Mar 19, 2020, at 12:18 PM, Ciara Power <[email protected]> wrote:
This patchset extensively reworks the telemetry library adding new functionality and simplifying much of the existing code, while maintaining backward compatibility.
This work is based on the previously sent RFC for a "process info"
library: https://patchwork.dpdk.org/project/dpdk/list/?series=7741
However, rather than creating a new library, this patchset takes that work and merges it into the existing telemetry library, as mentioned above.The telemetry library as shipped in 19.11 is based upon the metrics library and outputs all statistics based on that as a source. However, this limits the telemetry output to only port-level statistics information, rather than allowing it to be used as a general scheme for telemetry information across all DPDK libraries.
With this patchset applied, rather than the telemetry library being responsible for pulling ethdev stats and pushing them into the metrics library for retrieval later, each library e.g. ethdev, rawdev, and even the metrics library itself (for backwards compatiblity) now handle their own stats. Any library or app can register a callback function with telemetry, which will be called if requested by the client connected via the telemetry socket. The callback function in the library/app then formats its stats, or other data, into a JSON string, and returns it to telemetry to be sent to the client.
To maintain backward compatibility, e.g. to allow the dpdk telemetry collectd plugin to continue to work, some of the existing telemetry code is kept, but is moved into the metrics library, and callbacks are registered with telemetry for the legacy commands that were supported previously.
The new version of the library, apart from the legacy interface support for backward compatibility, does not have an external dependency on the Jansson library, allowing the library to be enabled by default.
Quoted 6 lines
Quoted 5 lines
Note: In this version of the patchset, telemetry output is provided by the ethdev, rawdev and eal libraries, but this may be expanded further in later versions which are planned ahead of the merge deadline for 20.05
Thanks for the feedback Keith, agree with all your points. Some further comments inline below.
NOTE: We hope to send out a V2 very soon, so not all feedback about new commands may make it into that V2, but they should be able to be added later - either in V3 or subsequent patch. [We'll try and get at least some of them in for V2, though.]
/Bruce
Quoted 2 lines
I am looking at the patch and noticed we are adding new lines to the JSON output, they are not required. The spaces in the text could be removed as well as it will reduce the amount of data being sent. The output can be put into a JSON formatter to see the data better if needed.
The output from the new telemetry should not include any spaces. The whitespace in the output of the script shown comes from python, since it uses the json python library to parse (and therefore verify as correct json) the received info, and then uses json.dumps to print it out.
+ reply = json.loads(fd.recv(1024 * 12).decode())
+ print(json.dumps(reply))
You can tweak the format you'd like the output displayed in by adding some more paramters to the json.dumps() call.
As for the legacy support, it will include some whitespace as we have kept the output byte-for-byte idential as far as possible to avoid any compatibilty issues.
Quoted 3 lines
Some required information I believe needs to be added to the patch.
- Command to get the Link status of a port Speed/Duplex/LinkState via a new command ‘/ethdev/linkstate,X’ or I added it to the /ethdev/list command. I also added the total devices and available devices via the DPDK APIs.
I think a linkstate command is a good idea. We'll see about adding it.
Quoted 28 lines
{
"/ethdev/list": {
"ports": [{
"port": 0,
"duplex": "Full",
"state": "UP",
"rate": 40000
}, {
"port": 1,
"duplex": "Full",
"state": "UP",
"rate": 100000
}, {
"port": 2,
"duplex": "Full",
"state": "UP",
"rate": 40000
}, {
"port": 3,
"duplex": "Full",
"state": "UP",
"rate": 100000
}],
"avail": 4,
"total": 4
}
}Quoted 2 lines
The next one is the format of the /ethdev/stats are not very usable as most of the fields are not supported in drivers.
Yes, it's a problem. For V2 we are going to rename this to xstats, so that the standard ethdev stats can be added as a separate command. We did xstats originally because that was what was done previously in telemetry. We have planned to add standard stats in future.
Quoted 125 lines
{ "/ethdev/stats": { "rx_good_packets": 0, "tx_good_packets": 0, "rx_good_bytes": 0, "tx_good_bytes": 0, "rx_missed_errors": 0, "rx_errors": 0, "tx_errors": 0, "rx_mbuf_allocation_errors": 0, "rx_q0packets": 0, "rx_q0bytes": 0, "rx_q0errors": 0, "tx_q0packets": 0, "tx_q0bytes": 0, "rx_unicast_packets": 0, "rx_multicast_packets": 0, "rx_broadcast_packets": 0, "rx_dropped_packets": 0, "rx_unknown_protocol_packets": 5, "tx_unicast_packets": 0, "tx_multicast_packets": 0, "tx_broadcast_packets": 0, "tx_dropped_packets": 0, "tx_link_down_dropped": 0, "rx_crc_errors": 0, "rx_illegal_byte_errors": 0, "rx_error_bytes": 0, "mac_local_errors": 0, "mac_remote_errors": 0, "rx_length_errors": 0, "tx_xon_packets": 0, "rx_xon_packets": 0, "tx_xoff_packets": 0, "rx_xoff_packets": 0, "rx_size_64_packets": 0, "rx_size_65_to_127_packets": 5, "rx_size_128_to_255_packets": 0, "rx_size_256_to_511_packets": 0, "rx_size_512_to_1023_packets": 0, "rx_size_1024_to_1522_packets": 0, "rx_size_1523_to_max_packets": 0, "rx_undersized_errors": 0, "rx_oversize_errors": 0, "rx_mac_short_dropped": 0, "rx_fragmented_errors": 0, "rx_jabber_errors": 0, "tx_size_64_packets": 0, "tx_size_65_to_127_packets": 6, "tx_size_128_to_255_packets": 0, "tx_size_256_to_511_packets": 0, "tx_size_512_to_1023_packets": 0, "tx_size_1024_to_1522_packets": 0, "tx_size_1523_to_max_packets": 0, "rx_flow_director_atr_match_packets": 0, "rx_flow_director_sb_match_packets": 0, "tx_low_power_idle_status": 0, "rx_low_power_idle_status": 0, "tx_low_power_idle_count": 0, "rx_low_power_idle_count": 0, "rx_priority0_xon_packets": 0, "rx_priority1_xon_packets": 0, "rx_priority2_xon_packets": 0, "rx_priority3_xon_packets": 0, "rx_priority4_xon_packets": 0, "rx_priority5_xon_packets": 0, "rx_priority6_xon_packets": 0, "rx_priority7_xon_packets": 0, "rx_priority0_xoff_packets": 0, "rx_priority1_xoff_packets": 0, "rx_priority2_xoff_packets": 0, "rx_priority3_xoff_packets": 0, "rx_priority4_xoff_packets": 0, "rx_priority5_xoff_packets": 0, "rx_priority6_xoff_packets": 0, "rx_priority7_xoff_packets": 0, "tx_priority0_xon_packets": 0, "tx_priority1_xon_packets": 0, "tx_priority2_xon_packets": 0, "tx_priority3_xon_packets": 0, "tx_priority4_xon_packets": 0, "tx_priority5_xon_packets": 0, "tx_priority6_xon_packets": 0, "tx_priority7_xon_packets": 0, "tx_priority0_xoff_packets": 0, "tx_priority1_xoff_packets": 0, "tx_priority2_xoff_packets": 0, "tx_priority3_xoff_packets": 0, "tx_priority4_xoff_packets": 0, "tx_priority5_xoff_packets": 0, "tx_priority6_xoff_packets": 0, "tx_priority7_xoff_packets": 0, "tx_priority0_xon_to_xoff_packets": 0, "tx_priority1_xon_to_xoff_packets": 0, "tx_priority2_xon_to_xoff_packets": 0, "tx_priority3_xon_to_xoff_packets": 0, "tx_priority4_xon_to_xoff_packets": 0, "tx_priority5_xon_to_xoff_packets": 0, "tx_priority6_xon_to_xoff_packets": 0, "tx_priority7_xon_to_xoff_packets": 0 } }Most of the fields above are device dependent and very difficult to this data from device to device. The array based information like queue stats needs to be an array in json. The packet size counters are great, but not all of the ports support hardware versions. I would like to see us add these to all PMDs even if we have to do them in software and then added to the basic /ethdev/stats output.
I create a simpler layout with just the basic values from the dpdk stats get API. Even the queue data is not valid for most ports, but I hope we can add software support to drivers that do not have hardware queue stats. The following is much easier to parse and use then the above format. Note I added the portid value to structure. I used my own names for the fields, just easier to type, but we can use the ones above.
{ “/ethdev/stats”: { "portid": 0, "ipackets": 0, "opackets": 0, "ibytes": 0, "obytes": 0, "imissed": 0, "ierrors": 0, "oerrors": 0, "rx_nombuf": 0, "q_ipackets": [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], "q_opackets": [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], "q_ibytes": [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], "q_obytes": [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], "q_errors": [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0] } }
Quoted 1 line
If we need device specific data then we need to create a new command to dump this data instead e.g. ‘/ethdev/xstats,X'.
Yep, +1.
Stay tuned for V2! :-)
Quoted 2 lines
—Keith
v2 cover update and simplify telemetry library.
In reply to Ciara PowerThis patchset extensively reworks the telemetry library adding new functionality and simplifying much of the existing code, while maintaining backward compatibility.
This work is based on the previously sent RFC for a "process info"
library: https://patchwork.dpdk.org/project/dpdk/list/?series=7741
However, rather than creating a new library, this patchset takes that work and merges it into the existing telemetry library, as mentioned above.
The telemetry library as shipped in 19.11 is based upon the metrics library and outputs all statistics based on that as a source. However, this limits the telemetry output to only port-level statistics information, rather than allowing it to be used as a general scheme for telemetry information across all DPDK libraries.
With this patchset applied, rather than the telemetry library being responsible for pulling ethdev stats and pushing them into the metrics library for retrieval later, each library e.g. ethdev, rawdev, and even the metrics library itself (for backwards compatiblity) now handle their own stats. Any library or app can register a callback function with telemetry, which will be called if requested by the client connected via the telemetry socket. The callback function in the library/app then formats its stats, or other data, into a JSON string, and returns it to telemetry to be sent to the client.
To maintain backward compatibility, e.g. to allow the dpdk telemetry collectd plugin to continue to work, some of the existing telemetry code is kept, but is moved into the metrics library, and callbacks are registered with telemetry for the legacy commands that were supported previously.
The new version of the library, apart from the legacy interface support for backward compatibility, does not have an external dependency on the Jansson library, allowing the library to be enabled by default.
Note: In this version of the patchset, telemetry output is provided by the ethdev, rawdev and eal libraries, but this may be expanded further in later versions which are planned ahead of the merge deadline for 20.05
v2:
- Added JSON API, and unit tests, to simplify creation of valid json responses from libraries.
- Added printing of basic info, including max output buffer size, app PID and DPDK version on connection.
- Added /info command to report that basic info post-connect. This replaces the eal version command from v1.
- Renamed stats to xstats in commands to allow a future generic "stats" call.
- Added documentation, including updating existing howto and adding programmers guide section and API docs.
- Added link status command for ethdev ports.
- Fixed windows builds.
Bruce Richardson (8):
build: add arch-specific header path to global includes
telemetry: invert dependency on metrics
telemetry: introduce new telemetry functionality
telemetry: add utility functions for creating json app/test: add telemetry json tests
ethdev: add callback support for telemetry
usertools: add new telemetry python script
eal: add eal telemetry callbacks
Ciara Power (8):
telemetry: move code to metrics for later reuse
metrics: reduce code taken from telemetry
rawdev: add callback support for telemetry examples/l3fwd-power: enable use of new telemetry
telemetry: introduce telemetry backward compatibility
telemetry: remove existing telemetry files
lib: add telemetry as eal dependency
doc: update telemetry documentation
app/test/Makefile | 2 + app/test/meson.build | 4 + app/test/test_telemetry_json.c | 136 ++ config/common_base | 2 +- config/meson.build | 7 - doc/api/doxy-api-index.md | 1 + doc/guides/howto/telemetry.rst | 108 +- doc/guides/linux_gsg/eal_args.include.rst | 8 + doc/guides/linux_gsg/sys_reqs.rst | 2 - doc/guides/prog_guide/index.rst | 1 + doc/guides/prog_guide/telemetry_lib.rst | 62 + doc/guides/rel_notes/release_20_05.rst | 15 + examples/l3fwd-power/Makefile | 2 +- examples/l3fwd-power/main.c | 53 +- examples/l3fwd-power/meson.build | 2 +- lib/Makefile | 10 +- lib/librte_eal/arm/include/meson.build | 2 - lib/librte_eal/common/eal_common_options.c | 79 + lib/librte_eal/common/eal_internal_cfg.h | 1 + lib/librte_eal/common/eal_options.h | 7 + lib/librte_eal/freebsd/Makefile | 1 + lib/librte_eal/freebsd/eal.c | 12 + lib/librte_eal/freebsd/meson.build | 2 +- lib/librte_eal/linux/Makefile | 1 + lib/librte_eal/linux/eal.c | 12 + lib/librte_eal/linux/meson.build | 2 +- lib/librte_eal/meson.build | 5 +- lib/librte_eal/ppc/include/meson.build | 2 - lib/librte_eal/x86/include/meson.build | 2 - lib/librte_ethdev/Makefile | 2 +- lib/librte_ethdev/meson.build | 2 +- lib/librte_ethdev/rte_ethdev.c | 100 + lib/librte_metrics/Makefile | 11 + lib/librte_metrics/meson.build | 10 + lib/librte_metrics/rte_metrics.c | 6 +- lib/librte_metrics/rte_metrics.h | 5 +- lib/librte_metrics/rte_metrics_telemetry.c | 539 +++++ lib/librte_metrics/rte_metrics_telemetry.h | 65 + lib/librte_metrics/rte_metrics_version.map | 7 + lib/librte_rawdev/Makefile | 3 +- lib/librte_rawdev/meson.build | 3 + lib/librte_rawdev/rte_rawdev.c | 75 + lib/librte_telemetry/Makefile | 15 +- lib/librte_telemetry/meson.build | 17 +- lib/librte_telemetry/rte_telemetry.c | 1895 ----------------- lib/librte_telemetry/rte_telemetry.h | 77 +- lib/librte_telemetry/rte_telemetry_internal.h | 112 - lib/librte_telemetry/rte_telemetry_json.h | 205 ++ lib/librte_telemetry/rte_telemetry_legacy.h | 63 + lib/librte_telemetry/rte_telemetry_parser.c | 682 ------ lib/librte_telemetry/rte_telemetry_parser.h | 15 - .../rte_telemetry_parser_test.c | 533 ----- .../rte_telemetry_socket_tests.h | 36 - .../rte_telemetry_version.map | 5 +- lib/librte_telemetry/telemetry.c | 311 +++ lib/librte_telemetry/telemetry_legacy.c | 226 ++ lib/meson.build | 3 +- meson.build | 9 + mk/rte.app.mk | 11 +- usertools/dpdk-telemetry.py | 44 + usertools/meson.build | 2 +- 61 files changed, 2200 insertions(+), 3432 deletions(-) create mode 100644 app/test/test_telemetry_json.c create mode 100644 doc/guides/prog_guide/telemetry_lib.rst create mode 100644 lib/librte_metrics/rte_metrics_telemetry.c create mode 100644 lib/librte_metrics/rte_metrics_telemetry.h delete mode 100644 lib/librte_telemetry/rte_telemetry.c delete mode 100644 lib/librte_telemetry/rte_telemetry_internal.h create mode 100644 lib/librte_telemetry/rte_telemetry_json.h create mode 100644 lib/librte_telemetry/rte_telemetry_legacy.h delete mode 100644 lib/librte_telemetry/rte_telemetry_parser.c delete mode 100644 lib/librte_telemetry/rte_telemetry_parser.h delete mode 100644 lib/librte_telemetry/rte_telemetry_parser_test.c delete mode 100644 lib/librte_telemetry/rte_telemetry_socket_tests.h create mode 100644 lib/librte_telemetry/telemetry.c create mode 100644 lib/librte_telemetry/telemetry_legacy.c create mode 100755 usertools/dpdk-telemetry.py
Signature · 1 line
2.17.1
PATCH v2 1/16 build: add arch-specific header path to global includes
From: Bruce Richardson <[email protected]>
The global include path, which is used by anything built before EAL, points to the EAL header files so they utility macros etc. can be used anywhere in DPDK. This path included the OS-specific EAL header files, but not the architecture-specific ones. This patch moves the selection of target architecture to the top-level meson.build file so that the global include can reference that.
--- config/meson.build | 7 ------- lib/librte_eal/arm/include/meson.build | 2 -- lib/librte_eal/ppc/include/meson.build | 2 -- lib/librte_eal/x86/include/meson.build | 2 -- meson.build | 9 +++++++++ 5 files changed, 9 insertions(+), 13 deletions(-)
config/meson.build +0 -7
@@ -229,13 +229,6 @@ dpdk_conf.set('RTE_LIBRTE_DPAA2_USE_PHYS_IOVA', true) compile_time_cpuflags = [] -if host_machine.cpu_family().startswith('x86') - arch_subdir = 'x86' -elif host_machine.cpu_family().startswith('arm') or host_machine.cpu_family().startswith('aarch') - arch_subdir = 'arm' -elif host_machine.cpu_family().startswith('ppc') - arch_subdir = 'ppc' -endif subdir(arch_subdir) dpdk_conf.set('RTE_COMPILE_TIME_CPUFLAGS', ','.join(compile_time_cpuflags))
lib/librte_eal/arm/include/meson.build +0 -2
@@ -1,8 +1,6 @@ # SPDX-License-Identifier: BSD-3-Clause # Copyright(c) 2017 Intel Corporation. -includes += include_directories('.') - arch_headers = files( 'rte_atomic_32.h', 'rte_atomic_64.h',
lib/librte_eal/ppc/include/meson.build +0 -2
@@ -1,8 +1,6 @@ # SPDX-License-Identifier: BSD-3-Clause # Copyright(c) 2018 Luca Boccassi <[email protected]> -includes += include_directories('.') - arch_headers = files( 'rte_atomic.h', 'rte_byteorder.h',
lib/librte_eal/x86/include/meson.build +0 -2
@@ -1,8 +1,6 @@ # SPDX-License-Identifier: BSD-3-Clause # Copyright(c) 2017 Intel Corporation -includes += include_directories('.') - arch_headers = files( 'rte_atomic_32.h', 'rte_atomic_64.h',
meson.build +9 -0
@@ -24,12 +24,21 @@ dpdk_libs_disabled = [] dpdk_drvs_disabled = [] abi_version_file = files('ABI_VERSION') +if host_machine.cpu_family().startswith('x86') + arch_subdir = 'x86' +elif host_machine.cpu_family().startswith('arm') or host_machine.cpu_family().startswith('aarch') + arch_subdir = 'arm' +elif host_machine.cpu_family().startswith('ppc') + arch_subdir = 'ppc' +endif + # configure the build, and make sure configs here and in config folder are # able to be included in any file. We also store a global array of include dirs # for passing to pmdinfogen scripts global_inc = include_directories('.', 'config', 'lib/librte_eal/include', 'lib/librte_eal/@0@/include'.format(host_machine.system()), + 'lib/librte_eal/@0@/include'.format(arch_subdir), ) subdir('config')
Signature · 1 line
2.17.1
PATCH v2 2/16 telemetry: move code to metrics for later reuse
In reply to Ciara PowerThis commit moves some of the telemetry library code to a new file in the metrics library. No modifications are made to the moved code, except what is needed to allow it to compile and run. The additional code in metrics is built only when the Jansson library is present. Telemetry functions as normal, using the functions from the metrics_telemetry file. This move will enable code be reused by the new version of telemetry in a later commit, to support backward compatibility with the existing telemetry usage.
--- lib/Makefile | 2 +- lib/librte_metrics/Makefile | 10 + lib/librte_metrics/meson.build | 9 + lib/librte_metrics/rte_metrics.c | 1 - lib/librte_metrics/rte_metrics.h | 3 +- lib/librte_metrics/rte_metrics_telemetry.c | 719 ++++++++++++++++++ lib/librte_metrics/rte_metrics_telemetry.h | 71 ++ lib/librte_metrics/rte_metrics_version.map | 7 + lib/librte_telemetry/rte_telemetry.c | 550 +------------- lib/librte_telemetry/rte_telemetry_internal.h | 32 +- lib/librte_telemetry/rte_telemetry_parser.c | 270 +------ mk/rte.app.mk | 2 + 12 files changed, 859 insertions(+), 817 deletions(-) create mode 100644 lib/librte_metrics/rte_metrics_telemetry.c create mode 100644 lib/librte_metrics/rte_metrics_telemetry.h
lib/Makefile +1 -1
@@ -71,7 +71,7 @@ DEPDIRS-librte_gro := librte_eal librte_mbuf librte_ethdev librte_net DIRS-$(CONFIG_RTE_LIBRTE_JOBSTATS) += librte_jobstats DEPDIRS-librte_jobstats := librte_eal DIRS-$(CONFIG_RTE_LIBRTE_METRICS) += librte_metrics -DEPDIRS-librte_metrics := librte_eal +DEPDIRS-librte_metrics := librte_eal librte_ethdev DIRS-$(CONFIG_RTE_LIBRTE_BITRATE) += librte_bitratestats DEPDIRS-librte_bitratestats := librte_eal librte_metrics librte_ethdev DIRS-$(CONFIG_RTE_LIBRTE_LATENCY_STATS) += librte_latencystats
lib/librte_metrics/Makefile +10 -0
@@ -7,6 +7,7 @@ include $(RTE_SDK)/mk/rte.vars.mk LIB = librte_metrics.a CFLAGS += $(WERROR_FLAGS) -I$(SRCDIR) -O3 +CFLAGS += -DALLOW_EXPERIMENTAL_API LDLIBS += -lrte_eal EXPORT_MAP := rte_metrics_version.map
@@ -14,6 +15,15 @@ EXPORT_MAP := rte_metrics_version.map # all source are stored in SRCS-y SRCS-$(CONFIG_RTE_LIBRTE_METRICS) := rte_metrics.c +ifeq ($(CONFIG_RTE_LIBRTE_TELEMETRY),y) +SRCS-y += rte_metrics_telemetry.c +SYMLINK-$(CONFIG_RTE_LIBRTE_METRICS)-include += rte_metrics_telemetry.h + +LDLIBS += -lrte_ethdev +LDLIBS += -ljansson + +endif + # Install header file SYMLINK-$(CONFIG_RTE_LIBRTE_METRICS)-include += rte_metrics.h
lib/librte_metrics/meson.build +9 -0
@@ -1,5 +1,14 @@ # SPDX-License-Identifier: BSD-3-Clause # Copyright(c) 2017 Intel Corporation +allow_experimental_apis = true sources = files('rte_metrics.c') headers = files('rte_metrics.h') + +jansson = dependency('jansson', required: false) +if jansson.found() + ext_deps += jansson + sources += files('rte_metrics_telemetry.c') + headers = files('rte_metrics_telemetry.h') + deps += ['ethdev'] +endif
lib/librte_metrics/rte_metrics.c +0 -1
@@ -13,7 +13,6 @@#include <rte_memzone.h> #include <rte_spinlock.h> -#define RTE_METRICS_MAX_METRICS 256#define RTE_METRICS_MEMZONE_NAME "RTE_METRICS"/**
lib/librte_metrics/rte_metrics.h +1 -2
@@ -32,6 +32,7 @@ extern "C" {/** Maximum length of metric name (including null-terminator) */ #define RTE_METRICS_MAX_NAME_LEN 64 +#define RTE_METRICS_MAX_METRICS 256/** * Global metric special id.
@@ -43,7 +44,6 @@ extern "C" {*/ #define RTE_METRICS_GLOBAL -1 -/** * A name-key lookup for metrics. *
@@ -71,7 +71,6 @@ struct rte_metric_value {uint64_t value; }; -/** * Initializes metric module. This function must be called from * a primary process before metrics are used.
lib/librte_metrics/rte_metrics_telemetry.c new file +719 -0
719 lines not on this page · raw message
lib/librte_metrics/rte_metrics_telemetry.h new file +71 -0
71 lines not on this page · raw message
lib/librte_metrics/rte_metrics_version.map +7 -0
@@ -16,4 +16,11 @@ EXPERIMENTAL { global: rte_metrics_deinit; + rte_metrics_tel_encode_json_format; + rte_metrics_tel_reg_all_ethdev; + rte_metrics_tel_get_global_stats; + rte_metrics_tel_get_port_stats_ids; + rte_metrics_tel_get_ports_stats_json; + rte_metrics_tel_extract_data; + };
lib/librte_telemetry/rte_telemetry.c +20 -530
597 lines not on this page · raw message
lib/librte_telemetry/rte_telemetry_internal.h +2 -30
@@ -4,6 +4,8 @@#include <rte_log.h> #include <rte_tailq.h> +#include <rte_metrics.h> +#include <rte_metrics_telemetry.h> #ifndef _RTE_TELEMETRY_INTERNAL_H_#define _RTE_TELEMETRY_INTERNAL_H_
@@ -50,28 +52,6 @@ enum rte_telemetry_parser_actions { ACTION_DELETE = 2 }; -enum rte_telemetry_stats_type { -PORT_STATS =0 , -GLOBAL_STATS =1 -}; - -/* @internal */ -struct telemetry_encode_param { -enum rte_telemetry_stats_type type; -union { -struct port_param { -int num_metric_ids; -uint32_t metric_ids[MAX_METRICS ]; -int num_port_ids; -uint32_t port_ids[RTE_MAX_ETHPORTS ]; - } pp; -struct global_param { -int num_metric_ids; -uint32_t metric_ids[MAX_METRICS ]; - } gp; - }; -}; -int32_t rte_telemetry_parse_client_message (struct telemetry_impl *telemetry,char *buf);
@@ -87,14 +67,6 @@ int32_t rte_telemetry_unregister_client(struct telemetry_impl *telemetry, const char *client_path); -/** -* This is a wrapper for the ethdev api rte_eth_find_next(). -* If rte_eth_find_next() returns the same port id that we passed it, -* then we know that that port is active. -*/ -int32_t -rte_telemetry_is_port_active (int port_id); -int32_t rte_telemetry_send_ports_stats_values (struct telemetry_encode_param *ep,struct telemetry_impl *telemetry);
lib/librte_telemetry/rte_telemetry_parser.c +17 -253
344 lines not on this page · raw message
mk/rte.app.mk +2 -0
@@ -55,7 +55,9 @@ _LDLIBS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += -lrte_telemetry -ljansson _LDLIBS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += --no-whole-archive _LDLIBS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += --as-needed _LDLIBS-$(CONFIG_RTE_LIBRTE_JOBSTATS) += -lrte_jobstats +_LDLIBS-$(CONFIG_RTE_LIBRTE_METRICS) += --whole-archive _LDLIBS-$(CONFIG_RTE_LIBRTE_METRICS) += -lrte_metrics +_LDLIBS-$(CONFIG_RTE_LIBRTE_METRICS) += --no-whole-archive _LDLIBS-$(CONFIG_RTE_LIBRTE_BITRATE) += -lrte_bitratestats _LDLIBS-$(CONFIG_RTE_LIBRTE_LATENCY_STATS) += -lrte_latencystats _LDLIBS-$(CONFIG_RTE_LIBRTE_POWER) += -lrte_power
Signature · 1 line
2.17.1
PATCH v2 3/16 metrics: reduce code taken from telemetry
In reply to Ciara PowerThe telemetry code that was moved into the metrics library can be shortened, while still maintaining the same functionality.
--- lib/librte_metrics/rte_metrics_telemetry.c | 476 ++++---------------- lib/librte_metrics/rte_metrics_telemetry.h | 18 +- lib/librte_telemetry/rte_telemetry.c | 11 - lib/librte_telemetry/rte_telemetry_parser.c | 12 +- 4 files changed, 96 insertions(+), 421 deletions(-)
lib/librte_metrics/rte_metrics_telemetry.c +89 -387
@@ -23,33 +23,12 @@ int metrics_log_level; #define METRICS_LOG_WARN(fmt, args...) \ METRICS_LOG(WARNING, fmt, ## args) -static int32_t -rte_metrics_tel_is_port_active (int port_id) -{ -int ret; - - ret =rte_eth_find_next (port_id); -if (ret == port_id) -return 1 ; - -METRICS_LOG_ERR ("port_id: %d is invalid, not active" , - port_id); - -return 0 ; -} -static int32_t rte_metrics_tel_reg_port_ethdev_to_metrics (uint16_t port_id) { -int ret, num_xstats, ret_val, i; -struct rte_eth_xstat *eth_xstats =NULL ; +int ret, num_xstats, i;struct rte_eth_xstat_name *eth_xstats_names =NULL ; -if (!rte_eth_dev_is_valid_port (port_id)) { -METRICS_LOG_ERR ("port_id: %d is invalid" , port_id); -return -EINVAL ; - } - num_xstats =rte_eth_xstats_get (port_id,NULL ,0 );if (num_xstats <0 ) { METRICS_LOG_ERR("rte_eth_xstats_get(%u) failed: %d",
@@ -57,53 +36,32 @@ rte_metrics_tel_reg_port_ethdev_to_metrics(uint16_t port_id)return -EPERM ; } - eth_xstats =malloc (sizeof (struct rte_eth_xstat ) * num_xstats); -if (eth_xstats ==NULL ) { -METRICS_LOG_ERR ("Failed to malloc memory for xstats" ); -return -ENOMEM ; - } - - ret =rte_eth_xstats_get (port_id, eth_xstats, num_xstats);const char *xstats_names[num_xstats]; eth_xstats_names =malloc (sizeof (struct rte_eth_xstat_name ) * num_xstats); -if (ret <0 || ret > num_xstats) { -METRICS_LOG_ERR ("rte_eth_xstats_get(%u) len%i failed: %d" , - port_id, num_xstats, ret); - ret_val = -EPERM ; - goto free_xstats; - } -if (eth_xstats_names ==NULL ) {METRICS_LOG_ERR ("Failed to malloc memory for xstats_names" ); - ret_val = -ENOMEM ; + ret = -ENOMEM ; goto free_xstats; } - ret =rte_eth_xstats_get_names (port_id, eth_xstats_names, num_xstats); -if (ret <0 || ret > num_xstats) { -METRICS_LOG_ERR ("rte_eth_xstats_get_names(%u) len%i failed: %d" , - port_id, num_xstats, ret); - ret_val = -EPERM ; +if (rte_eth_xstats_get_names (port_id, + eth_xstats_names, num_xstats) != num_xstats) { +METRICS_LOG_ERR ("rte_eth_xstats_get_names(%u) len %d failed" , + port_id, num_xstats); + ret = -EPERM ; goto free_xstats; }for (i =0 ; i < num_xstats; i++) - xstats_names[i] = eth_xstats_names[eth_xstats[i].id].name; - - ret_val =rte_metrics_reg_names (xstats_names, num_xstats); -if (ret_val <0 ) { + xstats_names[i] = eth_xstats_names[i].name; + ret =rte_metrics_reg_names (xstats_names, num_xstats); +if (ret <0 )METRICS_LOG_ERR ("rte_metrics_reg_names failed - metrics may already be registered" ); - ret_val =-1 ; - goto free_xstats; - } - - goto free_xstats; free_xstats: -free (eth_xstats);free (eth_xstats_names); -return ret_val; +return ret; }int32_t
@@ -113,20 +71,18 @@ rte_metrics_tel_reg_all_ethdev(int *metrics_register_done, int *reg_index_list)const void *dev_ops;int reg_index; } drv_idx[RTE_MAX_ETHPORTS] = { {0} }; -int nb_drv_idx =0 ; -uint16_t pid; -int ret; +int ret, nb_drv_idx =0 ; +uint16_t d; -RTE_ETH_FOREACH_DEV (pid) { +RTE_ETH_FOREACH_DEV (d) {int i;/* Different device types have different numbers of stats, so * first check if the stats for this type of device have * already been registered */ for (i =0 ; i < nb_drv_idx; i++) { -if (rte_eth_devices[pid].dev_ops == - drv_idx[i].dev_ops) { - reg_index_list[pid] = drv_idx[i].reg_index; +if (rte_eth_devices[d].dev_ops == drv_idx[i].dev_ops) { + reg_index_list[d] = drv_idx[i].reg_index;break ; } }
@@ -134,17 +90,16 @@ rte_metrics_tel_reg_all_ethdev(int *metrics_register_done, int *reg_index_list)continue ;/* we found a match, go to next port */ /* No match, register a new set of xstats for this port */ - ret =rte_metrics_tel_reg_port_ethdev_to_metrics (pid); + ret =rte_metrics_tel_reg_port_ethdev_to_metrics (d);if (ret <0 ) { -METRICS_LOG_ERR ("Failed to register ethdev metrics" ); -return -1 ; +METRICS_LOG_ERR ("Failed to register ethdev to metrics" ); +return ret; } - reg_index_list[pid] = ret; - drv_idx[nb_drv_idx].dev_ops = rte_eth_devices[pid].dev_ops; + reg_index_list[d] = ret; + drv_idx[nb_drv_idx].dev_ops = rte_eth_devices[d].dev_ops; drv_idx[nb_drv_idx].reg_index = ret; nb_drv_idx++; } - *metrics_register_done =1 ;return 0 ; }
@@ -155,28 +110,17 @@ rte_metrics_tel_update_metrics_ethdev(uint16_t port_id, int reg_start_index)int ret, num_xstats, i;struct rte_eth_xstat *eth_xstats; -if (!rte_eth_dev_is_valid_port (port_id)) { -METRICS_LOG_ERR ("port_id: %d is invalid" , port_id); -return -EINVAL ; - } - - ret =rte_metrics_tel_is_port_active (port_id); -if (ret <1 ) -return -EINVAL ; - num_xstats =rte_eth_xstats_get (port_id,NULL ,0 );if (num_xstats <0 ) {METRICS_LOG_ERR ("rte_eth_xstats_get(%u) failed: %d" , port_id, num_xstats);return -EPERM ; } - eth_xstats =malloc (sizeof (struct rte_eth_xstat ) * num_xstats);if (eth_xstats ==NULL ) {METRICS_LOG_ERR ("Failed to malloc memory for xstats" );return -ENOMEM ; } - ret =rte_eth_xstats_get (port_id, eth_xstats, num_xstats);if (ret <0 || ret > num_xstats) {free (eth_xstats);
@@ -188,223 +132,96 @@ rte_metrics_tel_update_metrics_ethdev(uint16_t port_id, int reg_start_index)uint64_t xstats_values[num_xstats];for (i =0 ; i < num_xstats; i++) xstats_values[i] = eth_xstats[i].value; - - ret =rte_metrics_update_values (port_id, reg_start_index, xstats_values, - num_xstats); -if (ret <0 ) { +if (rte_metrics_update_values (port_id, reg_start_index, xstats_values, + num_xstats) <0 ) {METRICS_LOG_ERR ("Could not update metrics values" );free (eth_xstats);return -EPERM ; } -free (eth_xstats);return 0 ; } -static int -rte_metrics_tel_get_metrics (uint32_t port_id,struct rte_metric_value - *metrics,struct rte_metric_name *names,int num_metrics) -{ -int ret, num_values; - -if (num_metrics <0 ) { -METRICS_LOG_ERR ("Invalid metrics count" ); -return -EINVAL ; - }else if (num_metrics ==0 ) { -METRICS_LOG_ERR ("No metrics to display (none have been registered)" ); -return -EPERM ; - } - -if (metrics ==NULL ) { -METRICS_LOG_ERR ("Metrics must be initialised." ); -return -EINVAL ; - } - -if (names ==NULL ) { -METRICS_LOG_ERR ("Names must be initialised." ); -return -EINVAL ; - } - - ret =rte_metrics_get_names (names, num_metrics); -if (ret <0 || ret > num_metrics) { -METRICS_LOG_ERR ("Cannot get metrics names" ); -return -EPERM ; - } - - num_values =rte_metrics_get_values (port_id,NULL ,0 ); - ret =rte_metrics_get_values (port_id, metrics, num_values); -if (ret <0 || ret > num_values) { -METRICS_LOG_ERR ("Cannot get metrics values" ); -return -EPERM ; - } - -return 0 ; -} -static int32_t -rte_metrics_tel_json_format_stat (json_t *stats,const char *metric_name, -uint64_t metric_value) -{ -int ret; -json_t *stat =json_object (); - -if (stat ==NULL ) { -METRICS_LOG_ERR ("Could not create stat JSON object" ); -return -EPERM ; - } - - ret =json_object_set_new (stat,"name" ,json_string (metric_name)); -if (ret <0 ) { -METRICS_LOG_ERR ("Stat Name field cannot be set" ); -return -EPERM ; - } - - ret =json_object_set_new (stat,"value" ,json_integer (metric_value)); -if (ret <0 ) { -METRICS_LOG_ERR ("Stat Value field cannot be set" ); -return -EPERM ; - } - - ret =json_array_append_new (stats, stat); -if (ret <0 ) { -METRICS_LOG_ERR ("Stat cannot be added to stats json array" ); -return -EPERM ; - } - -return 0 ; -} - -static int32_t -rte_metrics_tel_json_format_port (uint32_t port_id,json_t *ports, +rte_metrics_tel_format_port (uint32_t pid,json_t *ports,uint32_t *metric_ids,int num_metric_ids) { -struct rte_metric_value *metrics =0 ; -struct rte_metric_name *names =0 ; -int num_metrics, ret; +struct rte_metric_value *metrics =NULL ; +struct rte_metric_name *names =NULL ; +int num_metrics, i, ret = -EPERM ;/* most error cases return EPERM */ json_t *port, *stats; -int i; num_metrics =rte_metrics_get_names (NULL ,0 );if (num_metrics <0 ) {METRICS_LOG_ERR ("Cannot get metrics count" ); - goto einval_fail; +return -EINVAL ; }else if (num_metrics ==0 ) {METRICS_LOG_ERR ("No metrics to display (none have been registered)" ); - goto eperm_fail; +return -EPERM ; } metrics =malloc (sizeof (struct rte_metric_value ) * num_metrics); names =malloc (sizeof (struct rte_metric_name ) * num_metrics);if (metrics ==NULL || names ==NULL ) {METRICS_LOG_ERR ("Cannot allocate memory" ); -free (metrics); -free (names);return -ENOMEM ; } - ret =rte_metrics_tel_get_metrics (port_id, metrics, names, - num_metrics); -if (ret <0 ) { -free (metrics); -free (names); -METRICS_LOG_ERR ("rte_metrics_tel_get_metrics failed" ); -return ret; +if (rte_metrics_get_names (names, num_metrics) != num_metrics || +rte_metrics_get_values (pid, metrics, num_metrics) + != num_metrics) { +METRICS_LOG_ERR ("Error getting metrics" ); + goto fail; } - port =json_object (); stats =json_array (); -if (port ==NULL || stats ==NULL ) { -METRICS_LOG_ERR ("Could not create port/stats JSON objects" ); - goto eperm_fail; - } - - ret =json_object_set_new (port,"port" ,json_integer (port_id)); -if (ret <0 ) { -METRICS_LOG_ERR ("Port field cannot be set" ); - goto eperm_fail; +if (stats ==NULL ) { +METRICS_LOG_ERR ("Could not create stats JSON object" ); + goto fail; } -for (i =0 ; i < num_metric_ids; i++) { -int metric_id = metric_ids[i]; -int metric_index =-1 ; -int metric_name_key =-1 ; +for (i =0 ; i < num_metrics; i++) {int32_t j; -uint64_t metric_value; - -if (metric_id >= num_metrics) { -METRICS_LOG_ERR ("Metric_id: %d is not valid" , - metric_id); - goto einval_fail; - } - -for (j =0 ; j < num_metrics; j++) { -if (metrics[j].key == metric_id) { - metric_name_key = metrics[j].key; - metric_index = j; +for (j =0 ; j < num_metric_ids; j++) +if (metrics[i].key == metric_ids[j])break ; - } - } - -const char *metric_name = names[metric_name_key].name; - metric_value = metrics[metric_index].value; -if (metric_name_key <0 || metric_index <0 ) { -METRICS_LOG_ERR ("Could not get metric name/index" ); - goto eperm_fail; - } +if (num_metric_ids >0 && j == num_metric_ids) +continue ;/* can't find this id */ - ret =rte_metrics_tel_json_format_stat (stats, metric_name, - metric_value); -if (ret <0 ) { +json_t *stat =json_pack ("{s,s,s,I}" , +"name" , names[metrics[i].key].name, +"value" , metrics[i].value); +if (stat ==NULL ||json_array_append_new (stats, stat) <0 ) {METRICS_LOG_ERR ("Format stat with id: %u failed" , - metric_id); -free (metrics); -free (names); -return ret; + metrics[i].key); + goto fail; } } -if (json_array_size (stats) ==0 ) - ret =json_object_set_new (port,"stats" ,json_null ()); -else - ret =json_object_set_new (port,"stats" , stats); - -if (ret <0 ) { -METRICS_LOG_ERR ("Stats object cannot be set" ); - goto eperm_fail; - } - - ret =json_array_append_new (ports, port); -if (ret <0 ) { -METRICS_LOG_ERR ("Port object cannot be added to ports array" ); - goto eperm_fail; + port =json_pack ("{s,i,s,o}" ,"port" , pid,"stats" , +json_array_size (stats) ? stats :json_null ()); +if (port ==NULL ||json_array_append_new (ports, port) <0 ) { +METRICS_LOG_ERR ("Error creating port and adding to ports" ); + goto fail; }free (metrics);free (names);return 0 ; -eperm_fail: -free (metrics); -free (names); -return -EPERM ; - -einval_fail: +fail:free (metrics);free (names); -return -EINVAL ; +return ret; }int32_t rte_metrics_tel_encode_json_format (struct telemetry_encode_param *ep,char **json_buffer) { -int ret;json_t *root, *ports; -int i; -uint32_t port_id; -int num_port_ids; -int num_metric_ids; +int ret, i; ports =json_array ();if (ports ==NULL ) {
@@ -413,28 +230,15 @@ rte_metrics_tel_encode_json_format(struct telemetry_encode_param *ep, }if (ep->type ==PORT_STATS ) { - num_port_ids = ep->pp.num_port_ids; - num_metric_ids = ep->pp.num_metric_ids; - -if (num_port_ids <=0 || num_metric_ids <=0 ) { -METRICS_LOG_ERR ("Please provide port and metric ids to query" ); +if (ep->pp.num_port_ids <=0 ) { +METRICS_LOG_ERR ("Please provide port/metric ids" );return -EINVAL ; } -for (i =0 ; i < num_port_ids; i++) { - port_id = ep->pp.port_ids[i]; -if (!rte_eth_dev_is_valid_port (port_id)) { -METRICS_LOG_ERR ("Port: %d invalid" , - port_id); -return -EINVAL ; - } - } - -for (i =0 ; i < num_port_ids; i++) { - port_id = ep->pp.port_ids[i]; - ret =rte_metrics_tel_json_format_port (port_id, +for (i =0 ; i < ep->pp.num_port_ids; i++) { + ret =rte_metrics_tel_format_port (ep->pp.port_ids[i], ports, &ep->pp.metric_ids[0 ], - num_metric_ids); + ep->pp.num_metric_ids);if (ret <0 ) {METRICS_LOG_ERR ("Format port in JSON failed" );return ret;
@@ -442,34 +246,21 @@ rte_metrics_tel_encode_json_format(struct telemetry_encode_param *ep, } }else if (ep->type ==GLOBAL_STATS ) {/* Request Global Metrics */ - ret =rte_metrics_tel_json_format_port (RTE_METRICS_GLOBAL , - ports, &ep->gp.metric_ids[0 ], - ep->gp.num_metric_ids); + ret =rte_metrics_tel_format_port (RTE_METRICS_GLOBAL , + ports,NULL ,0 );if (ret <0 ) { -METRICS_LOG_ERR (" Request Global Metrics Failed" ); +METRICS_LOG_ERR ("Request Global Metrics Failed" );return ret; } }else { -METRICS_LOG_ERR (" Invalid metrics type in encode params" ); +METRICS_LOG_ERR ("Invalid metrics type in encode params" );return -EINVAL ; } - root =json_object (); + root =json_pack ("{s,s,s,o}" ,"status_code" ,"Status OK: 200" , +"data" , ports);if (root ==NULL ) { -METRICS_LOG_ERR ("Could not create root JSON object" ); -return -EPERM ; - } - - ret =json_object_set_new (root,"status_code" , -json_string ("Status OK: 200" )); -if (ret <0 ) { -METRICS_LOG_ERR ("Status code field cannot be set" ); -return -EPERM ; - } - - ret =json_object_set_new (root,"data" , ports); -if (ret <0 ) { -METRICS_LOG_ERR ("Data field cannot be set" ); +METRICS_LOG_ERR ("Root, Status or data field cannot be set" );return -EPERM ; }
@@ -478,42 +269,6 @@ rte_metrics_tel_encode_json_format(struct telemetry_encode_param *ep,return 0 ; } -int32_t -rte_metrics_tel_get_global_stats (struct telemetry_encode_param *ep) -{ -int num_metrics, ret, i; -struct rte_metric_value *values; - - num_metrics =rte_metrics_get_values (RTE_METRICS_GLOBAL ,NULL ,0 ); -if (num_metrics <0 ) { -METRICS_LOG_ERR ("Cannot get metrics count" ); -return -EINVAL ; - }else if (num_metrics ==0 ) { -METRICS_LOG_ERR ("No metrics to display (none have been registered)" ); -return -EPERM ; - } - - values =malloc (sizeof (struct rte_metric_value ) * num_metrics); -if (values ==NULL ) { -METRICS_LOG_ERR ("Cannot allocate memory" ); -return -ENOMEM ; - } - - ret =rte_metrics_get_values (RTE_METRICS_GLOBAL , values, num_metrics); -if (ret <0 ) { -METRICS_LOG_ERR ("Could not get stat values" ); -free (values); -return -EINVAL ; - } -for (i =0 ; i < num_metrics; i++) - ep->gp.metric_ids[i] = values[i].key; - - ep->gp.num_metric_ids = num_metrics; - ep->type =GLOBAL_STATS ; -free (values); -return 0 ; -} -int32_t rte_metrics_tel_get_ports_stats_json (struct telemetry_encode_param *ep,int *reg_index,char **json_buffer)
@@ -547,24 +302,7 @@ rte_metrics_tel_get_ports_stats_json(struct telemetry_encode_param *ep,int32_t rte_metrics_tel_get_port_stats_ids (struct telemetry_encode_param *ep) { -int ret, num_metrics, i, p; -struct rte_metric_value *values; -uint64_t num_port_ids =0 ; - - num_metrics =rte_metrics_get_values (0 ,NULL ,0 ); -if (num_metrics <0 ) { -METRICS_LOG_ERR ("Cannot get metrics count" ); -return -EINVAL ; - }else if (num_metrics ==0 ) { -METRICS_LOG_ERR ("No metrics to display (none have been registered)" ); -return -EPERM ; - } - - values =malloc (sizeof (struct rte_metric_value ) * num_metrics); -if (values ==NULL ) { -METRICS_LOG_ERR ("Cannot allocate memory" ); -return -ENOMEM ; - } +int p, num_port_ids =0 ;RTE_ETH_FOREACH_DEV (p) { ep->pp.port_ids[num_port_ids] = p;
@@ -573,51 +311,26 @@ rte_metrics_tel_get_port_stats_ids(struct telemetry_encode_param *ep)if (!num_port_ids) {METRICS_LOG_ERR ("No active ports" ); - goto fail; - } - - ret =rte_metrics_get_values (ep->pp.port_ids[0 ], values, num_metrics); -if (ret <0 ) { -METRICS_LOG_ERR ("Could not get stat values" ); - goto fail; +return -EINVAL ; } -for (i =0 ; i < num_metrics; i++) - ep->pp.metric_ids[i] = values[i].key; ep->pp.num_port_ids = num_port_ids; - ep->pp.num_metric_ids = num_metrics; + ep->pp.num_metric_ids =0 ; ep->type =PORT_STATS ;return 0 ; - -fail: -free (values); -return -EINVAL ; }static int32_t rte_metrics_tel_stat_names_to_ids (const char *const *stat_names, -uint32_t *stat_ids,uint64_t num_stat_names) +uint32_t *stat_ids,int num_stat_names) {struct rte_metric_name *names; -int ret, num_metrics; -uint32_t i, k; - -if (stat_names ==NULL ) { -METRICS_LOG_WARN ("Invalid stat_names argument" ); -return -EINVAL ; - } - -if (num_stat_names <=0 ) { -METRICS_LOG_WARN ("Invalid num_stat_names argument" ); -return -EINVAL ; - } +int num_metrics; +int i, j, nb_stat_ids =0 ; num_metrics =rte_metrics_get_names (NULL ,0 ); -if (num_metrics <0 ) { -METRICS_LOG_ERR ("Cannot get metrics count" ); -return -EPERM ; - }else if (num_metrics ==0 ) { -METRICS_LOG_WARN ("No metrics have been registered" ); +if (num_metrics <=0 ) { +METRICS_LOG_ERR ("Error getting metrics count - no metrics may be registered" );return -EPERM ; }
@@ -627,29 +340,25 @@ rte_metrics_tel_stat_names_to_ids(const char * const *stat_names,return -ENOMEM ; } - ret =rte_metrics_get_names (names, num_metrics); -if (ret <0 || ret > num_metrics) { +if (rte_metrics_get_names (names, num_metrics) != num_metrics) {METRICS_LOG_ERR ("Cannot get metrics names" );free (names);return -EPERM ; } - k =0 ; -for (i =0 ; i < (uint32_t )num_stat_names; i++) { -uint32_t j; -for (j =0 ; j < (uint32_t )num_metrics; j++) { +for (i =0 ; i < num_stat_names; i++) { +for (j =0 ; j < num_metrics; j++) {if (strcmp (stat_names[i], names[j].name) ==0 ) { - stat_ids[k] = j; - k++; + stat_ids[nb_stat_ids++] = j;break ; } } - } - -if (k != num_stat_names) { -METRICS_LOG_WARN ("Invalid stat names provided" ); -free (names); -return -EINVAL ; +if (j == num_metrics) { +METRICS_LOG_WARN ("Invalid stat name %s\n" , + stat_names[i]); +free (names); +return -EINVAL ; + } }free (names);
@@ -670,28 +379,21 @@ rte_metrics_tel_extract_data(struct telemetry_encode_param *ep, json_t *data)memset (ep,0 ,sizeof (*ep)); ep->pp.num_port_ids =json_array_size (port_ids_json); ep->pp.num_metric_ids = num_stat_names; -if (!json_is_object (data)) { +if (!json_is_object (data) || !json_is_array (port_ids_json) || + !json_is_array (stat_names_json)) {METRICS_LOG_WARN ("Invalid data provided for this command" );return -EINVAL ; } -if (!json_is_array (port_ids_json) || - !json_is_array (stat_names_json)) { -METRICS_LOG_WARN ("Invalid input data array(s)" ); -return -EINVAL ; - } - json_array_foreach(port_ids_json, index, value) {if (!json_is_integer (value)) {METRICS_LOG_WARN ("Port ID given is not valid" );return -EINVAL ; } ep->pp.port_ids[index] =json_integer_value (value); - ret =rte_metrics_tel_is_port_active (ep->pp.port_ids[index]); -if (ret <1 ) +if (rte_eth_dev_is_valid_port (ep->pp.port_ids[index]) <1 )return -EINVAL ; } - json_array_foreach(stat_names_json, index, value) {if (!json_is_string (value)) {METRICS_LOG_WARN ("Stat Name given is not a string" );
lib/librte_metrics/rte_metrics_telemetry.h +6 -12
@@ -21,18 +21,12 @@ enum rte_telemetry_stats_type {struct telemetry_encode_param {enum rte_telemetry_stats_type type; -union { -struct port_param { -int num_metric_ids; -uint32_t metric_ids[RTE_METRICS_MAX_METRICS ]; -int num_port_ids; -uint32_t port_ids[RTE_MAX_ETHPORTS ]; - } pp; -struct global_param { -int num_metric_ids; -uint32_t metric_ids[RTE_METRICS_MAX_METRICS ]; - } gp; - }; +struct port_param { +int num_metric_ids; +uint32_t metric_ids[RTE_METRICS_MAX_METRICS ]; +int num_port_ids; +uint32_t port_ids[RTE_MAX_ETHPORTS ]; + } pp; };struct telemetry_metrics_data {
lib/librte_telemetry/rte_telemetry.c +0 -11
@@ -145,11 +145,6 @@ rte_telemetry_send_global_stats_values(struct telemetry_encode_param *ep,return -1 ; } -if (ep->gp.num_metric_ids <0 ) { -TELEMETRY_LOG_ERR ("Invalid num_metric_ids, must be positive" ); - goto einval_fail; - } - ret =rte_metrics_tel_encode_json_format (ep, &json_buffer);if (ret <0 ) {TELEMETRY_LOG_ERR ("JSON encode function failed" );
@@ -166,12 +161,6 @@ rte_telemetry_send_global_stats_values(struct telemetry_encode_param *ep, }return 0 ; - -einval_fail: - ret =rte_telemetry_send_error_response (telemetry, -EINVAL ); -if (ret <0 ) -TELEMETRY_LOG_ERR ("Could not send error" ); -return -1 ; }int32_t
lib/librte_telemetry/rte_telemetry_parser.c +1 -11
@@ -225,9 +225,8 @@ rte_telemetry_command_global_stat_values(struct telemetry_impl *telemetry, int action, json_t *data) { int ret; -struct telemetry_encode_param ep; +struct telemetry_encode_param ep = { .type =GLOBAL_STATS }; -memset (&ep,0 ,sizeof (ep));if (telemetry ==NULL ) {TELEMETRY_LOG_ERR ("Invalid telemetry argument" );return -1 ;
@@ -249,15 +248,6 @@ rte_telemetry_command_global_stat_values(struct telemetry_impl *telemetry,return -1 ; } - ret =rte_metrics_tel_get_global_stats (&ep); -if (ret <0 ) { -TELEMETRY_LOG_ERR ("Could not get global stat values" ); - ret =rte_telemetry_send_error_response (telemetry, ret); -if (ret <0 ) -TELEMETRY_LOG_ERR ("Could not send error" ); -return -1 ; - } - ret =rte_telemetry_send_global_stats_values (&ep, telemetry);if (ret <0 ) {TELEMETRY_LOG_ERR ("Sending global stats values failed" );
Signature · 1 line
2.17.1
PATCH v2 4/16 telemetry: invert dependency on metrics
In reply to Ciara PowerFrom: Bruce Richardson <[email protected]>
Rather than having the telemetry library depend on the metrics lib we invert the dependency so that metrics instead depends on telemetry lib, and registers the needed functions with it at init time. This prepares the way for a cleaner telemetry architecture to be applied in later patches.
--- lib/Makefile | 7 +++-- lib/librte_metrics/Makefile | 1 + lib/librte_metrics/meson.build | 2 +- lib/librte_metrics/rte_metrics.c | 5 ++++ lib/librte_metrics/rte_metrics.h | 2 ++ lib/librte_metrics/rte_metrics_telemetry.c | 14 +++++++++ lib/librte_telemetry/Makefile | 3 +- lib/librte_telemetry/meson.build | 2 +- lib/librte_telemetry/rte_telemetry.c | 19 ++++++++---- lib/librte_telemetry/rte_telemetry_internal.h | 30 +++++++++++++++++++ lib/librte_telemetry/rte_telemetry_parser.c | 5 ++-- .../rte_telemetry_version.map | 1 + lib/meson.build | 3 +- mk/rte.app.mk | 6 +--- 14 files changed, 80 insertions(+), 20 deletions(-)
lib/Makefile +5 -2
@@ -22,6 +22,8 @@ DIRS-$(CONFIG_RTE_LIBRTE_CFGFILE) += librte_cfgfile DEPDIRS-librte_cfgfile := librte_eal DIRS-$(CONFIG_RTE_LIBRTE_CMDLINE) += librte_cmdline DEPDIRS-librte_cmdline := librte_eal librte_net +DIRS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += librte_telemetry +DEPDIRS-librte_telemetry := librte_eal DIRS-$(CONFIG_RTE_LIBRTE_ETHER) += librte_ethdev DEPDIRS-librte_ethdev := librte_net librte_eal librte_mempool librte_ring DEPDIRS-librte_ethdev += librte_mbuf
@@ -72,6 +74,9 @@ DIRS-$(CONFIG_RTE_LIBRTE_JOBSTATS) += librte_jobstats DEPDIRS-librte_jobstats := librte_eal DIRS-$(CONFIG_RTE_LIBRTE_METRICS) += librte_metrics DEPDIRS-librte_metrics := librte_eal librte_ethdev +ifeq ($(CONFIG_RTE_LIBRTE_TELEMETRY),y) +DEPDIRS-librte_metrics += librte_telemetry +endif DIRS-$(CONFIG_RTE_LIBRTE_BITRATE) += librte_bitratestats DEPDIRS-librte_bitratestats := librte_eal librte_metrics librte_ethdev DIRS-$(CONFIG_RTE_LIBRTE_LATENCY_STATS) += librte_latencystats
@@ -114,8 +119,6 @@ DEPDIRS-librte_bpf := librte_eal librte_mempool librte_mbuf librte_ethdev DIRS-$(CONFIG_RTE_LIBRTE_IPSEC) += librte_ipsec DEPDIRS-librte_ipsec := librte_eal librte_mbuf librte_cryptodev librte_security \ librte_net -DIRS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += librte_telemetry -DEPDIRS-librte_telemetry := librte_eal librte_metrics librte_ethdev DIRS-$(CONFIG_RTE_LIBRTE_RCU) += librte_rcu DEPDIRS-librte_rcu := librte_eal
lib/librte_metrics/Makefile +1 -0
@@ -22,6 +22,7 @@ SYMLINK-$(CONFIG_RTE_LIBRTE_METRICS)-include += rte_metrics_telemetry.h LDLIBS += -lrte_ethdev LDLIBS += -ljansson +CFLAGS += -I$(RTE_SDK)/lib/librte_telemetry/ endif # Install header file
lib/librte_metrics/meson.build +1 -1
@@ -10,5 +10,5 @@ if jansson.found() ext_deps += jansson sources += files('rte_metrics_telemetry.c') headers = files('rte_metrics_telemetry.h') - deps += ['ethdev'] + deps += ['ethdev', 'telemetry'] endif
lib/librte_metrics/rte_metrics.c +5 -0
@@ -13,6 +13,8 @@#include <rte_memzone.h> #include <rte_spinlock.h> +int metrics_initialized; +#define RTE_METRICS_MEMZONE_NAME "RTE_METRICS"/**
@@ -60,6 +62,8 @@ rte_metrics_init(int socket_id)struct rte_metrics_data_s *stats;const struct rte_memzone *memzone; +if (metrics_initialized) +return ;if (rte_eal_process_type () !=RTE_PROC_PRIMARY )return ;
@@ -73,6 +77,7 @@ rte_metrics_init(int socket_id) stats = memzone->addr;memset (stats,0 ,sizeof (struct rte_metrics_data_s ));rte_spinlock_init (&stats->lock); + metrics_initialized =1 ; }int
lib/librte_metrics/rte_metrics.h +2 -0
@@ -30,6 +30,8 @@extern "C" {#endif +extern int metrics_initialized; +/** Maximum length of metric name (including null-terminator) */ #define RTE_METRICS_MAX_NAME_LEN 64#define RTE_METRICS_MAX_METRICS 256
lib/librte_metrics/rte_metrics_telemetry.c +14 -0
@@ -6,6 +6,9 @@#include <rte_ethdev.h> #include <rte_string_fns.h> +#ifdef RTE_LIBRTE_TELEMETRY +#include <rte_telemetry_internal.h> +#endif #include "rte_metrics.h" #include "rte_metrics_telemetry.h"
@@ -74,6 +77,7 @@ rte_metrics_tel_reg_all_ethdev(int *metrics_register_done, int *reg_index_list)int ret, nb_drv_idx =0 ;uint16_t d; +rte_metrics_init (rte_socket_id ());RTE_ETH_FOREACH_DEV (d) {int i;/* Different device types have different numbers of stats, so
@@ -415,6 +419,16 @@ rte_metrics_tel_extract_data(struct telemetry_encode_param *ep, json_t *data)RTE_INIT (metrics_ctor) { +#ifdef RTE_LIBRTE_TELEMETRY +static const struct metrics_functions fns = { + .reg_all_ethdev = rte_metrics_tel_reg_all_ethdev, + .encode_json_format = rte_metrics_tel_encode_json_format, + .get_port_stats_ids = rte_metrics_tel_get_port_stats_ids, + .get_ports_stats_json = rte_metrics_tel_get_ports_stats_json, + .extract_data = rte_metrics_tel_extract_data + }; +rte_telemetry_set_metrics_fns (&fns);/* assign them to telemetry lib */ +#endif metrics_log_level =rte_log_register ("lib.metrics" );if (metrics_log_level >=0 )rte_log_set_level (metrics_log_level,RTE_LOG_ERR );
lib/librte_telemetry/Makefile +2 -1
@@ -9,8 +9,9 @@ LIB = librte_telemetry.a CFLAGS += -O3 CFLAGS += $(WERROR_FLAGS) -I$(SRCDIR) CFLAGS += -DALLOW_EXPERIMENTAL_API +CFLAGS += -I$(RTE_SDK)/lib/librte_metrics/ -LDLIBS += -lrte_eal -lrte_ethdev +LDLIBS += -lrte_eal LDLIBS += -lrte_metrics LDLIBS += -lpthread LDLIBS += -ljansson
lib/librte_telemetry/meson.build +1 -1
@@ -3,8 +3,8 @@ sources = files('rte_telemetry.c', 'rte_telemetry_parser.c', 'rte_telemetry_parser_test.c') headers = files('rte_telemetry.h', 'rte_telemetry_internal.h', 'rte_telemetry_parser.h') -deps += ['metrics', 'ethdev'] cflags += '-DALLOW_EXPERIMENTAL_API' +includes += include_directories('../librte_metrics') jansson = dependency('jansson', required: false) if jansson.found()
lib/librte_telemetry/rte_telemetry.c +13 -6
@@ -10,10 +10,10 @@#include <jansson.h> #include <rte_eal.h> -#include <rte_ethdev.h> #include <rte_metrics.h> #include <rte_option.h> #include <rte_string_fns.h> +#include <rte_lcore.h> #include "rte_telemetry.h" #include "rte_telemetry_internal.h"
@@ -43,6 +43,15 @@ struct json_data {int stat_value; }; +/* global array of functions pointers to metrics library */ +const struct metrics_functions *metrics_fns; + +void +rte_telemetry_set_metrics_fns (const struct metrics_functions *fns) +{ + metrics_fns = fns; +} +static void rte_telemetry_get_runtime_dir (char *socket_path,size_t size) {
@@ -145,7 +154,7 @@ rte_telemetry_send_global_stats_values(struct telemetry_encode_param *ep,return -1 ; } - ret =rte_metrics_tel_encode_json_format (ep, &json_buffer); + ret = metrics_fns->encode_json_format (ep, &json_buffer);if (ret <0 ) {TELEMETRY_LOG_ERR ("JSON encode function failed" ); ret =rte_telemetry_send_error_response (telemetry, ret);
@@ -190,7 +199,7 @@ rte_telemetry_send_ports_stats_values(struct telemetry_encode_param *ep, goto einval_fail; } - ret =rte_metrics_tel_get_ports_stats_json (ep, telemetry->reg_index, + ret = metrics_fns->get_ports_stats_json (ep, telemetry->reg_index, &json_buffer);if (ret <0 ) { TELEMETRY_LOG_ERR("Function for get_ports_stats_json"
@@ -222,8 +231,7 @@ rte_telemetry_initial_accept(struct telemetry_impl *telemetry)int ret;int selftest =0 ; - ret =rte_metrics_tel_reg_all_ethdev ( - &telemetry->metrics_register_done, + ret = metrics_fns->reg_all_ethdev (&telemetry->metrics_register_done, telemetry->reg_index);if (ret <0 ) {TELEMETRY_LOG_ERR ("Failed to register ethdev metrics" );
@@ -467,7 +475,6 @@ rte_telemetry_init(void) } static_telemetry->socket_id =rte_socket_id (); -rte_metrics_init (static_telemetry->socket_id); ret =pthread_attr_init (&attr);if (ret !=0 ) {
lib/librte_telemetry/rte_telemetry_internal.h +30 -0
@@ -10,6 +10,36 @@#ifndef _RTE_TELEMETRY_INTERNAL_H_#define _RTE_TELEMETRY_INTERNAL_H_ +/* function types for the functions coming from metrics library */ +typedef int32_t (*metrics_tel_reg_all_ethdev_t )(int *metrics_register_done, +int *reg_index_list); + +typedef int32_t (*metrics_tel_encode_json_format_t )( +struct telemetry_encode_param *ep,char **json_buffer); + +typedef int32_t (*metrics_tel_get_port_stats_ids_t )( +struct telemetry_encode_param *ep); + +typedef int32_t (*metrics_tel_get_ports_stats_json_t )( +struct telemetry_encode_param *ep, +int *reg_index,char **json_buffer); + +typedef int32_t (*metrics_tel_extract_data_t )(struct telemetry_encode_param *ep, +json_t *data); + +struct metrics_functions { +metrics_tel_reg_all_ethdev_t reg_all_ethdev; +metrics_tel_encode_json_format_t encode_json_format; +metrics_tel_get_port_stats_ids_t get_port_stats_ids; +metrics_tel_get_ports_stats_json_t get_ports_stats_json; +metrics_tel_extract_data_t extract_data; +}; +extern const struct metrics_functions *metrics_fns; + +/* API for use by metrics libraries to provide the functions to use */ +__rte_experimental +void rte_telemetry_set_metrics_fns(const struct metrics_functions *fns); +/* Logging Macros */ extern int telemetry_log_level;
lib/librte_telemetry/rte_telemetry_parser.c +2 -3
@@ -10,7 +10,6 @@#include <rte_metrics.h> #include <rte_common.h> -#include <rte_ethdev.h> #include <rte_metrics_telemetry.h> #include "rte_telemetry_internal.h"
@@ -202,7 +201,7 @@ rte_telemetry_command_ports_all_stat_values(struct telemetry_impl *telemetry,return -1 ; } - ret =rte_metrics_tel_get_port_stats_ids (&ep); + ret = metrics_fns->get_port_stats_ids (&ep);if (ret <0 ) {TELEMETRY_LOG_ERR ("Could not get ports stat values" ); ret =rte_telemetry_send_error_response (telemetry, ret);
@@ -276,7 +275,7 @@ rte_telemetry_command_ports_stats_values_by_name(struct telemetry_implreturn -1 ; } - ret =rte_metrics_tel_extract_data (&ep, data); + ret = metrics_fns->extract_data (&ep, data);if (ret <0 ) {TELEMETRY_LOG_ERR ("Extracting JSON data failed" ); ret =rte_telemetry_send_error_response (telemetry, ret);
lib/librte_telemetry/rte_telemetry_version.map +1 -0
@@ -5,6 +5,7 @@ EXPERIMENTAL { rte_telemetry_init; rte_telemetry_parse; rte_telemetry_selftest; + rte_telemetry_set_metrics_fns; local: *; };
lib/meson.build +2 -1
@@ -11,6 +11,7 @@ libraries = [ 'kvargs', # eal depends on kvargs 'eal', # everything depends on eal + 'telemetry', 'ring', 'mempool', 'mbuf', 'net', 'meter', 'ethdev', 'pci', # core 'cmdline', 'metrics', # bitrate/latency stats depends on this
@@ -30,7 +31,7 @@ libraries = [ # add pkt framework libs which use other libs from above 'port', 'table', 'pipeline', # flow_classify lib depends on pkt framework table lib - 'flow_classify', 'bpf', 'telemetry'] + 'flow_classify', 'bpf'] if is_windows libraries = ['kvargs','eal'] # only supported libraries for windows
mk/rte.app.mk +1 -5
@@ -49,11 +49,6 @@ _LDLIBS-$(CONFIG_RTE_LIBRTE_FIB) += -lrte_fib _LDLIBS-$(CONFIG_RTE_LIBRTE_RIB) += -lrte_rib _LDLIBS-$(CONFIG_RTE_LIBRTE_LPM) += -lrte_lpm _LDLIBS-$(CONFIG_RTE_LIBRTE_ACL) += -lrte_acl -_LDLIBS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += --no-as-needed -_LDLIBS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += --whole-archive -_LDLIBS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += -lrte_telemetry -ljansson -_LDLIBS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += --no-whole-archive -_LDLIBS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += --as-needed _LDLIBS-$(CONFIG_RTE_LIBRTE_JOBSTATS) += -lrte_jobstats _LDLIBS-$(CONFIG_RTE_LIBRTE_METRICS) += --whole-archive _LDLIBS-$(CONFIG_RTE_LIBRTE_METRICS) += -lrte_metrics
@@ -95,6 +90,7 @@ _LDLIBS-$(CONFIG_RTE_DRIVER_MEMPOOL_RING) += -lrte_mempool_ring _LDLIBS-$(CONFIG_RTE_LIBRTE_OCTEONTX2_MEMPOOL) += -lrte_mempool_octeontx2 _LDLIBS-$(CONFIG_RTE_LIBRTE_RING) += -lrte_ring _LDLIBS-$(CONFIG_RTE_LIBRTE_PCI) += -lrte_pci +_LDLIBS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += -lrte_telemetry -ljansson _LDLIBS-$(CONFIG_RTE_LIBRTE_EAL) += -lrte_eal _LDLIBS-$(CONFIG_RTE_LIBRTE_CMDLINE) += -lrte_cmdline _LDLIBS-$(CONFIG_RTE_LIBRTE_REORDER) += -lrte_reorder
Signature · 1 line
2.17.1
Re: [dpdk-dev] [PATCH v2 04/16] telemetry: invert dependency on metrics
lib/librte_metrics/meson.build if jansson.found() · line 13
Quoted 11 lines
-----Original Message-----
From: Power, Ciara <[email protected]>
+DEPDIRS-librte_metrics +=librte_telemetryendifindex
0f9f2e0e6f..d116857e2d100644
--- a/lib/librte_metrics/meson.buildlib/librte_metrics/meson.build +1
-0+ deps += ['ethdev', 'telemetry']
The telemetry dependency should be added under CONFIG_RTE_LIBRTE_TELEMETRY= y condition as in makefile.
Re: [dpdk-dev] [PATCH v2 04/16] telemetry: invert dependency on metrics
Hi Reshma,
Quoted 6 lines
Quoted 4 lines
-----Original Message-----
From: Power, Ciara <[email protected]>
+DEPDIRS-librte_metrics +=librte_telemetryendif
Quoted 6 lines
lib/librte_metrics/meson.build if jansson.found() · line 13
Quoted 3 lines
index
0f9f2e0e6f..d116857e2d100644
--- a/lib/librte_metrics/meson.buildlib/librte_metrics/meson.build +1
-0+ deps += ['ethdev', 'telemetry']The telemetry dependency should be added under
CONFIG_RTE_LIBRTE_TELEMETRY=y condition as in makefile.
This is covered by the Jansson condition block surrounding this line, which is equivalent to the makefile variable check.
Thanks,
Ciara
PATCH v2 5/16 telemetry: introduce new telemetry functionality
In reply to Ciara PowerFrom: Bruce Richardson <[email protected]>
This patch introduces a new telemetry connection socket and handling functionality. Like the existing telemetry implementation (which is unaffected by this change) it uses a unix socket, but unlike the existing one it does not have a fixed list of commands - instead libraries or applications can register telemetry commands and callbacks to provide a full-extensible solution for all kinds of telemetry across DPDK.
---
v2:
- Added DPDK information message on client connection.
- Added /info command to get DPDK information post-connect.
- Replaced pid in socket name with v2.
- Increased output buffer size to 16k.
- Telemetry default callbacks now registered by init function.
--- lib/librte_telemetry/Makefile | 4 + lib/librte_telemetry/meson.build | 5 +- lib/librte_telemetry/rte_telemetry.c | 3 + lib/librte_telemetry/rte_telemetry.h | 70 ++++- .../rte_telemetry_version.map | 2 + lib/librte_telemetry/telemetry.c | 278 ++++++++++++++++++ 6 files changed, 360 insertions(+), 2 deletions(-) create mode 100644 lib/librte_telemetry/telemetry.c
lib/librte_telemetry/Makefile +4 -0
@@ -10,6 +10,9 @@ CFLAGS += -O3 CFLAGS += $(WERROR_FLAGS) -I$(SRCDIR) CFLAGS += -DALLOW_EXPERIMENTAL_API CFLAGS += -I$(RTE_SDK)/lib/librte_metrics/ +CFLAGS += -I$(RTE_SDK)/lib/librte_eal/include +CFLAGS += -I$(RTE_SDK)/lib/librte_eal/$(ARCH_DIR)/include +CFLAGS += -pthread LDLIBS += -lrte_eal LDLIBS += -lrte_metrics
@@ -22,6 +25,7 @@ EXPORT_MAP := rte_telemetry_version.map SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) := rte_telemetry.c SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += rte_telemetry_parser.c SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += rte_telemetry_parser_test.c +SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += telemetry.c # export include files SYMLINK-$(CONFIG_RTE_LIBRTE_TELEMETRY)-include := rte_telemetry.h
lib/librte_telemetry/meson.build +4 -1
@@ -1,7 +1,10 @@ # SPDX-License-Identifier: BSD-3-Clause # Copyright(c) 2018 Intel Corporation -sources = files('rte_telemetry.c', 'rte_telemetry_parser.c', 'rte_telemetry_parser_test.c') +includes = [global_inc] + +sources = files('rte_telemetry.c', 'rte_telemetry_parser.c', 'rte_telemetry_parser_test.c', + 'telemetry.c') headers = files('rte_telemetry.h', 'rte_telemetry_internal.h', 'rte_telemetry_parser.h') cflags += '-DALLOW_EXPERIMENTAL_API' includes += include_directories('../librte_metrics')
lib/librte_telemetry/rte_telemetry.c +3 -0
@@ -503,6 +503,9 @@ rte_telemetry_init(void)return -EPERM ; } +if (rte_telemetry_new_init () !=0 ) +return -1 ; +return 0 ; }
lib/librte_telemetry/rte_telemetry.h +69 -1
92 lines not on this page · raw message
lib/librte_telemetry/rte_telemetry_version.map +2 -0
@@ -6,6 +6,8 @@ EXPERIMENTAL { rte_telemetry_parse; rte_telemetry_selftest; rte_telemetry_set_metrics_fns; + rte_telemetry_new_init; + rte_telemetry_register_cmd; local: *; };
lib/librte_telemetry/telemetry.c new file +278 -0
278 lines not on this page · raw message
Signature · 1 line
2.17.1
Re: [dpdk-dev] [PATCH v2 05/16] telemetry: introduce new telemetry functionality
Quoted 152 lines · Ciara
From: Bruce Richardson <[email protected]>
This patch introduces a new telemetry connection socket and handling functionality. Like the existing telemetry implementation (which is unaffected by this change) it uses a unix socket, but unlike the existing one it does not have a fixed list of commands - instead libraries or applications can register telemetry commands and callbacks to provide a full-extensible solution for all kinds of telemetry across DPDK.
Signed-off-by Bruce Richardson <[email protected]>Signed-off-by Ciara Power <[email protected]>---
v2:
- Added DPDK information message on client connection.
- Added /info command to get DPDK information post-connect.
- Replaced pid in socket name with v2.
- Increased output buffer size to 16k.
- Telemetry default callbacks now registered by init function.
---lib/librte_telemetry/Makefile | 4 + lib/librte_telemetry/meson.build | 5 +- lib/librte_telemetry/rte_telemetry.c | 3 + lib/librte_telemetry/rte_telemetry.h | 70 ++++- .../rte_telemetry_version.map | 2 + lib/librte_telemetry/telemetry.c | 278 ++++++++++++++++++ 6 files changed, 360 insertions(+), 2 deletions(-)create mode 100644
lib/librte_telemetry/telemetry.clib/librte_telemetry/Makefile +0
-0@@ -10,6 +10,9 @@ CFLAGS += -O3 CFLAGS += $(WERROR_FLAGS) -I$(SRCDIR)CFLAGS += -DALLOW_EXPERIMENTAL_API
CFLAGS += -I$(RTE_SDK)/lib/librte_metrics/lib/librte_telemetry/Makefile +3
-0+CFLAGS += -I$(RTE_SDK)/lib/librte_eal/include +CFLAGS += -I$(RTE_SDK)/lib/librte_eal/$(ARCH_DIR)/include +CFLAGS += -pthreadLDLIBS += -lrte_eal
LDLIBS += -lrte_metricslib/librte_telemetry/Makefile +0
-0@@ -22,6 +25,7 @@ EXPORT_MAP := rte_telemetry_version.mapSRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) :=
rte_telemetry.cSRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) +=rte_telemetry_parser.cSRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) +=rte_telemetry_parser_test.c+SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) +=telemetry.c# export include files SYMLINK-$(CONFIG_RTE_LIBRTE_TELEMETRY)-include := rte_telemetry.hlib/librte_telemetry/meson.build +4
-1@@ -1,7 +1,10 @@ # SPDX-License-Identifier: BSD-3-Clause # Copyright(c) 2018 Intel Corporation -sources = files('rte_telemetry.c', 'rte_telemetry_parser.c', 'rte_telemetry_parser_test.c') +includes = [global_inc] + +sources = files('rte_telemetry.c', 'rte_telemetry_parser.c', 'rte_telemetry_parser_test.c', + 'telemetry.c') headers = files('rte_telemetry.h', 'rte_telemetry_internal.h', 'rte_telemetry_parser.h')cflags += '-DALLOW_EXPERIMENTAL_API' includes +=
include_directories('../librte_metrics')lib/librte_telemetry/rte_telemetry.c +3
-0@@ -503,6 +503,9 @@ rte_telemetry_init(void)return -EPERM ; } +if (rte_telemetry_new_init () !=0 ) +return -1 ; +return 0 ; }lib/librte_telemetry/rte_telemetry.h +41
-1@@ -3,19 +3,59 @@*/ #include <stdint.h> +#include <rte_compat.h> #ifndef _RTE_TELEMETRY_H_#define _RTE_TELEMETRY_H_ +/** Maximum number of telemetry callbacks. */ +#define TELEMETRY_MAX_CALLBACKS 64 +/** +* @warning +* @b EXPERIMENTAL: all functions in this file may change without prior notice +* * @file * RTE Telemetry * * The telemetry library provides a method to retrieve statistics from -* DPDK by sending a JSON encoded message over a socket. DPDK will send +* DPDK by sending a request message over a socket. DPDK will send * a JSON encoded response containing telemetry data. ***/ +/** +* This telemetry callback is used when registering a command. +* It handles getting and formatting stats to be returned to telemetry when +* requested. Stats up to buf_len in length are put in the buffer. +* +* @param cmd +* The cmd that was requested by the client. +* @param params +* Contains data required by the callback function. +* @param buffer +* A buffer to hold the formatted response. +* @param buf_len +* Length of the buffer. +* +* @return +* Length of buffer used on success. +* @return +* Negative integer on error. +*/ +typedef int (*telemetry_cb )(const char *cmd,const char *params, +char *buffer,int buf_len); + +/** +* Used for handling data received over a telemetry socket. +* +* @param sock_id +* ID for the socket to be used by the handler. +* +* @return +* Void. +*/ +typedef void * (*handler )(void *sock_id); +/** * @warning * @b EXPERIMENTAL: this API may change without prior notice @@ -66,4 +106,32 @@ __rte_experimental
Quoted 2 lines
int32_trte_telemetry_selftest(void);
I think we need to be constant with how prototypes are formatted. The two below do not add a newline after the return value.
Quoted 141 lines
lib/librte_telemetry/rte_telemetry.h +28
-0+/** +* Used when registering a command and callback function with telemetry. +* +* @param cmd +* The command to register with telemetry. +* @param fn +* Callback function to be called when the command is requested. +* +* @return +* 0 on success. +* @return +* -EINVAL for invalid parameters failure. +* @return +* -ENOENT if max callbacks limit has been reached. +*/ +__rte_experimental +int rte_telemetry_register_cmd(const char *cmd, telemetry_cb fn); + +/** +* Initialize new version of Telemetry. +* +* @return +* 0 on success. +* @return +* -1 on failure. +*/ +__rte_experimental +int rte_telemetry_new_init(void);#endif
lib/librte_telemetry/rte_telemetry_version.map +2
-0@@ -6,6 +6,8 @@ EXPERIMENTAL { rte_telemetry_parse; rte_telemetry_selftest; rte_telemetry_set_metrics_fns; + rte_telemetry_new_init; + rte_telemetry_register_cmd; local: *; };lib/librte_telemetry/telemetry.c new file +92
-0@@ -0,0 +1,278 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright(c) 2020 Intel Corporation +*/ + +#include <unistd.h> +#include <pthread.h> +#include <sys/socket.h> +#include <sys/un.h> +#include <dlfcn.h> + +/* we won't link against libbsd, so just always use DPDKs-specific strlcpy */ +#undef RTE_USE_LIBBSD +#include <rte_string_fns.h> +#include <rte_common.h> +#include <rte_spinlock.h> +#include <rte_version.h> + +#include "rte_telemetry.h" + +#define MAX_CMD_LEN 56 +#define MAX_OUTPUT_LEN (1024 * 16) + +static int +list_commands(const char *cmd __rte_unused, const char *params __rte_unused, +char *buffer,int buf_len); + +static int +handle_info(const char *cmd __rte_unused, const char *params __rte_unused, +char *buffer,int buf_len); + +static void * +client_handler (void *socket); + +struct cmd_callback { +char cmd[MAX_CMD_LEN ]; +telemetry_cb fn; +}; + +struct socket { +int sock; +char path[sizeof (((struct sockaddr_un *)0 )->sun_path)]; +handler fn; +}; +static struct socket v2_socket;/* socket for v2 telemetry */ +static char telemetry_log_error[1024 ];/* Will contain error on init failure */ +/* list of command callbacks, with one command registered by default */ +static struct cmd_callback callbacks[TELEMETRY_MAX_CALLBACKS ]; +static int num_callbacks;/* How many commands are registered */ +/* Used when accessing or modifying list of command callbacks */ +static rte_spinlock_t callback_sl =RTE_SPINLOCK_INITIALIZER ; + +int +rte_telemetry_register_cmd (const char *cmd,telemetry_cb fn) +{ +int i =0 ; + +if (strlen (cmd) >=MAX_CMD_LEN || fn ==NULL || cmd[0 ] !='/' ) +return -EINVAL ; +if (num_callbacks >=TELEMETRY_MAX_CALLBACKS ) +return -ENOENT ; + +rte_spinlock_lock (&callback_sl); +while (i < num_callbacks &&strcmp (cmd, callbacks[i].cmd) >0 ) + i++; +if (i != num_callbacks) +/* Move elements to keep the list alphabetical */ +memmove (callbacks + i +1 , callbacks + i, +sizeof (struct cmd_callback ) * (num_callbacks - i)); + +strlcpy (callbacks[i].cmd, cmd,MAX_CMD_LEN ); + callbacks[i].fn = fn; + num_callbacks++; +rte_spinlock_unlock (&callback_sl); + +return 0 ; +} + +static int +list_commands(const char *cmd __rte_unused, const char *params __rte_unused, +char *buffer,int buf_len) +{ +int i, ret, used =0 ; + + used +=strlcpy (buffer,"[" , buf_len); +for (i =0 ; i < num_callbacks; i++) { + ret =snprintf (buffer + used, buf_len - used,"\"%s\"," , + callbacks[i].cmd); +if (ret + used >= buf_len) +break ; + used += ret; + } + buffer[used -1 ] =']' ;
lib/librte_telemetry/telemetry.c line 102
Quoted 10 lines
lib/librte_telemetry/telemetry.c new file +10
-0+return used; +} + +static int +handle_info(const char *cmd __rte_unused, const char *params __rte_unused, +char *buffer,int buf_len) +{ +int ret =snprintf (buffer, buf_len, +"{\"pid\":%d, \"version\":\"%s\", \"max_output_len\":%d}" , +getpid (),rte_version (),MAX_OUTPUT_LEN );
The spaces can be removed after the commas, correct?
Quoted 4 lines
lib/librte_telemetry/telemetry.c new file +4
-0+return ret >= buf_len ?-1 : ret; +} + +static void
lib/librte_telemetry/telemetry.c line 116
Quoted 10 lines
lib/librte_telemetry/telemetry.c new file +10
-0+perform_command(telemetry_cb fn, const char *cmd, const char *param, int s) +{ + char out_buf[MAX_OUTPUT_LEN]; + +int used =snprintf (out_buf, +sizeof (out_buf),"{\"%s\":" , cmd); +int ret =fn (cmd, param, out_buf + used,sizeof (out_buf) - used); +if (ret <0 ) { + used +=strlcpy (out_buf + used,"null}\n" , +sizeof (out_buf) - used);
Is the newline required in the above output?
lib/librte_telemetry/telemetry.c line 122
Quoted 6 lines
lib/librte_telemetry/telemetry.c new file +6
-0+if (write (s, out_buf, used) <0 ) +perror ("Error writing to socket" ); +return ; + } + used += ret; + used +=strlcpy (out_buf + used,"}\n" ,sizeof (out_buf) - used);
Do we need the newline in the output?
Quoted 10 lines
lib/librte_telemetry/telemetry.c new file +10
-0+if (write (s, out_buf, used) <0 ) +perror ("Error writing to socket" ); +} + +static int +unknown_command(const char *cmd __rte_unused, const char *params __rte_unused, +char *buffer,int buf_len) +{ +return snprintf (buffer, buf_len,"null" ); +}
lib/librte_telemetry/telemetry.c line 142
Quoted 10 lines
lib/librte_telemetry/telemetry.c new file +10
-0+ +static void * +client_handler (void *sock_id) +{ +int s = (int )(uintptr_t )sock_id; +char buffer[1024 ]; + +/* receive data is not null terminated */ +int bytes =read (s, buffer,sizeof (buffer)); + buffer[bytes] =0 ;
If bytes is 1024, then we overrun this buffer correct?
lib/librte_telemetry/telemetry.c line 150
Quoted 8 lines
lib/librte_telemetry/telemetry.c new file +8
-0+while (bytes >0 ) { +const char *cmd =strtok (buffer,"," ); +const char *param =strtok (NULL ,"," ); +telemetry_cb fn = unknown_command; +int i; + +rte_spinlock_lock (&callback_sl); +for (i =0 ; i < num_callbacks; i++)
Do we need to validate the cmd pointer before we use that pointer? The man page for strcmp did not state what will happened if the strings are NULL.
lib/librte_telemetry/telemetry.c line 160
Quoted 10 lines
lib/librte_telemetry/telemetry.c new file +10
-0+if (strcmp (cmd, callbacks[i].cmd) ==0 ) { + fn = callbacks[i].fn; +break ; + } + +rte_spinlock_unlock (&callback_sl); +perform_command (fn, cmd, param, s); + + bytes =read (s, buffer,sizeof (buffer)); + buffer[bytes] =0 ;
Same buffer overrun problem.
Quoted 121 lines
lib/librte_telemetry/telemetry.c new file +118
-0+ } +close (s); +return NULL ; +} + +static void * +socket_listener (void *socket) +{ +while (1 ) { +pthread_t th; +struct socket *s = (struct socket *)socket; +int s_accepted =accept (s->sock,NULL ,NULL ); +if (s_accepted <0 ) { +snprintf (telemetry_log_error, +sizeof (telemetry_log_error), +"Error with accept, telemetry thread quitting\n" ); +return NULL ; + } +char info_buf[1024 ]; +if (handle_info (NULL ,NULL , info_buf,sizeof (info_buf)) <0 ) +strlcpy (info_buf,"{}" ,sizeof (info_buf)); +if (write (s_accepted, info_buf,strlen (info_buf)) <0 ) +perror ("Error writing to socket" ); +pthread_create (&th,NULL , s->fn, (void *)(uintptr_t )s_accepted); +pthread_detach (th); + } +return NULL ; +} + +static inline char * +get_socket_path (const char *runtime_dir,const int version) +{ +static char path[PATH_MAX ]; +snprintf (path,sizeof (path),"%s/dpdk_telemetry.v%d" , +strlen (runtime_dir) ? runtime_dir :"/tmp" , version); +return path; +} + +static void +unlink_sockets (void ) +{ +if (v2_socket.path[0 ]) +unlink (v2_socket.path); +} + +static int +create_socket (char *path) +{ +int sock =socket (AF_UNIX ,SOCK_SEQPACKET ,0 ); +if (sock <0 ) { +snprintf (telemetry_log_error,sizeof (telemetry_log_error), +"Error with socket creation, %s" , +strerror (errno)); +return -1 ; + } + +struct sockaddr_un sun = {.sun_family =AF_UNIX }; +strlcpy (sun.sun_path, path,sizeof (sun.sun_path)); +unlink (sun.sun_path); +if (bind (sock, (void *) &sun,sizeof (sun)) <0 ) { +snprintf (telemetry_log_error,sizeof (telemetry_log_error), +"Error binding socket: %s" , +strerror (errno)); + sun.sun_path[0 ] =0 ; + goto error; + } + +if (listen (sock,1 ) <0 ) { +snprintf (telemetry_log_error,sizeof (telemetry_log_error), +"Error calling listen for socket: %s" , +strerror (errno)); + goto error; + } + +return sock; + +error: +close (sock); +unlink_sockets (); +return -1 ; +} + +static int +telemetry_v2_init (const char *runtime_dir,const char **err_str) +{ +pthread_t t_new; + +rte_telemetry_register_cmd ("/" , list_commands); +rte_telemetry_register_cmd ("/info" , handle_info); + v2_socket.fn = client_handler; +if (strlcpy (v2_socket.path,get_socket_path (runtime_dir,2 ), +sizeof (v2_socket.path)) >=sizeof (v2_socket.path)) { +snprintf (telemetry_log_error,sizeof (telemetry_log_error), +"Error with socket binding, path too long" ); +return -1 ; + } + + v2_socket.sock =create_socket (v2_socket.path); +if (v2_socket.sock <0 ) { + *err_str = telemetry_log_error; +return -1 ; + } +pthread_create (&t_new,NULL , socket_listener, &v2_socket); +atexit (unlink_sockets); + +return 0 ; +} + +int32_t +rte_telemetry_new_init (void ) +{ +const char *error_str; +if (telemetry_v2_init (rte_eal_get_runtime_dir (), &error_str) !=0 ) { +printf ("Error initialising telemetry - %s" , error_str); +return -1 ; + } +return 0 ; +}Signature · 1 line
2.17.1
PATCH v2 6/16 telemetry: add utility functions for creating json
In reply to Ciara PowerFrom: Bruce Richardson <[email protected]>
The functions added in this patch will make it easier for applications to build up correct JSON responses to telemetry requests.
--- lib/librte_telemetry/Makefile | 1 + lib/librte_telemetry/meson.build | 2 +- lib/librte_telemetry/rte_telemetry.h | 1 + lib/librte_telemetry/rte_telemetry_json.h | 205 ++++++++++++++++++++++ 4 files changed, 208 insertions(+), 1 deletion(-) create mode 100644 lib/librte_telemetry/rte_telemetry_json.h
lib/librte_telemetry/Makefile +1 -0
@@ -29,5 +29,6 @@ SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += telemetry.c # export include files SYMLINK-$(CONFIG_RTE_LIBRTE_TELEMETRY)-include := rte_telemetry.h +SYMLINK-$(CONFIG_RTE_LIBRTE_TELEMETRY)-include += rte_telemetry_json.h include $(RTE_SDK)/mk/rte.lib.mk
lib/librte_telemetry/meson.build +1 -1
@@ -5,7 +5,7 @@ includes = [global_inc] sources = files('rte_telemetry.c', 'rte_telemetry_parser.c', 'rte_telemetry_parser_test.c', 'telemetry.c') -headers = files('rte_telemetry.h', 'rte_telemetry_internal.h', 'rte_telemetry_parser.h') +headers = files('rte_telemetry.h', 'rte_telemetry_internal.h', 'rte_telemetry_parser.h', 'rte_telemetry_json.h') cflags += '-DALLOW_EXPERIMENTAL_API' includes += include_directories('../librte_metrics')
lib/librte_telemetry/rte_telemetry.h +1 -0
@@ -4,6 +4,7 @@#include <stdint.h> #include <rte_compat.h> +#include <rte_telemetry_json.h> #ifndef _RTE_TELEMETRY_H_#define _RTE_TELEMETRY_H_
lib/librte_telemetry/rte_telemetry_json.h new file +205 -0
205 lines not on this page · raw message
Signature · 1 line
2.17.1
Re: [dpdk-dev] [PATCH v2 06/16] telemetry: add utility functions for creating json
Quoted 103 lines · Ciara
From: Bruce Richardson <[email protected]>
The functions added in this patch will make it easier for applications to build up correct JSON responses to telemetry requests.
Signed-off-by Bruce Richardson <[email protected]>---
lib/librte_telemetry/Makefile | 1 + lib/librte_telemetry/meson.build | 2 +- lib/librte_telemetry/rte_telemetry.h | 1 + lib/librte_telemetry/rte_telemetry_json.h | 205 ++++++++++++++++++++++ 4 files changed, 208 insertions(+), 1 deletion(-)create mode 100644
lib/librte_telemetry/rte_telemetry_json.hlib/librte_telemetry/Makefile +0
-0@@ -29,5 +29,6 @@ SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += telemetry.c # export include filesSYMLINK-$(CONFIG_RTE_LIBRTE_TELEMETRY)-include :=
rte_telemetry.h+SYMLINK-$(CONFIG_RTE_LIBRTE_TELEMETRY)-include +=rte_telemetry_json.hinclude $(RTE_SDK)/mk/rte.lib.mk
lib/librte_telemetry/meson.build +1
-1@@ -5,7 +5,7 @@ includes = [global_inc] sources = files('rte_telemetry.c', 'rte_telemetry_parser.c', 'rte_telemetry_parser_test.c', 'telemetry.c') -headers = files('rte_telemetry.h', 'rte_telemetry_internal.h', 'rte_telemetry_parser.h') +headers = files('rte_telemetry.h', 'rte_telemetry_internal.h', 'rte_telemetry_parser.h', 'rte_telemetry_json.h')cflags += '-DALLOW_EXPERIMENTAL_API' includes +=
include_directories('../librte_metrics')lib/librte_telemetry/rte_telemetry.h +1
-0@@ -4,6 +4,7 @@#include <stdint.h> #include <rte_compat.h> +#include <rte_telemetry_json.h> #ifndef _RTE_TELEMETRY_H_#define _RTE_TELEMETRY_H_lib/librte_telemetry/rte_telemetry_json.h new file +43
-0@@ -0,0 +1,205 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright(c) 2020 Intel Corporation +*/ + +#ifndef _RTE_TELEMETRY_JSON_H_ +#define _RTE_TELEMETRY_JSON_H_ + +#include <inttypes.h> +#include <stdarg.h> +#include <stdio.h> + +/** +* @warning +* @b EXPERIMENTAL: all functions in this file may change without prior notice +* +* @file +* RTE Telemetry Utility Functions for Creating JSON Responses +* +* This file contains small inline functions to make it easier for applications +* to build up valid JSON responses to telemetry requests. +* +***/ + +/** +* @internal +* +* Copies a value into a buffer if the buffer has enough available space. +* Nothing written to buffer if an overflow ocurs. +* This function is not for use for values larger than 1k. +* +* @param buf +* Buffer for data to be appended to. +* @param len +* Length of buffer. +* @param format +* Format string. +* @param ... +* Optional arguments that may be required by the format string. +* +* @return +* Number of characters added to buffer +*/ +__attribute__((__format__(__printf__, 3, 4)))
lib/librte_telemetry/rte_telemetry_json.h line 53
Quoted 10 lines
lib/librte_telemetry/rte_telemetry_json.h new file +10
-0+static inline int +__json_snprintf (char *buf,const int len,const char *format, ...) +{ +char tmp[1024 ]; +va_list ap; +int ret; + +va_start (ap, format); + ret =vsnprintf (tmp,sizeof (tmp), format, ap); +va_end (ap);
Would strlcpy(buf, tmp, len); reduce the test below? vsnprintf() writes at most size bytes including the ‘\0’ to the buffer. Maybe able to reduce the code to this:
return strlcpy(buf, tmp, len); // strlcpy returns the total length of buf.
This means the ret is not really required, unless I missed something.
Quoted 155 lines
lib/librte_telemetry/rte_telemetry_json.h new file +152
-0+if (ret >0 && ret < (int )sizeof (tmp) && ret < len) { +strcpy (buf, tmp); +return ret; + } + return 0; /* nothing written or modified */ +} + +/** +* Copies an empty array into the provided buffer. +* +* @param buf +* Buffer to hold the empty array. +* @param len +* Length of buffer. +* @param used +* The number of used characters in the buffer. +* +* @return +* Total number of characters in buffer. +*/ +static inline int +rte_tel_json_empty_array (char *buf,const int len,const int used) +{ +return used +__json_snprintf (buf + used, len - used,"[]" ); +} + +/** +* Copies an empty object into the provided buffer. +* +* @param buf +* Buffer to hold the empty object. +* @param len +* Length of buffer. +* @param used +* The number of used characters in the buffer. +* +* @return +* Total number of characters in buffer +*/ +static inline int +rte_tel_json_empty_obj (char *buf,const int len,const int used) +{ +return used +__json_snprintf (buf + used, len - used,"{}" ); +} + +/** +* Copies a string into the provided buffer, in JSON format. +* +* @param buf +* Buffer to copy string into. +* @param len +* Length of buffer. +* @param used +* The number of used characters in the buffer. +* @param str +* String value to copy into buffer. +* +* @return +* Total number of characters in buffer +*/ +static inline int +rte_tel_json_str (char *buf,const int len,const int used,const char *str) +{ +return used +__json_snprintf (buf + used, len - used,"\"%s\"" , str); +} + +/** +* Appends a string into the JSON array in the provided buffer. +* +* @param buf +* Buffer to append array string to. +* @param len +* Length of buffer. +* @param used +* The number of used characters in the buffer. +* @param str +* String value to append to buffer. +* +* @return +* Total number of characters in buffer +*/ +static inline int +rte_tel_json_add_array_string (char *buf,const int len,const int used, +const char *str) +{ +int ret, end = used -1 ;/* strip off final delimiter */ +if (used <=2 )/* assume empty, since minimum is '[]' */ +return __json_snprintf (buf, len,"[\"%s\"]" , str); + + ret =__json_snprintf (buf + end, len - end,",\"%s\"]" , str); +return ret ==0 ? used : end + ret; +} + +/** +* Appends an integer into the JSON array in the provided buffer. +* +* @param buf +* Buffer to append array integer to. +* @param len +* Length of buffer. +* @param used +* The number of used characters in the buffer. +* @param val +* Integer value to append to buffer. +* +* @return +* Total number of characters in buffer +*/ +static inline int +rte_tel_json_add_array_int (char *buf,const int len,const int used,int val) +{ +int ret, end = used -1 ;/* strip off final delimiter */ +if (used <=2 )/* assume empty, since minimum is '[]' */ +return __json_snprintf (buf, len,"[%d]" , val); + + ret =__json_snprintf (buf + end, len - end,",%d]" , val); +return ret ==0 ? used : end + ret; +} + +/** +* Add a new element with uint64_t value to the JSON object stored in the +* provided buffer. +* +* @param buf +* Buffer to append object element to. +* @param len +* Length of buffer. +* @param used +* The number of used characters in the buffer. +* @param name +* String for object element key. +* @param val +* Uint64_t for object element value. +* +* @return +* Total number of characters in buffer +*/ +static inline int +rte_tel_json_add_obj_u64 (char *buf,const int len,const int used, +const char *name,uint64_t val) +{ +int ret, end = used -1 ; +if (used <=2 )/* assume empty, since minimum is '{}' */ +return __json_snprintf (buf, len,"{\"%s\":%" PRIu64"}" , name, + val); + + ret =__json_snprintf (buf + end, len - end,",\"%s\":%" PRIu64"}" , + name, val); +return ret ==0 ? used : end + ret; +} + +#endif /*_RTE_TELEMETRY_JSON_H_*/ Signature · 1 line
2.17.1
Re: [dpdk-dev] [PATCH v2 06/16] telemetry: add utility functions for creating json
Quoted 17 lines · Keith
Quoted 17 lines · Ciara
From: Bruce Richardson <[email protected]>
The functions added in this patch will make it easier for applications to build up correct JSON responses to telemetry requests.
Signed-off-by Bruce Richardson <[email protected]>---
lib/librte_telemetry/Makefile | 1 + lib/librte_telemetry/meson.build | 2 +- lib/librte_telemetry/rte_telemetry.h | 1 + lib/librte_telemetry/rte_telemetry_json.h | 205 ++++++++++++++++++++++ 4 files changed, 208 insertions(+), 1 deletion(-)create mode 100644
lib/librte_telemetry/rte_telemetry_json.h
<snip>
Quoted 37 lines
Quoted 20 lines
lib/librte_telemetry/rte_telemetry_json.h new file +20
-0+/** +* @internal +* +* Copies a value into a buffer if the buffer has enough available space. +* Nothing written to buffer if an overflow ocurs. +* This function is not for use for values larger than 1k. +* +* @param buf +* Buffer for data to be appended to. +* @param len +* Length of buffer. +* @param format +* Format string. +* @param ... +* Optional arguments that may be required by the format string. +* +* @return +* Number of characters added to buffer +*/ +__attribute__((__format__(__printf__, 3, 4)))lib/librte_telemetry/rte_telemetry_json.h line 53
Quoted 10 lines
lib/librte_telemetry/rte_telemetry_json.h new file +10
-0+static inline int +__json_snprintf (char *buf,const int len,const char *format, ...) +{ +char tmp[1024 ]; +va_list ap; +int ret; + +va_start (ap, format); +ret =vsnprintf (tmp,sizeof (tmp), format, ap); +va_end (ap);Would
strlcpy(buf, tmp, len); reduce the test below?vsnprintf()writes at most size bytes including the ‘\0’ to the buffer. Maybe able to reduce the code to this:return
strlcpy(buf, tmp, len);// strlcpy returns the total length of buf.This means the ret is not really required, unless I missed something.
Quoted 7 lines
lib/librte_telemetry/rte_telemetry_json.h line 60
Quoted 7 lines
lib/librte_telemetry/rte_telemetry_json.h new file +7
-0+if (ret >0 && ret < (int )sizeof (tmp) && ret < len) { +strcpy (buf, tmp); +return ret; +} +return 0 ;/* nothing written or modified */ +} +
The intent here is that the buffer remains unmodified and the function returns zero in the case that the printf fails to work. Truncation would likely leave us with invalid json, so it's all or nothing, which is why we can't just take the snprintf or strlcpy. [On overflow they still modify the buffer, which means any closing "]" or "}" in the json would be overwritten.]
/Bruce
PATCH v2 7/16 app/test: add telemetry json tests
In reply to Ciara PowerFrom: Bruce Richardson <[email protected]>
This patch adds tests for the json utility functions in the telemetry library.
--- app/test/Makefile | 2 + app/test/meson.build | 4 + app/test/test_telemetry_json.c | 136 +++++++++++++++++++++++++++++++++ 3 files changed, 142 insertions(+) create mode 100644 app/test/test_telemetry_json.c
app/test/Makefile +2 -0
@@ -136,6 +136,8 @@ SRCS-$(CONFIG_RTE_LIBRTE_LPM) += test_lpm_perf.c SRCS-$(CONFIG_RTE_LIBRTE_LPM) += test_lpm6.c SRCS-$(CONFIG_RTE_LIBRTE_LPM) += test_lpm6_perf.c +SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += test_telemetry_json.c + SRCS-y += test_debug.c SRCS-y += test_errno.c SRCS-y += test_tailq.c
app/test/meson.build +4 -0
@@ -320,6 +320,10 @@ endif if dpdk_conf.has('RTE_LIBRTE_SKELETON_EVENTDEV_PMD') test_deps += 'pmd_skeleton_event' endif +if dpdk_conf.has('RTE_LIBRTE_TELEMETRY') + test_sources += 'test_telemetry_json.c' + fast_tests += [['telemetry_json_autotest', true]] +endif # The following linkages of drivers are required because # they are used via a driver-specific API.
app/test/test_telemetry_json.c new file +136 -0
136 lines not on this page · raw message
Signature · 1 line
2.17.1
PATCH v2 8/16 ethdev: add callback support for telemetry
In reply to Ciara PowerFrom: Bruce Richardson <[email protected]>
The ethdev library now registers commands with telemetry, and implements the callback functions. These commands allow the list of ethdev ports and the stats and link status for a port to be queried.
---
v2:
- Renamed stats to xstats for device specific stats.
- Added link status command for ethdev ports.
--- lib/librte_ethdev/Makefile | 4 ++ lib/librte_ethdev/meson.build | 4 ++ lib/librte_ethdev/rte_ethdev.c | 106 +++++++++++++++++++++++++++++++++ 3 files changed, 114 insertions(+)
lib/librte_ethdev/Makefile +4 -0
@@ -24,6 +24,10 @@ SRCS-y += rte_tm.c SRCS-y += rte_mtr.c SRCS-y += ethdev_profile.c +ifeq ($(CONFIG_RTE_LIBRTE_TELEMETRY),y) +LDLIBS += -lrte_telemetry +endif + # # Export include files #
lib/librte_ethdev/meson.build +4 -0
@@ -26,3 +26,7 @@ headers = files('rte_ethdev.h', 'rte_tm_driver.h') deps += ['net', 'kvargs', 'meter'] + +if dpdk_conf.has('RTE_LIBRTE_TELEMETRY') + deps += ['telemetry'] +endif
lib/librte_ethdev/rte_ethdev.c +106 -0
121 lines not on this page · raw message
Signature · 1 line
2.17.1
Re: [dpdk-dev] [PATCH v2 08/16] ethdev: add callback support for telemetry
Quoted 148 lines · Ciara
From: Bruce Richardson <[email protected]>
The ethdev library now registers commands with telemetry, and implements the callback functions. These commands allow the list of ethdev ports and the stats and link status for a port to be queried.
Signed-off-by Bruce Richardson <[email protected]>Signed-off-by Ciara Power <[email protected]>---
v2:
- Renamed stats to xstats for device specific stats.
- Added link status command for ethdev ports.
---lib/librte_ethdev/Makefile | 4 ++ lib/librte_ethdev/meson.build | 4 ++ lib/librte_ethdev/rte_ethdev.c | 106 +++++++++++++++++++++++++++++++++ 3 files changed, 114 insertions(+)lib/librte_ethdev/Makefile +0
-0@@ -24,6 +24,10 @@ SRCS-y += rte_tm.cSRCS-y +=
rte_mtr.c
SRCS-y +=ethdev_profile.clib/librte_ethdev/Makefile +4
-0+ifeq ($(CONFIG_RTE_LIBRTE_TELEMETRY),y) +LDLIBS += -lrte_telemetry +endif +#
# Export include files
#lib/librte_ethdev/meson.build +0
-0@@ -26,3 +26,7 @@ headers = files('rte_ethdev.h', 'rte_tm_driver.h')deps += ['net', 'kvargs', 'meter']
lib/librte_ethdev/meson.build +4
-0+ +if dpdk_conf.has('RTE_LIBRTE_TELEMETRY') + deps += ['telemetry'] +endiflib/librte_ethdev/rte_ethdev.c +83
-0@@ -38,6 +38,9 @@#include <rte_kvargs.h> #include <rte_class.h> #include <rte_ether.h> +#ifdef RTE_LIBRTE_TELEMETRY +#include <rte_telemetry.h> +#endif #include "rte_ethdev.h" #include "rte_ethdev_driver.h" @@ -5189,9 +5192,112 @@ rte_eth_devargs_parse(const char *dargs, struct rte_eth_devargs *eth_da)return result; } +#ifdef RTE_LIBRTE_TELEMETRY +static int +handle_port_list(const char *cmd __rte_unused, + const char *params __rte_unused, +char *buffer,int buf_len) +{ +int port_id, used =0 ; + + used =rte_tel_json_empty_array (buffer, buf_len, used); +RTE_ETH_FOREACH_DEV (port_id) + used =rte_tel_json_add_array_int (buffer, buf_len, used, + port_id); +return used; +} + +static int +handle_port_xstats(const char *cmd __rte_unused, +const char *params, +char *buffer,int buf_len) +{ +struct rte_eth_xstat *eth_xstats; +struct rte_eth_xstat_name *xstat_names; +int port_id, num_xstats; +int i, ret; +int used =0 ; + +if (params ==NULL ||strlen (params) ==0 || !isdigit (*params)) +return -1 ; + + port_id =atoi (params); +if (!rte_eth_dev_is_valid_port (port_id)) +return -1 ; + + num_xstats =rte_eth_xstats_get (port_id,NULL ,0 ); +if (num_xstats <0 ) +return -1 ; + +/* use one malloc for both names and stats */ + eth_xstats =malloc ((sizeof (struct rte_eth_xstat ) + +sizeof (struct rte_eth_xstat_name )) * num_xstats); +if (eth_xstats ==NULL ) +return -1 ; + xstat_names = (void *)ð_xstats[num_xstats]; + + ret =rte_eth_xstats_get_names (port_id, xstat_names, num_xstats); +if (ret <0 || ret > num_xstats) { +free (eth_xstats); +return -1 ; + } + + ret =rte_eth_xstats_get (port_id, eth_xstats, num_xstats); +if (ret <0 || ret > num_xstats) { +free (eth_xstats); +return -1 ; + } + + used =rte_tel_json_empty_obj (buffer, buf_len, used); +for (i =0 ; i < num_xstats; i++) + used =rte_tel_json_add_obj_u64 (buffer, buf_len, used, + xstat_names[i].name, eth_xstats[i].value); + +return used; +} + +static int +handle_port_link_status(const char *cmd __rte_unused, +const char *params, +char *buffer,int buf_len) +{ +int ret, port_id; +struct rte_eth_link link; + +if (params ==NULL ||strlen (params) ==0 || !isdigit (*params)) +return -1 ; + + port_id =atoi (params); +if (!rte_eth_dev_is_valid_port (port_id)) +return -1 ; + + ret =rte_eth_link_get (port_id, &link);
lib/librte_ethdev/rte_ethdev.c rte_eth_devargs_parse(const char *dargs, struct rte_eth_devargs *eth_da) · line 5284
Quoted 10 lines
lib/librte_ethdev/rte_ethdev.c +10
-0+if (ret <0 ) +return -1 ; + +if (link.link_status) + ret =snprintf (buffer, buf_len, +"{\"status\":\"%s\", \"speed\":%u, \"duplex\":" +"\"%s\"}" , link.link_status ?"UP" :"DOWN:" , + link.link_speed, + (link.link_duplex ==ETH_LINK_FULL_DUPLEX ) ? + ("full-duplex" ) : ("half-duplex" ));
Adding link status nice. Please remove the spaces in the output string.
Quoted 22 lines
lib/librte_ethdev/rte_ethdev.c +13
-0+ else + ret =snprintf (buffer, buf_len,"{\"status\":\"DOWN\"}" ); + + return ret >= buf_len ? -1 : ret; +} +#endif +RTE_INIT (ethdev_init_log) { rte_eth_dev_logtype =rte_log_register ("lib.ethdev" );if (rte_eth_dev_logtype >=0 )rte_log_set_level (rte_eth_dev_logtype,RTE_LOG_INFO ); +#ifdef RTE_LIBRTE_TELEMETRY +rte_telemetry_register_cmd ("/ethdev/list" , handle_port_list); +rte_telemetry_register_cmd ("/ethdev/xstats" , handle_port_xstats); +rte_telemetry_register_cmd ("/ethdev/link_status" , + handle_port_link_status); +#endif }Signature · 1 line
2.17.1
Re: [dpdk-dev] [PATCH v2 08/16] ethdev: add callback support for telemetry
Quoted 23 lines · Keith
Quoted 23 lines · Ciara
From: Bruce Richardson <[email protected]>
The ethdev library now registers commands with telemetry, and implements the callback functions. These commands allow the list of ethdev ports and the stats and link status for a port to be queried.
Signed-off-by Bruce Richardson <[email protected]>Signed-off-by Ciara Power <[email protected]>---
v2:
- Renamed stats to xstats for device specific stats.
- Added link status command for ethdev ports.
---lib/librte_ethdev/Makefile | 4 ++ lib/librte_ethdev/meson.build | 4 ++ lib/librte_ethdev/rte_ethdev.c | 106 +++++++++++++++++++++++++++++++++ 3 files changed, 114 insertions(+)
<snip>
Quoted 11 lines
+
lib/librte_ethdev/rte_ethdev.c rte_eth_devargs_parse(const char *dargs, struct rte_eth_devargs *eth_da) · line 5284
Quoted 7 lines
lib/librte_ethdev/rte_ethdev.c +7
-0+if (link.link_status) +ret =snprintf (buffer, buf_len, +"{\"status\":\"%s\", \"speed\":%u, \"duplex\":" +"\"%s\"}" , link.link_status ?"UP" :"DOWN:" , +link.link_speed, +(link.link_duplex ==ETH_LINK_FULL_DUPLEX ) ? +("full-duplex" ) : ("half-duplex" ));Adding link status nice. Please remove the spaces in the output string.
Good catch, thanks.
Re: [dpdk-dev] [PATCH v2 08/16] ethdev: add callback support fortelemetry
Quoted 28 lines
From: dev [mailto:[email protected]] On Behalf Of Bruce Richardson
Sent: Thursday, April 9, 2020 10:21 AMQuoted 3 lines · Keith
Quoted 3 lines
On Apr 8, 2020, at 11:49 AM, Power, Ciara <[email protected]>
Quoted 6 lines · wrote:
Quoted 6 lines
From: Bruce Richardson <[email protected]>
The ethdev library now registers commands with telemetry, and implements the callback functions. These commands allow the list of ethdev ports and the stats and link status for a port to be
queried.
Quoted 4 lines
Quoted 4 lines
Signed-off-by Bruce Richardson <[email protected]>Signed-off-by Ciara Power <[email protected]>Quoted 8 lines
Quoted 8 lines
---
v2:
- Renamed stats to xstats for device specific stats.
- Added link status command for ethdev ports.
---lib/librte_ethdev/Makefile | 4 ++ lib/librte_ethdev/meson.build | 4 ++ lib/librte_ethdev/rte_ethdev.c | 106+++++++++++++++++++++++++++++++++
Quoted 8 lines
Quoted 2 lines
Quoted 2 lines
3 files changed, 114 insertions(+)<snip>
Quoted 5 lines
+
lib/librte_ethdev/rte_ethdev.c rte_eth_devargs_parse(const char *dargs, struct rte_eth_devargs *eth_da) · line 5281
Quoted 4 lines
lib/librte_ethdev/rte_ethdev.c +4
-0+if (link.link_status) +ret = snprintf(buffer, buf_len, +"{\"status\":\"%s\", \"speed\":%u, \"duplex\":" +"\"%s\"}", link.link_status ? "UP" : "DOWN:",
Also remove the colon after DOWN.
Quoted 8 lines
Quoted 5 lines
lib/librte_ethdev/rte_ethdev.c rte_eth_devargs_parse(const char *dargs, struct rte_eth_devargs *eth_da) · line 5284
Quoted 3 lines
lib/librte_ethdev/rte_ethdev.c +3
-0+link.link_speed, +(link.link_duplex ==ETH_LINK_FULL_DUPLEX ) ? +("full-duplex") : ("half-duplex"));Adding link status nice. Please remove the spaces in the output
string.
Quoted 1 line
Good catch, thanks.
PATCH v2 9/16 usertools: add new telemetry python script
In reply to Ciara PowerFrom: Bruce Richardson <[email protected]>
This patch adds a python script that can be used with the new telemetry socket. It connects as a client to the socket, and allows the user send a command and see the JSON response.
The example usage below shows the script connecting to the new telemetry socket, and sending two basic ethdev commands entered by the user. The response for each command is shown below the user input.
Connecting to /var/run/dpdk/rte/dpdk_telemetry.v2
{"pid": 63724, "version": "DPDK 20.05.0-rc0", "max_output_len": 16384} --> /
{"/": ["/", "/ethdev/link_status", "/ethdev/list", "/ethdev/xstats", \
"/info"]}
--> /info
{"/info": {"pid": 63724, "version": "DPDK 20.05.0-rc0", \
"max_output_len": 16384}}
--> /ethdev/list
{"/ethdev/list": [0, 1]}
--> /ethdev/link_status,0
{"/ethdev/link_status": {"status": "UP", "speed": 10000, "duplex": \
"full-duplex"}}
--> /ethdev/xstats,0
{"/ethdev/xstats": {"rx_good_packets": 0, "tx_good_packets": 0, \
<snip>
"tx_priority7_xon_to_xoff_packets": 0}}---
v2:
- Renamed new python script to dpdk-telemetry.py.
- Fixed script to validate input before sending to Telemetry.
--- usertools/dpdk-telemetry.py | 44 +++++++++++++++++++++++++++++++++++++ usertools/meson.build | 2 +- 2 files changed, 45 insertions(+), 1 deletion(-) create mode 100755 usertools/dpdk-telemetry.py
usertools/dpdk-telemetry.py new file +44 -0
@@ -0,0 +1,44 @@ +#! /usr/bin/python3 +# SPDX-License-Identifier: BSD-3-Clause +# Copyright(c) 2020 Intel Corporation + +import socket +import os +import glob +import json + +telemetry_version = "v2" + +def read_socket(buf_len): + reply = fd.recv(buf_len).decode() + try: + print(json.dumps(json.loads(reply))) + return json.loads(reply) + except: + print("Error in reply: ", reply) + raise + +def handle_socket(path): + print("Connecting to " + path) + try: + fd.connect(path) + except OSError: + return + json_reply = read_socket(1024) + output_buf_len = json_reply["max_output_len"] + text = input('--> ').strip() + while (text != "quit"): + if text.startswith('/'): + fd.send(text.encode()) + read_socket(output_buf_len) + text = input('--> ').strip() + + fd.close() + +fd = socket.socket(socket.AF_UNIX, socket.SOCK_SEQPACKET) +# Path to sockets for processes run as a root user +for f in glob.glob('/var/run/dpdk/*/dpdk_telemetry.%s' % telemetry_version): + handle_socket(f) +# Path to sockets for processes run as a regular user +for f in glob.glob('/run/user/%d/dpdk/*/dpdk_telemetry.%s' % (os.getuid(), telemetry_version)): + handle_socket(f)
usertools/meson.build +1 -1
@@ -1,4 +1,4 @@ # SPDX-License-Identifier: BSD-3-Clause # Copyright(c) 2017 Intel Corporation -install_data(['dpdk-devbind.py', 'dpdk-pmdinfo.py'], install_dir: 'bin') +install_data(['dpdk-devbind.py', 'dpdk-pmdinfo.py', 'dpdk-telemetry.py'], install_dir: 'bin')
Signature · 1 line
2.17.1
Re: [dpdk-dev] [PATCH v2 09/16] usertools: add new telemetry python script
Quoted 4 lines
-----Original Message-----
From: Power, Ciara <[email protected]>
Some pylint checks found, good to address valid ones.
#pylint-3.6 ./usertools/dpdk-telemetry.py or # pylint ./usertools/dpdk-telemetry.py ************* Module dpdk-telemetry
W: 18, 0: Bad indentation. Found 12 spaces, expected 8 (bad-indentation) W: 19, 0: Bad indentation. Found 12 spaces, expected 8 (bad-indentation) C: 30, 0: Unnecessary parens after 'while' keyword (superfluous-parens) W: 41, 0: Bad indentation. Found 2 spaces, expected 4 (bad-indentation) W: 44, 0: Bad indentation. Found 2 spaces, expected 4 (bad-indentation) C: 1, 0: Invalid module name "dpdk-telemetry" (invalid-name) C: 1, 0: Missing module docstring (missing-docstring) C: 10, 0: Invalid constant name "telemetry_version" (invalid-name) C: 12, 0: Missing function docstring (missing-docstring) C: 21, 0: Missing function docstring (missing-docstring) C: 38, 0: Invalid constant name "fd" (invalid-name)
usertools/dpdk-telemetry.py line 16
Quoted 2 lines
usertools/dpdk-telemetry.py new file +2
-0+def read_socket(buf_len): + return json.loads(reply)
Close the open fd?
usertools/dpdk-telemetry.py line 18
Quoted 2 lines
usertools/dpdk-telemetry.py new file +2
-0+ except: + print("Error in reply: ", reply)
Close the open fd?
Quoted 3 lines
usertools/dpdk-telemetry.py new file +2
-0+ raise +def handle_socket(path):
<snip>
usertools/dpdk-telemetry.py line 25
Quoted 2 lines
usertools/dpdk-telemetry.py new file +2
-0+ fd.connect(path) + except OSError:
Good to add reason of error message.
Do you need to close the fd?
Quoted 1 line
+ return
Re: [dpdk-dev] [PATCH v2 09/16] usertools: add new telemetry python script
Quoted 33 lines · Reshma
Quoted 4 lines
-----Original Message-----
From: Power, Ciara <[email protected]>Some pylint checks found, good to address valid ones.
#pylint-3.6
./usertools/dpdk-telemetry.pyor # pylint./usertools/dpdk-telemetry.py************* Module dpdk-telemetryW: 18, 0: Bad indentation. Found 12 spaces, expected 8 (bad-indentation) W: 19, 0: Bad indentation. Found 12 spaces, expected 8 (bad-indentation) C: 30, 0: Unnecessary parens after 'while' keyword (superfluous-parens) W: 41, 0: Bad indentation. Found 2 spaces, expected 4 (bad-indentation) W: 44, 0: Bad indentation. Found 2 spaces, expected 4 (bad-indentation) C: 1, 0: Invalid module name "dpdk-telemetry" (invalid-name) C: 1, 0: Missing module docstring (missing-docstring) C: 10, 0: Invalid constant name "telemetry_version" (invalid-name) C: 12, 0: Missing function docstring (missing-docstring) C: 21, 0: Missing function docstring (missing-docstring) C: 38, 0: Invalid constant name "fd" (invalid-name)usertools/dpdk-telemetry.py line 16
Quoted 2 lines
usertools/dpdk-telemetry.py new file +2
-0+def read_socket(buf_len): + return json.loads(reply)Close the open fd?
usertools/dpdk-telemetry.py line 18
Quoted 2 lines
usertools/dpdk-telemetry.py new file +2
-0+ except: + print("Error in reply: ", reply)Close the open fd?
Quoted 1 line
+ raise
Quoted 10 lines
Quoted 1 line
+def
handle_socket(path):<snip>
usertools/dpdk-telemetry.py line 25
Quoted 2 lines
usertools/dpdk-telemetry.py new file +2
-0+ fd.connect(path) + except OSError:Good to add reason of error message.
Do you need to close the fd?Quoted 1 line
+ return
Thanks for the review, Reshma. For v3 we are ensuring pep8/pycodestyle compliance, but we'll also add pylint to the list to run. We'll look into the other issues too.
PATCH v2 10/16 rawdev: add callback support for telemetry
In reply to Ciara PowerThe rawdev library now registers commands with telemetry, and implements the corresponding callback functions. These allow a list of rawdev devices and xstats for a rawdev port to be queried.
An example usage, with ioat rawdev driver instances, is shown below:
Connecting to /var/run/dpdk/rte/dpdk_telemetry.v2
{"pid": 66100, "version": "DPDK 20.05.0-rc0", "max_output_len": 16384} --> /
{"/": ["/", "/ethdev/link_status", "/ethdev/list", "/ethdev/xstats", \
"/info", "/rawdev/list", "/rawdev/xstats"]}
--> /rawdev/list
{"/rawdev/list": [0, 1, 2, 3, 4, 5]}
--> /rawdev/xstats,0
{"/rawdev/xstats": {"failed_enqueues": 0, "successful_enqueues": 0, \
"copies_started": 0, "copies_completed": 0}}---
v2: Renamed stats to xstats for device specific stats.
--- lib/librte_rawdev/Makefile | 5 +++ lib/librte_rawdev/meson.build | 5 +++ lib/librte_rawdev/rte_rawdev.c | 81 ++++++++++++++++++++++++++++++++++ 3 files changed, 91 insertions(+)
lib/librte_rawdev/Makefile +5 -0
@@ -11,6 +11,11 @@ CFLAGS += -O3 CFLAGS += $(WERROR_FLAGS) LDLIBS += -lrte_eal +ifeq ($(CONFIG_RTE_LIBRTE_TELEMETRY),y) +CFLAGS += -DALLOW_EXPERIMENTAL_API +LDLIBS += -lrte_telemetry +endif + # library source files SRCS-y += rte_rawdev.c
lib/librte_rawdev/meson.build +5 -0
@@ -3,3 +3,8 @@ sources = files('rte_rawdev.c') headers = files('rte_rawdev.h', 'rte_rawdev_pmd.h') + +if dpdk_conf.has('RTE_LIBRTE_TELEMETRY') + allow_experimental_apis = true + deps += ['telemetry'] +endif
lib/librte_rawdev/rte_rawdev.c +81 -0
96 lines not on this page · raw message
Signature · 1 line
2.17.1
PATCH v2 11/16 examples/l3fwd-power: enable use of new telemetry
In reply to Ciara PowerThe l3fwd-power example app now registers a stats command with telemetry, and provides a callback function to handle formatting the power stats.
An example usage is shown below:
Connecting to /var/run/dpdk/rte/dpdk_telemetry.v2
{"pid": 6726, "version": "DPDK 20.05.0-rc0", "max_output_len": 16384} --> /
{"/": ["/", "/ethdev/link_status", "/ethdev/list", "/ethdev/xstats", \
"/info", "/l3fwd-power/stats", "/rawdev/list", "/rawdev/xstats"]}
--> /l3fwd-power/stats
{"/l3fwd-power/stats": {"empty_poll": 281625000, "full_poll": 0, \
"busy_percent": 0}}The existing stats tracking done by the app using the metrics library is unaffected. This will still be used to ensure backward compatibility.
--- examples/l3fwd-power/Makefile | 4 +++ examples/l3fwd-power/main.c | 57 ++++++++++++++++++++++++-------- examples/l3fwd-power/meson.build | 4 +++ 3 files changed, 51 insertions(+), 14 deletions(-)
examples/l3fwd-power/Makefile +4 -0
@@ -68,6 +68,10 @@ ifeq ($(CONFIG_RTE_TOOLCHAIN_GCC),y) CFLAGS_main.o += -Wno-return-type endif +ifeq ($(CONFIG_RTE_LIBRTE_TELEMETRY),y) +LDLIBS += -lrte_telemetry +endif + include $(RTE_SDK)/mk/rte.extapp.mk endif endif
examples/l3fwd-power/main.c +43 -14
111 lines not on this page · raw message
examples/l3fwd-power/meson.build +4 -0
@@ -16,3 +16,7 @@ deps += ['power', 'timer', 'lpm', 'hash', 'metrics'] sources = files( 'main.c', 'perf_core.c' ) + +if dpdk_conf.has('RTE_LIBRTE_TELEMETRY') + deps += ['telemetry'] +endif
Signature · 1 line
2.17.1
Re: [dpdk-dev] [PATCH v2 11/16] examples/l3fwd-power: enable use of new telemetry
examples/l3fwd-power/main.c update_telemetry(__attribute__((unused)) struct rte_timer *tim, · line 2118
Quoted 13 lines
-----Original Message-----
From: Power, Ciara <[email protected]>
---examples/l3fwd-power/main.c +6
-1- +#define NUM_TELSTATS RTE_DIM(telstats_strings) + +static void +update_telemetry (__attribute__((unused))struct rte_timer *tim, + __attribute__((unused))void *arg) + uint64_t values[3 ] = {0 };
Use NUM_TELSTATS, in place of 3.
Review
Quoted 1 line
(quoted diff) +1
-0+ uint64_t values[3] = {0};
Use NUM_TELSTATS, in place of 3.
Thanks,
Reshma
PATCH v2 12/16 telemetry: introduce telemetry backward compatibility
In reply to Ciara PowerThe new telemetry will now open a socket using the old telemetry path, to ensure backward compatibility. This is not yet initialised, as it would clash with the existing telemetry, to be removed in a later patch. This means that both old and new telemetry socket interfaces are handled in a common way.
--- lib/librte_metrics/Makefile | 2 +- lib/librte_metrics/meson.build | 1 + lib/librte_metrics/rte_metrics_telemetry.c | 113 +++++++++ lib/librte_telemetry/Makefile | 1 + lib/librte_telemetry/meson.build | 4 +- lib/librte_telemetry/rte_telemetry.h | 1 + lib/librte_telemetry/rte_telemetry_legacy.h | 63 +++++ .../rte_telemetry_version.map | 2 + lib/librte_telemetry/telemetry.c | 32 +++ lib/librte_telemetry/telemetry_legacy.c | 226 ++++++++++++++++++ 10 files changed, 442 insertions(+), 3 deletions(-) create mode 100644 lib/librte_telemetry/rte_telemetry_legacy.h create mode 100644 lib/librte_telemetry/telemetry_legacy.c
lib/librte_metrics/Makefile +1 -1
@@ -19,7 +19,7 @@ ifeq ($(CONFIG_RTE_LIBRTE_TELEMETRY),y) SRCS-y += rte_metrics_telemetry.c SYMLINK-$(CONFIG_RTE_LIBRTE_METRICS)-include += rte_metrics_telemetry.h -LDLIBS += -lrte_ethdev +LDLIBS += -lrte_ethdev -lrte_telemetry LDLIBS += -ljansson CFLAGS += -I$(RTE_SDK)/lib/librte_telemetry/
lib/librte_metrics/meson.build +1 -0
@@ -11,4 +11,5 @@ if jansson.found() sources += files('rte_metrics_telemetry.c') headers = files('rte_metrics_telemetry.h') deps += ['ethdev', 'telemetry'] + includes += include_directories('../librte_telemetry') endif
lib/librte_metrics/rte_metrics_telemetry.c +113 -0
131 lines not on this page · raw message
lib/librte_telemetry/Makefile +1 -0
@@ -26,6 +26,7 @@ SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) := rte_telemetry.c SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += rte_telemetry_parser.c SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += rte_telemetry_parser_test.c SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += telemetry.c +SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += telemetry_legacy.c # export include files SYMLINK-$(CONFIG_RTE_LIBRTE_TELEMETRY)-include := rte_telemetry.h
lib/librte_telemetry/meson.build +2 -2
@@ -3,8 +3,8 @@ includes = [global_inc] -sources = files('rte_telemetry.c', 'rte_telemetry_parser.c', 'rte_telemetry_parser_test.c', - 'telemetry.c') +sources = files('rte_telemetry.c','rte_telemetry_parser.c', 'rte_telemetry_parser_test.c', + 'telemetry.c', 'telemetry_legacy.c') headers = files('rte_telemetry.h', 'rte_telemetry_internal.h', 'rte_telemetry_parser.h', 'rte_telemetry_json.h') cflags += '-DALLOW_EXPERIMENTAL_API' includes += include_directories('../librte_metrics')
lib/librte_telemetry/rte_telemetry.h +1 -0
@@ -135,4 +135,5 @@ int rte_telemetry_register_cmd(const char *cmd, telemetry_cb fn);*/ __rte_experimental int rte_telemetry_new_init(void); +#endif
lib/librte_telemetry/rte_telemetry_legacy.h new file +63 -0
63 lines not on this page · raw message
lib/librte_telemetry/rte_telemetry_version.map +2 -0
@@ -8,6 +8,8 @@ EXPERIMENTAL { rte_telemetry_set_metrics_fns; rte_telemetry_new_init; rte_telemetry_register_cmd; + rte_telemetry_legacy_init; + rte_telemetry_legacy_register; local: *; };
lib/librte_telemetry/telemetry.c +32 -0
@@ -16,6 +16,7 @@#include <rte_version.h> #include "rte_telemetry.h" +#include "rte_telemetry_legacy.h" #define MAX_CMD_LEN 56#define MAX_OUTPUT_LEN (1024 * 16)
@@ -42,6 +43,7 @@ struct socket {handler fn; };static struct socket v2_socket;/* socket for v2 telemetry */ +static struct socket v1_socket;/* socket for v1 telemetry */ static char telemetry_log_error[1024 ];/* Will contain error on init failure */ /* list of command callbacks, with one command registered by default */ static struct cmd_callback callbacks[TELEMETRY_MAX_CALLBACKS ];
@@ -201,6 +203,8 @@ unlink_sockets(void) {if (v2_socket.path[0 ])unlink (v2_socket.path); +if (v1_socket.path[0 ]) +unlink (v1_socket.path); } static int
@@ -240,6 +244,34 @@ create_socket(char *path)return -1 ; } +static int __rte_unused /* will be used in future commit */ +telemetry_legacy_init (const char *runtime_dir,const char **err_str) +{ +pthread_t t_old; + +if (num_legacy_callbacks ==1 ) { + *err_str ="No legacy callbacks - error creating legacy socket" ; +return -1 ; + } + + v1_socket.fn = legacy_client_handler; +if ((size_t )snprintf (v1_socket.path,sizeof (v1_socket.path), +"%s/telemetry" , runtime_dir) + >=sizeof (v1_socket.path)) { +snprintf (telemetry_log_error,sizeof (telemetry_log_error), +"Error with socket binding, path too long" ); +return -1 ; + } + v1_socket.sock =create_socket (v1_socket.path); +if (v1_socket.sock <0 ) { + *err_str = telemetry_log_error; +return -1 ; + } +pthread_create (&t_old,NULL , socket_listener, &v1_socket); + +return 0 ; +} +static int telemetry_v2_init (const char *runtime_dir,const char **err_str) {
lib/librte_telemetry/telemetry_legacy.c new file +226 -0
226 lines not on this page · raw message
Signature · 1 line
2.17.1
Re: [dpdk-dev] [PATCH v2 12/16] telemetry: introduce telemetry backward compatibility
Quoted 11 lines
-----Original Message-----
From: Power, Ciara <[email protected]>Review
Quoted 7 lines
(quoted diff) +6
-0+static int +telemetry_v2_init(const char *runtime_dir, const char **err_str) + if (strlcpy(v2_socket.path, get_socket_path(runtime_dir, 2), + sizeof(v2_socket.path)) >= sizeof(v2_socket.path)) { + snprintf(telemetry_log_error, sizeof(telemetry_log_error), + "Error with socket binding, path too long");
Need to update the telemetry_log_error to err_str?
PATCH v2 13/16 telemetry: remove existing telemetry files
In reply to Ciara PowerThis patch removes the existing telemetry files, which are now redundant as the new version of telemetry has backward compatibility for their functionality.
--- lib/librte_metrics/rte_metrics_telemetry.c | 9 - lib/librte_telemetry/Makefile | 5 - lib/librte_telemetry/meson.build | 15 +- lib/librte_telemetry/rte_telemetry.c | 1384 ----------------- lib/librte_telemetry/rte_telemetry.h | 55 +- lib/librte_telemetry/rte_telemetry_internal.h | 114 -- lib/librte_telemetry/rte_telemetry_parser.c | 435 ------ lib/librte_telemetry/rte_telemetry_parser.h | 15 - .../rte_telemetry_parser_test.c | 533 ------- .../rte_telemetry_socket_tests.h | 36 - .../rte_telemetry_version.map | 6 - lib/librte_telemetry/telemetry.c | 19 +- 12 files changed, 23 insertions(+), 2603 deletions(-) delete mode 100644 lib/librte_telemetry/rte_telemetry.c delete mode 100644 lib/librte_telemetry/rte_telemetry_internal.h delete mode 100644 lib/librte_telemetry/rte_telemetry_parser.c delete mode 100644 lib/librte_telemetry/rte_telemetry_parser.h delete mode 100644 lib/librte_telemetry/rte_telemetry_parser_test.c delete mode 100644 lib/librte_telemetry/rte_telemetry_socket_tests.h
lib/librte_metrics/rte_metrics_telemetry.c +0 -9
@@ -7,7 +7,6 @@#include <rte_ethdev.h> #include <rte_string_fns.h> #ifdef RTE_LIBRTE_TELEMETRY -#include <rte_telemetry_internal.h> #include <rte_telemetry_legacy.h> #endif
@@ -527,14 +526,6 @@ handle_ports_stats_values_by_name(const char *cmd __rte_unused,RTE_INIT (metrics_ctor) {#ifdef RTE_LIBRTE_TELEMETRY -static const struct metrics_functions fns = { - .reg_all_ethdev = rte_metrics_tel_reg_all_ethdev, - .encode_json_format = rte_metrics_tel_encode_json_format, - .get_port_stats_ids = rte_metrics_tel_get_port_stats_ids, - .get_ports_stats_json = rte_metrics_tel_get_ports_stats_json, - .extract_data = rte_metrics_tel_extract_data - }; -rte_telemetry_set_metrics_fns (&fns);/* assign them to telemetry lib */ rte_telemetry_legacy_register ("ports_all_stat_values" ,DATA_NOT_REQ , handle_ports_all_stats_values); rte_telemetry_legacy_register("global_stat_values", DATA_NOT_REQ,
lib/librte_telemetry/Makefile +0 -5
@@ -15,16 +15,11 @@ CFLAGS += -I$(RTE_SDK)/lib/librte_eal/$(ARCH_DIR)/include CFLAGS += -pthread LDLIBS += -lrte_eal -LDLIBS += -lrte_metrics LDLIBS += -lpthread -LDLIBS += -ljansson EXPORT_MAP := rte_telemetry_version.map # library source files -SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) := rte_telemetry.c -SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += rte_telemetry_parser.c -SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += rte_telemetry_parser_test.c SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += telemetry.c SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += telemetry_legacy.c
lib/librte_telemetry/meson.build +3 -12
@@ -3,17 +3,8 @@ includes = [global_inc] -sources = files('rte_telemetry.c','rte_telemetry_parser.c', 'rte_telemetry_parser_test.c', - 'telemetry.c', 'telemetry_legacy.c') -headers = files('rte_telemetry.h', 'rte_telemetry_internal.h', 'rte_telemetry_parser.h', 'rte_telemetry_json.h') +sources = files('telemetry.c', 'telemetry_legacy.c') +headers = files('rte_telemetry.h', 'rte_telemetry_json.h') cflags += '-DALLOW_EXPERIMENTAL_API' includes += include_directories('../librte_metrics') - -jansson = dependency('jansson', required: false) -if jansson.found() - ext_deps += jansson - dpdk_app_link_libraries += ['telemetry'] -else - build = false - reason = 'missing dependency "jansson"' -endif +dpdk_app_link_libraries += ['telemetry']
lib/librte_telemetry/rte_telemetry.c deleted +0 -1384
1,384 lines not on this page · raw message
lib/librte_telemetry/rte_telemetry.h +3 -52
78 lines not on this page · raw message
lib/librte_telemetry/rte_telemetry_internal.h deleted +0 -114
114 lines not on this page · raw message
lib/librte_telemetry/rte_telemetry_parser.c deleted +0 -435
435 lines not on this page · raw message
lib/librte_telemetry/rte_telemetry_parser.h deleted +0 -15
@@ -1,15 +0,0 @@ -/* SPDX-License-Identifier: BSD-3-Clause -* Copyright(c) 2018 Intel Corporation -*/ - -#include "rte_telemetry_internal.h" -#include "rte_compat.h" - -#ifndef _RTE_TELEMETRY_PARSER_H_ -#define _RTE_TELEMETRY_PARSER_H_ - -__rte_experimental -int32_t -rte_telemetry_parse (struct telemetry_impl *telemetry,char *socket_rx_data); - -#endif
lib/librte_telemetry/rte_telemetry_parser_test.c deleted +0 -533
533 lines not on this page · raw message
lib/librte_telemetry/rte_telemetry_socket_tests.h deleted +0 -36
@@ -1,36 +0,0 @@ -/* SPDX-License-Identifier: BSD-3-Clause -* Copyright(c) 2018 Intel Corporation -*/ - -#include <stdbool.h> - -#include "rte_telemetry_internal.h" - -#ifndef _RTE_TELEMETRY_SOCKET_TESTING_H_ -#define _RTE_TELEMETRY_SOCKET_TESTING_H_ - -int32_t -rte_telemetry_json_socket_message_test (struct telemetry_impl *telemetry, -int fd); - -int32_t -rte_telemetry_invalid_json_test (struct telemetry_impl *telemetry,int fd); - -int32_t -rte_telemetry_valid_json_test (struct telemetry_impl *telemetry,int fd); - -int32_t -rte_telemetry_json_contents_test (struct telemetry_impl *telemetry,int fd); - -int32_t -rte_telemetry_json_empty_test (struct telemetry_impl *telemetry,int fd); - -int32_t -rte_telemetry_socket_register_test (struct telemetry_impl *telemetry,int *fd, -int send_fd,int recv_fd); - -int32_t -rte_telemetry_socket_test_setup (struct telemetry_impl *telemetry,int *send_fd, -int *recv_fd); - -#endif
lib/librte_telemetry/rte_telemetry_version.map +0 -6
@@ -1,14 +1,8 @@ EXPERIMENTAL { global: - rte_telemetry_cleanup; rte_telemetry_init; - rte_telemetry_parse; - rte_telemetry_selftest; - rte_telemetry_set_metrics_fns; - rte_telemetry_new_init; rte_telemetry_register_cmd; - rte_telemetry_legacy_init; rte_telemetry_legacy_register; local: *;
lib/librte_telemetry/telemetry.c +17 -2
@@ -14,6 +14,7 @@#include <rte_common.h> #include <rte_spinlock.h> #include <rte_version.h> +#include <rte_option.h> #include "rte_telemetry.h" #include "rte_telemetry_legacy.h"
@@ -244,7 +245,7 @@ create_socket(char *path)return -1 ; } -static int __rte_unused /* will be used in future commit */ +static int telemetry_legacy_init (const char *runtime_dir,const char **err_str) {pthread_t t_old;
@@ -299,12 +300,26 @@ telemetry_v2_init(const char *runtime_dir, const char **err_str) }int32_t -rte_telemetry_new_init (void ) +rte_telemetry_init (void ) {const char *error_str;if (telemetry_v2_init (rte_eal_get_runtime_dir (), &error_str) !=0 ) {printf ("Error initialising telemetry - %s" , error_str);return -1 ; } +if (telemetry_legacy_init (rte_eal_get_runtime_dir (), &error_str) + !=0 ) +printf ("No telemetry legacy support- %s" , error_str);return 0 ; } + +static struct rte_option option = { + .name ="telemetry" , + .usage ="Enable telemetry backend" , + .cb = &rte_telemetry_init, + .enabled =0 +}; + +RTE_INIT (telemetry_register_op) { +rte_option_register (&option); +}
Signature · 1 line
2.17.1
PATCH v2 14/16 lib: add telemetry as eal dependency
In reply to Ciara PowerThis patch moves telemetry further down the build, and adds it as a dependency for EAL. Telemetry V2 is now configured to build by default, and the legacy support is built when the telemetry config flag is set.
Telemetry now has EAL flags, shown below:
"--telemetry" = Enables telemetry (this is default if no flags given) "--no-telemetry" = Disables telemetry
When telemetry is enabled, it will attempt to open the new socket version, and also the legacy support socket (this will depend on Jansson external dependency and telemetry config flag, as before).
---
v2: Telemetry config flag now represents the legacy support being built,
and is disabled by default, as in the existing telemetry.
--- config/common_base | 2 +- examples/l3fwd-power/Makefile | 6 +----- examples/l3fwd-power/main.c | 8 ++------ examples/l3fwd-power/meson.build | 6 +----- lib/Makefile | 5 ++--- lib/librte_eal/common/eal_common_options.c | 9 ++++++++ lib/librte_eal/common/eal_internal_cfg.h | 1 + lib/librte_eal/common/eal_options.h | 4 ++++ lib/librte_eal/freebsd/Makefile | 1 + lib/librte_eal/freebsd/eal.c | 9 ++++++++ lib/librte_eal/freebsd/meson.build | 2 +- lib/librte_eal/linux/Makefile | 1 + lib/librte_eal/linux/eal.c | 9 ++++++++ lib/librte_eal/linux/meson.build | 2 +- lib/librte_eal/meson.build | 5 ++++- lib/librte_ethdev/Makefile | 6 +----- lib/librte_ethdev/meson.build | 6 +----- lib/librte_ethdev/rte_ethdev.c | 6 ------ lib/librte_rawdev/Makefile | 6 +----- lib/librte_rawdev/meson.build | 6 ++---- lib/librte_rawdev/rte_rawdev.c | 6 ------ lib/librte_telemetry/Makefile | 9 ++++---- lib/librte_telemetry/meson.build | 1 - lib/librte_telemetry/rte_telemetry.h | 2 +- lib/librte_telemetry/telemetry.c | 24 +++++----------------- lib/meson.build | 2 +- mk/rte.app.mk | 5 ++++- 27 files changed, 67 insertions(+), 82 deletions(-)
config/common_base +1 -1
@@ -916,7 +916,7 @@ CONFIG_RTE_LIBRTE_BITRATE=y CONFIG_RTE_LIBRTE_LATENCY_STATS=y # -# Compile librte_telemetry +# Compile librte_telemetry legacy support # CONFIG_RTE_LIBRTE_TELEMETRY=n
examples/l3fwd-power/Makefile +1 -5
@@ -60,7 +60,7 @@ else CFLAGS += -DALLOW_EXPERIMENTAL_API CFLAGS += -O3 CFLAGS += $(WERROR_FLAGS) -LDLIBS += -lm +LDLIBS += -lm -lrte_telemetry # workaround for a gcc bug with noreturn attribute # http://gcc.gnu.org/bugzilla/show_bug.cgi?id=12603
@@ -68,10 +68,6 @@ ifeq ($(CONFIG_RTE_TOOLCHAIN_GCC),y) CFLAGS_main.o += -Wno-return-type endif -ifeq ($(CONFIG_RTE_LIBRTE_TELEMETRY),y) -LDLIBS += -lrte_telemetry -endif - include $(RTE_SDK)/mk/rte.extapp.mk endif endif
examples/l3fwd-power/main.c +2 -6
@@ -46,9 +46,7 @@#include <rte_spinlock.h> #include <rte_power_empty_poll.h> #include <rte_metrics.h> -#ifdef RTE_LIBRTE_TELEMETRY #include <rte_telemetry.h> -#endif #include "perf_core.h" #include "main.h"
@@ -2123,7 +2121,7 @@ update_telemetry(__attribute__((unused)) struct rte_timer *tim,if (ret <0 )RTE_LOG (WARNING ,POWER ,"failed to update metrcis\n" ); } -#ifdef RTE_LIBRTE_TELEMETRY + static int handle_app_stats(const char *cmd __rte_unused, const char *params __rte_unused,
@@ -2141,7 +2139,7 @@ handle_app_stats(const char *cmd __rte_unused,return used; } -#endif +static void telemetry_setup_timer (void ) {
@@ -2541,10 +2539,8 @@ main(int argc, char **argv)rte_spinlock_init (&stats[lcore_id].telemetry_lock); }rte_timer_init (&telemetry_timer); -#ifdef RTE_LIBRTE_TELEMETRY rte_telemetry_register_cmd ("/l3fwd-power/stats" , handle_app_stats); -#endif rte_eal_mp_remote_launch (main_telemetry_loop,NULL ,SKIP_MASTER ); }
examples/l3fwd-power/meson.build +1 -5
@@ -12,11 +12,7 @@ if not dpdk_conf.has('RTE_LIBRTE_POWER') endif allow_experimental_apis = true -deps += ['power', 'timer', 'lpm', 'hash', 'metrics'] +deps += ['power', 'timer', 'lpm', 'hash', 'metrics', 'telemetry'] sources = files( 'main.c', 'perf_core.c' ) - -if dpdk_conf.has('RTE_LIBRTE_TELEMETRY') - deps += ['telemetry'] -endif
lib/Makefile +2 -3
@@ -4,8 +4,9 @@ include $(RTE_SDK)/mk/rte.vars.mk DIRS-$(CONFIG_RTE_LIBRTE_KVARGS) += librte_kvargs +DIRS-y += librte_telemetry DIRS-$(CONFIG_RTE_LIBRTE_EAL) += librte_eal -DEPDIRS-librte_eal := librte_kvargs +DEPDIRS-librte_eal := librte_kvargs librte_telemetry DIRS-$(CONFIG_RTE_LIBRTE_PCI) += librte_pci DEPDIRS-librte_pci := librte_eal DIRS-$(CONFIG_RTE_LIBRTE_RING) += librte_ring
@@ -22,8 +23,6 @@ DIRS-$(CONFIG_RTE_LIBRTE_CFGFILE) += librte_cfgfile DEPDIRS-librte_cfgfile := librte_eal DIRS-$(CONFIG_RTE_LIBRTE_CMDLINE) += librte_cmdline DEPDIRS-librte_cmdline := librte_eal librte_net -DIRS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += librte_telemetry -DEPDIRS-librte_telemetry := librte_eal DIRS-$(CONFIG_RTE_LIBRTE_ETHER) += librte_ethdev DEPDIRS-librte_ethdev := librte_net librte_eal librte_mempool librte_ring DEPDIRS-librte_ethdev += librte_mbuf
lib/librte_eal/common/eal_common_options.c +9 -0
@@ -86,6 +86,8 @@ eal_long_options[] = { {OPT_LEGACY_MEM, 0, NULL, OPT_LEGACY_MEM_NUM }, {OPT_SINGLE_FILE_SEGMENTS, 0, NULL, OPT_SINGLE_FILE_SEGMENTS_NUM}, {OPT_MATCH_ALLOCATIONS, 0, NULL, OPT_MATCH_ALLOCATIONS_NUM}, + {OPT_TELEMETRY, 0, NULL, OPT_TELEMETRY_NUM }, + {OPT_NO_TELEMETRY, 0, NULL, OPT_NO_TELEMETRY_NUM }, {0, 0, NULL, 0 } };
@@ -1455,6 +1457,11 @@ eal_parse_common_option(int opt, const char *optarg,return -1 ; }break ; +case OPT_TELEMETRY_NUM : +break ; +case OPT_NO_TELEMETRY_NUM : + conf->no_telemetry =1 ; +break ;/* don't know what to do, leave this to caller */ default :
@@ -1698,6 +1705,8 @@ eal_common_usage(void)" --" OPT_IN_MEMORY " Operate entirely in memory. This will\n" " disable secondary process support\n" " --" OPT_BASE_VIRTADDR " Base virtual address\n" +" --" OPT_TELEMETRY " Enable telemetry support (on by default)\n" +" --" OPT_NO_TELEMETRY " Disable telemetry support\n" "\nEAL options for DEBUG use only:\n" " --" OPT_HUGE_UNLINK " Unlink hugepage files after init\n" " --" OPT_NO_HUGE " Use malloc instead of hugetlbfs\n"
lib/librte_eal/common/eal_internal_cfg.h +1 -0
@@ -82,6 +82,7 @@ struct internal_config {rte_cpuset_t ctrl_cpuset;/**< cpuset for ctrl threads */ volatile unsigned int init_complete;/**< indicates whether EAL has completed initialization */ +unsigned int no_telemetry;/**< true to disable Telemetry */ };extern struct internal_config internal_config;/**< Global EAL configuration. */
lib/librte_eal/common/eal_options.h +4 -0
@@ -69,6 +69,10 @@ enum {OPT_IOVA_MODE_NUM , #define OPT_MATCH_ALLOCATIONS "match-allocations"OPT_MATCH_ALLOCATIONS_NUM , +#define OPT_TELEMETRY "telemetry" +OPT_TELEMETRY_NUM , +#define OPT_NO_TELEMETRY "no-telemetry" +OPT_NO_TELEMETRY_NUM , OPT_LONG_MAX_NUM };
lib/librte_eal/freebsd/Makefile +1 -0
@@ -19,6 +19,7 @@ LDLIBS += -lexecinfo LDLIBS += -lpthread LDLIBS += -lgcc_s LDLIBS += -lrte_kvargs +LDLIBS += -lrte_telemetry EXPORT_MAP := ../rte_eal_version.map
lib/librte_eal/freebsd/eal.c +9 -0
@@ -44,6 +44,7 @@#include <rte_option.h> #include <rte_atomic.h> #include <malloc_heap.h> +#include <rte_telemetry.h> #include "eal_private.h" #include "eal_thread.h"
@@ -952,6 +953,14 @@ rte_eal_init(int argc, char **argv)rte_eal_init_alert ("Cannot clear runtime directory\n" );return -1 ; } +if (!internal_config.no_telemetry) { +const char *error_str; +if (rte_telemetry_init (rte_eal_get_runtime_dir (), + &error_str) !=0 ) { +rte_eal_init_alert (error_str); +return -1 ; + } + }eal_mcfg_complete ();
lib/librte_eal/freebsd/meson.build +1 -1
@@ -18,4 +18,4 @@ sources += files( 'eal_timer.c', ) -deps += ['kvargs'] +deps += ['kvargs', 'telemetry']
lib/librte_eal/linux/Makefile +1 -0
@@ -20,6 +20,7 @@ LDLIBS += -lpthread LDLIBS += -lgcc_s LDLIBS += -lrt LDLIBS += -lrte_kvargs +LDLIBS += -lrte_telemetry ifeq ($(CONFIG_RTE_EAL_NUMA_AWARE_HUGEPAGES),y) LDLIBS += -lnuma endif
lib/librte_eal/linux/eal.c +9 -0
@@ -51,6 +51,7 @@#include <malloc_heap.h> #include <rte_vfio.h> #include <rte_option.h> +#include <rte_telemetry.h> #include "eal_private.h" #include "eal_thread.h"
@@ -1291,6 +1292,14 @@ rte_eal_init(int argc, char **argv)rte_eal_init_alert ("Cannot clear runtime directory\n" );return -1 ; } +if (!internal_config.no_telemetry) { +const char *error_str; +if (rte_telemetry_init (rte_eal_get_runtime_dir (), + &error_str) !=0 ) { +rte_eal_init_alert (error_str); +return -1 ; + } + }eal_mcfg_complete ();
lib/librte_eal/linux/meson.build +1 -1
@@ -21,7 +21,7 @@ sources += files( 'eal_vfio_mp_sync.c', ) -deps += ['kvargs'] +deps += ['kvargs', 'telemetry'] if has_libnuma == 1 dpdk_conf.set10('RTE_EAL_NUMA_AWARE_HUGEPAGES', true) endif
lib/librte_eal/meson.build +4 -1
@@ -12,7 +12,10 @@ subdir(exec_env) subdir(arch_subdir) allow_experimental_apis = true -deps += 'kvargs' +deps += ['kvargs'] +if not is_windows + deps += ['telemetry'] +endif if dpdk_conf.has('RTE_USE_LIBBSD') ext_deps += libbsd endif
lib/librte_ethdev/Makefile +1 -5
@@ -12,7 +12,7 @@ CFLAGS += -DALLOW_EXPERIMENTAL_API CFLAGS += -O3 CFLAGS += $(WERROR_FLAGS) LDLIBS += -lrte_net -lrte_eal -lrte_mempool -lrte_ring -LDLIBS += -lrte_mbuf -lrte_kvargs -lrte_meter +LDLIBS += -lrte_mbuf -lrte_kvargs -lrte_meter -lrte_telemetry EXPORT_MAP := rte_ethdev_version.map
@@ -24,10 +24,6 @@ SRCS-y += rte_tm.c SRCS-y += rte_mtr.c SRCS-y += ethdev_profile.c -ifeq ($(CONFIG_RTE_LIBRTE_TELEMETRY),y) -LDLIBS += -lrte_telemetry -endif - # # Export include files #
lib/librte_ethdev/meson.build +1 -5
@@ -25,8 +25,4 @@ headers = files('rte_ethdev.h', 'rte_tm.h', 'rte_tm_driver.h') -deps += ['net', 'kvargs', 'meter'] - -if dpdk_conf.has('RTE_LIBRTE_TELEMETRY') - deps += ['telemetry'] -endif +deps += ['net', 'kvargs', 'meter', 'telemetry']
lib/librte_ethdev/rte_ethdev.c +0 -6
@@ -38,9 +38,7 @@#include <rte_kvargs.h> #include <rte_class.h> #include <rte_ether.h> -#ifdef RTE_LIBRTE_TELEMETRY #include <rte_telemetry.h> -#endif #include "rte_ethdev.h" #include "rte_ethdev_driver.h"
@@ -5192,7 +5190,6 @@ rte_eth_devargs_parse(const char *dargs, struct rte_eth_devargs *eth_da)return result; } -#ifdef RTE_LIBRTE_TELEMETRY static int handle_port_list(const char *cmd __rte_unused, const char *params __rte_unused,
@@ -5287,17 +5284,14 @@ handle_port_link_status(const char *cmd __rte_unused,return ret >= buf_len ?-1 : ret; } -#endif RTE_INIT (ethdev_init_log) { rte_eth_dev_logtype =rte_log_register ("lib.ethdev" );if (rte_eth_dev_logtype >=0 )rte_log_set_level (rte_eth_dev_logtype,RTE_LOG_INFO ); -#ifdef RTE_LIBRTE_TELEMETRY rte_telemetry_register_cmd ("/ethdev/list" , handle_port_list);rte_telemetry_register_cmd ("/ethdev/xstats" , handle_port_xstats);rte_telemetry_register_cmd ("/ethdev/link_status" , handle_port_link_status); -#endif }
lib/librte_rawdev/Makefile +1 -5
@@ -9,12 +9,8 @@ LIB = librte_rawdev.a # build flags CFLAGS += -O3 CFLAGS += $(WERROR_FLAGS) -LDLIBS += -lrte_eal - -ifeq ($(CONFIG_RTE_LIBRTE_TELEMETRY),y) CFLAGS += -DALLOW_EXPERIMENTAL_API -LDLIBS += -lrte_telemetry -endif +LDLIBS += -lrte_eal -lrte_telemetry # library source files SRCS-y += rte_rawdev.c
lib/librte_rawdev/meson.build +2 -4
@@ -4,7 +4,5 @@ sources = files('rte_rawdev.c') headers = files('rte_rawdev.h', 'rte_rawdev_pmd.h') -if dpdk_conf.has('RTE_LIBRTE_TELEMETRY') - allow_experimental_apis = true - deps += ['telemetry'] -endif +allow_experimental_apis = true +deps += ['telemetry']
lib/librte_rawdev/rte_rawdev.c +0 -6
@@ -29,9 +29,7 @@#include <rte_common.h> #include <rte_malloc.h> #include <rte_errno.h> -#ifdef RTE_LIBRTE_TELEMETRY #include <rte_telemetry.h> -#endif #include "rte_rawdev.h" #include "rte_rawdev_pmd.h"
@@ -547,7 +545,6 @@ rte_rawdev_pmd_release(struct rte_rawdev *rawdev)return 0 ; } -#ifdef RTE_LIBRTE_TELEMETRY static int handle_dev_list(const char *cmd __rte_unused, const char *params __rte_unused,
@@ -619,15 +616,12 @@ handle_dev_xstats(const char *cmd __rte_unused,free (rawdev_xstats);return used; } -#endif RTE_INIT (librawdev_init_log) { librawdev_logtype =rte_log_register ("lib.rawdev" );if (librawdev_logtype >=0 )rte_log_set_level (librawdev_logtype,RTE_LOG_INFO ); -#ifdef RTE_LIBRTE_TELEMETRY rte_telemetry_register_cmd ("/rawdev/list" , handle_dev_list);rte_telemetry_register_cmd ("/rawdev/xstats" , handle_dev_xstats); -#endif }
lib/librte_telemetry/Makefile +4 -5
@@ -14,17 +14,16 @@ CFLAGS += -I$(RTE_SDK)/lib/librte_eal/include CFLAGS += -I$(RTE_SDK)/lib/librte_eal/$(ARCH_DIR)/include CFLAGS += -pthread -LDLIBS += -lrte_eal LDLIBS += -lpthread EXPORT_MAP := rte_telemetry_version.map # library source files -SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += telemetry.c -SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += telemetry_legacy.c +SRCS-y += telemetry.c +SRCS-y += telemetry_legacy.c # export include files -SYMLINK-$(CONFIG_RTE_LIBRTE_TELEMETRY)-include := rte_telemetry.h -SYMLINK-$(CONFIG_RTE_LIBRTE_TELEMETRY)-include += rte_telemetry_json.h +SYMLINK-y-include := rte_telemetry.h +SYMLINK-y-include += rte_telemetry_json.h include $(RTE_SDK)/mk/rte.lib.mk
lib/librte_telemetry/meson.build +0 -1
@@ -7,4 +7,3 @@ sources = files('telemetry.c', 'telemetry_legacy.c') headers = files('rte_telemetry.h', 'rte_telemetry_json.h') cflags += '-DALLOW_EXPERIMENTAL_API' includes += include_directories('../librte_metrics') -dpdk_app_link_libraries += ['telemetry']
lib/librte_telemetry/rte_telemetry.h +1 -1
@@ -85,6 +85,6 @@ int rte_telemetry_register_cmd(const char *cmd, telemetry_cb fn);* -1 on failure. */ __rte_experimental -int rte_telemetry_init(void); +int rte_telemetry_init(const char *runtime_dir, const char **err_str);#endif
lib/librte_telemetry/telemetry.c +5 -19
@@ -14,7 +14,6 @@#include <rte_common.h> #include <rte_spinlock.h> #include <rte_version.h> -#include <rte_option.h> #include "rte_telemetry.h" #include "rte_telemetry_legacy.h"
@@ -300,26 +299,13 @@ telemetry_v2_init(const char *runtime_dir, const char **err_str) }int32_t -rte_telemetry_init (void ) +rte_telemetry_init (const char *runtime_dir,const char **err_str) { -const char *error_str; -if (telemetry_v2_init (rte_eal_get_runtime_dir (), &error_str) !=0 ) { -printf ("Error initialising telemetry - %s" , error_str); +if (telemetry_v2_init (runtime_dir, err_str) !=0 ) { +printf ("Error initialising telemetry - %s" , *err_str);return -1 ; } -if (telemetry_legacy_init (rte_eal_get_runtime_dir (), &error_str) - !=0 ) -printf ("No telemetry legacy support- %s" , error_str); +if (telemetry_legacy_init (runtime_dir, err_str) !=0 ) +printf ("No telemetry legacy support- %s" , *err_str);return 0 ; } - -static struct rte_option option = { - .name ="telemetry" , - .usage ="Enable telemetry backend" , - .cb = &rte_telemetry_init, - .enabled =0 -}; - -RTE_INIT (telemetry_register_op) { -rte_option_register (&option); -}
lib/meson.build +1 -1
@@ -10,8 +10,8 @@ # core libs which are widely reused, so their deps are kept to a minimum. libraries = [ 'kvargs', # eal depends on kvargs + 'telemetry', # basic info querying capability about dpdk processes 'eal', # everything depends on eal - 'telemetry', 'ring', 'mempool', 'mbuf', 'net', 'meter', 'ethdev', 'pci', # core 'cmdline', 'metrics', # bitrate/latency stats depends on this
mk/rte.app.mk +4 -1
@@ -52,6 +52,9 @@ _LDLIBS-$(CONFIG_RTE_LIBRTE_ACL) += -lrte_acl _LDLIBS-$(CONFIG_RTE_LIBRTE_JOBSTATS) += -lrte_jobstats _LDLIBS-$(CONFIG_RTE_LIBRTE_METRICS) += --whole-archive _LDLIBS-$(CONFIG_RTE_LIBRTE_METRICS) += -lrte_metrics +ifeq ($(CONFIG_RTE_LIBRTE_TELEMETRY),y) +_LDLIBS-$(CONFIG_RTE_LIBRTE_METRICS) += -ljansson +endif _LDLIBS-$(CONFIG_RTE_LIBRTE_METRICS) += --no-whole-archive _LDLIBS-$(CONFIG_RTE_LIBRTE_BITRATE) += -lrte_bitratestats _LDLIBS-$(CONFIG_RTE_LIBRTE_LATENCY_STATS) += -lrte_latencystats
@@ -74,6 +77,7 @@ _LDLIBS-$(CONFIG_RTE_LIBRTE_HASH) += -lrte_hash _LDLIBS-$(CONFIG_RTE_LIBRTE_MEMBER) += -lrte_member _LDLIBS-$(CONFIG_RTE_LIBRTE_VHOST) += -lrte_vhost _LDLIBS-$(CONFIG_RTE_LIBRTE_KVARGS) += -lrte_kvargs +_LDLIBS-y += -lrte_telemetry _LDLIBS-$(CONFIG_RTE_LIBRTE_MBUF) += -lrte_mbuf _LDLIBS-$(CONFIG_RTE_LIBRTE_NET) += -lrte_net _LDLIBS-$(CONFIG_RTE_LIBRTE_ETHER) += -lrte_ethdev
@@ -90,7 +94,6 @@ _LDLIBS-$(CONFIG_RTE_DRIVER_MEMPOOL_RING) += -lrte_mempool_ring _LDLIBS-$(CONFIG_RTE_LIBRTE_OCTEONTX2_MEMPOOL) += -lrte_mempool_octeontx2 _LDLIBS-$(CONFIG_RTE_LIBRTE_RING) += -lrte_ring _LDLIBS-$(CONFIG_RTE_LIBRTE_PCI) += -lrte_pci -_LDLIBS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += -lrte_telemetry -ljansson _LDLIBS-$(CONFIG_RTE_LIBRTE_EAL) += -lrte_eal _LDLIBS-$(CONFIG_RTE_LIBRTE_CMDLINE) += -lrte_cmdline _LDLIBS-$(CONFIG_RTE_LIBRTE_REORDER) += -lrte_reorder
Signature · 1 line
2.17.1
PATCH v2 15/16 eal: add eal telemetry callbacks
In reply to Ciara PowerFrom: Bruce Richardson <[email protected]>
EAL now registers commands to provide some basic info from EAL.
Example:
Connecting to /var/run/dpdk/rte/dpdk_telemetry.v2
{"pid": 926, "version": "DPDK 20.05.0-rc0", "max_output_len": 16384} --> /
{"/": ["/", "/eal/app_params", "/eal/params", "/ethdev/link_status", \
"/ethdev/list", "/ethdev/xstats", "/info", "/rawdev/list", \
"/rawdev/xstats"]}--> /eal/app_params
{"/eal/app_params": ["-i"]}
--> /eal/params
{"/eal/params": ["./app/dpdk-testpmd"]}
---
v2:
- Removed /eal/version command as /info replaces it.
- Compile telemetry callbacks and include headers if not in Windows execution environment.
--- lib/librte_eal/common/eal_common_options.c | 70 ++++++++++++++++++++++ lib/librte_eal/common/eal_options.h | 3 + lib/librte_eal/freebsd/eal.c | 3 + lib/librte_eal/linux/eal.c | 3 + 4 files changed, 79 insertions(+)
lib/librte_eal/common/eal_common_options.c +70 -0
@@ -29,6 +29,9 @@#include <rte_version.h> #include <rte_devargs.h> #include <rte_memcpy.h> +#ifndef RTE_EXEC_ENV_WINDOWS +#include <rte_telemetry.h> +#endif #include "eal_internal_cfg.h" #include "eal_options.h"
@@ -132,6 +135,73 @@ static int master_lcore_parsed;static int mem_parsed;static int core_parsed; +#ifndef RTE_EXEC_ENV_WINDOWS +static char **eal_args; +static char **eal_app_args; + +#define EAL_PARAM_REQ "/eal/params" +#define EAL_APP_PARAM_REQ "/eal/app_params" + +/* callback handler for telemetry library to report out EAL flags */ +int +handle_eal_info_request(const char *cmd, const char *params __rte_unused, +char *buffer,int buf_len) +{ +char **args; +int used =0 ; +int i =0 ; + +if (strcmp (cmd,EAL_PARAM_REQ ) ==0 ) + args = eal_args; +else + args = eal_app_args; + +if (args ==NULL || args[0 ] ==NULL ) +return rte_tel_json_empty_array (buffer, buf_len, used); + +for ( ; args[i] !=NULL ; i++) + used =rte_tel_json_add_array_string (buffer, buf_len, used, + args[i]); +return used; +} + +int +eal_save_args (int argc,char **argv) +{ +int i, j; + +/* clone argv to report out later. We overprovision, but +* this does not waste huge amounts of memory +*/ + eal_args =calloc (argc +1 ,sizeof (*eal_args)); +if (eal_args ==NULL ) +return -1 ; + +for (i =0 ; i < argc; i++) { + eal_args[i] =strdup (argv[i]); +if (strcmp (argv[i],"--" ) ==0 ) +break ; + } + eal_args[i++] =NULL ;/* always finish with NULL */ +rte_telemetry_register_cmd (EAL_PARAM_REQ , handle_eal_info_request); + +/* allow reporting of any app args we know about too */ +if (i == argc) +return 0 ; + + eal_app_args =calloc (argc - i +1 ,sizeof (*eal_args)); +if (eal_app_args ==NULL ) +return -1 ; + +for (j =0 ; i < argc; j++, i++) + eal_app_args[j] =strdup (argv[i]); + eal_app_args[j] =NULL ; +rte_telemetry_register_cmd (EAL_APP_PARAM_REQ , handle_eal_info_request); + +return 0 ; +} +#endif +static int eal_option_device_add (enum rte_devtype type,const char *optarg) {
lib/librte_eal/common/eal_options.h +3 -0
@@ -88,5 +88,8 @@ int eal_check_common_options(struct internal_config *internal_cfg);void eal_common_usage (void );enum rte_proc_type_t eal_proc_type_detect (void );int eal_plugins_init (void ); +int eal_save_args (int argc,char **argv); +int handle_eal_info_request(const char *cmd, const char *params __rte_unused, +char *buffer,int buf_len);#endif /* EAL_OPTIONS_H */
lib/librte_eal/freebsd/eal.c +3 -0
@@ -725,6 +725,9 @@ rte_eal_init(int argc, char **argv)eal_reset_internal_config (&internal_config); +/* clone argv to report out later in telemetry */ +eal_save_args (argc, argv); +/* set log level as early as possible */ eal_log_level_parse (argc, argv);
lib/librte_eal/linux/eal.c +3 -0
@@ -992,6 +992,9 @@ rte_eal_init(int argc, char **argv)/* set log level as early as possible */ eal_log_level_parse (argc, argv); +/* clone argv to report out later in telemetry */ +eal_save_args (argc, argv); +if (rte_eal_cpu_init () <0 ) {rte_eal_init_alert ("Cannot detect lcores." ); rte_errno =ENOTSUP ;
Signature · 1 line
2.17.1
PATCH v2 16/16 doc: update telemetry documentation
In reply to Ciara PowerThe existing documentation for Telemetry is updated, and further documentation is added.
--- doc/api/doxy-api-index.md | 1 + doc/guides/howto/telemetry.rst | 108 ++++++++++------------ doc/guides/linux_gsg/eal_args.include.rst | 8 ++ doc/guides/linux_gsg/sys_reqs.rst | 2 - doc/guides/prog_guide/index.rst | 1 + doc/guides/prog_guide/telemetry_lib.rst | 62 +++++++++++++ doc/guides/rel_notes/release_20_05.rst | 15 +++ 7 files changed, 138 insertions(+), 59 deletions(-) create mode 100644 doc/guides/prog_guide/telemetry_lib.rst
doc/api/doxy-api-index.md +1 -0
@@ -170,6 +170,7 @@ The public API headers are grouped by topics: - **debug**: [jobstats] (@ref rte_jobstats.h), [telemetry] (@ref rte_telemetry.h), + [telemetry-json] (@ref rte_telemetry_json.h), [pdump] (@ref rte_pdump.h), [hexdump] (@ref rte_hexdump.h), [debug] (@ref rte_debug.h),
doc/guides/howto/telemetry.rst +51 -57
137 lines not on this page · raw message
doc/guides/linux_gsg/eal_args.include.rst +8 -0
@@ -150,3 +150,11 @@ Other options * ``mbuf-pool-ops-name``: Pool ops name for mbuf to use. + +* ``--telemetry``: + + Enable telemetry (enabled by default). + +* ``--no-telemetry``: + + Disable telemetry.
doc/guides/linux_gsg/sys_reqs.rst +0 -2
@@ -95,8 +95,6 @@ For libraries the additional dependencies include: * libarchive: for some unit tests using tar to get their resources. -* jansson: to compile and use the telemetry library. - * libelf: to compile and use the bpf library. For poll-mode drivers, the additional dependencies for each driver can be
doc/guides/prog_guide/index.rst +1 -0
@@ -57,6 +57,7 @@ Programmer's Guide metrics_lib bpf_lib ipsec_lib + telemetry_lib source_org dev_kit_build_system dev_kit_root_make_help
doc/guides/prog_guide/telemetry_lib.rst new file +62 -0
62 lines not on this page · raw message
doc/guides/rel_notes/release_20_05.rst +15 -0
@@ -62,6 +62,21 @@ New Features * Added support for matching on IPv4 Time To Live and IPv6 Hop Limit. +* **Updated Telemetry Library.** + + The updated Telemetry library has many improvements on the original version + to make it more accessible and scalable: + + * It enables DPDK libraries and applications provide their own specific + telemetry information, rather than being limited to what could be reported + through the metrics library. + + * It is no longer dependent on the external Jansson library, which allows + Telemetry be enabled by default. + + * The socket handling has been simplified making it easier for clients to + connect and retrieve information. + Removed Items -------------
Signature · 1 line
2.17.1
08/04/2020 18:49, Ciara Power:
Quoted 16 lines
This patchset extensively reworks the telemetry library adding new functionality and simplifying much of the existing code, while maintaining backward compatibility.
This work is based on the previously sent RFC for a "process info"
library: https://patchwork.dpdk.org/project/dpdk/list/?series=7741
However, rather than creating a new library, this patchset takes that work and merges it into the existing telemetry library, as mentioned above.The telemetry library as shipped in 19.11 is based upon the metrics library and outputs all statistics based on that as a source. However, this limits the telemetry output to only port-level statistics information, rather than allowing it to be used as a general scheme for telemetry information across all DPDK libraries.
Quoted 9 lines
With this patchset applied, rather than the telemetry library being responsible for pulling ethdev stats and pushing them into the metrics library for retrieval later, each library e.g. ethdev, rawdev, and even the metrics library itself (for backwards compatiblity) now handle their own stats. Any library or app can register a callback function with telemetry, which will be called if requested by the client connected via the telemetry socket. The callback function in the library/app then formats its stats, or other data, into a JSON string, and returns it to telemetry to be sent to the client.
I think this is a global need in DPDK, and it is usually called RPC, IPC or control messaging.
We had a similar need for multi-process communication, thus rte_mp IPC. We also need a control channel for user configuration applications. We also need to control some features like logging or tracing.
In my opinion, it is time to introduce a general control channel in DPDK. The application must be in the loop of the control mechanism. Making such channel standard will ease application adoption.
Please read some comments here:
http://inbox.dpdk.org/dev/2580933.jp2sp48Hzj@xps/
Quoted 33 lines · Thomas Monjalon
08/04/2020 18:49, Ciara Power:
Quoted 16 lines
This patchset extensively reworks the telemetry library adding new functionality and simplifying much of the existing code, while maintaining backward compatibility.
This work is based on the previously sent RFC for a "process info"
library: https://patchwork.dpdk.org/project/dpdk/list/?series=7741
However, rather than creating a new library, this patchset takes that work and merges it into the existing telemetry library, as mentioned above.The telemetry library as shipped in 19.11 is based upon the metrics library and outputs all statistics based on that as a source. However, this limits the telemetry output to only port-level statistics information, rather than allowing it to be used as a general scheme for telemetry information across all DPDK libraries.
Quoted 9 lines
With this patchset applied, rather than the telemetry library being responsible for pulling ethdev stats and pushing them into the metrics library for retrieval later, each library e.g. ethdev, rawdev, and even the metrics library itself (for backwards compatiblity) now handle their own stats. Any library or app can register a callback function with telemetry, which will be called if requested by the client connected via the telemetry socket. The callback function in the library/app then formats its stats, or other data, into a JSON string, and returns it to telemetry to be sent to the client.
I think this is a global need in DPDK, and it is usually called RPC, IPC or control messaging.
We had a similar need for multi-process communication, thusrte_mpIPC. We also need a control channel for user configuration applications. We also need to control some features like logging or tracing.
Quoted 7 lines
In my opinion, it is time to introduce a general control channel in DPDK. The application must be in the loop of the control mechanism. Making such channel standard will ease application adoption.
Please read some comments here:
http://inbox.dpdk.org/dev/2580933.jp2sp48Hzj@xps/
Hi Thomas,
I agree that having a single control mechanism or messaging mechanism in DPDK would be nice to have. However, I don't believe the plans for such a scheme should impact this patchset right now as the idea of a common channel was only first mooted about a week ago, and while there has been some email discussion about it, there is as yet no requirements list that I've seen, nobody actually doing coding work on it, no rfc and most importantly no timeline for creating and merging such into DPDK.
At present though, DPDK has a telemetry solution that works for the use case of ethdev stats and some power management info, but requires a more general solution to allow monitoring tools like PMDT to introspect DPDK, and also to prove statistics for other parts of DPDK such as cryptodev, eventdev, and other libraries, plus the application itself if the app so desires.
Regards,
/Bruce
09/04/2020 11:19, Bruce Richardson:
Quoted 43 lines · Thomas Monjalon
Quoted 33 lines
08/04/2020 18:49, Ciara Power:
Quoted 16 lines
This patchset extensively reworks the telemetry library adding new functionality and simplifying much of the existing code, while maintaining backward compatibility.
This work is based on the previously sent RFC for a "process info"
library: https://patchwork.dpdk.org/project/dpdk/list/?series=7741
However, rather than creating a new library, this patchset takes that work and merges it into the existing telemetry library, as mentioned above.The telemetry library as shipped in 19.11 is based upon the metrics library and outputs all statistics based on that as a source. However, this limits the telemetry output to only port-level statistics information, rather than allowing it to be used as a general scheme for telemetry information across all DPDK libraries.
Quoted 9 lines
With this patchset applied, rather than the telemetry library being responsible for pulling ethdev stats and pushing them into the metrics library for retrieval later, each library e.g. ethdev, rawdev, and even the metrics library itself (for backwards compatiblity) now handle their own stats. Any library or app can register a callback function with telemetry, which will be called if requested by the client connected via the telemetry socket. The callback function in the library/app then formats its stats, or other data, into a JSON string, and returns it to telemetry to be sent to the client.
I think this is a global need in DPDK, and it is usually called RPC, IPC or control messaging.
We had a similar need for multi-process communication, thusrte_mpIPC. We also need a control channel for user configuration applications. We also need to control some features like logging or tracing.Quoted 7 lines
In my opinion, it is time to introduce a general control channel in DPDK. The application must be in the loop of the control mechanism. Making such channel standard will ease application adoption.
Please read some comments here:
http://inbox.dpdk.org/dev/2580933.jp2sp48Hzj@xps/Hi Thomas,
Quoted 7 lines
I agree that having a single control mechanism or messaging mechanism in DPDK would be nice to have. However, I don't believe the plans for such a scheme should impact this patchset right now as the idea of a common channel was only first mooted about a week ago, and while there has been some email discussion about it, there is as yet no requirements list that I've seen, nobody actually doing coding work on it, no rfc and most importantly no timeline for creating and merging such into DPDK.
Yes, this is a new idea.
Throwing the idea in this "telemetry" thread and in "IF proxy" thread is the first step before starting a dedicated thread to design a generic mechanism.
Quoted 5 lines
At present though, DPDK has a telemetry solution that works for the use case of ethdev stats and some power management info, but requires a more general solution to allow monitoring tools like PMDT to introspect DPDK, and also to prove statistics for other parts of DPDK such as cryptodev, eventdev, and other libraries, plus the application itself if the app so desires.
Doing rework on telemetry is similar to a general control mechanism. Can we take this opportunity to work on what we believe to be a bigger idea? It should be done anyway, so why pushing this temporary solution? Sometimes we need a quick answer to an urgent problem.
But I don't think telemetry is currently in such situation that a rework in 20.05 is mandatory.
Quoted 67 lines · Thomas Monjalon
09/04/2020 11:19, Bruce Richardson:
Quoted 43 lines · Thomas Monjalon
Quoted 33 lines
08/04/2020 18:49, Ciara Power:
Quoted 16 lines
This patchset extensively reworks the telemetry library adding new functionality and simplifying much of the existing code, while maintaining backward compatibility.
This work is based on the previously sent RFC for a "process info"
library: https://patchwork.dpdk.org/project/dpdk/list/?series=7741
However, rather than creating a new library, this patchset takes that work and merges it into the existing telemetry library, as mentioned above.The telemetry library as shipped in 19.11 is based upon the metrics library and outputs all statistics based on that as a source. However, this limits the telemetry output to only port-level statistics information, rather than allowing it to be used as a general scheme for telemetry information across all DPDK libraries.
Quoted 9 lines
With this patchset applied, rather than the telemetry library being responsible for pulling ethdev stats and pushing them into the metrics library for retrieval later, each library e.g. ethdev, rawdev, and even the metrics library itself (for backwards compatiblity) now handle their own stats. Any library or app can register a callback function with telemetry, which will be called if requested by the client connected via the telemetry socket. The callback function in the library/app then formats its stats, or other data, into a JSON string, and returns it to telemetry to be sent to the client.
I think this is a global need in DPDK, and it is usually called RPC, IPC or control messaging.
We had a similar need for multi-process communication, thusrte_mpIPC. We also need a control channel for user configuration applications. We also need to control some features like logging or tracing.Quoted 7 lines
In my opinion, it is time to introduce a general control channel in DPDK. The application must be in the loop of the control mechanism. Making such channel standard will ease application adoption.
Please read some comments here:
http://inbox.dpdk.org/dev/2580933.jp2sp48Hzj@xps/Hi Thomas,
Quoted 7 lines
I agree that having a single control mechanism or messaging mechanism in DPDK would be nice to have. However, I don't believe the plans for such a scheme should impact this patchset right now as the idea of a common channel was only first mooted about a week ago, and while there has been some email discussion about it, there is as yet no requirements list that I've seen, nobody actually doing coding work on it, no rfc and most importantly no timeline for creating and merging such into DPDK.
Yes, this is a new idea.
Throwing the idea in this "telemetry" thread and in "IF proxy" thread is the first step before starting a dedicated thread to design a generic mechanism.Quoted 5 lines
At present though, DPDK has a telemetry solution that works for the use case of ethdev stats and some power management info, but requires a more general solution to allow monitoring tools like PMDT to introspect DPDK, and also to prove statistics for other parts of DPDK such as cryptodev, eventdev, and other libraries, plus the application itself if the app so desires.
Quoted 6 lines
Doing rework on telemetry is similar to a general control mechanism. Can we take this opportunity to work on what we believe to be a bigger idea? It should be done anyway, so why pushing this temporary solution? Sometimes we need a quick answer to an urgent problem.
But I don't think telemetry is currently in such situation that a rework in 20.05 is mandatory.
Updating telemetry to be more consumable and standardize on a single method to get stats/info out of DPDK is a clean and simple solution. Starting over and creating yet another solution means we are pushing this support out again and many customer are asking for this support now.
The current telemetry solution in this patch gives us a great starting point and going back to the drawing board is a waste of time IMO and we need something now. To me this is a urgent problem we need to solve now, as I want to push PMDT and if we keep pushing out this type of support then it will never be upstreamed.
In PMDT I believe I have resolved all of the tech boards concerns and just waiting for this patch and a patch to PCM to push the code back to DPDK again.
So please let's not redesign this again.
Quoted 2 lines
10/04/2020 16:39, Wiles, Keith:
Quoted 71 lines
Quoted 64 lines · Thomas Monjalon
09/04/2020 11:19, Bruce Richardson:
Quoted 43 lines · Thomas Monjalon
Quoted 33 lines
08/04/2020 18:49, Ciara Power:
Quoted 16 lines
This patchset extensively reworks the telemetry library adding new functionality and simplifying much of the existing code, while maintaining backward compatibility.
This work is based on the previously sent RFC for a "process info"
library: https://patchwork.dpdk.org/project/dpdk/list/?series=7741
However, rather than creating a new library, this patchset takes that work and merges it into the existing telemetry library, as mentioned above.The telemetry library as shipped in 19.11 is based upon the metrics library and outputs all statistics based on that as a source. However, this limits the telemetry output to only port-level statistics information, rather than allowing it to be used as a general scheme for telemetry information across all DPDK libraries.
Quoted 9 lines
With this patchset applied, rather than the telemetry library being responsible for pulling ethdev stats and pushing them into the metrics library for retrieval later, each library e.g. ethdev, rawdev, and even the metrics library itself (for backwards compatiblity) now handle their own stats. Any library or app can register a callback function with telemetry, which will be called if requested by the client connected via the telemetry socket. The callback function in the library/app then formats its stats, or other data, into a JSON string, and returns it to telemetry to be sent to the client.
I think this is a global need in DPDK, and it is usually called RPC, IPC or control messaging.
We had a similar need for multi-process communication, thusrte_mpIPC. We also need a control channel for user configuration applications. We also need to control some features like logging or tracing.Quoted 7 lines
In my opinion, it is time to introduce a general control channel in DPDK. The application must be in the loop of the control mechanism. Making such channel standard will ease application adoption.
Please read some comments here:
http://inbox.dpdk.org/dev/2580933.jp2sp48Hzj@xps/Hi Thomas,
Quoted 7 lines
I agree that having a single control mechanism or messaging mechanism in DPDK would be nice to have. However, I don't believe the plans for such a scheme should impact this patchset right now as the idea of a common channel was only first mooted about a week ago, and while there has been some email discussion about it, there is as yet no requirements list that I've seen, nobody actually doing coding work on it, no rfc and most importantly no timeline for creating and merging such into DPDK.
Yes, this is a new idea.
Throwing the idea in this "telemetry" thread and in "IF proxy" thread is the first step before starting a dedicated thread to design a generic mechanism.Quoted 5 lines
At present though, DPDK has a telemetry solution that works for the use case of ethdev stats and some power management info, but requires a more general solution to allow monitoring tools like PMDT to introspect DPDK, and also to prove statistics for other parts of DPDK such as cryptodev, eventdev, and other libraries, plus the application itself if the app so desires.
Quoted 6 lines
Doing rework on telemetry is similar to a general control mechanism. Can we take this opportunity to work on what we believe to be a bigger idea? It should be done anyway, so why pushing this temporary solution? Sometimes we need a quick answer to an urgent problem.
But I don't think telemetry is currently in such situation that a rework in 20.05 is mandatory.
Quoted 7 lines
Updating telemetry to be more consumable and standardize on a single method to get stats/info out of DPDK is a clean and simple solution. Starting over and creating yet another solution means we are pushing this support out again and many customer are asking for this support now.
The current telemetry solution in this patch gives us a great starting point and going back to the drawing board is a waste of time IMO and we need something now. To me this is a urgent problem we need to solve now, as I want to push PMDT and if we keep pushing out this type of support then it will never be upstreamed.
In PMDT I believe I have resolved all of the tech boards concerns and just waiting for this patch and a patch to PCM to push the code back to DPDK again.
So please let's not redesign this again.
I understand your concern.
I think we need to go to the drawing board,
and consider at least these 5 use cases:
1/ multi-process IPC
2/ telemetry
3/ IF proxy
4/ external user configuration
5/ log/trace start/stop
Merging telemetry means we'll rework 1 and 2 later. I am OK with merging telemetry in 20.05 if we can be sure that there will be no resistance and help for reworking it with a more general communication channel if required later.
We need a kind of community vote here. Please give +1 / -1. Giving +1 means you will help when needed.
Quoted 94 lines · Thomas Monjalon
10/04/2020 16:39, Wiles, Keith:
Quoted 71 lines
Quoted 64 lines · Thomas Monjalon
09/04/2020 11:19, Bruce Richardson:
Quoted 43 lines · Thomas Monjalon
Quoted 33 lines
08/04/2020 18:49, Ciara Power:
Quoted 16 lines
This patchset extensively reworks the telemetry library adding new functionality and simplifying much of the existing code, while maintaining backward compatibility.
This work is based on the previously sent RFC for a "process info"
library: https://patchwork.dpdk.org/project/dpdk/list/?series=7741
However, rather than creating a new library, this patchset takes that work and merges it into the existing telemetry library, as mentioned above.The telemetry library as shipped in 19.11 is based upon the metrics library and outputs all statistics based on that as a source. However, this limits the telemetry output to only port-level statistics information, rather than allowing it to be used as a general scheme for telemetry information across all DPDK libraries.
Quoted 9 lines
With this patchset applied, rather than the telemetry library being responsible for pulling ethdev stats and pushing them into the metrics library for retrieval later, each library e.g. ethdev, rawdev, and even the metrics library itself (for backwards compatiblity) now handle their own stats. Any library or app can register a callback function with telemetry, which will be called if requested by the client connected via the telemetry socket. The callback function in the library/app then formats its stats, or other data, into a JSON string, and returns it to telemetry to be sent to the client.
I think this is a global need in DPDK, and it is usually called RPC, IPC or control messaging.
We had a similar need for multi-process communication, thusrte_mpIPC. We also need a control channel for user configuration applications. We also need to control some features like logging or tracing.Quoted 7 lines
In my opinion, it is time to introduce a general control channel in DPDK. The application must be in the loop of the control mechanism. Making such channel standard will ease application adoption.
Please read some comments here:
http://inbox.dpdk.org/dev/2580933.jp2sp48Hzj@xps/Hi Thomas,
Quoted 7 lines
I agree that having a single control mechanism or messaging mechanism in DPDK would be nice to have. However, I don't believe the plans for such a scheme should impact this patchset right now as the idea of a common channel was only first mooted about a week ago, and while there has been some email discussion about it, there is as yet no requirements list that I've seen, nobody actually doing coding work on it, no rfc and most importantly no timeline for creating and merging such into DPDK.
Yes, this is a new idea.
Throwing the idea in this "telemetry" thread and in "IF proxy" thread is the first step before starting a dedicated thread to design a generic mechanism.Quoted 5 lines
At present though, DPDK has a telemetry solution that works for the use case of ethdev stats and some power management info, but requires a more general solution to allow monitoring tools like PMDT to introspect DPDK, and also to prove statistics for other parts of DPDK such as cryptodev, eventdev, and other libraries, plus the application itself if the app so desires.
Quoted 6 lines
Doing rework on telemetry is similar to a general control mechanism. Can we take this opportunity to work on what we believe to be a bigger idea? It should be done anyway, so why pushing this temporary solution? Sometimes we need a quick answer to an urgent problem.
But I don't think telemetry is currently in such situation that a rework in 20.05 is mandatory.Quoted 7 lines
Updating telemetry to be more consumable and standardize on a single method to get stats/info out of DPDK is a clean and simple solution. Starting over and creating yet another solution means we are pushing this support out again and many customer are asking for this support now.
The current telemetry solution in this patch gives us a great starting point and going back to the drawing board is a waste of time IMO and we need something now. To me this is a urgent problem we need to solve now, as I want to push PMDT and if we keep pushing out this type of support then it will never be upstreamed.
In PMDT I believe I have resolved all of the tech boards concerns and just waiting for this patch and a patch to PCM to push the code back to DPDK again.
So please let's not redesign this again.
I understand your concern.
I think we need to go to the drawing board,
and consider at least these 5 use cases:
1/ multi-process IPC
2/ telemetry
3/ IF proxy
4/ external user configuration
5/ log/trace start/stop
Quoted 8 lines
Merging telemetry means we'll rework 1 and 2 later. I am OK with merging telemetry in 20.05 if we can be sure that there will be no resistance and help for reworking it with a more general communication channel if required later.
We need a kind of community vote here. Please give +1 / -1. Giving +1 means you will help when needed.
I agree merging the telemetry patch for 20.05 is reasonable and addressing the above concerns later is a good compromise.
+1 for helping on the above concerns later after the 20.05 release and merge of telemetry patch.
Quoted 1 line
Quoted 52 lines · Thomas Monjalon
09/04/2020 11:19, Bruce Richardson:
Quoted 43 lines · Thomas Monjalon
Quoted 33 lines
08/04/2020 18:49, Ciara Power:
Quoted 16 lines
This patchset extensively reworks the telemetry library adding new functionality and simplifying much of the existing code, while maintaining backward compatibility.
This work is based on the previously sent RFC for a "process info"
library: https://patchwork.dpdk.org/project/dpdk/list/?series=7741
However, rather than creating a new library, this patchset takes that work and merges it into the existing telemetry library, as mentioned above.The telemetry library as shipped in 19.11 is based upon the metrics library and outputs all statistics based on that as a source. However, this limits the telemetry output to only port-level statistics information, rather than allowing it to be used as a general scheme for telemetry information across all DPDK libraries.
Quoted 9 lines
With this patchset applied, rather than the telemetry library being responsible for pulling ethdev stats and pushing them into the metrics library for retrieval later, each library e.g. ethdev, rawdev, and even the metrics library itself (for backwards compatiblity) now handle their own stats. Any library or app can register a callback function with telemetry, which will be called if requested by the client connected via the telemetry socket. The callback function in the library/app then formats its stats, or other data, into a JSON string, and returns it to telemetry to be sent to the client.
I think this is a global need in DPDK, and it is usually called RPC, IPC or control messaging.
We had a similar need for multi-process communication, thusrte_mpIPC. We also need a control channel for user configuration applications. We also need to control some features like logging or tracing.Quoted 7 lines
In my opinion, it is time to introduce a general control channel in DPDK. The application must be in the loop of the control mechanism. Making such channel standard will ease application adoption.
Please read some comments here:
http://inbox.dpdk.org/dev/2580933.jp2sp48Hzj@xps/Hi Thomas,
Quoted 7 lines
I agree that having a single control mechanism or messaging mechanism in DPDK would be nice to have. However, I don't believe the plans for such a scheme should impact this patchset right now as the idea of a common channel was only first mooted about a week ago, and while there has been some email discussion about it, there is as yet no requirements list that I've seen, nobody actually doing coding work on it, no rfc and most importantly no timeline for creating and merging such into DPDK.
Quoted 4 lines
Yes, this is a new idea.
Throwing the idea in this "telemetry" thread and in "IF proxy" thread is the first step before starting a dedicated thread to design a generic mechanism.
May I offer the services of https://zeromq.org/ ?
Signature · 2 lines
Kind regards, Luca Boccassi
23/04/2020 12:30, Luca Boccassi:
Quoted 53 lines · Thomas Monjalon
Quoted 52 lines
09/04/2020 11:19, Bruce Richardson:
Quoted 50 lines · Thomas Monjalon
Quoted 33 lines
08/04/2020 18:49, Ciara Power:
Quoted 16 lines
This patchset extensively reworks the telemetry library adding new functionality and simplifying much of the existing code, while maintaining backward compatibility.
This work is based on the previously sent RFC for a "process info"
library: https://patchwork.dpdk.org/project/dpdk/list/?series=7741
However, rather than creating a new library, this patchset takes that work and merges it into the existing telemetry library, as mentioned above.The telemetry library as shipped in 19.11 is based upon the metrics library and outputs all statistics based on that as a source. However, this limits the telemetry output to only port-level statistics information, rather than allowing it to be used as a general scheme for telemetry information across all DPDK libraries.
Quoted 9 lines
With this patchset applied, rather than the telemetry library being responsible for pulling ethdev stats and pushing them into the metrics library for retrieval later, each library e.g. ethdev, rawdev, and even the metrics library itself (for backwards compatiblity) now handle their own stats. Any library or app can register a callback function with telemetry, which will be called if requested by the client connected via the telemetry socket. The callback function in the library/app then formats its stats, or other data, into a JSON string, and returns it to telemetry to be sent to the client.
I think this is a global need in DPDK, and it is usually called RPC, IPC or control messaging.
We had a similar need for multi-process communication, thusrte_mpIPC. We also need a control channel for user configuration applications. We also need to control some features like logging or tracing.Quoted 7 lines
In my opinion, it is time to introduce a general control channel in DPDK. The application must be in the loop of the control mechanism. Making such channel standard will ease application adoption.
Please read some comments here:
http://inbox.dpdk.org/dev/2580933.jp2sp48Hzj@xps/Hi Thomas,
I agree that having a single control mechanism or messaging mechanism in DPDK would be nice to have. However, I don't believe the plans for such a scheme should impact this patchset right now as the idea of a common channel was only first mooted about a week ago, and while there has been some email discussion about it, there is as yet no requirements list that I've seen, nobody actually doing coding work on it, no rfc and most importantly no timeline for creating and merging such into DPDK.
Quoted 6 lines
Quoted 4 lines
Yes, this is a new idea.
Throwing the idea in this "telemetry" thread and in "IF proxy" thread is the first step before starting a dedicated thread to design a generic mechanism.May I offer the services of https://zeromq.org/ ?
This is what I already proposed:
http://inbox.dpdk.org/dev/20334513.huCnfhLgOn@xps/
I'm sorry, I was supposed to start a new thread for this discussion. I will summarize my thoughts and discussions just after -rc1 is done.
Quoted 59 lines · Thomas Monjalon
23/04/2020 12:30, Luca Boccassi:
Quoted 58 lines · Thomas Monjalon
Quoted 56 lines
09/04/2020 11:19, Bruce Richardson:
Quoted 43 lines · Thomas Monjalon
Quoted 33 lines
08/04/2020 18:49, Ciara Power:
Quoted 16 lines
This patchset extensively reworks the telemetry library adding new functionality and simplifying much of the existing code, while maintaining backward compatibility.
This work is based on the previously sent RFC for a "process info"
library: https://patchwork.dpdk.org/project/dpdk/list/?series=7741
However, rather than creating a new library, this patchset takes that work and merges it into the existing telemetry library, as mentioned above.The telemetry library as shipped in 19.11 is based upon the metrics library and outputs all statistics based on that as a source. However, this limits the telemetry output to only port-level statistics information, rather than allowing it to be used as a general scheme for telemetry information across all DPDK libraries.
Quoted 9 lines
With this patchset applied, rather than the telemetry library being responsible for pulling ethdev stats and pushing them into the metrics library for retrieval later, each library e.g. ethdev, rawdev, and even the metrics library itself (for backwards compatiblity) now handle their own stats. Any library or app can register a callback function with telemetry, which will be called if requested by the client connected via the telemetry socket. The callback function in the library/app then formats its stats, or other data, into a JSON string, and returns it to telemetry to be sent to the client.
I think this is a global need in DPDK, and it is usually called RPC, IPC or control messaging.
We had a similar need for multi-process communication, thusrte_mpIPC. We also need a control channel for user configuration applications. We also need to control some features like logging or tracing.Quoted 7 lines
In my opinion, it is time to introduce a general control channel in DPDK. The application must be in the loop of the control mechanism. Making such channel standard will ease application adoption.
Please read some comments here:
http://inbox.dpdk.org/dev/2580933.jp2sp48Hzj@xps/Hi Thomas,
Quoted 7 lines
I agree that having a single control mechanism or messaging mechanism in DPDK would be nice to have. However, I don't believe the plans for such a scheme should impact this patchset right now as the idea of a common channel was only first mooted about a week ago, and while there has been some email discussion about it, there is as yet no requirements list that I've seen, nobody actually doing coding work on it, no rfc and most importantly no timeline for creating and merging such into DPDK.
Yes, this is a new idea.
Throwing the idea in this "telemetry" thread and in "IF proxy" thread is the first step before starting a dedicated thread to design a generic mechanism.
Quoted 7 lines
Quoted 1 line
May I offer the services of https://zeromq.org/ ?
This is what I already proposed:
http://inbox.dpdk.org/dev/20334513.huCnfhLgOn@xps/I'm sorry, I was supposed to start a new thread for this discussion. I will summarize my thoughts and discussions just after -rc1 is done.
Ah! They say great minds think alike :-P
Signature · 2 lines
Kind regards, Luca Boccassi
Quoted 19 lines
From: Ciara Power [mailto:[email protected]]
Sent: Wednesday, April 8, 2020 6:50 PMThis patchset extensively reworks the telemetry library adding new functionality and simplifying much of the existing code, while maintaining backward compatibility.
This work is based on the previously sent RFC for a "process info"
library: https://patchwork.dpdk.org/project/dpdk/list/?series=7741
However, rather than creating a new library, this patchset takes that work and merges it into the existing telemetry library, as mentioned above.The telemetry library as shipped in 19.11 is based upon the metrics library and outputs all statistics based on that as a source. However, this limits the telemetry output to only port-level statistics information, rather than allowing it to be used as a general scheme for telemetry information across all DPDK libraries.
Quoted 9 lines
With this patchset applied, rather than the telemetry library being responsible for pulling ethdev stats and pushing them into the metrics library for retrieval later, each library e.g. ethdev, rawdev, and even the metrics library itself (for backwards compatiblity) now handle their
own stats. Any library or app can register a callback function with telemetry, which will be called if requested by the client connected via
the telemetry socket.
Great. Standardization across libraries is a good improvement.
Quoted 3 lines
The callback function in the library/app then
formats its stats, or other data, into a JSON string, and returns it to telemetry to be sent to the client.
I am strongly opposed to using JSON as the standard format in DPDK, and instead prefer a binary format with zero (or minimal) type conversion.
Here is one reason why I dislike JSON for this: A part of our application samples 100k+ counters every second to be able to provide drill-down statistics through the GUI. Converting these counters from uint64_t to JSON and back to uint64_t for data processing is not going to fly. And I assume that we are not the only company developing equipment with drill-down statistics.
I am aware that there is a difference between statistics for *drill-down and data processing* purposes and statistics for *telemetry eyeball viewing only* purposes, but the line is blurry, and I see a big risk of setting a path that leads to JSON being used in places where it shouldn't.
Here is another reason why I dislike JSON for this: JSON is fine for the LAMP stack with REST protocols. But other systems use other protocols with other formats, e.g. the TICK stack uses an even simpler text based format. So DPDK based systems supporting the TICK stack will need to convert to first JSON format (in the DPDK libraries), and then from JSON format to InfluxDB format (in the DPDK application).
I think that type conversion does not belong inside deep inside the DPDK libraries, but is a job for the DPDK application. However, DPDK could provide libraries for efficient bulk conversion to popular formats like JSON. And other formats, if they are relevant, e.g. ASN.1 used by old school SNMP.
Quoted 41 lines · Morten Brørup
Quoted 20 lines
From: Ciara Power [mailto:[email protected]]
Sent: Wednesday, April 8, 2020 6:50 PMThis patchset extensively reworks the telemetry library adding new functionality and simplifying much of the existing code, while maintaining backward compatibility.
This work is based on the previously sent RFC for a "process info"
library: https://patchwork.dpdk.org/project/dpdk/list/?series=7741
However, rather than creating a new library, this patchset takes that work and merges it into the existing telemetry library, as mentioned above.The telemetry library as shipped in 19.11 is based upon the metrics library and outputs all statistics based on that as a source. However, this limits the telemetry output to only port-level statistics information, rather than allowing it to be used as a general scheme for telemetry information across all DPDK libraries.
Quoted 9 lines
With this patchset applied, rather than the telemetry library being responsible for pulling ethdev stats and pushing them into the metrics library for retrieval later, each library e.g. ethdev, rawdev, and even the metrics library itself (for backwards compatiblity) now handle their
own stats. Any library or app can register a callback function with telemetry, which will be called if requested by the client connected via
the telemetry socket.Great. Standardization across libraries is a good improvement.
Quoted 3 lines
The callback function in the library/app then
formats its stats, or other data, into a JSON string, and returns it to telemetry to be sent to the client.I am strongly opposed to using JSON as the standard format in DPDK, and instead prefer a binary format with zero (or minimal) type conversion.
Quoted 7 lines
Here is one reason why I dislike JSON for this: A part of our application samples 100k+ counters every second to be able to provide drill-down statistics through the GUI. Converting these counters from
uint64_tto JSON and back touint64_tfor data processing is not going to fly. And I assume that we are not the only company developing equipment with drill-down statistics.I am aware that there is a difference between statistics for *drill-down and data processing* purposes and statistics for *telemetry eyeball viewing only* purposes, but the line is blurry, and I see a big risk of setting a path that leads to JSON being used in places where it shouldn't.
Here is another reason why I dislike JSON for this: JSON is fine for the LAMP stack with REST protocols. But other systems use other protocols with other formats, e.g. the TICK stack uses an even simpler text based format. So DPDK based systems supporting the TICK stack will need to convert to first JSON format (in the DPDK libraries), and then from JSON format to InfluxDB format (in the DPDK application).
I think that type conversion does not belong inside deep inside the DPDK libraries, but is a job for the DPDK application. However, DPDK could provide libraries for efficient bulk conversion to popular formats like JSON. And other formats, if they are relevant, e.g. ASN.1 used by old school SNMP.
I believe JSON has it place in this library and in DPDK as it is a good conversion tool and easy to utilize with a huge number of tools/languages. Binary output gets into endianness issues and a number of other problems, so I would not want all of the data exported from DPDK to be in binary format. If the layout of the structure changes then the code would need to know that on both side to be able to convert the data into the correct values.
With that stated, the new telemetry code allows the application to add new commands and with that you can create a binary set of commands along side the JSON or any other output format. With the new register command we can create say a ‘/ethdevraw/stats,X’ set of commands that can emit binary format.
Using this method we get the best of both worlds and when using languages like Go or Python to collect these stats we have a standard format for conversion. In Go it is pretty hard to do binary conversion and JSON conversion is just a few lines. JSON may not be the fastest, but if you are requesting stats faster than a second then use the raw commands to get the data, which anyone can add to its application or we can add them to DPDK as a standard command set.
Re: [dpdk-dev] [PATCH v2 00/16] update and simplify telemetrylibrary.
Quoted 63 lines
From: dev [mailto:[email protected]] On Behalf Of Wiles, Keith
Sent: Friday, April 10, 2020 4:22 PMQuoted 1 line
On Apr 10, 2020, at 5:49 AM, Morten Brørup <[email protected]>
Quoted 30 lines · wrote:
Quoted 20 lines
From: Ciara Power [mailto:[email protected]]
Sent: Wednesday, April 8, 2020 6:50 PMThis patchset extensively reworks the telemetry library adding new functionality and simplifying much of the existing code, while maintaining backward compatibility.
This work is based on the previously sent RFC for a "process info"
library: https://patchwork.dpdk.org/project/dpdk/list/?series=7741
However, rather than creating a new library, this patchset takes that work and merges it into the existing telemetry library, as mentioned above.The telemetry library as shipped in 19.11 is based upon the metrics library and outputs all statistics based on that as a source. However, this limits the telemetry output to only port-level statistics information, rather than allowing it to be used as a general scheme for telemetry information across all DPDK libraries.
Quoted 9 lines
With this patchset applied, rather than the telemetry library being responsible for pulling ethdev stats and pushing them into the metrics library for retrieval later, each library e.g. ethdev, rawdev, and even the metrics library itself (for backwards compatiblity) now handle their
own stats. Any library or app can register a callback function with telemetry, which will be called if requested by the client connected via
the telemetry socket.Quoted 7 lines
Great. Standardization across libraries is a good improvement.
Quoted 3 lines
The callback function in the library/app then
formats its stats, or other data, into a JSON string, and returns it to telemetry to be sent to the client.I am strongly opposed to using JSON as the standard format in DPDK, and
instead prefer a binary format with zero (or minimal) type conversion.
Quoted 2 lines
Here is one reason why I dislike JSON for this: A part of our application
samples 100k+ counters every second to be able to provide drill-down statistics through the GUI. Converting these counters from
uint64_tto JSON and back touint64_tfor data processing is not going to fly. And I assume that we are not the only company developing equipment with drill-down statistics.Quoted 2 lines
I am aware that there is a difference between statistics for *drill-down
and data processing* purposes and statistics for *telemetry eyeball viewing only* purposes, but the line is blurry, and I see a big risk of setting a path that leads to JSON being used in places where it shouldn't.
Quoted 2 lines
Here is another reason why I dislike JSON for this: JSON is fine for the
LAMP stack with REST protocols. But other systems use other protocols with other formats, e.g. the TICK stack uses an even simpler text based format. So DPDK based systems supporting the TICK stack will need to convert to first JSON format (in the DPDK libraries), and then from JSON format to InfluxDB format (in the DPDK application).
Quoted 1 line
Quoted 8 lines
Quoted 1 line
I think that type conversion does not belong inside deep inside the DPDK
libraries, but is a job for the DPDK application. However, DPDK could provide libraries for efficient bulk conversion to popular formats like JSON. And other formats, if they are relevant, e.g. ASN.1 used by old school SNMP.
I believe JSON has it place in this library and in DPDK as it is a good conversion tool and easy to utilize with a huge number of
tools/languages.
JSON is extremely heavy compared to a raw binary format.
It makes sense for low volume, hierarchical structured data, but not for large tables or arrays of counters.
Quoted 3 lines
Binary output gets into endianness issues and a number of other problems, so I would not want all of the data exported from DPDK to be in binary format.
Endianness considerations are only relevant for data exchanged across the network; not data exchanged across processes inside the same machine.
And if you are exchanging data across the network, you would usually implement one or more well known protocols for that, e.g. JSON over HTTPS, or ASN.1 over SNMP, or InfluxDB over UDP. This means that the application needs to implement a protocol handler, which - in my opinion - should handle the relevant data type conversions from the raw format provided by DPDK.
I think it would be silly for DPDK core libraries to provide counters in JSON format, so an SNMP Agent would need to convert them from JSON back to binary and then to ASN.1.
Quoted 3 lines
If the layout of the structure changes then the code would need to know that on both side to be able to convert the data into the correct values.
I may be exaggerating here, but trying to prove a point: This is what we have ABI stability for. Structures should be designed cleverly and future proof, e.g. like the ethdev xstats. Using text based APIs is a circumvention of ABI stability.
Quoted 6 lines
With that stated, the new telemetry code allows the application to add new commands and with that you can create a binary set of commands along side the JSON or any other output format. With the new register command we can create say a ‘/ethdevraw/stats,X’ set of commands that can emit binary format.
That would be silly. The protocol handler should make the protocol specific conversion, not the driver! Again, going to the extreme to prove a point: If I understand you correctly, this would mean that PMDs would have provide counters in ASN.1 format for SNMP.
Our application provides a HTTPS/REST based communication interface for multiple purposes, e.g. getting tables of data. And if you want to get a table of some data via this interface, you can specify the output format in the request, so you can get it in e.g. TSV format (tabulator separated with a headline) for scripts, HTML format for human eyeballs. This data conversion happens at a common location, so we can easily add other output formats. You don't want to push this all the way down to the originator of the data.
Quoted 5 lines
Using this method we get the best of both worlds and when using languages like Go or Python to collect these stats we have a standard format for conversion. In Go it is pretty hard to do binary conversion and JSON conversion is just a few lines.
I don't think DPDK should provide preferential treatment to Go or Python. DPDK is based on C, and should mainly cater for C.
Quoted 4 lines
JSON may not be the fastest, but if you are
requesting stats faster than a second then use the raw commands to get the data, which anyone can add to its application or we can add them to DPDK as a standard command set.
APIs in the libraries are currently available to get data in raw format. My main concern is that libraries in the future will not provide functions to get raw data, like they do now, but only JSON formatted data for the telemetry library. This is what I want to avoid.
Re: [dpdk-dev] [PATCH v2 00/16] update and simplify telemetrylibrary.
Quoted 109 lines · Morten Brørup
Quoted 63 lines
From: dev [mailto:[email protected]] On Behalf Of Wiles, Keith
Sent: Friday, April 10, 2020 4:22 PMQuoted 1 line
On Apr 10, 2020, at 5:49 AM, Morten Brørup <[email protected]>
Quoted 30 lines · wrote:
Quoted 20 lines
From: Ciara Power [mailto:[email protected]]
Sent: Wednesday, April 8, 2020 6:50 PMThis patchset extensively reworks the telemetry library adding new functionality and simplifying much of the existing code, while maintaining backward compatibility.
This work is based on the previously sent RFC for a "process info"
library: https://patchwork.dpdk.org/project/dpdk/list/?series=7741
However, rather than creating a new library, this patchset takes that work and merges it into the existing telemetry library, as mentioned above.The telemetry library as shipped in 19.11 is based upon the metrics library and outputs all statistics based on that as a source. However, this limits the telemetry output to only port-level statistics information, rather than allowing it to be used as a general scheme for telemetry information across all DPDK libraries.
Quoted 9 lines
With this patchset applied, rather than the telemetry library being responsible for pulling ethdev stats and pushing them into the metrics library for retrieval later, each library e.g. ethdev, rawdev, and even the metrics library itself (for backwards compatiblity) now handle their
own stats. Any library or app can register a callback function with telemetry, which will be called if requested by the client connected via
the telemetry socket.Quoted 7 lines
Great. Standardization across libraries is a good improvement.
Quoted 3 lines
The callback function in the library/app then
formats its stats, or other data, into a JSON string, and returns it to telemetry to be sent to the client.I am strongly opposed to using JSON as the standard format in DPDK, and
instead prefer a binary format with zero (or minimal) type conversion.
Quoted 2 lines
Here is one reason why I dislike JSON for this: A part of our application
samples 100k+ counters every second to be able to provide drill-down statistics through the GUI. Converting these counters from
uint64_tto JSON and back touint64_tfor data processing is not going to fly. And I assume that we are not the only company developing equipment with drill-down statistics.Quoted 2 lines
I am aware that there is a difference between statistics for *drill-down
and data processing* purposes and statistics for *telemetry eyeball viewing only* purposes, but the line is blurry, and I see a big risk of setting a path that leads to JSON being used in places where it shouldn't.
Quoted 2 lines
Here is another reason why I dislike JSON for this: JSON is fine for the
LAMP stack with REST protocols. But other systems use other protocols with other formats, e.g. the TICK stack uses an even simpler text based format. So DPDK based systems supporting the TICK stack will need to convert to first JSON format (in the DPDK libraries), and then from JSON format to InfluxDB format (in the DPDK application).
Quoted 1 line
Quoted 8 lines
Quoted 1 line
I think that type conversion does not belong inside deep inside the DPDK
libraries, but is a job for the DPDK application. However, DPDK could provide libraries for efficient bulk conversion to popular formats like JSON. And other formats, if they are relevant, e.g. ASN.1 used by old school SNMP.
I believe JSON has it place in this library and in DPDK as it is a good conversion tool and easy to utilize with a huge number of
tools/languages.JSON is extremely heavy compared to a raw binary format.
It makes sense for low volume, hierarchical structured data, but not for large tables or arrays of counters.
Quoted 3 lines
Binary output gets into endianness issues and a number of other problems, so I would not want all of the data exported from DPDK to be in binary format.
Endianness considerations are only relevant for data exchanged across the network; not data exchanged across processes inside the same machine.
And if you are exchanging data across the network, you would usually implement one or more well known protocols for that, e.g. JSON over HTTPS, or ASN.1 over SNMP, or InfluxDB over UDP. This means that the application needs to implement a protocol handler, which - in my opinion - should handle the relevant data type conversions from the raw format provided by DPDK.
I think it would be silly for DPDK core libraries to provide counters in JSON format, so an SNMP Agent would need to convert them from JSON back to binary and then to ASN.1.
Quoted 3 lines
If the layout of the structure changes then the code would need to know that on both side to be able to convert the data into the correct values.
I may be exaggerating here, but trying to prove a point: This is what we have ABI stability for. Structures should be designed cleverly and future proof, e.g. like the ethdev xstats. Using text based APIs is a circumvention of ABI stability.
Quoted 6 lines
With that stated, the new telemetry code allows the application to add new commands and with that you can create a binary set of commands along side the JSON or any other output format. With the new register command we can create say a ‘/ethdevraw/stats,X’ set of commands that can emit binary format.
That would be silly. The protocol handler should make the protocol specific conversion, not the driver! Again, going to the extreme to prove a point: If I understand you correctly, this would mean that PMDs would have provide counters in ASN.1 format for SNMP.
Our application provides a HTTPS/REST based communication interface for multiple purposes, e.g. getting tables of data. And if you want to get a table of some data via this interface, you can specify the output format in the request, so you can get it in e.g. TSV format (tabulator separated with a headline) for scripts, HTML format for human eyeballs. This data conversion happens at a common location, so we can easily add other output formats. You don't want to push this all the way down to the originator of the data.
Quoted 5 lines
Using this method we get the best of both worlds and when using languages like Go or Python to collect these stats we have a standard format for conversion. In Go it is pretty hard to do binary conversion and JSON conversion is just a few lines.
Quoted 9 lines
I don't think DPDK should provide preferential treatment to Go or Python. DPDK is based on C, and should mainly cater for C.
Quoted 4 lines
JSON may not be the fastest, but if you are
requesting stats faster than a second then use the raw commands to get the data, which anyone can add to its application or we can add them to DPDK as a standard command set.APIs in the libraries are currently available to get data in raw format. My main concern is that libraries in the future will not provide functions to get raw data, like they do now, but only JSON formatted data for the telemetry library. This is what I want to avoid.
Hi Morten,
thanks for all the feedback.
Firstly on the performance side, we did some basic benchmarking of the output capabilities of the current proposal. Using a dummy client that had two queries constantly outstanding (to avoid dead time between one response and next request), we measured the number of replies per second from the ethdev xstats call.
* with a 2.3 GHz Xeon system, we got 3,500 responses per second, with 146 stats per response, giving a total of >500k stats per second encoded and transmitted.
* for those 500k stats, looking at the cpu time on the core doing the telemetry work, ~80% of CPU time was spent inside the ixgbe driver getting the stats from the NIC card itself.
* replacing the ixgbe NIC with a ring vdev increased the responses per second to >100k, though with only 13 stats per response this time, giving 1.3M stats per second.
* Splitting the existing xstats call in this RFC into separate xstat names and xstat values calls (something I think is a good idea to do generally), and only calling the xstat values call each time, gives further perf increases to 163k responses per second.
Overall so, at least on the json generation side, it appears we can do things rather quickly, though I admit that we did not look into the parsing cost on the other side.
All that being said, however, I do understand your point about having everything work internally in json - something that ties in with Thomas concern about having flexibility. Therefore, while we will upstream a v3 very shortly with the few incremental comments on v2, we can thereafter look to switch the internal communication between callbacks and telemetry library to use a regular data structure, and then leave the json encoding to the library itself just before output. That would:
a) allow the addition of other output types in the future without needing new callbacks.
b) allow more flexibility for integrating with a future one-IPC mechanism for DPDK.
I hope this option will resolve most concerns and allow for a 20.05 integration.
Regards.
/Bruce
Re: [dpdk-dev] [PATCH v2 00/16] update and simplifytelemetrylibrary.
Quoted 248 lines
From: dev [mailto:[email protected]] On Behalf Of Bruce Richardson
Sent: Monday, April 20, 2020 3:19 PMQuoted 4 lines · Morten Brørup
Quoted 4 lines
From: dev [mailto:[email protected]] On Behalf Of Wiles, Keith
Sent: Friday, April 10, 2020 4:22 PMQuoted 1 line
On Apr 10, 2020, at 5:49 AM, Morten Brørup
Quoted 6 lines
Quoted 6 lines
Quoted 5 lines · wrote:
Quoted 5 lines
From: Ciara Power [mailto:[email protected]]
Sent: Wednesday, April 8, 2020 6:50 PMThis patchset extensively reworks the telemetry library adding
new
Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
functionality and simplifying much of the existing code, while maintaining backward compatibility.
This work is based on the previously sent RFC for a "process
info"
Quoted 1 line
Quoted 1 line
Quoted 1 line
Quoted 1 line
library:
https://patchwork.dpdk.org/project/dpdk/list/?series=7741
Quoted 5 lines
Quoted 5 lines
Quoted 5 lines
Quoted 5 lines
However, rather than creating a new library, this patchset takes that work and merges it into the existing telemetry library, as mentioned above.
The telemetry library as shipped in 19.11 is based upon the
metrics
Quoted 1 line
Quoted 1 line
Quoted 1 line
Quoted 1 line
library and outputs all statistics based on that as a source.
However,
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
this limits the telemetry output to only port-level statistics information, rather than allowing it to be used as a general
scheme for
Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
telemetry information across all DPDK libraries.
With this patchset applied, rather than the telemetry library
being
Quoted 1 line
Quoted 1 line
Quoted 1 line
Quoted 1 line
responsible for pulling ethdev stats and pushing them into the
metrics
Quoted 1 line
Quoted 1 line
Quoted 1 line
Quoted 1 line
library for retrieval later, each library e.g. ethdev, rawdev,
and even
Quoted 1 line
Quoted 1 line
Quoted 1 line
Quoted 1 line
the metrics library itself (for backwards compatiblity) now
handle
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
their
own stats. Any library or app can register a callback functionwith
Quoted 1 line
Quoted 1 line
Quoted 1 line
Quoted 1 line
telemetry, which will be called if requested by the client
connected
Quoted 7 lines
Quoted 7 lines
Quoted 7 lines
Quoted 2 lines
via
the telemetry socket.Great. Standardization across libraries is a good improvement.
Quoted 2 lines
The callback function in the library/app then formats its stats, or other data, into a JSON string, and
returns it to
Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
Quoted 1 line
telemetry to be sent to the client.
I am strongly opposed to using JSON as the standard format in
DPDK, and
Quoted 1 line
Quoted 1 line
instead prefer a binary format with zero (or minimal) type
conversion.
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
Here is one reason why I dislike JSON for this: A part of our
application
Quoted 1 line
Quoted 1 line
samples 100k+ counters every second to be able to provide drill-
down
Quoted 1 line
Quoted 1 line
statistics through the GUI. Converting these counters from
uint64_tto JSON
Quoted 1 line
Quoted 1 line
and back to
uint64_tfor data processing is not going to fly. And Iassume
Quoted 1 line
Quoted 1 line
that we are not the only company developing equipment with drill-
down
Quoted 3 lines
Quoted 3 lines
statistics.
Quoted 2 lines
I am aware that there is a difference between statistics for
*drill-down
Quoted 1 line
Quoted 1 line
and data processing* purposes and statistics for *telemetry eyeball
viewing
Quoted 1 line
Quoted 1 line
only* purposes, but the line is blurry, and I see a big risk of
setting a
Quoted 3 lines
Quoted 3 lines
path that leads to JSON being used in places where it shouldn't.
Quoted 2 lines
Here is another reason why I dislike JSON for this: JSON is fine
for the
Quoted 1 line
Quoted 1 line
LAMP stack with REST protocols. But other systems use other
protocols with
Quoted 1 line
Quoted 1 line
other formats, e.g. the TICK stack uses an even simpler text based
format.
Quoted 1 line
Quoted 1 line
So DPDK based systems supporting the TICK stack will need to
convert to
Quoted 1 line
Quoted 1 line
first JSON format (in the DPDK libraries), and then from JSON
format to
Quoted 3 lines
Quoted 3 lines
InfluxDB format (in the DPDK application).
Quoted 2 lines
I think that type conversion does not belong inside deep inside
the DPDK
Quoted 1 line
Quoted 1 line
libraries, but is a job for the DPDK application. However, DPDK
could
Quoted 1 line
Quoted 1 line
provide libraries for efficient bulk conversion to popular formats
like
Quoted 1 line
Quoted 1 line
JSON. And other formats, if they are relevant, e.g. ASN.1 used by
old
Quoted 3 lines
Quoted 3 lines
school SNMP.
I believe JSON has it place in this library and in DPDK as it is a
good
Quoted 1 line
Quoted 1 line
conversion tool and easy to utilize with a huge number of
tools/languages.Quoted 4 lines
JSON is extremely heavy compared to a raw binary format.
It makes sense for low volume, hierarchical structured data, but not
for large tables or arrays of counters.
Quoted 2 lines
Quoted 2 lines
Binary output gets into endianness issues and a number of other
problems,
Quoted 1 line
Quoted 1 line
so I would not want all of the data exported from DPDK to be in
binary
Quoted 3 lines
Quoted 1 line
format.
Endianness considerations are only relevant for data exchanged across
the network; not data exchanged across processes inside the same machine.
Quoted 2 lines
And if you are exchanging data across the network, you would usually
implement one or more well known protocols for that, e.g. JSON over HTTPS, or ASN.1 over SNMP, or InfluxDB over UDP. This means that the application needs to implement a protocol handler, which - in my opinion - should handle the relevant data type conversions from the raw format provided by DPDK.
Quoted 2 lines
I think it would be silly for DPDK core libraries to provide counters
in JSON format, so an SNMP Agent would need to convert them from JSON back to binary and then to ASN.1.
Quoted 3 lines
Quoted 3 lines
If the layout of the structure changes then the code would need to know that on both side to be able to convert the data into the
correct
Quoted 3 lines
Quoted 1 line
values.
I may be exaggerating here, but trying to prove a point: This is what
we have ABI stability for. Structures should be designed cleverly and future proof, e.g. like the ethdev xstats. Using text based APIs is a circumvention of ABI stability.
Quoted 3 lines
Quoted 3 lines
With that stated, the new telemetry code allows the application to
add new
Quoted 1 line
Quoted 1 line
commands and with that you can create a binary set of commands
along side
Quoted 1 line
Quoted 1 line
the JSON or any other output format. With the new register command
we can
Quoted 1 line
Quoted 1 line
create say a ‘/ethdevraw/stats,X’ set of commands that can emit
binary
Quoted 3 lines
Quoted 1 line
format.
That would be silly. The protocol handler should make the protocol
specific conversion, not the driver! Again, going to the extreme to prove a point: If I understand you correctly, this would mean that PMDs would have provide counters in ASN.1 format for SNMP.
Quoted 2 lines
Our application provides a HTTPS/REST based communication interface
for multiple purposes, e.g. getting tables of data. And if you want to get a table of some data via this interface, you can specify the output format in the request, so you can get it in e.g. TSV format (tabulator separated with a headline) for scripts, HTML format for human eyeballs. This data conversion happens at a common location, so we can easily add other output formats. You don't want to push this all the way down to the originator of the data.
Quoted 3 lines
Quoted 3 lines
Using this method we get the best of both worlds and when using
languages
Quoted 1 line
Quoted 1 line
like Go or Python to collect these stats we have a standard format
for
Quoted 1 line
Quoted 1 line
conversion. In Go it is pretty hard to do binary conversion and
JSON
Quoted 3 lines
Quoted 1 line
conversion is just a few lines.
I don't think DPDK should provide preferential treatment to Go or
Python. DPDK is based on C, and should mainly cater for C.
Quoted 3 lines
Quoted 3 lines
JSON may not be the fastest, but if you are
requesting stats faster than a second then use the raw commands toget the
Quoted 1 line
Quoted 1 line
data, which anyone can add to its application or we can add them to
DPDK as
Quoted 3 lines
Quoted 1 line
a standard command set.
APIs in the libraries are currently available to get data in raw
format. My main concern is that libraries in the future will not provide functions to get raw data, like they do now, but only JSON formatted data for the telemetry library. This is what I want to avoid.
Quoted 1 line
Hi Morten,
thanks for all the feedback.
Firstly on the performance side, we did some basic benchmarking of the output capabilities of the current proposal. Using a dummy client that had
two queries constantly outstanding (to avoid dead time between one response
and next request), we measured the number of replies per second from the
ethdev xstats call.
* with a 2.3 GHz Xeon system, we got 3,500 responses per second, with 146
stats per response, giving a total of >500k stats per second encoded
and
transmitted.
* for those 500k stats, looking at the cpu time on the core doing the telemetry work, ~80% of CPU time was spent inside the ixgbe driver getting the stats from the NIC card itself.
* replacing the ixgbe NIC with a ring vdev increased the responses per second to >100k, though with only 13 stats per response this time,
giving
1.3M stats per second.
* Splitting the existing xstats call in this RFC into separate xstat names and xstat values calls (something I think is a good idea to do generally), and only calling the xstat values call each time, gives further perf increases to 163k responses per second.Overall so, at least on the json generation side, it appears we can do things rather quickly, though I admit that we did not look into the parsing
cost on the other side.All that being said, however, I do understand your point about having everything work internally in json - something that ties in with Thomas concern about having flexibility. Therefore, while we will upstream a v3
very shortly with the few incremental comments on v2, we can thereafter look to switch the internal communication between callbacks and telemetry
library to use a regular data structure, and then leave the json encoding
to the library itself just before output. That would:
a) allow the addition of other output types in the future without needing
new callbacks.
b) allow more flexibility for integrating with a future one-IPC mechanism
for DPDK.
Quoted 5 lines
I hope this option will resolve most concerns and allow for a 20.05 integration.
Regards.
/Bruce
Yes. Thank you.
Med venlig hilsen / kind regards
- Morten Brørup
v3 cover update and simplify telemetry library.
In reply to Ciara PowerNote: as discussed on-list, v4 will use a non-json internal representation.
v3:
- Removed rte_option as it is no longer used.
- General cleanup.
v2:
- Added JSON API, and unit tests, to simplify creation of valid json responses from libraries.
- Added printing of basic info, including max output buffer size, app PID and DPDK version on connection.
- Added /info command to report that basic info post-connect. This replaces the eal version command from v1.
- Renamed stats to xstats in commands to allow a future generic "stats" call.
- Added documentation, including updating existing howto and adding programmers guide section and API docs.
- Added link status command for ethdev ports.
- Fixed windows builds.
This patchset extensively reworks the telemetry library adding new functionality and simplifying much of the existing code, while maintaining backward compatibility.
This work is based on the previously sent RFC for a "process info"
library: https://patchwork.dpdk.org/project/dpdk/list/?series=7741
However, rather than creating a new library, this patchset takes that work and merges it into the existing telemetry library, as mentioned above.
The telemetry library as shipped in 19.11 is based upon the metrics library and outputs all statistics based on that as a source. However, this limits the telemetry output to only port-level statistics information, rather than allowing it to be used as a general scheme for telemetry information across all DPDK libraries.
With this patchset applied, rather than the telemetry library being responsible for pulling ethdev stats and pushing them into the metrics library for retrieval later, each library e.g. ethdev, rawdev, and even the metrics library itself (for backwards compatiblity) now handle their own stats. Any library or app can register a callback function with telemetry, which will be called if requested by the client connected via the telemetry socket. The callback function in the library/app then formats its stats, or other data, into a JSON string, and returns it to telemetry to be sent to the client.
To maintain backward compatibility, e.g. to allow the dpdk telemetry collectd plugin to continue to work, some of the existing telemetry code is kept, but is moved into the metrics library, and callbacks are registered with telemetry for the legacy commands that were supported previously.
The new version of the library, apart from the legacy interface support for backward compatibility, does not have an external dependency on the Jansson library, allowing the library to be enabled by default.
Note: In this version of the patchset, telemetry output is provided by the ethdev, rawdev and eal libraries, but this may be expanded further in later versions which are planned ahead of the merge deadline for 20.05
Bruce Richardson (8):
build: add arch-specific header path to global includes
telemetry: invert dependency on metrics
telemetry: introduce new telemetry functionality
telemetry: add utility functions for creating json app/test: add telemetry json tests
ethdev: add callback support for telemetry
usertools: add new telemetry python script
eal: add eal telemetry callbacks
Ciara Power (9):
telemetry: move code to metrics for later reuse
metrics: reduce code taken from telemetry
rawdev: add callback support for telemetry examples/l3fwd-power: enable use of new telemetry
telemetry: introduce telemetry backward compatibility
telemetry: remove existing telemetry files
lib: add telemetry as eal dependency
eal: remove rte-option infrastructure
doc: update telemetry documentation
app/test/Makefile | 2 + app/test/meson.build | 4 + app/test/test_telemetry_json.c | 136 ++ config/common_base | 2 +- config/meson.build | 7 - doc/api/doxy-api-index.md | 1 + doc/guides/howto/telemetry.rst | 108 +- doc/guides/linux_gsg/eal_args.include.rst | 8 + doc/guides/linux_gsg/sys_reqs.rst | 2 - doc/guides/prog_guide/index.rst | 1 + doc/guides/prog_guide/telemetry_lib.rst | 62 + doc/guides/rel_notes/release_20_05.rst | 15 + examples/l3fwd-power/Makefile | 2 +- examples/l3fwd-power/main.c | 53 +- examples/l3fwd-power/meson.build | 2 +- lib/Makefile | 10 +- lib/librte_eal/arm/include/meson.build | 2 - lib/librte_eal/common/eal_common_options.c | 81 +- lib/librte_eal/common/eal_internal_cfg.h | 1 + lib/librte_eal/common/eal_options.h | 7 + lib/librte_eal/common/eal_private.h | 28 - lib/librte_eal/common/meson.build | 2 - lib/librte_eal/common/rte_option.c | 95 - lib/librte_eal/freebsd/Makefile | 2 +- lib/librte_eal/freebsd/eal.c | 26 +- lib/librte_eal/freebsd/meson.build | 2 +- lib/librte_eal/include/meson.build | 1 - lib/librte_eal/include/rte_option.h | 72 - lib/librte_eal/linux/Makefile | 2 +- lib/librte_eal/linux/eal.c | 26 +- lib/librte_eal/linux/meson.build | 2 +- lib/librte_eal/meson.build | 5 +- lib/librte_eal/ppc/include/meson.build | 2 - lib/librte_eal/rte_eal_version.map | 1 - lib/librte_eal/x86/include/meson.build | 2 - lib/librte_ethdev/Makefile | 2 +- lib/librte_ethdev/meson.build | 2 +- lib/librte_ethdev/rte_ethdev.c | 99 + lib/librte_metrics/Makefile | 10 + lib/librte_metrics/meson.build | 9 + lib/librte_metrics/rte_metrics.c | 6 +- lib/librte_metrics/rte_metrics.h | 5 +- lib/librte_metrics/rte_metrics_telemetry.c | 539 +++++ lib/librte_metrics/rte_metrics_telemetry.h | 65 + lib/librte_metrics/rte_metrics_version.map | 7 + lib/librte_rawdev/Makefile | 2 +- lib/librte_rawdev/meson.build | 2 + lib/librte_rawdev/rte_rawdev.c | 75 + lib/librte_telemetry/Makefile | 15 +- lib/librte_telemetry/meson.build | 15 +- lib/librte_telemetry/rte_telemetry.c | 1895 ----------------- lib/librte_telemetry/rte_telemetry.h | 78 +- lib/librte_telemetry/rte_telemetry_internal.h | 112 - lib/librte_telemetry/rte_telemetry_json.h | 206 ++ lib/librte_telemetry/rte_telemetry_legacy.h | 65 + lib/librte_telemetry/rte_telemetry_parser.c | 682 ------ lib/librte_telemetry/rte_telemetry_parser.h | 15 - .../rte_telemetry_parser_test.c | 533 ----- .../rte_telemetry_socket_tests.h | 36 - .../rte_telemetry_version.map | 5 +- lib/librte_telemetry/telemetry.c | 312 +++ lib/librte_telemetry/telemetry_legacy.c | 226 ++ lib/meson.build | 3 +- meson.build | 9 + mk/rte.app.mk | 11 +- usertools/dpdk-telemetry.py | 83 + usertools/meson.build | 2 +- 67 files changed, 2241 insertions(+), 3659 deletions(-) create mode 100644 app/test/test_telemetry_json.c create mode 100644 doc/guides/prog_guide/telemetry_lib.rst delete mode 100644 lib/librte_eal/common/rte_option.c delete mode 100644 lib/librte_eal/include/rte_option.h create mode 100644 lib/librte_metrics/rte_metrics_telemetry.c create mode 100644 lib/librte_metrics/rte_metrics_telemetry.h delete mode 100644 lib/librte_telemetry/rte_telemetry.c delete mode 100644 lib/librte_telemetry/rte_telemetry_internal.h create mode 100644 lib/librte_telemetry/rte_telemetry_json.h create mode 100644 lib/librte_telemetry/rte_telemetry_legacy.h delete mode 100644 lib/librte_telemetry/rte_telemetry_parser.c delete mode 100644 lib/librte_telemetry/rte_telemetry_parser.h delete mode 100644 lib/librte_telemetry/rte_telemetry_parser_test.c delete mode 100644 lib/librte_telemetry/rte_telemetry_socket_tests.h create mode 100644 lib/librte_telemetry/telemetry.c create mode 100644 lib/librte_telemetry/telemetry_legacy.c create mode 100755 usertools/dpdk-telemetry.py
Signature · 1 line
2.17.1
PATCH v3 1/17 build: add arch-specific header path to global includes
From: Bruce Richardson <[email protected]>
The global include path, which is used by anything built before EAL, points to the EAL header files so they utility macros etc. can be used anywhere in DPDK. This path included the OS-specific EAL header files, but not the architecture-specific ones. This patch moves the selection of target architecture to the top-level meson.build file so that the global include can reference that.
--- config/meson.build | 7 ------- lib/librte_eal/arm/include/meson.build | 2 -- lib/librte_eal/ppc/include/meson.build | 2 -- lib/librte_eal/x86/include/meson.build | 2 -- meson.build | 9 +++++++++ 5 files changed, 9 insertions(+), 13 deletions(-)
config/meson.build +0 -7
@@ -229,13 +229,6 @@ dpdk_conf.set('RTE_LIBRTE_DPAA2_USE_PHYS_IOVA', true) compile_time_cpuflags = [] -if host_machine.cpu_family().startswith('x86') - arch_subdir = 'x86' -elif host_machine.cpu_family().startswith('arm') or host_machine.cpu_family().startswith('aarch') - arch_subdir = 'arm' -elif host_machine.cpu_family().startswith('ppc') - arch_subdir = 'ppc' -endif subdir(arch_subdir) dpdk_conf.set('RTE_COMPILE_TIME_CPUFLAGS', ','.join(compile_time_cpuflags))
lib/librte_eal/arm/include/meson.build +0 -2
@@ -1,8 +1,6 @@ # SPDX-License-Identifier: BSD-3-Clause # Copyright(c) 2017 Intel Corporation. -includes += include_directories('.') - arch_headers = files( 'rte_atomic_32.h', 'rte_atomic_64.h',
lib/librte_eal/ppc/include/meson.build +0 -2
@@ -1,8 +1,6 @@ # SPDX-License-Identifier: BSD-3-Clause # Copyright(c) 2018 Luca Boccassi <[email protected]> -includes += include_directories('.') - arch_headers = files( 'rte_atomic.h', 'rte_byteorder.h',
lib/librte_eal/x86/include/meson.build +0 -2
@@ -1,8 +1,6 @@ # SPDX-License-Identifier: BSD-3-Clause # Copyright(c) 2017 Intel Corporation -includes += include_directories('.') - arch_headers = files( 'rte_atomic_32.h', 'rte_atomic_64.h',
meson.build +9 -0
@@ -24,12 +24,21 @@ dpdk_libs_disabled = [] dpdk_drvs_disabled = [] abi_version_file = files('ABI_VERSION') +if host_machine.cpu_family().startswith('x86') + arch_subdir = 'x86' +elif host_machine.cpu_family().startswith('arm') or host_machine.cpu_family().startswith('aarch') + arch_subdir = 'arm' +elif host_machine.cpu_family().startswith('ppc') + arch_subdir = 'ppc' +endif + # configure the build, and make sure configs here and in config folder are # able to be included in any file. We also store a global array of include dirs # for passing to pmdinfogen scripts global_inc = include_directories('.', 'config', 'lib/librte_eal/include', 'lib/librte_eal/@0@/include'.format(host_machine.system()), + 'lib/librte_eal/@0@/include'.format(arch_subdir), ) subdir('config')
Signature · 1 line
2.17.1
PATCH v3 2/17 telemetry: move code to metrics for later reuse
In reply to Ciara PowerThis commit moves some of the telemetry library code to a new file in the metrics library. No modifications are made to the moved code, except what is needed to allow it to compile and run. The additional code in metrics is built only when the Jansson library is present. Telemetry functions as normal, using the functions from the metrics_telemetry file. This move will enable code be reused by the new version of telemetry in a later commit, to support backward compatibility with the existing telemetry usage.
--- lib/Makefile | 2 +- lib/librte_metrics/Makefile | 9 + lib/librte_metrics/meson.build | 8 + lib/librte_metrics/rte_metrics.c | 1 - lib/librte_metrics/rte_metrics.h | 3 +- lib/librte_metrics/rte_metrics_telemetry.c | 719 ++++++++++++++++++ lib/librte_metrics/rte_metrics_telemetry.h | 71 ++ lib/librte_metrics/rte_metrics_version.map | 7 + lib/librte_telemetry/rte_telemetry.c | 550 +------------- lib/librte_telemetry/rte_telemetry_internal.h | 32 +- lib/librte_telemetry/rte_telemetry_parser.c | 270 +------ mk/rte.app.mk | 2 + 12 files changed, 857 insertions(+), 817 deletions(-) create mode 100644 lib/librte_metrics/rte_metrics_telemetry.c create mode 100644 lib/librte_metrics/rte_metrics_telemetry.h
lib/Makefile +1 -1
@@ -71,7 +71,7 @@ DEPDIRS-librte_gro := librte_eal librte_mbuf librte_ethdev librte_net DIRS-$(CONFIG_RTE_LIBRTE_JOBSTATS) += librte_jobstats DEPDIRS-librte_jobstats := librte_eal DIRS-$(CONFIG_RTE_LIBRTE_METRICS) += librte_metrics -DEPDIRS-librte_metrics := librte_eal +DEPDIRS-librte_metrics := librte_eal librte_ethdev DIRS-$(CONFIG_RTE_LIBRTE_BITRATE) += librte_bitratestats DEPDIRS-librte_bitratestats := librte_eal librte_metrics librte_ethdev DIRS-$(CONFIG_RTE_LIBRTE_LATENCY_STATS) += librte_latencystats
lib/librte_metrics/Makefile +9 -0
@@ -14,6 +14,15 @@ EXPORT_MAP := rte_metrics_version.map # all source are stored in SRCS-y SRCS-$(CONFIG_RTE_LIBRTE_METRICS) := rte_metrics.c +ifeq ($(CONFIG_RTE_LIBRTE_TELEMETRY),y) +SRCS-y += rte_metrics_telemetry.c +SYMLINK-$(CONFIG_RTE_LIBRTE_METRICS)-include += rte_metrics_telemetry.h + +LDLIBS += -lrte_ethdev +LDLIBS += -ljansson + +endif + # Install header file SYMLINK-$(CONFIG_RTE_LIBRTE_METRICS)-include += rte_metrics.h
lib/librte_metrics/meson.build +8 -0
@@ -3,3 +3,11 @@ sources = files('rte_metrics.c') headers = files('rte_metrics.h') + +jansson = dependency('jansson', required: false) +if jansson.found() + ext_deps += jansson + sources += files('rte_metrics_telemetry.c') + headers = files('rte_metrics_telemetry.h') + deps += ['ethdev'] +endif
lib/librte_metrics/rte_metrics.c +0 -1
@@ -13,7 +13,6 @@#include <rte_memzone.h> #include <rte_spinlock.h> -#define RTE_METRICS_MAX_METRICS 256#define RTE_METRICS_MEMZONE_NAME "RTE_METRICS"/**
lib/librte_metrics/rte_metrics.h +1 -2
@@ -32,6 +32,7 @@ extern "C" {/** Maximum length of metric name (including null-terminator) */ #define RTE_METRICS_MAX_NAME_LEN 64 +#define RTE_METRICS_MAX_METRICS 256/** * Global metric special id.
@@ -43,7 +44,6 @@ extern "C" {*/ #define RTE_METRICS_GLOBAL -1 -/** * A name-key lookup for metrics. *
@@ -71,7 +71,6 @@ struct rte_metric_value {uint64_t value; }; -/** * Initializes metric module. This function must be called from * a primary process before metrics are used.
lib/librte_metrics/rte_metrics_telemetry.c new file +719 -0
719 lines not on this page · raw message
lib/librte_metrics/rte_metrics_telemetry.h new file +71 -0
71 lines not on this page · raw message
lib/librte_metrics/rte_metrics_version.map +7 -0
@@ -16,4 +16,11 @@ EXPERIMENTAL { global: rte_metrics_deinit; + rte_metrics_tel_encode_json_format; + rte_metrics_tel_reg_all_ethdev; + rte_metrics_tel_get_global_stats; + rte_metrics_tel_get_port_stats_ids; + rte_metrics_tel_get_ports_stats_json; + rte_metrics_tel_extract_data; + };
lib/librte_telemetry/rte_telemetry.c +20 -530
597 lines not on this page · raw message
lib/librte_telemetry/rte_telemetry_internal.h +2 -30
@@ -4,6 +4,8 @@#include <rte_log.h> #include <rte_tailq.h> +#include <rte_metrics.h> +#include <rte_metrics_telemetry.h> #ifndef _RTE_TELEMETRY_INTERNAL_H_#define _RTE_TELEMETRY_INTERNAL_H_
@@ -50,28 +52,6 @@ enum rte_telemetry_parser_actions { ACTION_DELETE = 2 }; -enum rte_telemetry_stats_type { -PORT_STATS =0 , -GLOBAL_STATS =1 -}; - -/* @internal */ -struct telemetry_encode_param { -enum rte_telemetry_stats_type type; -union { -struct port_param { -int num_metric_ids; -uint32_t metric_ids[MAX_METRICS ]; -int num_port_ids; -uint32_t port_ids[RTE_MAX_ETHPORTS ]; - } pp; -struct global_param { -int num_metric_ids; -uint32_t metric_ids[MAX_METRICS ]; - } gp; - }; -}; -int32_t rte_telemetry_parse_client_message (struct telemetry_impl *telemetry,char *buf);
@@ -87,14 +67,6 @@ int32_t rte_telemetry_unregister_client(struct telemetry_impl *telemetry, const char *client_path); -/** -* This is a wrapper for the ethdev api rte_eth_find_next(). -* If rte_eth_find_next() returns the same port id that we passed it, -* then we know that that port is active. -*/ -int32_t -rte_telemetry_is_port_active (int port_id); -int32_t rte_telemetry_send_ports_stats_values (struct telemetry_encode_param *ep,struct telemetry_impl *telemetry);
lib/librte_telemetry/rte_telemetry_parser.c +17 -253
344 lines not on this page · raw message
mk/rte.app.mk +2 -0
@@ -55,7 +55,9 @@ _LDLIBS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += -lrte_telemetry -ljansson _LDLIBS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += --no-whole-archive _LDLIBS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += --as-needed _LDLIBS-$(CONFIG_RTE_LIBRTE_JOBSTATS) += -lrte_jobstats +_LDLIBS-$(CONFIG_RTE_LIBRTE_METRICS) += --whole-archive _LDLIBS-$(CONFIG_RTE_LIBRTE_METRICS) += -lrte_metrics +_LDLIBS-$(CONFIG_RTE_LIBRTE_METRICS) += --no-whole-archive _LDLIBS-$(CONFIG_RTE_LIBRTE_BITRATE) += -lrte_bitratestats _LDLIBS-$(CONFIG_RTE_LIBRTE_LATENCY_STATS) += -lrte_latencystats _LDLIBS-$(CONFIG_RTE_LIBRTE_POWER) += -lrte_power
Signature · 1 line
2.17.1
PATCH v3 3/17 metrics: reduce code taken from telemetry
In reply to Ciara PowerThe telemetry code that was moved into the metrics library can be shortened, while still maintaining the same functionality.
--- lib/librte_metrics/rte_metrics_telemetry.c | 476 ++++---------------- lib/librte_metrics/rte_metrics_telemetry.h | 18 +- lib/librte_telemetry/rte_telemetry.c | 11 - lib/librte_telemetry/rte_telemetry_parser.c | 12 +- 4 files changed, 96 insertions(+), 421 deletions(-)
lib/librte_metrics/rte_metrics_telemetry.c +89 -387
@@ -23,33 +23,12 @@ int metrics_log_level; #define METRICS_LOG_WARN(fmt, args...) \ METRICS_LOG(WARNING, fmt, ## args) -static int32_t -rte_metrics_tel_is_port_active (int port_id) -{ -int ret; - - ret =rte_eth_find_next (port_id); -if (ret == port_id) -return 1 ; - -METRICS_LOG_ERR ("port_id: %d is invalid, not active" , - port_id); - -return 0 ; -} -static int32_t rte_metrics_tel_reg_port_ethdev_to_metrics (uint16_t port_id) { -int ret, num_xstats, ret_val, i; -struct rte_eth_xstat *eth_xstats =NULL ; +int ret, num_xstats, i;struct rte_eth_xstat_name *eth_xstats_names =NULL ; -if (!rte_eth_dev_is_valid_port (port_id)) { -METRICS_LOG_ERR ("port_id: %d is invalid" , port_id); -return -EINVAL ; - } - num_xstats =rte_eth_xstats_get (port_id,NULL ,0 );if (num_xstats <0 ) { METRICS_LOG_ERR("rte_eth_xstats_get(%u) failed: %d",
@@ -57,53 +36,32 @@ rte_metrics_tel_reg_port_ethdev_to_metrics(uint16_t port_id)return -EPERM ; } - eth_xstats =malloc (sizeof (struct rte_eth_xstat ) * num_xstats); -if (eth_xstats ==NULL ) { -METRICS_LOG_ERR ("Failed to malloc memory for xstats" ); -return -ENOMEM ; - } - - ret =rte_eth_xstats_get (port_id, eth_xstats, num_xstats);const char *xstats_names[num_xstats]; eth_xstats_names =malloc (sizeof (struct rte_eth_xstat_name ) * num_xstats); -if (ret <0 || ret > num_xstats) { -METRICS_LOG_ERR ("rte_eth_xstats_get(%u) len%i failed: %d" , - port_id, num_xstats, ret); - ret_val = -EPERM ; - goto free_xstats; - } -if (eth_xstats_names ==NULL ) {METRICS_LOG_ERR ("Failed to malloc memory for xstats_names" ); - ret_val = -ENOMEM ; + ret = -ENOMEM ; goto free_xstats; } - ret =rte_eth_xstats_get_names (port_id, eth_xstats_names, num_xstats); -if (ret <0 || ret > num_xstats) { -METRICS_LOG_ERR ("rte_eth_xstats_get_names(%u) len%i failed: %d" , - port_id, num_xstats, ret); - ret_val = -EPERM ; +if (rte_eth_xstats_get_names (port_id, + eth_xstats_names, num_xstats) != num_xstats) { +METRICS_LOG_ERR ("rte_eth_xstats_get_names(%u) len %d failed" , + port_id, num_xstats); + ret = -EPERM ; goto free_xstats; }for (i =0 ; i < num_xstats; i++) - xstats_names[i] = eth_xstats_names[eth_xstats[i].id].name; - - ret_val =rte_metrics_reg_names (xstats_names, num_xstats); -if (ret_val <0 ) { + xstats_names[i] = eth_xstats_names[i].name; + ret =rte_metrics_reg_names (xstats_names, num_xstats); +if (ret <0 )METRICS_LOG_ERR ("rte_metrics_reg_names failed - metrics may already be registered" ); - ret_val =-1 ; - goto free_xstats; - } - - goto free_xstats; free_xstats: -free (eth_xstats);free (eth_xstats_names); -return ret_val; +return ret; }int32_t
@@ -113,20 +71,18 @@ rte_metrics_tel_reg_all_ethdev(int *metrics_register_done, int *reg_index_list)const void *dev_ops;int reg_index; } drv_idx[RTE_MAX_ETHPORTS] = { {0} }; -int nb_drv_idx =0 ; -uint16_t pid; -int ret; +int ret, nb_drv_idx =0 ; +uint16_t d; -RTE_ETH_FOREACH_DEV (pid) { +RTE_ETH_FOREACH_DEV (d) {int i;/* Different device types have different numbers of stats, so * first check if the stats for this type of device have * already been registered */ for (i =0 ; i < nb_drv_idx; i++) { -if (rte_eth_devices[pid].dev_ops == - drv_idx[i].dev_ops) { - reg_index_list[pid] = drv_idx[i].reg_index; +if (rte_eth_devices[d].dev_ops == drv_idx[i].dev_ops) { + reg_index_list[d] = drv_idx[i].reg_index;break ; } }
@@ -134,17 +90,16 @@ rte_metrics_tel_reg_all_ethdev(int *metrics_register_done, int *reg_index_list)continue ;/* we found a match, go to next port */ /* No match, register a new set of xstats for this port */ - ret =rte_metrics_tel_reg_port_ethdev_to_metrics (pid); + ret =rte_metrics_tel_reg_port_ethdev_to_metrics (d);if (ret <0 ) { -METRICS_LOG_ERR ("Failed to register ethdev metrics" ); -return -1 ; +METRICS_LOG_ERR ("Failed to register ethdev to metrics" ); +return ret; } - reg_index_list[pid] = ret; - drv_idx[nb_drv_idx].dev_ops = rte_eth_devices[pid].dev_ops; + reg_index_list[d] = ret; + drv_idx[nb_drv_idx].dev_ops = rte_eth_devices[d].dev_ops; drv_idx[nb_drv_idx].reg_index = ret; nb_drv_idx++; } - *metrics_register_done =1 ;return 0 ; }
@@ -155,28 +110,17 @@ rte_metrics_tel_update_metrics_ethdev(uint16_t port_id, int reg_start_index)int ret, num_xstats, i;struct rte_eth_xstat *eth_xstats; -if (!rte_eth_dev_is_valid_port (port_id)) { -METRICS_LOG_ERR ("port_id: %d is invalid" , port_id); -return -EINVAL ; - } - - ret =rte_metrics_tel_is_port_active (port_id); -if (ret <1 ) -return -EINVAL ; - num_xstats =rte_eth_xstats_get (port_id,NULL ,0 );if (num_xstats <0 ) {METRICS_LOG_ERR ("rte_eth_xstats_get(%u) failed: %d" , port_id, num_xstats);return -EPERM ; } - eth_xstats =malloc (sizeof (struct rte_eth_xstat ) * num_xstats);if (eth_xstats ==NULL ) {METRICS_LOG_ERR ("Failed to malloc memory for xstats" );return -ENOMEM ; } - ret =rte_eth_xstats_get (port_id, eth_xstats, num_xstats);if (ret <0 || ret > num_xstats) {free (eth_xstats);
@@ -188,223 +132,96 @@ rte_metrics_tel_update_metrics_ethdev(uint16_t port_id, int reg_start_index)uint64_t xstats_values[num_xstats];for (i =0 ; i < num_xstats; i++) xstats_values[i] = eth_xstats[i].value; - - ret =rte_metrics_update_values (port_id, reg_start_index, xstats_values, - num_xstats); -if (ret <0 ) { +if (rte_metrics_update_values (port_id, reg_start_index, xstats_values, + num_xstats) <0 ) {METRICS_LOG_ERR ("Could not update metrics values" );free (eth_xstats);return -EPERM ; } -free (eth_xstats);return 0 ; } -static int -rte_metrics_tel_get_metrics (uint32_t port_id,struct rte_metric_value - *metrics,struct rte_metric_name *names,int num_metrics) -{ -int ret, num_values; - -if (num_metrics <0 ) { -METRICS_LOG_ERR ("Invalid metrics count" ); -return -EINVAL ; - }else if (num_metrics ==0 ) { -METRICS_LOG_ERR ("No metrics to display (none have been registered)" ); -return -EPERM ; - } - -if (metrics ==NULL ) { -METRICS_LOG_ERR ("Metrics must be initialised." ); -return -EINVAL ; - } - -if (names ==NULL ) { -METRICS_LOG_ERR ("Names must be initialised." ); -return -EINVAL ; - } - - ret =rte_metrics_get_names (names, num_metrics); -if (ret <0 || ret > num_metrics) { -METRICS_LOG_ERR ("Cannot get metrics names" ); -return -EPERM ; - } - - num_values =rte_metrics_get_values (port_id,NULL ,0 ); - ret =rte_metrics_get_values (port_id, metrics, num_values); -if (ret <0 || ret > num_values) { -METRICS_LOG_ERR ("Cannot get metrics values" ); -return -EPERM ; - } - -return 0 ; -} -static int32_t -rte_metrics_tel_json_format_stat (json_t *stats,const char *metric_name, -uint64_t metric_value) -{ -int ret; -json_t *stat =json_object (); - -if (stat ==NULL ) { -METRICS_LOG_ERR ("Could not create stat JSON object" ); -return -EPERM ; - } - - ret =json_object_set_new (stat,"name" ,json_string (metric_name)); -if (ret <0 ) { -METRICS_LOG_ERR ("Stat Name field cannot be set" ); -return -EPERM ; - } - - ret =json_object_set_new (stat,"value" ,json_integer (metric_value)); -if (ret <0 ) { -METRICS_LOG_ERR ("Stat Value field cannot be set" ); -return -EPERM ; - } - - ret =json_array_append_new (stats, stat); -if (ret <0 ) { -METRICS_LOG_ERR ("Stat cannot be added to stats json array" ); -return -EPERM ; - } - -return 0 ; -} - -static int32_t -rte_metrics_tel_json_format_port (uint32_t port_id,json_t *ports, +rte_metrics_tel_format_port (uint32_t pid,json_t *ports,uint32_t *metric_ids,int num_metric_ids) { -struct rte_metric_value *metrics =0 ; -struct rte_metric_name *names =0 ; -int num_metrics, ret; +struct rte_metric_value *metrics =NULL ; +struct rte_metric_name *names =NULL ; +int num_metrics, i, ret = -EPERM ;/* most error cases return EPERM */ json_t *port, *stats; -int i; num_metrics =rte_metrics_get_names (NULL ,0 );if (num_metrics <0 ) {METRICS_LOG_ERR ("Cannot get metrics count" ); - goto einval_fail; +return -EINVAL ; }else if (num_metrics ==0 ) {METRICS_LOG_ERR ("No metrics to display (none have been registered)" ); - goto eperm_fail; +return -EPERM ; } metrics =malloc (sizeof (struct rte_metric_value ) * num_metrics); names =malloc (sizeof (struct rte_metric_name ) * num_metrics);if (metrics ==NULL || names ==NULL ) {METRICS_LOG_ERR ("Cannot allocate memory" ); -free (metrics); -free (names);return -ENOMEM ; } - ret =rte_metrics_tel_get_metrics (port_id, metrics, names, - num_metrics); -if (ret <0 ) { -free (metrics); -free (names); -METRICS_LOG_ERR ("rte_metrics_tel_get_metrics failed" ); -return ret; +if (rte_metrics_get_names (names, num_metrics) != num_metrics || +rte_metrics_get_values (pid, metrics, num_metrics) + != num_metrics) { +METRICS_LOG_ERR ("Error getting metrics" ); + goto fail; } - port =json_object (); stats =json_array (); -if (port ==NULL || stats ==NULL ) { -METRICS_LOG_ERR ("Could not create port/stats JSON objects" ); - goto eperm_fail; - } - - ret =json_object_set_new (port,"port" ,json_integer (port_id)); -if (ret <0 ) { -METRICS_LOG_ERR ("Port field cannot be set" ); - goto eperm_fail; +if (stats ==NULL ) { +METRICS_LOG_ERR ("Could not create stats JSON object" ); + goto fail; } -for (i =0 ; i < num_metric_ids; i++) { -int metric_id = metric_ids[i]; -int metric_index =-1 ; -int metric_name_key =-1 ; +for (i =0 ; i < num_metrics; i++) {int32_t j; -uint64_t metric_value; - -if (metric_id >= num_metrics) { -METRICS_LOG_ERR ("Metric_id: %d is not valid" , - metric_id); - goto einval_fail; - } - -for (j =0 ; j < num_metrics; j++) { -if (metrics[j].key == metric_id) { - metric_name_key = metrics[j].key; - metric_index = j; +for (j =0 ; j < num_metric_ids; j++) +if (metrics[i].key == metric_ids[j])break ; - } - } - -const char *metric_name = names[metric_name_key].name; - metric_value = metrics[metric_index].value; -if (metric_name_key <0 || metric_index <0 ) { -METRICS_LOG_ERR ("Could not get metric name/index" ); - goto eperm_fail; - } +if (num_metric_ids >0 && j == num_metric_ids) +continue ;/* can't find this id */ - ret =rte_metrics_tel_json_format_stat (stats, metric_name, - metric_value); -if (ret <0 ) { +json_t *stat =json_pack ("{s,s,s,I}" , +"name" , names[metrics[i].key].name, +"value" , metrics[i].value); +if (stat ==NULL ||json_array_append_new (stats, stat) <0 ) {METRICS_LOG_ERR ("Format stat with id: %u failed" , - metric_id); -free (metrics); -free (names); -return ret; + metrics[i].key); + goto fail; } } -if (json_array_size (stats) ==0 ) - ret =json_object_set_new (port,"stats" ,json_null ()); -else - ret =json_object_set_new (port,"stats" , stats); - -if (ret <0 ) { -METRICS_LOG_ERR ("Stats object cannot be set" ); - goto eperm_fail; - } - - ret =json_array_append_new (ports, port); -if (ret <0 ) { -METRICS_LOG_ERR ("Port object cannot be added to ports array" ); - goto eperm_fail; + port =json_pack ("{s,i,s,o}" ,"port" , pid,"stats" , +json_array_size (stats) ? stats :json_null ()); +if (port ==NULL ||json_array_append_new (ports, port) <0 ) { +METRICS_LOG_ERR ("Error creating port and adding to ports" ); + goto fail; }free (metrics);free (names);return 0 ; -eperm_fail: -free (metrics); -free (names); -return -EPERM ; - -einval_fail: +fail:free (metrics);free (names); -return -EINVAL ; +return ret; }int32_t rte_metrics_tel_encode_json_format (struct telemetry_encode_param *ep,char **json_buffer) { -int ret;json_t *root, *ports; -int i; -uint32_t port_id; -int num_port_ids; -int num_metric_ids; +int ret, i; ports =json_array ();if (ports ==NULL ) {
@@ -413,28 +230,15 @@ rte_metrics_tel_encode_json_format(struct telemetry_encode_param *ep, }if (ep->type ==PORT_STATS ) { - num_port_ids = ep->pp.num_port_ids; - num_metric_ids = ep->pp.num_metric_ids; - -if (num_port_ids <=0 || num_metric_ids <=0 ) { -METRICS_LOG_ERR ("Please provide port and metric ids to query" ); +if (ep->pp.num_port_ids <=0 ) { +METRICS_LOG_ERR ("Please provide port/metric ids" );return -EINVAL ; } -for (i =0 ; i < num_port_ids; i++) { - port_id = ep->pp.port_ids[i]; -if (!rte_eth_dev_is_valid_port (port_id)) { -METRICS_LOG_ERR ("Port: %d invalid" , - port_id); -return -EINVAL ; - } - } - -for (i =0 ; i < num_port_ids; i++) { - port_id = ep->pp.port_ids[i]; - ret =rte_metrics_tel_json_format_port (port_id, +for (i =0 ; i < ep->pp.num_port_ids; i++) { + ret =rte_metrics_tel_format_port (ep->pp.port_ids[i], ports, &ep->pp.metric_ids[0 ], - num_metric_ids); + ep->pp.num_metric_ids);if (ret <0 ) {METRICS_LOG_ERR ("Format port in JSON failed" );return ret;
@@ -442,34 +246,21 @@ rte_metrics_tel_encode_json_format(struct telemetry_encode_param *ep, } }else if (ep->type ==GLOBAL_STATS ) {/* Request Global Metrics */ - ret =rte_metrics_tel_json_format_port (RTE_METRICS_GLOBAL , - ports, &ep->gp.metric_ids[0 ], - ep->gp.num_metric_ids); + ret =rte_metrics_tel_format_port (RTE_METRICS_GLOBAL , + ports,NULL ,0 );if (ret <0 ) { -METRICS_LOG_ERR (" Request Global Metrics Failed" ); +METRICS_LOG_ERR ("Request Global Metrics Failed" );return ret; } }else { -METRICS_LOG_ERR (" Invalid metrics type in encode params" ); +METRICS_LOG_ERR ("Invalid metrics type in encode params" );return -EINVAL ; } - root =json_object (); + root =json_pack ("{s,s,s,o}" ,"status_code" ,"Status OK: 200" , +"data" , ports);if (root ==NULL ) { -METRICS_LOG_ERR ("Could not create root JSON object" ); -return -EPERM ; - } - - ret =json_object_set_new (root,"status_code" , -json_string ("Status OK: 200" )); -if (ret <0 ) { -METRICS_LOG_ERR ("Status code field cannot be set" ); -return -EPERM ; - } - - ret =json_object_set_new (root,"data" , ports); -if (ret <0 ) { -METRICS_LOG_ERR ("Data field cannot be set" ); +METRICS_LOG_ERR ("Root, Status or data field cannot be set" );return -EPERM ; }
@@ -478,42 +269,6 @@ rte_metrics_tel_encode_json_format(struct telemetry_encode_param *ep,return 0 ; } -int32_t -rte_metrics_tel_get_global_stats (struct telemetry_encode_param *ep) -{ -int num_metrics, ret, i; -struct rte_metric_value *values; - - num_metrics =rte_metrics_get_values (RTE_METRICS_GLOBAL ,NULL ,0 ); -if (num_metrics <0 ) { -METRICS_LOG_ERR ("Cannot get metrics count" ); -return -EINVAL ; - }else if (num_metrics ==0 ) { -METRICS_LOG_ERR ("No metrics to display (none have been registered)" ); -return -EPERM ; - } - - values =malloc (sizeof (struct rte_metric_value ) * num_metrics); -if (values ==NULL ) { -METRICS_LOG_ERR ("Cannot allocate memory" ); -return -ENOMEM ; - } - - ret =rte_metrics_get_values (RTE_METRICS_GLOBAL , values, num_metrics); -if (ret <0 ) { -METRICS_LOG_ERR ("Could not get stat values" ); -free (values); -return -EINVAL ; - } -for (i =0 ; i < num_metrics; i++) - ep->gp.metric_ids[i] = values[i].key; - - ep->gp.num_metric_ids = num_metrics; - ep->type =GLOBAL_STATS ; -free (values); -return 0 ; -} -int32_t rte_metrics_tel_get_ports_stats_json (struct telemetry_encode_param *ep,int *reg_index,char **json_buffer)
@@ -547,24 +302,7 @@ rte_metrics_tel_get_ports_stats_json(struct telemetry_encode_param *ep,int32_t rte_metrics_tel_get_port_stats_ids (struct telemetry_encode_param *ep) { -int ret, num_metrics, i, p; -struct rte_metric_value *values; -uint64_t num_port_ids =0 ; - - num_metrics =rte_metrics_get_values (0 ,NULL ,0 ); -if (num_metrics <0 ) { -METRICS_LOG_ERR ("Cannot get metrics count" ); -return -EINVAL ; - }else if (num_metrics ==0 ) { -METRICS_LOG_ERR ("No metrics to display (none have been registered)" ); -return -EPERM ; - } - - values =malloc (sizeof (struct rte_metric_value ) * num_metrics); -if (values ==NULL ) { -METRICS_LOG_ERR ("Cannot allocate memory" ); -return -ENOMEM ; - } +int p, num_port_ids =0 ;RTE_ETH_FOREACH_DEV (p) { ep->pp.port_ids[num_port_ids] = p;
@@ -573,51 +311,26 @@ rte_metrics_tel_get_port_stats_ids(struct telemetry_encode_param *ep)if (!num_port_ids) {METRICS_LOG_ERR ("No active ports" ); - goto fail; - } - - ret =rte_metrics_get_values (ep->pp.port_ids[0 ], values, num_metrics); -if (ret <0 ) { -METRICS_LOG_ERR ("Could not get stat values" ); - goto fail; +return -EINVAL ; } -for (i =0 ; i < num_metrics; i++) - ep->pp.metric_ids[i] = values[i].key; ep->pp.num_port_ids = num_port_ids; - ep->pp.num_metric_ids = num_metrics; + ep->pp.num_metric_ids =0 ; ep->type =PORT_STATS ;return 0 ; - -fail: -free (values); -return -EINVAL ; }static int32_t rte_metrics_tel_stat_names_to_ids (const char *const *stat_names, -uint32_t *stat_ids,uint64_t num_stat_names) +uint32_t *stat_ids,int num_stat_names) {struct rte_metric_name *names; -int ret, num_metrics; -uint32_t i, k; - -if (stat_names ==NULL ) { -METRICS_LOG_WARN ("Invalid stat_names argument" ); -return -EINVAL ; - } - -if (num_stat_names <=0 ) { -METRICS_LOG_WARN ("Invalid num_stat_names argument" ); -return -EINVAL ; - } +int num_metrics; +int i, j, nb_stat_ids =0 ; num_metrics =rte_metrics_get_names (NULL ,0 ); -if (num_metrics <0 ) { -METRICS_LOG_ERR ("Cannot get metrics count" ); -return -EPERM ; - }else if (num_metrics ==0 ) { -METRICS_LOG_WARN ("No metrics have been registered" ); +if (num_metrics <=0 ) { +METRICS_LOG_ERR ("Error getting metrics count - no metrics may be registered" );return -EPERM ; }
@@ -627,29 +340,25 @@ rte_metrics_tel_stat_names_to_ids(const char * const *stat_names,return -ENOMEM ; } - ret =rte_metrics_get_names (names, num_metrics); -if (ret <0 || ret > num_metrics) { +if (rte_metrics_get_names (names, num_metrics) != num_metrics) {METRICS_LOG_ERR ("Cannot get metrics names" );free (names);return -EPERM ; } - k =0 ; -for (i =0 ; i < (uint32_t )num_stat_names; i++) { -uint32_t j; -for (j =0 ; j < (uint32_t )num_metrics; j++) { +for (i =0 ; i < num_stat_names; i++) { +for (j =0 ; j < num_metrics; j++) {if (strcmp (stat_names[i], names[j].name) ==0 ) { - stat_ids[k] = j; - k++; + stat_ids[nb_stat_ids++] = j;break ; } } - } - -if (k != num_stat_names) { -METRICS_LOG_WARN ("Invalid stat names provided" ); -free (names); -return -EINVAL ; +if (j == num_metrics) { +METRICS_LOG_WARN ("Invalid stat name %s\n" , + stat_names[i]); +free (names); +return -EINVAL ; + } }free (names);
@@ -670,28 +379,21 @@ rte_metrics_tel_extract_data(struct telemetry_encode_param *ep, json_t *data)memset (ep,0 ,sizeof (*ep)); ep->pp.num_port_ids =json_array_size (port_ids_json); ep->pp.num_metric_ids = num_stat_names; -if (!json_is_object (data)) { +if (!json_is_object (data) || !json_is_array (port_ids_json) || + !json_is_array (stat_names_json)) {METRICS_LOG_WARN ("Invalid data provided for this command" );return -EINVAL ; } -if (!json_is_array (port_ids_json) || - !json_is_array (stat_names_json)) { -METRICS_LOG_WARN ("Invalid input data array(s)" ); -return -EINVAL ; - } - json_array_foreach(port_ids_json, index, value) {if (!json_is_integer (value)) {METRICS_LOG_WARN ("Port ID given is not valid" );return -EINVAL ; } ep->pp.port_ids[index] =json_integer_value (value); - ret =rte_metrics_tel_is_port_active (ep->pp.port_ids[index]); -if (ret <1 ) +if (rte_eth_dev_is_valid_port (ep->pp.port_ids[index]) <1 )return -EINVAL ; } - json_array_foreach(stat_names_json, index, value) {if (!json_is_string (value)) {METRICS_LOG_WARN ("Stat Name given is not a string" );
lib/librte_metrics/rte_metrics_telemetry.h +6 -12
@@ -21,18 +21,12 @@ enum rte_telemetry_stats_type {struct telemetry_encode_param {enum rte_telemetry_stats_type type; -union { -struct port_param { -int num_metric_ids; -uint32_t metric_ids[RTE_METRICS_MAX_METRICS ]; -int num_port_ids; -uint32_t port_ids[RTE_MAX_ETHPORTS ]; - } pp; -struct global_param { -int num_metric_ids; -uint32_t metric_ids[RTE_METRICS_MAX_METRICS ]; - } gp; - }; +struct port_param { +int num_metric_ids; +uint32_t metric_ids[RTE_METRICS_MAX_METRICS ]; +int num_port_ids; +uint32_t port_ids[RTE_MAX_ETHPORTS ]; + } pp; };struct telemetry_metrics_data {
lib/librte_telemetry/rte_telemetry.c +0 -11
@@ -145,11 +145,6 @@ rte_telemetry_send_global_stats_values(struct telemetry_encode_param *ep,return -1 ; } -if (ep->gp.num_metric_ids <0 ) { -TELEMETRY_LOG_ERR ("Invalid num_metric_ids, must be positive" ); - goto einval_fail; - } - ret =rte_metrics_tel_encode_json_format (ep, &json_buffer);if (ret <0 ) {TELEMETRY_LOG_ERR ("JSON encode function failed" );
@@ -166,12 +161,6 @@ rte_telemetry_send_global_stats_values(struct telemetry_encode_param *ep, }return 0 ; - -einval_fail: - ret =rte_telemetry_send_error_response (telemetry, -EINVAL ); -if (ret <0 ) -TELEMETRY_LOG_ERR ("Could not send error" ); -return -1 ; }int32_t
lib/librte_telemetry/rte_telemetry_parser.c +1 -11
@@ -225,9 +225,8 @@ rte_telemetry_command_global_stat_values(struct telemetry_impl *telemetry, int action, json_t *data) { int ret; -struct telemetry_encode_param ep; +struct telemetry_encode_param ep = { .type =GLOBAL_STATS }; -memset (&ep,0 ,sizeof (ep));if (telemetry ==NULL ) {TELEMETRY_LOG_ERR ("Invalid telemetry argument" );return -1 ;
@@ -249,15 +248,6 @@ rte_telemetry_command_global_stat_values(struct telemetry_impl *telemetry,return -1 ; } - ret =rte_metrics_tel_get_global_stats (&ep); -if (ret <0 ) { -TELEMETRY_LOG_ERR ("Could not get global stat values" ); - ret =rte_telemetry_send_error_response (telemetry, ret); -if (ret <0 ) -TELEMETRY_LOG_ERR ("Could not send error" ); -return -1 ; - } - ret =rte_telemetry_send_global_stats_values (&ep, telemetry);if (ret <0 ) {TELEMETRY_LOG_ERR ("Sending global stats values failed" );
Signature · 1 line
2.17.1
PATCH v3 4/17 telemetry: invert dependency on metrics
In reply to Ciara PowerFrom: Bruce Richardson <[email protected]>
Rather than having the telemetry library depend on the metrics lib we invert the dependency so that metrics instead depends on telemetry lib, and registers the needed functions with it at init time. This prepares the way for a cleaner telemetry architecture to be applied in later patches.
--- lib/Makefile | 7 +++-- lib/librte_metrics/Makefile | 3 +- lib/librte_metrics/meson.build | 3 +- lib/librte_metrics/rte_metrics.c | 5 ++++ lib/librte_metrics/rte_metrics.h | 2 ++ lib/librte_metrics/rte_metrics_telemetry.c | 14 +++++++++ lib/librte_telemetry/Makefile | 4 +-- lib/librte_telemetry/meson.build | 2 +- lib/librte_telemetry/rte_telemetry.c | 19 ++++++++---- lib/librte_telemetry/rte_telemetry_internal.h | 30 +++++++++++++++++++ lib/librte_telemetry/rte_telemetry_parser.c | 5 ++-- .../rte_telemetry_version.map | 1 + lib/meson.build | 3 +- mk/rte.app.mk | 6 +--- 14 files changed, 82 insertions(+), 22 deletions(-)
lib/Makefile +5 -2
@@ -22,6 +22,8 @@ DIRS-$(CONFIG_RTE_LIBRTE_CFGFILE) += librte_cfgfile DEPDIRS-librte_cfgfile := librte_eal DIRS-$(CONFIG_RTE_LIBRTE_CMDLINE) += librte_cmdline DEPDIRS-librte_cmdline := librte_eal librte_net +DIRS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += librte_telemetry +DEPDIRS-librte_telemetry := librte_eal DIRS-$(CONFIG_RTE_LIBRTE_ETHER) += librte_ethdev DEPDIRS-librte_ethdev := librte_net librte_eal librte_mempool librte_ring DEPDIRS-librte_ethdev += librte_mbuf
@@ -72,6 +74,9 @@ DIRS-$(CONFIG_RTE_LIBRTE_JOBSTATS) += librte_jobstats DEPDIRS-librte_jobstats := librte_eal DIRS-$(CONFIG_RTE_LIBRTE_METRICS) += librte_metrics DEPDIRS-librte_metrics := librte_eal librte_ethdev +ifeq ($(CONFIG_RTE_LIBRTE_TELEMETRY),y) +DEPDIRS-librte_metrics += librte_telemetry +endif DIRS-$(CONFIG_RTE_LIBRTE_BITRATE) += librte_bitratestats DEPDIRS-librte_bitratestats := librte_eal librte_metrics librte_ethdev DIRS-$(CONFIG_RTE_LIBRTE_LATENCY_STATS) += librte_latencystats
@@ -114,8 +119,6 @@ DEPDIRS-librte_bpf := librte_eal librte_mempool librte_mbuf librte_ethdev DIRS-$(CONFIG_RTE_LIBRTE_IPSEC) += librte_ipsec DEPDIRS-librte_ipsec := librte_eal librte_mbuf librte_cryptodev librte_security \ librte_net librte_hash -DIRS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += librte_telemetry -DEPDIRS-librte_telemetry := librte_eal librte_metrics librte_ethdev DIRS-$(CONFIG_RTE_LIBRTE_RCU) += librte_rcu DEPDIRS-librte_rcu := librte_eal
lib/librte_metrics/Makefile +2 -1
@@ -18,9 +18,10 @@ ifeq ($(CONFIG_RTE_LIBRTE_TELEMETRY),y) SRCS-y += rte_metrics_telemetry.c SYMLINK-$(CONFIG_RTE_LIBRTE_METRICS)-include += rte_metrics_telemetry.h -LDLIBS += -lrte_ethdev +LDLIBS += -lrte_ethdev -lrte_telemetry LDLIBS += -ljansson +CFLAGS += -I$(RTE_SDK)/lib/librte_telemetry/ endif # Install header file
lib/librte_metrics/meson.build +2 -1
@@ -9,5 +9,6 @@ if jansson.found() ext_deps += jansson sources += files('rte_metrics_telemetry.c') headers = files('rte_metrics_telemetry.h') - deps += ['ethdev'] + deps += ['ethdev', 'telemetry'] + includes += include_directories('../librte_telemetry') endif
lib/librte_metrics/rte_metrics.c +5 -0
@@ -13,6 +13,8 @@#include <rte_memzone.h> #include <rte_spinlock.h> +int metrics_initialized; +#define RTE_METRICS_MEMZONE_NAME "RTE_METRICS"/**
@@ -60,6 +62,8 @@ rte_metrics_init(int socket_id)struct rte_metrics_data_s *stats;const struct rte_memzone *memzone; +if (metrics_initialized) +return ;if (rte_eal_process_type () !=RTE_PROC_PRIMARY )return ;
@@ -73,6 +77,7 @@ rte_metrics_init(int socket_id) stats = memzone->addr;memset (stats,0 ,sizeof (struct rte_metrics_data_s ));rte_spinlock_init (&stats->lock); + metrics_initialized =1 ; }int
lib/librte_metrics/rte_metrics.h +2 -0
@@ -30,6 +30,8 @@extern "C" {#endif +extern int metrics_initialized; +/** Maximum length of metric name (including null-terminator) */ #define RTE_METRICS_MAX_NAME_LEN 64#define RTE_METRICS_MAX_METRICS 256
lib/librte_metrics/rte_metrics_telemetry.c +14 -0
@@ -6,6 +6,9 @@#include <rte_ethdev.h> #include <rte_string_fns.h> +#ifdef RTE_LIBRTE_TELEMETRY +#include <rte_telemetry_internal.h> +#endif #include "rte_metrics.h" #include "rte_metrics_telemetry.h"
@@ -74,6 +77,7 @@ rte_metrics_tel_reg_all_ethdev(int *metrics_register_done, int *reg_index_list)int ret, nb_drv_idx =0 ;uint16_t d; +rte_metrics_init (rte_socket_id ());RTE_ETH_FOREACH_DEV (d) {int i;/* Different device types have different numbers of stats, so
@@ -415,6 +419,16 @@ rte_metrics_tel_extract_data(struct telemetry_encode_param *ep, json_t *data)RTE_INIT (metrics_ctor) { +#ifdef RTE_LIBRTE_TELEMETRY +static const struct metrics_functions fns = { + .reg_all_ethdev = rte_metrics_tel_reg_all_ethdev, + .encode_json_format = rte_metrics_tel_encode_json_format, + .get_port_stats_ids = rte_metrics_tel_get_port_stats_ids, + .get_ports_stats_json = rte_metrics_tel_get_ports_stats_json, + .extract_data = rte_metrics_tel_extract_data + }; +rte_telemetry_set_metrics_fns (&fns);/* assign them to telemetry lib */ +#endif metrics_log_level =rte_log_register ("lib.metrics" );if (metrics_log_level >=0 )rte_log_set_level (metrics_log_level,RTE_LOG_ERR );
lib/librte_telemetry/Makefile +2 -2
@@ -8,9 +8,9 @@ LIB = librte_telemetry.a CFLAGS += -O3 CFLAGS += $(WERROR_FLAGS) -I$(SRCDIR) +CFLAGS += -I$(RTE_SDK)/lib/librte_metrics/ -LDLIBS += -lrte_eal -lrte_ethdev -LDLIBS += -lrte_metrics +LDLIBS += -lrte_eal LDLIBS += -lpthread LDLIBS += -ljansson
lib/librte_telemetry/meson.build +1 -1
@@ -3,7 +3,7 @@ sources = files('rte_telemetry.c', 'rte_telemetry_parser.c', 'rte_telemetry_parser_test.c') headers = files('rte_telemetry.h', 'rte_telemetry_internal.h', 'rte_telemetry_parser.h') -deps += ['metrics', 'ethdev'] +includes += include_directories('../librte_metrics') jansson = dependency('jansson', required: false) if jansson.found()
lib/librte_telemetry/rte_telemetry.c +13 -6
@@ -10,10 +10,10 @@#include <jansson.h> #include <rte_eal.h> -#include <rte_ethdev.h> #include <rte_metrics.h> #include <rte_option.h> #include <rte_string_fns.h> +#include <rte_lcore.h> #include "rte_telemetry.h" #include "rte_telemetry_internal.h"
@@ -43,6 +43,15 @@ struct json_data {int stat_value; }; +/* global array of functions pointers to metrics library */ +const struct metrics_functions *metrics_fns; + +void +rte_telemetry_set_metrics_fns (const struct metrics_functions *fns) +{ + metrics_fns = fns; +} +static void rte_telemetry_get_runtime_dir (char *socket_path,size_t size) {
@@ -145,7 +154,7 @@ rte_telemetry_send_global_stats_values(struct telemetry_encode_param *ep,return -1 ; } - ret =rte_metrics_tel_encode_json_format (ep, &json_buffer); + ret = metrics_fns->encode_json_format (ep, &json_buffer);if (ret <0 ) {TELEMETRY_LOG_ERR ("JSON encode function failed" ); ret =rte_telemetry_send_error_response (telemetry, ret);
@@ -190,7 +199,7 @@ rte_telemetry_send_ports_stats_values(struct telemetry_encode_param *ep, goto einval_fail; } - ret =rte_metrics_tel_get_ports_stats_json (ep, telemetry->reg_index, + ret = metrics_fns->get_ports_stats_json (ep, telemetry->reg_index, &json_buffer);if (ret <0 ) { TELEMETRY_LOG_ERR("Function for get_ports_stats_json"
@@ -222,8 +231,7 @@ rte_telemetry_initial_accept(struct telemetry_impl *telemetry)int ret;int selftest =0 ; - ret =rte_metrics_tel_reg_all_ethdev ( - &telemetry->metrics_register_done, + ret = metrics_fns->reg_all_ethdev (&telemetry->metrics_register_done, telemetry->reg_index);if (ret <0 ) {TELEMETRY_LOG_ERR ("Failed to register ethdev metrics" );
@@ -467,7 +475,6 @@ rte_telemetry_init(void) } static_telemetry->socket_id =rte_socket_id (); -rte_metrics_init (static_telemetry->socket_id); ret =pthread_attr_init (&attr);if (ret !=0 ) {
lib/librte_telemetry/rte_telemetry_internal.h +30 -0
@@ -10,6 +10,36 @@#ifndef _RTE_TELEMETRY_INTERNAL_H_#define _RTE_TELEMETRY_INTERNAL_H_ +/* function types for the functions coming from metrics library */ +typedef int32_t (*metrics_tel_reg_all_ethdev_t )(int *metrics_register_done, +int *reg_index_list); + +typedef int32_t (*metrics_tel_encode_json_format_t )( +struct telemetry_encode_param *ep,char **json_buffer); + +typedef int32_t (*metrics_tel_get_port_stats_ids_t )( +struct telemetry_encode_param *ep); + +typedef int32_t (*metrics_tel_get_ports_stats_json_t )( +struct telemetry_encode_param *ep, +int *reg_index,char **json_buffer); + +typedef int32_t (*metrics_tel_extract_data_t )(struct telemetry_encode_param *ep, +json_t *data); + +struct metrics_functions { +metrics_tel_reg_all_ethdev_t reg_all_ethdev; +metrics_tel_encode_json_format_t encode_json_format; +metrics_tel_get_port_stats_ids_t get_port_stats_ids; +metrics_tel_get_ports_stats_json_t get_ports_stats_json; +metrics_tel_extract_data_t extract_data; +}; +extern const struct metrics_functions *metrics_fns; + +/* API for use by metrics libraries to provide the functions to use */ +__rte_experimental +void rte_telemetry_set_metrics_fns(const struct metrics_functions *fns); +/* Logging Macros */ extern int telemetry_log_level;
lib/librte_telemetry/rte_telemetry_parser.c +2 -3
@@ -10,7 +10,6 @@#include <rte_metrics.h> #include <rte_common.h> -#include <rte_ethdev.h> #include <rte_metrics_telemetry.h> #include "rte_telemetry_internal.h"
@@ -202,7 +201,7 @@ rte_telemetry_command_ports_all_stat_values(struct telemetry_impl *telemetry,return -1 ; } - ret =rte_metrics_tel_get_port_stats_ids (&ep); + ret = metrics_fns->get_port_stats_ids (&ep);if (ret <0 ) {TELEMETRY_LOG_ERR ("Could not get ports stat values" ); ret =rte_telemetry_send_error_response (telemetry, ret);
@@ -276,7 +275,7 @@ rte_telemetry_command_ports_stats_values_by_name(struct telemetry_implreturn -1 ; } - ret =rte_metrics_tel_extract_data (&ep, data); + ret = metrics_fns->extract_data (&ep, data);if (ret <0 ) {TELEMETRY_LOG_ERR ("Extracting JSON data failed" ); ret =rte_telemetry_send_error_response (telemetry, ret);
lib/librte_telemetry/rte_telemetry_version.map +1 -0
@@ -5,6 +5,7 @@ EXPERIMENTAL { rte_telemetry_init; rte_telemetry_parse; rte_telemetry_selftest; + rte_telemetry_set_metrics_fns; local: *; };
lib/meson.build +2 -1
@@ -11,6 +11,7 @@ libraries = [ 'kvargs', # eal depends on kvargs 'eal', # everything depends on eal + 'telemetry', 'ring', 'mempool', 'mbuf', 'net', 'meter', 'ethdev', 'pci', # core 'cmdline', 'metrics', # bitrate/latency stats depends on this
@@ -30,7 +31,7 @@ libraries = [ # add pkt framework libs which use other libs from above 'port', 'table', 'pipeline', # flow_classify lib depends on pkt framework table lib - 'flow_classify', 'bpf', 'telemetry'] + 'flow_classify', 'bpf'] if is_windows libraries = ['kvargs','eal'] # only supported libraries for windows
mk/rte.app.mk +1 -5
@@ -49,11 +49,6 @@ _LDLIBS-$(CONFIG_RTE_LIBRTE_FIB) += -lrte_fib _LDLIBS-$(CONFIG_RTE_LIBRTE_RIB) += -lrte_rib _LDLIBS-$(CONFIG_RTE_LIBRTE_LPM) += -lrte_lpm _LDLIBS-$(CONFIG_RTE_LIBRTE_ACL) += -lrte_acl -_LDLIBS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += --no-as-needed -_LDLIBS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += --whole-archive -_LDLIBS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += -lrte_telemetry -ljansson -_LDLIBS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += --no-whole-archive -_LDLIBS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += --as-needed _LDLIBS-$(CONFIG_RTE_LIBRTE_JOBSTATS) += -lrte_jobstats _LDLIBS-$(CONFIG_RTE_LIBRTE_METRICS) += --whole-archive _LDLIBS-$(CONFIG_RTE_LIBRTE_METRICS) += -lrte_metrics
@@ -95,6 +90,7 @@ _LDLIBS-$(CONFIG_RTE_DRIVER_MEMPOOL_RING) += -lrte_mempool_ring _LDLIBS-$(CONFIG_RTE_LIBRTE_OCTEONTX2_MEMPOOL) += -lrte_mempool_octeontx2 _LDLIBS-$(CONFIG_RTE_LIBRTE_RING) += -lrte_ring _LDLIBS-$(CONFIG_RTE_LIBRTE_PCI) += -lrte_pci +_LDLIBS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += -lrte_telemetry -ljansson _LDLIBS-$(CONFIG_RTE_LIBRTE_EAL) += -lrte_eal _LDLIBS-$(CONFIG_RTE_LIBRTE_CMDLINE) += -lrte_cmdline _LDLIBS-$(CONFIG_RTE_LIBRTE_REORDER) += -lrte_reorder
Signature · 1 line
2.17.1
PATCH v3 5/17 telemetry: introduce new telemetry functionality
In reply to Ciara PowerFrom: Bruce Richardson <[email protected]>
This patch introduces a new telemetry connection socket and handling functionality. Like the existing telemetry implementation (which is unaffected by this change) it uses a unix socket, but unlike the existing one it does not have a fixed list of commands - instead libraries or applications can register telemetry commands and callbacks to provide a full-extensible solution for all kinds of telemetry across DPDK.
---
v2:
- Added DPDK information message on client connection.
- Added /info command to get DPDK information post-connect.
- Replaced pid in socket name with v2.
- Increased output buffer size to 16k.
- Telemetry default callbacks now registered by init function.
--- lib/librte_telemetry/Makefile | 4 + lib/librte_telemetry/meson.build | 5 +- lib/librte_telemetry/rte_telemetry.c | 3 + lib/librte_telemetry/rte_telemetry.h | 72 ++++- .../rte_telemetry_version.map | 2 + lib/librte_telemetry/telemetry.c | 278 ++++++++++++++++++ 6 files changed, 362 insertions(+), 2 deletions(-) create mode 100644 lib/librte_telemetry/telemetry.c
lib/librte_telemetry/Makefile +4 -0
@@ -9,6 +9,9 @@ LIB = librte_telemetry.a CFLAGS += -O3 CFLAGS += $(WERROR_FLAGS) -I$(SRCDIR) CFLAGS += -I$(RTE_SDK)/lib/librte_metrics/ +CFLAGS += -I$(RTE_SDK)/lib/librte_eal/include +CFLAGS += -I$(RTE_SDK)/lib/librte_eal/$(ARCH_DIR)/include +CFLAGS += -pthread LDLIBS += -lrte_eal LDLIBS += -lpthread
@@ -20,6 +23,7 @@ EXPORT_MAP := rte_telemetry_version.map SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) := rte_telemetry.c SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += rte_telemetry_parser.c SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += rte_telemetry_parser_test.c +SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += telemetry.c # export include files SYMLINK-$(CONFIG_RTE_LIBRTE_TELEMETRY)-include := rte_telemetry.h
lib/librte_telemetry/meson.build +4 -1
@@ -1,7 +1,10 @@ # SPDX-License-Identifier: BSD-3-Clause # Copyright(c) 2018 Intel Corporation -sources = files('rte_telemetry.c', 'rte_telemetry_parser.c', 'rte_telemetry_parser_test.c') +includes = [global_inc] + +sources = files('rte_telemetry.c', 'rte_telemetry_parser.c', 'rte_telemetry_parser_test.c', + 'telemetry.c') headers = files('rte_telemetry.h', 'rte_telemetry_internal.h', 'rte_telemetry_parser.h') includes += include_directories('../librte_metrics')
lib/librte_telemetry/rte_telemetry.c +3 -0
@@ -503,6 +503,9 @@ rte_telemetry_init(void)return -EPERM ; } +if (rte_telemetry_new_init () !=0 ) +return -1 ; +return 0 ; }
lib/librte_telemetry/rte_telemetry.h +71 -1
94 lines not on this page · raw message
lib/librte_telemetry/rte_telemetry_version.map +2 -0
@@ -6,6 +6,8 @@ EXPERIMENTAL { rte_telemetry_parse; rte_telemetry_selftest; rte_telemetry_set_metrics_fns; + rte_telemetry_new_init; + rte_telemetry_register_cmd; local: *; };
lib/librte_telemetry/telemetry.c new file +278 -0
278 lines not on this page · raw message
Signature · 1 line
2.17.1
PATCH v3 6/17 telemetry: add utility functions for creating json
In reply to Ciara PowerFrom: Bruce Richardson <[email protected]>
The functions added in this patch will make it easier for applications to build up correct JSON responses to telemetry requests.
--- lib/librte_telemetry/Makefile | 1 + lib/librte_telemetry/meson.build | 2 +- lib/librte_telemetry/rte_telemetry.h | 1 + lib/librte_telemetry/rte_telemetry_json.h | 206 ++++++++++++++++++++++ 4 files changed, 209 insertions(+), 1 deletion(-) create mode 100644 lib/librte_telemetry/rte_telemetry_json.h
lib/librte_telemetry/Makefile +1 -0
@@ -27,5 +27,6 @@ SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += telemetry.c # export include files SYMLINK-$(CONFIG_RTE_LIBRTE_TELEMETRY)-include := rte_telemetry.h +SYMLINK-$(CONFIG_RTE_LIBRTE_TELEMETRY)-include += rte_telemetry_json.h include $(RTE_SDK)/mk/rte.lib.mk
lib/librte_telemetry/meson.build +1 -1
@@ -5,7 +5,7 @@ includes = [global_inc] sources = files('rte_telemetry.c', 'rte_telemetry_parser.c', 'rte_telemetry_parser_test.c', 'telemetry.c') -headers = files('rte_telemetry.h', 'rte_telemetry_internal.h', 'rte_telemetry_parser.h') +headers = files('rte_telemetry.h', 'rte_telemetry_internal.h', 'rte_telemetry_parser.h', 'rte_telemetry_json.h') includes += include_directories('../librte_metrics') jansson = dependency('jansson', required: false)
lib/librte_telemetry/rte_telemetry.h +1 -0
@@ -4,6 +4,7 @@#include <stdint.h> #include <rte_compat.h> +#include <rte_telemetry_json.h> #ifndef _RTE_TELEMETRY_H_#define _RTE_TELEMETRY_H_
lib/librte_telemetry/rte_telemetry_json.h new file +206 -0
206 lines not on this page · raw message
Signature · 1 line
2.17.1
PATCH v3 7/17 app/test: add telemetry json tests
In reply to Ciara PowerFrom: Bruce Richardson <[email protected]>
This patch adds tests for the json utility functions in the telemetry library.
--- app/test/Makefile | 2 + app/test/meson.build | 4 + app/test/test_telemetry_json.c | 136 +++++++++++++++++++++++++++++++++ 3 files changed, 142 insertions(+) create mode 100644 app/test/test_telemetry_json.c
app/test/Makefile +2 -0
@@ -136,6 +136,8 @@ SRCS-$(CONFIG_RTE_LIBRTE_LPM) += test_lpm_perf.c SRCS-$(CONFIG_RTE_LIBRTE_LPM) += test_lpm6.c SRCS-$(CONFIG_RTE_LIBRTE_LPM) += test_lpm6_perf.c +SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += test_telemetry_json.c + SRCS-y += test_debug.c SRCS-y += test_errno.c SRCS-y += test_tailq.c
app/test/meson.build +4 -0
@@ -320,6 +320,10 @@ endif if dpdk_conf.has('RTE_LIBRTE_SKELETON_EVENTDEV_PMD') test_deps += 'pmd_skeleton_event' endif +if dpdk_conf.has('RTE_LIBRTE_TELEMETRY') + test_sources += 'test_telemetry_json.c' + fast_tests += [['telemetry_json_autotest', true]] +endif # The following linkages of drivers are required because # they are used via a driver-specific API.
app/test/test_telemetry_json.c new file +136 -0
136 lines not on this page · raw message
Signature · 1 line
2.17.1
PATCH v3 8/17 ethdev: add callback support for telemetry
In reply to Ciara PowerFrom: Bruce Richardson <[email protected]>
The ethdev library now registers commands with telemetry, and implements the callback functions. These commands allow the list of ethdev ports and the stats and link status for a port to be queried.
---
v2:
- Renamed stats to xstats for device specific stats.
- Added link status command for ethdev ports.
--- lib/librte_ethdev/Makefile | 4 ++ lib/librte_ethdev/meson.build | 4 ++ lib/librte_ethdev/rte_ethdev.c | 105 +++++++++++++++++++++++++++++++++ 3 files changed, 113 insertions(+)
lib/librte_ethdev/Makefile +4 -0
@@ -23,6 +23,10 @@ SRCS-y += rte_tm.c SRCS-y += rte_mtr.c SRCS-y += ethdev_profile.c +ifeq ($(CONFIG_RTE_LIBRTE_TELEMETRY),y) +LDLIBS += -lrte_telemetry +endif + # # Export include files #
lib/librte_ethdev/meson.build +4 -0
@@ -25,3 +25,7 @@ headers = files('rte_ethdev.h', 'rte_tm_driver.h') deps += ['net', 'kvargs', 'meter'] + +if dpdk_conf.has('RTE_LIBRTE_TELEMETRY') + deps += ['telemetry'] +endif
lib/librte_ethdev/rte_ethdev.c +105 -0
120 lines not on this page · raw message
Signature · 1 line
2.17.1
PATCH v3 9/17 usertools: add new telemetry python script
In reply to Ciara PowerFrom: Bruce Richardson <[email protected]>
This patch adds a python script that can be used with the new telemetry socket. It connects as a client to the socket, and allows the user send a command and see the JSON response.
The example usage below shows the script connecting to the new telemetry socket, and sending two basic ethdev commands entered by the user. The response for each command is shown below the user input.
Connecting to /var/run/dpdk/rte/dpdk_telemetry.v2
{"pid": 63724, "version": "DPDK 20.05.0-rc0", "max_output_len": 16384} --> /
{"/": ["/", "/ethdev/link_status", "/ethdev/list", "/ethdev/xstats", \
"/info"]}
--> /info
{"/info": {"pid": 63724, "version": "DPDK 20.05.0-rc0", \
"max_output_len": 16384}}
--> /ethdev/list
{"/ethdev/list": [0, 1]}
--> /ethdev/link_status,0
{"/ethdev/link_status": {"status": "UP", "speed": 10000, "duplex": \
"full-duplex"}}
--> /ethdev/xstats,0
{"/ethdev/xstats": {"rx_good_packets": 0, "tx_good_packets": 0, \
<snip>
"tx_priority7_xon_to_xoff_packets": 0}}---
v2:
- Renamed new python script to dpdk-telemetry.py.
- Fixed script to validate input before sending to Telemetry.
v3: Added readline support
--- usertools/dpdk-telemetry.py | 83 +++++++++++++++++++++++++++++++++++++ usertools/meson.build | 2 +- 2 files changed, 84 insertions(+), 1 deletion(-) create mode 100755 usertools/dpdk-telemetry.py
usertools/dpdk-telemetry.py new file +83 -0
@@ -0,0 +1,83 @@ +#! /usr/bin/python3 +# SPDX-License-Identifier: BSD-3-Clause +# Copyright(c) 2020 Intel Corporation + +""" +Script to be used with V2 Telemetry. +Allows the user input commands and read the Telemetry response. +""" + +import socket +import os +import glob +import json +import readline + +# global vars +TELEMETRY_VERSION = "v2" +CMDS = [] + + +def read_socket(sock, buf_len, echo=True): + """ Read data from socket and return it in JSON format """ + reply = sock.recv(buf_len).decode() + try: + ret = json.loads(reply) + except json.JSONDecodeError: + print("Error in reply: ", reply) + sock.close() + raise + if echo: + print(json.dumps(ret)) + return ret + + +def handle_socket(path): + """ Connect to socket and handle user input """ + sock = socket.socket(socket.AF_UNIX, socket.SOCK_SEQPACKET) + global CMDS + print("Connecting to " + path) + try: + sock.connect(path) + except OSError: + print("Error connecting to " + path) + sock.close() + return + json_reply = read_socket(sock, 1024) + output_buf_len = json_reply["max_output_len"] + + # get list of commands for readline completion + sock.send("/".encode()) + CMDS = read_socket(sock, output_buf_len, False)["/"] + + # interactive prompt + text = input('--> ').strip() + while text != "quit": + if text.startswith('/'): + sock.send(text.encode()) + read_socket(sock, output_buf_len) + text = input('--> ').strip() + sock.close() + + +def readline_complete(text, state): + """ Find any matching commands from the list based on user input """ + all_cmds = ['quit'] + CMDS + if text: + matches = [c for c in all_cmds if c.startswith(text)] + else: + matches = all_cmds + return matches[state] + + +readline.parse_and_bind('tab: complete') +readline.set_completer(readline_complete) +readline.set_completer_delims(readline.get_completer_delims().replace('/', '')) + +# Path to sockets for processes run as a root user +for f in glob.glob('/var/run/dpdk/*/dpdk_telemetry.%s' % TELEMETRY_VERSION): + handle_socket(f) +# Path to sockets for processes run as a regular user +for f in glob.glob('/run/user/%d/dpdk/*/dpdk_telemetry.%s' % + (os.getuid(), TELEMETRY_VERSION)): + handle_socket(f)
usertools/meson.build +1 -1
@@ -1,4 +1,4 @@ # SPDX-License-Identifier: BSD-3-Clause # Copyright(c) 2017 Intel Corporation -install_data(['dpdk-devbind.py', 'dpdk-pmdinfo.py'], install_dir: 'bin') +install_data(['dpdk-devbind.py', 'dpdk-pmdinfo.py', 'dpdk-telemetry.py'], install_dir: 'bin')
Signature · 1 line
2.17.1
PATCH v3 10/17 rawdev: add callback support for telemetry
In reply to Ciara PowerThe rawdev library now registers commands with telemetry, and implements the corresponding callback functions. These allow a list of rawdev devices and xstats for a rawdev port to be queried.
An example usage, with ioat rawdev driver instances, is shown below:
Connecting to /var/run/dpdk/rte/dpdk_telemetry.v2
{"pid": 66100, "version": "DPDK 20.05.0-rc0", "max_output_len": 16384} --> /
{"/": ["/", "/ethdev/link_status", "/ethdev/list", "/ethdev/xstats", \
"/info", "/rawdev/list", "/rawdev/xstats"]}
--> /rawdev/list
{"/rawdev/list": [0, 1, 2, 3, 4, 5]}
--> /rawdev/xstats,0
{"/rawdev/xstats": {"failed_enqueues": 0, "successful_enqueues": 0, \
"copies_started": 0, "copies_completed": 0}}---
v2: Renamed stats to xstats for device specific stats.
--- lib/librte_rawdev/Makefile | 4 ++ lib/librte_rawdev/meson.build | 4 ++ lib/librte_rawdev/rte_rawdev.c | 81 ++++++++++++++++++++++++++++++++++ 3 files changed, 89 insertions(+)
lib/librte_rawdev/Makefile +4 -0
@@ -11,6 +11,10 @@ CFLAGS += -O3 CFLAGS += $(WERROR_FLAGS) LDLIBS += -lrte_eal +ifeq ($(CONFIG_RTE_LIBRTE_TELEMETRY),y) +LDLIBS += -lrte_telemetry +endif + # library source files SRCS-y += rte_rawdev.c
lib/librte_rawdev/meson.build +4 -0
@@ -3,3 +3,7 @@ sources = files('rte_rawdev.c') headers = files('rte_rawdev.h', 'rte_rawdev_pmd.h') + +if dpdk_conf.has('RTE_LIBRTE_TELEMETRY') + deps += ['telemetry'] +endif
lib/librte_rawdev/rte_rawdev.c +81 -0
96 lines not on this page · raw message
Signature · 1 line
2.17.1
PATCH v3 11/17 examples/l3fwd-power: enable use of new telemetry
In reply to Ciara PowerThe l3fwd-power example app now registers a stats command with telemetry, and provides a callback function to handle formatting the power stats.
An example usage is shown below:
Connecting to /var/run/dpdk/rte/dpdk_telemetry.v2
{"pid": 6726, "version": "DPDK 20.05.0-rc0", "max_output_len": 16384} --> /
{"/": ["/", "/ethdev/link_status", "/ethdev/list", "/ethdev/xstats", \
"/info", "/l3fwd-power/stats", "/rawdev/list", "/rawdev/xstats"]}
--> /l3fwd-power/stats
{"/l3fwd-power/stats": {"empty_poll": 281625000, "full_poll": 0, \
"busy_percent": 0}}The existing stats tracking done by the app using the metrics library is unaffected. This will still be used to ensure backward compatibility.
--- examples/l3fwd-power/Makefile | 4 +++ examples/l3fwd-power/main.c | 57 ++++++++++++++++++++++++-------- examples/l3fwd-power/meson.build | 4 +++ 3 files changed, 51 insertions(+), 14 deletions(-)
examples/l3fwd-power/Makefile +4 -0
@@ -68,6 +68,10 @@ ifeq ($(CONFIG_RTE_TOOLCHAIN_GCC),y) CFLAGS_main.o += -Wno-return-type endif +ifeq ($(CONFIG_RTE_LIBRTE_TELEMETRY),y) +LDLIBS += -lrte_telemetry +endif + include $(RTE_SDK)/mk/rte.extapp.mk endif endif
examples/l3fwd-power/main.c +43 -14
111 lines not on this page · raw message
examples/l3fwd-power/meson.build +4 -0
@@ -16,3 +16,7 @@ deps += ['power', 'timer', 'lpm', 'hash', 'metrics'] sources = files( 'main.c', 'perf_core.c' ) + +if dpdk_conf.has('RTE_LIBRTE_TELEMETRY') + deps += ['telemetry'] +endif
Signature · 1 line
2.17.1
PATCH v3 12/17 telemetry: introduce telemetry backward compatibility
In reply to Ciara PowerThe new telemetry will now open a socket using the old telemetry path, to ensure backward compatibility. This is not yet initialised, as it would clash with the existing telemetry, to be removed in a later patch. This means that both old and new telemetry socket interfaces are handled in a common way.
--- lib/librte_metrics/rte_metrics_telemetry.c | 113 +++++++++ lib/librte_telemetry/Makefile | 1 + lib/librte_telemetry/meson.build | 4 +- lib/librte_telemetry/rte_telemetry_legacy.h | 65 +++++ .../rte_telemetry_version.map | 2 + lib/librte_telemetry/telemetry.c | 31 +++ lib/librte_telemetry/telemetry_legacy.c | 226 ++++++++++++++++++ 7 files changed, 440 insertions(+), 2 deletions(-) create mode 100644 lib/librte_telemetry/rte_telemetry_legacy.h create mode 100644 lib/librte_telemetry/telemetry_legacy.c
lib/librte_metrics/rte_metrics_telemetry.c +113 -0
@@ -8,6 +8,7 @@#include <rte_string_fns.h> #ifdef RTE_LIBRTE_TELEMETRY #include <rte_telemetry_internal.h> +#include <rte_telemetry_legacy.h> #endif #include "rte_metrics.h"
@@ -417,6 +418,112 @@ rte_metrics_tel_extract_data(struct telemetry_encode_param *ep, json_t *data)return 0 ; } +static int +rte_metrics_tel_initial_metrics_setup (void ) +{ +int ret; +rte_metrics_init (rte_socket_id ()); + +if (!tel_met_data.metrics_register_done) { + ret =rte_metrics_tel_reg_all_ethdev ( + &tel_met_data.metrics_register_done, + tel_met_data.reg_index); +if (ret <0 ) +return ret; + } +return 0 ; +} + +static int +handle_ports_all_stats_values(const char *cmd __rte_unused, + const char *params __rte_unused, +char *buffer,int buf_len) +{ +struct telemetry_encode_param ep; +int ret, used =0 ; +char *json_buffer =NULL ; + + ret =rte_metrics_tel_initial_metrics_setup (); +if (ret <0 ) +return ret; + +memset (&ep,0 ,sizeof (ep)); + ret =rte_metrics_tel_get_port_stats_ids (&ep); +if (ret <0 ) +return ret; + + ret =rte_metrics_tel_get_ports_stats_json (&ep, tel_met_data.reg_index, + &json_buffer); +if (ret <0 ) +return ret; + + used +=strlcpy (buffer, json_buffer, buf_len); +return used; +} + +static int +handle_global_stats_values(const char *cmd __rte_unused, + const char *params __rte_unused, +char *buffer,int buf_len) +{ +char *json_buffer =NULL ; +struct telemetry_encode_param ep = { .type =GLOBAL_STATS }; +int ret, used =0 ; + + ret =rte_metrics_tel_initial_metrics_setup (); +if (ret <0 ) +return ret; + + ret =rte_metrics_tel_encode_json_format (&ep, &json_buffer); +if (ret <0 ) { +METRICS_LOG_ERR ("JSON encode function failed" ); +return ret; + } + used +=strlcpy (buffer, json_buffer, buf_len); +return used; +} + +static int +handle_ports_stats_values_by_name(const char *cmd __rte_unused, +const char *params, +char *buffer,int buf_len) +{ +char *json_buffer =NULL ; +struct telemetry_encode_param ep; +int ret, used =0 ; +json_t *data; +json_error_t error; + + ret =rte_metrics_tel_initial_metrics_setup (); +if (ret <0 ) +return ret; + + data =json_loads (params,0 , &error); +if (!data) { +METRICS_LOG_WARN ("Could not load JSON object from data passed in : %s" , + error.text); +return -EPERM ; + }else if (!json_is_object (data)) { +METRICS_LOG_WARN ("JSON Request data is not a JSON object" ); +json_decref (data); +return -EINVAL ; + } + + ret =rte_metrics_tel_extract_data (&ep, data); +if (ret <0 ) { +METRICS_LOG_ERR ("Extract data function failed" ); +return ret; + } + + ret =rte_metrics_tel_encode_json_format (&ep, &json_buffer); +if (ret <0 ) { +METRICS_LOG_ERR ("JSON encode function failed" ); +return ret; + } + used +=strlcpy (buffer, json_buffer, buf_len); +return used; +} +RTE_INIT (metrics_ctor) {#ifdef RTE_LIBRTE_TELEMETRY
@@ -428,6 +535,12 @@ RTE_INIT(metrics_ctor) .extract_data = rte_metrics_tel_extract_data };rte_telemetry_set_metrics_fns (&fns);/* assign them to telemetry lib */ +rte_telemetry_legacy_register ("ports_all_stat_values" ,DATA_NOT_REQ , + handle_ports_all_stats_values); +rte_telemetry_legacy_register ("global_stat_values" ,DATA_NOT_REQ , + handle_global_stats_values); +rte_telemetry_legacy_register ("ports_stats_values_by_name" ,DATA_REQ , + handle_ports_stats_values_by_name);#endif metrics_log_level =rte_log_register ("lib.metrics" );if (metrics_log_level >=0 )
lib/librte_telemetry/Makefile +1 -0
@@ -24,6 +24,7 @@ SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) := rte_telemetry.c SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += rte_telemetry_parser.c SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += rte_telemetry_parser_test.c SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += telemetry.c +SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += telemetry_legacy.c # export include files SYMLINK-$(CONFIG_RTE_LIBRTE_TELEMETRY)-include := rte_telemetry.h
lib/librte_telemetry/meson.build +2 -2
@@ -3,8 +3,8 @@ includes = [global_inc] -sources = files('rte_telemetry.c', 'rte_telemetry_parser.c', 'rte_telemetry_parser_test.c', - 'telemetry.c') +sources = files('rte_telemetry.c','rte_telemetry_parser.c', 'rte_telemetry_parser_test.c', + 'telemetry.c', 'telemetry_legacy.c') headers = files('rte_telemetry.h', 'rte_telemetry_internal.h', 'rte_telemetry_parser.h', 'rte_telemetry_json.h') includes += include_directories('../librte_metrics')
lib/librte_telemetry/rte_telemetry_legacy.h new file +65 -0
65 lines not on this page · raw message
lib/librte_telemetry/rte_telemetry_version.map +2 -0
@@ -8,6 +8,8 @@ EXPERIMENTAL { rte_telemetry_set_metrics_fns; rte_telemetry_new_init; rte_telemetry_register_cmd; + rte_telemetry_legacy_init; + rte_telemetry_legacy_register; local: *; };
lib/librte_telemetry/telemetry.c +31 -0
@@ -16,6 +16,7 @@#include <rte_version.h> #include "rte_telemetry.h" +#include "rte_telemetry_legacy.h" #define MAX_CMD_LEN 56#define MAX_OUTPUT_LEN (1024 * 16)
@@ -42,6 +43,7 @@ struct socket {handler fn; };static struct socket v2_socket;/* socket for v2 telemetry */ +static struct socket v1_socket;/* socket for v1 telemetry */ static char telemetry_log_error[1024 ];/* Will contain error on init failure */ /* list of command callbacks, with one command registered by default */ static struct cmd_callback callbacks[TELEMETRY_MAX_CALLBACKS ];
@@ -202,6 +204,8 @@ unlink_sockets(void) {if (v2_socket.path[0 ])unlink (v2_socket.path); +if (v1_socket.path[0 ]) +unlink (v1_socket.path); } static int
@@ -241,6 +245,33 @@ create_socket(char *path)return -1 ; } +static int __rte_unused /* will be used in future commit */ +telemetry_legacy_init (const char *runtime_dir) +{ +pthread_t t_old; + +if (num_legacy_callbacks ==1 ) { +snprintf (telemetry_log_error,sizeof (telemetry_log_error), +"No legacy callbacks, legacy socket not created" ); +return -1 ; + } + + v1_socket.fn = legacy_client_handler; +if ((size_t )snprintf (v1_socket.path,sizeof (v1_socket.path), +"%s/telemetry" , runtime_dir) + >=sizeof (v1_socket.path)) { +snprintf (telemetry_log_error,sizeof (telemetry_log_error), +"Error with socket binding, path too long" ); +return -1 ; + } + v1_socket.sock =create_socket (v1_socket.path); +if (v1_socket.sock <0 ) +return -1 ; +pthread_create (&t_old,NULL , socket_listener, &v1_socket); + +return 0 ; +} +static int telemetry_v2_init (const char *runtime_dir) {
lib/librte_telemetry/telemetry_legacy.c new file +226 -0
226 lines not on this page · raw message
Signature · 1 line
2.17.1
PATCH v3 13/17 telemetry: remove existing telemetry files
In reply to Ciara PowerThis patch removes the existing telemetry files, which are now redundant as the new version of telemetry has backward compatibility for their functionality.
--- lib/librte_metrics/rte_metrics_telemetry.c | 9 - lib/librte_telemetry/Makefile | 4 - lib/librte_telemetry/meson.build | 15 +- lib/librte_telemetry/rte_telemetry.c | 1384 ----------------- lib/librte_telemetry/rte_telemetry.h | 54 +- lib/librte_telemetry/rte_telemetry_internal.h | 114 -- lib/librte_telemetry/rte_telemetry_parser.c | 435 ------ lib/librte_telemetry/rte_telemetry_parser.h | 15 - .../rte_telemetry_parser_test.c | 533 ------- .../rte_telemetry_socket_tests.h | 36 - .../rte_telemetry_version.map | 6 - lib/librte_telemetry/telemetry.c | 20 +- 12 files changed, 23 insertions(+), 2602 deletions(-) delete mode 100644 lib/librte_telemetry/rte_telemetry.c delete mode 100644 lib/librte_telemetry/rte_telemetry_internal.h delete mode 100644 lib/librte_telemetry/rte_telemetry_parser.c delete mode 100644 lib/librte_telemetry/rte_telemetry_parser.h delete mode 100644 lib/librte_telemetry/rte_telemetry_parser_test.c delete mode 100644 lib/librte_telemetry/rte_telemetry_socket_tests.h
lib/librte_metrics/rte_metrics_telemetry.c +0 -9
@@ -7,7 +7,6 @@#include <rte_ethdev.h> #include <rte_string_fns.h> #ifdef RTE_LIBRTE_TELEMETRY -#include <rte_telemetry_internal.h> #include <rte_telemetry_legacy.h> #endif
@@ -527,14 +526,6 @@ handle_ports_stats_values_by_name(const char *cmd __rte_unused,RTE_INIT (metrics_ctor) {#ifdef RTE_LIBRTE_TELEMETRY -static const struct metrics_functions fns = { - .reg_all_ethdev = rte_metrics_tel_reg_all_ethdev, - .encode_json_format = rte_metrics_tel_encode_json_format, - .get_port_stats_ids = rte_metrics_tel_get_port_stats_ids, - .get_ports_stats_json = rte_metrics_tel_get_ports_stats_json, - .extract_data = rte_metrics_tel_extract_data - }; -rte_telemetry_set_metrics_fns (&fns);/* assign them to telemetry lib */ rte_telemetry_legacy_register ("ports_all_stat_values" ,DATA_NOT_REQ , handle_ports_all_stats_values); rte_telemetry_legacy_register("global_stat_values", DATA_NOT_REQ,
lib/librte_telemetry/Makefile +0 -4
@@ -15,14 +15,10 @@ CFLAGS += -pthread LDLIBS += -lrte_eal LDLIBS += -lpthread -LDLIBS += -ljansson EXPORT_MAP := rte_telemetry_version.map # library source files -SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) := rte_telemetry.c -SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += rte_telemetry_parser.c -SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += rte_telemetry_parser_test.c SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += telemetry.c SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += telemetry_legacy.c
lib/librte_telemetry/meson.build +3 -12
@@ -3,16 +3,7 @@ includes = [global_inc] -sources = files('rte_telemetry.c','rte_telemetry_parser.c', 'rte_telemetry_parser_test.c', - 'telemetry.c', 'telemetry_legacy.c') -headers = files('rte_telemetry.h', 'rte_telemetry_internal.h', 'rte_telemetry_parser.h', 'rte_telemetry_json.h') +sources = files('telemetry.c', 'telemetry_legacy.c') +headers = files('rte_telemetry.h', 'rte_telemetry_json.h') includes += include_directories('../librte_metrics') - -jansson = dependency('jansson', required: false) -if jansson.found() - ext_deps += jansson - dpdk_app_link_libraries += ['telemetry'] -else - build = false - reason = 'missing dependency "jansson"' -endif +dpdk_app_link_libraries += ['telemetry']
lib/librte_telemetry/rte_telemetry.c deleted +0 -1384
1,384 lines not on this page · raw message
lib/librte_telemetry/rte_telemetry.h +2 -52
70 lines not on this page · raw message
lib/librte_telemetry/rte_telemetry_internal.h deleted +0 -114
114 lines not on this page · raw message
lib/librte_telemetry/rte_telemetry_parser.c deleted +0 -435
435 lines not on this page · raw message
lib/librte_telemetry/rte_telemetry_parser.h deleted +0 -15
@@ -1,15 +0,0 @@ -/* SPDX-License-Identifier: BSD-3-Clause -* Copyright(c) 2018 Intel Corporation -*/ - -#include "rte_telemetry_internal.h" -#include "rte_compat.h" - -#ifndef _RTE_TELEMETRY_PARSER_H_ -#define _RTE_TELEMETRY_PARSER_H_ - -__rte_experimental -int32_t -rte_telemetry_parse (struct telemetry_impl *telemetry,char *socket_rx_data); - -#endif
lib/librte_telemetry/rte_telemetry_parser_test.c deleted +0 -533
533 lines not on this page · raw message
lib/librte_telemetry/rte_telemetry_socket_tests.h deleted +0 -36
@@ -1,36 +0,0 @@ -/* SPDX-License-Identifier: BSD-3-Clause -* Copyright(c) 2018 Intel Corporation -*/ - -#include <stdbool.h> - -#include "rte_telemetry_internal.h" - -#ifndef _RTE_TELEMETRY_SOCKET_TESTING_H_ -#define _RTE_TELEMETRY_SOCKET_TESTING_H_ - -int32_t -rte_telemetry_json_socket_message_test (struct telemetry_impl *telemetry, -int fd); - -int32_t -rte_telemetry_invalid_json_test (struct telemetry_impl *telemetry,int fd); - -int32_t -rte_telemetry_valid_json_test (struct telemetry_impl *telemetry,int fd); - -int32_t -rte_telemetry_json_contents_test (struct telemetry_impl *telemetry,int fd); - -int32_t -rte_telemetry_json_empty_test (struct telemetry_impl *telemetry,int fd); - -int32_t -rte_telemetry_socket_register_test (struct telemetry_impl *telemetry,int *fd, -int send_fd,int recv_fd); - -int32_t -rte_telemetry_socket_test_setup (struct telemetry_impl *telemetry,int *send_fd, -int *recv_fd); - -#endif
lib/librte_telemetry/rte_telemetry_version.map +0 -6
@@ -1,14 +1,8 @@ EXPERIMENTAL { global: - rte_telemetry_cleanup; rte_telemetry_init; - rte_telemetry_parse; - rte_telemetry_selftest; - rte_telemetry_set_metrics_fns; - rte_telemetry_new_init; rte_telemetry_register_cmd; - rte_telemetry_legacy_init; rte_telemetry_legacy_register; local: *;
lib/librte_telemetry/telemetry.c +18 -2
@@ -14,6 +14,7 @@#include <rte_common.h> #include <rte_spinlock.h> #include <rte_version.h> +#include <rte_option.h> #include "rte_telemetry.h" #include "rte_telemetry_legacy.h"
@@ -245,7 +246,7 @@ create_socket(char *path)return -1 ; } -static int __rte_unused /* will be used in future commit */ +static int telemetry_legacy_init (const char *runtime_dir) {pthread_t t_old;
@@ -297,7 +298,7 @@ telemetry_v2_init(const char *runtime_dir) }int32_t -rte_telemetry_new_init (void ) +rte_telemetry_init (void ) {const char *error_str;if (telemetry_v2_init (rte_eal_get_runtime_dir ()) !=0 ) {
@@ -305,5 +306,20 @@ rte_telemetry_new_init(void)printf ("Error initialising telemetry - %s" , error_str);return -1 ; } +if (telemetry_legacy_init (rte_eal_get_runtime_dir ()) !=0 ) { + error_str = telemetry_log_error; +printf ("No telemetry legacy support- %s" , error_str); + }return 0 ; } + +static struct rte_option option = { + .name ="telemetry" , + .usage ="Enable telemetry backend" , + .cb = &rte_telemetry_init, + .enabled =0 +}; + +RTE_INIT (telemetry_register_op) { +rte_option_register (&option); +}
Signature · 1 line
2.17.1
PATCH v3 14/17 lib: add telemetry as eal dependency
In reply to Ciara PowerThis patch moves telemetry further down the build, and adds it as a dependency for EAL. Telemetry V2 is now configured to build by default, and the legacy support is built when the telemetry config flag is set.
Telemetry now has EAL flags, shown below:
"--telemetry" = Enables telemetry (this is default if no flags given) "--no-telemetry" = Disables telemetry
When telemetry is enabled, it will attempt to open the new socket version, and also the legacy support socket (this will depend on Jansson external dependency and telemetry config flag, as before).
---
v2: Telemetry config flag now represents the legacy support being built,
and is disabled by default, as in the existing telemetry.
--- config/common_base | 2 +- examples/l3fwd-power/Makefile | 6 +---- examples/l3fwd-power/main.c | 8 ++----- examples/l3fwd-power/meson.build | 6 +---- lib/Makefile | 5 ++-- lib/librte_eal/common/eal_common_options.c | 9 ++++++++ lib/librte_eal/common/eal_internal_cfg.h | 1 + lib/librte_eal/common/eal_options.h | 4 ++++ lib/librte_eal/freebsd/Makefile | 1 + lib/librte_eal/freebsd/eal.c | 9 ++++++++ lib/librte_eal/freebsd/meson.build | 2 +- lib/librte_eal/linux/Makefile | 1 + lib/librte_eal/linux/eal.c | 9 ++++++++ lib/librte_eal/linux/meson.build | 2 +- lib/librte_eal/meson.build | 5 +++- lib/librte_ethdev/Makefile | 6 +---- lib/librte_ethdev/meson.build | 6 +---- lib/librte_ethdev/rte_ethdev.c | 6 ----- lib/librte_rawdev/Makefile | 6 +---- lib/librte_rawdev/meson.build | 4 +--- lib/librte_rawdev/rte_rawdev.c | 6 ----- lib/librte_telemetry/Makefile | 9 ++++---- lib/librte_telemetry/meson.build | 1 - lib/librte_telemetry/rte_telemetry.h | 3 ++- lib/librte_telemetry/telemetry.c | 27 ++++++---------------- lib/meson.build | 2 +- mk/rte.app.mk | 5 +++- 27 files changed, 69 insertions(+), 82 deletions(-)
config/common_base +1 -1
@@ -916,7 +916,7 @@ CONFIG_RTE_LIBRTE_BITRATE=y CONFIG_RTE_LIBRTE_LATENCY_STATS=y # -# Compile librte_telemetry +# Compile librte_telemetry legacy support # CONFIG_RTE_LIBRTE_TELEMETRY=n
examples/l3fwd-power/Makefile +1 -5
@@ -60,7 +60,7 @@ else CFLAGS += -DALLOW_EXPERIMENTAL_API CFLAGS += -O3 CFLAGS += $(WERROR_FLAGS) -LDLIBS += -lm +LDLIBS += -lm -lrte_telemetry # workaround for a gcc bug with noreturn attribute # http://gcc.gnu.org/bugzilla/show_bug.cgi?id=12603
@@ -68,10 +68,6 @@ ifeq ($(CONFIG_RTE_TOOLCHAIN_GCC),y) CFLAGS_main.o += -Wno-return-type endif -ifeq ($(CONFIG_RTE_LIBRTE_TELEMETRY),y) -LDLIBS += -lrte_telemetry -endif - include $(RTE_SDK)/mk/rte.extapp.mk endif endif
examples/l3fwd-power/main.c +2 -6
@@ -46,9 +46,7 @@#include <rte_spinlock.h> #include <rte_power_empty_poll.h> #include <rte_metrics.h> -#ifdef RTE_LIBRTE_TELEMETRY #include <rte_telemetry.h> -#endif #include "perf_core.h" #include "main.h"
@@ -2123,7 +2121,7 @@ update_telemetry(__rte_unused struct rte_timer *tim,if (ret <0 )RTE_LOG (WARNING ,POWER ,"failed to update metrcis\n" ); } -#ifdef RTE_LIBRTE_TELEMETRY + static int handle_app_stats(const char *cmd __rte_unused, const char *params __rte_unused,
@@ -2141,7 +2139,7 @@ handle_app_stats(const char *cmd __rte_unused,return used; } -#endif +static void telemetry_setup_timer (void ) {
@@ -2541,10 +2539,8 @@ main(int argc, char **argv)rte_spinlock_init (&stats[lcore_id].telemetry_lock); }rte_timer_init (&telemetry_timer); -#ifdef RTE_LIBRTE_TELEMETRY rte_telemetry_register_cmd ("/l3fwd-power/stats" , handle_app_stats); -#endif rte_eal_mp_remote_launch (main_telemetry_loop,NULL ,SKIP_MASTER ); }
examples/l3fwd-power/meson.build +1 -5
@@ -12,11 +12,7 @@ if not dpdk_conf.has('RTE_LIBRTE_POWER') endif allow_experimental_apis = true -deps += ['power', 'timer', 'lpm', 'hash', 'metrics'] +deps += ['power', 'timer', 'lpm', 'hash', 'metrics', 'telemetry'] sources = files( 'main.c', 'perf_core.c' ) - -if dpdk_conf.has('RTE_LIBRTE_TELEMETRY') - deps += ['telemetry'] -endif
lib/Makefile +2 -3
@@ -4,8 +4,9 @@ include $(RTE_SDK)/mk/rte.vars.mk DIRS-$(CONFIG_RTE_LIBRTE_KVARGS) += librte_kvargs +DIRS-y += librte_telemetry DIRS-$(CONFIG_RTE_LIBRTE_EAL) += librte_eal -DEPDIRS-librte_eal := librte_kvargs +DEPDIRS-librte_eal := librte_kvargs librte_telemetry DIRS-$(CONFIG_RTE_LIBRTE_PCI) += librte_pci DEPDIRS-librte_pci := librte_eal DIRS-$(CONFIG_RTE_LIBRTE_RING) += librte_ring
@@ -22,8 +23,6 @@ DIRS-$(CONFIG_RTE_LIBRTE_CFGFILE) += librte_cfgfile DEPDIRS-librte_cfgfile := librte_eal DIRS-$(CONFIG_RTE_LIBRTE_CMDLINE) += librte_cmdline DEPDIRS-librte_cmdline := librte_eal librte_net -DIRS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += librte_telemetry -DEPDIRS-librte_telemetry := librte_eal DIRS-$(CONFIG_RTE_LIBRTE_ETHER) += librte_ethdev DEPDIRS-librte_ethdev := librte_net librte_eal librte_mempool librte_ring DEPDIRS-librte_ethdev += librte_mbuf
lib/librte_eal/common/eal_common_options.c +9 -0
@@ -86,6 +86,8 @@ eal_long_options[] = { {OPT_LEGACY_MEM, 0, NULL, OPT_LEGACY_MEM_NUM }, {OPT_SINGLE_FILE_SEGMENTS, 0, NULL, OPT_SINGLE_FILE_SEGMENTS_NUM}, {OPT_MATCH_ALLOCATIONS, 0, NULL, OPT_MATCH_ALLOCATIONS_NUM}, + {OPT_TELEMETRY, 0, NULL, OPT_TELEMETRY_NUM }, + {OPT_NO_TELEMETRY, 0, NULL, OPT_NO_TELEMETRY_NUM }, {0, 0, NULL, 0 } };
@@ -1455,6 +1457,11 @@ eal_parse_common_option(int opt, const char *optarg,return -1 ; }break ; +case OPT_TELEMETRY_NUM : +break ; +case OPT_NO_TELEMETRY_NUM : + conf->no_telemetry =1 ; +break ;/* don't know what to do, leave this to caller */ default :
@@ -1698,6 +1705,8 @@ eal_common_usage(void)" --" OPT_IN_MEMORY " Operate entirely in memory. This will\n" " disable secondary process support\n" " --" OPT_BASE_VIRTADDR " Base virtual address\n" +" --" OPT_TELEMETRY " Enable telemetry support (on by default)\n" +" --" OPT_NO_TELEMETRY " Disable telemetry support\n" "\nEAL options for DEBUG use only:\n" " --" OPT_HUGE_UNLINK " Unlink hugepage files after init\n" " --" OPT_NO_HUGE " Use malloc instead of hugetlbfs\n"
lib/librte_eal/common/eal_internal_cfg.h +1 -0
@@ -82,6 +82,7 @@ struct internal_config {rte_cpuset_t ctrl_cpuset;/**< cpuset for ctrl threads */ volatile unsigned int init_complete;/**< indicates whether EAL has completed initialization */ +unsigned int no_telemetry;/**< true to disable Telemetry */ };extern struct internal_config internal_config;/**< Global EAL configuration. */
lib/librte_eal/common/eal_options.h +4 -0
@@ -69,6 +69,10 @@ enum {OPT_IOVA_MODE_NUM , #define OPT_MATCH_ALLOCATIONS "match-allocations"OPT_MATCH_ALLOCATIONS_NUM , +#define OPT_TELEMETRY "telemetry" +OPT_TELEMETRY_NUM , +#define OPT_NO_TELEMETRY "no-telemetry" +OPT_NO_TELEMETRY_NUM , OPT_LONG_MAX_NUM };
lib/librte_eal/freebsd/Makefile +1 -0
@@ -18,6 +18,7 @@ LDLIBS += -lexecinfo LDLIBS += -lpthread LDLIBS += -lgcc_s LDLIBS += -lrte_kvargs +LDLIBS += -lrte_telemetry EXPORT_MAP := ../rte_eal_version.map
lib/librte_eal/freebsd/eal.c +9 -0
@@ -44,6 +44,7 @@#include <rte_option.h> #include <rte_atomic.h> #include <malloc_heap.h> +#include <rte_telemetry.h> #include "eal_private.h" #include "eal_thread.h"
@@ -952,6 +953,14 @@ rte_eal_init(int argc, char **argv)rte_eal_init_alert ("Cannot clear runtime directory\n" );return -1 ; } +if (!internal_config.no_telemetry) { +const char *error_str; +if (rte_telemetry_init (rte_eal_get_runtime_dir (), + &error_str) !=0 ) { +rte_eal_init_alert (error_str); +return -1 ; + } + }eal_mcfg_complete ();
lib/librte_eal/freebsd/meson.build +1 -1
@@ -18,4 +18,4 @@ sources += files( 'eal_timer.c', ) -deps += ['kvargs'] +deps += ['kvargs', 'telemetry']
lib/librte_eal/linux/Makefile +1 -0
@@ -19,6 +19,7 @@ LDLIBS += -lpthread LDLIBS += -lgcc_s LDLIBS += -lrt LDLIBS += -lrte_kvargs +LDLIBS += -lrte_telemetry ifeq ($(CONFIG_RTE_EAL_NUMA_AWARE_HUGEPAGES),y) LDLIBS += -lnuma endif
lib/librte_eal/linux/eal.c +9 -0
@@ -51,6 +51,7 @@#include <malloc_heap.h> #include <rte_vfio.h> #include <rte_option.h> +#include <rte_telemetry.h> #include "eal_private.h" #include "eal_thread.h"
@@ -1291,6 +1292,14 @@ rte_eal_init(int argc, char **argv)rte_eal_init_alert ("Cannot clear runtime directory\n" );return -1 ; } +if (!internal_config.no_telemetry) { +const char *error_str; +if (rte_telemetry_init (rte_eal_get_runtime_dir (), + &error_str) !=0 ) { +rte_eal_init_alert (error_str); +return -1 ; + } + }eal_mcfg_complete ();
lib/librte_eal/linux/meson.build +1 -1
@@ -21,7 +21,7 @@ sources += files( 'eal_vfio_mp_sync.c', ) -deps += ['kvargs'] +deps += ['kvargs', 'telemetry'] if has_libnuma == 1 dpdk_conf.set10('RTE_EAL_NUMA_AWARE_HUGEPAGES', true) endif
lib/librte_eal/meson.build +4 -1
@@ -11,7 +11,10 @@ subdir(exec_env) subdir(arch_subdir) -deps += 'kvargs' +deps += ['kvargs'] +if not is_windows + deps += ['telemetry'] +endif if dpdk_conf.has('RTE_USE_LIBBSD') ext_deps += libbsd endif
lib/librte_ethdev/Makefile +1 -5
@@ -11,7 +11,7 @@ LIB = librte_ethdev.a CFLAGS += -O3 CFLAGS += $(WERROR_FLAGS) LDLIBS += -lrte_net -lrte_eal -lrte_mempool -lrte_ring -LDLIBS += -lrte_mbuf -lrte_kvargs -lrte_meter +LDLIBS += -lrte_mbuf -lrte_kvargs -lrte_meter -lrte_telemetry EXPORT_MAP := rte_ethdev_version.map
@@ -23,10 +23,6 @@ SRCS-y += rte_tm.c SRCS-y += rte_mtr.c SRCS-y += ethdev_profile.c -ifeq ($(CONFIG_RTE_LIBRTE_TELEMETRY),y) -LDLIBS += -lrte_telemetry -endif - # # Export include files #
lib/librte_ethdev/meson.build +1 -5
@@ -24,8 +24,4 @@ headers = files('rte_ethdev.h', 'rte_tm.h', 'rte_tm_driver.h') -deps += ['net', 'kvargs', 'meter'] - -if dpdk_conf.has('RTE_LIBRTE_TELEMETRY') - deps += ['telemetry'] -endif +deps += ['net', 'kvargs', 'meter', 'telemetry']
lib/librte_ethdev/rte_ethdev.c +0 -6
@@ -38,9 +38,7 @@#include <rte_kvargs.h> #include <rte_class.h> #include <rte_ether.h> -#ifdef RTE_LIBRTE_TELEMETRY #include <rte_telemetry.h> -#endif #include "rte_ethdev.h" #include "rte_ethdev_driver.h"
@@ -5192,7 +5190,6 @@ rte_eth_devargs_parse(const char *dargs, struct rte_eth_devargs *eth_da)return result; } -#ifdef RTE_LIBRTE_TELEMETRY static int handle_port_list(const char *cmd __rte_unused, const char *params __rte_unused,
@@ -5286,17 +5283,14 @@ handle_port_link_status(const char *cmd __rte_unused,return ret >= buf_len ?-1 : ret; } -#endif RTE_INIT (ethdev_init_log) { rte_eth_dev_logtype =rte_log_register ("lib.ethdev" );if (rte_eth_dev_logtype >=0 )rte_log_set_level (rte_eth_dev_logtype,RTE_LOG_INFO ); -#ifdef RTE_LIBRTE_TELEMETRY rte_telemetry_register_cmd ("/ethdev/list" , handle_port_list);rte_telemetry_register_cmd ("/ethdev/xstats" , handle_port_xstats);rte_telemetry_register_cmd ("/ethdev/link_status" , handle_port_link_status); -#endif }
lib/librte_rawdev/Makefile +1 -5
@@ -9,11 +9,7 @@ LIB = librte_rawdev.a # build flags CFLAGS += -O3 CFLAGS += $(WERROR_FLAGS) -LDLIBS += -lrte_eal - -ifeq ($(CONFIG_RTE_LIBRTE_TELEMETRY),y) -LDLIBS += -lrte_telemetry -endif +LDLIBS += -lrte_eal -lrte_telemetry # library source files SRCS-y += rte_rawdev.c
lib/librte_rawdev/meson.build +1 -3
@@ -4,6 +4,4 @@ sources = files('rte_rawdev.c') headers = files('rte_rawdev.h', 'rte_rawdev_pmd.h') -if dpdk_conf.has('RTE_LIBRTE_TELEMETRY') - deps += ['telemetry'] -endif +deps += ['telemetry']
lib/librte_rawdev/rte_rawdev.c +0 -6
@@ -29,9 +29,7 @@#include <rte_common.h> #include <rte_malloc.h> #include <rte_errno.h> -#ifdef RTE_LIBRTE_TELEMETRY #include <rte_telemetry.h> -#endif #include "rte_rawdev.h" #include "rte_rawdev_pmd.h"
@@ -547,7 +545,6 @@ rte_rawdev_pmd_release(struct rte_rawdev *rawdev)return 0 ; } -#ifdef RTE_LIBRTE_TELEMETRY static int handle_dev_list(const char *cmd __rte_unused, const char *params __rte_unused,
@@ -619,15 +616,12 @@ handle_dev_xstats(const char *cmd __rte_unused,free (rawdev_xstats);return used; } -#endif RTE_INIT (librawdev_init_log) { librawdev_logtype =rte_log_register ("lib.rawdev" );if (librawdev_logtype >=0 )rte_log_set_level (librawdev_logtype,RTE_LOG_INFO ); -#ifdef RTE_LIBRTE_TELEMETRY rte_telemetry_register_cmd ("/rawdev/list" , handle_dev_list);rte_telemetry_register_cmd ("/rawdev/xstats" , handle_dev_xstats); -#endif }
lib/librte_telemetry/Makefile +4 -5
@@ -13,17 +13,16 @@ CFLAGS += -I$(RTE_SDK)/lib/librte_eal/include CFLAGS += -I$(RTE_SDK)/lib/librte_eal/$(ARCH_DIR)/include CFLAGS += -pthread -LDLIBS += -lrte_eal LDLIBS += -lpthread EXPORT_MAP := rte_telemetry_version.map # library source files -SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += telemetry.c -SRCS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += telemetry_legacy.c +SRCS-y += telemetry.c +SRCS-y += telemetry_legacy.c # export include files -SYMLINK-$(CONFIG_RTE_LIBRTE_TELEMETRY)-include := rte_telemetry.h -SYMLINK-$(CONFIG_RTE_LIBRTE_TELEMETRY)-include += rte_telemetry_json.h +SYMLINK-y-include := rte_telemetry.h +SYMLINK-y-include += rte_telemetry_json.h include $(RTE_SDK)/mk/rte.lib.mk
lib/librte_telemetry/meson.build +0 -1
@@ -6,4 +6,3 @@ includes = [global_inc] sources = files('telemetry.c', 'telemetry_legacy.c') headers = files('rte_telemetry.h', 'rte_telemetry_json.h') includes += include_directories('../librte_metrics') -dpdk_app_link_libraries += ['telemetry']
lib/librte_telemetry/rte_telemetry.h +2 -1
@@ -86,5 +86,6 @@ rte_telemetry_register_cmd(const char *cmd, telemetry_cb fn);*/ __rte_experimental int -rte_telemetry_init (void ); +rte_telemetry_init (const char *runtime_dir,const char **err_str); +#endif
lib/librte_telemetry/telemetry.c +7 -20
@@ -14,7 +14,6 @@#include <rte_common.h> #include <rte_spinlock.h> #include <rte_version.h> -#include <rte_option.h> #include "rte_telemetry.h" #include "rte_telemetry_legacy.h"
@@ -298,28 +297,16 @@ telemetry_v2_init(const char *runtime_dir) }int32_t -rte_telemetry_init (void ) +rte_telemetry_init (const char *runtime_dir,const char **err_str) { -const char *error_str; -if (telemetry_v2_init (rte_eal_get_runtime_dir ()) !=0 ) { - error_str = telemetry_log_error; -printf ("Error initialising telemetry - %s" , error_str); +if (telemetry_v2_init (runtime_dir) !=0 ) { + *err_str = telemetry_log_error; +printf ("Error initialising telemetry - %s" , *err_str);return -1 ; } -if (telemetry_legacy_init (rte_eal_get_runtime_dir ()) !=0 ) { - error_str = telemetry_log_error; -printf ("No telemetry legacy support- %s" , error_str); +if (telemetry_legacy_init (runtime_dir) !=0 ) { + *err_str = telemetry_log_error; +printf ("No telemetry legacy support- %s" , *err_str); }return 0 ; } - -static struct rte_option option = { - .name ="telemetry" , - .usage ="Enable telemetry backend" , - .cb = &rte_telemetry_init, - .enabled =0 -}; - -RTE_INIT (telemetry_register_op) { -rte_option_register (&option); -}
lib/meson.build +1 -1
@@ -10,8 +10,8 @@ # core libs which are widely reused, so their deps are kept to a minimum. libraries = [ 'kvargs', # eal depends on kvargs + 'telemetry', # basic info querying capability about dpdk processes 'eal', # everything depends on eal - 'telemetry', 'ring', 'mempool', 'mbuf', 'net', 'meter', 'ethdev', 'pci', # core 'cmdline', 'metrics', # bitrate/latency stats depends on this
mk/rte.app.mk +4 -1
@@ -52,6 +52,9 @@ _LDLIBS-$(CONFIG_RTE_LIBRTE_ACL) += -lrte_acl _LDLIBS-$(CONFIG_RTE_LIBRTE_JOBSTATS) += -lrte_jobstats _LDLIBS-$(CONFIG_RTE_LIBRTE_METRICS) += --whole-archive _LDLIBS-$(CONFIG_RTE_LIBRTE_METRICS) += -lrte_metrics +ifeq ($(CONFIG_RTE_LIBRTE_TELEMETRY),y) +_LDLIBS-$(CONFIG_RTE_LIBRTE_METRICS) += -ljansson +endif _LDLIBS-$(CONFIG_RTE_LIBRTE_METRICS) += --no-whole-archive _LDLIBS-$(CONFIG_RTE_LIBRTE_BITRATE) += -lrte_bitratestats _LDLIBS-$(CONFIG_RTE_LIBRTE_LATENCY_STATS) += -lrte_latencystats
@@ -74,6 +77,7 @@ _LDLIBS-$(CONFIG_RTE_LIBRTE_HASH) += -lrte_hash _LDLIBS-$(CONFIG_RTE_LIBRTE_MEMBER) += -lrte_member _LDLIBS-$(CONFIG_RTE_LIBRTE_VHOST) += -lrte_vhost _LDLIBS-$(CONFIG_RTE_LIBRTE_KVARGS) += -lrte_kvargs +_LDLIBS-y += -lrte_telemetry _LDLIBS-$(CONFIG_RTE_LIBRTE_MBUF) += -lrte_mbuf _LDLIBS-$(CONFIG_RTE_LIBRTE_NET) += -lrte_net _LDLIBS-$(CONFIG_RTE_LIBRTE_ETHER) += -lrte_ethdev
@@ -90,7 +94,6 @@ _LDLIBS-$(CONFIG_RTE_DRIVER_MEMPOOL_RING) += -lrte_mempool_ring _LDLIBS-$(CONFIG_RTE_LIBRTE_OCTEONTX2_MEMPOOL) += -lrte_mempool_octeontx2 _LDLIBS-$(CONFIG_RTE_LIBRTE_RING) += -lrte_ring _LDLIBS-$(CONFIG_RTE_LIBRTE_PCI) += -lrte_pci -_LDLIBS-$(CONFIG_RTE_LIBRTE_TELEMETRY) += -lrte_telemetry -ljansson _LDLIBS-$(CONFIG_RTE_LIBRTE_EAL) += -lrte_eal _LDLIBS-$(CONFIG_RTE_LIBRTE_CMDLINE) += -lrte_cmdline _LDLIBS-$(CONFIG_RTE_LIBRTE_REORDER) += -lrte_reorder
Signature · 1 line
2.17.1
PATCH v3 15/17 eal: remove rte-option infrastructure
In reply to Ciara PowerAs Telemetry no longer uses rte_option, and was the only user of this infrastructure, it can now be removed.
--- lib/librte_eal/common/eal_common_options.c | 1 - lib/librte_eal/common/eal_private.h | 28 ------- lib/librte_eal/common/meson.build | 2 - lib/librte_eal/common/rte_option.c | 95 ---------------------- lib/librte_eal/freebsd/Makefile | 1 - lib/librte_eal/freebsd/eal.c | 14 +--- lib/librte_eal/include/meson.build | 1 - lib/librte_eal/include/rte_option.h | 72 ---------------- lib/librte_eal/linux/Makefile | 1 - lib/librte_eal/linux/eal.c | 14 +--- lib/librte_eal/rte_eal_version.map | 1 - 11 files changed, 2 insertions(+), 228 deletions(-) delete mode 100644 lib/librte_eal/common/rte_option.c delete mode 100644 lib/librte_eal/include/rte_option.h
lib/librte_eal/common/eal_common_options.c +0 -1
@@ -1714,5 +1714,4 @@ eal_common_usage(void)" --" OPT_NO_HPET " Disable HPET\n" " --" OPT_NO_SHCONF " No shared config (mmap'd files)\n" "\n", RTE_MAX_LCORE); -rte_option_usage (); }
lib/librte_eal/common/eal_private.h +0 -28
@@ -409,34 +409,6 @@ dev_sigbus_handler_register(void);int dev_sigbus_handler_unregister (void ); -/** -* Check if the option is registered. -* -* @param option -* The option to be parsed. -* -* @return -* 0 on success -* @return -* -1 on fail -*/ -int -rte_option_parse (const char *opt); - -/** -* Iterate through the registered options and execute the associated -* callback if enabled. -*/ -void -rte_option_init (void ); - -/** -* Iterate through the registered options and show the associated -* usage string. -*/ -void -rte_option_usage (void ); -/** * Get OS-specific EAL mapping base address. */
lib/librte_eal/common/meson.build +0 -2
@@ -14,7 +14,6 @@ if is_windows 'eal_common_log.c', 'eal_common_options.c', 'eal_common_thread.c', - 'rte_option.c', ) subdir_done() endif
@@ -49,7 +48,6 @@ sources += files( 'malloc_mp.c', 'rte_keepalive.c', 'rte_malloc.c', - 'rte_option.c', 'rte_random.c', 'rte_reciprocal.c', 'rte_service.c',
lib/librte_eal/common/rte_option.c deleted +0 -95
95 lines not on this page · raw message
lib/librte_eal/freebsd/Makefile +0 -1
@@ -66,7 +66,6 @@ SRCS-$(CONFIG_RTE_EXEC_ENV_FREEBSD) += malloc_elem.c SRCS-$(CONFIG_RTE_EXEC_ENV_FREEBSD) += malloc_heap.c SRCS-$(CONFIG_RTE_EXEC_ENV_FREEBSD) += malloc_mp.c SRCS-$(CONFIG_RTE_EXEC_ENV_FREEBSD) += rte_keepalive.c -SRCS-$(CONFIG_RTE_EXEC_ENV_FREEBSD) += rte_option.c SRCS-$(CONFIG_RTE_EXEC_ENV_FREEBSD) += rte_service.c SRCS-$(CONFIG_RTE_EXEC_ENV_FREEBSD) += rte_random.c SRCS-$(CONFIG_RTE_EXEC_ENV_FREEBSD) += rte_reciprocal.c
lib/librte_eal/freebsd/eal.c +1 -13
@@ -41,7 +41,6 @@#include <rte_devargs.h> #include <rte_version.h> #include <rte_vfio.h> -#include <rte_option.h> #include <rte_atomic.h> #include <malloc_heap.h> #include <rte_telemetry.h>
@@ -536,20 +535,12 @@ eal_parse_args(int argc, char **argv) argvopt = argv; optind =1 ; optreset =1 ; - opterr =0 ;while ((opt =getopt_long (argc, argvopt, eal_short_options, eal_long_options, &option_index)) !=EOF ) { -/* -* getopt didn't recognise the option, lets parse the -* registered options to see if the flag is valid -*/ +/* getopt didn't recognise the option */ if (opt =='?' ) { - ret =rte_option_parse (argv[optind-1 ]); -if (ret ==0 ) -continue ; -eal_usage (prgname); ret =-1 ; goto out;
@@ -964,9 +955,6 @@ rte_eal_init(int argc, char **argv)eal_mcfg_complete (); -/* Call each registered callback, if enabled */ -rte_option_init (); -return fctret; }
lib/librte_eal/include/meson.build +0 -1
@@ -29,7 +29,6 @@ headers += files( 'rte_malloc.h', 'rte_memory.h', 'rte_memzone.h', - 'rte_option.h', 'rte_pci_dev_feature_defs.h', 'rte_pci_dev_features.h', 'rte_per_lcore.h',
lib/librte_eal/include/rte_option.h deleted +0 -72
72 lines not on this page · raw message
lib/librte_eal/linux/Makefile +0 -1
@@ -73,7 +73,6 @@ SRCS-$(CONFIG_RTE_EXEC_ENV_LINUX) += malloc_elem.c SRCS-$(CONFIG_RTE_EXEC_ENV_LINUX) += malloc_heap.c SRCS-$(CONFIG_RTE_EXEC_ENV_LINUX) += malloc_mp.c SRCS-$(CONFIG_RTE_EXEC_ENV_LINUX) += rte_keepalive.c -SRCS-$(CONFIG_RTE_EXEC_ENV_LINUX) += rte_option.c SRCS-$(CONFIG_RTE_EXEC_ENV_LINUX) += rte_service.c SRCS-$(CONFIG_RTE_EXEC_ENV_LINUX) += rte_random.c SRCS-$(CONFIG_RTE_EXEC_ENV_LINUX) += rte_reciprocal.c
lib/librte_eal/linux/eal.c +1 -13
@@ -50,7 +50,6 @@#include <rte_atomic.h> #include <malloc_heap.h> #include <rte_vfio.h> -#include <rte_option.h> #include <rte_telemetry.h> #include "eal_private.h"
@@ -700,20 +699,12 @@ eal_parse_args(int argc, char **argv) argvopt = argv; optind =1 ; - opterr =0 ;while ((opt =getopt_long (argc, argvopt, eal_short_options, eal_long_options, &option_index)) !=EOF ) { -/* -* getopt didn't recognise the option, lets parse the -* registered options to see if the flag is valid -*/ +/* getopt didn't recognise the option */ if (opt =='?' ) { - ret =rte_option_parse (argv[optind-1 ]); -if (ret ==0 ) -continue ; -eal_usage (prgname); ret =-1 ; goto out;
@@ -1303,9 +1294,6 @@ rte_eal_init(int argc, char **argv)eal_mcfg_complete (); -/* Call each registered callback, if enabled */ -rte_option_init (); -return fctret; }
lib/librte_eal/rte_eal_version.map +0 -1
@@ -303,7 +303,6 @@ EXPERIMENTAL { rte_memseg_get_fd_offset; rte_memseg_get_fd_offset_thread_unsafe; rte_memseg_get_fd_thread_unsafe; - rte_option_register; # added in 19.02 rte_extmem_attach;
Signature · 1 line
2.17.1