Thread device learns weighting from advertisement (ARMmbed#1696)

- Save weighting value from received advertisement.
- Check weighting value together with partition id
- Update network data version saving

Author: Arto Kinnunen

source/6LoWPAN/Thread/thread_bootstrap.c

@@ -245,45 +245,31 @@ bool thread_check_is_this_my_parent(protocol_interface_info_entry_t *cur, mle_ne
 bool thread_bootstrap_request_network_data(protocol_interface_info_entry_t *cur, thread_leader_data_t *leaderData, uint16_t short_address)
 {
     bool requestNetworkdata = false;
-    thread_leader_data_t *leadeInfo = thread_info(cur)->thread_leader_data;
+    thread_leader_data_t *leaderInfo = thread_info(cur)->thread_leader_data;
 
     if (thread_info(cur)->thread_endnode_parent->shortAddress != short_address) {
         return false;
     }
 
-    if (thread_info(cur)->thread_leader_data->partitionId != leaderData->partitionId) {
+    if (!thread_partition_match(cur, leaderData)) {
         tr_debug("Learn new Network Data");
         requestNetworkdata = true;
-        thread_info(cur)->thread_leader_data->dataVersion = leaderData->dataVersion - 1;
-        thread_info(cur)->thread_leader_data->stableDataVersion = leaderData->stableDataVersion - 1;
+        thread_partition_info_update(cur, leaderData);
     }
-    else if (common_serial_number_greater_8(leaderData->dataVersion, leadeInfo->dataVersion)) {
+    else if (common_serial_number_greater_8(leaderData->dataVersion, leaderInfo->dataVersion)) {
         requestNetworkdata = true;
 
-    } else if (common_serial_number_greater_8(leaderData->stableDataVersion, leadeInfo->stableDataVersion)) {
+    } else if (common_serial_number_greater_8(leaderData->stableDataVersion, leaderInfo->stableDataVersion)) {
         requestNetworkdata = true;
 
     }
 
-    // Version number is updated when new network data is learned to avoid synchronization problems
-    thread_info(cur)->thread_leader_data->leaderRouterId = leaderData->leaderRouterId;
-    thread_info(cur)->thread_leader_data->partitionId = leaderData->partitionId;
     if (requestNetworkdata) {
         thread_bootstrap_parent_network_data_request(cur, true);
     }
     return true;
 }
 
-bool thread_instance_id_matches(protocol_interface_info_entry_t *cur, thread_leader_data_t *leaderData)
-{
-    if (thread_info(cur)->thread_leader_data) {
-        if (thread_info(cur)->thread_leader_data->partitionId == leaderData->partitionId) {
-            return true;
-        }
-    }
-    return false;
-}
-
 static int thread_router_check_previous_partition_info(protocol_interface_info_entry_t *cur, thread_leader_data_t *leaderData, mle_tlv_info_t *routeTlv)
 {
     if (!routeTlv || !routeTlv->dataPtr || !routeTlv->tlvLen || !leaderData) {
@@ -386,8 +372,7 @@ int thread_leader_data_validation(protocol_interface_info_entry_t *cur, thread_l
     if (!thread_info(cur)->thread_leader_data) {
         return -1;
     }
-    if ((thread_info(cur)->thread_leader_data->partitionId != leaderData->partitionId) ||
-        (thread_info(cur)->thread_leader_data->weighting != leaderData->weighting)) {
+    if (!thread_partition_match(cur, leaderData)) {
         uint8_t routers_in_route_tlv = thread_get_router_count_from_route_tlv(routeTlv);
         //partition checks
         return thread_bootstrap_partition_process(cur,routers_in_route_tlv,leaderData, routeTlv);

source/6LoWPAN/Thread/thread_bootstrap.h

@@ -126,7 +126,6 @@ int thread_parent_discover_start(int8_t interface_id, uint8_t *mac64 );
 
 bool thread_device_synch_timeout(int8_t interface_id, uint16_t msgId, bool usedAllRetries);
 bool thread_link_request_timeout(int8_t interface_id, uint16_t msgId, bool usedAllRetries);
-bool thread_instance_id_matches(struct protocol_interface_info_entry *cur, struct thread_leader_data_s *leaderData);
 int thread_leader_data_validation(struct protocol_interface_info_entry *cur, struct thread_leader_data_s *leaderData, struct mle_tlv_info_s *routeTlv);
 uint8_t thread_calculate_link_margin(int8_t dbm, uint8_t compLinkMarginFromParent);
 uint8_t thread_compute_link_margin(int8_t rssi);

source/6LoWPAN/Thread/thread_common.c

@@ -1922,7 +1922,7 @@ void thread_mcast_group_change(struct protocol_interface_info_entry *interface,
     }
 }
 
-void thread_old_partition_data_purge(protocol_interface_info_entry_t *cur)
+void thread_partition_data_purge(protocol_interface_info_entry_t *cur)
 {
     /* Partition has been changed. Wipe out data related to old partition */
     thread_management_client_pending_coap_request_kill(cur->id);
@@ -1935,5 +1935,28 @@ void thread_old_partition_data_purge(protocol_interface_info_entry_t *cur)
 
 }
 
+bool thread_partition_match(protocol_interface_info_entry_t *cur, thread_leader_data_t *leaderData)
+{
+    if (thread_info(cur)->thread_leader_data) {
+        if ((thread_info(cur)->thread_leader_data->partitionId == leaderData->partitionId) &&
+            (thread_info(cur)->thread_leader_data->weighting == leaderData->weighting)) {
+            return true;
+        }
+    }
+    return false;
+}
+
+void thread_partition_info_update(protocol_interface_info_entry_t *cur, thread_leader_data_t *leaderData)
+{
+    /* Force network data update later when processing network data TLV */
+    thread_info(cur)->thread_leader_data->dataVersion = leaderData->dataVersion - 1;
+    thread_info(cur)->thread_leader_data->stableDataVersion = leaderData->stableDataVersion - 1;
+    thread_info(cur)->thread_leader_data->leaderRouterId = leaderData->leaderRouterId;
+    thread_info(cur)->thread_leader_data->partitionId = leaderData->partitionId;
+    thread_info(cur)->thread_leader_data->weighting = leaderData->weighting;
+    /* New network data learned, get rid of old partition data */
+    thread_partition_data_purge(cur);
+}
+
 #endif
 

source/6LoWPAN/Thread/thread_common.h

@@ -416,7 +416,9 @@ uint8_t thread_pending_timestamp_tlv_size(protocol_interface_info_entry_t *cur);
 void thread_calculate_key_guard_timer(protocol_interface_info_entry_t *cur, link_configuration_s *linkConfiguration, bool is_init);
 void thread_set_link_local_address(protocol_interface_info_entry_t *cur);
 void thread_mcast_group_change(struct protocol_interface_info_entry *interface, struct if_group_entry *group, bool group_added);
-void thread_old_partition_data_purge(protocol_interface_info_entry_t *cur);
+void thread_partition_data_purge(protocol_interface_info_entry_t *cur);
+bool thread_partition_match(protocol_interface_info_entry_t *cur, thread_leader_data_t *leaderData);
+void thread_partition_info_update(protocol_interface_info_entry_t *cur, thread_leader_data_t *leaderData);
 
 #else // HAVE_THREAD
 

source/6LoWPAN/Thread/thread_host_bootstrap.c

@@ -122,7 +122,7 @@ static void thread_merge_prepare(protocol_interface_info_entry_t *cur)
     thread_clean_old_16_bit_address_based_addresses(cur);
     mpl_clear_realm_scope_seeds(cur);
     ipv6_route_table_remove_info(cur->id, ROUTE_THREAD_PROXIED_HOST, NULL);
-    thread_old_partition_data_purge(cur);
+    thread_partition_data_purge(cur);
     thread_network_data_clean(cur);
     cur->nwk_mode = ARM_NWK_GP_IP_MODE;
 }
@@ -538,8 +538,7 @@ void thread_mle_parent_discover_receive_cb(int8_t interface_id, mle_message_t *m
             if (thread_info(cur)->thread_attached_state == THREAD_STATE_REATTACH || thread_info(cur)->thread_attached_state == THREAD_STATE_REATTACH_RETRY) {
                 tr_debug("Reattach");
                 if (thread_info(cur)->thread_leader_data) {
-                    if ((thread_info(cur)->thread_leader_data->partitionId != leaderData.partitionId) ||
-                        (thread_info(cur)->thread_leader_data->weighting != leaderData.weighting)) {
+                    if (!thread_partition_match(cur, &leaderData)) {
                         //accept only same ID at reattach phase
                         return;
                     }
@@ -557,8 +556,7 @@ void thread_mle_parent_discover_receive_cb(int8_t interface_id, mle_message_t *m
                     thread_info(cur)->thread_attached_state == THREAD_STATE_CONNECTED ||
                     thread_info(cur)->thread_attached_state == THREAD_STATE_CONNECTED_ROUTER) {
                 if (thread_info(cur)->thread_leader_data) {
-                    if ((thread_info(cur)->thread_leader_data->partitionId == leaderData.partitionId) &&
-                        (thread_info(cur)->thread_leader_data->weighting == leaderData.weighting)) {
+                    if (thread_partition_match(cur, &leaderData)) {
                         //accept only different ID at anyattach phase
                         tr_debug("Drop old partition");
                         return;
@@ -1017,7 +1015,8 @@ static bool thread_child_id_req_timeout(int8_t interface_id, uint16_t msgId, boo
     tr_debug("Back to old partition");
 
     /* If scanned parent is from other partition, delete from MLE table */
-    if (scanned_parent->leader_data.partitionId != thread_info(cur)->thread_leader_data->partitionId) {
+    if ((scanned_parent->leader_data.partitionId != thread_info(cur)->thread_leader_data->partitionId) ||
+        (scanned_parent->leader_data.weighting != thread_info(cur)->thread_leader_data->weighting)) {
         memcpy(ll64, ADDR_LINK_LOCAL_PREFIX , 8);
         memcpy(&ll64[8], scanned_parent->mac64 , 8);
         ll64[8] ^= 2;

source/6LoWPAN/Thread/thread_leader_service.c

@@ -1346,7 +1346,7 @@ static void thread_leader_service_interface_setup_activate(protocol_interface_in
     thread_leader_service_private_routemask_init(private);
     //SET Router ID
     thread_leader_allocate_router_id_by_allocated_id(private, routerId, cur->mac);
-    thread_old_partition_data_purge(cur);
+    thread_partition_data_purge(cur);
     // remove any existing rloc mapping in nvm
     thread_nvm_store_mleid_rloc_map_remove();
     cur->lowpan_address_mode = NET_6LOWPAN_GP16_ADDRESS;

source/6LoWPAN/Thread/thread_mle_message_handler.c

@@ -159,16 +159,11 @@ static void thread_save_leader_data(protocol_interface_info_entry_t *cur, thread
             requestNetworkdata = true;
         }
 
-        if (thread_info(cur)->thread_leader_data->partitionId != leaderData->partitionId) {
+        if (!thread_partition_match(cur, leaderData)) {
             requestNetworkdata = true;
-            thread_info(cur)->thread_leader_data->stableDataVersion = leaderData->stableDataVersion - 1;
-            thread_info(cur)->thread_leader_data->dataVersion = leaderData->dataVersion - 1;
+            thread_partition_info_update(cur, leaderData);
         }
 
-        thread_info(cur)->thread_leader_data->partitionId = leaderData->partitionId;
-        thread_info(cur)->thread_leader_data->leaderRouterId = leaderData->leaderRouterId;
-        thread_info(cur)->thread_leader_data->weighting = leaderData->weighting;
-
         if (requestNetworkdata) {
             thread_bootstrap_parent_network_data_request(cur, false);
         } else {
@@ -304,11 +299,6 @@ static void thread_update_mle_entry(protocol_interface_info_entry_t *cur, mle_me
 
 static bool thread_parse_advertisement_from_parent(protocol_interface_info_entry_t *cur, thread_leader_data_t *leader_data, uint16_t short_address)
 {
-    if ((thread_info(cur)->thread_leader_data->partitionId != leader_data->partitionId) ||
-        (thread_info(cur)->thread_leader_data->weighting != leader_data->weighting)) {
-        //parent changed partition/weight - reset own routing information
-        thread_old_partition_data_purge(cur);
-    }
     //check if network data needs to be requested
     if (!thread_bootstrap_request_network_data(cur, leader_data, short_address)) {
         tr_debug("Parent short address changed - re-attach");
@@ -347,7 +337,7 @@ static void thread_parse_advertisement(protocol_interface_info_entry_t *cur, mle
     // Check if this is from my parent
     my_parent = thread_check_is_this_my_parent(cur, entry_temp);
 
-    adv_from_my_partition = thread_instance_id_matches(cur, &leaderData);
+    adv_from_my_partition = thread_partition_match(cur, &leaderData);
 
     if ((security_headers->KeyIdMode == MAC_KEY_ID_MODE_SRC4_IDX) && adv_from_my_partition) {
         thread_management_key_synch_req(cur->id, common_read_32_bit(security_headers->Keysource));
@@ -374,7 +364,7 @@ static void thread_parse_advertisement(protocol_interface_info_entry_t *cur, mle
         /* REED and FED */
         if (!thread_attach_active_router(cur)) {
             /* Check if advertisement is from same partition */
-            if (thread_info(cur)->thread_leader_data->weighting == leaderData.weighting && thread_info(cur)->thread_leader_data->partitionId == leaderData.partitionId ) {
+            if (thread_partition_match(cur, &leaderData)) {
                 if (!entry_temp && thread_bootstrap_link_create_check(cur, shortAddress) && thread_bootstrap_link_create_allowed(cur, shortAddress, mle_msg->packet_src_address)) {
                     // Create link to new neighbor no other processing allowed
                     thread_link_request_start(cur, mle_msg->packet_src_address);
@@ -404,8 +394,7 @@ static void thread_parse_advertisement(protocol_interface_info_entry_t *cur, mle
     }
 
     // Process route TLV
-    if ((entry_temp && routeTlv.dataPtr && routeTlv.tlvLen) &&
-            (thread_info(cur)->thread_leader_data->partitionId == leaderData.partitionId)){
+    if ((entry_temp && routeTlv.dataPtr && routeTlv.tlvLen) && thread_partition_match(cur, &leaderData)){
         tr_debug("Update Route TLV %x", entry_temp->short_adr);
         thread_router_bootstrap_route_tlv_push(cur, routeTlv.dataPtr, routeTlv.tlvLen , linkMargin, entry_temp);
     }
@@ -570,7 +559,7 @@ static void thread_parse_data_response(protocol_interface_info_entry_t *cur, mle
                 return;
             }
         } else {
-            if (thread_info(cur)->thread_leader_data->partitionId != leaderData.partitionId) {
+            if (!thread_partition_match(cur, &leaderData)) {
                 // if receiving data response from different partition it is dropped
                 return;
             }
@@ -583,10 +572,8 @@ static void thread_parse_data_response(protocol_interface_info_entry_t *cur, mle
         }
     }
 
-    if (thread_info(cur)->thread_leader_data->partitionId != leaderData.partitionId) {
-        thread_info(cur)->thread_leader_data->leaderRouterId = leaderData.leaderRouterId;
-        thread_info(cur)->thread_leader_data->partitionId = leaderData.partitionId;
-        thread_old_partition_data_purge(cur);
+    if (!thread_partition_match(cur, &leaderData)) {
+        thread_partition_info_update(cur, &leaderData);
         accept_new_data = true;
     }
 
@@ -722,10 +709,8 @@ static void thread_host_child_update_request_process(protocol_interface_info_ent
     mle_tlv_read_tlv(MLE_TYPE_TLV_REQUEST, mle_msg->data_ptr, mle_msg->data_length, &tlv_req);
 
     // Check if partition changed
-    if (thread_info(cur)->thread_leader_data->partitionId != leaderData.partitionId) {
-        thread_info(cur)->thread_leader_data->leaderRouterId = leaderData.leaderRouterId;
-        thread_info(cur)->thread_leader_data->partitionId = leaderData.partitionId;
-        thread_old_partition_data_purge(cur);
+    if (!thread_partition_match(cur, &leaderData)) {
+        thread_partition_info_update(cur, &leaderData);
     }
     //Check Network Data TLV
     if (mle_tlv_read_tlv(MLE_TYPE_NETWORK_DATA, mle_msg->data_ptr, mle_msg->data_length, &networkDataTlv)) {

source/6LoWPAN/Thread/thread_router_bootstrap.c

@@ -1714,7 +1714,7 @@ void thread_router_bootstrap_mle_receive_cb(int8_t interface_id, mle_message_t *
                     if (mle_tlv_read_16_bit_tlv(MLE_TYPE_SRC_ADDRESS, mle_msg->data_ptr, mle_msg->data_length, &shortAddress)) {
                         //Correct TLV's lets response
                         if (!thread_is_router_addr(shortAddress)) {
-                            if (leaderDataReceived && thread_info(cur)->thread_leader_data->partitionId == leaderData.partitionId) {
+                            if (leaderDataReceived && thread_partition_match(cur, &leaderData)) {
                                 //REED or end device send response
                                 thread_router_accept_to_endevice(cur, mle_msg, challengeTlv.dataPtr, challengeTlv.tlvLen);
                             } else {
@@ -1759,7 +1759,7 @@ void thread_router_bootstrap_mle_receive_cb(int8_t interface_id, mle_message_t *
                 }
 
                 //validate partition id
-                if (thread_info(cur)->thread_leader_data->partitionId != leaderData.partitionId) {
+                if (!thread_partition_match(cur, &leaderData)) {
                     tr_debug("Drop link request from wrong partition");
                     return;
                 }

test/nanostack/unittest/stub/thread_common_stub.c

@@ -396,3 +396,11 @@ int thread_address_registration_primary_bbr_get(struct protocol_interface_info_e
 void thread_reset_neighbour_info(protocol_interface_info_entry_t *cur, mle_neigh_table_entry_t *neighbour)
 {
 }
+bool thread_partition_match(protocol_interface_info_entry_t *cur, thread_leader_data_t *leaderData)
+{
+    return false;
+}
+void thread_partition_info_update(protocol_interface_info_entry_t *cur, thread_leader_data_t *leaderData)
+{
+}
+