Merge pull request #1334 from SpiNNakerManchester/clean

Christian-B · web-flow · commit 733f5f89d49c · 2026-01-21T08:40:41.000Z
Clean
diff --git a/.github/workflows/c_actions.yml b/.github/workflows/c_actions.yml
@@ -42,23 +42,12 @@ jobs:
       with:
         base-dir: c_common/models
 
-    - name: Build C Code
+    - name: Build and insert C Code
       env:
         SPINN_INSTALL_DIR: ${{ github.workspace }}/spinnaker_tools_install
         SPINN_COMMON_INSTALL_DIR: ${{ github.workspace }}/spinn_common_install
         FEC_INSTALL_DIR: ${{ github.workspace }}/fec_install
         CFLAGS: -fdiagnostics-color=always
-        C_LOGS_DICT: ${{ github.workspace }}/spinn_front_end_common/common_model_binaries/logs.sqlite3
-      run: |
-        make -C spinnaker_tools install
-        make -C spinn_common install
-        make -C c_common
-
-    - name: Build C Code central install
-      env:
-        SPINN_DIRS: ${{ github.workspace }}/spinn_dirs
-        CFLAGS: -fdiagnostics-color=always
-        C_LOGS_DICT: ${{ github.workspace }}/spinn_front_end_common/common_model_binaries/logs.sqlite3
       run: |
         make -C spinnaker_tools install
         make -C spinn_common install
