1 # -*- makefile -*- : Force emacs to use Makefile mode
3 # This file contains various boring housekeeping functions that would
4 # otherwise seriously clutter up the main Makefile.
6 # Objects to be removed by "make clean"
8 CLEANUP := $(BIN)/*.* # *.* to avoid catching the "CVS" directory
10 # Show what we're using for "echo -e"
13 @$(ECHO) Using "$(ECHO)" to echo
15 # Version number calculations
21 MM_VERSION = $(VERSION_MAJOR).$(VERSION_MINOR)
22 VERSION = $(MM_VERSION).$(VERSION_PATCH)$(EXTRAVERSION)
23 CFLAGS += -DVERSION_MAJOR=$(VERSION_MAJOR) \
24 -DVERSION_MINOR=$(VERSION_MINOR) \
25 -DVERSION=\"$(VERSION)\"
26 IDENT = '$(@F) $(VERSION) (GPL) etherboot.org'
30 # Check for tools that can cause failed builds
32 .toolcheck : Makefile Config
33 @if $(CC) -v 2>&1 | grep -is 'gcc version 2\.96' > /dev/null; then \
34 $(ECHO) 'gcc 2.96 is unsuitable for compiling Etherboot'; \
35 $(ECHO) 'Use gcc 2.95 or gcc 3.x instead'; \
38 @if [ `perl -e 'use bytes; print chr(255)' | wc -c` = 2 ]; then \
39 $(ECHO) 'Your Perl version has a Unicode handling bug'; \
40 $(ECHO) 'Execute this command before compiling Etherboot:'; \
41 $(ECHO) 'export LANG=$${LANG%.UTF-8}'; \
45 VERYCLEANUP += .toolcheck
57 # Check for an old version of gas (binutils 2.9.1)
59 OLDGAS := $(shell $(AS) --version | grep -q '2\.9\.1' && $(ECHO) -DGAS291)
64 # compiler.h is needed for our linking and debugging system
66 CFLAGS += -include compiler.h
68 # config/%.h files are generated from config.h using mkconfig.pl
73 # SRCDIRS lists all directories containing source files.
77 # SRCS lists all .c or .S files found in any SRCDIR
79 SRCS += $(wildcard $(patsubst %,%/*.c,$(SRCDIRS)))
80 SRCS += $(wildcard $(patsubst %,%/*.S,$(SRCDIRS)))
84 # AUTO_SRCS lists all files in SRCS that are not mentioned in
85 # NON_AUTO_SRCS. Files should be added to NON_AUTO_SRCS if they
86 # cannot be built using the standard build template.
88 AUTO_SRCS = $(filter-out $(NON_AUTO_SRCS),$(SRCS))
92 # We automatically generate rules for any file mentioned in AUTO_SRCS
93 # using the following set of templates. It would be cleaner to use
94 # $(eval ...), but this function exists only in GNU make >= 3.80.
96 # src_template : generate Makefile rules for a given source file
98 # $(1) is the full path to the source file (e.g. "drivers/net/rtl8139.c")
99 # $(2) is the full path to the .d file (e.g. "bin/deps/drivers/net/rtl8139.d")
100 # $(3) is the source type (e.g. "c")
101 # $(4) is the source base name (e.g. "rtl8139")
105 @$(ECHO) "Generating Makefile rules for $(1)"
106 @$(MKDIR) -p $(dir $(2))
109 $(foreach OBJ,$(if $(OBJS_$(4)),$(OBJS_$(4)),$(4)), \
110 $(call obj_template,$(1),$(2),$(3),$(OBJ)))
111 @$(PARSEROM) $(1) >> $(2)
115 # obj_template : generate Makefile rules for a given resultant object
116 # of a particular source file. (We can have multiple objects per
117 # source file via the OBJS_xxx list.)
119 # $(1) is the full path to the source file (e.g. "drivers/net/rtl8139.c")
120 # $(2) is the full path to the .d file (e.g. "bin/deps/drivers/net/rtl8139.d")
121 # $(3) is the source type (e.g. "c")
122 # $(4) is the object name (e.g. "rtl8139")
126 @$(CPP) $(CFLAGS) $(CFLAGS_$(3)) $(CFLAGS_$(4)) -DOBJECT=$(4) \
127 -Wno-error -M $(1) -MT "$(4)_DEPS" -MG -MP | \
128 sed 's/_DEPS\s*:/_DEPS =/' >> $(2)
129 @$(ECHO) '\n$$(BIN)/$(4).o : $(1) $$(MAKEDEPS) $$($(4)_DEPS)' \
130 '\n\t$$(QM)$(ECHO) " [BUILD] $$@"\n' \
131 '\n\t$$(RULE_$(3))\n' \
132 '\nBOBJS += $$(BIN)/$(4).o\n' \
133 $(foreach TGT,$(DEBUG_TARGETS), \
134 $(if $(RULE_$(3)_to_$(TGT)), \
135 '\n$$(BIN)/$(4).$(TGT) : $(1) $$(MAKEDEPS) $$($(4)_DEPS)' \
136 '\n\t$$(QM)$(ECHO) " [BUILD] $$@"\n' \
137 '\n\t$$(RULE_$(3)_to_$(TGT))\n' \
138 '\n$(TGT)_OBJS += $$(BIN)/$(4).$(TGT)\n' ) ) \
139 '\n$(2) : $$($(4)_DEPS)\n' \
140 '\nTAGS : $$($(4)_DEPS)\n' \
145 # Rule to generate the Makefile rules files to be included
147 $(BIN)/deps/%.d : % $(MAKEDEPS) $(PARSEROM)
148 $(if $(filter $(AUTO_SRCS),$<),$(call src_template,$<,$@,$(subst .,,$(suffix $<)),$(basename $(notdir $<))),@$(ECHO) 'ERROR: $< is not an AUTO_SRC' ; exit 1)
150 # Calculate and include the list of Makefile rules files
152 AUTO_DEPS = $(patsubst %,$(BIN)/deps/%.d,$(AUTO_SRCS))
155 @$(ECHO) $(AUTO_DEPS)
156 VERYCLEANUP += $(BIN)/deps
158 # The following variables are created by the Makefile rules files
168 # Generate the NIC file from the parsed source files. The NIC file is
169 # only for rom-o-matic.
171 $(BIN)/NIC : $(AUTO_DEPS)
172 @$(ECHO) '# This is an automatically generated file, do not edit' > $@
173 @$(ECHO) '# It does not affect anything in the build, ' \
174 'it is only for rom-o-matic' >> $@
176 @perl -ne 'chomp; print "$$1\n" if /\# NIC\t(.*)$$/' $^ >> $@
177 CLEANUP += $(BIN)/NIC
179 # Analyse a target name (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and
180 # derive the variables:
182 # TGT_ELEMENTS : the elements of the target (e.g. "dfe538 prism2_pci")
183 # TGT_PREFIX : the prefix type (e.g. "zrom")
184 # TGT_DRIVERS : the driver for each element (e.g. "rtl8139 prism2_pci")
185 # TGT_ROM_NAME : the ROM name (e.g. "dfe538")
186 # TGT_MEDIA : the media type (e.g. "rom")
188 DRIVERS_gpxe = $(DRIVERS)
189 CARD_DRIVER = $(firstword $(DRIVER_$(1)) $(1))
190 TGT_ELEMENTS = $(subst --, ,$(firstword $(subst ., ,$(notdir $@))))
191 TGT_PREFIX = $(word 2,$(subst ., ,$(notdir $@)))
192 TGT_ROM_NAME = $(firstword $(TGT_ELEMENTS))
193 TGT_DRIVERS = $(strip $(if $(DRIVERS_$(TGT_ROM_NAME)), \
194 $(DRIVERS_$(TGT_ROM_NAME)), \
195 $(foreach TGT_ELEMENT,$(TGT_ELEMENTS), \
196 $(call CARD_DRIVER,$(TGT_ELEMENT))) ))
197 TGT_MEDIA = $(subst z,,$(TGT_PREFIX))
199 # Look up ROM IDs for the current target
200 # (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the variables:
202 # TGT_PCI_VENDOR : the PCI vendor ID (e.g. "0x1186")
203 # TGT_PCI_DEVICE : the PCI device ID (e.g. "0x1300")
205 TGT_PCI_VENDOR = $(PCI_VENDOR_$(TGT_ROM_NAME))
206 TGT_PCI_DEVICE = $(PCI_DEVICE_$(TGT_ROM_NAME))
208 # Calculate link-time options for the current target
209 # (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the variables:
211 # TGT_LD_DRIVERS : symbols to require in order to drag in the relevant drivers
212 # (e.g. "obj_rtl8139 obj_prism2_pci")
213 # TGT_LD_IDS : symbols to define in order to fill in ID structures in the
214 # ROM header (e.g."pci_vendor_id=0x1186 pci_device_id=0x1300")
216 TGT_LD_DRIVERS = $(subst -,_,$(patsubst %,obj_%,$(TGT_DRIVERS)))
217 TGT_LD_PREFIX = obj_$(TGT_PREFIX)prefix
218 TGT_LD_IDS = $(if $(TGT_PCI_VENDOR),pci_vendor_id=$(TGT_PCI_VENDOR)) \
219 $(if $(TGT_PCI_DEVICE),pci_device_id=$(TGT_PCI_DEVICE))
221 # Calculate linker flags based on link-time options for the current
222 # target type (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the
225 # TGT_LD_FLAGS : target-specific flags to pass to linker (e.g.
226 # "-u obj_zpciprefix -u obj_rtl8139 -u obj_prism2_pci
227 # --defsym pci_vendor=0x1186 --defsym pci_device=0x1300")
229 TGT_LD_FLAGS = $(foreach SYM,$(TGT_LD_PREFIX) $(TGT_LD_DRIVERS) obj_config,\
230 -u $(SYM) --defsym check_$(SYM)=$(SYM) ) \
231 $(patsubst %,--defsym %,$(TGT_LD_IDS))
233 # Calculate makerom flags for the specific target
234 # (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the variables:
236 # TGT_MAKEROM_FLAGS : target-specific flags for makerom (e.g.
237 # "-p 0x1186,0x1300")
239 TGT_MAKEROM_FLAGS = $(strip $(MAKEROM_FLAGS_$(TGT_ROM_NAME)) \
240 $(if $(TGT_PCI_VENDOR),$(strip -p $(TGT_PCI_VENDOR),$(TGT_PCI_DEVICE))))
242 # Calculate list of debugging versions of objects to be included in
246 DEBUG_LIST = $(subst $(COMMA), ,$(DEBUG))
247 DEBUG_OBJ_LEVEL = $(firstword $(word 2,$(subst :, ,$(1))) 1)
248 DEBUG_OBJ_BASE = $(word 1,$(subst :, ,$(1))).dbg$(call DEBUG_OBJ_LEVEL,$(1))
249 DEBUG_OBJ = $(BIN)/$(call DEBUG_OBJ_BASE,$(1)).o
250 DEBUG_ORIG_OBJ = $(BIN)/$(word 1,$(subst :, ,$(1))).o
251 DEBUG_OBJS = $(foreach D,$(DEBUG_LIST),$(call DEBUG_OBJ,$(D)))
252 DEBUG_ORIG_OBJS = $(foreach D,$(DEBUG_LIST),$(call DEBUG_ORIG_OBJ,$(D)))
253 BLIB_OBJS = $(DEBUG_OBJS) $(filter-out $(DEBUG_ORIG_OBJS),$(BOBJS))
255 # Print out all derived information for a given target.
258 @$(ECHO) 'Elements : $(TGT_ELEMENTS)'
259 @$(ECHO) 'Prefix : $(TGT_PREFIX)'
260 @$(ECHO) 'Drivers : $(TGT_DRIVERS)'
261 @$(ECHO) 'ROM name : $(TGT_ROM_NAME)'
262 @$(ECHO) 'Media : $(TGT_MEDIA)'
264 @$(ECHO) 'PCI vendor : $(TGT_PCI_VENDOR)'
265 @$(ECHO) 'PCI device : $(TGT_PCI_DEVICE)'
267 @$(ECHO) 'LD driver symbols : $(TGT_LD_DRIVERS)'
268 @$(ECHO) 'LD prefix symbols : $(TGT_LD_PREFIX)'
269 @$(ECHO) 'LD ID symbols : $(TGT_LD_IDS)'
271 @$(ECHO) 'LD target flags : $(TGT_LD_FLAGS)'
273 @$(ECHO) 'makerom target flags : $(TGT_MAKEROM_FLAGS)'
275 @$(ECHO) 'Debugging objects : $(DEBUG_OBJS)'
276 @$(ECHO) 'Replaced objects : $(DEBUG_ORIG_OBJS)'
278 # List of objects included in the last build of blib. This is needed
279 # in order to correctly rebuild blib whenever the list of objects
282 BLIB_LIST = $(BIN)/.blib.list
283 ifneq ($(shell cat $(BLIB_LIST)),$(BLIB_OBJS))
284 $(shell $(ECHO) "$(BLIB_OBJS)" > $(BLIB_LIST))
289 VERYCLEANUP += $(BLIB_LIST)
291 # Library of all objects
294 $(BLIB) : $(BLIB_OBJS) $(BLIB_LIST) $(MAKEDEPS)
296 $(QM)$(ECHO) " [AR] $@"
297 $(Q)$(AR) r $@ $(BLIB_OBJS)
301 # Build an intermediate object file from the objects required for the
304 $(BIN)/%.tmp : $(BLIB) $(MAKEDEPS) $(LDSCRIPT)
305 $(QM)$(ECHO) " [LD] $@"
306 $(Q)$(LD) $(LDFLAGS) -T $(LDSCRIPT) $(TGT_LD_FLAGS) $(BLIB) -o $@ \
307 -Map $(BIN)/$*.tmp.map
308 $(Q)$(OBJDUMP) -ht $@ | $(SORTOBJDUMP) >> $(BIN)/$*.tmp.map
310 # Show a linker map for the specified target
312 $(BIN)/%.map : $(BIN)/%.tmp
313 @less $(BIN)/$*.tmp.map
315 # Extract compression information from intermediate object file
317 $(BIN)/%.zinfo : $(BIN)/%.tmp
318 $(QM)$(ECHO) " [ZINFO] $@"
319 $(Q)$(OBJCOPY) -O binary -j .zinfo $< $@
321 # Build raw binary file from intermediate object file
323 $(BIN)/%.bin : $(BIN)/%.tmp
324 $(QM)$(ECHO) " [BIN] $@"
325 $(Q)$(OBJCOPY) -O binary -R .zinfo $< $@
327 # Compress raw binary file
329 $(BIN)/%.zbin : $(BIN)/%.bin $(BIN)/%.zinfo $(ZBIN)
330 $(QM)$(ECHO) " [ZBIN] $@"
331 $(Q)$(ZBIN) $(BIN)/$*.bin $(BIN)/$*.zinfo > $@
333 # Build bochs symbol table
334 $(BIN)/%.bxs : $(BIN)/%.tmp
335 $(NM) $< | cut -d" " -f1,3 > $@
337 # Rules for each media format. These are generated and placed in an
338 # external Makefile fragment. We could do this via $(eval ...), but
339 # that would require make >= 3.80.
341 # Note that there's an alternative way to generate most .rom images:
342 # they can be copied from their 'master' ROM image using cp and
343 # reprocessed with makerom to add the PCI IDs and ident string. The
344 # relevant rule would look something like:
346 # $(BIN)/dfe538%rom : $(BIN)/rtl8139%rom
350 # You can derive the ROM/driver relationships using the variables
351 # DRIVER_<rom> and/or ROMS_<driver>.
353 # We don't currently do this, because (a) it would require generating
354 # yet more Makefile fragments (since you need a rule for each ROM in
355 # ROMS), and (b) the linker is so fast that it probably wouldn't make
356 # much difference to the overall build time.
361 AUTO_MEDIA = $(filter-out $(NON_AUTO_MEDIA),$(MEDIA))
363 @$(ECHO) $(AUTO_MEDIA)
365 # media_template : create Makefile rules for specified media
367 # $(1) is the media name (e.g. "rom")
368 # $(2) is the full path to the .d file (e.g. "bin/deps/rom.media.d")
370 define media_template
372 @$(ECHO) "Generating Makefile rules for $(1) media"
373 @$(MKDIR) -p $(dir $(2))
376 @$(ECHO) '$$(BIN)/%.$(1) : $$(BIN)/%.$(1).zbin' \
377 '\n\t$$(QM)$(ECHO) " [FINISH] $$@"' \
378 '\n\t$$(Q)$$(CP) $$< $$@' \
379 '\n\t$$(Q)$$(FINALISE_$(1))' \
384 # Rule to generate the Makefile rules to be included
386 $(BIN)/deps/%.media.d : $(MAKEDEPS)
387 $(if $(filter $(AUTO_MEDIA),$*), \
388 $(call media_template,$*,$@), \
389 @$(ECHO) 'ERROR: $* is not an AUTO_MEDIA' ; exit 1)
391 # Calculate and include the list of Makefile rules files
393 MEDIA_DEPS = $(patsubst %,$(BIN)/deps/%.media.d,$(AUTO_MEDIA))
395 @$(ECHO) $(MEDIA_DEPS)
396 include $(MEDIA_DEPS)
398 # The "allXXXs" targets for each suffix
400 allall: allroms allzroms allpxes allisos alldsks
401 allroms allzroms : all%s : $(foreach ROM,$(ROMS),$(BIN)/$(ROM).%)
402 allpxes allisos alldsks : all%s : $(foreach DRIVER,$(DRIVERS),$(BIN)/$(DRIVER).%)
406 $(BIN)/etherboot.% : $(BIN)/gpxe.%
407 ln -sf $(notdir $<) $@
409 # Wrap up binary blobs
411 $(BIN)/%.o : payload/%.img
412 $(QM)echo " [WRAP] $@"
413 $(Q)$(LD) -b binary -r -o $@ $< --undefined obj_payload \
416 BOBJS += $(patsubst payload/%.img,$(BIN)/%.o,$(wildcard payload/*.img))
418 # The compression utilities
420 $(NRV2B) : util/nrv2b.c $(MAKEDEPS)
421 $(QM)$(ECHO) " [HOSTCC] $@"
422 $(Q)$(HOST_CC) -O2 -DENCODE -DDECODE -DMAIN -DVERBOSE -DNDEBUG \
423 -DBITSIZE=32 -DENDIAN=0 -o $@ $<
426 $(ZBIN) : util/zbin.c util/nrv2b.c $(MAKEDEPS)
427 $(QM)$(ECHO) " [HOSTCC] $@"
428 $(Q)$(HOST_CC) -O2 -o $@ $<
431 # Auto-incrementing build serial number. Append "bs" to your list of
432 # build targets to get a serial number printed at the end of the
433 # build. Enable -DBUILD_SERIAL in order to see it when the code runs.
435 BUILDSERIAL_H = config/.buildserial.h
436 BUILDSERIAL_NOW = config/.buildserial.now
437 BUILDSERIAL_NEXT = config/.buildserial.next
439 $(BUILDSERIAL_NOW) $(BUILDSERIAL_NEXT) :
442 $(BUILDSERIAL_H) : $(BUILDSERIAL_NOW) $(BUILDSERIAL_NEXT)
443 $(ECHO) '#define BUILD_SERIAL_NUM $(shell cat $<)' > $@
445 ifeq ($(filter bs,$(MAKECMDGOALS)),bs)
446 $(shell diff -q $(BUILDSERIAL_NOW) $(BUILDSERIAL_NEXT) > /dev/null || \
447 cp -f $(BUILDSERIAL_NEXT) $(BUILDSERIAL_NOW))
450 bs : $(BUILDSERIAL_NOW)
451 @$(ECHO) $$(( $(shell cat $<) + 1 )) > $(BUILDSERIAL_NEXT)
452 @$(ECHO) "Build serial number is $(shell cat $<)"
454 # List of available architectures
456 ARCHS = $(filter-out CVS,$(patsubst arch/%,%,$(wildcard arch/*)))
460 OTHER_ARCHS = $(filter-out $(ARCH),$(ARCHS))
462 @$(ECHO) $(OTHER_ARCHS)
464 # Build the TAGS file for emacs
469 ctags -e -R -f $@ --exclude=bin \
470 $(foreach ARCH,$(OTHER_ARCHS),--exclude=arch/$(ARCH))
473 # Symbol table checks
475 SYMTAB = $(BIN)/symtab
477 $(OBJDUMP) -w -t $< > $@
479 CLEANUP += $(BIN)/symtab
484 # Force rebuild for any given target
488 $(MAKE) $(MAKEFLAGS) $(BIN)/$*
492 $(BIN)/doxygen.cfg : doxygen.cfg $(MAKEDEPS)
493 $(PERL) -pe 's{\@SRCDIRS\@}{$(SRCDIRS)}; ' \
494 -e 's{\@BIN\@}{$(BIN)}; ' \
495 -e 's{\@ARCH\@}{$(ARCH)}; ' \
498 $(BIN)/doc : $(BIN)/doxygen.cfg
503 VERYCLEANUP += $(BIN)/doc
508 @[ -f $(BIN)/doc/html/index.html ] || $(MAKE) $(BIN)/doc
509 @if [ -n "$$BROWSER" ] ; then \
510 ( $$BROWSER $(BIN)/doc/html/index.html & ) ; \
512 $(ECHO) "Documentation index in $(BIN)/doc/html/index.html" ; \
521 $(RM) -r $(VERYCLEANUP)
523 # Make clean tarballs for release
525 gpxe-tarball : ../VERSION
526 ($(ECHO) -n $(VERSION) ''; date -u +'%Y-%m-%d') > ../VERSION
527 $(RM) -r /tmp/gpxe/gpxe-$(VERSION)
528 mkdir -p /tmp/gpxe/gpxe-$(VERSION)
529 cp -rP .. /tmp/gpxe/gpxe-$(VERSION)
530 $(RM) -r /tmp/gpxe/CVS
531 ( cd /tmp/gpxe/gpxe-$(VERSION)/src ; $(RM) -r bin/deps ; $(MAKE) clean ; $(MAKE) veryclean )
532 ( cd /tmp/gpxe; tar cf /tmp/gpxe/gpxe-$(VERSION).tar --exclude CVS --exclude "#*" \
533 --exclude "*~" gpxe-$(VERSION) )
534 bzip2 -9 < /tmp/gpxe/gpxe-$(VERSION).tar > /tmp/gpxe/gpxe-$(VERSION).tar.bz2
535 gzip -9 < /tmp/gpxe/gpxe-$(VERSION).tar > /tmp/gpxe/gpxe-$(VERSION).tar.gz
536 $(RM) -r /tmp/gpxe/gpxe-$(VERSION)
537 $(RM) /tmp/gpxe/gpxe-$(VERSION).tar
538 ( cd /tmp/gpxe ; tar -zxf /tmp/gpxe/gpxe-$(VERSION).tar.gz )