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 45set -eu 46 47if [ $# -ne 0 ] && [ "$1" = "--help" ]; then 48 cat <<EOF 49$0 [-v] 50This script confirms that the naming of all symbols and identifiers in mbed 51TLS are consistent with the house style and are also self-consistent. 52 53 -v If the script fails unexpectedly, print a command trace. 54EOF 55 exit 56fi 57 58trace= 59if [ $# -ne 0 ] && [ "$1" = "-v" ]; then 60 shift 61 trace='-x' 62 exec 2>check-names.err 63 trap 'echo "FAILED UNEXPECTEDLY, status=$?"; 64 cat check-names.err' EXIT 65 set -x 66fi 67 68printf "Analysing source code...\n" 69 70sh $trace tests/scripts/list-macros.sh 71tests/scripts/list-enum-consts.pl 72sh $trace tests/scripts/list-identifiers.sh 73sh $trace tests/scripts/list-symbols.sh 74 75FAIL=0 76 77printf "\nExported symbols declared in header: " 78UNDECLARED=$( diff exported-symbols identifiers | sed -n -e 's/^< //p' ) 79if [ "x$UNDECLARED" = "x" ]; then 80 echo "PASS" 81else 82 echo "FAIL" 83 echo "$UNDECLARED" 84 FAIL=1 85fi 86 87diff macros identifiers | sed -n -e 's/< //p' > actual-macros 88 89for THING in actual-macros enum-consts; do 90 printf 'Names of %s: ' "$THING" 91 test -r $THING 92 BAD=$( grep -v '^MBEDTLS_[0-9A-Z_]*[0-9A-Z]$' $THING || true ) 93 if [ "x$BAD" = "x" ]; then 94 echo "PASS" 95 else 96 echo "FAIL" 97 echo "$BAD" 98 FAIL=1 99 fi 100done 101 102for THING in identifiers; do 103 printf 'Names of %s: ' "$THING" 104 test -r $THING 105 BAD=$( grep -v '^mbedtls_[0-9a-z_]*[0-9a-z]$' $THING || true ) 106 if [ "x$BAD" = "x" ]; then 107 echo "PASS" 108 else 109 echo "FAIL" 110 echo "$BAD" 111 FAIL=1 112 fi 113done 114 115printf "Likely typos: " 116sort -u actual-macros enum-consts > _caps 117HEADERS=$( ls include/mbedtls/*.h | egrep -v 'compat-1\.3\.h' ) 118NL=' 119' 120sed -n 's/MBED..._[A-Z0-9_]*/\'"$NL"'&\'"$NL"/gp \ 121 $HEADERS library/*.c \ 122 | grep MBEDTLS | sort -u > _MBEDTLS_XXX 123TYPOS=$( diff _caps _MBEDTLS_XXX | sed -n 's/^> //p' \ 124 | egrep -v 'XXX|__|_$|^MBEDTLS_.*CONFIG_FILE$' || true ) 125rm _MBEDTLS_XXX _caps 126if [ "x$TYPOS" = "x" ]; then 127 echo "PASS" 128else 129 echo "FAIL" 130 echo "$TYPOS" 131 FAIL=1 132fi 133 134if [ -n "$trace" ]; then 135 set +x 136 trap - EXIT 137 rm check-names.err 138fi 139 140printf "\nOverall: " 141if [ "$FAIL" -eq 0 ]; then 142 rm macros actual-macros enum-consts identifiers exported-symbols 143 echo "PASSED" 144 exit 0 145else 146 echo "FAILED" 147 exit 1 148fi 149