Merge pull request #921 from LedgerHQ/dynamic-memory-alloc

Add dynamic memory allocator

Author: nroggeman-ledger

.github/workflows/unit_tests.yml

@@ -29,6 +29,8 @@ jobs:
           STAX=1 cmake -Bbuild -H. && make -C build && CTEST_OUTPUT_ON_FAILURE=1 make -C build test
           cd ../app_storage/
           cmake -Bbuild -H. && make -C build && make -C build test
+          cd ../lib_alloc/
+          cmake -Bbuild -H. && make -C build && make -C build test
 
       - name: Generate code coverage
         run: |
@@ -38,6 +40,8 @@ jobs:
           ../gen_coverage.sh
           cd ../app_storage/
           ../gen_coverage.sh
+          cd ../lib_alloc/
+          ../gen_coverage.sh
 
       - uses: actions/upload-artifact@v4
         with:

Makefile.rules

@@ -27,6 +27,11 @@ else
     NBGL_INCLUDE_PATH := lib_nbgl
 endif
 
+# include dynamic memory allocator, if asked (temporary flag)
+ifeq ($(ENABLE_DYNAMIC_ALLOC), 1)
+  SDK_SOURCE_PATH += lib_alloc
+endif
+
 define uniq =
   $(eval seen :=)
   $(foreach _,$1,$(if $(filter $_,${seen}),,$(eval seen += $_)))

doc/Doxyfile

@@ -825,6 +825,8 @@ WARN_LOGFILE           =
 
 INPUT                  = \
                          doc \
+                         lib_alloc \
+                         lib_alloc/doc \
                          lib_cxng/doc \
                          lib_cxng/include \
                          lib_cxng/src \

doc/mainpage.dox

@@ -13,6 +13,10 @@ The @subpage ble_mainpage page contains all information necessary to interact wi
 
 The @subpage cxng_mainpage page contains all information necessary to understand Cryptographic Library
 
+@section mem_presentation Dynamic Memory Allocator Interface
+
+The @subpage mem_alloc_mainpage page contains all information necessary to interact with Dynamic Memory Allocator.
+
 @section nbgl_presentation Screen drawing API
 
 The @subpage nbgl_mainpage page contains all information necessary to understand the Graphical Library for

include/errors.h

@@ -150,5 +150,6 @@ enum sdk_generic_identifiers {
 #define EXCEPTION_IO_STATE    0x11  // keep original value // SWO_MUI_UNK_15
 #define EXCEPTION_CXPORT      0x12  // keep original value // SWO_MUI_UNK_16
 #define EXCEPTION_SYSTEM      0x13  // keep original value // SWO_MUI_UNK_17
+#define EXCEPTION_CORRUPT     0x14
 
 #endif  // ERRORS_H

lib_alloc/doc/mainpage.dox

@@ -0,0 +1,21 @@
+/** @page mem_alloc_mainpage Dynamic memory allocator
+
+@section mem_alloc_mainpage_intro Introduction
+
+This page describes the Dynamic Memory Allocator available for Applications.
+
+Basically, this allocator behaves like any memory allocator in usual OS. The main difference is that it can be instantiated, thanks to
+its initialization function: @ref mem_init()
+
+This function takes as parameters
+
+- a pointer to a buffer that will be used both as context for the Allocator and for dynamic chunks,
+- and the size of this buffer
+
+It returns a memory context (@ref mem_ctx_t) that will be used by other functions
+
+Then, chunks can be allocated with @ref mem_alloc() and released with @ref mem_free()
+
+Both of these function take the memory context as first parameter.
+
+*/