1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2020 Intel Corporation
5 #ifndef RTE_EXEC_ENV_WINDOWS
8 #include <sys/socket.h>
11 #endif /* !RTE_EXEC_ENV_WINDOWS */
13 /* we won't link against libbsd, so just always use DPDKs-specific strlcpy */
15 #include <rte_string_fns.h>
16 #include <rte_common.h>
17 #include <rte_spinlock.h>
20 #include "rte_telemetry.h"
21 #include "telemetry_json.h"
22 #include "telemetry_data.h"
23 #include "telemetry_internal.h"
25 #define MAX_CMD_LEN 56
26 #define MAX_OUTPUT_LEN (1024 * 16)
27 #define MAX_CONNECTIONS 10
29 #ifndef RTE_EXEC_ENV_WINDOWS
31 client_handler(void *socket);
32 #endif /* !RTE_EXEC_ENV_WINDOWS */
35 char cmd[MAX_CMD_LEN];
37 char help[RTE_TEL_MAX_STRING_LEN];
40 #ifndef RTE_EXEC_ENV_WINDOWS
43 char path[sizeof(((struct sockaddr_un *)0)->sun_path)];
45 uint16_t *num_clients;
47 static struct socket v2_socket; /* socket for v2 telemetry */
48 static struct socket v1_socket; /* socket for v1 telemetry */
49 #endif /* !RTE_EXEC_ENV_WINDOWS */
51 static const char *telemetry_version; /* save rte_version */
52 static const char *socket_dir; /* runtime directory */
53 static rte_cpuset_t *thread_cpuset;
54 static rte_log_fn rte_log_ptr;
55 static uint32_t logtype;
57 #define TMTY_LOG(l, ...) \
58 rte_log_ptr(RTE_LOG_ ## l, logtype, "TELEMETRY: " __VA_ARGS__)
60 /* list of command callbacks, with one command registered by default */
61 static struct cmd_callback *callbacks;
62 static int num_callbacks; /* How many commands are registered */
63 /* Used when accessing or modifying list of command callbacks */
64 static rte_spinlock_t callback_sl = RTE_SPINLOCK_INITIALIZER;
65 #ifndef RTE_EXEC_ENV_WINDOWS
66 static uint16_t v2_clients;
67 #endif /* !RTE_EXEC_ENV_WINDOWS */
70 rte_telemetry_register_cmd(const char *cmd, telemetry_cb fn, const char *help)
72 struct cmd_callback *new_callbacks;
75 if (strlen(cmd) >= MAX_CMD_LEN || fn == NULL || cmd[0] != '/'
76 || strlen(help) >= RTE_TEL_MAX_STRING_LEN)
79 rte_spinlock_lock(&callback_sl);
80 new_callbacks = realloc(callbacks, sizeof(callbacks[0]) * (num_callbacks + 1));
81 if (new_callbacks == NULL) {
82 rte_spinlock_unlock(&callback_sl);
85 callbacks = new_callbacks;
87 while (i < num_callbacks && strcmp(cmd, callbacks[i].cmd) > 0)
89 if (i != num_callbacks)
90 /* Move elements to keep the list alphabetical */
91 memmove(callbacks + i + 1, callbacks + i,
92 sizeof(struct cmd_callback) * (num_callbacks - i));
94 strlcpy(callbacks[i].cmd, cmd, MAX_CMD_LEN);
96 strlcpy(callbacks[i].help, help, RTE_TEL_MAX_STRING_LEN);
98 rte_spinlock_unlock(&callback_sl);
103 #ifndef RTE_EXEC_ENV_WINDOWS
106 list_commands(const char *cmd __rte_unused, const char *params __rte_unused,
107 struct rte_tel_data *d)
111 rte_tel_data_start_array(d, RTE_TEL_STRING_VAL);
112 rte_spinlock_lock(&callback_sl);
113 for (i = 0; i < num_callbacks; i++)
114 rte_tel_data_add_array_string(d, callbacks[i].cmd);
115 rte_spinlock_unlock(&callback_sl);
120 json_info(const char *cmd __rte_unused, const char *params __rte_unused,
121 struct rte_tel_data *d)
123 rte_tel_data_start_dict(d);
124 rte_tel_data_add_dict_string(d, "version", telemetry_version);
125 rte_tel_data_add_dict_int(d, "pid", getpid());
126 rte_tel_data_add_dict_int(d, "max_output_len", MAX_OUTPUT_LEN);
131 command_help(const char *cmd __rte_unused, const char *params,
132 struct rte_tel_data *d)
138 rte_tel_data_start_dict(d);
139 rte_spinlock_lock(&callback_sl);
140 for (i = 0; i < num_callbacks; i++)
141 if (strcmp(params, callbacks[i].cmd) == 0) {
142 rte_tel_data_add_dict_string(d, params,
146 rte_spinlock_unlock(&callback_sl);
147 if (i == num_callbacks)
153 container_to_json(const struct rte_tel_data *d, char *out_buf, size_t buf_len)
158 if (d->type != RTE_TEL_DICT && d->type != RTE_TEL_ARRAY_U64 &&
159 d->type != RTE_TEL_ARRAY_INT && d->type != RTE_TEL_ARRAY_STRING)
160 return snprintf(out_buf, buf_len, "null");
162 used = rte_tel_json_empty_array(out_buf, buf_len, 0);
163 if (d->type == RTE_TEL_ARRAY_U64)
164 for (i = 0; i < d->data_len; i++)
165 used = rte_tel_json_add_array_u64(out_buf,
167 d->data.array[i].u64val);
168 if (d->type == RTE_TEL_ARRAY_INT)
169 for (i = 0; i < d->data_len; i++)
170 used = rte_tel_json_add_array_int(out_buf,
172 d->data.array[i].ival);
173 if (d->type == RTE_TEL_ARRAY_STRING)
174 for (i = 0; i < d->data_len; i++)
175 used = rte_tel_json_add_array_string(out_buf,
177 d->data.array[i].sval);
178 if (d->type == RTE_TEL_DICT)
179 for (i = 0; i < d->data_len; i++) {
180 const struct tel_dict_entry *v = &d->data.dict[i];
182 case RTE_TEL_STRING_VAL:
183 used = rte_tel_json_add_obj_str(out_buf,
185 v->name, v->value.sval);
187 case RTE_TEL_INT_VAL:
188 used = rte_tel_json_add_obj_int(out_buf,
190 v->name, v->value.ival);
192 case RTE_TEL_U64_VAL:
193 used = rte_tel_json_add_obj_u64(out_buf,
195 v->name, v->value.u64val);
197 case RTE_TEL_CONTAINER:
200 const struct container *cont =
202 if (container_to_json(cont->data,
204 used = rte_tel_json_add_obj_json(
209 rte_tel_data_free(cont->data);
219 output_json(const char *cmd, const struct rte_tel_data *d, int s)
221 char out_buf[MAX_OUTPUT_LEN];
224 size_t buf_len, prefix_used, used = 0;
227 RTE_BUILD_BUG_ON(sizeof(out_buf) < MAX_CMD_LEN +
228 RTE_TEL_MAX_SINGLE_STRING_LEN + 10);
231 used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":null}",
232 MAX_CMD_LEN, cmd ? cmd : "none");
235 used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":\"%.*s\"}",
237 RTE_TEL_MAX_SINGLE_STRING_LEN, d->data.str);
240 prefix_used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":",
242 cb_data_buf = &out_buf[prefix_used];
243 buf_len = sizeof(out_buf) - prefix_used - 1; /* space for '}' */
245 used = rte_tel_json_empty_obj(cb_data_buf, buf_len, 0);
246 for (i = 0; i < d->data_len; i++) {
247 const struct tel_dict_entry *v = &d->data.dict[i];
249 case RTE_TEL_STRING_VAL:
250 used = rte_tel_json_add_obj_str(cb_data_buf,
252 v->name, v->value.sval);
254 case RTE_TEL_INT_VAL:
255 used = rte_tel_json_add_obj_int(cb_data_buf,
257 v->name, v->value.ival);
259 case RTE_TEL_U64_VAL:
260 used = rte_tel_json_add_obj_u64(cb_data_buf,
262 v->name, v->value.u64val);
264 case RTE_TEL_CONTAINER:
267 const struct container *cont =
269 if (container_to_json(cont->data,
271 used = rte_tel_json_add_obj_json(
276 rte_tel_data_free(cont->data);
281 used += strlcat(out_buf + used, "}", sizeof(out_buf) - used);
283 case RTE_TEL_ARRAY_STRING:
284 case RTE_TEL_ARRAY_INT:
285 case RTE_TEL_ARRAY_U64:
286 case RTE_TEL_ARRAY_CONTAINER:
287 prefix_used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":",
289 cb_data_buf = &out_buf[prefix_used];
290 buf_len = sizeof(out_buf) - prefix_used - 1; /* space for '}' */
292 used = rte_tel_json_empty_array(cb_data_buf, buf_len, 0);
293 for (i = 0; i < d->data_len; i++)
294 if (d->type == RTE_TEL_ARRAY_STRING)
295 used = rte_tel_json_add_array_string(
298 d->data.array[i].sval);
299 else if (d->type == RTE_TEL_ARRAY_INT)
300 used = rte_tel_json_add_array_int(cb_data_buf,
302 d->data.array[i].ival);
303 else if (d->type == RTE_TEL_ARRAY_U64)
304 used = rte_tel_json_add_array_u64(cb_data_buf,
306 d->data.array[i].u64val);
307 else if (d->type == RTE_TEL_ARRAY_CONTAINER) {
309 const struct container *rec_data =
310 &d->data.array[i].container;
311 if (container_to_json(rec_data->data,
313 used = rte_tel_json_add_array_json(
315 buf_len, used, temp);
317 rte_tel_data_free(rec_data->data);
320 used += strlcat(out_buf + used, "}", sizeof(out_buf) - used);
323 if (write(s, out_buf, used) < 0)
324 perror("Error writing to socket");
328 perform_command(telemetry_cb fn, const char *cmd, const char *param, int s)
330 struct rte_tel_data data;
332 int ret = fn(cmd, param, &data);
334 char out_buf[MAX_CMD_LEN + 10];
335 int used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":null}",
336 MAX_CMD_LEN, cmd ? cmd : "none");
337 if (write(s, out_buf, used) < 0)
338 perror("Error writing to socket");
341 output_json(cmd, &data, s);
345 unknown_command(const char *cmd __rte_unused, const char *params __rte_unused,
346 struct rte_tel_data *d)
348 return d->type = RTE_TEL_NULL;
352 client_handler(void *sock_id)
354 int s = (int)(uintptr_t)sock_id;
357 snprintf(info_str, sizeof(info_str),
358 "{\"version\":\"%s\",\"pid\":%d,\"max_output_len\":%d}",
359 telemetry_version, getpid(), MAX_OUTPUT_LEN);
360 if (write(s, info_str, strlen(info_str)) < 0) {
365 /* receive data is not null terminated */
366 int bytes = read(s, buffer, sizeof(buffer) - 1);
369 const char *cmd = strtok(buffer, ",");
370 const char *param = strtok(NULL, "\0");
371 telemetry_cb fn = unknown_command;
374 if (cmd && strlen(cmd) < MAX_CMD_LEN) {
375 rte_spinlock_lock(&callback_sl);
376 for (i = 0; i < num_callbacks; i++)
377 if (strcmp(cmd, callbacks[i].cmd) == 0) {
378 fn = callbacks[i].fn;
381 rte_spinlock_unlock(&callback_sl);
383 perform_command(fn, cmd, param, s);
385 bytes = read(s, buffer, sizeof(buffer) - 1);
388 __atomic_sub_fetch(&v2_clients, 1, __ATOMIC_RELAXED);
393 socket_listener(void *socket)
398 struct socket *s = (struct socket *)socket;
399 int s_accepted = accept(s->sock, NULL, NULL);
400 if (s_accepted < 0) {
401 TMTY_LOG(ERR, "Error with accept, telemetry thread quitting\n");
404 if (s->num_clients != NULL) {
405 uint16_t conns = __atomic_load_n(s->num_clients,
407 if (conns >= MAX_CONNECTIONS) {
411 __atomic_add_fetch(s->num_clients, 1,
414 rc = pthread_create(&th, NULL, s->fn,
415 (void *)(uintptr_t)s_accepted);
417 TMTY_LOG(ERR, "Error with create client thread: %s\n",
420 if (s->num_clients != NULL)
421 __atomic_sub_fetch(s->num_clients, 1,
431 get_socket_path(const char *runtime_dir, const int version)
433 static char path[PATH_MAX];
434 snprintf(path, sizeof(path), "%s/dpdk_telemetry.v%d",
435 strlen(runtime_dir) ? runtime_dir : "/tmp", version);
442 if (v2_socket.path[0])
443 unlink(v2_socket.path);
444 if (v1_socket.path[0])
445 unlink(v1_socket.path);
449 create_socket(char *path)
451 int sock = socket(AF_UNIX, SOCK_SEQPACKET, 0);
453 TMTY_LOG(ERR, "Error with socket creation, %s\n", strerror(errno));
457 struct sockaddr_un sun = {.sun_family = AF_UNIX};
458 strlcpy(sun.sun_path, path, sizeof(sun.sun_path));
459 TMTY_LOG(DEBUG, "Attempting socket bind to path '%s'\n", path);
461 if (bind(sock, (void *) &sun, sizeof(sun)) < 0) {
464 TMTY_LOG(DEBUG, "Initial bind to socket '%s' failed.\n", path);
466 /* first check if we have a runtime dir */
467 if (stat(socket_dir, &st) < 0 || !S_ISDIR(st.st_mode)) {
468 TMTY_LOG(ERR, "Cannot access DPDK runtime directory: %s\n", socket_dir);
473 /* check if current socket is active */
474 if (connect(sock, (void *)&sun, sizeof(sun)) == 0) {
479 /* socket is not active, delete and attempt rebind */
480 TMTY_LOG(DEBUG, "Attempting unlink and retrying bind\n");
481 unlink(sun.sun_path);
482 if (bind(sock, (void *) &sun, sizeof(sun)) < 0) {
483 TMTY_LOG(ERR, "Error binding socket: %s\n", strerror(errno));
485 return -errno; /* if unlink failed, this will be -EADDRINUSE as above */
489 if (listen(sock, 1) < 0) {
490 TMTY_LOG(ERR, "Error calling listen for socket: %s\n", strerror(errno));
491 unlink(sun.sun_path);
495 TMTY_LOG(DEBUG, "Socket creation and binding ok\n");
501 set_thread_name(pthread_t id __rte_unused, const char *name __rte_unused)
503 #if defined RTE_EXEC_ENV_LINUX && defined __GLIBC__ && defined __GLIBC_PREREQ
504 #if __GLIBC_PREREQ(2, 12)
505 pthread_setname_np(id, name);
507 #elif defined RTE_EXEC_ENV_FREEBSD
508 pthread_set_name_np(id, name);
513 telemetry_legacy_init(void)
518 if (num_legacy_callbacks == 1) {
519 TMTY_LOG(WARNING, "No legacy callbacks, legacy socket not created\n");
523 v1_socket.fn = legacy_client_handler;
524 if ((size_t) snprintf(v1_socket.path, sizeof(v1_socket.path),
525 "%s/telemetry", socket_dir) >= sizeof(v1_socket.path)) {
526 TMTY_LOG(ERR, "Error with socket binding, path too long\n");
529 v1_socket.sock = create_socket(v1_socket.path);
530 if (v1_socket.sock < 0) {
531 v1_socket.path[0] = '\0';
534 rc = pthread_create(&t_old, NULL, socket_listener, &v1_socket);
536 TMTY_LOG(ERR, "Error with create legacy socket thread: %s\n",
538 close(v1_socket.sock);
540 unlink(v1_socket.path);
541 v1_socket.path[0] = '\0';
544 pthread_setaffinity_np(t_old, sizeof(*thread_cpuset), thread_cpuset);
545 set_thread_name(t_old, "telemetry-v1");
546 TMTY_LOG(DEBUG, "Legacy telemetry socket initialized ok\n");
547 pthread_detach(t_old);
552 telemetry_v2_init(void)
554 char spath[sizeof(v2_socket.path)];
559 v2_socket.num_clients = &v2_clients;
560 rte_telemetry_register_cmd("/", list_commands,
561 "Returns list of available commands, Takes no parameters");
562 rte_telemetry_register_cmd("/info", json_info,
563 "Returns DPDK Telemetry information. Takes no parameters");
564 rte_telemetry_register_cmd("/help", command_help,
565 "Returns help text for a command. Parameters: string command");
566 v2_socket.fn = client_handler;
567 if (strlcpy(spath, get_socket_path(socket_dir, 2), sizeof(spath)) >= sizeof(spath)) {
568 TMTY_LOG(ERR, "Error with socket binding, path too long\n");
571 memcpy(v2_socket.path, spath, sizeof(v2_socket.path));
573 v2_socket.sock = create_socket(v2_socket.path);
574 while (v2_socket.sock < 0) {
575 /* bail out on unexpected error, or suffix wrap-around */
576 if (v2_socket.sock != -EADDRINUSE || suffix < 0) {
577 v2_socket.path[0] = '\0'; /* clear socket path */
580 /* add a suffix to the path if the basic version fails */
581 if (snprintf(v2_socket.path, sizeof(v2_socket.path), "%s:%d",
582 spath, ++suffix) >= (int)sizeof(v2_socket.path)) {
583 TMTY_LOG(ERR, "Error with socket binding, path too long\n");
586 v2_socket.sock = create_socket(v2_socket.path);
588 rc = pthread_create(&t_new, NULL, socket_listener, &v2_socket);
590 TMTY_LOG(ERR, "Error with create socket thread: %s\n",
592 close(v2_socket.sock);
594 unlink(v2_socket.path);
595 v2_socket.path[0] = '\0';
598 pthread_setaffinity_np(t_new, sizeof(*thread_cpuset), thread_cpuset);
599 set_thread_name(t_new, "telemetry-v2");
600 pthread_detach(t_new);
601 atexit(unlink_sockets);
606 #endif /* !RTE_EXEC_ENV_WINDOWS */
609 rte_telemetry_init(const char *runtime_dir, const char *rte_version, rte_cpuset_t *cpuset,
610 rte_log_fn log_fn, uint32_t registered_logtype)
612 telemetry_version = rte_version;
613 socket_dir = runtime_dir;
614 thread_cpuset = cpuset;
615 rte_log_ptr = log_fn;
616 logtype = registered_logtype;
618 #ifndef RTE_EXEC_ENV_WINDOWS
619 if (telemetry_v2_init() != 0)
621 TMTY_LOG(DEBUG, "Telemetry initialized ok\n");
622 telemetry_legacy_init();
623 #endif /* RTE_EXEC_ENV_WINDOWS */