/* * SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ #include #include #include "sdkconfig.h" #include "lwip/inet.h" #include "lwip/netdb.h" #include "lwip/sockets.h" #include "esp_console.h" #include "esp_event.h" #include "esp_log.h" #include "argtable3/argtable3.h" #include "ping/ping_sock.h" #include "console_ping.h" static const char *TAG = "console_ping"; SemaphoreHandle_t sync_semaphore; /** * Static registration of this plugin is achieved by defining the plugin description * structure and placing it into .console_cmd_desc section. * The name of the section and its placement is determined by linker.lf file in 'plugins' component. */ static const console_cmd_plugin_desc_t __attribute__((section(".console_cmd_desc"), used)) PLUGIN = { .name = "console_cmd_ping", .plugin_regd_fn = &console_cmd_ping_register }; static void cmd_ping_on_ping_success(esp_ping_handle_t hdl, void *args) { uint8_t ttl; uint16_t seqno; uint32_t elapsed_time, recv_len; ip_addr_t target_addr; esp_ping_get_profile(hdl, ESP_PING_PROF_SEQNO, &seqno, sizeof(seqno)); esp_ping_get_profile(hdl, ESP_PING_PROF_TTL, &ttl, sizeof(ttl)); esp_ping_get_profile(hdl, ESP_PING_PROF_IPADDR, &target_addr, sizeof(target_addr)); esp_ping_get_profile(hdl, ESP_PING_PROF_SIZE, &recv_len, sizeof(recv_len)); esp_ping_get_profile(hdl, ESP_PING_PROF_TIMEGAP, &elapsed_time, sizeof(elapsed_time)); printf("%" PRIu32 " bytes from %s icmp_seq=%" PRIu16 " ttl=%" PRIu16 " time=%" PRIu32 " ms\n", recv_len, ipaddr_ntoa((ip_addr_t *)&target_addr), seqno, ttl, elapsed_time); } static void cmd_ping_on_ping_timeout(esp_ping_handle_t hdl, void *args) { uint16_t seqno; ip_addr_t target_addr; esp_ping_get_profile(hdl, ESP_PING_PROF_SEQNO, &seqno, sizeof(seqno)); esp_ping_get_profile(hdl, ESP_PING_PROF_IPADDR, &target_addr, sizeof(target_addr)); printf("From %s icmp_seq=%d timeout\n", ipaddr_ntoa((ip_addr_t *)&target_addr), seqno); } static void cmd_ping_on_ping_end(esp_ping_handle_t hdl, void *args) { ip_addr_t target_addr; uint32_t transmitted; uint32_t received; uint32_t total_time_ms; uint32_t loss; esp_ping_get_profile(hdl, ESP_PING_PROF_REQUEST, &transmitted, sizeof(transmitted)); esp_ping_get_profile(hdl, ESP_PING_PROF_REPLY, &received, sizeof(received)); esp_ping_get_profile(hdl, ESP_PING_PROF_IPADDR, &target_addr, sizeof(target_addr)); esp_ping_get_profile(hdl, ESP_PING_PROF_DURATION, &total_time_ms, sizeof(total_time_ms)); if (transmitted > 0) { loss = (uint32_t)((1 - ((float)received) / transmitted) * 100); } else { loss = 0; } if (IP_IS_V4(&target_addr)) { printf("\n--- %s ping statistics ---\n", inet_ntoa(*ip_2_ip4(&target_addr))); } else { printf("\n--- %s ping statistics ---\n", inet6_ntoa(*ip_2_ip6(&target_addr))); } printf("%" PRIu32 " packets transmitted, %" PRIu32 " received, %" PRIu32 "%% packet loss, time %" PRIu32 "ms\n", transmitted, received, loss, total_time_ms); // delete the ping sessions, so that we clean up all resources and can create a new ping session ESP_ERROR_CHECK(esp_ping_delete_session(hdl)); /* Give the semaphore as ping task is done */ xSemaphoreGive(sync_semaphore); } static struct { struct arg_dbl *timeout; struct arg_dbl *interval; struct arg_int *data_size; struct arg_int *count; struct arg_int *tos; struct arg_int *ttl; struct arg_str *host; struct arg_end *end; } ping_args; static int do_ping_cmd(int argc, char **argv) { esp_ping_config_t config = ESP_PING_DEFAULT_CONFIG(); int nerrors = arg_parse(argc, argv, (void **)&ping_args); if (nerrors != 0) { arg_print_errors(stderr, ping_args.end, argv[0]); return 1; } if (ping_args.timeout->count > 0) { config.timeout_ms = (uint32_t)(ping_args.timeout->dval[0] * 1000); } if (ping_args.interval->count > 0) { config.interval_ms = (uint32_t)(ping_args.interval->dval[0] * 1000); } if (ping_args.data_size->count > 0) { config.data_size = (uint32_t)(ping_args.data_size->ival[0]); } if (ping_args.count->count > 0) { config.count = (uint32_t)(ping_args.count->ival[0]); } if (ping_args.tos->count > 0) { config.tos = (uint32_t)(ping_args.tos->ival[0]); } if (ping_args.ttl->count > 0) { config.ttl = (uint32_t)(ping_args.ttl->ival[0]); } // parse IP address struct sockaddr_in6 sock_addr6; ip_addr_t target_addr = {0}; if (inet_pton(AF_INET6, ping_args.host->sval[0], &sock_addr6.sin6_addr) == 1) { /* convert ip6 string to ip6 address */ ipaddr_aton(ping_args.host->sval[0], &target_addr); } else { struct addrinfo hint = {0}; struct addrinfo *res = NULL; /* convert ip4 string or hostname to ip4 or ip6 address */ if (getaddrinfo(ping_args.host->sval[0], NULL, &hint, &res) != 0) { printf("ping: unknown host %s\n", ping_args.host->sval[0]); return 1; } if (res->ai_family == AF_INET) { struct in_addr addr4 = ((struct sockaddr_in *) (res->ai_addr))->sin_addr; inet_addr_to_ip4addr(ip_2_ip4(&target_addr), &addr4); } else { struct in6_addr addr6 = ((struct sockaddr_in6 *) (res->ai_addr))->sin6_addr; inet6_addr_to_ip6addr(ip_2_ip6(&target_addr), &addr6); } freeaddrinfo(res); } config.target_addr = target_addr; /* set callback functions */ esp_ping_callbacks_t cbs = { .cb_args = NULL, .on_ping_success = cmd_ping_on_ping_success, .on_ping_timeout = cmd_ping_on_ping_timeout, .on_ping_end = cmd_ping_on_ping_end }; esp_ping_handle_t ping; ESP_ERROR_CHECK(esp_ping_new_session(&config, &cbs, &ping)); ESP_ERROR_CHECK(esp_ping_start(ping)); /* Wait till the ping task is done */ if (xSemaphoreTake(sync_semaphore, portMAX_DELAY) != pdTRUE) { ESP_LOGE(TAG, "Error in xSemaphoreTake\n"); } return 0; } /** * @brief Registers the ping command. * * @return * - esp_err_t */ esp_err_t console_cmd_ping_register(void) { esp_err_t ret; sync_semaphore = xSemaphoreCreateBinary(); ping_args.timeout = arg_dbl0("W", "timeout", "", "Time to wait for a response, in seconds"); ping_args.interval = arg_dbl0("i", "interval", "", "Wait interval seconds between sending each packet"); ping_args.data_size = arg_int0("s", "size", "", "Specify the number of data bytes to be sent"); ping_args.count = arg_int0("c", "count", "", "Stop after sending count packets"); ping_args.tos = arg_int0("Q", "tos", "", "Set Type of Service related bits in IP datagrams"); ping_args.ttl = arg_int0("T", "ttl", "", "Set Time to Live related bits in IP datagrams"); ping_args.host = arg_str1(NULL, NULL, "", "Host address"); ping_args.end = arg_end(1); const esp_console_cmd_t ping_cmd = { .command = "ping", .help = "send ICMP ECHO_REQUEST to network hosts", .hint = NULL, .func = &do_ping_cmd, .argtable = &ping_args }; ret = esp_console_cmd_register(&ping_cmd); if (ret) { ESP_LOGE(TAG, "Unable to register ping"); } return ret; }