src/Makefile.housekeeping

   1 # -*- makefile -*- : Force emacs to use Makefile mode
   2 #
   3 # This file contains various boring housekeeping functions that would
   4 # otherwise seriously clutter up the main Makefile.
   5
   6 ###############################################################################
   7 #
   8 # Find a usable "echo -e" substitute.
   9 #
  10 TAB                     := $(shell $(PRINTF) '\t')
  11 ECHO_E_ECHO             := $(ECHO)
  12 ECHO_E_ECHO_E           := $(ECHO) -e
  13 ECHO_E_BIN_ECHO         := /bin/echo
  14 ECHO_E_BIN_ECHO_E       := /bin/echo -e
  15 ECHO_E_ECHO_TAB         := $(shell $(ECHO_E_ECHO) '\t' | cat)
  16 ECHO_E_ECHO_E_TAB       := $(shell $(ECHO_E_ECHO_E) '\t' | cat)
  17 ECHO_E_BIN_ECHO_TAB     := $(shell $(ECHO_E_BIN_ECHO) '\t')
  18 ECHO_E_BIN_ECHO_E_TAB   := $(shell $(ECHO_E_BIN_ECHO_E) '\t')
  19
  20 ifeq ($(ECHO_E_ECHO_TAB),$(TAB))
  21 ECHO_E          := $(ECHO_E_ECHO)
  22 endif
  23 ifeq ($(ECHO_E_ECHO_E_TAB),$(TAB))
  24 ECHO_E          := $(ECHO_E_ECHO_E)
  25 endif
  26 ifeq ($(ECHO_E_BIN_ECHO_TAB),$(TAB))
  27 ECHO_E          := $(ECHO_E_BIN_ECHO)
  28 endif
  29 ifeq ($(ECHO_E_BIN_ECHO_E_TAB),$(TAB))
  30 ECHO_E          := $(ECHO_E_BIN_ECHO_E)
  31 endif
  32
  33 .echocheck :
  34 ifdef ECHO_E
  35         @$(TOUCH) $@
  36 else
  37         @$(PRINTF) '%24s : x%sx\n' 'tab' '$(TAB)'
  38         @$(PRINTF) '%24s : x%sx\n' '"$(ECHO_E_ECHO) \t"' \
  39                                     '$(ECHO_E_ECHO_TAB)'
  40         @$(PRINTF) '%24s : x%sx\n' '"$(ECHO_E_ECHO_E) \t"' \
  41                                     '$(ECHO_E_ECHO_E_TAB)'
  42         @$(PRINTF) '%24s : x%sx\n' '"$(ECHO_E_BIN_ECHO) \t"' \
  43                                     '$(ECHO_E_BIN_ECHO_TAB)'
  44         @$(PRINTF) '%24s : x%sx\n' '"$(ECHO_E_BIN_ECHO_E) \t"' \
  45                                     '$(ECHO_E_BIN_ECHO_E_TAB)'
  46         @$(ECHO) "No usable \"echo -e\" substitute found"
  47         @exit 1
  48 endif
  49 MAKEDEPS        += .echocheck
  50 VERYCLEANUP     += .echocheck
  51
  52 echo :
  53         @$(ECHO) "Using \"$(ECHO_E)\" for \"echo -e\""
  54
  55 ###############################################################################
  56 #
  57 # Generate a usable "seq" substitute
  58 #
  59 define seq
  60         $(shell awk 'BEGIN { for ( i = $(1) ; i <= $(2) ; i++ ) print i }')
  61 endef
  62
  63 ###############################################################################
  64 #
  65 # Determine host OS
  66 #
  67 HOST_OS         := $(shell uname -s)
  68 hostos :
  69         @$(ECHO) $(HOST_OS)
  70
  71 ###############################################################################
  72 #
  73 # Determine compiler
  74
  75 CCDEFS          := $(shell $(CC) -E -x c -c /dev/null -dM | cut -d" " -f2)
  76 ccdefs:
  77         @$(ECHO) $(CCDEFS)
  78
  79 ifeq ($(filter __ICC,$(CCDEFS)),__ICC)
  80 CCTYPE          := icc
  81 else
  82 CCTYPE          := gcc
  83 endif
  84 cctype:
  85         @$(ECHO) $(CCTYPE)
  86
  87 ###############################################################################
  88 #
  89 # Check for tools that can cause failed builds
  90 #
  91
  92 ifeq ($(CCTYPE),gcc)
  93 GCC_2_96_BANNER := $(shell $(CC) -v 2>&1 | grep -is 'gcc version 2\.96')
  94 ifneq ($(GCC_2_96_BANNER),)
  95 $(warning gcc 2.96 is unsuitable for compiling iPXE)
  96 $(warning Use gcc 2.95 or a newer version instead)
  97 $(error Unsuitable build environment found)
  98 endif
  99 endif
 100
 101 PERL_UNICODE_CHECK := $(shell $(PERL) -e 'use bytes; print chr(255)' | wc -c)
 102 ifeq ($(PERL_UNICODE_CHECK),2)
 103 $(warning Your Perl version has a Unicode handling bug)
 104 $(warning Execute this command before building iPXE:)
 105 $(warning export LANG=$${LANG%.UTF-8})
 106 $(error Unsuitable build environment found)
 107 endif
 108
 109 LD_GOLD_BANNER := $(shell $(LD) -v 2>&1 | grep 'GNU gold')
 110 ifneq ($(LD_GOLD_BANNER),)
 111 $(warning GNU gold is unsuitable for building iPXE)
 112 $(warning Use GNU ld instead)
 113 $(error Unsuitable build environment found)
 114 endif
 115
 116 ###############################################################################
 117 #
 118 # Check if $(eval ...) is available to use
 119 #
 120
 121 HAVE_EVAL :=
 122 ifndef NO_EVAL
 123 $(eval HAVE_EVAL := yes)
 124 endif
 125 eval :
 126         @$(ECHO) $(HAVE_EVAL)
 127
 128 ###############################################################################
 129 #
 130 # Check for various tool workarounds
 131 #
 132
 133 WORKAROUND_CFLAGS :=
 134 WORKAROUND_ASFLAGS :=
 135 WORKAROUND_LDFLAGS :=
 136
 137 # Make syntax does not allow use of comma or space in certain places.
 138 # This ugly workaround is suggested in the manual.
 139 #
 140 COMMA   := ,
 141 EMPTY   :=
 142 SPACE   := $(EMPTY) $(EMPTY)
 143 HASH    := \#
 144 define NEWLINE
 145
 146
 147 endef
 148
 149 # Some widespread patched versions of gcc include -fstack-protector by
 150 # default, even when -ffreestanding is specified.  We therefore need
 151 # to disable -fstack-protector if the compiler supports it.
 152 #
 153 ifeq ($(CCTYPE),gcc)
 154 SP_TEST = $(CC) -fno-stack-protector -x c -c /dev/null \
 155                 -o /dev/null >/dev/null 2>&1
 156 SP_FLAGS := $(shell $(SP_TEST) && $(ECHO) '-fno-stack-protector')
 157 WORKAROUND_CFLAGS += $(SP_FLAGS)
 158 endif
 159
 160 # gcc 4.4 generates .eh_frame sections by default, which distort the
 161 # output of "size".  Inhibit this.
 162 #
 163 ifeq ($(CCTYPE),gcc)
 164 CFI_TEST = $(CC) -fno-dwarf2-cfi-asm -fno-exceptions -fno-unwind-tables \
 165                  -fno-asynchronous-unwind-tables -x c -c /dev/null \
 166                  -o /dev/null >/dev/null 2>&1
 167 CFI_FLAGS := $(shell $(CFI_TEST) && \
 168                $(ECHO) '-fno-dwarf2-cfi-asm -fno-exceptions ' \
 169                        '-fno-unwind-tables -fno-asynchronous-unwind-tables')
 170 WORKAROUND_CFLAGS += $(CFI_FLAGS)
 171 endif
 172
 173 # gcc 4.6 generates spurious warnings if -Waddress is in force.
 174 # Inhibit this.
 175 #
 176 ifeq ($(CCTYPE),gcc)
 177 WNA_TEST = $(CC) -Wno-address -x c -c /dev/null -o /dev/null >/dev/null 2>&1
 178 WNA_FLAGS := $(shell $(WNA_TEST) && $(ECHO) '-Wno-address')
 179 WORKAROUND_CFLAGS += $(WNA_FLAGS)
 180 endif
 181
 182 # Some versions of gas choke on division operators, treating them as
 183 # comment markers.  Specifying --divide will work around this problem,
 184 # but isn't available on older gas versions.
 185 #
 186 DIVIDE_TEST = $(AS) --divide /dev/null -o /dev/null 2>/dev/null
 187 DIVIDE_FLAGS := $(shell $(DIVIDE_TEST) && $(ECHO) '--divide')
 188 WORKAROUND_ASFLAGS += $(DIVIDE_FLAGS)
 189
 190 ###############################################################################
 191 #
 192 # Build verbosity
 193 #
 194 ifeq ($(V),1)
 195 Q :=
 196 QM := @\#
 197 else
 198 Q := @
 199 QM := @
 200 endif
 201
 202 ###############################################################################
 203 #
 204 # Checker
 205 #
 206 ifeq ($(C),1)
 207 export REAL_CC := $(CC)
 208 CC := cgcc
 209 CFLAGS += -Wno-decl
 210 endif
 211
 212 ###############################################################################
 213 #
 214 # Set BIN according to whatever was specified on the command line as
 215 # the build target.
 216 #
 217
 218 # Determine how many different BIN directories are mentioned in the
 219 # make goals.
 220 #
 221 BIN_GOALS       := $(filter bin bin/% bin-%,$(MAKECMDGOALS))
 222 BIN_GOALS_BINS  := $(sort $(foreach BG,$(BIN_GOALS),\
 223                                     $(firstword $(subst /, ,$(BG)))))
 224 NUM_BINS        := $(words $(BIN_GOALS_BINS))
 225
 226 ifeq ($(NUM_BINS),0)
 227
 228 # No BIN directory was specified.  Set BIN to "bin" as a sensible
 229 # default.
 230
 231 BIN             := bin
 232
 233 else # NUM_BINS == 0
 234
 235 ifeq ($(NUM_BINS),1)
 236
 237 # If exactly one BIN directory was specified, set BIN to match this
 238 # directory.
 239 #
 240 BIN             := $(firstword $(BIN_GOALS_BINS))
 241
 242 else # NUM_BINS == 1
 243
 244 # More than one BIN directory was specified.  We cannot handle the
 245 # latter case within a single make invocation, so set up recursive
 246 # targets for each BIN directory.  Use exactly one target for each BIN
 247 # directory since running multiple make invocations within the same
 248 # BIN directory is likely to cause problems.
 249 #
 250 # Leave $(BIN) undefined.  This has implications for any target that
 251 # depends on $(BIN); such targets should be made conditional upon the
 252 # existence of $(BIN).
 253 #
 254 BIN_GOALS_FIRST := $(foreach BGB,$(BIN_GOALS_BINS),\
 255                              $(firstword $(filter $(BGB)/%,$(BIN_GOALS))))
 256 BIN_GOALS_OTHER := $(filter-out $(BIN_GOALS_FIRST),$(BIN_GOALS))
 257
 258 $(BIN_GOALS_FIRST) : % : BIN_RECURSE
 259         $(Q)$(MAKE) --no-print-directory BIN=$(firstword $(subst /, ,$@)) \
 260             $(filter $(firstword $(subst /, ,$@))/%, $(BIN_GOALS))
 261 $(BIN_GOALS_OTHER) : % : BIN_RECURSE
 262         $(Q)$(TRUE)
 263 .PHONY : BIN_RECURSE
 264
 265 endif # NUM_BINS == 1
 266 endif # NUM_BINS == 0
 267
 268 ifdef BIN
 269
 270 # Create $(BIN) directory if it doesn't exist yet
 271 #
 272 ifeq ($(wildcard $(BIN)),)
 273 $(shell $(MKDIR) -p $(BIN))
 274 endif
 275
 276 # Target to allow e.g. "make bin-efi arch"
 277 #
 278 $(BIN) :
 279         @# Do nothing, silently
 280 .PHONY : $(BIN)
 281
 282 # Remove everything in $(BIN) for a "make clean"
 283 #
 284 CLEANUP += $(BIN)/*.* # Avoid picking up directories
 285
 286 endif # defined(BIN)
 287
 288 # Determine whether or not we need to include the dependency files
 289 #
 290 NO_DEP_TARGETS  := $(BIN) clean veryclean
 291 ifeq ($(MAKECMDGOALS),)
 292 NEED_DEPS       := 1
 293 endif
 294 ifneq ($(strip $(filter-out $(NO_DEP_TARGETS),$(MAKECMDGOALS))),)
 295 NEED_DEPS       := 1
 296 endif
 297
 298 ###############################################################################
 299 #
 300 # Select build architecture and platform based on $(BIN)
 301 #
 302 # BIN has the form bin[-[arch-]platform]
 303
 304 ARCHS           := $(patsubst arch/%,%,$(wildcard arch/*))
 305 PLATFORMS       := $(patsubst config/defaults/%.h,%,\
 306                      $(wildcard config/defaults/*.h))
 307 archs :
 308         @$(ECHO) $(ARCHS)
 309
 310 platforms :
 311         @$(ECHO) $(PLATFORMS)
 312
 313 ifdef BIN
 314
 315 # Determine architecture portion of $(BIN), if present
 316 BIN_ARCH        := $(strip $(foreach A,$(ARCHS),\
 317                              $(patsubst bin-$(A)-%,$(A),\
 318                                $(filter bin-$(A)-%,$(BIN)))))
 319
 320 # Determine platform portion of $(BIN), if present
 321 ifeq ($(BIN_ARCH),)
 322 BIN_PLATFORM    := $(patsubst bin-%,%,$(filter bin-%,$(BIN)))
 323 else
 324 BIN_PLATFORM    := $(patsubst bin-$(BIN_ARCH)-%,%,$(BIN))
 325 endif
 326
 327 # Determine build architecture
 328 DEFAULT_ARCH    := i386
 329 ARCH            := $(firstword $(BIN_ARCH) $(DEFAULT_ARCH))
 330 CFLAGS          += -DARCH=$(ARCH)
 331 arch :
 332         @$(ECHO) $(ARCH)
 333 .PHONY : arch
 334
 335 # Determine build platform
 336 DEFAULT_PLATFORM := pcbios
 337 PLATFORM        := $(firstword $(BIN_PLATFORM) $(DEFAULT_PLATFORM))
 338 CFLAGS          += -DPLATFORM=$(PLATFORM)
 339 platform :
 340         @$(ECHO) $(PLATFORM)
 341
 342 endif # defined(BIN)
 343
 344 # Include architecture-specific Makefile
 345 ifdef ARCH
 346 MAKEDEPS        += arch/$(ARCH)/Makefile
 347 include arch/$(ARCH)/Makefile
 348 endif
 349
 350 # Include architecture-specific include path
 351 ifdef ARCH
 352 INCDIRS         += arch/$(ARCH)/include
 353 INCDIRS         += arch/$(ARCH)/include/$(PLATFORM)
 354 endif
 355
 356 ###############################################################################
 357 #
 358 # Source file handling
 359
 360 # SRCDIRS lists all directories containing source files.
 361 srcdirs :
 362         @$(ECHO) $(SRCDIRS)
 363
 364 # SRCS lists all .c or .S files found in any SRCDIR
 365 #
 366 SRCS    += $(wildcard $(patsubst %,%/*.c,$(SRCDIRS)))
 367 SRCS    += $(wildcard $(patsubst %,%/*.S,$(SRCDIRS)))
 368 srcs :
 369         @$(ECHO) $(SRCS)
 370
 371 # AUTO_SRCS lists all files in SRCS that are not mentioned in
 372 # NON_AUTO_SRCS.  Files should be added to NON_AUTO_SRCS if they
 373 # cannot be built using the standard build template.
 374 #
 375 AUTO_SRCS = $(filter-out $(NON_AUTO_SRCS),$(SRCS))
 376 autosrcs :
 377         @$(ECHO) $(AUTO_SRCS)
 378
 379 # Just about everything else in this section depends upon having
 380 # $(BIN) set
 381
 382 ifdef BIN
 383
 384 # INCDIRS lists the include path
 385 incdirs :
 386         @$(ECHO) $(INCDIRS)
 387
 388 # Common flags
 389 #
 390 CFLAGS          += $(foreach INC,$(INCDIRS),-I$(INC))
 391 CFLAGS          += -Os
 392 CFLAGS          += -g
 393 ifeq ($(CCTYPE),gcc)
 394 CFLAGS          += -ffreestanding
 395 CFLAGS          += -Wall -W -Wformat-nonliteral
 396 HOST_CFLAGS     += -Wall -W -Wformat-nonliteral
 397 endif
 398 ifeq ($(CCTYPE),icc)
 399 CFLAGS          += -fno-builtin
 400 CFLAGS          += -no-ip
 401 CFLAGS          += -no-gcc
 402 CFLAGS          += -diag-disable 111 # Unreachable code
 403 CFLAGS          += -diag-disable 128 # Unreachable loop
 404 CFLAGS          += -diag-disable 170 # Array boundary checks
 405 CFLAGS          += -diag-disable 177 # Unused functions
 406 CFLAGS          += -diag-disable 181 # printf() format checks
 407 CFLAGS          += -diag-disable 188 # enum strictness
 408 CFLAGS          += -diag-disable 193 # Undefined preprocessor identifiers
 409 CFLAGS          += -diag-disable 280 # switch ( constant )
 410 CFLAGS          += -diag-disable 310 # K&R parameter lists
 411 CFLAGS          += -diag-disable 424 # Extra semicolon
 412 CFLAGS          += -diag-disable 589 # Declarations mid-code
 413 CFLAGS          += -diag-disable 593 # Unused variables
 414 CFLAGS          += -diag-disable 810 # Casting ints to smaller ints
 415 CFLAGS          += -diag-disable 981 # Sequence point violations
 416 CFLAGS          += -diag-disable 1292 # Ignored attributes
 417 CFLAGS          += -diag-disable 1338 # void pointer arithmetic
 418 CFLAGS          += -diag-disable 1361 # Variable-length arrays
 419 CFLAGS          += -diag-disable 1418 # Missing prototypes
 420 CFLAGS          += -diag-disable 1419 # Missing prototypes
 421 CFLAGS          += -diag-disable 1599 # Hidden variables
 422 CFLAGS          += -Wall -Wmissing-declarations
 423 endif
 424 CFLAGS          += $(WORKAROUND_CFLAGS) $(EXTRA_CFLAGS)
 425 ASFLAGS         += $(WORKAROUND_ASFLAGS) $(EXTRA_ASFLAGS)
 426 LDFLAGS         += $(WORKAROUND_LDFLAGS) $(EXTRA_LDFLAGS)
 427 HOST_CFLAGS     += -O2 -g
 428
 429 # Inhibit -Werror if NO_WERROR is specified on make command line
 430 #
 431 ifneq ($(NO_WERROR),1)
 432 CFLAGS          += -Werror
 433 ASFLAGS         += --fatal-warnings
 434 HOST_CFLAGS     += -Werror
 435 endif
 436
 437 # Function trace recorder state in the last build.  This is needed
 438 # in order to correctly rebuild whenever the function recorder is
 439 # enabled/disabled.
 440 #
 441 FNREC_STATE     := $(BIN)/.fnrec.state
 442 ifeq ($(wildcard $(FNREC_STATE)),)
 443 FNREC_OLD       := <invalid>
 444 else
 445 FNREC_OLD       := $(shell cat $(FNREC_STATE))
 446 endif
 447 ifeq ($(FNREC_OLD),$(FNREC))
 448 $(FNREC_STATE) :
 449 else
 450 $(FNREC_STATE) : clean
 451 $(shell $(ECHO) "$(FNREC)" > $(FNREC_STATE))
 452 endif
 453
 454 VERYCLEANUP     += $(FNREC_STATE)
 455 MAKEDEPS        += $(FNREC_STATE)
 456
 457 ifeq ($(FNREC),1)
 458 # Enabling -finstrument-functions affects gcc's analysis and leads to spurious
 459 # warnings about use of uninitialised variables.
 460 #
 461 CFLAGS          += -Wno-uninitialized
 462 CFLAGS          += -finstrument-functions
 463 CFLAGS          += -finstrument-functions-exclude-file-list=core/fnrec.c
 464 endif
 465
 466 # Enable per-item sections and section garbage collection.  Note that
 467 # some older versions of gcc support -fdata-sections but treat it as
 468 # implying -fno-common, which would break our build.  Some other older
 469 # versions issue a spurious and uninhibitable warning if
 470 # -ffunction-sections is used with -g, which would also break our
 471 # build since we use -Werror.
 472 #
 473 ifeq ($(CCTYPE),gcc)
 474 DS_TEST         = $(ECHO) 'char x;' | \
 475                   $(CC) -fdata-sections -S -x c - -o - 2>/dev/null | \
 476                   grep -E '\.comm' > /dev/null
 477 DS_FLAGS        := $(shell $(DS_TEST) && $(ECHO) '-fdata-sections')
 478 FS_TEST         = $(CC) -ffunction-sections -g -c -x c /dev/null \
 479                   -o /dev/null 2>/dev/null
 480 FS_FLAGS        := $(shell $(FS_TEST) && $(ECHO) '-ffunction-sections')
 481 CFLAGS          += $(FS_FLAGS) $(DS_FLAGS)
 482 endif
 483 LDFLAGS         += --gc-sections
 484
 485 # Force creation of static binaries (required for OpenBSD, does no
 486 # harm on other platforms).
 487 #
 488 LDFLAGS         += -static
 489
 490 # compiler.h is needed for our linking and debugging system
 491 #
 492 CFLAGS          += -include include/compiler.h
 493
 494 # CFLAGS for specific object types
 495 #
 496 CFLAGS_c        +=
 497 CFLAGS_S        += -DASSEMBLY
 498
 499 # Base object name of the current target
 500 #
 501 OBJECT          = $(firstword $(subst ., ,$(@F)))
 502
 503 # CFLAGS for specific object files.  You can define
 504 # e.g. CFLAGS_rtl8139, and have those flags automatically used when
 505 # compiling bin/rtl8139.o.
 506 #
 507 OBJ_CFLAGS      = $(CFLAGS_$(OBJECT)) -DOBJECT=$(subst -,_,$(OBJECT))
 508 $(BIN)/%.flags :
 509         @$(ECHO) $(OBJ_CFLAGS)
 510
 511 # ICC requires postprocessing objects to fix up table alignments
 512 #
 513 ifeq ($(CCTYPE),icc)
 514 POST_O          = && $(ICCFIX) $@
 515 POST_O_DEPS     := $(ICCFIX)
 516 else
 517 POST_O          :=
 518 POST_O_DEPS     :=
 519 endif
 520
 521 # Rules for specific object types.
 522 #
 523 COMPILE_c       = $(CC) $(CFLAGS) $(CFLAGS_c) $(OBJ_CFLAGS)
 524 RULE_c          = $(Q)$(COMPILE_c) -c $< -o $@ $(POST_O)
 525 RULE_c_to_dbg%.o = $(Q)$(COMPILE_c) -DDBGLVL_MAX=$* -c $< -o $@ $(POST_O)
 526 RULE_c_to_c     = $(Q)$(COMPILE_c) -E -c $< > $@
 527 RULE_c_to_s     = $(Q)$(COMPILE_c) -S -g0 -c $< -o $@
 528
 529 PREPROCESS_S    = $(CPP) $(CFLAGS) $(CFLAGS_S) $(OBJ_CFLAGS)
 530 ASSEMBLE_S      = $(AS) $(ASFLAGS)
 531 RULE_S          = $(Q)$(PREPROCESS_S) $< | $(ASSEMBLE_S) -o $@
 532 RULE_S_to_dbg%.o = $(Q)$(PREPROCESS_S) -DDBGLVL_MAX=$* $< | $(ASSEMBLE_S) -o $@
 533 RULE_S_to_s     = $(Q)$(PREPROCESS_S) $< > $@
 534
 535 DEBUG_TARGETS   += dbg%.o c s
 536
 537 # List of embedded images included in the last build of embedded.o.
 538 # This is needed in order to correctly rebuild embedded.o whenever the
 539 # list of objects changes.
 540 #
 541 EMBED           := $(EMBEDDED_IMAGE) # Maintain backwards compatibility
 542 EMBEDDED_LIST   := $(BIN)/.embedded.list
 543 ifeq ($(wildcard $(EMBEDDED_LIST)),)
 544 EMBED_OLD := <invalid>
 545 else
 546 EMBED_OLD := $(shell cat $(EMBEDDED_LIST))
 547 endif
 548 ifneq ($(EMBED_OLD),$(EMBED))
 549 $(shell $(ECHO) "$(EMBED)" > $(EMBEDDED_LIST))
 550 endif
 551
 552 $(EMBEDDED_LIST) : $(MAKEDEPS)
 553
 554 VERYCLEANUP     += $(EMBEDDED_LIST)
 555
 556 EMBEDDED_FILES  := $(subst $(COMMA), ,$(EMBED))
 557 EMBED_ALL       := $(foreach i,$(call seq,1,$(words $(EMBEDDED_FILES))),\
 558                      EMBED ( $(i), \"$(word $(i), $(EMBEDDED_FILES))\",\
 559                              \"$(notdir $(word $(i),$(EMBEDDED_FILES)))\" ))
 560
 561 embedded_DEPS += $(EMBEDDED_FILES) $(EMBEDDED_LIST)
 562
 563 CFLAGS_embedded = -DEMBED_ALL="$(EMBED_ALL)"
 564
 565 # List of trusted root certificates
 566 #
 567 TRUSTED_LIST    := $(BIN)/.trusted.list
 568 ifeq ($(wildcard $(TRUSTED_LIST)),)
 569 TRUST_OLD := <invalid>
 570 else
 571 TRUST_OLD := $(shell cat $(TRUSTED_LIST))
 572 endif
 573 ifneq ($(TRUST_OLD),$(TRUST))
 574 $(shell $(ECHO) "$(TRUST)" > $(TRUSTED_LIST))
 575 endif
 576
 577 $(TRUSTED_LIST) : $(MAKEDEPS)
 578
 579 VERYCLEANUP     += $(TRUSTED_LIST)
 580
 581 # Trusted root certificate fingerprints
 582 #
 583 TRUSTED_CERTS   := $(subst $(COMMA), ,$(TRUST))
 584 TRUSTED_FPS     := $(foreach CERT,$(TRUSTED_CERTS),\
 585                      0x$(subst :,$(COMMA) 0x,$(lastword $(subst =, ,\
 586                          $(shell $(OPENSSL) x509 -in $(CERT) -noout -sha256 \
 587                                  -fingerprint))))$(COMMA))
 588
 589 rootcert_DEPS += $(TRUSTED_FILES) $(TRUSTED_LIST)
 590
 591 CFLAGS_rootcert = $(if $(TRUSTED_FPS),-DTRUSTED="$(TRUSTED_FPS)")
 592
 593 # List of embedded certificates
 594 #
 595 CERT_LIST := $(BIN)/.certificate.list
 596 ifeq ($(wildcard $(CERT_LIST)),)
 597 CERT_OLD := <invalid>
 598 else
 599 CERT_OLD := $(shell cat $(CERT_LIST))
 600 endif
 601 ifneq ($(CERT_OLD),$(CERT))
 602 $(shell $(ECHO) "$(CERT)" > $(CERT_LIST))
 603 endif
 604
 605 $(CERT_LIST) : $(MAKEDEPS)
 606
 607 VERYCLEANUP += $(CERT_LIST)
 608
 609 # Embedded certificates concatenated and then split into one file per
 610 # certificate (even if original files contained certificate chains)
 611 #
 612 CERT_FILES := $(subst $(COMMA), ,$(CERT))
 613 CERT_CONCAT := $(BIN)/.certificates.pem
 614
 615 ifneq ($(CERT),)
 616
 617 CERT_COUNT := $(shell grep "BEGIN CERTIFICATE" $(CERT_FILES) | wc -l)
 618
 619 $(CERT_CONCAT) : $(CERT_FILES) $(CERT_LIST)
 620         $(Q)cat $(CERT_FILES) > $@
 621
 622 # We must use an (otherwise unnecessary) pattern rule here to encode
 623 # the fact that one "csplit" command generates multiple targets
 624 CERT_PEMS := $(foreach i,$(call seq,1,$(CERT_COUNT)),\
 625                $(BIN)/.certificate.pem.$(i))
 626 $(subst .pem.,.%.,$(CERT_PEMS)) : $(BIN)/.certificates.%
 627         $(Q)$(CSPLIT) -q -n 1 -f $(BIN)/.certificate.pem. $< \
 628                 '/BEGIN CERTIFICATE/' '{*}'
 629
 630 CERT_DERS := $(subst .certificate.pem.,.certificate.der.,$(CERT_PEMS))
 631 $(BIN)/.certificate.der.% : $(BIN)/.certificate.pem.%
 632         $(Q)$(OPENSSL) x509 -in $< -outform DER -out $@
 633
 634 CERT_ALL := $(foreach i,$(call seq,1,$(CERT_COUNT)),\
 635               CERT ( $(i), \"$(word $(i),$(CERT_DERS))\" ))
 636
 637 endif
 638
 639 certstore_DEPS += $(CERT_LIST) $(CERT_FILES) $(CERT_PEMS) $(CERT_DERS)
 640
 641 CFLAGS_certstore += -DCERT_ALL="$(CERT_ALL)"
 642
 643 CLEANUP += $(BIN)/.certificate.* $(BIN)/.certificates.*
 644
 645 # (Single-element) list of private keys
 646 #
 647 ifdef KEY
 648 PRIVKEY := $(KEY) # Maintain backwards compatibility
 649 endif
 650 PRIVKEY_LIST := $(BIN)/.private_key.list
 651 ifeq ($(wildcard $(PRIVKEY_LIST)),)
 652 PRIVKEY_OLD := <invalid>
 653 else
 654 PRIVKEY_OLD := $(shell cat $(PRIVKEY_LIST))
 655 endif
 656 ifneq ($(PRIVKEY_OLD),$(PRIVKEY))
 657 $(shell $(ECHO) "$(PRIVKEY)" > $(PRIVKEY_LIST))
 658 endif
 659
 660 $(PRIVKEY_LIST) : $(MAKEDEPS)
 661
 662 VERYCLEANUP += $(PRIVKEY_LIST)
 663
 664 # Embedded private key
 665 #
 666 PRIVKEY_INC := $(BIN)/.private_key.der
 667
 668 ifdef PRIVKEY
 669 $(PRIVKEY_INC) : $(PRIVKEY) $(PRIVKEY_LIST)
 670         $(Q)$(OPENSSL) rsa -in $< -outform DER -out $@
 671
 672 privkey_DEPS += $(PRIVKEY_INC)
 673 endif
 674
 675 CLEANUP += $(BIN)/.private_key.*
 676
 677 privkey_DEPS += $(PRIVKEY_LIST)
 678
 679 CFLAGS_privkey += $(if $(PRIVKEY),-DPRIVATE_KEY="\"$(PRIVKEY_INC)\"")
 680
 681 # (Single-element) list of named configurations
 682 #
 683 CONFIG_LIST := $(BIN)/.config.list
 684 ifeq ($(wildcard $(CONFIG_LIST)),)
 685 CONFIG_OLD := <invalid>
 686 else
 687 CONFIG_OLD := $(shell cat $(CONFIG_LIST))
 688 endif
 689 ifneq ($(CONFIG_OLD),$(CONFIG))
 690 $(shell $(ECHO) "$(CONFIG)" > $(CONFIG_LIST))
 691 endif
 692
 693 $(CONFIG_LIST) : $(MAKEDEPS)
 694
 695 VERYCLEANUP += $(CONFIG_LIST)
 696
 697 # Named configurations
 698 #
 699 ifneq ($(CONFIG),)
 700 ifneq ($(wildcard config/$(CONFIG)),)
 701 CFLAGS  += -DCONFIG=$(CONFIG)
 702 endif
 703 CFLAGS  += -DLOCAL_CONFIG=$(CONFIG)
 704 endif
 705
 706 config/named.h : $(CONFIG_LIST)
 707         $(Q)$(TOUCH) $@
 708
 709 .PRECIOUS : config/named.h
 710
 711 # These files use .incbin inline assembly to include a binary file.
 712 # Unfortunately ccache does not detect this dependency and caches
 713 # builds even when the binary file has changed.
 714 #
 715 $(BIN)/embedded.% : override CC := env CCACHE_DISABLE=1 $(CC)
 716 $(BIN)/certstore.% : override CC := env CCACHE_DISABLE=1 $(CC)
 717 $(BIN)/privkey.% : override CC := env CCACHE_DISABLE=1 $(CC)
 718
 719 # Debug message autocolourisation range
 720 #
 721 DBGCOL_LIST     := $(BIN)/.dbgcol.list
 722 ifeq ($(wildcard $(DBGCOL_LIST)),)
 723 DBGCOL_OLD := <invalid>
 724 else
 725 DBGCOL_OLD := $(shell cat $(DBGCOL_LIST))
 726 endif
 727 ifneq ($(DBGCOL_OLD),$(DBGCOL))
 728 $(shell $(ECHO) "$(DBGCOL)" > $(DBGCOL_LIST))
 729 endif
 730
 731 $(DBGCOL_LIST) : $(MAKEDEPS)
 732
 733 VERYCLEANUP += $(DBGCOL_LIST)
 734
 735 DBGCOL_COLOURS := $(subst -, ,$(DBGCOL))
 736 DBGCOL_MIN := $(word 1,$(DBGCOL_COLOURS))
 737 DBGCOL_MAX := $(word 2,$(DBGCOL_COLOURS))
 738
 739 debug_DEPS += $(DBGCOL_LIST)
 740
 741 CFLAGS_debug += $(if $(DBGCOL_MIN),-DDBGCOL_MIN=$(DBGCOL_MIN))
 742 CFLAGS_debug += $(if $(DBGCOL_MAX),-DDBGCOL_MAX=$(DBGCOL_MAX))
 743
 744 # We automatically generate rules for any file mentioned in AUTO_SRCS
 745 # using the following set of templates.  We use $(eval ...) if
 746 # available, otherwise we generate separate Makefile fragments and
 747 # include them.
 748
 749 # deps_template : generate dependency list for a given source file
 750 #
 751 # $(1) is the full path to the source file (e.g. "drivers/net/rtl8139.c")
 752 #
 753 define deps_template_file
 754 $(call deps_template_parts,$(1),$(subst .,,$(suffix $(1))),$(basename $(notdir $(1))))
 755 endef
 756 #
 757 # $(1) is the full path to the source file (e.g. "drivers/net/rtl8139.c")
 758 # $(2) is the source type (e.g. "c")
 759 # $(3) is the source base name (e.g. "rtl8139")
 760 #
 761 define deps_template_parts
 762         @$(ECHO) "  [DEPS] $(1)"
 763         @$(MKDIR) -p $(BIN)/deps/$(dir $(1))
 764         $(Q)$(CPP) $(CFLAGS) $(CFLAGS_$(2)) $(CFLAGS_$(3)) -DOBJECT=$(3) \
 765                 -Wno-error -M $(1) -MG -MP | \
 766                 sed 's/\.o\s*:/_DEPS +=/' > $(BIN)/deps/$(1).d
 767         $(Q)$(if $(findstring drivers/,$(1)),\
 768            $(PERL) $(PARSEROM) $(1) >> $(BIN)/deps/$(1).d)
 769 endef
 770
 771 # rules_template : generate rules for a given source file
 772 #
 773 # $(1) is the full path to the source file (e.g. "drivers/net/rtl8139.c")
 774 #
 775 define rules_template
 776 $(call rules_template_parts,$(1),$(subst .,,$(suffix $(1))),$(basename $(notdir $(1))))
 777 endef
 778 #
 779 # $(1) is the full path to the source file (e.g. "drivers/net/rtl8139.c")
 780 # $(2) is the source type (e.g. "c")
 781 # $(3) is the source base name (e.g. "rtl8139")
 782 #
 783 define rules_template_parts
 784 $$(BIN)/$(3).o : $(1) $$(MAKEDEPS) $$(POST_O_DEPS) $$($(3)_DEPS)
 785         $$(QM)$(ECHO) "  [BUILD] $$@"
 786         $$(RULE_$(2))
 787 BOBJS += $$(BIN)/$(3).o
 788 $(foreach TGT,$(DEBUG_TARGETS),$(if $(RULE_$(2)_to_$(TGT)),$(NEWLINE)$(call rules_template_target,$(1),$(2),$(3),$(TGT))))
 789 $$(BIN)/deps/$(1).d : $$($(3)_DEPS)
 790 TAGS : $$($(3)_DEPS)
 791 endef
 792 #
 793 # $(1) is the full path to the source file (e.g. "drivers/net/rtl8139.c")
 794 # $(2) is the source type (e.g. "c")
 795 # $(3) is the source base name (e.g. "rtl8139")
 796 # $(4) is the destination type (e.g. "dbg%.o")
 797 #
 798 define rules_template_target
 799 $$(BIN)/$(3).$(4) : $(1) $$(MAKEDEPS) $$(POST_O_DEPS) $$($(3)_DEPS)
 800         $$(QM)$(ECHO) "  [BUILD] $$@"
 801         $$(RULE_$(2)_to_$(4))
 802 $(TGT)_OBJS += $$(BIN)/$(3).$(4)
 803 endef
 804 #
 805 # $(1) is the full path to the source file (e.g. "drivers/net/rtl8139.c")
 806 #
 807 define rules_template_file
 808         @$(ECHO) "  [RULES] $(1)"
 809         @$(MKDIR) -p $(BIN)/rules/$(dir $(1))
 810         @$(ECHO_E) '$(subst $(NEWLINE),\n,$(call rules_template,$(1)))' \
 811                  > $(BIN)/rules/$(1).r
 812 endef
 813
 814 # Generate the dependency files
 815 #
 816 $(BIN)/deps/%.d : % $(MAKEDEPS) $(PARSEROM)
 817         $(call deps_template_file,$<)
 818
 819 # Calculate list of dependency files
 820 #
 821 AUTO_DEPS       = $(patsubst %,$(BIN)/deps/%.d,$(AUTO_SRCS))
 822 autodeps :
 823         @$(ECHO) $(AUTO_DEPS)
 824 VERYCLEANUP     += $(BIN)/deps
 825
 826 # Include dependency files
 827 #
 828 ifdef NEED_DEPS
 829 ifneq ($(AUTO_DEPS),)
 830 -include $(AUTO_DEPS)
 831 endif
 832 endif
 833
 834 # Generate the rules files
 835 #
 836 $(BIN)/rules/%.r : % $(MAKEDEPS)
 837         $(call rules_template_file,$<)
 838
 839 # Calculate list of rules files
 840 #
 841 AUTO_RULES      = $(patsubst %,$(BIN)/rules/%.r,$(AUTO_SRCS))
 842 autorules :
 843         @$(ECHO) $(AUTO_RULES)
 844 VERYCLEANUP     += $(BIN)/rules
 845
 846 # Evaluate rules (or include rules files)
 847 #
 848 ifdef NEED_DEPS
 849 ifneq ($(AUTO_RULES),)
 850 ifneq ($(HAVE_EVAL),)
 851 $(foreach SRC,$(AUTO_SRCS),$(eval $(call rules_template,$(SRC))))
 852 else
 853 -include $(AUTO_RULES)
 854 endif
 855 endif
 856 endif
 857
 858 # The following variables are created by the rules files
 859 #
 860 bobjs :
 861         @$(ECHO) $(BOBJS)
 862 drivers :
 863         @$(ECHO) $(DRIVERS)
 864 .PHONY : drivers
 865 roms :
 866         @$(ECHO) $(ROMS)
 867
 868 # Generate error usage information
 869 #
 870 $(BIN)/%.einfo : $(BIN)/%.o
 871         $(QM)$(ECHO) "  [EINFO] $@"
 872         $(Q)$(OBJCOPY) -O binary -j .einfo --set-section-flags .einfo=alloc \
 873                 $< $@
 874
 875 EINFOS          := $(patsubst $(BIN)/%.o,$(BIN)/%.einfo,$(BOBJS))
 876 $(BIN)/errors : $(EINFOS) $(EINFO)
 877         $(QM)$(ECHO) "  [EINFO] $@"
 878         $(Q)$(EINFO) $(EINFOS) | sort > $@
 879 CLEANUP         += $(BIN)/errors        # Doesn't match the $(BIN)/*.* pattern
 880
 881 # Generate the NIC file from the parsed source files.  The NIC file is
 882 # only for rom-o-matic.
 883 #
 884 $(BIN)/NIC : $(AUTO_DEPS)
 885         @$(ECHO) '# This is an automatically generated file, do not edit' > $@
 886         @$(ECHO) '# It does not affect anything in the build, ' \
 887              'it is only for rom-o-matic' >> $@
 888         @$(ECHO) >> $@
 889         @perl -ne 'chomp; print "$$1\n" if /\# NIC\t(.*)$$/' $^ >> $@
 890 CLEANUP         += $(BIN)/NIC   # Doesn't match the $(BIN)/*.* pattern
 891
 892 # Analyse a target name (e.g. "bin/dfe538--prism2_pci.rom.tmp") and
 893 # derive the variables:
 894 #
 895 # TGT_ELEMENTS : the elements of the target (e.g. "dfe538 prism2_pci")
 896 # TGT_PREFIX   : the prefix type (e.g. "pcirom")
 897 # TGT_DRIVERS  : the driver for each element (e.g. "rtl8139 prism2_pci")
 898 # TGT_ROM_NAME : the ROM name (e.g. "dfe538")
 899 #
 900 DRIVERS_ipxe    = $(DRIVERS)
 901 CARD_DRIVER     = $(firstword $(DRIVER_$(1)) $(1))
 902 TGT_ELEMENTS    = $(subst --, ,$(firstword $(subst ., ,$(notdir $@))))
 903 TGT_ROM_NAME    = $(firstword $(TGT_ELEMENTS))
 904 TGT_DRIVERS     = $(strip $(if $(DRIVERS_$(TGT_ROM_NAME)), \
 905                                $(DRIVERS_$(TGT_ROM_NAME)), \
 906                                $(foreach TGT_ELEMENT,$(TGT_ELEMENTS), \
 907                                  $(call CARD_DRIVER,$(TGT_ELEMENT))) ))
 908 TGT_PREFIX_NAME = $(word 2,$(subst ., ,$(notdir $@)))
 909 TGT_PREFIX      = $(strip $(if $(filter rom,$(TGT_PREFIX_NAME)), \
 910                                $(ROM_TYPE_$(TGT_ROM_NAME))rom, \
 911                                $(TGT_PREFIX_NAME)))
 912
 913 # Look up ROM IDs for the current target
 914 # (e.g. "bin/dfe538--prism2_pci.rom.tmp") and derive the variables:
 915 #
 916 # TGT_PCI_VENDOR : the PCI vendor ID (e.g. "0x1186")
 917 # TGT_PCI_DEVICE : the PCI device ID (e.g. "0x1300")
 918 #
 919 TGT_PCI_VENDOR  = $(PCI_VENDOR_$(TGT_ROM_NAME))
 920 TGT_PCI_DEVICE  = $(PCI_DEVICE_$(TGT_ROM_NAME))
 921
 922 # Calculate link-time options for the current target
 923 # (e.g. "bin/dfe538--prism2_pci.rom.tmp") and derive the variables:
 924 #
 925 # TGT_LD_DRIVERS : symbols to require in order to drag in the relevant drivers
 926 #                  (e.g. "obj_rtl8139 obj_prism2_pci")
 927 # TGT_LD_IDS :     symbols to define in order to fill in ID structures in the
 928 #                  ROM header (e.g."pci_vendor_id=0x1186 pci_device_id=0x1300")
 929 #
 930 TGT_LD_DRIVERS  = $(subst -,_,$(patsubst %,obj_%,$(TGT_DRIVERS)))
 931 TGT_LD_IDS      = pci_vendor_id=$(firstword $(TGT_PCI_VENDOR) 0) \
 932                   pci_device_id=$(firstword $(TGT_PCI_DEVICE) 0)
 933 TGT_LD_ENTRY    = _$(TGT_PREFIX)_start
 934
 935 # Calculate linker flags based on link-time options for the current
 936 # target type (e.g. "bin/dfe538--prism2_pci.rom.tmp") and derive the
 937 # variables:
 938 #
 939 # TGT_LD_FLAGS : target-specific flags to pass to linker (e.g.
 940 #                "-u obj_zpciprefix -u obj_rtl8139 -u obj_prism2_pci
 941 #                 --defsym pci_vendor=0x1186 --defsym pci_device=0x1300")
 942 #
 943 TGT_LD_FLAGS    = $(foreach SYM,$(TGT_LD_ENTRY) $(TGT_LD_DRIVERS) obj_config,\
 944                     -u $(SYM) --defsym check_$(SYM)=$(SYM) ) \
 945                   $(patsubst %,--defsym %,$(TGT_LD_IDS)) \
 946                   -e $(TGT_LD_ENTRY)
 947
 948 # Calculate list of debugging versions of objects to be included in
 949 # the target.
 950 #
 951 DEBUG_LIST      = $(subst $(COMMA), ,$(DEBUG))
 952 DEBUG_OBJ_LEVEL = $(firstword $(word 2,$(subst :, ,$(1))) 1)
 953 DEBUG_OBJ_BASE  = $(word 1,$(subst :, ,$(1))).dbg$(call DEBUG_OBJ_LEVEL,$(1))
 954 DEBUG_OBJ       = $(BIN)/$(call DEBUG_OBJ_BASE,$(1)).o
 955 DEBUG_ORIG_OBJ  = $(BIN)/$(word 1,$(subst :, ,$(1))).o
 956 DEBUG_OBJS      = $(foreach D,$(DEBUG_LIST),$(call DEBUG_OBJ,$(D)))
 957 DEBUG_ORIG_OBJS = $(foreach D,$(DEBUG_LIST),$(call DEBUG_ORIG_OBJ,$(D)))
 958 BLIB_OBJS       = $(DEBUG_OBJS) $(filter-out $(DEBUG_ORIG_OBJS),$(BOBJS))
 959
 960 # Print out all derived information for a given target.
 961 #
 962 $(BIN)/%.info :
 963         @$(ECHO) 'Elements             : $(TGT_ELEMENTS)'
 964         @$(ECHO) 'Prefix               : $(TGT_PREFIX)'
 965         @$(ECHO) 'Drivers              : $(TGT_DRIVERS)'
 966         @$(ECHO) 'ROM name             : $(TGT_ROM_NAME)'
 967         @$(ECHO)
 968         @$(ECHO) 'PCI vendor           : $(TGT_PCI_VENDOR)'
 969         @$(ECHO) 'PCI device           : $(TGT_PCI_DEVICE)'
 970         @$(ECHO)
 971         @$(ECHO) 'LD driver symbols    : $(TGT_LD_DRIVERS)'
 972         @$(ECHO) 'LD ID symbols        : $(TGT_LD_IDS)'
 973         @$(ECHO) 'LD entry point       : $(TGT_LD_ENTRY)'
 974         @$(ECHO)
 975         @$(ECHO) 'LD target flags      : $(TGT_LD_FLAGS)'
 976         @$(ECHO)
 977         @$(ECHO) 'Debugging objects    : $(DEBUG_OBJS)'
 978         @$(ECHO) 'Replaced objects     : $(DEBUG_ORIG_OBJS)'
 979
 980 # List of objects included in the last build of blib.  This is needed
 981 # in order to correctly rebuild blib whenever the list of objects
 982 # changes.
 983 #
 984 BLIB_LIST       := $(BIN)/.blib.list
 985 ifeq ($(wildcard $(BLIB_LIST)),)
 986 BLIB_OBJS_OLD   := <invalid>
 987 else
 988 BLIB_OBJS_OLD   := $(shell cat $(BLIB_LIST))
 989 endif
 990 ifneq ($(BLIB_OBJS_OLD),$(BLIB_OBJS))
 991 $(shell $(ECHO) "$(BLIB_OBJS)" > $(BLIB_LIST))
 992 endif
 993
 994 $(BLIB_LIST) : $(MAKEDEPS)
 995
 996 VERYCLEANUP     += $(BLIB_LIST)
 997
 998 # Library of all objects
 999 #
1000 BLIB            = $(BIN)/blib.a
1001 $(BLIB) : $(BLIB_OBJS) $(BLIB_LIST) $(MAKEDEPS)
1002         $(Q)$(RM) $(BLIB)
1003         $(QM)$(ECHO) "  [AR] $@"
1004         $(Q)$(AR) r $@ $(sort $(BLIB_OBJS))
1005         $(Q)$(RANLIB) $@
1006 blib : $(BLIB)
1007
1008 # Command to generate build ID.  Must be unique for each $(BIN)/%.tmp,
1009 # even within the same build run.
1010 #
1011 BUILD_ID_CMD    := perl -e 'printf "0x%08x", int ( rand ( 0xffffffff ) );'
1012
1013 # Build timestamp
1014 #
1015 BUILD_TIMESTAMP := $(shell date +%s)
1016
1017 # Build version
1018 #
1019 GIT_INDEX := $(if $(GITVERSION),$(if $(wildcard ../.git/index),../.git/index))
1020 $(BIN)/version.%.o : core/version.c $(MAKEDEPS) $(GIT_INDEX)
1021         $(QM)$(ECHO) "  [VERSION] $@"
1022         $(Q)$(COMPILE_c) -DBUILD_NAME="\"$*\"" \
1023                 -DVERSION_MAJOR=$(VERSION_MAJOR) \
1024                 -DVERSION_MINOR=$(VERSION_MINOR) \
1025                 -DVERSION_PATCH=$(VERSION_PATCH) \
1026                 -DVERSION="\"$(VERSION)\"" \
1027                 -c $< -o $@
1028
1029 # Build an intermediate object file from the objects required for the
1030 # specified target.
1031 #
1032 $(BIN)/%.tmp : $(BIN)/version.%.o $(BLIB) $(MAKEDEPS) $(LDSCRIPT)
1033         $(QM)$(ECHO) "  [LD] $@"
1034         $(Q)$(LD) $(LDFLAGS) -T $(LDSCRIPT) $(TGT_LD_FLAGS) $< $(BLIB) -o $@ \
1035                 --defsym _build_id=`$(BUILD_ID_CMD)` \
1036                 --defsym _build_timestamp=$(BUILD_TIMESTAMP) \
1037                 -Map $(BIN)/$*.tmp.map
1038         $(Q)$(OBJDUMP) -ht $@ | $(PERL) $(SORTOBJDUMP) >> $(BIN)/$*.tmp.map
1039
1040 # Keep intermediate object file (useful for debugging)
1041 .PRECIOUS : $(BIN)/%.tmp
1042
1043 # Show a linker map for the specified target
1044 #
1045 $(BIN)/%.map : $(BIN)/%.tmp
1046         @less $(BIN)/$*.tmp.map
1047
1048 # Get objects list for the specified target
1049 #
1050 define objs_list
1051         $(sort $(foreach OBJ_SYMBOL,\
1052                  $(filter obj_%,$(shell $(NM) $(1) | cut -d" " -f3)),\
1053                  $(patsubst obj_%,%,$(OBJ_SYMBOL))))
1054 endef
1055 $(BIN)/%.objs : $(BIN)/%.tmp
1056         $(Q)$(ECHO) $(call objs_list,$<)
1057 $(BIN)/%.sizes : $(BIN)/%.tmp
1058         $(Q)$(SIZE) -t $(foreach OBJ,$(call objs_list,$<),$(wildcard $(BIN)/$(subst _,?,$(OBJ)).o)) | \
1059                 sort -g
1060
1061 # Get dependency list for the specified target
1062 #
1063 define deps_list
1064         $(sort $(foreach OBJ,$(call objs_list,$(1)),$($(OBJ)_DEPS)))
1065 endef
1066 $(BIN)/%.deps : $(BIN)/%.tmp
1067         $(Q)$(ECHO) $(call deps_list,$<)
1068
1069 # Get unneeded source files for the specified target
1070 #
1071 define nodeps_list
1072         $(sort $(filter-out $(call deps_list,$(1)),\
1073                  $(foreach BOBJ,$(BOBJS),\
1074                    $($(basename $(notdir $(BOBJ)))_DEPS))))
1075 endef
1076 $(BIN)/%.nodeps : $(BIN)/%.tmp
1077         $(Q)$(ECHO) $(call nodeps_list,$<)
1078
1079 # Get licensing verdict for the specified target
1080 #
1081 define licensable_deps_list
1082         $(filter-out config/local/%.h,\
1083           $(filter-out $(BIN)/.%.list,\
1084             $(call deps_list,$(1))))
1085 endef
1086 define unlicensed_deps_list
1087         $(shell grep -L FILE_LICENCE $(call licensable_deps_list,$(1)))
1088 endef
1089 define licence_list
1090         $(sort $(foreach LICENCE,\
1091                  $(filter __licence__%,$(shell $(NM) $(1) | cut -d" " -f3)),\
1092                  $(word 2,$(subst __, ,$(LICENCE)))))
1093 endef
1094 $(BIN)/%.licence_list : $(BIN)/%.tmp
1095         $(Q)$(ECHO) $(call licence_list,$<)
1096 $(BIN)/%.licence : $(BIN)/%.tmp
1097         $(QM)$(ECHO) "  [LICENCE] $@"
1098         $(Q)$(if $(strip $(call unlicensed_deps_list,$<)),\
1099                 echo -n "Unable to determine licence because the following " ;\
1100                 echo "files are missing a licence declaration:" ;\
1101                 echo $(call unlicensed_deps_list,$<);\
1102                 exit 1,\
1103                 $(PERL) $(LICENCE) $(call licence_list,$<))
1104
1105 # Extract compression information from intermediate object file
1106 #
1107 $(BIN)/%.zinfo : $(BIN)/%.tmp
1108         $(QM)$(ECHO) "  [ZINFO] $@"
1109         $(Q)$(OBJCOPY) -O binary -j .zinfo $< $@
1110
1111 # Build raw binary file from intermediate object file
1112 #
1113 $(BIN)/%.bin : $(BIN)/%.tmp
1114         $(QM)$(ECHO) "  [BIN] $@"
1115         $(Q)$(OBJCOPY) -O binary -R .zinfo $< $@
1116
1117 # Compress raw binary file
1118 #
1119 $(BIN)/%.zbin : $(BIN)/%.bin $(BIN)/%.zinfo $(ZBIN)
1120         $(QM)$(ECHO) "  [ZBIN] $@"
1121         $(Q)$(ZBIN) $(BIN)/$*.bin $(BIN)/$*.zinfo > $@
1122
1123 # Rules for each media format.  These are generated and placed in an
1124 # external Makefile fragment.  We could do this via $(eval ...), but
1125 # that would require make >= 3.80.
1126 #
1127 # Note that there's an alternative way to generate most .rom images:
1128 # they can be copied from their 'master' ROM image using cp and
1129 # reprocessed with makerom to add the PCI IDs and ident string.  The
1130 # relevant rule would look something like:
1131 #
1132 #   $(BIN)/dfe538%rom : $(BIN)/rtl8139%rom
1133 #       cat $< $@
1134 #       $(FINALISE_rom)
1135 #
1136 # You can derive the ROM/driver relationships using the variables
1137 # DRIVER_<rom> and/or ROMS_<driver>.
1138 #
1139 # We don't currently do this, because (a) it would require generating
1140 # yet more Makefile fragments (since you need a rule for each ROM in
1141 # ROMS), and (b) the linker is so fast that it probably wouldn't make
1142 # much difference to the overall build time.
1143
1144 # Add NON_AUTO_MEDIA to the media list, so that they show up in the
1145 # output of "make"
1146 #
1147 MEDIA           += $(NON_AUTO_MEDIA)
1148
1149 media :
1150         @$(ECHO) $(MEDIA)
1151
1152 AUTO_MEDIA      = $(filter-out $(NON_AUTO_MEDIA),$(MEDIA))
1153 automedia :
1154         @$(ECHO) $(AUTO_MEDIA)
1155
1156 # media_template : create media rules
1157 #
1158 # $(1) is the media name (e.g. "rom")
1159 #
1160 define media_template
1161 $(if $(filter $(1),$(AUTO_MEDIA)),$(call auto_media_template,$(1)))
1162 LIST_$(1) := $$(if $$(LIST_NAME_$(1)),$$($$(LIST_NAME_$(1))),$$(DRIVERS))
1163 ALL_$(1) = $$(foreach ITEM,$$(LIST_$(1)),$$(BIN)/$$(ITEM).$(1))
1164 $$(BIN)/all$(1)s : $$(ALL_$(1))
1165 $$(BIN)/allall : $$(BIN)/all$(1)s
1166 all$(1)s : $$(BIN)/all$(1)s
1167 allall : $$(BIN)/allall
1168 endef
1169 #
1170 # $(1) is the media name (e.g. "rom")
1171 #
1172 define auto_media_template
1173 $$(BIN)/%.$(1) : $$(BIN)/%.$(1).zbin
1174         $$(QM)echo "  [FINISH] $$@"
1175         $$(Q)$$(CP) $$< $$@
1176         $$(Q)$$(if $$(PAD_$(1)),$$(PAD_$(1)) $$@)
1177         $$(Q)$$(if $$(FINALISE_$(1)),$$(FINALISE_$(1)) $$@)
1178 endef
1179 #
1180 # $(1) is the media name (e.g. "rom")
1181 #
1182 define media_template_file
1183         @$(ECHO) "  [MEDIARULES] $(1)"
1184         @$(MKDIR) -p $(BIN)/rules/$(dir $(1))
1185         @$(ECHO_E) '$(subst $(NEWLINE),\n,$(call media_template,$(1)))' \
1186                 > $(BIN)/rules/$(1).media.r
1187 endef
1188
1189 # Generate media rules files
1190 #
1191 $(BIN)/rules/%.media.r : $(MAKEDEPS)
1192         $(call media_template_file,$*)
1193
1194 # Calculate list of media rules files
1195 #
1196 MEDIA_RULES             = $(patsubst %,$(BIN)/rules/%.media.r,$(MEDIA))
1197 mediarules :
1198         @$(ECHO) $(MEDIA_RULES)
1199
1200 # Evaluate media rules (or include media rules files)
1201 #
1202 ifdef NEED_DEPS
1203 ifneq ($(MEDIA_RULES),)
1204 ifneq ($(HAVE_EVAL),)
1205 $(foreach MEDIUM,$(MEDIA),$(eval $(call media_template,$(MEDIUM))))
1206 else
1207 -include $(MEDIA_RULES)
1208 endif
1209 endif
1210 endif
1211
1212 # Alias for ipxe.%
1213 #
1214 $(BIN)/etherboot.% : $(BIN)/ipxe.%
1215         ln -sf $(notdir $<) $@
1216
1217 endif # defined(BIN)
1218
1219 ###############################################################################
1220 #
1221 # The compression utilities
1222 #
1223
1224 ZBIN_LDFLAGS := -llzma
1225
1226 $(ZBIN) : util/zbin.c $(MAKEDEPS)
1227         $(QM)$(ECHO) "  [HOSTCC] $@"
1228         $(Q)$(HOST_CC) $(HOST_CFLAGS) $< $(ZBIN_LDFLAGS) -o $@
1229 CLEANUP += $(ZBIN)
1230
1231 ###############################################################################
1232 #
1233 # The EFI image converter
1234 #
1235 ELF2EFI_CFLAGS  := -I$(BINUTILS_DIR)/include -I$(BFD_DIR)/include \
1236                    -I$(ZLIB_DIR)/include -idirafter include
1237 ELF2EFI_LDFLAGS := -L$(BINUTILS_DIR)/lib -L$(BFD_DIR)/lib -L$(ZLIB_DIR)/lib \
1238                    -lbfd -ldl -liberty -lz -Wl,--no-warn-search-mismatch
1239
1240 $(ELF2EFI32) : util/elf2efi.c $(MAKEDEPS)
1241         $(QM)$(ECHO) "  [HOSTCC] $@"
1242         $(Q)$(HOST_CC) $(HOST_CFLAGS) $(ELF2EFI_CFLAGS) -DEFI_TARGET_IA32 $< \
1243                 $(ELF2EFI_LDFLAGS) -o $@
1244 CLEANUP += $(ELF2EFI32)
1245
1246 $(ELF2EFI64) : util/elf2efi.c $(MAKEDEPS)
1247         $(QM)$(ECHO) "  [HOSTCC] $@"
1248         $(Q)$(HOST_CC) $(HOST_CFLAGS) $(ELF2EFI_CFLAGS) -DEFI_TARGET_X64 $< \
1249                 $(ELF2EFI_LDFLAGS) -o $@
1250 CLEANUP += $(ELF2EFI64)
1251
1252 $(EFIROM) : util/efirom.c $(MAKEDEPS)
1253         $(QM)$(ECHO) "  [HOSTCC] $@"
1254         $(Q)$(HOST_CC) $(HOST_CFLAGS) -idirafter include -o $@ $<
1255 CLEANUP += $(EFIROM)
1256
1257 $(EFIFATBIN) : util/efifatbin.c $(MAKEDEPS)
1258         $(QM)$(ECHO) "  [HOSTCC] $@"
1259         $(Q)$(HOST_CC) $(HOST_CFLAGS) -idirafter include -o $@ $<
1260 CLEANUP += $(EFIFATBIN)
1261
1262 ###############################################################################
1263 #
1264 # The ICC fixup utility
1265 #
1266 $(ICCFIX) : util/iccfix.c $(MAKEDEPS)
1267         $(QM)$(ECHO) "  [HOSTCC] $@"
1268         $(Q)$(HOST_CC) $(HOST_CFLAGS) -idirafter include -o $@ $<
1269 CLEANUP += $(ICCFIX)
1270
1271 ###############################################################################
1272 #
1273 # The error usage information utility
1274 #
1275 $(EINFO) : util/einfo.c $(MAKEDEPS)
1276         $(QM)$(ECHO) "  [HOSTCC] $@"
1277         $(Q)$(HOST_CC) $(HOST_CFLAGS) -idirafter include -o $@ $<
1278 CLEANUP += $(EINFO)
1279
1280 ###############################################################################
1281 #
1282 # Local configs
1283 #
1284 CONFIG_HEADERS := $(patsubst config/%,%,$(wildcard config/*.h))
1285 CONFIG_LOCAL_HEADERS := $(foreach HEADER,$(CONFIG_HEADERS),\
1286                                   config/local/$(HEADER))
1287
1288 $(CONFIG_LOCAL_HEADERS) :
1289         $(Q)$(TOUCH) $@
1290
1291 .PRECIOUS : $(CONFIG_LOCAL_HEADERS)
1292
1293 ifneq ($(CONFIG),)
1294
1295 CONFIG_LOCAL_NAMED_HEADERS := $(foreach HEADER,$(CONFIG_HEADERS),\
1296                                         config/local/$(CONFIG)/$(HEADER))
1297
1298 $(CONFIG_LOCAL_NAMED_HEADERS) :
1299         $(Q)$(MKDIR) -p $(dir $@)
1300         $(Q)$(TOUCH) $@
1301
1302 .PRECIOUS : $(CONFIG_LOCAL_NAMED_HEADERS)
1303
1304 endif
1305
1306 ###############################################################################
1307 #
1308 # Build the TAGS file(s) for emacs
1309 #
1310 TAGS :
1311         ctags -e -R -f $@ --exclude=bin
1312
1313 CLEANUP += TAGS
1314
1315 ###############################################################################
1316 #
1317 # Force rebuild for any given target
1318 #
1319 %.rebuild :
1320         rm -f $*
1321         $(Q)$(MAKE) $*
1322
1323 ###############################################################################
1324 #
1325 # Symbol table checks
1326 #
1327
1328 ifdef BIN
1329
1330 SYMTAB  = $(BIN)/symtab
1331 $(SYMTAB) : $(BLIB)
1332         $(OBJDUMP) -w -t $< > $@
1333
1334 CLEANUP += $(BIN)/symtab
1335
1336 symcheck : $(SYMTAB)
1337         $(PERL) $(SYMCHECK) $<
1338
1339 endif # defined(BIN)
1340
1341 ###############################################################################
1342 #
1343 # Build bochs symbol table
1344 #
1345
1346 ifdef BIN
1347
1348 $(BIN)/%.bxs : $(BIN)/%.tmp
1349         $(NM) $< | cut -d" " -f1,3 > $@
1350
1351 endif # defined(BIN)
1352
1353 ###############################################################################
1354 #
1355 # Documentation
1356 #
1357
1358 ifdef BIN
1359
1360 $(BIN)/doxygen.cfg : doxygen.cfg $(MAKEDEPS)
1361         $(Q)$(PERL) -pe 's{\@SRCDIRS\@}{$(SRCDIRS)}; ' \
1362                 -e  's{\@INCDIRS\@}{$(filter-out .,$(INCDIRS))}; ' \
1363                 -e  's{\@BIN\@}{$(BIN)}; ' \
1364                 -e  's{\@ARCH\@}{$(ARCH)}; ' \
1365                 $< > $@
1366
1367 $(BIN)/doc : $(BIN)/doxygen.cfg
1368         $(Q)$(DOXYGEN) $<
1369
1370 .PHONY : $(BIN)/doc
1371
1372 doc : $(BIN)/doc
1373
1374 doc-clean :
1375         $(Q)$(RM) -r $(BIN)/doc
1376
1377 VERYCLEANUP     += $(BIN)/doc
1378
1379 docview :
1380         @[ -f $(BIN)/doc/html/index.html ] || $(MAKE) $(BIN)/doc
1381         @if [ -n "$$BROWSER" ] ; then \
1382                 ( $$BROWSER $(BIN)/doc/html/index.html & ) ; \
1383         else \
1384                 $(ECHO) "Documentation index in $(BIN)/doc/html/index.html" ; \
1385         fi
1386
1387 endif # defined(BIN)
1388
1389 ###############################################################################
1390 #
1391 # Keyboard maps
1392 #
1393
1394 hci/keymap/keymap_%.c :
1395         $(Q)$(PERL) $(GENKEYMAP) $* > $@
1396
1397 ###############################################################################
1398 #
1399 # Force deletion of incomplete targets
1400 #
1401
1402 .DELETE_ON_ERROR :
1403
1404 ###############################################################################
1405 #
1406 # Clean-up
1407 #
1408
1409 ifeq ($(NUM_BINS),0)
1410 ALLBINS         := bin{,-*}
1411 CLEANUP         := $(patsubst $(BIN)/%,$(ALLBINS)/%,$(CLEANUP))
1412 VERYCLEANUP     := $(patsubst $(BIN)/%,$(ALLBINS)/%,$(VERYCLEANUP))
1413 endif
1414
1415 clean :
1416         $(RM) $(CLEANUP)
1417
1418 veryclean : clean
1419         $(RM) -r $(VERYCLEANUP)