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