bb8e3f45a6
Ccache CMake build system has some conditions that automatically
enables a developer mode (sets CCACHE_DEV_MODE=ON). See [1].
More specifically, if CCACHE_DEV_MODE is unset AND the environment
variable "CI" is set, CCACHE_DEV_MODE is set to "ON".
This situation can happen when Buildroot builds are executed in
Jenkins jobs, for example. Since Buildroot does not set
CCACHE_DEV_MODE and Jenkins sets the "CI" environment variable,
this ccache developer mode can be enabled in an unexpected way
for the Buildroot user. For example, it happened that a Jenkins build
breaks, while the build with the same configuration in the user
session is working.
One of the effects of enabling this ccache developer mode, is to treat
compiler warnings as errors, see [3]. This can lead to build error,
depending on the ccache version and the host compiler being used.
This behavior can be reproduced and observed, with commands:
cat > .config <<EOF
BR2_aarch64=y
BR2_TOOLCHAIN_EXTERNAL=y
BR2_CCACHE=y
BR2_PACKAGE_BUSYBOX=y
EOF
make olddefconfig
make clean
make host-ccache
Outputs:
...
-- Ccache version: 4.9.1
-- Ccache dev mode: OFF
-- Setting CMAKE_BUILD_TYPE to Release as none was specified.
...
Whereas:
make clean
CI=true make host-ccache
Outputs:
...
-- Ccache version: 4.9.1
-- Ccache dev mode: ON
-- Setting CMAKE_BUILD_TYPE to Debug as none was specified.
...
For a failure example: on Fedora 40 with host gcc 14.1.1, Buildroot at
tag 2024.02 has ccache 4.8.2. Host ccache can fail, when building with
"CI=true make host-ccache" with output:
/buildroot/output/build/host-ccache-4.8.2/src/third_party/fmt/core.h:3119:44: in 'constexpr' expansion of 'fmt::v8::make_format_args<>(args#0, args#1)'
/buildroot/output/build/host-ccache-4.8.2/src/third_party/fmt/core.h:1706:15: error: possibly dangling reference to a temporary [-Werror=dangling-reference]
1706 | const auto& arg = arg_mapper<Context>().map(std::forward<T>(val));
| ^~~
This commit sets CCACHE_DEV_MODE=OFF to make the ccache behavior more
deterministic in Buildroot, independently of being used in a CI tool
or not.
[1] https://github.com/ccache/ccache/blob/v4.9.1/CMakeLists.txt#L56
[2] https://github.com/jenkinsci/jenkins/blob/jenkins-2.459/core/src/main/java/jenkins/model/CoreEnvironmentContributor.java#L43
[3] https://github.com/ccache/ccache/blob/v4.9.1/cmake/StandardWarnings.cmake#L5
Reported-by: Xavier Roumegue <xroumegue@gmail.com>
Signed-off-by: Julien Olivain <ju.o@free.fr>
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
(cherry picked from commit 197be7ed87)
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
78 lines
2.7 KiB
Makefile
78 lines
2.7 KiB
Makefile
################################################################################
|
|
#
|
|
# ccache
|
|
#
|
|
################################################################################
|
|
|
|
CCACHE_VERSION = 4.8.2
|
|
CCACHE_SITE = https://github.com/ccache/ccache/releases/download/v$(CCACHE_VERSION)
|
|
CCACHE_SOURCE = ccache-$(CCACHE_VERSION).tar.xz
|
|
CCACHE_LICENSE = GPL-3.0+, others
|
|
CCACHE_LICENSE_FILES = LICENSE.adoc GPL-3.0.txt
|
|
HOST_CCACHE_DEPENDENCIES = host-hiredis host-zstd
|
|
|
|
# We are ccache, so we can't use ccache
|
|
HOST_CCACHE_CONF_OPTS += \
|
|
-UCMAKE_C_COMPILER_LAUNCHER \
|
|
-UCMAKE_CXX_COMPILER_LAUNCHER \
|
|
-DCCACHE_DEV_MODE=OFF \
|
|
-DZSTD_FROM_INTERNET=OFF \
|
|
-DHIREDIS_FROM_INTERNET=OFF \
|
|
-DENABLE_TESTING=OFF
|
|
|
|
# Patch host-ccache as follows:
|
|
# - Use BR_CACHE_DIR instead of CCACHE_DIR, because CCACHE_DIR
|
|
# is already used by autotargets for the ccache package.
|
|
# BR_CACHE_DIR is exported by Makefile based on config option
|
|
# BR2_CCACHE_DIR.
|
|
# - Change hard-coded last-ditch default to match path in .config, to avoid
|
|
# the need to specify BR_CACHE_DIR when invoking ccache directly.
|
|
# CCache replaces "home_dir" with the home directory of the current user,
|
|
# so rewrite BR_CACHE_DIR to take that into consideration for SDK purpose
|
|
HOST_CCACHE_DEFAULT_CCACHE_DIR = $(patsubst $(HOME)/%,%,$(BR_CACHE_DIR))
|
|
|
|
define HOST_CCACHE_PATCH_CONFIGURATION
|
|
sed -i 's,getenv("CCACHE_DIR"),getenv("BR_CACHE_DIR"),' $(@D)/src/Config.cpp
|
|
sed -i 's,".ccache","$(HOST_CCACHE_DEFAULT_CCACHE_DIR)",' $(@D)/src/Config.cpp
|
|
sed -i 's,"/.cache/ccache","/$(HOST_CCACHE_DEFAULT_CCACHE_DIR)",' $(@D)/src/Config.cpp
|
|
sed -i 's,"/.config/ccache","/$(HOST_CCACHE_DEFAULT_CCACHE_DIR)",' $(@D)/src/Config.cpp
|
|
sed -i 's,getenv("XDG_CACHE_HOME"),nullptr,' $(@D)/src/Config.cpp
|
|
sed -i 's,getenv("XDG_CONFIG_HOME"),nullptr,' $(@D)/src/Config.cpp
|
|
endef
|
|
|
|
HOST_CCACHE_POST_PATCH_HOOKS += HOST_CCACHE_PATCH_CONFIGURATION
|
|
|
|
define HOST_CCACHE_MAKE_CACHE_DIR
|
|
mkdir -p $(BR_CACHE_DIR)
|
|
endef
|
|
|
|
HOST_CCACHE_POST_INSTALL_HOOKS += HOST_CCACHE_MAKE_CACHE_DIR
|
|
|
|
# Provide capability to do initial ccache setup (e.g. increase default size)
|
|
BR_CCACHE_INITIAL_SETUP = $(call qstrip,$(BR2_CCACHE_INITIAL_SETUP))
|
|
ifneq ($(BR_CCACHE_INITIAL_SETUP),)
|
|
define HOST_CCACHE_DO_INITIAL_SETUP
|
|
@$(call MESSAGE,"Applying initial settings")
|
|
$(CCACHE) $(BR_CCACHE_INITIAL_SETUP)
|
|
$(CCACHE) -s
|
|
endef
|
|
|
|
HOST_CCACHE_POST_INSTALL_HOOKS += HOST_CCACHE_DO_INITIAL_SETUP
|
|
endif
|
|
|
|
$(eval $(host-cmake-package))
|
|
|
|
ifeq ($(BR2_CCACHE),y)
|
|
ccache-stats: host-ccache
|
|
$(Q)$(CCACHE) -s
|
|
|
|
ccache-options: host-ccache
|
|
ifeq ($(CCACHE_OPTIONS),)
|
|
$(Q)echo "Usage: make ccache-options CCACHE_OPTIONS=\"opts\""
|
|
$(Q)echo "where 'opts' corresponds to one or more valid ccache options" \
|
|
"(see ccache help text below)"
|
|
$(Q)echo
|
|
endif
|
|
$(Q)$(CCACHE) $(CCACHE_OPTIONS)
|
|
endif
|