add debug symbols option in CLI and gRPC insterface

Author: rsora

cli/compile/compile.go

@@ -48,6 +48,7 @@ var (
 	verify             bool     // Upload, verify uploaded binary after the upload.
 	exportFile         string   // The compiled binary is written to this file
 	libraries          []string // List of custom libraries paths separated by commas. Or can be used multiple times for multiple libraries paths.
+	optimizeForDebug   bool     // Optimize compile output for debug, not for release
 )
 
 // NewCommand created a new `compile` command
@@ -80,6 +81,7 @@ func NewCommand() *cobra.Command {
 	command.Flags().StringVar(&vidPid, "vid-pid", "", "When specified, VID/PID specific build properties are used, if boards supports them.")
 	command.Flags().StringSliceVar(&libraries, "libraries", []string{},
 		"List of custom libraries paths separated by commas. Or can be used multiple times for multiple libraries paths.")
+	command.Flags().BoolVar(&optimizeForDebug, "optimize-for-debug", false, "Optional, optimize compile output for debug, not for release.")
 
 	return command
 }
@@ -99,20 +101,21 @@ func run(cmd *cobra.Command, args []string) {
 	sketchPath := initSketchPath(path)
 
 	_, err = compile.Compile(context.Background(), &rpc.CompileReq{
-		Instance:        inst,
-		Fqbn:            fqbn,
-		SketchPath:      sketchPath.String(),
-		ShowProperties:  showProperties,
-		Preprocess:      preprocess,
-		BuildCachePath:  buildCachePath,
-		BuildPath:       buildPath,
-		BuildProperties: buildProperties,
-		Warnings:        warnings,
-		Verbose:         verbose,
-		Quiet:           quiet,
-		VidPid:          vidPid,
-		ExportFile:      exportFile,
-		Libraries:       libraries,
+		Instance:         inst,
+		Fqbn:             fqbn,
+		SketchPath:       sketchPath.String(),
+		ShowProperties:   showProperties,
+		Preprocess:       preprocess,
+		BuildCachePath:   buildCachePath,
+		BuildPath:        buildPath,
+		BuildProperties:  buildProperties,
+		Warnings:         warnings,
+		Verbose:          verbose,
+		Quiet:            quiet,
+		VidPid:           vidPid,
+		ExportFile:       exportFile,
+		Libraries:        libraries,
+		OptimizeForDebug: optimizeForDebug,
 	}, os.Stdout, os.Stderr, viper.GetString("logging.level") == "debug")
 
 	if err != nil {

commands/compile/compile.go

@@ -103,6 +103,9 @@ func Compile(ctx context.Context, req *rpc.CompileReq, outStream, errStream io.W
 
 	builderCtx.Verbose = req.GetVerbose()
 
+	// Optimize for debug
+	builderCtx.OptimizeForDebug = req.GetOptimizeForDebug()
+
 	builderCtx.CoreBuildCachePath = paths.TempDir().Join("arduino-core-cache")
 
 	builderCtx.Jobs = int(req.GetJobs())

legacy/builder/create_build_options_map.go

@@ -17,7 +17,6 @@ package builder
 
 import (
 	"encoding/json"
-
 	"github.com/arduino/arduino-cli/legacy/builder/i18n"
 	"github.com/arduino/arduino-cli/legacy/builder/types"
 )
@@ -30,7 +29,6 @@ func (s *CreateBuildOptionsMap) Run(ctx *types.Context) error {
 	if err != nil {
 		return i18n.WrapError(err)
 	}
-
 	ctx.BuildOptionsJson = string(bytes)
 
 	return nil

legacy/builder/setup_build_properties.go

@@ -69,6 +69,17 @@ func (s *SetupBuildProperties) Run(ctx *types.Context) error {
 	buildProperties.Set("ide_version", ctx.ArduinoAPIVersion)
 	buildProperties.Set("runtime.os", utils.PrettyOSName())
 
+	if ctx.OptimizeForDebug {
+		if buildProperties.ContainsKey("compiler.optimization_flags.debug") {
+			buildProperties.Set("compiler.optimization_flags", buildProperties.Get("compiler.optimization_flags.debug"))
+		}
+	} else {
+		if buildProperties.ContainsKey("compiler.optimization_flags.release") {
+			buildProperties.Set("compiler.optimization_flags", buildProperties.Get("compiler.optimization_flags.release"))
+		}
+	}
+	ctx.OptimizationFlags = buildProperties.Get("compiler.optimization_flags")
+
 	variant := buildProperties.Get("build.variant")
 	if variant == "" {
 		buildProperties.Set("build.variant.path", "")

legacy/builder/types/context.go

@@ -94,6 +94,10 @@ type Context struct {
 	Verbose           bool
 	DebugPreprocessor bool
 
+	// Compile optimization settings
+	OptimizeForDebug  bool
+	OptimizationFlags string
+
 	// Dry run, only create progress map
 	Progress ProgressStruct
 
@@ -140,6 +144,7 @@ func (ctx *Context) ExtractBuildOptions() *properties.Map {
 	opts.Set("runtime.ide.version", ctx.ArduinoAPIVersion)
 	opts.Set("customBuildProperties", strings.Join(ctx.CustomBuildProperties, ","))
 	opts.Set("additionalFiles", strings.Join(additionalFilesRelative, ","))
+	opts.Set("compiler.optimization_flags", ctx.OptimizationFlags)
 	return opts
 }
 
@@ -156,6 +161,7 @@ func (ctx *Context) InjectBuildOptions(opts *properties.Map) {
 	ctx.FQBN = fqbn
 	ctx.ArduinoAPIVersion = opts.Get("runtime.ide.version")
 	ctx.CustomBuildProperties = strings.Split(opts.Get("customBuildProperties"), ",")
+	ctx.OptimizationFlags = opts.Get("compiler.optimization_flags")
 }
 
 func (ctx *Context) GetLogger() i18n.Logger {

rpc/commands/compile.pb.go

@@ -37,6 +37,7 @@ message CompileReq {
   string exportFile = 13;   // The compiled binary is written to this file
   int32 jobs = 14;   // The max number of concurrent compiler instances to run (as make -jx)
   repeated string libraries = 15; // List of custom libraries paths separated by commas. Or can be used multiple times for multiple libraries paths.
+  bool optimizeForDebug = 16; // Optimize compile output for debug, not for release
 }
 
 message CompileResp {