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>
18 #include <rte_version.h>
20 #include "rte_telemetry.h"
21 #include "telemetry_json.h"
22 #include "telemetry_data.h"
23 #include "rte_telemetry_legacy.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 */
51 static char telemetry_log_error[1024]; /* Will contain error on init failure */
52 /* list of command callbacks, with one command registered by default */
53 static struct cmd_callback callbacks[TELEMETRY_MAX_CALLBACKS];
54 static int num_callbacks; /* How many commands are registered */
55 /* Used when accessing or modifying list of command callbacks */
56 static rte_spinlock_t callback_sl = RTE_SPINLOCK_INITIALIZER;
57 #ifndef RTE_EXEC_ENV_WINDOWS
58 static uint16_t v2_clients;
59 #endif /* !RTE_EXEC_ENV_WINDOWS */
62 rte_telemetry_register_cmd(const char *cmd, telemetry_cb fn, const char *help)
66 if (strlen(cmd) >= MAX_CMD_LEN || fn == NULL || cmd[0] != '/'
67 || strlen(help) >= MAX_HELP_LEN)
69 if (num_callbacks >= TELEMETRY_MAX_CALLBACKS)
72 rte_spinlock_lock(&callback_sl);
73 while (i < num_callbacks && strcmp(cmd, callbacks[i].cmd) > 0)
75 if (i != num_callbacks)
76 /* Move elements to keep the list alphabetical */
77 memmove(callbacks + i + 1, callbacks + i,
78 sizeof(struct cmd_callback) * (num_callbacks - i));
80 strlcpy(callbacks[i].cmd, cmd, MAX_CMD_LEN);
82 strlcpy(callbacks[i].help, help, MAX_HELP_LEN);
84 rte_spinlock_unlock(&callback_sl);
89 #ifndef RTE_EXEC_ENV_WINDOWS
92 list_commands(const char *cmd __rte_unused, const char *params __rte_unused,
93 struct rte_tel_data *d)
97 rte_tel_data_start_array(d, RTE_TEL_STRING_VAL);
98 for (i = 0; i < num_callbacks; i++)
99 rte_tel_data_add_array_string(d, callbacks[i].cmd);
104 json_info(const char *cmd __rte_unused, const char *params __rte_unused,
105 struct rte_tel_data *d)
107 rte_tel_data_start_dict(d);
108 rte_tel_data_add_dict_string(d, "version", rte_version());
109 rte_tel_data_add_dict_int(d, "pid", getpid());
110 rte_tel_data_add_dict_int(d, "max_output_len", MAX_OUTPUT_LEN);
115 command_help(const char *cmd __rte_unused, const char *params,
116 struct rte_tel_data *d)
122 rte_tel_data_start_dict(d);
123 rte_spinlock_lock(&callback_sl);
124 for (i = 0; i < num_callbacks; i++)
125 if (strcmp(params, callbacks[i].cmd) == 0) {
126 rte_tel_data_add_dict_string(d, params,
130 rte_spinlock_unlock(&callback_sl);
131 if (i == num_callbacks)
137 container_to_json(const struct rte_tel_data *d, char *out_buf, size_t buf_len)
142 if (d->type != RTE_TEL_ARRAY_U64 && d->type != RTE_TEL_ARRAY_INT
143 && d->type != RTE_TEL_ARRAY_STRING)
144 return snprintf(out_buf, buf_len, "null");
146 used = rte_tel_json_empty_array(out_buf, buf_len, 0);
147 if (d->type == RTE_TEL_ARRAY_U64)
148 for (i = 0; i < d->data_len; i++)
149 used = rte_tel_json_add_array_u64(out_buf,
151 d->data.array[i].u64val);
152 if (d->type == RTE_TEL_ARRAY_INT)
153 for (i = 0; i < d->data_len; i++)
154 used = rte_tel_json_add_array_int(out_buf,
156 d->data.array[i].ival);
157 if (d->type == RTE_TEL_ARRAY_STRING)
158 for (i = 0; i < d->data_len; i++)
159 used = rte_tel_json_add_array_string(out_buf,
161 d->data.array[i].sval);
166 output_json(const char *cmd, const struct rte_tel_data *d, int s)
168 char out_buf[MAX_OUTPUT_LEN];
171 size_t buf_len, prefix_used, used = 0;
174 RTE_BUILD_BUG_ON(sizeof(out_buf) < MAX_CMD_LEN +
175 RTE_TEL_MAX_SINGLE_STRING_LEN + 10);
178 used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":null}",
179 MAX_CMD_LEN, cmd ? cmd : "none");
182 used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":\"%.*s\"}",
184 RTE_TEL_MAX_SINGLE_STRING_LEN, d->data.str);
187 prefix_used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":",
189 cb_data_buf = &out_buf[prefix_used];
190 buf_len = sizeof(out_buf) - prefix_used - 1; /* space for '}' */
192 used = rte_tel_json_empty_obj(cb_data_buf, buf_len, 0);
193 for (i = 0; i < d->data_len; i++) {
194 const struct tel_dict_entry *v = &d->data.dict[i];
196 case RTE_TEL_STRING_VAL:
197 used = rte_tel_json_add_obj_str(cb_data_buf,
199 v->name, v->value.sval);
201 case RTE_TEL_INT_VAL:
202 used = rte_tel_json_add_obj_int(cb_data_buf,
204 v->name, v->value.ival);
206 case RTE_TEL_U64_VAL:
207 used = rte_tel_json_add_obj_u64(cb_data_buf,
209 v->name, v->value.u64val);
211 case RTE_TEL_CONTAINER:
214 const struct container *cont =
216 if (container_to_json(cont->data,
218 used = rte_tel_json_add_obj_json(
223 rte_tel_data_free(cont->data);
228 used += strlcat(out_buf + used, "}", sizeof(out_buf) - used);
230 case RTE_TEL_ARRAY_STRING:
231 case RTE_TEL_ARRAY_INT:
232 case RTE_TEL_ARRAY_U64:
233 case RTE_TEL_ARRAY_CONTAINER:
234 prefix_used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":",
236 cb_data_buf = &out_buf[prefix_used];
237 buf_len = sizeof(out_buf) - prefix_used - 1; /* space for '}' */
239 used = rte_tel_json_empty_array(cb_data_buf, buf_len, 0);
240 for (i = 0; i < d->data_len; i++)
241 if (d->type == RTE_TEL_ARRAY_STRING)
242 used = rte_tel_json_add_array_string(
245 d->data.array[i].sval);
246 else if (d->type == RTE_TEL_ARRAY_INT)
247 used = rte_tel_json_add_array_int(cb_data_buf,
249 d->data.array[i].ival);
250 else if (d->type == RTE_TEL_ARRAY_U64)
251 used = rte_tel_json_add_array_u64(cb_data_buf,
253 d->data.array[i].u64val);
254 else if (d->type == RTE_TEL_ARRAY_CONTAINER) {
256 const struct container *rec_data =
257 &d->data.array[i].container;
258 if (container_to_json(rec_data->data,
260 used = rte_tel_json_add_array_json(
262 buf_len, used, temp);
264 rte_tel_data_free(rec_data->data);
267 used += strlcat(out_buf + used, "}", sizeof(out_buf) - used);
270 if (write(s, out_buf, used) < 0)
271 perror("Error writing to socket");
275 perform_command(telemetry_cb fn, const char *cmd, const char *param, int s)
277 struct rte_tel_data data;
279 int ret = fn(cmd, param, &data);
281 char out_buf[MAX_CMD_LEN + 10];
282 int used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":null}",
283 MAX_CMD_LEN, cmd ? cmd : "none");
284 if (write(s, out_buf, used) < 0)
285 perror("Error writing to socket");
288 output_json(cmd, &data, s);
292 unknown_command(const char *cmd __rte_unused, const char *params __rte_unused,
293 struct rte_tel_data *d)
295 return d->type = RTE_TEL_NULL;
299 client_handler(void *sock_id)
301 int s = (int)(uintptr_t)sock_id;
304 snprintf(info_str, sizeof(info_str),
305 "{\"version\":\"%s\",\"pid\":%d,\"max_output_len\":%d}",
306 rte_version(), getpid(), MAX_OUTPUT_LEN);
307 if (write(s, info_str, strlen(info_str)) < 0) {
312 /* receive data is not null terminated */
313 int bytes = read(s, buffer, sizeof(buffer) - 1);
316 const char *cmd = strtok(buffer, ",");
317 const char *param = strtok(NULL, "\0");
318 telemetry_cb fn = unknown_command;
321 if (cmd && strlen(cmd) < MAX_CMD_LEN) {
322 rte_spinlock_lock(&callback_sl);
323 for (i = 0; i < num_callbacks; i++)
324 if (strcmp(cmd, callbacks[i].cmd) == 0) {
325 fn = callbacks[i].fn;
328 rte_spinlock_unlock(&callback_sl);
330 perform_command(fn, cmd, param, s);
332 bytes = read(s, buffer, sizeof(buffer) - 1);
335 __atomic_sub_fetch(&v2_clients, 1, __ATOMIC_RELAXED);
340 socket_listener(void *socket)
344 struct socket *s = (struct socket *)socket;
345 int s_accepted = accept(s->sock, NULL, NULL);
346 if (s_accepted < 0) {
347 snprintf(telemetry_log_error,
348 sizeof(telemetry_log_error),
349 "Error with accept, telemetry thread quitting");
352 if (s->num_clients != NULL) {
353 uint16_t conns = __atomic_load_n(s->num_clients,
355 if (conns >= MAX_CONNECTIONS) {
359 __atomic_add_fetch(s->num_clients, 1,
362 pthread_create(&th, NULL, s->fn, (void *)(uintptr_t)s_accepted);
369 get_socket_path(const char *runtime_dir, const int version)
371 static char path[PATH_MAX];
372 snprintf(path, sizeof(path), "%s/dpdk_telemetry.v%d",
373 strlen(runtime_dir) ? runtime_dir : "/tmp", version);
380 if (v2_socket.path[0])
381 unlink(v2_socket.path);
382 if (v1_socket.path[0])
383 unlink(v1_socket.path);
387 create_socket(char *path)
389 int sock = socket(AF_UNIX, SOCK_SEQPACKET, 0);
391 snprintf(telemetry_log_error, sizeof(telemetry_log_error),
392 "Error with socket creation, %s",
397 struct sockaddr_un sun = {.sun_family = AF_UNIX};
398 strlcpy(sun.sun_path, path, sizeof(sun.sun_path));
399 unlink(sun.sun_path);
400 if (bind(sock, (void *) &sun, sizeof(sun)) < 0) {
401 snprintf(telemetry_log_error, sizeof(telemetry_log_error),
402 "Error binding socket: %s",
408 if (listen(sock, 1) < 0) {
409 snprintf(telemetry_log_error, sizeof(telemetry_log_error),
410 "Error calling listen for socket: %s",
424 telemetry_legacy_init(const char *runtime_dir, rte_cpuset_t *cpuset)
428 if (num_legacy_callbacks == 1) {
429 snprintf(telemetry_log_error, sizeof(telemetry_log_error),
430 "No legacy callbacks, legacy socket not created");
434 v1_socket.fn = legacy_client_handler;
435 if ((size_t) snprintf(v1_socket.path, sizeof(v1_socket.path),
436 "%s/telemetry", runtime_dir)
437 >= sizeof(v1_socket.path)) {
438 snprintf(telemetry_log_error, sizeof(telemetry_log_error),
439 "Error with socket binding, path too long");
442 v1_socket.sock = create_socket(v1_socket.path);
443 if (v1_socket.sock < 0)
445 pthread_create(&t_old, NULL, socket_listener, &v1_socket);
446 pthread_setaffinity_np(t_old, sizeof(*cpuset), cpuset);
452 telemetry_v2_init(const char *runtime_dir, rte_cpuset_t *cpuset)
456 v2_socket.num_clients = &v2_clients;
457 rte_telemetry_register_cmd("/", list_commands,
458 "Returns list of available commands, Takes no parameters");
459 rte_telemetry_register_cmd("/info", json_info,
460 "Returns DPDK Telemetry information. Takes no parameters");
461 rte_telemetry_register_cmd("/help", command_help,
462 "Returns help text for a command. Parameters: string command");
463 v2_socket.fn = client_handler;
464 if (strlcpy(v2_socket.path, get_socket_path(runtime_dir, 2),
465 sizeof(v2_socket.path)) >= sizeof(v2_socket.path)) {
466 snprintf(telemetry_log_error, sizeof(telemetry_log_error),
467 "Error with socket binding, path too long");
471 v2_socket.sock = create_socket(v2_socket.path);
472 if (v2_socket.sock < 0)
474 pthread_create(&t_new, NULL, socket_listener, &v2_socket);
475 pthread_setaffinity_np(t_new, sizeof(*cpuset), cpuset);
476 atexit(unlink_sockets);
481 #endif /* !RTE_EXEC_ENV_WINDOWS */
484 rte_telemetry_init(const char *runtime_dir, rte_cpuset_t *cpuset,
485 const char **err_str)
487 #ifndef RTE_EXEC_ENV_WINDOWS
488 if (telemetry_v2_init(runtime_dir, cpuset) != 0) {
489 *err_str = telemetry_log_error;
492 if (telemetry_legacy_init(runtime_dir, cpuset) != 0) {
493 *err_str = telemetry_log_error;
495 #else /* RTE_EXEC_ENV_WINDOWS */
496 RTE_SET_USED(runtime_dir);
497 RTE_SET_USED(cpuset);
498 RTE_SET_USED(err_str);
500 snprintf(telemetry_log_error, sizeof(telemetry_log_error),
501 "DPDK Telemetry is not supported on Windows.");
502 #endif /* RTE_EXEC_ENV_WINDOWS */