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" is can be used as temporary file and
  90 # is 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-option-align
 138 # Prefix align with either -falign or -malign
 139 cc-option-align = $(subst -functions=0,,\
 140         $(call cc-option,-falign-functions=0,-malign-functions=0))
 141
 142 # cc-disable-warning
 143 # Usage: cflags-y += $(call cc-disable-warning,unused-but-set-variable)
 144 cc-disable-warning = $(call try-run,\
 145         $(CC) -Werror $(KBUILD_CPPFLAGS) $(CC_OPTION_CFLAGS) -W$(strip $(1)) -c -x c /dev/null -o "$$TMP",-Wno-$(strip $(1)))
 146
 147 # cc-name
 148 # Expands to either gcc or clang
 149 cc-name = $(shell $(CC) -v 2>&1 | grep -q "clang version" && echo clang || echo gcc)
 150
 151 # cc-version
 152 cc-version = $(shell $(CONFIG_SHELL) $(srctree)/scripts/gcc-version.sh $(CC))
 153
 154 # cc-fullversion
 155 cc-fullversion = $(shell $(CONFIG_SHELL) \
 156         $(srctree)/scripts/gcc-version.sh -p $(CC))
 157
 158 # cc-ifversion
 159 # Usage:  EXTRA_CFLAGS += $(call cc-ifversion, -lt, 0402, -O1)
 160 cc-ifversion = $(shell [ $(cc-version) $(1) $(2) ] && echo $(3) || echo $(4))
 161
 162 # cc-ldoption
 163 # Usage: ldflags += $(call cc-ldoption, -Wl$(comma)--hash-style=both)
 164 cc-ldoption = $(call try-run,\
 165         $(CC) $(1) $(KBUILD_CPPFLAGS) $(CC_OPTION_CFLAGS) -nostdlib -x c /dev/null -o "$$TMP",$(1),$(2))
 166
 167 # ld-option
 168 # Usage: LDFLAGS += $(call ld-option, -X)
 169 ld-option = $(call try-run,\
 170         $(CC) $(KBUILD_CPPFLAGS) $(CC_OPTION_CFLAGS) -x c /dev/null -c -o "$$TMPO"; \
 171         $(LD) $(LDFLAGS) $(1) "$$TMPO" -o "$$TMP",$(1),$(2))
 172
 173 # ar-option
 174 # Usage: KBUILD_ARFLAGS := $(call ar-option,D)
 175 # Important: no spaces around options
 176 ar-option = $(call try-run, $(AR) rc$(1) "$$TMP",$(1),$(2))
 177
 178 # ld-version
 179 # Note this is mainly for HJ Lu's 3 number binutil versions
 180 ld-version = $(shell $(LD) --version | $(srctree)/scripts/ld-version.sh)
 181
 182 # ld-ifversion
 183 # Usage:  $(call ld-ifversion, -ge, 22252, y)
 184 ld-ifversion = $(shell [ $(ld-version) $(1) $(2) ] && echo $(3) || echo $(4))
 185
 186 ######
 187
 188 ###
 189 # Shorthand for $(Q)$(MAKE) -f scripts/Makefile.build obj=
 190 # Usage:
 191 # $(Q)$(MAKE) $(build)=dir
 192 build := -f $(srctree)/scripts/Makefile.build obj
 193
 194 ###
 195 # Shorthand for $(Q)$(MAKE) -f scripts/Makefile.modbuiltin obj=
 196 # Usage:
 197 # $(Q)$(MAKE) $(modbuiltin)=dir
 198 modbuiltin := -f $(srctree)/scripts/Makefile.modbuiltin obj
 199
 200 ###
 201 # Shorthand for $(Q)$(MAKE) -f scripts/Makefile.dtbinst obj=
 202 # Usage:
 203 # $(Q)$(MAKE) $(dtbinst)=dir
 204 dtbinst := -f $(if $(KBUILD_SRC),$(srctree)/)scripts/Makefile.dtbinst obj
 205
 206 ###
 207 # Shorthand for $(Q)$(MAKE) -f scripts/Makefile.clean obj=
 208 # Usage:
 209 # $(Q)$(MAKE) $(clean)=dir
 210 clean := -f $(srctree)/scripts/Makefile.clean obj
 211
 212 ###
 213 # Shorthand for $(Q)$(MAKE) -f scripts/Makefile.headersinst obj=
 214 # Usage:
 215 # $(Q)$(MAKE) $(hdr-inst)=dir
 216 hdr-inst := -f $(srctree)/scripts/Makefile.headersinst obj
 217
 218 # Prefix -I with $(srctree) if it is not an absolute path.
 219 # skip if -I has no parameter
 220 addtree = $(if $(patsubst -I%,%,$(1)), \
 221 $(if $(filter-out -I/% -I./% -I../%,$(1)),$(patsubst -I%,-I$(srctree)/%,$(1)),$(1)))
 222
 223 # Find all -I options and call addtree
 224 flags = $(foreach o,$($(1)),$(if $(filter -I%,$(o)),$(call addtree,$(o)),$(o)))
 225
 226 # echo command.
 227 # Short version is used, if $(quiet) equals `quiet_', otherwise full one.
 228 echo-cmd = $(if $($(quiet)cmd_$(1)),\
 229         echo '  $(call escsq,$($(quiet)cmd_$(1)))$(echo-why)';)
 230
 231 # printing commands
 232 cmd = @$(echo-cmd) $(cmd_$(1))
 233
 234 # Add $(obj)/ for paths that are not absolute
 235 objectify = $(foreach o,$(1),$(if $(filter /%,$(o)),$(o),$(obj)/$(o)))
 236
 237 ###
 238 # if_changed      - execute command if any prerequisite is newer than
 239 #                   target, or command line has changed
 240 # if_changed_dep  - as if_changed, but uses fixdep to reveal dependencies
 241 #                   including used config symbols
 242 # if_changed_rule - as if_changed but execute rule instead
 243 # See Documentation/kbuild/makefiles.txt for more info
 244
 245 ifneq ($(KBUILD_NOCMDDEP),1)
 246 # Check if both arguments are the same including their order. Result is empty
 247 # string if equal. User may override this check using make KBUILD_NOCMDDEP=1
 248 arg-check = $(filter-out $(subst $(space),$(space_escape),$(strip $(cmd_$@))), \
 249                          $(subst $(space),$(space_escape),$(strip $(cmd_$1))))
 250 else
 251 arg-check = $(if $(strip $(cmd_$@)),,1)
 252 endif
 253
 254 # Replace >$< with >$$< to preserve $ when reloading the .cmd file
 255 # (needed for make)
 256 # Replace >#< with >$(pound)< to avoid starting a comment in the .cmd file
 257 # (needed for make)
 258 # Replace >'< with >'\''< to be able to enclose the whole string in '...'
 259 # (needed for the shell)
 260 make-cmd = $(call escsq,$(subst $(pound),$$(pound),$(subst $$,$$$$,$(cmd_$(1)))))
 261
 262 # Find any prerequisites that is newer than target or that does not exist.
 263 # PHONY targets skipped in both cases.
 264 any-prereq = $(filter-out $(PHONY),$?) $(filter-out $(PHONY) $(wildcard $^),$^)
 265
 266 # Execute command if command has changed or prerequisite(s) are updated.
 267 #
 268 if_changed = $(if $(strip $(any-prereq) $(arg-check)),                       \
 269         @set -e;                                                             \
 270         $(echo-cmd) $(cmd_$(1));                                             \
 271         printf '%s\n' 'cmd_$@ := $(make-cmd)' > $(dot-target).cmd, @:)
 272
 273 # Execute the command and also postprocess generated .d dependencies file.
 274 if_changed_dep = $(if $(strip $(any-prereq) $(arg-check) ),                  \
 275         @set -e;                                                             \
 276         $(cmd_and_fixdep), @:)
 277
 278 ifndef CONFIG_TRIM_UNUSED_KSYMS
 279
 280 cmd_and_fixdep =                                                             \
 281         $(echo-cmd) $(cmd_$(1));                                             \
 282         scripts/basic/fixdep $(depfile) $@ '$(make-cmd)' > $(dot-target).tmp;\
 283         rm -f $(depfile);                                                    \
 284         mv -f $(dot-target).tmp $(dot-target).cmd;
 285
 286 else
 287
 288 # Filter out exported kernel symbol names from the preprocessor output.
 289 # See also __KSYM_DEPS__ in include/linux/export.h.
 290 # We disable the depfile generation here, so as not to overwrite the existing
 291 # depfile while fixdep is parsing it.
 292 flags_nodeps = $(filter-out -Wp$(comma)-M%, $($(1)))
 293 ksym_dep_filter =                                                            \
 294         case "$(1)" in                                                       \
 295           cc_*_c|cpp_i_c)                                                    \
 296             $(CPP) $(call flags_nodeps,c_flags) -D__KSYM_DEPS__ $< ;;        \
 297           as_*_S|cpp_s_S)                                                    \
 298             $(CPP) $(call flags_nodeps,a_flags) -D__KSYM_DEPS__ $< ;;        \
 299           boot*|build*|*cpp_lds_S|dtc|host*|vdso*) : ;;                      \
 300           *) echo "Don't know how to preprocess $(1)" >&2; false ;;          \
 301         esac | tr ";" "\n" | sed -rn 's/^.*=== __KSYM_(.*) ===.*$$/KSYM_\1/p'
 302
 303 cmd_and_fixdep =                                                             \
 304         $(echo-cmd) $(cmd_$(1));                                             \
 305         $(ksym_dep_filter) |                                                 \
 306                 scripts/basic/fixdep -e $(depfile) $@ '$(make-cmd)'          \
 307                         > $(dot-target).tmp;                                 \
 308         rm -f $(depfile);                                                    \
 309         mv -f $(dot-target).tmp $(dot-target).cmd;
 310
 311 endif
 312
 313 # Usage: $(call if_changed_rule,foo)
 314 # Will check if $(cmd_foo) or any of the prerequisites changed,
 315 # and if so will execute $(rule_foo).
 316 if_changed_rule = $(if $(strip $(any-prereq) $(arg-check) ),                 \
 317         @set -e;                                                             \
 318         $(rule_$(1)), @:)
 319
 320 ###
 321 # why - tell why a a target got build
 322 #       enabled by make V=2
 323 #       Output (listed in the order they are checked):
 324 #          (1) - due to target is PHONY
 325 #          (2) - due to target missing
 326 #          (3) - due to: file1.h file2.h
 327 #          (4) - due to command line change
 328 #          (5) - due to missing .cmd file
 329 #          (6) - due to target not in $(targets)
 330 # (1) PHONY targets are always build
 331 # (2) No target, so we better build it
 332 # (3) Prerequisite is newer than target
 333 # (4) The command line stored in the file named dir/.target.cmd
 334 #     differed from actual command line. This happens when compiler
 335 #     options changes
 336 # (5) No dir/.target.cmd file (used to store command line)
 337 # (6) No dir/.target.cmd file and target not listed in $(targets)
 338 #     This is a good hint that there is a bug in the kbuild file
 339 ifeq ($(KBUILD_VERBOSE),2)
 340 why =                                                                        \
 341     $(if $(filter $@, $(PHONY)),- due to target is PHONY,                    \
 342         $(if $(wildcard $@),                                                 \
 343             $(if $(strip $(any-prereq)),- due to: $(any-prereq),             \
 344                 $(if $(arg-check),                                           \
 345                     $(if $(cmd_$@),- due to command line change,             \
 346                         $(if $(filter $@, $(targets)),                       \
 347                             - due to missing .cmd file,                      \
 348                             - due to $(notdir $@) not in $$(targets)         \
 349                          )                                                   \
 350                      )                                                       \
 351                  )                                                           \
 352              ),                                                              \
 353              - due to target missing                                         \
 354          )                                                                   \
 355      )
 356
 357 echo-why = $(call escsq, $(strip $(why)))
 358 endif
 359
 360 ###############################################################################
 361 #
 362 # When a Kconfig string contains a filename, it is suitable for
 363 # passing to shell commands. It is surrounded by double-quotes, and
 364 # any double-quotes or backslashes within it are escaped by
 365 # backslashes.
 366 #
 367 # This is no use for dependencies or $(wildcard). We need to strip the
 368 # surrounding quotes and the escaping from quotes and backslashes, and
 369 # we *do* need to escape any spaces in the string. So, for example:
 370 #
 371 # Usage: $(eval $(call config_filename,FOO))
 372 #
 373 # Defines FOO_FILENAME based on the contents of the CONFIG_FOO option,
 374 # transformed as described above to be suitable for use within the
 375 # makefile.
 376 #
 377 # Also, if the filename is a relative filename and exists in the source
 378 # tree but not the build tree, define FOO_SRCPREFIX as $(srctree)/ to
 379 # be prefixed to *both* command invocation and dependencies.
 380 #
 381 # Note: We also print the filenames in the quiet_cmd_foo text, and
 382 # perhaps ought to have a version specially escaped for that purpose.
 383 # But it's only cosmetic, and $(patsubst "%",%,$(CONFIG_FOO)) is good
 384 # enough.  It'll strip the quotes in the common case where there's no
 385 # space and it's a simple filename, and it'll retain the quotes when
 386 # there's a space. There are some esoteric cases in which it'll print
 387 # the wrong thing, but we don't really care. The actual dependencies
 388 # and commands *do* get it right, with various combinations of single
 389 # and double quotes, backslashes and spaces in the filenames.
 390 #
 391 ###############################################################################
 392 #
 393 define config_filename
 394 ifneq ($$(CONFIG_$(1)),"")
 395 $(1)_FILENAME := $$(subst \\,\,$$(subst \$$(quote),$$(quote),$$(subst $$(space_escape),\$$(space),$$(patsubst "%",%,$$(subst $$(space),$$(space_escape),$$(CONFIG_$(1)))))))
 396 ifneq ($$(patsubst /%,%,$$(firstword $$($(1)_FILENAME))),$$(firstword $$($(1)_FILENAME)))
 397 else
 398 ifeq ($$(wildcard $$($(1)_FILENAME)),)
 399 ifneq ($$(wildcard $$(srctree)/$$($(1)_FILENAME)),)
 400 $(1)_SRCPREFIX := $(srctree)/
 401 endif
 402 endif
 403 endif
 404 endif
 405 endef
 406 #
 407 ###############################################################################
 408
 409 # delete partially updated (i.e. corrupted) files on error
 410 .DELETE_ON_ERROR: