xref: /linux-6.15/scripts/Makefile.lib (revision e3117404)
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))
170_rust_flags += $(if $(patsubst n%,, \
171		$(KASAN_SANITIZE_$(target-stem).o)$(KASAN_SANITIZE)$(is-kernel-object)), \
172		$(RUSTFLAGS_KASAN))
173endif
174endif
175
176ifeq ($(CONFIG_KMSAN),y)
177_c_flags += $(if $(patsubst n%,, \
178		$(KMSAN_SANITIZE_$(target-stem).o)$(KMSAN_SANITIZE)$(is-kernel-object)), \
179		$(CFLAGS_KMSAN))
180_c_flags += $(if $(patsubst n%,, \
181		$(KMSAN_ENABLE_CHECKS_$(target-stem).o)$(KMSAN_ENABLE_CHECKS)$(is-kernel-object)), \
182		, -mllvm -msan-disable-checks=1)
183endif
184
185ifeq ($(CONFIG_UBSAN),y)
186_c_flags += $(if $(patsubst n%,, \
187		$(UBSAN_SANITIZE_$(target-stem).o)$(UBSAN_SANITIZE)$(is-kernel-object)), \
188		$(CFLAGS_UBSAN))
189_c_flags += $(if $(patsubst n%,, \
190		$(UBSAN_SIGNED_WRAP_$(target-stem).o)$(UBSAN_SANITIZE_$(target-stem).o)$(UBSAN_SIGNED_WRAP)$(UBSAN_SANITIZE)$(is-kernel-object)), \
191		$(CFLAGS_UBSAN_SIGNED_WRAP))
192endif
193
194ifeq ($(CONFIG_KCOV),y)
195_c_flags += $(if $(patsubst n%,, \
196	$(KCOV_INSTRUMENT_$(target-stem).o)$(KCOV_INSTRUMENT)$(if $(is-kernel-object),$(CONFIG_KCOV_INSTRUMENT_ALL))), \
197	$(CFLAGS_KCOV))
198endif
199
200#
201# Enable KCSAN flags except some files or directories we don't want to check
202# (depends on variables KCSAN_SANITIZE_obj.o, KCSAN_SANITIZE)
203#
204ifeq ($(CONFIG_KCSAN),y)
205_c_flags += $(if $(patsubst n%,, \
206	$(KCSAN_SANITIZE_$(target-stem).o)$(KCSAN_SANITIZE)$(is-kernel-object)), \
207	$(CFLAGS_KCSAN))
208# Some uninstrumented files provide implied barriers required to avoid false
209# positives: set KCSAN_INSTRUMENT_BARRIERS for barrier instrumentation only.
210_c_flags += $(if $(patsubst n%,, \
211	$(KCSAN_INSTRUMENT_BARRIERS_$(target-stem).o)$(KCSAN_INSTRUMENT_BARRIERS)n), \
212	-D__KCSAN_INSTRUMENT_BARRIERS__)
213endif
214
215# $(src) for including checkin headers from generated source files
216# $(obj) for including generated headers from checkin source files
217ifeq ($(KBUILD_EXTMOD),)
218ifdef building_out_of_srctree
219_c_flags   += $(addprefix -I, $(src) $(obj))
220_a_flags   += $(addprefix -I, $(src) $(obj))
221_cpp_flags += $(addprefix -I, $(src) $(obj))
222endif
223endif
224
225# If $(is-kernel-object) is 'y', this object will be linked to vmlinux or modules
226is-kernel-object = $(or $(part-of-builtin),$(part-of-module))
227
228part-of-builtin = $(if $(filter $(basename $@).o, $(real-obj-y) $(lib-y)),y)
229part-of-module = $(if $(filter $(basename $@).o, $(real-obj-m)),y)
230quiet_modtag = $(if $(part-of-module),[M],   )
231
232modkern_cflags =                                          \
233	$(if $(part-of-module),                           \
234		$(KBUILD_CFLAGS_MODULE) $(CFLAGS_MODULE), \
235		$(KBUILD_CFLAGS_KERNEL) $(CFLAGS_KERNEL) $(modfile_flags))
236
237modkern_rustflags =                                              \
238	$(if $(part-of-module),                                   \
239		$(KBUILD_RUSTFLAGS_MODULE) $(RUSTFLAGS_MODULE), \
240		$(KBUILD_RUSTFLAGS_KERNEL) $(RUSTFLAGS_KERNEL))
241
242modkern_aflags = $(if $(part-of-module),				\
243			$(KBUILD_AFLAGS_MODULE) $(AFLAGS_MODULE),	\
244			$(KBUILD_AFLAGS_KERNEL) $(AFLAGS_KERNEL))
245
246c_flags        = -Wp,-MMD,$(depfile) $(NOSTDINC_FLAGS) $(LINUXINCLUDE)     \
247		 -include $(srctree)/include/linux/compiler_types.h       \
248		 $(_c_flags) $(modkern_cflags)                           \
249		 $(basename_flags) $(modname_flags)
250
251rust_flags     = $(_rust_flags) $(modkern_rustflags) @$(objtree)/include/generated/rustc_cfg
252
253a_flags        = -Wp,-MMD,$(depfile) $(NOSTDINC_FLAGS) $(LINUXINCLUDE)     \
254		 $(_a_flags) $(modkern_aflags)
255
256cpp_flags      = -Wp,-MMD,$(depfile) $(NOSTDINC_FLAGS) $(LINUXINCLUDE)     \
257		 $(_cpp_flags)
258
259ld_flags       = $(KBUILD_LDFLAGS) $(ldflags-y) $(LDFLAGS_$(@F))
260
261DTC_INCLUDE    := $(srctree)/scripts/dtc/include-prefixes
262
263dtc_cpp_flags  = -Wp,-MMD,$(depfile).pre.tmp -nostdinc                    \
264		 $(addprefix -I,$(DTC_INCLUDE))                          \
265		 -undef -D__DTS__
266
267ifdef CONFIG_OBJTOOL
268
269objtool := $(objtree)/tools/objtool/objtool
270
271objtool-args-$(CONFIG_HAVE_JUMP_LABEL_HACK)		+= --hacks=jump_label
272objtool-args-$(CONFIG_HAVE_NOINSTR_HACK)		+= --hacks=noinstr
273objtool-args-$(CONFIG_MITIGATION_CALL_DEPTH_TRACKING)	+= --hacks=skylake
274objtool-args-$(CONFIG_X86_KERNEL_IBT)			+= --ibt
275objtool-args-$(CONFIG_FINEIBT)				+= --cfi
276objtool-args-$(CONFIG_FTRACE_MCOUNT_USE_OBJTOOL)	+= --mcount
277ifdef CONFIG_FTRACE_MCOUNT_USE_OBJTOOL
278objtool-args-$(CONFIG_HAVE_OBJTOOL_NOP_MCOUNT)		+= --mnop
279endif
280objtool-args-$(CONFIG_UNWINDER_ORC)			+= --orc
281objtool-args-$(CONFIG_MITIGATION_RETPOLINE)		+= --retpoline
282objtool-args-$(CONFIG_MITIGATION_RETHUNK)		+= --rethunk
283objtool-args-$(CONFIG_MITIGATION_SLS)			+= --sls
284objtool-args-$(CONFIG_STACK_VALIDATION)			+= --stackval
285objtool-args-$(CONFIG_HAVE_STATIC_CALL_INLINE)		+= --static-call
286objtool-args-$(CONFIG_HAVE_UACCESS_VALIDATION)		+= --uaccess
287objtool-args-$(CONFIG_GCOV_KERNEL)			+= --no-unreachable
288objtool-args-$(CONFIG_PREFIX_SYMBOLS)			+= --prefix=$(CONFIG_FUNCTION_PADDING_BYTES)
289
290objtool-args = $(objtool-args-y)					\
291	$(if $(delay-objtool), --link)					\
292	$(if $(part-of-module), --module)
293
294delay-objtool := $(or $(CONFIG_LTO_CLANG),$(CONFIG_X86_KERNEL_IBT))
295
296cmd_objtool = $(if $(objtool-enabled), ; $(objtool) $(objtool-args) $@)
297cmd_gen_objtooldep = $(if $(objtool-enabled), { echo ; echo '$@: $$(wildcard $(objtool))' ; } >> $(dot-target).cmd)
298
299endif # CONFIG_OBJTOOL
300
301# Useful for describing the dependency of composite objects
302# Usage:
303#   $(call multi_depend, multi_used_targets, suffix_to_remove, suffix_to_add)
304define multi_depend
305$(foreach m, $1, \
306	$(eval $m: \
307	$(addprefix $(obj)/, $(call suffix-search, $(patsubst $(obj)/%,%,$m), $2, $3))))
308endef
309
310# Copy a file
311# ===========================================================================
312# 'cp' preserves permissions. If you use it to copy a file in read-only srctree,
313# the copy would be read-only as well, leading to an error when executing the
314# rule next time. Use 'cat' instead in order to generate a writable file.
315quiet_cmd_copy = COPY    $@
316      cmd_copy = cat $< > $@
317
318$(obj)/%: $(src)/%_shipped
319	$(call cmd,copy)
320
321# Commands useful for building a boot image
322# ===========================================================================
323#
324#	Use as following:
325#
326#	target: source(s) FORCE
327#		$(if_changed,ld/objcopy/gzip)
328#
329#	and add target to 'targets' so that we know we have to
330#	read in the saved command line
331
332# Linking
333# ---------------------------------------------------------------------------
334
335quiet_cmd_ld = LD      $@
336      cmd_ld = $(LD) $(ld_flags) $(real-prereqs) -o $@
337
338# Archive
339# ---------------------------------------------------------------------------
340
341quiet_cmd_ar = AR      $@
342      cmd_ar = rm -f $@; $(AR) cDPrsT $@ $(real-prereqs)
343
344# Objcopy
345# ---------------------------------------------------------------------------
346
347quiet_cmd_objcopy = OBJCOPY $@
348cmd_objcopy = $(OBJCOPY) $(OBJCOPYFLAGS) $(OBJCOPYFLAGS_$(@F)) $< $@
349
350# Gzip
351# ---------------------------------------------------------------------------
352
353quiet_cmd_gzip = GZIP    $@
354      cmd_gzip = cat $(real-prereqs) | $(KGZIP) -n -f -9 > $@
355
356# DTC
357# ---------------------------------------------------------------------------
358DTC ?= $(objtree)/scripts/dtc/dtc
359DTC_FLAGS += \
360	-Wno-unique_unit_address
361
362# Disable noisy checks by default
363ifeq ($(findstring 1,$(KBUILD_EXTRA_WARN)),)
364DTC_FLAGS += -Wno-unit_address_vs_reg \
365	-Wno-avoid_unnecessary_addr_size \
366	-Wno-alias_paths \
367	-Wno-graph_child_address \
368	-Wno-simple_bus_reg
369else
370DTC_FLAGS += \
371        -Wunique_unit_address_if_enabled
372endif
373
374ifneq ($(findstring 2,$(KBUILD_EXTRA_WARN)),)
375DTC_FLAGS += -Wnode_name_chars_strict \
376	-Wproperty_name_chars_strict \
377	-Wunique_unit_address
378endif
379
380DTC_FLAGS += $(DTC_FLAGS_$(target-stem))
381
382# Set -@ if the target is a base DTB that overlay is applied onto
383DTC_FLAGS += $(if $(filter $(patsubst $(obj)/%,%,$@), $(base-dtb-y)), -@)
384
385# Generate an assembly file to wrap the output of the device tree compiler
386quiet_cmd_wrap_S_dtb = WRAP    $@
387      cmd_wrap_S_dtb = {								\
388		symbase=__$(patsubst .%,%,$(suffix $<))_$(subst -,_,$(notdir $*));	\
389		echo '\#include <asm-generic/vmlinux.lds.h>';				\
390		echo '.section .dtb.init.rodata,"a"';					\
391		echo '.balign STRUCT_ALIGNMENT';					\
392		echo ".global $${symbase}_begin";					\
393		echo "$${symbase}_begin:";						\
394		echo '.incbin "$<" ';							\
395		echo ".global $${symbase}_end";						\
396		echo "$${symbase}_end:";						\
397		echo '.balign STRUCT_ALIGNMENT';					\
398	} > $@
399
400$(obj)/%.dtb.S: $(obj)/%.dtb FORCE
401	$(call if_changed,wrap_S_dtb)
402
403$(obj)/%.dtbo.S: $(obj)/%.dtbo FORCE
404	$(call if_changed,wrap_S_dtb)
405
406quiet_cmd_dtc = DTC     $@
407cmd_dtc = $(HOSTCC) -E $(dtc_cpp_flags) -x assembler-with-cpp -o $(dtc-tmp) $< ; \
408	$(DTC) -o $@ -b 0 \
409		$(addprefix -i,$(dir $<) $(DTC_INCLUDE)) $(DTC_FLAGS) \
410		-d $(depfile).dtc.tmp $(dtc-tmp) ; \
411	cat $(depfile).pre.tmp $(depfile).dtc.tmp > $(depfile)
412
413DT_CHECK_CMD = $(DT_CHECKER) $(DT_CHECKER_FLAGS) -u $(srctree)/$(DT_BINDING_DIR) -p $(DT_TMP_SCHEMA)
414
415# NOTE:
416# Do not replace $(filter %.dtb %.dtbo, $^) with $(real-prereqs). When a single
417# DTB is turned into a multi-blob DTB, $^ will contain header file dependencies
418# recorded in the .*.cmd file.
419ifneq ($(CHECK_DTBS),)
420quiet_cmd_fdtoverlay = DTOVLCH $@
421      cmd_fdtoverlay = $(objtree)/scripts/dtc/fdtoverlay -o $@ -i $(filter %.dtb %.dtbo, $^) ; $(DT_CHECK_CMD) $@ || true
422else
423quiet_cmd_fdtoverlay = DTOVL   $@
424      cmd_fdtoverlay = $(objtree)/scripts/dtc/fdtoverlay -o $@ -i $(filter %.dtb %.dtbo, $^)
425endif
426
427$(multi-dtb-y): FORCE
428	$(call if_changed,fdtoverlay)
429$(call multi_depend, $(multi-dtb-y), .dtb, -dtbs)
430
431ifneq ($(CHECK_DTBS),)
432DT_CHECKER ?= dt-validate
433DT_CHECKER_FLAGS ?= $(if $(DT_SCHEMA_FILES),-l $(DT_SCHEMA_FILES),-m)
434DT_BINDING_DIR := Documentation/devicetree/bindings
435DT_TMP_SCHEMA := $(objtree)/$(DT_BINDING_DIR)/processed-schema.json
436
437quiet_cmd_dtb =	DTC_CHK $@
438      cmd_dtb =	$(cmd_dtc) ; $(DT_CHECK_CMD) $@ || true
439else
440quiet_cmd_dtb = $(quiet_cmd_dtc)
441      cmd_dtb = $(cmd_dtc)
442endif
443
444$(obj)/%.dtb: $(obj)/%.dts $(DTC) $(DT_TMP_SCHEMA) FORCE
445	$(call if_changed_dep,dtb)
446
447$(obj)/%.dtbo: $(src)/%.dtso $(DTC) FORCE
448	$(call if_changed_dep,dtc)
449
450dtc-tmp = $(subst $(comma),_,$(dot-target).dts.tmp)
451
452# Bzip2
453# ---------------------------------------------------------------------------
454
455# Bzip2 and LZMA do not include size in file... so we have to fake that;
456# append the size as a 32-bit littleendian number as gzip does.
457size_append = printf $(shell						\
458dec_size=0;								\
459for F in $(real-prereqs); do					\
460	fsize=$$($(CONFIG_SHELL) $(srctree)/scripts/file-size.sh $$F);	\
461	dec_size=$$(expr $$dec_size + $$fsize);				\
462done;									\
463printf "%08x\n" $$dec_size |						\
464	sed 's/\(..\)/\1 /g' | {					\
465		read ch0 ch1 ch2 ch3;					\
466		for ch in $$ch3 $$ch2 $$ch1 $$ch0; do			\
467			printf '%s%03o' '\\' $$((0x$$ch)); 		\
468		done;							\
469	}								\
470)
471
472quiet_cmd_file_size = GEN     $@
473      cmd_file_size = $(size_append) > $@
474
475quiet_cmd_bzip2 = BZIP2   $@
476      cmd_bzip2 = cat $(real-prereqs) | $(KBZIP2) -9 > $@
477
478quiet_cmd_bzip2_with_size = BZIP2   $@
479      cmd_bzip2_with_size = { cat $(real-prereqs) | $(KBZIP2) -9; $(size_append); } > $@
480
481# Lzma
482# ---------------------------------------------------------------------------
483
484quiet_cmd_lzma = LZMA    $@
485      cmd_lzma = cat $(real-prereqs) | $(LZMA) -9 > $@
486
487quiet_cmd_lzma_with_size = LZMA    $@
488      cmd_lzma_with_size = { cat $(real-prereqs) | $(LZMA) -9; $(size_append); } > $@
489
490quiet_cmd_lzo = LZO     $@
491      cmd_lzo = cat $(real-prereqs) | $(KLZOP) -9 > $@
492
493quiet_cmd_lzo_with_size = LZO     $@
494      cmd_lzo_with_size = { cat $(real-prereqs) | $(KLZOP) -9; $(size_append); } > $@
495
496quiet_cmd_lz4 = LZ4     $@
497      cmd_lz4 = cat $(real-prereqs) | $(LZ4) -l -c1 stdin stdout > $@
498
499quiet_cmd_lz4_with_size = LZ4     $@
500      cmd_lz4_with_size = { cat $(real-prereqs) | $(LZ4) -l -c1 stdin stdout; \
501                  $(size_append); } > $@
502
503# U-Boot mkimage
504# ---------------------------------------------------------------------------
505
506MKIMAGE := $(srctree)/scripts/mkuboot.sh
507
508# SRCARCH just happens to match slightly more than ARCH (on sparc), so reduces
509# the number of overrides in arch makefiles
510UIMAGE_ARCH ?= $(SRCARCH)
511UIMAGE_COMPRESSION ?= $(or $(2),none)
512UIMAGE_OPTS-y ?=
513UIMAGE_TYPE ?= kernel
514UIMAGE_LOADADDR ?= arch_must_set_this
515UIMAGE_ENTRYADDR ?= $(UIMAGE_LOADADDR)
516UIMAGE_NAME ?= Linux-$(KERNELRELEASE)
517
518quiet_cmd_uimage = UIMAGE  $@
519      cmd_uimage = $(BASH) $(MKIMAGE) -A $(UIMAGE_ARCH) -O linux \
520			-C $(UIMAGE_COMPRESSION) $(UIMAGE_OPTS-y) \
521			-T $(UIMAGE_TYPE) \
522			-a $(UIMAGE_LOADADDR) -e $(UIMAGE_ENTRYADDR) \
523			-n '$(UIMAGE_NAME)' -d $< $@
524
525# Flat Image Tree (FIT)
526# This allows for packaging of a kernel and all devicetrees files, using
527# compression.
528# ---------------------------------------------------------------------------
529
530MAKE_FIT := $(srctree)/scripts/make_fit.py
531
532# Use this to override the compression algorithm
533FIT_COMPRESSION ?= gzip
534
535quiet_cmd_fit = FIT     $@
536      cmd_fit = $(MAKE_FIT) -o $@ --arch $(UIMAGE_ARCH) --os linux \
537		--name '$(UIMAGE_NAME)' \
538		$(if $(findstring 1,$(KBUILD_VERBOSE)),-v) \
539		$(if $(FIT_DECOMPOSE_DTBS),--decompose-dtbs) \
540		--compress $(FIT_COMPRESSION) -k $< @$(word 2,$^)
541
542# XZ
543# ---------------------------------------------------------------------------
544# Use xzkern to compress the kernel image and xzmisc to compress other things.
545#
546# xzkern uses a big LZMA2 dictionary since it doesn't increase memory usage
547# of the kernel decompressor. A BCJ filter is used if it is available for
548# the target architecture. xzkern also appends uncompressed size of the data
549# using size_append. The .xz format has the size information available at
550# the end of the file too, but it's in more complex format and it's good to
551# avoid changing the part of the boot code that reads the uncompressed size.
552# Note that the bytes added by size_append will make the xz tool think that
553# the file is corrupt. This is expected.
554#
555# xzmisc doesn't use size_append, so it can be used to create normal .xz
556# files. xzmisc uses smaller LZMA2 dictionary than xzkern, because a very
557# big dictionary would increase the memory usage too much in the multi-call
558# decompression mode. A BCJ filter isn't used either.
559quiet_cmd_xzkern = XZKERN  $@
560      cmd_xzkern = cat $(real-prereqs) | sh $(srctree)/scripts/xz_wrap.sh > $@
561
562quiet_cmd_xzkern_with_size = XZKERN  $@
563      cmd_xzkern_with_size = { cat $(real-prereqs) | sh $(srctree)/scripts/xz_wrap.sh; \
564                     $(size_append); } > $@
565
566quiet_cmd_xzmisc = XZMISC  $@
567      cmd_xzmisc = cat $(real-prereqs) | $(XZ) --check=crc32 --lzma2=dict=1MiB > $@
568
569# ZSTD
570# ---------------------------------------------------------------------------
571# Appends the uncompressed size of the data using size_append. The .zst
572# format has the size information available at the beginning of the file too,
573# but it's in a more complex format and it's good to avoid changing the part
574# of the boot code that reads the uncompressed size.
575#
576# Note that the bytes added by size_append will make the zstd tool think that
577# the file is corrupt. This is expected.
578#
579# zstd uses a maximum window size of 8 MB. zstd22 uses a maximum window size of
580# 128 MB. zstd22 is used for kernel compression because it is decompressed in a
581# single pass, so zstd doesn't need to allocate a window buffer. When streaming
582# decompression is used, like initramfs decompression, zstd22 should likely not
583# be used because it would require zstd to allocate a 128 MB buffer.
584
585quiet_cmd_zstd = ZSTD    $@
586      cmd_zstd = cat $(real-prereqs) | $(ZSTD) -19 > $@
587
588quiet_cmd_zstd22 = ZSTD22  $@
589      cmd_zstd22 = cat $(real-prereqs) | $(ZSTD) -22 --ultra > $@
590
591quiet_cmd_zstd22_with_size = ZSTD22  $@
592      cmd_zstd22_with_size = { cat $(real-prereqs) | $(ZSTD) -22 --ultra; $(size_append); } > $@
593
594# ASM offsets
595# ---------------------------------------------------------------------------
596
597# Default sed regexp - multiline due to syntax constraints
598#
599# Use [:space:] because LLVM's integrated assembler inserts <tab> around
600# the .ascii directive whereas GCC keeps the <space> as-is.
601define sed-offsets
602	's:^[[:space:]]*\.ascii[[:space:]]*"\(.*\)".*:\1:; \
603	/^->/{s:->#\(.*\):/* \1 */:; \
604	s:^->\([^ ]*\) [\$$#]*\([^ ]*\) \(.*\):#define \1 \2 /* \3 */:; \
605	s:->::; p;}'
606endef
607
608# Use filechk to avoid rebuilds when a header changes, but the resulting file
609# does not
610define filechk_offsets
611	 echo "#ifndef $2"; \
612	 echo "#define $2"; \
613	 echo "/*"; \
614	 echo " * DO NOT MODIFY."; \
615	 echo " *"; \
616	 echo " * This file was generated by Kbuild"; \
617	 echo " */"; \
618	 echo ""; \
619	 sed -ne $(sed-offsets) < $<; \
620	 echo ""; \
621	 echo "#endif"
622endef
623