blob: 9ab40aacd3f57ddb6e2a0814bf1e5b5e16461a2b [file] [log] [blame]
Hanno Becker43fa8d62019-03-18 17:12:05 +00001#!/bin/sh
2
3# baremetal.sh
4#
5# This file is part of mbed TLS (https://tls.mbed.org)
6#
7# Copyright (c) 2019, ARM Limited, All Rights Reserved
8#
9# Purpose
10#
11# * Create a baremetal library-only build (omitting the tests and
12# example programs, which have stronger configuration requirements)
13# for a Cortex-M target in a minimal configuration, and generate
14# code-size statistics.
15# By default, the script uses configs/baremetal.h and targets Cortex-M0+,
16# and outputs the code-size statistics as `rom.COMMIT_HASH`.
17#
18# * Create a 32-bit host-build of library, tests and example programs
19# in a 'baremetal' base configuration minimally modified to allow
20# running tests and example programs, and obtain heap usage statistics
21# of a test run of ssl_client2 and ssl_server2. This can be used as
22# an estimate for heap usage of 32-bit baremetal applications using Mbed TLS.
23#
24# By default, the script uses configs/baremetal.h as the base configuration
25# modified by configs/baremetal_test.h, and emits the heap usage statistics
26# as `massif.COMMIT_HASH`.
27#
28
29set -eu
30
31if [ -d include/mbedtls ]; then :; else
32 echo "$0: must be run from root" >&2
33 exit 1
34fi
35
36if grep -i cmake Makefile >/dev/null; then
37 echo "$0: not compatible with cmake" >&2
38 exit 1
39fi
40
41# The 'baremetal' configuration to test
42: ${BAREMETAL_CONFIG:=./configs/baremetal.h}
43CFLAGS_CONFIG="-DMBEDTLS_CONFIG_FILE='\"../$BAREMETAL_CONFIG\"'"
44
45# The modifications to the 'baremetal' configuration which allows
46# tests and example programs to build and execute.
47: ${BAREMETAL_USER_CONFIG:=./configs/baremetal_test.h}
48CFLAGS_USER_CONFIG="-DMBEDTLS_USER_CONFIG_FILE='\"../$BAREMETAL_USER_CONFIG\"'"
49
50: ${ARMC5_BIN_DIR:=""}
51: ${ARMC6_BIN_DIR:=""}
52if [ -n "$ARMC5_BIN_DIR" ]; then
53 ARMC5_BIN_DIR="$ARMC5_BIN_DIR/"
54fi
55
56if [ -n "$ARMC6_BIN_DIR" ]; then
57 ARMC6_BIN_DIR="$ARMC6_BIN_DIR/"
58fi
59
60: ${NAME:=$(git rev-parse HEAD)}
61: ${GCC_CC:=arm-none-eabi-gcc}
62: ${GCC_AR:=arm-none-eabi-ar}
63: ${ARMC6_CC:="${ARMC6_BIN_DIR}armclang"}
64: ${ARMC6_AR:="${ARMC6_BIN_DIR}armar"}
65: ${ARMC5_CC:="${ARMC5_BIN_DIR}armcc"}
66: ${ARMC5_AR:="${ARMC5_BIN_DIR}armar"}
67
68date=$( date +%Y-%m-%d-%H-%M-%S )
69
70baremetal_build_gcc()
71{
72 echo "Cleanup..."
73 make clean
74
75 echo "Create 32-bit library-only baremetal build (GCC, config: $BAREMETAL_CONFIG)"
76 gcc_ver=$($GCC_CC --version | head -n 1 | sed -n 's/^.*\([0-9]\.[0-9]\.[0-9]\).*$/\1/p')
77
78 CFLAGS_BAREMETAL="-Os -mthumb -mcpu=cortex-m0plus"
79 CFLAGS="$CFLAGS_BAREMETAL $CFLAGS_CONFIG"
80
81 $GCC_CC --version
82
83 echo "GCC version: $gcc_ver"
84 echo "Flags: $CFLAGS_BAREMETAL"
85 make CC=$GCC_CC AR=$GCC_AR CFLAGS="$CFLAGS" lib -j > /dev/null
86
87 ROM_OUT_FILE="rom_files__${date}__${NAME}__gcc_${gcc_ver}"
88 ROM_OUT_SYMS="rom_syms__${date}__${NAME}__gcc_${gcc_ver}"
89 echo "Generate file statistics..."
Hanno Beckerb4d8fab2019-04-03 13:41:28 +010090 ./scripts/extract_codesize_stats.sh --info "gcc_${gcc_ver}" --name $NAME --files > $ROM_OUT_FILE
Hanno Becker43fa8d62019-03-18 17:12:05 +000091 echo "Generate symbol statistics..."
Hanno Beckerb4d8fab2019-04-03 13:41:28 +010092 ./scripts/extract_codesize_stats.sh --info "gcc_${gcc_ver}" --name $NAME --syms > $ROM_OUT_SYMS
Hanno Becker43fa8d62019-03-18 17:12:05 +000093
94 echo "ROM statistics written to:"
95 echo "* $ROM_OUT_FILE"
96 echo "* $ROM_OUT_SYMS"
97}
98
99baremetal_build_armc5()
100{
101 echo "Cleanup..."
102 make clean
103
104 echo "Create 32-bit library-only baremetal build (ARMC5, Config: $BAREMETAL_CONFIG)"
105 armc5_ver=$($ARMC5_CC | sed -n 's/.*ARM Compiler \([^ ]*\)$/\1/p')
106
107 CFLAGS_BAREMETAL="-Ospace --thumb --cpu Cortex-m0plus"
108 CFLAGS="$CFLAGS_BAREMETAL $CFLAGS_CONFIG"
109 WARNING_CFLAGS="--strict --c99"
110
111 echo "ARMC5 version: $armc5_ver"
112 echo "Flags: $WARNING_CFLAGS $CFLAGS_BAREMETAL"
113 make WARNING_CFLAGS="$WARNING_CFLAGS" CC=$ARMC5_CC AR=$ARMC5_AR CFLAGS="$CFLAGS" lib -j > /dev/null
114
115 ROM_OUT_FILE="rom_files__${date}__${NAME}__armc5_${armc5_ver}"
116 ROM_OUT_SYMS="rom_syms__${date}__${NAME}__armc5_${armc5_ver}"
117 echo "Generate file statistics..."
Hanno Beckerb4d8fab2019-04-03 13:41:28 +0100118 ./scripts/extract_codesize_stats.sh --info "armc5_${armc5_ver}" --name $NAME --files > $ROM_OUT_FILE
Hanno Becker43fa8d62019-03-18 17:12:05 +0000119 echo "Generate symbol statistics..."
Hanno Beckerb4d8fab2019-04-03 13:41:28 +0100120 ./scripts/extract_codesize_stats.sh --info "armc5_${armc5_ver}" --name $NAME --syms > $ROM_OUT_SYMS
Hanno Becker43fa8d62019-03-18 17:12:05 +0000121
122 echo "ROM statistics written to:"
123 echo "* $ROM_OUT_FILE"
124 echo "* $ROM_OUT_SYMS"
125}
126
127baremetal_build_armc6()
128{
129 echo "Cleanup..."
130 make clean
131
132 echo "Create 32-bit library-only baremetal build (ARMC6, Config: $BAREMETAL_CONFIG)"
133 armc6_ver=$($ARMC6_CC --version | sed -n 's/.*ARM Compiler \([^ ]*\)$/\1/p')
134
135 CFLAGS_BAREMETAL="-Os --target=arm-arm-none-eabi -mthumb -mcpu=cortex-m0plus"
136 CFLAGS="$CFLAGS_BAREMETAL $CFLAGS_CONFIG"
137 WARNING_CFLAGS="-xc -std=c99"
138
139 echo "ARMC6 version: $armc6_ver"
140 echo "Flags: $WARNING_CFLAGS $CFLAGS_BAREMETAL"
141 make WARNING_CFLAGS="$WARNING_CFLAGS" CC=$ARMC6_CC AR=$ARMC6_AR CFLAGS="$CFLAGS" lib -j > /dev/null
142
143 ROM_OUT_FILE="rom_files__${date}__${NAME}__armc6_${armc6_ver}"
144 ROM_OUT_SYMS="rom_syms__${date}__${NAME}__armc6_${armc6_ver}"
145 echo "Generate file statistics..."
Hanno Beckerb4d8fab2019-04-03 13:41:28 +0100146 ./scripts/extract_codesize_stats.sh --info "armc6_${armc6_ver}" --name $NAME --files > $ROM_OUT_FILE
Hanno Becker43fa8d62019-03-18 17:12:05 +0000147 echo "Generate symbol statistics..."
Hanno Beckerb4d8fab2019-04-03 13:41:28 +0100148 ./scripts/extract_codesize_stats.sh --info "armc6_${armc6_ver}" --name $NAME --syms > $ROM_OUT_SYMS
Hanno Becker43fa8d62019-03-18 17:12:05 +0000149
150 echo "ROM statistics written to:"
151 echo "* $ROM_OUT_FILE"
152 echo "* $ROM_OUT_SYMS"
153}
154
155# 32-bit host-build of library, tests and example programs,
156# + heap usage measurements.
157baremetal_ram_build() {
Hanno Beckerc7c20812019-04-03 11:55:57 +0100158 : ${BASE_CFLAGS:="-g -m32 -fstack-usage"}
Hanno Becker43fa8d62019-03-18 17:12:05 +0000159 echo "Create 32-bit host-build (Config: $BAREMETAL_CONFIG + $BAREMETAL_USER_CONFIG)"
160
161 echo "Cleanup..."
162 make clean
163
164 CFLAGS="$BASE_CFLAGS $CFLAGS_CONFIG $CFLAGS_USER_CONFIG"
165
166 echo "Modifications: $BAREMETAL_USER_CONFIG"
167 cat $BAREMETAL_USER_CONFIG | grep "^#define" | awk '{print "* " $0 }'
168
169 echo "Build (flags: $CFLAGS)..."
170 make CFLAGS="$CFLAGS" -j > /dev/null
171 echo ""
172}
173
Hanno Becker5541e4e2019-04-03 11:31:43 +0100174# usage:
175# - `baremetal_ram_heap 0` for heap usage only
176# - `baremetal_ram_heap 1` for heap and stack usage
Hanno Becker43fa8d62019-03-18 17:12:05 +0000177baremetal_ram_heap() {
178
179 : ${CLI:=./programs/ssl/ssl_client2}
180 : ${CLI_PARAMS:="dtls=1"}
181 : ${SRV:=./programs/ssl/ssl_server2}
182 : ${SRV_PARAMS:="dtls=1 renegotiation=1 auth_mode=required"}
183 : ${VALGRIND:=valgrind}
184 : ${VALGRIND_MASSIF_PARAMS="--time-unit=B --threshold=0.01 --detailed-freq=1"}
185
186 if [ $1 -eq 1 ]; then
187 RAM_HEAP_OUT="ram_heap_stack__${date}__$NAME"
188 VALGRIND_MASSIF_PARAMS="--stacks=yes $VALGRIND_MASSIF_PARAMS"
189 else
190 RAM_HEAP_OUT="ram_heap__${date}__$NAME"
191 fi
192
193 SRV_CMD="$SRV server_addr=127.0.0.1 server_port=4433 debug_level=4 $SRV_PARAMS"
194 CLI_CMD="$CLI server_addr=127.0.0.1 server_port=4433 $CLI_PARAMS"
195
196 # Piece together valgrind cmd line
197 VALGRIND_BASE="$VALGRIND --tool=massif $VALGRIND_MASSIF_PARAMS"
198
199 FUNC_IGNORE=""
Hanno Becker43fa8d62019-03-18 17:12:05 +0000200 FUNC_IGNORE="__fopen_internal $FUNC_IGNORE"
201 FUNC_IGNORE="_IO_file_doallocate $FUNC_IGNORE"
202 FUNC_IGNORE="strdup $FUNC_IGNORE"
203 FUNC_IGNORE="__tzstring_len $FUNC_IGNORE"
204 FUNC_IGNORE="__tzfile_read $FUNC_IGNORE"
205
206 VALGRIND_IGNORE=""
207 for func in $FUNC_IGNORE; do
208 echo "* Valgrind ignore: $func"
209 VALGRIND_IGNORE="--ignore-fn=$func $VALGRIND_IGNORE"
210 done
211
212 VALGRIND_CMD="$VALGRIND_BASE $VALGRIND_IGNORE --massif-out-file=${RAM_HEAP_OUT} -- $CLI_CMD"
213
214 $SRV_CMD > /dev/null 2>&1 &
215 SRV_PID=$!
216 echo "Server started, PID $SRV_PID"
217
218 $VALGRIND_CMD > /dev/null 2>&1 &
219 VAL_PID=$!
220 echo "Valgrind massif started, PID $VAL_PID"
221
222 wait $VAL_PID
223 echo "Valgrind done, killing server"
224 kill $SRV_PID
225 echo "Done"
226
227 if `cat $RAM_HEAP_OUT | grep '???'` >/dev/null 2>&1; then
228 echo "Warning: Unrecognized symbols in massif output file - does your version of `valgrind` support 32-bit builds?"
229 fi
230
231 printf "Max heap usage: "
232 ./scripts/massif_max.pl $RAM_HEAP_OUT
233 echo "SUCCESS - Heap usage statistics written to: $RAM_HEAP_OUT\n"
234}
235
236baremetal_ram_stack() {
237 : ${CLI:=./programs/ssl/ssl_client2}
238 : ${CLI_PARAMS:="dtls=1"}
239 : ${SRV:=./programs/ssl/ssl_server2}
240 : ${SRV_PARAMS:="dtls=1 renegotiation=1 auth_mode=required"}
241 : ${VALGRIND:=valgrind}
242 : ${VALGRIND_CALLGRIND_PARAMS:="--separate-callers=100"}
243
Hanno Beckerc7c20812019-04-03 11:55:57 +0100244 RAM_CALLGRIND_OUT="ram_callgrind__${date}__$NAME"
Hanno Becker43fa8d62019-03-18 17:12:05 +0000245 RAM_STACK_OUT="ram_stack__${date}__$NAME"
246
247 SRV_CMD="$SRV server_addr=127.0.0.1 server_port=4433 debug_level=4 $SRV_PARAMS"
248 CLI_CMD="$CLI server_addr=127.0.0.1 server_port=4433 $CLI_PARAMS"
249
250 VALGRIND_BASE="$VALGRIND --tool=callgrind $VALGRIND_CALLGRIND_PARAMS"
Hanno Beckerc7c20812019-04-03 11:55:57 +0100251 VALGRIND_CMD="$VALGRIND_BASE --callgrind-out-file=${RAM_CALLGRIND_OUT} $CLI_CMD"
Hanno Becker43fa8d62019-03-18 17:12:05 +0000252
253 $SRV_CMD > /dev/null 2>&1 &
254 SRV_PID=$!
255 echo "Server started, PID $SRV_PID"
256
257 $VALGRIND_CMD > /dev/null 2>&1 &
258 VAL_PID=$!
259 echo "Valgrind callgrind started, PID $VAL_PID"
260
261 wait $VAL_PID
262 echo "Valgrind done, killing server"
263 kill $SRV_PID
264 echo "Done"
265
Hanno Becker13737242019-04-03 12:17:20 +0100266 # Extract callgraphs from source files directly
Hanno Becker7f6e8082019-04-03 13:48:09 +0100267 RAM_CALLGRAPH_OUT=""
Hanno Becker13737242019-04-03 12:17:20 +0100268 if [ -x "$(command -v cflow)" ]; then
269 RAM_CALLGRAPH_OUT="ram_cflow__${date}__$NAME"
270 cflow library/*.c > $RAM_CALLGRAPH_OUT 2> /dev/null
271 fi
272
Hanno Beckerc7c20812019-04-03 11:55:57 +0100273 # Merge stack usage files
274 cat library/*.su > ${RAM_STACK_OUT}_unsorted
275 sort -r -k2 -n ${RAM_STACK_OUT}_unsorted > $RAM_STACK_OUT
276 rm ${RAM_STACK_OUT}_unsorted
277
Hanno Becker13737242019-04-03 12:17:20 +0100278 echo "SUCCESS"
279 echo "* Stack usage statistics written to $RAM_STACK_OUT"
280 echo "* Callgrind output written to $RAM_CALLGRIND_OUT"
281 if [ -n $RAM_CALLGRAPH_OUT ]; then
282 echo "* Static call graph written to $RAM_CALLGRAPH_OUT"
283 fi
Hanno Becker43fa8d62019-03-18 17:12:05 +0000284}
285
286show_usage() {
Hanno Becker7a097852019-04-03 11:55:40 +0100287 echo "Usage: $0 [--rom [--gcc] [--armc5] [--armc6]|--ram [--stack] [--heap]]"
Hanno Becker43fa8d62019-03-18 17:12:05 +0000288}
289
290test_build=0
291raw_build=0
292
293build_gcc=0
294build_armc5=0
295build_armc6=0
296
297measure_heap=0
298measure_stack=0
299
300while [ $# -gt 0 ]; do
301 case "$1" in
302 --gcc) build_gcc=1;;
303 --armc5) build_armc5=1;;
304 --armc6) build_armc6=1;;
305 --ram) test_build=1;;
306 --rom) raw_build=1;;
307 --heap) measure_heap=1;;
308 --stack) measure_stack=1;;
309 -*)
310 echo >&2 "Unknown option: $1"
311 show_usage
312 exit 1
313 ;;
314 esac
315 shift
316done
317
318if [ "$test_build" -eq 0 ] &&
319 [ "$raw_build" -eq 0 ]; then
320 echo "Need to set either --ram or --rom"
321 show_usage
322 exit 1
323fi
324
325if [ "$test_build" -eq 1 ]; then
326
327 if [ "$measure_heap" -eq 0 ] &&
328 [ "$measure_stack" -eq 0 ]; then
329 echo "Need to set either --heap or --stack with --ram"
330 show_usage
331 exit 1
332 fi
333
334 baremetal_ram_build
335
336 if [ "$measure_heap" -eq 1 ]; then
337 baremetal_ram_heap 0
338 baremetal_ram_heap 1
339 fi
340
341 if [ "$measure_stack" -eq 1 ]; then
342 baremetal_ram_stack
343 fi
344
345fi
346
347if [ "$raw_build" -eq 1 ]; then
348
349 if [ "$build_gcc" -eq 0 ] &&
350 [ "$build_armc5" -eq 0 ] &&
351 [ "$build_armc6" -eq 0 ]; then
352 echo "Need to set either --gcc, --armc5 or --armc6 with --rom"
353 show_usage
354 exit 1
355 fi
356
357 if [ "$build_gcc" -eq 1 ]; then
358 baremetal_build_gcc
359 fi
360 if [ "$build_armc5" -eq 1 ]; then
361 baremetal_build_armc5
362 fi
363 if [ "$build_armc6" -eq 1 ]; then
364 baremetal_build_armc6
365 fi
366fi