scripts/Kbuild.include

   1 # SPDX-License-Identifier: GPL-2.0
   2 ####
   3 # kbuild: Generic definitions
   4
   5 # Convenient variables
   6 comma   := ,
   7 quote   := "
   8 squote  := '
   9 empty   :=
  10 space   := $(empty) $(empty)
  11 space_escape := _-_SPACE_-_
  12 pound := \#
  13
  14 ###
  15 # Name of target with a '.' as filename prefix. foo/bar.o => foo/.bar.o
  16 dot-target = $(dir $@).$(notdir $@)
  17
  18 ###
  19 # The temporary file to save gcc -MD generated dependencies must not
  20 # contain a comma
  21 depfile = $(subst $(comma),_,$(dot-target).d)
  22
  23 ###
  24 # filename of target with directory and extension stripped
  25 basetarget = $(basename $(notdir $@))
  26
  27 ###
  28 # real prerequisites without phony targets
  29 real-prereqs = $(filter-out $(PHONY), $^)
  30
  31 ###
  32 # Escape single quote for use in echo statements
  33 escsq = $(subst $(squote),'\$(squote)',$1)
  34
  35 ###
  36 # Easy method for doing a status message
  37        kecho := :
  38  quiet_kecho := echo
  39 silent_kecho := :
  40 kecho := $($(quiet)kecho)
  41
  42 ###
  43 # filechk is used to check if the content of a generated file is updated.
  44 # Sample usage:
  45 #
  46 # filechk_sample = echo $(KERNELRELEASE)
  47 # version.h: FORCE
  48 #       $(call filechk,sample)
  49 #
  50 # The rule defined shall write to stdout the content of the new file.
  51 # The existing file will be compared with the new one.
  52 # - If no file exist it is created
  53 # - If the content differ the new file is used
  54 # - If they are equal no change, and no timestamp update
  55 # - stdin is piped in from the first prerequisite ($<) so one has
  56 #   to specify a valid file as first prerequisite (often the kbuild file)
  57 define filechk
  58         $(Q)set -e;                             \
  59         mkdir -p $(dir $@);                     \
  60         { $(filechk_$(1)); } > [email protected];          \
  61         if [ -r $@ ] && cmp -s $@ [email protected]; then  \
  62                 rm -f [email protected];                   \
  63         else                                    \
  64                 $(kecho) '  UPD     $@';        \
  65                 mv -f [email protected] $@;                \
  66         fi
  67 endef
  68
  69 ######
  70 # gcc support functions
  71 # See documentation in Documentation/kbuild/makefiles.rst
  72
  73 # cc-cross-prefix
  74 # Usage: CROSS_COMPILE := $(call cc-cross-prefix, m68k-linux-gnu- m68k-linux-)
  75 # Return first <prefix> where a <prefix>gcc is found in PATH.
  76 # If no gcc found in PATH with listed prefixes return nothing
  77 #
  78 # Note: '2>/dev/null' is here to force Make to invoke a shell. Otherwise, it
  79 # would try to directly execute the shell builtin 'command'. This workaround
  80 # should be kept for a long time since this issue was fixed only after the
  81 # GNU Make 4.2.1 release.
  82 cc-cross-prefix = $(firstword $(foreach c, $(filter-out -%, $(1)), \
  83                         $(if $(shell command -v $(c)gcc 2>/dev/null), $(c))))
  84
  85 # output directory for tests below
  86 TMPOUT := $(if $(KBUILD_EXTMOD),$(firstword $(KBUILD_EXTMOD))/)
  87
  88 # try-run
  89 # Usage: option = $(call try-run, $(CC)...-o "$$TMP",option-ok,otherwise)
  90 # Exit code chooses option. "$$TMP" serves as a temporary file and is
  91 # automatically cleaned up.
  92 try-run = $(shell set -e;               \
  93         TMP="$(TMPOUT).$$$$.tmp";       \
  94         TMPO="$(TMPOUT).$$$$.o";        \
  95         if ($(1)) >/dev/null 2>&1;      \
  96         then echo "$(2)";               \
  97         else echo "$(3)";               \
  98         fi;                             \
  99         rm -f "$$TMP" "$$TMPO")
 100
 101 # as-option
 102 # Usage: cflags-y += $(call as-option,-Wa$(comma)-isa=foo,)
 103
 104 as-option = $(call try-run,\
 105         $(CC) $(KBUILD_CFLAGS) $(1) -c -x assembler /dev/null -o "$$TMP",$(1),$(2))
 106
 107 # as-instr
 108 # Usage: cflags-y += $(call as-instr,instr,option1,option2)
 109
 110 as-instr = $(call try-run,\
 111         printf "%b\n" "$(1)" | $(CC) $(KBUILD_AFLAGS) -c -x assembler -o "$$TMP" -,$(2),$(3))
 112
 113 # __cc-option
 114 # Usage: MY_CFLAGS += $(call __cc-option,$(CC),$(MY_CFLAGS),-march=winchip-c6,-march=i586)
 115 __cc-option = $(call try-run,\
 116         $(1) -Werror $(2) $(3) -c -x c /dev/null -o "$$TMP",$(3),$(4))
 117
 118 # Do not attempt to build with gcc plugins during cc-option tests.
 119 # (And this uses delayed resolution so the flags will be up to date.)
 120 CC_OPTION_CFLAGS = $(filter-out $(GCC_PLUGINS_CFLAGS),$(KBUILD_CFLAGS))
 121
 122 # cc-option
 123 # Usage: cflags-y += $(call cc-option,-march=winchip-c6,-march=i586)
 124
 125 cc-option = $(call __cc-option, $(CC),\
 126         $(KBUILD_CPPFLAGS) $(CC_OPTION_CFLAGS),$(1),$(2))
 127
 128 # hostcc-option
 129 # Usage: cflags-y += $(call hostcc-option,-march=winchip-c6,-march=i586)
 130 hostcc-option = $(call __cc-option, $(HOSTCC),\
 131         $(KBUILD_HOSTCFLAGS) $(HOST_EXTRACFLAGS),$(1),$(2))
 132
 133 # cc-option-yn
 134 # Usage: flag := $(call cc-option-yn,-march=winchip-c6)
 135 cc-option-yn = $(call try-run,\
 136         $(CC) -Werror $(KBUILD_CPPFLAGS) $(CC_OPTION_CFLAGS) $(1) -c -x c /dev/null -o "$$TMP",y,n)
 137
 138 # cc-disable-warning
 139 # Usage: cflags-y += $(call cc-disable-warning,unused-but-set-variable)
 140 cc-disable-warning = $(call try-run,\
 141         $(CC) -Werror $(KBUILD_CPPFLAGS) $(CC_OPTION_CFLAGS) -W$(strip $(1)) -c -x c /dev/null -o "$$TMP",-Wno-$(strip $(1)))
 142
 143 # cc-ifversion
 144 # Usage:  EXTRA_CFLAGS += $(call cc-ifversion, -lt, 0402, -O1)
 145 cc-ifversion = $(shell [ $(CONFIG_GCC_VERSION)0 $(1) $(2)000 ] && echo $(3) || echo $(4))
 146
 147 # ld-option
 148 # Usage: KBUILD_LDFLAGS += $(call ld-option, -X, -Y)
 149 ld-option = $(call try-run, $(LD) $(KBUILD_LDFLAGS) $(1) -v,$(1),$(2),$(3))
 150
 151 # ar-option
 152 # Usage: KBUILD_ARFLAGS := $(call ar-option,D)
 153 # Important: no spaces around options
 154 ar-option = $(call try-run, $(AR) rc$(1) "$$TMP",$(1),$(2))
 155
 156 # ld-version
 157 # Note this is mainly for HJ Lu's 3 number binutil versions
 158 ld-version = $(shell $(LD) --version | $(srctree)/scripts/ld-version.sh)
 159
 160 # ld-ifversion
 161 # Usage:  $(call ld-ifversion, -ge, 22252, y)
 162 ld-ifversion = $(shell [ $(ld-version) $(1) $(2) ] && echo $(3) || echo $(4))
 163
 164 ######
 165
 166 ###
 167 # Shorthand for $(Q)$(MAKE) -f scripts/Makefile.build obj=
 168 # Usage:
 169 # $(Q)$(MAKE) $(build)=dir
 170 build := -f $(srctree)/scripts/Makefile.build obj
 171
 172 ###
 173 # Shorthand for $(Q)$(MAKE) -f scripts/Makefile.modbuiltin obj=
 174 # Usage:
 175 # $(Q)$(MAKE) $(modbuiltin)=dir
 176 modbuiltin := -f $(srctree)/scripts/Makefile.modbuiltin obj
 177
 178 ###
 179 # Shorthand for $(Q)$(MAKE) -f scripts/Makefile.dtbinst obj=
 180 # Usage:
 181 # $(Q)$(MAKE) $(dtbinst)=dir
 182 dtbinst := -f $(srctree)/scripts/Makefile.dtbinst obj
 183
 184 ###
 185 # Shorthand for $(Q)$(MAKE) -f scripts/Makefile.clean obj=
 186 # Usage:
 187 # $(Q)$(MAKE) $(clean)=dir
 188 clean := -f $(srctree)/scripts/Makefile.clean obj
 189
 190 ###
 191 # Shorthand for $(Q)$(MAKE) -f scripts/Makefile.headersinst obj=
 192 # Usage:
 193 # $(Q)$(MAKE) $(hdr-inst)=dir
 194 hdr-inst := -f $(srctree)/scripts/Makefile.headersinst obj
 195
 196 # echo command.
 197 # Short version is used, if $(quiet) equals `quiet_', otherwise full one.
 198 echo-cmd = $(if $($(quiet)cmd_$(1)),\
 199         echo '  $(call escsq,$($(quiet)cmd_$(1)))$(echo-why)';)
 200
 201 # printing commands
 202 cmd = @set -e; $(echo-cmd) $(cmd_$(1))
 203
 204 # Add $(obj)/ for paths that are not absolute
 205 objectify = $(foreach o,$(1),$(if $(filter /%,$(o)),$(o),$(obj)/$(o)))
 206
 207 ###
 208 # if_changed      - execute command if any prerequisite is newer than
 209 #                   target, or command line has changed
 210 # if_changed_dep  - as if_changed, but uses fixdep to reveal dependencies
 211 #                   including used config symbols
 212 # if_changed_rule - as if_changed but execute rule instead
 213 # See Documentation/kbuild/makefiles.rst for more info
 214
 215 ifneq ($(KBUILD_NOCMDDEP),1)
 216 # Check if both arguments are the same including their order. Result is empty
 217 # string if equal. User may override this check using make KBUILD_NOCMDDEP=1
 218 arg-check = $(filter-out $(subst $(space),$(space_escape),$(strip $(cmd_$@))), \
 219                          $(subst $(space),$(space_escape),$(strip $(cmd_$1))))
 220 else
 221 arg-check = $(if $(strip $(cmd_$@)),,1)
 222 endif
 223
 224 # Replace >$< with >$$< to preserve $ when reloading the .cmd file
 225 # (needed for make)
 226 # Replace >#< with >$(pound)< to avoid starting a comment in the .cmd file
 227 # (needed for make)
 228 # Replace >'< with >'\''< to be able to enclose the whole string in '...'
 229 # (needed for the shell)
 230 make-cmd = $(call escsq,$(subst $(pound),$$(pound),$(subst $$,$$$$,$(cmd_$(1)))))
 231
 232 # Find any prerequisites that is newer than target or that does not exist.
 233 # PHONY targets skipped in both cases.
 234 any-prereq = $(filter-out $(PHONY),$?) $(filter-out $(PHONY) $(wildcard $^),$^)
 235
 236 # Execute command if command has changed or prerequisite(s) are updated.
 237 if_changed = $(if $(strip $(any-prereq) $(arg-check)),                       \
 238         $(cmd);                                                              \
 239         printf '%s\n' 'cmd_$@ := $(make-cmd)' > $(dot-target).cmd, @:)
 240
 241 # Execute the command and also postprocess generated .d dependencies file.
 242 if_changed_dep = $(if $(strip $(any-prereq) $(arg-check)),$(cmd_and_fixdep),@:)
 243
 244 cmd_and_fixdep =                                                             \
 245         $(cmd);                                                              \
 246         scripts/basic/fixdep $(depfile) $@ '$(make-cmd)' > $(dot-target).cmd;\
 247         rm -f $(depfile)
 248
 249 # Usage: $(call if_changed_rule,foo)
 250 # Will check if $(cmd_foo) or any of the prerequisites changed,
 251 # and if so will execute $(rule_foo).
 252 if_changed_rule = $(if $(strip $(any-prereq) $(arg-check)),$(rule_$(1)),@:)
 253
 254 ###
 255 # why - tell why a target got built
 256 #       enabled by make V=2
 257 #       Output (listed in the order they are checked):
 258 #          (1) - due to target is PHONY
 259 #          (2) - due to target missing
 260 #          (3) - due to: file1.h file2.h
 261 #          (4) - due to command line change
 262 #          (5) - due to missing .cmd file
 263 #          (6) - due to target not in $(targets)
 264 # (1) PHONY targets are always build
 265 # (2) No target, so we better build it
 266 # (3) Prerequisite is newer than target
 267 # (4) The command line stored in the file named dir/.target.cmd
 268 #     differed from actual command line. This happens when compiler
 269 #     options changes
 270 # (5) No dir/.target.cmd file (used to store command line)
 271 # (6) No dir/.target.cmd file and target not listed in $(targets)
 272 #     This is a good hint that there is a bug in the kbuild file
 273 ifeq ($(KBUILD_VERBOSE),2)
 274 why =                                                                        \
 275     $(if $(filter $@, $(PHONY)),- due to target is PHONY,                    \
 276         $(if $(wildcard $@),                                                 \
 277             $(if $(strip $(any-prereq)),- due to: $(any-prereq),             \
 278                 $(if $(arg-check),                                           \
 279                     $(if $(cmd_$@),- due to command line change,             \
 280                         $(if $(filter $@, $(targets)),                       \
 281                             - due to missing .cmd file,                      \
 282                             - due to $(notdir $@) not in $$(targets)         \
 283                          )                                                   \
 284                      )                                                       \
 285                  )                                                           \
 286              ),                                                              \
 287              - due to target missing                                         \
 288          )                                                                   \
 289      )
 290
 291 echo-why = $(call escsq, $(strip $(why)))
 292 endif
 293
 294 ###############################################################################
 295 #
 296 # When a Kconfig string contains a filename, it is suitable for
 297 # passing to shell commands. It is surrounded by double-quotes, and
 298 # any double-quotes or backslashes within it are escaped by
 299 # backslashes.
 300 #
 301 # This is no use for dependencies or $(wildcard). We need to strip the
 302 # surrounding quotes and the escaping from quotes and backslashes, and
 303 # we *do* need to escape any spaces in the string. So, for example:
 304 #
 305 # Usage: $(eval $(call config_filename,FOO))
 306 #
 307 # Defines FOO_FILENAME based on the contents of the CONFIG_FOO option,
 308 # transformed as described above to be suitable for use within the
 309 # makefile.
 310 #
 311 # Also, if the filename is a relative filename and exists in the source
 312 # tree but not the build tree, define FOO_SRCPREFIX as $(srctree)/ to
 313 # be prefixed to *both* command invocation and dependencies.
 314 #
 315 # Note: We also print the filenames in the quiet_cmd_foo text, and
 316 # perhaps ought to have a version specially escaped for that purpose.
 317 # But it's only cosmetic, and $(patsubst "%",%,$(CONFIG_FOO)) is good
 318 # enough.  It'll strip the quotes in the common case where there's no
 319 # space and it's a simple filename, and it'll retain the quotes when
 320 # there's a space. There are some esoteric cases in which it'll print
 321 # the wrong thing, but we don't really care. The actual dependencies
 322 # and commands *do* get it right, with various combinations of single
 323 # and double quotes, backslashes and spaces in the filenames.
 324 #
 325 ###############################################################################
 326 #
 327 define config_filename
 328 ifneq ($$(CONFIG_$(1)),"")
 329 $(1)_FILENAME := $$(subst \\,\,$$(subst \$$(quote),$$(quote),$$(subst $$(space_escape),\$$(space),$$(patsubst "%",%,$$(subst $$(space),$$(space_escape),$$(CONFIG_$(1)))))))
 330 ifneq ($$(patsubst /%,%,$$(firstword $$($(1)_FILENAME))),$$(firstword $$($(1)_FILENAME)))
 331 else
 332 ifeq ($$(wildcard $$($(1)_FILENAME)),)
 333 ifneq ($$(wildcard $$(srctree)/$$($(1)_FILENAME)),)
 334 $(1)_SRCPREFIX := $(srctree)/
 335 endif
 336 endif
 337 endif
 338 endif
 339 endef
 340 #
 341 ###############################################################################
 342
 343 # delete partially updated (i.e. corrupted) files on error
 344 .DELETE_ON_ERROR:
 345
 346 # do not delete intermediate files automatically
 347 .SECONDARY: