[build] Keep top-level script in cwd with different outpath

Author: salkinium

examples/nucleo_f103rb/blink/project.xml

@@ -3,8 +3,11 @@
   <options>
     <option name="modm:build:build.path">../../../build/nucleo_f103rb/blink</option>
   </options>
+  <!-- This just tests the lbuild outpath, don't copy this! -->
+  <outpath>../generated/blink</outpath>
   <modules>
     <module>modm:build:scons</module>
+    <module>modm:build:make</module>
     <module>modm:processing:timer</module>
   </modules>
 </library>

repo.lb

@@ -24,7 +24,7 @@ from os.path import normpath
 
 # Check for miminum required lbuild version
 import lbuild
-min_lbuild_version = "1.17.0"
+min_lbuild_version = "1.20.0"
 if StrictVersion(getattr(lbuild, "__version__", "0.1.0")) < StrictVersion(min_lbuild_version):
     print("modm requires at least lbuild v{}, please upgrade!\n"
           "    pip3 install -U lbuild".format(min_lbuild_version))

src/modm/platform/core/avr/module.lb

@@ -35,7 +35,8 @@ def build(env):
 
     env.outbasepath = "modm/link"
     env.copy("linkerscript.ld")
-    env.collect(":build:linkflags", "-L{project_source_dir}", "-Tmodm/link/linkerscript.ld")
+    env.collect(":build:linkflags", "-L{project_source_dir}",
+                "-T{}".format(env.relcwdoutpath("modm/link/linkerscript.ld")))
 
     env.substitutions = {
         "target": target.identifier,

src/modm/platform/core/cortex/module.lb

@@ -343,11 +343,9 @@ def build(env):
 
     env.collect(":build:linkflags", "-Wl,--no-wchar-size-warning", "-L{project_source_dir}")
     # Linkerscript
-    linkerscript_override_option = env["linkerscript.override"]
-    if linkerscript_override_option:
-        env.collect(":build:linkflags", "-T{}".format(linkerscript_override_option))
-    else:
-        env.collect(":build:linkflags", "-Tmodm/link/linkerscript.ld")
+    linkerscript = env["linkerscript.override"]
+    env.collect(":build:linkflags", "-T{}".format(env.relcwdoutpath(
+            linkerscript if linkerscript else "modm/link/linkerscript.ld")))
 
     # Compilation for FPU
     core = env[":target"].get_driver("core")["type"]

test/Makefile

@@ -9,15 +9,15 @@
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
-# LBUILD = python3 ../../library-builder/scripts/lbuild
-# LBUILD = lbuild
+# LBUILD = python3 ../../lbuild
 LBUILD = $(shell which lbuild)
 # SCONS = python3 `which scons`
 SCONS = scons
 
 define compile-test
 	@$(RM) -r ../build/generated-unittest/$(1)
-	$(LBUILD) -c config/$(1).xml $(3) -p ../build/generated-unittest/$(1) build --no-log
+	$(LBUILD) -p ../build/generated-unittest/$(1) -c config/$(1).xml $(3) \
+			  -C ../build/generated-unittest/$(1) build --no-log
 	$(SCONS) -C ../build/generated-unittest/$(1) $(2)
 endef
 define run-test

test/all/run_all.py

@@ -145,7 +145,7 @@ def run(self):
 
             lbuild_command += ["-D:target={}".format(self.device),
                                "-D:build:build.path={}/build".format(tempdir),
-                               "-p", str(tempdir),
+                               "-p", str(tempdir), "-C", str(tempdir),
                                "build",
                                "--no-log"]
 

tools/build_script_generator/make/module.lb

@@ -56,19 +56,21 @@ def post_build(env):
         subs["memories"] = []
     # Add SCons specific data
     linkerscript = env.get(":platform:cortex-m:linkerscript.override")
-    linkerscript = env.relative_outpath(linkerscript) if linkerscript \
+    linkerscript = linkerscript if linkerscript \
                    else "modm/link/linkerscript.ld"
     subs.update({
-        "build_path": env.relative_outpath(env["::build.path"]),
-        "generated_paths": repositories,
+        "build_path": env.relcwdoutpath(env["::build.path"]),
+        "modm_path": env.relcwdoutpath("modm"),
+        "outpath": env.relcwdoutpath(""),
+        "repositories": repositories,
         "linkerscript": linkerscript,
         "is_unittest": is_unittest,
         "program_extension": "exe" if env[":target"].identifier.family == "windows" else "elf",
     })
     if is_unittest:
-        subs["unittest_source"] = env.relative_outpath(env["::unittest.source"])
+        subs["unittest_source"] = env.relcwdoutpath(env["::unittest.source"])
     if len(env["::image.source"]):
-        subs["image_source"] = env.relative_outpath(env["::image.source"])
+        subs["image_source"] = env.relcwdoutpath(env["::image.source"])
     if subs["platform"] == "avr":
         subs.update(env.query("::avrdude_options"))
     if subs["platform"] == "sam":
@@ -83,6 +85,8 @@ def post_build(env):
             nflag = fmt(flag)
             if nflag: return nflag;
         return flag
+    def relocate(path):
+        return env.relcwdoutpath(path).replace(subs["modm_path"], "$(MODM_PATH)")
 
     for repo in repositories:
         files = []
@@ -115,17 +119,17 @@ def post_build(env):
         # Generate library SConscript
         env.outbasepath = repo
         env.template("resources/repo.mk.in", "repo.mk",
-                     filters={"flags_format": flags_format,
+                     filters={"flags_format": flags_format, "relocate": relocate,
                               "objectify": lambda f: f.rsplit(".", 1)[0]+".o"})
 
     env.outbasepath = "modm"
-    env.template("resources/config.mk.in", "config.mk")
+    env.template("resources/config.mk.in", "config.mk", filters={"relocate": relocate})
     env.template("resources/compiler.mk.in", "compiler.mk")
 
     # these are the ONLY files that are allowed to NOT be namespaced with modm!
-    env.outbasepath = "."
+    env.outbasepath = env.cwdpath(".")
     if env["include_makefile"]:
-        env.template("resources/Makefile.in", "Makefile")
+        env.template("resources/Makefile.in", "Makefile", filters={"relocate": relocate})
 
 
 # ============================ Option Descriptions ============================

tools/build_script_generator/make/resources/Makefile.in

@@ -21,18 +21,19 @@
 # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
+MODM_PATH := {{modm_path}}
 %% if is_unittest
 unittest_runner.cpp:
-	@python3 modm/modm_tools/unit_test.py {{ unittest_source }}
+	@python3 $(MODM_PATH)/modm_tools/unit_test.py {{ unittest_source }}
 APP_SRC := unittest_runner.cpp
 %% else
 APP_SRC := $(shell find . -type f \( -name '*.c' -o -iname '*.s' -o -name '*.sx' \
 			-o -name '*.cpp' -o -name '*.cxx' -o -name '*.c++' -o -name '*.cc' \) )
 %% endif
 %#
-include modm/config.mk
-%% for path in generated_paths
-include {{path}}/repo.mk
+include $(MODM_PATH)/config.mk
+%% for repo in repositories
+include {{ repo | relocate }}/repo.mk
 %% endfor
 %#
 %% if platform == "hosted"
@@ -73,14 +74,14 @@ size: build
 port?=auto
 .PHONY: program
 program: build
-	@python3 modm/modm_tools/avrdude.py -p $(CONFIG_AVRDUDE_DEVICE) \
+	@python3 $(MODM_PATH)/modm_tools/avrdude.py -p $(CONFIG_AVRDUDE_DEVICE) \
 			$(CONFIG_AVRDUDE_PROGRAMMER) $(CONFIG_AVRDUDE_OPTIONS) \
 			-P $(if $(CONFIG_AVRDUDE_PORT),$(CONFIG_AVRDUDE_PORT),$(port)) \
 			$(CONFIG_AVRDUDE_BAUDRATE) $(ELF_FILE)
 
 .PHONY: program-fuses
 program-fuses: build
-	@python3 modm/modm_tools/avrdude.py -p $(CONFIG_AVRDUDE_DEVICE) \
+	@python3 $(MODM_PATH)/modm_tools/avrdude.py -p $(CONFIG_AVRDUDE_DEVICE) \
 			$(CONFIG_AVRDUDE_PROGRAMMER) $(CONFIG_AVRDUDE_OPTIONS) \
 			-P $(if $(CONFIG_AVRDUDE_PORT),$(CONFIG_AVRDUDE_PORT),$(port)) \
 			$(CONFIG_AVRDUDE_BAUDRATE) $(ELF_FILE) \
@@ -90,17 +91,17 @@ program-fuses: build
 .PHONY: size
 size: build
 	@echo "Memory usage···" $(ELF_FILE)
-	@python3 modm/modm_tools/size.py $(ELF_FILE) $(CONFIG_DEVICE_MEMORY)
+	@python3 $(MODM_PATH)/modm_tools/size.py $(ELF_FILE) $(CONFIG_DEVICE_MEMORY)
 
 port?=auto
 .PHONY: program
 program: build
-	@python3 modm/modm_tools/openocd.py $(ELF_FILE) \
+	@python3 $(MODM_PATH)/modm_tools/openocd.py $(ELF_FILE) \
 			$(addprefix -f ,$(MODM_OPENOCD_CONFIGFILES))
 
 .PHONY: program-bmp
 program-bmp: build
-	@python3 modm/modm_tools/bmp.py -p $(port) $(ELF_FILE)
+	@python3 $(MODM_PATH)/modm_tools/bmp.py -p $(port) $(ELF_FILE)
 
 delay?=5
 .PHONY: program-dfu
@@ -110,49 +111,49 @@ program-dfu: bin
 %% if platform in ["sam"]
 .PHONY: program-bossac
 program-bossac: bin
-	@python3 modm/modm_tools/bossac.py -p $(port) \
+	@python3 $(MODM_PATH)/modm_tools/bossac.py -p $(port) \
 			--offset $(if $($(MODM_BOSSAC_OFFSET) < 4096),4096,$(MODM_BOSSAC_OFFSET)) \
 			$(MODM_BOSSAC_OPTIONS) $(BIN_FILE)
 %% endif
 %#
 .PHONY: reset
 reset:
-	@python3 modm/modm_tools/openocd.py --reset \
+	@python3 $(MODM_PATH)/modm_tools/openocd.py --reset \
 			$(addprefix -f ,$(MODM_OPENOCD_CONFIGFILES))
 
 .PHONY: reset-bmp
 reset-bmp:
-	@python3 modm/modm_tools/bmp.py -p $(port) --reset
+	@python3 $(MODM_PATH)/modm_tools/bmp.py -p $(port) --reset
 
 ui?=tui
 .PHONY: debug
 debug: build
-	@python3 modm/modm_tools/gdb.py $(addprefix -x ,$(MODM_GDBINIT)) \
+	@python3 $(MODM_PATH)/modm_tools/gdb.py $(addprefix -x ,$(MODM_GDBINIT)) \
 			$(addprefix -x ,$(MODM_OPENOCD_GDBINIT)) \
 			$(ELF_FILE) --ui=$(ui) \
 			openocd $(addprefix -f ,$(MODM_OPENOCD_CONFIGFILES))
 
 .PHONY: debug-bmp
 debug-bmp: build
-	@python3 modm/modm_tools/gdb.py $(addprefix -x ,$(MODM_GDBINIT)) \
+	@python3 $(MODM_PATH)/modm_tools/gdb.py $(addprefix -x ,$(MODM_GDBINIT)) \
 			$(ELF_FILE) --ui=$(ui) \
 			bmp -p $(port)
 
 coredump?=coredump.txt
 .PHONY: debug-coredump
 debug-coredump: build
-	@python3 modm/modm_tools/gdb.py $(addprefix -x ,$(MODM_GDBINIT)) \
+	@python3 $(MODM_PATH)/modm_tools/gdb.py $(addprefix -x ,$(MODM_GDBINIT)) \
 			$(ELF_FILE) --ui=$(ui) \
-			crashdebug --binary-path modm/ext/crashcatcher/bins \
+			crashdebug --binary-path $(MODM_PATH)/ext/crashcatcher/bins \
 			--dump $(coredump)
 
 fcpu?=0
 .PHONY: log-itm
 log-itm:
-	@python3 modm/modm_tools/log.py itm openocd -f modm/openocd.cfg --fcpu $(fcpu)
+	@python3 $(MODM_PATH)/modm_tools/log.py itm openocd -f $(MODM_PATH)/openocd.cfg --fcpu $(fcpu)
 
 channel?=0
 .PHONY: log-rtt
 log-rtt:
-	@python3 modm/modm_tools/log.py rtt openocd -f modm/openocd.cfg --channel $(channel)
+	@python3 $(MODM_PATH)/modm_tools/log.py rtt openocd -f $(MODM_PATH)/openocd.cfg --channel $(channel)
 %% endif

tools/build_script_generator/make/resources/config.mk.in

@@ -38,9 +38,9 @@ CONFIG_AVRDUDE_OPTIONS := {{ avrdude_options }}
 CONFIG_AVRDUDE_BAUDRATE := -b {{ avrdude_baudrate }}
 %% endif
 %% elif core.startswith("cortex-m")
-MODM_OPENOCD_CONFIGFILES += modm/openocd.cfg
-MODM_OPENOCD_GDBINIT += modm/openocd_gdbinit
-MODM_GDBINIT += modm/gdbinit
+MODM_OPENOCD_CONFIGFILES += $(MODM_PATH)/openocd.cfg
+MODM_OPENOCD_GDBINIT += $(MODM_PATH)/openocd_gdbinit
+MODM_GDBINIT += $(MODM_PATH)/gdbinit
 %% if platform == "sam"
 %% if bossac_offset
 MODM_BOSSAC_OFFSET := {{ bossac_offset }}
@@ -51,19 +51,19 @@ MODM_BOSSAC_OPTIONS := {{ bossac_options }}
 %% endif
 %% endif
 %#
-include modm/compiler.mk
+include $(MODM_PATH)/compiler.mk
 
 # Application sources
 APP_SRC := $(APP_SRC:./%=%)
-%% for repo in generated_paths
-APP_SRC := $(filter-out {{repo}}/%,$(APP_SRC))
+%% for repo in repositories
+APP_SRC := $(filter-out {{ repo | relocate }}/%,$(APP_SRC))
 %% endfor
 CPPDEFINES += -I.
 %% if options["::info.git"] != "Disabled"
 %#
 # Git information
-INFO_GIT_FILE := modm/src/info_git.c
-$(INFO_GIT_FILE): $(shell python3 modm/modm_tools/info.py \
+INFO_GIT_FILE := $(MODM_PATH)/src/info_git.c
+$(INFO_GIT_FILE): $(shell python3 $(MODM_PATH)/modm_tools/info.py \
     -o $(INFO_GIT_FILE) -t {{ "git_status" if "Status" in options["::info.git"] else "git" }} --check-rebuild);
 APP_SRC += $(INFO_GIT_FILE)
 CLEAN_FILES += $(INFO_GIT_FILE)
@@ -72,9 +72,9 @@ CPPDEFINES += -DMODM_GIT_INFO{% if "Status" in options["::info.git"] %} -DMODM_G
 %% if options["::info.build"]
 %#
 # Build information
-INFO_BUILD_FILE := modm/src/info_build.c
+INFO_BUILD_FILE := $(MODM_PATH)/src/info_build.c
 $(INFO_BUILD_FILE):
-	@python3 modm/modm_tools/info.py -o $(INFO_BUILD_FILE) -t build --compiler $(CC) \
+	@python3 $(MODM_PATH)/modm_tools/info.py -o $(INFO_BUILD_FILE) -t build --compiler $(CC) \
 		--additions MODM_BUILD_PROJECT_NAME="$(MODM_PROJECT_NAME)"
 APP_SRC += $(INFO_BUILD_FILE)
 CLEAN_FILES += $(INFO_BUILD_FILE)
@@ -86,7 +86,7 @@ CPPDEFINES += -DMODM_BUILD_INFO
 IMAGE_SOURCE := {{image_source}}
 .PRECIOUS: $(IMAGE_SOURCE)/%.cpp
 $(IMAGE_SOURCE)/%.cpp: $(IMAGE_SOURCE)/%.pbm
-	@python3 modm/modm_tools/bitmap.py $^ -o $(dir $^)
+	@python3 $(MODM_PATH)/modm_tools/bitmap.py $^ -o $(dir $^)
 IMAGE_PBM := $(wildcard $(IMAGE_SOURCE)/*.pbm)
 APP_SRC += $(IMAGE_PBM:.pbm=.cpp)
 CPPDEFINES += -I$(IMAGE_SOURCE)
@@ -98,11 +98,11 @@ APP_OBJS := $(addprefix $(BUILDPATH)/,$(APP_SRC))
 %% for suffix in ["cpp", "cxx", "c++", "cc", "c", "sx", "s", "S"]
 APP_OBJS := $(APP_OBJS:.{{suffix}}=.o)
 %% endfor
-LIBRARIES :={% for repo in generated_paths %} $(BUILDPATH)/{{repo}}/lib{{repo}}.a{% endfor %}
+LIBRARIES :={% for repo in repositories %} $(BUILDPATH)/{{repo}}/lib{{repo}}.a{% endfor %}
 
 # Application linking
 .PRECIOUS: $(BUILDPATH)/%.{{program_extension}}
-$(BUILDPATH)/%.{{program_extension}}: $(APP_OBJS) $(LIBRARIES){% if platform != "hosted" %} {{ linkerscript }}{% endif %}
+$(BUILDPATH)/%.{{program_extension}}: $(APP_OBJS) $(LIBRARIES){% if platform != "hosted" %} {{ linkerscript | relocate }}{% endif %}
 	@echo "Linking········" $@
 	@$(CXX) -o $@ $(LINKFLAGS) $(filter %.o,$^) $(LIBPATH) \
 %% if platform != "hosted"
@@ -131,13 +131,25 @@ compile_asm = \
 .PRECIOUS: $(BUILDPATH)/%.o $(BUILDPATH)/%.a
 $(BUILDPATH)/%.o : %.c
 	@$(call compile_c,$@,$<,)
+%% if outpath != "."
+$(BUILDPATH)/%.o : {{outpath}}/%.c
+	@$(call compile_c,$@,$<,)
+%% endif
 %% for suffix in ["cc", "cpp", "cxx", "c++"]
 $(BUILDPATH)/%.o : %.{{suffix}}
 	@$(call compile_cpp,$@,$<,)
+%% if outpath != "."
+$(BUILDPATH)/%.o : {{outpath}}/%.{{suffix}}
+	@$(call compile_cpp,$@,$<,)
+%% endif
 %% endfor
 %% for suffix in ["sx", "s", "S"]
 $(BUILDPATH)/%.o : %.{{suffix}}
 	@$(call compile_asm,$@,$<,)
+%% if outpath != "."
+$(BUILDPATH)/%.o : {{outpath}}/%.{{suffix}}
+	@$(call compile_asm,$@,$<,)
+%% endif
 %% endfor
 %#
 .PRECIOUS: $(BUILDPATH)/%.bin

tools/build_script_generator/make/resources/repo.mk.in

@@ -48,7 +48,7 @@ LINKFLAGS += $(ARCHFLAGS)
 # Include paths
 CPPDEFINES += \
 %% for path in include_paths | sort
-	-I{{ path | modm.windowsify(escape_level=0) }}{% if not loop.last %} \{% endif %}
+	-I{{ path | relocate }}{% if not loop.last %} \{% endif %}
 %% endfor
 %% endif
 
@@ -57,7 +57,7 @@ CPPDEFINES += \
 # Repo sources
 {{ repo|upper }}_OBJS += \
 %% for file, _ in sources
-	$(BUILDPATH)/{{ file | modm.windowsify(escape_level=0) | objectify }}{% if not loop.last %} \{% endif %}
+	$(BUILDPATH)/{{ file | objectify }}{% if not loop.last %} \{% endif %}
 %% endfor
 
 # Include header dependencies files
@@ -66,7 +66,7 @@ CPPDEFINES += \
 # Custom build rules for repo sources
 %% for file, flags in sources
 	%% if flags | length
-$(BUILDPATH)/{{ file | modm.windowsify(escape_level=0) | objectify }}: {{ file | modm.windowsify(escape_level=0) }}
+$(BUILDPATH)/{{ file | objectify }}: {{ file }}
 	%% set ext = {"sx":"asm","s":"asm","S":"asm"}.get(file.split(".")[-1],file.split(".")[-1])
 	@$(call compile_{{ ext }},$@,$<,{% for key, profiles in flags.items() if "" in profiles %} {{ profiles[""] | join(" ") }}{% endfor %} \
 		%% for key, profiles in flags.items()
@@ -101,7 +101,7 @@ LIBS += \
 # Repo library paths
 LIBPATH += \
 %% for library in library_paths | sort
-	-L{{ library | modm.windowsify(escape_level=0) }}{% if not loop.last %} \{% endif %}
+	-L{{ library | relocate }}{% if not loop.last %} \{% endif %}
 %% endfor
 %% endif