1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2020 Intel Corporation
7 #include <sys/socket.h>
11 /* we won't link against libbsd, so just always use DPDKs-specific strlcpy */
13 #include <rte_string_fns.h>
14 #include <rte_common.h>
15 #include <rte_spinlock.h>
16 #include <rte_version.h>
18 #include "rte_telemetry.h"
19 #include "telemetry_json.h"
20 #include "telemetry_data.h"
21 #include "rte_telemetry_legacy.h"
23 #define MAX_CMD_LEN 56
24 #define MAX_HELP_LEN 64
25 #define MAX_OUTPUT_LEN (1024 * 16)
28 client_handler(void *socket);
31 char cmd[MAX_CMD_LEN];
33 char help[MAX_HELP_LEN];
38 char path[sizeof(((struct sockaddr_un *)0)->sun_path)];
41 static struct socket v2_socket; /* socket for v2 telemetry */
42 static struct socket v1_socket; /* socket for v1 telemetry */
43 static char telemetry_log_error[1024]; /* Will contain error on init failure */
44 /* list of command callbacks, with one command registered by default */
45 static struct cmd_callback callbacks[TELEMETRY_MAX_CALLBACKS];
46 static int num_callbacks; /* How many commands are registered */
47 /* Used when accessing or modifying list of command callbacks */
48 static rte_spinlock_t callback_sl = RTE_SPINLOCK_INITIALIZER;
51 rte_telemetry_register_cmd(const char *cmd, telemetry_cb fn, const char *help)
55 if (strlen(cmd) >= MAX_CMD_LEN || fn == NULL || cmd[0] != '/'
56 || strlen(help) >= MAX_HELP_LEN)
58 if (num_callbacks >= TELEMETRY_MAX_CALLBACKS)
61 rte_spinlock_lock(&callback_sl);
62 while (i < num_callbacks && strcmp(cmd, callbacks[i].cmd) > 0)
64 if (i != num_callbacks)
65 /* Move elements to keep the list alphabetical */
66 memmove(callbacks + i + 1, callbacks + i,
67 sizeof(struct cmd_callback) * (num_callbacks - i));
69 strlcpy(callbacks[i].cmd, cmd, MAX_CMD_LEN);
71 strlcpy(callbacks[i].help, help, MAX_HELP_LEN);
73 rte_spinlock_unlock(&callback_sl);
79 list_commands(const char *cmd __rte_unused, const char *params __rte_unused,
80 struct rte_tel_data *d)
84 rte_tel_data_start_array(d, RTE_TEL_STRING_VAL);
85 for (i = 0; i < num_callbacks; i++)
86 rte_tel_data_add_array_string(d, callbacks[i].cmd);
91 json_info(const char *cmd __rte_unused, const char *params __rte_unused,
92 struct rte_tel_data *d)
94 rte_tel_data_start_dict(d);
95 rte_tel_data_add_dict_string(d, "version", rte_version());
96 rte_tel_data_add_dict_int(d, "pid", getpid());
97 rte_tel_data_add_dict_int(d, "max_output_len", MAX_OUTPUT_LEN);
102 command_help(const char *cmd __rte_unused, const char *params,
103 struct rte_tel_data *d)
109 rte_tel_data_start_dict(d);
110 rte_spinlock_lock(&callback_sl);
111 for (i = 0; i < num_callbacks; i++)
112 if (strcmp(params, callbacks[i].cmd) == 0) {
113 rte_tel_data_add_dict_string(d, params,
117 rte_spinlock_unlock(&callback_sl);
118 if (i == num_callbacks)
124 output_json(const char *cmd, const struct rte_tel_data *d, int s)
126 char out_buf[MAX_OUTPUT_LEN];
129 size_t buf_len, prefix_used, used = 0;
132 RTE_BUILD_BUG_ON(sizeof(out_buf) < MAX_CMD_LEN +
133 RTE_TEL_MAX_SINGLE_STRING_LEN + 10);
136 used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":null}",
137 MAX_CMD_LEN, cmd ? cmd : "none");
140 used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":\"%.*s\"}",
142 RTE_TEL_MAX_SINGLE_STRING_LEN, d->data.str);
145 prefix_used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":",
147 cb_data_buf = &out_buf[prefix_used];
148 buf_len = sizeof(out_buf) - prefix_used - 1; /* space for '}' */
150 used = rte_tel_json_empty_obj(cb_data_buf, buf_len, 0);
151 for (i = 0; i < d->data_len; i++) {
152 const struct tel_dict_entry *v = &d->data.dict[i];
154 case RTE_TEL_STRING_VAL:
155 used = rte_tel_json_add_obj_str(cb_data_buf,
157 v->name, v->value.sval);
159 case RTE_TEL_INT_VAL:
160 used = rte_tel_json_add_obj_int(cb_data_buf,
162 v->name, v->value.ival);
164 case RTE_TEL_U64_VAL:
165 used = rte_tel_json_add_obj_u64(cb_data_buf,
167 v->name, v->value.u64val);
172 used += strlcat(out_buf + used, "}", sizeof(out_buf) - used);
174 case RTE_TEL_ARRAY_STRING:
175 case RTE_TEL_ARRAY_INT:
176 case RTE_TEL_ARRAY_U64:
177 prefix_used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":",
179 cb_data_buf = &out_buf[prefix_used];
180 buf_len = sizeof(out_buf) - prefix_used - 1; /* space for '}' */
182 used = rte_tel_json_empty_array(cb_data_buf, buf_len, 0);
183 for (i = 0; i < d->data_len; i++)
184 if (d->type == RTE_TEL_ARRAY_STRING)
185 used = rte_tel_json_add_array_string(
188 d->data.array[i].sval);
189 else if (d->type == RTE_TEL_ARRAY_INT)
190 used = rte_tel_json_add_array_int(cb_data_buf,
192 d->data.array[i].ival);
193 else if (d->type == RTE_TEL_ARRAY_U64)
194 used = rte_tel_json_add_array_u64(cb_data_buf,
196 d->data.array[i].u64val);
198 used += strlcat(out_buf + used, "}", sizeof(out_buf) - used);
201 if (write(s, out_buf, used) < 0)
202 perror("Error writing to socket");
206 perform_command(telemetry_cb fn, const char *cmd, const char *param, int s)
208 struct rte_tel_data data;
210 int ret = fn(cmd, param, &data);
212 char out_buf[MAX_CMD_LEN + 10];
213 int used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":null}",
214 MAX_CMD_LEN, cmd ? cmd : "none");
215 if (write(s, out_buf, used) < 0)
216 perror("Error writing to socket");
219 output_json(cmd, &data, s);
223 unknown_command(const char *cmd __rte_unused, const char *params __rte_unused,
224 struct rte_tel_data *d)
226 return d->type = RTE_TEL_NULL;
230 client_handler(void *sock_id)
232 int s = (int)(uintptr_t)sock_id;
235 snprintf(info_str, sizeof(info_str),
236 "{\"version\":\"%s\",\"pid\":%d,\"max_output_len\":%d}",
237 rte_version(), getpid(), MAX_OUTPUT_LEN);
238 if (write(s, info_str, strlen(info_str)) < 0) {
243 /* receive data is not null terminated */
244 int bytes = read(s, buffer, sizeof(buffer) - 1);
247 const char *cmd = strtok(buffer, ",");
248 const char *param = strtok(NULL, ",");
249 telemetry_cb fn = unknown_command;
252 if (cmd && strlen(cmd) < MAX_CMD_LEN) {
253 rte_spinlock_lock(&callback_sl);
254 for (i = 0; i < num_callbacks; i++)
255 if (strcmp(cmd, callbacks[i].cmd) == 0) {
256 fn = callbacks[i].fn;
259 rte_spinlock_unlock(&callback_sl);
261 perform_command(fn, cmd, param, s);
263 bytes = read(s, buffer, sizeof(buffer) - 1);
270 socket_listener(void *socket)
274 struct socket *s = (struct socket *)socket;
275 int s_accepted = accept(s->sock, NULL, NULL);
276 if (s_accepted < 0) {
277 snprintf(telemetry_log_error,
278 sizeof(telemetry_log_error),
279 "Error with accept, telemetry thread quitting");
282 pthread_create(&th, NULL, s->fn, (void *)(uintptr_t)s_accepted);
289 get_socket_path(const char *runtime_dir, const int version)
291 static char path[PATH_MAX];
292 snprintf(path, sizeof(path), "%s/dpdk_telemetry.v%d",
293 strlen(runtime_dir) ? runtime_dir : "/tmp", version);
300 if (v2_socket.path[0])
301 unlink(v2_socket.path);
302 if (v1_socket.path[0])
303 unlink(v1_socket.path);
307 create_socket(char *path)
309 int sock = socket(AF_UNIX, SOCK_SEQPACKET, 0);
311 snprintf(telemetry_log_error, sizeof(telemetry_log_error),
312 "Error with socket creation, %s",
317 struct sockaddr_un sun = {.sun_family = AF_UNIX};
318 strlcpy(sun.sun_path, path, sizeof(sun.sun_path));
319 unlink(sun.sun_path);
320 if (bind(sock, (void *) &sun, sizeof(sun)) < 0) {
321 snprintf(telemetry_log_error, sizeof(telemetry_log_error),
322 "Error binding socket: %s",
328 if (listen(sock, 1) < 0) {
329 snprintf(telemetry_log_error, sizeof(telemetry_log_error),
330 "Error calling listen for socket: %s",
344 telemetry_legacy_init(const char *runtime_dir, rte_cpuset_t *cpuset)
348 if (num_legacy_callbacks == 1) {
349 snprintf(telemetry_log_error, sizeof(telemetry_log_error),
350 "No legacy callbacks, legacy socket not created");
354 v1_socket.fn = legacy_client_handler;
355 if ((size_t) snprintf(v1_socket.path, sizeof(v1_socket.path),
356 "%s/telemetry", runtime_dir)
357 >= sizeof(v1_socket.path)) {
358 snprintf(telemetry_log_error, sizeof(telemetry_log_error),
359 "Error with socket binding, path too long");
362 v1_socket.sock = create_socket(v1_socket.path);
363 if (v1_socket.sock < 0)
365 pthread_create(&t_old, NULL, socket_listener, &v1_socket);
366 pthread_setaffinity_np(t_old, sizeof(*cpuset), cpuset);
372 telemetry_v2_init(const char *runtime_dir, rte_cpuset_t *cpuset)
376 rte_telemetry_register_cmd("/", list_commands,
377 "Returns list of available commands, Takes no parameters");
378 rte_telemetry_register_cmd("/info", json_info,
379 "Returns DPDK Telemetry information. Takes no parameters");
380 rte_telemetry_register_cmd("/help", command_help,
381 "Returns help text for a command. Parameters: string command");
382 v2_socket.fn = client_handler;
383 if (strlcpy(v2_socket.path, get_socket_path(runtime_dir, 2),
384 sizeof(v2_socket.path)) >= sizeof(v2_socket.path)) {
385 snprintf(telemetry_log_error, sizeof(telemetry_log_error),
386 "Error with socket binding, path too long");
390 v2_socket.sock = create_socket(v2_socket.path);
391 if (v2_socket.sock < 0)
393 pthread_create(&t_new, NULL, socket_listener, &v2_socket);
394 pthread_setaffinity_np(t_new, sizeof(*cpuset), cpuset);
395 atexit(unlink_sockets);
401 rte_telemetry_init(const char *runtime_dir, rte_cpuset_t *cpuset,
402 const char **err_str)
404 if (telemetry_v2_init(runtime_dir, cpuset) != 0) {
405 *err_str = telemetry_log_error;
406 printf("Error initialising telemetry - %s\n", *err_str);
409 if (telemetry_legacy_init(runtime_dir, cpuset) != 0) {
410 *err_str = telemetry_log_error;
411 printf("No telemetry legacy support - %s\n", *err_str);