bf16fde9361c56e313c916939dd0712f9d11cb2e
[people/meteger/gpxe.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 .toolcheck :
92         @if $(CC) -v 2>&1 | grep -is 'gcc version 2\.96' > /dev/null; then \
93                 $(ECHO) 'gcc 2.96 is unsuitable for compiling Etherboot'; \
94                 $(ECHO) 'Use gcc 2.95 or gcc 3.x instead'; \
95                 exit 1; \
96         fi
97         @if [ `perl -e 'use bytes; print chr(255)' | wc -c` = 2 ]; then \
98                 $(ECHO) 'Your Perl version has a Unicode handling bug'; \
99                 $(ECHO) 'Execute this command before compiling Etherboot:'; \
100                 $(ECHO) 'export LANG=$${LANG%.UTF-8}'; \
101                 exit 1; \
102         fi
103         @$(TOUCH) $@
104 MAKEDEPS        += .toolcheck
105 VERYCLEANUP     += .toolcheck
106
107 ###############################################################################
108 #
109 # Check for various tool workarounds
110 #
111
112 # Make syntax does not allow use of comma or space in certain places.
113 # This ugly workaround is suggested in the manual.
114 #
115 COMMA   := ,
116 EMPTY   :=
117 SPACE   := $(EMPTY) $(EMPTY)
118
119 # Check for an old version of gas (binutils 2.9.1)
120 #
121 OLDGAS  := $(shell $(AS) --version | grep -q '2\.9\.1' && $(ECHO) -DGAS291)
122 CFLAGS  += $(OLDGAS)
123 oldgas :
124         @$(ECHO) $(oldgas)
125
126 # Some widespread patched versions of gcc include -fstack-protector by
127 # default, even when -ffreestanding is specified.  We therefore need
128 # to disable -fstack-protector if the compiler supports it.
129 #
130 ifeq ($(CCTYPE),gcc)
131 SP_TEST = $(CC) -fno-stack-protector -x c -c /dev/null \
132                 -o /dev/null >/dev/null 2>&1
133 SP_FLAGS := $(shell $(SP_TEST) && $(ECHO) '-fno-stack-protector')
134 CFLAGS  += $(SP_FLAGS)
135 endif
136
137 # gcc 4.4 generates .eh_frame sections by default, which distort the
138 # output of "size".  Inhibit this.
139 #
140 ifeq ($(CCTYPE),gcc)
141 CFI_TEST = $(CC) -fno-dwarf2-cfi-asm -x c -c /dev/null \
142                  -o /dev/null >/dev/null 2>&1
143 CFI_FLAGS := $(shell $(CFI_TEST) && $(ECHO) '-fno-dwarf2-cfi-asm')
144 CFLAGS  += $(CFI_FLAGS)
145 endif
146
147 # Some versions of gas choke on division operators, treating them as
148 # comment markers.  Specifying --divide will work around this problem,
149 # but isn't available on older gas versions.
150 #
151 DIVIDE_TEST = $(AS) --divide /dev/null -o /dev/null 2>/dev/null
152 DIVIDE_FLAGS := $(shell $(DIVIDE_TEST) && $(ECHO) '--divide')
153 ASFLAGS += $(DIVIDE_FLAGS)
154
155 ###############################################################################
156 #
157 # Build verbosity
158 #
159 ifeq ($(V),1)
160 Q :=
161 QM := @\#
162 else
163 Q := @
164 QM := @
165 endif
166
167 ###############################################################################
168 #
169 # Set BIN according to whatever was specified on the command line as
170 # the build target.
171 #
172
173 # Determine how many different BIN directories are mentioned in the
174 # make goals.
175 #
176 BIN_GOALS       := $(filter bin/% bin-%,$(MAKECMDGOALS))
177 BIN_GOAL_BINS   := $(foreach BG,$(BIN_GOALS),$(firstword $(subst /, ,$(BG))))
178 NUM_BINS        := $(words $(sort $(BIN_GOAL_BINS)))
179
180 ifeq ($(NUM_BINS),0)
181
182 # No BIN directory was specified.  Set BIN to "bin" as a sensible
183 # default.
184
185 BIN             := bin
186
187 else # NUM_BINS == 0
188
189 ifeq ($(NUM_BINS),1)
190
191 # If exactly one BIN directory was specified, set BIN to match this
192 # directory.
193 #
194 BIN             := $(firstword $(BIN_GOAL_BINS))
195
196 else # NUM_BINS == 1
197
198 # More than one BIN directory was specified.  We cannot handle the
199 # latter case within a single make invocation, so set up recursive
200 # targets for each BIN directory.
201 #
202 # Leave $(BIN) undefined.  This has implications for any target that
203 # depends on $(BIN); such targets should be made conditional upon the
204 # existence of $(BIN).
205 #
206 $(BIN_GOALS) : % : BIN_RECURSE
207         $(Q)$(MAKE) --no-print-directory BIN=$(firstword $(subst /, ,$@)) $@
208 .PHONY : BIN_RECURSE
209
210 endif # NUM_BINS == 1
211 endif # NUM_BINS == 0
212
213 ifdef BIN
214
215 # Create $(BIN) directory if it doesn't exist yet
216 #
217 ifeq ($(wildcard $(BIN)),)
218 $(shell $(MKDIR) -p $(BIN))
219 endif
220
221 # Target to allow e.g. "make bin-efi arch"
222 #
223 $(BIN) :
224         @# Do nothing, silently
225 .PHONY : $(BIN)
226
227 # Remove everything in $(BIN) for a "make clean"
228 #
229 CLEANUP += $(BIN)/*.* # Avoid picking up directories
230
231 endif # defined(BIN)
232
233 # Determine whether or not we need to include the dependency files
234 #
235 NO_DEP_TARGETS  := $(BIN) clean veryclean
236 ifeq ($(MAKECMDGOALS),)
237 NEED_DEPS       := 1
238 endif
239 ifneq ($(strip $(filter-out $(NO_DEP_TARGETS),$(MAKECMDGOALS))),)
240 NEED_DEPS       := 1
241 endif
242
243 ###############################################################################
244 #
245 # Select build architecture and platform based on $(BIN)
246 #
247 # BIN has the form bin[-[arch-]platform]
248
249 ARCHS           := $(patsubst arch/%,%,$(wildcard arch/*))
250 PLATFORMS       := $(patsubst config/defaults/%.h,%,\
251                      $(wildcard config/defaults/*.h))
252 archs :
253         @$(ECHO) $(ARCHS)
254
255 platforms :
256         @$(ECHO) $(PLATFORMS)
257
258 ifdef BIN
259
260 # Determine architecture portion of $(BIN), if present
261 BIN_ARCH        := $(strip $(foreach A,$(ARCHS),\
262                              $(patsubst bin-$(A)-%,$(A),\
263                                $(filter bin-$(A)-%,$(BIN)))))
264
265 # Determine platform portion of $(BIN), if present
266 ifeq ($(BIN_ARCH),)
267 BIN_PLATFORM    := $(patsubst bin-%,%,$(filter bin-%,$(BIN)))
268 else
269 BIN_PLATFORM    := $(patsubst bin-$(BIN_ARCH)-%,%,$(BIN))
270 endif
271
272 # Determine build architecture
273 DEFAULT_ARCH    := i386
274 ARCH            := $(firstword $(BIN_ARCH) $(DEFAULT_ARCH))
275 CFLAGS          += -DARCH=$(ARCH)
276 arch :
277         @$(ECHO) $(ARCH)
278 .PHONY : arch
279
280 # Determine build platform
281 DEFAULT_PLATFORM := pcbios
282 PLATFORM        := $(firstword $(BIN_PLATFORM) $(DEFAULT_PLATFORM))
283 CFLAGS          += -DPLATFORM=$(PLATFORM)
284 platform :
285         @$(ECHO) $(PLATFORM)
286
287 endif # defined(BIN)
288
289 # Include architecture-specific Makefile
290 ifdef ARCH
291 MAKEDEPS        += arch/$(ARCH)/Makefile
292 include arch/$(ARCH)/Makefile
293 endif
294
295 # Include architecture-specific include path
296 ifdef ARCH
297 INCDIRS         += arch/$(ARCH)/include
298 endif
299
300 ###############################################################################
301 #
302 # Source file handling
303
304 # SRCDIRS lists all directories containing source files.
305 srcdirs :
306         @$(ECHO) $(SRCDIRS)
307
308 # SRCS lists all .c or .S files found in any SRCDIR
309 #
310 SRCS    += $(wildcard $(patsubst %,%/*.c,$(SRCDIRS)))
311 SRCS    += $(wildcard $(patsubst %,%/*.S,$(SRCDIRS)))
312 srcs :
313         @$(ECHO) $(SRCS)
314
315 # AUTO_SRCS lists all files in SRCS that are not mentioned in
316 # NON_AUTO_SRCS.  Files should be added to NON_AUTO_SRCS if they
317 # cannot be built using the standard build template.
318 #
319 AUTO_SRCS = $(filter-out $(NON_AUTO_SRCS),$(SRCS))
320 autosrcs :
321         @$(ECHO) $(AUTO_SRCS)
322
323 # Just about everything else in this section depends upon having
324 # $(BIN) set
325
326 ifdef BIN
327
328 # INCDIRS lists the include path
329 incdirs :
330         @$(ECHO) $(INCDIRS)
331
332 # Common flags
333 #
334 CFLAGS          += $(foreach INC,$(INCDIRS),-I$(INC))
335 CFLAGS          += -Os
336 CFLAGS          += -g
337 ifeq ($(CCTYPE),gcc)
338 CFLAGS          += -ffreestanding
339 CFLAGS          += -Wall -W -Wformat-nonliteral
340 endif
341 ifeq ($(CCTYPE),icc)
342 CFLAGS          += -fno-builtin
343 CFLAGS          += -no-ip
344 CFLAGS          += -no-gcc
345 CFLAGS          += -diag-disable 111 # Unreachable code
346 CFLAGS          += -diag-disable 128 # Unreachable loop
347 CFLAGS          += -diag-disable 170 # Array boundary checks
348 CFLAGS          += -diag-disable 177 # Unused functions
349 CFLAGS          += -diag-disable 181 # printf() format checks
350 CFLAGS          += -diag-disable 188 # enum strictness
351 CFLAGS          += -diag-disable 193 # Undefined preprocessor identifiers
352 CFLAGS          += -diag-disable 280 # switch ( constant )
353 CFLAGS          += -diag-disable 310 # K&R parameter lists
354 CFLAGS          += -diag-disable 424 # Extra semicolon
355 CFLAGS          += -diag-disable 589 # Declarations mid-code
356 CFLAGS          += -diag-disable 593 # Unused variables
357 CFLAGS          += -diag-disable 810 # Casting ints to smaller ints
358 CFLAGS          += -diag-disable 981 # Sequence point violations
359 CFLAGS          += -diag-disable 1292 # Ignored attributes
360 CFLAGS          += -diag-disable 1338 # void pointer arithmetic
361 CFLAGS          += -diag-disable 1361 # Variable-length arrays
362 CFLAGS          += -diag-disable 1418 # Missing prototypes
363 CFLAGS          += -diag-disable 1419 # Missing prototypes
364 CFLAGS          += -diag-disable 1599 # Hidden variables
365 CFLAGS          += -Wall -Wmissing-declarations
366 endif
367 CFLAGS          += $(EXTRA_CFLAGS)
368 ASFLAGS         += $(EXTRA_ASFLAGS)
369 LDFLAGS         += $(EXTRA_LDFLAGS)
370
371 # Inhibit -Werror if NO_WERROR is specified on make command line
372 #
373 ifneq ($(NO_WERROR),1)
374 CFLAGS          += -Werror
375 ASFLAGS         += --fatal-warnings
376 endif
377
378 # Function trace recorder state in the last build.  This is needed
379 # in order to correctly rebuild whenever the function recorder is
380 # enabled/disabled.
381 #
382 FNREC_STATE     := $(BIN)/.fnrec.state
383 ifeq ($(wildcard $(FNREC_STATE)),)
384 FNREC_STATE_OLD := <invalid>
385 else
386 FNREC_STATE_OLD := $(shell cat $(FNREC_STATE))
387 endif
388 ifeq ($(FNREC_STATE_OLD),$(FNREC))
389 $(FNREC_STATE) :
390 else
391 $(FNREC_STATE) : clean
392 $(shell $(ECHO) "$(FNREC)" > $(FNREC_STATE))
393 endif
394
395 VERYCLEANUP     += $(FNREC_STATE)
396 MAKEDEPS        += $(FNREC_STATE)
397
398 ifeq ($(FNREC),1)
399 # Enabling -finstrument-functions affects gcc's analysis and leads to spurious
400 # warnings about use of uninitialised variables.
401 #
402 CFLAGS          += -Wno-uninitialized
403 CFLAGS          += -finstrument-functions
404 CFLAGS          += -finstrument-functions-exclude-file-list=core/fnrec.c
405 endif
406
407 # compiler.h is needed for our linking and debugging system
408 #
409 CFLAGS          += -include compiler.h
410
411 # CFLAGS for specific object types
412 #
413 CFLAGS_c        +=
414 CFLAGS_S        += -DASSEMBLY
415
416 # Base object name of the current target
417 #
418 OBJECT          = $(firstword $(subst ., ,$(@F)))
419
420 # CFLAGS for specific object files.  You can define
421 # e.g. CFLAGS_rtl8139, and have those flags automatically used when
422 # compiling bin/rtl8139.o.
423 #
424 OBJ_CFLAGS      = $(CFLAGS_$(OBJECT)) -DOBJECT=$(subst -,_,$(OBJECT))
425 $(BIN)/%.flags :
426         @$(ECHO) $(OBJ_CFLAGS)
427
428 # ICC requires postprocessing objects to fix up table alignments
429 #
430 ifeq ($(CCTYPE),icc)
431 POST_O          = && $(ICCFIX) $@
432 POST_O_DEPS     := $(ICCFIX)
433 else
434 POST_O          :=
435 POST_O_DEPS     :=
436 endif
437
438 # Rules for specific object types.
439 #
440 COMPILE_c       = $(CC) $(CFLAGS) $(CFLAGS_c) $(OBJ_CFLAGS)
441 RULE_c          = $(Q)$(COMPILE_c) -c $< -o $@ $(POST_O)
442 RULE_c_to_dbg%.o = $(Q)$(COMPILE_c) -Ddebug_$(subst -,_,$(OBJECT))=$* -c $< -o $@ $(POST_O)
443 RULE_c_to_c     = $(Q)$(COMPILE_c) -E -c $< > $@
444 RULE_c_to_s     = $(Q)$(COMPILE_c) -S -g0 -c $< -o $@
445
446 PREPROCESS_S    = $(CPP) $(CFLAGS) $(CFLAGS_S) $(OBJ_CFLAGS)
447 ASSEMBLE_S      = $(AS) $(ASFLAGS)
448 RULE_S          = $(Q)$(PREPROCESS_S) $< | $(ASSEMBLE_S) -o $@
449 RULE_S_to_s     = $(Q)$(PREPROCESS_S) $< > $@
450
451 DEBUG_TARGETS   += dbg%.o c s
452
453 # We automatically generate rules for any file mentioned in AUTO_SRCS
454 # using the following set of templates.  It would be cleaner to use
455 # $(eval ...), but this function exists only in GNU make >= 3.80.
456
457 # src_template : generate Makefile rules for a given source file
458 #
459 # $(1) is the full path to the source file (e.g. "drivers/net/rtl8139.c")
460 # $(2) is the full path to the .d file (e.g. "bin/deps/drivers/net/rtl8139.d")
461 # $(3) is the source type (e.g. "c")
462 # $(4) is the source base name (e.g. "rtl8139")
463 #
464 define src_template
465
466         @$(ECHO) "  [DEPS] $(1)"
467         @$(MKDIR) -p $(dir $(2))
468         @$(RM) $(2)
469         @$(TOUCH) $(2)
470         @$(CPP) $(CFLAGS) $(CFLAGS_$(3)) $(CFLAGS_$(4)) -DOBJECT=$(4) \
471                 -Wno-error -M $(1) -MG -MP | \
472                 sed 's/\.o\s*:/_DEPS =/' >> $(2)
473         @$(ECHO_E) '\n$$(BIN)/$(4).o :' \
474                  '$(1) $$(MAKEDEPS) $$(POST_O_DEPS) $$($(4)_DEPS)' \
475                  '\n\t$$(QM)$(ECHO) "  [BUILD] $$@"' \
476                  '\n\t$$(RULE_$(3))\n' \
477                  '\nBOBJS += $$(BIN)/$(4).o\n' \
478                  $(foreach TGT,$(DEBUG_TARGETS), \
479                     $(if $(RULE_$(3)_to_$(TGT)), \
480                     '\n$$(BIN)/$(4).$(TGT) :' \
481                     '$(1) $$(MAKEDEPS) $$(POST_O_DEPS) $$($(4)_DEPS)' \
482                     '\n\t$$(QM)$(ECHO) "  [BUILD] $$@"' \
483                     '\n\t$$(RULE_$(3)_to_$(TGT))\n' \
484                     '\n$(TGT)_OBJS += $$(BIN)/$(4).$(TGT)\n' ) ) \
485                  '\n$(2) : $$($(4)_DEPS)\n' \
486                  '\nTAGS : $$($(4)_DEPS)\n' \
487                 >> $(2)
488         @$(PARSEROM) $(1) >> $(2)
489
490 endef
491
492 # Rule to generate the Makefile rules files to be included
493 #
494 $(BIN)/deps/%.d : % $(MAKEDEPS) $(PARSEROM)
495         $(if $(filter $(AUTO_SRCS),$<),$(call src_template,$<,$@,$(subst .,,$(suffix $<)),$(basename $(notdir $<))),@$(ECHO) 'ERROR: $< is not an AUTO_SRC' ; exit 1)
496
497 # Calculate and include the list of Makefile rules files
498 #
499 AUTO_DEPS       = $(patsubst %,$(BIN)/deps/%.d,$(AUTO_SRCS))
500 ifdef NEED_DEPS
501 ifneq ($(AUTO_DEPS),)
502 -include $(AUTO_DEPS)
503 endif
504 endif
505 autodeps :
506         @$(ECHO) $(AUTO_DEPS)
507 VERYCLEANUP     += $(BIN)/deps
508
509 # The following variables are created by the Makefile rules files
510 #
511 bobjs :
512         @$(ECHO) $(BOBJS)
513 drivers :
514         @$(ECHO) $(DRIVERS)
515 .PHONY : drivers
516 roms :
517         @$(ECHO) $(ROMS)
518
519 # List of embedded images included in the last build of embedded.o.
520 # This is needed in order to correctly rebuild embedded.o whenever the
521 # list of objects changes.
522 #
523 EMBEDDED_LIST   := $(BIN)/.embedded.list
524 ifeq ($(wildcard $(EMBEDDED_LIST)),)
525 EMBEDDED_LIST_IMAGE := <invalid>
526 else
527 EMBEDDED_LIST_IMAGE := $(shell cat $(EMBEDDED_LIST))
528 endif
529 ifneq ($(EMBEDDED_LIST_IMAGE),$(EMBEDDED_IMAGE))
530 $(shell $(ECHO) "$(EMBEDDED_IMAGE)" > $(EMBEDDED_LIST))
531 endif
532
533 $(EMBEDDED_LIST) :
534
535 VERYCLEANUP     += $(EMBEDDED_LIST)
536
537 EMBEDDED_FILES  := $(subst $(COMMA), ,$(EMBEDDED_IMAGE))
538 EMBED_ALL       := $(foreach i,$(call seq,1,$(words $(EMBEDDED_FILES))),\
539                      EMBED ( $(i), \"$(word $(i), $(EMBEDDED_FILES))\",\
540                              \"$(notdir $(word $(i),$(EMBEDDED_FILES)))\" ))
541
542 $(BIN)/embedded.o : $(EMBEDDED_FILES) $(EMBEDDED_LIST)
543
544 # This file uses .incbin inline assembly to include a binary file.
545 # Unfortunately ccache does not detect this dependency and caches builds even
546 # when the binary file has changed.
547 #
548 $(BIN)/embedded.o : override CC := env CCACHE_DISABLE=1 $(CC)
549
550 CFLAGS_embedded = -DEMBED_ALL="$(EMBED_ALL)"
551
552 # Generate the NIC file from the parsed source files.  The NIC file is
553 # only for rom-o-matic.
554 #
555 $(BIN)/NIC : $(AUTO_DEPS)
556         @$(ECHO) '# This is an automatically generated file, do not edit' > $@
557         @$(ECHO) '# It does not affect anything in the build, ' \
558              'it is only for rom-o-matic' >> $@
559         @$(ECHO) >> $@
560         @perl -ne 'chomp; print "$$1\n" if /\# NIC\t(.*)$$/' $^ >> $@
561 CLEANUP         += $(BIN)/NIC   # Doesn't match the $(BIN)/*.* pattern
562
563 # Analyse a target name (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and
564 # derive the variables:
565
566 # TGT_ELEMENTS : the elements of the target (e.g. "dfe538 prism2_pci")
567 # TGT_PREFIX   : the prefix type (e.g. "zrom")
568 # TGT_DRIVERS  : the driver for each element (e.g. "rtl8139 prism2_pci")
569 # TGT_ROM_NAME : the ROM name (e.g. "dfe538")
570 # TGT_MEDIA    : the media type (e.g. "rom")
571 #
572 DRIVERS_gpxe    = $(DRIVERS)
573 CARD_DRIVER     = $(firstword $(DRIVER_$(1)) $(1))
574 TGT_ELEMENTS    = $(subst --, ,$(firstword $(subst ., ,$(notdir $@))))
575 TGT_PREFIX      = $(word 2,$(subst ., ,$(notdir $@)))
576 TGT_ROM_NAME    = $(firstword $(TGT_ELEMENTS))
577 TGT_DRIVERS     = $(strip $(if $(DRIVERS_$(TGT_ROM_NAME)), \
578                                $(DRIVERS_$(TGT_ROM_NAME)), \
579                                $(foreach TGT_ELEMENT,$(TGT_ELEMENTS), \
580                                  $(call CARD_DRIVER,$(TGT_ELEMENT))) ))
581 TGT_MEDIA       = $(subst z,,$(TGT_PREFIX))
582
583 # Look up ROM IDs for the current target
584 # (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the variables:
585 #
586 # TGT_PCI_VENDOR : the PCI vendor ID (e.g. "0x1186")
587 # TGT_PCI_DEVICE : the PCI device ID (e.g. "0x1300")
588 #
589 TGT_PCI_VENDOR  = $(PCI_VENDOR_$(TGT_ROM_NAME))
590 TGT_PCI_DEVICE  = $(PCI_DEVICE_$(TGT_ROM_NAME))
591
592 # Calculate link-time options for the current target
593 # (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the variables:
594 #
595 # TGT_LD_DRIVERS : symbols to require in order to drag in the relevant drivers
596 #                  (e.g. "obj_rtl8139 obj_prism2_pci")
597 # TGT_LD_IDS :     symbols to define in order to fill in ID structures in the
598 #                  ROM header (e.g."pci_vendor_id=0x1186 pci_device_id=0x1300")
599 #
600 TGT_LD_DRIVERS  = $(subst -,_,$(patsubst %,obj_%,$(TGT_DRIVERS)))
601 TGT_LD_PREFIX   = obj_$(TGT_PREFIX)prefix
602 TGT_LD_IDS      = pci_vendor_id=$(firstword $(TGT_PCI_VENDOR) 0) \
603                   pci_device_id=$(firstword $(TGT_PCI_DEVICE) 0)
604
605 # Calculate linker flags based on link-time options for the current
606 # target type (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the
607 # variables:
608 #
609 # TGT_LD_FLAGS : target-specific flags to pass to linker (e.g.
610 #                "-u obj_zpciprefix -u obj_rtl8139 -u obj_prism2_pci
611 #                 --defsym pci_vendor=0x1186 --defsym pci_device=0x1300")
612 #
613 TGT_LD_FLAGS    = $(foreach SYM,$(TGT_LD_PREFIX) $(TGT_LD_DRIVERS) obj_config,\
614                     -u $(SYM) --defsym check_$(SYM)=$(SYM) ) \
615                   $(patsubst %,--defsym %,$(TGT_LD_IDS)) \
616                   $(TGT_LD_FLAGS_PRE)
617
618 # Calculate makerom flags for the specific target
619 # (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the variables:
620 #
621 # TGT_MAKEROM_FLAGS : target-specific flags for makerom (e.g.
622 #                     "-p 0x1186,0x1300")
623 #
624 TGT_MAKEROM_FLAGS = $(strip $(MAKEROM_FLAGS_$(TGT_ROM_NAME)) \
625        $(if $(TGT_PCI_VENDOR),$(strip -p $(TGT_PCI_VENDOR),$(TGT_PCI_DEVICE))))
626
627 # Calculate list of debugging versions of objects to be included in
628 # the target.
629 #
630 DEBUG_LIST      = $(subst $(COMMA), ,$(DEBUG))
631 DEBUG_OBJ_LEVEL = $(firstword $(word 2,$(subst :, ,$(1))) 1)
632 DEBUG_OBJ_BASE  = $(word 1,$(subst :, ,$(1))).dbg$(call DEBUG_OBJ_LEVEL,$(1))
633 DEBUG_OBJ       = $(BIN)/$(call DEBUG_OBJ_BASE,$(1)).o
634 DEBUG_ORIG_OBJ  = $(BIN)/$(word 1,$(subst :, ,$(1))).o
635 DEBUG_OBJS      = $(foreach D,$(DEBUG_LIST),$(call DEBUG_OBJ,$(D)))
636 DEBUG_ORIG_OBJS = $(foreach D,$(DEBUG_LIST),$(call DEBUG_ORIG_OBJ,$(D)))
637 BLIB_OBJS       = $(DEBUG_OBJS) $(filter-out $(DEBUG_ORIG_OBJS),$(BOBJS))
638
639 # Print out all derived information for a given target.
640 #
641 $(BIN)/%.info :
642         @$(ECHO) 'Elements             : $(TGT_ELEMENTS)'
643         @$(ECHO) 'Prefix               : $(TGT_PREFIX)'
644         @$(ECHO) 'Drivers              : $(TGT_DRIVERS)'
645         @$(ECHO) 'ROM name             : $(TGT_ROM_NAME)'
646         @$(ECHO) 'Media                : $(TGT_MEDIA)'
647         @$(ECHO)
648         @$(ECHO) 'PCI vendor           : $(TGT_PCI_VENDOR)'
649         @$(ECHO) 'PCI device           : $(TGT_PCI_DEVICE)'
650         @$(ECHO)
651         @$(ECHO) 'LD driver symbols    : $(TGT_LD_DRIVERS)'
652         @$(ECHO) 'LD prefix symbols    : $(TGT_LD_PREFIX)'
653         @$(ECHO) 'LD ID symbols        : $(TGT_LD_IDS)'
654         @$(ECHO)
655         @$(ECHO) 'LD target flags      : $(TGT_LD_FLAGS)'
656         @$(ECHO)
657         @$(ECHO) 'makerom target flags : $(TGT_MAKEROM_FLAGS)'
658         @$(ECHO)
659         @$(ECHO) 'Debugging objects    : $(DEBUG_OBJS)'
660         @$(ECHO) 'Replaced objects     : $(DEBUG_ORIG_OBJS)'
661
662 # List of objects included in the last build of blib.  This is needed
663 # in order to correctly rebuild blib whenever the list of objects
664 # changes.
665 #
666 BLIB_LIST       := $(BIN)/.blib.list
667 ifeq ($(wildcard $(BLIB_LIST)),)
668 BLIB_LIST_OBJS  := <invalid>
669 else
670 BLIB_LIST_OBJS  := $(shell cat $(BLIB_LIST))
671 endif
672 ifneq ($(BLIB_LIST_OBJS),$(BLIB_OBJS))
673 $(shell $(ECHO) "$(BLIB_OBJS)" > $(BLIB_LIST))
674 endif
675
676 $(BLIB_LIST) :
677
678 VERYCLEANUP     += $(BLIB_LIST)
679
680 # Library of all objects
681 #
682 BLIB            = $(BIN)/blib.a
683 $(BLIB) : $(BLIB_OBJS) $(BLIB_LIST) $(MAKEDEPS)
684         $(Q)$(RM) $(BLIB)
685         $(QM)$(ECHO) "  [AR] $@"
686         $(Q)$(AR) r $@ $(BLIB_OBJS)
687         $(Q)$(RANLIB) $@
688 blib : $(BLIB)
689
690 # Build an intermediate object file from the objects required for the
691 # specified target.
692 #
693 $(BIN)/%.tmp : $(BLIB) $(MAKEDEPS) $(LDSCRIPT) 
694         $(QM)$(ECHO) "  [LD] $@"
695         $(Q)$(LD) $(LDFLAGS) -T $(LDSCRIPT) $(TGT_LD_FLAGS) $(BLIB) -o $@ \
696                 -Map $(BIN)/$*.tmp.map
697         $(Q)$(OBJDUMP) -ht $@ | $(SORTOBJDUMP) >> $(BIN)/$*.tmp.map
698
699 # Keep intermediate object file (useful for debugging)
700 .PRECIOUS : $(BIN)/%.tmp
701
702 # Show a linker map for the specified target
703 #
704 $(BIN)/%.map : $(BIN)/%.tmp
705         @less $(BIN)/$*.tmp.map
706
707 # Get objects list for the specified target
708 #
709 define objs_list
710         $(sort $(foreach OBJ_SYMBOL,\
711                  $(filter obj_%,$(shell $(NM) $(1) | cut -d" " -f3)),\
712                  $(patsubst obj_%,%,$(OBJ_SYMBOL))))
713 endef
714 $(BIN)/%.objs : $(BIN)/%.tmp
715         $(Q)$(ECHO) $(call objs_list,$<)
716 $(BIN)/%.sizes : $(BIN)/%.tmp
717         $(Q)$(SIZE) -t $(foreach OBJ,$(call objs_list,$<),$(wildcard $(BIN)/$(subst _,?,$(OBJ)).o)) | \
718                 sort -g
719
720 # Get dependency list for the specified target
721 #
722 define deps_list
723         $(sort $(foreach OBJ,$(call objs_list,$(1)),$($(OBJ)_DEPS)))
724 endef
725 $(BIN)/%.deps : $(BIN)/%.tmp
726         $(Q)$(ECHO) $(call deps_list,$<)
727
728 # Get unneeded source files for the specified target
729 #
730 define nodeps_list
731         $(sort $(filter-out $(call deps_list,$(1)),\
732                  $(foreach BOBJ,$(BOBJS),\
733                    $($(basename $(notdir $(BOBJ)))_DEPS))))
734 endef
735 $(BIN)/%.nodeps : $(BIN)/%.tmp
736         $(Q)$(ECHO) $(call nodeps_list,$<)
737
738 # Get licensing verdict for the specified target
739 #
740 define unlicensed_deps_list
741         $(shell grep -L FILE_LICENCE $(call deps_list,$(1)))
742 endef
743 define licence_list
744         $(patsubst __licence_%,%,\
745           $(filter __licence_%,$(shell $(NM) $(1) | cut -d" " -f3)))
746 endef
747 $(BIN)/%.licence : $(BIN)/%.tmp
748         $(QM)$(ECHO) "  [LICENCE] $@"
749         $(Q)$(if $(strip $(call unlicensed_deps_list,$<)),\
750                 echo -n "Unable to determine licence because the following " ;\
751                 echo "files are missing a licence declaration:" ;\
752                 echo $(call unlicensed_deps_list,$<);\
753                 exit 1,\
754                 $(LICENCE) $(call licence_list,$<))
755
756 # Extract compression information from intermediate object file
757 #
758 $(BIN)/%.zinfo : $(BIN)/%.tmp
759         $(QM)$(ECHO) "  [ZINFO] $@"
760         $(Q)$(OBJCOPY) -O binary -j .zinfo $< $@
761
762 # Build raw binary file from intermediate object file
763 #
764 $(BIN)/%.bin : $(BIN)/%.tmp
765         $(QM)$(ECHO) "  [BIN] $@"
766         $(Q)$(OBJCOPY) -O binary -R .zinfo $< $@
767
768 # Compress raw binary file
769 #
770 $(BIN)/%.zbin : $(BIN)/%.bin $(BIN)/%.zinfo $(ZBIN)
771         $(QM)$(ECHO) "  [ZBIN] $@"
772         $(Q)$(ZBIN) $(BIN)/$*.bin $(BIN)/$*.zinfo > $@
773
774 # Rules for each media format.  These are generated and placed in an
775 # external Makefile fragment.  We could do this via $(eval ...), but
776 # that would require make >= 3.80.
777
778 # Note that there's an alternative way to generate most .rom images:
779 # they can be copied from their 'master' ROM image using cp and
780 # reprocessed with makerom to add the PCI IDs and ident string.  The
781 # relevant rule would look something like:
782 #
783 #   $(BIN)/dfe538%rom : $(BIN)/rtl8139%rom
784 #       cat $< $@
785 #       $(FINALISE_rom)
786
787 # You can derive the ROM/driver relationships using the variables
788 # DRIVER_<rom> and/or ROMS_<driver>.
789
790 # We don't currently do this, because (a) it would require generating
791 # yet more Makefile fragments (since you need a rule for each ROM in
792 # ROMS), and (b) the linker is so fast that it probably wouldn't make
793 # much difference to the overall build time.
794
795 media :
796         @$(ECHO) $(MEDIA)
797
798 AUTO_MEDIA      = $(filter-out $(NON_AUTO_MEDIA),$(MEDIA))
799 automedia :
800         @$(ECHO) $(AUTO_MEDIA)
801
802 # media_template : create Makefile rules for specified media
803 #
804 # $(1) is the media name (e.g. "rom")
805 # $(2) is the full path to the .d file (e.g. "bin/deps/rom.media.d")
806 #
807 define media_template
808
809         @$(ECHO) "  [MEDIADEPS] $(1)"
810         @$(MKDIR) -p $(dir $(2))
811         @$(RM) $(2)
812         @$(TOUCH) $(2)
813         @$(ECHO_E) '$$(BIN)/%.$(1) : $$(BIN)/%.$(1).zbin' \
814                   '\n\t$$(QM)$(ECHO) "  [FINISH] $$@"' \
815                   '\n\t$$(Q)$$(CP) $$< $$@' \
816                   '\n\t$$(Q)$$(PAD_$(1))' \
817                   '\n\t$$(Q)$$(FINALISE_$(1))' \
818                 > $(2)
819
820 endef
821
822 # Rule to generate the Makefile rules to be included
823 #
824 $(BIN)/deps/%.media.d : $(MAKEDEPS)
825         $(if $(filter $(AUTO_MEDIA),$*), \
826                 $(call media_template,$*,$@), \
827                 @$(ECHO) 'ERROR: $* is not an AUTO_MEDIA' ; exit 1)
828
829 # Calculate and include the list of Makefile rules files
830 #
831 MEDIA_DEPS              = $(patsubst %,$(BIN)/deps/%.media.d,$(AUTO_MEDIA))
832 mediadeps :
833         @$(ECHO) $(MEDIA_DEPS)
834 ifdef NEED_DEPS
835 ifneq ($(MEDIA_DEPS),)
836 -include $(MEDIA_DEPS)
837 endif
838 endif
839
840 # Wrap up binary blobs (for embedded images)
841 #
842 $(BIN)/%.o : payload/%.img
843         $(QM)echo "  [WRAP] $@"
844         $(Q)$(LD) -b binary -r -o $@ $< --undefined obj_payload \
845                 --defsym obj_$*=0
846
847 BOBJS += $(patsubst payload/%.img,$(BIN)/%.o,$(wildcard payload/*.img))
848
849 # The "allXXXs" targets for each suffix
850 #
851 allall: allroms allzroms allpxes allisos alldsks
852 allroms allzroms : all%s : $(foreach ROM,$(ROMS),$(BIN)/$(ROM).%)
853 allpxes allisos alldsks : all%s : $(foreach DRIVER,$(DRIVERS),$(BIN)/$(DRIVER).%)
854
855 # Alias for gpxe.%
856 #
857 $(BIN)/etherboot.% : $(BIN)/gpxe.%
858         ln -sf $(notdir $<) $@
859
860 endif # defined(BIN)
861
862 ###############################################################################
863 #
864 # Rules for finalising files.  TGT_MAKEROM_FLAGS is defined as part of
865 # the automatic build system and varies by target; it includes the
866 # "-p 0x1234,0x5678" string to set the PCI IDs.
867 #
868 FINALISE_rom    = $(MAKEROM) $(MAKEROM_FLAGS) $(TGT_MAKEROM_FLAGS) \
869                   -i$(IDENT) -s 0 $@
870 FINALISE_hrom   = $(FINALISE_rom)
871 FINALISE_xrom   = $(MAKEROM) $(MAKEROM_FLAGS) $(TGT_MAKEROM_FLAGS) \
872                   -i$(IDENT) -n -s 0 $@
873
874 # Some ROMs require specific flags to be passed to makerom.pl
875 #
876 MAKEROM_FLAGS_3c503 = -3
877
878 ###############################################################################
879 #
880 # The compression utilities
881 #
882 $(NRV2B) : util/nrv2b.c $(MAKEDEPS)
883         $(QM)$(ECHO) "  [HOSTCC] $@"
884         $(Q)$(HOST_CC) -O2 -DENCODE -DDECODE -DMAIN -DVERBOSE -DNDEBUG \
885                        -DBITSIZE=32 -DENDIAN=0 -o $@ $<
886 CLEANUP += $(NRV2B)
887
888 $(ZBIN) : util/zbin.c util/nrv2b.c $(MAKEDEPS)
889         $(QM)$(ECHO) "  [HOSTCC] $@"
890         $(Q)$(HOST_CC) -O2 -o $@ $<
891 CLEANUP += $(ZBIN)
892
893 ###############################################################################
894 #
895 # The EFI image converter
896 #
897 ELF2EFI_CFLAGS  := -I$(BINUTILS_DIR)/include -I$(BFD_DIR)/include \
898                    -I$(ZLIB_DIR)/include -idirafter include \
899                    -L$(BINUTILS_DIR)/lib -L$(BFD_DIR)/lib \
900                    -L$(ZLIB_DIR)/lib -lbfd -liberty -lz
901
902 $(ELF2EFI32) : util/elf2efi.c $(MAKEDEPS)
903         $(QM)$(ECHO) "  [HOSTCC] $@"
904         $(Q)$(HOST_CC) $< $(ELF2EFI_CFLAGS) -DMDE_CPU_IA32 -O2 -o $@
905 CLEANUP += $(ELF2EFI32)
906
907 $(ELF2EFI64) : util/elf2efi.c $(MAKEDEPS)
908         $(QM)$(ECHO) "  [HOSTCC] $@"
909         $(Q)$(HOST_CC) $< $(ELF2EFI_CFLAGS) -DMDE_CPU_X64 -O2 -o $@
910 CLEANUP += $(ELF2EFI64)
911
912 $(EFIROM) : util/efirom.c $(MAKEDEPS)
913         $(QM)$(ECHO) "  [HOSTCC] $@"
914         $(Q)$(HOST_CC) -idirafter include -O2 -o $@ $<
915 CLEANUP += $(EFIROM)
916
917 ###############################################################################
918 #
919 # The ICC fixup utility
920 #
921 $(ICCFIX) : util/iccfix.c $(MAKEDEPS)
922         $(QM)$(ECHO) "  [HOSTCC] $@"
923         $(Q)$(HOST_CC) -idirafter include -O2 -o $@ $<
924 CLEANUP += $(ICCFIX)
925
926 ###############################################################################
927 #
928 # Local configs
929 #
930 config/local/%.h :
931         $(Q)touch $@
932
933 ###############################################################################
934 #
935 # Auto-incrementing build serial number.  Append "bs" to your list of
936 # build targets to get a serial number printed at the end of the
937 # build.  Enable -DBUILD_SERIAL in order to see it when the code runs.
938 #
939 BUILDSERIAL_H           = config/.buildserial.h
940 BUILDSERIAL_NOW         = config/.buildserial.now
941 BUILDSERIAL_NEXT        = config/.buildserial.next
942
943 $(BUILDSERIAL_NOW) $(BUILDSERIAL_NEXT) :
944         $(ECHO) 1 > $@
945
946 $(BUILDSERIAL_H) : $(BUILDSERIAL_NOW) $(BUILDSERIAL_NEXT)
947         $(ECHO) '#define BUILD_SERIAL_NUM $(shell cat $<)' > $@
948
949 ifeq ($(filter bs,$(MAKECMDGOALS)),bs)
950 $(shell diff -q $(BUILDSERIAL_NOW) $(BUILDSERIAL_NEXT) > /dev/null || \
951         cp -f $(BUILDSERIAL_NEXT) $(BUILDSERIAL_NOW))
952 endif
953
954 bs : $(BUILDSERIAL_NOW)
955         @$(ECHO) $$(( $(shell cat $<) + 1 )) > $(BUILDSERIAL_NEXT)
956         @$(ECHO) "Build serial number is $(shell cat $<)"
957
958 ###############################################################################
959 #
960 # Build the TAGS file(s) for emacs
961 #
962 TAGS :
963         ctags -e -R -f $@ --exclude=bin
964
965 CLEANUP += TAGS
966
967 ###############################################################################
968 #
969 # Force rebuild for any given target
970 #
971 %.rebuild :
972         rm -f $*
973         $(Q)$(MAKE) $*
974
975 ###############################################################################
976 #
977 # Symbol table checks
978 #
979
980 ifdef BIN
981
982 SYMTAB  = $(BIN)/symtab
983 $(SYMTAB) : $(BLIB)
984         $(OBJDUMP) -w -t $< > $@
985
986 CLEANUP += $(BIN)/symtab
987
988 symcheck : $(SYMTAB)
989         $(SYMCHECK) $<
990
991 endif # defined(BIN)
992
993 ###############################################################################
994 #
995 # Build bochs symbol table
996 #
997
998 ifdef BIN
999
1000 $(BIN)/%.bxs : $(BIN)/%.tmp
1001         $(NM) $< | cut -d" " -f1,3 > $@
1002
1003 endif # defined(BIN)
1004
1005 ###############################################################################
1006 #
1007 # Documentation
1008 #
1009
1010 ifdef BIN
1011
1012 $(BIN)/doxygen.cfg : doxygen.cfg $(MAKEDEPS)
1013         $(Q)$(PERL) -pe 's{\@SRCDIRS\@}{$(SRCDIRS)}; ' \
1014                 -e  's{\@INCDIRS\@}{$(filter-out .,$(INCDIRS))}; ' \
1015                 -e  's{\@BIN\@}{$(BIN)}; ' \
1016                 -e  's{\@ARCH\@}{$(ARCH)}; ' \
1017                 $< > $@
1018
1019 $(BIN)/doc : $(BIN)/doxygen.cfg
1020         $(Q)$(DOXYGEN) $<
1021
1022 .PHONY : $(BIN)/doc
1023
1024 doc : $(BIN)/doc
1025
1026 doc-clean :
1027         $(Q)$(RM) -r $(BIN)/doc
1028
1029 VERYCLEANUP     += $(BIN)/doc
1030
1031 docview :
1032         @[ -f $(BIN)/doc/html/index.html ] || $(MAKE) $(BIN)/doc
1033         @if [ -n "$$BROWSER" ] ; then \
1034                 ( $$BROWSER $(BIN)/doc/html/index.html & ) ; \
1035         else \
1036                 $(ECHO) "Documentation index in $(BIN)/doc/html/index.html" ; \
1037         fi
1038
1039 endif # defined(BIN)
1040
1041 ###############################################################################
1042 #
1043 # Clean-up
1044 #
1045 clean :
1046         $(RM) $(CLEANUP)
1047
1048 veryclean : clean
1049         $(RM) -r $(VERYCLEANUP)