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>
19 #include "rte_telemetry.h"
20 #include "telemetry_json.h"
21 #include "telemetry_data.h"
22 #include "rte_telemetry_legacy.h"
24 #define MAX_CMD_LEN 56
25 #define MAX_HELP_LEN 64
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[MAX_HELP_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 char telemetry_log_error[1024]; /* Will contain error on init failure */
53 /* list of command callbacks, with one command registered by default */
54 static struct cmd_callback callbacks[TELEMETRY_MAX_CALLBACKS];
55 static int num_callbacks; /* How many commands are registered */
56 /* Used when accessing or modifying list of command callbacks */
57 static rte_spinlock_t callback_sl = RTE_SPINLOCK_INITIALIZER;
58 #ifndef RTE_EXEC_ENV_WINDOWS
59 static uint16_t v2_clients;
60 #endif /* !RTE_EXEC_ENV_WINDOWS */
63 rte_telemetry_register_cmd(const char *cmd, telemetry_cb fn, const char *help)
67 if (strlen(cmd) >= MAX_CMD_LEN || fn == NULL || cmd[0] != '/'
68 || strlen(help) >= MAX_HELP_LEN)
70 if (num_callbacks >= TELEMETRY_MAX_CALLBACKS)
73 rte_spinlock_lock(&callback_sl);
74 while (i < num_callbacks && strcmp(cmd, callbacks[i].cmd) > 0)
76 if (i != num_callbacks)
77 /* Move elements to keep the list alphabetical */
78 memmove(callbacks + i + 1, callbacks + i,
79 sizeof(struct cmd_callback) * (num_callbacks - i));
81 strlcpy(callbacks[i].cmd, cmd, MAX_CMD_LEN);
83 strlcpy(callbacks[i].help, help, MAX_HELP_LEN);
85 rte_spinlock_unlock(&callback_sl);
90 #ifndef RTE_EXEC_ENV_WINDOWS
93 list_commands(const char *cmd __rte_unused, const char *params __rte_unused,
94 struct rte_tel_data *d)
98 rte_tel_data_start_array(d, RTE_TEL_STRING_VAL);
99 for (i = 0; i < num_callbacks; i++)
100 rte_tel_data_add_array_string(d, callbacks[i].cmd);
105 json_info(const char *cmd __rte_unused, const char *params __rte_unused,
106 struct rte_tel_data *d)
108 rte_tel_data_start_dict(d);
109 rte_tel_data_add_dict_string(d, "version", telemetry_version);
110 rte_tel_data_add_dict_int(d, "pid", getpid());
111 rte_tel_data_add_dict_int(d, "max_output_len", MAX_OUTPUT_LEN);
116 command_help(const char *cmd __rte_unused, const char *params,
117 struct rte_tel_data *d)
123 rte_tel_data_start_dict(d);
124 rte_spinlock_lock(&callback_sl);
125 for (i = 0; i < num_callbacks; i++)
126 if (strcmp(params, callbacks[i].cmd) == 0) {
127 rte_tel_data_add_dict_string(d, params,
131 rte_spinlock_unlock(&callback_sl);
132 if (i == num_callbacks)
138 container_to_json(const struct rte_tel_data *d, char *out_buf, size_t buf_len)
143 if (d->type != RTE_TEL_ARRAY_U64 && d->type != RTE_TEL_ARRAY_INT
144 && d->type != RTE_TEL_ARRAY_STRING)
145 return snprintf(out_buf, buf_len, "null");
147 used = rte_tel_json_empty_array(out_buf, buf_len, 0);
148 if (d->type == RTE_TEL_ARRAY_U64)
149 for (i = 0; i < d->data_len; i++)
150 used = rte_tel_json_add_array_u64(out_buf,
152 d->data.array[i].u64val);
153 if (d->type == RTE_TEL_ARRAY_INT)
154 for (i = 0; i < d->data_len; i++)
155 used = rte_tel_json_add_array_int(out_buf,
157 d->data.array[i].ival);
158 if (d->type == RTE_TEL_ARRAY_STRING)
159 for (i = 0; i < d->data_len; i++)
160 used = rte_tel_json_add_array_string(out_buf,
162 d->data.array[i].sval);
167 output_json(const char *cmd, const struct rte_tel_data *d, int s)
169 char out_buf[MAX_OUTPUT_LEN];
172 size_t buf_len, prefix_used, used = 0;
175 RTE_BUILD_BUG_ON(sizeof(out_buf) < MAX_CMD_LEN +
176 RTE_TEL_MAX_SINGLE_STRING_LEN + 10);
179 used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":null}",
180 MAX_CMD_LEN, cmd ? cmd : "none");
183 used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":\"%.*s\"}",
185 RTE_TEL_MAX_SINGLE_STRING_LEN, d->data.str);
188 prefix_used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":",
190 cb_data_buf = &out_buf[prefix_used];
191 buf_len = sizeof(out_buf) - prefix_used - 1; /* space for '}' */
193 used = rte_tel_json_empty_obj(cb_data_buf, buf_len, 0);
194 for (i = 0; i < d->data_len; i++) {
195 const struct tel_dict_entry *v = &d->data.dict[i];
197 case RTE_TEL_STRING_VAL:
198 used = rte_tel_json_add_obj_str(cb_data_buf,
200 v->name, v->value.sval);
202 case RTE_TEL_INT_VAL:
203 used = rte_tel_json_add_obj_int(cb_data_buf,
205 v->name, v->value.ival);
207 case RTE_TEL_U64_VAL:
208 used = rte_tel_json_add_obj_u64(cb_data_buf,
210 v->name, v->value.u64val);
212 case RTE_TEL_CONTAINER:
215 const struct container *cont =
217 if (container_to_json(cont->data,
219 used = rte_tel_json_add_obj_json(
224 rte_tel_data_free(cont->data);
229 used += strlcat(out_buf + used, "}", sizeof(out_buf) - used);
231 case RTE_TEL_ARRAY_STRING:
232 case RTE_TEL_ARRAY_INT:
233 case RTE_TEL_ARRAY_U64:
234 case RTE_TEL_ARRAY_CONTAINER:
235 prefix_used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":",
237 cb_data_buf = &out_buf[prefix_used];
238 buf_len = sizeof(out_buf) - prefix_used - 1; /* space for '}' */
240 used = rte_tel_json_empty_array(cb_data_buf, buf_len, 0);
241 for (i = 0; i < d->data_len; i++)
242 if (d->type == RTE_TEL_ARRAY_STRING)
243 used = rte_tel_json_add_array_string(
246 d->data.array[i].sval);
247 else if (d->type == RTE_TEL_ARRAY_INT)
248 used = rte_tel_json_add_array_int(cb_data_buf,
250 d->data.array[i].ival);
251 else if (d->type == RTE_TEL_ARRAY_U64)
252 used = rte_tel_json_add_array_u64(cb_data_buf,
254 d->data.array[i].u64val);
255 else if (d->type == RTE_TEL_ARRAY_CONTAINER) {
257 const struct container *rec_data =
258 &d->data.array[i].container;
259 if (container_to_json(rec_data->data,
261 used = rte_tel_json_add_array_json(
263 buf_len, used, temp);
265 rte_tel_data_free(rec_data->data);
268 used += strlcat(out_buf + used, "}", sizeof(out_buf) - used);
271 if (write(s, out_buf, used) < 0)
272 perror("Error writing to socket");
276 perform_command(telemetry_cb fn, const char *cmd, const char *param, int s)
278 struct rte_tel_data data;
280 int ret = fn(cmd, param, &data);
282 char out_buf[MAX_CMD_LEN + 10];
283 int used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":null}",
284 MAX_CMD_LEN, cmd ? cmd : "none");
285 if (write(s, out_buf, used) < 0)
286 perror("Error writing to socket");
289 output_json(cmd, &data, s);
293 unknown_command(const char *cmd __rte_unused, const char *params __rte_unused,
294 struct rte_tel_data *d)
296 return d->type = RTE_TEL_NULL;
300 client_handler(void *sock_id)
302 int s = (int)(uintptr_t)sock_id;
305 snprintf(info_str, sizeof(info_str),
306 "{\"version\":\"%s\",\"pid\":%d,\"max_output_len\":%d}",
307 telemetry_version, getpid(), MAX_OUTPUT_LEN);
308 if (write(s, info_str, strlen(info_str)) < 0) {
313 /* receive data is not null terminated */
314 int bytes = read(s, buffer, sizeof(buffer) - 1);
317 const char *cmd = strtok(buffer, ",");
318 const char *param = strtok(NULL, "\0");
319 telemetry_cb fn = unknown_command;
322 if (cmd && strlen(cmd) < MAX_CMD_LEN) {
323 rte_spinlock_lock(&callback_sl);
324 for (i = 0; i < num_callbacks; i++)
325 if (strcmp(cmd, callbacks[i].cmd) == 0) {
326 fn = callbacks[i].fn;
329 rte_spinlock_unlock(&callback_sl);
331 perform_command(fn, cmd, param, s);
333 bytes = read(s, buffer, sizeof(buffer) - 1);
336 __atomic_sub_fetch(&v2_clients, 1, __ATOMIC_RELAXED);
341 socket_listener(void *socket)
345 struct socket *s = (struct socket *)socket;
346 int s_accepted = accept(s->sock, NULL, NULL);
347 if (s_accepted < 0) {
348 snprintf(telemetry_log_error,
349 sizeof(telemetry_log_error),
350 "Error with accept, telemetry thread quitting");
353 if (s->num_clients != NULL) {
354 uint16_t conns = __atomic_load_n(s->num_clients,
356 if (conns >= MAX_CONNECTIONS) {
360 __atomic_add_fetch(s->num_clients, 1,
363 pthread_create(&th, NULL, s->fn, (void *)(uintptr_t)s_accepted);
370 get_socket_path(const char *runtime_dir, const int version)
372 static char path[PATH_MAX];
373 snprintf(path, sizeof(path), "%s/dpdk_telemetry.v%d",
374 strlen(runtime_dir) ? runtime_dir : "/tmp", version);
381 if (v2_socket.path[0])
382 unlink(v2_socket.path);
383 if (v1_socket.path[0])
384 unlink(v1_socket.path);
388 create_socket(char *path)
390 int sock = socket(AF_UNIX, SOCK_SEQPACKET, 0);
392 snprintf(telemetry_log_error, sizeof(telemetry_log_error),
393 "Error with socket creation, %s",
398 struct sockaddr_un sun = {.sun_family = AF_UNIX};
399 strlcpy(sun.sun_path, path, sizeof(sun.sun_path));
400 unlink(sun.sun_path);
401 if (bind(sock, (void *) &sun, sizeof(sun)) < 0) {
402 snprintf(telemetry_log_error, sizeof(telemetry_log_error),
403 "Error binding socket: %s",
409 if (listen(sock, 1) < 0) {
410 snprintf(telemetry_log_error, sizeof(telemetry_log_error),
411 "Error calling listen for socket: %s",
425 telemetry_legacy_init(const char *runtime_dir, rte_cpuset_t *cpuset)
429 if (num_legacy_callbacks == 1) {
430 snprintf(telemetry_log_error, sizeof(telemetry_log_error),
431 "No legacy callbacks, legacy socket not created");
435 v1_socket.fn = legacy_client_handler;
436 if ((size_t) snprintf(v1_socket.path, sizeof(v1_socket.path),
437 "%s/telemetry", runtime_dir)
438 >= sizeof(v1_socket.path)) {
439 snprintf(telemetry_log_error, sizeof(telemetry_log_error),
440 "Error with socket binding, path too long");
443 v1_socket.sock = create_socket(v1_socket.path);
444 if (v1_socket.sock < 0)
446 pthread_create(&t_old, NULL, socket_listener, &v1_socket);
447 pthread_setaffinity_np(t_old, sizeof(*cpuset), cpuset);
453 telemetry_v2_init(const char *runtime_dir, rte_cpuset_t *cpuset)
457 v2_socket.num_clients = &v2_clients;
458 rte_telemetry_register_cmd("/", list_commands,
459 "Returns list of available commands, Takes no parameters");
460 rte_telemetry_register_cmd("/info", json_info,
461 "Returns DPDK Telemetry information. Takes no parameters");
462 rte_telemetry_register_cmd("/help", command_help,
463 "Returns help text for a command. Parameters: string command");
464 v2_socket.fn = client_handler;
465 if (strlcpy(v2_socket.path, get_socket_path(runtime_dir, 2),
466 sizeof(v2_socket.path)) >= sizeof(v2_socket.path)) {
467 snprintf(telemetry_log_error, sizeof(telemetry_log_error),
468 "Error with socket binding, path too long");
472 v2_socket.sock = create_socket(v2_socket.path);
473 if (v2_socket.sock < 0)
475 pthread_create(&t_new, NULL, socket_listener, &v2_socket);
476 pthread_setaffinity_np(t_new, sizeof(*cpuset), cpuset);
477 atexit(unlink_sockets);
482 #endif /* !RTE_EXEC_ENV_WINDOWS */
485 rte_telemetry_init(const char *runtime_dir, const char *rte_version,
486 rte_cpuset_t *cpuset, const char **err_str)
488 telemetry_version = rte_version;
489 #ifndef RTE_EXEC_ENV_WINDOWS
490 if (telemetry_v2_init(runtime_dir, cpuset) != 0) {
491 *err_str = telemetry_log_error;
494 if (telemetry_legacy_init(runtime_dir, cpuset) != 0) {
495 *err_str = telemetry_log_error;
497 #else /* RTE_EXEC_ENV_WINDOWS */
498 RTE_SET_USED(runtime_dir);
499 RTE_SET_USED(cpuset);
500 RTE_SET_USED(err_str);
502 snprintf(telemetry_log_error, sizeof(telemetry_log_error),
503 "DPDK Telemetry is not supported on Windows.");
504 #endif /* RTE_EXEC_ENV_WINDOWS */