alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
781acfea51
esp-idf/tools/cmake/scripts/expand_requirements.cmake

270 lines
11 KiB
CMake
Raw Normal View History

cmake: separate app from idf lib project mbedtls: import mbedtls using unmodified cmake file
2018-11-11 02:36:10 -05:00
# expand_requirements.cmake is a utility cmake script to expand component requirements early in the build,
cmake: Add component dependency support Components should set the COMPONENT_REQUIRES & COMPONENT_PRIVATE_REQUIRES variables to define their requirements.
2018-03-22 02:27:10 -04:00
# before the components are ready to be included.
#
# Parameters:
# - COMPONENTS = Space-separated list of initial components to include in the build.
# Can be empty, in which case all components are in the build.
cmake: Generate list of components with dependent items first, use deterministic ordering Guarantees that a component's project_include.cmake will be called after its dependent components' project_include.cmake. Because of cycles in the dependency graph, this is less useful than you'd think but it gives a strong guarantee for any component which is not part of a cycle. Also applies deterministic ordering (ordering is initialised as COMPONENT_REQUIRES_COMMON then all COMPONENTS in alphabetical order, but then the sorting by dependencies is applied.)
2018-08-30 23:56:03 -04:00
# - COMPONENT_REQUIRES_COMMON = Components to always include in the build, and treated as dependencies
# of all other components.
cmake: Add component dependency support Components should set the COMPONENT_REQUIRES & COMPONENT_PRIVATE_REQUIRES variables to define their requirements.
2018-03-22 02:27:10 -04:00
# - DEPENDENCIES_FILE = Path of generated cmake file which will contain the expanded dependencies for these
# components.
# - COMPONENT_DIRS = List of paths to search for all components.
# - DEBUG = Set -DDEBUG=1 to debug component lists in the build.
#
# If successful, DEPENDENCIES_FILE can be expanded to set BUILD_COMPONENTS & BUILD_COMPONENT_PATHS with all
# components required for the build, and the get_component_requirements() function to return each component's
# recursively expanded requirements.
#
cmake: Generate list of components with dependent items first, use deterministic ordering Guarantees that a component's project_include.cmake will be called after its dependent components' project_include.cmake. Because of cycles in the dependency graph, this is less useful than you'd think but it gives a strong guarantee for any component which is not part of a cycle. Also applies deterministic ordering (ordering is initialised as COMPONENT_REQUIRES_COMMON then all COMPONENTS in alphabetical order, but then the sorting by dependencies is applied.)
2018-08-30 23:56:03 -04:00
# BUILD_COMPONENTS & BUILD_COMPONENT_PATHS will be ordered in a best-effort way so that dependencies are listed first.
# (Note that IDF supports cyclic dependencies, and dependencies in a cycle have ordering guarantees.)
#
# Determinism:
#
# Given the the same list of names in COMPONENTS (regardless of order), and an identical value of
# COMPONENT_REQUIRES_COMMON, and all the same COMPONENT_REQUIRES & COMPONENT_PRIV_REQUIRES values in
# each component, then the output of BUILD_COMPONENTS should always be in the same
# order.
#
# BUILD_COMPONENT_PATHS will be in the same component order as BUILD_COMPONENTS, even if the
# actual component paths are different due to different paths.
#
cmake: Add component dependency support Components should set the COMPONENT_REQUIRES & COMPONENT_PRIVATE_REQUIRES variables to define their requirements.
2018-03-22 02:27:10 -04:00
# TODO: Error out if a component requirement is missing
cmake_minimum_required(VERSION 3.5)
cmake: Expand components relative to PROJECT_PATH correctly
2018-08-09 22:18:25 -04:00
include("${IDF_PATH}/tools/cmake/utilities.cmake")
build system: support for multiple targets
2018-10-18 23:51:51 -04:00
include("${IDF_PATH}/tools/cmake/component_utils.cmake")
cmake: Add component dependency support Components should set the COMPONENT_REQUIRES & COMPONENT_PRIVATE_REQUIRES variables to define their requirements.
2018-03-22 02:27:10 -04:00
Add ESP_PLATFORM to build environment. Merges https://github.com/espressif/esp-idf/pull/2601
2018-10-21 09:34:53 -04:00
set(ESP_PLATFORM 1)
cmake: Add component dependency support Components should set the COMPONENT_REQUIRES & COMPONENT_PRIVATE_REQUIRES variables to define their requirements.
2018-03-22 02:27:10 -04:00
if(NOT DEPENDENCIES_FILE)
message(FATAL_ERROR "DEPENDENCIES_FILE must be set.")
endif()
if(NOT COMPONENT_DIRS)
message(FATAL_ERROR "COMPONENT_DIRS variable must be set")
endif()
spaces2list(COMPONENT_DIRS)
cmake: Generate list of components with dependent items first, use deterministic ordering Guarantees that a component's project_include.cmake will be called after its dependent components' project_include.cmake. Because of cycles in the dependency graph, this is less useful than you'd think but it gives a strong guarantee for any component which is not part of a cycle. Also applies deterministic ordering (ordering is initialised as COMPONENT_REQUIRES_COMMON then all COMPONENTS in alphabetical order, but then the sorting by dependencies is applied.)
2018-08-30 23:56:03 -04:00
spaces2list(COMPONENT_REQUIRES_COMMON)
cmake: Add component dependency support Components should set the COMPONENT_REQUIRES & COMPONENT_PRIVATE_REQUIRES variables to define their requirements.
2018-03-22 02:27:10 -04:00
# Dummy register_component used to save requirements variables as global properties, for later expansion
#
# (expand_component_requirements() includes the component CMakeLists.txt, which then sets its component variables,
# calls this dummy macro, and immediately exits again.)
macro(register_component)
cmake: make main a component again
2018-09-10 21:44:12 -04:00
if(COMPONENT STREQUAL main AND NOT COMPONENT_REQUIRES)
set(main_component_requires ${COMPONENTS})
list(REMOVE_ITEM main_component_requires "main")
set_property(GLOBAL PROPERTY "${COMPONENT}_REQUIRES" "${main_component_requires}")
else()
spaces2list(COMPONENT_REQUIRES)
set_property(GLOBAL PROPERTY "${COMPONENT}_REQUIRES" "${COMPONENT_REQUIRES}")
endif()
cmake: Add component dependency support Components should set the COMPONENT_REQUIRES & COMPONENT_PRIVATE_REQUIRES variables to define their requirements.
2018-03-22 02:27:10 -04:00
spaces2list(COMPONENT_PRIV_REQUIRES)
set_property(GLOBAL PROPERTY "${COMPONENT}_PRIV_REQUIRES" "${COMPONENT_PRIV_REQUIRES}")
# This is tricky: we override register_component() so it returns out of the component CMakeLists.txt
# (as we're declaring it as a macro not a function, so it doesn't have its own scope.)
#
# This means no targets are defined, and the component expansion ends early.
return()
endmacro()
macro(register_config_only_component)
register_component()
endmacro()
build system: support for multiple targets
2018-10-18 23:51:51 -04:00
function(require_idf_targets)
if(NOT ${IDF_TARGET} IN_LIST ARGN)
message(FATAL_ERROR "Component ${COMPONENT_NAME} only supports targets: ${ARGN}")
cmake: Add support for test build
2018-08-26 22:48:16 -04:00
endif()
cmake: Add component dependency support Components should set the COMPONENT_REQUIRES & COMPONENT_PRIVATE_REQUIRES variables to define their requirements.
2018-03-22 02:27:10 -04:00
endfunction()
# expand_component_requirements: Recursively expand a component's requirements,
# setting global properties BUILD_COMPONENTS & BUILD_COMPONENT_PATHS and
# also invoking the components to call register_component() above,
# which will add per-component global properties with dependencies, etc.
function(expand_component_requirements component)
cmake: Generate list of components with dependent items first, use deterministic ordering Guarantees that a component's project_include.cmake will be called after its dependent components' project_include.cmake. Because of cycles in the dependency graph, this is less useful than you'd think but it gives a strong guarantee for any component which is not part of a cycle. Also applies deterministic ordering (ordering is initialised as COMPONENT_REQUIRES_COMMON then all COMPONENTS in alphabetical order, but then the sorting by dependencies is applied.)
2018-08-30 23:56:03 -04:00
get_property(seen_components GLOBAL PROPERTY SEEN_COMPONENTS)
cmake: Add support for test build
2018-08-26 22:48:16 -04:00
if(component IN_LIST seen_components)
cmake: Generate list of components with dependent items first, use deterministic ordering Guarantees that a component's project_include.cmake will be called after its dependent components' project_include.cmake. Because of cycles in the dependency graph, this is less useful than you'd think but it gives a strong guarantee for any component which is not part of a cycle. Also applies deterministic ordering (ordering is initialised as COMPONENT_REQUIRES_COMMON then all COMPONENTS in alphabetical order, but then the sorting by dependencies is applied.)
2018-08-30 23:56:03 -04:00
return() # already added, or in process of adding, this component
cmake: Add component dependency support Components should set the COMPONENT_REQUIRES & COMPONENT_PRIVATE_REQUIRES variables to define their requirements.
2018-03-22 02:27:10 -04:00
endif()
cmake: Generate list of components with dependent items first, use deterministic ordering Guarantees that a component's project_include.cmake will be called after its dependent components' project_include.cmake. Because of cycles in the dependency graph, this is less useful than you'd think but it gives a strong guarantee for any component which is not part of a cycle. Also applies deterministic ordering (ordering is initialised as COMPONENT_REQUIRES_COMMON then all COMPONENTS in alphabetical order, but then the sorting by dependencies is applied.)
2018-08-30 23:56:03 -04:00
set_property(GLOBAL APPEND PROPERTY SEEN_COMPONENTS ${component})
cmake: Add component dependency support Components should set the COMPONENT_REQUIRES & COMPONENT_PRIVATE_REQUIRES variables to define their requirements.
2018-03-22 02:27:10 -04:00
cmake: Add support for test build
2018-08-26 22:48:16 -04:00
find_component_path("${component}" "${ALL_COMPONENTS}" "${ALL_COMPONENT_PATHS}" component_path)
cmake: Add component dependency support Components should set the COMPONENT_REQUIRES & COMPONENT_PRIVATE_REQUIRES variables to define their requirements.
2018-03-22 02:27:10 -04:00
debug("Expanding dependencies of ${component} @ ${component_path}")
if(NOT component_path)
set_property(GLOBAL APPEND PROPERTY COMPONENTS_NOT_FOUND ${component})
return()
endif()
# include the component CMakeLists.txt to expand its properties
# into the global cache (via register_component(), above)
unset(COMPONENT_REQUIRES)
unset(COMPONENT_PRIV_REQUIRES)
set(COMPONENT ${component})
include(${component_path}/CMakeLists.txt)
get_property(requires GLOBAL PROPERTY "${component}_REQUIRES")
get_property(requires_priv GLOBAL PROPERTY "${component}_PRIV_REQUIRES")
cmake: Generate list of components with dependent items first, use deterministic ordering Guarantees that a component's project_include.cmake will be called after its dependent components' project_include.cmake. Because of cycles in the dependency graph, this is less useful than you'd think but it gives a strong guarantee for any component which is not part of a cycle. Also applies deterministic ordering (ordering is initialised as COMPONENT_REQUIRES_COMMON then all COMPONENTS in alphabetical order, but then the sorting by dependencies is applied.)
2018-08-30 23:56:03 -04:00
# Recurse dependencies first, so that they appear first in the list (when possible)
foreach(req ${COMPONENT_REQUIRES_COMMON} ${requires} ${requires_priv})
cmake: Add component dependency support Components should set the COMPONENT_REQUIRES & COMPONENT_PRIVATE_REQUIRES variables to define their requirements.
2018-03-22 02:27:10 -04:00
expand_component_requirements(${req})
endforeach()
cmake: Generate list of components with dependent items first, use deterministic ordering Guarantees that a component's project_include.cmake will be called after its dependent components' project_include.cmake. Because of cycles in the dependency graph, this is less useful than you'd think but it gives a strong guarantee for any component which is not part of a cycle. Also applies deterministic ordering (ordering is initialised as COMPONENT_REQUIRES_COMMON then all COMPONENTS in alphabetical order, but then the sorting by dependencies is applied.)
2018-08-30 23:56:03 -04:00
cmake: Add support for test build
2018-08-26 22:48:16 -04:00
list(FIND TEST_COMPONENTS ${component} idx)
if(NOT idx EQUAL -1)
list(GET TEST_COMPONENTS ${idx} test_component)
list(GET TEST_COMPONENT_PATHS ${idx} test_component_path)
set_property(GLOBAL APPEND PROPERTY BUILD_TEST_COMPONENTS ${test_component})
set_property(GLOBAL APPEND PROPERTY BUILD_TEST_COMPONENT_PATHS ${test_component_path})
endif()
cmake: Generate list of components with dependent items first, use deterministic ordering Guarantees that a component's project_include.cmake will be called after its dependent components' project_include.cmake. Because of cycles in the dependency graph, this is less useful than you'd think but it gives a strong guarantee for any component which is not part of a cycle. Also applies deterministic ordering (ordering is initialised as COMPONENT_REQUIRES_COMMON then all COMPONENTS in alphabetical order, but then the sorting by dependencies is applied.)
2018-08-30 23:56:03 -04:00
# Now append this component to the full list (after its dependencies)
set_property(GLOBAL APPEND PROPERTY BUILD_COMPONENT_PATHS ${component_path})
set_property(GLOBAL APPEND PROPERTY BUILD_COMPONENTS ${component})
cmake: Add component dependency support Components should set the COMPONENT_REQUIRES & COMPONENT_PRIVATE_REQUIRES variables to define their requirements.
2018-03-22 02:27:10 -04:00
endfunction()
cmake: Add support for test build
2018-08-26 22:48:16 -04:00
# filter_components_list: Filter the components included in the build
# as specified by the user. Or, in the case of unit testing, filter out
# the test components to be built.
macro(filter_components_list)
spaces2list(COMPONENTS)
spaces2list(EXCLUDE_COMPONENTS)
spaces2list(TEST_COMPONENTS)
spaces2list(TEST_EXCLUDE_COMPONENTS)
list(LENGTH ALL_COMPONENTS all_components_length)
math(EXPR all_components_length "${all_components_length} - 1")
foreach(component_idx RANGE 0 ${all_components_length})
list(GET ALL_COMPONENTS ${component_idx} component)
list(GET ALL_COMPONENT_PATHS ${component_idx} component_path)
if(COMPONENTS)
if(${component} IN_LIST COMPONENTS)
set(add_component 1)
else()
set(add_component 0)
endif()
else()
set(add_component 1)
endif()
if(NOT ${component} IN_LIST EXCLUDE_COMPONENTS AND add_component EQUAL 1)
list(APPEND components ${component})
list(APPEND component_paths ${component_path})
cmake: separate app from idf lib project mbedtls: import mbedtls using unmodified cmake file
2018-11-11 02:36:10 -05:00
if(BUILD_TESTS EQUAL 1)
if(TEST_COMPONENTS)
cmake: Add support for test build
2018-08-26 22:48:16 -04:00
if(${component} IN_LIST TEST_COMPONENTS)
set(add_test_component 1)
else()
set(add_test_component 0)
endif()
else()
set(add_test_component 1)
endif()
if(${component} IN_LIST ALL_TEST_COMPONENTS)
if(NOT ${component} IN_LIST TEST_EXCLUDE_COMPONENTS AND add_test_component EQUAL 1)
list(APPEND test_components ${component}_test)
list(APPEND test_component_paths ${component_path}/test)
list(APPEND components ${component}_test)
list(APPEND component_paths ${component_path}/test)
endif()
endif()
endif()
endif()
endforeach()
set(COMPONENTS ${components})
set(TEST_COMPONENTS ${test_components})
set(TEST_COMPONENT_PATHS ${test_component_paths})
list(APPEND ALL_COMPONENTS "${TEST_COMPONENTS}")
list(APPEND ALL_COMPONENT_PATHS "${TEST_COMPONENT_PATHS}")
endmacro()
# Main functionality goes here
cmake: Add component dependency support Components should set the COMPONENT_REQUIRES & COMPONENT_PRIVATE_REQUIRES variables to define their requirements.
2018-03-22 02:27:10 -04:00
# Find every available component in COMPONENT_DIRS, save as ALL_COMPONENT_PATHS and ALL_COMPONENTS
cmake: Add support for test build
2018-08-26 22:48:16 -04:00
components_find_all("${COMPONENT_DIRS}" ALL_COMPONENT_PATHS ALL_COMPONENTS ALL_TEST_COMPONENTS)
cmake: Add component dependency support Components should set the COMPONENT_REQUIRES & COMPONENT_PRIVATE_REQUIRES variables to define their requirements.
2018-03-22 02:27:10 -04:00
cmake: Add support for test build
2018-08-26 22:48:16 -04:00
filter_components_list()
cmake: Add component dependency support Components should set the COMPONENT_REQUIRES & COMPONENT_PRIVATE_REQUIRES variables to define their requirements.
2018-03-22 02:27:10 -04:00
debug("ALL_COMPONENT_PATHS ${ALL_COMPONENT_PATHS}")
debug("ALL_COMPONENTS ${ALL_COMPONENTS}")
cmake: Add support for test build
2018-08-26 22:48:16 -04:00
debug("ALL_TEST_COMPONENTS ${ALL_TEST_COMPONENTS}")
cmake: Add component dependency support Components should set the COMPONENT_REQUIRES & COMPONENT_PRIVATE_REQUIRES variables to define their requirements.
2018-03-22 02:27:10 -04:00
cmake: Generate list of components with dependent items first, use deterministic ordering Guarantees that a component's project_include.cmake will be called after its dependent components' project_include.cmake. Because of cycles in the dependency graph, this is less useful than you'd think but it gives a strong guarantee for any component which is not part of a cycle. Also applies deterministic ordering (ordering is initialised as COMPONENT_REQUIRES_COMMON then all COMPONENTS in alphabetical order, but then the sorting by dependencies is applied.)
2018-08-30 23:56:03 -04:00
set_property(GLOBAL PROPERTY SEEN_COMPONENTS "") # anti-infinite-recursion
cmake: Add component dependency support Components should set the COMPONENT_REQUIRES & COMPONENT_PRIVATE_REQUIRES variables to define their requirements.
2018-03-22 02:27:10 -04:00
set_property(GLOBAL PROPERTY BUILD_COMPONENTS "")
set_property(GLOBAL PROPERTY BUILD_COMPONENT_PATHS "")
cmake: Add support for test build
2018-08-26 22:48:16 -04:00
set_property(GLOBAL PROPERTY BUILD_TEST_COMPONENTS "")
set_property(GLOBAL PROPERTY BUILD_TEST_COMPONENT_PATHS "")
cmake: Add component dependency support Components should set the COMPONENT_REQUIRES & COMPONENT_PRIVATE_REQUIRES variables to define their requirements.
2018-03-22 02:27:10 -04:00
set_property(GLOBAL PROPERTY COMPONENTS_NOT_FOUND "")
cmake: add ulp components build support
2018-09-13 02:54:59 -04:00
# Indicate that the component CMakeLists.txt is being included in the early expansion phase of the build,
# and might not want to execute particular operations.
set(CMAKE_BUILD_EARLY_EXPANSION 1)
cmake: Add component dependency support Components should set the COMPONENT_REQUIRES & COMPONENT_PRIVATE_REQUIRES variables to define their requirements.
2018-03-22 02:27:10 -04:00
foreach(component ${COMPONENTS})
debug("Expanding initial component ${component}")
expand_component_requirements(${component})
endforeach()
cmake: add ulp components build support
2018-09-13 02:54:59 -04:00
unset(CMAKE_BUILD_EARLY_EXPANSION)
cmake: Add component dependency support Components should set the COMPONENT_REQUIRES & COMPONENT_PRIVATE_REQUIRES variables to define their requirements.
2018-03-22 02:27:10 -04:00
get_property(build_components GLOBAL PROPERTY BUILD_COMPONENTS)
get_property(build_component_paths GLOBAL PROPERTY BUILD_COMPONENT_PATHS)
cmake: Add support for test build
2018-08-26 22:48:16 -04:00
get_property(build_test_components GLOBAL PROPERTY BUILD_TEST_COMPONENTS)
get_property(build_test_component_paths GLOBAL PROPERTY BUILD_TEST_COMPONENT_PATHS)
cmake: Add component dependency support Components should set the COMPONENT_REQUIRES & COMPONENT_PRIVATE_REQUIRES variables to define their requirements.
2018-03-22 02:27:10 -04:00
get_property(not_found GLOBAL PROPERTY COMPONENTS_NOT_FOUND)
debug("components in build: ${build_components}")
debug("components in build: ${build_component_paths}")
debug("components not found: ${not_found}")
function(line contents)
cmake: Only rewrite componend_depends.cmake if it changes
2018-08-09 22:30:32 -04:00
file(APPEND "${DEPENDENCIES_FILE}.tmp" "${contents}\n")
cmake: Add component dependency support Components should set the COMPONENT_REQUIRES & COMPONENT_PRIVATE_REQUIRES variables to define their requirements.
2018-03-22 02:27:10 -04:00
endfunction()
cmake: Only rewrite componend_depends.cmake if it changes
2018-08-09 22:30:32 -04:00
file(WRITE "${DEPENDENCIES_FILE}.tmp" "# Component requirements generated by expand_requirements.cmake\n\n")
cmake: Add component dependency support Components should set the COMPONENT_REQUIRES & COMPONENT_PRIVATE_REQUIRES variables to define their requirements.
2018-03-22 02:27:10 -04:00
line("set(BUILD_COMPONENTS ${build_components})")
line("set(BUILD_COMPONENT_PATHS ${build_component_paths})")
cmake: Add support for test build
2018-08-26 22:48:16 -04:00
line("set(BUILD_TEST_COMPONENTS ${build_test_components})")
line("set(BUILD_TEST_COMPONENT_PATHS ${build_test_component_paths})")
cmake: Add component dependency support Components should set the COMPONENT_REQUIRES & COMPONENT_PRIVATE_REQUIRES variables to define their requirements.
2018-03-22 02:27:10 -04:00
line("")
line("# get_component_requirements: Generated function to read the dependencies of a given component.")
line("#")
line("# Parameters:")
line("# - component: Name of component")
line("# - var_requires: output variable name. Set to recursively expanded COMPONENT_REQUIRES ")
line("# for this component.")
line("# - var_private_requires: output variable name. Set to recursively expanded COMPONENT_PRIV_REQUIRES ")
line("# for this component.")
line("#")
line("# Throws a fatal error if 'componeont' is not found (indicates a build system problem).")
line("#")
line("function(get_component_requirements component var_requires var_private_requires)")
foreach(build_component ${build_components})
get_property(reqs GLOBAL PROPERTY "${build_component}_REQUIRES")
get_property(private_reqs GLOBAL PROPERTY "${build_component}_PRIV_REQUIRES")
line(" if(\"\$\{component}\" STREQUAL \"${build_component}\")")
line(" set(\${var_requires} \"${reqs}\" PARENT_SCOPE)")
line(" set(\${var_private_requires} \"${private_reqs}\" PARENT_SCOPE)")
line(" return()")
line(" endif()")
endforeach()
line(" message(FATAL_ERROR \"Component not found: \${component}\")")
line("endfunction()")
cmake: Only rewrite componend_depends.cmake if it changes
2018-08-09 22:30:32 -04:00
# only replace DEPENDENCIES_FILE if it has changed (prevents ninja/make build loops.)
execute_process(COMMAND ${CMAKE_COMMAND} -E copy_if_different "${DEPENDENCIES_FILE}.tmp" "${DEPENDENCIES_FILE}")
execute_process(COMMAND ${CMAKE_COMMAND} -E remove "${DEPENDENCIES_FILE}.tmp")
Reference in New Issue Copy Permalink