[cbuild-run] Debugger integration refinements

Author: brondani

tools/projmgr/include/ProjMgrRunDebug.h

@@ -210,7 +210,8 @@ class ProjMgrRunDebug {
   void GetDebugSequenceBlock(const RteItem* item, DebugSequencesBlockType& block);
   void PushBackUniquely(std::vector<std::pair<const RteItem*, std::vector<std::string>>>& vec,
     const RteItem* item, const std::string pname);
-  FilesType SetLoadFromOutput(const ContextItem* context, OutputType output, const std::string type);
+  void AddGeneratedImage(const ContextItem* context, const std::string& filename, const std::string& type, const std::string& load);
+  void AddGeneratedImages(const ContextItem* context);
   const std::string GetAccessAttributes(const RteItem* mem);
   void SetAccessPorts(std::vector<AccessPortType>& parent, const std::map<unsigned int,
     std::vector<AccessPortType>>& childrenMap);

tools/projmgr/include/ProjMgrWorker.h

@@ -243,23 +243,13 @@ struct ContextTypesItem {
 };
 
 /**
- * @brief gdb core item containing
+ * @brief gdb server item containing
  *        port number of processor
  *        processor name
- *        primary processor
 */
-struct GdbCoreItem {
+struct GdbServerItem {
   unsigned long long port;
   std::string pname;
-  bool start = false;
-};
-
-/**
- * @brief gdb server item containing
- *        list of the gdb core items
-*/
-struct GdbServerItem {
-  std::vector<GdbCoreItem> core;
 };
 
 /**
@@ -270,7 +260,7 @@ struct GdbServerItem {
  *        debug clock speed
  *        debug configuration file
  *        start pname
- *        gdbserver
+ *        list of gdbserver items
 */
 struct DebuggerType {
   std::string name;
@@ -279,7 +269,7 @@ struct DebuggerType {
   std::optional<unsigned long long> clock;
   std::string dbgconf;
   std::string startPname;
-  GdbServerItem gdbserver;
+  std::vector<GdbServerItem> gdbserver;
 };
 
 /**
@@ -341,6 +331,7 @@ struct DebuggerType {
  *        default dbgconf
  *        images
  *        selected target-set
+ *        load offset for generated binary
 */
 struct ContextItem {
   CdefaultItem* cdefault = nullptr;
@@ -407,6 +398,7 @@ struct ContextItem {
   std::pair<std::string, RteFileInstance*> dbgconf;
   std::vector<ImageItem> images;
   std::string targetSet;
+  std::string loadOffset;
 };
 
 /**

tools/projmgr/schemas/common.schema.json

@@ -2048,11 +2048,11 @@
         "type":        { "type": "string", "description": "Specifies the file type." },
         "info":        { "type": "string", "description": "Brief description of the file." },
         "load":        { "$ref": "#/definitions/TargetSetLoadType" },
-        "load-offset": { "type": "number", "description": "Offset applied to the binary content when loading the file." },
+        "load-offset": { "type": "number", "description": "Offset applied in *.csolution.yml when loading the image file." },
         "pname":       { "type": "string", "description": "Image belongs to processor in a multi-core system." }
       },
       "additionalProperties": false,
-      "required": ["file", "type"]
+      "required": ["file", "type", "load"]
     },
     "RunSystemFilesType": {
       "title": "output:\nDocumentation: https://open-cmsis-pack.github.io/cmsis-toolbox/YML-CBuild-Format/#system-descriptions",
@@ -2149,35 +2149,25 @@
         "clock":           { "type": "number", "description": "Selected debug clock speed (in Hz)." },
         "dbgconf":         { "type": "string", "description": "Debugger configuration file (pinout, trace)." },
         "start-pname":     { "type": "string", "description": "Debugger connects at start to this processor." },
-        "gdbserver":       { "$ref": "#/definitions/GdbServerType" }
+        "gdbserver":       { "$ref": "#/definitions/GdbServersType" },
+        "terminal":        { "type": "string", "description": "Terminal port of the debugger." },
+        "trace":           { "type": "string", "description": "Trace port of the debugger." }
       },
       "additionalProperties": true,
       "required": ["name"]
     },
-    "GdbServerType": {
+    "GdbServersType": {
       "title": "gdbserver:\nDocumentation: https://open-cmsis-pack.github.io/cmsis-toolbox/YML-CBuild-Format/#gdbserver",
       "description": "Information for GDB server option of debugger.",
-      "type": "object",
-      "properties": {
-        "core":     { "$ref": "#/definitions/GdbCoresType" },
-        "terminal": { "type": "string", "description": "Terminal port of the GDB server." },
-        "trace":    { "type": "string", "description": "Trace port of the GDB server." }
-      },
-      "additionalProperties": false,
-      "required": ["core"]
-    },
-    "GdbCoresType": {
-      "description": "List of the processor cores along with GDB port number.",
       "type": "array",
       "uniqueItems": true,
-      "items": { "$ref": "#/definitions/GdbCoreType" }
+      "items": { "$ref": "#/definitions/GdbServerType" }
     },
-    "GdbCoreType": {
+    "GdbServerType": {
       "type": "object",
       "properties": {
         "port":  { "type": "number", "description": "Port number of processor." },
         "pname": { "type": "string", "description": "Processor name of the processor (only required for multi-core systems)." },
-        "start": { "type": "null", "description": "Identifies the start or primary processor. Only one processor can have the start: node." },
         "punit": { "type": "number", "description": "Identifies the procssor core in a SMP system." }
       },
       "additionalProperties": false,
@@ -2347,16 +2337,16 @@
     "TargetSetImageType": {
       "type": "object",
       "properties": {
-        "project-context": { "type": "string", "description": "Project context in the format 'project-name.build-type'." },
-        "image":           { "type": "string", "description": "Base filename of the image (without path)." },
-        "info":            { "type": "string", "description": "Brief description of the file." },
-        "type":            { "enum": [ "elf", "hex", "bin", "lib" ], "description": "Specifies an explicit file type." },
+        "project-context": { "type": "string", "description": "Project output with optional build-type: '<project_name>[.buid_type]'." },
+        "image":           { "type": "string", "description": "Additional image file to load." },
+        "info":            { "type": "string", "description": "Brief description of the image file." },
+        "type":            { "enum": [ "elf", "hex", "bin", "lib" ], "description": "Specifies an explicit image type." },
         "load":            { "$ref": "#/definitions/TargetSetLoadType" },
-        "load-offset":     { "type": "number", "description": "Offset applied to the binary content when loading the file." }
+        "load-offset":     { "type": "number", "description": "Offset applied to the binary content when loading the image file." }
       },
       "additionalProperties": false,
       "oneOf": [
-        { "required": ["project-context"], "not": {"required": ["image"]} },
+        { "required": ["project-context"], "not": {"required": ["image", "load", "type"]} },
         { "required": ["image"], "not": {"required": ["project-context"]} }
       ]
     },

tools/projmgr/src/ProjMgrCbuildRun.cpp

@@ -31,7 +31,7 @@ class ProjMgrCbuildRun : public ProjMgrCbuildBase {
   void SetDebugPortsNode(YAML::Node node, const std::vector<DebugPortType>& debugPorts);
   void SetAccessPortsNode(YAML::Node node, const std::vector<AccessPortType>& accessPorts);
   void SetDatapatchNode(YAML::Node node, const std::vector<DatapatchType>& datapatch);
-  void SetGdbServerNode(YAML::Node node, const GdbServerItem& gdbserver);
+  void SetGdbServerNode(YAML::Node node, const std::vector<GdbServerItem>& gdbserver);
 };
 
 ProjMgrCbuildRun::ProjMgrCbuildRun(YAML::Node node,
@@ -111,15 +111,12 @@ void ProjMgrCbuildRun::SetDebuggerNode(YAML::Node node, const DebuggerType& debu
   }
 }
 
-void ProjMgrCbuildRun::SetGdbServerNode(YAML::Node node, const GdbServerItem& gdbserver) {
-  for (const auto& item : gdbserver.core) {
-    YAML::Node coreNode;
-    coreNode[YAML_PORT] = item.port;
-    SetNodeValue(coreNode[YAML_PNAME], item.pname);
-    if (item.start) {
-      coreNode[YAML_START] = YAML::Null;
-    }
-    node[YAML_CORE].push_back(coreNode);
+void ProjMgrCbuildRun::SetGdbServerNode(YAML::Node node, const std::vector<GdbServerItem>& gdbserver) {
+  for (const auto& item : gdbserver) {
+    YAML::Node gdbserverNode;
+    gdbserverNode[YAML_PORT] = item.port;
+    SetNodeValue(gdbserverNode[YAML_PNAME], item.pname);
+    node.push_back(gdbserverNode);
   }
 }
 

tools/projmgr/src/ProjMgrRunDebug.cpp

@@ -18,6 +18,10 @@ using namespace std;
   * @brief default debugger parameters
  */
 static constexpr const char* DEBUGGER_NAME_DEFAULT = "CMSIS-DAP";
+static constexpr const char* LOAD_IMAGE_SYMBOLS = "image+symbols";
+static constexpr const char* LOAD_IMAGE = "image";
+static constexpr const char* LOAD_SYMBOLS = "symbols";
+static constexpr const char* LOAD_NONE = "none";
 
 ProjMgrRunDebug::ProjMgrRunDebug(void) {
   // Reserved
@@ -219,36 +223,23 @@ bool ProjMgrRunDebug::CollectSettings(const vector<ContextItem*>& contexts, cons
 
   // outputs
   for (const auto& context : contexts) {
-    // populate load entries from context outputs
-    const map<const string, const OutputType> types = {
-      { RteConstants::OUTPUT_TYPE_ELF, context->outputTypes.elf },
-      { RteConstants::OUTPUT_TYPE_HEX, context->outputTypes.hex },
-      { RteConstants::OUTPUT_TYPE_BIN, context->outputTypes.bin },
-    };
-    for (const auto& [type, output] : types) {
-      const auto& load = SetLoadFromOutput(context, output, type);
-      if (!load.file.empty()) {
-        m_runDebug.outputs.push_back(load);
-      }
-    }
+    // populate image entries from context outputs
+    AddGeneratedImages(context);
   }
 
-  // merge/insert target-set image nodes
-  for (const auto& item : context0->images) {
-    bool merged = false;
-    for (auto& output : m_runDebug.outputs) {
-      if (output.file == item.image) {
-        output.info = output.info.empty() ? item.info : output.info;
-        output.type = output.type.empty() ? item.type : output.type;
-        output.load = output.load.empty() ? item.load : output.load;
-        output.offset = output.offset.empty() ? item.offset : output.offset;
-        merged = true;
-        break;
-      }
+  // insert target-set image nodes
+  for (auto item : context0->images) {
+    if (item.type.empty()) {
+      item.type = ProjMgrUtils::FileTypeFromExtension(item.image);
     }
-    if (!merged) {
-      m_runDebug.outputs.push_back({ item.image, item.info, item.type, item.load, item.offset });
+    if (item.load.empty()) {
+      // files with 'type: elf' get 'load: image+symbols'
+      // files with 'type: lib' get 'load: none'
+      // all other file types get 'load: image'
+      item.load = item.type == RteConstants::OUTPUT_TYPE_ELF ? LOAD_IMAGE_SYMBOLS :
+        item.type == RteConstants::OUTPUT_TYPE_LIB ? LOAD_NONE : LOAD_IMAGE;
     }
+    m_runDebug.outputs.push_back({ item.image, item.info, item.type, item.load, item.offset });
   }
 
   // debug vars
@@ -330,11 +321,10 @@ void ProjMgrRunDebug::CollectDebuggerSettings(const ContextItem& context, const
       if (adapter.gdbserver) {
         unsigned long long port = adapter.defaults.port.empty() ? 0 : RteUtils::StringToULL(adapter.defaults.port);
         for (const auto& [pname, _] : pnames) {
-          GdbCoreItem item;
+          GdbServerItem item;
           item.port = port++;
           item.pname = pname;
-          item.start = !pname.empty() && (pname == m_runDebug.debugger.startPname);
-          m_runDebug.debugger.gdbserver.core.push_back(item);
+          m_runDebug.debugger.gdbserver.push_back(item);
         }
       }
       if (m_runDebug.debugger.protocol.empty()) {
@@ -345,6 +335,11 @@ void ProjMgrRunDebug::CollectDebuggerSettings(const ContextItem& context, const
       }
     }
   }
+
+  // primary processor
+  if (m_runDebug.debugger.startPname.empty()) {
+    m_runDebug.debugger.startPname = context.deviceItem.pname;
+  }
 }
 
 void ProjMgrRunDebug::CollectDebugTopology(const ContextItem& context, const vector<pair<const RteItem*, vector<string>>> debugs,
@@ -519,16 +514,42 @@ void ProjMgrRunDebug::SetProtNodes(const RteDeviceProperty* item, AccessPortType
   }
 }
 
-FilesType ProjMgrRunDebug::SetLoadFromOutput(const ContextItem* context, OutputType output, const string type) {
-  FilesType load;
-  if (output.on) {
-    RteFsUtils::NormalizePath(output.filename, context->directories.cprj + '/' + context->directories.outdir);
-    load.file = output.filename;
-    load.info = "generate by " + context->name;
-    load.type = type;
-    load.pname = context->deviceItem.pname;
+void ProjMgrRunDebug::AddGeneratedImage(const ContextItem* context, const string& filename, const string& type, const string& load) {
+  string file = filename;
+  RteFsUtils::NormalizePath(file, context->directories.cprj + '/' + context->directories.outdir);
+  if (!file.empty()) {
+    FilesType image;
+    image.file = file;
+    image.info = "generate by " + context->name;
+    image.type = type;
+    image.load = load;
+    image.pname = context->deviceItem.pname;
+    image.offset = type == RteConstants::OUTPUT_TYPE_BIN ? context->loadOffset : RteUtils::EMPTY_STRING;
+    m_runDebug.outputs.push_back(image);
+  }
+}
+
+void ProjMgrRunDebug::AddGeneratedImages(const ContextItem* context) {
+  /*
+  For 'compiler: AC6':
+    - When only a file with 'type: elf' is generated, the file gets 'load: image+symbols'
+    - When a file with 'type: elf' and a file with 'type: hex' is generated, the 'type: elf' file gets 'load: symbols' and the 'type: hex' file gets 'load: image'
+    - All other file types get 'load: none'
+  For any other compiler:
+    - Files with 'type: elf' get 'load: image+symbols'
+    - All other file types get 'load: none'
+  */
+  if (context->outputTypes.elf.on) {
+    AddGeneratedImage(context, context->outputTypes.elf.filename, RteConstants::OUTPUT_TYPE_ELF,
+      context->compiler == "AC6" && context->outputTypes.hex.on ? LOAD_SYMBOLS : LOAD_IMAGE_SYMBOLS);
+  }
+  if (context->outputTypes.hex.on) {
+    AddGeneratedImage(context, context->outputTypes.hex.filename, RteConstants::OUTPUT_TYPE_HEX,
+      context->compiler == "AC6" ? LOAD_IMAGE : LOAD_NONE);
+  }
+  if (context->outputTypes.bin.on) {
+    AddGeneratedImage(context, context->outputTypes.bin.filename, RteConstants::OUTPUT_TYPE_BIN, LOAD_NONE);
   }
-  return load;
 }
 
 void ProjMgrRunDebug::GetDebugSequenceBlock(const RteItem* item, DebugSequencesBlockType& block) {

tools/projmgr/src/ProjMgrWorker.cpp

@@ -2515,9 +2515,6 @@ bool ProjMgrWorker::ProcessImages(ContextItem& context) {
   const vector<ImageItem>& images = m_activeTargetSet.images;
   for (auto item : images) {
     if (!item.image.empty()) {
-      if (item.type.empty()) {
-        item.type = ProjMgrUtils::FileTypeFromExtension(item.image);
-      }
       if (!ProcessSequenceRelative(context, item.image, context.csolution->directory)) {
         return false;
       }
@@ -2526,6 +2523,9 @@ bool ProjMgrWorker::ProcessImages(ContextItem& context) {
       }
       context.images.push_back(item);
     }
+    else if (item.context == context.cproject->name + (context.type.build.empty() ? "" : '.' + context.type.build)) {
+      context.loadOffset = item.offset;
+    }
   }
   return true;
 }

tools/projmgr/test/data/TestRunDebug/ref/run-debug+TestHW.cbuild-run.yml

@@ -13,9 +13,19 @@ cbuild-run:
       info: generate by run-debug+TestHW
       type: elf
       load: symbols
+    - file: out/run-debug/TestHW/run-debug.hex
+      info: generate by run-debug+TestHW
+      type: hex
+      load: image
+    - file: out/run-debug/TestHW/run-debug.bin
+      info: generate by run-debug+TestHW
+      type: bin
+      load: none
+      load-offset: 0x0000A000
     - file: ../data/TestRunDebug/customImage.bin
       info: load image info
       type: bin
+      load: image
       load-offset: 0x00001000
   system-resources:
     memory:
@@ -43,8 +53,7 @@ cbuild-run:
     clock: 20000000
     dbgconf: ../data/TestRunDebug/RTE/Device/RteTest1/RteTest1.dbgconf
     gdbserver:
-      core:
-        - port: 3333
+      - port: 3333
   debug-vars:
     vars: |
       __var DbgMCU_CR      = 0x00000007;   // DBGMCU_CR: DBG_SLEEP, DBG_STOP, DBG_STANDBY

tools/projmgr/test/data/TestRunDebug/ref/run-debug+TestHW.cbuild.yml

@@ -36,8 +36,12 @@ build:
     outdir: out/run-debug/TestHW
     rtedir: ../data/TestRunDebug/RTE
   output:
+    - type: bin
+      file: run-debug.bin
     - type: elf
       file: run-debug.axf
+    - type: hex
+      file: run-debug.hex
   components:
     - component: ARM::Device:Startup&RteTest [email protected]
       condition: ARMCM4 RteTest