@@ -74,5 +63,5 @@ jobs:
         name: fec_binaries
         path: |
           spinn_front_end_common/common_model_binaries/*.aplx
-          spinn_front_end_common/common_model_binaries/logs.sqlite3
+          spinn_front_end_common/common_model_binaries/logs*.sqlite3
         retention-days: 5
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -37,9 +37,6 @@ jobs:
         with:
           repository: SpiNNakerManchester/SupportScripts
           path: support
-      - name: Set dynamic environment variables
-        run: |
-          echo "SPINN_DIRS=$PWD/spinnaker_tools" >> $GITHUB_ENV
 
       - name: Checkout SpiNNaker Dependencies
         uses: SpiNNakerManchester/SupportScripts/actions/install-spinn-deps@main
diff --git a/c_common/Makefile b/c_common/Makefile
@@ -12,8 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-INSTALL_DIRS = front_end_common_lib
-BUILD_DIRS = models
+DIRS = front_end_common_lib models
 
 # Locations of tag files
 TAGFILES=sllt.tag common.tag
@@ -23,16 +22,16 @@ COMMON_TAG=https://spinnakermanchester.github.io/spinn_common/common.tag
 DOXYGEN ?= doxygen
 WGET ?= wget
 
-all: install build
+all: build
 	
-build: install $(BUILD_DIRS)
-	@for d in $(BUILD_DIRS); do $(MAKE) -C $$d || exit $$?; done
+build: $(DIRS)
+	@for d in $(DIRS); do $(MAKE) -C $$d || exit $$?; done
 
-install: $(INSTALL_DIRS)
-	@for d in $(INSTALL_DIRS); do $(MAKE) -C $$d install || exit $$?; done
+install: $(DIRS)
+	@for d in $(DIRS); do $(MAKE) -C $$d install || exit $$?; done
 
-clean: $(BUILD_DIRS)
-	@for d in $(BUILD_DIRS) $(INSTALL_DIRS); do $(MAKE) -C $$d clean || exit $$?; done
+clean: $(DIRS)
+	@for d in $(DIRS); do $(MAKE) -C $$d clean || exit $$?; done
 
 sllt.tag: .sllt_template.tag
 	cp .sllt_template.tag sllt.tag
diff --git a/c_common/front_end_common_lib/Makefile b/c_common/front_end_common_lib/Makefile
@@ -12,12 +12,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# If SPINN_COMMON_INSTALL_DIR is not defined, this is also an error!
-SPINN_COMMON_INSTALL_DIR := $(strip $(if $(SPINN_COMMON_INSTALL_DIR), $(SPINN_COMMON_INSTALL_DIR), $(if $(SPINN_DIRS), $(SPINN_DIRS)/spinn_common_install, $(error SPINN_COMMON_INSTALL_DIR or SPINN_DIRS is not set.  Please define SPINN_COMMON_INSTALL_DIR or SPINN_DIRS))))
-
 FEC_DIR := $(dir $(abspath $(lastword $(MAKEFILE_LIST))))
 FEC_BUILD = $(FEC_DIR)/build
+FEC_LIB = $(FEC_DIR)/lib
 override LIB := 1
+
+SPINN_COMMON_INSTALL_DIR := $(strip $(if $(SPINN_COMMON_INSTALL_DIR), $(SPINN_COMMON_INSTALL_DIR), $(abspath $(FEC_DIR)../../../spinn_common)))
+
 include $(SPINN_COMMON_INSTALL_DIR)/make/spinn_common.mk
 
 ifndef PRINT_DEBUG
@@ -46,39 +47,47 @@ INSTALL ?= install
 
 # Variables needed for file converter
 SRC_DIR = $(FEC_DIR)/src/
-MODIFIED_DIR = $(FEC_BUILD)/modified_src/
+MODIFIED_DIR =  $(FEC_BUILD)/modified_src/
 
 # Build rules (default)
-$(FEC_BUILD)/$(APP).a: $(BUILD_OBJS)
+$(FEC_LIB)/$(APP).a: $(BUILD_OBJS)
 	$(MKDIR) $(FEC_BUILD)
+	$(MKDIR) $(FEC_LIB)
 	@$(RM) $@
 	$(AR) $@ $(BUILD_OBJS)
 
+APP_OUTPUT_DIR := $(FEC_DIR)../../spinn_front_end_common/common_model_binaries/
+# key for the database in this APP_OUTPUT_DIR
+DATABASE_KEY = C
 $(MODIFIED_DIR)%.c: $(RAW_DIR)
-	python -m spinn_utilities.make_tools.converter $(SRC_DIR) $(MODIFIED_DIR) True
+	python -m spinn_utilities.make_tools.converter $(SRC_DIR) $(MODIFIED_DIR) $(APP_OUTPUT_DIR) $(DATABASE_KEY)
 
 $(FEC_BUILD)/%.o: $(MODIFIED_DIR)/%.c
 	$(CC) $(CFLAGS) -o $@ $<
 
+INSTALL_ERROR := c_common/front_end_common_lib install is only required if you are building in a temporary location.
+INSTALL_ERROR += In which case you must set the environment variable FEC_INSTALL_DIR to where the install should go.
+INSTALL_ERROR += This environment variable must also exist for all higher level makes.
+
 # Installing rules
-install: $(FEC_BUILD)/$(APP).a
-	$(eval FEC_INSTALL_DIR := $(strip $(if $(FEC_INSTALL_DIR), $(FEC_INSTALL_DIR), $(if $(SPINN_DIRS), $(SPINN_DIRS)/fec_install, $(error FEC_INSTALL_DIR or SPINN_DIRS is not set.  Please define FEC_INSTALL_DIR or SPINN_DIRS)))))
+install: $(FEC_LIB)/$(APP).a
+	$(eval FEC_INSTALL_DIR := $(strip $(if $(FEC_INSTALL_DIR), $(FEC_INSTALL_DIR), $(error $(INSTALL_ERROR)))))
 	$(MKDIR) $(FEC_INSTALL_DIR)/lib
 	$(MKDIR) $(FEC_INSTALL_DIR)/include
 	$(MKDIR) $(FEC_INSTALL_DIR)/make
 	$(INSTALL) -c -m644 $< $(FEC_INSTALL_DIR)/lib
 	$(INSTALL) -c -m644 $(HEADERS:%=$(FEC_DIR)/include/%) $(FEC_INSTALL_DIR)/include
-	$(INSTALL) -c -m644 $(FEC_DIR)/fec.mk $(FEC_INSTALL_DIR)/make
+	$(INSTALL) -c -m644 $(FEC_DIR)/make/fec.mk $(FEC_INSTALL_DIR)/make
 
 clean:
-	$(RM) $(FEC_BUILD)/$(APP).a $(BUILD_OBJS)
+	$(RM) $(FEC_LIB)/$(APP).a $(BUILD_OBJS)
 	rm -rf $(MODIFIED_DIR)
-	$(RM) $(FEC_BUILD)/logs.sqlite3
+	$(RM) $(APP_OUTPUT_DIR)logs*.sqlite3
+	$(RM) $(APP_OUTPUT_DIR)*.aplx
 
 .PRECIOUS: $(MODIFIED_DIR)%.c $(BUILD_DIR)%.nm $(BUILD_DIR)%.elf $(BUILD_DIR)%.bin
 
 .PHONY: clean install
 
 test:
-	#$(APP_OUTPUT_DIR)$(APP).dict
 	#$(INSTALL_LIBS)
diff --git a/c_common/front_end_common_lib/lib/.gitignore b/c_common/front_end_common_lib/lib/.gitignore
@@ -0,0 +1 @@
+*.a
diff --git a/c_common/front_end_common_lib/make/fec.mk b/c_common/front_end_common_lib/make/fec.mk
@@ -12,11 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# FEC_INSTALL_DIR must be set for this file to be found
-
-# We also need SPINN_COMMON_INSTALL_DIR for common library
-SPINN_COMMON_INSTALL_DIR := $(strip $(if $(SPINN_COMMON_INSTALL_DIR), $(SPINN_COMMON_INSTALL_DIR), $(if $(SPINN_DIRS), $(SPINN_DIRS)/spinn_common_install, $(error SPINN_COMMON_INSTALL_DIR or SPINN_DIRS is not set.  Please define SPINN_COMMON_INSTALL_DIR or SPINN_DIRS))))
-
 # Find out where we are installed now (in the make subdirectory, so go up one)
 FEC_DIR := $(abspath $(dir $(lastword $(MAKEFILE_LIST)))/../)
 
@@ -27,7 +22,13 @@ ifndef APP_OUTPUT_DIR
 endif
 APP_OUTPUT_DIR :=  $(abspath $(APP_OUTPUT_DIR))/
 
-# APP name for a and dict files
+ifndef DATABASE_KEY
+    # Makes in https://github.com/orgs/SpiNNakerManchester should user Upper case letters
+    # So each user APP_OUTPUT_DIR should have a unique lower case one to avoid clashes
+    $(error DATABASE_KEY is not set. Please set it to a unique lower case letter)
+endif
+
+# APP name for a files
 ifndef APP
     $(error APP is not set.  Please define APP)
 endif
@@ -69,12 +70,12 @@ get_path = $(abspath $(word $2, $(subst :, ,$1)))/
 # directory pair
 define add_source_dir#(src_dir)
 $(call get_path,$(1),2): $(wildcard $(call get_path,$(1),1)/**/*)
