iPXE - Open Source Boot Firmware

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