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