[projmgr] Initial target-set implementation

Partly address #2056
New:
- `target-set` and its subnodes parsing and selected contexts handling
- add `a`, `--active` options to set active `target-set`
- add `list target-sets` command

Changes:
- Rename `load` to `images`
- Move `debugger` and `images` from csolution top level into
`target-set`

Differences from implementation and current specification due to
inconsistencies:
- `images` is allowed only under `target-set`
- `load` mode and `load-offset` have a coherent structure between input
and output (csolution.yml and cbuild-run.yml)
- active `target-set` in cbuild-run.yml

Not implemented in this PR:
- `debug-adapters.yml` handling

Co-authored-by: Daniel Brondani <[email protected]>

Author: grasci-arm

tools/projmgr/include/ProjMgr.h

@@ -145,6 +145,7 @@ class ProjMgr {
   std::string m_clayerSearchPath;
   std::string m_export;
   std::string m_selectedToolchain;
+  std::string m_activeTargetSet;
   bool m_checkSchema;
   bool m_missingPacks;
   bool m_updateRteFiles;
@@ -172,6 +173,7 @@ class ProjMgr {
   bool RunListConfigs();
   bool RunListDependencies();
   bool RunListContexts();
+  bool RunListTargetSets();
   bool RunListGenerators();
   bool RunListLayers();
   bool RunListToolchains();

tools/projmgr/include/ProjMgrParser.h

@@ -126,6 +126,54 @@ struct MemoryItem {
   std::string algorithm;
 };
 
+/**
+ * @brief debugger item containing
+ *        name of debug configuration
+ *        debug protocol (jtag or swd)
+ *        debug clock speed
+ *        debug configuration file
+ *        start pname
+*/
+struct DebuggerItem {
+  std::string name;
+  std::string protocol;
+  std::string clock;
+  std::string dbgconf;
+  std::string startPname;
+};
+
+/**
+ * @brief target set image containing
+ *        project context
+ *        image file
+ *        info brief description
+ *        type specifies an explicit file type
+ *        load mode
+ *        load offset
+*/
+struct ImageItem {
+  std::string context;
+  std::string image;
+  std::string info;
+  std::string type;
+  std::string load;
+  std::string offset;
+};
+
+/**
+ * @brief target set containing
+ *        set name (default unnamed),
+ *        info string,
+ *        target set images,
+ *        debugger configuration
+*/
+struct TargetSetItem {
+  std::string set;
+  std::string info;
+  std::vector<ImageItem> images;
+  DebuggerItem debugger;
+};
+
 /**
  * @brief build types containing
  *        toolchain,
@@ -168,12 +216,14 @@ struct BuildType {
  *        platform board,
  *        platform device,
  *        additional memory,
+ *        target set,
  *        build options
 */
 struct TargetType {
   std::string board;
   std::string device;
   std::vector<MemoryItem> memory;
+  std::vector<TargetSetItem> targetSet;  
   BuildType build;
 };
 
@@ -420,42 +470,6 @@ struct CdefaultItem {
   std::vector<MiscItem> misc;
 };
 
-/**
- * @brief debugger item containing
- *        name of debug configuration
- *        brief description
- *        debug protocol (jtag or swd)
- *        debug clock speed
- *        debug configuration file
- *        type filter
-*/
-struct DebuggerItem {
-  std::string name;
-  std::string info;
-  std::string protocol;
-  std::string clock;
-  std::string dbgconf;
-  TypeFilter type;
-};
-
-/**
- * @brief load item containing
- *        file specifies the file name
- *        info brief description of the file
- *        type specifies an explicit file type
- *        run additional command string for download or programming
- *        debug additional command string for debug
- *        type filter
-*/
-struct LoadItem {
-  std::string file;
-  std::string info;
-  std::string type;
-  std::string run;
-  std::string debug;
-  TypeFilter typeFilter;
-};
-
 typedef std::vector<std::pair<std::string, BuildType>> BuildTypes;
 typedef std::vector<std::pair<std::string, TargetType>> TargetTypes;
 /**
@@ -476,8 +490,6 @@ typedef std::vector<std::pair<std::string, TargetType>> TargetTypes;
  *        cdefault enable switch,
  *        generator options,
  *        list of executes,
- *        list of debuggers,
- *        list of loads
 */
 struct CsolutionItem {
   std::string name;
@@ -497,8 +509,6 @@ struct CsolutionItem {
   GeneratorsItem generators;
   CbuildPackItem cbuildPack;
   std::vector<ExecutesItem> executes;
-  std::vector<DebuggerItem> debuggers;
-  std::vector<LoadItem> loads;
   std::vector<std::string> ymlOrderedBuildTypes;
   std::vector<std::string> ymlOrderedTargetTypes;
 };

tools/projmgr/include/ProjMgrRunDebug.h

@@ -55,8 +55,8 @@ struct FilesType {
   std::string file;
   std::string info;
   std::string type;
-  std::string run;
-  std::string debug;
+  std::string load;
+  std::string offset;  
   std::string pname;
 };
 
@@ -90,17 +90,6 @@ struct DebugVarsType {
   std::string vars;
 };
 
-/**
- * @brief debugger type
-*/
-struct DebuggerType {
-  std::string name;
-  std::string info;
-  std::string protocol;
-  std::optional<unsigned long long> clock;
-  std::string dbgconf;
-};
-
 /**
  * @brief punit type
 */
@@ -172,6 +161,7 @@ struct RunDebugType {
   std::string solution;
   std::string solutionName;
   std::string targetType;
+  std::string targetSet;
   std::string compiler;
   std::string board;
   std::string boardPack;
@@ -181,7 +171,7 @@ struct RunDebugType {
   std::vector<FilesType> outputs;
   std::vector<FilesType> systemDescriptions;
   SystemResourcesType systemResources;
-  std::vector<DebuggerType> debuggers;
+  DebuggerType debugger;
   DebugVarsType debugVars;
   std::vector<DebugSequencesType> debugSequences;
   DebugTopologyType debugTopology;

tools/projmgr/include/ProjMgrWorker.h

@@ -242,6 +242,24 @@ struct ContextTypesItem {
   BoolMap missingTargetTypes;
 };
 
+/**
+ * @brief debugger type
+ *        name of debug configuration
+ *        brief description
+ *        debug protocol (jtag or swd)
+ *        debug clock speed
+ *        debug configuration file
+ *        start pname
+*/
+struct DebuggerType {
+  std::string name;
+  std::string info;
+  std::string protocol;
+  std::optional<unsigned long long> clock;
+  std::string dbgconf;
+  std::string startPname;
+};
+
 /**
  * @brief project context item containing
  *        pointer to csolution,
@@ -297,9 +315,10 @@ struct ContextTypesItem {
  *        vector of device books
  *        vector of board books
  *        additional memory
- *        debuggers
+ *        debugger
  *        default dbgconf
- *        loads
+ *        images
+ *        selected target-set
 */
 struct ContextItem {
   CdefaultItem* cdefault = nullptr;
@@ -362,9 +381,10 @@ struct ContextItem {
   std::vector<BookItem> deviceBooks;
   std::vector<BookItem> boardBooks;
   std::vector<MemoryItem> memory;
-  std::vector<DebuggerItem> debuggers;
+  DebuggerType debugger;
   std::pair<std::string, RteFileInstance*> dbgconf;
-  std::vector<LoadItem> loads;
+  std::vector<ImageItem> images;
+  std::string targetSet;
 };
 
 /**
@@ -486,6 +506,14 @@ class ProjMgrWorker {
   */
   bool ListContexts(std::vector<std::string>& contexts, const std::string& filter = RteUtils::EMPTY_STRING, const bool ymlOrder = false);
 
+  /**
+   * @brief list target-sets
+   * @param reference to list of target-sets
+   * @param filter words to filter results
+   * @return true if executed successfully
+  */
+  bool ListTargetSets(std::vector<std::string>& targetSets, const std::string& filter = RteUtils::EMPTY_STRING);
+
   /**
    * @brief list generators of a given context
    * @param reference to list of generators
@@ -662,12 +690,14 @@ class ProjMgrWorker {
   /**
    * @brief parse context selection
    * @param contexts pattern (wildcards are allowed)
-   * @param context replacement pattern (wildcards are allowed)
+   * @param check cbuildset flag (default false)
+   * @param active target-set (default empty)
    * @return true if executed successfully
   */
   bool ParseContextSelection(
     const std::vector<std::string>& contextSelection,
-    const bool checkCbuildSet = false);
+    const bool checkCbuildSet = false,
+    const std::string activeTargetSet = std::string());
 
   /**
    * @brief get the list of selected contexts
@@ -832,6 +862,8 @@ class ProjMgrWorker {
   StrVec m_selectableCompilers;
   bool m_undefCompiler = false;
   std::map<std::string, FileNode> m_missingFiles;
+  std::string m_activeTargetType;
+  TargetSetItem m_activeTargetSet;
 
   bool LoadPacks(ContextItem& context);
   bool CheckMissingPackRequirements(const std::string& contextName);
@@ -859,7 +891,7 @@ class ProjMgrWorker {
   bool ProcessConfigFiles(ContextItem& context);
   bool ProcessComponentFiles(ContextItem& context);
   bool ProcessDebuggers(ContextItem& context);
-  bool ProcessLoads(ContextItem& context);
+  bool ProcessImages(ContextItem& context);
   bool ProcessExecutes(ContextItem& context, bool solutionLevel = false);
   bool ProcessGroups(ContextItem& context);
   bool ProcessSequencesRelatives(ContextItem& context, bool rerun);
@@ -941,6 +973,8 @@ class ProjMgrWorker {
   StrVec CollectSelectableCompilers();
   void ProcessTmpDir(std::string& tmpdir, const std::string& base);
   bool IsCreatedByExecute(const std::string file, const std::string dir);
+  bool ParseTargetSetContextSelection(const std::string& activeTargetSet);
+  bool GetActiveTargetSet(const std::string& activeTargetSet);
 };
 
 #endif  // PROJMGRWORKER_H

tools/projmgr/include/ProjMgrYamlParser.h

@@ -122,6 +122,8 @@ static constexpr const char* YAML_HOST = "host";
 static constexpr const char* YAML_HPROT = "HPROT";
 static constexpr const char* YAML_ID = "id";
 static constexpr const char* YAML_IF = "if";
+static constexpr const char* YAML_IMAGES = "images";
+static constexpr const char* YAML_IMAGE = "image";
 static constexpr const char* YAML_IMPLEMENTED_BY = "implemented-by";
 static constexpr const char* YAML_IMPLEMENTS = "implements";
 static constexpr const char* YAML_INDEX = "index";
@@ -135,6 +137,7 @@ static constexpr const char* YAML_LANGUAGE_CPP = "language-CPP";
 static constexpr const char* YAML_LAYER = "layer";
 static constexpr const char* YAML_LAYERS = "layers";
 static constexpr const char* YAML_LOAD = "load";
+static constexpr const char* YAML_LOAD_OFFSET = "load-offset";
 static constexpr const char* YAML_LICENSE = "license";
 static constexpr const char* YAML_LICENSES = "licenses";
 static constexpr const char* YAML_LICENSE_AGREEMENT = "license-agreement";
@@ -179,6 +182,7 @@ static constexpr const char* YAML_PROCESSOR = "processor";
 static constexpr const char* YAML_PROGRAMMING = "programming";
 static constexpr const char* YAML_PROJECT = "project";
 static constexpr const char* YAML_PROJECTS = "projects";
+static constexpr const char* YAML_PROJECT_CONTEXT = "project-context";
 static constexpr const char* YAML_PROJECT_TYPE = "project-type";
 static constexpr const char* YAML_PROTOCOL = "protocol";
 static constexpr const char* YAML_PROVIDES = "provides";
@@ -204,6 +208,7 @@ static constexpr const char* YAML_SETTINGS = "settings";
 static constexpr const char* YAML_SELECT_COMPILER = "select-compiler";
 static constexpr const char* YAML_SIZE = "size";
 static constexpr const char* YAML_START = "start";
+static constexpr const char* YAML_START_PNAME = "start-pname";
 static constexpr const char* YAML_STATUS = "status";
 static constexpr const char* YAML_SOLUTION = "solution";
 static constexpr const char* YAML_SPROT = "SPROT";
@@ -215,6 +220,7 @@ static constexpr const char* YAML_SYSTEM_RESOURCES = "system-resources";
 static constexpr const char* YAML_TAPINDEX = "tapindex";
 static constexpr const char* YAML_TARGET_CONFIGURATIONS = "target-configurations";
 static constexpr const char* YAML_TARGETSEL = "targetsel";
+static constexpr const char* YAML_TARGET_SET = "target-set";
 static constexpr const char* YAML_TARGETTYPE = "target-type";
 static constexpr const char* YAML_TARGETTYPES = "target-types";
 static constexpr const char* YAML_TIMEOUT = "timeout";
@@ -312,8 +318,9 @@ class ProjMgrYamlParser {
   void ParseOutputDirs(const YAML::Node& parent, const std::string& file, struct DirectoriesItem& directories);
   void ParseGenerators(const YAML::Node& parent, const std::string& file, GeneratorsItem& generators);
   void ParseExecutes(const YAML::Node& parent, const std::string& file, std::vector<ExecutesItem>& executes);
-  bool ParseDebugger(const YAML::Node& parent, const std::string& file, std::vector<DebuggerItem>& debbugers);
-  bool ParseLoad(const YAML::Node& parent, const std::string& file, std::vector<LoadItem>& loads);
+  void ParseDebugger(const YAML::Node& parent, const std::string& file, DebuggerItem& debugger);
+  void ParseTargetSet(const YAML::Node& parent, const std::string& file, std::vector<TargetSetItem>& targetSet);
+  void ParseImages(const YAML::Node& parent, const std::string& file, std::vector<ImageItem>& loads);
   void ParseConnections(const YAML::Node& parent, std::vector<ConnectItem>& connects);
   bool ParseTargetType(const YAML::Node& parent, const std::string& file, TargetType& targetType);
   bool ParseBuildTypes(const YAML::Node& parent, const std::string& file, BuildTypes& buildTypes);