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