############################################################################
# arch/arm64/src/Toolchain.defs
#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements.  See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.  The
# ASF licenses this file to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance with the
# License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
# License for the specific language governing permissions and limitations
# under the License.
#
############################################################################

#
# Supported toolchains
#
# Each toolchain definition should set:
#
#  CROSSDEV         The GNU toolchain triple (command prefix)
#  ARCHCPUFLAGS     CPU-specific flags selecting the instruction set
#                   FPU options, etc.
#  ARCHOPTIMIZATION The optimization level that results in
#                   reliable code generation.
#

ifeq ($(CONFIG_ARCH_HAVE_AE),y)
  OPTION_MARCH_FEATURE = ae
endif

ifeq ($(CONFIG_ARCH_ARMV8A),y)
  ifeq ($(CONFIG_ARCH_AS_HAS_ARMV8_5),y)
    OPTION_MARCH = -march=armv8.5-a
  else
    OPTION_MARCH = -march=armv8-a
  endif
  ifeq ($(CONFIG_ARM64_MTE),y)
    OPTION_MARCH_FEATURE = +memtag
  endif
  ARCHCPUFLAGS += $(OPTION_MARCH)$(OPTION_MARCH_FEATURE)
else ifeq ($(CONFIG_ARCH_ARMV8R),y)
  ifeq ($(CONFIG_ARCH_FPU),y)
    ARCHCPUFLAGS += -march=armv8-r
  else
    ARCHCPUFLAGS += -march=armv8-r+nofp
  endif
else ifeq ($(CONFIG_ARCH_CORTEX_A53),y)
  ARCHCPUFLAGS += -mcpu=cortex-a53$(OPTION_MARCH_FEATURE)
else ifeq ($(CONFIG_ARCH_CORTEX_A55),y)
  ARCHCPUFLAGS += -mcpu=cortex-a55$(OPTION_MARCH_FEATURE)
else ifeq ($(CONFIG_ARCH_CORTEX_A57),y)
  ARCHCPUFLAGS += -mcpu=cortex-a57$(OPTION_MARCH_FEATURE)
else ifeq ($(CONFIG_ARCH_CORTEX_A72),y)
  ARCHCPUFLAGS += -mcpu=cortex-a72$(OPTION_MARCH_FEATURE)
else ifeq ($(CONFIG_ARCH_CORTEX_R82),y)
  ARCHCPUFLAGS += -mcpu=cortex-r82$(OPTION_MARCH_FEATURE)
endif

ifeq ($(CONFIG_DEBUG_CUSTOMOPT),y)
  ARCHOPTIMIZATION += $(CONFIG_DEBUG_OPTLEVEL)
else ifeq ($(CONFIG_DEBUG_FULLOPT),y)
  ARCHOPTIMIZATION += -Os
endif

ifneq ($(CONFIG_DEBUG_NOOPT),y)
  ARCHOPTIMIZATION += -fno-strict-aliasing
endif

ifeq ($(CONFIG_FRAME_POINTER),y)
  ARCHOPTIMIZATION += -fno-omit-frame-pointer
else
  ARCHOPTIMIZATION += -fomit-frame-pointer
endif

ifeq ($(CONFIG_STACK_CANARIES),y)
  ARCHOPTIMIZATION += -fstack-protector-all
endif

ifeq ($(CONFIG_MM_UBSAN_ALL),y)
  ARCHOPTIMIZATION += $(CONFIG_MM_UBSAN_OPTION)
endif

ifeq ($(CONFIG_MM_UBSAN_TRAP_ON_ERROR),y)
  ARCHOPTIMIZATION += -fsanitize-undefined-trap-on-error
endif

ifeq ($(CONFIG_MM_KASAN_INSTRUMENT_ALL),y)
  ARCHOPTIMIZATION += -fsanitize=kernel-address
  KASAN_PARAM += asan-stack=0
  KASAN_PARAM += asan-instrumentation-with-call-threshold=0

  ifeq ($(CONFIG_MM_KASAN_GLOBAL),y)
    KASAN_PARAM += asan-globals=1
  else
    KASAN_PARAM += asan-globals=0
  endif

  ifeq ($(CONFIG_MM_KASAN_DISABLE_READS_CHECK),y)
    KASAN_PARAM += asan-instrument-reads=0
  endif

  ifeq ($(CONFIG_MM_KASAN_DISABLE_WRITES_CHECK),y)
    KASAN_PARAM += asan-instrument-writes=0
  endif

  ifeq ($(CONFIG_ARCH_TOOLCHAIN_CLANG),y)
    ARCHOPTIMIZATION += $(addprefix -mllvm ,$(addprefix -,$(KASAN_PARAM)))
  else
    ARCHOPTIMIZATION += $(addprefix --param ,$(KASAN_PARAM))
  endif
endif

# Instrumentation options

