/****************************************************************************
* apps/system/ping/ping.c
*
* Copyright (C) 2017-2018 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <gnutt@nuttx.org>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name NuttX nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
****************************************************************************/
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include <unistd.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <errno.h>
#include <arpa/inet.h>
#include "netutils/icmpv6_ping.h"
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
#define ICMPv6_PING6_DATALEN 56
#define ICMPv6_NPINGS 10 /* Default number of pings */
#define ICMPv6_POLL_DELAY 1000 /* 1 second in milliseconds */
/****************************************************************************
* Private Functions
****************************************************************************/
/****************************************************************************
* Name: show_usage
****************************************************************************/
static void show_usage(FAR const char *progname, int exitcode) noreturn_function;
static void show_usage(FAR const char *progname, int exitcode)
{
#if defined(CONFIG_LIBC_NETDB) && defined(CONFIG_NETDB_DNSCLIENT)
printf("\nUsage: %s [-c <count>] [-i <interval>] [-W <timeout>] [-s <size>] <hostname>\n", progname);
printf(" %s -h\n", progname);
printf("\nWhere:\n");
printf(" <hostname> is either an IPv6 address or the name of the remote host\n");
printf(" that is requested the ICMPv6 ECHO reply.\n");
#else
printf("\nUsage: %s [-c <count>] [-i <interval>] [-W <timeout>] [-s <size>] <ip-address>\n", progname);
printf(" %s -h\n", progname);
printf("\nWhere:\n");
printf(" <ip-address> is the IPv6 address request the ICMPv6 ECHO reply.\n");
#endif
printf(" -c <count> determines the number of pings. Default %u.\n",
ICMPv6_NPINGS);
printf(" -i <interval> is the default delay between pings (milliseconds).\n");
printf(" Default %d.\n", ICMPv6_POLL_DELAY);
printf(" -W <timeout> is the timeout for wait response (milliseconds).\n");
printf(" Default %d.\n", ICMPv6_POLL_DELAY);
printf(" -s <size> specifies the number of data bytes to be sent. Default %u.\n",
ICMPv6_PING6_DATALEN);
printf(" -h shows this text and exits.\n");
exit(exitcode);
}
/****************************************************************************
* Name: ping_result
****************************************************************************/
static void ping6_result(FAR const struct ping6_result_s *result)
{
char strbuffer[INET6_ADDRSTRLEN];
switch (result->code)
{
case ICMPv6_E_HOSTIP:
fprintf(stderr, "ERROR: ping6_gethostip(%s) failed\n",
result->info->hostname);
break;
case ICMPv6_E_MEMORY:
fprintf(stderr, "ERROR: Failed to allocate memory\n");
break;
case ICMPv6_E_SOCKET:
fprintf(stderr, "ERROR: socket() failed: %d\n", result->extra);
break;
case ICMPv6_I_BEGIN:
inet_ntop(AF_INET6, result->dest.s6_addr16, strbuffer, INET6_ADDRSTRLEN);
printf("PING6 %s: %u bytes of data\n",
strbuffer, result->info->datalen);
break;
case ICMPv6_E_SENDTO:
fprintf(stderr, "ERROR: sendto failed at seqno %u: %d\n",
result->seqno, result->extra);
break;
case ICMPv6_E_SENDSMALL:
fprintf(stderr, "ERROR: sendto returned %d, expected %u\n",
result->extra, result->outsize);
break;
case ICMPv6_E_POLL:
fprintf(stderr, "ERROR: poll failed: %d\n", result->extra);
break;
case ICMPv6_W_TIMEOUT:
inet_ntop(AF_INET6, result->dest.s6_addr16, strbuffer,
INET6_ADDRSTRLEN);
printf("No response from %s: icmp_seq=%u time=%d ms\n",
strbuffer, result->seqno, result->extra);
break;
case ICMPv6_E_RECVFROM:
fprintf(stderr, "ERROR: recvfrom failed: %d\n", result->extra);
break;
case ICMPv6_E_RECVSMALL:
fprintf(stderr, "ERROR: short ICMP packet: %d\n", result->extra);
break;
case ICMPv6_W_IDDIFF:
fprintf(stderr,
"WARNING: Ignoring ICMP reply with ID %d. "
"Expected %u\n",
result->extra, result->id);
break;
case ICMPv6_W_SEQNOBIG:
fprintf(stderr,
"WARNING: Ignoring ICMP reply to sequence %d. "
"Expected <= %u\n",
result->extra, result->seqno);
break;
case ICMPv6_W_SEQNOSMALL:
fprintf(stderr, "WARNING: Received after timeout\n");
break;
case ICMPv6_I_ROUNDTRIP:
inet_ntop(AF_INET6, result->dest.s6_addr16, strbuffer,
INET6_ADDRSTRLEN);
printf("%u bytes from %s icmp_seq=%u time=%u ms\n",
result->info->datalen, strbuffer, result->seqno,
result->extra);
break;
case ICMPv6_W_RECVBIG:
fprintf(stderr,
"WARNING: Ignoring ICMP reply with different payload "
"size: %d vs %u\n",
result->extra, result->outsize);
break;
case ICMPv6_W_DATADIFF:
fprintf(stderr, "WARNING: Echoed data corrupted\n");
break;
case ICMPv6_W_TYPE:
fprintf(stderr, "WARNING: ICMP packet with unknown type: %d\n",
result->extra);
break;
case ICMPv6_I_FINISH:
if (result->nrequests > 0)
{
unsigned int tmp;
/* Calculate the percentage of lost packets */
tmp = (100 * (result->nrequests - result->nreplies) +
(result->nrequests >> 1)) /
result->nrequests;
printf("%u packets transmitted, %u received, %u%% packet loss, time %d ms\n",
result->nrequests, result->nreplies, tmp, result->extra);
}
break;
}
}
/****************************************************************************
* Public Functions
****************************************************************************/
int main(int argc, FAR char *argv[])
{
struct ping6_info_s info;
FAR char *endptr;
int exitcode;
int option;
info.count = ICMPv6_NPINGS;
info.datalen = ICMPv6_PING6_DATALEN;
info.delay = ICMPv6_POLL_DELAY;
info.timeout = ICMPv6_POLL_DELAY;
info.callback = ping6_result;
/* Parse command line options */
exitcode = EXIT_FAILURE;
while ((option = getopt(argc, argv, ":c:i:W:s:h")) != ERROR)
{
switch (option)
{
case 'c':
{
long count = strtol(optarg, &endptr, 10);
if (count < 1 || count > UINT16_MAX)
{
fprintf(stderr, "ERROR: <count> out of range: %ld\n", count);
goto errout_with_usage;
}
info.count = (uint16_t)count;
}
break;
case 'i':
{
long delay = strtol(optarg, &endptr, 10);
if (delay < 1 || delay > UINT16_MAX)
{
fprintf(stderr, "ERROR: <interval> out of range: %ld\n", delay);
goto errout_with_usage;
}
info.delay = (int16_t)delay;
}
break;
case 'W':
{
long timeout = strtol(optarg, &endptr, 10);
if (timeout < 1 || timeout > UINT16_MAX)
{
fprintf(stderr, "ERROR: <timeout> out of range: %ld\n", timeout);
goto errout_with_usage;
}
info.timeout = (int16_t)timeout;
}
break;
case 's':
{
long datalen = strtol(optarg, &endptr, 10);
if (datalen < 1 || datalen > UINT16_MAX)
{
fprintf(stderr, "ERROR: <size> out of range: %ld\n", datalen);
goto errout_with_usage;
}
info.datalen = (uint16_t)datalen;
}
break;
case 'h':
exitcode = EXIT_SUCCESS;
goto errout_with_usage;
case ':':
fprintf(stderr, "ERROR: Missing required argument\n");
goto errout_with_usage;
case '?':
default:
fprintf(stderr, "ERROR: Unrecognized option\n");
goto errout_with_usage;
}
}
/* There should be one final parameters remaining on the command line */
if (optind >= argc)
{
printf("ERROR: Missing required <ip-address> argument\n");
goto errout_with_usage;
}
info.hostname = argv[optind];
icmp6_ping(&info);
return EXIT_SUCCESS;
errout_with_usage:
optind = 0;
show_usage(argv[0], exitcode);
return exitcode; /* Not reachable */
}