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