-	python -m spinn_utilities.make_tools.converter $(call get_path,$(1),1) $(call get_path,$(1),2)
+	python -m spinn_utilities.make_tools.converter $(call get_path,$(1),1) $(call get_path,$(1),2) $(APP_OUTPUT_DIR) $(DATABASE_KEY)
 
 $(call get_path,$(1), 2)%.c: $(call get_path,$(1), 1)%.c
-	python -m spinn_utilities.make_tools.converter $(call get_path,$(1),1) $(call get_path,$(1),2)
+	python -m spinn_utilities.make_tools.converter $(call get_path,$(1),1) $(call get_path,$(1),2) $(APP_OUTPUT_DIR) $(DATABASE_KEY)
 $(call get_path,$(1), 2)%.h: $(call get_path,$(1), 1)%.h
-	python -m spinn_utilities.make_tools.converter $(call get_path,$(1),1) $(call get_path,$(1),2)
+	python -m spinn_utilities.make_tools.converter $(call get_path,$(1),1) $(call get_path,$(1),2) $(APP_OUTPUT_DIR) $(DATABASE_KEY)
 
 # Build the o files from the modified sources
 $$(BUILD_DIR)%.o: $(call get_path,$(1),2)%.c
@@ -135,9 +136,7 @@ $(foreach d, $(SOURCE_DIRS), \
     $(eval $(call add_source_dir, $(d))))
 OBJECTS += $(_OBJS)
 
