1#!/bin/sh
2#
3# Copyright The Mbed TLS Contributors
4# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
5#
6# This file is provided under the Apache License 2.0, or the
7# GNU General Public License v2.0 or later.
8#
9# **********
10# Apache License 2.0:
11#
12# Licensed under the Apache License, Version 2.0 (the "License"); you may
13# not use this file except in compliance with the License.
14# You may obtain a copy of the License at
15#
16# http://www.apache.org/licenses/LICENSE-2.0
17#
18# Unless required by applicable law or agreed to in writing, software
19# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
20# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
21# See the License for the specific language governing permissions and
22# limitations under the License.
23#
24# **********
25#
26# **********
27# GNU General Public License v2.0 or later:
28#
29# This program is free software; you can redistribute it and/or modify
30# it under the terms of the GNU General Public License as published by
31# the Free Software Foundation; either version 2 of the License, or
32# (at your option) any later version.
33#
34# This program is distributed in the hope that it will be useful,
35# but WITHOUT ANY WARRANTY; without even the implied warranty of
36# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
37# GNU General Public License for more details.
38#
39# You should have received a copy of the GNU General Public License along
40# with this program; if not, write to the Free Software Foundation, Inc.,
41# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
42#
43# **********
44#
45# Purpose
46#
47# This script determines ROM size (or code size) for the standard mbed TLS
48# configurations, when built for a Cortex M3/M4 target.
49#
50# Configurations included:
51#   default    include/mbedtls/config.h
52#   thread     configs/config-thread.h
53#   suite-b    configs/config-suite-b.h
54#   psk        configs/config-ccm-psk-tls1_2.h
55#
56# Usage: footprint.sh
57#
58set -eu
59
60CONFIG_H='include/mbedtls/config.h'
61
62if [ -r $CONFIG_H ]; then :; else
63    echo "$CONFIG_H not found" >&2
64    echo "This script needs to be run from the root of" >&2
65    echo "a git checkout or uncompressed tarball" >&2
66    exit 1
67fi
68
69if grep -i cmake Makefile >/dev/null; then
70    echo "Not compatible with CMake" >&2
71    exit 1
72fi
73
74if which arm-none-eabi-gcc >/dev/null 2>&1; then :; else
75    echo "You need the ARM-GCC toolchain in your path" >&2
76    echo "See https://launchpad.net/gcc-arm-embedded/" >&2
77    exit 1
78fi
79
80ARMGCC_FLAGS='-Os -march=armv7-m -mthumb'
81OUTFILE='00-footprint-summary.txt'
82
83log()
84{
85    echo "$@"
86    echo "$@" >> "$OUTFILE"
87}
88
89doit()
90{
91    NAME="$1"
92    FILE="$2"
93
94    log ""
95    log "$NAME ($FILE):"
96
97    cp $CONFIG_H ${CONFIG_H}.bak
98    if [ "$FILE" != $CONFIG_H ]; then
99        cp "$FILE"  $CONFIG_H
100    fi
101
102    {
103        scripts/config.pl unset MBEDTLS_NET_C || true
104        scripts/config.pl unset MBEDTLS_TIMING_C || true
105        scripts/config.pl unset MBEDTLS_FS_IO || true
106        scripts/config.pl --force set MBEDTLS_NO_PLATFORM_ENTROPY || true
107    } >/dev/null 2>&1
108
109    make clean >/dev/null
110    CC=arm-none-eabi-gcc AR=arm-none-eabi-ar LD=arm-none-eabi-ld \
111        CFLAGS="$ARMGCC_FLAGS" make lib >/dev/null
112
113    OUT="size-${NAME}.txt"
114    arm-none-eabi-size -t library/libmbed*.a > "$OUT"
115    log "$( head -n1 "$OUT" )"
116    log "$( tail -n1 "$OUT" )"
117
118    cp ${CONFIG_H}.bak $CONFIG_H
119}
120
121# truncate the file just this time
122echo "(generated by $0)" > "$OUTFILE"
123echo "" >> "$OUTFILE"
124
125log "Footprint of standard configurations (minus net_sockets.c, timing.c, fs_io)"
126log "for bare-metal ARM Cortex-M3/M4 microcontrollers."
127
128VERSION_H="include/mbedtls/version.h"
129MBEDTLS_VERSION=$( sed -n 's/.*VERSION_STRING *"\(.*\)"/\1/p' $VERSION_H )
130if git rev-parse HEAD >/dev/null; then
131    GIT_HEAD=$( git rev-parse HEAD | head -c 10 )
132    GIT_VERSION=" (git head: $GIT_HEAD)"
133else
134    GIT_VERSION=""
135fi
136
137log ""
138log "mbed TLS $MBEDTLS_VERSION$GIT_VERSION"
139log "$( arm-none-eabi-gcc --version | head -n1 )"
140log "CFLAGS=$ARMGCC_FLAGS"
141
142doit default    include/mbedtls/config.h
143doit thread     configs/config-thread.h
144doit suite-b    configs/config-suite-b.h
145doit psk        configs/config-ccm-psk-tls1_2.h
146
147zip mbedtls-footprint.zip "$OUTFILE" size-*.txt >/dev/null
148