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