toolchain.inc

   1 # SPDX-License-Identifier: GPL-2.0-only
   2
   3 # ccache integration
   4 ifeq ($(CONFIG_CCACHE),y)
   5
   6 CCACHE:=$(word 1,$(wildcard $(addsuffix /ccache,$(subst :, ,$(PATH)))))
   7 ifeq ($(CCACHE),)
   8 $(error ccache selected, but not found in PATH)
   9 endif
  10
  11 export CCACHE_COMPILERCHECK=content
  12 export CCACHE_BASEDIR=$(top)
  13
  14 $(foreach arch,$(ARCH_SUPPORTED), \
  15         $(eval CC_$(arch):=$(CCACHE) $(CC_$(arch))))
  16
  17 HOSTCC:=$(CCACHE) $(HOSTCC)
  18 HOSTCXX:=$(CCACHE) $(HOSTCXX)
  19 endif
  20
  21 # scan-build integration
  22 ifneq ($(CCC_ANALYZER_OUTPUT_FORMAT),)
  23
  24 ifeq ($(CCC_ANALYZER_ANALYSIS),)
  25 export CCC_ANALYZER_ANALYSIS := -analyzer-opt-analyze-headers
  26 endif
  27
  28 $(foreach arch,$(ARCH_SUPPORTED), \
  29         $(eval CC_$(arch):=CCC_CC="$(CC_$(arch))" $(CC) ))
  30
  31 HOSTCC:=CCC_CC="$(HOSTCC)" $(CC)
  32 HOSTCXX:=CCC_CXX="$(HOSTCXX)" $(CXX)
  33 endif
  34
  35 # include-what-you-use integration
  36 ifeq ($(CONFIG_IWYU),y)
  37
  38 IWYU:=$(word 1,$(wildcard $(addsuffix /iwyu,$(subst :, ,$(PATH)))))
  39 ifeq ($(IWYU),)
  40 $(error include-what-you-use selected, but not found in PATH)
  41 endif
  42
  43 $(foreach arch,$(ARCH_SUPPORTED), \
  44         $(eval CC_$(arch):=$(IWYU) ))
  45
  46 CFLAGS_common := -Xiwyu --prefix_header_includes=remove  -Xiwyu --no_comments  -Xiwyu --no_fwd_decls $(CFLAGS_common)
  47 NOCOMPILE := 1
  48 endif
  49
  50 COREBOOT_STANDARD_STAGES := decompressor bootblock verstage romstage ramstage
  51 MAP-decompressor := bootblock
  52
  53 ARCHDIR-i386    := x86
  54 ARCHDIR-x86_32  := x86
  55 ARCHDIR-x86_64  := x86
  56 ARCHDIR-arm     := arm
  57 ARCHDIR-arm64   := arm64
  58 ARCHDIR-riscv   := riscv
  59 ARCHDIR-ppc64   := ppc64
  60
  61 CFLAGS_arm      +=
  62 CFLAGS_arm64    += -mgeneral-regs-only
  63 CFLAGS_riscv    +=
  64 CFLAGS_x86_32   +=
  65 CFLAGS_x86_64   += -mcmodel=large -mno-red-zone
  66 CFLAGS_ppc64    +=
  67
  68 GCC_ADAFLAGS_arm        +=
  69 GCC_ADAFLAGS_arm64      += -mgeneral-regs-only
  70 GCC_ADAFLAGS_riscv      +=
  71 GCC_ADAFLAGS_x86_32     +=
  72 GCC_ADAFLAGS_x86_64     += -mcmodel=large -mno-red-zone
  73 GCC_ADAFLAGS_ppc64      +=
  74
  75 # Some boards only provide 2K stacks, so storing lots of data there leads to
  76 # problems. Since C rules don't allow us to statically determine the maximum
  77 # stack use, we use 1.5K as heuristic, assuming that we typically have lots
  78 # of tiny stack frames and the odd large one.
  79 #
  80 # Store larger buffers in BSS, use static to share data in cache-as-ram
  81 # on x86.
  82 # Since GCCs detection of dynamic array bounds unfortunately seems to be
  83 # very basic, you'll sometimes have to use a static upper bound for the
  84 # size and an assert() to make sure it's honored (see gpio_base3_value()
  85 # for an example).
  86 # (If you absolutely need a larger stack frame and are 100% sure it cannot
  87 # cause problems, you can whitelist it with #pragma diagnostic.)
  88 ifeq ($(CONFIG_COMPILER_GCC),y)
  89 CFLAGS_arm      += -Wstack-usage=1536
  90 CFLAGS_arm64    += -Wstack-usage=1536
  91 CFLAGS_riscv    += -Wstack-usage=1536
  92 CFLAGS_ppc64    += -Wstack-usage=1536
  93 endif
  94
  95 toolchain_to_dir = \
  96         $(foreach arch,$(ARCH_SUPPORTED),\
  97         $(eval CPPFLAGS_$(arch) += \
  98         -Isrc/arch/$(ARCHDIR-$(arch))/include))
  99
 100 # set_stage_toolchain: Decides the toolchain to be used by every stage
 101 # E.g.: If bootblock is x86_32, it sets ARCH-BOOTBLOCK-y = x86_32, whereas
 102 # ARCH-BOOTBLOCK-n = armv7. Then, ARCH-BOOTBLOCK-y can be used anywhere to
 103 # decide the compiler toolchain for bootblock stage
 104 # This step is essential for initializing the toolchain for coreboot standard
 105 # stages i.e. bootblock, romstage and ramstage, since it acts as the second
 106 # parameter to create_class_compiler below in init_standard_toolchain
 107 map_stage = $(strip $(if $(MAP-$(1)),$(MAP-$(1)),$(1)))
 108 set_stage_toolchain= \
 109         $(foreach arch,$(ARCH_SUPPORTED), \
 110         $(eval ARCH-$(1)-$($(shell \
 111                 echo CONFIG_ARCH_$(call map_stage,$(1))_$(arch) | \
 112                 tr '[:lower:]' '[:upper:]')) := $(arch)))
 113
 114 # standard-archs: Tell which architectures are used by the standard stages.
 115 standard-archs = $(sort $(foreach stagearch, \
 116                           $(patsubst %,ARCH-%-y,$(COREBOOT_STANDARD_STAGES)), \
 117                           $($(stagearch))))
 118
 119 # create_class_compiler: Used to create compiler tool set for
 120 # special classes
 121 # @1: special class
 122 # @2: compiler set to be used
 123 # e.g.: smm special class uses i386 as compiler set
 124 define create_class_compiler
 125 $(if $(2),,$(warning *** The toolchain architecture for $(1) is unknown.) \
 126         $(warning CONFIG_ARCH_$(1)_* settings in $(DOTCONFIG):) \
 127         $(error $(shell grep CONFIG_ARCH_$(1)_ $(DOTCONFIG))))
 128 CC_$(1) := $(CC_$(2))
 129 GCC_$(1) := $(GCC_CC_$(2))
 130 LD_$(1) := $(LD_$(2))
 131 NM_$(1) := $(NM_$(2))
 132 AR_$(1) := $(AR_$(2))
 133 GNATBIND_$(1) := $(GNATBIND_$(2))
 134 OBJCOPY_$(1) := $(OBJCOPY_$(2))
 135 OBJDUMP_$(1) := $(OBJDUMP_$(2))
 136 STRIP_$(1) := $(STRIP_$(2))
 137 READELF_$(1) := $(READELF_$(2))
 138 CFLAGS_$(1) = $$(CFLAGS_common) $$(CFLAGS_$(2))
 139 ADAFLAGS_$(1) = --RTS=$$(obj)/libgnat-$(2)/ $$(ADAFLAGS_common) $$(GCC_ADAFLAGS_$(2))
 140 CPPFLAGS_$(1) = $$(CPPFLAGS_common) $$(CPPFLAGS_$(2)) -D__ARCH_$(2)__
 141 COMPILER_RT_$(1) := $$(COMPILER_RT_$(2))
 142 COMPILER_RT_FLAGS_$(1) := $$(COMPILER_RT_FLAGS_$(2))
 143 LDFLAGS_$(1) = $$(LDFLAGS_common) $$(LDFLAGS_$(2))
 144 endef
 145
 146 # define_class: Allows defining any program as dynamic class and compiler tool
 147 # set for the same based on the architecture for which the program is to be
 148 # compiled
 149 # @1: program (class name)
 150 # @2: architecture for which the program needs to be compiled
 151 # IMP: Ensure that define_class is called before any .c or .S files are added to
 152 # the class of the program. Check subdirs-y for order of subdirectory inclusions
 153 define define_class
 154 classes-y += $(1)
 155 $(eval $(call create_class_compiler,$(1),$(2)))
 156 endef
 157
 158 # initialize standard toolchain (CC,AS and others) for give stage
 159 # @1 : stage for which the toolchain is to be initialized
 160 init_standard_toolchain = \
 161         $(eval $(call set_stage_toolchain,$(1))) \
 162         $(eval $(call create_class_compiler,$(1),$(ARCH-$(1)-y)))
 163
 164 init_stages = \
 165         $(foreach stage,$(COREBOOT_STANDARD_STAGES), \
 166         $(eval $(call init_standard_toolchain,$(stage))))
 167
 168 $(eval $(call toolchain_to_dir))
 169
 170 $(call init_stages)
 171
 172 # Test for coreboot toolchain (except when explicitly not requested)
 173 ifneq ($(NOCOMPILE),1)
 174 # Only run if we're doing a build (not for tests, kconfig, ...)
 175 # rationale: gcc versions by Linux distributions tend to be quite messed up
 176 # llvm/clang also needs patches supplied by the coreboot build
 177 COMPILERFAIL:=0
 178 IASLFAIL:=0
 179
 180 ifneq ($(CONFIG_ANY_TOOLCHAIN),y)
 181 # Verify that the coreboot toolchain is being used.
 182 $(foreach arch,$(sort $(foreach stage,\
 183         $(COREBOOT_STANDARD_STAGES),$(ARCH-$(stage)-y))), \
 184         $(if $(shell if [ -n "$(CC_$(arch))" ]; then \
 185                 $(CC_$(arch)) -v 2>&1 | grep -q "coreboot toolchain" || \
 186                 echo not-coreboot; else echo not-coreboot; fi), \
 187                 $(eval COMPILERFAIL:=1)\
 188                 $(warning The coreboot toolchain for '$(arch)'\
 189                         architecture was not found.)))
 190 # If iasl doesn't match the current coreboot version, fail the test
 191 # TODO: Figure out if iasl is even needed for the build.
 192 $(if $(shell if [ -n "$(IASL)" ]; then \
 193         $(IASL) -v 2>&1 | grep -q "coreboot toolchain" || \
 194         echo not-coreboot; else echo not-coreboot; fi), \
 195         $(eval COMPILERFAIL:=1)$(eval IASLFAIL:=1)\
 196         $(warning The coreboot toolchain version of iasl \
 197                 '$(shell util/crossgcc/buildgcc -s iasl)' was not found))
 198 else #$(CONFIG_ANY_TOOLCHAIN)
 199 # If the coreboot toolchain isn't being used, verify that there is A toolchain
 200 $(foreach arch,$(sort \
 201         $(foreach stage,$(COREBOOT_STANDARD_STAGES),$(ARCH-$(stage)-y))), \
 202         $(if $(CC_$(arch)),, $(eval COMPILERFAIL:=1) \
 203         $(warning No compiler found for '$(arch)' architecture. \
 204                 Install one or use the coreboot toolchain?)) )
 205 # If iasl isn't present, fail
 206 # TODO: Figure out if iasl is even needed for the build.
 207 $(if $(IASL),, $(eval COMPILERFAIL:=1)$(eval IASLFAIL:=1) \
 208         $(warning iasl not found. \
 209                 Please install it or use the coreboot toolchain.))
 210 endif
 211
 212 # If the compiler check failed, print out warnings
 213 ifeq ($(COMPILERFAIL),1)
 214 ifneq ($(XGCCPATH),)
 215 $(warning )
 216 $(warning Path to your toolchain is currently set to '$(XGCCPATH)')
 217 endif
 218 $(warning )
 219 $(warning To build the entire coreboot toolchain: run 'make crossgcc')
 220 ifeq ($(IASLFAIL),1)
 221 $(warning To build just IASL: run 'make iasl')
 222 endif #($(IASLFAIL),1)
 223 $(warning For more toolchain build targets: run 'make help_toolchain')
 224 $(warning )
 225 ifneq ($(CONFIG_ANY_TOOLCHAIN),y)
 226 $(warning To try to use any toolchain in your path, \
 227         run 'make menuconfig', then select)
 228 $(warning the config option: 'General setup', \
 229         and 'Allow building with any toolchain')
 230 $(warning Note that this is NOT supported.  \
 231         Using it means you're on your own.)
 232 $(warning )
 233 endif #($(CONFIG_ANY_TOOLCHAIN),y)
 234 $(error Halting the build)
 235 endif #($(COMPILERFAIL),1)
 236
 237 endif #($(NOCOMPILE),1)
 238
 239 # Run the toolchain version checks if the requested target is 'test-toolchain'
 240 # Checks the versions of GCC, binutils, clang, and IASL
 241 ifneq ($(MAKECMDGOALS),)
 242 ifneq ($(filter test-toolchain,$(MAKECMDGOALS)),)
 243 $(foreach arch, $(ARCH_SUPPORTED), \
 244         $(if $(shell if [ -n "$(GCC_CC_$(arch))" ]; then \
 245                 $(GCC_CC_$(arch)) --version 2>&1 | head -n1 | rev | \
 246                 cut -d ' ' -f 1 | rev | \
 247                 grep -q "$$(util/crossgcc/buildgcc -s gcc)" || \
 248                 echo not-current; fi), \
 249                 $(eval COMPILER_OUT_OF_DATE:=1) \
 250                 $(warning The coreboot toolchain version of gcc for '$(arch)' \
 251                         architecture is not the current version.) \
 252                 $(warning $(arch) gcc version from buildgcc: \
 253                         $(shell util/crossgcc/buildgcc -s gcc)) \
 254                 $(warning $(arch) version of gcc executable: \
 255                         $(shell $(GCC_CC_$(arch)) --version | head -n1 | \
 256                         rev | cut -d ' ' -f 1 | rev))) \
 257         $(if $(shell if [ -n "$(CLANG_CC_$(arch))" ]; then \
 258                 $(CLANG_CC_$(arch)) --version  2>&1 | \
 259                         sed 's/.*clang version/clang version/' | \
 260                         head -n1 | cut -d ' ' -f 3 | \
 261                 grep -q "$(shell util/crossgcc/buildgcc -s clang)" || \
 262                 echo not-current; fi), \
 263                 $(eval COMPILER_OUT_OF_DATE:=1) \
 264                 $(warning The coreboot toolchain version of clang for \
 265                         '$(arch)' architecture is not the current version.) \
 266                 $(warning $(arch) clang version from buildgcc: \
 267                         $(shell util/crossgcc/buildgcc -s clang)) \
 268                 $(warning $(arch) version of clang executable: \
 269                         $(shell $(CLANG_CC_$(arch)) --version 2>&1 | \
 270                         sed 's/.*clang version/clang version/' | \
 271                         head -n1 | cut -d ' ' -f 3))) \
 272         $(if $(shell if [ "$(OBJDUMP_$(arch))" != "invalidobjdump" ]; then \
 273                 $(OBJDUMP_$(arch)) -v 2>&1 | \
 274                 grep -q "$(shell util/crossgcc/buildgcc -s binutils)" || \
 275                 echo not-current; fi), \
 276                 $(eval COMPILER_OUT_OF_DATE:=1)\
 277                 $(warning The coreboot toolchain version of binutils for \
 278                         '$(arch)' architecture is not the current version.)) \
 279 )
 280 $(if $(shell if [ -n "$(IASL)" ]; then $(IASL) -v 2>&1 | \
 281         grep -q "$(shell util/crossgcc/buildgcc -s iasl)" || \
 282         echo not-coreboot; fi), \
 283         $(eval COMPILER_OUT_OF_DATE:=1)\
 284         $(warning The coreboot toolchain version of iasl \
 285                 is not the current version) \
 286                 $(warning $(arch) iasl version from buildgcc: \
 287                         $(shell util/crossgcc/buildgcc -s iasl)) \
 288                 $(warning $(arch) version of iasl executable: \
 289                         $(shell $(IASL) -v 2>&1 | \
 290                         grep ASL+ | rev | cut -f 1 -d ' ' | rev)))
 291 $(eval UPDATED_SUBMODULES:=1)
 292 endif #($(filter crossgcc_check%,$(MAKECMDGOALS)),)
 293 endif #($(MAKECMDGOALS),)