Improved building of debugging objects. You can now specify a "DEBUG="
[people/lynusvaz/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 # 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   = 5
13 VERSION_MINOR   = 3
14 VERSION_PATCH   = 14
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 # Check for an old version of gas (binutils 2.9.1)
43 #
44 OLDGAS  := $(shell $(AS) --version | grep -q '2\.9\.1' && echo -DGAS291)
45 CFLAGS  += $(OLDGAS)
46 oldgas :
47         @echo $(oldgas)
48
49 # compiler.h is needed for our linking and debugging system
50 #
51 CFLAGS  += -include compiler.h
52
53 # SRCDIRS lists all directories containing source files.
54 srcdirs :
55         @echo $(SRCDIRS)
56
57 # SRCS lists all .c or .S files found in any SRCDIR
58 #
59 SRCS    += $(wildcard $(patsubst %,%/*.c,$(SRCDIRS)))
60 SRCS    += $(wildcard $(patsubst %,%/*.S,$(SRCDIRS)))
61 srcs :
62         @echo $(SRCS)
63
64 # AUTO_SRCS lists all files in SRCS that are not mentioned in
65 # NON_AUTO_SRCS.  Files should be added to NON_AUTO_SRCS if they
66 # cannot be built using the standard build template.
67 #
68 AUTO_SRCS = $(filter-out $(NON_AUTO_SRCS),$(SRCS))
69 autosrcs :
70         @echo $(AUTO_SRCS)
71
72 # We automatically generate rules for any file mentioned in AUTO_SRCS
73 # using the following set of templates.  It would be cleaner to use
74 # $(eval ...), but this function exists only in GNU make >= 3.80.
75
76 # src_template : generate Makefile rules for a given source file
77 #
78 # $(1) is the full path to the source file (e.g. "drivers/net/rtl8139.c")
79 # $(2) is the full path to the .d file (e.g. "bin/deps/drivers/net/rtl8139.d")
80 # $(3) is the source type (e.g. "c")
81 # $(4) is the source base name (e.g. "rtl8139")
82 #
83 define src_template
84
85         @echo "Generating Makefile rules for $(1)"
86         @$(MKDIR) -p $(dir $(2))
87         @$(RM) $(2)
88         @$(TOUCH) $(2)
89         $(foreach OBJ,$(if $(OBJS_$(4)),$(OBJS_$(4)),$(4)), \
90                 $(call obj_template,$(1),$(2),$(3),$(OBJ)))
91         @$(PARSEROM) $(1) >> $(2)
92
93 endef
94
95 # obj_template : generate Makefile rules for a given resultant object
96 # of a particular source file.  (We can have multiple objects per
97 # source file via the OBJS_xxx list.)
98 #
99 # $(1) is the full path to the source file (e.g. "drivers/net/rtl8139.c")
100 # $(2) is the full path to the .d file (e.g. "bin/deps/drivers/net/rtl8139.d")
101 # $(3) is the source type (e.g. "c")
102 # $(4) is the object name (e.g. "rtl8139")
103 #
104 define obj_template
105
106         @$(CPP) $(CFLAGS) $(CFLAGS_$(3)) $(CFLAGS_$(4)) \
107                 -M $(1) -MT "$(4)_DEPS" | tr : = >> $(2)
108         @echo -e '\n$$(BIN)/$(4).o : $(1) $$(MAKEDEPS) $$($(4)_DEPS)' \
109                  '\n\t$$(RULE_$(3))\n' \
110                  '\nBOBJS += $$(BIN)/$(4).o\n' \
111                  $(foreach TGT,$(DEBUG_TARGETS), \
112                     $(if $(RULE_$(3)_to_$(TGT)), \
113                     '\n$$(BIN)/$(4).$(TGT) : $(1) $$(MAKEDEPS) $$($(4)_DEPS)' \
114                     '\n\t$$(RULE_$(3)_to_$(TGT))\n' \
115                     '\n$(TGT)_OBJS += $$(BIN)/$(4).$(TGT)\n' ) ) \
116                  '\n$(2) : $$($(4)_DEPS)\n' \
117                  '\nTAGS : $$($(4)_DEPS)\n' \
118                 >> $(2)
119
120 endef
121
122 # Rule to generate the Makefile rules files to be included
123 #
124 $(BIN)/deps/%.d : % $(MAKEDEPS) $(PARSEROM)
125         $(if $(filter $(AUTO_SRCS),$<),$(call src_template,$<,$@,$(subst .,,$(suffix $<)),$(basename $(notdir $<))),@echo 'ERROR: $< is not an AUTO_SRC' ; exit 1)
126
127 # Calculate and include the list of Makefile rules files
128 #
129 AUTO_DEPS       = $(patsubst %,$(BIN)/deps/%.d,$(AUTO_SRCS))
130 include $(AUTO_DEPS)
131 autodeps :
132         @echo $(AUTO_DEPS)
133 VERYCLEANUP     += $(BIN)/deps
134
135 # The following variables are created by the Makefile rules files
136 #
137 bobjs :
138         @echo $(BOBJS)
139 drivers :
140         @echo $(DRIVERS)
141 .PHONY : drivers
142 roms :
143         @echo $(ROMS)
144
145 # Generate the NIC file from the parsed source files.  The NIC file is
146 # only for rom-o-matic.
147 #
148 $(BIN)/NIC : $(AUTO_DEPS)
149         @echo '# This is an automatically generated file, do not edit' > $@
150         @echo '# It does not affect anything in the build, ' \
151              'it is only for rom-o-matic' >> $@
152         @echo >> $@
153         @perl -ne 'chomp; print "$$1\n" if /\# NIC\t(.*)$$/' $^ >> $@
154 CLEANUP         += $(BIN)/NIC
155
156 # Library of all objects
157 #
158 $(BLIB) : $(BOBJS)
159         $(AR) r $@ $(BOBJS)
160         $(RANLIB) $@
161 blib : $(BLIB)
162
163 # Analyse a target name (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and
164 # derive the variables:
165
166 # TGT_ELEMENTS : the elements of the target (e.g. "dfe538 prism2_pci")
167 # TGT_PREFIX   : the prefix type (e.g. "zrom")
168 # TGT_DRIVERS  : the driver for each element (e.g. "rtl8139 prism2_pci")
169 # TGT_ROM_NAME : the ROM name (e.g. "dfe538")
170 # TGT_MEDIA    : the media type (e.g. "rom")
171 #
172 TGT_ELEMENTS    = $(subst --, ,$(firstword $(subst ., ,$(notdir $@))))
173 TGT_PREFIX      = $(word 2,$(subst ., ,$(notdir $@)))
174 TGT_DRIVERS     = $(strip $(foreach TGT_ELEMENT,$(TGT_ELEMENTS), \
175                    $(firstword $(DRIVER_$(TGT_ELEMENT)) $(TGT_ELEMENT))))
176 TGT_ROM_NAME    = $(firstword $(TGT_ELEMENTS))
177 TGT_MEDIA       = $(subst z,,$(TGT_PREFIX))
178
179 # Look up ROM type and IDs for the current target
180 # (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the variables:
181 #
182 # TGT_ROM_TYPE   : PCI/ISA indicator (e.g. "pci")
183 # TGT_PCI_VENDOR : the PCI vendor ID (e.g. "0x1186")
184 # TGT_PCI_DEVICE : the PCI device ID (e.g. "0x1300")
185 #
186 TGT_ROM_TYPE    = $(ROM_TYPE_$(TGT_ROM_NAME))
187 TGT_PCI_VENDOR  = $(PCI_VENDOR_$(TGT_ROM_NAME))
188 TGT_PCI_DEVICE  = $(PCI_DEVICE_$(TGT_ROM_NAME))
189
190 # Calculate link-time options for the current target
191 # (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the variables:
192 #
193 # TGT_LD_DRIVERS : symbols to require in order to drag in the relevant drivers
194 #                  (e.g. "obj_rtl8139 obj_prism2_pci")
195 # TGT_LD_PREFIX  : symbols to require in order to drag in the relevant prefix
196 #                  (e.g. "obj_zpciprefix")
197 # TGT_LD_IDS :     symbols to define in order to fill in ID structures in the
198 #                  ROM header (e.g."pci_vendor_id=0x1186 pci_device_id=0x1300")
199 #
200 TGT_LD_DRIVERS  = $(subst -,_,$(patsubst %,obj_%,$(TGT_DRIVERS)))
201 TGT_LD_PREFIX   = obj_$(subst rom,$(TGT_ROM_TYPE),$(TGT_PREFIX))prefix
202 TGT_LD_IDS      = $(if $(TGT_PCI_VENDOR),pci_vendor_id=$(TGT_PCI_VENDOR)) \
203                   $(if $(TGT_PCI_DEVICE),pci_device_id=$(TGT_PCI_DEVICE))
204
205 # Calculate linker flags based on link-time options for the current
206 # target type (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the
207 # variables:
208 #
209 # TGT_LD_FLAGS : target-specific flags to pass to linker (e.g.
210 #                "-u obj_zpciprefix -u obj_rtl8139 -u obj_prism2_pci
211 #                 --defsym pci_vendor=0x1186 --defsym pci_device=0x1300")
212 #
213 TGT_LD_FLAGS    = $(foreach SYM,$(TGT_LD_PREFIX) $(TGT_LD_DRIVERS) obj_config,\
214                     -u $(SYM) --defsym check_$(SYM)=$(SYM) ) \
215                   $(patsubst %,--defsym %,$(TGT_LD_IDS))
216
217 # Calculate makerom flags for the specific target
218 # (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the variables:
219 #
220 # TGT_MAKEROM_FLAGS : target-specific flags for makerom (e.g.
221 #                     "-p 0x1186,0x1300")
222 #
223 TGT_MAKEROM_FLAGS = $(strip $(MAKEROM_FLAGS_$(TGT_ROM_NAME)) \
224        $(if $(TGT_PCI_VENDOR),$(strip -p $(TGT_PCI_VENDOR),$(TGT_PCI_DEVICE))))
225
226 # Calculate list of debugging versions of objects to be included in
227 # the target.
228 #
229 COMMA           := ,
230 DEBUG_OBJECTS   = $(foreach D,$(subst $(COMMA), ,$(DEBUG)),$(BIN)/$(D).dbg.o)
231 $(foreach OBJ,$(filter-out $(dbg.o_OBJS),$(DEBUG_OBJECTS)), \
232         $(error $(OBJ) is not a valid debug object) \
233 )
234
235 # Print out all derived information for a given target.
236 #
237 $(BIN)/%.info :
238         @echo 'Elements             : $(TGT_ELEMENTS)'
239         @echo 'Prefix               : $(TGT_PREFIX)'
240         @echo 'Drivers              : $(TGT_DRIVERS)'
241         @echo 'ROM name             : $(TGT_ROM_NAME)'
242         @echo 'Media                : $(TGT_MEDIA)'
243         @echo
244         @echo 'ROM type             : $(TGT_ROM_TYPE)'
245         @echo 'PCI vendor           : $(TGT_PCI_VENDOR)'
246         @echo 'PCI device           : $(TGT_PCI_DEVICE)'
247         @echo
248         @echo 'LD driver symbols    : $(TGT_LD_DRIVERS)'
249         @echo 'LD prefix symbols    : $(TGT_LD_PREFIX)'
250         @echo 'LD ID symbols        : $(TGT_LD_IDS)'
251         @echo
252         @echo 'LD target flags      : $(TGT_LD_FLAGS)'
253         @echo
254         @echo 'makerom target flags : $(TGT_MAKEROM_FLAGS)'
255         @echo
256         @echo 'Debugging objects    : $(DEBUG_OBJECTS)'
257
258 # Build an intermediate object file from the objects required for the
259 # specified target.
260
261 # If it's a debugging version, force a link to take place by making
262 # this target depend on a phony target, and mark the resulting files
263 # as being older than BLIB, so that any subsequent images will do a
264 # fresh link.  Otherwise, you won't get what you expect when you do
265 # e.g. "make DEBUG=pci bin/pnic.dsk ; make bin/pnic.dsk ; make
266 # DEBUG=pci bin/pnic.dsk"
267 #
268 $(BIN)/%.tmp : $(BLIB) $(MAKEDEPS) $(LDSCRIPT) \
269                $(DEBUG_OBJECTS) $(if $(DEBUG),force_relink)
270         $(LD) $(LDFLAGS) -T $(LDSCRIPT) $(TGT_LD_FLAGS) \
271                 $(DEBUG_OBJECTS) $(BLIB) -o $@ -Map $(BIN)/$*.tmp.map
272         $(if $(DEBUG_OBJECTS),$(TOUCH) -r $(BLIB) -B 2 $@ $(BIN)/$*.tmp.map)
273 .PHONY : force_relink
274
275 # Show a linker map for the specified target
276 #
277 $(BIN)/%.map : $(BIN)/%.tmp
278         @less $(BIN)/$*.tmp.map
279
280 # Rules for each media format.  These are generated and placed in an
281 # external Makefile fragment.  We could do this via $(eval ...), but
282 # that would require make >= 3.80.
283
284 # Note that there's an alternative way to generate most .rom images:
285 # they can be copied from their 'master' ROM image using cp and
286 # reprocessed with makerom to add the PCI IDs and ident string.  The
287 # relevant rule would look something like:
288 #
289 #   $(BIN)/dfe538%rom : $(BIN)/rtl8139%rom
290 #       cat $< $@
291 #       $(FINALISE_rom)
292
293 # You can derive the ROM/driver relationships using the variables
294 # DRIVER_<rom> and/or ROMS_<driver>.
295
296 # We don't currently do this, because (a) it would require generating
297 # yet more Makefile fragments (since you need a rule for each ROM in
298 # ROMS), and (b) the linker is so fast that it probably wouldn't make
299 # much difference to the overall build time.
300
301 media :
302         @echo $(MEDIA)
303
304 AUTO_MEDIA      = $(filter-out $(NON_AUTO_MEDIA),$(MEDIA))
305 automedia :
306         @echo $(AUTO_MEDIA)
307
308 # media_template : create Makefile rules for specified media
309 #
310 # $(1) is the media name (e.g. "rom")
311 # $(2) is the full path to the .d file (e.g. "bin/deps/rom.media.d")
312 #
313 define media_template
314
315         @echo "Generating Makefile rules for $(1) media"
316         @$(MKDIR) -p $(dir $(2))
317         @$(RM) $(2)
318         @$(TOUCH) $(2)
319         @echo -e '$$(BIN)/%$(1) : $$(BIN)/%$(1).tmp' \
320                   '\n\t$$(OBJCOPY) -O binary $$< $$@' \
321                   '\n\t$$(FINALISE_$(1))' \
322                 > $(2)
323
324 endef
325
326 # Rule to generate the Makefile rules to be included
327 #
328 $(BIN)/deps/%.media.d : $(MAKEDEPS)
329         $(if $(filter $(AUTO_MEDIA),$*), \
330                 $(call media_template,$*,$@), \
331                 @echo 'ERROR: $* is not an AUTO_MEDIA' ; exit 1)
332
333 # Calculate and include the list of Makefile rules files
334 #
335 MEDIA_DEPS              = $(patsubst %,$(BIN)/deps/%.media.d,$(AUTO_MEDIA))
336 mediadeps :
337         @echo $(MEDIA_DEPS)
338 include $(MEDIA_DEPS)
339
340 # The "allXXXs" targets for each suffix
341 #
342 allroms allzroms : all%s : $(foreach ROM,$(ROMS),$(BIN)/$(ROM).%)
343 all%s : $(foreach DRIVER,$(DRIVERS),$(BIN)/$(DRIVER).%)
344
345 # The compressor utility
346 #
347 $(NRV2B) : util/nrv2b.c $(MAKEDEPS)
348         $(HOST_CC) -O2 -DENCODE -DDECODE -DMAIN -DVERBOSE -DNDEBUG \
349                        -DBITSIZE=32 -DENDIAN=0 -o $@ $<
350 CLEANUP += $(NRV2B)
351
352 # Auto-incrementing build serial number.  Append "bs" to your list of
353 # build targets to get a serial number printed at the end of the
354 # build.  Enable -DBUILD_SERIAL in order to see it when the code runs.
355 #
356 BUILDSERIAL_H = include/.buildserial.h
357
358 $(BUILDSERIAL_H) :
359         @if [ ! -s $@ ]; then echo '#define BUILD_SERIAL_NUM 0' > $@; fi
360         @perl -pi -e 's/(BUILD_SERIAL_NUM)\s+(\d+)/"$${1} ".($${2}+1)/e' $@
361
362 bs : $(BUILDSERIAL_H)
363         @perl -n -e '/BUILD_SERIAL_NUM\s+(\d+)/ && ' \
364                 -e 'print "Build serial number is $$1\n";' $<
365
366 ifeq ($(filter bs,$(MAKECMDGOALS)),bs)
367 .PHONY : $(BUILDSERIAL_H)
368 endif
369
370 # Ensure that include/.buildserial.h always exists, to solve the
371 # problem of bootstrapping a BUILD_SERIAL-enabled build.
372 #
373 ifeq ($(wildcard $(BUILDSERIAL_H)),)
374 $(shell $(TOUCH) $(BUILDSERIAL_H))
375 endif
376
377 # List of available architectures
378 #
379 ARCHS   = $(filter-out CVS,$(patsubst arch/%,%,$(wildcard arch/*)))
380 archs :
381         @echo $(ARCHS)
382
383 OTHER_ARCHS     = $(filter-out $(ARCH),$(ARCHS))
384 otherarchs :
385         @echo $(OTHER_ARCHS)
386
387 # Build the TAGS file for emacs
388 #
389 TAGS : TAGS.$(ARCH)
390
391 TAGS.$(ARCH) : 
392         ctags -e -R -f $@ $(foreach ARCH,$(OTHER_ARCHS),--exclude=arch/$(ARCH))
393 CLEANUP += TAGS*
394
395 # Force rebuild for any given target
396 #
397 $(BIN)/%.rebuild :
398         rm -f $(BIN)/$*
399         $(MAKE) $(MAKEFLAGS) $(BIN)/$*
400
401 # Clean-up
402 #
403 clean :
404         $(RM) $(CLEANUP)
405
406 veryclean : clean
407         $(RM) -r $(VERYCLEANUP)