# Copyright (C) 2016 Embecosm Limited.
#
# Contributor Andrew Burgess <andrew.burgess@embecosm.com>
#
# This program is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by the Free
# Software Foundation; either version 3 of the License, or (at your option)
# any later version.
#
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
# more details.
#
# You should have received a copy of the GNU General Public License along with
# this program.  If not, see <http://www.gnu.org/licenses/>.  */
#
##########################################################################
# Validate SRC_DIR and BUILD_DIR command line parameters
##########################################################################

SRC_DIR =
BUILD_DIR =

# Check that the source directory exists
ifeq ("","$(SRC_DIR)")
$(error "Missing source directory")
else
ifeq ("","$(shell ls -d $(SRC_DIR) 2>/dev/null)")
$(error "Souce directory `$(SRC_DIR)' does not exist")
endif
endif

# Check that the build directory exists
ifeq ("","$(BUILD_DIR)")
$(error "Missing build directory")
else
ifeq ("","$(shell ls -d $(BUILD_DIR) 2>/dev/null)")
$(error "Build directory `$(BUILD_DIR)' does not exist")
endif
endif

ABS_SRC_DIR = $(abspath $(SRC_DIR))
ABS_BUILD_DIR = $(abspath $(BUILD_DIR))

##########################################################################
# Some colors, use NC=1 (No Colours) to turn colours off
##########################################################################

