build: improve diagnostics for unrecognized toolchain tools

Up until recently the build system accepted an arbitrary value for `AS`
and, unbeknownst to anybody, was simply not making use of it. Recent
feedback has revealed that a number of contributors have `AS` explicitly
configured to use the GNU assembler, which is not a supported assembler,
and this breakage has yielded some cryptic error messages, e.g.:

    aarch64-none-elf-as: unrecognized option '-x'

This change introduces human-readable diagnostics to help developers
with diagnosing unsupported toolchain tools:

    The configured AArch64 assembler could not be identified and may not
    be supported:

        aarch64-none-elf-as

    The default AArch64 assembler is:

        aarch64-none-elf-gcc

    The following tools are supported:

      - Arm® Compiler for Embedded `armclang`
      - LLVM Clang (`clang`)
      - GNU GCC (`gcc`)

    The build system will treat this assembler as GNU GCC (`gcc`).

Change-Id: I316036c83be2d45ee83a88846cf65c6ce7ae3c26
Signed-off-by: Chris Kay <chris.kay@arm.com>
This commit is contained in:
Chris Kay 2024-04-16 17:19:20 +00:00
parent 784092ee16
commit 3d6c7e590e
5 changed files with 212 additions and 99 deletions

View file

@ -17,48 +17,6 @@
toolchains ?= host $(ARCH)
ifneq ($(filter host,$(toolchains)),)
host-cc := $(HOSTCC)
host-cpp := $(HOSTCPP)
host-as := $(HOSTAS)
host-ld := $(HOSTLD)
host-oc := $(HOSTOC)
host-od := $(HOSTOD)
host-ar := $(HOSTAR)
host-dtc := $(HOSTDTC)
endif
ifneq ($(filter aarch32,$(toolchains)),)
aarch32-cc := $(if $(filter-out default,$(origin CC)),$(CC))
aarch32-cpp := $(if $(filter-out default,$(origin CPP)),$(CPP))
aarch32-as := $(if $(filter-out default,$(origin AS)),$(AS))
aarch32-ld := $(if $(filter-out default,$(origin LD)),$(LD))
aarch32-oc := $(if $(filter-out default,$(origin OC)),$(OC))
aarch32-od := $(if $(filter-out default,$(origin OD)),$(OD))
aarch32-ar := $(if $(filter-out default,$(origin AR)),$(AR))
aarch32-dtc := $(if $(filter-out default,$(origin DTC)),$(DTC))
endif
ifneq ($(filter aarch64,$(toolchains)),)
aarch64-cc := $(if $(filter-out default,$(origin CC)),$(CC))
aarch64-cpp := $(if $(filter-out default,$(origin CPP)),$(CPP))
aarch64-as := $(if $(filter-out default,$(origin AS)),$(AS))
aarch64-ld := $(if $(filter-out default,$(origin LD)),$(LD))
aarch64-oc := $(if $(filter-out default,$(origin OC)),$(OC))
aarch64-od := $(if $(filter-out default,$(origin OD)),$(OD))
aarch64-ar := $(if $(filter-out default,$(origin AR)),$(AR))
aarch64-dtc := $(if $(filter-out default,$(origin DTC)),$(DTC))
endif
include $(dir $(lastword $(MAKEFILE_LIST)))build_env.mk
include $(dir $(lastword $(MAKEFILE_LIST)))utilities.mk
@ -72,21 +30,29 @@ include $(addprefix $(dir $(lastword $(MAKEFILE_LIST)))toolchains/, \
# or type of tool in the toolchain.
#
# C-related tools
tool-classes := cc # C compilers
tool-classes += cpp # C preprocessors
tool-classes := cc
tool-class-name-cc := C compiler
# Assembly-related tools
tool-classes += as # Assemblers
tool-classes += cpp
tool-class-name-cpp := C preprocessor
# Linking and object-handling tools
tool-classes += ld # Linkers
tool-classes += oc # Object copiers
tool-classes += od # Object dumpers
tool-classes += ar # Archivers
tool-classes += as
tool-class-name-as := assembler
# Other tools
tool-classes += dtc # Device tree compilers
tool-classes += ld
tool-class-name-ld := linker
tool-classes += oc
tool-class-name-oc := object copier
tool-classes += od
tool-class-name-od := object dumper
tool-classes += ar
tool-class-name-ar := archiver
tool-classes += dtc
tool-class-name-dtc := device tree compiler
#
# Configure tools that we recognize.
@ -96,28 +62,54 @@ tool-classes += dtc # Device tree compilers
# further down.
#
# Arm Compiler for Embedded
tools := arm-clang # armclang
tools += arm-link # armlink
tools += arm-ar # armar
tools += arm-fromelf # fromelf
# Arm® Compiler for Embedded
tools := arm-clang
tool-name-arm-clang := Arm® Compiler for Embedded `armclang`
tools += arm-link
tool-name-arm-link := Arm® Compiler for Embedded `armlink`
tools += arm-ar
tool-name-arm-ar := Arm® Compiler for Embedded `armar`
tools += arm-fromelf
tool-name-arm-fromelf := Arm® Compiler for Embedded `fromelf`
# LLVM Project
tools += llvm-clang # clang
tools += llvm-lld # lld
tools += llvm-objcopy # llvm-objcopy
tools += llvm-objdump # llvm-objdump
tools += llvm-ar # llvm-ar
tools += llvm-clang
tool-name-llvm-clang := LLVM Clang (`clang`)
tools += llvm-lld
tool-name-llvm-lld := LLVM LLD (`lld`)
tools += llvm-objcopy
tool-name-llvm-objcopy := LLVM `llvm-objcopy`
tools += llvm-objdump
tool-name-llvm-objdump := LLVM `llvm-objdump`
tools += llvm-ar
tool-name-llvm-ar := LLVM `llvm-ar`
# GNU Compiler Collection & GNU Binary Utilities
tools += gnu-gcc # gcc
tools += gnu-ld # ld
tools += gnu-objcopy # objcopy
tools += gnu-objdump # objdump
tools += gnu-ar # gcc-ar
tools += gnu-gcc
tool-name-gnu-gcc := GNU GCC (`gcc`)
tools += gnu-ld
tool-name-gnu-ld := GNU LD (`ld.bfd`)
tools += gnu-objcopy
tool-name-gnu-objcopy := GNU `objcopy`
tools += gnu-objdump
tool-name-gnu-objdump := GNU `objdump`
tools += gnu-ar
tool-name-gnu-ar := GNU `ar`
# Other tools
tools += dtc # Device Tree Compiler
tools += generic-dtc
tool-name-generic-dtc := Device Tree Compiler (`dtc`)
#
# Assign tools to tool classes.
@ -142,7 +134,7 @@ tools-od := arm-fromelf llvm-objdump gnu-objdump # Object dumpers
tools-ar := arm-ar llvm-ar gnu-ar # Archivers
# Other tools
tools-dtc := dtc # Device tree compilers
tools-dtc := generic-dtc # Device tree compilers
define check-tool-class-tools
$(eval tool-class := $(1))
@ -224,27 +216,27 @@ $(foreach toolchain,$(toolchains), \
#
# Arm Compiler for Embedded
guess-tool-arm-clang = $(shell $(call escape-shell,$(1)) --version 2>&1 <$(nul) | grep -o "Tool: armclang")
guess-tool-arm-link = $(shell $(call escape-shell,$(1)) --help 2>&1 <$(nul) | grep -o "Tool: armlink")
guess-tool-arm-fromelf = $(shell $(call escape-shell,$(1)) --help 2>&1 <$(nul) | grep -o "Tool: fromelf")
guess-tool-arm-ar = $(shell $(call escape-shell,$(1)) --version 2>&1 <$(nul) | grep -o "Tool: armar")
guess-tool-arm-clang = $(shell $(call escape-shell,$(1)) --version 2>&1 <$(nul) | grep -o "Tool: armclang")
guess-tool-arm-link = $(shell $(call escape-shell,$(1)) --help 2>&1 <$(nul) | grep -o "Tool: armlink")
guess-tool-arm-fromelf = $(shell $(call escape-shell,$(1)) --help 2>&1 <$(nul) | grep -o "Tool: fromelf")
guess-tool-arm-ar = $(shell $(call escape-shell,$(1)) --version 2>&1 <$(nul) | grep -o "Tool: armar")
# LLVM Project
guess-tool-llvm-clang = $(shell $(call escape-shell,$(1)) -v 2>&1 <$(nul) | grep -o "clang version")
guess-tool-llvm-lld = $(shell $(call escape-shell,$(1)) --help 2>&1 <$(nul) | grep -o "OVERVIEW: lld")
guess-tool-llvm-objcopy = $(shell $(call escape-shell,$(1)) --help 2>&1 <$(nul) | grep -o "llvm-objcopy tool")
guess-tool-llvm-objdump = $(shell $(call escape-shell,$(1)) --help 2>&1 <$(nul) | grep -o "llvm object file dumper")
guess-tool-llvm-ar = $(shell $(call escape-shell,$(1)) --help 2>&1 <$(nul) | grep -o "LLVM Archiver")
guess-tool-llvm-clang = $(shell $(call escape-shell,$(1)) -v 2>&1 <$(nul) | grep -o "clang version")
guess-tool-llvm-lld = $(shell $(call escape-shell,$(1)) --help 2>&1 <$(nul) | grep -o "OVERVIEW: lld")
guess-tool-llvm-objcopy = $(shell $(call escape-shell,$(1)) --help 2>&1 <$(nul) | grep -o "llvm-objcopy tool")
guess-tool-llvm-objdump = $(shell $(call escape-shell,$(1)) --help 2>&1 <$(nul) | grep -o "llvm object file dumper")
guess-tool-llvm-ar = $(shell $(call escape-shell,$(1)) --help 2>&1 <$(nul) | grep -o "LLVM Archiver")
# GNU Compiler Collection & GNU Binary Utilities
guess-tool-gnu-gcc = $(shell $(call escape-shell,$(1)) -v 2>&1 <$(nul) | grep -o "gcc version")
guess-tool-gnu-ld = $(shell $(call escape-shell,$(1)) -v 2>&1 <$(nul) | grep -o "GNU ld")
guess-tool-gnu-objcopy = $(shell $(call escape-shell,$(1)) --version 2>&1 <$(nul) | grep -o "GNU objcopy")
guess-tool-gnu-objdump = $(shell $(call escape-shell,$(1)) --version 2>&1 <$(nul) | grep -o "GNU objdump")
guess-tool-gnu-ar = $(shell $(call escape-shell,$(1)) --version 2>&1 <$(nul) | grep -o "GNU ar")
guess-tool-gnu-gcc = $(shell $(call escape-shell,$(1)) -v 2>&1 <$(nul) | grep -o "gcc version")
guess-tool-gnu-ld = $(shell $(call escape-shell,$(1)) -v 2>&1 <$(nul) | grep -o "GNU ld")
guess-tool-gnu-objcopy = $(shell $(call escape-shell,$(1)) --version 2>&1 <$(nul) | grep -o "GNU objcopy")
guess-tool-gnu-objdump = $(shell $(call escape-shell,$(1)) --version 2>&1 <$(nul) | grep -o "GNU objdump")
guess-tool-gnu-ar = $(shell $(call escape-shell,$(1)) --version 2>&1 <$(nul) | grep -o "GNU ar")
# Other tools
guess-tool-dtc = $(shell $(call escape-shell,$(1)) --version 2>&1 <$(nul) | grep -o "Version: DTC")
guess-tool-generic-dtc = $(shell $(call escape-shell,$(1)) --version 2>&1 <$(nul) | grep -o "Version: DTC")
guess-tool = $(firstword $(foreach candidate,$(1), \
$(if $(call guess-tool-$(candidate),$(2)),$(candidate))))
@ -294,11 +286,44 @@ guess-gnu-gcc-oc = $(shell $(call escape-shell,$(1)) --print-prog-name objcopy 2
guess-gnu-gcc-od = $(shell $(call escape-shell,$(1)) --print-prog-name objdump 2>$(nul))
guess-gnu-gcc-ar = $(call which,$(call decompat-path,$(patsubst %$(call file-name,$(1)),%$(subst gcc,gcc-ar,$(call file-name,$(1))),$(call compat-path,$(1)))))
define warn-unrecognized-tool
$(eval toolchain := $(1))
$(eval tool-class := $(2))
$$(warning )
$$(warning The configured $$($(toolchain)-name) $$(tool-class-name-$(tool-class)) could not be identified and may not be supported:)
$$(warning )
$$(warning $$(space) $$($(toolchain)-$(tool-class)))
$$(warning )
$$(warning The default $$($(toolchain)-name) $$(tool-class-name-$(tool-class)) is:)
$$(warning )
$$(warning $$(space) $$($(toolchain)-$(tool-class)-default))
$$(warning )
$$(warning The following tools are supported:)
$$(warning )
$$(foreach tool,$$(tools-$(tool-class)), \
$$(warning $$(space) - $$(tool-name-$$(tool))))
$$(warning )
$$(warning The build system will treat this $$(tool-class-name-$(tool-class)) as $$(tool-name-$$($(toolchain)-$(tool-class)-id-default)).)
$$(warning )
endef
define locate-toolchain-tool-cc
$(eval toolchain := $(1))
$(toolchain)-cc := $$(or $$($(toolchain)-cc),$$($(toolchain)-cc-default))
$(toolchain)-cc-id := $$(call guess-tool,$$(tools-cc),$$($(toolchain)-cc))
ifndef $(toolchain)-cc-id
$(toolchain)-cc-id := $$($(toolchain)-cc-id-default)
$$(eval $$(call warn-unrecognized-tool,$(toolchain),cc))
endif
$(toolchain)-cc-path := $$($(toolchain)-cc)
$(toolchain)-cc := $$(call escape-shell,$$($(toolchain)-cc))
endef
define locate-toolchain-tool
@ -308,33 +333,29 @@ define locate-toolchain-tool
ifndef $(toolchain)-$(tool-class)
$(toolchain)-$(tool-class) := $$(call guess-$$($(toolchain)-cc-id)-$(tool-class),$$($(toolchain)-cc-path))
ifeq ($$($(toolchain)-$(tool-class)),)
ifndef $(toolchain)-$(tool-class)
$(toolchain)-$(tool-class) := $$($(toolchain)-$(tool-class)-default)
endif
endif
$(toolchain)-$(tool-class)-id := $$(call guess-tool,$$(tools-$(tool-class)),$$($$(toolchain)-$(tool-class)))
endef
$(toolchain)-$(tool-class)-id := $$(call guess-tool,$$(tools-$(tool-class)),$$($(toolchain)-$(tool-class)))
define canonicalize-toolchain-tool-path
$(eval toolchain := $(1))
$(eval tool-class := $(2))
ifndef $(toolchain)-$(tool-class)-id
$(toolchain)-$(tool-class)-id := $$($(toolchain)-$(tool-class)-id-default)
$(toolchain)-$(tool-class)-path := $$(call absolute-path,$$(call which,$$($(toolchain)-$(tool-class))))
$(toolchain)-$(tool-class)-path := $$(or $$($(toolchain)-$(tool-class)-path),$$($(toolchain)-$(tool-class)))
$$(eval $$(call warn-unrecognized-tool,$(toolchain),$(tool-class)))
endif
$(toolchain)-$(tool-class) := $(call escape-shell,$$($(toolchain)-$(tool-class)-path))
$(toolchain)-$(tool-class) := $$(call escape-shell,$$($(toolchain)-$(tool-class)))
endef
define locate-toolchain
$(eval toolchain := $(1))
$$(eval $$(call locate-toolchain-tool-cc,$(toolchain)))
$$(eval $$(call canonicalize-toolchain-tool-path,$(toolchain),cc))
$$(foreach tool-class,$$(filter-out cc,$$(tool-classes)), \
$$(eval $$(call locate-toolchain-tool,$(toolchain),$$(tool-class))) \
$$(eval $$(call canonicalize-toolchain-tool-path,$(toolchain),$$(tool-class))))
$$(eval $$(call locate-toolchain-tool,$(toolchain),$$(tool-class))))
endef
$(foreach toolchain,$(toolchains), \

View file

@ -4,11 +4,36 @@
# SPDX-License-Identifier: BSD-3-Clause
#
aarch32-name := AArch32
aarch32-cc := $(if $(filter-out default,$(origin CC)),$(CC))
aarch32-cc-default := $(or $(CROSS_COMPILE),arm-none-eabi-)gcc
aarch32-cc-id-default := gnu-gcc
aarch32-cpp := $(if $(filter-out default,$(origin CPP)),$(CPP))
aarch32-cpp-default := $(or $(CROSS_COMPILE),arm-none-eabi-)gcc
aarch32-cpp-id-default := gnu-gcc
aarch32-as := $(if $(filter-out default,$(origin AS)),$(AS))
aarch32-as-default := $(or $(CROSS_COMPILE),arm-none-eabi-)gcc
aarch32-as-id-default := gnu-gcc
aarch32-ld := $(if $(filter-out default,$(origin LD)),$(LD))
aarch32-ld-default := $(or $(CROSS_COMPILE),arm-none-eabi-)gcc
aarch32-ld-id-default := gnu-gcc
aarch32-oc := $(if $(filter-out default,$(origin OC)),$(OC))
aarch32-oc-default := $(or $(CROSS_COMPILE),arm-none-eabi-)objcopy
aarch32-oc-id-default := gnu-objcopy
aarch32-od := $(if $(filter-out default,$(origin OD)),$(OD))
aarch32-od-default := $(or $(CROSS_COMPILE),arm-none-eabi-)objdump
aarch32-od-id-default := gnu-objdump
aarch32-ar := $(if $(filter-out default,$(origin AR)),$(AR))
aarch32-ar-default := $(or $(CROSS_COMPILE),arm-none-eabi-)gcc-ar
aarch32-ar-id-default := gnu-ar
aarch32-dtc := $(if $(filter-out default,$(origin DTC)),$(DTC))
aarch32-dtc-default := dtc
aarch32-dtc-id-default := generic-dtc

View file

@ -4,11 +4,36 @@
# SPDX-License-Identifier: BSD-3-Clause
#
aarch64-name := AArch64
aarch64-cc := $(if $(filter-out default,$(origin CC)),$(CC))
aarch64-cc-default := $(or $(CROSS_COMPILE),aarch64-none-elf-)gcc
aarch64-cc-id-default := gnu-gcc
aarch64-cpp := $(if $(filter-out default,$(origin CPP)),$(CPP))
aarch64-cpp-default := $(or $(CROSS_COMPILE),aarch64-none-elf-)gcc
aarch64-cpp-id-default := gnu-gcc
aarch64-as := $(if $(filter-out default,$(origin AS)),$(AS))
aarch64-as-default := $(or $(CROSS_COMPILE),aarch64-none-elf-)gcc
aarch64-as-id-default := gnu-gcc
aarch64-ld := $(if $(filter-out default,$(origin LD)),$(LD))
aarch64-ld-default := $(or $(CROSS_COMPILE),aarch64-none-elf-)gcc
aarch64-ld-id-default := gnu-gcc
aarch64-oc := $(if $(filter-out default,$(origin OC)),$(OC))
aarch64-oc-default := $(or $(CROSS_COMPILE),aarch64-none-elf-)objcopy
aarch64-oc-id-default := gnu-objcopy
aarch64-od := $(if $(filter-out default,$(origin OD)),$(OD))
aarch64-od-default := $(or $(CROSS_COMPILE),aarch64-none-elf-)objdump
aarch64-od-id-default := gnu-objdump
aarch64-ar := $(if $(filter-out default,$(origin AR)),$(AR))
aarch64-ar-default := $(or $(CROSS_COMPILE),aarch64-none-elf-)gcc-ar
aarch64-ar-id-default := gnu-ar
aarch64-dtc := $(if $(filter-out default,$(origin DTC)),$(DTC))
aarch64-dtc-default := dtc
aarch64-dtc-id-default := generic-dtc

View file

@ -1,14 +1,39 @@
#
# Copyright (c) 2023, Arm Limited and Contributors. All rights reserved.
# Copyright (c) 2023-2024, Arm Limited and Contributors. All rights reserved.
#
# SPDX-License-Identifier: BSD-3-Clause
#
host-name := host
host-cc := $(HOSTCC)
host-cc-default := gcc
host-cc-id-default := gnu-gcc
host-cpp := $(HOSTCPP)
host-cpp-default := gcc
host-cpp-id-default := gnu-gcc
host-as := $(HOSTAS)
host-as-default := gcc
host-as-id-default := gnu-gcc
host-ld := $(HOSTLD)
host-ld-default := gcc
host-ld-id-default := gnu-gcc
host-oc := $(HOSTOC)
host-oc-default := objcopy
host-oc-id-default := gnu-objcopy
host-od := $(HOSTOD)
host-od-default := objdump
host-od-id-default := gnu-objdump
host-ar := $(HOSTAR)
host-ar-default := gcc-ar
host-ar-id-default := gnu-ar
host-dtc := $(HOSTDTC)
host-dtc-default := dtc
host-dtc-id-default := generic-dtc

View file

@ -4,11 +4,28 @@
# SPDX-License-Identifier: BSD-3-Clause
#
rk3399-m0-name := RK3399 M0
rk3399-m0-cc-default := $(or $(M0_CROSS_COMPILE),arm-none-eabi-)gcc
rk3399-m0-cc-id-default := gnu-gcc
rk3399-m0-cpp-default := $(or $(M0_CROSS_COMPILE),arm-none-eabi-)gcc
rk3399-m0-cpp-id-default := gnu-gcc
rk3399-m0-as-default := $(or $(M0_CROSS_COMPILE),arm-none-eabi-)gcc
rk3399-m0-as-id-default := gnu-gcc
rk3399-m0-ld-default := $(or $(M0_CROSS_COMPILE),arm-none-eabi-)gcc
rk3399-m0-ld-id-default := gnu-gcc
rk3399-m0-oc-default := $(or $(M0_CROSS_COMPILE),arm-none-eabi-)objcopy
rk3399-m0-oc-id-default := gnu-objcopy
rk3399-m0-od-default := $(or $(M0_CROSS_COMPILE),arm-none-eabi-)objdump
rk3399-m0-od-id-default := gnu-objdump
rk3399-m0-ar-default := $(or $(M0_CROSS_COMPILE),arm-none-eabi-)gcc-ar
rk3399-m0-ar-id-default := gnu-ar
rk3399-m0-dtc-default := dtc
rk3399-m0-dtc-id-default := generic-dtc