53d8a800a8c1364c686a4f093cbb3be23152122e
[people/xl0/gpxe-arm.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 # Objects to be removed by "make clean"
7 #
8 CLEANUP := $(BIN)/*.* # *.* to avoid catching the "CVS" directory
9
10 # Version number calculations 
11 #
12 VERSION_MAJOR   = 0
13 VERSION_MINOR   = 5
14 VERSION_PATCH   = 1
15 EXTRAVERSION    =       
16 MM_VERSION      = $(VERSION_MAJOR).$(VERSION_MINOR)
17 VERSION         = $(MM_VERSION).$(VERSION_PATCH)$(EXTRAVERSION)
18 CFLAGS          += -DVERSION_MAJOR=$(VERSION_MAJOR) \
19                    -DVERSION_MINOR=$(VERSION_MINOR) \
20                    -DVERSION=\"$(VERSION)\"
21 IDENT           = '$(@F) $(VERSION) (GPL) etherboot.org'
22 version :
23         @echo $(VERSION)
24
25 # Check for tools that can cause failed builds
26 #
27 .toolcheck : Makefile Config
28         @if $(CC) -v 2>&1 | grep -is 'gcc version 2\.96' > /dev/null; then \
29                 echo 'gcc 2.96 is unsuitable for compiling Etherboot'; \
30                 echo 'Use gcc 2.95 or gcc 3.x instead'; \
31                 exit 1; \
32         fi
33         @if [ `perl -e 'use bytes; print chr(255)' | wc -c` = 2 ]; then \
34                 echo 'Your Perl version has a Unicode handling bug'; \
35                 echo 'Execute this command before compiling Etherboot:'; \
36                 echo 'export LANG=$${LANG%.UTF-8}'; \
37                 exit 1; \
38         fi
39         @$(TOUCH) $@
40 VERYCLEANUP     += .toolcheck
41
42 # Build verbosity
43 #
44 ifeq ($(V),1)
45 Q = 
46 QM = @\#
47 else
48 Q = @
49 QM = @
50 endif
51
52 # Check for an old version of gas (binutils 2.9.1)
53 #
54 OLDGAS  := $(shell $(AS) --version | grep -q '2\.9\.1' && echo -DGAS291)
55 CFLAGS  += $(OLDGAS)
56 oldgas :
57         @echo $(oldgas)
58
59 # compiler.h is needed for our linking and debugging system
60 #
61 CFLAGS  += -include compiler.h
62
63 # config/%.h files are generated from config.h using mkconfig.pl
64 config/%.h : config.h
65         $(MKCONFIG) $<
66 CLEANUP += config/*.h
67
68 # SRCDIRS lists all directories containing source files.
69 srcdirs :
70         @echo $(SRCDIRS)
71
72 # SRCS lists all .c or .S files found in any SRCDIR
73 #
74 SRCS    += $(wildcard $(patsubst %,%/*.c,$(SRCDIRS)))
75 SRCS    += $(wildcard $(patsubst %,%/*.S,$(SRCDIRS)))
76 srcs :
77         @echo $(SRCS)
78
79 # AUTO_SRCS lists all files in SRCS that are not mentioned in
80 # NON_AUTO_SRCS.  Files should be added to NON_AUTO_SRCS if they
81 # cannot be built using the standard build template.
82 #
83 AUTO_SRCS = $(filter-out $(NON_AUTO_SRCS),$(SRCS))
84 autosrcs :
85         @echo $(AUTO_SRCS)
86
87 # We automatically generate rules for any file mentioned in AUTO_SRCS
88 # using the following set of templates.  It would be cleaner to use
89 # $(eval ...), but this function exists only in GNU make >= 3.80.
90
91 # src_template : generate Makefile rules for a given source file
92 #
93 # $(1) is the full path to the source file (e.g. "drivers/net/rtl8139.c")
94 # $(2) is the full path to the .d file (e.g. "bin/deps/drivers/net/rtl8139.d")
95 # $(3) is the source type (e.g. "c")
96 # $(4) is the source base name (e.g. "rtl8139")
97 #
98 define src_template
99
100         @echo "Generating Makefile rules for $(1)"
101         @$(MKDIR) -p $(dir $(2))
102         @$(RM) $(2)
103         @$(TOUCH) $(2)
104         $(foreach OBJ,$(if $(OBJS_$(4)),$(OBJS_$(4)),$(4)), \
105                 $(call obj_template,$(1),$(2),$(3),$(OBJ)))
106         @$(PARSEROM) $(1) >> $(2)
107
108 endef
109
110 # obj_template : generate Makefile rules for a given resultant object
111 # of a particular source file.  (We can have multiple objects per
112 # source file via the OBJS_xxx list.)
113 #
114 # $(1) is the full path to the source file (e.g. "drivers/net/rtl8139.c")
115 # $(2) is the full path to the .d file (e.g. "bin/deps/drivers/net/rtl8139.d")
116 # $(3) is the source type (e.g. "c")
117 # $(4) is the object name (e.g. "rtl8139")
118 #
119 define obj_template
120
121         @$(CPP) $(CFLAGS) $(CFLAGS_$(3)) $(CFLAGS_$(4)) \
122                 -M $(1) -MT "$(4)_DEPS" -MG | tr : = >> $(2)
123         @echo -e '\n$$(BIN)/$(4).o : $(1) $$(MAKEDEPS) $$($(4)_DEPS)' \
124                  '\n\t$$(QM)echo "  [BUILD] $$@"\n' \
125                  '\n\t$$(RULE_$(3))\n' \
126                  '\nBOBJS += $$(BIN)/$(4).o\n' \
127                  $(foreach TGT,$(DEBUG_TARGETS), \
128                     $(if $(RULE_$(3)_to_$(TGT)), \
129                     '\n$$(BIN)/$(4).$(TGT) : $(1) $$(MAKEDEPS) $$($(4)_DEPS)' \
130                     '\n\t$$(QM)echo "  [BUILD] $$@"\n' \
131                     '\n\t$$(RULE_$(3)_to_$(TGT))\n' \
132                     '\n$(TGT)_OBJS += $$(BIN)/$(4).$(TGT)\n' ) ) \
133                  '\n$(2) : $$($(4)_DEPS)\n' \
134                  '\nTAGS : $$($(4)_DEPS)\n' \
135                 >> $(2)
136
137 endef
138
139 # Rule to generate the Makefile rules files to be included
140 #
141 $(BIN)/deps/%.d : % $(MAKEDEPS) $(PARSEROM)
142         $(if $(filter $(AUTO_SRCS),$<),$(call src_template,$<,$@,$(subst .,,$(suffix $<)),$(basename $(notdir $<))),@echo 'ERROR: $< is not an AUTO_SRC' ; exit 1)
143
144 # Calculate and include the list of Makefile rules files
145 #
146 AUTO_DEPS       = $(patsubst %,$(BIN)/deps/%.d,$(AUTO_SRCS))
147 include $(AUTO_DEPS)
148 autodeps :
149         @echo $(AUTO_DEPS)
150 VERYCLEANUP     += $(BIN)/deps
151
152 # The following variables are created by the Makefile rules files
153 #
154 bobjs :
155         @echo $(BOBJS)
156 drivers :
157         @echo $(DRIVERS)
158 .PHONY : drivers
159 roms :
160         @echo $(ROMS)
161
162 # Generate the NIC file from the parsed source files.  The NIC file is
163 # only for rom-o-matic.
164 #
165 $(BIN)/NIC : $(AUTO_DEPS)
166         @echo '# This is an automatically generated file, do not edit' > $@
167         @echo '# It does not affect anything in the build, ' \
168              'it is only for rom-o-matic' >> $@
169         @echo >> $@
170         @perl -ne 'chomp; print "$$1\n" if /\# NIC\t(.*)$$/' $^ >> $@
171 CLEANUP         += $(BIN)/NIC
172
173 # Analyse a target name (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and
174 # derive the variables:
175
176 # TGT_ELEMENTS : the elements of the target (e.g. "dfe538 prism2_pci")
177 # TGT_PREFIX   : the prefix type (e.g. "zrom")
178 # TGT_DRIVERS  : the driver for each element (e.g. "rtl8139 prism2_pci")
179 # TGT_ROM_NAME : the ROM name (e.g. "dfe538")
180 # TGT_MEDIA    : the media type (e.g. "rom")
181 #
182 DRIVERS_etherboot = $(DRIVERS)
183 CARD_DRIVER     = $(firstword $(DRIVER_$(1)) $(1))
184 TGT_ELEMENTS    = $(subst --, ,$(firstword $(subst ., ,$(notdir $@))))
185 TGT_PREFIX      = $(word 2,$(subst ., ,$(notdir $@)))
186 TGT_ROM_NAME    = $(firstword $(TGT_ELEMENTS))
187 TGT_DRIVERS     = $(strip $(if $(DRIVERS_$(TGT_ROM_NAME)), \
188                                $(DRIVERS_$(TGT_ROM_NAME)), \
189                                $(foreach TGT_ELEMENT,$(TGT_ELEMENTS), \
190                                  $(call CARD_DRIVER,$(TGT_ELEMENT))) ))
191 TGT_MEDIA       = $(subst z,,$(TGT_PREFIX))
192
193 # Look up ROM IDs for the current target
194 # (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the variables:
195 #
196 # TGT_PCI_VENDOR : the PCI vendor ID (e.g. "0x1186")
197 # TGT_PCI_DEVICE : the PCI device ID (e.g. "0x1300")
198 #
199 TGT_PCI_VENDOR  = $(PCI_VENDOR_$(TGT_ROM_NAME))
200 TGT_PCI_DEVICE  = $(PCI_DEVICE_$(TGT_ROM_NAME))
201
202 # Calculate link-time options for the current target
203 # (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the variables:
204 #
205 # TGT_LD_DRIVERS : symbols to require in order to drag in the relevant drivers
206 #                  (e.g. "obj_rtl8139 obj_prism2_pci")
207 # TGT_LD_IDS :     symbols to define in order to fill in ID structures in the
208 #                  ROM header (e.g."pci_vendor_id=0x1186 pci_device_id=0x1300")
209 #
210 TGT_LD_DRIVERS  = $(subst -,_,$(patsubst %,obj_%,$(TGT_DRIVERS)))
211 TGT_LD_PREFIX   = obj_$(TGT_PREFIX)prefix
212 TGT_LD_IDS      = $(if $(TGT_PCI_VENDOR),pci_vendor_id=$(TGT_PCI_VENDOR)) \
213                   $(if $(TGT_PCI_DEVICE),pci_device_id=$(TGT_PCI_DEVICE))
214
215 # Calculate linker flags based on link-time options for the current
216 # target type (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the
217 # variables:
218 #
219 # TGT_LD_FLAGS : target-specific flags to pass to linker (e.g.
220 #                "-u obj_zpciprefix -u obj_rtl8139 -u obj_prism2_pci
221 #                 --defsym pci_vendor=0x1186 --defsym pci_device=0x1300")
222 #
223 TGT_LD_FLAGS    = $(foreach SYM,$(TGT_LD_PREFIX) $(TGT_LD_DRIVERS) obj_config,\
224                     -u $(SYM) --defsym check_$(SYM)=$(SYM) ) \
225                   $(patsubst %,--defsym %,$(TGT_LD_IDS))
226
227 # Calculate makerom flags for the specific target
228 # (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the variables:
229 #
230 # TGT_MAKEROM_FLAGS : target-specific flags for makerom (e.g.
231 #                     "-p 0x1186,0x1300")
232 #
233 TGT_MAKEROM_FLAGS = $(strip $(MAKEROM_FLAGS_$(TGT_ROM_NAME)) \
234        $(if $(TGT_PCI_VENDOR),$(strip -p $(TGT_PCI_VENDOR),$(TGT_PCI_DEVICE))))
235
236 # Calculate list of debugging versions of objects to be included in
237 # the target.
238 #
239 COMMA           := ,
240 SPACE           := $(subst x, ,x)
241 DEBUG_LIST      = $(subst $(COMMA), ,$(DEBUG))
242 DEBUG_OBJ_LEVEL = $(firstword $(word 2,$(subst :, ,$(1))) 1)
243 DEBUG_OBJ_BASE  = $(word 1,$(subst :, ,$(1))).dbg$(call DEBUG_OBJ_LEVEL,$(1))
244 DEBUG_OBJ       = $(BIN)/$(call DEBUG_OBJ_BASE,$(1)).o
245 DEBUG_ORIG_OBJ  = $(BIN)/$(word 1,$(subst :, ,$(1))).o
246 DEBUG_OBJS      = $(foreach D,$(DEBUG_LIST),$(call DEBUG_OBJ,$(D)))
247 DEBUG_ORIG_OBJS = $(foreach D,$(DEBUG_LIST),$(call DEBUG_ORIG_OBJ,$(D)))
248 BLIB_OBJS       = $(DEBUG_OBJS) $(filter-out $(DEBUG_ORIG_OBJS),$(BOBJS))
249 BLIB_TAG_ELEM   = $(foreach D,$(DEBUG_LIST),$(call DEBUG_OBJ_BASE,$(D)))
250 BLIB_TAG        = $(subst $(SPACE),-,$(strip blib $(sort $(BLIB_TAG_ELEM))))
251
252 # Print out all derived information for a given target.
253 #
254 $(BIN)/%.info :
255         @echo 'Elements             : $(TGT_ELEMENTS)'
256         @echo 'Prefix               : $(TGT_PREFIX)'
257         @echo 'Drivers              : $(TGT_DRIVERS)'
258         @echo 'ROM name             : $(TGT_ROM_NAME)'
259         @echo 'Media                : $(TGT_MEDIA)'
260         @echo
261         @echo 'PCI vendor           : $(TGT_PCI_VENDOR)'
262         @echo 'PCI device           : $(TGT_PCI_DEVICE)'
263         @echo
264         @echo 'LD driver symbols    : $(TGT_LD_DRIVERS)'
265         @echo 'LD prefix symbols    : $(TGT_LD_PREFIX)'
266         @echo 'LD ID symbols        : $(TGT_LD_IDS)'
267         @echo
268         @echo 'LD target flags      : $(TGT_LD_FLAGS)'
269         @echo
270         @echo 'makerom target flags : $(TGT_MAKEROM_FLAGS)'
271         @echo
272         @echo 'Debugging objects    : $(DEBUG_OBJS)'
273         @echo 'Replaced objects     : $(DEBUG_ORIG_OBJS)'
274         @echo 'Build library tag    : $(BLIB_TAG)'
275
276 # Library of all objects
277 #
278 BLIB            = $(BIN)/$(BLIB_TAG).a
279 $(BLIB) : $(BLIB_OBJS) $(MAKEDEPS)
280         $(Q)$(RM) $(BLIB)
281         $(QM)echo "  [AR] $@"
282         $(Q)$(AR) r $@ $(BLIB_OBJS)
283         $(Q)$(RANLIB) $@
284 blib : $(BLIB)
285
286 # Build an intermediate object file from the objects required for the
287 # specified target.
288 #
289 $(BIN)/%.tmp : $(BLIB) $(MAKEDEPS) $(LDSCRIPT) 
290         $(QM)echo "  [LD] $@"
291         $(Q)$(LD) $(LDFLAGS) -T $(LDSCRIPT) $(TGT_LD_FLAGS) $(BLIB) -o $@ \
292                 -Map $(BIN)/$*.tmp.map
293         $(Q)$(OBJDUMP) -ht $@ | $(SORTOBJDUMP) >> $(BIN)/$*.tmp.map
294
295 # Show a linker map for the specified target
296 #
297 $(BIN)/%.map : $(BIN)/%.tmp
298         @less $(BIN)/$*.tmp.map
299
300 # Build bochs symbol table
301 $(BIN)/%.bxs : $(BIN)/%.tmp
302         $(NM) $< | cut -d" " -f1,3 > $@
303
304 # Rules for each media format.  These are generated and placed in an
305 # external Makefile fragment.  We could do this via $(eval ...), but
306 # that would require make >= 3.80.
307
308 # Note that there's an alternative way to generate most .rom images:
309 # they can be copied from their 'master' ROM image using cp and
310 # reprocessed with makerom to add the PCI IDs and ident string.  The
311 # relevant rule would look something like:
312 #
313 #   $(BIN)/dfe538%rom : $(BIN)/rtl8139%rom
314 #       cat $< $@
315 #       $(FINALISE_rom)
316
317 # You can derive the ROM/driver relationships using the variables
318 # DRIVER_<rom> and/or ROMS_<driver>.
319
320 # We don't currently do this, because (a) it would require generating
321 # yet more Makefile fragments (since you need a rule for each ROM in
322 # ROMS), and (b) the linker is so fast that it probably wouldn't make
323 # much difference to the overall build time.
324
325 media :
326         @echo $(MEDIA)
327
328 AUTO_MEDIA      = $(filter-out $(NON_AUTO_MEDIA),$(MEDIA))
329 automedia :
330         @echo $(AUTO_MEDIA)
331
332 # media_template : create Makefile rules for specified media
333 #
334 # $(1) is the media name (e.g. "rom")
335 # $(2) is the full path to the .d file (e.g. "bin/deps/rom.media.d")
336 #
337 define media_template
338
339         @echo "Generating Makefile rules for $(1) media"
340         @$(MKDIR) -p $(dir $(2))
341         @$(RM) $(2)
342         @$(TOUCH) $(2)
343         @echo -e '$$(BIN)/%$(1) : $$(BIN)/%$(1).tmp' \
344                   '\n\t$$(OBJCOPY) -O binary $$< $$@' \
345                   '\n\t$$(FINALISE_$(1))' \
346                 > $(2)
347
348 endef
349
350 # Rule to generate the Makefile rules to be included
351 #
352 $(BIN)/deps/%.media.d : $(MAKEDEPS)
353         $(if $(filter $(AUTO_MEDIA),$*), \
354                 $(call media_template,$*,$@), \
355                 @echo 'ERROR: $* is not an AUTO_MEDIA' ; exit 1)
356
357 # Calculate and include the list of Makefile rules files
358 #
359 MEDIA_DEPS              = $(patsubst %,$(BIN)/deps/%.media.d,$(AUTO_MEDIA))
360 mediadeps :
361         @echo $(MEDIA_DEPS)
362 include $(MEDIA_DEPS)
363
364 # The "allXXXs" targets for each suffix
365 #
366 allroms allzroms : all%s : $(foreach ROM,$(ROMS),$(BIN)/$(ROM).%)
367 all%s : $(foreach DRIVER,$(DRIVERS),$(BIN)/$(DRIVER).%)
368
369 # The compressor utility
370 #
371 $(NRV2B) : util/nrv2b.c $(MAKEDEPS)
372         $(HOST_CC) -O2 -DENCODE -DDECODE -DMAIN -DVERBOSE -DNDEBUG \
373                        -DBITSIZE=32 -DENDIAN=0 -o $@ $<
374 CLEANUP += $(NRV2B)
375
376 # Auto-incrementing build serial number.  Append "bs" to your list of
377 # build targets to get a serial number printed at the end of the
378 # build.  Enable -DBUILD_SERIAL in order to see it when the code runs.
379 #
380 BUILDSERIAL_H           = config/.buildserial.h
381 BUILDSERIAL_NOW         = config/.buildserial.now
382 BUILDSERIAL_NEXT        = config/.buildserial.next
383
384 $(BUILDSERIAL_NOW) $(BUILDSERIAL_NEXT) :
385         echo 1 > $@
386
387 $(BUILDSERIAL_H) : $(BUILDSERIAL_NOW) $(BUILDSERIAL_NEXT)
388         echo '#define BUILD_SERIAL_NUM $(shell cat $<)' > $@
389
390 ifeq ($(filter bs,$(MAKECMDGOALS)),bs)
391 $(shell diff -q $(BUILDSERIAL_NOW) $(BUILDSERIAL_NEXT) > /dev/null || \
392         cp -f $(BUILDSERIAL_NEXT) $(BUILDSERIAL_NOW))
393 endif
394
395 bs : $(BUILDSERIAL_NOW)
396         @echo $$(( $(shell cat $<) + 1 )) > $(BUILDSERIAL_NEXT)
397         @echo "Build serial number is $(shell cat $<)"
398
399 # List of available architectures
400 #
401 ARCHS   = $(filter-out CVS,$(patsubst arch/%,%,$(wildcard arch/*)))
402 archs :
403         @echo $(ARCHS)
404
405 OTHER_ARCHS     = $(filter-out $(ARCH),$(ARCHS))
406 otherarchs :
407         @echo $(OTHER_ARCHS)
408
409 # Build the TAGS file for emacs
410 #
411 TAGS : TAGS.$(ARCH)
412
413 TAGS.$(ARCH) : 
414         ctags -e -R -f $@ --exclude=bin \
415                 $(foreach ARCH,$(OTHER_ARCHS),--exclude=arch/$(ARCH))
416 CLEANUP += TAGS*
417
418 # Symbol table checks
419 #
420 SYMTAB  = $(BIN)/symtab
421 $(SYMTAB) : $(BLIB)
422         $(NM) -o -S $< > $@
423
424 CLEANUP += $(BIN)/symtab
425
426 symcheck : $(SYMTAB)
427         $(SYMCHECK) $<
428
429 # Force rebuild for any given target
430 #
431 $(BIN)/%.rebuild :
432         rm -f $(BIN)/$*
433         $(MAKE) $(MAKEFLAGS) $(BIN)/$*
434
435 # Documentation
436 #
437 $(BIN)/doxygen.cfg : doxygen.cfg $(MAKEDEPS)
438         $(PERL) -pe 's{\@SRCDIRS\@}{$(SRCDIRS)}; ' \
439                 -e  's{\@BIN\@}{$(BIN)}; ' \
440                 -e  's{\@ARCH\@}{$(ARCH)}; ' \
441                 $< > $@
442
443 $(BIN)/doc : $(BIN)/doxygen.cfg
444         $(DOXYGEN) $<
445
446 .PHONY : $(BIN)/doc
447
448 VERYCLEANUP     += $(BIN)/doc
449
450 doc : $(BIN)/doc
451
452 docview :
453         @[ -f $(BIN)/doc/html/index.html ] || $(MAKE) $(BIN)/doc
454         @if [ -n "$$BROWSER" ] ; then \
455                 ( $$BROWSER $(BIN)/doc/html/index.html & ) ; \
456         else \
457                 echo "Documentation index in $(BIN)/doc/html/index.html" ; \
458         fi
459
460 # Clean-up
461 #
462 clean :
463         $(RM) $(CLEANUP)
464
465 veryclean : clean
466         $(RM) -r $(VERYCLEANUP)
467
468 # Make clean tarballs for release
469
470 gpxe-tarball : ../VERSION
471         (echo -n $(VERSION) ''; date -u +'%Y-%m-%d') > ../VERSION
472         $(RM) -r /tmp/gpxe/gpxe-$(VERSION)
473         mkdir -p /tmp/gpxe/gpxe-$(VERSION)
474         cp -rP .. /tmp/gpxe/gpxe-$(VERSION)
475         $(RM) -r /tmp/gpxe/CVS
476         ( cd /tmp/gpxe/gpxe-$(VERSION)/src ; $(RM) -r bin/deps ; $(MAKE) clean ; $(MAKE) veryclean )
477         ( cd /tmp/gpxe; tar cf /tmp/gpxe/gpxe-$(VERSION).tar --exclude CVS --exclude "#*" \
478           --exclude "*~" gpxe-$(VERSION) )
479         bzip2 -9 < /tmp/gpxe/gpxe-$(VERSION).tar > /tmp/gpxe/gpxe-$(VERSION).tar.bz2
480         gzip -9 < /tmp/gpxe/gpxe-$(VERSION).tar > /tmp/gpxe/gpxe-$(VERSION).tar.gz
481         $(RM) -r /tmp/gpxe/gpxe-$(VERSION)
482         $(RM) /tmp/gpxe/gpxe-$(VERSION).tar
483         ( cd /tmp/gpxe ; tar -zxf /tmp/gpxe/gpxe-$(VERSION).tar.gz )