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