Limit amount of incoming packet based on memory (#2128)

Add new API to MAC layer to limit amount of incoming packets when
there is not enough memory available.

Author: Arto Kinnunen

nanostack/sw_mac.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016-2018, Arm Limited and affiliates.
+ * Copyright (c) 2016-2019, Arm Limited and affiliates.
  * SPDX-License-Identifier: Apache-2.0
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -82,11 +82,20 @@ extern struct fhss_api *ns_sw_mac_get_fhss_api(struct mac_api_s *mac_api);
 extern int ns_sw_mac_statistics_start(struct mac_api_s *mac_api, struct mac_statistics_s *mac_statistics);
 
 /**
- * @brief Read current timestamp for compared storaged data timestamp.
+ * @brief Read current timestamp.
  * @param mac_api MAC instance.
  * @return Current timestamp in us
  */
-uint32_t ns_sw_mac_read_current_timestamp(struct mac_api_s *mac_api);
+extern uint32_t ns_sw_mac_read_current_timestamp(struct mac_api_s *mac_api);
+
+/**
+ * @brief Limit amount of incoming packets if system does not have enough free memory.
+ * Memory statistics must been initialized in nsdynmemLIB to get this feature working.
+ *
+ * @param free_heap_percentage Percentage of free heap that must be available when packet arrives to MAC layer.
+ * @return 0 in case of success, <0 otherwise.
+ */
+extern int ns_sw_mac_packet_ingress_rate_limit_by_mem(uint8_t free_heap_percentage);
 
 #ifdef __cplusplus
 }

source/MAC/IEEE802_15_4/mac_mcps_sap.c

@@ -74,6 +74,8 @@ static void mac_pd_data_confirm_failure_handle(protocol_interface_rf_mac_setup_s
 
 static int8_t mac_tasklet_event_handler = -1;
 
+static uint32_t ns_dyn_mem_rate_limiting_threshold = 0xFFFFFFFF;
+
 /**
  * Get PHY time stamp.
  *
@@ -686,6 +688,7 @@ static int8_t mac_data_sap_rx_handler(mac_pre_parsed_frame_t *buf, protocol_inte
 {
     int8_t retval = -1;
     uint8_t status;
+
     //allocate Data ind primitiv and parse packet to that
     mcps_data_ind_t *data_ind = ns_dyn_mem_temporary_alloc(sizeof(mcps_data_ind_t));
 
@@ -2068,13 +2071,20 @@ 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_stat->heap_sector_allocated_bytes > ns_dyn_mem_rate_limiting_threshold) {
+        return NULL;
+    }
+
     mac_pre_parsed_frame_t *buffer = ns_dyn_mem_temporary_alloc(sizeof(mac_pre_parsed_frame_t) + frame_length);
 
     if (buffer) {
         memset(buffer, 0, sizeof(mac_pre_parsed_frame_t) + frame_length);
         buffer->frameLength = frame_length;
         memcpy(mac_header_message_start_pointer(buffer), data_ptr, frame_length);
     }
+
     return buffer;
 }
 
@@ -2298,3 +2308,15 @@ 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)
+{
+    const mem_stat_t *ns_dyn_mem_stat = ns_dyn_mem_get_mem_stat();
+
+    if (ns_dyn_mem_stat && free_heap_percentage < 100) {
+        ns_dyn_mem_rate_limiting_threshold = ns_dyn_mem_stat->heap_sector_size / 100 * (100 - free_heap_percentage);
+        return 0;
+    }
+
+    return -1;
+}

source/MAC/IEEE802_15_4/mac_mcps_sap.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016-2018, Arm Limited and affiliates.
+ * Copyright (c) 2016-2019, Arm Limited and affiliates.
  * SPDX-License-Identifier: Apache-2.0
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -216,4 +216,6 @@ int8_t mcps_pd_data_rebuild(struct protocol_interface_rf_mac_setup *rf_ptr, mac_
 
 int8_t mcps_generic_ack_build(struct protocol_interface_rf_mac_setup *rf_ptr, const mac_fcf_sequence_t *fcf, const uint8_t *data_ptr, const mcps_ack_data_payload_t *ack_payload);
 
+int mcps_packet_ingress_rate_limit_by_memory(uint8_t free_heap_percentage);
+
 #endif /* MAC_IEEE802_15_4_MAC_MCPS_SAP_H_ */

source/MAC/IEEE802_15_4/sw_mac.c

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016-2018, Arm Limited and affiliates.
+ * Copyright (c) 2016-2019, Arm Limited and affiliates.
  * SPDX-License-Identifier: Apache-2.0
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -715,3 +715,8 @@ uint32_t ns_sw_mac_read_current_timestamp(struct mac_api_s *mac_api)
     mac_setup->dev_driver->phy_driver->extension(PHY_EXTENSION_GET_TIMESTAMP, (uint8_t *)&time_stamp_buffer);
     return time_stamp_buffer;
 }
+
+int ns_sw_mac_packet_ingress_rate_limit_by_mem(uint8_t free_heap_percentage)
+{
+    return mcps_packet_ingress_rate_limit_by_memory(free_heap_percentage);
+}

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016-2018, Arm Limited and affiliates.
+ * Copyright (c) 2016-2019, Arm Limited and affiliates.
  * SPDX-License-Identifier: Apache-2.0
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -128,3 +128,8 @@ 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

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016-2018, Arm Limited and affiliates.
+ * Copyright (c) 2016-2019, Arm Limited and affiliates.
  * SPDX-License-Identifier: Apache-2.0
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -59,7 +59,6 @@
 
 static uint8_t tes_mac_mcps_mac64[8];
 
