toolchain.inc

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