+SPINN_COMMON_INSTALL_DIR := $(strip $(if $(SPINN_COMMON_INSTALL_DIR), $(SPINN_COMMON_INSTALL_DIR), $(abspath $(FEC_DIR)/../../../spinn_common)))
+
 # Bring in the common makefile
 include $(SPINN_COMMON_INSTALL_DIR)/make/spinn_common.mk
-
-# Tidy and cleaning dependencies
-clean:
-	$(RM) $(TEMP_FILES) $(OBJECTS) $(BUILD_DIR)$(APP).elf $(BUILD_DIR)$(APP).txt $(ALL_TARGETS) $(BUILD_DIR)$(APP).nm $(BUILD_DIR)$(APP).elf $(BUILD_DIR)$(APP).bin
diff --git a/c_common/models/Makefile b/c_common/models/Makefile
@@ -19,6 +19,8 @@ BUILD_DIRS = compressors \
 	         reverse_iptag_multicast_source \
 	         system_models
 
+install: all
+
 all: $(BUILD_DIRS)
 	@for d in $(BUILD_DIRS); do $(MAKE) -C $$d || exit $$?; done
 
diff --git a/c_common/models/chip_power_monitor/Makefile b/c_common/models/chip_power_monitor/Makefile
@@ -12,7 +12,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+CUR_DIR := $(abspath $(dir $(lastword $(MAKEFILE_LIST))))
+
 APP = chip_power_monitor
 SOURCES = chip_power_monitor.c
 
 include ../fec_models.mk
+
+clean:
+	$(RM) -r $(CUR_DIR)/build
diff --git a/c_common/models/command_sender_multicast_source/Makefile b/c_common/models/command_sender_multicast_source/Makefile
@@ -12,7 +12,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+CUR_DIR := $(abspath $(dir $(lastword $(MAKEFILE_LIST))))
+
 APP = command_sender_multicast_source
 SOURCES = command_sender_multicast_source.c
 
 include ../fec_models.mk
+
+clean:
+	$(RM) -r $(CUR_DIR)/build
diff --git a/c_common/models/compressors/Makefile b/c_common/models/compressors/Makefile
@@ -18,5 +18,7 @@ APPS = simple_pair_compressor.mk \
 all: $(APPS)
 	for f in $(APPS); do $(MAKE) -f $$f || exit $$?; done
 
-clean: $(DIRS)
-	for f in $(APPS); do $(MAKE) -f $$f clean || exit $$?; done
+CUR_DIR := $(abspath $(dir $(lastword $(MAKEFILE_LIST))))
+
+clean:
+	$(RM) -r $(CUR_DIR)/build
diff --git a/c_common/models/fec_models.mk b/c_common/models/fec_models.mk
@@ -12,12 +12,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-FEC_INSTALL_DIR := $(strip $(if $(FEC_INSTALL_DIR), $(FEC_INSTALL_DIR), $(if $(SPINN_DIRS), $(SPINN_DIRS)/fec_install, $(error FEC_INSTALL_DIR or SPINN_DIRS is not set.  Please define FEC_INSTALL_DIR or SPINN_DIRS))))
-
 MAKEFILE_PATH := $(abspath $(lastword $(MAKEFILE_LIST)))
 CURRENT_DIR := $(dir $(MAKEFILE_PATH))
 APP_OUTPUT_DIR := $(abspath $(CURRENT_DIR)../../spinn_front_end_common/common_model_binaries/)/
+# key for the database in this APP_OUTPUT_DIR
+DATABASE_KEY = C
 
-include $(FEC_INSTALL_DIR)/make/fec.mk
+FEC_MK = $(abspath $(CURRENT_DIR)../front_end_common_lib/make/fec.mk)
+include $(FEC_MK)
 
 .PRECIOUS: $(MODIFIED_DIR)%.c $(BUILD_DIR)%.o
