[feat] optimize GParam, remove level info in register element

ChunelFeng · ChunelFeng · commit a9b7bf37f953 · 2023-02-20T23:35:10.000+08:00
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -23,9 +23,10 @@ file(GLOB_RECURSE CGRAPH_SRC_LIST "./src/*.cpp")
 # 如果开启此宏定义，则CGraph执行过程中，不会在控制台打印任何信息
 # add_definitions(-D_CGRAPH_SILENCE_)
 
-# 编译libCGraph动态库
-# add_library(CGraphShared SHARED ${CGRAPH_SRC_LIST})
-add_library(CGraphObject OBJECT ${CGRAPH_SRC_LIST})
+# 以下三选一，本地编译执行，推荐OBJECT方式
+add_library(CGraph OBJECT ${CGRAPH_SRC_LIST})      # 通过代码编译
+# add_library(CGraph SHARED ${CGRAPH_SRC_LIST})    # 编译libCGraph动态库
+# add_library(CGraph STATIC ${CGRAPH_SRC_LIST})    # 编译libCGraph静态库
 
 set(CGRAPH_TUTORIAL_LIST
         T00-HelloCGraph
@@ -57,5 +58,5 @@ set(CGRAPH_TUTORIAL_LIST
         )
 
 foreach(tut ${CGRAPH_TUTORIAL_LIST})
-    add_executable(${tut} tutorial/${tut}.cpp $<TARGET_OBJECTS:CGraphObject>)
+    add_executable(${tut} tutorial/${tut}.cpp $<TARGET_OBJECTS:CGraph>)
 endforeach()
diff --git a/README.md b/README.md
@@ -104,10 +104,10 @@ int main() {
     GElementPtr a, b, c, d = nullptr;
 
     /* 注册节点，其中MyNode1和MyNode2必须为GNode的子类，否则无法通过编译 */
-    CStatus status = pipeline->registerGElement<MyNode1>(&a, {}, "nodeA");    // 将名为nodeA，无执行依赖的node信息，注册入pipeline中
-    status += pipeline->registerGElement<MyNode2>(&b, {a}, "nodeB");    // 将名为nodeB，依赖a执行的node信息，注册入pipeline中
+    CStatus status = pipeline->registerGElement<MyNode1>(&a, {}, "nodeA");
+    status += pipeline->registerGElement<MyNode2>(&b, {a}, "nodeB");
     status += pipeline->registerGElement<MyNode1>(&c, {a}, "nodeC");
-    status += pipeline->registerGElement<MyNode2>(&d, {b, c}, "nodeD");    // 将名为nodeD，依赖{b,c}执行的node信息，注册入pipeline中
+    status += pipeline->registerGElement<MyNode2>(&d, {b, c}, "nodeD");
     if (!status.isOK()) {
         return;    // 对以上所有CGraph接口的返回值做判定
     }
diff --git a/src/CBasic/CStrDefine.h b/src/CBasic/CStrDefine.h
@@ -14,8 +14,10 @@
 CGRAPH_NAMESPACE_BEGIN
 
 static const char* CGRAPH_EMPTY = "";
-static const char* CGRAPH_BASIC_EXCEPTION = "CGraph Exception";
-static const char* CGRAPH_FUNCTION_NO_SUPPORT = "function no support";
+static const char* CGRAPH_DEFAULT = "default";
+static const char* CGRAPH_UNKNOWN = "unknown";
+static const char* CGRAPH_BASIC_EXCEPTION = "CGraph default exception";
+static const char* CGRAPH_FUNCTION_NO_SUPPORT = "CGraph function no support";
 
 CGRAPH_NAMESPACE_END
 
diff --git a/src/GraphCtrl/GraphAspect/GAspectObject.h b/src/GraphCtrl/GraphAspect/GAspectObject.h
@@ -17,7 +17,8 @@
 
 CGRAPH_NAMESPACE_BEGIN
 
-class GAspectObject : public GraphObject, public CDescInfo {
+class GAspectObject : public GraphObject,
+                      public CDescInfo {
 public:
     explicit GAspectObject() {
         session_ = URandom<>::generateSession("aspect");
@@ -52,6 +53,8 @@ class GAspectObject : public GraphObject, public CDescInfo {
         CGRAPH_NO_SUPPORT
     }
 
+    CGRAPH_NO_ALLOWED_COPY(GAspectObject)
+
     CGRAPH_DECLARE_GPARAM_MANAGER_WRAPPER
 
 private:
diff --git a/src/GraphCtrl/GraphDaemon/GDaemonObject.h b/src/GraphCtrl/GraphDaemon/GDaemonObject.h
@@ -14,7 +14,8 @@
 
 CGRAPH_NAMESPACE_BEGIN
 
-class GDaemonObject : public GraphObject, public CDescInfo {
+class GDaemonObject : public GraphObject,
+                      public CDescInfo {
 protected:
     explicit GDaemonObject() {
         session_ = URandom<>::generateSession("daemon");
@@ -58,6 +59,8 @@ class GDaemonObject : public GraphObject, public CDescInfo {
         CGRAPH_NO_SUPPORT
     }
 
+    CGRAPH_NO_ALLOWED_COPY(GDaemonObject)
+
     friend class GDaemon;
     friend class GDaemonManager;
     friend class GPipeline;
diff --git a/src/GraphCtrl/GraphElement/GAdapter/GFunction/GFunction.h b/src/GraphCtrl/GraphElement/GAdapter/GFunction/GFunction.h
@@ -39,6 +39,7 @@ class GFunction : public GAdapter {
 protected:
     explicit GFunction() {
         this->element_type_ = GElementType::FUNCTION;
+        session_ = URandom<>::generateSession(CGRAPH_STR_FUNCTION);
     };
 
     CStatus init() override {
diff --git a/src/GraphCtrl/GraphElement/GAdapter/GSingleton/GSingleton.h b/src/GraphCtrl/GraphElement/GAdapter/GSingleton/GSingleton.h
@@ -19,7 +19,8 @@ template<typename T>
 class GSingleton : public GAdapter {
 protected:
     explicit GSingleton() {
-        this->element_type_ = GElementType::SINGLETON;
+        this->element_type_ = GElementType::SINGLETON;\
+        session_ = URandom<>::generateSession(CGRAPH_STR_SINGLETON);
     }
 
     CStatus init() override;
@@ -31,15 +32,13 @@ class GSingleton : public GAdapter {
      * @param dependElements
      * @param name
      * @param loop
-     * @param level
      * @param paramManager
      * @param eventManager
      * @return
      */
     CStatus setElementInfo(const std::set<GElementPtr> &dependElements,
                            const std::string &name,
                            CSize loop,
-                           CLevel level,
                            GParamManagerPtr paramManager,
                            GEventManagerPtr eventManager) override;
 
diff --git a/src/GraphCtrl/GraphElement/GAdapter/GSingleton/GSingleton.inl b/src/GraphCtrl/GraphElement/GAdapter/GSingleton/GSingleton.inl
@@ -69,7 +69,6 @@ template <typename T>
 CStatus GSingleton<T>::setElementInfo(const std::set<GElementPtr> &dependElements,
                                       const std::string &name,
                                       CSize loop,
-                                      CLevel level,
                                       GParamManagerPtr paramManager,
                                       GEventManagerPtr eventManager) {
     CGRAPH_FUNCTION_BEGIN
@@ -78,7 +77,7 @@ CStatus GSingleton<T>::setElementInfo(const std::set<GElementPtr> &dependElement
     CGRAPH_ASSERT_NOT_NULL(eventManager)
 
     // 这里，内部和外部均需要设定name信息
-    this->setName(name)->setLoop(loop)->setLevel(level);
+    this->setName(name)->setLoop(loop);
     status = this->addDependGElements(dependElements);
     CGRAPH_FUNCTION_CHECK_STATUS
 
diff --git a/src/GraphCtrl/GraphElement/GElement.cpp b/src/GraphCtrl/GraphElement/GElement.cpp
@@ -12,7 +12,6 @@ CGRAPH_NAMESPACE_BEGIN
 
 GElement::GElement() {
     element_type_ = GElementType::ELEMENT;
-    session_ = URandom<>::generateSession("element");
 }
 
 
@@ -108,13 +107,12 @@ CStatus GElement::addDependGElements(const GElementPtrSet& elements) {
 CStatus GElement::setElementInfo(const GElementPtrSet& dependElements,
                                  const std::string& name,
                                  CSize loop,
-                                 CLevel level,
                                  GParamManagerPtr paramManager,
                                  GEventManagerPtr eventManager) {
     CGRAPH_FUNCTION_BEGIN
     CGRAPH_ASSERT_INIT(false)
 
-    this->setName(name)->setLoop(loop)->setLevel(level);
+    this->setName(name)->setLoop(loop);
     param_manager_ = paramManager;
     event_manager_ = eventManager;
     status = this->addDependGElements(dependElements);
diff --git a/src/GraphCtrl/GraphElement/GElement.h b/src/GraphCtrl/GraphElement/GElement.h
@@ -20,7 +20,8 @@
 
 CGRAPH_NAMESPACE_BEGIN
 
-class GElement : public GElementObject, public CDescInfo {
+class GElement : public GElementObject,
+                 public CDescInfo {
 public:
     /**
      * 实现添加切面的逻辑
@@ -156,15 +157,13 @@ class GElement : public GElementObject, public CDescInfo {
      * @param dependElements
      * @param name
      * @param loop
-     * @param level
      * @param paramManager
      * @paarm eventManager
      * @return
      */
     virtual CStatus setElementInfo(const std::set<GElement *> &dependElements,
                                    const std::string &name,
                                    CSize loop,
-                                   CLevel level,
                                    GParamManagerPtr paramManager,
                                    GEventManagerPtr eventManager);
 
@@ -244,11 +243,11 @@ class GElement : public GElementObject, public CDescInfo {
 protected:
     CBool done_ { false };                           // 判定被执行结束
     CBool linkable_ { false };                       // 判定是否可以连通计算
-    CSize loop_ { 1 };                               // 元素执行次数
-    CLevel level_ { 0 };                             // 用于设定init的执行顺序(值小的，优先init，可以为负数)
+    CSize loop_ { CGRAPH_DEFAULT_LOOP_TIMES };       // 元素执行次数
+    CLevel level_ { CGRAPH_DEFAULT_ELEMENT_LEVEL };  // 用于设定init的执行顺序(值小的，优先init，可以为负数)
     std::set<GElement *> run_before_;                // 被依赖的节点
     std::set<GElement *> dependence_;                // 依赖的节点信息
-    std::atomic<CSize> left_depend_ { 0 };           // 当 left_depend_ 值为0的时候，即可以执行该element信息
+    std::atomic<CSize> left_depend_ { 0 };        // 当 left_depend_ 值为0的时候，即可以执行该element信息
     GParamManagerPtr param_manager_ { nullptr };     // 整体流程的参数管理类，所有pipeline中的所有element共享
     GAspectManagerPtr aspect_manager_ { nullptr };   // 整体流程的切面管理类
     GEventManagerPtr event_manager_ { nullptr };     // 事件管理类
diff --git a/src/GraphCtrl/GraphElement/GElementDefine.h b/src/GraphCtrl/GraphElement/GElementDefine.h
@@ -17,6 +17,13 @@ const static CMSec CGRAPH_DEFAULT_ELEMENT_RUN_TTL = 0;      // 线程超时时
 const static CSize CGRAPH_DEFAULT_LOOP_TIMES = 1;           // 默认循环次数信息
 const static CLevel CGRAPH_DEFAULT_ELEMENT_LEVEL = 0;       // 默认的element级别，用于控制init函数
 
+static const char* CGRAPH_STR_NODE = "node";
+static const char* CGRAPH_STR_CLUSTER = "cluster";
+static const char* CGRAPH_STR_REGION = "region";
+static const char* CGRAPH_STR_CONDITION = "condition";
+static const char* CGRAPH_STR_FUNCTION = "function";
+static const char* CGRAPH_STR_SINGLETON = "singleton";
+
 enum class GElementType {
     ELEMENT = 0x00000000,                    // 元素
     NODE = 0x00010000,                       // 节点
diff --git a/src/GraphCtrl/GraphElement/GGroup/GCluster/GCluster.cpp b/src/GraphCtrl/GraphElement/GGroup/GCluster/GCluster.cpp
@@ -12,6 +12,7 @@ CGRAPH_NAMESPACE_BEGIN
 
 GCluster::GCluster() {
     element_type_ = GElementType::CLUSTER;
+    session_ = URandom<>::generateSession(CGRAPH_STR_CLUSTER);
 }
 
 
diff --git a/src/GraphCtrl/GraphElement/GGroup/GCondition/GCondition.cpp b/src/GraphCtrl/GraphElement/GGroup/GCondition/GCondition.cpp
@@ -12,6 +12,7 @@ CGRAPH_NAMESPACE_BEGIN
 
 GCondition::GCondition() {
     element_type_ = GElementType::CONDITION;
+    session_ = URandom<>::generateSession(CGRAPH_STR_CONDITION);
 }
 
 
diff --git a/src/GraphCtrl/GraphElement/GGroup/GRegion/GRegion.cpp b/src/GraphCtrl/GraphElement/GGroup/GRegion/GRegion.cpp
@@ -16,6 +16,7 @@ GRegion::GRegion() : GGroup() {
     manager_ = CGRAPH_SAFE_MALLOC_COBJECT(GElementManager)
     is_init_ = false;
     element_type_ = GElementType::REGION;
+    session_ = URandom<>::generateSession(CGRAPH_STR_REGION);
 }
 
 
diff --git a/src/GraphCtrl/GraphElement/GNode/GNode.cpp b/src/GraphCtrl/GraphElement/GNode/GNode.cpp
@@ -13,6 +13,7 @@ CGRAPH_NAMESPACE_BEGIN
 GNode::GNode() : GElement() {
     node_type_ = GNodeType::BASIC;
     element_type_ = GElementType::NODE;
+    session_ = URandom<>::generateSession(CGRAPH_STR_NODE);
 }
 
 
diff --git a/src/GraphCtrl/GraphElement/_GEngine/GStaticEngine/GStaticEngine.cpp b/src/GraphCtrl/GraphElement/_GEngine/GStaticEngine/GStaticEngine.cpp
@@ -165,7 +165,9 @@ CStatus GStaticEngine::afterRunCheck() {
     CGRAPH_FUNCTION_BEGIN
     /* 验证是否所有的内容均被执行过 */
     if (run_element_size_ != total_element_size_) {
-        CGRAPH_RETURN_ERROR_STATUS("pipeline static run element size check failed...")
+        const std::string& errInfo = "run size = [" + std::to_string(run_element_size_)
+                                      + "], total size = [" + std::to_string(total_element_size_) + "] ...";
+        CGRAPH_RETURN_ERROR_STATUS("pipeline static run element size check failed, " + errInfo)
     }
 
     /* 需要验证每个cluster里的每个内容是否被执行过一次 */
diff --git a/src/GraphCtrl/GraphParam/GParam.cpp b/src/GraphCtrl/GraphParam/GParam.cpp
@@ -0,0 +1,55 @@
+/***************************
+@Author: Chunel
+@Contact: chunel@foxmail.com
+@File: GParam.cpp
+@Time: 2023/2/20 22:11
+@Desc: 
+***************************/
+
+#include "GParam.h"
+
+CGRAPH_NAMESPACE_BEGIN
+
+
+CStatus GParam::dump(const std::string& path) {
+    CGRAPH_NO_SUPPORT
+}
+
+
+CStatus GParam::load(const std::string& path) {
+    CGRAPH_NO_SUPPORT
+}
+
+
+CStatus GParam::getBacktrace(std::set<std::string>& backtrace) {
+    CGRAPH_FUNCTION_BEGIN
+    if (!backtrace_enable_) {
+        CGRAPH_RETURN_ERROR_STATUS("backtrace no enable.")
+    }
+
+    CGRAPH_READ_LOCK lk(_param_shared_lock_);
+    for (const auto& iter : backtrace_) {
+        backtrace.emplace(iter);
+    }
+
+    CGRAPH_FUNCTION_END
+}
+
+
+CVoid GParam::addBacktrace(const std::string& name, const std::string& session) {
+    if (!backtrace_enable_) {
+        // 如果没有开启，直接返回即可
+        return;
+    }
+
+    // 如果name不为空，则添加name信息。如果name为空，则添加session信息
+    CGRAPH_WRITE_LOCK lk(_param_shared_lock_);
+    backtrace_.insert(name.empty() ? session : name);
+}
+
+
+const std::string& GParam::getKey() const {
+    return key_;
+}
+
+CGRAPH_NAMESPACE_END
diff --git a/src/GraphCtrl/GraphParam/GParam.h b/src/GraphCtrl/GraphParam/GParam.h
diff --git a/src/GraphCtrl/GraphParam/GParamManager.inl b/src/GraphCtrl/GraphParam/GParamManager.inl
diff --git a/src/GraphCtrl/GraphPipeline/GPipeline.h b/src/GraphCtrl/GraphPipeline/GPipeline.h
diff --git a/src/GraphCtrl/GraphPipeline/GPipeline.inl b/src/GraphCtrl/GraphPipeline/GPipeline.inl
diff --git a/tutorial/T11-Singleton.cpp b/tutorial/T11-Singleton.cpp
diff --git a/tutorial/T13-Daemon.cpp b/tutorial/T13-Daemon.cpp
diff --git a/tutorial/T14-Hold.cpp b/tutorial/T14-Hold.cpp
