The build caching of core.a is now optional thorugh a command line option

Signed-off-by: Cristian Maglie <c.maglie@arduino.cc>

Author: cmaglie

src/arduino.cc/arduino-builder/main.go

@@ -64,6 +64,7 @@ const FLAG_FQBN = "fqbn"
 const FLAG_IDE_VERSION = "ide-version"
 const FLAG_CORE_API_VERSION = "core-api-version"
 const FLAG_BUILD_PATH = "build-path"
+const FLAG_BUILD_CACHE = "build-cache"
 const FLAG_VERBOSE = "verbose"
 const FLAG_QUIET = "quiet"
 const FLAG_DEBUG_LEVEL = "debug-level"
@@ -126,6 +127,7 @@ var fqbnFlag *string
 var coreAPIVersionFlag *string
 var ideVersionFlag *string
 var buildPathFlag *string
+var buildCachePathFlag *string
 var verboseFlag *bool
 var quietFlag *bool
 var debugLevelFlag *int
@@ -148,6 +150,7 @@ func init() {
 	coreAPIVersionFlag = flag.String(FLAG_CORE_API_VERSION, "10600", "version of core APIs (used to populate ARDUINO #define)")
 	ideVersionFlag = flag.String(FLAG_IDE_VERSION, "10600", "[deprecated] use '"+FLAG_CORE_API_VERSION+"' instead")
 	buildPathFlag = flag.String(FLAG_BUILD_PATH, "", "build path")
+	buildCachePathFlag = flag.String(FLAG_BUILD_CACHE, "", "builds of 'core.a' are saved into this folder to be cached and reused")
 	verboseFlag = flag.Bool(FLAG_VERBOSE, false, "if 'true' prints lots of stuff")
 	quietFlag = flag.Bool(FLAG_QUIET, false, "if 'true' doesn't print any warnings or progress or whatever")
 	debugLevelFlag = flag.Int(FLAG_DEBUG_LEVEL, builder.DEFAULT_DEBUG_LEVEL, "Turns on debugging messages. The higher, the chattier")
@@ -256,6 +259,25 @@ func main() {
 	}
 	ctx.BuildPath = buildPath
 
+	// FLAG_BUILD_CACHE
+	buildCachePath, err := gohasissues.Unquote(*buildCachePathFlag)
+	if err != nil {
+		printCompleteError(err)
+	}
+	if buildCachePath != "" {
+		_, err := os.Stat(buildCachePath)
+		if err != nil {
+			fmt.Fprintln(os.Stderr, err)
+			os.Exit(1)
+		}
+
+		err = utils.EnsureFolderExists(buildCachePath)
+		if err != nil {
+			printCompleteError(err)
+		}
+	}
+	ctx.BuildCachePath = buildCachePath
+
 	// FLAG_VID_PID
 	if *vidPidFlag != "" {
 		ctx.USBVidPid = *vidPidFlag

src/arduino.cc/builder/add_additional_entries_to_context.go

@@ -30,10 +30,11 @@
 package builder
 
 import (
+	"path/filepath"
+
 	"arduino.cc/builder/constants"
 	"arduino.cc/builder/i18n"
 	"arduino.cc/builder/types"
-	"path/filepath"
 )
 
 type AddAdditionalEntriesToContext struct{}
@@ -64,6 +65,15 @@ func (s *AddAdditionalEntriesToContext) Run(ctx *types.Context) error {
 		ctx.CoreBuildPath = coreBuildPath
 	}
 
+	if ctx.BuildCachePath != "" {
+		coreBuildCachePath, err := filepath.Abs(filepath.Join(ctx.BuildCachePath, constants.FOLDER_CORE))
+		if err != nil {
+			return i18n.WrapError(err)
+		}
+
+		ctx.CoreBuildCachePath = coreBuildCachePath
+	}
+
 	if ctx.WarningsLevel == "" {
 		ctx.WarningsLevel = DEFAULT_WARNINGS_LEVEL
 	}

src/arduino.cc/builder/builder_utils/utils.go

@@ -471,5 +471,5 @@ func GetCachedCoreArchiveFileName(fqbn, coreFolder string) string {
 		coreFolder = absCoreFolder
 	} // silently continue if absolute path can't be detected
 	hash := utils.MD5Sum([]byte(coreFolder))
-	return os.TempDir() + "/core_" + fqbnToUnderscore + "_" + hash + ".a"
+	return "core_" + fqbnToUnderscore + "_" + hash + ".a"
 }

src/arduino.cc/builder/phases/core_builder.go

@@ -30,6 +30,8 @@
 package phases
 
 import (
+	"path/filepath"
+
 	"arduino.cc/builder/builder_utils"
 	"arduino.cc/builder/constants"
 	"arduino.cc/builder/i18n"
@@ -42,6 +44,7 @@ type CoreBuilder struct{}
 
 func (s *CoreBuilder) Run(ctx *types.Context) error {
 	coreBuildPath := ctx.CoreBuildPath
+	coreBuildCachePath := ctx.CoreBuildCachePath
 	buildProperties := ctx.BuildProperties
 	verbose := ctx.Verbose
 	warningsLevel := ctx.WarningsLevel
@@ -52,7 +55,14 @@ func (s *CoreBuilder) Run(ctx *types.Context) error {
 		return i18n.WrapError(err)
 	}
 
-	archiveFile, objectFiles, err := compileCore(coreBuildPath, buildProperties, verbose, warningsLevel, logger)
+	if coreBuildCachePath != "" {
+		err := utils.EnsureFolderExists(coreBuildCachePath)
+		if err != nil {
+			return i18n.WrapError(err)
+		}
+	}
+
+	archiveFile, objectFiles, err := compileCore(coreBuildPath, coreBuildCachePath, buildProperties, verbose, warningsLevel, logger)
 	if err != nil {
 		return i18n.WrapError(err)
 	}
@@ -63,7 +73,7 @@ func (s *CoreBuilder) Run(ctx *types.Context) error {
 	return nil
 }
 
-func compileCore(buildPath string, buildProperties properties.Map, verbose bool, warningsLevel string, logger i18n.Logger) (string, []string, error) {
+func compileCore(buildPath string, buildCachePath string, buildProperties properties.Map, verbose bool, warningsLevel string, logger i18n.Logger) (string, []string, error) {
 	coreFolder := buildProperties[constants.BUILD_PROPERTIES_BUILD_CORE_PATH]
 	variantFolder := buildProperties[constants.BUILD_PROPERTIES_BUILD_VARIANT_PATH]
 
@@ -89,15 +99,19 @@ func compileCore(buildPath string, buildProperties properties.Map, verbose bool,
 	// Recreate the archive if ANY of the core files (including platform.txt) has changed
 	realCoreFolder := utils.GetParentFolder(coreFolder, 2)
 
-	targetArchivedCore := builder_utils.GetCachedCoreArchiveFileName(buildProperties[constants.BUILD_PROPERTIES_FQBN], realCoreFolder)
-	canUseArchivedCore := !builder_utils.CoreOrReferencedCoreHasChanged(realCoreFolder, targetCoreFolder, targetArchivedCore)
-
-	if canUseArchivedCore {
-		// use archived core
-		if verbose {
-			logger.Println(constants.LOG_LEVEL_INFO, "Using precompiled core")
+	var targetArchivedCore string
+	if buildCachePath != "" {
+		archivedCoreName := builder_utils.GetCachedCoreArchiveFileName(buildProperties[constants.BUILD_PROPERTIES_FQBN], realCoreFolder)
+		targetArchivedCore = filepath.Join(buildCachePath, archivedCoreName)
+		canUseArchivedCore := !builder_utils.CoreOrReferencedCoreHasChanged(realCoreFolder, targetCoreFolder, targetArchivedCore)
+
+		if canUseArchivedCore {
+			// use archived core
+			if verbose {
+				logger.Println(constants.LOG_LEVEL_INFO, "Using precompiled core")
+			}
+			return targetArchivedCore, variantObjectFiles, nil
 		}
-		return targetArchivedCore, variantObjectFiles, nil
 	}
 
 	coreObjectFiles, err := builder_utils.CompileFiles([]string{}, coreFolder, true, buildPath, buildProperties, includes, verbose, warningsLevel, logger)
@@ -111,7 +125,10 @@ func compileCore(buildPath string, buildProperties properties.Map, verbose bool,
 	}
 
 	// archive core.a
-	builder_utils.CopyFile(archiveFile, targetArchivedCore)
+	if targetArchivedCore != "" {
+		logger.Println(constants.LOG_LEVEL_DEBUG, "Archiving built core (caching) in: "+targetArchivedCore)
+		builder_utils.CopyFile(archiveFile, targetArchivedCore)
+	}
 
 	return archiveFile, variantObjectFiles, nil
 }

src/arduino.cc/builder/types/context.go

@@ -37,8 +37,10 @@ type Context struct {
 	BuildProperties      properties.Map
 	BuildCore            string
 	BuildPath            string
+	BuildCachePath       string
 	SketchBuildPath      string
 	CoreBuildPath        string
+	CoreBuildCachePath   string
 	CoreArchiveFilePath  string
 	CoreObjectsFiles     []string
 	LibrariesBuildPath   string