[experimental] Initial implementation of cbuild-run.yml handling

Author: spcaipers-arm

external/json-schema-validator.patch

@@ -60,6 +60,15 @@ index 0beb613..0a9122b 100644
  	return esub;
  }
 
+@@ -468,7 +472,7 @@ class type_schema : public schema
+ 
+ 		if (type)
+ 			type->validate(ptr, instance, patch, e);
+-		else
++		else if (!instance.is_string() || instance.get_ref<const json::string_t&>().find("0x") != 0)
+ 			e.error(ptr, instance, "unexpected instance type");
+ 
+ 		if (enum_.first) {
 @@ -576,6 +580,32 @@ public:
  		attr = sch.find("enum");
  		if (attr != sch.end()) {

test/packs/ARM/RteTest_DFP/0.2.0/ARM.RteTest_DFP.pdsc

@@ -486,6 +486,7 @@
       <description>uVision Simulator</description>
       <mountedDevice    deviceIndex="0" Dvendor="ARM:82" Dname="RteTest_ARMCM4_NOFP"/>
       <compatibleDevice deviceIndex="0" Dvendor="ARM:82" Dname="RteTest_ARMCM4_FP"/>
+      <algorithm name="Device/ARM/Flash/BOARD.FLM" start="0x80000000" size="0x00020000" default="1"/>
     </board>
     <board name="RteTest board test revision" vendor="Keil" revision="Rev1">
       <description>uVision Simulator</description>

test/packs/ARM/RteTest_DFP/0.2.0/Device/ARM/Flash/BOARD.FLM

@@ -0,0 +1 @@
+BOARD.FLM : not real flash algorithm

test/packs/ARM/RteTest_DFP/0.2.0/Device/ARM/Flash/FAMILY.FLM

@@ -1 +1 @@
-FAMILY.FLM : not real flash algorithm
+FAMILY.FLM : not real flash algorithm

tools/projmgr/CMakeLists.txt

@@ -14,11 +14,15 @@ SET(PROJMGR_SOURCE_FILES ProjMgr.cpp ProjMgrKernel.cpp ProjMgrCallback.cpp
   ProjMgrParser.cpp ProjMgrWorker.cpp ProjMgrGenerator.cpp ProjMgrXmlParser.cpp
   ProjMgrYamlParser.cpp ProjMgrLogger.cpp ProjMgrYamlSchemaChecker.cpp
   ProjMgrYamlEmitter.cpp ProjMgrUtils.cpp ProjMgrExtGenerator.cpp
+  ProjMgrCbuildBase.cpp ProjMgrCbuild.cpp ProjMgrCbuildIdx.cpp
+  ProjMgrCbuildGenIdx.cpp ProjMgrCbuildPack.cpp ProjMgrCbuildSet.cpp
+  ProjMgrCbuildRun.cpp ProjMgrRunDebug.cpp
 )
 SET(PROJMGR_HEADER_FILES ProjMgr.h ProjMgrKernel.h ProjMgrCallback.h
   ProjMgrParser.h ProjMgrWorker.h ProjMgrGenerator.h ProjMgrXmlParser.h
   ProjMgrYamlParser.h ProjMgrLogger.h ProjMgrYamlSchemaChecker.h
   ProjMgrYamlEmitter.h ProjMgrUtils.h ProjMgrExtGenerator.h
+  ProjMgrCbuildBase.h ProjMgrRunDebug.h
 )
 
 list(TRANSFORM PROJMGR_SOURCE_FILES PREPEND src/)

tools/projmgr/include/ProjMgr.h

@@ -11,6 +11,7 @@
 #include "ProjMgrWorker.h"
 #include "ProjMgrGenerator.h"
 #include "ProjMgrYamlEmitter.h"
+#include "ProjMgrRunDebug.h"
 
 #include <cxxopts.hpp>
 
@@ -105,6 +106,12 @@ class ProjMgr {
   */
   ProjMgrYamlEmitter& GetEmitter() { return m_emitter; };
 
+  /**
+   * @brief get run debug manager object
+   * @return reference to m_runDebug
+  */
+  ProjMgrRunDebug& GetRunDebug() { return m_runDebug; };
+
   /**
    * @brief get cdefault file in solution/project or in installation directory
    * @return true if file is found successfully, false otherwise
@@ -122,6 +129,7 @@ class ProjMgr {
   ProjMgrWorker m_worker;
   ProjMgrGenerator m_generator;
   ProjMgrYamlEmitter m_emitter;
+  ProjMgrRunDebug m_runDebug;
 
   std::string m_csolutionFile;
   std::string m_cdefaultFile;

tools/projmgr/include/ProjMgrCbuildBase.h

@@ -0,0 +1,33 @@
+/*
+ * Copyright (c) 2020-2024 Arm Limited. All rights reserved.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef PROJMGRCBUILDBASE_H
+#define PROJMGRCBUILDBASE_H
+
+#include <vector>
+#include <string>
+
+/**
+ * Forward declarations
+*/
+namespace YAML {
+  class Node;
+}
+
+/**
+  * @brief projmgr base class for output yaml files
+*/
+class ProjMgrCbuildBase {
+protected:
+  ProjMgrCbuildBase(bool useAbsolutePaths = false) : m_useAbsolutePaths(useAbsolutePaths) {};
+  void SetNodeValue(YAML::Node node, const std::string& value);
+  void SetNodeValue(YAML::Node node, const std::vector<std::string>& vec);
+  const std::string FormatPath(const std::string& original, const std::string& directory);
+
+  bool m_useAbsolutePaths;
+};
+
+#endif  // PROJMGRCBUILDBASE_H

tools/projmgr/include/ProjMgrParser.h

@@ -110,6 +110,22 @@ struct ProcessorItem {
   std::string branchProtection;
 };
 
+/**
+ * @brief memory item containing
+ *        name
+ *        access
+ *        start
+ *        size
+ *        algorithm
+*/
+struct MemoryItem {
+  std::string name;
+  std::string access;
+  std::string start;
+  std::string size;
+  std::string algorithm;
+};
+
 /**
  * @brief build types containing
  *        toolchain,
@@ -151,10 +167,13 @@ struct BuildType {
  * @brief target types containing
  *        platform board,
  *        platform device,
+ *        additional memory,
+ *        build options
 */
 struct TargetType {
   std::string board;
   std::string device;
+  std::vector<MemoryItem> memory;
   BuildType build;
 };
 

tools/projmgr/include/ProjMgrRunDebug.h

@@ -0,0 +1,80 @@
+/*
+ * Copyright (c) 2024 Arm Limited. All rights reserved.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef PROJMGRRUNDEBUG_H
+#define PROJMGRRUNDEBUG_H
+
+#include "ProjMgrWorker.h"
+
+ /**
+  * @brief programming algorithm types
+ */
+struct AlgorithmType {
+  std::string algorithm;
+  unsigned long long start = 0;
+  unsigned long long size = 0;
+  unsigned long long ramStart = 0;
+  unsigned long long ramSize = 0;
+  bool bDefault = false;
+};
+
+/**
+ * @brief files type
+*/
+struct FilesType {
+  std::string file;
+  std::string type;
+};
+
+ /**
+  * @brief debug run manager types
+ */
+struct RunDebugType {
+  std::string solution;
+  std::string targetType;
+  std::string compiler;
+  std::string board;
+  std::string boardPack;
+  std::string device;
+  std::string devicePack;
+  std::vector<AlgorithmType> algorithms;
+  std::vector<FilesType> outputs;
+  std::vector<FilesType> systemDescriptions;
+};
+
+/**
+  * @brief projmgr run debug management class
+*/
+class ProjMgrRunDebug {
+public:
+  /**
+   * @brief class constructor
+  */
+  ProjMgrRunDebug(void);
+
+  /**
+   * @brief class destructor
+  */
+  ~ProjMgrRunDebug(void);
+
+  /**
+   * @brief get run debug info
+   * @return reference to m_runDebug
+  */
+  RunDebugType& Get() { return m_runDebug; };
+
+  /**
+   * @brief collect run/debug info for selected contexts
+   * @param vector of selected contexts
+   * @return true if executed successfully
+  */
+  bool CollectSettings(const std::vector<ContextItem*>& contexts);
+
+protected:
+  RunDebugType m_runDebug;
+};
+
+#endif  // PROJMGRRUNDEBUG_H

tools/projmgr/include/ProjMgrUtils.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020-2022 Arm Limited. All rights reserved.
+ * Copyright (c) 2020-2024 Arm Limited. All rights reserved.
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -130,7 +130,7 @@ class ProjMgrUtils {
   */
   static RtePackage* ReadGpdscFile(const std::string& gpdsc, bool& valid);
 
- /**
+  /**
    * @brief expand compiler id the format <name>@[>=]<version> into name, minimum and maximum versions
    * @param compiler id
    * @param name reference to compiler name
@@ -231,7 +231,7 @@ class ProjMgrUtils {
    * @param input string
    * @return string with replaced characters
   */
-  static std:: string ReplaceDelimiters(const std::string input);
+  static std::string ReplaceDelimiters(const std::string input);
 
   /**
    * @brief find referenced context
@@ -273,6 +273,13 @@ class ProjMgrUtils {
   */
   static bool ContainsIncompatiblePack(const std::list<RtePackage*>& packs, const std::string& requirement);
 
+  /**
+   * @brief convert ULL to hex string
+   * @param unsigned long long number
+   * @return hexadecimal string
+  */
+  static const std::string ULLToHex(unsigned long long number);
+
 protected:
   /**
    * @brief get filtered list of contexts