diff --git a/c_common/models/live_packet_gather/Makefile b/c_common/models/live_packet_gather/Makefile
@@ -12,7 +12,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+CUR_DIR := $(abspath $(dir $(lastword $(MAKEFILE_LIST))))
+
 APP = live_packet_gather
 SOURCES = live_packet_gather.c
 
 include ../fec_models.mk
+
+clean:
+	$(RM) -r $(CUR_DIR)/build
diff --git a/c_common/models/reverse_iptag_multicast_source/Makefile b/c_common/models/reverse_iptag_multicast_source/Makefile
@@ -12,7 +12,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+CUR_DIR := $(abspath $(dir $(lastword $(MAKEFILE_LIST))))
+
 APP = reverse_iptag_multicast_source
 SOURCES = reverse_iptag_multicast_source.c
 
 include ../fec_models.mk
+
+clean:
+	$(RM) -r $(CUR_DIR)/build
diff --git a/c_common/models/system_models/Makefile b/c_common/models/system_models/Makefile
@@ -17,5 +17,7 @@ APPS = extra_monitor.mk data_speed_up_packet_gatherer.mk
 all: $(APPS)
 	for f in $(APPS); do $(MAKE) -f $$f || exit $$?; done
 
-clean: $(DIRS)
-	for f in $(APPS); do $(MAKE) -f $$f clean || exit $$?; done
+CUR_DIR := $(abspath $(dir $(lastword $(MAKEFILE_LIST))))
+
+clean:
+	$(RM) -r $(CUR_DIR)/build
diff --git a/setup.cfg b/setup.cfg
@@ -59,7 +59,7 @@ include =
         spinnaker.cfg
         spinnaker.cfg.template
         *.aplx
-        *.dict
+        logs*.sqlite3
         *.sql
         py.typed
 
diff --git a/spinn_front_end_common/common_model_binaries/.gitignore b/spinn_front_end_common/common_model_binaries/.gitignore
@@ -1 +1,2 @@
 *.aplx
+logs*.sqlite3
diff --git a/spinn_front_end_common/interface/spinnaker.cfg b/spinn_front_end_common/interface/spinnaker.cfg
@@ -322,6 +322,9 @@ validate_json = Debug
 @validate_json = Runs schema validation on json files created.
     Mainly used for testing changes to the algorithms or bugs.
 
+external_binaries = None
+@external_binaries = Absolute path to where user created and combined binaries are located.
+
 [Buffers]
 @ = This section control if runs are divided into smaller runs and how.
 
diff --git a/unittests/interface/interface_functions/logsZ.sqlite3 b/unittests/interface/interface_functions/logsZ.sqlite3
@@ -0,0 +1,15 @@
+Copyright (c) 2025 The University of Manchester
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+     https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+MOCK for DataView.register_binary_search_path
diff --git a/unittests/interface/interface_functions/mock.dict b/unittests/interface/interface_functions/mock.dict
diff --git a/unittests/interface/interface_functions/test_front_end_common_chip_iobuf_extractor.py b/unittests/interface/interface_functions/test_front_end_common_chip_iobuf_extractor.py
@@ -13,11 +13,9 @@
 # limitations under the License.
 
 import os
-import tempfile
 from typing import Iterable, List, Optional, Tuple
 import unittest
 from spinn_utilities.config_holder import set_config
-from spinn_utilities.make_tools.log_sqllite_database import LogSqlLiteDatabase
 from spinn_utilities.overrides import overrides
 from spinn_machine import CoreSubsets, CoreSubset
 from spinnman.model import IOBuffer
@@ -85,9 +83,6 @@ class TestFrontEndCommonChipIOBufExtractor(unittest.TestCase):
 
     def setUp(self) -> None:
         unittest_setup()
-        os.environ["C_LOGS_DICT"] = tempfile.mktemp()
-        # There needs to be a dict but it can be empty
-        LogSqlLiteDatabase(new_dict=True)
         writer = FecDataWriter.mock()
         writer.set_transceiver(_PretendTransceiver(
             [IOBuffer(0, 0, 1, text001), IOBuffer(0, 0, 2, text002),
