b6b747e94eb59acaf1db4dabe47f53d863ffd177
[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 INCDIRS         += arch/$(ARCH)/include/$(PLATFORM)
299 endif
300
301 ###############################################################################
302 #
303 # Source file handling
304
305 # SRCDIRS lists all directories containing source files.
306 srcdirs :
307         @$(ECHO) $(SRCDIRS)
308
309 # SRCS lists all .c or .S files found in any SRCDIR
310 #
311 SRCS    += $(wildcard $(patsubst %,%/*.c,$(SRCDIRS)))
312 SRCS    += $(wildcard $(patsubst %,%/*.S,$(SRCDIRS)))
313 srcs :
314         @$(ECHO) $(SRCS)
315
316 # AUTO_SRCS lists all files in SRCS that are not mentioned in
317 # NON_AUTO_SRCS.  Files should be added to NON_AUTO_SRCS if they
318 # cannot be built using the standard build template.
319 #
320 AUTO_SRCS = $(filter-out $(NON_AUTO_SRCS),$(SRCS))
321 autosrcs :
322         @$(ECHO) $(AUTO_SRCS)
323
324 # Just about everything else in this section depends upon having
325 # $(BIN) set
326
327 ifdef BIN
328
329 # INCDIRS lists the include path
330 incdirs :
331         @$(ECHO) $(INCDIRS)
332
333 # Common flags
334 #
335 CFLAGS          += $(foreach INC,$(INCDIRS),-I$(INC))
336 CFLAGS          += -Os
337 CFLAGS          += -g
338 ifeq ($(CCTYPE),gcc)
339 CFLAGS          += -ffreestanding
340 CFLAGS          += -Wall -W -Wformat-nonliteral
341 endif
342 ifeq ($(CCTYPE),icc)
343 CFLAGS          += -fno-builtin
344 CFLAGS          += -no-ip
345 CFLAGS          += -no-gcc
346 CFLAGS          += -diag-disable 111 # Unreachable code
347 CFLAGS          += -diag-disable 128 # Unreachable loop
348 CFLAGS          += -diag-disable 170 # Array boundary checks
349 CFLAGS          += -diag-disable 177 # Unused functions
350 CFLAGS          += -diag-disable 181 # printf() format checks
351 CFLAGS          += -diag-disable 188 # enum strictness
352 CFLAGS          += -diag-disable 193 # Undefined preprocessor identifiers
353 CFLAGS          += -diag-disable 280 # switch ( constant )
354 CFLAGS          += -diag-disable 310 # K&R parameter lists
355 CFLAGS          += -diag-disable 424 # Extra semicolon
356 CFLAGS          += -diag-disable 589 # Declarations mid-code
357 CFLAGS          += -diag-disable 593 # Unused variables
358 CFLAGS          += -diag-disable 810 # Casting ints to smaller ints
359 CFLAGS          += -diag-disable 981 # Sequence point violations
360 CFLAGS          += -diag-disable 1292 # Ignored attributes
361 CFLAGS          += -diag-disable 1338 # void pointer arithmetic
362 CFLAGS          += -diag-disable 1361 # Variable-length arrays
363 CFLAGS          += -diag-disable 1418 # Missing prototypes
364 CFLAGS          += -diag-disable 1419 # Missing prototypes
365 CFLAGS          += -diag-disable 1599 # Hidden variables
366 CFLAGS          += -Wall -Wmissing-declarations
367 endif
368 CFLAGS          += $(EXTRA_CFLAGS)
369 ASFLAGS         += $(EXTRA_ASFLAGS)
370 LDFLAGS         += $(EXTRA_LDFLAGS)
371
372 # Inhibit -Werror if NO_WERROR is specified on make command line
373 #
374 ifneq ($(NO_WERROR),1)
375 CFLAGS          += -Werror
376 ASFLAGS         += --fatal-warnings
377 endif
378
379 # Function trace recorder state in the last build.  This is needed
380 # in order to correctly rebuild whenever the function recorder is
381 # enabled/disabled.
382 #
383 FNREC_STATE     := $(BIN)/.fnrec.state
384 ifeq ($(wildcard $(FNREC_STATE)),)
385 FNREC_STATE_OLD := <invalid>
386 else
387 FNREC_STATE_OLD := $(shell cat $(FNREC_STATE))
388 endif
389 ifeq ($(FNREC_STATE_OLD),$(FNREC))
390 $(FNREC_STATE) :
391 else
392 $(FNREC_STATE) : clean
393 $(shell $(ECHO) "$(FNREC)" > $(FNREC_STATE))
394 endif
395
396 VERYCLEANUP     += $(FNREC_STATE)
397 MAKEDEPS        += $(FNREC_STATE)
398
399 ifeq ($(FNREC),1)
400 # Enabling -finstrument-functions affects gcc's analysis and leads to spurious
401 # warnings about use of uninitialised variables.
402 #
403 CFLAGS          += -Wno-uninitialized
404 CFLAGS          += -finstrument-functions
405 CFLAGS          += -finstrument-functions-exclude-file-list=core/fnrec.c
406 endif
407
408 # compiler.h is needed for our linking and debugging system
409 #
410 CFLAGS          += -include compiler.h
411
412 # CFLAGS for specific object types
413 #
414 CFLAGS_c        +=
415 CFLAGS_S        += -DASSEMBLY
416
417 # Base object name of the current target
418 #
419 OBJECT          = $(firstword $(subst ., ,$(@F)))
420
421 # CFLAGS for specific object files.  You can define
422 # e.g. CFLAGS_rtl8139, and have those flags automatically used when
423 # compiling bin/rtl8139.o.
424 #
425 OBJ_CFLAGS      = $(CFLAGS_$(OBJECT)) -DOBJECT=$(subst -,_,$(OBJECT))
426 $(BIN)/%.flags :
427         @$(ECHO) $(OBJ_CFLAGS)
428
429 # ICC requires postprocessing objects to fix up table alignments
430 #
431 ifeq ($(CCTYPE),icc)
432 POST_O          = && $(ICCFIX) $@
433 POST_O_DEPS     := $(ICCFIX)
434 else
435 POST_O          :=
436 POST_O_DEPS     :=
437 endif
438
439 # Rules for specific object types.
440 #
441 COMPILE_c       = $(CC) $(CFLAGS) $(CFLAGS_c) $(OBJ_CFLAGS)
442 RULE_c          = $(Q)$(COMPILE_c) -c $< -o $@ $(POST_O)
443 RULE_c_to_dbg%.o = $(Q)$(COMPILE_c) -Ddebug_$(subst -,_,$(OBJECT))=$* -c $< -o $@ $(POST_O)
444 RULE_c_to_c     = $(Q)$(COMPILE_c) -E -c $< > $@
445 RULE_c_to_s     = $(Q)$(COMPILE_c) -S -g0 -c $< -o $@
446
447 PREPROCESS_S    = $(CPP) $(CFLAGS) $(CFLAGS_S) $(OBJ_CFLAGS)
448 ASSEMBLE_S      = $(AS) $(ASFLAGS)
449 RULE_S          = $(Q)$(PREPROCESS_S) $< | $(ASSEMBLE_S) -o $@
450 RULE_S_to_s     = $(Q)$(PREPROCESS_S) $< > $@
451
452 DEBUG_TARGETS   += dbg%.o c s
453
454 # We automatically generate rules for any file mentioned in AUTO_SRCS
455 # using the following set of templates.  It would be cleaner to use
456 # $(eval ...), but this function exists only in GNU make >= 3.80.
457
458 # src_template : generate Makefile rules for a given source file
459 #
460 # $(1) is the full path to the source file (e.g. "drivers/net/rtl8139.c")
461 # $(2) is the full path to the .d file (e.g. "bin/deps/drivers/net/rtl8139.d")
462 # $(3) is the source type (e.g. "c")
463 # $(4) is the source base name (e.g. "rtl8139")
464 #
465 define src_template
466
467         @$(ECHO) "  [DEPS] $(1)"
468         @$(MKDIR) -p $(dir $(2))
469         @$(RM) $(2)
470         @$(TOUCH) $(2)
471         @$(CPP) $(CFLAGS) $(CFLAGS_$(3)) $(CFLAGS_$(4)) -DOBJECT=$(4) \
472                 -Wno-error -M $(1) -MG -MP | \
473                 sed 's/\.o\s*:/_DEPS =/' >> $(2)
474         @$(ECHO_E) '\n$$(BIN)/$(4).o :' \
475                  '$(1) $$(MAKEDEPS) $$(POST_O_DEPS) $$($(4)_DEPS)' \
476                  '\n\t$$(QM)$(ECHO) "  [BUILD] $$@"' \
477                  '\n\t$$(RULE_$(3))\n' \
478                  '\nBOBJS += $$(BIN)/$(4).o\n' \
479                  $(foreach TGT,$(DEBUG_TARGETS), \
480                     $(if $(RULE_$(3)_to_$(TGT)), \
481                     '\n$$(BIN)/$(4).$(TGT) :' \
482                     '$(1) $$(MAKEDEPS) $$(POST_O_DEPS) $$($(4)_DEPS)' \
483                     '\n\t$$(QM)$(ECHO) "  [BUILD] $$@"' \
484                     '\n\t$$(RULE_$(3)_to_$(TGT))\n' \
485                     '\n$(TGT)_OBJS += $$(BIN)/$(4).$(TGT)\n' ) ) \
486                  '\n$(2) : $$($(4)_DEPS)\n' \
487                  '\nTAGS : $$($(4)_DEPS)\n' \
488                 >> $(2)
489         @$(PARSEROM) $(1) >> $(2)
490
491 endef
492
493 # Rule to generate the Makefile rules files to be included
494 #
495 $(BIN)/deps/%.d : % $(MAKEDEPS) $(PARSEROM)
496         $(if $(filter $(AUTO_SRCS),$<),$(call src_template,$<,$@,$(subst .,,$(suffix $<)),$(basename $(notdir $<))),@$(ECHO) 'ERROR: $< is not an AUTO_SRC' ; exit 1)
497
498 # Calculate and include the list of Makefile rules files
499 #
500 AUTO_DEPS       = $(patsubst %,$(BIN)/deps/%.d,$(AUTO_SRCS))
501 ifdef NEED_DEPS
502 ifneq ($(AUTO_DEPS),)
503 -include $(AUTO_DEPS)
504 endif
505 endif
506 autodeps :
507         @$(ECHO) $(AUTO_DEPS)
508 VERYCLEANUP     += $(BIN)/deps
509
510 # The following variables are created by the Makefile rules files
511 #
512 bobjs :
513         @$(ECHO) $(BOBJS)
514 drivers :
515         @$(ECHO) $(DRIVERS)
516 .PHONY : drivers
517 roms :
518         @$(ECHO) $(ROMS)
519
520 # List of embedded images included in the last build of embedded.o.
521 # This is needed in order to correctly rebuild embedded.o whenever the
522 # list of objects changes.
523 #
524 EMBEDDED_LIST   := $(BIN)/.embedded.list
525 ifeq ($(wildcard $(EMBEDDED_LIST)),)
526 EMBEDDED_LIST_IMAGE := <invalid>
527 else
528 EMBEDDED_LIST_IMAGE := $(shell cat $(EMBEDDED_LIST))
529 endif
530 ifneq ($(EMBEDDED_LIST_IMAGE),$(EMBEDDED_IMAGE))
531 $(shell $(ECHO) "$(EMBEDDED_IMAGE)" > $(EMBEDDED_LIST))
532 endif
533
534 $(EMBEDDED_LIST) :
535
536 VERYCLEANUP     += $(EMBEDDED_LIST)
537
538 EMBEDDED_FILES  := $(subst $(COMMA), ,$(EMBEDDED_IMAGE))
539 EMBED_ALL       := $(foreach i,$(call seq,1,$(words $(EMBEDDED_FILES))),\
540                      EMBED ( $(i), \"$(word $(i), $(EMBEDDED_FILES))\",\
541                              \"$(notdir $(word $(i),$(EMBEDDED_FILES)))\" ))
542
543 $(BIN)/embedded.o : $(EMBEDDED_FILES) $(EMBEDDED_LIST)
544
545 # This file uses .incbin inline assembly to include a binary file.
546 # Unfortunately ccache does not detect this dependency and caches builds even
547 # when the binary file has changed.
548 #
549 $(BIN)/embedded.o : override CC := env CCACHE_DISABLE=1 $(CC)
550
551 CFLAGS_embedded = -DEMBED_ALL="$(EMBED_ALL)"
552
553 # Generate error usage information
554 #
555 $(BIN)/%.einfo : $(BIN)/%.o
556         $(QM)$(ECHO) "  [EINFO] $@"
557         $(Q)$(OBJCOPY) -O binary -j .einfo --set-section-flags .einfo=alloc \
558                 $< $@
559
560 EINFOS          := $(patsubst $(BIN)/%.o,$(BIN)/%.einfo,$(BOBJS))
561 $(BIN)/errors : $(EINFOS) $(EINFO)
562         $(QM)$(ECHO) "  [EINFO] $@"
563         $(Q)$(EINFO) $(EINFOS) | sort > $@
564
565 # Generate the NIC file from the parsed source files.  The NIC file is
566 # only for rom-o-matic.
567 #
568 $(BIN)/NIC : $(AUTO_DEPS)
569         @$(ECHO) '# This is an automatically generated file, do not edit' > $@
570         @$(ECHO) '# It does not affect anything in the build, ' \
571              'it is only for rom-o-matic' >> $@
572         @$(ECHO) >> $@
573         @perl -ne 'chomp; print "$$1\n" if /\# NIC\t(.*)$$/' $^ >> $@
574 CLEANUP         += $(BIN)/NIC   # Doesn't match the $(BIN)/*.* pattern
575
576 # Analyse a target name (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and
577 # derive the variables:
578
579 # TGT_ELEMENTS : the elements of the target (e.g. "dfe538 prism2_pci")
580 # TGT_PREFIX   : the prefix type (e.g. "zrom")
581 # TGT_DRIVERS  : the driver for each element (e.g. "rtl8139 prism2_pci")
582 # TGT_ROM_NAME : the ROM name (e.g. "dfe538")
583 # TGT_MEDIA    : the media type (e.g. "rom")
584 #
585 DRIVERS_gpxe    = $(DRIVERS)
586 CARD_DRIVER     = $(firstword $(DRIVER_$(1)) $(1))
587 TGT_ELEMENTS    = $(subst --, ,$(firstword $(subst ., ,$(notdir $@))))
588 TGT_PREFIX      = $(word 2,$(subst ., ,$(notdir $@)))
589 TGT_ROM_NAME    = $(firstword $(TGT_ELEMENTS))
590 TGT_DRIVERS     = $(strip $(if $(DRIVERS_$(TGT_ROM_NAME)), \
591                                $(DRIVERS_$(TGT_ROM_NAME)), \
592                                $(foreach TGT_ELEMENT,$(TGT_ELEMENTS), \
593                                  $(call CARD_DRIVER,$(TGT_ELEMENT))) ))
594 TGT_MEDIA       = $(subst z,,$(TGT_PREFIX))
595
596 # Look up ROM IDs for the current target
597 # (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the variables:
598 #
599 # TGT_PCI_VENDOR : the PCI vendor ID (e.g. "0x1186")
600 # TGT_PCI_DEVICE : the PCI device ID (e.g. "0x1300")
601 #
602 TGT_PCI_VENDOR  = $(PCI_VENDOR_$(TGT_ROM_NAME))
603 TGT_PCI_DEVICE  = $(PCI_DEVICE_$(TGT_ROM_NAME))
604
605 # Calculate link-time options for the current target
606 # (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the variables:
607 #
608 # TGT_LD_DRIVERS : symbols to require in order to drag in the relevant drivers
609 #                  (e.g. "obj_rtl8139 obj_prism2_pci")
610 # TGT_LD_IDS :     symbols to define in order to fill in ID structures in the
611 #                  ROM header (e.g."pci_vendor_id=0x1186 pci_device_id=0x1300")
612 #
613 TGT_LD_DRIVERS  = $(subst -,_,$(patsubst %,obj_%,$(TGT_DRIVERS)))
614 TGT_LD_PREFIX   = obj_$(TGT_PREFIX)prefix
615 TGT_LD_IDS      = pci_vendor_id=$(firstword $(TGT_PCI_VENDOR) 0) \
616                   pci_device_id=$(firstword $(TGT_PCI_DEVICE) 0)
617
618 # Calculate linker flags based on link-time options for the current
619 # target type (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the
620 # variables:
621 #
622 # TGT_LD_FLAGS : target-specific flags to pass to linker (e.g.
623 #                "-u obj_zpciprefix -u obj_rtl8139 -u obj_prism2_pci
624 #                 --defsym pci_vendor=0x1186 --defsym pci_device=0x1300")
625 #
626 TGT_LD_FLAGS    = $(foreach SYM,$(TGT_LD_PREFIX) $(TGT_LD_DRIVERS) obj_config,\
627                     -u $(SYM) --defsym check_$(SYM)=$(SYM) ) \
628                   $(patsubst %,--defsym %,$(TGT_LD_IDS)) \
629                   $(TGT_LD_FLAGS_PRE)
630
631 # Calculate list of debugging versions of objects to be included in
632 # the target.
633 #
634 DEBUG_LIST      = $(subst $(COMMA), ,$(DEBUG))
635 DEBUG_OBJ_LEVEL = $(firstword $(word 2,$(subst :, ,$(1))) 1)
636 DEBUG_OBJ_BASE  = $(word 1,$(subst :, ,$(1))).dbg$(call DEBUG_OBJ_LEVEL,$(1))
637 DEBUG_OBJ       = $(BIN)/$(call DEBUG_OBJ_BASE,$(1)).o
638 DEBUG_ORIG_OBJ  = $(BIN)/$(word 1,$(subst :, ,$(1))).o
639 DEBUG_OBJS      = $(foreach D,$(DEBUG_LIST),$(call DEBUG_OBJ,$(D)))
640 DEBUG_ORIG_OBJS = $(foreach D,$(DEBUG_LIST),$(call DEBUG_ORIG_OBJ,$(D)))
641 BLIB_OBJS       = $(DEBUG_OBJS) $(filter-out $(DEBUG_ORIG_OBJS),$(BOBJS))
642
643 # Print out all derived information for a given target.
644 #
645 $(BIN)/%.info :
646         @$(ECHO) 'Elements             : $(TGT_ELEMENTS)'
647         @$(ECHO) 'Prefix               : $(TGT_PREFIX)'
648         @$(ECHO) 'Drivers              : $(TGT_DRIVERS)'
649         @$(ECHO) 'ROM name             : $(TGT_ROM_NAME)'
650         @$(ECHO) 'Media                : $(TGT_MEDIA)'
651         @$(ECHO)
652         @$(ECHO) 'PCI vendor           : $(TGT_PCI_VENDOR)'
653         @$(ECHO) 'PCI device           : $(TGT_PCI_DEVICE)'
654         @$(ECHO)
655         @$(ECHO) 'LD driver symbols    : $(TGT_LD_DRIVERS)'
656         @$(ECHO) 'LD prefix symbols    : $(TGT_LD_PREFIX)'
657         @$(ECHO) 'LD ID symbols        : $(TGT_LD_IDS)'
658         @$(ECHO)
659         @$(ECHO) 'LD target flags      : $(TGT_LD_FLAGS)'
660         @$(ECHO)
661         @$(ECHO) 'Debugging objects    : $(DEBUG_OBJS)'
662         @$(ECHO) 'Replaced objects     : $(DEBUG_ORIG_OBJS)'
663
664 # List of objects included in the last build of blib.  This is needed
665 # in order to correctly rebuild blib whenever the list of objects
666 # changes.
667 #
668 BLIB_LIST       := $(BIN)/.blib.list
669 ifeq ($(wildcard $(BLIB_LIST)),)
670 BLIB_LIST_OBJS  := <invalid>
671 else
672 BLIB_LIST_OBJS  := $(shell cat $(BLIB_LIST))
673 endif
674 ifneq ($(BLIB_LIST_OBJS),$(BLIB_OBJS))
675 $(shell $(ECHO) "$(BLIB_OBJS)" > $(BLIB_LIST))
676 endif
677
678 $(BLIB_LIST) :
679
680 VERYCLEANUP     += $(BLIB_LIST)
681
682 # Library of all objects
683 #
684 BLIB            = $(BIN)/blib.a
685 $(BLIB) : $(BLIB_OBJS) $(BLIB_LIST) $(MAKEDEPS)
686         $(Q)$(RM) $(BLIB)
687         $(QM)$(ECHO) "  [AR] $@"
688         $(Q)$(AR) r $@ $(BLIB_OBJS)
689         $(Q)$(RANLIB) $@
690 blib : $(BLIB)
691
692 # Command to generate build ID.  Must be unique for each $(BIN)/%.tmp,
693 # even within the same build run.
694 #
695 BUILD_ID_CMD    := perl -e 'printf "0x%08x", int ( rand ( 0xffffffff ) );'
696
697 # Build an intermediate object file from the objects required for the
698 # specified target.
699 #
700 $(BIN)/%.tmp : $(BLIB) $(MAKEDEPS) $(LDSCRIPT)
701         $(QM)$(ECHO) "  [LD] $@"
702         $(Q)$(LD) $(LDFLAGS) -T $(LDSCRIPT) $(TGT_LD_FLAGS) $(BLIB) -o $@ \
703                 --defsym _build_id=`$(BUILD_ID_CMD)` -Map $(BIN)/$*.tmp.map
704         $(Q)$(OBJDUMP) -ht $@ | $(SORTOBJDUMP) >> $(BIN)/$*.tmp.map
705
706 # Keep intermediate object file (useful for debugging)
707 .PRECIOUS : $(BIN)/%.tmp
708
709 # Show a linker map for the specified target
710 #
711 $(BIN)/%.map : $(BIN)/%.tmp
712         @less $(BIN)/$*.tmp.map
713
714 # Get objects list for the specified target
715 #
716 define objs_list
717         $(sort $(foreach OBJ_SYMBOL,\
718                  $(filter obj_%,$(shell $(NM) $(1) | cut -d" " -f3)),\
719                  $(patsubst obj_%,%,$(OBJ_SYMBOL))))
720 endef
721 $(BIN)/%.objs : $(BIN)/%.tmp
722         $(Q)$(ECHO) $(call objs_list,$<)
723 $(BIN)/%.sizes : $(BIN)/%.tmp
724         $(Q)$(SIZE) -t $(foreach OBJ,$(call objs_list,$<),$(wildcard $(BIN)/$(subst _,?,$(OBJ)).o)) | \
725                 sort -g
726
727 # Get dependency list for the specified target
728 #
729 define deps_list
730         $(sort $(foreach OBJ,$(call objs_list,$(1)),$($(OBJ)_DEPS)))
731 endef
732 $(BIN)/%.deps : $(BIN)/%.tmp
733         $(Q)$(ECHO) $(call deps_list,$<)
734
735 # Get unneeded source files for the specified target
736 #
737 define nodeps_list
738         $(sort $(filter-out $(call deps_list,$(1)),\
739                  $(foreach BOBJ,$(BOBJS),\
740                    $($(basename $(notdir $(BOBJ)))_DEPS))))
741 endef
742 $(BIN)/%.nodeps : $(BIN)/%.tmp
743         $(Q)$(ECHO) $(call nodeps_list,$<)
744
745 # Get licensing verdict for the specified target
746 #
747 define unlicensed_deps_list
748         $(shell grep -L FILE_LICENCE $(call deps_list,$(1)))
749 endef
750 define licence_list
751         $(patsubst __licence_%,%,\
752           $(filter __licence_%,$(shell $(NM) $(1) | cut -d" " -f3)))
753 endef
754 $(BIN)/%.licence : $(BIN)/%.tmp
755         $(QM)$(ECHO) "  [LICENCE] $@"
756         $(Q)$(if $(strip $(call unlicensed_deps_list,$<)),\
757                 echo -n "Unable to determine licence because the following " ;\
758                 echo "files are missing a licence declaration:" ;\
759                 echo $(call unlicensed_deps_list,$<);\
760                 exit 1,\
761                 $(LICENCE) $(call licence_list,$<))
762
763 # Extract compression information from intermediate object file
764 #
765 $(BIN)/%.zinfo : $(BIN)/%.tmp
766         $(QM)$(ECHO) "  [ZINFO] $@"
767         $(Q)$(OBJCOPY) -O binary -j .zinfo $< $@
768
769 # Build raw binary file from intermediate object file
770 #
771 $(BIN)/%.bin : $(BIN)/%.tmp
772         $(QM)$(ECHO) "  [BIN] $@"
773         $(Q)$(OBJCOPY) -O binary -R .zinfo $< $@
774
775 # Compress raw binary file
776 #
777 $(BIN)/%.zbin : $(BIN)/%.bin $(BIN)/%.zinfo $(ZBIN)
778         $(QM)$(ECHO) "  [ZBIN] $@"
779         $(Q)$(ZBIN) $(BIN)/$*.bin $(BIN)/$*.zinfo > $@
780
781 # Rules for each media format.  These are generated and placed in an
782 # external Makefile fragment.  We could do this via $(eval ...), but
783 # that would require make >= 3.80.
784
785 # Note that there's an alternative way to generate most .rom images:
786 # they can be copied from their 'master' ROM image using cp and
787 # reprocessed with makerom to add the PCI IDs and ident string.  The
788 # relevant rule would look something like:
789 #
790 #   $(BIN)/dfe538%rom : $(BIN)/rtl8139%rom
791 #       cat $< $@
792 #       $(FINALISE_rom)
793
794 # You can derive the ROM/driver relationships using the variables
795 # DRIVER_<rom> and/or ROMS_<driver>.
796
797 # We don't currently do this, because (a) it would require generating
798 # yet more Makefile fragments (since you need a rule for each ROM in
799 # ROMS), and (b) the linker is so fast that it probably wouldn't make
800 # much difference to the overall build time.
801
802 media :
803         @$(ECHO) $(MEDIA)
804
805 AUTO_MEDIA      = $(filter-out $(NON_AUTO_MEDIA),$(MEDIA))
806 automedia :
807         @$(ECHO) $(AUTO_MEDIA)
808
809 # media_template : create Makefile rules for specified media
810 #
811 # $(1) is the media name (e.g. "rom")
812 # $(2) is the full path to the .d file (e.g. "bin/deps/rom.media.d")
813 #
814 define media_template
815
816         @$(ECHO) "  [MEDIADEPS] $(1)"
817         @$(MKDIR) -p $(dir $(2))
818         @$(RM) $(2)
819         @$(TOUCH) $(2)
820         @$(ECHO_E) '$$(BIN)/%.$(1) : $$(BIN)/%.$(1).zbin' \
821                   '\n\t$$(QM)$(ECHO) "  [FINISH] $$@"' \
822                   '\n\t$$(Q)$$(CP) $$< $$@' \
823                   '\n\t$$(Q)$$(PAD_$(1))' \
824                   '\n\t$$(Q)$$(FINALISE_$(1))' \
825                 > $(2)
826
827 endef
828
829 # Rule to generate the Makefile rules to be included
830 #
831 $(BIN)/deps/%.media.d : $(MAKEDEPS)
832         $(if $(filter $(AUTO_MEDIA),$*), \
833                 $(call media_template,$*,$@), \
834                 @$(ECHO) 'ERROR: $* is not an AUTO_MEDIA' ; exit 1)
835
836 # Calculate and include the list of Makefile rules files
837 #
838 MEDIA_DEPS              = $(patsubst %,$(BIN)/deps/%.media.d,$(AUTO_MEDIA))
839 mediadeps :
840         @$(ECHO) $(MEDIA_DEPS)
841 ifdef NEED_DEPS
842 ifneq ($(MEDIA_DEPS),)
843 -include $(MEDIA_DEPS)
844 endif
845 endif
846
847 # Wrap up binary blobs (for embedded images)
848 #
849 $(BIN)/%.o : payload/%.img
850         $(QM)echo "  [WRAP] $@"
851         $(Q)$(LD) -b binary -r -o $@ $< --undefined obj_payload \
852                 --defsym obj_$*=0
853
854 BOBJS += $(patsubst payload/%.img,$(BIN)/%.o,$(wildcard payload/*.img))
855
856 # The "allXXXs" targets for each suffix
857 #
858 allall: allroms allzroms allpxes allisos alldsks
859 allroms allzroms : all%s : $(foreach ROM,$(ROMS),$(BIN)/$(ROM).%)
860 allpxes allisos alldsks : all%s : $(foreach DRIVER,$(DRIVERS),$(BIN)/$(DRIVER).%)
861
862 # Alias for gpxe.%
863 #
864 $(BIN)/etherboot.% : $(BIN)/gpxe.%
865         ln -sf $(notdir $<) $@
866
867 endif # defined(BIN)
868
869 ###############################################################################
870 #
871 # The compression utilities
872 #
873 $(NRV2B) : util/nrv2b.c $(MAKEDEPS)
874         $(QM)$(ECHO) "  [HOSTCC] $@"
875         $(Q)$(HOST_CC) -O2 -DENCODE -DDECODE -DMAIN -DVERBOSE -DNDEBUG \
876                        -DBITSIZE=32 -DENDIAN=0 -o $@ $<
877 CLEANUP += $(NRV2B)
878
879 $(ZBIN) : util/zbin.c util/nrv2b.c $(MAKEDEPS)
880         $(QM)$(ECHO) "  [HOSTCC] $@"
881         $(Q)$(HOST_CC) -O2 -o $@ $<
882 CLEANUP += $(ZBIN)
883
884 ###############################################################################
885 #
886 # The EFI image converter
887 #
888 ELF2EFI_CFLAGS  := -I$(BINUTILS_DIR)/include -I$(BFD_DIR)/include \
889                    -I$(ZLIB_DIR)/include -idirafter include \
890                    -L$(BINUTILS_DIR)/lib -L$(BFD_DIR)/lib \
891                    -L$(ZLIB_DIR)/lib -lbfd -liberty -lz \
892                    -Wl,--no-warn-search-mismatch
893
894 $(ELF2EFI32) : util/elf2efi.c $(MAKEDEPS)
895         $(QM)$(ECHO) "  [HOSTCC] $@"
896         $(Q)$(HOST_CC) $< $(ELF2EFI_CFLAGS) -DMDE_CPU_IA32 -O2 -o $@
897 CLEANUP += $(ELF2EFI32)
898
899 $(ELF2EFI64) : util/elf2efi.c $(MAKEDEPS)
900         $(QM)$(ECHO) "  [HOSTCC] $@"
901         $(Q)$(HOST_CC) $< $(ELF2EFI_CFLAGS) -DMDE_CPU_X64 -O2 -o $@
902 CLEANUP += $(ELF2EFI64)
903
904 $(EFIROM) : util/efirom.c $(MAKEDEPS)
905         $(QM)$(ECHO) "  [HOSTCC] $@"
906         $(Q)$(HOST_CC) -idirafter include -O2 -o $@ $<
907 CLEANUP += $(EFIROM)
908
909 ###############################################################################
910 #
911 # The ICC fixup utility
912 #
913 $(ICCFIX) : util/iccfix.c $(MAKEDEPS)
914         $(QM)$(ECHO) "  [HOSTCC] $@"
915         $(Q)$(HOST_CC) -idirafter include -O2 -o $@ $<
916 CLEANUP += $(ICCFIX)
917
918 ###############################################################################
919 #
920 # The error usage information utility
921 #
922 $(EINFO) : util/einfo.c $(MAKEDEPS)
923         $(QM)$(ECHO) "  [HOSTCC] $@"
924         $(Q)$(HOST_CC) -idirafter include -O2 -o $@ $<
925 CLEANUP += $(EINFO)
926
927 ###############################################################################
928 #
929 # Local configs
930 #
931 config/local/%.h :
932         $(Q)touch $@
933
934 ###############################################################################
935 #
936 # Auto-incrementing build serial number.  Append "bs" to your list of
937 # build targets to get a serial number printed at the end of the
938 # build.  Enable -DBUILD_SERIAL in order to see it when the code runs.
939 #
940 BUILDSERIAL_H           = config/.buildserial.h
941 BUILDSERIAL_NOW         = config/.buildserial.now
942 BUILDSERIAL_NEXT        = config/.buildserial.next
943
944 $(BUILDSERIAL_NOW) $(BUILDSERIAL_NEXT) :
945         $(ECHO) 1 > $@
946
947 $(BUILDSERIAL_H) : $(BUILDSERIAL_NOW) $(BUILDSERIAL_NEXT)
948         $(ECHO) '#define BUILD_SERIAL_NUM $(shell cat $<)' > $@
949
950 ifeq ($(filter bs,$(MAKECMDGOALS)),bs)
951 $(shell diff -q $(BUILDSERIAL_NOW) $(BUILDSERIAL_NEXT) > /dev/null || \
952         cp -f $(BUILDSERIAL_NEXT) $(BUILDSERIAL_NOW))
953 endif
954
955 bs : $(BUILDSERIAL_NOW)
956         @$(ECHO) $$(( $(shell cat $<) + 1 )) > $(BUILDSERIAL_NEXT)
957         @$(ECHO) "Build serial number is $(shell cat $<)"
958
959 ###############################################################################
960 #
961 # Build the TAGS file(s) for emacs
962 #
963 TAGS :
964         ctags -e -R -f $@ --exclude=bin
965
966 CLEANUP += TAGS
967
968 ###############################################################################
969 #
970 # Force rebuild for any given target
971 #
972 %.rebuild :
973         rm -f $*
974         $(Q)$(MAKE) $*
975
976 ###############################################################################
977 #
978 # Symbol table checks
979 #
980
981 ifdef BIN
982
983 SYMTAB  = $(BIN)/symtab
984 $(SYMTAB) : $(BLIB)
985         $(OBJDUMP) -w -t $< > $@
986
987 CLEANUP += $(BIN)/symtab
988
989 symcheck : $(SYMTAB)
990         $(SYMCHECK) $<
991
992 endif # defined(BIN)
993
994 ###############################################################################
995 #
996 # Build bochs symbol table
997 #
998
999 ifdef BIN
1000
1001 $(BIN)/%.bxs : $(BIN)/%.tmp
1002         $(NM) $< | cut -d" " -f1,3 > $@
1003
1004 endif # defined(BIN)
1005
1006 ###############################################################################
1007 #
1008 # Documentation
1009 #
1010
1011 ifdef BIN
1012
1013 $(BIN)/doxygen.cfg : doxygen.cfg $(MAKEDEPS)
1014         $(Q)$(PERL) -pe 's{\@SRCDIRS\@}{$(SRCDIRS)}; ' \
1015                 -e  's{\@INCDIRS\@}{$(filter-out .,$(INCDIRS))}; ' \
1016                 -e  's{\@BIN\@}{$(BIN)}; ' \
1017                 -e  's{\@ARCH\@}{$(ARCH)}; ' \
1018                 $< > $@
1019
1020 $(BIN)/doc : $(BIN)/doxygen.cfg
1021         $(Q)$(DOXYGEN) $<
1022
1023 .PHONY : $(BIN)/doc
1024
1025 doc : $(BIN)/doc
1026
1027 doc-clean :
1028         $(Q)$(RM) -r $(BIN)/doc
1029
1030 VERYCLEANUP     += $(BIN)/doc
1031
1032 docview :
1033         @[ -f $(BIN)/doc/html/index.html ] || $(MAKE) $(BIN)/doc
1034         @if [ -n "$$BROWSER" ] ; then \
1035                 ( $$BROWSER $(BIN)/doc/html/index.html & ) ; \
1036         else \
1037                 $(ECHO) "Documentation index in $(BIN)/doc/html/index.html" ; \
1038         fi
1039
1040 endif # defined(BIN)
1041
1042 ###############################################################################
1043 #
1044 # Clean-up
1045 #
1046 clean :
1047         $(RM) $(CLEANUP)
1048
1049 veryclean : clean
1050         $(RM) -r $(VERYCLEANUP)