[linux-block.git] / tools / scripts / Makefile.include

# SPDX-License-Identifier: GPL-2.0
ifneq ($(O),)
ifeq ($(origin O), command line)
	dummy := $(if $(shell cd $(PWD); test -d $(O) || echo $(O)),$(error O=$(O) does not exist),)
	ABSOLUTE_O := $(shell cd $(PWD); cd $(O) ; pwd)
	OUTPUT := $(ABSOLUTE_O)/$(if $(subdir),$(subdir)/)
	COMMAND_O := O=$(ABSOLUTE_O)
ifeq ($(objtree),)
	objtree := $(O)
endif
endif
endif

# check that the output directory actually exists
ifneq ($(OUTPUT),)
OUTDIR := $(shell cd $(OUTPUT) && pwd)
$(if $(OUTDIR),, $(error output directory "$(OUTPUT)" does not exist))
endif

#
# Include saner warnings here, which can catch bugs:
#
EXTRA_WARNINGS := -Wbad-function-cast
EXTRA_WARNINGS += -Wdeclaration-after-statement
EXTRA_WARNINGS += -Wformat-security
EXTRA_WARNINGS += -Wformat-y2k
EXTRA_WARNINGS += -Winit-self
EXTRA_WARNINGS += -Wmissing-declarations
EXTRA_WARNINGS += -Wmissing-prototypes
EXTRA_WARNINGS += -Wnested-externs
EXTRA_WARNINGS += -Wno-system-headers
EXTRA_WARNINGS += -Wold-style-definition
EXTRA_WARNINGS += -Wpacked
EXTRA_WARNINGS += -Wredundant-decls
EXTRA_WARNINGS += -Wstrict-prototypes
EXTRA_WARNINGS += -Wswitch-default
EXTRA_WARNINGS += -Wswitch-enum
EXTRA_WARNINGS += -Wundef
EXTRA_WARNINGS += -Wwrite-strings
EXTRA_WARNINGS += -Wformat
EXTRA_WARNINGS += -Wno-type-limits

# Makefiles suck: This macro sets a default value of $(2) for the
# variable named by $(1), unless the variable has been set by
# environment or command line. This is necessary for CC and AR
# because make sets default values, so the simpler ?= approach
# won't work as expected.
define allow-override
  $(if $(or $(findstring environment,$(origin $(1))),\
            $(findstring command line,$(origin $(1)))),,\
    $(eval $(1) = $(2)))
endef

ifneq ($(LLVM),)
ifneq ($(filter %/,$(LLVM)),)
LLVM_PREFIX := $(LLVM)
else ifneq ($(filter -%,$(LLVM)),)
LLVM_SUFFIX := $(LLVM)
endif

$(call allow-override,CC,$(LLVM_PREFIX)clang$(LLVM_SUFFIX))
$(call allow-override,AR,$(LLVM_PREFIX)llvm-ar$(LLVM_SUFFIX))
$(call allow-override,LD,$(LLVM_PREFIX)ld.lld$(LLVM_SUFFIX))
$(call allow-override,CXX,$(LLVM_PREFIX)clang++$(LLVM_SUFFIX))
$(call allow-override,STRIP,$(LLVM_PREFIX)llvm-strip$(LLVM_SUFFIX))
else
# Allow setting various cross-compile vars or setting CROSS_COMPILE as a prefix.
$(call allow-override,CC,$(CROSS_COMPILE)gcc)
$(call allow-override,AR,$(CROSS_COMPILE)ar)
$(call allow-override,LD,$(CROSS_COMPILE)ld)
$(call allow-override,CXX,$(CROSS_COMPILE)g++)
$(call allow-override,STRIP,$(CROSS_COMPILE)strip)
endif

CC_NO_CLANG := $(shell $(CC) -dM -E -x c /dev/null | grep -Fq "__clang__"; echo $$?)

ifneq ($(LLVM),)
HOSTAR  ?= $(LLVM_PREFIX)llvm-ar$(LLVM_SUFFIX)
HOSTCC  ?= $(LLVM_PREFIX)clang$(LLVM_SUFFIX)
HOSTLD  ?= $(LLVM_PREFIX)ld.lld$(LLVM_SUFFIX)
else
HOSTAR  ?= ar
HOSTCC  ?= gcc
HOSTLD  ?= ld
endif

