[FIXUP] cmake: Rework compile/link flags summary #93

hebasto · 2024-02-06T13:31:38Z

All flags have the only line to be displayed in the "Configure summary" now. This change is expected to simplify parsing the summary.

Here are output examples:

for a single configuration generator:

$ cmake -B build -G "Ninja"
<snip>

Cross compiling ....................... FALSE
C compiler ............................ GNU 13.2.0, /usr/bin/cc
C++ compiler .......................... GNU 13.2.0, /usr/bin/c++
CMAKE_BUILD_TYPE ...................... RelWithDebInfo
Preprocessor defined macros ........... 
C compiler flags ...................... -O2 -g -fPIC -fno-extended-identifiers -fstack-reuse=none
C++ compiler flags .................... -O2 -g -fPIC -fno-extended-identifiers -fstack-reuse=none -Wall -Wextra -Wformat -Wformat-security -Wvla -Wredundant-decls -Wdate-time -Wduplicated-branches -Wduplicated-cond -Wlogical-op -Woverloaded-virtual -Wsuggest-override -Wimplicit-fallthrough -Wunreachable-code -Wno-unused-parameter -U_FORTIFY_SOURCE -D_FORTIFY_SOURCE=3 -Wstack-protector -fstack-protector-all -fcf-protection=full -fstack-clash-protection
Linker flags .......................... -O2 -g -fstack-reuse=none -fstack-protector-all -fcf-protection=full -fstack-clash-protection -Wl,-z,relro -Wl,-z,now -Wl,-z,separate-code -fPIE -pie

NOTE: The summary above may not exactly match the final applied build flags
      if any additional CMAKE_* or environment variables have been modified.
      To see the exact flags applied, build with the --verbose option.

<snip>

for a multiple configurations generator:

$ cmake -B build -G "Ninja Multi-Config"
<snip>

Cross compiling ....................... FALSE
C compiler ............................ GNU 13.2.0, /usr/bin/cc
C++ compiler .......................... GNU 13.2.0, /usr/bin/c++
Available build configurations ........ RelWithDebInfo, Debug, Release, Coverage
Default build configuration ........... RelWithDebInfo

'RelWithDebInfo' build configuration:
  Preprocessor defined macros ......... 
  C compiler flags .................... -O2 -g -fPIC -fno-extended-identifiers -fstack-reuse=none
  C++ compiler flags .................. -O2 -g -fPIC -fno-extended-identifiers -fstack-reuse=none -Wall -Wextra -Wformat -Wformat-security -Wvla -Wredundant-decls -Wdate-time -Wduplicated-branches -Wduplicated-cond -Wlogical-op -Woverloaded-virtual -Wsuggest-override -Wimplicit-fallthrough -Wunreachable-code -Wno-unused-parameter -U_FORTIFY_SOURCE -D_FORTIFY_SOURCE=3 -Wstack-protector -fstack-protector-all -fcf-protection=full -fstack-clash-protection
  Linker flags ........................ -O2 -g -fstack-reuse=none -fstack-protector-all -fcf-protection=full -fstack-clash-protection -Wl,-z,relro -Wl,-z,now -Wl,-z,separate-code -fPIE -pie

'Debug' build configuration:
  Preprocessor defined macros ......... DEBUG DEBUG_LOCKORDER DEBUG_LOCKCONTENTION RPC_DOC_CHECK ABORT_ON_FAILED_ASSUME
  C compiler flags .................... -O0 -g3 -fPIC -fno-extended-identifiers -fstack-reuse=none
  C++ compiler flags .................. -O0 -ftrapv -g3 -fPIC -fno-extended-identifiers -fstack-reuse=none -Wall -Wextra -Wformat -Wformat-security -Wvla -Wredundant-decls -Wdate-time -Wduplicated-branches -Wduplicated-cond -Wlogical-op -Woverloaded-virtual -Wsuggest-override -Wimplicit-fallthrough -Wunreachable-code -Wno-unused-parameter -Wstack-protector -fstack-protector-all -fcf-protection=full -fstack-clash-protection
  Linker flags ........................ -O0 -ftrapv -g3 -fstack-reuse=none -fstack-protector-all -fcf-protection=full -fstack-clash-protection -Wl,-z,relro -Wl,-z,now -Wl,-z,separate-code -fPIE -pie

'Release' build configuration:
  Preprocessor defined macros ......... 
  C compiler flags .................... -O2 -fPIC -fno-extended-identifiers -fstack-reuse=none
  C++ compiler flags .................. -O2 -fPIC -fno-extended-identifiers -fstack-reuse=none -Wall -Wextra -Wformat -Wformat-security -Wvla -Wredundant-decls -Wdate-time -Wduplicated-branches -Wduplicated-cond -Wlogical-op -Woverloaded-virtual -Wsuggest-override -Wimplicit-fallthrough -Wunreachable-code -Wno-unused-parameter -U_FORTIFY_SOURCE -D_FORTIFY_SOURCE=3 -Wstack-protector -fstack-protector-all -fcf-protection=full -fstack-clash-protection
  Linker flags ........................ -O2 -fstack-reuse=none -fstack-protector-all -fcf-protection=full -fstack-clash-protection -Wl,-z,relro -Wl,-z,now -Wl,-z,separate-code -fPIE -pie

'Coverage' build configuration:
  Preprocessor defined macros ......... 
  C compiler flags .................... -fPIC -fno-extended-identifiers -fstack-reuse=none
  C++ compiler flags .................. -Og --coverage -fPIC -fno-extended-identifiers -fstack-reuse=none -Wall -Wextra -Wformat -Wformat-security -Wvla -Wredundant-decls -Wdate-time -Wduplicated-branches -Wduplicated-cond -Wlogical-op -Woverloaded-virtual -Wsuggest-override -Wimplicit-fallthrough -Wunreachable-code -Wno-unused-parameter -U_FORTIFY_SOURCE -D_FORTIFY_SOURCE=3 -Wstack-protector -fstack-protector-all -fcf-protection=full -fstack-clash-protection
  Linker flags ........................ -Og --coverage -fstack-reuse=none -fstack-protector-all -fcf-protection=full -fstack-clash-protection -Wl,-z,relro -Wl,-z,now -Wl,-z,separate-code -fPIE -pie

NOTE: The summary above may not exactly match the final applied build flags
      if any additional CMAKE_* or environment variables have been modified.
      To see the exact flags applied, build with the --verbose option.

<snip>

Closes #221

hebasto · 2024-02-06T13:33:00Z

This change was requested by @fanquake in #82. @TheCharlatan gave his 👍 .

fanquake · 2024-02-06T13:45:41Z

Tested on a macOS system with cmake -S . -B build.

Cross compiling ....................... FALSE
Build configuration ................... RelWithDebInfo
Preprocessor defined macros ........... -DMAC_OSX -D -D -D -D -D -DHAVE_CONFIG_H
C compiler ............................ /Library/Developer/CommandLineTools/usr/bin/cc
C compiler flags ...................... -O2 -g -Wstack-protector -fstack-protector-all -mbranch-protection=bti
C++ compiler .......................... /Library/Developer/CommandLineTools/usr/bin/c++
C++ compiler flags .................... -O2 -g -Wstack-protector -fstack-protector-all -mbranch-protection=bti
Linker flags .......................... -Wl,-dead_strip -Wl,-dead_strip_dylibs -Wl,-headerpad_max_install_names -Wl,-fixup_chains

What is Preprocessor defined macros ........... -DMAC_OSX -D -D -D -D -D -DHAVE_CONFIG_H?

It'd be nice if the compiler output was the actual compiler, i.e clang or gcc, rather than always cc.
It'd also be nice if it was consistent about when it was showing a ccache wrapper or not.

On two Linux machines, one aarch64 Fedora, the other x86_64 Ubuntu, both configured with cmake -S . -B build and using GCC and ccache, one shows me:

C compiler ............................ /usr/lib64/ccache/cc
C compiler flags ...................... -O2 -g -fno-extended-identifiers -fstack-reuse=none -Wstack-protector -fstack-protector-all -fstack-clash-protection -mbranch-protection=bti
C++ compiler .......................... /usr/lib64/ccache/c++
...
Use ccache for compiling .............. ON

but the other shows me:

C compiler ............................ /usr/bin/cc
C compiler flags ...................... -O2 -g -fno-extended-identifiers -fstack-reuse=none -Wstack-protector -fstack-protector-all -fcf-protection=full -fstack-clash-protection
C++ compiler .......................... /usr/bin/c++
...
Use ccache for compiling .............. ON

Is there a reason for the difference?

hebasto · 2024-02-06T14:38:22Z

I did my best efforts to address @fanquake's comment.

On two Linux machines, one aarch64 Fedora, the other x86_64 Ubuntu, both configured with cmake -S . -B build and using GCC and ccache, one shows me:

C compiler ............................ /usr/lib64/ccache/cc
C compiler flags ...................... -O2 -g -fno-extended-identifiers -fstack-reuse=none -Wstack-protector -fstack-protector-all -fstack-clash-protection -mbranch-protection=bti
C++ compiler .......................... /usr/lib64/ccache/c++
...
Use ccache for compiling .............. ON

but the other shows me:

C compiler ............................ /usr/bin/cc
C compiler flags ...................... -O2 -g -fno-extended-identifiers -fstack-reuse=none -Wstack-protector -fstack-protector-all -fcf-protection=full -fstack-clash-protection
C++ compiler .......................... /usr/bin/c++
...
Use ccache for compiling .............. ON

Is there a reason for the difference?

I would assume it depends on how the ccache package is installed, including created symlinks, PATH variable modifications etc.

hebasto · 2024-02-09T19:11:51Z

Rebased.

pablomartin4btc

tACK 2890ef1

Tested on Ubuntu 22.04.

cmake -B build -DCMAKE_BUILD_TYPE=Debug

Before:

Cross compiling ....................... FALSE
Preprocessor defined macros ........... 
C compiler ............................ /usr/bin/cc
CFLAGS ................................ 
C++ compiler .......................... /usr/bin/c++
CXXFLAGS .............................. 
Common compile options ................ -fno-extended-identifiers -fstack-reuse=none -Wstack-protector -fstack-protector-all -fcf-protection=full -fstack-clash-protection
Common link options ................... -fno-extended-identifiers -fstack-reuse=none -fstack-protector-all -fcf-protection=full -fstack-clash-protection -Wl,-z,relro -Wl,-z,now -Wl,-z,separate-code
Linker flags for executables .......... 
Linker flags for shared libraries ..... 
Build type (configuration):
 - CMAKE_BUILD_TYPE ................... Debug
 - Preprocessor defined macros ........ DEBUG DEBUG_LOCKORDER DEBUG_LOCKCONTENTION RPC_DOC_CHECK ABORT_ON_FAILED_ASSUME
 - CFLAGS ............................. -O0 -g3
 - CXXFLAGS ........................... -O0 -g3 -ftrapv
 - LDFLAGS for executables ............ 
 - LDFLAGS for shared libraries ....... 
Use assembly routines ................. ON
Attempt to harden executables ......... ON
Treat compiler warnings as errors ..... OFF
Use ccache for compiling .............. ON

After:

Cross compiling ....................... FALSE
Build configuration ................... Debug
Preprocessor defined macros ........... -DHAVE_CONFIG_H -DDEBUG -DDEBUG_LOCKORDER -DDEBUG_LOCKCONTENTION -DRPC_DOC_CHECK -DABORT_ON_FAILED_ASSUME
C compiler ............................ GNU 11.4.0, /usr/bin/cc
C compiler flags ...................... -O0 -g3 -fno-extended-identifiers -fstack-reuse=none -Wstack-protector -fstack-protector-all -fcf-protection=full -fstack-clash-protection
C++ compiler .......................... GNU 11.4.0, /usr/bin/c++
C++ compiler flags .................... -O0 -g3 -ftrapv -fno-extended-identifiers -fstack-reuse=none -Wstack-protector -fstack-protector-all -fcf-protection=full -fstack-clash-protection
Linker flags .......................... -fno-extended-identifiers -fstack-reuse=none -fstack-protector-all -fcf-protection=full -fstack-clash-protection -Wl,-z,relro -Wl,-z,now -Wl,-z,separate-code
Use assembly routines ................. ON
Attempt to harden executables ......... ON
Treat compiler warnings as errors ..... OFF
Use ccache for compiling .............. ON

pablomartin4btc

tACK d8d9ced

With multi config:

cmake -B build -G "Ninja Multi-Config"

...
Cross compiling ....................... FALSE
Available build configurations ........ RelWithDebInfo, Debug, Release
Default build configuration ........... RelWithDebInfo
Preprocessor defined macros ........... -DHAVE_CONFIG_H
C compiler ............................ GNU 11.4.0, /usr/bin/cc
C compiler flags ...................... -O2 -g -fno-extended-identifiers -fstack-reuse=none -Wstack-protector -fstack-protector-all -fcf-protection=full -fstack-clash-protection
C++ compiler .......................... GNU 11.4.0, /usr/bin/c++
C++ compiler flags .................... -O2 -g -fno-extended-identifiers -fstack-reuse=none -Wstack-protector -fstack-protector-all -fcf-protection=full -fstack-clash-protection
Linker flags .......................... -fno-extended-identifiers -fstack-reuse=none -fstack-protector-all -fcf-protection=full -fstack-clash-protection -Wl,-z,relro -Wl,-z,now -Wl,-z,separate-code
Use assembly routines ................. ON
Attempt to harden executables ......... ON
Treat compiler warnings as errors ..... OFF
Use ccache for compiling .............. ON
...

m3dwards · 2024-03-07T13:59:04Z

With this PR on multi-config build we lose information on what the flags would be if a build configuration other than the default is picked? Before this PR for example the summary told me that -O0 -g3 -ftrapv would be used in a debug build but that info is lost now it seems.

