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