Add support for anonymous addressing in Wi-SUN border router (ARMmbed#2565)

DHCPv6 server can now assign addresses anonymously.

Added support for New API to allow Anonymous addressing in border router
Simplified the DHCPv6 server to assign Ids in sequence
Simplified DHCPv6 library to use only one structure for address

Fixed parameter names
Fixed function names
Added correct comments to function descriptions

Author: Mika Tervonen

CHANGELOG.md

@@ -5,7 +5,7 @@
 ## Release vXX.X.X
 
 ### Features
-* 
+* Added support for Anonymous address generation in DHCPv6 server for Wi-SUN Border router
 
 ### Changes
 * Added throttling of number of simultaneous EAPOL authentications based on Border Router TX queue size

nanostack/ws_bbr_api.h

@@ -99,6 +99,7 @@ int ws_bbr_start(int8_t interface_id, int8_t backbone_interface_id);
 #define BBR_REQUIRE_DAO_REFRESH   0x0000 /**< Deprecated DAO Refresh is now the default functionality*/
 #define BBR_PERIODIC_VERSION_INC  0x0010 /**< Increment PAN version number Periodically*/
 #define BBR_GUA_SLAAC             0x0020 /**< in Global prefix use SLAAC address generation to reduce traffic during bootstrap */
+#define BBR_DHCP_ANONYMOUS        0x0040 /**< Generate anonymous addresses from DHCP server */
 
 /**
  * Configure border router features.
@@ -108,6 +109,9 @@ int ws_bbr_start(int8_t interface_id, int8_t backbone_interface_id);
  *          BBR_ULA_C     Configure Mesh local ULA prefix with SLAAC address
  *          BBR_GUA_ROUTE Add more specific route for GUA
  *          BBR_BB_WAIT   Start Wi-SUN network only when backbone is ready
+ *          BBR_DHCP_ANONYMOUS if true give anonymous address (16 bit suffix) to
+ *                             optimize data in RF interface (saves 12 bytes per hop)
+ *                             or false to reduce RAM usage in Border router as assigned address list is not needed (40 bytes per device).
  *
  * By default Wi-SUN network is started and is treated as separate interface even if backbone is not available.
  *

source/6LoWPAN/Thread/thread_management_if.c

@@ -699,7 +699,7 @@ int thread_dhcpv6_server_set_anonymous_addressing(int8_t interface_id, uint8_t *
         return -1;
     }
 
-    return DHCPv6_server_service_set_address_autonous_flag(interface_id, prefix_ptr, anonymous, false);
+    return DHCPv6_server_service_set_address_generation_anonymous(interface_id, prefix_ptr, anonymous, false);
 #else
     (void) interface_id;
     (void) prefix_ptr;

source/6LoWPAN/ws/ws_bbr_api.c

@@ -523,8 +523,10 @@ static void ws_bbr_dhcp_server_start(protocol_interface_info_entry_t *cur, uint8
         return;
     }
     DHCPv6_server_service_callback_set(cur->id, global_id, NULL, wisun_dhcp_address_add_cb);
-    //Enable SLAAC mode to border router
-    DHCPv6_server_service_set_address_autonous_flag(cur->id, global_id, true, false);
+    //Check for anonymous mode
+    bool anonymous = (configuration & BBR_DHCP_ANONYMOUS) ? true : false;
+
+    DHCPv6_server_service_set_address_generation_anonymous(cur->id, global_id, anonymous, false);
     DHCPv6_server_service_set_address_validlifetime(cur->id, global_id, dhcp_address_lifetime);
     //SEt max value for not limiting address allocation
     DHCPv6_server_service_set_max_clients_accepts_count(cur->id, global_id, MAX_SUPPORTED_ADDRESS_LIST_SIZE);
@@ -533,6 +535,7 @@ static void ws_bbr_dhcp_server_start(protocol_interface_info_entry_t *cur, uint8
 
     ws_dhcp_client_address_request(cur, global_id, ll);
 }
+
 static void ws_bbr_dhcp_server_stop(protocol_interface_info_entry_t *cur, uint8_t *global_id)
 {
     if (!cur) {

source/DHCPv6_Server/DHCPv6_Server_service.c

@@ -93,7 +93,7 @@ int DHCPv6_server_respond_client(dhcpv6_gua_server_entry_s *serverBase, dhcpv6_r
     //Validate Client DUID
     dhcp_link_options_params_t clientDUID;
     if (libdhcpv6_get_link_address_from_duid(replyPacket->clientDUID.duid, replyPacket->clientDUID.duid_length, replyPacket->clientDUID.type, &clientDUID) == 0) {
-        dhcp_allocated_address = libdhcpv6_address_allocated_list_scan(serverBase, clientDUID.link_id, clientDUID.link_type, dhcp_ia_non_temporal_params->iaId, dhcp_ia_non_temporal_params->T0, dhcp_ia_non_temporal_params->T1, allocateNew);
+        dhcp_allocated_address = libdhcpv6_address_allocate(serverBase, clientDUID.link_id, clientDUID.link_type, dhcp_ia_non_temporal_params->iaId, dhcp_ia_non_temporal_params->T0, dhcp_ia_non_temporal_params->T1, allocateNew);
     }
     if (dhcp_allocated_address) {
         address_allocated = true;
@@ -109,7 +109,7 @@ int DHCPv6_server_respond_client(dhcpv6_gua_server_entry_s *serverBase, dhcpv6_r
 
             if (!serverBase->addCb(serverBase->interfaceId, &update_info, serverBase->guaPrefix)) {
                 address_allocated = false;
-                libdhcpv6_address_rm_from_allocated_list(serverBase, dhcp_allocated_address->nonTemporalAddress);
+                libdhcpv6_address_delete(serverBase, dhcp_allocated_address->nonTemporalAddress);
             }
         }
     }
@@ -299,9 +299,9 @@ void DHCPv6_server_service_delete(int8_t interface, uint8_t guaPrefix[static 8],
         ns_list_foreach_safe(dhcpv6_allocated_address_entry_t, cur, &serverInfo->allocatedAddressList) {
             //Delete Server data base
             if (serverInfo->removeCb) {
-                uint8_t allocated_address[16];
-                libdhcpv6_allocated_address_write(allocated_address, cur, serverInfo);
-                serverInfo->removeCb(interface, allocated_address, NULL);
+                uint8_t ipAddress[16];
+                libdhcpv6_allocated_address_write(ipAddress, cur, serverInfo);
+                serverInfo->removeCb(interface, ipAddress, NULL);
             }
         }
 
@@ -327,25 +327,33 @@ void DHCPv6_server_service_delete(int8_t interface, uint8_t guaPrefix[static 8],
 
 /* Control GUA address for client by DUI.Default value is true
  *
+ * Anonymous and disable address list can optimize either
+ * Using 16 bit suffix to optimize data amount in network
+ * and having list of assigned addresses meaning larger RAM usage at border router
+ *
+ * or Using SLAAC type address generation and not have a list of addresses at Border router
+ * -> Less RAM usage, but more bandwidth used
  *
  *  /param interface interface id of this thread instance.
  *  /param guaPrefix Prefix which will be removed
- *  /param mode true trig autonous mode, false define address by default suffics + client id
+ *  /param mode true assign addresses anonymously. false define address by Prefix + client id
+ *  /param disable_address_list Dont keep track of assigned Addresses (Can't be used if anonymous)
  */
-int DHCPv6_server_service_set_address_autonous_flag(int8_t interface, uint8_t guaPrefix[static 16], bool mode, bool autonomous_skip_list)
+int DHCPv6_server_service_set_address_generation_anonymous(int8_t interface, uint8_t guaPrefix[static 16], bool mode, bool disable_address_list)
 {
     dhcpv6_gua_server_entry_s *serverInfo = libdhcpv6_server_data_get_by_prefix_and_interfaceid(interface, guaPrefix);
     if (!serverInfo) {
         return -1;
 
     }
 
-    serverInfo->enableAddressAutonous = mode;
+    serverInfo->anonymousAddress = mode;
     if (mode) {
-        serverInfo->disableAddressListAllocation = autonomous_skip_list;
+        serverInfo->disableAddressList = disable_address_list;
     } else {
-        serverInfo->disableAddressListAllocation = false;
+        serverInfo->disableAddressList = false;
     }
+    tr_info("DHCPv6 %s, address list %s", mode ? "anonymous address" : "address mode SLAAC", disable_address_list ? "Not Stored" : "Stored");
 
     return 0;
 }
@@ -375,6 +383,7 @@ int DHCPv6_server_service_duid_update(int8_t interface, uint8_t guaPrefix[static
     if (!serverInfo) {
         return -1;
     }
+    tr_info("DHCPv6 duid %s", trace_array(duid_ptr, duid_length));
 
     return libdhcpv6_server_duid_set(serverInfo, duid_ptr, duid_type, duid_length);
 }
@@ -399,6 +408,7 @@ int DHCPv6_server_service_set_max_clients_accepts_count(int8_t interface, uint8_
     }
 
     serverInfo->maxSupportedClients = maxClientCount;
+    tr_info("DHCPv6 maximum clients %"PRIu32, serverInfo->maxSupportedClients);
 
     return 0;
 }
@@ -421,6 +431,7 @@ int DHCPv6_server_service_set_address_validlifetime(int8_t interface, uint8_t gu
         return -1;
     }
     serverInfo->validLifetime = validLifeTimne;
+    tr_info("DHCPv6 Valid lifetime %"PRIu32, serverInfo->validLifetime);
 
     return 0;
 }
