refactored packet ingress

made the ingress affect other interfaces than RF

Moved the functionality to ns_monitor

Author: Mika Tervonen

source/Core/include/ns_monitor.h

@@ -35,5 +35,10 @@ void ns_monitor_timer(uint16_t seconds);
 
 int ns_monitor_heap_gc_threshold_set(uint8_t percentage_high, uint8_t percentage_critical);
 
+int ns_monitor_packet_ingress_rate_limit_by_memory(uint8_t free_heap_percentage);
+
+bool ns_monitor_packet_allocation_allowed(void);
+
+
 #endif // _NS_MONITOR_H
 

source/Core/ns_monitor.c

@@ -62,6 +62,8 @@ typedef struct ns_monitor__s {
 
 static ns_monitor_t *ns_monitor_ptr = NULL;
 
+static uint8_t ns_dyn_mem_rate_limiting_threshold_percentage = 0; // Percentage of free memory required to allow routing
+
 typedef void (ns_maintenance_gc_cb)(bool full_gc);
 
 /*
@@ -189,3 +191,31 @@ int ns_monitor_heap_gc_threshold_set(uint8_t percentage_high, uint8_t percentage
 
     return -1;
 }
+
+int ns_monitor_packet_ingress_rate_limit_by_memory(uint8_t free_heap_percentage)
+{
+    if (free_heap_percentage < 100) {
+        ns_dyn_mem_rate_limiting_threshold_percentage = free_heap_percentage;
+        return 0;
+    }
+
+    return -1;
+}
+
+bool ns_monitor_packet_allocation_allowed(void)
+{
+    // If there is no packets to forward this should not be blocked.
+    // There should be cleanup routine enabled that will remove unneeded memory to prevent locks
+    // this could trigger a function to clean packets from routing and allow newest packets
+
+    const mem_stat_t *ns_dyn_mem_stat = ns_dyn_mem_get_mem_stat();
+
+    if (ns_dyn_mem_stat && ns_dyn_mem_rate_limiting_threshold_percentage) {
+        if (ns_dyn_mem_stat->heap_sector_allocated_bytes > ns_dyn_mem_stat->heap_sector_size / 100 * (100 - ns_dyn_mem_rate_limiting_threshold_percentage)) {
+            // Packet allocation not allowed as memory is running low.
+            return false;
+        }
+    }
+    return true;
+}
+

source/MAC/IEEE802_15_4/mac_mcps_sap.c

@@ -34,6 +34,7 @@
 #include "fhss_api.h"
 #include "platform/arm_hal_interrupt.h"
 #include "common_functions.h"
+#include "Core/include/ns_monitor.h"
 
 #include "MAC/IEEE802_15_4/sw_mac_internal.h"
 #include "MAC/IEEE802_15_4/mac_defines.h"
@@ -75,8 +76,6 @@ static void mac_pd_data_confirm_failure_handle(protocol_interface_rf_mac_setup_s
 
 static int8_t mac_tasklet_event_handler = -1;
 
-static uint8_t ns_dyn_mem_rate_limiting_threshold_percentage = 0;
-
 /**
  * Get PHY time stamp.
  *
@@ -2131,13 +2130,9 @@ void mcps_sap_pre_parsed_frame_buffer_free(mac_pre_parsed_frame_t *buf)
 mac_pre_parsed_frame_t *mcps_sap_pre_parsed_frame_buffer_get(const uint8_t *data_ptr, uint16_t frame_length)
 {
     // check that system has enough space to handle the new packet
-    const mem_stat_t *ns_dyn_mem_stat = ns_dyn_mem_get_mem_stat();
-
-    if (ns_dyn_mem_stat && ns_dyn_mem_rate_limiting_threshold_percentage) {
-        if (ns_dyn_mem_stat->heap_sector_allocated_bytes > ns_dyn_mem_stat->heap_sector_size / 100 * (100 - ns_dyn_mem_rate_limiting_threshold_percentage)) {
-            // Packet is dropped from radio interface because there is not enough memory to handle incoming packets.
-            return NULL;
-        }
+    if (!ns_monitor_packet_allocation_allowed()) {
+        // stack can not handle new packets for routing
+        return NULL;
     }
 
     mac_pre_parsed_frame_t *buffer = ns_dyn_mem_temporary_alloc(sizeof(mac_pre_parsed_frame_t) + frame_length);
@@ -2391,16 +2386,6 @@ uint8_t mcps_sap_purge_reg_handler(protocol_interface_rf_mac_setup_s *rf_mac_set
     return confirmation.status;
 }
 
-int mcps_packet_ingress_rate_limit_by_memory(uint8_t free_heap_percentage)
-{
-    if (free_heap_percentage < 100) {
-        ns_dyn_mem_rate_limiting_threshold_percentage = free_heap_percentage;
-        return 0;
-    }
-
-    return -1;
-}
-
 void mcps_pending_packet_counter_update_check(protocol_interface_rf_mac_setup_s *rf_mac_setup, mac_pre_build_frame_t *buffer)
 {
     if (buffer->fcf_dsn.securityEnabled) {

source/MAC/ethernet/ethernet_mac_api.c

@@ -22,6 +22,7 @@
 #include "nsdynmemLIB.h"
 #include "common_functions.h"
 #include "MAC/rf_driver_storage.h"
+#include "Core/include/ns_monitor.h"
 
 typedef struct eth_mac_internal_s {
     eth_mac_api_t *mac_api;
@@ -269,6 +270,11 @@ static int8_t eth_mac_net_phy_rx(const uint8_t *data_ptr, uint16_t data_len, uin
         return -1;
     }
 
+    if (!ns_monitor_packet_allocation_allowed()) {
+        // stack can not handle new packets for routing
+        return -1;
+    }
+
     eth_data_ind_t *data_ind = ns_dyn_mem_temporary_alloc(sizeof(eth_data_ind_t));
     if (!data_ind) {
         return -1;

source/MAC/serial/serial_mac_api.c

@@ -23,6 +23,7 @@
 #include "common_functions.h"
 #include "ns_trace.h"
 #include "MAC/rf_driver_storage.h"
+#include "Core/include/ns_monitor.h"
 
 #define TRACE_GROUP "seMa"
 
@@ -317,10 +318,16 @@ static int8_t serial_mac_net_phy_rx(const uint8_t *data_ptr, uint16_t data_len,
     (void)link_quality;
     (void) dbm;
 
+    if (!ns_monitor_packet_allocation_allowed()) {
+        // stack can not handle new packets for routing
+        return -1;
+    }
+
     serial_data_ind_t *data_ind = ns_dyn_mem_temporary_alloc(sizeof(serial_data_ind_t));
     if (!data_ind) {
         return -1;
     }
+
     data_ind->msdu = ns_dyn_mem_temporary_alloc(data_len);
     if (!data_ind->msdu) {
         ns_dyn_mem_free(data_ind);

source/Service_Libs/utils/ns_conf.c

@@ -29,5 +29,5 @@ int ns_conf_gc_threshold_set(uint8_t percentage_high, uint8_t percentage_critica
 
 int ns_conf_packet_ingress_rate_limit_by_mem(uint8_t free_heap_percentage)
 {
-    return mcps_packet_ingress_rate_limit_by_memory(free_heap_percentage);
+    return ns_monitor_packet_ingress_rate_limit_by_memory(free_heap_percentage);
 }

test/nanostack/unittest/mac/ethernet_mac_api/Makefile

@@ -10,6 +10,7 @@ TEST_SRC_FILES = \
 	main.cpp \
         ethernet_mac_apitest.cpp \
         test_ethernet_mac_api.c \
+        ../../stub/ns_monitor_stub.c \
         ../../stub/common_functions_stub.c \
         ../../stub/nsdynmemLIB_stub.c \
         ../../stub/event_stub.c \

test/nanostack/unittest/mac/mac_mcps_sap/Makefile

@@ -16,6 +16,7 @@ TEST_SRC_FILES = \
         ../../stub/mac_header_helper_functions_stub.c \
         ../../stub/event_stub.c \
         ../../stub/ns_timer_stub.c \
+        ../../stub/ns_monitor_stub.c \
         ../../stub/sw_mac_stub.c \
         ../../stub/mac_mlme_stub.c \
         ../../stub/mac_timer_stub.c \

test/nanostack/unittest/mac/mac_mcps_sap/mac_mcps_saptest.cpp

@@ -127,9 +127,3 @@ TEST(mac_mcps_sap, test_mcps_sap_data_req_handler_ext)
 {
     CHECK(test_mcps_sap_data_req_handler_ext());
 }
-
-TEST(mac_mcps_sap, test_mcps_packet_ingress_rate_limit_by_memory)
-{
-    CHECK(test_mcps_packet_ingress_rate_limit_by_memory());
-}
-

test/nanostack/unittest/mac/mac_mcps_sap/test_mac_mcps_sap.c

@@ -58,6 +58,7 @@
 #include "mac_filter_stub.h"
 #include "mac_mlme_stub.h"
 #include "fhss_config_stub.h"
+#include "ns_monitor_stub.h"
 #include <string.h>
 
 static uint8_t tes_mac_mcps_mac64[8];
@@ -2196,20 +2197,18 @@ bool test_mcps_sap_pre_parsed_frame_buffer_get()
     ns_dyn_mem_free(buf);
 
     // Test that if dynamic memory is low, then allocation fails
-    // Update memory stats: heap size = 1000, allocated 600
     nsdynmemlib_stub.returnCounter = 1;
-    nsdynmemlib_mem_stats_stub.heap_sector_size = 1000;
-    nsdynmemlib_mem_stats_stub.heap_sector_allocated_bytes = 600;
-    // Set ingress limit to 50% = 500 bytes
-    mcps_packet_ingress_rate_limit_by_memory(50);
+    ns_monitor_stub.return_bool = false;
+
     buf = mcps_sap_pre_parsed_frame_buffer_get(buffer, 8);
     if (buf) {
         return false;
     }
 
     // Test that allocation succeeds when there is enough heap
     nsdynmemlib_stub.returnCounter = 1;
-    nsdynmemlib_mem_stats_stub.heap_sector_allocated_bytes = 400;
+    ns_monitor_stub.return_bool = true;
+
     buf = mcps_sap_pre_parsed_frame_buffer_get(buffer, 8);
     if (!buf || buf->frameLength != 8) {
         return false;
@@ -3227,25 +3226,3 @@ bool test_mcps_sap_data_req_handler_ext()
     test_mac_rf_mac_class_free(rf_mac_setup);
     return true;
 }
-
-bool test_mcps_packet_ingress_rate_limit_by_memory()
-{
-
-    int ret_val;
-
-    nsdynmemlib_mem_stats_stub.heap_sector_size = 1000;
-
-    // Too big percentage
-    ret_val = mcps_packet_ingress_rate_limit_by_memory(101);
-    if (ret_val == 0) {
-        return false;
-    }
-
-    // OK case
-    ret_val = mcps_packet_ingress_rate_limit_by_memory(50);
-    if (ret_val != 0) {
-        return false;
-    }
-
-    return true;
-}

test/nanostack/unittest/mac/mac_mcps_sap/test_mac_mcps_sap.h

@@ -63,8 +63,6 @@ bool test_mac_mcps_data_confirmation();
 
 bool test_mcps_sap_data_req_handler_ext();
 
-bool test_mcps_packet_ingress_rate_limit_by_memory();
-
 #ifdef __cplusplus
 }
 #endif

test/nanostack/unittest/mac/serial_mac_api/Makefile

@@ -12,6 +12,7 @@ TEST_SRC_FILES = \
         test_serial_mac_api.c \
         ../../stub/common_functions_stub.c \
         ../../stub/ns_list_stub.c \
+        ../../stub/ns_monitor_stub.c \
         ../../stub/nsdynmemLIB_stub.c \
         ../../stub/mbed_trace_stub.c \
         ../../stub/event_stub.c \

test/nanostack/unittest/stub/mac_mcps_sap_stub.c

@@ -152,11 +152,6 @@ uint8_t mcps_sap_purge_reg_handler(protocol_interface_rf_mac_setup_s *rf_mac_set
     return 0;
 }
 
-int mcps_packet_ingress_rate_limit_by_memory(uint8_t free_heap_percentage)
-{
-    return (int)mac_mcps_sap_stub.int8_value;
-}
-
 int mac_convert_frame_type_to_fhss(uint8_t frame_type)
 {
     return 0;

test/nanostack/unittest/stub/ns_monitor_stub.c

@@ -18,7 +18,11 @@
 #include <string.h>
 #include "ns_types.h"
 #include "nsdynmemLIB.h"
-#include "ns_file_system.h"
+#include "ns_monitor_stub.h"
+
+
+ns_monitor_stub_def ns_monitor_stub = {true};
+
 
 void ns_monitor_init(void)
 {
@@ -38,4 +42,12 @@ int ns_monitor_heap_gc_threshold_set(uint8_t percentage_high, uint8_t percentage
     return 0;
 }
 
+int ns_monitor_packet_ingress_rate_limit_by_memory(uint8_t free_heap_percentage)
+{
+    return 0;
+}
 
+bool ns_monitor_packet_allocation_allowed(void)
+{
+    return ns_monitor_stub.return_bool;
+}

test/nanostack/unittest/stub/ns_monitor_stub.h

@@ -0,0 +1,35 @@
+/*
+ * Copyright (c) 2015-2017, Arm Limited and affiliates.
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+#ifndef __NS_MONITOR_STUB_H__
+#define __NS_MONITOR_STUB_H__
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+typedef struct {
+    bool return_bool;
+} ns_monitor_stub_def;
+
+extern ns_monitor_stub_def ns_monitor_stub;
+
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif // __NS_MONITOR_STUB_H__