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_HELP_LEN 64
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[MAX_HELP_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[TELEMETRY_MAX_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)
75 if (strlen(cmd) >= MAX_CMD_LEN || fn == NULL || cmd[0] != '/'
76 || strlen(help) >= MAX_HELP_LEN)
78 if (num_callbacks >= TELEMETRY_MAX_CALLBACKS)
81 rte_spinlock_lock(&callback_sl);
82 while (i < num_callbacks && strcmp(cmd, callbacks[i].cmd) > 0)
84 if (i != num_callbacks)
85 /* Move elements to keep the list alphabetical */
86 memmove(callbacks + i + 1, callbacks + i,
87 sizeof(struct cmd_callback) * (num_callbacks - i));
89 strlcpy(callbacks[i].cmd, cmd, MAX_CMD_LEN);
91 strlcpy(callbacks[i].help, help, MAX_HELP_LEN);
93 rte_spinlock_unlock(&callback_sl);
98 #ifndef RTE_EXEC_ENV_WINDOWS
101 list_commands(const char *cmd __rte_unused, const char *params __rte_unused,
102 struct rte_tel_data *d)
106 rte_tel_data_start_array(d, RTE_TEL_STRING_VAL);
107 for (i = 0; i < num_callbacks; i++)
108 rte_tel_data_add_array_string(d, callbacks[i].cmd);
113 json_info(const char *cmd __rte_unused, const char *params __rte_unused,
114 struct rte_tel_data *d)
116 rte_tel_data_start_dict(d);
117 rte_tel_data_add_dict_string(d, "version", telemetry_version);
118 rte_tel_data_add_dict_int(d, "pid", getpid());
119 rte_tel_data_add_dict_int(d, "max_output_len", MAX_OUTPUT_LEN);
124 command_help(const char *cmd __rte_unused, const char *params,
125 struct rte_tel_data *d)
131 rte_tel_data_start_dict(d);
132 rte_spinlock_lock(&callback_sl);
133 for (i = 0; i < num_callbacks; i++)
134 if (strcmp(params, callbacks[i].cmd) == 0) {
135 rte_tel_data_add_dict_string(d, params,
139 rte_spinlock_unlock(&callback_sl);
140 if (i == num_callbacks)
146 container_to_json(const struct rte_tel_data *d, char *out_buf, size_t buf_len)
151 if (d->type != RTE_TEL_ARRAY_U64 && d->type != RTE_TEL_ARRAY_INT
152 && d->type != RTE_TEL_ARRAY_STRING)
153 return snprintf(out_buf, buf_len, "null");
155 used = rte_tel_json_empty_array(out_buf, buf_len, 0);
156 if (d->type == RTE_TEL_ARRAY_U64)
157 for (i = 0; i < d->data_len; i++)
158 used = rte_tel_json_add_array_u64(out_buf,
160 d->data.array[i].u64val);
161 if (d->type == RTE_TEL_ARRAY_INT)
162 for (i = 0; i < d->data_len; i++)
163 used = rte_tel_json_add_array_int(out_buf,
165 d->data.array[i].ival);
166 if (d->type == RTE_TEL_ARRAY_STRING)
167 for (i = 0; i < d->data_len; i++)
168 used = rte_tel_json_add_array_string(out_buf,
170 d->data.array[i].sval);
175 output_json(const char *cmd, const struct rte_tel_data *d, int s)
177 char out_buf[MAX_OUTPUT_LEN];
180 size_t buf_len, prefix_used, used = 0;
183 RTE_BUILD_BUG_ON(sizeof(out_buf) < MAX_CMD_LEN +
184 RTE_TEL_MAX_SINGLE_STRING_LEN + 10);
187 used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":null}",
188 MAX_CMD_LEN, cmd ? cmd : "none");
191 used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":\"%.*s\"}",
193 RTE_TEL_MAX_SINGLE_STRING_LEN, d->data.str);
196 prefix_used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":",
198 cb_data_buf = &out_buf[prefix_used];
199 buf_len = sizeof(out_buf) - prefix_used - 1; /* space for '}' */
201 used = rte_tel_json_empty_obj(cb_data_buf, buf_len, 0);
202 for (i = 0; i < d->data_len; i++) {
203 const struct tel_dict_entry *v = &d->data.dict[i];
205 case RTE_TEL_STRING_VAL:
206 used = rte_tel_json_add_obj_str(cb_data_buf,
208 v->name, v->value.sval);
210 case RTE_TEL_INT_VAL:
211 used = rte_tel_json_add_obj_int(cb_data_buf,
213 v->name, v->value.ival);
215 case RTE_TEL_U64_VAL:
216 used = rte_tel_json_add_obj_u64(cb_data_buf,
218 v->name, v->value.u64val);
220 case RTE_TEL_CONTAINER:
223 const struct container *cont =
225 if (container_to_json(cont->data,
227 used = rte_tel_json_add_obj_json(
232 rte_tel_data_free(cont->data);
237 used += strlcat(out_buf + used, "}", sizeof(out_buf) - used);
239 case RTE_TEL_ARRAY_STRING:
240 case RTE_TEL_ARRAY_INT:
241 case RTE_TEL_ARRAY_U64:
242 case RTE_TEL_ARRAY_CONTAINER:
243 prefix_used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":",
245 cb_data_buf = &out_buf[prefix_used];
246 buf_len = sizeof(out_buf) - prefix_used - 1; /* space for '}' */
248 used = rte_tel_json_empty_array(cb_data_buf, buf_len, 0);
249 for (i = 0; i < d->data_len; i++)
250 if (d->type == RTE_TEL_ARRAY_STRING)
251 used = rte_tel_json_add_array_string(
254 d->data.array[i].sval);
255 else if (d->type == RTE_TEL_ARRAY_INT)
256 used = rte_tel_json_add_array_int(cb_data_buf,
258 d->data.array[i].ival);
259 else if (d->type == RTE_TEL_ARRAY_U64)
260 used = rte_tel_json_add_array_u64(cb_data_buf,
262 d->data.array[i].u64val);
263 else if (d->type == RTE_TEL_ARRAY_CONTAINER) {
265 const struct container *rec_data =
266 &d->data.array[i].container;
267 if (container_to_json(rec_data->data,
269 used = rte_tel_json_add_array_json(
271 buf_len, used, temp);
273 rte_tel_data_free(rec_data->data);
276 used += strlcat(out_buf + used, "}", sizeof(out_buf) - used);
279 if (write(s, out_buf, used) < 0)
280 perror("Error writing to socket");
284 perform_command(telemetry_cb fn, const char *cmd, const char *param, int s)
286 struct rte_tel_data data;
288 int ret = fn(cmd, param, &data);
290 char out_buf[MAX_CMD_LEN + 10];
291 int used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":null}",
292 MAX_CMD_LEN, cmd ? cmd : "none");
293 if (write(s, out_buf, used) < 0)
294 perror("Error writing to socket");
297 output_json(cmd, &data, s);
301 unknown_command(const char *cmd __rte_unused, const char *params __rte_unused,
302 struct rte_tel_data *d)
304 return d->type = RTE_TEL_NULL;
308 client_handler(void *sock_id)
310 int s = (int)(uintptr_t)sock_id;
313 snprintf(info_str, sizeof(info_str),
314 "{\"version\":\"%s\",\"pid\":%d,\"max_output_len\":%d}",
315 telemetry_version, getpid(), MAX_OUTPUT_LEN);
316 if (write(s, info_str, strlen(info_str)) < 0) {
321 /* receive data is not null terminated */
322 int bytes = read(s, buffer, sizeof(buffer) - 1);
325 const char *cmd = strtok(buffer, ",");
326 const char *param = strtok(NULL, "\0");
327 telemetry_cb fn = unknown_command;
330 if (cmd && strlen(cmd) < MAX_CMD_LEN) {
331 rte_spinlock_lock(&callback_sl);
332 for (i = 0; i < num_callbacks; i++)
333 if (strcmp(cmd, callbacks[i].cmd) == 0) {
334 fn = callbacks[i].fn;
337 rte_spinlock_unlock(&callback_sl);
339 perform_command(fn, cmd, param, s);
341 bytes = read(s, buffer, sizeof(buffer) - 1);
344 __atomic_sub_fetch(&v2_clients, 1, __ATOMIC_RELAXED);
349 socket_listener(void *socket)
353 struct socket *s = (struct socket *)socket;
354 int s_accepted = accept(s->sock, NULL, NULL);
355 if (s_accepted < 0) {
356 TMTY_LOG(ERR, "Error with accept, telemetry thread quitting\n");
359 if (s->num_clients != NULL) {
360 uint16_t conns = __atomic_load_n(s->num_clients,
362 if (conns >= MAX_CONNECTIONS) {
366 __atomic_add_fetch(s->num_clients, 1,
369 pthread_create(&th, NULL, s->fn, (void *)(uintptr_t)s_accepted);
376 get_socket_path(const char *runtime_dir, const int version)
378 static char path[PATH_MAX];
379 snprintf(path, sizeof(path), "%s/dpdk_telemetry.v%d",
380 strlen(runtime_dir) ? runtime_dir : "/tmp", version);
387 if (v2_socket.path[0])
388 unlink(v2_socket.path);
389 if (v1_socket.path[0])
390 unlink(v1_socket.path);
394 create_socket(char *path)
396 int sock = socket(AF_UNIX, SOCK_SEQPACKET, 0);
398 TMTY_LOG(ERR, "Error with socket creation, %s\n", strerror(errno));
402 struct sockaddr_un sun = {.sun_family = AF_UNIX};
403 strlcpy(sun.sun_path, path, sizeof(sun.sun_path));
404 unlink(sun.sun_path);
405 if (bind(sock, (void *) &sun, sizeof(sun)) < 0) {
406 TMTY_LOG(ERR, "Error binding socket: %s\n", strerror(errno));
411 if (listen(sock, 1) < 0) {
412 TMTY_LOG(ERR, "Error calling listen for socket: %s\n", strerror(errno));
425 telemetry_legacy_init(void)
429 if (num_legacy_callbacks == 1) {
430 TMTY_LOG(WARNING, "No legacy callbacks, legacy socket not created\n");
434 v1_socket.fn = legacy_client_handler;
435 if ((size_t) snprintf(v1_socket.path, sizeof(v1_socket.path),
436 "%s/telemetry", socket_dir) >= sizeof(v1_socket.path)) {
437 TMTY_LOG(ERR, "Error with socket binding, path too long\n");
440 v1_socket.sock = create_socket(v1_socket.path);
441 if (v1_socket.sock < 0)
443 pthread_create(&t_old, NULL, socket_listener, &v1_socket);
444 pthread_setaffinity_np(t_old, sizeof(*thread_cpuset), thread_cpuset);
446 TMTY_LOG(DEBUG, "Legacy telemetry socket initialized ok\n");
451 telemetry_v2_init(void)
455 v2_socket.num_clients = &v2_clients;
456 rte_telemetry_register_cmd("/", list_commands,
457 "Returns list of available commands, Takes no parameters");
458 rte_telemetry_register_cmd("/info", json_info,
459 "Returns DPDK Telemetry information. Takes no parameters");
460 rte_telemetry_register_cmd("/help", command_help,
461 "Returns help text for a command. Parameters: string command");
462 v2_socket.fn = client_handler;
463 if (strlcpy(v2_socket.path, get_socket_path(socket_dir, 2),
464 sizeof(v2_socket.path)) >= sizeof(v2_socket.path)) {
465 TMTY_LOG(ERR, "Error with socket binding, path too long\n");
469 v2_socket.sock = create_socket(v2_socket.path);
470 if (v2_socket.sock < 0)
472 pthread_create(&t_new, NULL, socket_listener, &v2_socket);
473 pthread_setaffinity_np(t_new, sizeof(*thread_cpuset), thread_cpuset);
474 atexit(unlink_sockets);
479 #endif /* !RTE_EXEC_ENV_WINDOWS */
482 rte_telemetry_init(const char *runtime_dir, const char *rte_version, rte_cpuset_t *cpuset,
483 rte_log_fn log_fn, uint32_t registered_logtype)
485 telemetry_version = rte_version;
486 socket_dir = runtime_dir;
487 thread_cpuset = cpuset;
488 rte_log_ptr = log_fn;
489 logtype = registered_logtype;
491 #ifndef RTE_EXEC_ENV_WINDOWS
492 if (telemetry_v2_init() != 0)
494 TMTY_LOG(DEBUG, "Telemetry initialized ok\n");
495 telemetry_legacy_init();
496 #endif /* RTE_EXEC_ENV_WINDOWS */