Wi-sun Neighbour table update and DHCP new callback

Temporary entry with shorter lifetime and API for remove and set stable lifetime.

Temporary entry life time is 5 seconds.

Temporary entry is released after TX process automatically.

NA build will remove neighbours which not have ARO.

DHCP relay and server will call new registred callback for direct received messages.

Author: Juha Heiskanen

nanostack/dhcp_service_api.h

@@ -109,6 +109,15 @@ typedef int (dhcp_service_receive_req_cb)(uint16_t instance_id, uint32_t msg_tr_
 
 typedef int (dhcp_service_receive_resp_cb)(uint16_t instance_id, void *ptr, uint8_t msg_name,  uint8_t *msg_ptr, uint16_t msg_len);
 
+/* \brief Neighbour table update callback this is called for DHCP relay and server link local responses
+ *
+ * \param interface interface where address is got
+ * \param ll_addr Link local which neighbour must be guarantee.
+ *
+ *
+ */
+typedef void (dhcp_relay_neighbour_cb)(int8_t interface, uint8_t ll_addr[static 16]);
+
 
 /**
  * \brief Initialize a new DHCP service instance.
@@ -235,5 +244,16 @@ void dhcp_service_req_remove_all(void *msg_class_ptr);
  */
 bool dhcp_service_timer_tick(uint16_t ticks);
 
+/**
+ * \brief Register callback which is called when Relay or server RX direct message.
+ *
+ * \param interface_id Interface id for registed callback.
+ * \param notify_cb callback pointer
+ *
+ * \return 0, if everything went fine.
+ * \return -1, if error occurred.
+ */
+int dhcp_service_link_local_rx_cb_set(int8_t interface_id, dhcp_relay_neighbour_cb *notify_cb);
+
 
 #endif //DHCP_SERVICE_API_H_

source/6LoWPAN/ws/ws_bootstrap.c

@@ -63,6 +63,7 @@
 #include "Service_Libs/nd_proxy/nd_proxy.h"
 #include "Service_Libs/blacklist/blacklist.h"
 #include "platform/topo_trace.h"
+#include "dhcp_service_api.h"
 #include "libDHCPv6/libDHCPv6.h"
 #include "DHCPv6_client/dhcpv6_client_api.h"
 #include "ws_management_api.h"
@@ -136,21 +137,54 @@ mac_neighbor_table_entry_t *ws_bootstrap_mac_neighbor_add(struct protocol_interf
     }
     // TODO only call these for new neighbour
     mlme_device_descriptor_t device_desc;
-    neighbor->lifetime = WS_NEIGHBOR_LINK_TIMEOUT;
-    neighbor->link_lifetime = WS_NEIGHBOR_LINK_TIMEOUT;
-    tr_debug("Added new neighbor %s : index:%u", trace_array(src64, 8), neighbor->index);
+    neighbor->lifetime = WS_NEIGHBOUR_TEMPORARY_ENTRY_LIFETIME;
+    neighbor->link_lifetime = WS_NEIGHBOUR_TEMPORARY_ENTRY_LIFETIME;
     mac_helper_device_description_write(interface, &device_desc, neighbor->mac64, neighbor->mac16, 0, false);
     mac_helper_devicetable_set(&device_desc, interface, neighbor->index, interface->mac_parameters->mac_default_key_index, true);
+
     return neighbor;
 }
 
+void ws_bootstrap_neighbor_set_stable(struct protocol_interface_info_entry *interface, const uint8_t *src64)
+{
+    mac_neighbor_table_entry_t *neighbor = mac_neighbor_table_address_discover(mac_neighbor_info(interface), src64, MAC_ADDR_MODE_64_BIT);
+
+    if (neighbor && neighbor->link_lifetime != WS_NEIGHBOR_LINK_TIMEOUT) {
+        neighbor->lifetime = WS_NEIGHBOR_LINK_TIMEOUT;
+        neighbor->link_lifetime = WS_NEIGHBOR_LINK_TIMEOUT;
+        tr_info("Added new neighbor %s : index:%u", trace_array(src64, 8), neighbor->index);
+    }
+}
+
+void ws_bootstrap_mac_neighbor_short_time_set(struct protocol_interface_info_entry *interface, const uint8_t *src64, uint32_t valid_time)
+{
+    mac_neighbor_table_entry_t *neighbor = mac_neighbor_table_address_discover(mac_neighbor_info(interface), src64, MAC_ADDR_MODE_64_BIT);
+
+    if (neighbor && neighbor->link_lifetime != WS_NEIGHBOR_LINK_TIMEOUT) {
+        //mlme_device_descriptor_t device_desc;
+        neighbor->lifetime = valid_time;
+        neighbor->link_lifetime = valid_time;
+        tr_debug("Set short response neighbor %s : index:%u", trace_array(src64, 8), neighbor->index);
+    }
+}
+
 static void ws_bootstrap_neighbor_delete(struct protocol_interface_info_entry *interface, mac_neighbor_table_entry_t *entry_ptr)
 {
     mac_helper_devicetable_remove(interface->mac_api, entry_ptr->index, entry_ptr->mac64);
     etx_neighbor_remove(interface->id, entry_ptr->index, entry_ptr->mac64);
     ws_neighbor_class_entry_remove(&interface->ws_info->neighbor_storage, entry_ptr->index);
 }
 
