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