scripts/Makefile.lib

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