Added info API for Wi-SUN border router

Added API to get generic BBR status
Added API to get routing table from Border router

Added RPL interface to get routing table from instance

Author: Mika Tervonen

nanostack/ws_bbr_api.h

@@ -30,6 +30,34 @@
 
 #include "ns_types.h"
 
+/**
+ * \brief Struct ws_statistics Border router dynamic information.
+ */
+typedef struct bbr_information {
+    /** Timestamp of the the device. Can be used as version number*/
+    uint64_t timestamp;
+    /** Border router dodag id */
+    uint8_t dodag_id[16];
+    /** Address prefix given to devices in network  set to 0 if not available*/
+    uint8_t prefix[8];
+    /** Amount of devices in the network. */
+    uint16_t devices_in_network;
+    /** Border router instance identifier defined in RPL */
+    uint8_t instance_id;
+    /** RPL version number */
+    uint8_t version;
+} bbr_information_t;
+
+/**
+ * \brief Struct route_info is parent child relation structure.
+ */
+typedef struct bbr_route_info {
+    /** IID of target device public IPv6 address can be formed by combining prefix + IID*/
+    uint8_t target[8];
+    /** IID of parent*/
+    uint8_t parent[8];
+} bbr_route_info_t;
+
 /**
  * Start backbone border router service.
  *
@@ -83,6 +111,49 @@ int ws_bbr_configure(int8_t interface_id, uint16_t options);
  */
 void ws_bbr_stop(int8_t interface_id);
 
+/**
+ * Get border router information
+ *
+ * \param interface_id interface ID of the Wi-SUN network
+ * \param info_ptr Structure given to stack where information is stored
+ *
+ * \return 0 on success
+ * \return <0 in case of errors
+ *
+ */
+int ws_bbr_info_get(int8_t interface_id, bbr_information_t *info_ptr);
+
+/**
+ * Routing table get
+ *
+ * Table is Parent child relation using the Global address IID of the devices
+ * To get the full IPv6 address of the device.
+ *  IPv6 =  Global Prefix + IID.
+ *
+ * Routing table is in the format: 18 bytes per entry
+ * | Node IID 8 bytes   | parent IID 8 bytes |
+ * | 1122112211221122   | 1111111111111111   |
+ * | 1133113311331133   | 1111111111111111   |
+ * | 1144114411441144   | 1111111111111111   |
+ * | 1155115511551155   | 1122112211221122   |
+ * | 1166116611661166   | 1122112211221122   |
+ * | 1177117711771177   | 1155115511551155   |
+ * | 1188118811881188   | 1177117711771177   |
+ *
+ * Order is not assured only parent child link is given in random order
+ *
+ * Return value is device amount in network divided by 16 bytes per route entry
+ *
+ * \param interface_id interface ID of the Wi-SUN network
+ * \param table_ptr Application allocated memory block where routing table is written.
+ * \param table_len Length of the table allocated by application given as amount of entries.
+ *
+ * \return 0 - x on success indicates amount of bytes written to the table_ptr
+ * \return <0 in case of errors
+ *
+ */
+int ws_bbr_routing_table_get(int8_t interface_id, bbr_route_info_t *table_ptr, uint16_t table_len);
+
 /**
  * Remove node's keys from border router
  *

source/6LoWPAN/ws/ws_bbr_api.c

@@ -737,6 +737,79 @@ int ws_bbr_configure(int8_t interface_id, uint16_t options)
     return -1;
 #endif
 }
+int ws_bbr_info_get(int8_t interface_id, bbr_information_t *info_ptr)
+{
+#ifdef HAVE_WS_BORDER_ROUTER
+
+    protocol_interface_info_entry_t *cur = protocol_stack_interface_info_get_by_id(interface_id);
+    rpl_dodag_info_t dodag_info;
+
+    if (!info_ptr) {
+        return -1;
+    }
+    if (!cur || !protocol_6lowpan_rpl_root_dodag) {
+        tr_warn("bbr not started");
+        return -1;
+    }
+    struct rpl_instance *instance = rpl_control_lookup_instance(protocol_6lowpan_rpl_domain, current_instance_id, current_dodag_id);
+    if (!instance) {
+        tr_warn("bbr instance not found");
+        return -2;
+    }
+    // Zero the structure
+    memset(info_ptr, 0, sizeof(bbr_information_t));
+
+    rpl_control_read_dodag_info(instance, &dodag_info);
+
+    memcpy(info_ptr->dodag_id, current_dodag_id, 16);
+    memcpy(info_ptr->prefix, current_global_prefix, 8);
+
+    info_ptr->devices_in_network = ws_bbr_pan_size(cur);
+    info_ptr->instance_id = current_instance_id;
+    info_ptr->version = dodag_info.version_num;
+    info_ptr->timestamp = protocol_core_monotonic_time; // TODO switch to second timer
+    // consider DTSN included It can also be added for getting device information
+    // Consider own device API to get DTSN, DHCP lifetime values
+    return 0;
+
+#else
+    (void) interface_id;
+    (void) info_ptr;
+
+    return -1;
+#endif
+}
+
+int ws_bbr_routing_table_get(int8_t interface_id, bbr_route_info_t *table_ptr, uint16_t table_len)
+{
+#ifdef HAVE_WS_BORDER_ROUTER
+    protocol_interface_info_entry_t *cur = protocol_stack_interface_info_get_by_id(interface_id);
+    int length;
+    if (!cur || !protocol_6lowpan_rpl_root_dodag) {
+        return -1;
+    }
+
+    struct rpl_instance *instance = rpl_control_lookup_instance(protocol_6lowpan_rpl_domain, current_instance_id, current_dodag_id);
+    if (!instance) {
+        tr_warn("bbr instance not found");
+        return -2;
+    }
+    memset(table_ptr, 0, table_len);
+
+    /* RPL structure must match the external structure so we dont need to make conversion.
+     *
+     */
+    length = rpl_control_route_table_get(instance, current_global_prefix, (rpl_route_info_t *)table_ptr, table_len);
+
+    return length;
+#else
+    (void) interface_id;
+    (void) table_ptr;
+    (void) table_len;
+
+    return -1;
+#endif
+}
 
 int ws_bbr_node_keys_remove(int8_t interface_id, uint8_t *eui64)
 {

source/RPL/rpl_control.c

@@ -1886,6 +1886,11 @@ static void rpl_domain_print(const rpl_domain_t *domain, route_print_fn_t *print
     }
 }
 
+uint16_t rpl_control_route_table_get(struct rpl_instance *instance, uint8_t *prefix, rpl_route_info_t *output_table, uint16_t output_table_len)
+{
+    return rpl_downward_route_table_get(instance, prefix, output_table, output_table_len);
+}
+
 void rpl_control_print(route_print_fn_t *print_fn)
 {
     unsigned t = protocol_core_monotonic_time % 10;

source/RPL/rpl_control.h

@@ -44,6 +44,10 @@ typedef void rpl_prefix_callback_t(struct prefix_entry_t *prefix, void *handle,
 
 typedef bool rpl_new_parent_callback_t(uint8_t *ll_parent_address, void *handle, struct rpl_instance *instance, uint16_t candidate_rank);
 
+typedef struct rpl_route_info {
+    uint8_t node[8];                  /* IID of parent in parent child relation table */
+    uint8_t parent[8];                /* IID of child in parent child relation table */
+} rpl_route_info_t;
 
 typedef struct rpl_domain {
     NS_LIST_HEAD_INCOMPLETE(struct rpl_instance) instances;
@@ -186,6 +190,7 @@ ipv6_route_predicate_fn_t *rpl_control_get_route_predicate(rpl_domain_t *domain,
 
 /* Diagnostic APIs */
 void rpl_control_print(route_print_fn_t *print_fn);
+uint16_t rpl_control_route_table_get(struct rpl_instance *instance, uint8_t *prefix, rpl_route_info_t *output_table, uint16_t output_table_len);
 
 struct rpl_instance *rpl_control_enumerate_instances(rpl_domain_t *domain, struct rpl_instance *instance);
 struct rpl_instance *rpl_control_lookup_instance(rpl_domain_t *domain, uint8_t instance_id, const uint8_t *dodagid);

source/RPL/rpl_downward.c

@@ -1754,6 +1754,52 @@ void rpl_downward_print_instance(rpl_instance_t *instance, route_print_fn_t *pri
     }
 }
 
+uint16_t rpl_downward_route_table_get(rpl_instance_t *instance, uint8_t *prefix, rpl_route_info_t *output_table, uint16_t output_table_len)
+{
+    uint16_t index = 0;
+
+    if (!prefix || !output_table || !output_table_len) {
+        return 0;
+    }
+    if (ns_list_is_empty(&instance->dao_targets)) {
+        return 0;
+    }
+    if (!rpl_instance_am_root(instance)) {
+        // Question should this be available also for non roots in storing mode
+        return 0;
+    }
+
+#ifdef HAVE_RPL_ROOT
+    rpl_downward_compute_paths(instance);
+
+    ns_list_foreach(rpl_dao_target_t, target, &instance->dao_targets) {
+        if (memcmp(target->prefix, prefix, 8) != 0) {
+            continue;
+        }
+
+        if (target->root) {
+            /* Target has root structure
+             * We take the first transit only from table as simple topology is needed
+             */
+            rpl_dao_root_transit_t *transit = ns_list_get_first(&target->info.root.transits);
+            if (transit) {
+                memcpy(output_table->node, &target->prefix[8], 8);
+                memcpy(output_table->parent, &transit->transit[8], 8);
+
+                index++;
+                if (index == output_table_len) {
+                    //table is full
+                    return index;
+                }
+                output_table++;
+            }
+        }
+        /* We dont put non roots to list so border router is not visible as a node in list*/
+    }
+#endif
+    return index;
+}
+
 rpl_dao_target_t *rpl_instance_get_active_target_confirmation(rpl_instance_t *instance)
 {
     ns_list_foreach_safe(rpl_dao_target_t, n, &instance->dao_targets) {

source/RPL/rpl_downward.h

@@ -27,6 +27,7 @@ struct rpl_dao_root_transit;
 void rpl_downward_dao_slow_timer(struct rpl_instance *instance, uint16_t seconds);
 void rpl_downward_dao_timer(struct rpl_instance *instance, uint16_t ticks);
 void rpl_downward_print_instance(struct rpl_instance *instance, route_print_fn_t *print_fn);
+uint16_t rpl_downward_route_table_get(rpl_instance_t *instance, uint8_t *prefix, rpl_route_info_t *output_table, uint16_t output_table_len);
 
 void rpl_downward_convert_dodag_preferences_to_dao_path_control(struct rpl_dodag *dodag);
 void rpl_downward_process_dao_parent_changes(struct rpl_instance *instance);

test/nanostack/unittest/stub/rpl_downward_stub.c

@@ -139,7 +139,10 @@ void rpl_downward_dao_timer(rpl_instance_t *instance, uint16_t ticks)
 void rpl_downward_print_instance(rpl_instance_t *instance, route_print_fn_t *print_fn)
 {
 }
-
+uint16_t rpl_downward_route_table_get(rpl_instance_t *instance, uint8_t *prefix, rpl_route_info_t *output_table, uint16_t output_table_len)
+{
+    return 0;
+}
 void rpl_instance_send_address_registration(rpl_instance_t *instance, const uint8_t addr[16])
 {
 }