I prefer this new format for single config build configurations but not as much for multi-config.

With the PR I get -DHAVE_CONFIG_H in the preprocessor macro line but it's not there in cmake-staging summary. Is this correct?

hebasto · 2024-03-18T10:45:44Z

@m3dwards

With this PR on multi-config build we lose information on what the flags would be if a build configuration other than the default is picked? Before this PR for example the summary told me that -O0 -g3 -ftrapv would be used in a debug build but that info is lost now it seems.

When using multi-config generators, you can specify -DCMAKE_BUILD_TYPE=... to print the summary for the desired configuration. The second run of cmake command with the adjusted -DCMAKE_BUILD_TYPE prints the summary in no time.

I prefer this new format for single config build configurations but not as much for multi-config.

I doubt that we want introduce a such an inconsistency.

With the PR I get -DHAVE_CONFIG_H in the preprocessor macro line but it's not there in cmake-staging summary. Is this correct?

Yes, that is correct. See the diff in the src/CMakeLists.txt. The core_interface library is a proper home for the HAVE_CONFIG_H macro definition.

hebasto · 2024-03-18T11:09:37Z

Friendly ping @TheCharlatan @vasild @fanquake :)

vasild · 2024-03-22T15:05:34Z

I agree with @m3dwards that it is easier to print all configs right away and with @fanquake that printing "CFLAGS: x, Debug CFLAGS: y" is confusing - it is unclear which one wins if x and y are mutually exclusive and also for me it was not clear whether y replaces x or is merged with it.

Consider the following patch, it resolves both complaints:

[patch] print all without a default beforehand

diff --git i/cmake/module/FlagsSummary.cmake w/cmake/module/FlagsSummary.cmake
index bec15f489d..0a3aed17f9 100644
--- i/cmake/module/FlagsSummary.cmake
+++ w/cmake/module/FlagsSummary.cmake
@@ -44,39 +44,40 @@ function(flags_summary)
     if(CMAKE_GENERATOR MATCHES "Visual Studio")
       set(default_config "Debug")
     else()
       list(GET CMAKE_CONFIGURATION_TYPES 0 default_config)
     endif()
     message("Default build configuration ........... ${default_config}")
-    string(TOUPPER "${default_config}" config_uppercase)
-    if(DEFINED CMAKE_BUILD_TYPE)
-      message("Flags for configuration \"${CMAKE_BUILD_TYPE}\":")
-      string(TOUPPER "${CMAKE_BUILD_TYPE}" config_uppercase)
-    endif()
   else()
     message("Build configuration ................... ${CMAKE_BUILD_TYPE}")
-    string(TOUPPER "${CMAKE_BUILD_TYPE}" config_uppercase)
   endif()
 
-  string(STRIP "${definitions_ALL} ${definitions_${config_uppercase}}" combined_cpp_flags)
-  normalize_preprocessor_definitions(combined_cpp_flags)
-  message("Preprocessor defined macros ........... ${combined_cpp_flags}")
-
   message("C compiler ............................ ${CMAKE_C_COMPILER_ID} ${CMAKE_C_COMPILER_VERSION}, ${CMAKE_C_COMPILER}")
-  string(STRIP "${CMAKE_C_FLAGS} ${CMAKE_C_FLAGS_${config_uppercase}}" combined_c_flags)
+  message("C++ compiler .......................... ${CMAKE_CXX_COMPILER_ID} ${CMAKE_CXX_COMPILER_VERSION}, ${CMAKE_CXX_COMPILER}")
+
   list(JOIN DEPENDS_C_COMPILER_FLAGS " " depends_c_flags)
-  string(STRIP "${combined_c_flags} ${depends_c_flags}" combined_c_flags)
+  list(JOIN DEPENDS_CXX_COMPILER_FLAGS " " depends_cxx_flags)
   get_target_interface(common_compile_options core_interface COMPILE_OPTIONS)
-  string(STRIP "${combined_c_flags} ${common_compile_options}" combined_c_flags)
-  message("C compiler flags ...................... ${combined_c_flags}")
 
-  message("C++ compiler .......................... ${CMAKE_CXX_COMPILER_ID} ${CMAKE_CXX_COMPILER_VERSION}, ${CMAKE_CXX_COMPILER}")
-  string(STRIP "${CMAKE_CXX_FLAGS} ${CMAKE_CXX_FLAGS_${config_uppercase}}" combined_cxx_flags)
-  list(JOIN DEPENDS_CXX_COMPILER_FLAGS " " depends_cxx_flags)
-  string(STRIP "${combined_cxx_flags} ${depends_cxx_flags}" combined_cxx_flags)
-  string(STRIP "${combined_cxx_flags} ${common_compile_options}" combined_cxx_flags)
-  message("C++ compiler flags .................... ${combined_cxx_flags}")
+  foreach(config IN LISTS CMAKE_CONFIGURATION_TYPES)
+    message("'${config}' build configuration:")
+    string(TOUPPER "${config}" config_uppercase)
+
+    string(STRIP "${definitions_ALL} ${definitions_${config_uppercase}}" combined_cpp_flags)
+    normalize_preprocessor_definitions(combined_cpp_flags)
+    message("  Preprocessor defined macros ......... ${combined_cpp_flags}")
+
+    string(STRIP "${CMAKE_C_FLAGS} ${CMAKE_C_FLAGS_${config_uppercase}}" combined_c_flags)
+    string(STRIP "${combined_c_flags} ${depends_c_flags}" combined_c_flags)
+    string(STRIP "${combined_c_flags} ${common_compile_options}" combined_c_flags)
+    message("  C compiler flags .................... ${combined_c_flags}")
+
+    string(STRIP "${CMAKE_CXX_FLAGS} ${CMAKE_CXX_FLAGS_${config_uppercase}}" combined_cxx_flags)
+    string(STRIP "${combined_cxx_flags} ${depends_cxx_flags}" combined_cxx_flags)
+    string(STRIP "${combined_cxx_flags} ${common_compile_options}" combined_cxx_flags)
+    message("  C++ compiler flags .................. ${combined_cxx_flags}")
+  endforeach()
 
   get_target_interface(common_link_options core_interface LINK_OPTIONS)
   string(STRIP "${CMAKE_EXE_LINKER_FLAGS} ${common_link_options}" combined_linker_flags)
   message("Linker flags .......................... ${combined_linker_flags}")
 endfunction()

Output:

Available build configurations ........ RelWithDebInfo, Debug, Release
Default build configuration ........... RelWithDebInfo
C compiler ............................ Clang 19.0.0, /usr/local/bin/clang-devel
C++ compiler .......................... Clang 19.0.0, /usr/local/bin/clang++-devel
'RelWithDebInfo' build configuration:
  Preprocessor defined macros ......... -DHAVE_CONFIG_H
  C compiler flags .................... -O2 -g -Werror ...
  C++ compiler flags .................. -O2 -g -Werror ...
'Debug' build configuration:
  Preprocessor defined macros ......... -DHAVE_CONFIG_H -DDEBUG ...
  C compiler flags .................... -O0 -g3 -Werror ...
  C++ compiler flags .................. -O0 -g3 -ftrapv -Werror ...
'Release' build configuration:
  Preprocessor defined macros ......... -DHAVE_CONFIG_H
  C compiler flags .................... -O2 -Werror ...
  C++ compiler flags .................. -O2 -Werror ...

or

Build configuration ................... Debug
C compiler ............................ Clang 19.0.0, /usr/local/bin/clang-devel
C++ compiler .......................... Clang 19.0.0, /usr/local/bin/clang++-devel
'Debug' build configuration:
  Preprocessor defined macros ......... -DHAVE_CONFIG_H -DDEBUG ...
  C compiler flags .................... -O0 -g3 -Werror ...
  C++ compiler flags .................. -O0 -g3 -ftrapv -Werror ...

hebasto · 2024-03-22T18:29:21Z

Reworked per @m3dwards's and @vasild's feedback.

vasild

ACK 484004b

vasild

ACK 4e52664

cmake/module/FlagsSummary.cmake

D33r-Gee

ACK 4e52664 tested on WSL Ubuntu 22.04.

Built both single and multi config both compiled properly

hebasto · 2024-05-30T09:10:17Z

Addressed the recent @vasild's comments.

vasild

ACK 628cae3

fanquake · 2024-05-30T09:49:43Z

cmake/module/FlagsSummary.cmake

+  indent_message("Preprocessor defined macros ..........." "${definitions}" ${indent_num})
+
+  string(STRIP "${CMAKE_C_FLAGS} ${CMAKE_C_FLAGS_${config_uppercase}}" combined_c_flags)
+  if(CMAKE_INTERPROCEDURAL_OPTIMIZATION)


if(CMAKE_INTERPROCEDURAL_OPTIMIZATION)
if(CMAKE_POSITION_INDEPENDENT_CODE)
if(CMAKE_CXX_LINK_PIE_SUPPORTED)

I bought this up here: #93 (comment), and was hoping there would be a more maintainable solution than just adding more conditionals, because this seems fragile, and hard to maintain.

For example, on my Alpine box, which uses a recent CMake, if I configure with cmake -B build -DCMAKE_LINKER_TYPE=LLD, -fuse-ld=lld isn't shown in the link flags summary:

Linker flags -O2 -g -fstack-reuse=none -fstack-protector-all -fstack-clash-protection -Wl,-z,relro -Wl,-z,now -Wl,-z,separate-code -fPIE -pie

even though it is used during linking:

/usr/bin/c++ -O2 -g -fstack-reuse=none -fstack-protector-all -fstack-clash-protection -Wl,-z,relro -Wl,-z,now -Wl,-z,separate-code -fuse-ld=lld -fPIE -pie <snip>

The approach used here basically requires us to maintain awareness of all relevant CMake options across all versions, and ensure that we are always keeping our own build system updated to accomodate them (as well as backport all these changes, so newer CMake versions work properly with older branches). I've been picking out examples here, but I'm sure there are more relevant CMake options that are still missing.

At this moment, I cannot suggest a more maintainable solution. Maybe someone could suggest it.

An alternative has been suggested in #218. It guarantees 100% accuracy, but still relies on CMake's implementation details.

e2f2f23 fixup! cmake: Add `HARDENING` option (Hennadii Stepanov) Pull request description: During testing #93, a few issues were [noticed](#93 (comment)): - > `-mbranch-protection=bti` shouldn't be in C flags The other change simplifies the summary code in #93. ACKs for top commit: m3dwards: ACK e2f2f23 Tree-SHA512: 386e3c180dbe68d76602bea12737651bbec398bfd5d75c32e3b235d418e60322e1c82ce08c4fb719e205705c5af2895d78d17d6907d8b370b5225dd8d4f0604b

hebasto · 2024-06-05T14:42:27Z

Rebased.

real-or-random · 2024-06-06T08:41:36Z

The approach used here basically requires us to maintain awareness of all relevant CMake options across all versions, and ensure that we are always keeping our own build system updated to accomodate them (as well as backport all these changes, so newer CMake versions work properly with older branches).