# Some tools require Clang, LLC and/or LLVM utils
CLANG		?= clang
LLC		?= llc
LLVM_CONFIG	?= llvm-config
LLVM_OBJCOPY	?= llvm-objcopy
LLVM_STRIP	?= llvm-strip

ifeq ($(CC_NO_CLANG), 1)
EXTRA_WARNINGS += -Wstrict-aliasing=3

else ifneq ($(CROSS_COMPILE),)
# Allow userspace to override CLANG_CROSS_FLAGS to specify their own
# sysroots and flags or to avoid the GCC call in pure Clang builds.
ifeq ($(CLANG_CROSS_FLAGS),)
CLANG_CROSS_FLAGS := --target=$(notdir $(CROSS_COMPILE:%-=%))
GCC_TOOLCHAIN_DIR := $(dir $(shell which $(CROSS_COMPILE)gcc 2>/dev/null))
ifneq ($(GCC_TOOLCHAIN_DIR),)
CLANG_CROSS_FLAGS += --prefix=$(GCC_TOOLCHAIN_DIR)$(notdir $(CROSS_COMPILE))
CLANG_CROSS_FLAGS += --sysroot=$(shell $(CROSS_COMPILE)gcc -print-sysroot)
CLANG_CROSS_FLAGS += --gcc-toolchain=$(realpath $(GCC_TOOLCHAIN_DIR)/..)
endif # GCC_TOOLCHAIN_DIR
endif # CLANG_CROSS_FLAGS
CFLAGS += $(CLANG_CROSS_FLAGS)
AFLAGS += $(CLANG_CROSS_FLAGS)
else
CLANG_CROSS_FLAGS :=
endif # CROSS_COMPILE

# Hack to avoid type-punned warnings on old systems such as RHEL5:
# We should be changing CFLAGS and checking gcc version, but this
# will do for now and keep the above -Wstrict-aliasing=3 in place
# in newer systems.
# Needed for the __raw_cmpxchg in tools/arch/x86/include/asm/cmpxchg.h
#
# See https://lore.kernel.org/lkml/9a8748490611281710g78402fbeh8ff7fcc162dbcbca@mail.gmail.com/
# and https://gcc.gnu.org/gcc-4.8/changes.html,
# that takes into account Linus's comments (search for Wshadow) for the reasoning about
# -Wshadow not being interesting before gcc 4.8.

ifneq ($(filter 3.%,$(MAKE_VERSION)),)  # make-3
EXTRA_WARNINGS += -fno-strict-aliasing
EXTRA_WARNINGS += -Wno-shadow
else
EXTRA_WARNINGS += -Wshadow
endif

ifneq ($(findstring $(MAKEFLAGS), w),w)
PRINT_DIR = --no-print-directory
else
NO_SUBDIR = :
endif

# If the user is running make -s (silent mode), suppress echoing of commands
# make-4.0 (and later) keep single letter options in the 1st word of MAKEFLAGS.
ifeq ($(filter 3.%,$(MAKE_VERSION)),)
short-opts := $(firstword -$(MAKEFLAGS))
else
short-opts := $(filter-out --%,$(MAKEFLAGS))
endif

ifneq ($(findstring s,$(short-opts)),)
  silent=1
endif

#
# Define a callable command for descending to a new directory
#
# Call by doing: $(call descend,directory[,target])
#
descend = \
	+mkdir -p $(OUTPUT)$(1) && \
	$(MAKE) $(COMMAND_O) subdir=$(if $(subdir),$(subdir)/$(1),$(1)) $(PRINT_DIR) -C $(1) $(2)

QUIET_SUBDIR0  = +$(MAKE) $(COMMAND_O) -C # space to separate -C and subdir
QUIET_SUBDIR1  =

