Remove PSA status coverage log test

We haven't used this in years. It's obsolete because this functionality
should now be provided by the more general PSA function
wrappers (`PSALoggingWrapper` generator), although that work is unfinished.
It belongs in TF-PSA-Crypto anyway. So remove it, it's one less little
amount of baggage.

Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>

programs/Makefile

@@ -8,9 +8,6 @@ else
 DLOPEN_LDFLAGS ?=
 endif
 
-ifdef RECORD_PSA_STATUS_COVERAGE_LOG
-LOCAL_CFLAGS += -Werror -DRECORD_PSA_STATUS_COVERAGE_LOG
-endif
 DEP=${MBEDLIBS} ${MBEDTLS_TEST_OBJS}
 
 # Only build the dlopen test in shared library builds, and not when building

tests/Makefile

@@ -19,10 +19,6 @@ LOCAL_CFLAGS += $(TF_PSA_CRYPTO_LIBRARY_PRIVATE_INCLUDE)
 # on non-POSIX platforms.
 LOCAL_CFLAGS += -D_POSIX_C_SOURCE=200809L
 
-ifdef RECORD_PSA_STATUS_COVERAGE_LOG
-LOCAL_CFLAGS += -Werror -DRECORD_PSA_STATUS_COVERAGE_LOG
-endif
-
 GENERATED_MBEDTLS_CONFIG_DATA_FILES := $(patsubst tests/%,%,$(shell \
 	$(PYTHON) ../framework/scripts/generate_config_tests.py --list || \
 	echo FAILED \
@@ -110,12 +106,6 @@ include/test/test_keys.h: ../framework/scripts/generate_test_keys.py
 	$(PYTHON) ../framework/scripts/generate_test_keys.py --output $@
 
 TEST_OBJS_DEPS = $(wildcard include/test/*.h include/test/*/*.h)
-ifdef RECORD_PSA_STATUS_COVERAGE_LOG
-# Explicitly depend on this header because on a clean copy of the source tree,
-# it doesn't exist yet and must be generated as part of the build, and
-# therefore the wildcard enumeration above doesn't include it.
-TEST_OBJS_DEPS += ../framework/tests/include/test/instrument_record_status.h
-endif
 TEST_OBJS_DEPS += include/test/test_certs.h include/test/test_keys.h \
                   ../tf-psa-crypto/tests/include/test/test_keys.h
 
@@ -311,9 +301,3 @@ libtestdriver1.a:
 	fi
 	$(MAKE) -C ./libtestdriver1/library CFLAGS="-I../../ $(CFLAGS)" LDFLAGS="$(LDFLAGS)" libmbedcrypto.a
 	cp ./libtestdriver1/library/libmbedcrypto.a ../library/libtestdriver1.a
-
-ifdef RECORD_PSA_STATUS_COVERAGE_LOG
-../framework/tests/include/test/instrument_record_status.h: ../tf-psa-crypto/include/psa/crypto.h Makefile
-	echo "  Gen  $@"
-	sed <../tf-psa-crypto/include/psa/crypto.h >$@ -n 's/^psa_status_t \([A-Za-z0-9_]*\)(.*/#define \1(...) RECORD_STATUS("\1", \1(__VA_ARGS__))/p'
-endif

tests/scripts/components-configuration-crypto.sh

@@ -493,15 +493,6 @@ component_test_everest_curve25519_only () {
     ctest
 }
 
-component_test_psa_collect_statuses () {
-  msg "build+test: psa_collect_statuses" # ~30s
-  scripts/config.py full
-  tests/scripts/psa_collect_statuses.py
-  # Check that psa_crypto_init() succeeded at least once
-  grep -q '^0:psa_crypto_init:' tests/statuses.log
-  rm -f tests/statuses.log
-}
-
 # Check that the specified libraries exist and are empty.
 are_empty_libraries () {
   nm "$@" >/dev/null 2>/dev/null

tests/scripts/psa_collect_statuses.py

@@ -1,130 +0,0 @@
-#!/usr/bin/env python3
-"""Describe the test coverage of PSA functions in terms of return statuses.
-
-1. Build Mbed TLS with -DRECORD_PSA_STATUS_COVERAGE_LOG
-2. Run psa_collect_statuses.py
-
-The output is a series of line of the form "psa_foo PSA_ERROR_XXX". Each
-function/status combination appears only once.
-
-This script must be run from the top of an Mbed TLS source tree.
-The build command is "make -DRECORD_PSA_STATUS_COVERAGE_LOG", which is
-only supported with make (as opposed to CMake or other build methods).
-"""
-
-# Copyright The Mbed TLS Contributors
-# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
-
-import argparse
-import os
-import subprocess
-import sys
-
-DEFAULT_STATUS_LOG_FILE = 'tests/statuses.log'
-DEFAULT_PSA_CONSTANT_NAMES = 'tf-psa-crypto/programs/psa/psa_constant_names'
-
-class Statuses:
-    """Information about observed return statues of API functions."""
-
-    def __init__(self):
-        self.functions = {}
-        self.codes = set()
-        self.status_names = {}
-
-    def collect_log(self, log_file_name):
-        """Read logs from RECORD_PSA_STATUS_COVERAGE_LOG.
-
-        Read logs produced by running Mbed TLS test suites built with
-        -DRECORD_PSA_STATUS_COVERAGE_LOG.
-        """
-        with open(log_file_name) as log:
-            for line in log:
-                value, function, tail = line.split(':', 2)
-                if function not in self.functions:
-                    self.functions[function] = {}
-                fdata = self.functions[function]
-                if value not in self.functions[function]:
-                    fdata[value] = []
-                fdata[value].append(tail)
-                self.codes.add(int(value))
-
-    def get_constant_names(self, psa_constant_names):
-        """Run psa_constant_names to obtain names for observed numerical values."""
-        values = [str(value) for value in self.codes]
-        cmd = [psa_constant_names, 'status'] + values
-        output = subprocess.check_output(cmd).decode('ascii')
-        for value, name in zip(values, output.rstrip().split('\n')):
-            self.status_names[value] = name
-
-    def report(self):
-        """Report observed return values for each function.
-
-        The report is a series of line of the form "psa_foo PSA_ERROR_XXX".
-        """
-        for function in sorted(self.functions.keys()):
-            fdata = self.functions[function]
-            names = [self.status_names[value] for value in fdata.keys()]
-            for name in sorted(names):
-                sys.stdout.write('{} {}\n'.format(function, name))
-
-def collect_status_logs(options):
-    """Build and run unit tests and report observed function return statuses.
-
-    Build Mbed TLS with -DRECORD_PSA_STATUS_COVERAGE_LOG, run the
-    test suites and display information about observed return statuses.
-    """
-    rebuilt = False
-    if not options.use_existing_log and os.path.exists(options.log_file):
-        os.remove(options.log_file)
-    if not os.path.exists(options.log_file):
-        if options.clean_before:
-            subprocess.check_call(['make', '-f', 'scripts/legacy.make', 'clean'],
-                                  cwd='tests',
-                                  stdout=sys.stderr)
-        with open(os.devnull, 'w') as devnull:
-            make_q_ret = subprocess.call(['make', '-f', 'scripts/legacy.make',
-                                          '-q', 'lib', 'tests'],
-                                         stdout=devnull, stderr=devnull)
-        if make_q_ret != 0:
-            subprocess.check_call(['make', '-f', 'scripts/legacy.make',
-                                   'RECORD_PSA_STATUS_COVERAGE_LOG=1'],
-                                  stdout=sys.stderr)
-            rebuilt = True
-        subprocess.check_call(['make', '-f', 'scripts/legacy.make', 'test'],
-                              stdout=sys.stderr)
-    data = Statuses()
-    data.collect_log(options.log_file)
-    data.get_constant_names(options.psa_constant_names)
-    if rebuilt and options.clean_after:
-        subprocess.check_call(['make', '-f', 'scripts/legacy.make', 'clean'],
-                              cwd='tests',
-                              stdout=sys.stderr)
-    return data
-
-def main():
-    parser = argparse.ArgumentParser(description=globals()['__doc__'])
-    parser.add_argument('--clean-after',
-                        action='store_true',
-                        help='Run "make clean" after rebuilding')
-    parser.add_argument('--clean-before',
-                        action='store_true',
-                        help='Run "make clean" before regenerating the log file)')
-    parser.add_argument('--log-file', metavar='FILE',
-                        default=DEFAULT_STATUS_LOG_FILE,
-                        help='Log file location (default: {})'.format(
-                            DEFAULT_STATUS_LOG_FILE
-                        ))
-    parser.add_argument('--psa-constant-names', metavar='PROGRAM',
-                        default=DEFAULT_PSA_CONSTANT_NAMES,
-                        help='Path to psa_constant_names (default: {})'.format(
-                            DEFAULT_PSA_CONSTANT_NAMES
-                        ))
-    parser.add_argument('--use-existing-log', '-e',
-                        action='store_true',
-                        help='Don\'t regenerate the log file if it exists')
-    options = parser.parse_args()
-    data = collect_status_logs(options)
-    data.report()
-
-if __name__ == '__main__':
-    main()