Commit | Line | Data |
---|---|---|
96ac6d43 | 1 | # SPDX-License-Identifier: GPL-2.0 |
8ec4b4ff SR |
2 | #### |
3 | # kbuild: Generic definitions | |
4 | ||
beda9f3a | 5 | # Convenient variables |
8ec4b4ff | 6 | comma := , |
13338935 | 7 | quote := " |
d51bfb78 | 8 | squote := ' |
8ec4b4ff SR |
9 | empty := |
10 | space := $(empty) $(empty) | |
9c8fa9bc | 11 | space_escape := _-_SPACE_-_ |
9564a8cf | 12 | pound := \# |
8ec4b4ff | 13 | |
48f1f058 SR |
14 | ### |
15 | # Name of target with a '.' as filename prefix. foo/bar.o => foo/.bar.o | |
16 | dot-target = $(dir $@).$(notdir $@) | |
17 | ||
8ec4b4ff | 18 | ### |
30a77297 | 19 | # The temporary file to save gcc -MMD generated dependencies must not |
8ec4b4ff | 20 | # contain a comma |
48f1f058 | 21 | depfile = $(subst $(comma),_,$(dot-target).d) |
8ec4b4ff | 22 | |
5e8d780d SR |
23 | ### |
24 | # filename of target with directory and extension stripped | |
25 | basetarget = $(basename $(notdir $@)) | |
26 | ||
afa974b7 MY |
27 | ### |
28 | # real prerequisites without phony targets | |
29 | real-prereqs = $(filter-out $(PHONY), $^) | |
30 | ||
d51bfb78 SR |
31 | ### |
32 | # Escape single quote for use in echo statements | |
33 | escsq = $(subst $(squote),'\$(squote)',$1) | |
34 | ||
7e826c44 MY |
35 | ### |
36 | # Quote a string to pass it to C files. foo => '"foo"' | |
37 | stringify = $(squote)$(quote)$1$(quote)$(squote) | |
38 | ||
5410ecc0 MF |
39 | ### |
40 | # Easy method for doing a status message | |
41 | kecho := : | |
42 | quiet_kecho := echo | |
43 | silent_kecho := : | |
44 | kecho := $($(quiet)kecho) | |
45 | ||
8ec4b4ff SR |
46 | ### |
47 | # filechk is used to check if the content of a generated file is updated. | |
48 | # Sample usage: | |
ba97df45 MY |
49 | # |
50 | # filechk_sample = echo $(KERNELRELEASE) | |
51 | # version.h: FORCE | |
8ec4b4ff | 52 | # $(call filechk,sample) |
ba97df45 | 53 | # |
8ec4b4ff SR |
54 | # The rule defined shall write to stdout the content of the new file. |
55 | # The existing file will be compared with the new one. | |
56 | # - If no file exist it is created | |
57 | # - If the content differ the new file is used | |
58 | # - If they are equal no change, and no timestamp update | |
8ec4b4ff | 59 | define filechk |
88fe89a4 MY |
60 | $(Q)set -e; \ |
61 | mkdir -p $(dir $@); \ | |
62 | trap "rm -f $(dot-target).tmp" EXIT; \ | |
63 | { $(filechk_$(1)); } > $(dot-target).tmp; \ | |
64 | if [ ! -r $@ ] || ! cmp -s $@ $(dot-target).tmp; then \ | |
65 | $(kecho) ' UPD $@'; \ | |
66 | mv -f $(dot-target).tmp $@; \ | |
8ec4b4ff SR |
67 | fi |
68 | endef | |
69 | ||
beda9f3a | 70 | ### |
8ec4b4ff SR |
71 | # Shorthand for $(Q)$(MAKE) -f scripts/Makefile.build obj= |
72 | # Usage: | |
73 | # $(Q)$(MAKE) $(build)=dir | |
5b2389b4 | 74 | build := -f $(srctree)/scripts/Makefile.build obj |
8ec4b4ff | 75 | |
9fb5e537 RR |
76 | ### |
77 | # Shorthand for $(Q)$(MAKE) -f scripts/Makefile.dtbinst obj= | |
78 | # Usage: | |
79 | # $(Q)$(MAKE) $(dtbinst)=dir | |
487c7c77 | 80 | dtbinst := -f $(srctree)/scripts/Makefile.dtbinst obj |
9fb5e537 | 81 | |
371fdc77 MY |
82 | ### |
83 | # Shorthand for $(Q)$(MAKE) -f scripts/Makefile.clean obj= | |
84 | # Usage: | |
85 | # $(Q)$(MAKE) $(clean)=dir | |
86 | clean := -f $(srctree)/scripts/Makefile.clean obj | |
87 | ||
5de043f4 OV |
88 | # echo command. |
89 | # Short version is used, if $(quiet) equals `quiet_', otherwise full one. | |
bff288c1 | 90 | echo-cmd = $(if $($(quiet)cmd_$(1)),\ |
5de043f4 OV |
91 | echo ' $(call escsq,$($(quiet)cmd_$(1)))$(echo-why)';) |
92 | ||
174a1dcc MY |
93 | # sink stdout for 'make -s' |
94 | redirect := | |
95 | quiet_redirect := | |
96 | silent_redirect := exec >/dev/null; | |
97 | ||
5de043f4 | 98 | # printing commands |
174a1dcc | 99 | cmd = @set -e; $(echo-cmd) $($(quiet)redirect) $(cmd_$(1)) |
8ec4b4ff SR |
100 | |
101 | ### | |
5de043f4 | 102 | # if_changed - execute command if any prerequisite is newer than |
8ec4b4ff SR |
103 | # target, or command line has changed |
104 | # if_changed_dep - as if_changed, but uses fixdep to reveal dependencies | |
105 | # including used config symbols | |
106 | # if_changed_rule - as if_changed but execute rule instead | |
cd238eff | 107 | # See Documentation/kbuild/makefiles.rst for more info |
8ec4b4ff SR |
108 | |
109 | ifneq ($(KBUILD_NOCMDDEP),1) | |
50bcca6a | 110 | # Check if both commands are the same including their order. Result is empty |
9c8fa9bc | 111 | # string if equal. User may override this check using make KBUILD_NOCMDDEP=1 |
50bcca6a | 112 | cmd-check = $(filter-out $(subst $(space),$(space_escape),$(strip $(cmd_$@))), \ |
9c8fa9bc | 113 | $(subst $(space),$(space_escape),$(strip $(cmd_$1)))) |
c4d5ee13 | 114 | else |
50bcca6a | 115 | cmd-check = $(if $(strip $(cmd_$@)),,1) |
8ec4b4ff SR |
116 | endif |
117 | ||
164f0d2e MM |
118 | # Replace >$< with >$$< to preserve $ when reloading the .cmd file |
119 | # (needed for make) | |
9564a8cf | 120 | # Replace >#< with >$(pound)< to avoid starting a comment in the .cmd file |
164f0d2e MM |
121 | # (needed for make) |
122 | # Replace >'< with >'\''< to be able to enclose the whole string in '...' | |
123 | # (needed for the shell) | |
9564a8cf | 124 | make-cmd = $(call escsq,$(subst $(pound),$$(pound),$(subst $$,$$$$,$(cmd_$(1))))) |
6176aa9a | 125 | |
2d3b1b8f MY |
126 | # Find any prerequisites that are newer than target or that do not exist. |
127 | # (This is not true for now; $? should contain any non-existent prerequisites, | |
128 | # but it does not work as expected when .SECONDARY is present. This seems a bug | |
129 | # of GNU Make.) | |
48f1f058 | 130 | # PHONY targets skipped in both cases. |
eba19032 | 131 | newer-prereqs = $(filter-out $(PHONY),$?) |
48f1f058 | 132 | |
5de043f4 | 133 | # Execute command if command has changed or prerequisite(s) are updated. |
eba19032 | 134 | if_changed = $(if $(newer-prereqs)$(cmd-check), \ |
67126965 | 135 | $(cmd); \ |
2aedcd09 | 136 | printf '%s\n' 'cmd_$@ := $(make-cmd)' > $(dot-target).cmd, @:) |
8ec4b4ff | 137 | |
5de043f4 | 138 | # Execute the command and also postprocess generated .d dependencies file. |
eba19032 | 139 | if_changed_dep = $(if $(newer-prereqs)$(cmd-check),$(cmd_and_fixdep),@:) |
c1a95fda | 140 | |
e4aca459 | 141 | cmd_and_fixdep = \ |
3a2429e1 | 142 | $(cmd); \ |
392885ee | 143 | scripts/basic/fixdep $(depfile) $@ '$(make-cmd)' > $(dot-target).cmd;\ |
e5d28910 | 144 | rm -f $(depfile) |
c1a95fda | 145 | |
8ec4b4ff | 146 | # Usage: $(call if_changed_rule,foo) |
beda9f3a RZ |
147 | # Will check if $(cmd_foo) or any of the prerequisites changed, |
148 | # and if so will execute $(rule_foo). | |
eba19032 | 149 | if_changed_rule = $(if $(newer-prereqs)$(cmd-check),$(rule_$(1)),@:) |
48f1f058 | 150 | |
45d506bd | 151 | ### |
312a3d09 | 152 | # why - tell why a target got built |
45d506bd SR |
153 | # enabled by make V=2 |
154 | # Output (listed in the order they are checked): | |
155 | # (1) - due to target is PHONY | |
156 | # (2) - due to target missing | |
157 | # (3) - due to: file1.h file2.h | |
158 | # (4) - due to command line change | |
159 | # (5) - due to missing .cmd file | |
160 | # (6) - due to target not in $(targets) | |
161 | # (1) PHONY targets are always build | |
162 | # (2) No target, so we better build it | |
163 | # (3) Prerequisite is newer than target | |
164 | # (4) The command line stored in the file named dir/.target.cmd | |
165 | # differed from actual command line. This happens when compiler | |
166 | # options changes | |
167 | # (5) No dir/.target.cmd file (used to store command line) | |
168 | # (6) No dir/.target.cmd file and target not listed in $(targets) | |
169 | # This is a good hint that there is a bug in the kbuild file | |
170 | ifeq ($(KBUILD_VERBOSE),2) | |
171 | why = \ | |
172 | $(if $(filter $@, $(PHONY)),- due to target is PHONY, \ | |
173 | $(if $(wildcard $@), \ | |
eba19032 | 174 | $(if $(newer-prereqs),- due to: $(newer-prereqs), \ |
50bcca6a | 175 | $(if $(cmd-check), \ |
45d506bd SR |
176 | $(if $(cmd_$@),- due to command line change, \ |
177 | $(if $(filter $@, $(targets)), \ | |
178 | - due to missing .cmd file, \ | |
179 | - due to $(notdir $@) not in $$(targets) \ | |
180 | ) \ | |
181 | ) \ | |
182 | ) \ | |
183 | ), \ | |
184 | - due to target missing \ | |
185 | ) \ | |
186 | ) | |
187 | ||
188 | echo-why = $(call escsq, $(strip $(why))) | |
189 | endif | |
3ee550f1 DW |
190 | |
191 | ############################################################################### | |
192 | # | |
193 | # When a Kconfig string contains a filename, it is suitable for | |
194 | # passing to shell commands. It is surrounded by double-quotes, and | |
195 | # any double-quotes or backslashes within it are escaped by | |
196 | # backslashes. | |
197 | # | |
198 | # This is no use for dependencies or $(wildcard). We need to strip the | |
199 | # surrounding quotes and the escaping from quotes and backslashes, and | |
200 | # we *do* need to escape any spaces in the string. So, for example: | |
201 | # | |
202 | # Usage: $(eval $(call config_filename,FOO)) | |
203 | # | |
204 | # Defines FOO_FILENAME based on the contents of the CONFIG_FOO option, | |
205 | # transformed as described above to be suitable for use within the | |
206 | # makefile. | |
207 | # | |
208 | # Also, if the filename is a relative filename and exists in the source | |
209 | # tree but not the build tree, define FOO_SRCPREFIX as $(srctree)/ to | |
210 | # be prefixed to *both* command invocation and dependencies. | |
211 | # | |
212 | # Note: We also print the filenames in the quiet_cmd_foo text, and | |
213 | # perhaps ought to have a version specially escaped for that purpose. | |
214 | # But it's only cosmetic, and $(patsubst "%",%,$(CONFIG_FOO)) is good | |
215 | # enough. It'll strip the quotes in the common case where there's no | |
216 | # space and it's a simple filename, and it'll retain the quotes when | |
217 | # there's a space. There are some esoteric cases in which it'll print | |
218 | # the wrong thing, but we don't really care. The actual dependencies | |
219 | # and commands *do* get it right, with various combinations of single | |
220 | # and double quotes, backslashes and spaces in the filenames. | |
221 | # | |
222 | ############################################################################### | |
223 | # | |
3ee550f1 DW |
224 | define config_filename |
225 | ifneq ($$(CONFIG_$(1)),"") | |
226 | $(1)_FILENAME := $$(subst \\,\,$$(subst \$$(quote),$$(quote),$$(subst $$(space_escape),\$$(space),$$(patsubst "%",%,$$(subst $$(space),$$(space_escape),$$(CONFIG_$(1))))))) | |
227 | ifneq ($$(patsubst /%,%,$$(firstword $$($(1)_FILENAME))),$$(firstword $$($(1)_FILENAME))) | |
228 | else | |
229 | ifeq ($$(wildcard $$($(1)_FILENAME)),) | |
230 | ifneq ($$(wildcard $$(srctree)/$$($(1)_FILENAME)),) | |
231 | $(1)_SRCPREFIX := $(srctree)/ | |
232 | endif | |
233 | endif | |
234 | endif | |
235 | endif | |
236 | endef | |
237 | # | |
238 | ############################################################################### | |
9c2af1c7 MY |
239 | |
240 | # delete partially updated (i.e. corrupted) files on error | |
241 | .DELETE_ON_ERROR: | |
8e9b61b2 MY |
242 | |
243 | # do not delete intermediate files automatically | |
244 | .SECONDARY: |