dc5be379a9
apps/netutils/netlib: netlib_ipv[4|6]adaptor() will now use the new routing table interfaces if they are available: If the desination IP address does not correspond to the network served by any device, then the address of the router that should get us to the correct sub-net is is determined. Then the network adaptor that can communicate with the that router has the IP address that will returned.
apps/netutils/netlib: Add new utilities netlib_ipv[4|6]router() that can be used to determine the IP address of a router that would be used some some destination IP address that is not locally accessible.
apps/netutils/netlib: Add helpers for reading the routing table: netlib_read_ipv4route() and netlib_read_ipv6route()
286 lines
10 KiB
C
286 lines
10 KiB
C
/****************************************************************************
|
|
* apps/include/netutils/netlib.h
|
|
* Various non-standard APIs to support netutils. All non-standard and
|
|
* intended only for internal use.
|
|
*
|
|
* Copyright (C) 2007, 2009, 2011, 2015, 2017 Gregory Nutt. All rights reserved.
|
|
* Author: Gregory Nutt <gnutt@nuttx.org>
|
|
*
|
|
* Some of these APIs derive from uIP. uIP also has a BSD style license:
|
|
*
|
|
* Author: Adam Dunkels <adam@sics.se>
|
|
* Copyright (c) 2002, Adam Dunkels.
|
|
* All rights reserved.
|
|
*
|
|
* 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. The name of the author may not be used to endorse or promote
|
|
* products derived from this software without specific prior
|
|
* written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifndef __APPS_INCLUDE_NETUTILS_NETLIB_H
|
|
#define __APPS_INCLUDE_NETUTILS_NETLIB_H
|
|
|
|
/****************************************************************************
|
|
* Included Files
|
|
****************************************************************************/
|
|
|
|
#include <nuttx/config.h>
|
|
|
|
#include <stdint.h>
|
|
#include <stdbool.h>
|
|
#include <stdio.h>
|
|
#include <pthread.h>
|
|
|
|
#include <netinet/in.h>
|
|
#include <nuttx/net/netconfig.h>
|
|
|
|
/****************************************************************************
|
|
* Pre-processor Definitions
|
|
****************************************************************************/
|
|
|
|
#undef HAVE_ROUTE_PROCFS
|
|
#if !defined(CONFIG_DISABLE_MOUNTPOINT) && defined(CONFIG_NET_ROUTE) && \
|
|
defined(CONFIG_FS_PROCFS) && !defined(CONFIG_FS_PROCFS_EXCLUDE_ROUTE)
|
|
# define HAVE_ROUTE_PROCFS
|
|
#endif
|
|
|
|
#ifdef HAVE_ROUTE_PROCFS
|
|
# ifndef CONFIG_NETLIB_PROCFS_MOUNTPT
|
|
# define CONFIG_NETLIB_PROCFS_MOUNTPT "/proc"
|
|
# endif
|
|
|
|
# define IPv4_ROUTE_PATH CONFIG_NETLIB_PROCFS_MOUNTPT "/net/route/ipv4"
|
|
# define IPv6_ROUTE_PATH CONFIG_NETLIB_PROCFS_MOUNTPT "/net/route/ipv6"
|
|
#endif
|
|
|
|
/* SOCK_DGRAM is the preferred socket type to use when we just want a
|
|
* socket for performing drive ioctls. However, we can't use SOCK_DRAM
|
|
* if UDP is disabled.
|
|
*/
|
|
|
|
#if defined(CONFIG_NET_UDP)
|
|
# define NETLIB_SOCK_IOCTL SOCK_DGRAM
|
|
#elif defined(CONFIG_NET_TCP)
|
|
# define NETLIB_SOCK_IOCTL SOCK_STREAM
|
|
#elif defined(CONFIG_NET_IEEE802154)
|
|
# define NETLIB_SOCK_IOCTL SOCK_DGRAM
|
|
#elif defined(CONFIG_NET_PKT)
|
|
# define NETLIB_SOCK_IOCTL SOCK_RAW
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Public Types
|
|
****************************************************************************/
|
|
|
|
#ifdef HAVE_ROUTE_PROCFS
|
|
/* Describes one entry from the IPv4 routing table. All addresses are in
|
|
* host byte order!
|
|
*/
|
|
|
|
#ifdef CONFIG_NET_IPv4
|
|
struct netlib_ipv4_route_s
|
|
{
|
|
in_addr_t prefix; /* Routing prefix */
|
|
in_addr_t netmask; /* Routing netmask */
|
|
in_addr_t router; /* Router IPv4 address */
|
|
};
|
|
#endif
|
|
|
|
/* Describes one entry from the IPv6 routing table. All addresses are in
|
|
* host byte order!
|
|
*/
|
|
|
|
#ifdef CONFIG_NET_IPv6
|
|
struct netlib_ipv6_route_s
|
|
{
|
|
uint16_t prefix[8]; /* Routing prefix */
|
|
uint16_t netmask[8]; /* Routing netmask */
|
|
uint16_t router[8]; /* Router IPv6 address */
|
|
};
|
|
#endif
|
|
#endif /* HAVE_ROUTE_PROCFS */
|
|
|
|
/****************************************************************************
|
|
* Public Data
|
|
****************************************************************************/
|
|
|
|
#undef EXTERN
|
|
#if defined(__cplusplus)
|
|
#define EXTERN extern "C"
|
|
extern "C"
|
|
{
|
|
#else
|
|
#define EXTERN extern
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Public Function Prototypes
|
|
****************************************************************************/
|
|
|
|
/* Convert a textual representation of an IP address to a numerical representation.
|
|
*
|
|
* This function takes a textual representation of an IP address in
|
|
* the form a.b.c.d and converts it into a 4-byte array that can be
|
|
* used by other uIP functions.
|
|
*
|
|
* addrstr A pointer to a string containing the IP address in
|
|
* textual form.
|
|
*
|
|
* addr A pointer to a 4-byte array that will be filled in with
|
|
* the numerical representation of the address.
|
|
*
|
|
* Return: 0 If the IP address could not be parsed.
|
|
* Return: Non-zero If the IP address was parsed.
|
|
*/
|
|
|
|
bool netlib_ipv4addrconv(FAR const char *addrstr, FAR uint8_t *addr);
|
|
bool netlib_ethaddrconv(FAR const char *hwstr, FAR uint8_t *hw);
|
|
|
|
#ifdef CONFIG_NET_ETHERNET
|
|
/* Get and set IP/MAC addresses (Ethernet L2 only) */
|
|
|
|
int netlib_setmacaddr(FAR const char *ifname, FAR const uint8_t *macaddr);
|
|
int netlib_getmacaddr(FAR const char *ifname, FAR uint8_t *macaddr);
|
|
#endif
|
|
|
|
#ifdef CONFIG_WIRELESS_IEEE802154
|
|
/* IEEE 802.15.4 MAC IOCTL commands. */
|
|
|
|
int netlib_seteaddr(FAR const char *ifname, FAR const uint8_t *eaddr);
|
|
int netlib_getpanid(FAR const char *ifname, FAR uint8_t *panid);
|
|
bool netlib_saddrconv(FAR const char *hwstr, FAR uint8_t *hw);
|
|
bool netlib_eaddrconv(FAR const char *hwstr, FAR uint8_t *hw);
|
|
#endif
|
|
|
|
#ifdef CONFIG_WIRELESS_PKTRADIO
|
|
/* IEEE 802.15.4 MAC IOCTL commands. */
|
|
|
|
struct pktradio_properties_s; /* Forward reference */
|
|
struct pktradio_addr_s; /* Forward reference */
|
|
|
|
int netlib_getproperties(FAR const char *ifname,
|
|
FAR struct pktradio_properties_s *properties);
|
|
int netlib_setnodeaddr(FAR const char *ifname,
|
|
FAR const struct pktradio_addr_s *nodeaddr);
|
|
int netlib_getnodnodeaddr(FAR const char *ifname,
|
|
FAR struct pktradio_addr_s *nodeaddr);
|
|
bool netlib_nodeaddrconv(FAR const char *addrstr,
|
|
FAR struct pktradio_addr_s *nodeaddr);
|
|
#endif
|
|
|
|
/* IP address support */
|
|
|
|
#ifdef CONFIG_NET_IPv4
|
|
int netlib_get_ipv4addr(FAR const char *ifname, FAR struct in_addr *addr);
|
|
int netlib_set_ipv4addr(FAR const char *ifname, FAR const struct in_addr *addr);
|
|
int netlib_set_dripv4addr(FAR const char *ifname, FAR const struct in_addr *addr);
|
|
int netlib_get_dripv4addr(FAR const char *ifname, FAR struct in_addr *addr);
|
|
int netlib_set_ipv4netmask(FAR const char *ifname, FAR const struct in_addr *addr);
|
|
int netlib_get_ipv4netmask(FAR const char *ifname, FAR struct in_addr *addr);
|
|
int netlib_ipv4adaptor(in_addr_t destipaddr, FAR in_addr_t *srcipaddr);
|
|
#endif
|
|
|
|
#ifdef CONFIG_NET_IPv6
|
|
int netlib_get_ipv6addr(FAR const char *ifname, FAR struct in6_addr *addr);
|
|
int netlib_set_ipv6addr(FAR const char *ifname, FAR const struct in6_addr *addr);
|
|
int netlib_set_dripv6addr(FAR const char *ifname, FAR const struct in6_addr *addr);
|
|
int netlib_set_ipv6netmask(FAR const char *ifname, FAR const struct in6_addr *addr);
|
|
int netlib_ipv6adaptor(FAR const struct in6_addr *destipaddr,
|
|
FAR struct in6_addr *srcipaddr);
|
|
|
|
uint8_t netlib_ipv6netmask2prefix(FAR const uint16_t *mask);
|
|
void netlib_prefix2ipv6netmask(uint8_t preflen, FAR struct in6_addr *netmask);
|
|
#endif
|
|
|
|
#ifdef CONFIG_NETDEV_WIRELESS_IOCTL
|
|
int netlib_getessid(FAR const char *ifname, FAR char *essid, size_t idlen);
|
|
int netlib_setessid(FAR const char *ifname, FAR const char *essid);
|
|
#endif
|
|
|
|
#ifdef CONFIG_NET_ARP
|
|
/* ARP Table Support */
|
|
|
|
int netlib_del_arpmapping(FAR const struct sockaddr_in *inaddr);
|
|
int netlib_get_arpmapping(FAR const struct sockaddr_in *inaddr,
|
|
FAR uint8_t *macaddr);
|
|
int netlib_set_arpmapping(FAR const struct sockaddr_in *inaddr,
|
|
FAR const uint8_t *macaddr);
|
|
#endif
|
|
|
|
#ifdef HAVE_ROUTE_PROCFS
|
|
# ifdef CONFIG_NET_IPv4
|
|
# define netlib_open_ipv4route() fopen(IPv4_ROUTE_PATH, "r")
|
|
# define netlib_close_ipv4route(stream) fclose(stream)
|
|
ssize_t netlib_read_ipv4route(FILE *stream,
|
|
FAR struct netlib_ipv4_route_s *route);
|
|
int netlib_ipv4router(FAR const struct in_addr *destipaddr,
|
|
FAR struct in_addr *router);
|
|
# endif
|
|
# ifdef CONFIG_NET_IPv6
|
|
# define netlib_open_ipv6route() fopen(IPv6_ROUTE_PATH, "r")
|
|
# define netlib_close_ipv6route(stream) fclose(stream)
|
|
ssize_t netlib_read_ipv6route(FILE *stream,
|
|
FAR struct netlib_ipv6_route_s *route);
|
|
int netlib_ipv6router(FAR const struct in6_addr *destipaddr,
|
|
FAR struct in6_addr *router);
|
|
# endif
|
|
#endif
|
|
|
|
#ifdef CONFIG_NET_ICMPv6_AUTOCONF
|
|
/* ICMPv6 Autoconfiguration */
|
|
|
|
int netlib_icmpv6_autoconfiguration(FAR const char *ifname);
|
|
#endif
|
|
|
|
/* HTTP support */
|
|
|
|
int netlib_parsehttpurl(FAR const char *url, uint16_t *port,
|
|
FAR char *hostname, int hostlen,
|
|
FAR char *filename, int namelen);
|
|
|
|
/* Generic server logic */
|
|
|
|
int netlib_listenon(uint16_t portno);
|
|
void netlib_server(uint16_t portno, pthread_startroutine_t handler,
|
|
int stacksize);
|
|
|
|
int netlib_getifstatus(FAR const char *ifname, FAR uint8_t *flags);
|
|
int netlib_ifup(FAR const char *ifname);
|
|
int netlib_ifdown(FAR const char *ifname);
|
|
|
|
/* DNS server addressing */
|
|
|
|
#if defined(CONFIG_NET_IPv4) && defined(CONFIG_NETDB_DNSCLIENT)
|
|
int netlib_set_ipv4dnsaddr(FAR const struct in_addr *inaddr);
|
|
#endif
|
|
|
|
#undef EXTERN
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __APPS_INCLUDE_NETUTILS_NETLIB_H */
|