Re: [dpdk-dev] [PATCH v2 05/16] telemetry: introduce new telemetry functionality

["Wiles, Keith" <keith.wiles@intel.com>]

> On Apr 8, 2020, at 11:49 AM, Power, Ciara <ciara.power@intel.com> wrote:
> 
> From: Bruce Richardson <bruce.richardson@intel.com>
> 
> 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 <bruce.richardson@intel.com>
> Signed-off-by: Ciara Power <ciara.power@intel.com>
> 
> ---
> 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
> 
> diff --git a/lib/librte_telemetry/Makefile b/lib/librte_telemetry/Makefile
> index 17e651c412..74a6e2d2f7 100644
> --- a/lib/librte_telemetry/Makefile
> +++ b/lib/librte_telemetry/Makefile
> @@ -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
> diff --git a/lib/librte_telemetry/meson.build b/lib/librte_telemetry/meson.build
> index b34661ac13..710c119b7a 100644
> --- a/lib/librte_telemetry/meson.build
> +++ b/lib/librte_telemetry/meson.build
> @@ -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')
> diff --git a/lib/librte_telemetry/rte_telemetry.c b/lib/librte_telemetry/rte_telemetry.c
> index 2fb8ffe873..45b6d9d948 100644
> --- a/lib/librte_telemetry/rte_telemetry.c
> +++ b/lib/librte_telemetry/rte_telemetry.c
> @@ -503,6 +503,9 @@ rte_telemetry_init(void)
> 		return -EPERM;
> 	}
> 
> +	if (rte_telemetry_new_init() != 0)
> +		return -1;
> +
> 	return 0;
> }
> 
> diff --git a/lib/librte_telemetry/rte_telemetry.h b/lib/librte_telemetry/rte_telemetry.h
> index aedb318598..d0230d4544 100644
> --- a/lib/librte_telemetry/rte_telemetry.h
> +++ b/lib/librte_telemetry/rte_telemetry.h
> @@ -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
> int32_t
> rte_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.
> 
> +/**
> + * 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
> diff --git a/lib/librte_telemetry/rte_telemetry_version.map b/lib/librte_telemetry/rte_telemetry_version.map
> index a80058c59c..831bbd59ad 100644
> --- a/lib/librte_telemetry/rte_telemetry_version.map
> +++ b/lib/librte_telemetry/rte_telemetry_version.map
> @@ -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: *;
> };
> diff --git a/lib/librte_telemetry/telemetry.c b/lib/librte_telemetry/telemetry.c
> new file mode 100644
> index 0000000000..2878c1dbd9
> --- /dev/null
> +++ b/lib/librte_telemetry/telemetry.c
> @@ -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] = ']';
> +	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?
> +	return ret >= buf_len ? -1 : ret;
> +}
> +
> +static void
> +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?
> +		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?
> +	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");
> +}
> +
> +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?
> +	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.

> +			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.
> +	}
> +	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;
> +}
> -- 
> 2.17.1
>