在《使用 acl 協程編寫高併發網絡服務》和《使用協程方式編寫高併發的 WEB 服務》兩篇文章中介紹瞭如何使用 acl 的協程功能編寫高併發服務器程序,本文主要介紹如何編譯使用 acl 的網絡協程庫。
一、 acl 協程庫的依賴關係
目前 acl 協程主要分爲 C 庫(lib_fiber.a,在 acl/lib_fiber/c 目錄下)和 C++庫(libfiber_cpp.a,在 acl/lib_fiber/cpp 目錄下),其中 lib_fiber_cpp.a 依賴 libfiber.a,具體的依賴關係如下:
libfiber.a 目前是獨立的庫,libfiber_cpp.a 依賴 libfiber.a 和 lib_acl_cpp.a,lib_acl_cpp.a 依賴 lib_protocol.a 和 lib_acl.a,lib_protocol.a 依賴 lib_acl.a。
其中,lib_acl.a 爲 acl 中的核心基礎 C 庫,lib_protocol.a 爲 acl 中的網絡協議(http/icmp/smtp)基礎 C 庫,lib_acl_cpp 爲 C++庫,依賴上述兩個 C 庫;libfiber.a 爲獨立的網絡協程庫,僅依賴於系統庫,libfiber_cpp.a 爲封裝了 libfiber.a 的 C++ 庫,如果用戶所用的 GCC 支持 C++11,則該庫還支持更爲簡潔的創建協程的方式(藉助於 C++11中的 lambda 表達式方式)。
二、一個簡單的例子
下面是一個簡單的使用 acl 協程的例子:
#include "lib_acl.h" #include <stdio.h> #include <stdlib.h> #include "fiber/lib_fiber.h" static int __max_loop = 100; static int __max_fiber = 10; static int __stack_size = 64000; /* 協程處理入口函數 */ static void fiber_main(ACL_FIBER *fiber, void *ctx acl_unused) { int i; /* 兩種方式均可以獲得當前的協程號 */ assert(acl_fiber_self() == acl_fiber_id(fiber)); for (i = 0; i < __max_loop; i++) { acl_fiber_yield(); /* 主動讓出 CPU 給其它協程 */ printf("fiber-%d\r\n", acl_fiber_self()); } } int main(void) { int ch, i; /* 創建協程 */ for (i = 0; i < __max_fiber; i++) acl_fiber_create(fiber_main, NULL, __stack_size); printf("---- begin schedule fibers now ----\r\n"); acl_fiber_schedule(); /* 循環調度所有協程,直至所有協程退出 */ printf("---- all fibers exit ----\r\n"); return 0; }
上述例子非常簡單,說明了 acl 協程創建、啓動和運行過程,如果僅此而已,當然使用協程並沒有什麼卵用,協程的關鍵價值在於與網絡通信的結合,可以達到高併發、高性能的目的。因此,現實中協程的應用範圍主要還是網絡服務方面,更爲準確的叫法應該是“網絡協程”,脫離了“網絡”協程基本沒啥價值。本文的開頭給出了兩個鏈接,指明瞭網絡協程的應用場景及實例。
三、編譯例子
下面的 Makefile 文件說明了最簡單的編譯方式:
fiber: main.o gcc -o fiber main.o -L./lib_fiber/lib -L./lib_acl/lib -l_acl -lfiber -lpthread -ldl main.o: main.c gcc -c main.c -O3 -DLINUX2 -I./lib_fiber/c/include -I./lib_acl/include
該 Makefile 也非常簡單,也僅是說明了使用 acl 網絡協程庫時的編譯條件。其中,l_fiber 指定了 acl 的網絡協程庫,l_acl 指定了 acl 基礎庫,-lpthread 及 -ldl 指定所依賴的系統庫;-DLINUX2 指定 LINUX 平臺的編譯條件,-I 指定頭文件所在位置。
四、C++ 示例
上面的例子展示了使用 acl C 協程庫的使用方法,同時 acl 也提供了 C++ 類封裝,方便 C++ 程序員編寫協程應用,下面的例子爲使用標準 C++ 編寫的協程示例:
#include <assert.h>
#include <iostream>
#include "acl_cpp/lib_acl.hpp"
#include "fiber/lib_fiber.hpp"
class myfiber : public acl::fiber
{
public:
myfiber(int max_loop) : max_loop_(max_loop) {}
protected:
// @override 實現基類純虛函數
void run(void)
{
// 兩種方式均可以獲得當前的協程號
assert(get_id() == acl::fiber::self());
for (int i = 0; i < max_loop_; i++) {
acl::fiber::yield(); // 主動讓出 CPU 給其它協程
std::cout << "fiber-" << acl::fiber::self() << std::endl;
}
delete this; // 因爲是動態創建的,所以需自動銷燬
}
private:
int max_loop_;
~myfiber(void) {}
};
int main(void)
{
int i, max_fiber = 10, max_loop = 10;
for (i = 0; i < max_fiber; i++) {
acl::fiber* fb = new myfiber(max_loop); // 創建協程
fb->start(); // 啓動協程
}
std::cout << "---- begin schedule fibers now ----" << std::endl;
acl::fiber::schedule(); // 循環調度所有協程,直至所有協程退出
std::cout << "---- all fibers exit ----" << std::endl;
return 0;
}
該例子也非常簡單,實現了與上面 C 示例相同的功能,只是採用 C++ 而已。用戶首先需要定義自己的類,其繼承於 acl::fiber 協程類,然後實現協程類中的純虛方法:run(),當調用協程的啓動方法 start() 時,acl::fiber 基類會自動回調純虛方法 run()。
該 C++ 示例的 Makefile 與 C 的有所不同,內容如下:
fiber: main.o
g++ -o fiber main.o -L./lib_fiber/lib -lfiber_cpp \
-L./lib_acl_cpp/lib -l_acl_cpp \
-L./lib_acl/lib -l_acl -lfiber \
-lpthread -ldl
main.o: main.cpp
g++ -O3 -Wall -c main.cpp -DLINUX2 -I./lib_fiber/cpp/include \
-I./lib_acl_cpp/include
五、C++11 示例
acl 的協程庫同時提供了支持 C++11 方式的調用方法,使創建協程更加方便,代碼如下:
#include <iostream>
#include "acl_cpp/lib_acl.hpp"
#include "fiber/lib_fiber.hpp"
static void fiber_main(int max_loop)
{
for (int i = 0; i < max_loop; i++) {
acl::fiber::yield(); // 主動讓出 CPU 給其它協程
std::cout << "fiber-" << acl::fiber::self() << std::endl;
}
}
int main(void)
{
int i, max_fiber = 10, max_loop = 10;
for (i = 0; i < max_fiber; i++) {
go[=] { // 採用 c++11 的 lambad 表達式方式創建協程
fiber_main(max_loop); // 進入協程處理函數
};
}
std::cout << "---- begin schedule fibers now ----" << std::endl;
// 循環調度所有協程,直至所有協程退出
acl::fiber::schedule();
std::cout << "---- all fibers exit ----" << std::endl;
return 0;
}
使用 C++11 方式創建協程是不是感覺更加簡潔?
同樣下面給出 makefile 內容:
fiber: main.o
g++ -o fiber main.o -L../../../lib -lfiber_cpp \
-L../../../../lib_acl_cpp/lib -l_acl_cpp \
-L../../../../lib_acl/lib -l_acl -lfiber \
-lpthread -ldl
main.o: main.cpp
g++ -std=c++11 -O3 -Wall -c main.cpp -DLINUX2 -I.. -I../../../cpp/include \
-I../../../../lib_acl_cpp/include
六、基於協程的網絡服務
前面提到了“如果協程不與網絡應用結合,則不會發揮其價值“,因此,下面就給出一個具體的基於協程的網絡服務器程序:
#include <iostream>
#include "acl_cpp/lib_acl.hpp"
#include "fiber/lib_fiber.hpp"
class fiber_client : public acl::fiber
{
public:
fiber_client(acl::socket_stream* conn) : conn_(conn) {}
protected:
// @override 實現基類純虛函數
void run(void)
{
std::cout << "fiber-" << acl::fiber::self()
<< ": fd=" << conn_->sock_handle()
<< ", addr=" << conn_->get_peer() << std::endl;
echo();
delete this; // 因爲是動態創建的,所以需自動銷燬
}
private:
acl::socket_stream* conn_;
~fiber_client(void)
{
delete conn_;
}
void echo(void)
{
char buf[8192];
// 從客戶端讀取數據並回顯
while (!conn_->eof()) {
int ret = conn_->read(buf, sizeof(buf), false);
if (ret == -1) {
std::cout << "read " << acl::last_serror() << std::endl;
break;
}
if (conn_->write(buf, ret) == -1) {
std::cout << "write " << acl::last_serror() << std::endl;
break;
}
}
}
};
class fiber_server : public acl::fiber
{
public:
fiber_server(const char* addr) : addr_(addr) {}
protected:
// @override
void run(void)
{
// 監聽服務地址
acl::server_socket ss;
if (ss.open(addr_) == false) {
std::cout << "listen " << addr_.c_str() << " error" << std::endl;
delete this;
return;
}
std::cout << "listen " << addr_.c_str() << " ok" << std::endl;
while (true) {
// 等待接收客戶端連接
acl::socket_stream* conn = ss.accept();
if (conn == NULL) {
std::cout << "accept error" << std::endl;
break;
}
// 創建客戶端處理協程
acl::fiber* fb = new fiber_client(conn);
fb->start();
}
delete this;
}
private:
acl::string addr_;
~fiber_server(void) {}
};
int main(void)
{
const char* addr = "127.0.0.1:8089";
acl::fiber* fb = new fiber_server(addr); // 創建監聽服務協程
fb->start(); // 啓動監聽協程
// 循環調度所有協程,直至所有協程退出
acl::fiber::schedule();
return 0;
}
麻雀雖小,五臟俱全,該示例簡明扼要地說明了如何使用 acl 的網絡協程庫編寫支持高併發的網絡服務應用。
七、參考
在 acl/lib_fiber/samples/ 目錄下,還有大量的使用 acl 協程的例子,包括:定時器、簡單聊天服務、mysql 訪問協程化、redis 訪問協程化、域名解析協程化等。
acl網絡協程的設計原理:網絡協程編程
基於協程的簡單網絡服務:使用 acl 協程編寫高併發網絡服務
基於協程的 WEB 服務:使用協程方式編寫高併發的 WEB 服務
協程庫:https://github.com/acl-dev/acl/tree/master/lib_fiber
acl svn:svn checkout svn://svn.code.sf.net/p/acl/code/trunk acl-code
acl github:https://github.com/acl-dev/acl
acl 國內鏡像:http://git.oschina.net/acl-dev/acl/tree/master
qq 羣:242722074