ifeq ($(CONFIG_ARCH_INSTRUMENT_ALL),y)
  ARCHOPTIMIZATION += -finstrument-functions
endif

ifeq ($(CONFIG_COVERAGE_ALL),y)
  ifeq ($(CONFIG_ARCH_TOOLCHAIN_GCC),y)
    ARCHOPTIMIZATION += -fprofile-arcs -ftest-coverage -fno-inline
  else ifeq ($(CONFIG_ARCH_TOOLCHAIN_CLANG),y)
    ARCHOPTIMIZATION += -fprofile-instr-generate -fcoverage-mapping
  endif
endif

ifeq ($(CONFIG_PROFILE_ALL),y)
  ARCHOPTIMIZATION += -pg
endif

ifeq ($(CONFIG_ARCH_FPU),y)
  ARCHCXXFLAGS += -D_LDBL_EQ_DBL
  ARCHCFLAGS   += -D_LDBL_EQ_DBL
endif

ARCHCFLAGS += -fno-common
ARCHCXXFLAGS += -fno-common

ARCHCFLAGS += -Wall -Wstrict-prototypes -Wshadow -Wundef -Werror -Wno-attributes -Wno-unknown-pragmas
ARCHCXXFLAGS += -Wall -Wshadow -Wundef -Wno-attributes -Wno-unknown-pragmas

ifeq ($(shell expr "$(GCCVER)" \>= 12),1)
  ARCHCXXFLAGS += -Wno-alloc-size-larger-than
endif

# When all C++ code is built using GCC 7.1 or a higher version,
# we can safely disregard warnings of the type "parameter passing for X changed in GCC 7.1."
# Refer to : https://stackoverflow.com/questions/48149323/what-does-the-gcc-warning-project-parameter-passing-for-x-changed-in-gcc-7-1-m

ifneq ($(CONFIG_LIBCXXTOOLCHAIN),y)
  ARCHCXXFLAGS += -nostdinc++
endif

ifneq ($(CONFIG_ARCH_TOOLCHAIN_CLANG),y)
  ARCHCFLAGS += -Wno-psabi
  ARCHCXXFLAGS += -Wno-psabi
endif

ifneq ($(CONFIG_CXX_STANDARD),)
  ARCHCXXFLAGS += -std=$(CONFIG_CXX_STANDARD)
endif

ifneq ($(CONFIG_CXX_EXCEPTION),y)
  ARCHCXXFLAGS += -fno-exceptions -fcheck-new
endif

ifneq ($(CONFIG_CXX_RTTI),y)
  ARCHCXXFLAGS += -fno-rtti
endif

ifeq ($(CONFIG_ARCH_TOOLCHAIN_ARMCLANG),)
  LDFLAGS += -nostdlib
endif

# Optimization of unused sections
ifeq ($(CONFIG_ARCH_TOOLCHAIN_ARMCLANG),)
  ifeq ($(CONFIG_DEBUG_OPT_UNUSED_SECTIONS),y)
    LDFLAGS          += --gc-sections
    ARCHOPTIMIZATION += -ffunction-sections -fdata-sections
  endif
endif

# Debug --whole-archive

ifeq ($(CONFIG_DEBUG_LINK_WHOLE_ARCHIVE),y)
  LDFLAGS += --whole-archive
endif

# Debug link map

ifeq ($(CONFIG_ARCH_TOOLCHAIN_ARMCLANG),)
  LDFLAGS += --cref -Map=$(call CONVERT_PATH,$(TOPDIR)$(DELIM)nuttx.map)
else
  LDFLAGS += --strict --map --xref --symbols --info=unused --info=veneers
  LDFLAGS += --info=summarysizes --info=summarystack
endif

ifeq ($(CONFIG_DEBUG_SYMBOLS),y)
  ARCHOPTIMIZATION += $(CONFIG_DEBUG_SYMBOLS_LEVEL)
endif

CROSSDEV ?= aarch64-none-elf-

# Default toolchain

ifeq ($(CONFIG_ARCH_TOOLCHAIN_GCC),y)
  CC = $(CROSSDEV)gcc
  CXX = $(CROSSDEV)g++
  CPP = $(CROSSDEV)gcc -E -P -x c
  STRIP = $(CROSSDEV)strip --strip-unneeded
  OBJCOPY = $(CROSSDEV)objcopy
  OBJDUMP = $(CROSSDEV)objdump
  LD = $(CROSSDEV)ld
  AR = $(CROSSDEV)ar rcs
  NM = $(CROSSDEV)nm
else ifeq ($(CONFIG_ARCH_TOOLCHAIN_CLANG),y)
  CC      = clang
  CXX     = clang++
  CPP     = clang -E -P -x c
  LD      = ld.lld -m aarch64elf
  STRIP   = llvm-strip --strip-unneeded
  AR      = llvm-ar rcs
  NM      = llvm-nm
  OBJCOPY = llvm-objcopy
  OBJDUMP = llvm-objdump

  ARCHCPUFLAGS += --target=aarch64-none-elf

