1 # SPDX-License-Identifier: GPL-2.0 1 # SPDX-License-Identifier: GPL-2.0
2 #### 2 ####
3 # kbuild: Generic definitions 3 # kbuild: Generic definitions
4 4
5 # Convenient variables 5 # Convenient variables
6 comma := , 6 comma := ,
7 quote := " 7 quote := "
8 squote := ' 8 squote := '
9 empty := 9 empty :=
10 space := $(empty) $(empty) 10 space := $(empty) $(empty)
11 space_escape := _-_SPACE_-_ 11 space_escape := _-_SPACE_-_
12 pound := \# 12 pound := \#
13 define newline <<
14 <<
15 <<
16 endef <<
17 <<
18 ### <<
19 # Comparison macros. <<
20 # Usage: $(call test-lt, $(CONFIG_LLD_VERSION) <<
21 # <<
22 # Use $(intcmp ...) if supported. (Make >= 4.4 <<
23 # Otherwise, fall back to the 'test' shell com <<
24 ifeq ($(intcmp 1,0,,,y),y) <<
25 test-ge = $(intcmp $(strip $1)0, $(strip $2)0, <<
26 test-gt = $(intcmp $(strip $1)0, $(strip $2)0, <<
27 else <<
28 test-ge = $(shell test $(strip $1)0 -ge $(stri <<
29 test-gt = $(shell test $(strip $1)0 -gt $(stri <<
30 endif <<
31 test-le = $(call test-ge, $2, $1) <<
32 test-lt = $(call test-gt, $2, $1) <<
33 13
34 ### 14 ###
35 # Name of target with a '.' as filename prefix 15 # Name of target with a '.' as filename prefix. foo/bar.o => foo/.bar.o
36 dot-target = $(dir $@).$(notdir $@) 16 dot-target = $(dir $@).$(notdir $@)
37 17
38 ### 18 ###
39 # Name of target with a '.tmp_' as filename pr <<
40 tmp-target = $(dir $@).tmp_$(notdir $@) <<
41 <<
42 ### <<
43 # The temporary file to save gcc -MMD generate 19 # The temporary file to save gcc -MMD generated dependencies must not
44 # contain a comma 20 # contain a comma
45 depfile = $(subst $(comma),_,$(dot-target).d) 21 depfile = $(subst $(comma),_,$(dot-target).d)
46 22
47 ### 23 ###
48 # filename of target with directory and extens 24 # filename of target with directory and extension stripped
49 basetarget = $(basename $(notdir $@)) 25 basetarget = $(basename $(notdir $@))
50 26
51 ### 27 ###
52 # real prerequisites without phony targets 28 # real prerequisites without phony targets
53 real-prereqs = $(filter-out $(PHONY), $^) 29 real-prereqs = $(filter-out $(PHONY), $^)
54 30
55 ### 31 ###
56 # Escape single quote for use in echo statemen 32 # Escape single quote for use in echo statements
57 escsq = $(subst $(squote),'\$(squote)',$1) 33 escsq = $(subst $(squote),'\$(squote)',$1)
58 34
59 ### 35 ###
60 # Quote a string to pass it to C files. foo => 36 # Quote a string to pass it to C files. foo => '"foo"'
61 stringify = $(squote)$(quote)$1$(quote)$(squot 37 stringify = $(squote)$(quote)$1$(quote)$(squote)
62 38
63 ### 39 ###
64 # The path to Kbuild or Makefile. Kbuild has p <<
65 kbuild-file = $(or $(wildcard $(src)/Kbuild),$ <<
66 <<
67 ### <<
68 # Read a file, replacing newlines with spaces <<
69 # <<
70 # Make 4.2 or later can read a file by using i <<
71 ifneq ($(filter-out 4.0 4.1, $(MAKE_VERSION)), <<
72 read-file = $(subst $(newline),$(space),$(file <<
73 else <<
74 read-file = $(shell cat $1 2>/dev/null) <<
75 endif <<
76 <<
77 ### <<
78 # Easy method for doing a status message 40 # Easy method for doing a status message
79 kecho := : 41 kecho := :
80 quiet_kecho := echo 42 quiet_kecho := echo
81 silent_kecho := : 43 silent_kecho := :
82 kecho := $($(quiet)kecho) 44 kecho := $($(quiet)kecho)
83 45
84 ### 46 ###
85 # filechk is used to check if the content of a 47 # filechk is used to check if the content of a generated file is updated.
86 # Sample usage: 48 # Sample usage:
87 # 49 #
88 # filechk_sample = echo $(KERNELRELEASE) 50 # filechk_sample = echo $(KERNELRELEASE)
89 # version.h: FORCE 51 # version.h: FORCE
90 # $(call filechk,sample) 52 # $(call filechk,sample)
91 # 53 #
92 # The rule defined shall write to stdout the c 54 # The rule defined shall write to stdout the content of the new file.
93 # The existing file will be compared with the 55 # The existing file will be compared with the new one.
94 # - If no file exist it is created 56 # - If no file exist it is created
95 # - If the content differ the new file is used 57 # - If the content differ the new file is used
96 # - If they are equal no change, and no timest 58 # - If they are equal no change, and no timestamp update
97 define filechk 59 define filechk
98 $(check-FORCE) 60 $(check-FORCE)
99 $(Q)set -e; 61 $(Q)set -e; \
100 mkdir -p $(dir $@); 62 mkdir -p $(dir $@); \
101 trap "rm -f $(tmp-target)" EXIT; !! 63 trap "rm -f $(dot-target).tmp" EXIT; \
102 { $(filechk_$(1)); } > $(tmp-target); !! 64 { $(filechk_$(1)); } > $(dot-target).tmp; \
103 if [ ! -r $@ ] || ! cmp -s $@ $(tmp-ta !! 65 if [ ! -r $@ ] || ! cmp -s $@ $(dot-target).tmp; then \
104 $(kecho) ' UPD $@'; 66 $(kecho) ' UPD $@'; \
105 mv -f $(tmp-target) $@; !! 67 mv -f $(dot-target).tmp $@; \
106 fi 68 fi
107 endef 69 endef
108 70
109 ### 71 ###
110 # Shorthand for $(Q)$(MAKE) -f scripts/Makefil 72 # Shorthand for $(Q)$(MAKE) -f scripts/Makefile.build obj=
111 # Usage: 73 # Usage:
112 # $(Q)$(MAKE) $(build)=dir 74 # $(Q)$(MAKE) $(build)=dir
113 build := -f $(srctree)/scripts/Makefile.build 75 build := -f $(srctree)/scripts/Makefile.build obj
114 76
115 ### 77 ###
>> 78 # Shorthand for $(Q)$(MAKE) -f scripts/Makefile.dtbinst obj=
>> 79 # Usage:
>> 80 # $(Q)$(MAKE) $(dtbinst)=dir
>> 81 dtbinst := -f $(srctree)/scripts/Makefile.dtbinst obj
>> 82
>> 83 ###
116 # Shorthand for $(Q)$(MAKE) -f scripts/Makefil 84 # Shorthand for $(Q)$(MAKE) -f scripts/Makefile.clean obj=
117 # Usage: 85 # Usage:
118 # $(Q)$(MAKE) $(clean)=dir 86 # $(Q)$(MAKE) $(clean)=dir
119 clean := -f $(srctree)/scripts/Makefile.clean 87 clean := -f $(srctree)/scripts/Makefile.clean obj
120 88
121 # pring log !! 89 # echo command.
122 # !! 90 # Short version is used, if $(quiet) equals `quiet_', otherwise full one.
123 # If quiet is "silent_", print nothing and sin !! 91 echo-cmd = $(if $($(quiet)cmd_$(1)),\
124 # If quiet is "quiet_", print short log !! 92 echo ' $(call escsq,$($(quiet)cmd_$(1)))$(echo-why)';)
125 # If quiet is empty, print short log and whole !! 93
126 silent_log_print = exec >/dev/null; !! 94 # sink stdout for 'make -s'
127 quiet_log_print = $(if $(quiet_cmd_$1), echo !! 95 redirect :=
128 log_print = echo '$(pound) $(call escsq !! 96 quiet_redirect :=
129 echo ' $(call escsq,$(cmd_ !! 97 silent_redirect := exec >/dev/null;
130 98
131 # Delete the target on interruption 99 # Delete the target on interruption
132 # 100 #
133 # GNU Make automatically deletes the target if 101 # GNU Make automatically deletes the target if it has already been changed by
134 # the interrupted recipe. So, you can safely s 102 # the interrupted recipe. So, you can safely stop the build by Ctrl-C (Make
135 # will delete incomplete targets), and resume 103 # will delete incomplete targets), and resume it later.
136 # 104 #
137 # However, this does not work when the stderr 105 # However, this does not work when the stderr is piped to another program, like
138 # $ make >&2 | tee log 106 # $ make >&2 | tee log
139 # Make dies with SIGPIPE before cleaning the t 107 # Make dies with SIGPIPE before cleaning the targets.
140 # 108 #
141 # To address it, we clean the target in signal 109 # To address it, we clean the target in signal traps.
142 # 110 #
143 # Make deletes the target when it catches SIGH 111 # Make deletes the target when it catches SIGHUP, SIGINT, SIGQUIT, SIGTERM.
144 # So, we cover them, and also SIGPIPE just in 112 # So, we cover them, and also SIGPIPE just in case.
145 # 113 #
146 # Of course, this is unneeded for phony target 114 # Of course, this is unneeded for phony targets.
147 delete-on-interrupt = \ 115 delete-on-interrupt = \
148 $(if $(filter-out $(PHONY), $@), \ 116 $(if $(filter-out $(PHONY), $@), \
149 $(foreach sig, HUP INT QUIT TE 117 $(foreach sig, HUP INT QUIT TERM PIPE, \
150 trap 'rm -f $@; trap - 118 trap 'rm -f $@; trap - $(sig); kill -s $(sig) $$$$' $(sig);))
151 119
152 # print and execute commands !! 120 # printing commands
153 cmd = @$(if $(cmd_$(1)),set -e; $($(quiet)log_ !! 121 cmd = @set -e; $(echo-cmd) $($(quiet)redirect) $(delete-on-interrupt) $(cmd_$(1))
154 122
155 ### 123 ###
156 # if_changed - execute command if any pre 124 # if_changed - execute command if any prerequisite is newer than
157 # target, or command line ha 125 # target, or command line has changed
158 # if_changed_dep - as if_changed, but uses fi 126 # if_changed_dep - as if_changed, but uses fixdep to reveal dependencies
159 # including used config symb 127 # including used config symbols
160 # if_changed_rule - as if_changed but execute 128 # if_changed_rule - as if_changed but execute rule instead
161 # See Documentation/kbuild/makefiles.rst for m 129 # See Documentation/kbuild/makefiles.rst for more info
162 130
163 ifneq ($(KBUILD_NOCMDDEP),1) 131 ifneq ($(KBUILD_NOCMDDEP),1)
164 # Check if both commands are the same includin 132 # Check if both commands are the same including their order. Result is empty
165 # string if equal. User may override this chec 133 # string if equal. User may override this check using make KBUILD_NOCMDDEP=1
166 # If the target does not exist, the *.cmd file !! 134 cmd-check = $(filter-out $(subst $(space),$(space_escape),$(strip $(cmd_$@))), \
167 # $(savedcmd_$@) gets empty. Then, target will <<
168 # happens to become empty. <<
169 cmd-check = $(filter-out $(subst $(space),$(sp <<
170 $(subst $(space),$(sp 135 $(subst $(space),$(space_escape),$(strip $(cmd_$1))))
171 else 136 else
172 # We still need to detect missing targets. !! 137 cmd-check = $(if $(strip $(cmd_$@)),,1)
173 cmd-check = $(if $(strip $(savedcmd_$@)),,1) <<
174 endif 138 endif
175 139
176 # Replace >$< with >$$< to preserve $ when rel 140 # Replace >$< with >$$< to preserve $ when reloading the .cmd file
177 # (needed for make) 141 # (needed for make)
178 # Replace >#< with >$(pound)< to avoid startin 142 # Replace >#< with >$(pound)< to avoid starting a comment in the .cmd file
179 # (needed for make) 143 # (needed for make)
180 # Replace >'< with >'\''< to be able to enclos 144 # Replace >'< with >'\''< to be able to enclose the whole string in '...'
181 # (needed for the shell) 145 # (needed for the shell)
182 make-cmd = $(call escsq,$(subst $(pound),$$(po 146 make-cmd = $(call escsq,$(subst $(pound),$$(pound),$(subst $$,$$$$,$(cmd_$(1)))))
183 147
184 # Find any prerequisites that are newer than t 148 # Find any prerequisites that are newer than target or that do not exist.
>> 149 # (This is not true for now; $? should contain any non-existent prerequisites,
>> 150 # but it does not work as expected when .SECONDARY is present. This seems a bug
>> 151 # of GNU Make.)
185 # PHONY targets skipped in both cases. 152 # PHONY targets skipped in both cases.
186 # If there is no prerequisite other than phony <<
187 # empty even if the target does not exist. cmd <<
188 newer-prereqs = $(filter-out $(PHONY),$?) 153 newer-prereqs = $(filter-out $(PHONY),$?)
189 154
190 # It is a typical mistake to forget the FORCE 155 # It is a typical mistake to forget the FORCE prerequisite. Check it here so
191 # no more breakage will slip in. 156 # no more breakage will slip in.
192 check-FORCE = $(if $(filter FORCE, $^),,$(warn 157 check-FORCE = $(if $(filter FORCE, $^),,$(warning FORCE prerequisite is missing))
193 158
194 if-changed-cond = $(newer-prereqs)$(cmd-check) 159 if-changed-cond = $(newer-prereqs)$(cmd-check)$(check-FORCE)
195 160
196 # Execute command if command has changed or pr 161 # Execute command if command has changed or prerequisite(s) are updated.
197 if_changed = $(if $(if-changed-cond),$(cmd_and !! 162 if_changed = $(if $(if-changed-cond), \
198 <<
199 cmd_and_savecmd = <<
200 $(cmd); 163 $(cmd); \
201 printf '%s\n' 'savedcmd_$@ := $(make-c !! 164 printf '%s\n' 'cmd_$@ := $(make-cmd)' > $(dot-target).cmd, @:)
202 165
203 # Execute the command and also postprocess gen 166 # Execute the command and also postprocess generated .d dependencies file.
204 if_changed_dep = $(if $(if-changed-cond),$(cmd 167 if_changed_dep = $(if $(if-changed-cond),$(cmd_and_fixdep),@:)
205 168
206 cmd_and_fixdep = 169 cmd_and_fixdep = \
207 $(cmd); 170 $(cmd); \
208 scripts/basic/fixdep $(depfile) $@ '$( 171 scripts/basic/fixdep $(depfile) $@ '$(make-cmd)' > $(dot-target).cmd;\
209 rm -f $(depfile) 172 rm -f $(depfile)
210 173
211 # Usage: $(call if_changed_rule,foo) 174 # Usage: $(call if_changed_rule,foo)
212 # Will check if $(cmd_foo) or any of the prere 175 # Will check if $(cmd_foo) or any of the prerequisites changed,
213 # and if so will execute $(rule_foo). 176 # and if so will execute $(rule_foo).
214 if_changed_rule = $(if $(if-changed-cond),$(ru 177 if_changed_rule = $(if $(if-changed-cond),$(rule_$(1)),@:)
215 178
216 ### 179 ###
217 # why - tell why a target got built 180 # why - tell why a target got built
218 # enabled by make V=2 181 # enabled by make V=2
219 # Output (listed in the order they are c 182 # Output (listed in the order they are checked):
220 # (1) - due to target is PHONY 183 # (1) - due to target is PHONY
221 # (2) - due to target missing 184 # (2) - due to target missing
222 # (3) - due to: file1.h file2.h 185 # (3) - due to: file1.h file2.h
223 # (4) - due to command line change 186 # (4) - due to command line change
224 # (5) - due to missing .cmd file 187 # (5) - due to missing .cmd file
225 # (6) - due to target not in $(target 188 # (6) - due to target not in $(targets)
226 # (1) PHONY targets are always build 189 # (1) PHONY targets are always build
227 # (2) No target, so we better build it 190 # (2) No target, so we better build it
228 # (3) Prerequisite is newer than target 191 # (3) Prerequisite is newer than target
229 # (4) The command line stored in the file name 192 # (4) The command line stored in the file named dir/.target.cmd
230 # differed from actual command line. This 193 # differed from actual command line. This happens when compiler
231 # options changes 194 # options changes
232 # (5) No dir/.target.cmd file (used to store c 195 # (5) No dir/.target.cmd file (used to store command line)
233 # (6) No dir/.target.cmd file and target not l 196 # (6) No dir/.target.cmd file and target not listed in $(targets)
234 # This is a good hint that there is a bug 197 # This is a good hint that there is a bug in the kbuild file
235 ifneq ($(findstring 2, $(KBUILD_VERBOSE)),) !! 198 ifeq ($(KBUILD_VERBOSE),2)
236 _why = !! 199 why = \
237 $(if $(filter $@, $(PHONY)),- due to targe 200 $(if $(filter $@, $(PHONY)),- due to target is PHONY, \
238 $(if $(wildcard $@), 201 $(if $(wildcard $@), \
239 $(if $(newer-prereqs),- due to: $( 202 $(if $(newer-prereqs),- due to: $(newer-prereqs), \
240 $(if $(cmd-check), 203 $(if $(cmd-check), \
241 $(if $(savedcmd_$@),- due !! 204 $(if $(cmd_$@),- due to command line change, \
242 $(if $(filter $@, $(ta 205 $(if $(filter $@, $(targets)), \
243 - due to missing . 206 - due to missing .cmd file, \
244 - due to $(notdir 207 - due to $(notdir $@) not in $$(targets) \
245 ) 208 ) \
246 ) 209 ) \
247 ) 210 ) \
248 ), 211 ), \
249 - due to target missing 212 - due to target missing \
250 ) 213 ) \
251 ) 214 )
252 215
253 why = $(space)$(strip $(_why)) !! 216 echo-why = $(call escsq, $(strip $(why)))
254 endif 217 endif
255 218
256 ############################################## 219 ###############################################################################
>> 220 #
>> 221 # When a Kconfig string contains a filename, it is suitable for
>> 222 # passing to shell commands. It is surrounded by double-quotes, and
>> 223 # any double-quotes or backslashes within it are escaped by
>> 224 # backslashes.
>> 225 #
>> 226 # This is no use for dependencies or $(wildcard). We need to strip the
>> 227 # surrounding quotes and the escaping from quotes and backslashes, and
>> 228 # we *do* need to escape any spaces in the string. So, for example:
>> 229 #
>> 230 # Usage: $(eval $(call config_filename,FOO))
>> 231 #
>> 232 # Defines FOO_FILENAME based on the contents of the CONFIG_FOO option,
>> 233 # transformed as described above to be suitable for use within the
>> 234 # makefile.
>> 235 #
>> 236 # Also, if the filename is a relative filename and exists in the source
>> 237 # tree but not the build tree, define FOO_SRCPREFIX as $(srctree)/ to
>> 238 # be prefixed to *both* command invocation and dependencies.
>> 239 #
>> 240 # Note: We also print the filenames in the quiet_cmd_foo text, and
>> 241 # perhaps ought to have a version specially escaped for that purpose.
>> 242 # But it's only cosmetic, and $(patsubst "%",%,$(CONFIG_FOO)) is good
>> 243 # enough. It'll strip the quotes in the common case where there's no
>> 244 # space and it's a simple filename, and it'll retain the quotes when
>> 245 # there's a space. There are some esoteric cases in which it'll print
>> 246 # the wrong thing, but we don't really care. The actual dependencies
>> 247 # and commands *do* get it right, with various combinations of single
>> 248 # and double quotes, backslashes and spaces in the filenames.
>> 249 #
>> 250 ###############################################################################
>> 251 #
>> 252 define config_filename
>> 253 ifneq ($$(CONFIG_$(1)),"")
>> 254 $(1)_FILENAME := $$(subst \\,\,$$(subst \$$(quote),$$(quote),$$(subst $$(space_escape),\$$(space),$$(patsubst "%",%,$$(subst $$(space),$$(space_escape),$$(CONFIG_$(1)))))))
>> 255 ifneq ($$(patsubst /%,%,$$(firstword $$($(1)_FILENAME))),$$(firstword $$($(1)_FILENAME)))
>> 256 else
>> 257 ifeq ($$(wildcard $$($(1)_FILENAME)),)
>> 258 ifneq ($$(wildcard $$(srctree)/$$($(1)_FILENAME)),)
>> 259 $(1)_SRCPREFIX := $(srctree)/
>> 260 endif
>> 261 endif
>> 262 endif
>> 263 endif
>> 264 endef
>> 265 #
>> 266 ###############################################################################
257 267
258 # delete partially updated (i.e. corrupted) fi 268 # delete partially updated (i.e. corrupted) files on error
259 .DELETE_ON_ERROR: 269 .DELETE_ON_ERROR:
260 270
261 # do not delete intermediate files automatical 271 # do not delete intermediate files automatically
262 # <<
263 # .NOTINTERMEDIATE is more correct, but only a <<
264 # Make 4.4 introduced .NOTINTERMEDIATE, and it <<
265 # global .NOTINTERMEDIATE does not work. We ca <<
266 # Use .SECONDARY for older Make versions, but <<
267 # deleted files. <<
268 ifneq ($(and $(filter notintermediate, $(.FEAT <<
269 .NOTINTERMEDIATE: <<
270 else <<
271 .SECONDARY: 272 .SECONDARY:
272 endif <<
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.