scripts/Kbuild.include

   1 ####
   2 # kbuild: Generic definitions
   3
   4 # Convenient variables
   5 comma   := ,
   6 quote   := "
   7 squote  := '
   8 empty   :=
   9 space   := $(empty) $(empty)
  10 space_escape := _-_SPACE_-_
  11 pound := \#
  12
  13 ###
  14 # Name of target with a '.' as filename prefix. foo/bar.o => foo/.bar.o
  15 dot-target = $(dir $@).$(notdir $@)
  16
  17 ###
  18 # The temporary file to save gcc -MD generated dependencies must not
  19 # contain a comma
  20 depfile = $(subst $(comma),_,$(dot-target).d)
  21
  22 ###
  23 # filename of target with directory and extension stripped
  24 basetarget = $(basename $(notdir $@))
  25
  26 ###
  27 # filename of first prerequisite with directory and extension stripped
  28 baseprereq = $(basename $(notdir $<))
  29
  30 ###
  31 # Escape single quote for use in echo statements
  32 escsq = $(subst $(squote),'\$(squote)',$1)
  33
  34 ###
  35 # Easy method for doing a status message
  36        kecho := :
  37  quiet_kecho := echo
  38 silent_kecho := :
  39 kecho := $($(quiet)kecho)
  40
  41 ###
  42 # filechk is used to check if the content of a generated file is updated.
  43 # Sample usage:
  44 # define filechk_sample
  45 #       echo $KERNELRELEASE
  46 # endef
  47 # version.h : Makefile
  48 #       $(call filechk,sample)
  49 # The rule defined shall write to stdout the content of the new file.
  50 # The existing file will be compared with the new one.
  51 # - If no file exist it is created
  52 # - If the content differ the new file is used
  53 # - If they are equal no change, and no timestamp update
  54 # - stdin is piped in from the first prerequisite ($<) so one has
  55 #   to specify a valid file as first prerequisite (often the kbuild file)
  56 define filechk
  57         $(Q)set -e;                             \
  58         $(kecho) '  CHK     $@';                \
  59         mkdir -p $(dir $@);                     \
  60         $(filechk_$(1)) < $< > $@.tmp;          \
  61         if [ -r $@ ] && cmp -s $@ $@.tmp; then  \
  62                 rm -f $@.tmp;                   \
  63         else                                    \
  64                 $(kecho) '  UPD     $@';        \
  65                 mv -f $@.tmp $@;                \
  66         fi
  67 endef
  68
  69 ######
  70 # gcc support functions
  71 # See documentation in Documentation/kbuild/makefiles.txt
  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$(CC) is found in PATH.
  76 # If no $(CC) found in PATH with listed prefixes return nothing
  77 cc-cross-prefix =  \
  78         $(word 1, $(foreach c,$(1),                                   \
  79                 $(shell set -e;                                       \
  80                 if (which $(strip $(c))$(CC)) > /dev/null 2>&1 ; then \
  81                         echo $(c);                                    \
  82                 fi)))
  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 # hostcc-option
 128 # Usage: cflags-y += $(call hostcc-option,-march=winchip-c6,-march=i586)
 129 hostcc-option = $(call __cc-option, $(HOSTCC),\
 130         $(HOSTCFLAGS) $(HOST_EXTRACFLAGS),$(1),$(2))
 131
 132 # cc-option-yn
 133 # Usage: flag := $(call cc-option-yn,-march=winchip-c6)
 134 cc-option-yn = $(call try-run,\
 135         $(CC) -Werror $(KBUILD_CPPFLAGS) $(CC_OPTION_CFLAGS) $(1) -c -x c /dev/null -o "$$TMP",y,n)
 136
 137 # cc-disable-warning
 138 # Usage: cflags-y += $(call cc-disable-warning,unused-but-set-variable)
 139 cc-disable-warning = $(call try-run,\
 140         $(CC) -Werror $(KBUILD_CPPFLAGS) $(CC_OPTION_CFLAGS) -W$(strip $(1)) -c -x c /dev/null -o "$$TMP",-Wno-$(strip $(1)))
 141
 142 # cc-name
 143 # Expands to either gcc or clang
 144 cc-name = $(shell $(CC) -v 2>&1 | grep -q "clang version" && echo clang || echo gcc)
 145
 146 # __cc-version
 147 # Returns compiler version
 148 __cc-version = $(shell $(CONFIG_SHELL) $(srctree)/scripts/$(cc-name)-version.sh $(CC))
 149
 150 # __cc-fullversion
 151 # Returns full compiler version
 152 __cc-fullversion = $(shell $(CONFIG_SHELL) \
 153         $(srctree)/scripts/$(cc-name)-version.sh -p $(CC))
 154
 155 # __cc-ifversion
 156 # Matches compiler name and version
 157 # Usage:  EXTRA_CFLAGS += $(call cc-if-name-version, gcc, -lt, 0402, -O1)
 158 __cc-ifversion = $(shell [ $(cc-name) = $(1) ] && [ $(__cc-version) $(2) $(3) ] && echo $(4) || echo $(5))
 159
 160 # __cc-if-fullversion
 161 # Matches compiler name and full version
 162 # Usage:  EXTRA_CFLAGS += $(call cc-if-name-fullversion, gcc, -lt, 040502, -O1)
 163 __cc-if-fullversion = $(shell [ $(cc-name) = $(1) ] && [ $(__cc-fullversion) $(2) $(3) ] && echo $(4) || echo $(5))
 164
 165 # gcc-ifversion
 166 gcc-ifversion = $(call __cc-ifversion, gcc, $(1), $(2), $(3), $(4))
 167
 168 # gcc-if-fullversion
 169 gcc-if-fullversion = (call __cc-if-fullversion, gcc, $(1), $(2), $(3), $(4))
 170
 171 # clang-ifversion
 172 clang-ifversion =  $(call __cc-ifversion, clang, $(1), $(2), $(3), $(4))
 173
 174 # clang-if-fullversion
 175 clang-if-fullversion = (call __cc-if-fullversion, clang, $(1), $(2), $(3), $(4))
 176
 177 # cc-version
 178 cc-version = $(shell $(CONFIG_SHELL) $(srctree)/scripts/gcc-version.sh $(CC))
 179
 180 # cc-fullversion
 181 cc-fullversion = $(shell $(CONFIG_SHELL) \
 182         $(srctree)/scripts/gcc-version.sh -p $(CC))
 183
 184 # backward compatibility
 185 cc-ifversion = $(gcc-ifversion)
 186 cc-if-fullversion = $(gcc-if-fullversion)
 187
 188 # cc-if-fullversion
 189 # Usage:  EXTRA_CFLAGS += $(call cc-if-fullversion, -lt, 040502, -O1)
 190 cc-if-fullversion = $(shell [ $(cc-fullversion) $(1) $(2) ] && echo $(3) || echo $(4))
 191
 192 # cc-ldoption
 193 # Usage: ldflags += $(call cc-ldoption, -Wl$(comma)--hash-style=both)
 194 cc-ldoption = $(call try-run,\
 195         $(CC) $(1) $(KBUILD_CPPFLAGS) $(CC_OPTION_CFLAGS) -nostdlib -x c /dev/null -o "$$TMP",$(1),$(2))
 196
 197 # ld-option
 198 # Usage: LDFLAGS += $(call ld-option, -X)
 199 ld-option = $(call try-run,\
 200         $(CC) $(KBUILD_CPPFLAGS) $(CC_OPTION_CFLAGS) -x c /dev/null -c -o "$$TMPO"; \
 201         $(LD) $(LDFLAGS) $(1) "$$TMPO" -o "$$TMP",$(1),$(2))
 202
 203 # ar-option
 204 # Usage: KBUILD_ARFLAGS := $(call ar-option,D)
 205 # Important: no spaces around options
 206 ar-option = $(call try-run, $(AR) rc$(1) "$$TMP",$(1),$(2))
 207
 208 # ld-name
 209 # Expands to either bfd or gold
 210 ld-name = $(shell $(LD) -v 2>&1 | grep -q "GNU gold" && echo gold || echo bfd)
 211
 212 # ld-version
 213 # Note this is mainly for HJ Lu's 3 number binutil versions
 214 ld-version = $(shell $(LD) --version | $(srctree)/scripts/ld-version.sh)
 215
 216 # ld-ifversion
 217 # Usage:  $(call ld-ifversion, -ge, 22252, y)
 218 ld-ifversion = $(shell [ $(ld-version) $(1) $(2) ] && echo $(3) || echo $(4))
 219
 220 # __ld-ifversion
 221 # Usage:  $(call __ld-ifversion, gold, -ge, 112000000, y)
 222 __ld-ifversion = $(shell [ $(ld-name) = $(1) ] && [ $(ld-version) $(2) $(3) ] && echo $(4) || echo $(5))
 223
 224 # bfd-ifversion
 225 # Usage:  $(call bfd-ifversion, -ge, 227000000, y)
 226 bfd-ifversion = $(call __ld-ifversion, bfd, $(1), $(2), $(3), $(4))
 227
 228 # gold-ifversion
 229 # Usage:  $(call gold-ifversion, -ge, 112000000, y)
 230 gold-ifversion = $(call __ld-ifversion, gold, $(1), $(2), $(3), $(4))
 231
 232 ######
 233
 234 ###
 235 # Shorthand for $(Q)$(MAKE) -f scripts/Makefile.build obj=
 236 # Usage:
 237 # $(Q)$(MAKE) $(build)=dir
 238 build := -f $(srctree)/scripts/Makefile.build obj
 239
 240 ###
 241 # Shorthand for $(Q)$(MAKE) -f scripts/Makefile.modbuiltin obj=
 242 # Usage:
 243 # $(Q)$(MAKE) $(modbuiltin)=dir
 244 modbuiltin := -f $(srctree)/scripts/Makefile.modbuiltin obj
 245
 246 ###
 247 # Shorthand for $(Q)$(MAKE) -f scripts/Makefile.dtbinst obj=
 248 # Usage:
 249 # $(Q)$(MAKE) $(dtbinst)=dir
 250 dtbinst := -f $(if $(KBUILD_SRC),$(srctree)/)scripts/Makefile.dtbinst obj
 251
 252 ###
 253 # Shorthand for $(Q)$(MAKE) -f scripts/Makefile.clean obj=
 254 # Usage:
 255 # $(Q)$(MAKE) $(clean)=dir
 256 clean := -f $(srctree)/scripts/Makefile.clean obj
 257
 258 ###
 259 # Shorthand for $(Q)$(MAKE) -f scripts/Makefile.headersinst obj=
 260 # Usage:
 261 # $(Q)$(MAKE) $(hdr-inst)=dir
 262 hdr-inst := -f $(srctree)/scripts/Makefile.headersinst obj
 263
 264 # Prefix -I with $(srctree) if it is not an absolute path.
 265 # skip if -I has no parameter
 266 addtree = $(if $(patsubst -I%,%,$(1)), \
 267 $(if $(filter-out -I/% -I./% -I../%,$(1)),$(patsubst -I%,-I$(srctree)/%,$(1)),$(1)))
 268
 269 # Find all -I options and call addtree
 270 flags = $(foreach o,$($(1)),$(if $(filter -I%,$(o)),$(call addtree,$(o)),$(o)))
 271
 272 # echo command.
 273 # Short version is used, if $(quiet) equals `quiet_', otherwise full one.
 274 echo-cmd = $(if $($(quiet)cmd_$(1)),\
 275         echo '  $(call escsq,$($(quiet)cmd_$(1)))$(echo-why)';)
 276
 277 # printing commands
 278 cmd = @$(echo-cmd) $(cmd_$(1))
 279
 280 # Add $(obj)/ for paths that are not absolute
 281 objectify = $(foreach o,$(1),$(if $(filter /%,$(o)),$(o),$(obj)/$(o)))
 282
 283 ###
 284 # if_changed      - execute command if any prerequisite is newer than
 285 #                   target, or command line has changed
 286 # if_changed_dep  - as if_changed, but uses fixdep to reveal dependencies
 287 #                   including used config symbols
 288 # if_changed_rule - as if_changed but execute rule instead
 289 # See Documentation/kbuild/makefiles.txt for more info
 290
 291 ifneq ($(KBUILD_NOCMDDEP),1)
 292 # Check if both arguments are the same including their order. Result is empty
 293 # string if equal. User may override this check using make KBUILD_NOCMDDEP=1
 294 arg-check = $(filter-out $(subst $(space),$(space_escape),$(strip $(cmd_$@))), \
 295                          $(subst $(space),$(space_escape),$(strip $(cmd_$1))))
 296 else
 297 arg-check = $(if $(strip $(cmd_$@)),,1)
 298 endif
 299
 300 # Replace >$< with >$$< to preserve $ when reloading the .cmd file
 301 # (needed for make)
 302 # Replace >#< with >$(pound)< to avoid starting a comment in the .cmd file
 303 # (needed for make)
 304 # Replace >'< with >'\''< to be able to enclose the whole string in '...'
 305 # (needed for the shell)
 306 make-cmd = $(call escsq,$(subst $(pound),$$(pound),$(subst $$,$$$$,$(cmd_$(1)))))
 307
 308 # Find any prerequisites that is newer than target or that does not exist.
 309 # PHONY targets skipped in both cases.
 310 any-prereq = $(filter-out $(PHONY),$?) $(filter-out $(PHONY) $(wildcard $^),$^)
 311
 312 # Execute command if command has changed or prerequisite(s) are updated.
 313 if_changed = $(if $(strip $(any-prereq) $(arg-check)),                       \
 314         @set -e;                                                             \
 315         $(echo-cmd) $(cmd_$(1));                                             \
 316         printf '%s\n' 'cmd_$@ := $(make-cmd)' > $(dot-target).cmd, @:)
 317
 318 # Execute the command and also postprocess generated .d dependencies file.
 319 if_changed_dep = $(if $(strip $(any-prereq) $(arg-check) ),                  \
 320         @set -e;                                                             \
 321         $(cmd_and_fixdep), @:)
 322
 323 ifndef CONFIG_TRIM_UNUSED_KSYMS
 324
 325 cmd_and_fixdep =                                                             \
 326         $(echo-cmd) $(cmd_$(1));                                             \
 327         scripts/basic/fixdep $(depfile) $@ '$(make-cmd)' > $(dot-target).tmp;\
 328         rm -f $(depfile);                                                    \
 329         mv -f $(dot-target).tmp $(dot-target).cmd;
 330
 331 else
 332
 333 # Filter out exported kernel symbol names from the preprocessor output.
 334 # See also __KSYM_DEPS__ in include/linux/export.h.
 335 # We disable the depfile generation here, so as not to overwrite the existing
 336 # depfile while fixdep is parsing it.
 337 flags_nodeps = $(filter-out -Wp$(comma)-M%, $($(1)))
 338 ksym_dep_filter =                                                            \
 339         case "$(1)" in                                                       \
 340           cc_*_c|cpp_i_c)                                                    \
 341             $(CPP) $(call flags_nodeps,c_flags) -D__KSYM_DEPS__ $< ;;        \
 342           as_*_S|cpp_s_S)                                                    \
 343             $(CPP) $(call flags_nodeps,a_flags) -D__KSYM_DEPS__ $< ;;        \
 344           boot*|build*|cpp_its_S|*cpp_lds_S|dtc|host*|vdso*) : ;;            \
 345           *) echo "Don't know how to preprocess $(1)" >&2; false ;;          \
 346         esac | tr ";" "\n" | sed -rn 's/^.*=== __KSYM_(.*) ===.*$$/KSYM_\1/p'
 347
 348 cmd_and_fixdep =                                                             \
 349         $(echo-cmd) $(cmd_$(1));                                             \
 350         $(ksym_dep_filter) |                                                 \
 351                 scripts/basic/fixdep -e $(depfile) $@ '$(make-cmd)'          \
 352                         > $(dot-target).tmp;                                 \
 353         rm -f $(depfile);                                                    \
 354         mv -f $(dot-target).tmp $(dot-target).cmd;
 355
 356 endif
 357
 358 # Usage: $(call if_changed_rule,foo)
 359 # Will check if $(cmd_foo) or any of the prerequisites changed,
 360 # and if so will execute $(rule_foo).
 361 if_changed_rule = $(if $(strip $(any-prereq) $(arg-check) ),                 \
 362         @set -e;                                                             \
 363         $(rule_$(1)), @:)
 364
 365 ###
 366 # why - tell why a target got built
 367 #       enabled by make V=2
 368 #       Output (listed in the order they are checked):
 369 #          (1) - due to target is PHONY
 370 #          (2) - due to target missing
 371 #          (3) - due to: file1.h file2.h
 372 #          (4) - due to command line change
 373 #          (5) - due to missing .cmd file
 374 #          (6) - due to target not in $(targets)
 375 # (1) PHONY targets are always build
 376 # (2) No target, so we better build it
 377 # (3) Prerequisite is newer than target
 378 # (4) The command line stored in the file named dir/.target.cmd
 379 #     differed from actual command line. This happens when compiler
 380 #     options changes
 381 # (5) No dir/.target.cmd file (used to store command line)
 382 # (6) No dir/.target.cmd file and target not listed in $(targets)
 383 #     This is a good hint that there is a bug in the kbuild file
 384 ifeq ($(KBUILD_VERBOSE),2)
 385 why =                                                                        \
 386     $(if $(filter $@, $(PHONY)),- due to target is PHONY,                    \
 387         $(if $(wildcard $@),                                                 \
 388             $(if $(strip $(any-prereq)),- due to: $(any-prereq),             \
 389                 $(if $(arg-check),                                           \
 390                     $(if $(cmd_$@),- due to command line change,             \
 391                         $(if $(filter $@, $(targets)),                       \
 392                             - due to missing .cmd file,                      \
 393                             - due to $(notdir $@) not in $$(targets)         \
 394                          )                                                   \
 395                      )                                                       \
 396                  )                                                           \
 397              ),                                                              \
 398              - due to target missing                                         \
 399          )                                                                   \
 400      )
 401
 402 echo-why = $(call escsq, $(strip $(why)))
 403 endif
 404
 405 ###############################################################################
 406 #
 407 # When a Kconfig string contains a filename, it is suitable for
 408 # passing to shell commands. It is surrounded by double-quotes, and
 409 # any double-quotes or backslashes within it are escaped by
 410 # backslashes.
 411 #
 412 # This is no use for dependencies or $(wildcard). We need to strip the
 413 # surrounding quotes and the escaping from quotes and backslashes, and
 414 # we *do* need to escape any spaces in the string. So, for example:
 415 #
 416 # Usage: $(eval $(call config_filename,FOO))
 417 #
 418 # Defines FOO_FILENAME based on the contents of the CONFIG_FOO option,
 419 # transformed as described above to be suitable for use within the
 420 # makefile.
 421 #
 422 # Also, if the filename is a relative filename and exists in the source
 423 # tree but not the build tree, define FOO_SRCPREFIX as $(srctree)/ to
 424 # be prefixed to *both* command invocation and dependencies.
 425 #
 426 # Note: We also print the filenames in the quiet_cmd_foo text, and
 427 # perhaps ought to have a version specially escaped for that purpose.
 428 # But it's only cosmetic, and $(patsubst "%",%,$(CONFIG_FOO)) is good
 429 # enough.  It'll strip the quotes in the common case where there's no
 430 # space and it's a simple filename, and it'll retain the quotes when
 431 # there's a space. There are some esoteric cases in which it'll print
 432 # the wrong thing, but we don't really care. The actual dependencies
 433 # and commands *do* get it right, with various combinations of single
 434 # and double quotes, backslashes and spaces in the filenames.
 435 #
 436 ###############################################################################
 437 #
 438 define config_filename
 439 ifneq ($$(CONFIG_$(1)),"")
 440 $(1)_FILENAME := $$(subst \\,\,$$(subst \$$(quote),$$(quote),$$(subst $$(space_escape),\$$(space),$$(patsubst "%",%,$$(subst $$(space),$$(space_escape),$$(CONFIG_$(1)))))))
 441 ifneq ($$(patsubst /%,%,$$(firstword $$($(1)_FILENAME))),$$(firstword $$($(1)_FILENAME)))
 442 else
 443 ifeq ($$(wildcard $$($(1)_FILENAME)),)
 444 ifneq ($$(wildcard $$(srctree)/$$($(1)_FILENAME)),)
 445 $(1)_SRCPREFIX := $(srctree)/
 446 endif
 447 endif
 448 endif
 449 endif
 450 endef
 451 #
 452 ###############################################################################
 453
 454 # delete partially updated (i.e. corrupted) files on error
 455 .DELETE_ON_ERROR: