Basic

CO?是一個優雅、高效的 C++ 基礎庫，支持 Linux, Windows 與 Mac 平臺。CO?追求極簡、高效，不依賴于?boost?等三方庫。

CO?包含協程庫(golang-style)、網絡庫(tcp/http/rpc)、日志庫、命令行與配置文件解析庫、單元測試框架、json 庫等基本組件。

參考文檔

• 中文
• English

亮點功能

• co

  co?是一個?golang?風格的 C++ 協程庫，有如下特性:

  • 支持多線程調度，默認線程數為系統 CPU 核數.

  • 協程共享線程棧(默認大小為 1MB)，內存占用極低，單機可輕松創建數百萬協程.

  • 支持系統 api hook (Linux & Mac).

  • 支持協程鎖?co::Mutex.

  • 支持協程同步事件?co::Event.

  • 支持協程池?co::Pool.

  • 用?go()?創建協程:

  void fun() {
      std::cout << "hello world" << std::endl;
  }
  
  go(fun);

• so

  so?是基于協程的 C++ 網絡庫，可輕松實現同時支持?ipv4?與?ipv6?的網絡程序，包含如下幾個模塊:

  • tcp 模塊, 支持一般的 tcp 編程.

  • http 模塊, 支持基本的 http 編程.

  • rpc 模塊，基于 json 的 rpc 框架，單線程 qps 可達到 12w+.

  • 實現靜態?web server:

  #include "co/flag.h"
  #include "co/log.h"
  #include "co/so.h"
  
  DEF_string(d, ".", "root dir"); // 指定 web server 根目錄
  
  int main(int argc, char** argv) {
      flag::init(argc, argv);
      log::init();
  
      so::easy(FLG_d.c_str()); // mum never have to worry again
  
      return 0;
  }

  • 實現一般的 http server:

  http::Server serv("0.0.0.0", 80);
  
  serv.on_req(
      [](const http::Req& req, http::Res& res) {
          if (req.is_method_get()) {
              if (req.url() == "/hello") {
                  res.set_status(200);
                  res.set_body("hello world");
              } else {
                  res.set_status(404);
              }
          } else {
              res.set_status(501);
          }
      }
  );
  
  serv.start();

• log

  log?是一個超級快的本地日志系統，打印日志比?printf?更安全:

  LOG << "hello " << 23;  // info
  ELOG << "hello again";  // error

  下面直觀感受一下?log?的性能:

  log vs glog	google glog	co/log
  win2012 HHD	1.6MB/s	180MB/s
  win10 SSD	3.7MB/s	560MB/s
  mac SSD	17MB/s	450MB/s
  linux SSD	54MB/s	1023MB/s

  上表是單線程連續打印 100 萬條 info 日志(每條 50 字節左右)的測試結果，co/log?幾乎快了?glog?兩個數量級。

  為何如此快？一是 log 庫內部基于比?sprintf?快 8-25 倍的?fastream?實現，二是 log 庫幾乎沒有什么內存分配操作。

• flag

  flag?是一個方便、易用的命令行及配置文件解析庫，支持自動生成配置文件。

  #include "co/flag.h"
  
  DEF_int32(i, 32, "comments");
  DEF_string(s, "xxx", "string type");
  
  int main(int argc, char** argv) {
      flag::init(argc, argv);
      std::cout << "i: " << FLG_i << std::endl;
      std::cout << "s: " << FLG_s << std::endl;
      return 0;
  }

  編譯后運行:

  ./xx                          # 以默認參數啟動
  ./xx -i=4k -s="hello world"   # 整數類型可以帶單位 k,m,g,t,p, 不分大小寫
  ./xx -i 4k -s "hello world"   # 與上等價
  ./xx --mkconf                 # 自動生成配置文件 xx.conf
  ./xx -config=xx.conf          # 從配置文件啟動

• json

  json?是一個速度堪比?rapidjson?的 json 庫，如果使用?jemalloc，parse?與?stringify?的性能會進一步提升。此庫對 json 標準的支持不如 rapidjson 全面，但能滿足程序員的基本需求，且更容易使用。

代碼構成

• co/include

  libco?的頭文件。

• co/src

  libco?的源代碼。

• co/test

  一些測試代碼，每個?.cc?文件都會編譯成一個單獨的測試程序。

• co/unitest

  一些單元測試代碼，每個?.cc?文件對應不同的測試單元，所有代碼都會編譯到單個測試程序中。

• co/gen

  代碼生成工具，根據 proto 文件，自動生成 rpc 框架代碼。

編譯執行

xmake

CO?推薦使用?xmake?進行編譯。

• 編譯器

  • Linux:?gcc 4.8+
  • Mac:?clang 3.3+
  • Windows:?vs2015+

• 安裝 xmake

  windows, mac 與 debian/ubuntu 可以直接去 xmake 的?release?頁面下載安裝包，其他系統請參考 xmake 的?Installation?說明。

  xmake 在 linux 上默認禁止 root 用戶編譯，ruki?說不安全，可以在?~/.bashrc?中加上下面的一行，啟用 root 編譯:

  export XMAKE_ROOT=y

• 快速上手

  # 所有命令都在 co 根目錄執行，后面不再說明
  xmake       # 默認編譯 libco 與 gen
  xmake -a    # 編譯所有項目 (libco, gen, co/test, co/unitest)

• 編譯 libco

  xmake build libco       # 編譯 libco
  xmake -b libco          # 與上同

• 編譯及運行 unitest 代碼

  co/unitest?是單元測試代碼，用于檢驗 libco 庫功能的正確性。

  xmake build unitest     # build 可以簡寫為 -b
  xmake run unitest -a    # 執行所有單元測試
  xmake r unitest -a      # 同上
  xmake r unitest -os     # 執行單元測試 os
  xmake r unitest -json   # 執行單元測試 json

• 編譯及運行 test 代碼

  co/test?包含了一些測試代碼。co/test 目錄下增加?xxx.cc?源文件，然后在 co 根目錄下執行?xmake build xxx?即可構建。

  xmake build flag             # 編譯 flag.cc
  xmake build log              # 編譯 log.cc
  xmake build json             # 編譯 json.cc
  xmake build rapidjson        # 編譯 rapidjson.cc
  xmake build rpc              # 編譯 rpc.cc
  xmake build easy             # 編譯 so/easy.cc
  xmake build pingpong         # 編譯 so/pingpong.cc
  
  xmake r flag -xz             # 測試 flag 庫
  xmake r log                  # 測試 log 庫
  xmake r log -cout            # 終端也打印日志
  xmake r log -perf            # log 庫性能測試
  xmake r json                 # 測試 json
  xmake r rapidjson            # 測試 rapidjson
  xmake r rpc                  # 啟動 rpc server
  xmake r rpc -c               # 啟動 rpc client
  xmake r easy -d xxx          # 啟動 web server
  xmake r pingpong             # pingpong server:   127.0.0.1:9988
  xmake r pingpong ip=::       # pingpong server:   :::9988  (ipv6)
  xmake r pingpong -c ip=::1   # pingpong client -> ::1:9988

• 編譯 gen

  # 建議將 gen 放到系統目錄下(如 /usr/local/bin/).
  xmake build gen
  gen hello_world.proto

  proto?文件格式可以參考?hello_world.proto。

• 安裝

  # 默認安裝頭文件、libco、gen
  xmake install -o pkg          # 打包安裝到 pkg 目錄
  xmake i -o pkg                # 同上
  xmake install -o /usr/local   # 安裝到 /usr/local 目錄

cmake

izhengfan?幫忙提供了 cmake 支持:

• 默認只編譯?libco?與?gen.
• 編譯生成的庫文件在 build/lib 目錄下，可執行文件在 build/bin 目錄下.
• 可以用?BUILD_ALL?指定編譯所有項目.
• 可以用?CMAKE_INSTALL_PREFIX?指定安裝目錄.

mkdir build && cd build
cmake ..
cmake .. -DBUILD_ALL=ON -DCMAKE_INSTALL_PREFIX=pkg
make -j8
make install

License

CO?以?MIT?License 發布.?CO?包含了一些其他項目的代碼，可能使用了與?CO?不同的 License，詳情見?LICENSE.md。

特別致謝

• co/context?的相關代碼取自?ruki?的?tbox，特別表示感謝！
• co 英文參考文檔，由?Leedehai(1-10)，daidai21(11-15) 與?google?翻譯，特別表示感謝！
• ruki?幫忙改進了 xmake 編譯腳本，特別表示感謝！
• izhengfan?提供了 cmake 編譯腳本，特別表示感謝！