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