meson: sphinx-build
[qemu.git] / rules.mak
1
2 # These are used when we want to do substitutions without confusing Make
3 NULL :=
4 SPACE := $(NULL) #
5 COMMA := ,
6
7 # Don't use implicit rules or variables
8 # we have explicit rules for everything
9 MAKEFLAGS += -rR
10
11 # Files with this suffixes are final, don't try to generate them
12 # using implicit rules
13 %/trace-events:
14 %.hx:
15 %.py:
16 %.objs:
17 %.d:
18 %.h:
19 %.c:
20 %.cc:
21 %.cpp:
22 %.m:
23 %.mak:
24
25 # Flags for dependency generation
26 QEMU_DGFLAGS += -MMD -MP -MT $@ -MF $(@D)/$(*F).d
27
28 # Compiler searches the source file dir first, but in vpath builds
29 # we need to make it search the build dir too, before any other
30 # explicit search paths. There are two search locations in the build
31 # dir, one absolute and the other relative to the compiler working
32 # directory. These are the same for target-independent files, but
33 # different for target-dependent ones.
34 QEMU_LOCAL_INCLUDES = -iquote $(BUILD_DIR) -iquote $(BUILD_DIR)/$(@D) -iquote $(@D)
35
36 WL_U := -Wl,-u,
37 find-symbols = $(if $1, $(sort $(shell $(NM) -P -g $1 | $2)))
38 defined-symbols = $(call find-symbols,$1,awk '$$2!="U"{print $$1}')
39 undefined-symbols = $(call find-symbols,$1,awk '$$2=="U"{print $$1}')
40
41 WL := -Wl,
42 ifdef CONFIG_DARWIN
43 whole-archive = $(WL)-force_load,$1
44 else
45 whole-archive = $(WL)--whole-archive $1 $(WL)--no-whole-archive
46 endif
47
48 # All the .mo objects in -m variables are also added into corresponding -y
49 # variable in unnest-vars, but filtered out here, when LINK is called.
50 #
51 # The .mo objects are supposed to be linked as a DSO, for module build. So here
52 # they are only used as a placeholders to generate those "archive undefined"
53 # symbol options (-Wl,-u,$symbol_name), which are the archive functions
54 # referenced by the code in the DSO.
55 #
56 # Also the presence in -y variables will also guarantee they are built before
57 # linking executables that will load them. So we can look up symbol reference
58 # in LINK.
59 #
60 # This is necessary because the exectuable itself may not use the function, in
61 # which case the function would not be linked in. Then the DSO loading will
62 # fail because of the missing symbol.
63 process-archive-undefs = $(filter-out %.a %.fa %.mo %$(DSOSUF),$1) \
64 $(addprefix $(WL_U), \
65 $(filter $(call defined-symbols,$(filter %.a %.fa, $1)), \
66 $(call undefined-symbols,$(filter %.mo %$(DSOSUF),$1)))) \
67 $(foreach l,$(filter %.fa,$1),$(call whole-archive,$l)) \
68 $(filter %.a,$1)
69
70 extract-libs = $(strip $(foreach o,$(filter-out %.mo %$(DSOSUF),$1),$($o-libs)))
71 expand-objs = $(strip $(sort $(filter %.o,$1)) \
72 $(foreach o,$(filter %.mo %$(DSOSUF),$1),$($o-objs)) \
73 $(filter-out %.o %.mo %$(DSOSUF),$1))
74
75 %.o: %.c
76 @mkdir -p $(dir $@)
77 $(call quiet-command,$(CC) $(QEMU_LOCAL_INCLUDES) $(QEMU_INCLUDES) \
78 $(QEMU_CFLAGS) $(QEMU_DGFLAGS) $(CFLAGS) $($@-cflags) \
79 -c -o $@ $<,"CC","$(TARGET_DIR)$@")
80
81 # If we have a CXX we might have some C++ objects, in which case we
82 # must link with the C++ compiler, not the plain C compiler.
83 LINKPROG = $(or $(CXX),$(CC))
84
85 LINK = $(call quiet-command, $(LINKPROG) $(CFLAGS) $(QEMU_LDFLAGS) -o $@ \
86 $(call process-archive-undefs, $1) \
87 $(call extract-libs,$1) $(LIBS),"LINK","$(TARGET_DIR)$@")
88
89 %.o: %.S
90 $(call quiet-command,$(CCAS) $(QEMU_LOCAL_INCLUDES) $(QEMU_INCLUDES) \
91 $(QEMU_CFLAGS) $(QEMU_DGFLAGS) $(CFLAGS) \
92 -c -o $@ $<,"CCAS","$(TARGET_DIR)$@")
93
94 %.o: %.cc
95 $(call quiet-command,$(CXX) $(QEMU_LOCAL_INCLUDES) $(QEMU_INCLUDES) \
96 $(QEMU_CXXFLAGS) $(QEMU_DGFLAGS) $(CXXFLAGS) $($@-cflags) \
97 -c -o $@ $<,"CXX","$(TARGET_DIR)$@")
98
99 %.o: %.cpp
100 $(call quiet-command,$(CXX) $(QEMU_LOCAL_INCLUDES) $(QEMU_INCLUDES) \
101 $(QEMU_CXXFLAGS) $(QEMU_DGFLAGS) $(CXXFLAGS) $($@-cflags) \
102 -c -o $@ $<,"CXX","$(TARGET_DIR)$@")
103
104 %.o: %.m
105 $(call quiet-command,$(OBJCC) $(QEMU_LOCAL_INCLUDES) $(QEMU_INCLUDES) \
106 $(QEMU_CFLAGS) $(QEMU_DGFLAGS) $(CFLAGS) $($@-cflags) \
107 -c -o $@ $<,"OBJC","$(TARGET_DIR)$@")
108
109 %.o: %.dtrace
110 $(call quiet-command,dtrace -o $@ -G -s $<,"GEN","$(TARGET_DIR)$@")
111
112 DSO_OBJ_CFLAGS := -fPIC -DBUILD_DSO
113 module-common.o: CFLAGS += $(DSO_OBJ_CFLAGS)
114 %$(DSOSUF): QEMU_LDFLAGS += $(LDFLAGS_SHARED)
115 %$(DSOSUF): %.mo
116 $(call LINK,$^)
117 @# Copy to build root so modules can be loaded when program started without install
118 $(if $(findstring /,$@),$(call quiet-command,cp $@ $(subst /,-,$@),"CP","$(subst /,-,$@)"))
119
120
121 LD_REL := $(CC) -nostdlib $(LD_REL_FLAGS)
122
123 %.mo:
124 $(call quiet-command,$(LD_REL) -o $@ $^,"LD","$(TARGET_DIR)$@")
125
126 .PHONY: modules
127 modules:
128
129 %$(EXESUF): %.o
130 $(call LINK,$(filter %.o %.a %.mo %.fa, $^))
131
132 %.a:
133 $(call quiet-command,rm -f $@ && $(AR) rcs $@ $^,"AR","$(TARGET_DIR)$@")
134
135 # Usage: $(call quiet-command,command and args,"NAME","args to print")
136 # This will run "command and args", and either:
137 # if V=1 just print the whole command and args
138 # otherwise print the 'quiet' output in the format " NAME args to print"
139 # NAME should be a short name of the command, 7 letters or fewer.
140 # If called with only a single argument, will print nothing in quiet mode.
141 quiet-command-run = $(if $(V),,$(if $2,printf " %-7s %s\n" $2 $3 && ))$1
142 quiet-@ = $(if $(V),,@)
143 quiet-command = $(quiet-@)$(call quiet-command-run,$1,$2,$3)
144
145 # cc-option
146 # Usage: CFLAGS+=$(call cc-option, -falign-functions=0, -malign-functions=0)
147
148 cc-option = $(if $(shell $(CC) $1 $2 -S -o /dev/null -xc /dev/null \
149 >/dev/null 2>&1 && echo OK), $2, $3)
150 cc-c-option = $(if $(shell $(CC) $1 $2 -c -o /dev/null -xc /dev/null \
151 >/dev/null 2>&1 && echo OK), $2, $3)
152
153 VPATH_SUFFIXES = %.c %.h %.S %.cc %.cpp %.m %.mak %.texi %.sh %.rc Kconfig% %.json.in
154 set-vpath = $(if $1,$(foreach PATTERN,$(VPATH_SUFFIXES),$(eval vpath $(PATTERN) $1)))
155
156 # install-prog list, dir
157 define install-prog
158 $(INSTALL_DIR) "$2"
159 $(INSTALL_PROG) $1 "$2"
160 $(if $(STRIP),$(STRIP) $(foreach T,$1,"$2/$(notdir $T)"),)
161 endef
162
163 # find-in-path
164 # Usage: $(call find-in-path, prog)
165 # Looks in the PATH if the argument contains no slash, else only considers one
166 # specific directory. Returns an # empty string if the program doesn't exist
167 # there.
168 find-in-path = $(if $(findstring /, $1), \
169 $(wildcard $1), \
170 $(wildcard $(patsubst %, %/$1, $(subst :, ,$(PATH)))))
171
172 # Logical functions (for operating on y/n values like CONFIG_FOO vars)
173 # Inputs to these must be either "y" (true) or "n" or "" (both false)
174 # Output is always either "y" or "n".
175 # Usage: $(call land,$(CONFIG_FOO),$(CONFIG_BAR))
176 # Logical NOT
177 lnot = $(if $(subst n,,$1),n,y)
178 # Logical AND
179 land = $(if $(findstring yy,$1$2),y,n)
180 # Logical OR
181 lor = $(if $(findstring y,$1$2),y,n)
182 # Logical XOR (note that this is the inverse of leqv)
183 lxor = $(if $(filter $(call lnot,$1),$(call lnot,$2)),n,y)
184 # Logical equivalence (note that leqv "","n" is true)
185 leqv = $(if $(filter $(call lnot,$1),$(call lnot,$2)),y,n)
186 # Logical if: like make's $(if) but with an leqv-like test
187 lif = $(if $(subst n,,$1),$2,$3)
188
189 # String testing functions: inputs to these can be any string;
190 # the output is always either "y" or "n". Leading and trailing whitespace
191 # is ignored when comparing strings.
192 # String equality
193 eq = $(if $(subst $2,,$1)$(subst $1,,$2),n,y)
194 # String inequality
195 ne = $(if $(subst $2,,$1)$(subst $1,,$2),y,n)
196 # Emptiness/non-emptiness tests:
197 isempty = $(if $1,n,y)
198 notempty = $(if $1,y,n)
199
200 .PHONY: clean-timestamp
201 clean-timestamp:
202 rm -f *.timestamp
203 clean: clean-timestamp
204
205 # will delete the target of a rule if commands exit with a nonzero exit status
206 .DELETE_ON_ERROR:
207
208 # save-vars
209 # Usage: $(call save-vars, vars)
210 # Save each variable $v in $vars as save-vars-$v, save their object's
211 # variables, then clear $v. saved-vars-$v contains the variables that
212 # where saved for the objects, in order to speedup load-vars.
213 define save-vars
214 $(foreach v,$1,
215 $(eval save-vars-$v := $(value $v))
216 $(eval saved-vars-$v := $(foreach o,$($v), \
217 $(if $($o-cflags), $o-cflags $(eval save-vars-$o-cflags := $($o-cflags))$(eval $o-cflags := )) \
218 $(if $($o-libs), $o-libs $(eval save-vars-$o-libs := $($o-libs))$(eval $o-libs := )) \
219 $(if $($o-objs), $o-objs $(eval save-vars-$o-objs := $($o-objs))$(eval $o-objs := ))))
220 $(eval $v := ))
221 endef
222
223 # load-vars
224 # Usage: $(call load-vars, vars, add_var)
225 # Load the saved value for each variable in @vars, and the per object
226 # variables.
227 # Append @add_var's current value to the loaded value.
228 define load-vars
229 $(eval $2-new-value := $(value $2))
230 $(foreach v,$1,
231 $(eval $v := $(value save-vars-$v))
232 $(foreach o,$(saved-vars-$v),
233 $(eval $o := $(save-vars-$o)) $(eval save-vars-$o := ))
234 $(eval save-vars-$v := )
235 $(eval saved-vars-$v := ))
236 $(eval $2 := $(value $2) $($2-new-value))
237 endef
238
239 # fix-paths
240 # Usage: $(call fix-paths, obj_path, src_path, vars)
241 # Add prefix @obj_path to all objects in @vars, and add prefix @src_path to all
242 # directories in @vars.
243 define fix-paths
244 $(foreach v,$3,
245 $(foreach o,$($v),
246 $(if $($o-libs),
247 $(eval $1$o-libs := $($o-libs)))
248 $(if $($o-cflags),
249 $(eval $1$o-cflags := $($o-cflags)))
250 $(if $($o-objs),
251 $(eval $1$o-objs := $(addprefix $1,$($o-objs)))))
252 $(eval $v := $(addprefix $1,$(filter-out %/,$($v))) \
253 $(addprefix $2,$(filter %/,$($v)))))
254 endef
255
256 # unnest-var-recursive
257 # Usage: $(call unnest-var-recursive, obj_prefix, vars, var)
258 #
259 # Unnest @var by including subdir Makefile.objs, while protect others in @vars
260 # unchanged.
261 #
262 # @obj_prefix is the starting point of object path prefix.
263 #
264 define unnest-var-recursive
265 $(eval dirs := $(sort $(filter %/,$($3))))
266 $(eval $3 := $(filter-out %/,$($3)))
267 $(foreach d,$(dirs:%/=%),
268 $(call save-vars,$2)
269 $(eval obj := $(if $1,$1/)$d)
270 $(eval -include $(SRC_PATH)/$d/Makefile.objs)
271 $(call fix-paths,$(if $1,$1/)$d/,$d/,$2)
272 $(call load-vars,$2,$3)
273 $(call unnest-var-recursive,$1,$2,$3))
274 endef
275
276 # unnest-vars
277 # Usage: $(call unnest-vars, obj_prefix, vars)
278 #
279 # @obj_prefix: object path prefix, can be empty, or '..', etc. Don't include
280 # ending '/'.
281 #
282 # @vars: the list of variable names to unnest.
283 #
284 # This macro will scan subdirectories's Makefile.objs, include them, to build
285 # up each variable listed in @vars.
286 #
287 # Per object and per module cflags and libs are saved with relative path fixed
288 # as well, those variables include -libs, -cflags and -objs. Items in -objs are
289 # also fixed to relative path against SRC_PATH plus the prefix @obj_prefix.
290 #
291 # All nested variables postfixed by -m in names are treated as DSO variables,
292 # and will be built as modules, if enabled.
293 #
294 # A simple example of the unnest:
295 #
296 # obj_prefix = ..
297 # vars = hot cold
298 # hot = fire.o sun.o season/
299 # cold = snow.o water/ season/
300 #
301 # Unnest through a faked source directory structure:
302 #
303 # SRC_PATH
304 # ├── water
305 # │ └── Makefile.objs──────────────────┐
306 # │ │ hot += steam.o │
307 # │ │ cold += ice.mo │
308 # │ │ ice.mo-libs := -licemaker │
309 # │ │ ice.mo-objs := ice1.o ice2.o │
310 # │ └──────────────────────────────┘
311 # │
312 # └── season
313 # └── Makefile.objs──────┐
314 # │ hot += summer.o │
315 # │ cold += winter.o │
316 # └──────────────────┘
317 #
318 # In the end, the result will be:
319 #
320 # hot = ../fire.o ../sun.o ../season/summer.o
321 # cold = ../snow.o ../water/ice.mo ../season/winter.o
322 # ../water/ice.mo-libs = -licemaker
323 # ../water/ice.mo-objs = ../water/ice1.o ../water/ice2.o
324 #
325 # Note that 'hot' didn't include 'water/' in the input, so 'steam.o' is not
326 # included.
327 #
328 define unnest-vars
329 # In the case of target build (i.e. $1 == ..), fix path for top level
330 # Makefile.objs objects
331 $(if $1,$(call fix-paths,$1/,,$2))
332
333 # Descend and include every subdir Makefile.objs
334 $(foreach v, $2,
335 $(call unnest-var-recursive,$1,$2,$v)
336 # Pass the .mo-cflags and .mo-libs along to its member objects
337 $(foreach o, $(filter %.mo,$($v)),
338 $(foreach p,$($o-objs),
339 $(if $($o-cflags), $(eval $p-cflags += $($o-cflags)))
340 $(if $($o-libs), $(eval $p-libs += $($o-libs))))))
341
342 # For all %.mo objects that are directly added into -y, just expand them
343 $(foreach v,$(filter %-y,$2),
344 $(eval $v := $(foreach o,$($v),$(if $($o-objs),$($o-objs),$o))))
345
346 $(foreach v,$(filter %-m,$2),
347 # All .o found in *-m variables are single object modules, create .mo
348 # for them
349 $(foreach o,$(filter %.o,$($v)),
350 $(eval $(o:%.o=%.mo)-objs := $o))
351 # Now unify .o in -m variable to .mo
352 $(eval $v := $($v:%.o=%.mo))
353 $(eval modules-m += $($v))
354
355 # For module build, build shared libraries during "make modules"
356 # For non-module build, add -m to -y
357 $(if $(CONFIG_MODULES),
358 $(foreach o,$($v),
359 $(eval $($o-objs): CFLAGS += $(DSO_OBJ_CFLAGS))
360 $(eval $o: $($o-objs)))
361 $(eval $(patsubst %-m,%-y,$v) += $($v))
362 $(eval modules: $($v:%.mo=%$(DSOSUF))),
363 $(eval $(patsubst %-m,%-y,$v) += $(call expand-objs, $($v)))))
364
365 # Post-process all the unnested vars
366 $(foreach v,$2,
367 $(foreach o, $(filter %.mo,$($v)),
368 # Find all the .mo objects in variables and add dependency rules
369 # according to .mo-objs. Report error if not set
370 $(if $($o-objs),
371 $(eval $(o:%.mo=%$(DSOSUF)): module-common.o $($o-objs))))
372 $(shell mkdir -p ./ $(sort $(dir $($v))))
373 # Include all the .d files
374 $(eval -include $(patsubst %.o,%.d,$(patsubst %.mo,%.d,$(filter %.o,$($v)))))
375 $(eval $v := $(filter-out %/,$($v))))
376 endef
377
378 print-%:
379 @echo '$*=$($*)'