2 * collectd - src/dpdkstat.c
5 * Copyright(c) 2016 Intel Corporation. All rights reserved.
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26 * Maryam Tahhan <maryam.tahhan@intel.com>
27 * Harry van Haaren <harry.van.haaren@intel.com>
28 * Taras Chornyi <tarasx.chornyi@intel.com>
29 * Serhiy Pshyk <serhiyx.pshyk@intel.com>
30 * Krzysztof Matczak <krzysztofx.matczak@intel.com>
36 #include "utils_dpdk.h"
38 #include <rte_config.h>
39 #include <rte_ethdev.h>
41 #define DPDK_STATS_PLUGIN "dpdkstat"
42 #define DPDK_STATS_NAME "dpdk_collectd_stats"
44 #define DPDK_STATS_TRACE() \
45 DEBUG("%s:%s:%d pid=%u", DPDK_STATS_PLUGIN, __FUNCTION__, __LINE__, getpid())
47 struct dpdk_stats_config_s {
49 uint32_t enabled_port_mask;
50 char port_name[RTE_MAX_ETHPORTS][DATA_MAX_NAME_LEN];
52 typedef struct dpdk_stats_config_s dpdk_stats_config_t;
54 #define RTE_VERSION_16_07 RTE_VERSION_NUM(16, 7, 0, 16)
56 #if RTE_VERSION < RTE_VERSION_16_07
57 #define DPDK_STATS_XSTAT_GET_VALUE(ctx, index) ctx->xstats[index].value
58 #define DPDK_STATS_XSTAT_GET_NAME(ctx, index) ctx->xstats[index].name
59 #define DPDK_STATS_CTX_GET_XSTAT_SIZE sizeof(struct rte_eth_xstats)
60 #define DPDK_STATS_CTX_INIT(ctx) \
62 ctx->xstats = (struct rte_eth_xstats *)&ctx->raw_data[0]; \
65 #define DPDK_STATS_XSTAT_GET_VALUE(ctx, index) ctx->xstats[index].value
66 #define DPDK_STATS_XSTAT_GET_NAME(ctx, index) ctx->xnames[index].name
67 #define DPDK_STATS_CTX_GET_XSTAT_SIZE \
68 (sizeof(struct rte_eth_xstat) + sizeof(struct rte_eth_xstat_name))
69 #define DPDK_STATS_CTX_INIT(ctx) \
71 ctx->xstats = (struct rte_eth_xstat *)&ctx->raw_data[0]; \
73 (struct rte_eth_xstat_name *)&ctx \
74 ->raw_data[ctx->stats_count * sizeof(struct rte_eth_xstat)]; \
78 struct dpdk_stats_ctx_s {
79 dpdk_stats_config_t config;
82 cdtime_t port_read_time[RTE_MAX_ETHPORTS];
83 uint32_t port_stats_count[RTE_MAX_ETHPORTS];
84 #if RTE_VERSION < RTE_VERSION_16_07
85 struct rte_eth_xstats *xstats;
87 struct rte_eth_xstat *xstats;
88 struct rte_eth_xstat_name *xnames;
92 typedef struct dpdk_stats_ctx_s dpdk_stats_ctx_t;
94 #define DPDK_STATS_CTX_GET(a) ((dpdk_stats_ctx_t *)dpdk_helper_priv_get(a))
96 dpdk_helper_ctx_t *g_hc = NULL;
97 static char g_shm_name[DATA_MAX_NAME_LEN] = DPDK_STATS_NAME;
98 static int dpdk_stats_reinit_helper();
99 static void dpdk_stats_default_config(void) {
100 dpdk_stats_ctx_t *ec = DPDK_STATS_CTX_GET(g_hc);
102 ec->config.interval = plugin_get_interval();
103 for (int i = 0; i < RTE_MAX_ETHPORTS; i++) {
104 ec->config.port_name[i][0] = 0;
106 /* Enable all ports by default */
107 ec->config.enabled_port_mask = ~0;
110 static int dpdk_stats_preinit(void) {
114 /* already initialized if config callback was called before init callback */
115 DEBUG("dpdk_stats_preinit: helper already initialized");
119 int ret = dpdk_helper_init(g_shm_name, sizeof(dpdk_stats_ctx_t), &g_hc);
121 char errbuf[ERR_BUF_SIZE];
122 ERROR("%s: failed to initialize %s helper(error: %s)", DPDK_STATS_PLUGIN,
123 g_shm_name, sstrerror(errno, errbuf, sizeof(errbuf)));
127 dpdk_stats_default_config();
131 static int dpdk_stats_config(oconfig_item_t *ci) {
134 int ret = dpdk_stats_preinit();
138 dpdk_stats_ctx_t *ctx = DPDK_STATS_CTX_GET(g_hc);
140 for (int i = 0; i < ci->children_num; i++) {
141 oconfig_item_t *child = ci->children + i;
143 if ((strcasecmp("EnabledPortMask", child->key) == 0) &&
144 (child->values[0].type == OCONFIG_TYPE_NUMBER)) {
145 ctx->config.enabled_port_mask = child->values[0].value.number;
146 DEBUG("%s: Enabled Port Mask 0x%X", DPDK_STATS_PLUGIN,
147 ctx->config.enabled_port_mask);
148 } else if (strcasecmp("SharedMemObj", child->key) == 0) {
149 cf_util_get_string_buffer(child, g_shm_name, sizeof(g_shm_name));
150 DEBUG("%s: Shared memory object %s", DPDK_STATS_PLUGIN, g_shm_name);
151 dpdk_stats_reinit_helper();
152 } else if (strcasecmp("EAL", child->key) == 0) {
153 ret = dpdk_helper_eal_config_parse(g_hc, child);
161 /* parse port names after EnabledPortMask was parsed */
162 for (int i = 0; i < ci->children_num; i++) {
163 oconfig_item_t *child = ci->children + i;
165 if (strcasecmp("PortName", child->key) == 0) {
167 while (!(ctx->config.enabled_port_mask & (1 << port_num)))
170 cf_util_get_string_buffer(child, ctx->config.port_name[port_num],
171 sizeof(ctx->config.port_name[port_num]));
172 DEBUG("%s: Port %d Name: %s", DPDK_STATS_PLUGIN, port_num,
173 ctx->config.port_name[port_num]);
182 static int dpdk_helper_stats_get(dpdk_helper_ctx_t *phc) {
186 dpdk_stats_ctx_t *ctx = DPDK_STATS_CTX_GET(phc);
188 /* get stats from DPDK */
189 for (uint8_t i = 0; i < ctx->ports_count; i++) {
190 if (!(ctx->config.enabled_port_mask & (1 << i)))
193 ctx->port_read_time[i] = cdtime();
194 /* Store available stats array length for port */
195 len = ctx->port_stats_count[i];
197 ret = rte_eth_xstats_get(i, &ctx->xstats[stats], len);
198 if (ret < 0 || ret > len) {
199 DPDK_CHILD_LOG(DPDK_STATS_PLUGIN
200 ": Error reading stats (port=%d; len=%d, ret=%d)\n",
202 ctx->port_stats_count[i] = 0;
205 #if RTE_VERSION >= RTE_VERSION_16_07
206 ret = rte_eth_xstats_get_names(i, &ctx->xnames[stats], len);
207 if (ret < 0 || ret > len) {
208 DPDK_CHILD_LOG(DPDK_STATS_PLUGIN
209 ": Error reading stat names (port=%d; len=%d ret=%d)\n",
211 ctx->port_stats_count[i] = 0;
215 ctx->port_stats_count[i] = ret;
216 stats += ctx->port_stats_count[i];
219 assert(stats <= ctx->stats_count);
223 static int dpdk_helper_stats_count_get(dpdk_helper_ctx_t *phc) {
224 uint8_t ports = dpdk_helper_eth_dev_count();
228 dpdk_stats_ctx_t *ctx = DPDK_STATS_CTX_GET(phc);
229 ctx->ports_count = ports;
233 for (int i = 0; i < ports; i++) {
234 if (!(ctx->config.enabled_port_mask & (1 << i)))
236 #if RTE_VERSION >= RTE_VERSION_16_07
237 len = rte_eth_xstats_get_names(i, NULL, 0);
239 len = rte_eth_xstats_get(i, NULL, 0);
242 DPDK_CHILD_LOG("%s: Cannot get stats count\n", DPDK_STATS_PLUGIN);
245 ctx->port_stats_count[i] = len;
249 DPDK_CHILD_LOG("%s:%s:%d stats_count=%d\n", DPDK_STATS_PLUGIN, __FUNCTION__,
250 __LINE__, stats_count);
255 static int dpdk_stats_get_size(dpdk_helper_ctx_t *phc) {
256 return dpdk_helper_data_size_get(phc) - sizeof(dpdk_stats_ctx_t);
259 int dpdk_helper_command_handler(dpdk_helper_ctx_t *phc, enum DPDK_CMD cmd) {
260 /* this function is called from helper context */
263 DPDK_CHILD_LOG("%s: Invalid argument(phc)\n", DPDK_STATS_PLUGIN);
267 if (cmd != DPDK_CMD_GET_STATS) {
268 DPDK_CHILD_LOG("%s: Unknown command (cmd=%d)\n", DPDK_STATS_PLUGIN, cmd);
272 int stats_count = dpdk_helper_stats_count_get(phc);
273 if (stats_count < 0) {
277 DPDK_STATS_CTX_GET(phc)->stats_count = stats_count;
278 int stats_size = stats_count * DPDK_STATS_CTX_GET_XSTAT_SIZE;
280 if (dpdk_stats_get_size(phc) < stats_size) {
283 ":%s:%d not enough space for stats (available=%d, needed=%d)\n",
284 __FUNCTION__, __LINE__, (int)dpdk_stats_get_size(phc), stats_size);
288 return dpdk_helper_stats_get(phc);
291 static void dpdk_stats_resolve_cnt_type(char *cnt_type, size_t cnt_type_len,
292 const char *cnt_name) {
294 type_end = strrchr(cnt_name, '_');
296 if ((type_end != NULL) && (strncmp(cnt_name, "rx_", strlen("rx_")) == 0)) {
297 if (strstr(type_end, "bytes") != NULL) {
298 sstrncpy(cnt_type, "if_rx_octets", cnt_type_len);
299 } else if (strstr(type_end, "error") != NULL) {
300 sstrncpy(cnt_type, "if_rx_errors", cnt_type_len);
301 } else if (strstr(type_end, "dropped") != NULL) {
302 sstrncpy(cnt_type, "if_rx_dropped", cnt_type_len);
303 } else if (strstr(type_end, "packets") != NULL) {
304 sstrncpy(cnt_type, "if_rx_packets", cnt_type_len);
305 } else if (strstr(type_end, "_placement") != NULL) {
306 sstrncpy(cnt_type, "if_rx_errors", cnt_type_len);
307 } else if (strstr(type_end, "_buff") != NULL) {
308 sstrncpy(cnt_type, "if_rx_errors", cnt_type_len);
310 /* Does not fit obvious type: use a more generic one */
311 sstrncpy(cnt_type, "derive", cnt_type_len);
314 } else if ((type_end != NULL) &&
315 (strncmp(cnt_name, "tx_", strlen("tx_"))) == 0) {
316 if (strstr(type_end, "bytes") != NULL) {
317 sstrncpy(cnt_type, "if_tx_octets", cnt_type_len);
318 } else if (strstr(type_end, "error") != NULL) {
319 sstrncpy(cnt_type, "if_tx_errors", cnt_type_len);
320 } else if (strstr(type_end, "dropped") != NULL) {
321 sstrncpy(cnt_type, "if_tx_dropped", cnt_type_len);
322 } else if (strstr(type_end, "packets") != NULL) {
323 sstrncpy(cnt_type, "if_tx_packets", cnt_type_len);
325 /* Does not fit obvious type: use a more generic one */
326 sstrncpy(cnt_type, "derive", cnt_type_len);
328 } else if ((type_end != NULL) &&
329 (strncmp(cnt_name, "flow_", strlen("flow_"))) == 0) {
331 if (strstr(type_end, "_filters") != NULL) {
332 sstrncpy(cnt_type, "operations", cnt_type_len);
333 } else if (strstr(type_end, "error") != NULL)
334 sstrncpy(cnt_type, "errors", cnt_type_len);
336 } else if ((type_end != NULL) &&
337 (strncmp(cnt_name, "mac_", strlen("mac_"))) == 0) {
338 if (strstr(type_end, "error") != NULL) {
339 sstrncpy(cnt_type, "errors", cnt_type_len);
342 /* Does not fit obvious type, or strrchr error:
343 * use a more generic type */
344 sstrncpy(cnt_type, "derive", cnt_type_len);
348 static void dpdk_stats_counter_submit(const char *plugin_instance,
349 const char *cnt_name, derive_t value,
350 cdtime_t port_read_time) {
351 value_list_t vl = VALUE_LIST_INIT;
352 vl.values = &(value_t){.derive = value};
354 vl.time = port_read_time;
355 sstrncpy(vl.host, hostname_g, sizeof(vl.host));
356 sstrncpy(vl.plugin, DPDK_STATS_PLUGIN, sizeof(vl.plugin));
357 sstrncpy(vl.plugin_instance, plugin_instance, sizeof(vl.plugin_instance));
358 dpdk_stats_resolve_cnt_type(vl.type, sizeof(vl.type), cnt_name);
359 sstrncpy(vl.type_instance, cnt_name, sizeof(vl.type_instance));
360 plugin_dispatch_values(&vl);
363 static int dpdk_stats_counters_dispatch(dpdk_helper_ctx_t *phc) {
364 dpdk_stats_ctx_t *ctx = DPDK_STATS_CTX_GET(phc);
366 /* dispatch stats values to collectd */
368 DEBUG("%s:%s:%d ports=%u", DPDK_STATS_PLUGIN, __FUNCTION__, __LINE__,
373 for (int i = 0; i < ctx->ports_count; i++) {
374 if (!(ctx->config.enabled_port_mask & (1 << i)))
378 if (ctx->config.port_name[i][0] != 0) {
379 snprintf(dev_name, sizeof(dev_name), "%s", ctx->config.port_name[i]);
381 snprintf(dev_name, sizeof(dev_name), "port.%d", i);
384 DEBUG(" === Dispatch stats for port %d (name=%s; stats_count=%d)", i,
385 dev_name, ctx->port_stats_count[i]);
387 for (int j = 0; j < ctx->port_stats_count[i]; j++) {
388 const char *cnt_name = DPDK_STATS_XSTAT_GET_NAME(ctx, stats_count);
389 if (cnt_name == NULL)
390 WARNING("dpdkstat: Invalid counter name");
392 dpdk_stats_counter_submit(
394 (derive_t)DPDK_STATS_XSTAT_GET_VALUE(ctx, stats_count),
395 ctx->port_read_time[i]);
398 assert(stats_count <= ctx->stats_count);
405 static int dpdk_stats_reinit_helper() {
408 dpdk_stats_ctx_t *ctx = DPDK_STATS_CTX_GET(g_hc);
410 size_t data_size = sizeof(dpdk_stats_ctx_t) +
411 (ctx->stats_count * DPDK_STATS_CTX_GET_XSTAT_SIZE);
413 DEBUG("%s:%d helper reinit (new_size=%zu)", __FUNCTION__, __LINE__,
416 dpdk_stats_ctx_t tmp_ctx;
417 dpdk_eal_config_t tmp_eal;
419 memcpy(&tmp_ctx, ctx, sizeof(dpdk_stats_ctx_t));
420 dpdk_helper_eal_config_get(g_hc, &tmp_eal);
422 dpdk_helper_shutdown(g_hc);
427 ret = dpdk_helper_init(g_shm_name, data_size, &g_hc);
429 char errbuf[ERR_BUF_SIZE];
430 ERROR("%s: failed to initialize %s helper(error: %s)", DPDK_STATS_PLUGIN,
431 g_shm_name, sstrerror(errno, errbuf, sizeof(errbuf)));
435 ctx = DPDK_STATS_CTX_GET(g_hc);
436 memcpy(ctx, &tmp_ctx, sizeof(dpdk_stats_ctx_t));
437 DPDK_STATS_CTX_INIT(ctx);
438 dpdk_helper_eal_config_set(g_hc, &tmp_eal);
443 static int dpdk_stats_read(user_data_t *ud) {
449 ERROR("dpdk stats plugin not initialized");
453 dpdk_stats_ctx_t *ctx = DPDK_STATS_CTX_GET(g_hc);
456 ret = dpdk_helper_command(g_hc, DPDK_CMD_GET_STATS, &result,
457 ctx->config.interval);
462 if (result == -ENOBUFS) {
463 dpdk_stats_reinit_helper();
464 } else if (result == -ENODEV) {
465 dpdk_helper_shutdown(g_hc);
466 } else if (result == 0) {
467 dpdk_stats_counters_dispatch(g_hc);
473 static int dpdk_stats_init(void) {
477 ret = dpdk_stats_preinit();
485 static int dpdk_stats_shutdown(void) {
490 ret = dpdk_helper_shutdown(g_hc);
493 ERROR("%s: failed to cleanup %s helper", DPDK_STATS_PLUGIN, g_shm_name);
500 void module_register(void) {
501 plugin_register_init(DPDK_STATS_PLUGIN, dpdk_stats_init);
502 plugin_register_complex_config(DPDK_STATS_PLUGIN, dpdk_stats_config);
503 plugin_register_complex_read(NULL, DPDK_STATS_PLUGIN, dpdk_stats_read, 0,
505 plugin_register_shutdown(DPDK_STATS_PLUGIN, dpdk_stats_shutdown);