ifneq ($(silent),1)
  ifneq ($(V),1)
	QUIET_CC       = @echo '  CC      '$@;
	QUIET_CC_FPIC  = @echo '  CC FPIC '$@;
	QUIET_CLANG    = @echo '  CLANG   '$@;
	QUIET_AR       = @echo '  AR      '$@;
	QUIET_LINK     = @echo '  LINK    '$@;
	QUIET_MKDIR    = @echo '  MKDIR   '$@;
	QUIET_GEN      = @echo '  GEN     '$@;
	QUIET_SUBDIR0  = +@subdir=
	QUIET_SUBDIR1  = ;$(NO_SUBDIR) \
			  echo '  SUBDIR  '$$subdir; \
			 $(MAKE) $(PRINT_DIR) -C $$subdir
	QUIET_FLEX     = @echo '  FLEX    '$@;
	QUIET_BISON    = @echo '  BISON   '$@;
	QUIET_GENSKEL  = @echo '  GENSKEL '$@;

	descend = \
		+@echo	       '  DESCEND '$(1); \
		mkdir -p $(OUTPUT)$(1) && \
		$(MAKE) $(COMMAND_O) subdir=$(if $(subdir),$(subdir)/$(1),$(1)) $(PRINT_DIR) -C $(1) $(2)

	QUIET_CLEAN    = @printf '  CLEAN   %s\n' $1;
	QUIET_INSTALL  = @printf '  INSTALL %s\n' $1;
	QUIET_UNINST   = @printf '  UNINST  %s\n' $1;
  endif
endif

pound := \#
Commit	Line	Data
b2441318	1	# SPDX-License-Identifier: GPL-2.0
9e4a6648	2	ifneq ($(O),)
bf35182f	3	ifeq ($(origin O), command line)
be40920f MH	4	dummy := $(if $(shell cd $(PWD); test -d $(O) \|\| echo $(O)),$(error O=$(O) does not exist),)
be40920f MH	5	ABSOLUTE_O := $(shell cd $(PWD); cd $(O) ; pwd)
bf35182f	6	OUTPUT := $(ABSOLUTE_O)/$(if $(subdir),$(subdir)/)
c883122a	7	COMMAND_O := O=$(ABSOLUTE_O)
bf35182f DH	8	ifeq ($(objtree),)
	9	objtree := $(O)
	10	endif
98d89bfd	11	endif
9e4a6648	12	endif
98d89bfd	13
98d89bfd	14	# check that the output directory actually exists
9e4a6648	15	ifneq ($(OUTPUT),)
16f8259c	16	OUTDIR := $(shell cd $(OUTPUT) && pwd)
98d89bfd BP	17	$(if $(OUTDIR),, $(error output directory "$(OUTPUT)" does not exist))
	18	endif
	19
	20	#
	21	# Include saner warnings here, which can catch bugs:
	22	#
d8caf3eb BP	23	EXTRA_WARNINGS := -Wbad-function-cast
	24	EXTRA_WARNINGS += -Wdeclaration-after-statement
	25	EXTRA_WARNINGS += -Wformat-security
	26	EXTRA_WARNINGS += -Wformat-y2k
	27	EXTRA_WARNINGS += -Winit-self
	28	EXTRA_WARNINGS += -Wmissing-declarations
	29	EXTRA_WARNINGS += -Wmissing-prototypes
	30	EXTRA_WARNINGS += -Wnested-externs
	31	EXTRA_WARNINGS += -Wno-system-headers
	32	EXTRA_WARNINGS += -Wold-style-definition
	33	EXTRA_WARNINGS += -Wpacked
	34	EXTRA_WARNINGS += -Wredundant-decls
d8caf3eb BP	35	EXTRA_WARNINGS += -Wstrict-prototypes
	36	EXTRA_WARNINGS += -Wswitch-default
	37	EXTRA_WARNINGS += -Wswitch-enum
	38	EXTRA_WARNINGS += -Wundef
	39	EXTRA_WARNINGS += -Wwrite-strings
	40	EXTRA_WARNINGS += -Wformat
d1d1a2cd	41	EXTRA_WARNINGS += -Wno-type-limits
98d89bfd	42
7ed1c190 MK	43	# Makefiles suck: This macro sets a default value of $(2) for the
	44	# variable named by $(1), unless the variable has been set by
	45	# environment or command line. This is necessary for CC and AR
	46	# because make sets default values, so the simpler ?= approach
	47	# won't work as expected.
	48	define allow-override
	49	$(if $(or $(findstring environment,$(origin $(1))),\
	50	$(findstring command line,$(origin $(1)))),,\
	51	$(eval $(1) = $(2)))
	52	endef
	53
