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 output_json(const char *cmd, const struct rte_tel_data *d, int s)
139 char out_buf[MAX_OUTPUT_LEN];
142 size_t buf_len, prefix_used, used = 0;
145 RTE_BUILD_BUG_ON(sizeof(out_buf) < MAX_CMD_LEN +
146 RTE_TEL_MAX_SINGLE_STRING_LEN + 10);
149 used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":null}",
150 MAX_CMD_LEN, cmd ? cmd : "none");
153 used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":\"%.*s\"}",
155 RTE_TEL_MAX_SINGLE_STRING_LEN, d->data.str);
158 prefix_used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":",
160 cb_data_buf = &out_buf[prefix_used];
161 buf_len = sizeof(out_buf) - prefix_used - 1; /* space for '}' */
163 used = rte_tel_json_empty_obj(cb_data_buf, buf_len, 0);
164 for (i = 0; i < d->data_len; i++) {
165 const struct tel_dict_entry *v = &d->data.dict[i];
167 case RTE_TEL_STRING_VAL:
168 used = rte_tel_json_add_obj_str(cb_data_buf,
170 v->name, v->value.sval);
172 case RTE_TEL_INT_VAL:
173 used = rte_tel_json_add_obj_int(cb_data_buf,
175 v->name, v->value.ival);
177 case RTE_TEL_U64_VAL:
178 used = rte_tel_json_add_obj_u64(cb_data_buf,
180 v->name, v->value.u64val);
185 used += strlcat(out_buf + used, "}", sizeof(out_buf) - used);
187 case RTE_TEL_ARRAY_STRING:
188 case RTE_TEL_ARRAY_INT:
189 case RTE_TEL_ARRAY_U64:
190 prefix_used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":",
192 cb_data_buf = &out_buf[prefix_used];
193 buf_len = sizeof(out_buf) - prefix_used - 1; /* space for '}' */
195 used = rte_tel_json_empty_array(cb_data_buf, buf_len, 0);
196 for (i = 0; i < d->data_len; i++)
197 if (d->type == RTE_TEL_ARRAY_STRING)
198 used = rte_tel_json_add_array_string(
201 d->data.array[i].sval);
202 else if (d->type == RTE_TEL_ARRAY_INT)
203 used = rte_tel_json_add_array_int(cb_data_buf,
205 d->data.array[i].ival);
206 else if (d->type == RTE_TEL_ARRAY_U64)
207 used = rte_tel_json_add_array_u64(cb_data_buf,
209 d->data.array[i].u64val);
211 used += strlcat(out_buf + used, "}", sizeof(out_buf) - used);
214 if (write(s, out_buf, used) < 0)
215 perror("Error writing to socket");
219 perform_command(telemetry_cb fn, const char *cmd, const char *param, int s)
221 struct rte_tel_data data;
223 int ret = fn(cmd, param, &data);
225 char out_buf[MAX_CMD_LEN + 10];
226 int used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":null}",
227 MAX_CMD_LEN, cmd ? cmd : "none");
228 if (write(s, out_buf, used) < 0)
229 perror("Error writing to socket");
232 output_json(cmd, &data, s);
236 unknown_command(const char *cmd __rte_unused, const char *params __rte_unused,
237 struct rte_tel_data *d)
239 return d->type = RTE_TEL_NULL;
243 client_handler(void *sock_id)
245 int s = (int)(uintptr_t)sock_id;
248 snprintf(info_str, sizeof(info_str),
249 "{\"version\":\"%s\",\"pid\":%d,\"max_output_len\":%d}",
250 rte_version(), getpid(), MAX_OUTPUT_LEN);
251 if (write(s, info_str, strlen(info_str)) < 0) {
256 /* receive data is not null terminated */
257 int bytes = read(s, buffer, sizeof(buffer) - 1);
260 const char *cmd = strtok(buffer, ",");
261 const char *param = strtok(NULL, ",");
262 telemetry_cb fn = unknown_command;
265 if (cmd && strlen(cmd) < MAX_CMD_LEN) {
266 rte_spinlock_lock(&callback_sl);
267 for (i = 0; i < num_callbacks; i++)
268 if (strcmp(cmd, callbacks[i].cmd) == 0) {
269 fn = callbacks[i].fn;
272 rte_spinlock_unlock(&callback_sl);
274 perform_command(fn, cmd, param, s);
276 bytes = read(s, buffer, sizeof(buffer) - 1);
279 __atomic_sub_fetch(&v2_clients, 1, __ATOMIC_RELAXED);
284 socket_listener(void *socket)
288 struct socket *s = (struct socket *)socket;
289 int s_accepted = accept(s->sock, NULL, NULL);
290 if (s_accepted < 0) {
291 snprintf(telemetry_log_error,
292 sizeof(telemetry_log_error),
293 "Error with accept, telemetry thread quitting");
296 if (s->num_clients != NULL) {
297 uint16_t conns = __atomic_load_n(s->num_clients,
299 if (conns >= MAX_CONNECTIONS) {
303 __atomic_add_fetch(s->num_clients, 1,
306 pthread_create(&th, NULL, s->fn, (void *)(uintptr_t)s_accepted);
313 get_socket_path(const char *runtime_dir, const int version)
315 static char path[PATH_MAX];
316 snprintf(path, sizeof(path), "%s/dpdk_telemetry.v%d",
317 strlen(runtime_dir) ? runtime_dir : "/tmp", version);
324 if (v2_socket.path[0])
325 unlink(v2_socket.path);
326 if (v1_socket.path[0])
327 unlink(v1_socket.path);
331 create_socket(char *path)
333 int sock = socket(AF_UNIX, SOCK_SEQPACKET, 0);
335 snprintf(telemetry_log_error, sizeof(telemetry_log_error),
336 "Error with socket creation, %s",
341 struct sockaddr_un sun = {.sun_family = AF_UNIX};
342 strlcpy(sun.sun_path, path, sizeof(sun.sun_path));
343 unlink(sun.sun_path);
344 if (bind(sock, (void *) &sun, sizeof(sun)) < 0) {
345 snprintf(telemetry_log_error, sizeof(telemetry_log_error),
346 "Error binding socket: %s",
352 if (listen(sock, 1) < 0) {
353 snprintf(telemetry_log_error, sizeof(telemetry_log_error),
354 "Error calling listen for socket: %s",
368 telemetry_legacy_init(const char *runtime_dir, rte_cpuset_t *cpuset)
372 if (num_legacy_callbacks == 1) {
373 snprintf(telemetry_log_error, sizeof(telemetry_log_error),
374 "No legacy callbacks, legacy socket not created");
378 v1_socket.fn = legacy_client_handler;
379 if ((size_t) snprintf(v1_socket.path, sizeof(v1_socket.path),
380 "%s/telemetry", runtime_dir)
381 >= sizeof(v1_socket.path)) {
382 snprintf(telemetry_log_error, sizeof(telemetry_log_error),
383 "Error with socket binding, path too long");
386 v1_socket.sock = create_socket(v1_socket.path);
387 if (v1_socket.sock < 0)
389 pthread_create(&t_old, NULL, socket_listener, &v1_socket);
390 pthread_setaffinity_np(t_old, sizeof(*cpuset), cpuset);
396 telemetry_v2_init(const char *runtime_dir, rte_cpuset_t *cpuset)
400 v2_socket.num_clients = &v2_clients;
401 rte_telemetry_register_cmd("/", list_commands,
402 "Returns list of available commands, Takes no parameters");
403 rte_telemetry_register_cmd("/info", json_info,
404 "Returns DPDK Telemetry information. Takes no parameters");
405 rte_telemetry_register_cmd("/help", command_help,
406 "Returns help text for a command. Parameters: string command");
407 v2_socket.fn = client_handler;
408 if (strlcpy(v2_socket.path, get_socket_path(runtime_dir, 2),
409 sizeof(v2_socket.path)) >= sizeof(v2_socket.path)) {
410 snprintf(telemetry_log_error, sizeof(telemetry_log_error),
411 "Error with socket binding, path too long");
415 v2_socket.sock = create_socket(v2_socket.path);
416 if (v2_socket.sock < 0)
418 pthread_create(&t_new, NULL, socket_listener, &v2_socket);
419 pthread_setaffinity_np(t_new, sizeof(*cpuset), cpuset);
420 atexit(unlink_sockets);
425 #endif /* !RTE_EXEC_ENV_WINDOWS */
428 rte_telemetry_init(const char *runtime_dir, rte_cpuset_t *cpuset,
429 const char **err_str)
431 #ifndef RTE_EXEC_ENV_WINDOWS
432 if (telemetry_v2_init(runtime_dir, cpuset) != 0) {
433 *err_str = telemetry_log_error;
436 if (telemetry_legacy_init(runtime_dir, cpuset) != 0) {
437 *err_str = telemetry_log_error;
439 #else /* RTE_EXEC_ENV_WINDOWS */
440 RTE_SET_USED(runtime_dir);
441 RTE_SET_USED(cpuset);
442 RTE_SET_USED(err_str);
444 snprintf(telemetry_log_error, sizeof(telemetry_log_error),
445 "DPDK Telemetry is not supported on Windows.");
446 #endif /* RTE_EXEC_ENV_WINDOWS */