1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2018 Intel Corporation
8 #include <sys/socket.h>
13 #include <rte_ethdev.h>
14 #include <rte_metrics.h>
15 #include <rte_option.h>
16 #include <rte_string_fns.h>
18 #include "rte_telemetry.h"
19 #include "rte_telemetry_internal.h"
20 #include "rte_telemetry_parser.h"
21 #include "rte_telemetry_parser_test.h"
22 #include "rte_telemetry_socket_tests.h"
28 #define SELFTEST_VALID_CLIENT "/var/run/dpdk/valid_client"
29 #define SELFTEST_INVALID_CLIENT "/var/run/dpdk/invalid_client"
30 #define SOCKET_TEST_CLIENT_PATH "/var/run/dpdk/client"
32 static telemetry_impl *static_telemetry;
34 struct telemetry_message_test {
36 int (*test_func_ptr)(struct telemetry_impl *telemetry, int fd);
48 rte_telemetry_get_runtime_dir(char *socket_path, size_t size)
50 snprintf(socket_path, size, "%s/telemetry", rte_eal_get_runtime_dir());
54 rte_telemetry_is_port_active(int port_id)
58 ret = rte_eth_find_next(port_id);
62 TELEMETRY_LOG_ERR("port_id: %d is invalid, not active",
69 rte_telemetry_update_metrics_ethdev(struct telemetry_impl *telemetry,
70 uint16_t port_id, int reg_start_index)
72 int ret, num_xstats, i;
73 struct rte_eth_xstat *eth_xstats;
75 if (!rte_eth_dev_is_valid_port(port_id)) {
76 TELEMETRY_LOG_ERR("port_id: %d is invalid", port_id);
77 ret = rte_telemetry_send_error_response(telemetry, -EINVAL);
79 TELEMETRY_LOG_ERR("Could not send error");
83 ret = rte_telemetry_is_port_active(port_id);
85 ret = rte_telemetry_send_error_response(telemetry, -EINVAL);
87 TELEMETRY_LOG_ERR("Could not send error");
91 num_xstats = rte_eth_xstats_get(port_id, NULL, 0);
93 TELEMETRY_LOG_ERR("rte_eth_xstats_get(%u) failed: %d", port_id,
95 ret = rte_telemetry_send_error_response(telemetry, -EPERM);
97 TELEMETRY_LOG_ERR("Could not send error");
101 eth_xstats = malloc(sizeof(struct rte_eth_xstat) * num_xstats);
102 if (eth_xstats == NULL) {
103 TELEMETRY_LOG_ERR("Failed to malloc memory for xstats");
104 ret = rte_telemetry_send_error_response(telemetry, -ENOMEM);
106 TELEMETRY_LOG_ERR("Could not send error");
110 ret = rte_eth_xstats_get(port_id, eth_xstats, num_xstats);
111 if (ret < 0 || ret > num_xstats) {
113 TELEMETRY_LOG_ERR("rte_eth_xstats_get(%u) len%i failed: %d",
114 port_id, num_xstats, ret);
115 ret = rte_telemetry_send_error_response(telemetry, -EPERM);
117 TELEMETRY_LOG_ERR("Could not send error");
121 uint64_t xstats_values[num_xstats];
122 for (i = 0; i < num_xstats; i++)
123 xstats_values[i] = eth_xstats[i].value;
125 ret = rte_metrics_update_values(port_id, reg_start_index, xstats_values,
128 TELEMETRY_LOG_ERR("Could not update metrics values");
129 ret = rte_telemetry_send_error_response(telemetry, -EPERM);
131 TELEMETRY_LOG_ERR("Could not send error");
141 rte_telemetry_write_to_socket(struct telemetry_impl *telemetry,
142 const char *json_string)
146 if (telemetry == NULL) {
147 TELEMETRY_LOG_ERR("Could not initialise TELEMETRY_API");
151 if (telemetry->request_client == NULL) {
152 TELEMETRY_LOG_ERR("No client has been chosen to write to");
156 if (json_string == NULL) {
157 TELEMETRY_LOG_ERR("Invalid JSON string!");
161 ret = send(telemetry->request_client->fd,
162 json_string, strlen(json_string), 0);
164 TELEMETRY_LOG_ERR("Failed to write to socket for client: %s",
165 telemetry->request_client->file_path);
173 rte_telemetry_send_error_response(struct telemetry_impl *telemetry,
177 const char *status_code, *json_buffer;
180 if (error_type == -EPERM)
181 status_code = "Status Error: Unknown";
182 else if (error_type == -EINVAL)
183 status_code = "Status Error: Invalid Argument 404";
184 else if (error_type == -ENOMEM)
185 status_code = "Status Error: Memory Allocation Error";
187 TELEMETRY_LOG_ERR("Invalid error type");
191 root = json_object();
194 TELEMETRY_LOG_ERR("Could not create root JSON object");
198 ret = json_object_set_new(root, "status_code", json_string(status_code));
200 TELEMETRY_LOG_ERR("Status code field cannot be set");
205 ret = json_object_set_new(root, "data", json_null());
207 TELEMETRY_LOG_ERR("Data field cannot be set");
212 json_buffer = json_dumps(root, 0);
215 ret = rte_telemetry_write_to_socket(telemetry, json_buffer);
217 TELEMETRY_LOG_ERR("Could not write to socket");
225 rte_telemetry_get_metrics(struct telemetry_impl *telemetry, uint32_t port_id,
226 struct rte_metric_value *metrics, struct rte_metric_name *names,
231 if (num_metrics < 0) {
232 TELEMETRY_LOG_ERR("Invalid metrics count");
234 } else if (num_metrics == 0) {
235 TELEMETRY_LOG_ERR("No metrics to display (none have been registered)");
239 if (metrics == NULL) {
240 TELEMETRY_LOG_ERR("Metrics must be initialised.");
245 TELEMETRY_LOG_ERR("Names must be initialised.");
249 ret = rte_metrics_get_names(names, num_metrics);
250 if (ret < 0 || ret > num_metrics) {
251 TELEMETRY_LOG_ERR("Cannot get metrics names");
255 num_values = rte_metrics_get_values(port_id, NULL, 0);
256 ret = rte_metrics_get_values(port_id, metrics, num_values);
257 if (ret < 0 || ret > num_values) {
258 TELEMETRY_LOG_ERR("Cannot get metrics values");
265 ret = rte_telemetry_send_error_response(telemetry, -EPERM);
267 TELEMETRY_LOG_ERR("Could not send error");
271 ret = rte_telemetry_send_error_response(telemetry, -EINVAL);
273 TELEMETRY_LOG_ERR("Could not send error");
279 rte_telemetry_json_format_stat(struct telemetry_impl *telemetry, json_t *stats,
280 const char *metric_name, uint64_t metric_value)
283 json_t *stat = json_object();
286 TELEMETRY_LOG_ERR("Could not create stat JSON object");
290 ret = json_object_set_new(stat, "name", json_string(metric_name));
292 TELEMETRY_LOG_ERR("Stat Name field cannot be set");
296 ret = json_object_set_new(stat, "value", json_integer(metric_value));
298 TELEMETRY_LOG_ERR("Stat Value field cannot be set");
302 ret = json_array_append_new(stats, stat);
304 TELEMETRY_LOG_ERR("Stat cannot be added to stats json array");
311 ret = rte_telemetry_send_error_response(telemetry, -EPERM);
313 TELEMETRY_LOG_ERR("Could not send error");
319 rte_telemetry_json_format_port(struct telemetry_impl *telemetry,
320 uint32_t port_id, json_t *ports, uint32_t *metric_ids,
321 uint32_t num_metric_ids)
323 struct rte_metric_value *metrics = 0;
324 struct rte_metric_name *names = 0;
325 int num_metrics, ret, err_ret;
326 json_t *port, *stats;
329 num_metrics = rte_metrics_get_names(NULL, 0);
330 if (num_metrics < 0) {
331 TELEMETRY_LOG_ERR("Cannot get metrics count");
333 } else if (num_metrics == 0) {
334 TELEMETRY_LOG_ERR("No metrics to display (none have been registered)");
338 metrics = malloc(sizeof(struct rte_metric_value) * num_metrics);
339 names = malloc(sizeof(struct rte_metric_name) * num_metrics);
340 if (metrics == NULL || names == NULL) {
341 TELEMETRY_LOG_ERR("Cannot allocate memory");
345 err_ret = rte_telemetry_send_error_response(telemetry, -ENOMEM);
347 TELEMETRY_LOG_ERR("Could not send error");
351 ret = rte_telemetry_get_metrics(telemetry, port_id, metrics, names,
356 TELEMETRY_LOG_ERR("rte_telemetry_get_metrics failed");
360 port = json_object();
361 stats = json_array();
362 if (port == NULL || stats == NULL) {
363 TELEMETRY_LOG_ERR("Could not create port/stats JSON objects");
367 ret = json_object_set_new(port, "port", json_integer(port_id));
369 TELEMETRY_LOG_ERR("Port field cannot be set");
373 for (i = 0; i < num_metric_ids; i++) {
374 int metric_id = metric_ids[i];
375 int metric_index = -1;
376 int metric_name_key = -1;
378 uint64_t metric_value;
380 if (metric_id >= num_metrics) {
381 TELEMETRY_LOG_ERR("Metric_id: %d is not valid",
386 for (j = 0; j < num_metrics; j++) {
387 if (metrics[j].key == metric_id) {
388 metric_name_key = metrics[j].key;
394 const char *metric_name = names[metric_name_key].name;
395 metric_value = metrics[metric_index].value;
397 if (metric_name_key < 0 || metric_index < 0) {
398 TELEMETRY_LOG_ERR("Could not get metric name/index");
402 ret = rte_telemetry_json_format_stat(telemetry, stats,
403 metric_name, metric_value);
405 TELEMETRY_LOG_ERR("Format stat with id: %u failed",
413 if (json_array_size(stats) == 0)
414 ret = json_object_set_new(port, "stats", json_null());
416 ret = json_object_set_new(port, "stats", stats);
419 TELEMETRY_LOG_ERR("Stats object cannot be set");
423 ret = json_array_append_new(ports, port);
425 TELEMETRY_LOG_ERR("Port object cannot be added to ports array");
436 ret = rte_telemetry_send_error_response(telemetry, -EPERM);
438 TELEMETRY_LOG_ERR("Could not send error");
444 ret = rte_telemetry_send_error_response(telemetry, -EINVAL);
446 TELEMETRY_LOG_ERR("Could not send error");
451 rte_telemetry_encode_json_format(struct telemetry_impl *telemetry,
452 uint32_t *port_ids, uint32_t num_port_ids, uint32_t *metric_ids,
453 uint32_t num_metric_ids, char **json_buffer)
456 json_t *root, *ports;
459 if (num_port_ids <= 0 || num_metric_ids <= 0) {
460 TELEMETRY_LOG_ERR("Please provide port and metric ids to query");
464 ports = json_array();
466 TELEMETRY_LOG_ERR("Could not create ports JSON array");
470 for (i = 0; i < num_port_ids; i++) {
471 if (!rte_eth_dev_is_valid_port(port_ids[i])) {
472 TELEMETRY_LOG_ERR("Port: %d invalid", port_ids[i]);
477 for (i = 0; i < num_port_ids; i++) {
478 ret = rte_telemetry_json_format_port(telemetry, port_ids[i],
479 ports, metric_ids, num_metric_ids);
481 TELEMETRY_LOG_ERR("Format port in JSON failed");
486 root = json_object();
488 TELEMETRY_LOG_ERR("Could not create root JSON object");
492 ret = json_object_set_new(root, "status_code",
493 json_string("Status OK: 200"));
495 TELEMETRY_LOG_ERR("Status code field cannot be set");
499 ret = json_object_set_new(root, "data", ports);
501 TELEMETRY_LOG_ERR("Data field cannot be set");
505 *json_buffer = json_dumps(root, JSON_INDENT(2));
510 ret = rte_telemetry_send_error_response(telemetry, -EPERM);
512 TELEMETRY_LOG_ERR("Could not send error");
516 ret = rte_telemetry_send_error_response(telemetry, -EINVAL);
518 TELEMETRY_LOG_ERR("Could not send error");
523 rte_telemetry_send_ports_stats_values(uint32_t *metric_ids, int num_metric_ids,
524 uint32_t *port_ids, int num_port_ids, struct telemetry_impl *telemetry)
527 char *json_buffer = NULL;
529 if (telemetry == NULL) {
530 TELEMETRY_LOG_ERR("Invalid telemetry argument");
534 if (metric_ids == NULL) {
535 TELEMETRY_LOG_ERR("Invalid metric_ids array");
539 if (num_metric_ids < 0) {
540 TELEMETRY_LOG_ERR("Invalid num_metric_ids, must be positive");
544 if (port_ids == NULL) {
545 TELEMETRY_LOG_ERR("Invalid port_ids array");
549 if (num_port_ids < 0) {
550 TELEMETRY_LOG_ERR("Invalid num_port_ids, must be positive");
554 for (i = 0; i < num_port_ids; i++) {
555 if (!rte_eth_dev_is_valid_port(port_ids[i])) {
556 TELEMETRY_LOG_ERR("Port: %d invalid", port_ids[i]);
560 ret = rte_telemetry_update_metrics_ethdev(telemetry,
561 port_ids[i], telemetry->reg_index);
563 TELEMETRY_LOG_ERR("Failed to update ethdev metrics");
568 ret = rte_telemetry_encode_json_format(telemetry, port_ids,
569 num_port_ids, metric_ids, num_metric_ids, &json_buffer);
571 TELEMETRY_LOG_ERR("JSON encode function failed");
575 ret = rte_telemetry_write_to_socket(telemetry, json_buffer);
577 TELEMETRY_LOG_ERR("Could not write to socket");
584 ret = rte_telemetry_send_error_response(telemetry, -EINVAL);
586 TELEMETRY_LOG_ERR("Could not send error");
592 rte_telemetry_reg_ethdev_to_metrics(uint16_t port_id)
594 int ret, num_xstats, ret_val, i;
595 struct rte_eth_xstat *eth_xstats = NULL;
596 struct rte_eth_xstat_name *eth_xstats_names = NULL;
598 if (!rte_eth_dev_is_valid_port(port_id)) {
599 TELEMETRY_LOG_ERR("port_id: %d is invalid", port_id);
603 num_xstats = rte_eth_xstats_get(port_id, NULL, 0);
604 if (num_xstats < 0) {
605 TELEMETRY_LOG_ERR("rte_eth_xstats_get(%u) failed: %d",
606 port_id, num_xstats);
610 eth_xstats = malloc(sizeof(struct rte_eth_xstat) * num_xstats);
611 if (eth_xstats == NULL) {
612 TELEMETRY_LOG_ERR("Failed to malloc memory for xstats");
616 ret = rte_eth_xstats_get(port_id, eth_xstats, num_xstats);
617 const char *xstats_names[num_xstats];
618 eth_xstats_names = malloc(sizeof(struct rte_eth_xstat_name) * num_xstats);
619 if (ret < 0 || ret > num_xstats) {
620 TELEMETRY_LOG_ERR("rte_eth_xstats_get(%u) len%i failed: %d",
621 port_id, num_xstats, ret);
626 if (eth_xstats_names == NULL) {
627 TELEMETRY_LOG_ERR("Failed to malloc memory for xstats_names");
632 ret = rte_eth_xstats_get_names(port_id, eth_xstats_names, num_xstats);
633 if (ret < 0 || ret > num_xstats) {
634 TELEMETRY_LOG_ERR("rte_eth_xstats_get_names(%u) len%i failed: %d",
635 port_id, num_xstats, ret);
640 for (i = 0; i < num_xstats; i++)
641 xstats_names[i] = eth_xstats_names[eth_xstats[i].id].name;
643 ret_val = rte_metrics_reg_names(xstats_names, num_xstats);
645 TELEMETRY_LOG_ERR("rte_metrics_reg_names failed - metrics may already be registered");
654 free(eth_xstats_names);
659 rte_telemetry_initial_accept(struct telemetry_impl *telemetry)
664 RTE_ETH_FOREACH_DEV(pid) {
665 telemetry->reg_index = rte_telemetry_reg_ethdev_to_metrics(pid);
669 if (telemetry->reg_index < 0) {
670 TELEMETRY_LOG_ERR("Failed to register ethdev metrics");
674 telemetry->metrics_register_done = 1;
675 ret = rte_telemetry_socket_messaging_testing(telemetry->reg_index,
676 telemetry->server_fd);
680 ret = rte_telemetry_parser_test(telemetry);
682 TELEMETRY_LOG_ERR("Parser Tests Failed");
686 TELEMETRY_LOG_INFO("Success - All Parser Tests Passed");
692 rte_telemetry_read_client(struct telemetry_impl *telemetry)
695 int ret, buffer_read;
697 buffer_read = read(telemetry->accept_fd, buf, BUF_SIZE-1);
699 if (buffer_read == -1) {
700 TELEMETRY_LOG_ERR("Read error");
702 } else if (buffer_read == 0) {
705 buf[buffer_read] = '\0';
706 ret = rte_telemetry_parse_client_message(telemetry, buf);
708 TELEMETRY_LOG_WARN("Parse message failed");
713 if (close(telemetry->accept_fd) < 0) {
714 TELEMETRY_LOG_ERR("Close TELEMETRY socket failed");
718 telemetry->accept_fd = 0;
724 rte_telemetry_accept_new_client(struct telemetry_impl *telemetry)
728 if (telemetry->accept_fd <= 0) {
729 ret = listen(telemetry->server_fd, 1);
731 TELEMETRY_LOG_ERR("Listening error with server fd");
735 telemetry->accept_fd = accept(telemetry->server_fd, NULL, NULL);
736 if (telemetry->accept_fd >= 0 &&
737 telemetry->metrics_register_done == 0) {
738 ret = rte_telemetry_initial_accept(telemetry);
740 TELEMETRY_LOG_ERR("Failed to run initial configurations/tests");
745 ret = rte_telemetry_read_client(telemetry);
747 TELEMETRY_LOG_ERR("Failed to read socket buffer");
756 rte_telemetry_read_client_sockets(struct telemetry_impl *telemetry)
759 telemetry_client *client;
760 char client_buf[BUF_SIZE];
763 TAILQ_FOREACH(client, &telemetry->client_list_head, client_list) {
764 bytes = read(client->fd, client_buf, BUF_SIZE-1);
767 client_buf[bytes] = '\0';
768 telemetry->request_client = client;
769 ret = rte_telemetry_parse(telemetry, client_buf);
771 TELEMETRY_LOG_WARN("Parse socket input failed: %i",
782 rte_telemetry_run(void *userdata)
785 struct telemetry_impl *telemetry = userdata;
787 if (telemetry == NULL) {
788 TELEMETRY_LOG_WARN("TELEMETRY could not be initialised");
792 ret = rte_telemetry_accept_new_client(telemetry);
794 TELEMETRY_LOG_ERR("Accept and read new client failed");
798 ret = rte_telemetry_read_client_sockets(telemetry);
800 TELEMETRY_LOG_ERR("Client socket read failed");
808 *rte_telemetry_run_thread_func(void *userdata)
811 struct telemetry_impl *telemetry = userdata;
813 if (telemetry == NULL) {
814 TELEMETRY_LOG_ERR("%s passed a NULL instance", __func__);
818 while (telemetry->thread_status) {
819 rte_telemetry_run(telemetry);
820 ret = usleep(SLEEP_TIME);
822 TELEMETRY_LOG_ERR("Calling thread could not be put to sleep");
828 rte_telemetry_set_socket_nonblock(int fd)
833 TELEMETRY_LOG_ERR("Invalid fd provided");
837 flags = fcntl(fd, F_GETFL, 0);
841 return fcntl(fd, F_SETFL, flags | O_NONBLOCK);
845 rte_telemetry_create_socket(struct telemetry_impl *telemetry)
848 struct sockaddr_un addr;
849 char socket_path[BUF_SIZE];
851 if (telemetry == NULL)
854 telemetry->server_fd = socket(AF_UNIX, SOCK_SEQPACKET, 0);
855 if (telemetry->server_fd == -1) {
856 TELEMETRY_LOG_ERR("Failed to open socket");
860 ret = rte_telemetry_set_socket_nonblock(telemetry->server_fd);
862 TELEMETRY_LOG_ERR("Could not set socket to NONBLOCK");
866 addr.sun_family = AF_UNIX;
867 rte_telemetry_get_runtime_dir(socket_path, sizeof(socket_path));
868 strlcpy(addr.sun_path, socket_path, sizeof(addr.sun_path));
871 if (bind(telemetry->server_fd, (struct sockaddr *)&addr,
873 TELEMETRY_LOG_ERR("Socket binding error");
880 if (close(telemetry->server_fd) < 0) {
881 TELEMETRY_LOG_ERR("Close TELEMETRY socket failed");
888 int32_t __rte_experimental
893 const char *telemetry_ctrl_thread = "telemetry";
895 if (static_telemetry) {
896 TELEMETRY_LOG_WARN("TELEMETRY structure already initialised");
900 static_telemetry = calloc(1, sizeof(struct telemetry_impl));
901 if (static_telemetry == NULL) {
902 TELEMETRY_LOG_ERR("Memory could not be allocated");
906 static_telemetry->socket_id = rte_socket_id();
907 rte_metrics_init(static_telemetry->socket_id);
909 ret = pthread_attr_init(&attr);
911 TELEMETRY_LOG_ERR("Pthread attribute init failed");
915 ret = rte_telemetry_create_socket(static_telemetry);
917 ret = rte_telemetry_cleanup();
919 TELEMETRY_LOG_ERR("TELEMETRY cleanup failed");
922 TAILQ_INIT(&static_telemetry->client_list_head);
924 ret = rte_ctrl_thread_create(&static_telemetry->thread_id,
925 telemetry_ctrl_thread, &attr, rte_telemetry_run_thread_func,
926 (void *)static_telemetry);
927 static_telemetry->thread_status = 1;
930 ret = rte_telemetry_cleanup();
932 TELEMETRY_LOG_ERR("TELEMETRY cleanup failed");
940 rte_telemetry_client_cleanup(struct telemetry_client *client)
944 ret = close(client->fd);
945 free(client->file_path);
949 TELEMETRY_LOG_ERR("Close client socket failed");
956 int32_t __rte_experimental
957 rte_telemetry_cleanup(void)
960 struct telemetry_impl *telemetry = static_telemetry;
961 telemetry_client *client, *temp_client;
963 TAILQ_FOREACH_SAFE(client, &telemetry->client_list_head, client_list,
965 TAILQ_REMOVE(&telemetry->client_list_head, client, client_list);
966 ret = rte_telemetry_client_cleanup(client);
968 TELEMETRY_LOG_ERR("Client cleanup failed");
973 ret = close(telemetry->server_fd);
975 TELEMETRY_LOG_ERR("Close TELEMETRY socket failed");
980 telemetry->thread_status = 0;
981 pthread_join(telemetry->thread_id, NULL);
983 static_telemetry = NULL;
989 rte_telemetry_unregister_client(struct telemetry_impl *telemetry,
990 const char *client_path)
993 telemetry_client *client, *temp_client;
995 if (telemetry == NULL) {
996 TELEMETRY_LOG_WARN("TELEMETRY is not initialised");
1000 if (client_path == NULL) {
1001 TELEMETRY_LOG_ERR("Invalid client path");
1005 if (TAILQ_EMPTY(&telemetry->client_list_head)) {
1006 TELEMETRY_LOG_ERR("There are no clients currently registered");
1010 TAILQ_FOREACH_SAFE(client, &telemetry->client_list_head, client_list,
1012 if (strcmp(client_path, client->file_path) == 0) {
1013 TAILQ_REMOVE(&telemetry->client_list_head, client,
1015 ret = rte_telemetry_client_cleanup(client);
1018 TELEMETRY_LOG_ERR("Client cleanup failed");
1026 TELEMETRY_LOG_WARN("Couldn't find client, possibly not registered yet.");
1030 ret = rte_telemetry_send_error_response(telemetry, -EINVAL);
1032 TELEMETRY_LOG_ERR("Could not send error");
1037 rte_telemetry_register_client(struct telemetry_impl *telemetry,
1038 const char *client_path)
1041 struct sockaddr_un addrs;
1043 if (telemetry == NULL) {
1044 TELEMETRY_LOG_ERR("Could not initialize TELEMETRY API");
1048 if (client_path == NULL) {
1049 TELEMETRY_LOG_ERR("Invalid client path");
1053 telemetry_client *client;
1054 TAILQ_FOREACH(client, &telemetry->client_list_head, client_list) {
1055 if (strcmp(client_path, client->file_path) == 0) {
1056 TELEMETRY_LOG_WARN("'%s' already registered",
1062 fd = socket(AF_UNIX, SOCK_SEQPACKET, 0);
1064 TELEMETRY_LOG_ERR("Client socket error");
1068 ret = rte_telemetry_set_socket_nonblock(fd);
1070 TELEMETRY_LOG_ERR("Could not set socket to NONBLOCK");
1074 addrs.sun_family = AF_UNIX;
1075 strlcpy(addrs.sun_path, client_path, sizeof(addrs.sun_path));
1076 telemetry_client *new_client = malloc(sizeof(telemetry_client));
1077 new_client->file_path = strdup(client_path);
1078 new_client->fd = fd;
1080 if (connect(fd, (struct sockaddr *)&addrs, sizeof(addrs)) == -1) {
1081 TELEMETRY_LOG_ERR("TELEMETRY client connect to %s didn't work",
1083 ret = rte_telemetry_client_cleanup(new_client);
1085 TELEMETRY_LOG_ERR("Client cleanup failed");
1091 TAILQ_INSERT_HEAD(&telemetry->client_list_head, new_client, client_list);
1097 rte_telemetry_parse_client_message(struct telemetry_impl *telemetry, char *buf)
1099 int ret, action_int;
1101 json_t *root = json_loads(buf, 0, &error);
1104 TELEMETRY_LOG_WARN("Could not load JSON object from data passed in : %s",
1107 } else if (!json_is_object(root)) {
1108 TELEMETRY_LOG_WARN("JSON Request is not a JSON object");
1112 json_t *action = json_object_get(root, "action");
1113 if (action == NULL) {
1114 TELEMETRY_LOG_WARN("Request does not have action field");
1116 } else if (!json_is_integer(action)) {
1117 TELEMETRY_LOG_WARN("Action value is not an integer");
1121 json_t *command = json_object_get(root, "command");
1122 if (command == NULL) {
1123 TELEMETRY_LOG_WARN("Request does not have command field");
1125 } else if (!json_is_string(command)) {
1126 TELEMETRY_LOG_WARN("Command value is not a string");
1130 action_int = json_integer_value(action);
1131 if (action_int != ACTION_POST) {
1132 TELEMETRY_LOG_WARN("Invalid action code");
1136 if (strcmp(json_string_value(command), "clients") != 0) {
1137 TELEMETRY_LOG_WARN("Invalid command");
1141 json_t *data = json_object_get(root, "data");
1143 TELEMETRY_LOG_WARN("Request does not have data field");
1147 json_t *client_path = json_object_get(data, "client_path");
1148 if (client_path == NULL) {
1149 TELEMETRY_LOG_WARN("Request does not have client_path field");
1153 if (!json_is_string(client_path)) {
1154 TELEMETRY_LOG_WARN("Client_path value is not a string");
1158 ret = rte_telemetry_register_client(telemetry,
1159 json_string_value(client_path));
1161 TELEMETRY_LOG_ERR("Could not register client");
1162 telemetry->register_fail_count++;
1169 TELEMETRY_LOG_WARN("Client attempted to register with invalid message");
1175 rte_telemetry_dummy_client_socket(const char *valid_client_path)
1177 int sockfd = socket(AF_UNIX, SOCK_SEQPACKET, 0);
1178 struct sockaddr_un addr = {0};
1181 TELEMETRY_LOG_ERR("Test socket creation failure");
1185 addr.sun_family = AF_UNIX;
1186 strlcpy(addr.sun_path, valid_client_path, sizeof(addr.sun_path));
1187 unlink(valid_client_path);
1189 if (bind(sockfd, (struct sockaddr *)&addr, sizeof(addr)) < 0) {
1190 TELEMETRY_LOG_ERR("Test socket binding failure");
1194 if (listen(sockfd, 1) < 0) {
1195 TELEMETRY_LOG_ERR("Listen failure");
1202 int32_t __rte_experimental
1203 rte_telemetry_selftest(void)
1205 const char *invalid_client_path = SELFTEST_INVALID_CLIENT;
1206 const char *valid_client_path = SELFTEST_VALID_CLIENT;
1209 TELEMETRY_LOG_INFO("Selftest");
1211 ret = rte_telemetry_init();
1213 TELEMETRY_LOG_ERR("Valid initialisation test failed");
1217 TELEMETRY_LOG_INFO("Success - Valid initialisation test passed");
1219 ret = rte_telemetry_init();
1220 if (ret != -EALREADY) {
1221 TELEMETRY_LOG_ERR("Invalid initialisation test failed");
1225 TELEMETRY_LOG_INFO("Success - Invalid initialisation test passed");
1227 ret = rte_telemetry_unregister_client(static_telemetry,
1228 invalid_client_path);
1229 if (ret != -EPERM) {
1230 TELEMETRY_LOG_ERR("Invalid unregister test failed");
1234 TELEMETRY_LOG_INFO("Success - Invalid unregister test passed");
1236 sockfd = rte_telemetry_dummy_client_socket(valid_client_path);
1238 TELEMETRY_LOG_ERR("Test socket creation failed");
1242 ret = rte_telemetry_register_client(static_telemetry, valid_client_path);
1244 TELEMETRY_LOG_ERR("Valid register test failed: %i", ret);
1248 accept(sockfd, NULL, NULL);
1249 TELEMETRY_LOG_INFO("Success - Valid register test passed");
1251 ret = rte_telemetry_register_client(static_telemetry, valid_client_path);
1252 if (ret != -EINVAL) {
1253 TELEMETRY_LOG_ERR("Invalid register test failed: %i", ret);
1257 TELEMETRY_LOG_INFO("Success - Invalid register test passed");
1259 ret = rte_telemetry_unregister_client(static_telemetry,
1260 invalid_client_path);
1262 TELEMETRY_LOG_ERR("Invalid unregister test failed: %i", ret);
1266 TELEMETRY_LOG_INFO("Success - Invalid unregister test passed");
1268 ret = rte_telemetry_unregister_client(static_telemetry, valid_client_path);
1270 TELEMETRY_LOG_ERR("Valid unregister test failed: %i", ret);
1274 TELEMETRY_LOG_INFO("Success - Valid unregister test passed");
1276 ret = rte_telemetry_cleanup();
1278 TELEMETRY_LOG_ERR("Cleanup test failed");
1282 TELEMETRY_LOG_INFO("Success - Valid cleanup test passed");
1288 rte_telemetry_socket_messaging_testing(int index, int socket)
1290 struct telemetry_impl *telemetry = calloc(1, sizeof(telemetry_impl));
1291 int fd, bad_send_fd, send_fd, bad_fd, bad_recv_fd, recv_fd, ret;
1293 if (telemetry == NULL) {
1294 TELEMETRY_LOG_ERR("Could not initialize Telemetry API");
1298 telemetry->server_fd = socket;
1299 telemetry->reg_index = index;
1300 TELEMETRY_LOG_INFO("Beginning Telemetry socket message Selftest");
1301 rte_telemetry_socket_test_setup(telemetry, &send_fd, &recv_fd);
1302 TELEMETRY_LOG_INFO("Register valid client test");
1304 ret = rte_telemetry_socket_register_test(telemetry, &fd, send_fd,
1307 TELEMETRY_LOG_ERR("Register valid client test failed!");
1312 TELEMETRY_LOG_INFO("Success - Register valid client test passed!");
1314 TELEMETRY_LOG_INFO("Register invalid/same client test");
1315 ret = rte_telemetry_socket_test_setup(telemetry, &bad_send_fd,
1317 ret = rte_telemetry_socket_register_test(telemetry, &bad_fd,
1318 bad_send_fd, bad_recv_fd);
1320 TELEMETRY_LOG_ERR("Register invalid/same client test failed!");
1325 TELEMETRY_LOG_INFO("Success - Register invalid/same client test passed!");
1327 ret = rte_telemetry_json_socket_message_test(telemetry, fd);
1338 rte_telemetry_socket_register_test(struct telemetry_impl *telemetry, int *fd,
1339 int send_fd, int recv_fd)
1342 char good_req_string[BUF_SIZE];
1344 snprintf(good_req_string, sizeof(good_req_string),
1345 "{\"action\":1,\"command\":\"clients\",\"data\":{\"client_path\""
1346 ":\"%s\"}}", SOCKET_TEST_CLIENT_PATH);
1350 ret = send(send_fd, good_req_string, strlen(good_req_string), 0);
1352 TELEMETRY_LOG_ERR("Could not send message over socket");
1356 rte_telemetry_run(telemetry);
1358 if (telemetry->register_fail_count != 0)
1361 *fd = accept(recv_fd, NULL, NULL);
1367 rte_telemetry_socket_test_setup(struct telemetry_impl *telemetry, int *send_fd,
1371 const char *client_path = SOCKET_TEST_CLIENT_PATH;
1372 char socket_path[BUF_SIZE];
1373 struct sockaddr_un addr = {0};
1374 struct sockaddr_un addrs = {0};
1375 *send_fd = socket(AF_UNIX, SOCK_SEQPACKET, 0);
1376 *recv_fd = socket(AF_UNIX, SOCK_SEQPACKET, 0);
1378 listen(telemetry->server_fd, 5);
1379 addr.sun_family = AF_UNIX;
1380 rte_telemetry_get_runtime_dir(socket_path, sizeof(socket_path));
1381 strlcpy(addr.sun_path, socket_path, sizeof(addr.sun_path));
1383 ret = connect(*send_fd, (struct sockaddr *) &addr, sizeof(addr));
1385 TELEMETRY_LOG_ERR("Could not connect socket");
1389 telemetry->accept_fd = accept(telemetry->server_fd, NULL, NULL);
1391 addrs.sun_family = AF_UNIX;
1392 strlcpy(addrs.sun_path, client_path, sizeof(addrs.sun_path));
1393 unlink(client_path);
1395 ret = bind(*recv_fd, (struct sockaddr *)&addrs, sizeof(addrs));
1397 TELEMETRY_LOG_ERR("Could not bind socket");
1405 rte_telemetry_stat_parse(char *buf, struct json_data *json_data_struct)
1408 json_t *root = json_loads(buf, 0, &error);
1410 json_t *status, *dataArray, *port, *stats, *name, *value, *dataArrayObj,
1418 TELEMETRY_LOG_ERR("JSON message is NULL");
1423 TELEMETRY_LOG_ERR("Could not load JSON object from data passed in : %s",
1426 } else if (!json_is_object(root)) {
1427 TELEMETRY_LOG_ERR("JSON Request is not a JSON object");
1432 status = json_object_get(root, "status_code");
1434 TELEMETRY_LOG_ERR("Request does not have status field");
1436 } else if (!json_is_string(status)) {
1437 TELEMETRY_LOG_ERR("Status value is not a string");
1441 json_data_struct->status_code = strdup(json_string_value(status));
1443 dataArray = json_object_get(root, "data");
1444 if (dataArray == NULL) {
1445 TELEMETRY_LOG_ERR("Request does not have data field");
1449 arraylen = json_array_size(dataArray);
1450 if (arraylen == 0) {
1451 json_data_struct->data = "null";
1455 for (i = 0; i < arraylen; i++) {
1456 dataArrayObj = json_array_get(dataArray, i);
1457 port = json_object_get(dataArrayObj, "port");
1458 stats = json_object_get(dataArrayObj, "stats");
1462 TELEMETRY_LOG_ERR("Request does not have port field");
1466 if (!json_is_integer(port)) {
1467 TELEMETRY_LOG_ERR("Port value is not an integer");
1471 json_data_struct->port = json_integer_value(port);
1473 if (stats == NULL) {
1474 TELEMETRY_LOG_ERR("Request does not have stats field");
1478 arraylen = json_array_size(stats);
1479 for (i = 0; i < arraylen; i++) {
1480 statsArrayObj = json_array_get(stats, i);
1481 name = json_object_get(statsArrayObj, "name");
1482 value = json_object_get(statsArrayObj, "value");
1486 TELEMETRY_LOG_ERR("Request does not have name field");
1490 if (!json_is_string(name)) {
1491 TELEMETRY_LOG_ERR("Stat name value is not a string");
1495 json_data_struct->stat_name = strdup(json_string_value(name));
1497 if (value == NULL) {
1498 TELEMETRY_LOG_ERR("Request does not have value field");
1502 if (!json_is_integer(value)) {
1503 TELEMETRY_LOG_ERR("Stat value is not an integer");
1507 json_data_struct->stat_value = json_integer_value(value);
1513 rte_telemetry_free_test_data(struct json_data *data)
1515 free(data->status_code);
1516 free(data->stat_name);
1521 rte_telemetry_valid_json_test(struct telemetry_impl *telemetry, int fd)
1527 int buffer_read = 0;
1529 struct json_data *data_struct;
1531 const char *status = "Status OK: 200";
1532 const char *name = "rx_good_packets";
1533 const char *valid_json_message = "{\"action\":0,\"command\":"
1534 "\"ports_stats_values_by_name\",\"data\":{\"ports\""
1535 ":[0],\"stats\":[\"rx_good_packets\"]}}";
1537 ret = send(fd, valid_json_message, strlen(valid_json_message), 0);
1539 TELEMETRY_LOG_ERR("Could not send message over socket");
1543 rte_telemetry_run(telemetry);
1544 buffer_read = recv(fd, buf, BUF_SIZE-1, 0);
1546 if (buffer_read == -1) {
1547 TELEMETRY_LOG_ERR("Read error");
1551 buf[buffer_read] = '\0';
1552 data_struct = calloc(1, sizeof(struct json_data));
1553 ret = rte_telemetry_stat_parse(buf, data_struct);
1556 TELEMETRY_LOG_ERR("Could not parse stats");
1560 if (strcmp(data_struct->status_code, status) != 0) {
1561 TELEMETRY_LOG_ERR("Status code is invalid");
1565 if (data_struct->port != port) {
1566 TELEMETRY_LOG_ERR("Port is invalid");
1570 if (strcmp(data_struct->stat_name, name) != 0) {
1571 TELEMETRY_LOG_ERR("Stat name is invalid");
1575 if (data_struct->stat_value != value) {
1576 TELEMETRY_LOG_ERR("Stat value is invalid");
1580 rte_telemetry_free_test_data(data_struct);
1584 TELEMETRY_LOG_INFO("Success - Passed valid JSON message test passed");
1590 rte_telemetry_invalid_json_test(struct telemetry_impl *telemetry, int fd)
1595 const char *invalid_json = "{]";
1596 const char *status = "Status Error: Unknown";
1597 const char *data = "null";
1598 struct json_data *data_struct;
1599 int buffer_read = 0;
1602 ret = send(fd, invalid_json, strlen(invalid_json), 0);
1604 TELEMETRY_LOG_ERR("Could not send message over socket");
1608 rte_telemetry_run(telemetry);
1609 buffer_read = recv(fd, buf, BUF_SIZE-1, 0);
1611 if (buffer_read == -1) {
1612 TELEMETRY_LOG_ERR("Read error");
1616 buf[buffer_read] = '\0';
1618 data_struct = calloc(1, sizeof(struct json_data));
1619 ret = rte_telemetry_stat_parse(buf, data_struct);
1622 TELEMETRY_LOG_ERR("Could not parse stats");
1624 if (strcmp(data_struct->status_code, status) != 0) {
1625 TELEMETRY_LOG_ERR("Status code is invalid");
1629 if (strcmp(data_struct->data, data) != 0) {
1630 TELEMETRY_LOG_ERR("Data status is invalid");
1634 rte_telemetry_free_test_data(data_struct);
1638 TELEMETRY_LOG_INFO("Success - Passed invalid JSON message test");
1644 rte_telemetry_json_contents_test(struct telemetry_impl *telemetry, int fd)
1649 char *status = "Status Error: Invalid Argument 404";
1650 char *data = "null";
1651 struct json_data *data_struct;
1652 const char *invalid_contents = "{\"action\":0,\"command\":"
1653 "\"ports_stats_values_by_name\",\"data\":{\"ports\""
1654 ":[0],\"stats\":[\"some_invalid_param\","
1655 "\"another_invalid_param\"]}}";
1656 int buffer_read = 0;
1659 ret = send(fd, invalid_contents, strlen(invalid_contents), 0);
1661 TELEMETRY_LOG_ERR("Could not send message over socket");
1665 rte_telemetry_run(telemetry);
1666 buffer_read = recv(fd, buf, BUF_SIZE-1, 0);
1668 if (buffer_read == -1) {
1669 TELEMETRY_LOG_ERR("Read error");
1673 buf[buffer_read] = '\0';
1674 data_struct = calloc(1, sizeof(struct json_data));
1675 ret = rte_telemetry_stat_parse(buf, data_struct);
1678 TELEMETRY_LOG_ERR("Could not parse stats");
1680 if (strcmp(data_struct->status_code, status) != 0) {
1681 TELEMETRY_LOG_ERR("Status code is invalid");
1685 if (strcmp(data_struct->data, data) != 0) {
1686 TELEMETRY_LOG_ERR("Data status is invalid");
1690 rte_telemetry_free_test_data(data_struct);
1694 TELEMETRY_LOG_INFO("Success - Passed invalid JSON content test");
1700 rte_telemetry_json_empty_test(struct telemetry_impl *telemetry, int fd)
1705 const char *status = "Status Error: Invalid Argument 404";
1706 char *data = "null";
1707 struct json_data *data_struct;
1708 const char *empty_json = "{}";
1709 int buffer_read = 0;
1712 ret = (send(fd, empty_json, strlen(empty_json), 0));
1714 TELEMETRY_LOG_ERR("Could not send message over socket");
1718 rte_telemetry_run(telemetry);
1719 buffer_read = recv(fd, buf, BUF_SIZE-1, 0);
1721 if (buffer_read == -1) {
1722 TELEMETRY_LOG_ERR("Read error");
1726 buf[buffer_read] = '\0';
1727 data_struct = calloc(1, sizeof(struct json_data));
1728 ret = rte_telemetry_stat_parse(buf, data_struct);
1731 TELEMETRY_LOG_ERR("Could not parse stats");
1733 if (strcmp(data_struct->status_code, status) != 0) {
1734 TELEMETRY_LOG_ERR("Status code is invalid");
1738 if (strcmp(data_struct->data, data) != 0) {
1739 TELEMETRY_LOG_ERR("Data status is invalid");
1743 rte_telemetry_free_test_data(data_struct);
1748 TELEMETRY_LOG_INFO("Success - Passed JSON empty message test");
1754 rte_telemetry_json_socket_message_test(struct telemetry_impl *telemetry, int fd)
1757 int ret, fail_count;
1760 struct telemetry_message_test socket_json_tests[] = {
1761 {.test_name = "Invalid JSON test",
1762 .test_func_ptr = rte_telemetry_invalid_json_test},
1763 {.test_name = "Valid JSON test",
1764 .test_func_ptr = rte_telemetry_valid_json_test},
1765 {.test_name = "JSON contents test",
1766 .test_func_ptr = rte_telemetry_json_contents_test},
1767 {.test_name = "JSON empty tests",
1768 .test_func_ptr = rte_telemetry_json_empty_test}
1771 #define NUM_TESTS RTE_DIM(socket_json_tests)
1773 for (i = 0; i < NUM_TESTS; i++) {
1774 TELEMETRY_LOG_INFO("%s", socket_json_tests[i].test_name);
1775 ret = (socket_json_tests[i].test_func_ptr)
1778 TELEMETRY_LOG_ERR("%s failed",
1779 socket_json_tests[i].test_name);
1784 if (fail_count > 0) {
1785 TELEMETRY_LOG_ERR("Failed %i JSON socket message test(s)",
1790 TELEMETRY_LOG_INFO("Success - All JSON tests passed");
1795 int telemetry_log_level;
1797 static struct rte_option option = {
1798 .opt_str = "--telemetry",
1799 .cb = &rte_telemetry_init,
1803 RTE_INIT(rte_telemetry_register)
1805 telemetry_log_level = rte_log_register("lib.telemetry");
1806 if (telemetry_log_level >= 0)
1807 rte_log_set_level(telemetry_log_level, RTE_LOG_ERR);
1809 rte_option_register(&option);