sergiotarxz/nuttx-apps
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
bd6bf35ffd
nuttx-apps/system/ping/ping.c

573 lines
18 KiB
C
Raw Blame History

/****************************************************************************
* apps/system/ping/ping.c
*
* Copyright (C) 2017 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 <sys/socket.h>
#include <sys/socket.h>
#include <unistd.h>
#include <stdlib.h>
#include <stdio.h>
#include <poll.h>
#include <string.h>
#include <errno.h>
#if defined(CONFIG_LIBC_NETDB) && defined(CONFIG_NETDB_DNSCLIENT)
# include <netdb.h>
#endif
#include <netinet/in.h>
#include <arpa/inet.h>
#include <nuttx/net/icmp.h>
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
#define ICMP_PING_DATALEN 56
#define ICMP_IOBUFFER_SIZE sizeof(struct icmp_hdr_s) + ICMP_PING_DATALEN
#define ICMP_NPINGS 10 /* Default number of pings */
#define ICMP_POLL_DELAY 1000 /* 1 second in milliseconds */
/****************************************************************************
* Private Types
****************************************************************************/
struct ping_info_s
{
int sockfd; /* Open IPPROTO_ICMP socket */
FAR struct in_addr dest; /* Target address to ping */
uint16_t count; /* Number of pings requested */
uint16_t nrequests; /* Number of ICMP ECHO requests sent */
uint16_t nreplies; /* Number of matching ICMP ECHO replies received */
int16_t delay; /* Deciseconds to delay between pings */
/* I/O buffer for data transfers */
uint8_t iobuffer[ICMP_IOBUFFER_SIZE];
};
/****************************************************************************
* Private Data
****************************************************************************/
/* NOTE: This will not work in the kernel build where there will be a
* separate instance of g_pingid in every process space.
*/
static uint16_t g_pingid = 0;
/****************************************************************************
* Private Functions
****************************************************************************/
/****************************************************************************
* Name: ping_newid
****************************************************************************/
static inline uint16_t ping_newid(void)
{
/* Revisit: No thread safe */
return ++g_pingid;
}
/****************************************************************************
* Name: ping_gethostip
*
* Description:
* Call gethostbyname() to get the IP address associated with a hostname.
*
* Input Parameters
* hostname - The host name to use in the nslookup.
* ipv4addr - The location to return the IPv4 address.
*
* Returned Value:
* Zero (OK) on success; a negated errno value on failure.
*
****************************************************************************/
static int ping_gethostip(FAR char *hostname, FAR struct ping_info_s *info)
{
#if defined(CONFIG_LIBC_NETDB) && defined(CONFIG_NETDB_DNSCLIENT)
/* Netdb DNS client support is enabled */
FAR struct hostent *he;
he = gethostbyname(hostname);
if (he == NULL)
{
nerr("ERROR: gethostbyname failed: %d\n", h_errno);
return -ENOENT;
}
else if (he->h_addrtype == AF_INET)
{
memcpy(&info->dest, he->h_addr, sizeof(in_addr_t));
}
else
{
nerr("ERROR: gethostbyname returned an address of type: %d\n",
he->h_addrtype);
return -ENOEXEC;
}
return OK;
#else /* CONFIG_LIBC_NETDB */
/* No host name support */
/* Convert strings to numeric IPv6 address */
int ret = inet_pton(AF_INET, hostname, &info->dest);
/* The inet_pton() function returns 1 if the conversion succeeds. It will
* return 0 if the input is not a valid IPv4 dotted-decimal string or -1
* with errno set to EAFNOSUPPORT if the address family argument is
* unsupported.
*/
return (ret > 0) ? OK : ERROR;
#endif /* CONFIG_LIBC_NETDB */
}
/****************************************************************************
* Name: icmp_ping
****************************************************************************/
static void icmp_ping(FAR struct ping_info_s *info)
{
struct sockaddr_in destaddr;
struct sockaddr_in fromaddr;
struct icmp_hdr_s outhdr;
FAR struct icmp_hdr_s *inhdr;
struct pollfd recvfd;
FAR uint8_t *ptr;
int32_t elapsed;
systime_t start;
socklen_t addrlen;
ssize_t nsent;
ssize_t nrecvd;
size_t outsize;
bool retry;
int delay;
int ret;
int ch;
int i;
memset(&destaddr, 0, sizeof(struct sockaddr_in));
destaddr.sin_family = AF_INET;
destaddr.sin_port = 0;
destaddr.sin_addr.s_addr = info->dest.s_addr;
memset(&outhdr, 0, sizeof(struct icmp_hdr_s));
outhdr.type = ICMP_ECHO_REQUEST;
outhdr.id = ping_newid();
outhdr.seqno = 0;
printf("PING %u.%u.%u.%u %d bytes of data\n",
(info->dest.s_addr ) & 0xff,
(info->dest.s_addr >> 8 ) & 0xff,
(info->dest.s_addr >> 16) & 0xff,
(info->dest.s_addr >> 24) & 0xff,
ICMP_PING_DATALEN);
while (info->nrequests < info->count)
{
/* Copy the ICMP header into the I/O buffer */
memcpy(info->iobuffer, &outhdr, sizeof(struct icmp_hdr_s));
/* Add some easily verifiable payload data */
ptr = &info->iobuffer[sizeof(struct icmp_hdr_s)];
ch = 0x20;
for (i = 0; i < ICMP_PING_DATALEN; i++)
{
*ptr++ = ch;
if (++ch > 0x7e)
{
ch = 0x20;
}
}
start = clock_systimer();
outsize = sizeof(struct icmp_hdr_s) + ICMP_PING_DATALEN;
nsent = sendto(info->sockfd, info->iobuffer, outsize, 0,
(FAR struct sockaddr*)&destaddr,
sizeof(struct sockaddr_in));
if (nsent < 0)
{
fprintf(stderr, "ERROR: sendto failed at seqno %u: %d\n",
outhdr.seqno, errno);
return;
}
else if (nsent != outsize)
{
fprintf(stderr, "ERROR: sendto returned %ld, expected %lu\n",
(long)nsent, (unsigned long)outsize);
return;
}
info->nrequests++;
delay = info->delay;
do
{
/* Wait for a reply with a timeout */
retry = false;
recvfd.fd = info->sockfd;
recvfd.events = POLLIN;
recvfd.revents = 0;
ret = poll(&recvfd, 1, delay);
if (ret < 0)
{
fprintf(stderr, "ERROR: poll failed: %d\n", errno);
return;
}
else if (ret == 0)
{
printf("No response from %u.%u.%u.%u: icmp_seq=%u time=%u ms\n",
(info->dest.s_addr ) & 0xff,
(info->dest.s_addr >> 8 ) & 0xff,
(info->dest.s_addr >> 16) & 0xff,
(info->dest.s_addr >> 24) & 0xff,
outhdr.seqno, info->delay);
continue;
}
/* Get the ICMP response (ignoring the sender) */
addrlen = sizeof(struct sockaddr_in);
nrecvd = recvfrom(info->sockfd, info->iobuffer,
ICMP_IOBUFFER_SIZE, 0,
(FAR struct sockaddr *)&fromaddr, &addrlen);
if (nrecvd < 0)
{
fprintf(stderr, "ERROR: recvfrom failed: %d\n", errno);
return;
}
else if (nrecvd < sizeof(struct icmp_hdr_s))
{
fprintf(stderr, "ERROR: short ICMP packet: %ld\n", (long)nrecvd);
return;
}
elapsed = (unsigned int)TICK2MSEC(clock_systimer() - start);
inhdr = (FAR struct icmp_hdr_s *)info->iobuffer;
if (inhdr->type == ICMP_ECHO_REPLY)
{
if (inhdr->id != outhdr.id)
{
fprintf(stderr,
"WARNING: Ignoring ICMP reply with ID %u. "
"Expected %u\n",
inhdr->id, outhdr.id);
retry = true;
}
else if (inhdr->seqno > outhdr.seqno)
{
fprintf(stderr,
"WARNING: Ignoring ICMP reply to sequence %u. "
"Expected <= &u\n",
inhdr->seqno, outhdr.seqno);
retry = true;
}
else
{
bool verified = true;
int32_t pktdelay = elapsed;
if (inhdr->seqno < outhdr.seqno)
{
fprintf(stderr, "WARNING: Received after timeout\n");
pktdelay += info->delay;
retry = true;
}
printf("%ld bytes from %u.%u.%u.%u: icmp_seq=%u time=%u ms\n",
nrecvd - sizeof(struct icmp_hdr_s),
(info->dest.s_addr ) & 0xff,
(info->dest.s_addr >> 8 ) & 0xff,
(info->dest.s_addr >> 16) & 0xff,
(info->dest.s_addr >> 24) & 0xff,
inhdr->seqno, pktdelay);
/* Verify the payload data */
if (nrecvd != outsize)
{
fprintf(stderr,
"WARNING: Ignoring ICMP reply with different payload "
"size: %ld vs %lu\n",
(long)nrecvd, (unsigned long)outsize);
verified = false;
}
else
{
ptr = &info->iobuffer[sizeof(struct icmp_hdr_s)];
ch = 0x20;
for (i = 0; i < ICMP_PING_DATALEN; i++, ptr++)
{
if (*ptr != ch)
{
fprintf(stderr, "WARNING: Echoed data corrupted\n");
verified = false;
break;
}
if (++ch > 0x7e)
{
ch = 0x20;
}
}
}
/* Only count the number of good replies */
if (verified)
{
info->nreplies++;
}
}
}
else
{
fprintf(stderr, "WARNING: ICMP packet with unknown type: %u\n",
inhdr->type);
}
delay -= elapsed;
}
while (retry && delay > 0);
/* Wait if necessary to preserved the requested ping rate */
elapsed = (unsigned int)TICK2MSEC(clock_systimer() - start);
if (elapsed < info->delay)
{
struct timespec rqt;
unsigned int remaining;
unsigned int sec;
unsigned int frac; /* In deciseconds */
remaining = info->delay - elapsed;
sec = remaining / MSEC_PER_SEC;
frac = remaining - MSEC_PER_SEC * sec;
rqt.tv_sec = sec;
rqt.tv_nsec = frac * NSEC_PER_MSEC;
(void)nanosleep(&rqt, NULL);
}
outhdr.seqno++;
}
}
/****************************************************************************
* 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>] <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>] <ip-address>\n", progname);
printf(" %s -h\n", progname);
printf("\nWhere:\n");
printf(" <ip-address> is the IPv4 address request the ICMP ECHO reply.\n");
#endif
printf(" -c <count> determines the number of pings. Default %u.\n",
ICMP_NPINGS);
printf(" -i <interval> is the default delay between pings (milliseconds).\n");
printf(" Default %d.\n", ICMP_POLL_DELAY);
printf(" -h shows this text and exits.\n");
exit(exitcode);
}
/****************************************************************************
* Public Functions
****************************************************************************/
#ifdef CONFIG_BUILD_KERNEL
int main(int argc, FAR char *argv[])
#else
int ping_main(int argc, char **argv)
#endif
{
FAR struct ping_info_s *info;
FAR char *endptr;
systime_t start;
int32_t elapsed;
int exitcode;
int option;
/* Allocate memory to hold ping information */
info = (FAR struct ping_info_s *)zalloc(sizeof(struct ping_info_s));
if (info == NULL)
{
fprintf(stderr, "ERROR: Failed to allocate memory\n", argv[1]);
return EXIT_FAILURE;
}
info->count = ICMP_NPINGS;
info->delay = ICMP_POLL_DELAY;
/* Parse command line options */
exitcode = EXIT_FAILURE;
while ((option = getopt(argc, argv, ":c:i: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 > INT16_MAX)
{
fprintf(stderr, "ERROR: <interval> out of range: %ld\n", delay);
goto errout_with_usage;
}
info->delay = (int16_t)delay;
}
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");
free(info);
show_usage(argv[0], EXIT_FAILURE);
}
if (ping_gethostip(argv[optind], info) < 0)
{
fprintf(stderr, "ERROR: ping_gethostip(%s) failed\n", argv[optind]);
goto errout_with_info;
}
info->sockfd = socket(AF_INET, SOCK_DGRAM, IPPROTO_ICMP);
if (info->sockfd < 0)
{
fprintf(stderr, "ERROR: socket() failed: %d\n", errno);
goto errout_with_info;
}
start = clock_systimer();
icmp_ping(info);
/* Get the total elapsed time */
elapsed = (int32_t)TICK2MSEC(clock_systimer() - start);
if (info->nrequests > 0)
{
unsigned int tmp;
/* Calculate the percentage of lost packets */
tmp = (100 * (info->nrequests - info->nreplies) + (info->nrequests >> 1)) /
info->nrequests;
printf("%u packets transmitted, %u received, %u%% packet loss, time %ld ms\n",
info->nrequests, info->nreplies, tmp, (long)elapsed);
}
close(info->sockfd);
free(info);
return EXIT_SUCCESS;
errout_with_usage:
free(info);
show_usage(argv[0], exitcode);
return exitcode; /* Not reachable */
errout_with_info:
free(info);
return EXIT_FAILURE;
}
Reference in New Issue View Git Blame Copy Permalink