xref: /linux/scripts/Makefile.lib (revision d195c39052d1da278a00a6744ce59c383b67b191)
1# SPDX-License-Identifier: GPL-2.0
2# Backward compatibility
3asflags-y  += $(EXTRA_AFLAGS)
4ccflags-y  += $(EXTRA_CFLAGS)
5cppflags-y += $(EXTRA_CPPFLAGS)
6ldflags-y  += $(EXTRA_LDFLAGS)
7always-y   += $(always)
8hostprogs  += $(hostprogs-y) $(hostprogs-m)
9
10# flags that take effect in current and sub directories
11KBUILD_AFLAGS += $(subdir-asflags-y)
12KBUILD_CFLAGS += $(subdir-ccflags-y)
13
14# Figure out what we need to build from the various variables
15# ===========================================================================
16
17# When an object is listed to be built compiled-in and modular,
18# only build the compiled-in version
19obj-m := $(filter-out $(obj-y),$(obj-m))
20
21# Libraries are always collected in one lib file.
22# Filter out objects already built-in
23lib-y := $(filter-out $(obj-y), $(sort $(lib-y) $(lib-m)))
24
25# Determine modorder.
26# Unfortunately, we don't have information about ordering between -y
27# and -m subdirs.  Just put -y's first.
28modorder	:= $(patsubst %/,%/modules.order, $(filter %/, $(obj-y)) $(obj-m:.o=.ko))
29
30# Handle objects in subdirs
31# ---------------------------------------------------------------------------
32# o if we encounter foo/ in $(obj-y), replace it by foo/built-in.a
33#   and add the directory to the list of dirs to descend into: $(subdir-y)
34# o if we encounter foo/ in $(obj-m), remove it from $(obj-m)
35#   and add the directory to the list of dirs to descend into: $(subdir-m)
36__subdir-y	:= $(patsubst %/,%,$(filter %/, $(obj-y)))
37subdir-y	+= $(__subdir-y)
38__subdir-m	:= $(patsubst %/,%,$(filter %/, $(obj-m)))
39subdir-m	+= $(__subdir-m)
40ifdef need-builtin
41obj-y		:= $(patsubst %/, %/built-in.a, $(obj-y))
42else
43obj-y		:= $(filter-out %/, $(obj-y))
44endif
45obj-m		:= $(filter-out %/, $(obj-m))
46
47# Subdirectories we need to descend into
48subdir-ym	:= $(sort $(subdir-y) $(subdir-m))
49
50# If $(foo-objs), $(foo-y), $(foo-m), or $(foo-) exists, foo.o is a composite object
51multi-used-y := $(sort $(foreach m,$(obj-y), $(if $(strip $($(m:.o=-objs)) $($(m:.o=-y)) $($(m:.o=-))), $(m))))
52multi-used-m := $(sort $(foreach m,$(obj-m), $(if $(strip $($(m:.o=-objs)) $($(m:.o=-y)) $($(m:.o=-m)) $($(m:.o=-))), $(m))))
53multi-used   := $(multi-used-y) $(multi-used-m)
54
55# $(subdir-obj-y) is the list of objects in $(obj-y) which uses dir/ to
56# tell kbuild to descend
57subdir-obj-y := $(filter %/built-in.a, $(obj-y))
58
59# Replace multi-part objects by their individual parts,
60# including built-in.a from subdirectories
61real-obj-y := $(foreach m, $(obj-y), $(if $(strip $($(m:.o=-objs)) $($(m:.o=-y)) $($(m:.o=-))),$($(m:.o=-objs)) $($(m:.o=-y)),$(m)))
62real-obj-m := $(foreach m, $(obj-m), $(if $(strip $($(m:.o=-objs)) $($(m:.o=-y)) $($(m:.o=-m)) $($(m:.o=-))),$($(m:.o=-objs)) $($(m:.o=-y)) $($(m:.o=-m)),$(m)))
63
64always-y += $(always-m)
65
66# DTB
67# If CONFIG_OF_ALL_DTBS is enabled, all DT blobs are built
68extra-y				+= $(dtb-y)
69extra-$(CONFIG_OF_ALL_DTBS)	+= $(dtb-)
70
71ifneq ($(CHECK_DTBS),)
72extra-y += $(patsubst %.dtb,%.dt.yaml, $(dtb-y))
73extra-$(CONFIG_OF_ALL_DTBS) += $(patsubst %.dtb,%.dt.yaml, $(dtb-))
74endif
75
76# Add subdir path
77
78extra-y		:= $(addprefix $(obj)/,$(extra-y))
79always-y	:= $(addprefix $(obj)/,$(always-y))
80targets		:= $(addprefix $(obj)/,$(targets))
81modorder	:= $(addprefix $(obj)/,$(modorder))
82obj-m		:= $(addprefix $(obj)/,$(obj-m))
83lib-y		:= $(addprefix $(obj)/,$(lib-y))
84subdir-obj-y	:= $(addprefix $(obj)/,$(subdir-obj-y))
85real-obj-y	:= $(addprefix $(obj)/,$(real-obj-y))
86real-obj-m	:= $(addprefix $(obj)/,$(real-obj-m))
87multi-used-m	:= $(addprefix $(obj)/,$(multi-used-m))
88subdir-ym	:= $(addprefix $(obj)/,$(subdir-ym))
89
90# Finds the multi-part object the current object will be linked into.
91# If the object belongs to two or more multi-part objects, list them all.
92modname-multi = $(sort $(foreach m,$(multi-used),\
93		$(if $(filter $*.o, $($(m:.o=-objs)) $($(m:.o=-y)) $($(m:.o=-m))),$(m:.o=))))
94
95__modname = $(if $(modname-multi),$(modname-multi),$(basetarget))
96
97modname = $(subst $(space),:,$(__modname))
98modfile = $(addprefix $(obj)/,$(__modname))
99
100# target with $(obj)/ and its suffix stripped
101target-stem = $(basename $(patsubst $(obj)/%,%,$@))
102
103# These flags are needed for modversions and compiling, so we define them here
104# $(modname_flags) defines KBUILD_MODNAME as the name of the module it will
105# end up in (or would, if it gets compiled in)
106name-fix = $(call stringify,$(subst $(comma),_,$(subst -,_,$1)))
107basename_flags = -DKBUILD_BASENAME=$(call name-fix,$(basetarget))
108modname_flags  = -DKBUILD_MODNAME=$(call name-fix,$(modname))
109modfile_flags  = -DKBUILD_MODFILE=$(call stringify,$(modfile))
110
111orig_c_flags   = $(KBUILD_CPPFLAGS) $(KBUILD_CFLAGS) \
112                 $(ccflags-y) $(CFLAGS_$(target-stem).o)
113_c_flags       = $(filter-out $(CFLAGS_REMOVE_$(target-stem).o), $(orig_c_flags))
114orig_a_flags   = $(KBUILD_CPPFLAGS) $(KBUILD_AFLAGS) \
115                 $(asflags-y) $(AFLAGS_$(target-stem).o)
116_a_flags       = $(filter-out $(AFLAGS_REMOVE_$(target-stem).o), $(orig_a_flags))
117_cpp_flags     = $(KBUILD_CPPFLAGS) $(cppflags-y) $(CPPFLAGS_$(target-stem).lds)
118
119#
120# Enable gcov profiling flags for a file, directory or for all files depending
121# on variables GCOV_PROFILE_obj.o, GCOV_PROFILE and CONFIG_GCOV_PROFILE_ALL
122# (in this order)
123#
124ifeq ($(CONFIG_GCOV_KERNEL),y)
125_c_flags += $(if $(patsubst n%,, \
126		$(GCOV_PROFILE_$(basetarget).o)$(GCOV_PROFILE)$(CONFIG_GCOV_PROFILE_ALL)), \
127		$(CFLAGS_GCOV))
128endif
129
130#
131# Enable address sanitizer flags for kernel except some files or directories
132# we don't want to check (depends on variables KASAN_SANITIZE_obj.o, KASAN_SANITIZE)
133#
134ifeq ($(CONFIG_KASAN),y)
135_c_flags += $(if $(patsubst n%,, \
136		$(KASAN_SANITIZE_$(basetarget).o)$(KASAN_SANITIZE)y), \
137		$(CFLAGS_KASAN), $(CFLAGS_KASAN_NOSANITIZE))
138endif
139
140ifeq ($(CONFIG_UBSAN),y)
141_c_flags += $(if $(patsubst n%,, \
142		$(UBSAN_SANITIZE_$(basetarget).o)$(UBSAN_SANITIZE)$(CONFIG_UBSAN_SANITIZE_ALL)), \
143		$(CFLAGS_UBSAN))
144endif
145
146ifeq ($(CONFIG_KCOV),y)
147_c_flags += $(if $(patsubst n%,, \
148	$(KCOV_INSTRUMENT_$(basetarget).o)$(KCOV_INSTRUMENT)$(CONFIG_KCOV_INSTRUMENT_ALL)), \
149	$(CFLAGS_KCOV))
150endif
151
152# $(srctree)/$(src) for including checkin headers from generated source files
153# $(objtree)/$(obj) for including generated headers from checkin source files
154ifeq ($(KBUILD_EXTMOD),)
155ifdef building_out_of_srctree
156_c_flags   += -I $(srctree)/$(src) -I $(objtree)/$(obj)
157_a_flags   += -I $(srctree)/$(src) -I $(objtree)/$(obj)
158_cpp_flags += -I $(srctree)/$(src) -I $(objtree)/$(obj)
159endif
160endif
161
162part-of-module = $(if $(filter $(basename $@).o, $(real-obj-m)),y)
163quiet_modtag = $(if $(part-of-module),[M],   )
164
165modkern_cflags =                                          \
166	$(if $(part-of-module),                           \
167		$(KBUILD_CFLAGS_MODULE) $(CFLAGS_MODULE), \
168		$(KBUILD_CFLAGS_KERNEL) $(CFLAGS_KERNEL) $(modfile_flags))
169
170modkern_aflags = $(if $(part-of-module),				\
171			$(KBUILD_AFLAGS_MODULE) $(AFLAGS_MODULE),	\
172			$(KBUILD_AFLAGS_KERNEL) $(AFLAGS_KERNEL))
173
174c_flags        = -Wp,-MD,$(depfile) $(NOSTDINC_FLAGS) $(LINUXINCLUDE)     \
175		 -include $(srctree)/include/linux/compiler_types.h       \
176		 $(_c_flags) $(modkern_cflags)                           \
177		 $(basename_flags) $(modname_flags)
178
179a_flags        = -Wp,-MD,$(depfile) $(NOSTDINC_FLAGS) $(LINUXINCLUDE)     \
180		 $(_a_flags) $(modkern_aflags)
181
182cpp_flags      = -Wp,-MD,$(depfile) $(NOSTDINC_FLAGS) $(LINUXINCLUDE)     \
183		 $(_cpp_flags)
184
185ld_flags       = $(KBUILD_LDFLAGS) $(ldflags-y) $(LDFLAGS_$(@F))
186
187DTC_INCLUDE    := $(srctree)/scripts/dtc/include-prefixes
188
189dtc_cpp_flags  = -Wp,-MD,$(depfile).pre.tmp -nostdinc                    \
190		 $(addprefix -I,$(DTC_INCLUDE))                          \
191		 -undef -D__DTS__
192
193# Useful for describing the dependency of composite objects
194# Usage:
195#   $(call multi_depend, multi_used_targets, suffix_to_remove, suffix_to_add)
196define multi_depend
197$(foreach m, $(notdir $1), \
198	$(eval $(obj)/$m: \
199	$(addprefix $(obj)/, $(foreach s, $3, $($(m:%$(strip $2)=%$(s)))))))
200endef
201
202# Shipped files
203# ===========================================================================
204
205quiet_cmd_shipped = SHIPPED $@
206cmd_shipped = cat $< > $@
207
208$(obj)/%: $(src)/%_shipped
209	$(call cmd,shipped)
210
211# Commands useful for building a boot image
212# ===========================================================================
213#
214#	Use as following:
215#
216#	target: source(s) FORCE
217#		$(if_changed,ld/objcopy/gzip)
218#
219#	and add target to extra-y so that we know we have to
220#	read in the saved command line
221
222# Linking
223# ---------------------------------------------------------------------------
224
225quiet_cmd_ld = LD      $@
226      cmd_ld = $(LD) $(ld_flags) $(real-prereqs) -o $@
227
228# Archive
229# ---------------------------------------------------------------------------
230
231quiet_cmd_ar = AR      $@
232      cmd_ar = rm -f $@; $(AR) cDPrsT $@ $(real-prereqs)
233
234# Objcopy
235# ---------------------------------------------------------------------------
236
237quiet_cmd_objcopy = OBJCOPY $@
238cmd_objcopy = $(OBJCOPY) $(OBJCOPYFLAGS) $(OBJCOPYFLAGS_$(@F)) $< $@
239
240# Gzip
241# ---------------------------------------------------------------------------
242
243quiet_cmd_gzip = GZIP    $@
244      cmd_gzip = cat $(real-prereqs) | gzip -n -f -9 > $@
245
246# DTC
247# ---------------------------------------------------------------------------
248DTC ?= $(objtree)/scripts/dtc/dtc
249
250# Disable noisy checks by default
251ifeq ($(findstring 1,$(KBUILD_EXTRA_WARN)),)
252DTC_FLAGS += -Wno-unit_address_vs_reg \
253	-Wno-unit_address_format \
254	-Wno-avoid_unnecessary_addr_size \
255	-Wno-alias_paths \
256	-Wno-graph_child_address \
257	-Wno-simple_bus_reg \
258	-Wno-unique_unit_address \
259	-Wno-pci_device_reg
260endif
261
262ifneq ($(findstring 2,$(KBUILD_EXTRA_WARN)),)
263DTC_FLAGS += -Wnode_name_chars_strict \
264	-Wproperty_name_chars_strict
265endif
266
267DTC_FLAGS += $(DTC_FLAGS_$(basetarget))
268
269# Generate an assembly file to wrap the output of the device tree compiler
270quiet_cmd_dt_S_dtb= DTB     $@
271cmd_dt_S_dtb=						\
272{							\
273	echo '\#include <asm-generic/vmlinux.lds.h>'; 	\
274	echo '.section .dtb.init.rodata,"a"';		\
275	echo '.balign STRUCT_ALIGNMENT';		\
276	echo '.global __dtb_$(subst -,_,$(*F))_begin';	\
277	echo '__dtb_$(subst -,_,$(*F))_begin:';		\
278	echo '.incbin "$<" ';				\
279	echo '__dtb_$(subst -,_,$(*F))_end:';		\
280	echo '.global __dtb_$(subst -,_,$(*F))_end';	\
281	echo '.balign STRUCT_ALIGNMENT'; 		\
282} > $@
283
284$(obj)/%.dtb.S: $(obj)/%.dtb FORCE
285	$(call if_changed,dt_S_dtb)
286
287quiet_cmd_dtc = DTC     $@
288cmd_dtc = mkdir -p $(dir ${dtc-tmp}) ; \
289	$(HOSTCC) -E $(dtc_cpp_flags) -x assembler-with-cpp -o $(dtc-tmp) $< ; \
290	$(DTC) -O $(2) -o $@ -b 0 \
291		$(addprefix -i,$(dir $<) $(DTC_INCLUDE)) $(DTC_FLAGS) \
292		-d $(depfile).dtc.tmp $(dtc-tmp) ; \
293	cat $(depfile).pre.tmp $(depfile).dtc.tmp > $(depfile)
294
295$(obj)/%.dtb: $(src)/%.dts $(DTC) FORCE
296	$(call if_changed_dep,dtc,dtb)
297
298DT_CHECKER ?= dt-validate
299DT_BINDING_DIR := Documentation/devicetree/bindings
300# DT_TMP_SCHEMA may be overridden from Documentation/devicetree/bindings/Makefile
301DT_TMP_SCHEMA ?= $(objtree)/$(DT_BINDING_DIR)/processed-schema.yaml
302
303quiet_cmd_dtb_check =	CHECK   $@
304      cmd_dtb_check =	$(DT_CHECKER) -u $(srctree)/$(DT_BINDING_DIR) -p $(DT_TMP_SCHEMA) $@
305
306define rule_dtc
307	$(call cmd_and_fixdep,dtc,yaml)
308	$(call cmd,dtb_check)
309endef
310
311$(obj)/%.dt.yaml: $(src)/%.dts $(DTC) $(DT_TMP_SCHEMA) FORCE
312	$(call if_changed_rule,dtc)
313
314dtc-tmp = $(subst $(comma),_,$(dot-target).dts.tmp)
315
316# Bzip2
317# ---------------------------------------------------------------------------
318
319# Bzip2 and LZMA do not include size in file... so we have to fake that;
320# append the size as a 32-bit littleendian number as gzip does.
321size_append = printf $(shell						\
322dec_size=0;								\
323for F in $(real-prereqs); do					\
324	fsize=$$($(CONFIG_SHELL) $(srctree)/scripts/file-size.sh $$F);	\
325	dec_size=$$(expr $$dec_size + $$fsize);				\
326done;									\
327printf "%08x\n" $$dec_size |						\
328	sed 's/\(..\)/\1 /g' | {					\
329		read ch0 ch1 ch2 ch3;					\
330		for ch in $$ch3 $$ch2 $$ch1 $$ch0; do			\
331			printf '%s%03o' '\\' $$((0x$$ch)); 		\
332		done;							\
333	}								\
334)
335
336quiet_cmd_bzip2 = BZIP2   $@
337      cmd_bzip2 = { cat $(real-prereqs) | bzip2 -9; $(size_append); } > $@
338
339# Lzma
340# ---------------------------------------------------------------------------
341
342quiet_cmd_lzma = LZMA    $@
343      cmd_lzma = { cat $(real-prereqs) | lzma -9; $(size_append); } > $@
344
345quiet_cmd_lzo = LZO     $@
346      cmd_lzo = { cat $(real-prereqs) | lzop -9; $(size_append); } > $@
347
348quiet_cmd_lz4 = LZ4     $@
349      cmd_lz4 = { cat $(real-prereqs) | lz4c -l -c1 stdin stdout; \
350                  $(size_append); } > $@
351
352# U-Boot mkimage
353# ---------------------------------------------------------------------------
354
355MKIMAGE := $(srctree)/scripts/mkuboot.sh
356
357# SRCARCH just happens to match slightly more than ARCH (on sparc), so reduces
358# the number of overrides in arch makefiles
359UIMAGE_ARCH ?= $(SRCARCH)
360UIMAGE_COMPRESSION ?= $(if $(2),$(2),none)
361UIMAGE_OPTS-y ?=
362UIMAGE_TYPE ?= kernel
363UIMAGE_LOADADDR ?= arch_must_set_this
364UIMAGE_ENTRYADDR ?= $(UIMAGE_LOADADDR)
365UIMAGE_NAME ?= 'Linux-$(KERNELRELEASE)'
366
367quiet_cmd_uimage = UIMAGE  $@
368      cmd_uimage = $(BASH) $(MKIMAGE) -A $(UIMAGE_ARCH) -O linux \
369			-C $(UIMAGE_COMPRESSION) $(UIMAGE_OPTS-y) \
370			-T $(UIMAGE_TYPE) \
371			-a $(UIMAGE_LOADADDR) -e $(UIMAGE_ENTRYADDR) \
372			-n $(UIMAGE_NAME) -d $< $@
373
374# XZ
375# ---------------------------------------------------------------------------
376# Use xzkern to compress the kernel image and xzmisc to compress other things.
377#
378# xzkern uses a big LZMA2 dictionary since it doesn't increase memory usage
379# of the kernel decompressor. A BCJ filter is used if it is available for
380# the target architecture. xzkern also appends uncompressed size of the data
381# using size_append. The .xz format has the size information available at
382# the end of the file too, but it's in more complex format and it's good to
383# avoid changing the part of the boot code that reads the uncompressed size.
384# Note that the bytes added by size_append will make the xz tool think that
385# the file is corrupt. This is expected.
386#
387# xzmisc doesn't use size_append, so it can be used to create normal .xz
388# files. xzmisc uses smaller LZMA2 dictionary than xzkern, because a very
389# big dictionary would increase the memory usage too much in the multi-call
390# decompression mode. A BCJ filter isn't used either.
391quiet_cmd_xzkern = XZKERN  $@
392      cmd_xzkern = { cat $(real-prereqs) | sh $(srctree)/scripts/xz_wrap.sh; \
393                     $(size_append); } > $@
394
395quiet_cmd_xzmisc = XZMISC  $@
396      cmd_xzmisc = cat $(real-prereqs) | xz --check=crc32 --lzma2=dict=1MiB > $@
397
398# ASM offsets
399# ---------------------------------------------------------------------------
400
401# Default sed regexp - multiline due to syntax constraints
402#
403# Use [:space:] because LLVM's integrated assembler inserts <tab> around
404# the .ascii directive whereas GCC keeps the <space> as-is.
405define sed-offsets
406	's:^[[:space:]]*\.ascii[[:space:]]*"\(.*\)".*:\1:; \
407	/^->/{s:->#\(.*\):/* \1 */:; \
408	s:^->\([^ ]*\) [\$$#]*\([^ ]*\) \(.*\):#define \1 \2 /* \3 */:; \
409	s:->::; p;}'
410endef
411
412# Use filechk to avoid rebuilds when a header changes, but the resulting file
413# does not
414define filechk_offsets
415	 echo "#ifndef $2"; \
416	 echo "#define $2"; \
417	 echo "/*"; \
418	 echo " * DO NOT MODIFY."; \
419	 echo " *"; \
420	 echo " * This file was generated by Kbuild"; \
421	 echo " */"; \
422	 echo ""; \
423	 sed -ne $(sed-offsets) < $<; \
424	 echo ""; \
425	 echo "#endif"
426endef
427