f62700ce	54	ifneq ($(LLVM),)
e9c28192 NC	55	ifneq ($(filter %/,$(LLVM)),)
	56	LLVM_PREFIX := $(LLVM)
	57	else ifneq ($(filter -%,$(LLVM)),)
	58	LLVM_SUFFIX := $(LLVM)
	59	endif
	60
	61	$(call allow-override,CC,$(LLVM_PREFIX)clang$(LLVM_SUFFIX))
	62	$(call allow-override,AR,$(LLVM_PREFIX)llvm-ar$(LLVM_SUFFIX))
	63	$(call allow-override,LD,$(LLVM_PREFIX)ld.lld$(LLVM_SUFFIX))
	64	$(call allow-override,CXX,$(LLVM_PREFIX)clang++$(LLVM_SUFFIX))
	65	$(call allow-override,STRIP,$(LLVM_PREFIX)llvm-strip$(LLVM_SUFFIX))
f62700ce	66	else
7ed1c190 MK	67	# Allow setting various cross-compile vars or setting CROSS_COMPILE as a prefix.
	68	$(call allow-override,CC,$(CROSS_COMPILE)gcc)
	69	$(call allow-override,AR,$(CROSS_COMPILE)ar)
	70	$(call allow-override,LD,$(CROSS_COMPILE)ld)
	71	$(call allow-override,CXX,$(CROSS_COMPILE)g++)
	72	$(call allow-override,STRIP,$(CROSS_COMPILE)strip)
f62700ce YS	73	endif
	74
	75	CC_NO_CLANG := $(shell $(CC) -dM -E -x c /dev/null \| grep -Fq "__clang__"; echo $$?)
7ed1c190	76
c8a950d0	77	ifneq ($(LLVM),)
e9c28192 NC	78	HOSTAR ?= $(LLVM_PREFIX)llvm-ar$(LLVM_SUFFIX)
	79	HOSTCC ?= $(LLVM_PREFIX)clang$(LLVM_SUFFIX)
	80	HOSTLD ?= $(LLVM_PREFIX)ld.lld$(LLVM_SUFFIX)
c8a950d0 JPB	81	else
	82	HOSTAR ?= ar
	83	HOSTCC ?= gcc
	84	HOSTLD ?= ld
	85	endif
	86
211a741c SD	87	# Some tools require Clang, LLC and/or LLVM utils
	88	CLANG ?= clang
	89	LLC ?= llc
	90	LLVM_CONFIG ?= llvm-config
	91	LLVM_OBJCOPY ?= llvm-objcopy
	92	LLVM_STRIP ?= llvm-strip
	93
3866058e	94	ifeq ($(CC_NO_CLANG), 1)
093b75ef	95	EXTRA_WARNINGS += -Wstrict-aliasing=3
cebdb737 JPB	96
cebdb737 JPB	97	else ifneq ($(CROSS_COMPILE),)
7fd9fd46 AR	98	# Allow userspace to override CLANG_CROSS_FLAGS to specify their own
	99	# sysroots and flags or to avoid the GCC call in pure Clang builds.
	100	ifeq ($(CLANG_CROSS_FLAGS),)
cebdb737	101	CLANG_CROSS_FLAGS := --target=$(notdir $(CROSS_COMPILE:%-=%))
b7892f7d	102	GCC_TOOLCHAIN_DIR := $(dir $(shell which $(CROSS_COMPILE)gcc 2>/dev/null))
cebdb737 JPB	103	ifneq ($(GCC_TOOLCHAIN_DIR),)
	104	CLANG_CROSS_FLAGS += --prefix=$(GCC_TOOLCHAIN_DIR)$(notdir $(CROSS_COMPILE))
	105	CLANG_CROSS_FLAGS += --sysroot=$(shell $(CROSS_COMPILE)gcc -print-sysroot)
	106	CLANG_CROSS_FLAGS += --gcc-toolchain=$(realpath $(GCC_TOOLCHAIN_DIR)/..)
	107	endif # GCC_TOOLCHAIN_DIR
7fd9fd46	108	endif # CLANG_CROSS_FLAGS
cebdb737 JPB	109	CFLAGS += $(CLANG_CROSS_FLAGS)
cebdb737 JPB	110	AFLAGS += $(CLANG_CROSS_FLAGS)
b539a287 FR	111	else
b539a287 FR	112	CLANG_CROSS_FLAGS :=
cebdb737	113	endif # CROSS_COMPILE
093b75ef	114
3337e682 ACM	115	# Hack to avoid type-punned warnings on old systems such as RHEL5:
	116	# We should be changing CFLAGS and checking gcc version, but this
	117	# will do for now and keep the above -Wstrict-aliasing=3 in place
	118	# in newer systems.
	119	# Needed for the __raw_cmpxchg in tools/arch/x86/include/asm/cmpxchg.h
