Complete the move of TF-PSA-Crypto driver wrappers to dispatch/ directory

CMakeLists.txt

@@ -67,6 +67,9 @@ endif()
 # Set the project and framework root directory.
 set(MBEDTLS_DIR ${CMAKE_CURRENT_SOURCE_DIR})
 set(MBEDTLS_FRAMEWORK_DIR ${CMAKE_CURRENT_SOURCE_DIR}/framework)
+if(NOT DEFINED TF_PSA_CRYPTO_DISPATCH_DIR)
+    set(TF_PSA_CRYPTO_DISPATCH_DIR ${CMAKE_CURRENT_SOURCE_DIR}/tf-psa-crypto/dispatch)
+endif()
 
 option(ENABLE_PROGRAMS "Build Mbed TLS programs." ON)
 
@@ -380,7 +383,7 @@ endforeach(target)
 #
 set(TF_PSA_CRYPTO_PRIVATE_INCLUDE_DIRS
         ${CMAKE_CURRENT_SOURCE_DIR}/tf-psa-crypto/core
-        ${CMAKE_CURRENT_SOURCE_DIR}/tf-psa-crypto/dispatch
+        ${TF_PSA_CRYPTO_DISPATCH_DIR}
         ${CMAKE_CURRENT_SOURCE_DIR}/tf-psa-crypto/drivers/builtin/src
         ${CMAKE_CURRENT_SOURCE_DIR}/tf-psa-crypto/extras
         ${CMAKE_CURRENT_SOURCE_DIR}/tf-psa-crypto/platform
@@ -434,6 +437,7 @@ if(ENABLE_TESTING OR ENABLE_PROGRAMS)
                 tests/include
                 include
                 tf-psa-crypto/include
+                ${TF_PSA_CRYPTO_DISPATCH_DIR}/include
                 tf-psa-crypto/drivers/builtin/include
                 tf-psa-crypto/drivers/everest/include
                 tf-psa-crypto/drivers/pqcp/include
@@ -471,6 +475,7 @@ if(ENABLE_TESTING OR ENABLE_PROGRAMS)
                 tests/include
                 include
                 tf-psa-crypto/include
+                ${TF_PSA_CRYPTO_DISPATCH_DIR}/include
                 tf-psa-crypto/drivers/builtin/include
                 library
                 tf-psa-crypto/drivers/everest/include

doxygen/mbedtls.doxyfile

@@ -6,7 +6,7 @@ EXTRACT_ALL            = YES
 EXTRACT_PRIVATE        = YES
 EXTRACT_STATIC         = YES
 CASE_SENSE_NAMES       = NO
-INPUT                  = ../include input ../tf-psa-crypto/include ../tests/include/alt-dummy
+INPUT                  = ../include input ../tf-psa-crypto/include ../tf-psa-crypto/dispatch/include ../tests/include/alt-dummy
 FILE_PATTERNS          = *.h
 EXCLUDE                = ../tf-psa-crypto/include/mbedtls/private
 RECURSIVE              = YES
@@ -22,7 +22,7 @@ GENERATE_LATEX         = NO
 GENERATE_XML           = YES
 MACRO_EXPANSION        = YES
 EXPAND_ONLY_PREDEF     = YES
-INCLUDE_PATH           = ../include ../tf-psa-crypto/include ../tf-psa-crypto/drivers/builtin/include
+INCLUDE_PATH           = ../include ../tf-psa-crypto/include ../tf-psa-crypto/dispatch/include ../tf-psa-crypto/drivers/builtin/include
 EXPAND_AS_DEFINED      = MBEDTLS_PRIVATE
 CLASS_DIAGRAMS         = NO
 HAVE_DOT               = YES

library/CMakeLists.txt

@@ -234,13 +234,15 @@ endif(USE_SHARED_MBEDTLS_LIBRARY)
 
 foreach(target IN LISTS target_libraries)
     add_library(MbedTLS::${target} ALIAS ${target})  # add_subdirectory support
-    # Include public header files from /include, /tf-psa-crypto/include/ and
-    # tf-psa-crypto/drivers/builtin/include/. Include private header files
-    # from /library and ${TF_PSA_CRYPTO_PRIVATE_INCLUDE_DIRS}.
+    # Include public header files from /include, /tf-psa-crypto/include,
+    # /tf-psa-crypto/dispatch/include and /tf-psa-crypto/drivers/builtin/include.
+    # Include private header files from /library and
+    # ${TF_PSA_CRYPTO_PRIVATE_INCLUDE_DIRS}.
     target_include_directories(${target}
         PUBLIC $<BUILD_INTERFACE:${MBEDTLS_DIR}/include/>
                $<BUILD_INTERFACE:${MBEDTLS_DIR}/tf-psa-crypto/include/>
                $<BUILD_INTERFACE:${MBEDTLS_DIR}/tf-psa-crypto/drivers/builtin/include/>
+               $<BUILD_INTERFACE:${TF_PSA_CRYPTO_DISPATCH_DIR}/include/>
                $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>
         PRIVATE ${MBEDTLS_DIR}/library/
                 ${TF_PSA_CRYPTO_PRIVATE_INCLUDE_DIRS}

programs/test/CMakeLists.txt

@@ -28,7 +28,8 @@ if(TEST_CPP)
     target_include_directories(cpp_dummy_build
         PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/../../include
         PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/../../tf-psa-crypto/include
-        PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/../../tf-psa-crypto/drivers/builtin/include)
+        PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/../../tf-psa-crypto/drivers/builtin/include
+        PRIVATE ${TF_PSA_CRYPTO_DISPATCH_DIR}/include)
     target_link_libraries(cpp_dummy_build ${tfpsacrypto_target} ${CMAKE_THREAD_LIBS_INIT})
 endif()
 
@@ -39,7 +40,8 @@ if(USE_SHARED_MBEDTLS_LIBRARY AND
     target_include_directories(dlopen
         PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/../../include
         PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/../../tf-psa-crypto/include
-        PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/../../tf-psa-crypto/drivers/builtin/include)
+        PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/../../tf-psa-crypto/drivers/builtin/include
+        PRIVATE ${TF_PSA_CRYPTO_DISPATCH_DIR}/include)
     target_link_libraries(dlopen ${CMAKE_DL_LIBS})
 endif()
 

programs/test/cmake_subproject_custom_dispatch/.gitignore

@@ -0,0 +1,5 @@
+build
+custom/include
+custom/psa_crypto_driver_wrappers*
+Makefile
+cmake_subproject_custom_dispatch

programs/test/cmake_subproject_custom_dispatch/CMakeLists.txt

@@ -0,0 +1,22 @@
+cmake_minimum_required(VERSION 3.5.1)
+
+# Test the target renaming support by adding a prefix to the targets built
+set(MBEDTLS_TARGET_PREFIX subproject_test_)
+
+# We use the parent Mbed TLS directory as the MBEDTLS_DIR for this test. Other
+# projects that use Mbed TLS as a subproject are likely to add by their own
+# relative paths.
+set(MBEDTLS_DIR ../../../)
+# Use the local `custom` directory for the crypto dispatch implementation
+set(TF_PSA_CRYPTO_DISPATCH_DIR ${CMAKE_CURRENT_LIST_DIR}/custom)
+
+# Add Mbed TLS as a subdirectory.
+add_subdirectory(${MBEDTLS_DIR} build)
+
+add_executable(cmake_subproject_custom_dispatch cmake_subproject_dispatch.c)
+target_link_libraries(cmake_subproject_custom_dispatch
+    subproject_test_mbedtls
+    subproject_test_mbedx509
+    subproject_test_tfpsacrypto
+    ${CMAKE_THREAD_LIBS_INIT}
+)

programs/test/cmake_subproject_custom_dispatch/cmake_subproject_dispatch.c

@@ -0,0 +1,30 @@
+/*
+ *  Simple program to test that CMake builds with Mbed TLS as a subdirectory
+ *  work correctly.
+ *
+ *  Copyright The Mbed TLS Contributors
+ *  SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
+ */
+
+#include "mbedtls/build_info.h"
+
+#include "mbedtls/platform.h"
+
+#include "mbedtls/version.h"
+
+/* Verify that the dispatch implementation is the custom one by linking with
+ * a nonstandard symbol. Real custom dispatch implementations should not have
+ * nonstandard symbols. */
+int verify_custom_dispatch(void);
+
+/* The main reason to build this is for testing the CMake build, so the program
+ * doesn't need to do very much. It calls a single library function to ensure
+ * linkage works, but that is all. */
+int main()
+{
+    const char *version = mbedtls_version_get_string_full();
+
+    mbedtls_printf("Built against %s\n", version);
+
+    return verify_custom_dispatch();
+}

programs/test/cmake_subproject_custom_dispatch/custom/CMakeLists.txt

@@ -0,0 +1,7 @@
+list(APPEND dispatch_src_files
+    "${CMAKE_CURRENT_SOURCE_DIR}/custom_dispatch.c"
+    "${CMAKE_CURRENT_SOURCE_DIR}/psa_crypto_driver_wrappers_no_static.c"
+)
+
+set(tf_psa_crypto_objlib "dispatch")
+include(${PROJECT_SOURCE_DIR}/objlib.cmake)

programs/test/cmake_subproject_custom_dispatch/custom/custom_dispatch.c

@@ -0,0 +1,13 @@
+/*
+ *  Dummy function to verify custom dispatch implementation
+ */
+/*
+ *  Copyright The Mbed TLS Contributors
+ *  SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
+ */
+
+int verify_custom_dispatch(void);
+int verify_custom_dispatch(void)
+{
+    return 0;
+}

scripts/generate_query_config.pl

@@ -114,6 +114,7 @@
 my @header_roots = qw(
                          include
                          tf-psa-crypto/include
+                         tf-psa-crypto/dispatch/include
                          tf-psa-crypto/drivers/builtin/include
                     );
 for my $root (@header_roots) {

scripts/legacy.make

@@ -93,6 +93,7 @@ install: no_test
 	cp -rp tf-psa-crypto/drivers/builtin/include/mbedtls $(DESTDIR)/include
 	mkdir -p $(DESTDIR)/include/psa
 	cp -rp tf-psa-crypto/include/psa $(DESTDIR)/include
+	cp -rp tf-psa-crypto/dispatch/include/psa $(DESTDIR)/include
 
 	mkdir -p $(DESTDIR)/lib
 	cp -RP library/libmbedtls.*    $(DESTDIR)/lib
@@ -172,6 +173,7 @@ C_SOURCE_FILES = $(wildcard \
 	library/*.[hc] \
 	tf-psa-crypto/core/*.[hc] \
 	tf-psa-crypto/include/*/*.h \
+	tf-psa-crypto/dispatch/include/*/*.h \
 	tf-psa-crypto/drivers/*/include/*/*.h \
 	tf-psa-crypto/drivers/*/include/*/*/*.h \
 	tf-psa-crypto/drivers/*/include/*/*/*/*.h \
@@ -203,6 +205,7 @@ cscope: cscope.in.out cscope.po.out cscope.out
 cscope.in.out cscope.po.out cscope.out: $(C_SOURCE_FILES)
 	cscope -bq -u -Iinclude -Ilibrary -Itf-psa-crypto/core \
         -Itf-psa-crypto/include \
+        -Itf-psa-crypto/dispatch/include \
 	-Itf-psa-crypto/drivers/builtin/src \
         -Itf-psa-crypto/dispatch \
         -Itf-psa-crypto/extras \

tests/scripts/components-build-system.sh

@@ -104,6 +104,29 @@ support_test_cmake_as_subdirectory () {
     support_test_cmake_out_of_source
 }
 
+component_test_cmake_as_subdirectory_custom_dispatch () {
+    # Remove existing generated files so that we use the ones CMake
+    # generates
+    $MAKE_COMMAND neat
+
+    msg "build: custom dispatch with cmake 'as-subdirectory' build"
+    cp -r tf-psa-crypto/dispatch/include programs/test/cmake_subproject_custom_dispatch/custom
+    cp tf-psa-crypto/dispatch/psa_crypto_driver_wrappers_no_static.h programs/test/cmake_subproject_custom_dispatch/custom
+    mv tf-psa-crypto/dispatch tf-psa-crypto/dispatch.bak
+    tf-psa-crypto/scripts/generate_driver_wrappers.py programs/test/cmake_subproject_custom_dispatch/custom
+    cd programs/test/cmake_subproject_custom_dispatch
+    # Note: Explicitly generate files as these are turned off in releases
+    cmake -D GEN_FILES=ON .
+    make
+    ./cmake_subproject_custom_dispatch
+    cd ../../..
+    mv tf-psa-crypto/dispatch.bak tf-psa-crypto/dispatch
+}
+
+support_test_cmake_as_subdirectory_custom_dispatch () {
+    support_test_cmake_out_of_source
+}
+
 component_test_cmake_as_package () {
     # Remove existing generated files so that we use the ones CMake
     # generates

tests/scripts/depends.py

@@ -189,6 +189,7 @@ def _consistency_check(self):
             header += f'#error "{option}"\n'
             header += '#endif\n'
         include_path = ['include', 'tf-psa-crypto/include',
+                        'tf-psa-crypto/dispatch/include',
                         'tf-psa-crypto/drivers/builtin/include']
 
         try:

tests/scripts/test_config_checks.py

@@ -19,6 +19,7 @@ class MbedtlsTestConfigChecks(unittest_config_checks.TestConfigChecks):
     PROJECT_CONFIG_C = 'library/mbedtls_config.c'
     PROJECT_SPECIFIC_INCLUDE_DIRECTORIES = [
         'tf-psa-crypto/include',
+        'tf-psa-crypto/dispatch/include',
         'tf-psa-crypto/drivers/builtin/include',
     ]