lk/make/build.mk

# Rules for generating the final binary and any auxillary files generated as a result.

# use linker garbage collection, if requested
WITH_LINKER_GC ?= false
ifeq (true,$(call TOBOOL,$(WITH_LINKER_GC)))
GLOBAL_COMPILEFLAGS += -ffunction-sections -fdata-sections
GLOBAL_LDFLAGS += --gc-sections
GLOBAL_DEFINES += LINKER_GC=1
endif

ifneq (,$(EXTRA_BUILDRULES))
-include $(EXTRA_BUILDRULES)
endif

$(EXTRA_LINKER_SCRIPTS):

$(OUTBIN): $(OUTELF)
	$(info generating image: $@)
	$(NOECHO)$(SIZE) $<
	$(NOECHO)$(OBJCOPY) -O binary $< $@

$(OUTELF).hex: $(OUTELF)
	$(info generating hex file: $@)
	$(NOECHO)$(OBJCOPY) -O ihex $< $@

$(OUTELF): $(ALLMODULE_OBJS) $(EXTRA_OBJS) $(LINKER_SCRIPT) $(EXTRA_LINKER_SCRIPTS)
	$(info linking $@)
	$(NOECHO)$(SIZE) -t --common $(sort $(ALLMODULE_OBJS)) $(EXTRA_OBJS)
	$(NOECHO)$(LD) $(GLOBAL_LDFLAGS) $(ARCH_LDFLAGS) -d -T $(LINKER_SCRIPT) \
		$(addprefix -T,$(EXTRA_LINKER_SCRIPTS)) \
		$(ALLMODULE_OBJS) $(EXTRA_OBJS) $(LIBGCC) -Map=$(OUTELF).map -o $@

$(OUTELF).sym: $(OUTELF)
	$(info generating symbols: $@)
	$(NOECHO)$(OBJDUMP) -t $< | $(CPPFILT) > $@
	$(NOECHO)echo "# vim: ts=8 nolist nowrap" >> $@

$(OUTELF).sym.sorted: $(OUTELF)
	$(info generating sorted symbols: $@)
	$(NOECHO)$(OBJDUMP) -t $< | $(CPPFILT) | sort > $@
	$(NOECHO)echo "# vim: ts=8 nolist nowrap" >> $@

$(OUTELF).lst: $(OUTELF)
	$(info generating listing: $@)
	$(NOECHO)$(OBJDUMP) $(ARCH_OBJDUMP_FLAGS) -d $< | $(CPPFILT) > $@
	$(NOECHO)echo "# vim: ts=8 nolist nowrap" >> $@

$(OUTELF).debug.lst: $(OUTELF)
	$(info generating listing: $@)
	$(NOECHO)$(OBJDUMP) $(ARCH_OBJDUMP_FLAGS) -l -S $< | $(CPPFILT) > $@
	$(NOECHO)echo "# vim: ts=8 nolist nowrap" >> $@

$(OUTELF).dump: $(OUTELF)
	$(info generating objdump: $@)
	$(NOECHO)$(OBJDUMP) -x $< | $(CPPFILT) > $@
	$(NOECHO)echo "# vim: ts=8 nolist nowrap" >> $@

$(OUTELF).size: $(OUTELF)
	$(info generating size map: $@)
	$(NOECHO)$(NM) -S --size-sort $< | $(CPPFILT) > $@
	$(NOECHO)echo "# vim: ts=8 nolist nowrap" >> $@

# generate a list of source files that potentially participate in this build.
# header file detection is a bit sloppy: it simply searches for every .h file inside
# the combined include paths. May pick up files that are not strictly speaking used.
# Alternate strategy that may work: union all of the .d files together and collect all
# of the used headers used there.
$(BUILDDIR)/srcfiles.txt: $(OUTELF) $(BUILDDIR)/include_paths.txt
	@$(MKDIR)
	$(info generating $@)
	$(NOECHO)echo $(sort $(ALLSRCS)) | tr ' ' '\n' > $@
	@for i in `cat $(BUILDDIR)/include_paths.txt`; do if [ -d $$i ]; then find $$i -type f -name \*.h; fi; done >> $@

# generate a list of all the include directories used in this project
$(BUILDDIR)/include_paths.txt: $(OUTELF)
	@$(MKDIR)
	$(info generating $@)
	$(NOECHO)echo $(subst -I,,$(sort $(GLOBAL_INCLUDES))) | tr ' ' '\n' > $@

#include arch/$(ARCH)/compile.mk
[make] add 'make tags' Tries to generate a curated ctags file for the current project and configuration. 2024-05-09 20:27:54 -07:00			`# Rules for generating the final binary and any auxillary files generated as a result.`

[make] miscellaneous make system tweaks -Have arch set the default optimization level. Most will use O2, but arm-m sets to Os. -Make the link time garbage collection be optional. Only set for arm-m. 2014-03-22 21:03:03 -07:00			`# use linker garbage collection, if requested`
[make] default WITH_LINKER_GC to false at the place it is used Also switch the test logic to the TOBOOL macro. 2022-04-18 01:09:52 -07:00			`WITH_LINKER_GC ?= false`
			`ifeq (true,$(call TOBOOL,$(WITH_LINKER_GC)))`
[make] miscellaneous make system tweaks -Have arch set the default optimization level. Most will use O2, but arm-m sets to Os. -Make the link time garbage collection be optional. Only set for arm-m. 2014-03-22 21:03:03 -07:00			`GLOBAL_COMPILEFLAGS += -ffunction-sections -fdata-sections`
			`GLOBAL_LDFLAGS += --gc-sections`
[make] default WITH_LINKER_GC to false at the place it is used Also switch the test logic to the TOBOOL macro. 2022-04-18 01:09:52 -07:00			`GLOBAL_DEFINES += LINKER_GC=1`
[make] miscellaneous make system tweaks -Have arch set the default optimization level. Most will use O2, but arm-m sets to Os. -Make the link time garbage collection be optional. Only set for arm-m. 2014-03-22 21:03:03 -07:00			`endif`

[make] Add support for EXTRA_BUILDRULES All makefiles added to EXTRA_BUILDRULES variable will be included right before processing bulk of build.mk Change-Id: Ic37e37ea7469ee57e6f6543f378c5d0c1510824b 2014-04-11 19:19:18 -07:00			`ifneq (,$(EXTRA_BUILDRULES))`
			`-include $(EXTRA_BUILDRULES)`
			`endif`

[make] add ability to set EXTRA_LINKER_SCRIPTS in modules This allows for individual modules to extend the main linker script, primarily to add their own sections to interate over. Remove the main shared_* linker scripts. 2015-10-26 16:33:39 -07:00			`$(EXTRA_LINKER_SCRIPTS):`

initial commit of lk (little kernel) project 2008-09-01 02:26:09 -07:00			`$(OUTBIN): $(OUTELF)`
[make] fix typo in build output 2019-02-17 20:29:35 -08:00			`$(info generating image: $@)`
initial commit of lk (little kernel) project 2008-09-01 02:26:09 -07:00			`$(NOECHO)$(SIZE) $<`
[make] fix a typo that was causing some build lines to echo 2012-11-11 14:00:34 -08:00			`$(NOECHO)$(OBJCOPY) -O binary $< $@`
initial commit of lk (little kernel) project 2008-09-01 02:26:09 -07:00
[make] also output .hex files in intel hex format 2012-11-02 11:48:17 -07:00			`$(OUTELF).hex: $(OUTELF)`
[make] replace echo commands with $(info) Seems to result in less forks since it doesn't need to run an echo binary. 2018-12-01 11:47:43 -08:00			`$(info generating hex file: $@)`
[make] fix a typo that was causing some build lines to echo 2012-11-11 14:00:34 -08:00			`$(NOECHO)$(OBJCOPY) -O ihex $< $@`
[make] also output .hex files in intel hex format 2012-11-02 11:48:17 -07:00
[make] add ability to set EXTRA_LINKER_SCRIPTS in modules This allows for individual modules to extend the main linker script, primarily to add their own sections to interate over. Remove the main shared_* linker scripts. 2015-10-26 16:33:39 -07:00			`$(OUTELF): $(ALLMODULE_OBJS) $(EXTRA_OBJS) $(LINKER_SCRIPT) $(EXTRA_LINKER_SCRIPTS)`
[make] replace echo commands with $(info) Seems to result in less forks since it doesn't need to run an echo binary. 2018-12-01 11:47:43 -08:00			`$(info linking $@)`
[make] also output the size of any extra objects included in the final link 2015-10-14 13:05:37 -07:00			`$(NOECHO)$(SIZE) -t --common $(sort $(ALLMODULE_OBJS)) $(EXTRA_OBJS)`
[make] Fix linker invocation to be compatible with ld.lld The LLD linker does not allow joined short arguments, so split -dT <script> into -d -T <script>. 2021-12-09 11:19:20 +00:00			`$(NOECHO)$(LD) $(GLOBAL_LDFLAGS) $(ARCH_LDFLAGS) -d -T $(LINKER_SCRIPT) \`
[arch][rules] create ARCH_LDFLAGS and clean up all the arch rules files to consistently use ARCH_* vars 2018-10-13 11:40:10 -07:00			`$(addprefix -T,$(EXTRA_LINKER_SCRIPTS)) \`
[make] output .map file 2016-10-31 10:38:42 +01:00			`$(ALLMODULE_OBJS) $(EXTRA_OBJS) $(LIBGCC) -Map=$(OUTELF).map -o $@`
initial commit of lk (little kernel) project 2008-09-01 02:26:09 -07:00
			`$(OUTELF).sym: $(OUTELF)`
[make] replace echo commands with $(info) Seems to result in less forks since it doesn't need to run an echo binary. 2018-12-01 11:47:43 -08:00			`$(info generating symbols: $@)`
initial commit of lk (little kernel) project 2008-09-01 02:26:09 -07:00			`$(NOECHO)$(OBJDUMP) -t $< \| $(CPPFILT) > $@`
[build] add a vim tag to some build generated files Set the tab stop to 8 and turn off listing characters to look proper on some editors that have that set to something else. 2024-04-23 23:27:37 -07:00			`$(NOECHO)echo "# vim: ts=8 nolist nowrap" >> $@`
initial commit of lk (little kernel) project 2008-09-01 02:26:09 -07:00
[make] also generate lk.elf.sym.sorted 2014-01-26 22:51:51 -08:00			`$(OUTELF).sym.sorted: $(OUTELF)`
[make] replace echo commands with $(info) Seems to result in less forks since it doesn't need to run an echo binary. 2018-12-01 11:47:43 -08:00			`$(info generating sorted symbols: $@)`
[make] also generate lk.elf.sym.sorted 2014-01-26 22:51:51 -08:00			`$(NOECHO)$(OBJDUMP) -t $< \| $(CPPFILT) \| sort > $@`
[build] add a vim tag to some build generated files Set the tab stop to 8 and turn off listing characters to look proper on some editors that have that set to something else. 2024-04-23 23:27:37 -07:00			`$(NOECHO)echo "# vim: ts=8 nolist nowrap" >> $@`
[make] also generate lk.elf.sym.sorted 2014-01-26 22:51:51 -08:00
initial commit of lk (little kernel) project 2008-09-01 02:26:09 -07:00			`$(OUTELF).lst: $(OUTELF)`
[make] replace echo commands with $(info) Seems to result in less forks since it doesn't need to run an echo binary. 2018-12-01 11:47:43 -08:00			`$(info generating listing: $@)`
[make] remove line numbers from the non-debug .lst file Turns out it's just a little too noisy for me for normal bringup. That's what .debug.lst is for. 2025-10-04 14:06:36 -07:00			`$(NOECHO)$(OBJDUMP) $(ARCH_OBJDUMP_FLAGS) -d $< \| $(CPPFILT) > $@`
[build] add a vim tag to some build generated files Set the tab stop to 8 and turn off listing characters to look proper on some editors that have that set to something else. 2024-04-23 23:27:37 -07:00			`$(NOECHO)echo "# vim: ts=8 nolist nowrap" >> $@`
initial commit of lk (little kernel) project 2008-09-01 02:26:09 -07:00
			`$(OUTELF).debug.lst: $(OUTELF)`
[make] replace echo commands with $(info) Seems to result in less forks since it doesn't need to run an echo binary. 2018-12-01 11:47:43 -08:00			`$(info generating listing: $@)`
[build] add line numbers to the disassembly .lst files 2025-09-29 22:28:00 -07:00			`$(NOECHO)$(OBJDUMP) $(ARCH_OBJDUMP_FLAGS) -l -S $< \| $(CPPFILT) > $@`
[build] add a vim tag to some build generated files Set the tab stop to 8 and turn off listing characters to look proper on some editors that have that set to something else. 2024-04-23 23:27:37 -07:00			`$(NOECHO)echo "# vim: ts=8 nolist nowrap" >> $@`
initial commit of lk (little kernel) project 2008-09-01 02:26:09 -07:00
[make] add ability to set EXTRA_LINKER_SCRIPTS in modules This allows for individual modules to extend the main linker script, primarily to add their own sections to interate over. Remove the main shared_* linker scripts. 2015-10-26 16:33:39 -07:00			`$(OUTELF).dump: $(OUTELF)`
[make] replace echo commands with $(info) Seems to result in less forks since it doesn't need to run an echo binary. 2018-12-01 11:47:43 -08:00			`$(info generating objdump: $@)`
[build] c++filt the dump and size map as well 2021-11-10 01:34:44 -08:00			`$(NOECHO)$(OBJDUMP) -x $< \| $(CPPFILT) > $@`
[build] add a vim tag to some build generated files Set the tab stop to 8 and turn off listing characters to look proper on some editors that have that set to something else. 2024-04-23 23:27:37 -07:00			`$(NOECHO)echo "# vim: ts=8 nolist nowrap" >> $@`
[make] add ability to set EXTRA_LINKER_SCRIPTS in modules This allows for individual modules to extend the main linker script, primarily to add their own sections to interate over. Remove the main shared_* linker scripts. 2015-10-26 16:33:39 -07:00
initial commit of lk (little kernel) project 2008-09-01 02:26:09 -07:00			`$(OUTELF).size: $(OUTELF)`
[make] replace echo commands with $(info) Seems to result in less forks since it doesn't need to run an echo binary. 2018-12-01 11:47:43 -08:00			`$(info generating size map: $@)`
[build] c++filt the dump and size map as well 2021-11-10 01:34:44 -08:00			`$(NOECHO)$(NM) -S --size-sort $< \| $(CPPFILT) > $@`
[build] add a vim tag to some build generated files Set the tab stop to 8 and turn off listing characters to look proper on some editors that have that set to something else. 2024-04-23 23:27:37 -07:00			`$(NOECHO)echo "# vim: ts=8 nolist nowrap" >> $@`
initial commit of lk (little kernel) project 2008-09-01 02:26:09 -07:00
[make] add 'make tags' Tries to generate a curated ctags file for the current project and configuration. 2024-05-09 20:27:54 -07:00			`# generate a list of source files that potentially participate in this build.`
			`# header file detection is a bit sloppy: it simply searches for every .h file inside`
			`# the combined include paths. May pick up files that are not strictly speaking used.`
			`# Alternate strategy that may work: union all of the .d files together and collect all`
			`# of the used headers used there.`
			`$(BUILDDIR)/srcfiles.txt: $(OUTELF) $(BUILDDIR)/include_paths.txt`
			`@$(MKDIR)`
[make] replace echo commands with $(info) Seems to result in less forks since it doesn't need to run an echo binary. 2018-12-01 11:47:43 -08:00			`$(info generating $@)`
[make] output a text file with all the source files and include paths used in the build 2015-11-20 20:51:52 -08:00			`$(NOECHO)echo $(sort $(ALLSRCS)) \| tr ' ' '\n' > $@`
[make] add 'make tags' Tries to generate a curated ctags file for the current project and configuration. 2024-05-09 20:27:54 -07:00			@for i in `cat $(BUILDDIR)/include_paths.txt`; do if [ -d $$i ]; then find $$i -type f -name \*.h; fi; done >> $@
[make] output a text file with all the source files and include paths used in the build 2015-11-20 20:51:52 -08:00
[make] add 'make tags' Tries to generate a curated ctags file for the current project and configuration. 2024-05-09 20:27:54 -07:00			`# generate a list of all the include directories used in this project`
[build] add deps for srcfiles.txt and include_paths.txt Without the dependencies, the files get written once and don't get updated when include paths or source files change. 2016-11-21 19:39:31 -08:00			`$(BUILDDIR)/include_paths.txt: $(OUTELF)`
[make] add 'make tags' Tries to generate a curated ctags file for the current project and configuration. 2024-05-09 20:27:54 -07:00			`@$(MKDIR)`
[make] replace echo commands with $(info) Seems to result in less forks since it doesn't need to run an echo binary. 2018-12-01 11:47:43 -08:00			`$(info generating $@)`
[make] output a text file with all the source files and include paths used in the build 2015-11-20 20:51:52 -08:00			`$(NOECHO)echo $(subst -I,,$(sort $(GLOBAL_INCLUDES))) \| tr ' ' '\n' > $@`

[make] better modularize the build system -Each module's rules.mk defines a seperate linkage unit. Each module can have a private set of CFLAGS, DEFINES, INCLUDES, and so forth. -Files to be compiled are now added by source, not object. Most rules.mk files can be converted easily by following these steps: 1) add 'MODULE := $(LOCAL_DIR)' near the top of the file 2) change OBJS += to MODULE_SRCS += and list source files instead of .os 3) add 'include make/module.mk' at the bottom of the file See make/module.mk for directions. 2012-08-29 14:51:23 -07:00			`#include arch/$(ARCH)/compile.mk`
initial commit of lk (little kernel) project 2008-09-01 02:26:09 -07:00