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