@@ -510,7 +521,7 @@ void DHCPv6_server_service_timeout_cb(uint32_t timeUpdateInSeconds)
 {
     (void) timeUpdateInSeconds;
 }
-int DHCPv6_server_service_set_address_autonous_flag(int8_t interface, uint8_t guaPrefix[static 16], bool mode, bool autonomous_skip_list)
+int DHCPv6_server_service_set_address_generation_anonymous(int8_t interface, uint8_t guaPrefix[static 16], bool mode, bool autonomous_skip_list)
 {
     (void) interface;
     (void) guaPrefix;

source/DHCPv6_Server/DHCPv6_server_service.h

@@ -62,13 +62,19 @@ void DHCPv6_server_service_timeout_cb(uint32_t timeUpdateInSeconds);
 
 /* Control GUA address for client by DUI.Default value is true
  *
+ * Anonymous and disable address list can optimize either
+ * Using 16 bit suffix to optimize data amount in network
+ * and having list of assigned addresses meaning larger RAM usage at border router
+ *
+ * or Using SLAAC type address generation and not have a list of addresses at Border router
+ * -> Less RAM usage, but more bandwidth used
  *
  *  /param interface interface id of this thread instance.
  *  /param guaPrefix Prefix which will be removed
- *  /param mode true trig autonous mode, false define address by default suffics + client id
- *  /param autonomous_skip_list true skip address list allocation when autonous mode is selected
+ *  /param mode true assign addresses anonymously. false define address by Prefix + client id
+ *  /param disable_address_list Dont keep track of assigned Addresses (Can't be used if anonymous)
  */
-int DHCPv6_server_service_set_address_autonous_flag(int8_t interface, uint8_t guaPrefix[static 16], bool mode, bool autonomous_skip_list);
+int DHCPv6_server_service_set_address_generation_anonymous(int8_t interface, uint8_t guaPrefix[static 16], bool mode, bool autonomous_skip_list);
 
 
 /* SET max accepted clients to server, Default is 200