+void ws_bootstrap_mac_neighbor_temporary_remove(struct protocol_interface_info_entry *interface, const uint8_t *src64)
+{
+    mac_neighbor_table_entry_t *neighbor = mac_neighbor_table_address_discover(mac_neighbor_info(interface), src64, MAC_ADDR_MODE_64_BIT);
+
+    if (neighbor && neighbor->link_lifetime != WS_NEIGHBOR_LINK_TIMEOUT) {
+        tr_debug("Remove temporary neighbour %s", trace_array(src64, 8));
+        mac_neighbor_table_neighbor_remove(mac_neighbor_info(interface), neighbor);
+    }
+}
+
 static void ws_bootstap_eapol_neigh_entry_allocate(struct protocol_interface_info_entry *interface)
 {
     uint8_t mac_64[8];
@@ -161,6 +195,7 @@ static void ws_bootstap_eapol_neigh_entry_allocate(struct protocol_interface_inf
     if (!mac_entry) {
         return;
     }
+    ws_bootstrap_neighbor_set_stable(interface, mac_64);
     mac_entry->lifetime = 0xffffffff;
     mac_entry->link_lifetime = 0xffffffff;
     ws_neighbor_class_entry_t *ws_neigh = ws_neighbor_class_entry_get(&interface->ws_info->neighbor_storage, mac_entry->index);
@@ -838,6 +873,23 @@ bool ws_bootstrap_nd_ns_transmit(protocol_interface_info_entry_t *cur, ipv6_neig
     return true;
 }
 
+static void ws_bootstrap_dhcp_neighbour_update_cb(int8_t interface_id, uint8_t ll_addr[static 16])
+{
+    if (memcmp(ll_addr, ADDR_LINK_LOCAL_PREFIX, 8)) {
+        return;
+    }
+
+    protocol_interface_info_entry_t *cur = protocol_stack_interface_info_get_by_id(interface_id);
+    if (!cur) {
+        return;
+    }
+
+    uint8_t mac64[8];
+    memcpy(mac64, ll_addr + 8, 8);
+    mac64[0] ^= 2;
+    ws_bootstrap_mac_neighbor_short_time_set(cur, mac64, WS_NEIGHBOUR_DHCP_ENTRY_LIFETIME);
+}
+
 static int8_t ws_bootstrap_up(protocol_interface_info_entry_t *cur)
 {
     int8_t ret_val = -1;
@@ -886,6 +938,7 @@ static int8_t ws_bootstrap_up(protocol_interface_info_entry_t *cur)
     cur->if_ns_transmit = ws_bootstrap_nd_ns_transmit;
 
     dhcp_client_init(cur->id, DHCPV6_DUID_HARDWARE_IEEE_802_NETWORKS_TYPE);
+    dhcp_service_link_local_rx_cb_set(cur->id, ws_bootstrap_dhcp_neighbour_update_cb);
     dhcp_client_configure(cur->id, true, true, true); //RENEW uses SOLICIT, Interface will use 1 instance for address get, IAID address hint is not used.
     dhcp_client_solicit_timeout_set(cur->id, WS_DHCP_SOLICIT_TIMEOUT, WS_DHCP_SOLICIT_MAX_RT, WS_DHCP_SOLICIT_MAX_RC);
 
@@ -1434,6 +1487,7 @@ static void ws_bootstrap_pan_config_analyse(struct protocol_interface_info_entry
         if (!neighbour_pointer_valid) {
             return;
         }
+        ws_bootstrap_neighbor_set_stable(cur, data->SrcAddr);
     }
 
     if (neighbour_pointer_valid) {
@@ -1707,6 +1761,10 @@ static void ws_bootstrap_neighbor_table_clean(struct protocol_interface_info_ent
             continue;
         }
 
+        if (cur->link_lifetime != WS_NEIGHBOR_LINK_TIMEOUT) {
+            continue;
+        }
+
         if (cur->link_role == PRIORITY_PARENT_NEIGHBOUR) {
             //This is our primary parent we cannot delete
             continue;
@@ -1834,7 +1892,7 @@ static bool ws_neighbor_entry_nud_notify(mac_neighbor_table_entry_t *entry_ptr,
     ws_neighbor_class_entry_t *ws_neighbor = ws_neighbor_class_entry_get(&cur->ws_info->neighbor_storage, entry_ptr->index);
     etx_storage_t *etx_entry = etx_storage_entry_get(cur->id, entry_ptr->index);
 
-    if (!entry_ptr->trusted_device || !ws_neighbor || !etx_entry || ws_neighbor->negative_aro_send) {
+    if (!entry_ptr->trusted_device || !ws_neighbor || !etx_entry || ws_neighbor->negative_aro_send || entry_ptr->link_lifetime != WS_NEIGHBOR_LINK_TIMEOUT) {
         return false;
     }
 
@@ -2515,6 +2573,7 @@ static bool ws_rpl_new_parent_callback(uint8_t *ll_parent_address, void *handle,
     bool create_ok = ws_bootstrap_neighbor_info_request(cur, entry->mac64, &neigh_buffer, true);
     if (create_ok) {
         ws_neighbor_class_entry_t *ws_neigh = neigh_buffer.ws_neighbor;
+        ws_bootstrap_neighbor_set_stable(cur, entry->mac64);
         //Copy fhss temporary data
         *ws_neigh = entry->neigh_info_list;
         //ETX Create here
@@ -3226,7 +3285,7 @@ static int8_t ws_bootstrap_neighbor_set(protocol_interface_info_entry_t *cur, pa
         ns_list_add_to_end(&cur->ws_info->parent_list_free, parent_ptr);
         return -1;
     }
-
+    ws_bootstrap_neighbor_set_stable(cur, parent_ptr->addr);
     ws_neighbor_class_neighbor_unicast_time_info_update(neighbor_info.ws_neighbor, &parent_ptr->ws_utt, parent_ptr->timestamp);
     ws_neighbor_class_neighbor_unicast_schedule_set(neighbor_info.ws_neighbor, &parent_ptr->ws_us, &cur->ws_info->hopping_schdule);
     return 0;

source/6LoWPAN/ws/ws_bootstrap.h

@@ -92,19 +92,28 @@ struct ws_neighbor_class_entry *ws_bootstrap_eapol_tx_temporary_set(struct proto
 
 void ws_bootstrap_eapol_tx_temporary_clear(struct protocol_interface_info_entry *interface);
 
+void ws_bootstrap_neighbor_set_stable(struct protocol_interface_info_entry *interface, const uint8_t *src64);
+
 int ws_bootstrap_get_info(protocol_interface_info_entry_t *cur, struct ws_stack_info *info_ptr);
 
+void ws_bootstrap_mac_neighbor_short_time_set(struct protocol_interface_info_entry *interface, const uint8_t *src64, uint32_t valid_time);
+
+void ws_bootstrap_mac_neighbor_temporary_remove(struct protocol_interface_info_entry *interface, const uint8_t *src64);
+
 #else
 
 #define ws_bootstrap_init(interface_id, bootstrap_mode) (-1)
 #define ws_bootstrap_state_machine(cur)
 #define ws_bootstrap_restart(cur)
 #define ws_bootstrap_neighbor_remove(cur, ll_address)
 #define ws_bootstrap_aro_failure(cur, ll_address)
+#define ws_bootstrap_neighbor_set_stable(interface, src64)
+#define ws_bootstrap_mac_neighbor_temporary_remove(interface, src64)
 #define ws_bootstrap_primary_parent_update(interface, neighbor)
 #define ws_bootstrap_secondary_parent_update(interface)
 #define ws_bootstrap_get_info(cur, info_ptr)
 
+
 #endif //HAVE_WS
 
 #endif /* WS_BOOTSTRAP_H_ */

source/6LoWPAN/ws/ws_common.c

@@ -422,6 +422,7 @@ uint8_t ws_common_allow_child_registration(protocol_interface_info_entry_t *inte
         tr_warn("Child registration not allowed %d/%d, max:%d", child_count, max_child_count, mac_neighbor_info(interface)->list_total_size);
         return ARO_FULL;
     }
+    ws_bootstrap_neighbor_set_stable(interface, eui64);
     tr_info("Child registration allowed %d/%d, max:%d", child_count, max_child_count, mac_neighbor_info(interface)->list_total_size);
     return ARO_SUCCESS;
 }
@@ -488,5 +489,12 @@ void ws_common_secondary_parent_update(protocol_interface_info_entry_t *interfac
 {
     ws_bootstrap_secondary_parent_update(interface);
 }
+void ws_common_link_temporary_remove(struct protocol_interface_info_entry *interface, const uint8_t *ll64)
+{
+    uint8_t mac64[8];
+    memcpy(mac64, ll64 + 8, 8);
+    mac64[0] ^= 2;
+    ws_bootstrap_mac_neighbor_temporary_remove(interface, mac64);
+}
 
 #endif // HAVE_WS

source/6LoWPAN/ws/ws_common.h

@@ -155,6 +155,8 @@ void ws_common_primary_parent_update(protocol_interface_info_entry_t *interface,
 
 void ws_common_secondary_parent_update(protocol_interface_info_entry_t *interface);
 
+void ws_common_link_temporary_remove(struct protocol_interface_info_entry *interface, const uint8_t *ll64);
+
 #define ws_info(cur) ((cur)->ws_info)
 #else
 #define ws_info(cur) ((ws_info_t *) NULL)
@@ -168,6 +170,7 @@ void ws_common_secondary_parent_update(protocol_interface_info_entry_t *interfac
 #define ws_common_latency_estimate_get(cur) 0
 #define ws_common_datarate_get(cur) 0
 #define ws_common_network_size_estimate_get(cur) 0
+#define ws_common_link_temporary_remove(interface, ll64) ((void)0)
 #define ws_common_primary_parent_update(interface, neighbor)
 #define ws_common_secondary_parent_update(interface)
 

source/6LoWPAN/ws/ws_common_defines.h

@@ -240,6 +240,9 @@ typedef struct ws_bs_ie {
 #define WS_FAN_VERSION_1_0 1
 
 #define WS_NEIGHBOR_LINK_TIMEOUT 2200
+
+#define WS_NEIGHBOUR_TEMPORARY_ENTRY_LIFETIME 5
+#define WS_NEIGHBOUR_DHCP_ENTRY_LIFETIME 60
 #define WS_NEIGHBOR_TEMPORARY_LINK_MIN_TIMEOUT_LARGE 520
 #define WS_NEIGHBOR_TEMPORARY_LINK_MIN_TIMEOUT_SMALL 260
 #define WS_NEIGHBOR_NUD_TIMEOUT WS_NEIGHBOR_LINK_TIMEOUT / 2

source/6LoWPAN/ws/ws_llc_data_service.c

@@ -465,10 +465,16 @@ static void ws_llc_mac_confirm_cb(const mac_api_t *api, const mcps_data_conf_t *
         }
     }
     //ETX update
+    llc_neighbour_req_t neighbor_info;
+    neighbor_info.ws_neighbor = NULL;
+    neighbor_info.neighbor = NULL;
     if (message->ack_requested && messsage_type == WS_FT_DATA) {
-        llc_neighbour_req_t neighbor_info;
+
         bool success = false;
 
+        if (message->dst_address_type == MAC_ADDR_MODE_64_BIT) {
+            base->ws_neighbor_info_request_cb(interface, message->dst_address, &neighbor_info, false);
+        }
         switch (data->status) {
             case MLME_SUCCESS:
             case MLME_TX_NO_ACK:
@@ -477,7 +483,7 @@ static void ws_llc_mac_confirm_cb(const mac_api_t *api, const mcps_data_conf_t *
                     success = true;
                 }
 
-                if (message->dst_address_type == MAC_ADDR_MODE_64_BIT && base->ws_neighbor_info_request_cb(interface, message->dst_address, &neighbor_info, false)) {
+                if (neighbor_info.ws_neighbor && neighbor_info.neighbor && neighbor_info.neighbor->link_lifetime == WS_NEIGHBOR_LINK_TIMEOUT) {
                     etx_transm_attempts_update(interface->id, 1 + data->tx_retries, success, neighbor_info.neighbor->index, neighbor_info.neighbor->mac64);
                     //TODO discover RSL from Enchanced ACK Header IE elements
                     ws_utt_ie_t ws_utt;
@@ -500,6 +506,7 @@ static void ws_llc_mac_confirm_cb(const mac_api_t *api, const mcps_data_conf_t *
             default:
                 break;
         }
+
     }
     //Free message
     llc_message_free(message, base);
@@ -529,6 +536,12 @@ static void ws_llc_mac_confirm_cb(const mac_api_t *api, const mcps_data_conf_t *
                 ns_list_remove(&base->temp_entries->llc_eap_pending_list, message);
                 ws_llc_mpx_eapol_send(base, message);
             }
+        } else {
+            if (neighbor_info.ws_neighbor && neighbor_info.neighbor && neighbor_info.neighbor->link_lifetime != WS_NEIGHBOR_LINK_TIMEOUT) {
+                //Remove temp neighbour
+                tr_debug("Remove Temp Entry by TX confirm");
+                mac_neighbor_table_neighbor_remove(mac_neighbor_info(interface), neighbor_info.neighbor);
+            }
         }
 
         return;

source/Common_Protocols/icmpv6.c

@@ -1648,6 +1648,7 @@ buffer_t *icmpv6_build_na(protocol_interface_info_entry_t *cur, bool solicited,
     }
     /* All other than ARO NA messages are omitted and MAC ACK is considered as success */
     if (!tllao_required && (!aro && cur->ipv6_neighbour_cache.omit_na)) {
+        ws_common_link_temporary_remove(cur, src_addr);
         return NULL;
     }