1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2020 Intel Corporation
5 #ifndef RTE_EXEC_ENV_WINDOWS
8 #include <sys/socket.h>
12 #endif /* !RTE_EXEC_ENV_WINDOWS */
14 /* we won't link against libbsd, so just always use DPDKs-specific strlcpy */
16 #include <rte_string_fns.h>
17 #include <rte_common.h>
18 #include <rte_spinlock.h>
21 #include "rte_telemetry.h"
22 #include "telemetry_json.h"
23 #include "telemetry_data.h"
24 #include "telemetry_internal.h"
26 #define MAX_CMD_LEN 56
27 #define MAX_OUTPUT_LEN (1024 * 16)
28 #define MAX_CONNECTIONS 10
30 #ifndef RTE_EXEC_ENV_WINDOWS
32 client_handler(void *socket);
33 #endif /* !RTE_EXEC_ENV_WINDOWS */
36 char cmd[MAX_CMD_LEN];
38 char help[RTE_TEL_MAX_STRING_LEN];
41 #ifndef RTE_EXEC_ENV_WINDOWS
44 char path[sizeof(((struct sockaddr_un *)0)->sun_path)];
46 uint16_t *num_clients;
48 static struct socket v2_socket; /* socket for v2 telemetry */
49 static struct socket v1_socket; /* socket for v1 telemetry */
50 #endif /* !RTE_EXEC_ENV_WINDOWS */
52 static const char *telemetry_version; /* save rte_version */
53 static const char *socket_dir; /* runtime directory */
54 static rte_cpuset_t *thread_cpuset;
55 static rte_log_fn rte_log_ptr;
56 static uint32_t logtype;
58 #define TMTY_LOG(l, ...) \
59 rte_log_ptr(RTE_LOG_ ## l, logtype, "TELEMETRY: " __VA_ARGS__)
61 /* list of command callbacks, with one command registered by default */
62 static struct cmd_callback *callbacks;
63 static int num_callbacks; /* How many commands are registered */
64 /* Used when accessing or modifying list of command callbacks */
65 static rte_spinlock_t callback_sl = RTE_SPINLOCK_INITIALIZER;
66 #ifndef RTE_EXEC_ENV_WINDOWS
67 static uint16_t v2_clients;
68 #endif /* !RTE_EXEC_ENV_WINDOWS */
71 rte_telemetry_register_cmd(const char *cmd, telemetry_cb fn, const char *help)
73 struct cmd_callback *new_callbacks;
76 if (strlen(cmd) >= MAX_CMD_LEN || fn == NULL || cmd[0] != '/'
77 || strlen(help) >= RTE_TEL_MAX_STRING_LEN)
80 rte_spinlock_lock(&callback_sl);
81 new_callbacks = realloc(callbacks, sizeof(callbacks[0]) * (num_callbacks + 1));
82 if (new_callbacks == NULL) {
83 rte_spinlock_unlock(&callback_sl);
86 callbacks = new_callbacks;
88 while (i < num_callbacks && strcmp(cmd, callbacks[i].cmd) > 0)
90 if (i != num_callbacks)
91 /* Move elements to keep the list alphabetical */
92 memmove(callbacks + i + 1, callbacks + i,
93 sizeof(struct cmd_callback) * (num_callbacks - i));
95 strlcpy(callbacks[i].cmd, cmd, MAX_CMD_LEN);
97 strlcpy(callbacks[i].help, help, RTE_TEL_MAX_STRING_LEN);
99 rte_spinlock_unlock(&callback_sl);
104 #ifndef RTE_EXEC_ENV_WINDOWS
107 list_commands(const char *cmd __rte_unused, const char *params __rte_unused,
108 struct rte_tel_data *d)
112 rte_tel_data_start_array(d, RTE_TEL_STRING_VAL);
113 rte_spinlock_lock(&callback_sl);
114 for (i = 0; i < num_callbacks; i++)
115 rte_tel_data_add_array_string(d, callbacks[i].cmd);
116 rte_spinlock_unlock(&callback_sl);
121 json_info(const char *cmd __rte_unused, const char *params __rte_unused,
122 struct rte_tel_data *d)
124 rte_tel_data_start_dict(d);
125 rte_tel_data_add_dict_string(d, "version", telemetry_version);
126 rte_tel_data_add_dict_int(d, "pid", getpid());
127 rte_tel_data_add_dict_int(d, "max_output_len", MAX_OUTPUT_LEN);
132 command_help(const char *cmd __rte_unused, const char *params,
133 struct rte_tel_data *d)
139 rte_tel_data_start_dict(d);
140 rte_spinlock_lock(&callback_sl);
141 for (i = 0; i < num_callbacks; i++)
142 if (strcmp(params, callbacks[i].cmd) == 0) {
143 rte_tel_data_add_dict_string(d, params,
147 rte_spinlock_unlock(&callback_sl);
148 if (i == num_callbacks)
154 container_to_json(const struct rte_tel_data *d, char *out_buf, size_t buf_len)
159 if (d->type != RTE_TEL_DICT && d->type != RTE_TEL_ARRAY_U64 &&
160 d->type != RTE_TEL_ARRAY_INT && d->type != RTE_TEL_ARRAY_STRING)
161 return snprintf(out_buf, buf_len, "null");
163 used = rte_tel_json_empty_array(out_buf, buf_len, 0);
164 if (d->type == RTE_TEL_ARRAY_U64)
165 for (i = 0; i < d->data_len; i++)
166 used = rte_tel_json_add_array_u64(out_buf,
168 d->data.array[i].u64val);
169 if (d->type == RTE_TEL_ARRAY_INT)
170 for (i = 0; i < d->data_len; i++)
171 used = rte_tel_json_add_array_int(out_buf,
173 d->data.array[i].ival);
174 if (d->type == RTE_TEL_ARRAY_STRING)
175 for (i = 0; i < d->data_len; i++)
176 used = rte_tel_json_add_array_string(out_buf,
178 d->data.array[i].sval);
179 if (d->type == RTE_TEL_DICT)
180 for (i = 0; i < d->data_len; i++) {
181 const struct tel_dict_entry *v = &d->data.dict[i];
183 case RTE_TEL_STRING_VAL:
184 used = rte_tel_json_add_obj_str(out_buf,
186 v->name, v->value.sval);
188 case RTE_TEL_INT_VAL:
189 used = rte_tel_json_add_obj_int(out_buf,
191 v->name, v->value.ival);
193 case RTE_TEL_U64_VAL:
194 used = rte_tel_json_add_obj_u64(out_buf,
196 v->name, v->value.u64val);
198 case RTE_TEL_CONTAINER:
201 const struct container *cont =
203 if (container_to_json(cont->data,
205 used = rte_tel_json_add_obj_json(
210 rte_tel_data_free(cont->data);
220 output_json(const char *cmd, const struct rte_tel_data *d, int s)
222 char out_buf[MAX_OUTPUT_LEN];
225 size_t buf_len, prefix_used, used = 0;
228 RTE_BUILD_BUG_ON(sizeof(out_buf) < MAX_CMD_LEN +
229 RTE_TEL_MAX_SINGLE_STRING_LEN + 10);
232 used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":null}",
233 MAX_CMD_LEN, cmd ? cmd : "none");
236 used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":\"%.*s\"}",
238 RTE_TEL_MAX_SINGLE_STRING_LEN, d->data.str);
241 prefix_used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":",
243 cb_data_buf = &out_buf[prefix_used];
244 buf_len = sizeof(out_buf) - prefix_used - 1; /* space for '}' */
246 used = rte_tel_json_empty_obj(cb_data_buf, buf_len, 0);
247 for (i = 0; i < d->data_len; i++) {
248 const struct tel_dict_entry *v = &d->data.dict[i];
250 case RTE_TEL_STRING_VAL:
251 used = rte_tel_json_add_obj_str(cb_data_buf,
253 v->name, v->value.sval);
255 case RTE_TEL_INT_VAL:
256 used = rte_tel_json_add_obj_int(cb_data_buf,
258 v->name, v->value.ival);
260 case RTE_TEL_U64_VAL:
261 used = rte_tel_json_add_obj_u64(cb_data_buf,
263 v->name, v->value.u64val);
265 case RTE_TEL_CONTAINER:
268 const struct container *cont =
270 if (container_to_json(cont->data,
272 used = rte_tel_json_add_obj_json(
277 rte_tel_data_free(cont->data);
282 used += strlcat(out_buf + used, "}", sizeof(out_buf) - used);
284 case RTE_TEL_ARRAY_STRING:
285 case RTE_TEL_ARRAY_INT:
286 case RTE_TEL_ARRAY_U64:
287 case RTE_TEL_ARRAY_CONTAINER:
288 prefix_used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":",
290 cb_data_buf = &out_buf[prefix_used];
291 buf_len = sizeof(out_buf) - prefix_used - 1; /* space for '}' */
293 used = rte_tel_json_empty_array(cb_data_buf, buf_len, 0);
294 for (i = 0; i < d->data_len; i++)
295 if (d->type == RTE_TEL_ARRAY_STRING)
296 used = rte_tel_json_add_array_string(
299 d->data.array[i].sval);
300 else if (d->type == RTE_TEL_ARRAY_INT)
301 used = rte_tel_json_add_array_int(cb_data_buf,
303 d->data.array[i].ival);
304 else if (d->type == RTE_TEL_ARRAY_U64)
305 used = rte_tel_json_add_array_u64(cb_data_buf,
307 d->data.array[i].u64val);
308 else if (d->type == RTE_TEL_ARRAY_CONTAINER) {
310 const struct container *rec_data =
311 &d->data.array[i].container;
312 if (container_to_json(rec_data->data,
314 used = rte_tel_json_add_array_json(
316 buf_len, used, temp);
318 rte_tel_data_free(rec_data->data);
321 used += strlcat(out_buf + used, "}", sizeof(out_buf) - used);
324 if (write(s, out_buf, used) < 0)
325 perror("Error writing to socket");
329 perform_command(telemetry_cb fn, const char *cmd, const char *param, int s)
331 struct rte_tel_data data;
333 int ret = fn(cmd, param, &data);
335 char out_buf[MAX_CMD_LEN + 10];
336 int used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":null}",
337 MAX_CMD_LEN, cmd ? cmd : "none");
338 if (write(s, out_buf, used) < 0)
339 perror("Error writing to socket");
342 output_json(cmd, &data, s);
346 unknown_command(const char *cmd __rte_unused, const char *params __rte_unused,
347 struct rte_tel_data *d)
349 return d->type = RTE_TEL_NULL;
353 client_handler(void *sock_id)
355 int s = (int)(uintptr_t)sock_id;
358 snprintf(info_str, sizeof(info_str),
359 "{\"version\":\"%s\",\"pid\":%d,\"max_output_len\":%d}",
360 telemetry_version, getpid(), MAX_OUTPUT_LEN);
361 if (write(s, info_str, strlen(info_str)) < 0) {
366 /* receive data is not null terminated */
367 int bytes = read(s, buffer, sizeof(buffer) - 1);
370 const char *cmd = strtok(buffer, ",");
371 const char *param = strtok(NULL, "\0");
372 telemetry_cb fn = unknown_command;
375 if (cmd && strlen(cmd) < MAX_CMD_LEN) {
376 rte_spinlock_lock(&callback_sl);
377 for (i = 0; i < num_callbacks; i++)
378 if (strcmp(cmd, callbacks[i].cmd) == 0) {
379 fn = callbacks[i].fn;
382 rte_spinlock_unlock(&callback_sl);
384 perform_command(fn, cmd, param, s);
386 bytes = read(s, buffer, sizeof(buffer) - 1);
389 __atomic_sub_fetch(&v2_clients, 1, __ATOMIC_RELAXED);
394 socket_listener(void *socket)
399 struct socket *s = (struct socket *)socket;
400 int s_accepted = accept(s->sock, NULL, NULL);
401 if (s_accepted < 0) {
402 TMTY_LOG(ERR, "Error with accept, telemetry thread quitting\n");
405 if (s->num_clients != NULL) {
406 uint16_t conns = __atomic_load_n(s->num_clients,
408 if (conns >= MAX_CONNECTIONS) {
412 __atomic_add_fetch(s->num_clients, 1,
415 rc = pthread_create(&th, NULL, s->fn,
416 (void *)(uintptr_t)s_accepted);
418 TMTY_LOG(ERR, "Error with create client thread: %s\n",
421 if (s->num_clients != NULL)
422 __atomic_sub_fetch(s->num_clients, 1,
432 get_socket_path(const char *runtime_dir, const int version)
434 static char path[PATH_MAX];
435 snprintf(path, sizeof(path), "%s/dpdk_telemetry.v%d",
436 strlen(runtime_dir) ? runtime_dir : "/tmp", version);
443 if (v2_socket.path[0])
444 unlink(v2_socket.path);
445 if (v1_socket.path[0])
446 unlink(v1_socket.path);
450 create_socket(char *path)
452 int sock = socket(AF_UNIX, SOCK_SEQPACKET, 0);
454 TMTY_LOG(ERR, "Error with socket creation, %s\n", strerror(errno));
458 struct sockaddr_un sun = {.sun_family = AF_UNIX};
459 strlcpy(sun.sun_path, path, sizeof(sun.sun_path));
460 TMTY_LOG(DEBUG, "Attempting socket bind to path '%s'\n", path);
462 if (bind(sock, (void *) &sun, sizeof(sun)) < 0) {
465 TMTY_LOG(DEBUG, "Initial bind to socket '%s' failed.\n", path);
467 /* first check if we have a runtime dir */
468 if (stat(socket_dir, &st) < 0 || !S_ISDIR(st.st_mode)) {
469 TMTY_LOG(ERR, "Cannot access DPDK runtime directory: %s\n", socket_dir);
474 /* check if current socket is active */
475 if (connect(sock, (void *)&sun, sizeof(sun)) == 0) {
480 /* socket is not active, delete and attempt rebind */
481 TMTY_LOG(DEBUG, "Attempting unlink and retrying bind\n");
482 unlink(sun.sun_path);
483 if (bind(sock, (void *) &sun, sizeof(sun)) < 0) {
484 TMTY_LOG(ERR, "Error binding socket: %s\n", strerror(errno));
486 return -errno; /* if unlink failed, this will be -EADDRINUSE as above */
490 if (listen(sock, 1) < 0) {
491 TMTY_LOG(ERR, "Error calling listen for socket: %s\n", strerror(errno));
492 unlink(sun.sun_path);
496 TMTY_LOG(DEBUG, "Socket creation and binding ok\n");
502 set_thread_name(pthread_t id __rte_unused, const char *name __rte_unused)
504 #if defined RTE_EXEC_ENV_LINUX && defined __GLIBC__ && defined __GLIBC_PREREQ
505 #if __GLIBC_PREREQ(2, 12)
506 pthread_setname_np(id, name);
508 #elif defined RTE_EXEC_ENV_FREEBSD
509 pthread_set_name_np(id, name);
514 telemetry_legacy_init(void)
519 if (num_legacy_callbacks == 1) {
520 TMTY_LOG(WARNING, "No legacy callbacks, legacy socket not created\n");
524 v1_socket.fn = legacy_client_handler;
525 if ((size_t) snprintf(v1_socket.path, sizeof(v1_socket.path),
526 "%s/telemetry", socket_dir) >= sizeof(v1_socket.path)) {
527 TMTY_LOG(ERR, "Error with socket binding, path too long\n");
530 v1_socket.sock = create_socket(v1_socket.path);
531 if (v1_socket.sock < 0) {
532 v1_socket.path[0] = '\0';
535 rc = pthread_create(&t_old, NULL, socket_listener, &v1_socket);
537 TMTY_LOG(ERR, "Error with create legcay socket thread: %s\n",
539 close(v1_socket.sock);
541 unlink(v1_socket.path);
542 v1_socket.path[0] = '\0';
545 pthread_setaffinity_np(t_old, sizeof(*thread_cpuset), thread_cpuset);
546 set_thread_name(t_old, "telemetry-v1");
547 TMTY_LOG(DEBUG, "Legacy telemetry socket initialized ok\n");
548 pthread_detach(t_old);
553 telemetry_v2_init(void)
555 char spath[sizeof(v2_socket.path)];
560 v2_socket.num_clients = &v2_clients;
561 rte_telemetry_register_cmd("/", list_commands,
562 "Returns list of available commands, Takes no parameters");
563 rte_telemetry_register_cmd("/info", json_info,
564 "Returns DPDK Telemetry information. Takes no parameters");
565 rte_telemetry_register_cmd("/help", command_help,
566 "Returns help text for a command. Parameters: string command");
567 v2_socket.fn = client_handler;
568 if (strlcpy(spath, get_socket_path(socket_dir, 2), sizeof(spath)) >= sizeof(spath)) {
569 TMTY_LOG(ERR, "Error with socket binding, path too long\n");
572 memcpy(v2_socket.path, spath, sizeof(v2_socket.path));
574 v2_socket.sock = create_socket(v2_socket.path);
575 while (v2_socket.sock < 0) {
576 /* bail out on unexpected error, or suffix wrap-around */
577 if (v2_socket.sock != -EADDRINUSE || suffix < 0) {
578 v2_socket.path[0] = '\0'; /* clear socket path */
581 /* add a suffix to the path if the basic version fails */
582 if (snprintf(v2_socket.path, sizeof(v2_socket.path), "%s:%d",
583 spath, ++suffix) >= (int)sizeof(v2_socket.path)) {
584 TMTY_LOG(ERR, "Error with socket binding, path too long\n");
587 v2_socket.sock = create_socket(v2_socket.path);
589 rc = pthread_create(&t_new, NULL, socket_listener, &v2_socket);
591 TMTY_LOG(ERR, "Error with create socket thread: %s\n",
593 close(v2_socket.sock);
595 unlink(v2_socket.path);
596 v2_socket.path[0] = '\0';
599 pthread_setaffinity_np(t_new, sizeof(*thread_cpuset), thread_cpuset);
600 set_thread_name(t_new, "telemetry-v2");
601 pthread_detach(t_new);
602 atexit(unlink_sockets);
607 #endif /* !RTE_EXEC_ENV_WINDOWS */
610 rte_telemetry_init(const char *runtime_dir, const char *rte_version, rte_cpuset_t *cpuset,
611 rte_log_fn log_fn, uint32_t registered_logtype)
613 telemetry_version = rte_version;
614 socket_dir = runtime_dir;
615 thread_cpuset = cpuset;
616 rte_log_ptr = log_fn;
617 logtype = registered_logtype;
619 #ifndef RTE_EXEC_ENV_WINDOWS
620 if (telemetry_v2_init() != 0)
622 TMTY_LOG(DEBUG, "Telemetry initialized ok\n");
623 telemetry_legacy_init();
624 #endif /* RTE_EXEC_ENV_WINDOWS */