-
 static mac_pre_build_frame_t *tes_mac_mcps_temporary_buffer_get(uint16_t length)
 {
     mac_pre_build_frame_t *buf = malloc(sizeof(mac_pre_build_frame_t));
@@ -75,7 +74,6 @@ static mac_pre_build_frame_t *tes_mac_mcps_temporary_buffer_get(uint16_t length)
     return buf;
 }
 
-
 static void test_mac_buffer_init(mac_pre_parsed_frame_t *buffer, uint16_t header_length, uint16_t payload_length, uint8_t security_length)
 {
     buffer->mac_header_length = header_length;
@@ -2189,6 +2187,27 @@ bool test_mcps_sap_pre_parsed_frame_buffer_get()
     if (memcmp(mac_header_message_start_pointer(buf), buffer, 8) != 0) {
         return false;
     }
+    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);
+    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;
+    buf = mcps_sap_pre_parsed_frame_buffer_get(buffer, 8);
+    if (!buf || buf->frameLength != 8) {
+        return false;
+    }
 
     ns_dyn_mem_free(buf);
     return true;
@@ -3199,3 +3218,25 @@ 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

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016-2018, Arm Limited and affiliates.
+ * Copyright (c) 2016-2019, Arm Limited and affiliates.
  * SPDX-License-Identifier: Apache-2.0
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -63,6 +63,8 @@ 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/sw_mac/sw_mactest.cpp

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016-2018, Arm Limited and affiliates.
+ * Copyright (c) 2016-2019, Arm Limited and affiliates.
  * SPDX-License-Identifier: Apache-2.0
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -114,3 +114,8 @@ TEST(sw_mac, test_ns_sw_mac_virtual_client_unregister)
     CHECK(test_ns_sw_mac_virtual_client_unregister());
 }
 
+TEST(sw_mac, test_ns_sw_mac_packet_ingress_rate_limit_by_mem)
+{
+    CHECK(test_ns_sw_mac_packet_ingress_rate_limit_by_mem());
+}
+

test/nanostack/unittest/mac/sw_mac/test_sw_mac.c

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016-2018, Arm Limited and affiliates.
+ * Copyright (c) 2016-2019, Arm Limited and affiliates.
  * SPDX-License-Identifier: Apache-2.0
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -477,6 +477,20 @@ bool test_ns_sw_mac_virtual_client_unregister()
     return true;
 }
 
+bool test_ns_sw_mac_packet_ingress_rate_limit_by_mem()
+{
+    int ret_val;
+
+    mac_mcps_sap_stub.int8_value = 0;
+
+    ret_val = ns_sw_mac_packet_ingress_rate_limit_by_mem(99);
+    if (ret_val != 0) {
+        return false;
+    }
+
+    return true;
+}
+
 bool test_mlme_req()
 {
     arm_device_driver_list_s list;

test/nanostack/unittest/mac/sw_mac/test_sw_mac.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016-2017, Arm Limited and affiliates.
+ * Copyright (c) 2016-2019, Arm Limited and affiliates.
  * SPDX-License-Identifier: Apache-2.0
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -59,6 +59,8 @@ bool test_ns_sw_mac_virtual_client_unregister();
 // Test registering FHSS to software MAC
 bool test_ns_sw_mac_fhss_register();
 
+bool test_ns_sw_mac_packet_ingress_rate_limit_by_mem();
+
 #ifdef __cplusplus
 }
 #endif

test/nanostack/unittest/stub/mac_mcps_sap_stub.c

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2014-2018, Arm Limited and affiliates.
+ * Copyright (c) 2014-2019, Arm Limited and affiliates.
  * SPDX-License-Identifier: Apache-2.0
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -152,6 +152,11 @@ 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/nsdynmemLIB_stub.c

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2014-2015, 2017-2018, Arm Limited and affiliates.
+ * Copyright (c) 2014-2015, 2017-2019, Arm Limited and affiliates.
  * SPDX-License-Identifier: Apache-2.0
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -17,13 +17,14 @@
 #include "nsdynmemLIB_stub.h"
 #include <stdint.h>
 #include <string.h>
-#include <nsdynmemLIB.h>
+#include "nsdynmemLIB.h"
 #include "platform/arm_hal_interrupt.h"
 #ifdef STANDARD_MALLOC
 #include <stdlib.h>
 #endif
 
 nsdynmemlib_stub_data_t nsdynmemlib_stub;
+mem_stat_t nsdynmemlib_mem_stats_stub;
 
 #if NSDYNMEMLIB_API_VERSION < 2
 typedef int16_t ns_mem_block_size_t;
@@ -61,3 +62,8 @@ void ns_dyn_mem_free(void *block)
 {
     free(block);
 }
+
+const mem_stat_t *ns_dyn_mem_get_mem_stat(void)
+{
+    return &nsdynmemlib_mem_stats_stub;
+}

test/nanostack/unittest/stub/nsdynmemLIB_stub.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2015-2018, Arm Limited and affiliates.
+ * Copyright (c) 2015-2019, Arm Limited and affiliates.
  * SPDX-License-Identifier: Apache-2.0
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -22,13 +22,15 @@ extern "C" {
 #endif
 
 #include "stdint.h"
+#include "nsdynmemLIB.h"
 
 typedef struct {
     uint8_t returnCounter;
     void *expectedPointer;
 } nsdynmemlib_stub_data_t;
 
 extern nsdynmemlib_stub_data_t nsdynmemlib_stub;
+extern mem_stat_t nsdynmemlib_mem_stats_stub;
 
 #ifdef __cplusplus
 }