Merge pull request #36 from lkpworkspace/dev

v0.9.6
- other:
    - 日志大小可配置
    - 新增接收队列溢出告警日志
    - 设置默认运行队列最大为2个
    - 新增API使用示例

Author: lkpworkspace

CMakeLists.txt

@@ -2,7 +2,7 @@ cmake_minimum_required(VERSION 3.10)
 if (POLICY CMP0091)
   cmake_policy(SET CMP0091 NEW)
 endif()
-project(myframe VERSION 0.9.5)
+project(myframe VERSION 0.9.6)
 
 ### option
 option(MYFRAME_USE_CV "Using conditional variables for thread communication" ON)

README.md

@@ -37,72 +37,18 @@ cmake -S . -B build -DCMAKE_INSTALL_PREFIX="./output" -DCMAKE_PREFIX_PATH="./out
 cmake --build build -j --config Release --target install
 ```
 
-### Hello,World 示例
-```c
-#include <string.h>
-#include <iostream>
+### Hello,World API示例
+- [API 示例](test/hello_test.cpp)
 
-#include "myframe/msg.h"
-#include "myframe/actor.h"
-
-using namespace myframe;
-/*
-  该actor实现：
-    自己给自己发送一条消息
-*/
-class Demo : public Actor
-{
- public:
-  /* actor模块加载完毕后调用 */
-  int Init(const char* param) override {
-    /* 构造 hello,world 消息发送给自己 */
-    auto mailbox = GetMailbox();
-    mailbox->Send("actor.demo.echo_hello_world", std::make_shared<Msg>("hello,world"));
-  }
-
-  void Proc(const std::shared_ptr<const Msg>& msg) override {
-    /* 获得文本消息， 打印 源actor地址 目的actor地址 消息内容 */
-    std::cout << *msg << ": " << msg->GetData() << std::endl;
-  }
-};
-
-/* 框架根据描述文件创建actor实例函数 */
-extern "C" std::shared_ptr<Actor> actor_create(const std::string& actor_name) {
-  if (actor_name == "demo") {
-    return std::make_shared<Demo>();
-  }
-  return nullptr;
-}
-
-```
-
-### Hello,World 配置文件
-```json
-{
-  "type":"library",
-  "lib":"demo",
-  "actor":{
-    "demo":[
-      {
-        "instance_name":"echo_hello_world",
-        "instance_params":""
-      }
-    ]
-  }
-}
-```
-- type: [ library | class ]
-- lib: 库名称
-- actor: 需要创建的actor列表
-  - demo: actor名
-    - instance_name：实例名称
-    - instance_params：实例参数
+### Hello,World 组件示例
+- [组件代码示例](examples/example_actor_helloworld.cpp)
+- [组件配置示例](examples/example_actor_helloworld.json)
 
 ## 程序接口
-- [Example](https://github.com/lkpworkspace/myframe/tree/master/examples)
-- [Actor模块](https://github.com/lkpworkspace/myframe/blob/master/myframe/actor.h)
-- [Worker模块](https://github.com/lkpworkspace/myframe/blob/master/myframe/worker.h)
-- [Msg模块](https://github.com/lkpworkspace/myframe/blob/master/myframe/msg.h)
+- [Example](examples)
+- [Actor模块](myframe/actor.h)
+- [Worker模块](myframe/worker.h)
+- [Msg模块](myframe/msg.h)
 
 ## 文档
 - [开发手册](doc/development_guide.md)

cpplint.bash

@@ -18,8 +18,8 @@ function main() {
     -name "*.hxx" -or \
     -name "*.cxx" -or \
     -name "*.cuh" \
-    ')' -and -not -path "./build/*" \
-    -and -not -path "./output/*" \
+    ')' -and -not -path "./build*" \
+    -and -not -path "./output*" \
     -and -not -path "./3rd/*" \
     -and -not -path "./myframe/export.h" \
     | xargs python3 ./cpplint.py

launcher/conf/sys.json

@@ -1,7 +1,11 @@
 {
-    "default_pending_queue_size":-1,
-    "default_run_queue_size":-1,
     "thread_poll_size":4,
     "conn_event_size":2,
-    "warning_msg_size":10
+    "warning_msg_size":10,
+    "log_dir":"log",
+    "lib_dir":"",
+    "service_dir":"service",
+    "default_pending_queue_size":-1,
+    "default_run_queue_size":2,
+    "log_max_size_mb":100
 }

launcher/launcher.cpp

@@ -42,7 +42,10 @@ int main(int argc, char** argv) {
     log_dir = module_args.GetLogDir();
   }
   log_dir = myframe::Common::GetAbsolutePath(log_dir.string());
-  myframe::InitLog(log_dir, module_args.GetProcessName());
+  myframe::InitLog(
+    log_dir,
+    module_args.GetProcessName(),
+    module_args.GetLogMaxSizeMB());
   LOG(INFO) << "launch command: " << module_args.GetCmd();
 
   if (module_args.GetLibDir().empty()) {

launcher/module_argument.cpp

@@ -61,6 +61,7 @@ void ModuleArgument::ParseArgument(
     process_name_ = process_name;
   }
 
+  // 命令行参数优先级大于配置文件优先级
   auto sys_conf = parser_.get<std::string>("sys_conf");
   if (!sys_conf.empty()) {
     if (!ParseSysConf(sys_conf)) {
@@ -74,10 +75,6 @@ void ModuleArgument::ParseArgument(
     conf_dir_ = dir;
   }
 
-  for (size_t i = 0; i < parser_.rest().size(); i++) {
-    conf_list_.emplace_back(parser_.rest()[i]);
-  }
-
   auto log_dir = parser_.get<std::string>("log_dir");
   if (!log_dir.empty()) {
     log_dir_ = log_dir;
@@ -87,6 +84,10 @@ void ModuleArgument::ParseArgument(
   if (!lib_dir.empty()) {
     lib_dir_ = lib_dir;
   }
+
+  for (size_t i = 0; i < parser_.rest().size(); i++) {
+    conf_list_.emplace_back(parser_.rest()[i]);
+  }
 }
 
 bool ModuleArgument::ParseSysConf(const std::string& sys_conf) {
@@ -139,6 +140,10 @@ bool ModuleArgument::ParseSysConf(const std::string& sys_conf) {
       && root["default_run_queue_size"].isInt()) {
     default_run_queue_size_ = root["default_run_queue_size"].asInt();
   }
+  if (root.isMember("log_max_size_mb")
+      && root["log_max_size_mb"].isInt()) {
+    log_max_size_mb_ = root["log_max_size_mb"].asInt();
+  }
   return true;
 }
 

launcher/module_argument.h

@@ -34,6 +34,7 @@ class ModuleArgument final {
   inline int GetDefaultRunQueueSize() const {
     return default_run_queue_size_;
   }
+  inline int GetLogMaxSizeMB() const { return log_max_size_mb_; }
 
  private:
   bool ParseSysConf(const std::string&);
@@ -42,7 +43,8 @@ class ModuleArgument final {
   int conn_event_size_{2};
   int warning_msg_size_{10};
   int default_pending_queue_size_{-1};
-  int default_run_queue_size_{-1};
+  int default_run_queue_size_{2};
+  int log_max_size_mb_{100};
   std::string log_dir_;
   std::string lib_dir_;
   std::string conf_dir_;

myframe/app.cpp

@@ -8,6 +8,7 @@ Author: 李柯鹏 <[email protected]>
 #include "myframe/app.h"
 
 #include <regex>
+#include <utility>
 
 #include "myframe/log.h"
 #include "myframe/platform.h"
@@ -509,9 +510,6 @@ void App::DispatchMsg(std::shared_ptr<Msg> msg) {
 }
 
 void App::DispatchMsg(std::list<std::shared_ptr<Msg>>* msg_list) {
-  LOG_IF(WARNING,
-      msg_list->size() > warning_msg_size_.load())
-    << " dispatch msg too many";
   for (auto& msg : (*msg_list)) {
     DispatchMsg(std::move(msg));
   }

myframe/app.h

@@ -6,22 +6,18 @@ Author: 李柯鹏 <[email protected]>
 ****************************************************************************/
 #pragma once
 #include <atomic>
-#include <list>
 #include <memory>
 #include <mutex>
-#include <unordered_map>
-#include <vector>
+#include <list>
 #include <string>
-#include <filesystem>
-#include <utility>
+#include <vector>
 
 #include <json/json.h>
 
 #include "myframe/macros.h"
 #include "myframe/event.h"
 #include "myframe/export.h"
-
-namespace stdfs = std::filesystem;
+#include "myframe/common.h"
 
 namespace myframe {
 
@@ -61,7 +57,7 @@ class MYFRAME_EXPORT App final : public std::enable_shared_from_this<App> {
     int event_conn_size = 2,
     int warning_msg_size = 10,
     int default_pending_queue_size = -1,
-    int default_run_queue_size = -1);
+    int default_run_queue_size = 2);
 
   int LoadServiceFromDir(const std::string& path);
 
@@ -145,7 +141,7 @@ class MYFRAME_EXPORT App final : public std::enable_shared_from_this<App> {
   std::string node_addr_;
   ///
   int default_pending_queue_size_{-1};
-  int default_run_queue_size_{-1};
+  int default_run_queue_size_{2};
   std::atomic<std::size_t> warning_msg_size_{10};
   std::atomic<State> state_{kUninitialized};
   std::recursive_mutex local_mtx_;

myframe/log.cpp

@@ -18,11 +18,14 @@ static void signal_handler(const char *data, size_t size) {
 
 namespace myframe {
 
-void InitLog(const stdfs::path& log_dir, const std::string& bin_name) {
+void InitLog(
+  const stdfs::path& log_dir,
+  const std::string& bin_name,
+  int max_size_mb) {
   google::InitGoogleLogging(bin_name.c_str());
 
   FLAGS_logbufsecs = 0;
-  FLAGS_max_log_size = 100;
+  FLAGS_max_log_size = max_size_mb;
   FLAGS_stop_logging_if_full_disk = true;
 
   std::string dst_str = (log_dir / bin_name).string();

myframe/log.h

@@ -6,19 +6,18 @@ Author: 李柯鹏 <[email protected]>
 ****************************************************************************/
 #pragma once
 #include <string>
-#include <filesystem>
 
 #include <glog/logging.h>
 
 #include "myframe/export.h"
-
-namespace stdfs = std::filesystem;
+#include "myframe/common.h"
 
 namespace myframe {
 
 MYFRAME_EXPORT void InitLog(
   const stdfs::path& log_dir,
-  const std::string& bin_name);
+  const std::string& bin_name,
+  int max_size_mb = 100);
 
 MYFRAME_EXPORT void ShutdownLog();
 

myframe/mailbox.cpp

@@ -8,6 +8,7 @@ Author: 李柯鹏 <[email protected]>
 #include <utility>
 
 #include "myframe/msg.h"
+#include "myframe/log.h"
 
 namespace myframe {
 
@@ -74,6 +75,8 @@ void Mailbox::RecvClear() {
 void Mailbox::Recv(std::shared_ptr<Msg> msg) {
   if (pending_queue_size_ > 0) {
     for (; recv_.size() >= static_cast<std::size_t>(pending_queue_size_);) {
+      LOG(WARNING) << Addr() << " pending queue overflow "
+        << recv_.size() << "/" << pending_queue_size_;
       recv_.pop_front();
     }
   }

myframe/mod_manager.cpp

@@ -6,15 +6,13 @@ Author: 李柯鹏 <[email protected]>
 ****************************************************************************/
 
 #include "myframe/mod_manager.h"
-#include <filesystem>
 
+#include "myframe/common.h"
 #include "myframe/log.h"
 #include "myframe/shared_library.h"
 #include "myframe/actor.h"
 #include "myframe/worker.h"
 
-namespace stdfs = std::filesystem;
-
 namespace myframe {
 
 ModManager::ModManager() {

test/CMakeLists.txt

@@ -4,6 +4,11 @@ cmake_minimum_required(VERSION 3.10)
 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/performance_test_config.h.in ${CMAKE_CURRENT_SOURCE_DIR}/performance_test_config.h @ONLY)
 
 ### test bin
+add_executable(hello_test hello_test.cpp)
+target_link_libraries(hello_test
+    myframe
+)
+
 add_executable(common_test common_test.cpp)
 target_link_libraries(common_test
     myframe
@@ -51,6 +56,7 @@ target_link_libraries(performance_trans100_fullspeed_test
 
 ### install
 INSTALL(TARGETS
+    hello_test
     common_test
     actor_run_queue_test
     app_send_test

test/hello_test.cpp

@@ -0,0 +1,53 @@
+/****************************************************************************
+Copyright (c) 2019, 李柯鹏
+All rights reserved.
+
+Author: 李柯鹏 <[email protected]>
+****************************************************************************/
+#include <iostream>
+#include "myframe/msg.h"
+#include "myframe/actor.h"
+#include "myframe/mod_manager.h"
+#include "myframe/app.h"
+
+#include "performance_test_config.h"
+
+class Hello : public myframe::Actor {
+ public:
+  /* actor模块加载完毕后调用 */
+  int Init(const char* param) override {
+    (void)param;
+    /* 构造 hello,world 消息发送给自己 */
+    auto mailbox = GetMailbox();
+    mailbox->Send(
+      mailbox->Addr(),
+      std::make_shared<myframe::Msg>("hello,world"));
+    return 0;
+  }
+
+  void Proc(const std::shared_ptr<const myframe::Msg>& msg) override {
+    /* 获得文本消息， 打印 源actor地址 目的actor地址 消息内容 */
+    std::cout << *msg << ": " << msg->GetData() << std::endl;
+  }
+};
+
+int main() {
+  auto lib_dir =
+    myframe::Common::GetAbsolutePath(MYFRAME_LIB_DIR).string();
+
+  auto app = std::make_shared<myframe::App>();
+  if (false == app->Init(lib_dir, 1)) {
+    std::cout << "Init failed\n";
+    return -1;
+  }
+
+  auto& mod = app->GetModManager();
+
+  mod->RegActor("Hello", [](const std::string&) {
+      return std::make_shared<Hello>();
+  });
+  auto actor = mod->CreateActorInst("class", "Hello");
+  app->AddActor("1", "", actor);
+
+  return app->Exec();
+}