else ifeq ($(CONFIG_ARCH_TOOLCHAIN_ARMCLANG),y)
  CC      = armclang
  CXX     = armclang
  CPP     = armclang -E -P -x c
  LD      = armlink
  STRIP   = llvm-strip --strip-unneeded
  AR      = armar -rcs
  NM      = llvm-nm
  OBJCOPY = llvm-objcopy
  OBJDUMP = llvm-objdump

  ARCHCPUFLAGS += --target=aarch64-arm-none-eabi

  # Since the no_builtin attribute is not fully supported on Clang
  # disable the built-in functions, refer:
  # https://github.com/apache/nuttx/pull/5971

  ARCHOPTIMIZATION += -fno-builtin

  # Suppress license warning

  ARCHCPUFLAGS += -Wno-license-management
  LDFLAGS      += --diag_suppress=9931

  # Input sections are specified even though there will be no such
  # sections found in the libraries linked.
  # Warning: L6314W: No section matches pattern *(xxx).

  LDFLAGS      += --diag_suppress=6314

  # Allow Empty Execution region declared on scatter
  # Warning: L6312W: Empty Execution region description for region xxx

  LDFLAGS      += --diag_suppress=6312

  # Match pattern for an unused section that is being removed.
  # Warning: L6329W: Pattern xxx only matches removed unused sections.

  LDFLAGS      += --diag_suppress=6329

  LDFLAGS      += --entry=__start
endif

# Link Time Optimization

ifeq ($(CONFIG_LTO_FULL),y)
  ARCHOPTIMIZATION += -flto
  ifeq ($(CONFIG_ARCH_TOOLCHAIN_GCC),y)
    LD := $(CROSSDEV)gcc
    AR := $(CROSSDEV)gcc-ar rcs
    NM := $(CROSSDEV)gcc-nm
    ARCHOPTIMIZATION += -fuse-linker-plugin
    ARCHOPTIMIZATION += -fno-builtin
  endif
endif

ifeq ($(CONFIG_ARCH_TOOLCHAIN_GCC),y)
  ifeq ($(GCCVER),)
    export GCCVER := $(shell $(CC) --version | grep gcc | sed -E "s/.* ([0-9]+\.[0-9]+).*/\1/" | cut -d'.' -f1)
  endif
  ifeq ($(shell expr "$(GCCVER)" \>= 12), 1)
    LDFLAGS += --no-warn-rwx-segments --print-memory-usage
  endif
endif

# Add the builtin library

EXTRA_LIBS += $(wildcard $(shell $(CC) $(ARCHCPUFLAGS) --print-libgcc-file-name))

ifeq ($(CONFIG_LIBM_TOOLCHAIN),y)
  ifeq ($(CONFIG_ARCH_TOOLCHAIN_CLANG),y)
    ARCHCPUFLAGS += --config=newlib.cfg
  endif
  EXTRA_LIBS += $(wildcard $(shell $(CC) $(ARCHCPUFLAGS) --print-file-name=libm.a))
endif

ifeq ($(CONFIG_LIBSUPCXX_TOOLCHAIN),y)
  EXTRA_LIBS += $(wildcard $(shell $(CC) $(ARCHCPUFLAGS) --print-file-name=libsupc++.a))
endif

ifeq ($(CONFIG_COVERAGE_TOOLCHAIN),y)
  EXTRA_LIBS += $(wildcard $(shell $(CC) $(ARCHCPUFLAGS) --print-file-name=libgcov.a))
endif

# Loadable module definitions

CMODULEFLAGS = $(CFLAGS) -fvisibility=hidden # --target1-abs
LDMODULEFLAGS = -r -T $(call CONVERT_PATH,$(TOPDIR)/libs/libc/elf/gnu-elf.ld)

# ELF module definitions

CELFFLAGS = $(CFLAGS) -fvisibility=hidden # --target1-abs
CXXELFFLAGS = $(CXXFLAGS) -fvisibility=hidden # --target1-abs

LDELFFLAGS = -r -e __start
ifneq ($(CONFIG_BUILD_KERNEL),y)
  # Flat build and protected elf entry point use crt0,
  # Kernel build will use apps/import/scripts/crt0

  LDELFFLAGS += $(TOPDIR)$(DELIM)arch$(DELIM)arm64$(DELIM)src$(DELIM)crt0.o
endif
LDELFFLAGS += -T $(call CONVERT_PATH,$(TOPDIR)$(DELIM)libs$(DELIM)libc$(DELIM)elf$(DELIM)gnu-elf.ld)

ifneq ($(CONFIG_BINFMT_ELF_RELOCATABLE)$(CONFIG_LTO_FULL),)
  # Lto not support in relocatable elf

  CMODULEFLAGS += -fno-lto
  CELFFLAGS += -fno-lto
  CXXELFFLAGS += -fno-lto
endif