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