From 72e0dc58d3caf63a57975e97ce13c5dc4b38cf9b Mon Sep 17 00:00:00 2001 From: Brad King Date: Mon, 7 Mar 2016 13:31:25 -0500 Subject: [PATCH] Diagnose recursive project/enable_language without crashing (#15999) Calling `project()` or `enable_language()` from a toolchain file will infinitely recurse since those commands load the toolchain file. Diagnose and reject this case with an error message instead of crashing when the stack eventually overflows. --- Source/cmGlobalGenerator.cxx | 21 +++++++++++++++++++ Source/cmGlobalGenerator.h | 1 + Tests/RunCMake/CMakeLists.txt | 1 + Tests/RunCMake/ToolchainFile/CMakeLists.txt | 3 +++ .../CallEnableLanguage-result.txt | 1 + .../CallEnableLanguage-stderr.txt | 5 +++++ .../CallEnableLanguage-toolchain.cmake | 1 + .../ToolchainFile/CallEnableLanguage.cmake | 0 .../ToolchainFile/CallProject-result.txt | 1 + .../ToolchainFile/CallProject-stderr.txt | 5 +++++ .../ToolchainFile/CallProject-toolchain.cmake | 1 + .../RunCMake/ToolchainFile/CallProject.cmake | 0 .../RunCMake/ToolchainFile/RunCMakeTest.cmake | 9 ++++++++ 13 files changed, 49 insertions(+) create mode 100644 Tests/RunCMake/ToolchainFile/CMakeLists.txt create mode 100644 Tests/RunCMake/ToolchainFile/CallEnableLanguage-result.txt create mode 100644 Tests/RunCMake/ToolchainFile/CallEnableLanguage-stderr.txt create mode 100644 Tests/RunCMake/ToolchainFile/CallEnableLanguage-toolchain.cmake create mode 100644 Tests/RunCMake/ToolchainFile/CallEnableLanguage.cmake create mode 100644 Tests/RunCMake/ToolchainFile/CallProject-result.txt create mode 100644 Tests/RunCMake/ToolchainFile/CallProject-stderr.txt create mode 100644 Tests/RunCMake/ToolchainFile/CallProject-toolchain.cmake create mode 100644 Tests/RunCMake/ToolchainFile/CallProject.cmake create mode 100644 Tests/RunCMake/ToolchainFile/RunCMakeTest.cmake diff --git a/Source/cmGlobalGenerator.cxx b/Source/cmGlobalGenerator.cxx index 848028ff3..c6284069e 100644 --- a/Source/cmGlobalGenerator.cxx +++ b/Source/cmGlobalGenerator.cxx @@ -398,6 +398,21 @@ cmGlobalGenerator::EnableLanguage(std::vectorconst& languages, return; } + std::set cur_languages(languages.begin(), languages.end()); + for (std::set::iterator li = cur_languages.begin(); + li != cur_languages.end(); ++li) + { + if (!this->LanguagesInProgress.insert(*li).second) + { + std::ostringstream e; + e << "Language '" << *li << "' is currently being enabled. " + "Recursive call not allowed."; + mf->IssueMessage(cmake::FATAL_ERROR, e.str()); + cmSystemTools::SetFatalErrorOccured(); + return; + } + } + if(this->TryCompileOuterMakefile) { // In a try-compile we can only enable languages provided by caller. @@ -823,6 +838,12 @@ cmGlobalGenerator::EnableLanguage(std::vectorconst& languages, { cmSystemTools::SetFatalErrorOccured(); } + + for (std::set::iterator li = cur_languages.begin(); + li != cur_languages.end(); ++li) + { + this->LanguagesInProgress.erase(*li); + } } //---------------------------------------------------------------------------- diff --git a/Source/cmGlobalGenerator.h b/Source/cmGlobalGenerator.h index 48fa70406..6e819d3a4 100644 --- a/Source/cmGlobalGenerator.h +++ b/Source/cmGlobalGenerator.h @@ -457,6 +457,7 @@ private: // in EnableLanguagesFromGenerator std::map IgnoreExtensions; std::set LanguagesReady; // Ready for try_compile + std::set LanguagesInProgress; std::map OutputExtensions; std::map LanguageToOutputExtension; std::map ExtensionToLanguage; diff --git a/Tests/RunCMake/CMakeLists.txt b/Tests/RunCMake/CMakeLists.txt index 5bef62908..23b9b42f6 100644 --- a/Tests/RunCMake/CMakeLists.txt +++ b/Tests/RunCMake/CMakeLists.txt @@ -152,6 +152,7 @@ add_RunCMake_test(ObjectLibrary) add_RunCMake_test(Swift) add_RunCMake_test(TargetObjects) add_RunCMake_test(TargetSources) +add_RunCMake_test(ToolchainFile) add_RunCMake_test(find_dependency) add_RunCMake_test(CompileDefinitions) add_RunCMake_test(CompileFeatures) diff --git a/Tests/RunCMake/ToolchainFile/CMakeLists.txt b/Tests/RunCMake/ToolchainFile/CMakeLists.txt new file mode 100644 index 000000000..93ee9dfd5 --- /dev/null +++ b/Tests/RunCMake/ToolchainFile/CMakeLists.txt @@ -0,0 +1,3 @@ +cmake_minimum_required(VERSION 3.5) +project(${RunCMake_TEST} NONE) +include(${RunCMake_TEST}.cmake) diff --git a/Tests/RunCMake/ToolchainFile/CallEnableLanguage-result.txt b/Tests/RunCMake/ToolchainFile/CallEnableLanguage-result.txt new file mode 100644 index 000000000..d00491fd7 --- /dev/null +++ b/Tests/RunCMake/ToolchainFile/CallEnableLanguage-result.txt @@ -0,0 +1 @@ +1 diff --git a/Tests/RunCMake/ToolchainFile/CallEnableLanguage-stderr.txt b/Tests/RunCMake/ToolchainFile/CallEnableLanguage-stderr.txt new file mode 100644 index 000000000..0de51c652 --- /dev/null +++ b/Tests/RunCMake/ToolchainFile/CallEnableLanguage-stderr.txt @@ -0,0 +1,5 @@ +^CMake Error at CallEnableLanguage-toolchain.cmake:[0-9]+ \(enable_language\): + Language 'NONE' is currently being enabled. Recursive call not allowed. +Call Stack \(most recent call first\): + .*/Modules/CMakeDetermineSystem.cmake:[0-9]+ \(include\) + CMakeLists.txt:[0-9]+ \(project\)$ diff --git a/Tests/RunCMake/ToolchainFile/CallEnableLanguage-toolchain.cmake b/Tests/RunCMake/ToolchainFile/CallEnableLanguage-toolchain.cmake new file mode 100644 index 000000000..814510129 --- /dev/null +++ b/Tests/RunCMake/ToolchainFile/CallEnableLanguage-toolchain.cmake @@ -0,0 +1 @@ +enable_language(NONE) diff --git a/Tests/RunCMake/ToolchainFile/CallEnableLanguage.cmake b/Tests/RunCMake/ToolchainFile/CallEnableLanguage.cmake new file mode 100644 index 000000000..e69de29bb diff --git a/Tests/RunCMake/ToolchainFile/CallProject-result.txt b/Tests/RunCMake/ToolchainFile/CallProject-result.txt new file mode 100644 index 000000000..d00491fd7 --- /dev/null +++ b/Tests/RunCMake/ToolchainFile/CallProject-result.txt @@ -0,0 +1 @@ +1 diff --git a/Tests/RunCMake/ToolchainFile/CallProject-stderr.txt b/Tests/RunCMake/ToolchainFile/CallProject-stderr.txt new file mode 100644 index 000000000..e2b9f1b8f --- /dev/null +++ b/Tests/RunCMake/ToolchainFile/CallProject-stderr.txt @@ -0,0 +1,5 @@ +^CMake Error at CallProject-toolchain.cmake:[0-9]+ \(project\): + Language 'NONE' is currently being enabled. Recursive call not allowed. +Call Stack \(most recent call first\): + .*/Modules/CMakeDetermineSystem.cmake:[0-9]+ \(include\) + CMakeLists.txt:[0-9]+ \(project\)$ diff --git a/Tests/RunCMake/ToolchainFile/CallProject-toolchain.cmake b/Tests/RunCMake/ToolchainFile/CallProject-toolchain.cmake new file mode 100644 index 000000000..b113c132a --- /dev/null +++ b/Tests/RunCMake/ToolchainFile/CallProject-toolchain.cmake @@ -0,0 +1 @@ +project(Bad NONE) diff --git a/Tests/RunCMake/ToolchainFile/CallProject.cmake b/Tests/RunCMake/ToolchainFile/CallProject.cmake new file mode 100644 index 000000000..e69de29bb diff --git a/Tests/RunCMake/ToolchainFile/RunCMakeTest.cmake b/Tests/RunCMake/ToolchainFile/RunCMakeTest.cmake new file mode 100644 index 000000000..75293e7c5 --- /dev/null +++ b/Tests/RunCMake/ToolchainFile/RunCMakeTest.cmake @@ -0,0 +1,9 @@ +include(RunCMake) + +function(run_cmake_toolchain t) + set(RunCMake_TEST_OPTIONS -DCMAKE_TOOLCHAIN_FILE=${RunCMake_SOURCE_DIR}/${t}-toolchain.cmake) + run_cmake(${t}) +endfunction() + +run_cmake_toolchain(CallEnableLanguage) +run_cmake_toolchain(CallProject)