doc: Document driver-specific -blockdev options
[qemu/kevin.git] / rules.mak
blob6e943335f3010034f27b5d50bfae50108b0c446e
2 COMMA := ,
4 # Don't use implicit rules or variables
5 # we have explicit rules for everything
6 MAKEFLAGS += -rR
8 # Files with this suffixes are final, don't try to generate them
9 # using implicit rules
10 %/trace-events:
11 %.hx:
12 %.py:
13 %.objs:
14 %.d:
15 %.h:
16 %.c:
17 %.cc:
18 %.cpp:
19 %.m:
20 %.mak:
21 clean-target:
23 # Flags for dependency generation
24 QEMU_DGFLAGS += -MMD -MP -MT $@ -MF $(@D)/$(*F).d
26 # Compiler searches the source file dir first, but in vpath builds
27 # we need to make it search the build dir too, before any other
28 # explicit search paths. There are two search locations in the build
29 # dir, one absolute and the other relative to the compiler working
30 # directory. These are the same for target-independent files, but
31 # different for target-dependent ones.
32 QEMU_LOCAL_INCLUDES = -I$(BUILD_DIR)/$(@D) -I$(@D)
34 WL_U := -Wl,-u,
35 find-symbols = $(if $1, $(sort $(shell $(NM) -P -g $1 | $2)))
36 defined-symbols = $(call find-symbols,$1,awk '$$2!="U"{print $$1}')
37 undefined-symbols = $(call find-symbols,$1,awk '$$2=="U"{print $$1}')
39 # All the .mo objects in -m variables are also added into corresponding -y
40 # variable in unnest-vars, but filtered out here, when LINK is called.
42 # The .mo objects are supposed to be linked as a DSO, for module build. So here
43 # they are only used as a placeholders to generate those "archive undefined"
44 # symbol options (-Wl,-u,$symbol_name), which are the archive functions
45 # referenced by the code in the DSO.
47 # Also the presence in -y variables will also guarantee they are built before
48 # linking executables that will load them. So we can look up symbol reference
49 # in LINK.
51 # This is necessary because the exectuable itself may not use the function, in
52 # which case the function would not be linked in. Then the DSO loading will
53 # fail because of the missing symbol.
54 process-archive-undefs = $(filter-out %.a %.mo,$1) \
55 $(addprefix $(WL_U), \
56 $(filter $(call defined-symbols,$(filter %.a, $1)), \
57 $(call undefined-symbols,$(filter %.mo,$1)))) \
58 $(filter %.a,$1)
60 extract-libs = $(strip $(foreach o,$(filter-out %.mo,$1),$($o-libs)))
61 expand-objs = $(strip $(sort $(filter %.o,$1)) \
62 $(foreach o,$(filter %.mo,$1),$($o-objs)) \
63 $(filter-out %.o %.mo,$1))
65 %.o: %.c
66 $(call quiet-command,$(CC) $(QEMU_LOCAL_INCLUDES) $(QEMU_INCLUDES) \
67 $(QEMU_CFLAGS) $(QEMU_DGFLAGS) $(CFLAGS) $($@-cflags) \
68 -c -o $@ $<,"CC","$(TARGET_DIR)$@")
69 %.o: %.rc
70 $(call quiet-command,$(WINDRES) -I. -o $@ $<,"RC","$(TARGET_DIR)$@")
72 # If we have a CXX we might have some C++ objects, in which case we
73 # must link with the C++ compiler, not the plain C compiler.
74 LINKPROG = $(or $(CXX),$(CC))
76 LINK = $(call quiet-command, $(LINKPROG) $(QEMU_CFLAGS) $(CFLAGS) $(LDFLAGS) -o $@ \
77 $(call process-archive-undefs, $1) \
78 $(version-obj-y) $(call extract-libs,$1) $(LIBS),"LINK","$(TARGET_DIR)$@")
80 %.o: %.S
81 $(call quiet-command,$(CCAS) $(QEMU_LOCAL_INCLUDES) $(QEMU_INCLUDES) \
82 $(QEMU_CFLAGS) $(QEMU_DGFLAGS) $(CFLAGS) \
83 -c -o $@ $<,"CCAS","$(TARGET_DIR)$@")
85 %.o: %.cc
86 $(call quiet-command,$(CXX) $(QEMU_LOCAL_INCLUDES) $(QEMU_INCLUDES) \
87 $(QEMU_CXXFLAGS) $(QEMU_DGFLAGS) $(CFLAGS) $($@-cflags) \
88 -c -o $@ $<,"CXX","$(TARGET_DIR)$@")
90 %.o: %.cpp
91 $(call quiet-command,$(CXX) $(QEMU_LOCAL_INCLUDES) $(QEMU_INCLUDES) \
92 $(QEMU_CXXFLAGS) $(QEMU_DGFLAGS) $(CFLAGS) $($@-cflags) \
93 -c -o $@ $<,"CXX","$(TARGET_DIR)$@")
95 %.o: %.m
96 $(call quiet-command,$(OBJCC) $(QEMU_LOCAL_INCLUDES) $(QEMU_INCLUDES) \
97 $(QEMU_CFLAGS) $(QEMU_DGFLAGS) $(CFLAGS) $($@-cflags) \
98 -c -o $@ $<,"OBJC","$(TARGET_DIR)$@")
100 %.o: %.dtrace
101 $(call quiet-command,dtrace -o $@ -G -s $<,"GEN","$(TARGET_DIR)$@")
103 DSO_OBJ_CFLAGS := -fPIC -DBUILD_DSO
104 module-common.o: CFLAGS += $(DSO_OBJ_CFLAGS)
105 %$(DSOSUF): LDFLAGS += $(LDFLAGS_SHARED)
106 %$(DSOSUF): %.mo
107 $(call LINK,$^)
108 @# Copy to build root so modules can be loaded when program started without install
109 $(if $(findstring /,$@),$(call quiet-command,cp $@ $(subst /,-,$@),"CP","$(subst /,-,$@)"))
112 LD_REL := $(CC) -nostdlib $(LD_REL_FLAGS)
114 %.mo:
115 $(call quiet-command,$(LD_REL) -o $@ $^,"LD","$(TARGET_DIR)$@")
117 .PHONY: modules
118 modules:
120 %$(EXESUF): %.o
121 $(call LINK,$(filter %.o %.a %.mo, $^))
123 %.a:
124 $(call quiet-command,rm -f $@ && $(AR) rcs $@ $^,"AR","$(TARGET_DIR)$@")
126 # Usage: $(call quiet-command,command and args,"NAME","args to print")
127 # This will run "command and args", and either:
128 # if V=1 just print the whole command and args
129 # otherwise print the 'quiet' output in the format " NAME args to print"
130 # NAME should be a short name of the command, 7 letters or fewer.
131 # If called with only a single argument, will print nothing in quiet mode.
132 quiet-command = $(if $(V),$1,$(if $(2),@printf " %-7s %s\n" $2 $3 && $1, @$1))
134 # cc-option
135 # Usage: CFLAGS+=$(call cc-option, -falign-functions=0, -malign-functions=0)
137 cc-option = $(if $(shell $(CC) $1 $2 -S -o /dev/null -xc /dev/null \
138 >/dev/null 2>&1 && echo OK), $2, $3)
139 cc-c-option = $(if $(shell $(CC) $1 $2 -c -o /dev/null -xc /dev/null \
140 >/dev/null 2>&1 && echo OK), $2, $3)
142 VPATH_SUFFIXES = %.c %.h %.S %.cc %.cpp %.m %.mak %.texi %.sh %.rc
143 set-vpath = $(if $1,$(foreach PATTERN,$(VPATH_SUFFIXES),$(eval vpath $(PATTERN) $1)))
145 # install-prog list, dir
146 define install-prog
147 $(INSTALL_DIR) "$2"
148 $(INSTALL_PROG) $1 "$2"
149 $(if $(STRIP),$(STRIP) $(foreach T,$1,"$2/$(notdir $T)"),)
150 endef
152 # find-in-path
153 # Usage: $(call find-in-path, prog)
154 # Looks in the PATH if the argument contains no slash, else only considers one
155 # specific directory. Returns an # empty string if the program doesn't exist
156 # there.
157 find-in-path = $(if $(findstring /, $1), \
158 $(wildcard $1), \
159 $(wildcard $(patsubst %, %/$1, $(subst :, ,$(PATH)))))
161 # Logical functions (for operating on y/n values like CONFIG_FOO vars)
162 # Inputs to these must be either "y" (true) or "n" or "" (both false)
163 # Output is always either "y" or "n".
164 # Usage: $(call land,$(CONFIG_FOO),$(CONFIG_BAR))
165 # Logical NOT
166 lnot = $(if $(subst n,,$1),n,y)
167 # Logical AND
168 land = $(if $(findstring yy,$1$2),y,n)
169 # Logical OR
170 lor = $(if $(findstring y,$1$2),y,n)
171 # Logical XOR (note that this is the inverse of leqv)
172 lxor = $(if $(filter $(call lnot,$1),$(call lnot,$2)),n,y)
173 # Logical equivalence (note that leqv "","n" is true)
174 leqv = $(if $(filter $(call lnot,$1),$(call lnot,$2)),y,n)
175 # Logical if: like make's $(if) but with an leqv-like test
176 lif = $(if $(subst n,,$1),$2,$3)
178 # String testing functions: inputs to these can be any string;
179 # the output is always either "y" or "n". Leading and trailing whitespace
180 # is ignored when comparing strings.
181 # String equality
182 eq = $(if $(subst $2,,$1)$(subst $1,,$2),n,y)
183 # String inequality
184 ne = $(if $(subst $2,,$1)$(subst $1,,$2),y,n)
185 # Emptiness/non-emptiness tests:
186 isempty = $(if $1,n,y)
187 notempty = $(if $1,y,n)
189 # Generate files with tracetool
190 TRACETOOL=$(PYTHON) $(SRC_PATH)/scripts/tracetool.py
192 # Generate timestamp files for .h include files
194 config-%.h: config-%.h-timestamp
195 @cmp $< $@ >/dev/null 2>&1 || cp $< $@
197 config-%.h-timestamp: config-%.mak $(SRC_PATH)/scripts/create_config
198 $(call quiet-command, sh $(SRC_PATH)/scripts/create_config < $< > $@,"GEN","$(TARGET_DIR)config-$*.h")
200 .PHONY: clean-timestamp
201 clean-timestamp:
202 rm -f *.timestamp
203 clean: clean-timestamp
205 # will delete the target of a rule if commands exit with a nonzero exit status
206 .DELETE_ON_ERROR:
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
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
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
256 # unnest-var-recursive
257 # Usage: $(call unnest-var-recursive, obj_prefix, vars, var)
259 # Unnest @var by including subdir Makefile.objs, while protect others in @vars
260 # unchanged.
262 # @obj_prefix is the starting point of object path prefix.
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
276 # unnest-vars
277 # Usage: $(call unnest-vars, obj_prefix, vars)
279 # @obj_prefix: object path prefix, can be empty, or '..', etc. Don't include
280 # ending '/'.
282 # @vars: the list of variable names to unnest.
284 # This macro will scan subdirectories's Makefile.objs, include them, to build
285 # up each variable listed in @vars.
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.
291 # All nested variables postfixed by -m in names are treated as DSO variables,
292 # and will be built as modules, if enabled.
294 # A simple example of the unnest:
296 # obj_prefix = ..
297 # vars = hot cold
298 # hot = fire.o sun.o season/
299 # cold = snow.o water/ season/
301 # Unnest through a faked source directory structure:
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 # └──────────────────┘
318 # In the end, the result will be:
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
325 # Note that 'hot' didn't include 'season/' in the input, so 'summer.o' is not
326 # included.
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))
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))))))
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))))
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))
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)))))
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 $(error $o added in $v but $o-objs is not set)))
373 $(shell mkdir -p ./ $(sort $(dir $($v))))
374 # Include all the .d files
375 $(eval -include $(patsubst %.o,%.d,$(patsubst %.mo,%.d,$($v))))
376 $(eval $v := $(filter-out %/,$($v))))
377 endef
379 TEXI2MAN = $(call quiet-command, \
380 perl -Ww -- $(SRC_PATH)/scripts/texi2pod.pl $(TEXI2PODFLAGS) $< $@.pod && \
381 $(POD2MAN) --section=$(subst .,,$(suffix $@)) --center=" " --release=" " $@.pod > $@, \
382 "GEN","$@")
384 %.1:
385 $(call TEXI2MAN)
386 %.7:
387 $(call TEXI2MAN)
388 %.8:
389 $(call TEXI2MAN)