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