I agree. As someone with a fresh look (I had opened #221 without being aware of this PR...), I doubt that this is the right approach, despite the many ACKs. Replicating CMake's flag logic is difficult and requires a lot of maintenance. And it somehow defeats the purpose: CMake's philosophy is that handles some of the logic for us, and we don't have to bother with it.

I think the appropriate approach is to figure out the flags is run the build system and observe what it does. IIUC #218 is a step in this direction, but it's even more complex (more code and also more magic). This is "just" for a nice summary.

Taking a step back, I wonder if it's worth keeping the summary in this form at all. Alternatively, we could print a best-effort summary, which includes most of the flag variable and maybe some of the most common abstract options, e.g., CMAKE_INTERPROCEDURAL_OPTIMIZATION. This is enough for users to verify that CMake has picked up all their manually passed config options correctly. If they want to go deeper, and see the full truth (e.g., for debugging), it's anyway better to inspect the actual build, which can be as simple running make with V=1.

theuni · 2024-06-07T16:06:14Z

On our call yesterday I think I largely agreed with @real-or-random here. I proposed that we:

Consider the summary to be best-effort
Include the abstracted CMake flags that we touch ourselves (like CMAKE_POSITION_INDEPENDENT_CODE)
Add a note that the flags may not exactly match the final build output if a user has modified additional abstracted CMake flags.

As for the note, how about:

Note that the above summary may not exactly match the final applied build flags if any additional CMAKE_* or environment variables have been modified. In order to see the exact flags applied, build with cmake --build --verbose.

This change mirrors the master branch behavior.

core_depends_release_interface -> core_interface_relwithdebinfo core_depends_debug_interface -> core_interface_debug There is no need to refer to depends.

hebasto · 2024-06-08T14:20:26Z

Reworked per the recent discussions and comments.

vasild

ACK 5c786ec

Tested and works as expected. -DAPPEND_... are present in the summary. Compared the summary flags with the actual flags. The actual flags have some additions which are not printed in the summary:

C++:

-DBOOST_MULTI_INDEX_DISABLE_SERIALIZATION
-D_THREAD_SAFE
-I/SOURCE/src
-I/SOURCE/src/leveldb/include
-I/SOURCE/src/minisketch/include
-I/SOURCE/src/univalue/include
-I/BUILD/src
-fcolor-diagnostics  # because of -DCMAKE_COLOR_DIAGNOSTICS=ON
-isystem /usr/local/include
-pthread
-std=c++20

Linking:

-Wl,-rpath,/usr/local/lib:
-pthread

real-or-random · 2024-06-11T08:24:43Z

Approach ACK

This solves #221 from my point of view. (I had suggested a different approach in #221, but I think the current PR with all compiler flags simply summarized on a single line is better for the average user.)

hebasto · 2024-06-17T13:37:03Z

Tested and works as expected. -DAPPEND_... are present in the summary. Compared the summary flags with the actual flags. The actual flags have some additions which are not printed in the summary:

C++:
-DBOOST_MULTI_INDEX_DISABLE_SERIALIZATION
-D_THREAD_SAFE
-I/SOURCE/src
-I/SOURCE/src/leveldb/include
-I/SOURCE/src/minisketch/include
-I/SOURCE/src/univalue/include
-I/BUILD/src
-fcolor-diagnostics  # because of -DCMAKE_COLOR_DIAGNOSTICS=ON
-isystem /usr/local/include
-pthread
-std=c++20
Linking:
-Wl,-rpath,/usr/local/lib:
-pthread

CMake abstracts -std=c++20 as the CMAKE_CXX_STANDARD variable, which we set explicitly. Therefore, it has been added to the summary as it was requested during the offline meeting last week.

4cd15f1 cmake: Remove unused `TristateOption` module (Hennadii Stepanov) 686a731 cmake [KILL 3-STATE]: Switch `WITH_CCACHE` to boolean (Hennadii Stepanov) Pull request description: This PR makes `WITH_CCACHE` an opportunistic boolean option with the default value `ON`. Also the build system learned to tell ccache in the [masquerade](https://ccache.dev/manual/4.9.1.html#_run_modes) mode, which addresses this #93 (comment). The `TristateOption` module has been deleted as planned. ACKs for top commit: m3dwards: ACK 4cd15f1 Tree-SHA512: 6df4d0b9ca06a2362596cfa972d5914ef95d3def15ba51a30745933a8a9bab212d02a7fc22ca9f8a564874aca853c3a9203b421f5e2dd7a1121f7cce7aaa968d

vasild

ACK 6068714

-std= is now added to the summary.

It is somewhat strange that we compile C in -std=c90 and C++ in -std=c++20 mode, but I guess they do not necessary have to be the same. Btw that naming has a y2k problem ;-)

hebasto mentioned this pull request Feb 6, 2024

cmake: Rework handling compiler flags #82

Merged

hebasto force-pushed the 240206-cmake-BG branch from aafd8d3 to 184c663 Compare February 6, 2024 14:32

hebasto added the enhancement New feature or request label Feb 6, 2024

hebasto force-pushed the cmake-staging branch from 17f4870 to 6367599 Compare February 9, 2024 18:38

hebasto force-pushed the 240206-cmake-BG branch from 184c663 to 7c82984 Compare February 9, 2024 19:10

hebasto force-pushed the 240206-cmake-BG branch from 7c82984 to 2890ef1 Compare February 9, 2024 22:16

pablomartin4btc reviewed Feb 29, 2024

View reviewed changes

hebasto force-pushed the cmake-staging branch from 15edb82 to 9e07ce3 Compare March 1, 2024 15:32

hebasto force-pushed the 240206-cmake-BG branch from 2890ef1 to d8d9ced Compare March 1, 2024 17:35

pablomartin4btc reviewed Mar 5, 2024

View reviewed changes

hebasto force-pushed the cmake-staging branch from 2716ccf to 81f3d4f Compare March 8, 2024 15:22

hebasto force-pushed the 240206-cmake-BG branch from d8d9ced to d2e335e Compare March 18, 2024 10:36

hebasto force-pushed the 240206-cmake-BG branch 3 times, most recently from f4f8a6c to a3a3d10 Compare March 22, 2024 18:25

hebasto force-pushed the 240206-cmake-BG branch from a3a3d10 to 484004b Compare March 22, 2024 18:33

hebasto force-pushed the cmake-staging branch from 700eaae to 8078427 Compare March 26, 2024 09:07

vasild approved these changes Mar 27, 2024

View reviewed changes

hebasto force-pushed the cmake-staging branch from a3313e2 to 418b4f4 Compare April 3, 2024 15:40

hebasto mentioned this pull request Apr 16, 2024

build: Add CMake buildsystem sipa/minisketch#75

Open

hebasto force-pushed the cmake-staging branch from bdaa036 to af998da Compare April 18, 2024 10:12

vasild approved these changes May 29, 2024

View reviewed changes

cmake/module/FlagsSummary.cmake Outdated Show resolved Hide resolved

cmake/module/FlagsSummary.cmake Outdated Show resolved Hide resolved

D33r-Gee reviewed May 29, 2024

View reviewed changes

hebasto force-pushed the 240206-cmake-BG branch from 4e52664 to 628cae3 Compare May 30, 2024 09:09

vasild approved these changes May 30, 2024

View reviewed changes

fanquake reviewed May 30, 2024

View reviewed changes

hebasto mentioned this pull request May 31, 2024

[POC] cmake: Rework compile/link flags summary -- an alternative implemenation #218

Closed

hebasto force-pushed the 240206-cmake-BG branch from 628cae3 to 50f9f3b Compare June 4, 2024 08:33

hebasto mentioned this pull request Jun 5, 2024

cmake build summary could be clearer #221

Closed

hebasto force-pushed the cmake-staging branch from 0e6def0 to 597da83 Compare June 5, 2024 14:35

hebasto force-pushed the 240206-cmake-BG branch from 50f9f3b to 0f85035 Compare June 5, 2024 14:42

hebasto force-pushed the 240206-cmake-BG branch from 0f85035 to 01ac165 Compare June 6, 2024 10:39

hebasto added 2 commits June 8, 2024 14:23

[FIXUP] cmake: Do not apply hardening flags to libsecp256k1 C code

44bec68

This change mirrors the master branch behavior.

[FIXUP] cmake: Rename interfaces

9dbbd05

core_depends_release_interface -> core_interface_relwithdebinfo core_depends_debug_interface -> core_interface_debug There is no need to refer to depends.

hebasto force-pushed the 240206-cmake-BG branch from 01ac165 to 5c786ec Compare June 8, 2024 14:19

vasild approved these changes Jun 11, 2024

View reviewed changes

[FIXUP] cmake: Rework compile/link flags summary

6068714

hebasto force-pushed the 240206-cmake-BG branch from 5c786ec to 6068714 Compare June 17, 2024 13:33

hebasto added this to the Ready for master milestone Jun 18, 2024

vasild approved these changes Jun 18, 2024

View reviewed changes

hebasto merged commit 0211ee2 into cmake-staging Jun 18, 2024
36 checks passed

hebasto mentioned this pull request Jun 28, 2024

cmake: Rework flags summary bitcoin-core/secp256k1#1558

Draft

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FIXUP] cmake: Rework compile/link flags summary #93

