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 # real prerequisites without phony targets
  28 real-prereqs = $(filter-out $(PHONY), $^)
  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 #
  45 # filechk_sample = echo $(KERNELRELEASE)
  46 # version.h: FORCE
  47 #       $(call filechk,sample)
  48 #
  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         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>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, $(filter-out -%, $(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 # hostcc-option
 128 # Usage: cflags-y += $(call hostcc-option,-march=winchip-c6,-march=i586)
 129 hostcc-option = $(call __cc-option, $(HOSTCC),\
 130         $(KBUILD_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-ifversion
 143 # Usage:  EXTRA_CFLAGS += $(call cc-ifversion, -lt, 0402, -O1)
 144 cc-ifversion = $(shell [ $(CONFIG_GCC_VERSION)0 $(1) $(2)000 ] && echo $(3) || echo $(4))
 145
 146 # cc-ldoption
 147 # Usage: ldflags += $(call cc-ldoption, -Wl$(comma)--hash-style=both)
 148 cc-ldoption = $(call try-run,\
 149         $(CC) $(1) $(KBUILD_CPPFLAGS) $(CC_OPTION_CFLAGS) -nostdlib -x c /dev/null -o "$$TMP",$(1),$(2))
 150
 151 # ld-option
 152 # Usage: KBUILD_LDFLAGS += $(call ld-option, -X, -Y)
 153 ld-option = $(call try-run, $(LD) $(KBUILD_LDFLAGS) $(1) -v,$(1),$(2),$(3))
 154
 155 # ar-option
 156 # Usage: KBUILD_ARFLAGS := $(call ar-option,D)
 157 # Important: no spaces around options
 158 ar-option = $(call try-run, $(AR) rc$(1) "$$TMP",$(1),$(2))
 159
 160 # ld-version
 161 # Note this is mainly for HJ Lu's 3 number binutil versions
 162 ld-version = $(shell $(LD) --version | $(srctree)/scripts/ld-version.sh)
 163
 164 # ld-ifversion
 165 # Usage:  $(call ld-ifversion, -ge, 22252, y)
 166 ld-ifversion = $(shell [ $(ld-version) $(1) $(2) ] && echo $(3) || echo $(4))
 167
 168 ######
 169
 170 ###
 171 # Shorthand for $(Q)$(MAKE) -f scripts/Makefile.build obj=
 172 # Usage:
 173 # $(Q)$(MAKE) $(build)=dir
 174 build := -f $(srctree)/scripts/Makefile.build obj
 175
 176 ###
 177 # Shorthand for $(Q)$(MAKE) -f scripts/Makefile.modbuiltin obj=
 178 # Usage:
 179 # $(Q)$(MAKE) $(modbuiltin)=dir
 180 modbuiltin := -f $(srctree)/scripts/Makefile.modbuiltin obj
 181
 182 ###
 183 # Shorthand for $(Q)$(MAKE) -f scripts/Makefile.dtbinst obj=
 184 # Usage:
 185 # $(Q)$(MAKE) $(dtbinst)=dir
 186 dtbinst := -f $(srctree)/scripts/Makefile.dtbinst obj
 187
 188 ###
 189 # Shorthand for $(Q)$(MAKE) -f scripts/Makefile.clean obj=
 190 # Usage:
 191 # $(Q)$(MAKE) $(clean)=dir
 192 clean := -f $(srctree)/scripts/Makefile.clean obj
 193
 194 ###
 195 # Shorthand for $(Q)$(MAKE) -f scripts/Makefile.headersinst obj=
 196 # Usage:
 197 # $(Q)$(MAKE) $(hdr-inst)=dir
 198 hdr-inst := -f $(srctree)/scripts/Makefile.headersinst obj
 199
 200 # Prefix -I with $(srctree) if it is not an absolute path.
 201 # skip if -I has no parameter
 202 addtree = $(if $(patsubst -I%,%,$(1)), \
 203 $(if $(filter-out -I/% -I./% -I../%,$(1)),$(patsubst -I%,-I$(srctree)/%,$(1)),$(1)),$(1))
 204
 205 # Find all -I options and call addtree
 206 flags = $(foreach o,$($(1)),$(if $(filter -I%,$(o)),$(call addtree,$(o)),$(o)))
 207
 208 # echo command.
 209 # Short version is used, if $(quiet) equals `quiet_', otherwise full one.
 210 echo-cmd = $(if $($(quiet)cmd_$(1)),\
 211         echo '  $(call escsq,$($(quiet)cmd_$(1)))$(echo-why)';)
 212
 213 # printing commands
 214 cmd = @set -e; $(echo-cmd) $(cmd_$(1))
 215
 216 # Add $(obj)/ for paths that are not absolute
 217 objectify = $(foreach o,$(1),$(if $(filter /%,$(o)),$(o),$(obj)/$(o)))
 218
 219 ###
 220 # if_changed      - execute command if any prerequisite is newer than
 221 #                   target, or command line has changed
 222 # if_changed_dep  - as if_changed, but uses fixdep to reveal dependencies
 223 #                   including used config symbols
 224 # if_changed_rule - as if_changed but execute rule instead
 225 # See Documentation/kbuild/makefiles.txt for more info
 226
 227 ifneq ($(KBUILD_NOCMDDEP),1)
 228 # Check if both arguments are the same including their order. Result is empty
 229 # string if equal. User may override this check using make KBUILD_NOCMDDEP=1
 230 arg-check = $(filter-out $(subst $(space),$(space_escape),$(strip $(cmd_$@))), \
 231                          $(subst $(space),$(space_escape),$(strip $(cmd_$1))))
 232 else
 233 arg-check = $(if $(strip $(cmd_$@)),,1)
 234 endif
 235
 236 # Replace >$< with >$$< to preserve $ when reloading the .cmd file
 237 # (needed for make)
 238 # Replace >#< with >$(pound)< to avoid starting a comment in the .cmd file
 239 # (needed for make)
 240 # Replace >'< with >'\''< to be able to enclose the whole string in '...'
 241 # (needed for the shell)
 242 make-cmd = $(call escsq,$(subst $(pound),$$(pound),$(subst $$,$$$$,$(cmd_$(1)))))
 243
 244 # Find any prerequisites that is newer than target or that does not exist.
 245 # PHONY targets skipped in both cases.
 246 any-prereq = $(filter-out $(PHONY),$?) $(filter-out $(PHONY) $(wildcard $^),$^)
 247
 248 # Execute command if command has changed or prerequisite(s) are updated.
 249 if_changed = $(if $(strip $(any-prereq) $(arg-check)),                       \
 250         $(cmd);                                                              \
 251         printf '%s\n' 'cmd_$@ := $(make-cmd)' > $(dot-target).cmd, @:)
 252
 253 # Execute the command and also postprocess generated .d dependencies file.
 254 if_changed_dep = $(if $(strip $(any-prereq) $(arg-check)),$(cmd_and_fixdep),@:)
 255
 256 cmd_and_fixdep =                                                             \
 257         $(cmd);                                                              \
 258         scripts/basic/fixdep $(depfile) $@ '$(make-cmd)' > $(dot-target).cmd;\
 259         rm -f $(depfile)
 260
 261 # Usage: $(call if_changed_rule,foo)
 262 # Will check if $(cmd_foo) or any of the prerequisites changed,
 263 # and if so will execute $(rule_foo).
 264 if_changed_rule = $(if $(strip $(any-prereq) $(arg-check)),$(rule_$(1)),@:)
 265
 266 ###
 267 # why - tell why a target got built
 268 #       enabled by make V=2
 269 #       Output (listed in the order they are checked):
 270 #          (1) - due to target is PHONY
 271 #          (2) - due to target missing
 272 #          (3) - due to: file1.h file2.h
 273 #          (4) - due to command line change
 274 #          (5) - due to missing .cmd file
 275 #          (6) - due to target not in $(targets)
 276 # (1) PHONY targets are always build
 277 # (2) No target, so we better build it
 278 # (3) Prerequisite is newer than target
 279 # (4) The command line stored in the file named dir/.target.cmd
 280 #     differed from actual command line. This happens when compiler
 281 #     options changes
 282 # (5) No dir/.target.cmd file (used to store command line)
 283 # (6) No dir/.target.cmd file and target not listed in $(targets)
 284 #     This is a good hint that there is a bug in the kbuild file
 285 ifeq ($(KBUILD_VERBOSE),2)
 286 why =                                                                        \
 287     $(if $(filter $@, $(PHONY)),- due to target is PHONY,                    \
 288         $(if $(wildcard $@),                                                 \
 289             $(if $(strip $(any-prereq)),- due to: $(any-prereq),             \
 290                 $(if $(arg-check),                                           \
 291                     $(if $(cmd_$@),- due to command line change,             \
 292                         $(if $(filter $@, $(targets)),                       \
 293                             - due to missing .cmd file,                      \
 294                             - due to $(notdir $@) not in $$(targets)         \
 295                          )                                                   \
 296                      )                                                       \
 297                  )                                                           \
 298              ),                                                              \
 299              - due to target missing                                         \
 300          )                                                                   \
 301      )
 302
 303 echo-why = $(call escsq, $(strip $(why)))
 304 endif
 305
 306 ###############################################################################
 307 #
 308 # When a Kconfig string contains a filename, it is suitable for
 309 # passing to shell commands. It is surrounded by double-quotes, and
 310 # any double-quotes or backslashes within it are escaped by
 311 # backslashes.
 312 #
 313 # This is no use for dependencies or $(wildcard). We need to strip the
 314 # surrounding quotes and the escaping from quotes and backslashes, and
 315 # we *do* need to escape any spaces in the string. So, for example:
 316 #
 317 # Usage: $(eval $(call config_filename,FOO))
 318 #
 319 # Defines FOO_FILENAME based on the contents of the CONFIG_FOO option,
 320 # transformed as described above to be suitable for use within the
 321 # makefile.
 322 #
 323 # Also, if the filename is a relative filename and exists in the source
 324 # tree but not the build tree, define FOO_SRCPREFIX as $(srctree)/ to
 325 # be prefixed to *both* command invocation and dependencies.
 326 #
 327 # Note: We also print the filenames in the quiet_cmd_foo text, and
 328 # perhaps ought to have a version specially escaped for that purpose.
 329 # But it's only cosmetic, and $(patsubst "%",%,$(CONFIG_FOO)) is good
 330 # enough.  It'll strip the quotes in the common case where there's no
 331 # space and it's a simple filename, and it'll retain the quotes when
 332 # there's a space. There are some esoteric cases in which it'll print
 333 # the wrong thing, but we don't really care. The actual dependencies
 334 # and commands *do* get it right, with various combinations of single
 335 # and double quotes, backslashes and spaces in the filenames.
 336 #
 337 ###############################################################################
 338 #
 339 define config_filename
 340 ifneq ($$(CONFIG_$(1)),"")
 341 $(1)_FILENAME := $$(subst \\,\,$$(subst \$$(quote),$$(quote),$$(subst $$(space_escape),\$$(space),$$(patsubst "%",%,$$(subst $$(space),$$(space_escape),$$(CONFIG_$(1)))))))
 342 ifneq ($$(patsubst /%,%,$$(firstword $$($(1)_FILENAME))),$$(firstword $$($(1)_FILENAME)))
 343 else
 344 ifeq ($$(wildcard $$($(1)_FILENAME)),)
 345 ifneq ($$(wildcard $$(srctree)/$$($(1)_FILENAME)),)
 346 $(1)_SRCPREFIX := $(srctree)/
 347 endif
 348 endif
 349 endif
 350 endif
 351 endef
 352 #
 353 ###############################################################################
 354
 355 # delete partially updated (i.e. corrupted) files on error
 356 .DELETE_ON_ERROR:
 357
 358 # do not delete intermediate files automatically
 359 .SECONDARY: