You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Makefile.housekeeping 14KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458
  1. # -*- makefile -*- : Force emacs to use Makefile mode
  2. # This file contains various boring housekeeping functions that would
  3. # otherwise seriously clutter up the main Makefile.
  4. # Objects to be removed by "make clean"
  5. #
  6. CLEANUP := $(BIN)/*.* # *.* to avoid catching the "CVS" directory
  7. # Version number calculations
  8. #
  9. VERSION_MAJOR = 0
  10. VERSION_MINOR = 5
  11. VERSION_PATCH = 0
  12. EXTRAVERSION =
  13. MM_VERSION = $(VERSION_MAJOR).$(VERSION_MINOR)
  14. VERSION = $(MM_VERSION).$(VERSION_PATCH)$(EXTRAVERSION)
  15. CFLAGS += -DVERSION_MAJOR=$(VERSION_MAJOR) \
  16. -DVERSION_MINOR=$(VERSION_MINOR) \
  17. -DVERSION=\"$(VERSION)\"
  18. IDENT = '$(@F) $(VERSION) (GPL) etherboot.org'
  19. version :
  20. @echo $(VERSION)
  21. # Check for tools that can cause failed builds
  22. #
  23. .toolcheck : Makefile Config
  24. @if $(CC) -v 2>&1 | grep -is 'gcc version 2\.96' > /dev/null; then \
  25. echo 'gcc 2.96 is unsuitable for compiling Etherboot'; \
  26. echo 'Use gcc 2.95 or gcc 3.x instead'; \
  27. exit 1; \
  28. fi
  29. @if [ `perl -e 'use bytes; print chr(255)' | wc -c` = 2 ]; then \
  30. echo 'Your Perl version has a Unicode handling bug'; \
  31. echo 'Execute this command before compiling Etherboot:'; \
  32. echo 'export LANG=$${LANG%.UTF-8}'; \
  33. exit 1; \
  34. fi
  35. @$(TOUCH) $@
  36. VERYCLEANUP += .toolcheck
  37. # Check for an old version of gas (binutils 2.9.1)
  38. #
  39. OLDGAS := $(shell $(AS) --version | grep -q '2\.9\.1' && echo -DGAS291)
  40. CFLAGS += $(OLDGAS)
  41. oldgas :
  42. @echo $(oldgas)
  43. # compiler.h is needed for our linking and debugging system
  44. #
  45. CFLAGS += -include compiler.h
  46. # config/%.h files are generated from config.h using mkconfig.pl
  47. config/%.h : config.h
  48. $(MKCONFIG) $<
  49. CLEANUP += config/*.h
  50. # SRCDIRS lists all directories containing source files.
  51. srcdirs :
  52. @echo $(SRCDIRS)
  53. # SRCS lists all .c or .S files found in any SRCDIR
  54. #
  55. SRCS += $(wildcard $(patsubst %,%/*.c,$(SRCDIRS)))
  56. SRCS += $(wildcard $(patsubst %,%/*.S,$(SRCDIRS)))
  57. srcs :
  58. @echo $(SRCS)
  59. # AUTO_SRCS lists all files in SRCS that are not mentioned in
  60. # NON_AUTO_SRCS. Files should be added to NON_AUTO_SRCS if they
  61. # cannot be built using the standard build template.
  62. #
  63. AUTO_SRCS = $(filter-out $(NON_AUTO_SRCS),$(SRCS))
  64. autosrcs :
  65. @echo $(AUTO_SRCS)
  66. # We automatically generate rules for any file mentioned in AUTO_SRCS
  67. # using the following set of templates. It would be cleaner to use
  68. # $(eval ...), but this function exists only in GNU make >= 3.80.
  69. # src_template : generate Makefile rules for a given source file
  70. #
  71. # $(1) is the full path to the source file (e.g. "drivers/net/rtl8139.c")
  72. # $(2) is the full path to the .d file (e.g. "bin/deps/drivers/net/rtl8139.d")
  73. # $(3) is the source type (e.g. "c")
  74. # $(4) is the source base name (e.g. "rtl8139")
  75. #
  76. define src_template
  77. @echo "Generating Makefile rules for $(1)"
  78. @$(MKDIR) -p $(dir $(2))
  79. @$(RM) $(2)
  80. @$(TOUCH) $(2)
  81. $(foreach OBJ,$(if $(OBJS_$(4)),$(OBJS_$(4)),$(4)), \
  82. $(call obj_template,$(1),$(2),$(3),$(OBJ)))
  83. @$(PARSEROM) $(1) >> $(2)
  84. endef
  85. # obj_template : generate Makefile rules for a given resultant object
  86. # of a particular source file. (We can have multiple objects per
  87. # source file via the OBJS_xxx list.)
  88. #
  89. # $(1) is the full path to the source file (e.g. "drivers/net/rtl8139.c")
  90. # $(2) is the full path to the .d file (e.g. "bin/deps/drivers/net/rtl8139.d")
  91. # $(3) is the source type (e.g. "c")
  92. # $(4) is the object name (e.g. "rtl8139")
  93. #
  94. define obj_template
  95. @$(CPP) $(CFLAGS) $(CFLAGS_$(3)) $(CFLAGS_$(4)) \
  96. -M $(1) -MT "$(4)_DEPS" -MG | tr : = >> $(2)
  97. @echo -e '\n$$(BIN)/$(4).o : $(1) $$(MAKEDEPS) $$($(4)_DEPS)' \
  98. '\n\t$$(RULE_$(3))\n' \
  99. '\nBOBJS += $$(BIN)/$(4).o\n' \
  100. $(foreach TGT,$(DEBUG_TARGETS), \
  101. $(if $(RULE_$(3)_to_$(TGT)), \
  102. '\n$$(BIN)/$(4).$(TGT) : $(1) $$(MAKEDEPS) $$($(4)_DEPS)' \
  103. '\n\t$$(RULE_$(3)_to_$(TGT))\n' \
  104. '\n$(TGT)_OBJS += $$(BIN)/$(4).$(TGT)\n' ) ) \
  105. '\n$(2) : $$($(4)_DEPS)\n' \
  106. '\nTAGS : $$($(4)_DEPS)\n' \
  107. >> $(2)
  108. endef
  109. # Rule to generate the Makefile rules files to be included
  110. #
  111. $(BIN)/deps/%.d : % $(MAKEDEPS) $(PARSEROM)
  112. $(if $(filter $(AUTO_SRCS),$<),$(call src_template,$<,$@,$(subst .,,$(suffix $<)),$(basename $(notdir $<))),@echo 'ERROR: $< is not an AUTO_SRC' ; exit 1)
  113. # Calculate and include the list of Makefile rules files
  114. #
  115. AUTO_DEPS = $(patsubst %,$(BIN)/deps/%.d,$(AUTO_SRCS))
  116. include $(AUTO_DEPS)
  117. autodeps :
  118. @echo $(AUTO_DEPS)
  119. VERYCLEANUP += $(BIN)/deps
  120. # The following variables are created by the Makefile rules files
  121. #
  122. bobjs :
  123. @echo $(BOBJS)
  124. drivers :
  125. @echo $(DRIVERS)
  126. .PHONY : drivers
  127. roms :
  128. @echo $(ROMS)
  129. # Generate the NIC file from the parsed source files. The NIC file is
  130. # only for rom-o-matic.
  131. #
  132. $(BIN)/NIC : $(AUTO_DEPS)
  133. @echo '# This is an automatically generated file, do not edit' > $@
  134. @echo '# It does not affect anything in the build, ' \
  135. 'it is only for rom-o-matic' >> $@
  136. @echo >> $@
  137. @perl -ne 'chomp; print "$$1\n" if /\# NIC\t(.*)$$/' $^ >> $@
  138. CLEANUP += $(BIN)/NIC
  139. # Analyse a target name (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and
  140. # derive the variables:
  141. #
  142. # TGT_ELEMENTS : the elements of the target (e.g. "dfe538 prism2_pci")
  143. # TGT_PREFIX : the prefix type (e.g. "zrom")
  144. # TGT_DRIVERS : the driver for each element (e.g. "rtl8139 prism2_pci")
  145. # TGT_ROM_NAME : the ROM name (e.g. "dfe538")
  146. # TGT_MEDIA : the media type (e.g. "rom")
  147. #
  148. DRIVERS_etherboot = $(DRIVERS)
  149. CARD_DRIVER = $(firstword $(DRIVER_$(1)) $(1))
  150. TGT_ELEMENTS = $(subst --, ,$(firstword $(subst ., ,$(notdir $@))))
  151. TGT_PREFIX = $(word 2,$(subst ., ,$(notdir $@)))
  152. TGT_ROM_NAME = $(firstword $(TGT_ELEMENTS))
  153. TGT_DRIVERS = $(strip $(if $(DRIVERS_$(TGT_ROM_NAME)), \
  154. $(DRIVERS_$(TGT_ROM_NAME)), \
  155. $(foreach TGT_ELEMENT,$(TGT_ELEMENTS), \
  156. $(call CARD_DRIVER,$(TGT_ELEMENT))) ))
  157. TGT_MEDIA = $(subst z,,$(TGT_PREFIX))
  158. # Look up ROM IDs for the current target
  159. # (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the variables:
  160. #
  161. # TGT_PCI_VENDOR : the PCI vendor ID (e.g. "0x1186")
  162. # TGT_PCI_DEVICE : the PCI device ID (e.g. "0x1300")
  163. #
  164. TGT_PCI_VENDOR = $(PCI_VENDOR_$(TGT_ROM_NAME))
  165. TGT_PCI_DEVICE = $(PCI_DEVICE_$(TGT_ROM_NAME))
  166. # Calculate link-time options for the current target
  167. # (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the variables:
  168. #
  169. # TGT_LD_DRIVERS : symbols to require in order to drag in the relevant drivers
  170. # (e.g. "obj_rtl8139 obj_prism2_pci")
  171. # TGT_LD_IDS : symbols to define in order to fill in ID structures in the
  172. # ROM header (e.g."pci_vendor_id=0x1186 pci_device_id=0x1300")
  173. #
  174. TGT_LD_DRIVERS = $(subst -,_,$(patsubst %,obj_%,$(TGT_DRIVERS)))
  175. TGT_LD_PREFIX = obj_$(TGT_PREFIX)prefix
  176. TGT_LD_IDS = $(if $(TGT_PCI_VENDOR),pci_vendor_id=$(TGT_PCI_VENDOR)) \
  177. $(if $(TGT_PCI_DEVICE),pci_device_id=$(TGT_PCI_DEVICE))
  178. # Calculate linker flags based on link-time options for the current
  179. # target type (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the
  180. # variables:
  181. #
  182. # TGT_LD_FLAGS : target-specific flags to pass to linker (e.g.
  183. # "-u obj_zpciprefix -u obj_rtl8139 -u obj_prism2_pci
  184. # --defsym pci_vendor=0x1186 --defsym pci_device=0x1300")
  185. #
  186. TGT_LD_FLAGS = $(foreach SYM,$(TGT_LD_PREFIX) $(TGT_LD_DRIVERS) obj_config,\
  187. -u $(SYM) --defsym check_$(SYM)=$(SYM) ) \
  188. $(patsubst %,--defsym %,$(TGT_LD_IDS))
  189. # Calculate makerom flags for the specific target
  190. # (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the variables:
  191. #
  192. # TGT_MAKEROM_FLAGS : target-specific flags for makerom (e.g.
  193. # "-p 0x1186,0x1300")
  194. #
  195. TGT_MAKEROM_FLAGS = $(strip $(MAKEROM_FLAGS_$(TGT_ROM_NAME)) \
  196. $(if $(TGT_PCI_VENDOR),$(strip -p $(TGT_PCI_VENDOR),$(TGT_PCI_DEVICE))))
  197. # Calculate list of debugging versions of objects to be included in
  198. # the target.
  199. #
  200. COMMA := ,
  201. DEBUG_LIST = $(subst $(COMMA), ,$(DEBUG))
  202. DEBUG_OBJ_BASE = $(word 1,$(subst :, ,$(1))).dbg$(word 2,$(subst :, ,$(1)))
  203. DEBUG_OBJ = $(BIN)/$(call DEBUG_OBJ_BASE,$(1)).o
  204. DEBUG_ORIG_OBJ = $(BIN)/$(word 1,$(subst :, ,$(1))).o
  205. DEBUG_OBJS = $(foreach D,$(DEBUG_LIST),$(call DEBUG_OBJ,$(D)))
  206. DEBUG_ORIG_OBJS = $(foreach D,$(DEBUG_LIST),$(call DEBUG_ORIG_OBJ,$(D)))
  207. BLIB_OBJS = $(DEBUG_OBJS) $(filter-out $(DEBUG_ORIG_OBJS),$(BOBJS))
  208. # Print out all derived information for a given target.
  209. #
  210. $(BIN)/%.info :
  211. @echo 'Elements : $(TGT_ELEMENTS)'
  212. @echo 'Prefix : $(TGT_PREFIX)'
  213. @echo 'Drivers : $(TGT_DRIVERS)'
  214. @echo 'ROM name : $(TGT_ROM_NAME)'
  215. @echo 'Media : $(TGT_MEDIA)'
  216. @echo
  217. @echo 'PCI vendor : $(TGT_PCI_VENDOR)'
  218. @echo 'PCI device : $(TGT_PCI_DEVICE)'
  219. @echo
  220. @echo 'LD driver symbols : $(TGT_LD_DRIVERS)'
  221. @echo 'LD prefix symbols : $(TGT_LD_PREFIX)'
  222. @echo 'LD ID symbols : $(TGT_LD_IDS)'
  223. @echo
  224. @echo 'LD target flags : $(TGT_LD_FLAGS)'
  225. @echo
  226. @echo 'makerom target flags : $(TGT_MAKEROM_FLAGS)'
  227. @echo
  228. @echo 'Debugging objects : $(DEBUG_OBJS)'
  229. @echo 'Replaced objects : $(DEBUG_ORIG_OBJS)'
  230. # List of objects included in the last build of blib. This is needed
  231. # in order to correctly rebuild blib whenever the list of objects
  232. # changes.
  233. #
  234. BLIB_LIST = $(BIN)/.blib.list
  235. ifneq ($(shell cat $(BLIB_LIST)),$(BLIB_OBJS))
  236. $(shell echo "$(BLIB_OBJS)" > $(BLIB_LIST))
  237. endif
  238. $(BLIB_LIST) :
  239. VERYCLEANUP += $(BLIB_LIST)
  240. # Library of all objects
  241. #
  242. BLIB = $(BIN)/blib.a
  243. $(BLIB) : $(BLIB_OBJS) $(BLIB_LIST) $(MAKEDEPS)
  244. $(RM) $(BLIB)
  245. $(AR) r $@ $(BLIB_OBJS)
  246. $(RANLIB) $@
  247. blib : $(BLIB)
  248. # Build an intermediate object file from the objects required for the
  249. # specified target.
  250. #
  251. $(BIN)/%.tmp : $(BLIB) $(MAKEDEPS) $(LDSCRIPT)
  252. $(LD) $(LDFLAGS) -T $(LDSCRIPT) $(TGT_LD_FLAGS) $(BLIB) -o $@ \
  253. -Map $(BIN)/$*.tmp.map
  254. $(OBJDUMP) -ht $@ | $(SORTOBJDUMP) >> $(BIN)/$*.tmp.map
  255. # Show a linker map for the specified target
  256. #
  257. $(BIN)/%.map : $(BIN)/%.tmp
  258. @less $(BIN)/$*.tmp.map
  259. # Build bochs symbol table
  260. $(BIN)/%.bxs : $(BIN)/%.tmp
  261. $(NM) $< | cut -d" " -f1,3 > $@
  262. # Rules for each media format. These are generated and placed in an
  263. # external Makefile fragment. We could do this via $(eval ...), but
  264. # that would require make >= 3.80.
  265. #
  266. # Note that there's an alternative way to generate most .rom images:
  267. # they can be copied from their 'master' ROM image using cp and
  268. # reprocessed with makerom to add the PCI IDs and ident string. The
  269. # relevant rule would look something like:
  270. #
  271. # $(BIN)/dfe538%rom : $(BIN)/rtl8139%rom
  272. # cat $< $@
  273. # $(FINALISE_rom)
  274. #
  275. # You can derive the ROM/driver relationships using the variables
  276. # DRIVER_<rom> and/or ROMS_<driver>.
  277. #
  278. # We don't currently do this, because (a) it would require generating
  279. # yet more Makefile fragments (since you need a rule for each ROM in
  280. # ROMS), and (b) the linker is so fast that it probably wouldn't make
  281. # much difference to the overall build time.
  282. media :
  283. @echo $(MEDIA)
  284. AUTO_MEDIA = $(filter-out $(NON_AUTO_MEDIA),$(MEDIA))
  285. automedia :
  286. @echo $(AUTO_MEDIA)
  287. # media_template : create Makefile rules for specified media
  288. #
  289. # $(1) is the media name (e.g. "rom")
  290. # $(2) is the full path to the .d file (e.g. "bin/deps/rom.media.d")
  291. #
  292. define media_template
  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. endef
  302. # Rule to generate the Makefile rules to be included
  303. #
  304. $(BIN)/deps/%.media.d : $(MAKEDEPS)
  305. $(if $(filter $(AUTO_MEDIA),$*), \
  306. $(call media_template,$*,$@), \
  307. @echo 'ERROR: $* is not an AUTO_MEDIA' ; exit 1)
  308. # Calculate and include the list of Makefile rules files
  309. #
  310. MEDIA_DEPS = $(patsubst %,$(BIN)/deps/%.media.d,$(AUTO_MEDIA))
  311. mediadeps :
  312. @echo $(MEDIA_DEPS)
  313. include $(MEDIA_DEPS)
  314. # The "allXXXs" targets for each suffix
  315. #
  316. allroms allzroms : all%s : $(foreach ROM,$(ROMS),$(BIN)/$(ROM).%)
  317. all%s : $(foreach DRIVER,$(DRIVERS),$(BIN)/$(DRIVER).%)
  318. # The compressor utility
  319. #
  320. $(NRV2B) : util/nrv2b.c $(MAKEDEPS)
  321. $(HOST_CC) -O2 -DENCODE -DDECODE -DMAIN -DVERBOSE -DNDEBUG \
  322. -DBITSIZE=32 -DENDIAN=0 -o $@ $<
  323. CLEANUP += $(NRV2B)
  324. # Auto-incrementing build serial number. Append "bs" to your list of
  325. # build targets to get a serial number printed at the end of the
  326. # build. Enable -DBUILD_SERIAL in order to see it when the code runs.
  327. #
  328. BUILDSERIAL_H = config/.buildserial.h
  329. BUILDSERIAL_NOW = config/.buildserial.now
  330. BUILDSERIAL_NEXT = config/.buildserial.next
  331. $(BUILDSERIAL_NOW) $(BUILDSERIAL_NEXT) :
  332. echo 1 > $@
  333. $(BUILDSERIAL_H) : $(BUILDSERIAL_NOW) $(BUILDSERIAL_NEXT)
  334. echo '#define BUILD_SERIAL_NUM $(shell cat $<)' > $@
  335. ifeq ($(filter bs,$(MAKECMDGOALS)),bs)
  336. $(shell diff -q $(BUILDSERIAL_NOW) $(BUILDSERIAL_NEXT) > /dev/null || \
  337. cp -f $(BUILDSERIAL_NEXT) $(BUILDSERIAL_NOW))
  338. endif
  339. bs : $(BUILDSERIAL_NOW)
  340. @echo $$(( $(shell cat $<) + 1 )) > $(BUILDSERIAL_NEXT)
  341. @echo "Build serial number is $(shell cat $<)"
  342. # List of available architectures
  343. #
  344. ARCHS = $(filter-out CVS,$(patsubst arch/%,%,$(wildcard arch/*)))
  345. archs :
  346. @echo $(ARCHS)
  347. OTHER_ARCHS = $(filter-out $(ARCH),$(ARCHS))
  348. otherarchs :
  349. @echo $(OTHER_ARCHS)
  350. # Build the TAGS file for emacs
  351. #
  352. TAGS : TAGS.$(ARCH)
  353. TAGS.$(ARCH) :
  354. ctags -e -R -f $@ --exclude=bin \
  355. $(foreach ARCH,$(OTHER_ARCHS),--exclude=arch/$(ARCH))
  356. CLEANUP += TAGS*
  357. # Symbol table checks
  358. #
  359. SYMTAB = $(BIN)/symtab
  360. $(SYMTAB) : $(BLIB)
  361. $(NM) -o -S $< > $@
  362. symcheck : $(SYMTAB)
  363. $(SYMCHECK) $<
  364. # Force rebuild for any given target
  365. #
  366. $(BIN)/%.rebuild :
  367. rm -f $(BIN)/$*
  368. $(MAKE) $(MAKEFLAGS) $(BIN)/$*
  369. # Documentation
  370. #
  371. $(BIN)/doxygen.cfg : doxygen.cfg $(MAKEDEPS)
  372. $(PERL) -pe 's{\@SRCDIRS\@}{$(SRCDIRS)}; ' \
  373. -e 's{\@BIN\@}{$(BIN)}; ' \
  374. -e 's{\@ARCH\@}{$(ARCH)}; ' \
  375. $< > $@
  376. $(BIN)/doc : $(BIN)/doxygen.cfg
  377. $(DOXYGEN) $<
  378. .PHONY : $(BIN)/doc
  379. VERYCLEANUP += $(BIN)/doc
  380. doc : $(BIN)/doc
  381. docview :
  382. @[ -f $(BIN)/doc/html/index.html ] || $(MAKE) $(BIN)/doc
  383. @if [ -n "$$BROWSER" ] ; then \
  384. ( $$BROWSER $(BIN)/doc/html/index.html & ) ; \
  385. else \
  386. echo "Documentation index in $(BIN)/doc/html/index.html" ; \
  387. fi
  388. # Clean-up
  389. #
  390. clean :
  391. $(RM) $(CLEANUP)
  392. veryclean : clean
  393. $(RM) -r $(VERYCLEANUP)