Bug 179971 – [CMake] Values of CMAKE_BUILD_TYPE from toolchain file are ignored

• Status: RESOLVED
• Resolution: FIXED
• Component: Tools / Tests

[Adrian Perez]

I have noticed this one while working with Buildroot. For CMake-based
packages it generates a “Toolchain file” [1] which defines the paths
to the cross-compilation tools, build options, and so on. This toolchain
file also specifies the build type with:

  # Build type from the Buildroot configuration                                    
  set(CMAKE_BUILD_TYPE Release CACHE STRING "Buildroot build configuration")       

Nevertheless, when WebKit is configured with the above setting, it will
notify that “RelWithDebInfo” is being used instead (output re-formatted
by me for clarity) — the value from the toolchain file is ignored:

  >>> wpewebkit custom Configuring
  (mkdir -p /home/aperez/devel/wpe/buildroot-wpe-overlay/buildroot-2017.08.1/output/build/wpewebkit-custom/ && \
   cd /home/aperez/devel/wpe/buildroot-wpe-overlay/buildroot-2017.08.1/output/build/wpewebkit-custom/ && \
   rm -f CMakeCache.txt && \
   PATH="/home/aperez/devel/wpe/buildroot-wpe-overlay/buildroot-2017.08.1/output/host/bin:/home/aperez/devel/wpe/buildroot-wpe-overlay/buildroot-2017.08.1/output/host/sbin:/usr/local/bin:/usr/local/sbin" \
     /usr/bin/cmake /home/aperez/devel/wpe/buildroot-wpe-overlay/buildroot-2017.08.1/output/build/wpewebkit-custom/ \
     -DCMAKE_TOOLCHAIN_FILE="/home/aperez/devel/wpe/buildroot-wpe-overlay/buildroot-2017.08.1/output/host/share/buildroot/toolchainfile.cmake" \
     -DCMAKE_INSTALL_PREFIX="/usr" \
     -DCMAKE_COLOR_MAKEFILE=OFF \
     -DBUILD_DOC=OFF \
     -DBUILD_DOCS=OFF \
     -DBUILD_EXAMPLE=OFF \
     -DBUILD_EXAMPLES=OFF \
     -DBUILD_TEST=OFF \
     -DBUILD_TESTS=OFF \
     -DBUILD_TESTING=OFF \
     -DBUILD_SHARED_LIBS=ON \
     -DENABLE_API_TESTS=OFF \
     -DENABLE_GEOLOCATION=OFF \
     -DENABLE_GTKDOC=OFF \
     -DENABLE_INTROSPECTION=OFF \
     -DENABLE_MINIBROWSER=OFF \
     -DENABLE_SPELLCHECK=OFF \
     -DPORT=WPE \
     -DENABLE_JIT=ON \
     -DENABLE_VIDEO=OFF \
     -DENABLE_WEB_AUDIO=OFF \
     -DENABLE_MEDIA_STREAM=OFF \
     -DENABLE_WEB_CRYPTO=OFF \
     -DENABLE_WEBDRIVER=OFF \
     -DENABLE_XSLT=OFF )
  CMake Warning at CMakeLists.txt:7 (message):
    No CMAKE_BUILD_TYPE value specified, defaulting to RelWithDebInfo.

Probably this has to do with how we are trying to detect whether “CMAKE_BUILD_TYPE”
was set (or not) in the command line. In this case it is not coming directly from
the command line, and it is being reset to “RelWithDebInfo”.

This is definitely having an impact on the build results: If I patch the Buildroot
recipe to pass “-DCMAKE_BUILD_TYPE=Release” in the command line, instead of letting
the default “RelWithDebInfo” overwrite the setting from the toolchain file, then
the resulting binaries take ~17 MiB less of disk space.


---
[1] https://cmake.org/cmake/help/v3.3/variable/CMAKE_TOOLCHAIN_FILE.html

[Adrian Perez]

Created attachment 327489 [details]
Example toolchainfile.cmake generated by Buildroot

[Michael Catanzaro]

The code at the top of our toplevel CMakeLists.txt is this:

if (NOT CMAKE_BUILD_TYPE)
    message(WARNING "No CMAKE_BUILD_TYPE value specified, defaulting to RelWithDebInfo.")
    set(CMAKE_BUILD_TYPE "RelWithDebInfo" CACHE STRING "Choose the type of build." FORCE)
else ()
    message(STATUS "The CMake build type is: ${CMAKE_BUILD_TYPE}")
endif ()

So... that's fairly straightforward.

Are the other variables in the toolchain file already set before that point?

[Adrian Perez]

(In reply to Michael Catanzaro from comment #2)
> The code at the top of our toplevel CMakeLists.txt is this:
> 
> if (NOT CMAKE_BUILD_TYPE)
>     message(WARNING "No CMAKE_BUILD_TYPE value specified, defaulting to
> RelWithDebInfo.")
>     set(CMAKE_BUILD_TYPE "RelWithDebInfo" CACHE STRING "Choose the type of
> build." FORCE)
> else ()
>     message(STATUS "The CMake build type is: ${CMAKE_BUILD_TYPE}")
> endif ()
> 
> So... that's fairly straightforward.

It is, indeed! It's puzzling, and I have no idea why CMake is so
bizarre. I suspect that the toolchain file is NOT loaded directly
on startup, but included by some file from “/usrshare/cmake/*”,
and those get pulled in by one of the top-level commands used to
configure.

> Are the other variables in the toolchain file already set before that point?

Will check. Probably not if my hypothesis as outlined above is
correct.

[Adrian Perez]

Created attachment 327524 [details]
Patch

[Adrian Perez]

(In reply to Adrian Perez from comment #3)
> (In reply to Michael Catanzaro from comment #2)
> > The code at the top of our toplevel CMakeLists.txt is this:
> > 
> > if (NOT CMAKE_BUILD_TYPE)
> >     message(WARNING "No CMAKE_BUILD_TYPE value specified, defaulting to
> > RelWithDebInfo.")
> >     set(CMAKE_BUILD_TYPE "RelWithDebInfo" CACHE STRING "Choose the type of
> > build." FORCE)
> > else ()
> >     message(STATUS "The CMake build type is: ${CMAKE_BUILD_TYPE}")
> > endif ()
> > 
> > So... that's fairly straightforward.
> 
> It is, indeed! It's puzzling, and I have no idea why CMake is so
> bizarre. I suspect that the toolchain file is NOT loaded directly
> on startup, but included by some file from “/usrshare/cmake/*”,
> and those get pulled in by one of the top-level commands used to
> configure.

It turns out that the call to “project()” in the top-level CMakeLists.txt
is what checks “CMAKE_TOOLCHAIN_FILE” and loads it. Therefore we need to
call “project()” first before checking anything.

[Carlos Alberto Lopez Perez]

Comment on attachment 327524 [details]
Patch

View in context: https://bugs.webkit.org/attachment.cgi?id=327524&action=review

wow, this is certainly tricky.

> CMakeLists.txt:10
>  
> +project(WebKit)
> +
>  if (NOT CMAKE_BUILD_TYPE)
>      message(WARNING "No CMAKE_BUILD_TYPE value specified, defaulting to RelWithDebInfo.")
>      set(CMAKE_BUILD_TYPE "RelWithDebInfo" CACHE STRING "Choose the type of build." FORCE)

I think this deserves a comment line saying that calling project first is needed to automatically define CMAKE_BUILD_TYPE from the toolchain file

[Adrian Perez]

(In reply to Carlos Alberto Lopez Perez from comment #6)
> Comment on attachment 327524 [details]
> Patch
> 
> View in context:
> https://bugs.webkit.org/attachment.cgi?id=327524&action=review
> 
> wow, this is certainly tricky.
> 
> > CMakeLists.txt:10
> >  
> > +project(WebKit)
> > +
> >  if (NOT CMAKE_BUILD_TYPE)
> >      message(WARNING "No CMAKE_BUILD_TYPE value specified, defaulting to RelWithDebInfo.")
> >      set(CMAKE_BUILD_TYPE "RelWithDebInfo" CACHE STRING "Choose the type of build." FORCE)
> 
> I think this deserves a comment line saying that calling project first is
> needed to automatically define CMAKE_BUILD_TYPE from the toolchain file

I'll add the comment before landing the change, with a link to

  https://cmake.org/cmake/help/v3.3/command/project.html

where it says that “project()” must be the first command (it does not explain
very well why, but then again not being particularly clear is something the
CMake documentation tends to do).

[Adrian Perez]

Created attachment 327629 [details]
Patch for landing

[WebKit Commit Bot]

Comment on attachment 327629 [details]
Patch for landing

Clearing flags on attachment: 327629

Committed r225168: <https://trac.webkit.org/changeset/225168>

[WebKit Commit Bot]

All reviewed patches have been landed.  Closing bug.

[Radar WebKit Bug Importer]

<rdar://problem/35697658>