From 24aaba0ecaa945ea21837206f6361a5448db808c Mon Sep 17 00:00:00 2001 From: Arto Kinnunen Date: Fri, 28 Aug 2020 15:12:51 +0300 Subject: [PATCH 1/6] Mesh: Enable Nanostack DNS cache usage Inherit methods gethostbyname, gethostbyname_async and get_dns_server to Nanostack class. Methods will try to find DNS server address or DNS query results from Nanostack DNS cache. --- .../nanostack-interface/Nanostack.cpp | 120 ++++++++++++++++++ .../nanostack/nanostack-interface/Nanostack.h | 52 ++++++++ 2 files changed, 172 insertions(+) diff --git a/features/nanostack/nanostack-interface/Nanostack.cpp b/features/nanostack/nanostack-interface/Nanostack.cpp index bc629155a1..32025f1d07 100644 --- a/features/nanostack/nanostack-interface/Nanostack.cpp +++ b/features/nanostack/nanostack-interface/Nanostack.cpp @@ -30,12 +30,20 @@ #include "mesh_system.h" // from inside mbed-mesh-api #include "socket_api.h" #include "net_interface.h" +#include "nsapi_dns.h" // Uncomment to enable trace //#define HAVE_DEBUG #include "ns_trace.h" #define TRACE_GROUP "nsif" +#define NSIF_DEEP_TRACE +#ifdef NSIF_DEEP_TRACE +#define TRACE_DEEP tr_debug +#else +#define TRACE_DEP(...) +#endif + #define NS_INTERFACE_SOCKETS_MAX 16 //same as NanoStack SOCKET_MAX #define MALLOC ns_dyn_mem_alloc @@ -150,6 +158,50 @@ static int8_t find_interface_by_address(const uint8_t target_addr[16]) return -1; } +static int8_t nanostack_interface_id_parse(const char* interface_name) +{ + int8_t interface_id = -1; + + TRACE_DEEP("nanostack_interface_id_parse() %s", interface_name ? interface_name : "null"); + + if (!interface_name) { + return -1; + } + + // parse interface ID from the interface_name + if (strlen(interface_name) < 4) { + return -1; + } + + interface_id = atoi(&interface_name[3]); + if (interface_id < 0) { + return -1; + } + + TRACE_DEEP("parsed interfaceID = %d", interface_id); + return interface_id; +} + +static int8_t nanostack_dns_query_result_check(const char *domain_name, SocketAddress *address, const char *interface_name) +{ + uint8_t dns_query_addr[16] = {0}; + int8_t interface_id, ns_query_result; + + interface_id = nanostack_interface_id_parse(interface_name); + + ns_query_result = arm_net_dns_query_result_get(interface_id, dns_query_addr, (char*)domain_name); + + TRACE_DEEP("nanostack_dns_query_result_check(): interface_id=%d, ret=%d, resolved %s to %s", + interface_id, ns_query_result, domain_name, trace_ipv6(dns_query_addr)); + + if (ns_query_result == 0) { + address->set_ip_bytes(dns_query_addr, NSAPI_IPv6); + return 0; + } + + return -1; +} + void *NanostackSocket::operator new (std::size_t sz) { return MALLOC(sz); @@ -534,6 +586,74 @@ const char *Nanostack::get_ip_address() return "::"; } +nsapi_error_t Nanostack::gethostbyname(const char *name, SocketAddress *address, nsapi_version_t version, const char *interface_name) +{ + if (name[0] == '\0') { + return NSAPI_ERROR_PARAMETER; + } + // check for simple ip addresses + if (address->set_ip_address(name)) { + if (version != NSAPI_UNSPEC && address->get_ip_version() != version) { + return NSAPI_ERROR_DNS_FAILURE; + } + return NSAPI_ERROR_OK; + } + + // try nanostack DNS cache, if not found then fallback to dns query + if (nanostack_dns_query_result_check(name, address, interface_name) == 0) { + return 0; + } + + return nsapi_dns_query(this, name, address, interface_name, version); +} + +nsapi_value_or_error_t Nanostack::gethostbyname_async(const char *name, hostbyname_cb_t callback, nsapi_version_t version, const char *interface_name) +{ + SocketAddress address; + + if (name[0] == '\0') { + return NSAPI_ERROR_PARAMETER; + } + + // check for simple ip addresses + if (address.set_ip_address(name)) { + if (version != NSAPI_UNSPEC && address.get_ip_version() != version) { + return NSAPI_ERROR_DNS_FAILURE; + } + callback(NSAPI_ERROR_OK, &address); + return NSAPI_ERROR_OK; + } + + // try nanostack DNS cache, if not found then fallback to dns query + if (nanostack_dns_query_result_check(name, &address, interface_name) == 0) { + // hit found, return result immediately + callback(NSAPI_ERROR_OK, &address); + return NSAPI_ERROR_OK; + } + + call_in_callback_cb_t call_in_cb = get_call_in_callback(); + return nsapi_dns_query_async(this, name, callback, call_in_cb, interface_name, version); +} + +nsapi_error_t Nanostack::get_dns_server(int index, SocketAddress *address, const char *interface_name) +{ + uint8_t dns_srv_address[16]; + int8_t interface_id; + int8_t ret; + + interface_id = nanostack_interface_id_parse(interface_name); + + ret = arm_net_dns_server_get(interface_id, dns_srv_address, NULL, 0, index); + + if (ret == 0) { + address->set_ip_bytes(dns_srv_address, NSAPI_IPv6); + TRACE_DEEP("get_dns_server(), index=%d, ret=%d, address=%s", index, ret, trace_ipv6((uint8_t*)address->get_ip_bytes())); + return NSAPI_ERROR_OK; + } + + return NSAPI_ERROR_NO_ADDRESS; +} + nsapi_error_t Nanostack::socket_open(void **handle, nsapi_protocol_t protocol) { // Validate parameters diff --git a/features/nanostack/nanostack-interface/Nanostack.h b/features/nanostack/nanostack-interface/Nanostack.h index aea1fb0b68..a266233f74 100644 --- a/features/nanostack/nanostack-interface/Nanostack.h +++ b/features/nanostack/nanostack-interface/Nanostack.h @@ -63,6 +63,58 @@ protected: */ virtual const char *get_ip_address(); + /** Translate a hostname to an IP address with specific version using network interface name. + * + * The hostname may be either a domain name or an IP address. If the + * hostname is an IP address, no network transactions will be performed. + * + * Method first checks Nanostack DNS query result cache. If match is found, then the result is returned immediately. + * Otherwise method calls DNS resolver to find a match. + * + * @param host Hostname to resolve. + * @param address Pointer to a SocketAddress to store the result. + * @param version IP version of address to resolve, NSAPI_UNSPEC indicates + * version is chosen by the stack (defaults to NSAPI_UNSPEC). + * @param interface_name Network interface name + * @return NSAPI_ERROR_OK on success, negative error code on failure. + */ + virtual nsapi_error_t gethostbyname(const char *name, SocketAddress *address, nsapi_version_t version, const char *interface_name); + + /** Translate a hostname to an IP address (asynchronous) using network interface name. + * + * The hostname may be either a domain name or a dotted IP address. If the + * hostname is an IP address, no network transactions will be performed. + * + * Method first checks Nanostack DNS query result cache. If match is found, then the result is returned immediately. + * + * Call is non-blocking. Result of the DNS operation is returned by the callback. + * If this function returns failure, callback will not be called. In case result + * is success (IP address was found from DNS cache), callback will be called + * before function returns. + * + * @param host Hostname to resolve. + * @param callback Callback that is called for result. + * @param version IP version of address to resolve, NSAPI_UNSPEC indicates + * version is chosen by the stack (defaults to NSAPI_UNSPEC). + * @param interface_name Network interface name + * @return 0 on immediate success, + * negative error code on immediate failure or + * a positive unique id that represents the hostname translation operation + * and can be passed to cancel. + */ + virtual nsapi_value_or_error_t gethostbyname_async(const char *name, hostbyname_cb_t callback, nsapi_version_t version, const char *interface_name); + + /** Get a domain name server from a list of servers to query + * + * Returns a DNS server address for a index. DNS servers are queried from Nanostack DNS cache. + * If returns error no more DNS servers to read. + * + * @param index Index of the DNS server, starts from zero + * @param address Destination for the host address + * @return 0 on success, negative error code on failure + */ + virtual nsapi_error_t get_dns_server(int index, SocketAddress *address, const char *interface_name); + /** Opens a socket * * Creates a network socket and stores it in the specified handle. From 58136e93d8566d4eacc896533e3d406f64c256b1 Mon Sep 17 00:00:00 2001 From: Arto Kinnunen Date: Mon, 31 Aug 2020 10:53:48 +0300 Subject: [PATCH 2/6] Review corrections -Check address version NSAPI_UNSPEC -Disable traces -More specific interface ID parsing -Harmonize return values --- .../nanostack-interface/Nanostack.cpp | 27 +++++++++++++------ 1 file changed, 19 insertions(+), 8 deletions(-) diff --git a/features/nanostack/nanostack-interface/Nanostack.cpp b/features/nanostack/nanostack-interface/Nanostack.cpp index 32025f1d07..d1683eb53e 100644 --- a/features/nanostack/nanostack-interface/Nanostack.cpp +++ b/features/nanostack/nanostack-interface/Nanostack.cpp @@ -37,11 +37,11 @@ #include "ns_trace.h" #define TRACE_GROUP "nsif" -#define NSIF_DEEP_TRACE +//#define NSIF_DEEP_TRACE #ifdef NSIF_DEEP_TRACE #define TRACE_DEEP tr_debug #else -#define TRACE_DEP(...) +#define TRACE_DEEP(...) #endif #define NS_INTERFACE_SOCKETS_MAX 16 //same as NanoStack SOCKET_MAX @@ -160,6 +160,7 @@ static int8_t find_interface_by_address(const uint8_t target_addr[16]) static int8_t nanostack_interface_id_parse(const char* interface_name) { + int namelen; int8_t interface_id = -1; TRACE_DEEP("nanostack_interface_id_parse() %s", interface_name ? interface_name : "null"); @@ -169,20 +170,20 @@ static int8_t nanostack_interface_id_parse(const char* interface_name) } // parse interface ID from the interface_name - if (strlen(interface_name) < 4) { + namelen = strlen(interface_name); + if (namelen < 4 || namelen > 5) { return -1; } - interface_id = atoi(&interface_name[3]); - if (interface_id < 0) { - return -1; + if ((strncmp("MES", interface_name, 3) == 0) && isdigit(interface_name[3])) { + interface_id = atoi(&interface_name[3]); } TRACE_DEEP("parsed interfaceID = %d", interface_id); return interface_id; } -static int8_t nanostack_dns_query_result_check(const char *domain_name, SocketAddress *address, const char *interface_name) +static int nanostack_dns_query_result_check(const char *domain_name, SocketAddress *address, const char *interface_name) { uint8_t dns_query_addr[16] = {0}; int8_t interface_id, ns_query_result; @@ -599,9 +600,14 @@ nsapi_error_t Nanostack::gethostbyname(const char *name, SocketAddress *address, return NSAPI_ERROR_OK; } + // Nanostack is IPv6 stack + if (version == NSAPI_UNSPEC) { + version = NSAPI_IPv6; + } + // try nanostack DNS cache, if not found then fallback to dns query if (nanostack_dns_query_result_check(name, address, interface_name) == 0) { - return 0; + return NSAPI_ERROR_OK; } return nsapi_dns_query(this, name, address, interface_name, version); @@ -624,6 +630,11 @@ nsapi_value_or_error_t Nanostack::gethostbyname_async(const char *name, hostbyna return NSAPI_ERROR_OK; } + // Nanostack is IPv6 stack + if (version == NSAPI_UNSPEC) { + version = NSAPI_IPv6; + } + // try nanostack DNS cache, if not found then fallback to dns query if (nanostack_dns_query_result_check(name, &address, interface_name) == 0) { // hit found, return result immediately From 7b775632f1d67054ca7b27b7c185a11fe9d999ea Mon Sep 17 00:00:00 2001 From: Arto Kinnunen Date: Mon, 31 Aug 2020 11:52:01 +0300 Subject: [PATCH 3/6] Follow Mbed OS coding style --- features/nanostack/nanostack-interface/Nanostack.cpp | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/features/nanostack/nanostack-interface/Nanostack.cpp b/features/nanostack/nanostack-interface/Nanostack.cpp index d1683eb53e..a1962b82a6 100644 --- a/features/nanostack/nanostack-interface/Nanostack.cpp +++ b/features/nanostack/nanostack-interface/Nanostack.cpp @@ -158,7 +158,7 @@ static int8_t find_interface_by_address(const uint8_t target_addr[16]) return -1; } -static int8_t nanostack_interface_id_parse(const char* interface_name) +static int8_t nanostack_interface_id_parse(const char *interface_name) { int namelen; int8_t interface_id = -1; @@ -190,10 +190,10 @@ static int nanostack_dns_query_result_check(const char *domain_name, SocketAddre interface_id = nanostack_interface_id_parse(interface_name); - ns_query_result = arm_net_dns_query_result_get(interface_id, dns_query_addr, (char*)domain_name); + ns_query_result = arm_net_dns_query_result_get(interface_id, dns_query_addr, (char *)domain_name); TRACE_DEEP("nanostack_dns_query_result_check(): interface_id=%d, ret=%d, resolved %s to %s", - interface_id, ns_query_result, domain_name, trace_ipv6(dns_query_addr)); + interface_id, ns_query_result, domain_name, trace_ipv6(dns_query_addr)); if (ns_query_result == 0) { address->set_ip_bytes(dns_query_addr, NSAPI_IPv6); @@ -658,7 +658,7 @@ nsapi_error_t Nanostack::get_dns_server(int index, SocketAddress *address, const if (ret == 0) { address->set_ip_bytes(dns_srv_address, NSAPI_IPv6); - TRACE_DEEP("get_dns_server(), index=%d, ret=%d, address=%s", index, ret, trace_ipv6((uint8_t*)address->get_ip_bytes())); + TRACE_DEEP("get_dns_server(), index=%d, ret=%d, address=%s", index, ret, trace_ipv6((uint8_t *)address->get_ip_bytes())); return NSAPI_ERROR_OK; } From 207250fe840acdbba999b5c52bf11af4dc95d006 Mon Sep 17 00:00:00 2001 From: Arto Kinnunen Date: Mon, 31 Aug 2020 14:36:33 +0300 Subject: [PATCH 4/6] Update WisunBorderRouter class Add set_dns_query_result to WisunBorderRouter. --- .../mbed-mesh-api/WisunBorderRouter.h | 13 +++++++++++++ .../mbed-mesh-api/source/WisunBorderRouter.cpp | 17 +++++++++++++++++ 2 files changed, 30 insertions(+) diff --git a/features/nanostack/mbed-mesh-api/mbed-mesh-api/WisunBorderRouter.h b/features/nanostack/mbed-mesh-api/mbed-mesh-api/WisunBorderRouter.h index eca0c3050e..db2fc7b068 100644 --- a/features/nanostack/mbed-mesh-api/mbed-mesh-api/WisunBorderRouter.h +++ b/features/nanostack/mbed-mesh-api/mbed-mesh-api/WisunBorderRouter.h @@ -260,6 +260,19 @@ public: * */ mesh_error_t get_radius_shared_secret(uint16_t *shared_secret_len, uint8_t *shared_secret); + /** + * \brief Set DNS query result to Nanostack cache. + * + * Function sets DNS query result to Nanostack cache to get distributed to the devices in the Wi-SUN network. + * Function must be called for a running Wi-SUN Border Router instance. + * + * \param address resolved address of domain_name. + * \param domain_name name of the domain. Must be non-NULL. + * \return MESH_ERROR_NONE on success. + * \return error value in case of failure. + * */ + mesh_error_t set_dns_query_result(SocketAddress *address, char *domain_name); + private: mesh_error_t configure(); mesh_error_t apply_configuration(int8_t mesh_if_id); diff --git a/features/nanostack/mbed-mesh-api/source/WisunBorderRouter.cpp b/features/nanostack/mbed-mesh-api/source/WisunBorderRouter.cpp index a681b8109a..7b2309dec7 100644 --- a/features/nanostack/mbed-mesh-api/source/WisunBorderRouter.cpp +++ b/features/nanostack/mbed-mesh-api/source/WisunBorderRouter.cpp @@ -324,3 +324,20 @@ mesh_error_t WisunBorderRouter::get_radius_shared_secret(uint16_t *shared_secret return MESH_ERROR_NONE; } + +mesh_error_t WisunBorderRouter::set_dns_query_result(SocketAddress *address, char *domain_name) +{ + if (!domain_name || !address) { + return MESH_ERROR_PARAM; + } + + if (_mesh_if_id < 0) { + return MESH_ERROR_STATE; + } + + if (ws_bbr_dns_query_result_set(_mesh_if_id, (const uint8_t *)address->get_ip_bytes(), domain_name) >= 0 ) { + return MESH_ERROR_NONE; + } + + return MESH_ERROR_UNKNOWN; +} From 22c3c35996b09eb0f680ebf98a5a00d8f039f7c2 Mon Sep 17 00:00:00 2001 From: Arto Kinnunen Date: Mon, 31 Aug 2020 16:36:13 +0300 Subject: [PATCH 5/6] Follow Mbed OS coding style --- features/nanostack/mbed-mesh-api/source/WisunBorderRouter.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/features/nanostack/mbed-mesh-api/source/WisunBorderRouter.cpp b/features/nanostack/mbed-mesh-api/source/WisunBorderRouter.cpp index 7b2309dec7..b8392af66f 100644 --- a/features/nanostack/mbed-mesh-api/source/WisunBorderRouter.cpp +++ b/features/nanostack/mbed-mesh-api/source/WisunBorderRouter.cpp @@ -335,7 +335,7 @@ mesh_error_t WisunBorderRouter::set_dns_query_result(SocketAddress *address, cha return MESH_ERROR_STATE; } - if (ws_bbr_dns_query_result_set(_mesh_if_id, (const uint8_t *)address->get_ip_bytes(), domain_name) >= 0 ) { + if (ws_bbr_dns_query_result_set(_mesh_if_id, (const uint8_t *)address->get_ip_bytes(), domain_name) >= 0) { return MESH_ERROR_NONE; } From 69720f10686538f22e9090eef442894e894b42ac Mon Sep 17 00:00:00 2001 From: Arto Kinnunen Date: Wed, 2 Sep 2020 15:15:45 +0300 Subject: [PATCH 6/6] Use macro for isdigit --- features/nanostack/nanostack-interface/Nanostack.cpp | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/features/nanostack/nanostack-interface/Nanostack.cpp b/features/nanostack/nanostack-interface/Nanostack.cpp index a1962b82a6..83899b6dbe 100644 --- a/features/nanostack/nanostack-interface/Nanostack.cpp +++ b/features/nanostack/nanostack-interface/Nanostack.cpp @@ -44,6 +44,8 @@ #define TRACE_DEEP(...) #endif +#define NANOSTACK_ISDIGIT(c) ((c) >= '0' && (c) <= '9') + #define NS_INTERFACE_SOCKETS_MAX 16 //same as NanoStack SOCKET_MAX #define MALLOC ns_dyn_mem_alloc @@ -175,7 +177,7 @@ static int8_t nanostack_interface_id_parse(const char *interface_name) return -1; } - if ((strncmp("MES", interface_name, 3) == 0) && isdigit(interface_name[3])) { + if ((strncmp("MES", interface_name, 3) == 0) && NANOSTACK_ISDIGIT(interface_name[3])) { interface_id = atoi(&interface_name[3]); }