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