1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2020 Intel Corporation
3 */
4
5 #ifndef RTE_EXEC_ENV_WINDOWS
6 #include <unistd.h>
7 #include <pthread.h>
8 #include <sys/socket.h>
9 #include <sys/un.h>
10 #include <dlfcn.h>
11 #endif /* !RTE_EXEC_ENV_WINDOWS */
12
13 /* we won't link against libbsd, so just always use DPDKs-specific strlcpy */
14 #undef RTE_USE_LIBBSD
15 #include <rte_string_fns.h>
16 #include <rte_common.h>
17 #include <rte_spinlock.h>
18 #include <rte_version.h>
19
20 #include "rte_telemetry.h"
21 #include "telemetry_json.h"
22 #include "telemetry_data.h"
23 #include "rte_telemetry_legacy.h"
24
25 #define MAX_CMD_LEN 56
26 #define MAX_HELP_LEN 64
27 #define MAX_OUTPUT_LEN (1024 * 16)
28 #define MAX_CONNECTIONS 10
29
30 #ifndef RTE_EXEC_ENV_WINDOWS
31 static void *
32 client_handler(void *socket);
33 #endif /* !RTE_EXEC_ENV_WINDOWS */
34
35 struct cmd_callback {
36 char cmd[MAX_CMD_LEN];
37 telemetry_cb fn;
38 char help[MAX_HELP_LEN];
39 };
40
41 #ifndef RTE_EXEC_ENV_WINDOWS
42 struct socket {
43 int sock;
44 char path[sizeof(((struct sockaddr_un *)0)->sun_path)];
45 handler fn;
46 uint16_t *num_clients;
47 };
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 */
60
61 int
rte_telemetry_register_cmd(const char * cmd,telemetry_cb fn,const char * help)62 rte_telemetry_register_cmd(const char *cmd, telemetry_cb fn, const char *help)
63 {
64 int i = 0;
65
66 if (strlen(cmd) >= MAX_CMD_LEN || fn == NULL || cmd[0] != '/'
67 || strlen(help) >= MAX_HELP_LEN)
68 return -EINVAL;
69 if (num_callbacks >= TELEMETRY_MAX_CALLBACKS)
70 return -ENOENT;
71
72 rte_spinlock_lock(&callback_sl);
73 while (i < num_callbacks && strcmp(cmd, callbacks[i].cmd) > 0)
74 i++;
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));
79
80 strlcpy(callbacks[i].cmd, cmd, MAX_CMD_LEN);
81 callbacks[i].fn = fn;
82 strlcpy(callbacks[i].help, help, MAX_HELP_LEN);
83 num_callbacks++;
84 rte_spinlock_unlock(&callback_sl);
85
86 return 0;
87 }
88
89 #ifndef RTE_EXEC_ENV_WINDOWS
90
91 static int
list_commands(const char * cmd __rte_unused,const char * params __rte_unused,struct rte_tel_data * d)92 list_commands(const char *cmd __rte_unused, const char *params __rte_unused,
93 struct rte_tel_data *d)
94 {
95 int i;
96
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);
100 return 0;
101 }
102
103 static int
json_info(const char * cmd __rte_unused,const char * params __rte_unused,struct rte_tel_data * d)104 json_info(const char *cmd __rte_unused, const char *params __rte_unused,
105 struct rte_tel_data *d)
106 {
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);
111 return 0;
112 }
113
114 static int
command_help(const char * cmd __rte_unused,const char * params,struct rte_tel_data * d)115 command_help(const char *cmd __rte_unused, const char *params,
116 struct rte_tel_data *d)
117 {
118 int i;
119
120 if (!params)
121 return -1;
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,
127 callbacks[i].help);
128 break;
129 }
130 rte_spinlock_unlock(&callback_sl);
131 if (i == num_callbacks)
132 return -1;
133 return 0;
134 }
135
136 static int
container_to_json(const struct rte_tel_data * d,char * out_buf,size_t buf_len)137 container_to_json(const struct rte_tel_data *d, char *out_buf, size_t buf_len)
138 {
139 size_t used = 0;
140 unsigned int i;
141
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");
145
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,
150 buf_len, used,
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,
155 buf_len, used,
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,
160 buf_len, used,
161 d->data.array[i].sval);
162 return used;
163 }
164
165 static void
output_json(const char * cmd,const struct rte_tel_data * d,int s)166 output_json(const char *cmd, const struct rte_tel_data *d, int s)
167 {
168 char out_buf[MAX_OUTPUT_LEN];
169
170 char *cb_data_buf;
171 size_t buf_len, prefix_used, used = 0;
172 unsigned int i;
173
174 RTE_BUILD_BUG_ON(sizeof(out_buf) < MAX_CMD_LEN +
175 RTE_TEL_MAX_SINGLE_STRING_LEN + 10);
176 switch (d->type) {
177 case RTE_TEL_NULL:
178 used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":null}",
179 MAX_CMD_LEN, cmd ? cmd : "none");
180 break;
181 case RTE_TEL_STRING:
182 used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":\"%.*s\"}",
183 MAX_CMD_LEN, cmd,
184 RTE_TEL_MAX_SINGLE_STRING_LEN, d->data.str);
185 break;
186 case RTE_TEL_DICT:
187 prefix_used = snprintf(out_buf, sizeof(out_buf), "{\"%.*s\":",
188 MAX_CMD_LEN, cmd);
189 cb_data_buf = &out_buf[prefix_used];
190 buf_len = sizeof(out_buf) - prefix_used - 1; /* space for '}' */
191
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];
195 switch (v->type) {
196 case RTE_TEL_STRING_VAL:
197 used = rte_tel_json_add_obj_str(cb_data_buf,
198 buf_len, used,
199 v->name, v->value.sval);
200 break;
201 case RTE_TEL_INT_VAL:
202 used = rte_tel_json_add_obj_int(cb_data_buf,
203 buf_len, used,
204 v->name, v->value.ival);
205 break;
206 case RTE_TEL_U64_VAL:
207 used = rte_tel_json_add_obj_u64(cb_data_buf,
208 buf_len, used,
209 v->name, v->value.u64val);
210 break;
211 case RTE_TEL_CONTAINER:
212 {
213 char temp[buf_len];
214 const struct container *cont =
215 &v->value.container;
216 if (container_to_json(cont->data,
217 temp, buf_len) != 0)
218 used = rte_tel_json_add_obj_json(
219 cb_data_buf,
220 buf_len, used,
221 v->name, temp);
222 if (!cont->keep)
223 rte_tel_data_free(cont->data);
224 }
225 }
226 }
227 used += prefix_used;
228 used += strlcat(out_buf + used, "}", sizeof(out_buf) - used);
229 break;
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\":",
235 MAX_CMD_LEN, cmd);
236 cb_data_buf = &out_buf[prefix_used];
237 buf_len = sizeof(out_buf) - prefix_used - 1; /* space for '}' */
238
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(
243 cb_data_buf,
244 buf_len, used,
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,
248 buf_len, used,
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,
252 buf_len, used,
253 d->data.array[i].u64val);
254 else if (d->type == RTE_TEL_ARRAY_CONTAINER) {
255 char temp[buf_len];
256 const struct container *rec_data =
257 &d->data.array[i].container;
258 if (container_to_json(rec_data->data,
259 temp, buf_len) != 0)
260 used = rte_tel_json_add_array_json(
261 cb_data_buf,
262 buf_len, used, temp);
263 if (!rec_data->keep)
264 rte_tel_data_free(rec_data->data);
265 }
266 used += prefix_used;
267 used += strlcat(out_buf + used, "}", sizeof(out_buf) - used);
268 break;
269 }
270 if (write(s, out_buf, used) < 0)
271 perror("Error writing to socket");
272 }
273
274 static void
perform_command(telemetry_cb fn,const char * cmd,const char * param,int s)275 perform_command(telemetry_cb fn, const char *cmd, const char *param, int s)
276 {
277 struct rte_tel_data data;
278
279 int ret = fn(cmd, param, &data);
280 if (ret < 0) {
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");
286 return;
287 }
288 output_json(cmd, &data, s);
289 }
290
291 static int
unknown_command(const char * cmd __rte_unused,const char * params __rte_unused,struct rte_tel_data * d)292 unknown_command(const char *cmd __rte_unused, const char *params __rte_unused,
293 struct rte_tel_data *d)
294 {
295 return d->type = RTE_TEL_NULL;
296 }
297
298 static void *
client_handler(void * sock_id)299 client_handler(void *sock_id)
300 {
301 int s = (int)(uintptr_t)sock_id;
302 char buffer[1024];
303 char info_str[1024];
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) {
308 close(s);
309 return NULL;
310 }
311
312 /* receive data is not null terminated */
313 int bytes = read(s, buffer, sizeof(buffer) - 1);
314 while (bytes > 0) {
315 buffer[bytes] = 0;
316 const char *cmd = strtok(buffer, ",");
317 const char *param = strtok(NULL, "\0");
318 telemetry_cb fn = unknown_command;
319 int i;
320
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;
326 break;
327 }
328 rte_spinlock_unlock(&callback_sl);
329 }
330 perform_command(fn, cmd, param, s);
331
332 bytes = read(s, buffer, sizeof(buffer) - 1);
333 }
334 close(s);
335 __atomic_sub_fetch(&v2_clients, 1, __ATOMIC_RELAXED);
336 return NULL;
337 }
338
339 static void *
socket_listener(void * socket)340 socket_listener(void *socket)
341 {
342 while (1) {
343 pthread_t th;
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");
350 return NULL;
351 }
352 if (s->num_clients != NULL) {
353 uint16_t conns = __atomic_load_n(s->num_clients,
354 __ATOMIC_RELAXED);
355 if (conns >= MAX_CONNECTIONS) {
356 close(s_accepted);
357 continue;
358 }
359 __atomic_add_fetch(s->num_clients, 1,
360 __ATOMIC_RELAXED);
361 }
362 pthread_create(&th, NULL, s->fn, (void *)(uintptr_t)s_accepted);
363 pthread_detach(th);
364 }
365 return NULL;
366 }
367
368 static inline char *
get_socket_path(const char * runtime_dir,const int version)369 get_socket_path(const char *runtime_dir, const int version)
370 {
371 static char path[PATH_MAX];
372 snprintf(path, sizeof(path), "%s/dpdk_telemetry.v%d",
373 strlen(runtime_dir) ? runtime_dir : "/tmp", version);
374 return path;
375 }
376
377 static void
unlink_sockets(void)378 unlink_sockets(void)
379 {
380 if (v2_socket.path[0])
381 unlink(v2_socket.path);
382 if (v1_socket.path[0])
383 unlink(v1_socket.path);
384 }
385
386 static int
create_socket(char * path)387 create_socket(char *path)
388 {
389 int sock = socket(AF_UNIX, SOCK_SEQPACKET, 0);
390 if (sock < 0) {
391 snprintf(telemetry_log_error, sizeof(telemetry_log_error),
392 "Error with socket creation, %s",
393 strerror(errno));
394 return -1;
395 }
396
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",
403 strerror(errno));
404 sun.sun_path[0] = 0;
405 goto error;
406 }
407
408 if (listen(sock, 1) < 0) {
409 snprintf(telemetry_log_error, sizeof(telemetry_log_error),
410 "Error calling listen for socket: %s",
411 strerror(errno));
412 goto error;
413 }
414
415 return sock;
416
417 error:
418 close(sock);
419 unlink_sockets();
420 return -1;
421 }
422
423 static int
telemetry_legacy_init(const char * runtime_dir,rte_cpuset_t * cpuset)424 telemetry_legacy_init(const char *runtime_dir, rte_cpuset_t *cpuset)
425 {
426 pthread_t t_old;
427
428 if (num_legacy_callbacks == 1) {
429 snprintf(telemetry_log_error, sizeof(telemetry_log_error),
430 "No legacy callbacks, legacy socket not created");
431 return -1;
432 }
433
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");
440 return -1;
441 }
442 v1_socket.sock = create_socket(v1_socket.path);
443 if (v1_socket.sock < 0)
444 return -1;
445 pthread_create(&t_old, NULL, socket_listener, &v1_socket);
446 pthread_setaffinity_np(t_old, sizeof(*cpuset), cpuset);
447
448 return 0;
449 }
450
451 static int
telemetry_v2_init(const char * runtime_dir,rte_cpuset_t * cpuset)452 telemetry_v2_init(const char *runtime_dir, rte_cpuset_t *cpuset)
453 {
454 pthread_t t_new;
455
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");
468 return -1;
469 }
470
471 v2_socket.sock = create_socket(v2_socket.path);
472 if (v2_socket.sock < 0)
473 return -1;
474 pthread_create(&t_new, NULL, socket_listener, &v2_socket);
475 pthread_setaffinity_np(t_new, sizeof(*cpuset), cpuset);
476 atexit(unlink_sockets);
477
478 return 0;
479 }
480
481 #endif /* !RTE_EXEC_ENV_WINDOWS */
482
483 int32_t
rte_telemetry_init(const char * runtime_dir,rte_cpuset_t * cpuset,const char ** err_str)484 rte_telemetry_init(const char *runtime_dir, rte_cpuset_t *cpuset,
485 const char **err_str)
486 {
487 #ifndef RTE_EXEC_ENV_WINDOWS
488 if (telemetry_v2_init(runtime_dir, cpuset) != 0) {
489 *err_str = telemetry_log_error;
490 return -1;
491 }
492 if (telemetry_legacy_init(runtime_dir, cpuset) != 0) {
493 *err_str = telemetry_log_error;
494 }
495 #else /* RTE_EXEC_ENV_WINDOWS */
496 RTE_SET_USED(runtime_dir);
497 RTE_SET_USED(cpuset);
498 RTE_SET_USED(err_str);
499
500 snprintf(telemetry_log_error, sizeof(telemetry_log_error),
501 "DPDK Telemetry is not supported on Windows.");
502 #endif /* RTE_EXEC_ENV_WINDOWS */
503
504 return 0;
505 }
506