scripts/Kbuild.include

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