Thread BR network data clearing (ARMmbed#1518)

When Thread BR upgrades from REED to Router is must include REED RLOC
to a/sd coap message so that network leader is able to delete REED
network data.

The REED RLOC was missing when publish attempt was made when previous
publish was still active.

Author: Arto Kinnunen

source/6LoWPAN/Thread/thread_bootstrap.c

@@ -1159,7 +1159,7 @@ void thread_tasklet(arm_event_s *event)
             thread_router_bootstrap_active_router_attach(cur);
             thread_bootstrap_child_id_request(cur);
             if (thread_nd_own_service_list_data_size(&cur->thread_info->localServerDataBase)) {
-                // We publish our services if we have some BUG leader cannot remove old ones
+                // publish our services to allow leader to remove old ones
                 thread_border_router_publish(cur->id);
             }
             thread_router_bootstrap_address_change_notify_send(cur);
@@ -1177,7 +1177,7 @@ void thread_tasklet(arm_event_s *event)
         case THREAD_ATTACH_ROUTER_ID_RELEASED:
             tr_debug_extra("Thread SM THREAD_ATTACH_ROUTER_ID_RELEASED");
             if (thread_nd_own_service_list_data_size(&cur->thread_info->localServerDataBase)) {
-                // We publish our services if we have some BUG leader cannot remove old ones
+                // publish our services to allow leader to remove old ones
                 thread_border_router_publish(cur->id);
             }
             break;

source/6LoWPAN/Thread/thread_border_router_api.c

@@ -82,6 +82,7 @@ typedef struct {
 /* Neighbor discovery options according to RFC6106 (rfc4861) */
 #define RFC6106_RECURSIVE_DNS_SERVER_OPTION     25
 #define RFC6106_DNS_SEARCH_LIST_OPTION          31
+
 static NS_LIST_DEFINE(border_router_instance_list, thread_border_router_t, link);
 
 
@@ -457,6 +458,7 @@ void thread_border_router_delete(int8_t interface_id)
     ns_dyn_mem_free(this->recursive_dns_server_option);
     ns_dyn_mem_free(this);
 }
+
 void thread_border_router_seconds_timer(int8_t interface_id, uint32_t seconds)
 {
     thread_border_router_t *this = thread_border_router_find_by_interface(interface_id);
@@ -783,17 +785,19 @@ static void thread_tmf_client_network_data_set_cb(int8_t interface_id, int8_t st
     if (!cur) {
         return;
     }
-    // Save the old address
-    cur->thread_info->localServerDataBase.registered_rloc16 = mac_helper_mac16_address_get(cur);
-    cur->thread_info->localServerDataBase.release_old_address = false;
+
     cur->thread_info->localServerDataBase.publish_active = false;
 
-    tr_debug("border router status %s, addr: %x",status?"Fail":"Ok", cur->thread_info->localServerDataBase.registered_rloc16);
+    tr_debug("BR a/sd response status: %s, addr: %x",status?"Fail":"OK", cur->thread_info->localServerDataBase.registered_rloc16);
 
     if (cur->thread_info->localServerDataBase.publish_pending) {
         cur->thread_info->localServerDataBase.publish_pending = false;
         thread_border_router_publish(cur->id);
     }
+
+    // always update RLOC to new one. If COAP response fails then resubmit timer will trigger new a/sd
+    cur->thread_info->localServerDataBase.registered_rloc16 = mac_helper_mac16_address_get(cur);
+    cur->thread_info->localServerDataBase.release_old_address = false;
 }
 #endif
 
@@ -817,6 +821,9 @@ int thread_border_router_publish(int8_t interface_id)
         return -2;
     }
 
+    rloc16 = mac_helper_mac16_address_get(cur);
+    tr_debug("Border router old: %x, new: %x", cur->thread_info->localServerDataBase.registered_rloc16, rloc16);
+
     if (cur->thread_info->localServerDataBase.publish_active) {
         cur->thread_info->localServerDataBase.publish_pending = true;
         tr_debug("Activate pending status for publish");
@@ -831,20 +838,18 @@ int thread_border_router_publish(int8_t interface_id)
     if (!ptr) {
         return -3;
     }
-    rloc16 = mac_helper_mac16_address_get(cur);
 
     ptr = thread_tmfcop_tlv_data_write_header(ptr, TMFCOP_TLV_NETWORK_DATA, network_data_len);
     ptr = thread_nd_own_service_list_data_write(&cur->thread_info->localServerDataBase, ptr, rloc16);
 
-    tr_debug("Border router old: %x, new: %x", cur->thread_info->localServerDataBase.registered_rloc16, rloc16);
-
     if (cur->thread_info->localServerDataBase.registered_rloc16 != 0xffff &&
             cur->thread_info->localServerDataBase.release_old_address &&
             cur->thread_info->localServerDataBase.registered_rloc16 != rloc16) {
         // Our address has changed so we must register our network with new address and remove the old address
-        tr_debug("Border router Address changed remove old");
+        tr_debug("BR address changed - remove old %x", cur->thread_info->localServerDataBase.registered_rloc16);
         ptr = thread_tmfcop_tlv_data_write_uint16(ptr,TMFCOP_TLV_RLOC16,cur->thread_info->localServerDataBase.registered_rloc16);
     }
+
     cur->thread_info->localServerDataBase.registered_rloc16 = rloc16;
     ret_val = thread_management_client_network_data_register(cur->id, payload_ptr, ptr - payload_ptr, thread_tmf_client_network_data_set_cb);
     if (payload_ptr) {

source/6LoWPAN/Thread/thread_leader_service.c

@@ -1122,7 +1122,7 @@ static int thread_leader_service_petition_ka_cb(int8_t service_id, uint8_t sourc
 
 static int thread_leader_service_network_data_register(protocol_interface_info_entry_t *cur, uint8_t *network_data_ptr, uint16_t network_data_length, uint16_t routerId)
 {
-    tr_debug("thread leader Register request");
+    tr_debug("Register network data for %x", routerId);
     // Mark all data to be cleared
     thread_network_data_router_id_mark_delete(&cur->thread_info->networkDataStorage, routerId, true);
 
@@ -1176,8 +1176,8 @@ static int thread_leader_service_register_cb(int8_t service_id, uint8_t source_a
 
     if (2 <= thread_tmfcop_tlv_data_get_uint16(payload_ptr, payload_len, TMFCOP_TLV_RLOC16, &old_rloc)) {
         // This will delete everything from old rloc
+        tr_warn("Remove network data from: %x", old_rloc);
         ret = thread_leader_service_network_data_register(cur, NULL, 0, old_rloc);
-        tr_warn("Removed network data from: %x", old_rloc);
     }
 
     if (!thread_tmfcop_tlv_exist(payload_ptr, payload_len, TMFCOP_TLV_NETWORK_DATA)) {

source/6LoWPAN/Thread/thread_management_client.c

@@ -614,8 +614,9 @@ void thread_management_client_pending_coap_request_kill(int8_t interface_id)
         return;
     }
 
+    cur->thread_info->localServerDataBase.publish_active = false;
+
     if (this->coap_asd_msg_id != 0) {
-        cur->thread_info->localServerDataBase.publish_active = false;
         coap_service_request_delete(this->coap_service_id, this->coap_asd_msg_id);
         this->coap_asd_msg_id = 0;
     }

source/6LoWPAN/Thread/thread_network_data_storage.h

@@ -185,8 +185,8 @@ typedef struct thread_network_local_data_cache_entry_s {
     thread_network_data_service_list_t service_list;
     uint16_t registered_rloc16;/*!< Address used for latest registration */
     bool release_old_address:1;/*!< true if release of old address is needed */
-    bool publish_active:1;
-    bool publish_pending:1;
+    bool publish_active:1;/*!< true when publish is active */
+    bool publish_pending:1;/*!< true when publish attempt made during active publish */
 } thread_network_local_data_cache_entry_t;
 
 /**