From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga05.intel.com (mga05.intel.com [192.55.52.43]) by dpdk.org (Postfix) with ESMTP id 62CE23772 for ; Fri, 28 Oct 2016 03:04:36 +0200 (CEST) Received: from orsmga005.jf.intel.com ([10.7.209.41]) by fmsmga105.fm.intel.com with ESMTP; 27 Oct 2016 18:04:35 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.31,406,1473145200"; d="scan'208";a="24653963" Received: from rhorton-mobl.ger.corp.intel.com (HELO VM.sh.intel.com) ([10.239.204.237]) by orsmga005.jf.intel.com with ESMTP; 27 Oct 2016 18:04:35 -0700 From: Remy Horton To: dev@dpdk.org Date: Fri, 28 Oct 2016 09:04:30 +0800 Message-Id: <1477616671-9547-3-git-send-email-remy.horton@intel.com> X-Mailer: git-send-email 2.5.5 In-Reply-To: <1477616671-9547-1-git-send-email-remy.horton@intel.com> References: <1477616671-9547-1-git-send-email-remy.horton@intel.com> Subject: [dpdk-dev] [RFC PATCH v2 2/3] lib: add bitrate statistics library X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 28 Oct 2016 01:04:37 -0000 This patch adds a library that calculates peak and average data-rate statistics. For ethernet devices. These statistics are reported using the metrics library. Signed-off-by: Remy Horton --- config/common_base | 5 + doc/api/doxy-api-index.md | 1 + doc/api/doxy-api.conf | 1 + lib/Makefile | 1 + lib/librte_bitratestats/Makefile | 53 +++++++++ lib/librte_bitratestats/rte_bitrate.c | 126 +++++++++++++++++++++ lib/librte_bitratestats/rte_bitrate.h | 80 +++++++++++++ .../rte_bitratestats_version.map | 9 ++ lib/librte_metrics/rte_metrics.c | 22 ++-- lib/librte_metrics/rte_metrics.h | 4 +- mk/rte.app.mk | 1 + 11 files changed, 291 insertions(+), 12 deletions(-) create mode 100644 lib/librte_bitratestats/Makefile create mode 100644 lib/librte_bitratestats/rte_bitrate.c create mode 100644 lib/librte_bitratestats/rte_bitrate.h create mode 100644 lib/librte_bitratestats/rte_bitratestats_version.map diff --git a/config/common_base b/config/common_base index c23a632..e778c00 100644 --- a/config/common_base +++ b/config/common_base @@ -597,3 +597,8 @@ CONFIG_RTE_TEST_PMD_RECORD_BURST_STATS=n # Compile the device metrics library # CONFIG_RTE_LIBRTE_METRICS=y + +# +# Compile the bitrate statistics library +# +CONFIG_RTE_LIBRTE_BITRATE=y diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md index ca50fa6..91e8ea6 100644 --- a/doc/api/doxy-api-index.md +++ b/doc/api/doxy-api-index.md @@ -148,4 +148,5 @@ There are many libraries, so their headers may be grouped by topics: [ABI compat] (@ref rte_compat.h), [keepalive] (@ref rte_keepalive.h), [Device Metrics] (@ref rte_metrics.h), + [Bitrate Statistics] (@ref rte_bitrate.h), [version] (@ref rte_version.h) diff --git a/doc/api/doxy-api.conf b/doc/api/doxy-api.conf index fe830eb..8765ddd 100644 --- a/doc/api/doxy-api.conf +++ b/doc/api/doxy-api.conf @@ -58,6 +58,7 @@ INPUT = doc/api/doxy-api-index.md \ lib/librte_ring \ lib/librte_sched \ lib/librte_metrics \ + lib/librte_bitratestats \ lib/librte_table \ lib/librte_timer \ lib/librte_vhost diff --git a/lib/Makefile b/lib/Makefile index 5d85dcf..e211bc0 100644 --- a/lib/Makefile +++ b/lib/Makefile @@ -59,6 +59,7 @@ DIRS-$(CONFIG_RTE_LIBRTE_PIPELINE) += librte_pipeline DIRS-$(CONFIG_RTE_LIBRTE_REORDER) += librte_reorder DIRS-$(CONFIG_RTE_LIBRTE_PDUMP) += librte_pdump DIRS-$(CONFIG_RTE_LIBRTE_METRICS) += librte_metrics +DIRS-$(CONFIG_RTE_LIBRTE_BITRATE) += librte_bitratestats ifeq ($(CONFIG_RTE_EXEC_ENV_LINUXAPP),y) DIRS-$(CONFIG_RTE_LIBRTE_KNI) += librte_kni diff --git a/lib/librte_bitratestats/Makefile b/lib/librte_bitratestats/Makefile new file mode 100644 index 0000000..b725d4e --- /dev/null +++ b/lib/librte_bitratestats/Makefile @@ -0,0 +1,53 @@ +# BSD LICENSE +# +# Copyright(c) 2016 Intel Corporation. All rights reserved. +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# +# * Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# * Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in +# the documentation and/or other materials provided with the +# distribution. +# * Neither the name of Intel Corporation nor the names of its +# contributors may be used to endorse or promote products derived +# from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +include $(RTE_SDK)/mk/rte.vars.mk + +# library name +LIB = librte_bitratestats.a + +CFLAGS += $(WERROR_FLAGS) -I$(SRCDIR) + +EXPORT_MAP := rte_bitratestats_version.map + +LIBABIVER := 1 + +# all source are stored in SRCS-y +SRCS-$(CONFIG_RTE_LIBRTE_BITRATE) := rte_bitrate.c + +# Install header file +SYMLINK-$(CONFIG_RTE_LIBRTE_BITRATE)-include += rte_bitrate.h + +DEPDIRS-$(CONFIG_RTE_LIBRTE_BITRATE) += lib/librte_eal +DEPDIRS-$(CONFIG_RTE_LIBRTE_BITRATE) += lib/librte_ether +DEPDIRS-$(CONFIG_RTE_LIBRTE_BITRATE) += lib/librte_metrics + +include $(RTE_SDK)/mk/rte.lib.mk diff --git a/lib/librte_bitratestats/rte_bitrate.c b/lib/librte_bitratestats/rte_bitrate.c new file mode 100644 index 0000000..fcdf401 --- /dev/null +++ b/lib/librte_bitratestats/rte_bitrate.c @@ -0,0 +1,126 @@ +/*- + * BSD LICENSE + * + * Copyright(c) 2016 Intel Corporation. All rights reserved. + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * * Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * * Neither the name of Intel Corporation nor the names of its + * contributors may be used to endorse or promote products derived + * from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +#include +#include +#include +#include +#include + + +struct rte_stats_bitrate_s { + uint64_t last_ibytes; + uint64_t last_obytes; + uint64_t peak_ibits; + uint64_t peak_obits; + uint64_t ewma_ibits; + uint64_t ewma_obits; +}; + +struct rte_stats_bitrates_s { + struct rte_stats_bitrate_s port_stats[RTE_MAX_ETHPORTS]; + uint16_t id_stats_set; +}; + + +struct rte_stats_bitrates_s *rte_stats_bitrate_create(void) +{ + return rte_zmalloc(NULL, sizeof(struct rte_stats_bitrates_s), 0); +} + + +int +rte_stats_bitrate_reg(struct rte_stats_bitrates_s *bitrate_data) +{ + const char *names[] = { + "mean_bits_in", "mean_bits_out", + "peak_bits_in", "peak_bits_out", + }; + int return_value; + + bitrate_data = rte_stats_bitrate_create(); + if (bitrate_data == NULL) + rte_exit(EXIT_FAILURE, "Could not allocate bitrate data.\n"); + return_value = rte_metrics_reg_metrics(&names[0], 4); + if (return_value >= 0) + bitrate_data->id_stats_set = return_value; + return return_value; +} + + +int +rte_stats_bitrate_calc(struct rte_stats_bitrates_s *bitrate_data, + uint8_t port_id) +{ + struct rte_stats_bitrate_s *port_data; + struct rte_eth_stats eth_stats; + int ret_code; + uint64_t cnt_bits; + int64_t delta; + const int64_t alpha_percent = 20; + uint64_t values[4]; + + ret_code = rte_eth_stats_get(port_id, ð_stats); + if (ret_code != 0) + return ret_code; + + port_data = &bitrate_data->port_stats[port_id]; + + /* Incoming */ + cnt_bits = (eth_stats.ibytes - port_data->last_ibytes) << 3; + port_data->last_ibytes = eth_stats.ibytes; + if (cnt_bits > port_data->peak_ibits) + port_data->peak_ibits = cnt_bits; + delta = cnt_bits; + delta -= port_data->ewma_ibits; + delta = (delta * alpha_percent) / 100; + port_data->ewma_ibits += delta; + + /* Outgoing */ + cnt_bits = (eth_stats.obytes - port_data->last_obytes) << 3; + port_data->last_obytes = eth_stats.obytes; + if (cnt_bits > port_data->peak_obits) + port_data->peak_obits = cnt_bits; + delta = cnt_bits; + delta -= port_data->ewma_obits; + delta = (delta * alpha_percent) / 100; + port_data->ewma_obits += delta; + + values[0] = port_data->ewma_ibits; + values[1] = port_data->ewma_obits; + values[2] = port_data->peak_ibits; + values[3] = port_data->peak_obits; + rte_metrics_update_metrics(port_id, bitrate_data->id_stats_set, + values, 4); + return 0; +} diff --git a/lib/librte_bitratestats/rte_bitrate.h b/lib/librte_bitratestats/rte_bitrate.h new file mode 100644 index 0000000..cd566d6 --- /dev/null +++ b/lib/librte_bitratestats/rte_bitrate.h @@ -0,0 +1,80 @@ +/*- + * BSD LICENSE + * + * Copyright(c) 2016 Intel Corporation. All rights reserved. + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * * Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * * Neither the name of Intel Corporation nor the names of its + * contributors may be used to endorse or promote products derived + * from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + + + +/** + * Bitrate statistics data structure + */ +struct rte_stats_bitrates_s; + + +/** + * Allocate a bitrate statistics structure + * + * @return + * - Pointer to structure on success + * - NULL on error (zmalloc failure) + */ +struct rte_stats_bitrates_s *rte_stats_bitrate_create(void); + + +/** + * Register bitrate statistics + * + * @param bitrate_data + * Pointer allocated by rte_stats_create() + * + * @return + * Zero on success + * Negative on error + */ +int rte_stats_bitrate_reg(struct rte_stats_bitrates_s *bitrate_data); + + +/** + * Calculate statistics for current time window. The period this function + * is called should be the intended time window width. + * + * @param bitrate_data + * Bitrate statistics data pointer + * + * @param port_id + * Port id to calculate statistics for + * + * @return + * - Zero on success + * - Negative value on error + */ +int rte_stats_bitrate_calc(struct rte_stats_bitrates_s *bitrate_data, + uint8_t port_id); diff --git a/lib/librte_bitratestats/rte_bitratestats_version.map b/lib/librte_bitratestats/rte_bitratestats_version.map new file mode 100644 index 0000000..9de6be9 --- /dev/null +++ b/lib/librte_bitratestats/rte_bitratestats_version.map @@ -0,0 +1,9 @@ +DPDK_16.11 { + global: + + rte_stats_bitrate_calc; + rte_stats_bitrate_create; + rte_stats_bitrate_reg; + + local: *; +}; diff --git a/lib/librte_metrics/rte_metrics.c b/lib/librte_metrics/rte_metrics.c index 354ba47..7dce738 100644 --- a/lib/librte_metrics/rte_metrics.c +++ b/lib/librte_metrics/rte_metrics.c @@ -44,6 +44,8 @@ #define RTE_METRICS_MAX_METRICS 256 +#define RTE_METRICS_MEMZONE_NAME "RTE_METRICS" + /** * Internal stats metadata and value entry. * @@ -62,7 +64,7 @@ * having a separate set metadata table doesn't save any memory. */ struct rte_metrics_meta_s { - struct rte_stat_name name; + char name[RTE_METRICS_MAX_NAME_LEN]; uint64_t value[RTE_MAX_ETHPORTS]; uint16_t idx_next_set; uint16_t idx_next_stat; @@ -100,10 +102,10 @@ rte_metrics_init(void) if (rte_eal_process_type() != RTE_PROC_PRIMARY) return; - memzone = rte_memzone_lookup("RTE_STATS"); + memzone = rte_memzone_lookup(RTE_METRICS_MEMZONE_NAME); if (memzone != NULL) return; - memzone = rte_memzone_reserve("RTE_STATS", + memzone = rte_memzone_reserve(RTE_METRICS_MEMZONE_NAME, sizeof(struct rte_metrics_data_s), rte_socket_id(), 0); if (memzone == NULL) rte_exit(EXIT_FAILURE, "Unable to allocate stats memzone\n"); @@ -135,7 +137,7 @@ rte_metrics_reg_metrics(const char **names, uint16_t cnt_names) return -EINVAL; rte_metrics_init(); - memzone = rte_memzone_lookup("RTE_STATS"); + memzone = rte_memzone_lookup(RTE_METRICS_MEMZONE_NAME); if (memzone == NULL) return -EIO; stats = memzone->addr; @@ -150,7 +152,7 @@ rte_metrics_reg_metrics(const char **names, uint16_t cnt_names) for (idx_name = 0; idx_name < cnt_names; idx_name++) { entry = &stats->metadata[idx_name + stats->cnt_stats]; - strncpy(entry->name.name, names[idx_name], + strncpy(entry->name, names[idx_name], RTE_METRICS_MAX_NAME_LEN); memset(entry->value, 0, sizeof(entry->value)); entry->idx_next_stat = idx_name + stats->cnt_stats + 1; @@ -184,7 +186,7 @@ rte_metrics_update_metrics(int port_id, uint16_t cnt_setsize; rte_metrics_init(); - memzone = rte_memzone_lookup("RTE_STATS"); + memzone = rte_memzone_lookup(RTE_METRICS_MEMZONE_NAME); if (memzone == NULL) return -EIO; stats = memzone->addr; @@ -211,14 +213,14 @@ rte_metrics_update_metrics(int port_id, int -rte_metrics_get_names(struct rte_stat_name *names, +rte_metrics_get_names(struct rte_metric_name *names, uint16_t capacity) { struct rte_metrics_data_s *stats; const struct rte_memzone *memzone; uint16_t idx_name; - memzone = rte_memzone_lookup("RTE_STATS"); + memzone = rte_memzone_lookup(RTE_METRICS_MEMZONE_NAME); /* If not allocated, fail silently */ if (memzone == NULL) return 0; @@ -229,7 +231,7 @@ rte_metrics_get_names(struct rte_stat_name *names, return -ERANGE; for (idx_name = 0; idx_name < stats->cnt_stats; idx_name++) strncpy(names[idx_name].name, - stats->metadata[idx_name].name.name, + stats->metadata[idx_name].name, RTE_METRICS_MAX_NAME_LEN); } return stats->cnt_stats; @@ -246,7 +248,7 @@ rte_metrics_get_values(int port_id, const struct rte_memzone *memzone; uint16_t idx_name; - memzone = rte_memzone_lookup("RTE_STATS"); + memzone = rte_memzone_lookup(RTE_METRICS_MEMZONE_NAME); /* If not allocated, fail silently */ if (memzone == NULL) return 0; diff --git a/lib/librte_metrics/rte_metrics.h b/lib/librte_metrics/rte_metrics.h index e8888eb..348db30 100644 --- a/lib/librte_metrics/rte_metrics.h +++ b/lib/librte_metrics/rte_metrics.h @@ -52,7 +52,7 @@ /** * Statistic name */ -struct rte_stat_name { +struct rte_metric_name { /** String describing statistic */ char name[RTE_METRICS_MAX_NAME_LEN]; }; @@ -130,7 +130,7 @@ int rte_metrics_reg_metrics(const char **names, uint16_t cnt_names); * - Negative: Failure */ int rte_metrics_get_names( - struct rte_stat_name *names, + struct rte_metric_name *names, uint16_t capacity); /** diff --git a/mk/rte.app.mk b/mk/rte.app.mk index 11d0c80..c499c69 100644 --- a/mk/rte.app.mk +++ b/mk/rte.app.mk @@ -98,6 +98,7 @@ _LDLIBS-$(CONFIG_RTE_LIBRTE_EAL) += -lrte_eal _LDLIBS-$(CONFIG_RTE_LIBRTE_CMDLINE) += -lrte_cmdline _LDLIBS-$(CONFIG_RTE_LIBRTE_CFGFILE) += -lrte_cfgfile _LDLIBS-$(CONFIG_RTE_LIBRTE_METRICS) += -lrte_metrics +_LDLIBS-$(CONFIG_RTE_LIBRTE_BITRATE) += -lrte_bitratestats _LDLIBS-$(CONFIG_RTE_LIBRTE_PMD_BOND) += -lrte_pmd_bond -- 2.5.5