Feature/add memap cstack usage ports (#661)

* Added memap, avstack, and checkstackusage tools to STM32F4xx Makefile and CMake builds to calculate CSTACK depth and RAM usage

* Added memap, cstack, and ram-usage recipes to stm32f10x port Makefile.  Added Cmake build.

* Removed local dlmstp.c module from stm32f10x port, and used the common datalink dlmstp.c module with MS/TP extended frames and zero-config support.

* Added .nm and .su to .gitignore to skip the analysis file residue.

ports/stm32f4xx/CMakeLists.txt

@@ -49,8 +49,12 @@ set(CMAKE_ASM_COMPILER arm-none-eabi-gcc)
 set(CMAKE_AR arm-none-eabi-ar)
 set(CMAKE_OBJCOPY arm-none-eabi-objcopy)
 set(CMAKE_OBJDUMP arm-none-eabi-objdump)
-set(SIZE arm-none-eabi-size)
+set(CMAKE_SIZE arm-none-eabi-size)
+set(CMAKE_NM arm-none-eabi-nm)
+set(CMAKE_CSTACK "${CMAKE_SOURCE_DIR}/../../tools/check-stack-usage/checkStackUsage.py")
+set(CMAKE_MEMAP "${CMAKE_SOURCE_DIR}/../../tools/memap/memap.py")
 set(CMAKE_TRY_COMPILE_TARGET_TYPE STATIC_LIBRARY)
+set(EXECUTABLE ${PROJECT_NAME}.elf)
 
 project(bacnet-mstp)
 
@@ -64,6 +68,7 @@ add_compile_options(-mcpu=cortex-m4)
 add_compile_options(-mthumb -mthumb-interwork)
 add_compile_options(-ffunction-sections -fdata-sections)
 add_compile_options(-fno-common -fmessage-length=0)
+add_compile_options(-fstack-usage -fdump-rtl-dfinish)
 add_link_options(-mcpu=cortex-m4)
 add_link_options(-mthumb -mthumb-interwork)
 add_link_options(-Wl,-gc-sections,--print-memory-usage)
@@ -95,13 +100,13 @@ if(BACNET_STACK_DEPRECATED_DISABLE)
   add_definitions(-DBACNET_STACK_DEPRECATED_DISABLE)
 endif()
 
-set(LIBRARY_BACNET_INC "../../src")
-set(LIBRARY_BACNET_CORE "../../src/bacnet")
-set(LIBRARY_BACNET_BASIC "../../src/bacnet/basic")
-set(LIBRARY_STM32_SRC "./STM32F4xx_StdPeriph_Driver/src")
-set(LIBRARY_STM32_INC "./STM32F4xx_StdPeriph_Driver/inc")
-set(LIBRARY_CMSIS_INC "./CMSIS")
-set(LIBRARY_CMSIS_GCC_INC "./CMSIS/gcc_ride7")
+set(LIBRARY_BACNET_INC "${CMAKE_SOURCE_DIR}/../../src")
+set(LIBRARY_BACNET_CORE "${CMAKE_SOURCE_DIR}/../../src/bacnet")
+set(LIBRARY_BACNET_BASIC "${CMAKE_SOURCE_DIR}/../../src/bacnet/basic")
+set(LIBRARY_STM32_SRC "${CMAKE_SOURCE_DIR}/STM32F4xx_StdPeriph_Driver/src")
+set(LIBRARY_STM32_INC "${CMAKE_SOURCE_DIR}/STM32F4xx_StdPeriph_Driver/inc")
+set(LIBRARY_CMSIS_INC "${CMAKE_SOURCE_DIR}/CMSIS")
+set(LIBRARY_CMSIS_GCC_INC "${CMAKE_SOURCE_DIR}/CMSIS/gcc_ride7")
 
 set(BACNET_PROJECT_SOURCE
     ${LIBRARY_STM32_SRC}/stm32f4xx_adc.c
@@ -242,6 +247,8 @@ target_compile_options(${EXECUTABLE} PRIVATE
     -Wno-comment
     -Wno-missing-braces
     -Wno-unused-variable
+    # reference the linker file for CSTACK size
+    -Wstack-usage=16384
     -Wno-unused-parameter
     -Wno-char-subscripts
 )
@@ -263,15 +270,42 @@ target_link_options(${EXECUTABLE} PRIVATE
     -Wl,--gc-sections
 )
 
+# Create hex and bin files
+add_custom_command(TARGET ${EXECUTABLE}
+    POST_BUILD
+    COMMAND ${CMAKE_OBJCOPY} -O ihex ${EXECUTABLE} ${PROJECT_NAME}.hex
+    COMMAND ${CMAKE_OBJCOPY} -O binary ${EXECUTABLE} ${PROJECT_NAME}.bin
+)
+
 # Print executable size
 add_custom_command(TARGET ${EXECUTABLE}
     POST_BUILD
-    COMMAND arm-none-eabi-size ${EXECUTABLE}
+    COMMAND ${CMAKE_SIZE} ${EXECUTABLE}
 )
 
-# Create hex file
-add_custom_command(TARGET ${EXECUTABLE}
-    POST_BUILD
-    COMMAND arm-none-eabi-objcopy -O ihex ${EXECUTABLE} ${PROJECT_NAME}.hex
-    COMMAND arm-none-eabi-objcopy -O binary ${EXECUTABLE} ${PROJECT_NAME}.bin
+# sort the RAM usage by size and place into a file
+add_custom_target(symbols
+    DEPENDS ${EXECUTABLE}
+    COMMENT "Print memory symbols by size"
+    COMMAND ${CMAKE_NM} -t d -S --size-sort ${EXECUTABLE} 1> ${PROJECT_NAME}.nm
+    COMMAND echo "RAM usage by size analysis in ${PROJECT_NAME}.nm"
+    COMMAND echo "=ADDRESS= ==RAM=== = ==VARIABLE-NAME=="
+    COMMAND tail ${PROJECT_NAME}.nm
+)
+
+# calculate the worst case CSTACK memory usage by size and place into a file
+add_custom_target(cstack 
+    DEPENDS ${EXECUTABLE}
+    COMMENT "Print CSTACK memory depth by size"
+    COMMAND ${CMAKE_CSTACK} ${EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR} 1> ${PROJECT_NAME}.su
+    COMMAND echo "C-Stack maxium depth analysis in ${PROJECT_NAME}.su"
+    COMMAND echo "==DEPTH== : == Functions called =="
+    COMMAND tail ${PROJECT_NAME}.su
+)
+
+# Print file and library sizes
+add_custom_target(memmap 
+    DEPENDS ${PROJECT_NAME}.map
+    COMMENT "Print file and library memory usage by size"
+    COMMAND ${CMAKE_MEMAP} -t GCC_ARM ${PROJECT_NAME}.map
 )

ports/stm32f4xx/Makefile

@@ -13,6 +13,9 @@ LIBRARY_STM32 = ./STM32F4xx_StdPeriph_Driver/src
 LIBRARY_STM32_INCLUDES = ./STM32F4xx_StdPeriph_Driver/inc
 LIBRARY_CMSIS = ./CMSIS
 
+CSTACK_TOOL := $(BACNET_DIR)/tools/avstack/avstack.pl
+MEMAP_TOOL := $(BACNET_DIR)/tools/memap/memap.py
+
 INCLUDES = -I$(PLATFORM_DIR)
 INCLUDES += -I$(LIBRARY_STM32_INCLUDES)
 INCLUDES += -I$(LIBRARY_CMSIS)
@@ -59,17 +62,15 @@ BACNET_SRC = \
 	$(BACNET_CORE)/bacint.c \
 	$(BACNET_CORE)/bacreal.c \
 	$(BACNET_CORE)/bacstr.c \
-	$(BACNET_CORE)/datalink/cobs.c \
-	$(BACNET_CORE)/datalink/crc.c \
-	$(BACNET_CORE)/datalink/dlmstp.c \
-	$(BACNET_CORE)/datalink/mstp.c \
-	$(BACNET_CORE)/datalink/mstptext.c \
+	$(BACNET_CORE)/bactimevalue.c \
+	$(BACNET_CORE)/calendar_entry.c \
+	$(BACNET_CORE)/dailyschedule.c \
 	$(BACNET_CORE)/datetime.c \
 	$(BACNET_CORE)/dcc.c \
-	$(BACNET_CORE)/indtext.c \
+	$(BACNET_CORE)/hostnport.c \
 	$(BACNET_CORE)/iam.c \
 	$(BACNET_CORE)/ihave.c \
-	$(BACNET_CORE)/hostnport.c \
+	$(BACNET_CORE)/indtext.c \
 	$(BACNET_CORE)/lighting.c \
 	$(BACNET_CORE)/memcopy.c \
 	$(BACNET_CORE)/npdu.c \
@@ -78,16 +79,20 @@ BACNET_SRC = \
 	$(BACNET_CORE)/reject.c \
 	$(BACNET_CORE)/rp.c \
 	$(BACNET_CORE)/rpm.c \
+	$(BACNET_CORE)/special_event.c \
 	$(BACNET_CORE)/timestamp.c \
 	$(BACNET_CORE)/weeklyschedule.c \
-	$(BACNET_CORE)/dailyschedule.c \
-	$(BACNET_CORE)/calendar_entry.c \
-	$(BACNET_CORE)/special_event.c \
-	$(BACNET_CORE)/bactimevalue.c \
 	$(BACNET_CORE)/whohas.c \
 	$(BACNET_CORE)/whois.c \
 	$(BACNET_CORE)/wp.c
 
+DATALINK_SRC = \
+	$(BACNET_CORE)/datalink/cobs.c \
+	$(BACNET_CORE)/datalink/crc.c \
+	$(BACNET_CORE)/datalink/dlmstp.c \
+	$(BACNET_CORE)/datalink/mstp.c \
+	$(BACNET_CORE)/datalink/mstptext.c
+
 STM32_SRC = \
 	$(LIBRARY_STM32)/stm32f4xx_adc.c \
 	$(LIBRARY_STM32)/stm32f4xx_can.c \
@@ -118,6 +123,7 @@ STM32_SRC = \
 CSRC = $(PLATFORM_SRC)
 CSRC += $(BASIC_SRC)
 CSRC += $(BACNET_SRC)
+CSRC += $(DATALINK_SRC)
 CSRC += $(STM32_SRC)
 
 ASRC = $(LIBRARY_CMSIS)/gcc_ride7/startup_stm32f4xx.s
@@ -173,6 +179,8 @@ CFLAGS += $(BACNET_FLAGS)
 CFLAGS += $(INCLUDES)
 # enable garbage collection of unused functions and data to shrink binary
 CFLAGS += -ffunction-sections -fdata-sections -fno-strict-aliasing
+# enable stack usage tracking
+CFLAGS += -fstack-usage
 # function calls will not use any special __builtin_xx to allow debug/linking
 CFLAGS += -fno-builtin
 # place uninitialized global variables in the data section of the object file.
@@ -211,6 +219,7 @@ ODFLAGS	= -x --syms
 
 AOBJ = $(ASRC:.s=.o)
 COBJ = $(CSRC:.c=.o)
+CSTACK = $(CSRC:.c=.su)
 
 all: $(TARGET).bin $(TARGET).hex $(TARGET).elf
 	$(OBJDUMP) $(ODFLAGS) $(TARGET).elf > $(TARGET).dmp
@@ -225,9 +234,22 @@ $(TARGET).hex:  $(TARGET).elf
 $(TARGET).elf: $(COBJ) $(AOBJ) Makefile
 	$(CC) $(CFLAGS) $(AOBJ) $(COBJ) $(LDFLAGS) -o $@
 
-: ram-usage
+.PHONY: ram-usage
 ram-usage:
-	$(NM) -t d -S --size-sort $(TARGET).elf 1> $(TARGET).nm
+	@$(NM) -t d -S --size-sort $(TARGET).elf 1> $(TARGET).nm
+	@echo "=ADDRESS= ==SIZE== = ==VARIABLE NAME=="
+	@tail $(TARGET).nm
+	
+.PHONY: cstack
+cstack:
+	@$(CSTACK_TOOL) $(COBJ) 2> /dev/null 1> $(TARGET).su
+	@head -n 25 $(TARGET).su
+
+.PHONY: memap
+memap:
+	# memmap needs Python and PrettyPrint and IntelHex
+	# sudo apt install python3-prettytable python3-intelhex
+	$(MEMAP_TOOL) -t GCC_ARM $(TARGET).map
 
 # GDB using st-util (GDB server for ST Link)
 GDB_PORT = 3333
@@ -282,6 +304,7 @@ install: $(TARGET).bin
 .PHONY: clean
 clean:
 	-rm -rf $(COBJ) $(AOBJ) $(COREOBJ)
+	-rm -rf $(CSTACK) $(CEXPAND)
 	-rm -rf $(TARGET).elf $(TARGET).bin $(TARGET).dmp $(TARGET).map
 	-rm -rf $(TARGET).su $(TARGET).nm
 	-rm -rf *.lst

ports/stm32f4xx/STM32F4xx_StdPeriph_Driver/src/syscalls.c

@@ -20,8 +20,6 @@
 extern int errno;
 extern int __io_putchar(int ch);
 
-register char * stack_ptr asm("sp");
-
 char *__env[1] = { 0 };
 char **environ = __env;
 
@@ -61,6 +59,7 @@ int _write(int file, char *ptr, int len)
 
 caddr_t _sbrk(int incr)
 {
+	register char * stack_ptr asm("sp");
 	extern char end asm("end");
 	static char *heap_end;
 	char *prev_heap_end;

ports/stm32f4xx/device.c

@@ -45,10 +45,6 @@
 #endif
 #include "bacnet/basic/object/device.h"
 
-/* forward prototype */
-int Device_Read_Property_Local(BACNET_READ_PROPERTY_DATA *rpdata);
-bool Device_Write_Property_Local(BACNET_WRITE_PROPERTY_DATA *wp_data);
-
 static struct my_object_functions {
     BACNET_OBJECT_TYPE Object_Type;
     object_init_function Object_Init;