[FIXUP] cmake: Rework compile/link flags summary #93

hebasto commented Feb 6, 2024 •

edited

Loading

hebasto commented Feb 6, 2024

fanquake commented Feb 6, 2024

hebasto commented Feb 6, 2024

hebasto commented Feb 9, 2024

pablomartin4btc left a comment

pablomartin4btc left a comment

m3dwards commented Mar 7, 2024

hebasto commented Mar 18, 2024

hebasto commented Mar 18, 2024

vasild commented Mar 22, 2024

hebasto commented Mar 22, 2024

vasild left a comment

vasild left a comment •

edited

Loading

D33r-Gee left a comment

hebasto commented May 30, 2024

vasild left a comment

fanquake May 30, 2024

hebasto May 30, 2024

hebasto May 31, 2024

hebasto commented Jun 5, 2024

real-or-random commented Jun 6, 2024

theuni commented Jun 7, 2024

hebasto commented Jun 8, 2024

vasild left a comment

real-or-random commented Jun 11, 2024

hebasto commented Jun 17, 2024

vasild left a comment

[FIXUP] cmake: Rework compile/link flags summary #93

[FIXUP] cmake: Rework compile/link flags summary #93

Conversation

hebasto commented Feb 6, 2024 • edited Loading

hebasto commented Feb 6, 2024

fanquake commented Feb 6, 2024

hebasto commented Feb 6, 2024

hebasto commented Feb 9, 2024

pablomartin4btc left a comment

Choose a reason for hiding this comment

pablomartin4btc left a comment

Choose a reason for hiding this comment

m3dwards commented Mar 7, 2024

hebasto commented Mar 18, 2024

hebasto commented Mar 18, 2024

vasild commented Mar 22, 2024

hebasto commented Mar 22, 2024

vasild left a comment

Choose a reason for hiding this comment

vasild left a comment • edited Loading

Choose a reason for hiding this comment

D33r-Gee left a comment

Choose a reason for hiding this comment

hebasto commented May 30, 2024

vasild left a comment

Choose a reason for hiding this comment

fanquake May 30, 2024

Choose a reason for hiding this comment

hebasto May 30, 2024

Choose a reason for hiding this comment

hebasto May 31, 2024

Choose a reason for hiding this comment

hebasto commented Jun 5, 2024

real-or-random commented Jun 6, 2024

theuni commented Jun 7, 2024

hebasto commented Jun 8, 2024

vasild left a comment

Choose a reason for hiding this comment

real-or-random commented Jun 11, 2024

hebasto commented Jun 17, 2024

vasild left a comment

Choose a reason for hiding this comment

hebasto commented Feb 6, 2024 •

edited

Loading

vasild left a comment •

edited

Loading