COLOUR_RED=$(if $(NC),,\033[1;31m)
COLOUR_GREEN=$(if $(NC),,\033[1;32m)
COLOUR_YELLOW=$(if $(NC),,\033[1;33m)
COLOUR_BLUE=$(if $(NC),,\033[1;34m)
COLOUR_PURPLE=$(if $(NC),,\033[1;35m)
COLOUR_LIGHT_CYAN=$(if $(NC),,\033[1;36m)
COLOUR_LIGHT_GREY=$(if $(NC),,\033[1;37m)
COLOUR_NONE=$(if $(NC),,\033[0m)

##########################################################################
# Which targets to build, and special flags required
##########################################################################

TARGETS = \
	aarch64-elf \
	aarch64-linux-gnu \
	aarch64-rtems \
	aarch64_be-elf \
	all-64 \
	all-64,32 \
	alpha-dec-vms \
	alpha-elf \
	alpha-freebsd6 \
	alpha-linux-gnu \
	alpha-linuxecoff \
	alpha-unknown-freebsd4.7 \
	alpha-unknown-osf4.0 \
	alpha64-dec-vms \
	am33_2.0-linux \
	arc-elf \
	arc-linux-uclibc \
	arceb-elf \
	arceb-elf,m32 \
	arm-eabi \
	arm-linux-androideabi \
	arm-linuxeabi \
	arm-nacl \
	arm-netbsdelf \
	arm-none-eabi \
	arm-nto \
	arm-pe \
	arm-rtems \
	arm-symbianelf \
	arm-uclinux_eabi \
	arm-vxworks \
	arm-wince-pe \
	armeb-eabi \
	avr-elf \
	bfin-elf \
	bfin-linux-uclibc \
	bfin-rtems \
	bfin-uclinux \
	c6x-elf \
	c6x-uclinux \
	cr16-elf \
	cris-axis-linux-gnu \
	cris-elf \
	cris-linux \
	crisv32-elf \
	crisv32-linux \
	crx-elf \
	d10v-elf \
	d30v-elf \
	dlx-elf \
	epiphany-elf \
	fido-elf \
	fr30-elf \
	frv-elf \
	frv-linux \
	ft32-elf \
	h8300-elf \
	h8300-rtems \
	hppa-linux \
	hppa-linux-gnu \
	hppa64-linux \
	hppa64-linux-gnu \
	i386-darwin \
	i386-linux \
	i386-lynxos \
	i386-pc-go32 \
	i386-rdos \
	i486-freebsd4 \
	i586-linux \
	i686-apple-darwin \
	i686-apple-darwin10 \
	i686-apple-darwin9 \
	i686-dragonfly \
	i686-elf \
	i686-freebsd6 \
	i686-kfreebsd-gnu \
	i686-kopensolaris-gnu \
	i686-nacl \
	i686-nto-qnx \
	i686-pc-beos \
	i686-pc-cygwin \
	i686-pc-elf \
	i686-pc-linux-gnu \
	i686-pc-linux-gnu,gold \
	i686-pc-mingw32 \
	i686-pe \
	i686-rtems \
	i686-solaris2.10 \
	ia64-elf \
	ia64-freebsd5 \
	ia64-freebsd6 \
	ia64-hp-vms \
	ia64-hpux \
	ia64-linux \
	ia64-netbsd \
	ia64-vms \
	ia64-x-freebsd5 \
	ip2k-elf \
	iq2000-elf \
	lm32-elf \
	lm32-rtems \
	lm32-rtems4.10 \
	lm32-uclinux \
	m32c-elf \
	m32c-rtems \
	m32r-elf \
	m68hc11-elf \
	m68k-elf \
	m68k-linux \
	m68k-rtems \
	m68k-uclinux \
	mcore-elf \
	mcore-pe \
	mep-elf \
	metag-elf \
	microblaze-elf \
	microblaze-linux \
	mingw32-pe \
	mips-elf \
	mips-freebsd \
	mips-img-elf \
	mips-img-linux \
	mips-kfreebsd-gnu \
	mips-linux \
	mips-mti-elf \
	mips-mti-linux \
	mips-netbsd \
	mips-rtems \
	mips-sde-elf \
	mips-sgi-irix5 \
	mips-sgi-irix6 \
	mips-vxworks \
	mips-windiss \
	mips64-elf \
	mips64-freebsd \
	mips64-img-linux \
	mips64-kfreebsd-gnu \
	mips64-linux \
	mips64-mti-linux \
	mips64-openbsd \
	mips64el-freebsd \
	mips64el-img-linux \
	mips64el-kfreebsd-gnu \
	mips64el-linux \
	mips64el-mti-linux \
	mips64el-openbsd \
	mips64el-ps2-elf \
	mips64el-st-linux-gnu \
	mips64octeon-linux \
	mips64orion-elf \
	mips64vr-elf \
	mips64vr4300-elf \
	mips64vr4300el-elf \
	mips64vrel-elf \
	mipsel-elf \
	mipsel-freebsd \
	mipsel-img-elf \
	mipsel-img-linux \
	mipsel-kfreebsd-gnu \
	mipsel-linux \
	mipsel-linux-gnu \
	mipsel-mti-elf \
	mipsel-mti-linux \
	mipsel-netbsd \
	mipsel-ps2-elf \
	mipsel-sde-elf \
	mipsel-vxworks \
	mipsisa32-elf \
	mipsisa32-elfoabi \
	mipsisa32-linux \
	mipsisa32el-elf \
	mipsisa32el-linux \
	mipsisa32r2-elf \
	mipsisa32r2-linux \
	mipsisa32r2-linux-gnu \
	mipsisa32r2el-elf \
	mipsisa32r2el-linux \
	mipsisa32r3-elf \
	mipsisa32r3-linux \
	mipsisa32r3el-elf \
	mipsisa32r3el-linux \
	mipsisa32r5-elf \
	mipsisa32r5-linux \
	mipsisa32r5el-elf \
	mipsisa32r5el-linux \
	mipsisa32r6-elf \
	mipsisa32r6-linux \
	mipsisa32r6el-elf \
	mipsisa32r6el-linux \
	mipsisa64-elf \
	mipsisa64-elfoabi \
	mipsisa64-linux \
	mipsisa64el-elf \
	mipsisa64el-linux \
	mipsisa64r2-elf \
	mipsisa64r2-linux \
	mipsisa64r2-sde-elf \
	mipsisa64r2el-elf \
	mipsisa64r2el-linux \
	mipsisa64r3-elf \
	mipsisa64r3-linux \
	mipsisa64r3el-elf \
	mipsisa64r3el-linux \
	mipsisa64r5-elf \
	mipsisa64r5-linux \
	mipsisa64r5el-elf \
	mipsisa64r5el-linux \
	mipsisa64r6-elf \
	mipsisa64r6-linux \
	mipsisa64r6el-elf \
	mipsisa64r6el-linux \
	mipsisa64sb1-elf \
	mipsr5900el-elf \
	mipsr5900el-linux \
	mipstx39-elf \
	mmix \
	mmix-knuth-mmixware \
	mmix-mmixware \
	mn10200-elf \
	mn10300-elf \
	moxie-elf \
	moxie-rtems \
	ms1-elf \
	msp430-elf \
	mt-elf \
	nds32be-elf \
	nds32le-elf \
	nios2-elf \
	nios2-linux \
	nios2-linux-gnu \
	nios2-rtems \
	or1k-elf \
	pdp11-dec-aout \
	pj-elf \
	powerpc-darwin7 \
	powerpc-darwin8 \
	powerpc-eabi \
	powerpc-eabialtivec \
	powerpc-eabisim \
	powerpc-eabisimaltivec \
	powerpc-eabispe \
	powerpc-freebsd6 \
	powerpc-ibm-aix5.2.0 \
	powerpc-linux \
	powerpc-linux_paired \
	powerpc-linux_spe \
	powerpc-lynxos \
	powerpc-nto \
	powerpc-rtems \
	powerpc-wrs-vxworks \
	powerpc-xilinx-eabi \
	powerpc64-linux \
	powerpc64-linux_altivec \
	powerpc64le-elf \
	powerpcle-eabi \
	powerpcle-eabisim \
	powerpcle-elf \
	ppc-elf \
	ppc-lynxos \
	rl78-elf \
	rs6000-aix4.3.3 \
	rs6000-elf \
	rx-elf \
	s390-linux \
	s390-linux-gnu \
	s390x-ibm-tpf \
	s390x-linux-gnu \
	score-elf \
	sh-elf \
	sh-linux \
	sh-nto \
	sh-pe \
	sh-rtems \
	sh-superh-elf \
	shl-unknown-netbsdelf1.6T \
	shle-linux \
	sparc-aout \
	sparc-elf \
	sparc-leon-elf \
	sparc-linux-gnu \
	sparc-rtems \
	sparc64-elf \
	sparc64-freebsd6 \
	sparc64-linux \
	sparc64-linux-gnu \
	sparc64-netbsd \
	sparc64-rtems \
	spu-elf \
	tic30-unknown-aout \
	tic30-unknown-coff \
	tic4x-coff \
	tic54x-coff \
	tic6x-elf \
	tilegx-linux \
	tilegx-linux-gnu \
	tilepro-elf \
	tilepro-linux \
	tilepro-linux-gnu \
	tx39-elf \
	v850-elf \
	v850-rtems \
	v850e-elf \
	vax-linux-gnu \
	vax-netbsdelf \
	visium-elf \
	x86_64-apple-darwin \
	x86_64-darwin \
	x86_64-freebsd6 \
	x86_64-linux \
	x86_64-pc-cygwin \
	x86_64-pc-linux-gnu \
	x86_64-pc-linux-gnu,gold \
	x86_64-rtems \
	x86_64-solaris2 \
	xc16x-elf \
	xgate-elf \
	xstormy16-elf \
	xtensa-elf \
	xtensa-linux \
	z80-coff \
	z8k-coff

BROKEN_TARGETS = \
	alpha-netbsd \
	alpha-openbsd \
	arm-wrs-vxworks \
	bfin-openbsd \
	hppa2.0-hpux10.1 \
	hppa2.0-hpux11.9 \
	hppa64-hp-hpux11.23 \
	hppa64-hpux11.3 \
	i686-mingw32crt \
	i686-netbsdelf9 \
	i686-openbsd \
	i686-pc-msdosdjgpp \
	i686-symbolics-gnu \
	i686-wrs-vxworks \
	i686-wrs-vxworksae \
	m32r-linux \
	m32rle-elf \
	m32rle-linux \
	m68k-netbsdelf \
	m68k-openbsd \
	mips-netbsd \
	mips-wrs-vxworks \
	mipsisa64sr71k-elf \
	moxie-uclinux \
	nvptx-none \
	pdp11-aout \
	powerpc-netbsd \
	powerpc-wrs-vxworksae \
	powerpc-wrs-vxworksmils \
	powerpc64-darwin \
	powerpcle-cygwin \
	rs6000-ibm-aix5.3.0 \
	rs6000-ibm-aix6.1 \
	rs6000-ibm-aix7.1 \
	sh-netbsdelf \
	sh-wrs-vxworks \
	sparc-netbsdelf \
	sparc-wrs-vxworks \
	sparc64-openbsd \
	tilegxbe-linux-gnu \
	vax-openbsd \
	x86_64-mingw32 \
	x86_64-netbsd \
	x86_64-w64-mingw32

##########################################################################
# Customisations for different targets.
##########################################################################

# For the following targets we define:
#       CONFIGURE_${target}=--target=${target} --disable-gdb
TARGETS_WITHOUT_GDB = \
	aarch64-linux-gnu \
	alpha-freebsd6 \
	alpha-linux-gnu \
	alpha-linuxecoff \
	alpha-unknown-freebsd4.7 \
	alpha-unknown-osf4.0 \
	arm-linux-androideabi \
	arm-linuxeabi \
	arm-netbsdelf \
	arm-none-eabi \
	arm-vxworks \
	arm-wince-pe \
	bfin-linux-uclibc \
	bfin-uclinux \
	d10v-elf \
	hppa-linux \
	hppa-linux-gnu \
	hppa64-linux \
	hppa64-linux-gnu \
	i386-darwin \
	i386-linux \
	i386-lynxos \
	i386-pc-go32 \
	i486-freebsd4 \
	i586-linux \
	i686-apple-darwin \
	i686-apple-darwin10 \
	i686-apple-darwin9 \
	i686-freebsd6 \
	i686-kfreebsd-gnu \
	i686-kopensolaris-gnu \
	i686-nto-qnx \
	i686-pc-beos \
	i686-pc-cygwin \
	i686-pc-linux-gnu \
	i686-pc-linux-gnu,gold \
	i686-pc-mingw32 \
	i686-solaris2.10 \
	ia64-linux \
	m68k-linux \
	mingw32-pe \
	mips-linux \
	mips-sgi-irix6 \
	mips64-linux \
	mips64el-st-linux-gnu \
	mips64octeon-linux \
	mipsel-linux-gnu \
	mipsisa32el-linux \
	mipsisa32r2-linux-gnu \
	mipsisa64r2-linux \
	ms1-elf \
	mt-elf \
	powerpc-freebsd6 \
	powerpc-ibm-aix5.2.0 \
	powerpc-linux \
	powerpc-linux_paired \
	powerpc-linux_spe \
	powerpc-wrs-vxworks \
	powerpc64-linux \
	powerpc64-linux_altivec \
	rs6000-aix4.3.3 \
	s390-linux \
	s390-linux-gnu \
	s390x-linux-gnu \
	score-elf \
	sh-linux \
	sh-nto \
	sh-pe \
	sh-rtems \
	sh-superh-elf \
	shl-unknown-netbsdelf1.6T \
	shle-linux \
	sparc-aout \
	sparc64-freebsd6 \
	sparc64-netbsd \
	spu-elf \
	tilegx-linux \
	tilegx-linux-gnu \
	vax-netbsdelf \
	x86_64-freebsd6 \
	x86_64-pc-cygwin \
	x86_64-solaris2 \
	xtensa-linux

$(foreach target,$(TARGETS_WITHOUT_GDB),$(eval CONFIGURE_${target}=--target=${target} --disable-gdb))

# The following CONFIGURE_* variables configure targets in various different ways.
CONFIGURE_all-64,32=--enable-targets=all --enable-64-bit-bfd --disable-gdb
CONFIGURE_all-64=--enable-targets=all --enable-64-bit-bfd
CONFIGURE_arceb-elf,m32=--target=arceb-elf --disable-gdb
CONFIGURE_crisv32-linux=--target=crisv32-*-linux
CONFIGURE_i686-pc-linux-gnu,gold=--target=i686-pc-linux-gnu --enable-gold --disable-gdb
CONFIGURE_tx39-elf=--target=tx39-elf --disable-gdb --disable-sim
CONFIGURE_x86_64-linux=--target=x86_64-*-linux
CONFIGURE_x86_64-pc-linux-gnu,gold=--enable-gold

CFLAGS_arc-elf,m32 = -m32
CFLAGS_all-64,32 = -m32

define CONFIGURE_CORE_i686-pc-linux-gnu,gold =
	CC="gcc -m32" CXX="g++ -m32" ABI="32" setarch i686 \
	    $(ABS_SRC_DIR)/configure \
	        --enable-gold \
	        --target=i686-pc-linux-gnu
endef

##########################################################################
# Variables created for use within this makefile
##########################################################################

BUILD_DIR_TARGETS = $(addprefix TARGET_BUILD_DIR_,$(TARGETS))
CONFIGURE_TARGETS = $(addprefix TARGET_CONFIGURE_,$(TARGETS))
BUILD_TARGETS = $(addprefix TARGET_BUILD_,$(TARGETS))
CHECK_GAS_TARGETS = $(addprefix TARGET_CHECK_GAS_,$(TARGETS))
CHECK_LD_TARGETS = $(addprefix TARGET_CHECK_LD_,$(TARGETS))
CHECK_BINUTILS_TARGETS = $(addprefix TARGET_CHECK_BINUTILS_,$(TARGETS))

##########################################################################
# The top-level build targets within this makefile
##########################################################################

define gather_summary_files =
	cd $(BUILD_DIR) && \
	    find . -mindepth 2 -name $(1) | xargs cat | sort \
	    > $(BUILD_DIR)/$(1)
endef


all :
	@echo "Try targets:"
	@echo "  dirs           - Create per target build directory"
	@echo "  configure      - Configure all targets"
	@echo "  build          - Build all targets"
	@echo "  check-gas      - Test the assembler"
	@echo "  check-ld       - Test the linker"
	@echo "  check-binutils - Test binutils"

# Create all of the build directories
.PHONY: dirs
dirs : $(BUILD_DIR_TARGETS)

# Configure all of the targets
.PHONY: configure
configure: $(CONFIGURE_TARGETS)
	@$(call gather_summary_files,configure.sum)

# Build all of the targets
.PHONY: build
build: $(BUILD_TARGETS)
	@$(call gather_summary_files,build.sum)

# Run various tests on the targets
.PHONY: check-all check-gas check-ld check-binutils
check-all: check-gas check-ld check-binutils
check-gas check-ld check-binutils: dirs configure build
check-gas: $(CHECK_GAS_TARGETS)
	@$(call gather_summary_files,check-gas.sum)
check-ld: $(CHECK_LD_TARGETS)
	@$(call gather_summary_files,check-ld.sum)
check-binutils: $(CHECK_BINUTILS_TARGETS)
	@$(call gather_summary_files,check-binutils.sum)

##########################################################################
# Support for configuring the builds
##########################################################################

define get_target_name =
  $(shell echo $(1) | sed 's/,.*//' | sed 's/ //g')
endef

define format_cflags =
  $(if $(1),"CFLAGS=$(1)",)
endef

define get_cflags =
  $(call format_cflags,$(if $(CFLAGS_$(1)),$(CFLAGS_$(1)),$(CFLAGS)))
endef

define get_configure_flags =
  $(if $(CONFIGURE_$(1)),$(CONFIGURE_$(1)),--target=$(strip $(call get_target_name,$(1))))
endef

define CONFIGURE_CORE =
	$(ABS_SRC_DIR)/configure \
	  $(call get_configure_flags,$*) \
	  $(call get_cflags,$*)
endef

define do_configure =
  $(if $(CONFIGURE_CORE_$*), $(CONFIGURE_CORE_$*), $(CONFIGURE_CORE))
endef

.PHONY: $(CONFIGURE_TARGETS)
$(CONFIGURE_TARGETS) : TARGET_CONFIGURE_% : $(BUILD_DIR)/%/configure.ok

$(BUILD_DIR)/%/configure.ok : | $(BUILD_DIR)/%
	@echo -e "Starting configure of $*"
	@+cd $(BUILD_DIR)/$* && \
	    $(call do_configure) >$(BUILD_DIR)/$*/configure.log 2>&1 && \
	  (echo -e "Finished configure of $*: $(COLOUR_GREEN)Success$(COLOUR_NONE)" && \
	      echo "$*: Success" > $(BUILD_DIR)/$*/configure.sum && \
              date > $(BUILD_DIR)/$*/configure.ok) || \
	  (echo -e "Finished configure of $*: $(COLOUR_RED)Failed$(COLOUR_NONE)" && \
	      echo "$*: Failed" > $(BUILD_DIR)/$*/configure.sum)

##########################################################################
# Support for performing the build
##########################################################################

define BUILD_CORE =
	$(MAKE)
endef

define do_build =
  $(if $(BUILD_CORE_$*), $(BUILD_CORE_$*), $(BUILD_CORE))
endef

.PHONY: $(BUILD_TARGETS)
$(BUILD_TARGETS) : TARGET_BUILD_% : $(BUILD_DIR)/%/build.ok

$(BUILD_DIR)/%/build.ok : $(BUILD_DIR)/%/configure.ok
	@echo "Starting build of $*"
	@+cd $(BUILD_DIR)/$* && \
	    $(call do_build) >$(BUILD_DIR)/$*/build.log 2>&1 && \
	  (echo -e "Finished build of $*: $(COLOUR_GREEN)Success$(COLOUR_NONE)" && \
	      echo "$*: Success" > $(BUILD_DIR)/$*/build.sum && \
              date > $(BUILD_DIR)/$*/build.ok) || \
	  (echo -e "Finished build of $*: $(COLOUR_RED)Failed$(COLOUR_NONE)" && \
	      echo "$*: Failed" > $(BUILD_DIR)/$*/build.sum)

##########################################################################
# Support for creating the build directories
##########################################################################

.PHONY: $(BUILD_DIR_TARGETS)
$(BUILD_DIR_TARGETS) : TARGET_BUILD_DIR_% : | $(BUILD_DIR)/%

$(BUILD_DIR)/% :
	@echo "Creating build directory for $*"
	@mkdir $@

##########################################################################
# Support for running tests
##########################################################################

# Generates the recipe snippet to create a summary file after running the tests.
# Args: (1) Success/Failed string to write.
#       (2) The name of the tool, gas/ld/binutils.
#       (3) The path to the produced sum file within the build directory.
define write_test_sum_file =
	(echo -n "$*: $(1): " > $(BUILD_DIR)/$*/check-$(2).sum && \
	 cat $(3) | grep "^\([XK]\?PASS\|[XK]\?FAIL\|UNSUPPORTED\|UNRESOLVED\|UNTESTED\):" | \
	 cut -d: -f1 | sort | uniq -c | awk '{ print $$2 "=" $$1 }' | \
	 xargs >> $(BUILD_DIR)/$*/check-$(2).sum)
endef

# Generates a recipe gas/ld/binutils tests, print a Success/Failed
# message, and create a top level summary file including that target
# name, status, and a list of PASS/FAIL/etc counts.
# Args: (1) The name of the test set to run gas/ld/binutils.
#       (2) The path to the produced sum file within the build directory.
define run_tests =
	cd $(BUILD_DIR)/$* && \
	    $(MAKE) check-$(1) >$(BUILD_DIR)/$*/check-$(1).log 2>&1 && \
	  (echo -e "Finished check-$(1) of $*: $(COLOUR_GREEN)Success$(COLOUR_NONE)" && \
	      $(call write_test_sum_file,Success,$(1),$(2))) || \
	  (echo -e "Finished check-$(1) of $*: $(COLOUR_RED)Failed$(COLOUR_NONE)" && \
	      $(call write_test_sum_file,Failed,$(1),$(2)))
endef

.PHONY : $(CHECK_GAS_TARGETS)
$(CHECK_GAS_TARGETS) : TARGET_CHECK_GAS_% : $(BUILD_DIR)/%/build.ok
	@echo "Starting check-gas of $*"
	@+$(call run_tests,gas,gas/testsuite/gas.sum)

.PHONY : $(CHECK_LD_TARGETS)
$(CHECK_LD_TARGETS) : TARGET_CHECK_LD_% : $(BUILD_DIR)/%/build.ok
	@echo "Starting check-ld of $*"
	@+$(call run_tests,ld,ld/ld.sum)

.PHONY : $(CHECK_BINUTILS_TARGETS)
$(CHECK_BINUTILS_TARGETS) : TARGET_CHECK_BINUTILS_% : $(BUILD_DIR)/%/build.ok
	@echo "Starting check-binutils of $*"
	@+$(call run_tests,binutils,binutils/binutils.sum)