xref: /linux/scripts/Makefile.lib (revision 661fb4e68cf62bf52eacfcd9b3b0d93fe4260c5b)
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)
7
8# flags that take effect in current and sub directories
9KBUILD_AFLAGS += $(subdir-asflags-y)
10KBUILD_CFLAGS += $(subdir-ccflags-y)
11KBUILD_RUSTFLAGS += $(subdir-rustflags-y)
12
13# Figure out what we need to build from the various variables
14# ===========================================================================
15
16# When an object is listed to be built compiled-in and modular,
17# only build the compiled-in version
18obj-m := $(filter-out $(obj-y),$(obj-m))
19
20# Libraries are always collected in one lib file.
21# Filter out objects already built-in
22lib-y := $(filter-out $(obj-y), $(sort $(lib-y) $(lib-m)))
23
24# Subdirectories we need to descend into
25subdir-ym := $(sort $(subdir-y) $(subdir-m) \
26			$(patsubst %/,%, $(filter %/, $(obj-y) $(obj-m))))
27
28# Handle objects in subdirs:
29# - If we encounter foo/ in $(obj-y), replace it by foo/built-in.a and
30#   foo/modules.order
31# - If we encounter foo/ in $(obj-m), replace it by foo/modules.order
32#
33# Generate modules.order to determine modorder. Unfortunately, we don't have
34# information about ordering between -y and -m subdirs. Just put -y's first.
35
36ifdef need-modorder
37obj-m := $(patsubst %/,%/modules.order, $(filter %/, $(obj-y)) $(obj-m))
38else
39obj-m := $(filter-out %/, $(obj-m))
40endif
41
42ifdef need-builtin
43obj-y		:= $(patsubst %/, %/built-in.a, $(obj-y))
44else
45obj-y		:= $(filter-out %/, $(obj-y))
46endif
47
48ifdef need-dtbslist
49dtb-y		+= $(addsuffix /dtbs-list, $(subdir-ym))
50always-y	+= dtbs-list
51endif
52
53# Expand $(foo-objs) $(foo-y) etc. by replacing their individuals
54suffix-search = $(strip $(foreach s, $3, $($(1:%$(strip $2)=%$s))))
55# List composite targets that are constructed by combining other targets
56multi-search = $(sort $(foreach m, $1, $(if $(call suffix-search, $m, $2, $3 -), $m)))
57# List primitive targets that are compiled from source files
58real-search = $(foreach m, $1, $(if $(call suffix-search, $m, $2, $3 -), $(call suffix-search, $m, $2, $3), $m))
59
60# If $(foo-objs), $(foo-y), $(foo-m), or $(foo-) exists, foo.o is a composite object
61multi-obj-y := $(call multi-search, $(obj-y), .o, -objs -y)
62multi-obj-m := $(call multi-search, $(obj-m), .o, -objs -y -m)
63multi-obj-ym := $(multi-obj-y) $(multi-obj-m)
64
65# Replace multi-part objects by their individual parts,
66# including built-in.a from subdirectories
67real-obj-y := $(call real-search, $(obj-y), .o, -objs -y)
68real-obj-m := $(call real-search, $(obj-m), .o, -objs -y -m)
69
70always-y += $(always-m)
71
72# hostprogs-always-y += foo
73# ... is a shorthand for
74# hostprogs += foo
75# always-y  += foo
76hostprogs += $(hostprogs-always-y) $(hostprogs-always-m)
77always-y += $(hostprogs-always-y) $(hostprogs-always-m)
78
79# userprogs-always-y is likewise.
80userprogs += $(userprogs-always-y) $(userprogs-always-m)
81always-y += $(userprogs-always-y) $(userprogs-always-m)
82
83# DTB
84# If CONFIG_OF_ALL_DTBS is enabled, all DT blobs are built
85dtb-$(CONFIG_OF_ALL_DTBS)       += $(dtb-)
86
87# Composite DTB (i.e. DTB constructed by overlay)
88multi-dtb-y := $(call multi-search, $(dtb-y), .dtb, -dtbs)
89# Primitive DTB compiled from *.dts
90real-dtb-y := $(call real-search, $(dtb-y), .dtb, -dtbs)
91# Base DTB that overlay is applied onto
92base-dtb-y := $(filter %.dtb, $(call real-search, $(multi-dtb-y), .dtb, -dtbs))
93
94always-y			+= $(dtb-y)
95
96# Add subdir path
97
98ifneq ($(obj),.)
99extra-y		:= $(addprefix $(obj)/,$(extra-y))
100always-y	:= $(addprefix $(obj)/,$(always-y))
101targets		:= $(addprefix $(obj)/,$(targets))
102obj-m		:= $(addprefix $(obj)/,$(obj-m))
103lib-y		:= $(addprefix $(obj)/,$(lib-y))
104real-obj-y	:= $(addprefix $(obj)/,$(real-obj-y))
105real-obj-m	:= $(addprefix $(obj)/,$(real-obj-m))
106multi-obj-m	:= $(addprefix $(obj)/, $(multi-obj-m))
107dtb-y		:= $(addprefix $(obj)/, $(dtb-y))
108multi-dtb-y	:= $(addprefix $(obj)/, $(multi-dtb-y))
109real-dtb-y	:= $(addprefix $(obj)/, $(real-dtb-y))
110subdir-ym	:= $(addprefix $(obj)/,$(subdir-ym))
111endif
112
113# Finds the multi-part object the current object will be linked into.
114# If the object belongs to two or more multi-part objects, list them all.
115modname-multi = $(sort $(foreach m,$(multi-obj-ym),\
116		$(if $(filter $*.o, $(call suffix-search, $m, .o, -objs -y -m)),$(m:.o=))))
117
118__modname = $(or $(modname-multi),$(basetarget))
119
120modname = $(subst $(space),:,$(__modname))
121modfile = $(addprefix $(obj)/,$(__modname))
122
123# target with $(obj)/ and its suffix stripped
124target-stem = $(basename $(patsubst $(obj)/%,%,$@))
125
126# These flags are needed for modversions and compiling, so we define them here
127# $(modname_flags) defines KBUILD_MODNAME as the name of the module it will
128# end up in (or would, if it gets compiled in)
129name-fix-token = $(subst $(comma),_,$(subst -,_,$1))
130name-fix = $(call stringify,$(call name-fix-token,$1))
131basename_flags = -DKBUILD_BASENAME=$(call name-fix,$(basetarget))
132modname_flags  = -DKBUILD_MODNAME=$(call name-fix,$(modname)) \
133		 -D__KBUILD_MODNAME=kmod_$(call name-fix-token,$(modname))
134modfile_flags  = -DKBUILD_MODFILE=$(call stringify,$(modfile))
135
136_c_flags       = $(filter-out $(CFLAGS_REMOVE_$(target-stem).o), \
137                     $(filter-out $(ccflags-remove-y), \
138                         $(KBUILD_CPPFLAGS) $(KBUILD_CFLAGS) $(ccflags-y)) \
139                     $(CFLAGS_$(target-stem).o))
140_rust_flags    = $(filter-out $(RUSTFLAGS_REMOVE_$(target-stem).o), \
141                     $(filter-out $(rustflags-remove-y), \
142                         $(KBUILD_RUSTFLAGS) $(rustflags-y)) \
143                     $(RUSTFLAGS_$(target-stem).o))
144_a_flags       = $(filter-out $(AFLAGS_REMOVE_$(target-stem).o), \
145                     $(filter-out $(asflags-remove-y), \
146                         $(KBUILD_CPPFLAGS) $(KBUILD_AFLAGS) $(asflags-y)) \
147                     $(AFLAGS_$(target-stem).o))
148_cpp_flags     = $(KBUILD_CPPFLAGS) $(cppflags-y) $(CPPFLAGS_$(target-stem).lds)
149
150#
151# Enable gcov profiling flags for a file, directory or for all files depending
152# on variables GCOV_PROFILE_obj.o, GCOV_PROFILE and CONFIG_GCOV_PROFILE_ALL
153# (in this order)
154#
155ifeq ($(CONFIG_GCOV_KERNEL),y)
156_c_flags += $(if $(patsubst n%,, \
157		$(GCOV_PROFILE_$(target-stem).o)$(GCOV_PROFILE)$(if $(is-kernel-object),$(CONFIG_GCOV_PROFILE_ALL))), \
158		$(CFLAGS_GCOV))
159endif
160
161#
162# Enable address sanitizer flags for kernel except some files or directories
163# we don't want to check (depends on variables KASAN_SANITIZE_obj.o, KASAN_SANITIZE)
164#
165ifeq ($(CONFIG_KASAN),y)
166ifneq ($(CONFIG_KASAN_HW_TAGS),y)
167_c_flags += $(if $(patsubst n%,, \
168		$(KASAN_SANITIZE_$(target-stem).o)$(KASAN_SANITIZE)$(is-kernel-object)), \
169		$(CFLAGS_KASAN), $(CFLAGS_KASAN_NOSANITIZE))
170endif
171endif
172
173ifeq ($(CONFIG_KMSAN),y)
174_c_flags += $(if $(patsubst n%,, \
175		$(KMSAN_SANITIZE_$(target-stem).o)$(KMSAN_SANITIZE)$(is-kernel-object)), \
176		$(CFLAGS_KMSAN))
177_c_flags += $(if $(patsubst n%,, \
178		$(KMSAN_ENABLE_CHECKS_$(target-stem).o)$(KMSAN_ENABLE_CHECKS)$(is-kernel-object)), \
179		, -mllvm -msan-disable-checks=1)
180endif
181
182ifeq ($(CONFIG_UBSAN),y)
183_c_flags += $(if $(patsubst n%,, \
184		$(UBSAN_SANITIZE_$(target-stem).o)$(UBSAN_SANITIZE)$(is-kernel-object)), \
185		$(CFLAGS_UBSAN))
186_c_flags += $(if $(patsubst n%,, \
187		$(UBSAN_SIGNED_WRAP_$(target-stem).o)$(UBSAN_SANITIZE_$(target-stem).o)$(UBSAN_SIGNED_WRAP)$(UBSAN_SANITIZE)$(is-kernel-object)), \
188		$(CFLAGS_UBSAN_SIGNED_WRAP))
189endif
190
191ifeq ($(CONFIG_KCOV),y)
192_c_flags += $(if $(patsubst n%,, \
193	$(KCOV_INSTRUMENT_$(target-stem).o)$(KCOV_INSTRUMENT)$(if $(is-kernel-object),$(CONFIG_KCOV_INSTRUMENT_ALL))), \
194	$(CFLAGS_KCOV))
195endif
196
197#
198# Enable KCSAN flags except some files or directories we don't want to check
199# (depends on variables KCSAN_SANITIZE_obj.o, KCSAN_SANITIZE)
200#
201ifeq ($(CONFIG_KCSAN),y)
202_c_flags += $(if $(patsubst n%,, \
203	$(KCSAN_SANITIZE_$(target-stem).o)$(KCSAN_SANITIZE)$(is-kernel-object)), \
204	$(CFLAGS_KCSAN))
205# Some uninstrumented files provide implied barriers required to avoid false
206# positives: set KCSAN_INSTRUMENT_BARRIERS for barrier instrumentation only.
207_c_flags += $(if $(patsubst n%,, \
208	$(KCSAN_INSTRUMENT_BARRIERS_$(target-stem).o)$(KCSAN_INSTRUMENT_BARRIERS)n), \
209	-D__KCSAN_INSTRUMENT_BARRIERS__)
210endif
211
212# $(src) for including checkin headers from generated source files
213# $(obj) for including generated headers from checkin source files
214ifeq ($(KBUILD_EXTMOD),)
215ifdef building_out_of_srctree
216_c_flags   += $(addprefix -I, $(src) $(obj))
217_a_flags   += $(addprefix -I, $(src) $(obj))
218_cpp_flags += $(addprefix -I, $(src) $(obj))
219endif
220endif
221
222# If $(is-kernel-object) is 'y', this object will be linked to vmlinux or modules
223is-kernel-object = $(or $(part-of-builtin),$(part-of-module))
224
225part-of-builtin = $(if $(filter $(basename $@).o, $(real-obj-y) $(lib-y)),y)
226part-of-module = $(if $(filter $(basename $@).o, $(real-obj-m)),y)
227quiet_modtag = $(if $(part-of-module),[M],   )
228
229modkern_cflags =                                          \
230	$(if $(part-of-module),                           \
231		$(KBUILD_CFLAGS_MODULE) $(CFLAGS_MODULE), \
232		$(KBUILD_CFLAGS_KERNEL) $(CFLAGS_KERNEL) $(modfile_flags))
233
234modkern_rustflags =                                              \
235	$(if $(part-of-module),                                   \
236		$(KBUILD_RUSTFLAGS_MODULE) $(RUSTFLAGS_MODULE), \
237		$(KBUILD_RUSTFLAGS_KERNEL) $(RUSTFLAGS_KERNEL))
238
239modkern_aflags = $(if $(part-of-module),				\
240			$(KBUILD_AFLAGS_MODULE) $(AFLAGS_MODULE),	\
241			$(KBUILD_AFLAGS_KERNEL) $(AFLAGS_KERNEL))
242
243c_flags        = -Wp,-MMD,$(depfile) $(NOSTDINC_FLAGS) $(LINUXINCLUDE)     \
244		 -include $(srctree)/include/linux/compiler_types.h       \
245		 $(_c_flags) $(modkern_cflags)                           \
246		 $(basename_flags) $(modname_flags)
247
248rust_flags     = $(_rust_flags) $(modkern_rustflags) @$(objtree)/include/generated/rustc_cfg
249
250a_flags        = -Wp,-MMD,$(depfile) $(NOSTDINC_FLAGS) $(LINUXINCLUDE)     \
251		 $(_a_flags) $(modkern_aflags)
252
253cpp_flags      = -Wp,-MMD,$(depfile) $(NOSTDINC_FLAGS) $(LINUXINCLUDE)     \
254		 $(_cpp_flags)
255
256ld_flags       = $(KBUILD_LDFLAGS) $(ldflags-y) $(LDFLAGS_$(@F))
257
258DTC_INCLUDE    := $(srctree)/scripts/dtc/include-prefixes
259
260dtc_cpp_flags  = -Wp,-MMD,$(depfile).pre.tmp -nostdinc                    \
261		 $(addprefix -I,$(DTC_INCLUDE))                          \
262		 -undef -D__DTS__
263
264ifdef CONFIG_OBJTOOL
265
266objtool := $(objtree)/tools/objtool/objtool
267
268objtool-args-$(CONFIG_HAVE_JUMP_LABEL_HACK)		+= --hacks=jump_label
269objtool-args-$(CONFIG_HAVE_NOINSTR_HACK)		+= --hacks=noinstr
270objtool-args-$(CONFIG_MITIGATION_CALL_DEPTH_TRACKING)	+= --hacks=skylake
271objtool-args-$(CONFIG_X86_KERNEL_IBT)			+= --ibt
272objtool-args-$(CONFIG_FINEIBT)				+= --cfi
273objtool-args-$(CONFIG_FTRACE_MCOUNT_USE_OBJTOOL)	+= --mcount
274ifdef CONFIG_FTRACE_MCOUNT_USE_OBJTOOL
275objtool-args-$(CONFIG_HAVE_OBJTOOL_NOP_MCOUNT)		+= --mnop
276endif
277objtool-args-$(CONFIG_UNWINDER_ORC)			+= --orc
278objtool-args-$(CONFIG_MITIGATION_RETPOLINE)		+= --retpoline
279objtool-args-$(CONFIG_MITIGATION_RETHUNK)		+= --rethunk
280objtool-args-$(CONFIG_MITIGATION_SLS)			+= --sls
281objtool-args-$(CONFIG_STACK_VALIDATION)			+= --stackval
282objtool-args-$(CONFIG_HAVE_STATIC_CALL_INLINE)		+= --static-call
283objtool-args-$(CONFIG_HAVE_UACCESS_VALIDATION)		+= --uaccess
284objtool-args-$(CONFIG_GCOV_KERNEL)			+= --no-unreachable
285objtool-args-$(CONFIG_PREFIX_SYMBOLS)			+= --prefix=$(CONFIG_FUNCTION_PADDING_BYTES)
286
287objtool-args = $(objtool-args-y)					\
288	$(if $(delay-objtool), --link)					\
289	$(if $(part-of-module), --module)
290
291delay-objtool := $(or $(CONFIG_LTO_CLANG),$(CONFIG_X86_KERNEL_IBT))
292
293cmd_objtool = $(if $(objtool-enabled), ; $(objtool) $(objtool-args) $@)
294cmd_gen_objtooldep = $(if $(objtool-enabled), { echo ; echo '$@: $$(wildcard $(objtool))' ; } >> $(dot-target).cmd)
295
296endif # CONFIG_OBJTOOL
297
298# Useful for describing the dependency of composite objects
299# Usage:
300#   $(call multi_depend, multi_used_targets, suffix_to_remove, suffix_to_add)
301define multi_depend
302$(foreach m, $1, \
303	$(eval $m: \
304	$(addprefix $(obj)/, $(call suffix-search, $(patsubst $(obj)/%,%,$m), $2, $3))))
305endef
306
307# Copy a file
308# ===========================================================================
309# 'cp' preserves permissions. If you use it to copy a file in read-only srctree,
310# the copy would be read-only as well, leading to an error when executing the
311# rule next time. Use 'cat' instead in order to generate a writable file.
312quiet_cmd_copy = COPY    $@
313      cmd_copy = cat $< > $@
314
315$(obj)/%: $(src)/%_shipped
316	$(call cmd,copy)
317
318# Commands useful for building a boot image
319# ===========================================================================
320#
321#	Use as following:
322#
323#	target: source(s) FORCE
324#		$(if_changed,ld/objcopy/gzip)
325#
326#	and add target to 'targets' so that we know we have to
327#	read in the saved command line
328
329# Linking
330# ---------------------------------------------------------------------------
331
332quiet_cmd_ld = LD      $@
333      cmd_ld = $(LD) $(ld_flags) $(real-prereqs) -o $@
334
335# Archive
336# ---------------------------------------------------------------------------
337
338quiet_cmd_ar = AR      $@
339      cmd_ar = rm -f $@; $(AR) cDPrsT $@ $(real-prereqs)
340
341# Objcopy
342# ---------------------------------------------------------------------------
343
344quiet_cmd_objcopy = OBJCOPY $@
345cmd_objcopy = $(OBJCOPY) $(OBJCOPYFLAGS) $(OBJCOPYFLAGS_$(@F)) $< $@
346
347# Gzip
348# ---------------------------------------------------------------------------
349
350quiet_cmd_gzip = GZIP    $@
351      cmd_gzip = cat $(real-prereqs) | $(KGZIP) -n -f -9 > $@
352
353# DTC
354# ---------------------------------------------------------------------------
355DTC ?= $(objtree)/scripts/dtc/dtc
356DTC_FLAGS += \
357	-Wno-unique_unit_address
358
359# Disable noisy checks by default
360ifeq ($(findstring 1,$(KBUILD_EXTRA_WARN)),)
361DTC_FLAGS += -Wno-unit_address_vs_reg \
362	-Wno-avoid_unnecessary_addr_size \
363	-Wno-alias_paths \
364	-Wno-graph_child_address \
365	-Wno-simple_bus_reg
366else
367DTC_FLAGS += \
368        -Wunique_unit_address_if_enabled
369endif
370
371ifneq ($(findstring 2,$(KBUILD_EXTRA_WARN)),)
372DTC_FLAGS += -Wnode_name_chars_strict \
373	-Wproperty_name_chars_strict \
374	-Wunique_unit_address
375endif
376
377DTC_FLAGS += $(DTC_FLAGS_$(target-stem))
378
379# Set -@ if the target is a base DTB that overlay is applied onto
380DTC_FLAGS += $(if $(filter $(patsubst $(obj)/%,%,$@), $(base-dtb-y)), -@)
381
382# Generate an assembly file to wrap the output of the device tree compiler
383quiet_cmd_wrap_S_dtb = WRAP    $@
384      cmd_wrap_S_dtb = {								\
385		symbase=__$(patsubst .%,%,$(suffix $<))_$(subst -,_,$(notdir $*));	\
386		echo '\#include <asm-generic/vmlinux.lds.h>';				\
387		echo '.section .dtb.init.rodata,"a"';					\
388		echo '.balign STRUCT_ALIGNMENT';					\
389		echo ".global $${symbase}_begin";					\
390		echo "$${symbase}_begin:";						\
391		echo '.incbin "$<" ';							\
392		echo ".global $${symbase}_end";						\
393		echo "$${symbase}_end:";						\
394		echo '.balign STRUCT_ALIGNMENT';					\
395	} > $@
396
397$(obj)/%.dtb.S: $(obj)/%.dtb FORCE
398	$(call if_changed,wrap_S_dtb)
399
400$(obj)/%.dtbo.S: $(obj)/%.dtbo FORCE
401	$(call if_changed,wrap_S_dtb)
402
403quiet_cmd_dtc = DTC     $@
404cmd_dtc = $(HOSTCC) -E $(dtc_cpp_flags) -x assembler-with-cpp -o $(dtc-tmp) $< ; \
405	$(DTC) -o $@ -b 0 \
406		$(addprefix -i,$(dir $<) $(DTC_INCLUDE)) $(DTC_FLAGS) \
407		-d $(depfile).dtc.tmp $(dtc-tmp) ; \
408	cat $(depfile).pre.tmp $(depfile).dtc.tmp > $(depfile)
409
410DT_CHECK_CMD = $(DT_CHECKER) $(DT_CHECKER_FLAGS) -u $(srctree)/$(DT_BINDING_DIR) -p $(DT_TMP_SCHEMA)
411
412ifneq ($(CHECK_DTBS),)
413quiet_cmd_fdtoverlay = DTOVLCH $@
414      cmd_fdtoverlay = $(objtree)/scripts/dtc/fdtoverlay -o $@ -i $(real-prereqs) ; $(DT_CHECK_CMD) $@ || true
415else
416quiet_cmd_fdtoverlay = DTOVL   $@
417      cmd_fdtoverlay = $(objtree)/scripts/dtc/fdtoverlay -o $@ -i $(real-prereqs)
418endif
419
420$(multi-dtb-y): FORCE
421	$(call if_changed,fdtoverlay)
422$(call multi_depend, $(multi-dtb-y), .dtb, -dtbs)
423
424ifneq ($(CHECK_DTBS),)
425DT_CHECKER ?= dt-validate
426DT_CHECKER_FLAGS ?= $(if $(DT_SCHEMA_FILES),-l $(DT_SCHEMA_FILES),-m)
427DT_BINDING_DIR := Documentation/devicetree/bindings
428DT_TMP_SCHEMA := $(objtree)/$(DT_BINDING_DIR)/processed-schema.json
429
430quiet_cmd_dtb =	DTC_CHK $@
431      cmd_dtb =	$(cmd_dtc) ; $(DT_CHECK_CMD) $@ || true
432else
433quiet_cmd_dtb = $(quiet_cmd_dtc)
434      cmd_dtb = $(cmd_dtc)
435endif
436
437$(obj)/%.dtb: $(obj)/%.dts $(DTC) $(DT_TMP_SCHEMA) FORCE
438	$(call if_changed_dep,dtb)
439
440$(obj)/%.dtbo: $(src)/%.dtso $(DTC) FORCE
441	$(call if_changed_dep,dtc)
442
443dtc-tmp = $(subst $(comma),_,$(dot-target).dts.tmp)
444
445# Bzip2
446# ---------------------------------------------------------------------------
447
448# Bzip2 and LZMA do not include size in file... so we have to fake that;
449# append the size as a 32-bit littleendian number as gzip does.
450size_append = printf $(shell						\
451dec_size=0;								\
452for F in $(real-prereqs); do					\
453	fsize=$$($(CONFIG_SHELL) $(srctree)/scripts/file-size.sh $$F);	\
454	dec_size=$$(expr $$dec_size + $$fsize);				\
455done;									\
456printf "%08x\n" $$dec_size |						\
457	sed 's/\(..\)/\1 /g' | {					\
458		read ch0 ch1 ch2 ch3;					\
459		for ch in $$ch3 $$ch2 $$ch1 $$ch0; do			\
460			printf '%s%03o' '\\' $$((0x$$ch)); 		\
461		done;							\
462	}								\
463)
464
465quiet_cmd_file_size = GEN     $@
466      cmd_file_size = $(size_append) > $@
467
468quiet_cmd_bzip2 = BZIP2   $@
469      cmd_bzip2 = cat $(real-prereqs) | $(KBZIP2) -9 > $@
470
471quiet_cmd_bzip2_with_size = BZIP2   $@
472      cmd_bzip2_with_size = { cat $(real-prereqs) | $(KBZIP2) -9; $(size_append); } > $@
473
474# Lzma
475# ---------------------------------------------------------------------------
476
477quiet_cmd_lzma = LZMA    $@
478      cmd_lzma = cat $(real-prereqs) | $(LZMA) -9 > $@
479
480quiet_cmd_lzma_with_size = LZMA    $@
481      cmd_lzma_with_size = { cat $(real-prereqs) | $(LZMA) -9; $(size_append); } > $@
482
483quiet_cmd_lzo = LZO     $@
484      cmd_lzo = cat $(real-prereqs) | $(KLZOP) -9 > $@
485
486quiet_cmd_lzo_with_size = LZO     $@
487      cmd_lzo_with_size = { cat $(real-prereqs) | $(KLZOP) -9; $(size_append); } > $@
488
489quiet_cmd_lz4 = LZ4     $@
490      cmd_lz4 = cat $(real-prereqs) | $(LZ4) -l -c1 stdin stdout > $@
491
492quiet_cmd_lz4_with_size = LZ4     $@
493      cmd_lz4_with_size = { cat $(real-prereqs) | $(LZ4) -l -c1 stdin stdout; \
494                  $(size_append); } > $@
495
496# U-Boot mkimage
497# ---------------------------------------------------------------------------
498
499MKIMAGE := $(srctree)/scripts/mkuboot.sh
500
501# SRCARCH just happens to match slightly more than ARCH (on sparc), so reduces
502# the number of overrides in arch makefiles
503UIMAGE_ARCH ?= $(SRCARCH)
504UIMAGE_COMPRESSION ?= $(or $(2),none)
505UIMAGE_OPTS-y ?=
506UIMAGE_TYPE ?= kernel
507UIMAGE_LOADADDR ?= arch_must_set_this
508UIMAGE_ENTRYADDR ?= $(UIMAGE_LOADADDR)
509UIMAGE_NAME ?= Linux-$(KERNELRELEASE)
510
511quiet_cmd_uimage = UIMAGE  $@
512      cmd_uimage = $(BASH) $(MKIMAGE) -A $(UIMAGE_ARCH) -O linux \
513			-C $(UIMAGE_COMPRESSION) $(UIMAGE_OPTS-y) \
514			-T $(UIMAGE_TYPE) \
515			-a $(UIMAGE_LOADADDR) -e $(UIMAGE_ENTRYADDR) \
516			-n '$(UIMAGE_NAME)' -d $< $@
517
518# Flat Image Tree (FIT)
519# This allows for packaging of a kernel and all devicetrees files, using
520# compression.
521# ---------------------------------------------------------------------------
522
523MAKE_FIT := $(srctree)/scripts/make_fit.py
524
525# Use this to override the compression algorithm
526FIT_COMPRESSION ?= gzip
527
528quiet_cmd_fit = FIT     $@
529      cmd_fit = $(MAKE_FIT) -o $@ --arch $(UIMAGE_ARCH) --os linux \
530		--name '$(UIMAGE_NAME)' \
531		$(if $(findstring 1,$(KBUILD_VERBOSE)),-v) \
532		--compress $(FIT_COMPRESSION) -k $< @$(word 2,$^)
533
534# XZ
535# ---------------------------------------------------------------------------
536# Use xzkern to compress the kernel image and xzmisc to compress other things.
537#
538# xzkern uses a big LZMA2 dictionary since it doesn't increase memory usage
539# of the kernel decompressor. A BCJ filter is used if it is available for
540# the target architecture. xzkern also appends uncompressed size of the data
541# using size_append. The .xz format has the size information available at
542# the end of the file too, but it's in more complex format and it's good to
543# avoid changing the part of the boot code that reads the uncompressed size.
544# Note that the bytes added by size_append will make the xz tool think that
545# the file is corrupt. This is expected.
546#
547# xzmisc doesn't use size_append, so it can be used to create normal .xz
548# files. xzmisc uses smaller LZMA2 dictionary than xzkern, because a very
549# big dictionary would increase the memory usage too much in the multi-call
550# decompression mode. A BCJ filter isn't used either.
551quiet_cmd_xzkern = XZKERN  $@
552      cmd_xzkern = cat $(real-prereqs) | sh $(srctree)/scripts/xz_wrap.sh > $@
553
554quiet_cmd_xzkern_with_size = XZKERN  $@
555      cmd_xzkern_with_size = { cat $(real-prereqs) | sh $(srctree)/scripts/xz_wrap.sh; \
556                     $(size_append); } > $@
557
558quiet_cmd_xzmisc = XZMISC  $@
559      cmd_xzmisc = cat $(real-prereqs) | $(XZ) --check=crc32 --lzma2=dict=1MiB > $@
560
561# ZSTD
562# ---------------------------------------------------------------------------
563# Appends the uncompressed size of the data using size_append. The .zst
564# format has the size information available at the beginning of the file too,
565# but it's in a more complex format and it's good to avoid changing the part
566# of the boot code that reads the uncompressed size.
567#
568# Note that the bytes added by size_append will make the zstd tool think that
569# the file is corrupt. This is expected.
570#
571# zstd uses a maximum window size of 8 MB. zstd22 uses a maximum window size of
572# 128 MB. zstd22 is used for kernel compression because it is decompressed in a
573# single pass, so zstd doesn't need to allocate a window buffer. When streaming
574# decompression is used, like initramfs decompression, zstd22 should likely not
575# be used because it would require zstd to allocate a 128 MB buffer.
576
577quiet_cmd_zstd = ZSTD    $@
578      cmd_zstd = cat $(real-prereqs) | $(ZSTD) -19 > $@
579
580quiet_cmd_zstd22 = ZSTD22  $@
581      cmd_zstd22 = cat $(real-prereqs) | $(ZSTD) -22 --ultra > $@
582
583quiet_cmd_zstd22_with_size = ZSTD22  $@
584      cmd_zstd22_with_size = { cat $(real-prereqs) | $(ZSTD) -22 --ultra; $(size_append); } > $@
585
586# ASM offsets
587# ---------------------------------------------------------------------------
588
589# Default sed regexp - multiline due to syntax constraints
590#
591# Use [:space:] because LLVM's integrated assembler inserts <tab> around
592# the .ascii directive whereas GCC keeps the <space> as-is.
593define sed-offsets
594	's:^[[:space:]]*\.ascii[[:space:]]*"\(.*\)".*:\1:; \
595	/^->/{s:->#\(.*\):/* \1 */:; \
596	s:^->\([^ ]*\) [\$$#]*\([^ ]*\) \(.*\):#define \1 \2 /* \3 */:; \
597	s:->::; p;}'
598endef
599
600# Use filechk to avoid rebuilds when a header changes, but the resulting file
601# does not
602define filechk_offsets
603	 echo "#ifndef $2"; \
604	 echo "#define $2"; \
605	 echo "/*"; \
606	 echo " * DO NOT MODIFY."; \
607	 echo " *"; \
608	 echo " * This file was generated by Kbuild"; \
609	 echo " */"; \
610	 echo ""; \
611	 sed -ne $(sed-offsets) < $<; \
612	 echo ""; \
613	 echo "#endif"
614endef
615