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