39e7317e	120	#
c9491aad KC	121	# See https://lore.kernel.org/lkml/9a8748490611281710g78402fbeh8ff7fcc162dbcbca@mail.gmail.com/
c9491aad KC	122	# and https://gcc.gnu.org/gcc-4.8/changes.html,
39e7317e ACM	123	# that takes into account Linus's comments (search for Wshadow) for the reasoning about
	124	# -Wshadow not being interesting before gcc 4.8.
	125
3337e682 ACM	126	ifneq ($(filter 3.%,$(MAKE_VERSION)),) # make-3
3337e682 ACM	127	EXTRA_WARNINGS += -fno-strict-aliasing
39e7317e ACM	128	EXTRA_WARNINGS += -Wno-shadow
	129	else
	130	EXTRA_WARNINGS += -Wshadow
3337e682 ACM	131	endif
3337e682 ACM	132
98d89bfd BP	133	ifneq ($(findstring $(MAKEFLAGS), w),w)
	134	PRINT_DIR = --no-print-directory
	135	else
	136	NO_SUBDIR = :
	137	endif
	138
b5c532e9 JO	139	# If the user is running make -s (silent mode), suppress echoing of commands
	140	# make-4.0 (and later) keep single letter options in the 1st word of MAKEFLAGS.
	141	ifeq ($(filter 3.%,$(MAKE_VERSION)),)
	142	short-opts := $(firstword -$(MAKEFLAGS))
	143	else
	144	short-opts := $(filter-out --%,$(MAKEFLAGS))
	145	endif
	146
	147	ifneq ($(findstring s,$(short-opts)),)
e572d088 JP	148	silent=1
e572d088 JP	149	endif
e572d088	150
ca9dfc6c DH	151	#
	152	# Define a callable command for descending to a new directory
	153	#
	154	# Call by doing: $(call descend,directory[,target])
	155	#
	156	descend = \
bf35182f	157	+mkdir -p $(OUTPUT)$(1) && \
2b73f65d	158	$(MAKE) $(COMMAND_O) subdir=$(if $(subdir),$(subdir)/$(1),$(1)) $(PRINT_DIR) -C $(1) $(2)
ca9dfc6c	159
bf35182f	160	QUIET_SUBDIR0 = +$(MAKE) $(COMMAND_O) -C # space to separate -C and subdir
98d89bfd BP	161	QUIET_SUBDIR1 =
98d89bfd BP	162
e572d088	163	ifneq ($(silent),1)
65fb0992	164	ifneq ($(V),1)
c6de37dd KC	165	QUIET_CC = @echo ' CC '$@;
	166	QUIET_CC_FPIC = @echo ' CC FPIC '$@;
	167	QUIET_CLANG = @echo ' CLANG '$@;
	168	QUIET_AR = @echo ' AR '$@;
	169	QUIET_LINK = @echo ' LINK '$@;
	170	QUIET_MKDIR = @echo ' MKDIR '$@;
	171	QUIET_GEN = @echo ' GEN '$@;
98d89bfd	172	QUIET_SUBDIR0 = +@subdir=
65fb0992	173	QUIET_SUBDIR1 = ;$(NO_SUBDIR) \
c6de37dd	174	echo ' SUBDIR '$$subdir; \
98d89bfd	175	$(MAKE) $(PRINT_DIR) -C $$subdir
c6de37dd KC	176	QUIET_FLEX = @echo ' FLEX '$@;
	177	QUIET_BISON = @echo ' BISON '$@;
	178	QUIET_GENSKEL = @echo ' GENSKEL '$@;
bf35182f DH	179
bf35182f DH	180	descend = \
c6de37dd	181	+@echo ' DESCEND '$(1); \
bf35182f	182	mkdir -p $(OUTPUT)$(1) && \
2b73f65d	183	$(MAKE) $(COMMAND_O) subdir=$(if $(subdir),$(subdir)/$(1),$(1)) $(PRINT_DIR) -C $(1) $(2)
b7248def	184
c6de37dd KC	185	QUIET_CLEAN = @printf ' CLEAN %s\n' $1;
	186	QUIET_INSTALL = @printf ' INSTALL %s\n' $1;
	187	QUIET_UNINST = @printf ' UNINST %s\n' $1;
65fb0992	188	endif
98d89bfd	189	endif
9564a8cf RV	190
9564a8cf RV	191	pound := \#