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