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>
17 #include <rte_option.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)
29 client_handler(void *socket);
32 char cmd[MAX_CMD_LEN];
34 char help[MAX_HELP_LEN];
39 char path[sizeof(((struct sockaddr_un *)0)->sun_path)];
42 static struct socket v2_socket; /* socket for v2 telemetry */
43 static struct socket v1_socket; /* socket for v1 telemetry */
44 static char telemetry_log_error[1024]; /* Will contain error on init failure */
45 /* list of command callbacks, with one command registered by default */
46 static struct cmd_callback callbacks[TELEMETRY_MAX_CALLBACKS];
47 static int num_callbacks; /* How many commands are registered */
48 /* Used when accessing or modifying list of command callbacks */
49 static rte_spinlock_t callback_sl = RTE_SPINLOCK_INITIALIZER;
52 rte_telemetry_register_cmd(const char *cmd, telemetry_cb fn, const char *help)
56 if (strlen(cmd) >= MAX_CMD_LEN || fn == NULL || cmd[0] != '/'
57 || strlen(help) >= MAX_HELP_LEN)
59 if (num_callbacks >= TELEMETRY_MAX_CALLBACKS)
62 rte_spinlock_lock(&callback_sl);
63 while (i < num_callbacks && strcmp(cmd, callbacks[i].cmd) > 0)
65 if (i != num_callbacks)
66 /* Move elements to keep the list alphabetical */
67 memmove(callbacks + i + 1, callbacks + i,
68 sizeof(struct cmd_callback) * (num_callbacks - i));
70 strlcpy(callbacks[i].cmd, cmd, MAX_CMD_LEN);
72 strlcpy(callbacks[i].help, help, MAX_HELP_LEN);
74 rte_spinlock_unlock(&callback_sl);
80 list_commands(const char *cmd __rte_unused, const char *params __rte_unused,
81 struct rte_tel_data *d)
85 rte_tel_data_start_array(d, RTE_TEL_STRING_VAL);
86 for (i = 0; i < num_callbacks; i++)
87 rte_tel_data_add_array_string(d, callbacks[i].cmd);
92 json_info(const char *cmd __rte_unused, const char *params __rte_unused,
93 struct rte_tel_data *d)
95 rte_tel_data_start_dict(d);
96 rte_tel_data_add_dict_string(d, "version", rte_version());
97 rte_tel_data_add_dict_int(d, "pid", getpid());
98 rte_tel_data_add_dict_int(d, "max_output_len", MAX_OUTPUT_LEN);
103 command_help(const char *cmd __rte_unused, const char *params,
104 struct rte_tel_data *d)
110 rte_tel_data_start_dict(d);
111 rte_spinlock_lock(&callback_sl);
112 for (i = 0; i < num_callbacks; i++)
113 if (strcmp(params, callbacks[i].cmd) == 0) {
114 rte_tel_data_add_dict_string(d, params,
118 rte_spinlock_unlock(&callback_sl);
119 if (i == num_callbacks)
125 output_json(const char *cmd, const struct rte_tel_data *d, int s)
127 char out_buf[MAX_OUTPUT_LEN];
130 size_t buf_len, prefix_used, used = 0;
133 RTE_BUILD_BUG_ON(sizeof(out_buf) < MAX_CMD_LEN +
134 RTE_TEL_MAX_SINGLE_STRING_LEN + 10);
137 used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":null}",
138 MAX_CMD_LEN, cmd ? cmd : "none");
141 used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":\"%.*s\"}",
143 RTE_TEL_MAX_SINGLE_STRING_LEN, d->data.str);
146 prefix_used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":",
148 cb_data_buf = &out_buf[prefix_used];
149 buf_len = sizeof(out_buf) - prefix_used - 1; /* space for '}' */
151 used = rte_tel_json_empty_obj(cb_data_buf, buf_len, 0);
152 for (i = 0; i < d->data_len; i++) {
153 const struct tel_dict_entry *v = &d->data.dict[i];
155 case RTE_TEL_STRING_VAL:
156 used = rte_tel_json_add_obj_str(cb_data_buf,
158 v->name, v->value.sval);
160 case RTE_TEL_INT_VAL:
161 used = rte_tel_json_add_obj_int(cb_data_buf,
163 v->name, v->value.ival);
165 case RTE_TEL_U64_VAL:
166 used = rte_tel_json_add_obj_u64(cb_data_buf,
168 v->name, v->value.u64val);
173 used += strlcat(out_buf + used, "}", sizeof(out_buf) - used);
175 case RTE_TEL_ARRAY_STRING:
176 case RTE_TEL_ARRAY_INT:
177 case RTE_TEL_ARRAY_U64:
178 prefix_used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":",
180 cb_data_buf = &out_buf[prefix_used];
181 buf_len = sizeof(out_buf) - prefix_used - 1; /* space for '}' */
183 used = rte_tel_json_empty_array(cb_data_buf, buf_len, 0);
184 for (i = 0; i < d->data_len; i++)
185 if (d->type == RTE_TEL_ARRAY_STRING)
186 used = rte_tel_json_add_array_string(
189 d->data.array[i].sval);
190 else if (d->type == RTE_TEL_ARRAY_INT)
191 used = rte_tel_json_add_array_int(cb_data_buf,
193 d->data.array[i].ival);
194 else if (d->type == RTE_TEL_ARRAY_U64)
195 used = rte_tel_json_add_array_u64(cb_data_buf,
197 d->data.array[i].u64val);
199 used += strlcat(out_buf + used, "}", sizeof(out_buf) - used);
202 if (write(s, out_buf, used) < 0)
203 perror("Error writing to socket");
207 perform_command(telemetry_cb fn, const char *cmd, const char *param, int s)
209 struct rte_tel_data data;
211 int ret = fn(cmd, param, &data);
213 char out_buf[MAX_CMD_LEN + 10];
214 int used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":null}",
215 MAX_CMD_LEN, cmd ? cmd : "none");
216 if (write(s, out_buf, used) < 0)
217 perror("Error writing to socket");
220 output_json(cmd, &data, s);
224 unknown_command(const char *cmd __rte_unused, const char *params __rte_unused,
225 struct rte_tel_data *d)
227 return d->type = RTE_TEL_NULL;
231 client_handler(void *sock_id)
233 int s = (int)(uintptr_t)sock_id;
236 snprintf(info_str, sizeof(info_str),
237 "{\"version\":\"%s\",\"pid\":%d,\"max_output_len\":%d}",
238 rte_version(), getpid(), MAX_OUTPUT_LEN);
239 if (write(s, info_str, strlen(info_str)) < 0) {
244 /* receive data is not null terminated */
245 int bytes = read(s, buffer, sizeof(buffer) - 1);
248 const char *cmd = strtok(buffer, ",");
249 const char *param = strtok(NULL, ",");
250 telemetry_cb fn = unknown_command;
253 if (cmd && strlen(cmd) < MAX_CMD_LEN) {
254 rte_spinlock_lock(&callback_sl);
255 for (i = 0; i < num_callbacks; i++)
256 if (strcmp(cmd, callbacks[i].cmd) == 0) {
257 fn = callbacks[i].fn;
260 rte_spinlock_unlock(&callback_sl);
262 perform_command(fn, cmd, param, s);
264 bytes = read(s, buffer, sizeof(buffer) - 1);
271 socket_listener(void *socket)
275 struct socket *s = (struct socket *)socket;
276 int s_accepted = accept(s->sock, NULL, NULL);
277 if (s_accepted < 0) {
278 snprintf(telemetry_log_error,
279 sizeof(telemetry_log_error),
280 "Error with accept, telemetry thread quitting\n");
283 pthread_create(&th, NULL, s->fn, (void *)(uintptr_t)s_accepted);
290 get_socket_path(const char *runtime_dir, const int version)
292 static char path[PATH_MAX];
293 snprintf(path, sizeof(path), "%s/dpdk_telemetry.v%d",
294 strlen(runtime_dir) ? runtime_dir : "/tmp", version);
301 if (v2_socket.path[0])
302 unlink(v2_socket.path);
303 if (v1_socket.path[0])
304 unlink(v1_socket.path);
308 create_socket(char *path)
310 int sock = socket(AF_UNIX, SOCK_SEQPACKET, 0);
312 snprintf(telemetry_log_error, sizeof(telemetry_log_error),
313 "Error with socket creation, %s",
318 struct sockaddr_un sun = {.sun_family = AF_UNIX};
319 strlcpy(sun.sun_path, path, sizeof(sun.sun_path));
320 unlink(sun.sun_path);
321 if (bind(sock, (void *) &sun, sizeof(sun)) < 0) {
322 snprintf(telemetry_log_error, sizeof(telemetry_log_error),
323 "Error binding socket: %s",
329 if (listen(sock, 1) < 0) {
330 snprintf(telemetry_log_error, sizeof(telemetry_log_error),
331 "Error calling listen for socket: %s",
345 telemetry_legacy_init(const char *runtime_dir)
349 if (num_legacy_callbacks == 1) {
350 snprintf(telemetry_log_error, sizeof(telemetry_log_error),
351 "No legacy callbacks, legacy socket not created");
355 v1_socket.fn = legacy_client_handler;
356 if ((size_t) snprintf(v1_socket.path, sizeof(v1_socket.path),
357 "%s/telemetry", runtime_dir)
358 >= sizeof(v1_socket.path)) {
359 snprintf(telemetry_log_error, sizeof(telemetry_log_error),
360 "Error with socket binding, path too long");
363 v1_socket.sock = create_socket(v1_socket.path);
364 if (v1_socket.sock < 0)
366 pthread_create(&t_old, NULL, socket_listener, &v1_socket);
372 telemetry_v2_init(const char *runtime_dir)
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 atexit(unlink_sockets);
400 rte_telemetry_init(void)
402 const char *error_str;
403 if (telemetry_v2_init(rte_eal_get_runtime_dir()) != 0) {
404 error_str = telemetry_log_error;
405 printf("Error initialising telemetry - %s", error_str);
408 if (telemetry_legacy_init(rte_eal_get_runtime_dir()) != 0) {
409 error_str = telemetry_log_error;
410 printf("No telemetry legacy support- %s", error_str);
415 static struct rte_option option = {
417 .usage = "Enable telemetry backend",
418 .cb = &rte_telemetry_init,
422 RTE_INIT(telemetry_register_op) {
423 rte_option_register(&option);