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   = 0
  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 # Analyse a target name (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and
 162 # derive the variables:
 163 #
 164 # TGT_ELEMENTS : the elements of the target (e.g. "dfe538 prism2_pci")
 165 # TGT_PREFIX   : the prefix type (e.g. "zrom")
 166 # TGT_DRIVERS  : the driver for each element (e.g. "rtl8139 prism2_pci")
 167 # TGT_ROM_NAME : the ROM name (e.g. "dfe538")
 168 # TGT_MEDIA    : the media type (e.g. "rom")
 169 #
 170 DRIVERS_etherboot = $(DRIVERS)
 171 CARD_DRIVER     = $(firstword $(DRIVER_$(1)) $(1))
 172 TGT_ELEMENTS    = $(subst --, ,$(firstword $(subst ., ,$(notdir $@))))
 173 TGT_PREFIX      = $(word 2,$(subst ., ,$(notdir $@)))
 174 TGT_ROM_NAME    = $(firstword $(TGT_ELEMENTS))
 175 TGT_DRIVERS     = $(strip $(if $(DRIVERS_$(TGT_ROM_NAME)), \
 176                                $(DRIVERS_$(TGT_ROM_NAME)), \
 177                                $(foreach TGT_ELEMENT,$(TGT_ELEMENTS), \
 178                                  $(call CARD_DRIVER,$(TGT_ELEMENT))) ))
 179 TGT_MEDIA       = $(subst z,,$(TGT_PREFIX))
 180
 181 # Look up ROM IDs for the current target
 182 # (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the variables:
 183 #
 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_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_IDS :     symbols to define in order to fill in ID structures in the
 196 #                  ROM header (e.g."pci_vendor_id=0x1186 pci_device_id=0x1300")
 197 #
 198 TGT_LD_DRIVERS  = $(subst -,_,$(patsubst %,obj_%,$(TGT_DRIVERS)))
 199 TGT_LD_PREFIX   = obj_$(TGT_PREFIX)prefix
 200 TGT_LD_IDS      = $(if $(TGT_PCI_VENDOR),pci_vendor_id=$(TGT_PCI_VENDOR)) \
 201                   $(if $(TGT_PCI_DEVICE),pci_device_id=$(TGT_PCI_DEVICE))
 202
 203 # Calculate linker flags based on link-time options for the current
 204 # target type (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the
 205 # variables:
 206 #
 207 # TGT_LD_FLAGS : target-specific flags to pass to linker (e.g.
 208 #                "-u obj_zpciprefix -u obj_rtl8139 -u obj_prism2_pci
 209 #                 --defsym pci_vendor=0x1186 --defsym pci_device=0x1300")
 210 #
 211 TGT_LD_FLAGS    = $(foreach SYM,$(TGT_LD_PREFIX) $(TGT_LD_DRIVERS) obj_config,\
 212                     -u $(SYM) --defsym check_$(SYM)=$(SYM) ) \
 213                   $(patsubst %,--defsym %,$(TGT_LD_IDS))
 214
 215 # Calculate makerom flags for the specific target
 216 # (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the variables:
 217 #
 218 # TGT_MAKEROM_FLAGS : target-specific flags for makerom (e.g.
 219 #                     "-p 0x1186,0x1300")
 220 #
 221 TGT_MAKEROM_FLAGS = $(strip $(MAKEROM_FLAGS_$(TGT_ROM_NAME)) \
 222        $(if $(TGT_PCI_VENDOR),$(strip -p $(TGT_PCI_VENDOR),$(TGT_PCI_DEVICE))))
 223
 224 # Calculate list of debugging versions of objects to be included in
 225 # the target.
 226 #
 227 COMMA           := ,
 228 DEBUG_LIST      = $(subst $(COMMA), ,$(DEBUG))
 229 DEBUG_OBJ_BASE  = $(word 1,$(subst :, ,$(1))).dbg$(word 2,$(subst :, ,$(1)))
 230 DEBUG_OBJ       = $(BIN)/$(call DEBUG_OBJ_BASE,$(1)).o
 231 DEBUG_ORIG_OBJ  = $(BIN)/$(word 1,$(subst :, ,$(1))).o
 232 DEBUG_OBJS      = $(foreach D,$(DEBUG_LIST),$(call DEBUG_OBJ,$(D)))
 233 DEBUG_ORIG_OBJS = $(foreach D,$(DEBUG_LIST),$(call DEBUG_ORIG_OBJ,$(D)))
 234 BLIB_OBJS       = $(DEBUG_OBJS) $(filter-out $(DEBUG_ORIG_OBJS),$(BOBJS))
 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 '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_OBJS)'
 257         @echo 'Replaced objects     : $(DEBUG_ORIG_OBJS)'
 258
 259 # List of objects included in the last build of blib.  This is needed
 260 # in order to correctly rebuild blib whenever the list of objects
 261 # changes.
 262 #
 263 BLIB_LIST       = $(BIN)/.blib.list
 264 ifneq ($(shell cat $(BLIB_LIST)),$(BLIB_OBJS))
 265 $(shell echo "$(BLIB_OBJS)" > $(BLIB_LIST))
 266 endif
 267
 268 $(BLIB_LIST) :
 269
 270 VERYCLEANUP     += $(BLIB_LIST)
 271
 272 # Library of all objects
 273 #
 274 BLIB            = $(BIN)/blib.a
 275 $(BLIB) : $(BLIB_OBJS) $(BLIB_LIST) $(MAKEDEPS)
 276         $(RM) $(BLIB)
 277         $(AR) r $@ $(BLIB_OBJS)
 278         $(RANLIB) $@
 279 blib : $(BLIB)
 280
 281 # Build an intermediate object file from the objects required for the
 282 # specified target.
 283 #
 284 $(BIN)/%.tmp : $(BLIB) $(MAKEDEPS) $(LDSCRIPT)
 285         $(LD) $(LDFLAGS) -T $(LDSCRIPT) $(TGT_LD_FLAGS) $(BLIB) -o $@ \
 286                 -Map $(BIN)/$*.tmp.map
 287         $(OBJDUMP) -ht $@ | $(SORTOBJDUMP) >> $(BIN)/$*.tmp.map
 288
 289 # Show a linker map for the specified target
 290 #
 291 $(BIN)/%.map : $(BIN)/%.tmp
 292         @less $(BIN)/$*.tmp.map
 293
 294 # Build bochs symbol table
 295 $(BIN)/%.bxs : $(BIN)/%.tmp
 296         $(NM) $< | cut -d" " -f1,3 > $@
 297
 298 # Rules for each media format.  These are generated and placed in an
 299 # external Makefile fragment.  We could do this via $(eval ...), but
 300 # that would require make >= 3.80.
 301 #
 302 # Note that there's an alternative way to generate most .rom images:
 303 # they can be copied from their 'master' ROM image using cp and
 304 # reprocessed with makerom to add the PCI IDs and ident string.  The
 305 # relevant rule would look something like:
 306 #
 307 #   $(BIN)/dfe538%rom : $(BIN)/rtl8139%rom
 308 #       cat $< $@
 309 #       $(FINALISE_rom)
 310 #
 311 # You can derive the ROM/driver relationships using the variables
 312 # DRIVER_<rom> and/or ROMS_<driver>.
 313 #
 314 # We don't currently do this, because (a) it would require generating
 315 # yet more Makefile fragments (since you need a rule for each ROM in
 316 # ROMS), and (b) the linker is so fast that it probably wouldn't make
 317 # much difference to the overall build time.
 318
 319 media :
 320         @echo $(MEDIA)
 321
 322 AUTO_MEDIA      = $(filter-out $(NON_AUTO_MEDIA),$(MEDIA))
 323 automedia :
 324         @echo $(AUTO_MEDIA)
 325
 326 # media_template : create Makefile rules for specified media
 327 #
 328 # $(1) is the media name (e.g. "rom")
 329 # $(2) is the full path to the .d file (e.g. "bin/deps/rom.media.d")
 330 #
 331 define media_template
 332
 333         @echo "Generating Makefile rules for $(1) media"
 334         @$(MKDIR) -p $(dir $(2))
 335         @$(RM) $(2)
 336         @$(TOUCH) $(2)
 337         @echo -e '$$(BIN)/%$(1) : $$(BIN)/%$(1).tmp' \
 338                   '\n\t$$(OBJCOPY) -O binary $$< $$@' \
 339                   '\n\t$$(FINALISE_$(1))' \
 340                 > $(2)
 341
 342 endef
 343
 344 # Rule to generate the Makefile rules to be included
 345 #
 346 $(BIN)/deps/%.media.d : $(MAKEDEPS)
 347         $(if $(filter $(AUTO_MEDIA),$*), \
 348                 $(call media_template,$*,$@), \
 349                 @echo 'ERROR: $* is not an AUTO_MEDIA' ; exit 1)
 350
 351 # Calculate and include the list of Makefile rules files
 352 #
 353 MEDIA_DEPS              = $(patsubst %,$(BIN)/deps/%.media.d,$(AUTO_MEDIA))
 354 mediadeps :
 355         @echo $(MEDIA_DEPS)
 356 include $(MEDIA_DEPS)
 357
 358 # The "allXXXs" targets for each suffix
 359 #
 360 allroms allzroms : all%s : $(foreach ROM,$(ROMS),$(BIN)/$(ROM).%)
 361 all%s : $(foreach DRIVER,$(DRIVERS),$(BIN)/$(DRIVER).%)
 362
 363 # The compressor utility
 364 #
 365 $(NRV2B) : util/nrv2b.c $(MAKEDEPS)
 366         $(HOST_CC) -O2 -DENCODE -DDECODE -DMAIN -DVERBOSE -DNDEBUG \
 367                        -DBITSIZE=32 -DENDIAN=0 -o $@ $<
 368 CLEANUP += $(NRV2B)
 369
 370 # Auto-incrementing build serial number.  Append "bs" to your list of
 371 # build targets to get a serial number printed at the end of the
 372 # build.  Enable -DBUILD_SERIAL in order to see it when the code runs.
 373 #
 374 BUILDSERIAL_H           = config/.buildserial.h
 375 BUILDSERIAL_NOW         = config/.buildserial.now
 376 BUILDSERIAL_NEXT        = config/.buildserial.next
 377
 378 $(BUILDSERIAL_NOW) $(BUILDSERIAL_NEXT) :
 379         echo 1 > $@
 380
 381 $(BUILDSERIAL_H) : $(BUILDSERIAL_NOW) $(BUILDSERIAL_NEXT)
 382         echo '#define BUILD_SERIAL_NUM $(shell cat $<)' > $@
 383
 384 ifeq ($(filter bs,$(MAKECMDGOALS)),bs)
 385 $(shell diff -q $(BUILDSERIAL_NOW) $(BUILDSERIAL_NEXT) > /dev/null || \
 386         cp -f $(BUILDSERIAL_NEXT) $(BUILDSERIAL_NOW))
 387 endif
 388
 389 bs : $(BUILDSERIAL_NOW)
 390         @echo $$(( $(shell cat $<) + 1 )) > $(BUILDSERIAL_NEXT)
 391         @echo "Build serial number is $(shell cat $<)"
 392
 393 # List of available architectures
 394 #
 395 ARCHS   = $(filter-out CVS,$(patsubst arch/%,%,$(wildcard arch/*)))
 396 archs :
 397         @echo $(ARCHS)
 398
 399 OTHER_ARCHS     = $(filter-out $(ARCH),$(ARCHS))
 400 otherarchs :
 401         @echo $(OTHER_ARCHS)
 402
 403 # Build the TAGS file for emacs
 404 #
 405 TAGS : TAGS.$(ARCH)
 406
 407 TAGS.$(ARCH) :
 408         ctags -e -R -f $@ --exclude=bin \
 409                 $(foreach ARCH,$(OTHER_ARCHS),--exclude=arch/$(ARCH))
 410 CLEANUP += TAGS*
 411
 412 # Symbol table checks
 413 #
 414 SYMTAB  = $(BIN)/symtab
 415 $(SYMTAB) : $(BLIB)
 416         $(NM) -o -S $< > $@
 417
 418 symcheck : $(SYMTAB)
 419         $(SYMCHECK) $<
 420
 421 # Force rebuild for any given target
 422 #
 423 $(BIN)/%.rebuild :
 424         rm -f $(BIN)/$*
 425         $(MAKE) $(MAKEFLAGS) $(BIN)/$*
 426
 427 # Documentation
 428 #
 429 $(BIN)/doxygen.cfg : doxygen.cfg $(MAKEDEPS)
 430         $(PERL) -pe 's{\@SRCDIRS\@}{$(SRCDIRS)}; ' \
 431                 -e  's{\@BIN\@}{$(BIN)}; ' \
 432                 -e  's{\@ARCH\@}{$(ARCH)}; ' \
 433                 $< > $@
 434
 435 $(BIN)/doc : $(BIN)/doxygen.cfg
 436         $(DOXYGEN) $<
 437
 438 .PHONY : $(BIN)/doc
 439
 440 VERYCLEANUP     += $(BIN)/doc
 441
 442 doc : $(BIN)/doc
 443
 444 docview :
 445         @[ -f $(BIN)/doc/html/index.html ] || $(MAKE) $(BIN)/doc
 446         @if [ -n "$$BROWSER" ] ; then \
 447                 ( $$BROWSER $(BIN)/doc/html/index.html & ) ; \
 448         else \
 449                 echo "Documentation index in $(BIN)/doc/html/index.html" ; \
 450         fi
 451
 452 # Clean-up
 453 #
 454 clean :
 455         $(RM) $(CLEANUP)
 456
 457 veryclean : clean
 458         $(RM) -r $(VERYCLEANUP)