Added possibility to set extra build-cache dirs for cores

Author: cmaglie

commands/service_compile.go

@@ -191,6 +191,12 @@ func (s *arduinoCoreServerImpl) Compile(req *rpc.CompileRequest, stream rpc.Ardu
 		}
 		coreBuildCachePath = buildCachePath.Join("core")
 	}
+	var extraCoreBuildCachePaths paths.PathList
+	if len(req.GetBuildCacheExtraPaths()) == 0 {
+		extraCoreBuildCachePaths = s.settings.GetBuildCacheExtraPaths()
+	} else {
+		extraCoreBuildCachePaths = paths.NewPathList(req.GetBuildCacheExtraPaths()...)
+	}
 
 	if _, err := pme.FindToolsRequiredForBuild(targetPlatform, buildPlatform); err != nil {
 		return err
@@ -229,6 +235,7 @@ func (s *arduinoCoreServerImpl) Compile(req *rpc.CompileRequest, stream rpc.Ardu
 		buildPath,
 		req.GetOptimizeForDebug(),
 		coreBuildCachePath,
+		extraCoreBuildCachePaths,
 		int(req.GetJobs()),
 		req.GetBuildProperties(),
 		s.settings.HardwareDirectories(),

internal/arduino/builder/builder.go

@@ -62,7 +62,8 @@ type Builder struct {
 	customBuildProperties []string
 
 	// core related
-	coreBuildCachePath *paths.Path
+	coreBuildCachePath       *paths.Path
+	extraCoreBuildCachePaths paths.PathList
 
 	logger *logger.BuilderLogger
 	clean  bool
@@ -121,6 +122,7 @@ func NewBuilder(
 	buildPath *paths.Path,
 	optimizeForDebug bool,
 	coreBuildCachePath *paths.Path,
+	extraCoreBuildCachePaths paths.PathList,
 	jobs int,
 	requestBuildProperties []string,
 	hardwareDirs, otherLibrariesDirs paths.PathList,
@@ -211,6 +213,7 @@ func NewBuilder(
 		jobs:                          jobs,
 		customBuildProperties:         customBuildPropertiesArgs,
 		coreBuildCachePath:            coreBuildCachePath,
+		extraCoreBuildCachePaths:      extraCoreBuildCachePaths,
 		logger:                        logger,
 		clean:                         clean,
 		sourceOverrides:               sourceOverrides,

internal/arduino/builder/core.go

@@ -108,6 +108,7 @@ func (b *Builder) compileCore() (*paths.Path, paths.PathList, error) {
 			return true
 		}
 
+		// If there is an archived core in the current build cache, use it
 		if _, err := buildcache.New(b.coreBuildCachePath).GetOrCreate(archivedCoreName); errors.Is(err, buildcache.CreateDirErr) {
 			return nil, nil, errors.New(i18n.Tr("creating core cache folder: %s", err))
 		}
@@ -119,6 +120,19 @@ func (b *Builder) compileCore() (*paths.Path, paths.PathList, error) {
 			}
 			return targetArchivedCore, variantObjectFiles, nil
 		}
+
+		// Otherwise try the extra build cache paths to see if there is a precompiled core
+		// that can be used
+		for _, extraCoreBuildCachePath := range b.extraCoreBuildCachePaths {
+			extraTargetArchivedCore := extraCoreBuildCachePath.Join(archivedCoreName, "core.a")
+			if canUseArchivedCore(extraTargetArchivedCore) {
+				// use archived core
+				if b.logger.Verbose() {
+					b.logger.Info(i18n.Tr("Using precompiled core: %[1]s", extraTargetArchivedCore))
+				}
+				return extraTargetArchivedCore, variantObjectFiles, nil
+			}
+		}
 	}
 
 	coreObjectFiles, err := b.compileFiles(

internal/cli/configuration/build_cache.go

@@ -15,7 +15,11 @@
 
 package configuration
 
-import "time"
+import (
+	"time"
+
+	"github.com/arduino/go-paths-helper"
+)
 
 // GetCompilationsBeforeBuildCachePurge returns the number of compilations before the build cache is purged.
 func (s *Settings) GetCompilationsBeforeBuildCachePurge() uint {
@@ -32,3 +36,24 @@ func (s *Settings) GetBuildCacheTTL() time.Duration {
 	}
 	return s.Defaults.GetDuration("build_cache.ttl")
 }
+
+// GetBuildCachePath returns the path to the build cache.
+func (s *Settings) GetBuildCachePath() (*paths.Path, bool) {
+	p, ok, _ := s.GetStringOk("build_cache.path")
+	if !ok {
+		return nil, false
+	}
+	return paths.New(p), true
+}
+
+// GetBuildCacheExtraPaths returns the extra paths to the core build cache.
+// Those paths are visited before the main core build cache to check for cached items.
+func (s *Settings) GetBuildCacheExtraPaths() paths.PathList {
+	var res paths.PathList
+	if ps, ok, _ := s.GetStringSliceOk("build_cache.extra_paths"); ok {
+		for _, p := range ps {
+			res.Add(paths.New(p, "cores"))
+		}
+	}
+	return res
+}

internal/cli/configuration/defaults.go

@@ -52,6 +52,8 @@ func SetDefaults(settings *Settings) {
 	setDefaultValueAndKeyTypeSchema("sketch.always_export_binaries", false)
 	setDefaultValueAndKeyTypeSchema("build_cache.ttl", (time.Hour * 24 * 30).String())
 	setDefaultValueAndKeyTypeSchema("build_cache.compilations_before_purge", uint(10))
+	setKeyTypeSchema("build_cache.path", "")
+	setKeyTypeSchema("build_cache.extra_paths", []string{})
 
 	// daemon settings
 	setDefaultValueAndKeyTypeSchema("daemon.port", "50051")