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