Linux高性能服務器編程學習筆記——簡單半同步/半異步進程池的實現

這是遊雙大大的《linux高性能服務器編程》第15章實現的半同步/半異步的進程池，使用了統一事件源的思想，這是我在閱讀完源碼之後記下的筆記以及註釋，確確實實學習到了很多東西，只有在實戰編程中才能記得更牢靠，更熟練。

半同步/半異步框架屬於同步I/O的一種，採用的事件處理模式爲Recator模式：要求工作進程自己從socket上讀取客戶請求和往socket寫入服務器應答；而進程池中的父進程只有一個工作：負責管理監聽socket，連接socket的事情交給子進程來處理。

也就是說，當有新的連接請求到來時，主進程只是接受這個請求，並向epoll內核中註冊socket上的請求事件，它將新的連接派發給子進程處理，此後新socket上的任何I/O操作都由子進程處理，除此之外就是檢測子進程工作狀態和等待退出；子進程檢測到管道內有數據，就分析是否是一個新的客戶連接請求到來，如果是，則把新socket上的讀寫事件epoll到自己的內核事件表中。

如下圖所示：

#include <sys/types.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <arpa/inet.h>
#include <assert.h>
#include <stdio.h>
#include <unistd.h>
#include <errno.h>
#include <string.h>
#include <fcntl.h>
#include <stdlib.h>
#include <sys/epoll.h>
#include <signal.h>
#include <sys/wait.h>
#include <sys/stat.h>
#include <vector>

using std::vector;
//描述一個子進程類，m_pid是目標子進程的PID,m_pipefd是父進程與子進程的通信管道
class process{
public:
    process():m_pid(-1){}
public:
    pid_t m_pid;
    int m_pipefd[2];//與父進程通信的管道描述符
};
//進程池類，定義爲模板類是爲了複用，模板參數爲處理邏輯任務的類
template<typename T>
class processpool{
private:
    //構造函數聲明爲私有，只能通過靜態create函數創建單例
    processpool(int listenfd,int process_number=8);//初始進程數位8
public:
    //使用靜態成員函數返回進程池指針，並採用單例模式，只允許有一個實例，這是正確處理信號的必要條件
    static processpool<T>* create(int listenfd,int process_number=8){
        if(!m_instance){
            m_instance=new processpool<T>(listenfd,process_number);
        }
        return m_instance;
    }
    ~processpool(){
        //delete m_instance;
        delete []m_sub_process;
    }
    //啓動進程池
    void run();
private:
    //void notify_parent_busy_ratio( int pipefd, M* manager );  //獲取目前連接數量，將其發送給父進程
    //int get_most_free_srv();  //找出最空閒的服務器
    //統一事件源，將信號事件與I/O事件一同處理
    void setup_sig_pipe();
    void run_child()//啓動子進程
    void run_parent();//啓動父進程
private:
    //進程池的最大進程數
    static const int MAX_PROCESS_NUMBER=16;
    //每個子進程最多能處理的客戶數量
    static const int USER_PER_PROCESS=65536；
    //epoll最多能處理的事件
    static const int MAX_EVENT_NUMBER=10000；
    //進程池中的進程總數
    int m_process_number;
    //子進程在池中的序號
    int m_inx;
    //每個進程都有一個epoll內核時間表
    int m_epollfd;
    //監聽socket
    int m_listenfd
    //子進程通過m_stop來決定是否停止運行
    int m_stop;
    //保存所有子進程的描述信息
    process* m_sub_process;
    //進程池靜態實例
    static processpool<T>* m_instance;
    int m_idx;
};
template<typename T>
processpool<T>* processpool<T>::m_instance=NULL;

//用於處理信號的管道,以實現統一時間源
static int sig_pipefd[2];

//將socket設置爲非阻塞
static int setnonblocking(int fd){
    int old_option = fcntl(fd,F_GETFL);
    int new_option = old_option|O_NONBLOCK;
    fcntl(fd,F_SETFL,new_option);
    return old_option;
}
//向epoll內核事件表中註冊fd上的事件
static void addfd(int epollfd,int fd){
    epoll_event event;
    event.data.fd=fd;
    event.events=EPOLLIN|EPOLLET;//ET模式，邊緣觸發
    epoll_ctl(epollfd,EPOLL_CTL_ADD,fd,&event);
    setnonblocking(fd);
}
//從epollfd標識的內核事件表中刪除fd上的註冊事件
static void removefd(int epollfd,int fd){
    epoll_ctl(epollfd,EPOLL_CTL_DEL,fd,0);
    close(fd);//記得關閉文件描述符
}
//信號處理函數
static void sig_handle(int sig){
    int save_errno=errno;
    int msg=sig;
    //將所得信號送給信號處理管道，統一處理
    send(sig_pipefd[1],(char *)&msg,1,0);
    errno=save_errno;
}
//添加信號,設置信號處理函數
static void addsig(int sig,void( handle )(int ),bool restart=true){
    struct sigaction sa;//設置信號函數的接口
    memset(&sa,'\0',sizeof(sa));
    sa.sa_handler = handler;//指明信號處理函數
    if( restart )
    {
        sa.sa_flags |= SA_RESTART;//sa_flags設置程序收到信號的行爲
    }
    sigfillset( &sa.sa_mask ); //在信號集函數中設置所有信號，sa_mask的作用是設置信號掩碼
    assert( sigaction( sig, &sa, NULL ) != -1 );
}
//進程池構造函數
template< typename T >
processpool< T >::processpool( int listenfd, int process_number )
    : m_listenfd( listenfd ), m_process_number( process_number ), m_idx( -1 ), m_stop( false )
{
    assert( ( process_number > 0 ) && ( process_number <= MAX_PROCESS_NUMBER ) );
    //分配保存所有子進程的描述信息的數組
    m_sub_process = new process[ process_number ];
    assert( m_sub_process );

    for( int i = 0; i < process_number; ++i )
    {
        //socketpair創建一對無名套接字，用於全雙工通信
        //這裏將每個子進程的m_pipefd連接起來
        int ret = socketpair( PF_UNIX, SOCK_STREAM, 0, m_sub_process[i].m_pipefd );
        assert( ret == 0 );
        //fork函數創建子進程
        m_sub_process[i].m_pid = fork();
        assert( m_sub_process[i].m_pid >= 0 );
        if( m_sub_process[i].m_pid > 0 )
        {
            //如果是父進程，關閉管道1，因爲1只能寫數據
            close( m_sub_process[i].m_pipefd[1] );
            continue;
        }
        else
        {
            //如果是子進程，關閉管道0，因爲0只能讀數據
            close( m_sub_process[i].m_pipefd[0] );
            m_idx = i;
            break;
        }
    }
}
//統一事件源，將信號事件與I/O事件一同處理
template< typename T >
void processpool< T >::setup_sig_pipe()
{
    m_epollfd = epoll_create( 5 );//size並不起作用
    assert( m_epollfd != -1 );
    //sig_pipefd是處理信號的管道
    int ret = socketpair( PF_UNIX, SOCK_STREAM, 0, sig_pipefd );
    assert( ret != -1 );
    //寫端口設置爲非阻塞
    setnonblocking( sig_pipefd[1] );
    //讀端口事件加入epoll事件表中
    addfd( m_epollfd, sig_pipefd[0] );
    //設置信號處理函數
    addsig( SIGCHLD, sig_handler );
    addsig( SIGTERM, sig_handler );
    addsig( SIGINT, sig_handler );
    addsig( SIGPIPE, SIG_IGN );
}
//父進程中m_idx值爲-1，子進程中m_idx>0，據此判斷運行父進程代碼或者子進程代碼
template<typename T>
void processpool<T>::run(){
    if(m_inx>-1){
        run_child();
        return ;
    }
    run_parent();
}
//子進程運行過程
//根據半同步/半異步模型，父進程用於對監聽的socket調用epoll_wait()添加事件
//子進程則需要監聽連接socket並調用epoll_wait()添加事件
template<typename T>
void processpool<T>::run_child(){
    //首先添加信號事件
    setup_sig_pipe();
    //每個子進程都通過m_idx找到在與父進程的通信管道
    int pipefd=m_sub_process[m_idx].m_pipefd[1];
    //子進程需要監聽管道描述符m_pipefd，因爲如果有新連接進來，父進程需要通過管道通知子進程accept連接
    addfd(m_epollfd,pipefd);

    epoll_event events[MAX_EVENT_NUMBER];
    T* users=new T[USER_PER_PROCESS];
    assert(users);
    int number = 0;
    int ret = -1;
    //如果沒用通知子進程停止，將一直運行下去
    while( ! m_stop )
    {
        //epoll_wait返回m_epollfd就緒事件的個數，裝在events數組中
        number = epoll_wait( m_epollfd, events, MAX_EVENT_NUMBER, -1 );
        if ( ( number < 0 ) && ( errno != EINTR ) )
        {
            printf( "epoll failure\n" );
            break;
        }

        for ( int i = 0; i < number; i++ )
        {
            //得到有就緒事件的描述符
            int sockfd = events[i].data.fd;
            //如果是父子進程的通信
            //EPOLLIN:只有當對端有數據寫入時纔會觸發,觸發一次後需要不斷讀取所有數據直到讀完EAGAIN爲止
            if( ( sockfd == pipefd ) && ( events[i].events & EPOLLIN ) )
            {
                int client = 0;
                //從父子之間的管道用recv讀取數據，將結果保存在client中
                ret = recv( sockfd, ( char* )&client, sizeof( client ), 0 );
                //不成功或者沒讀完
                if( ( ( ret < 0 ) && ( errno != EAGAIN ) ) || ret == 0 ) 
                {
                    continue;
                }
                else
                {
                    //成功讀取
                    struct sockaddr_in client_address;
                    socklen_t client_addrlength = sizeof(client_address);
                    //從監聽隊列中接受連接，m_listenfd是進程監聽的客戶連接
                    int connfd = accept(m_listenfd , (struct sockaddr*)&client_address, &client_addrlength);
                    //不成功
                    if ( connfd < 0 )
                    {
                        printf( "errno is: %d\n", errno );
                        continue;
                    }
                    //accept函數返回的connfd是一個新的連接，該socket唯一的標識了被接受的這個連接，可以用connfd進行通信了
                    //註冊事件
                    addfd( m_epollfd, connfd );
                    //模板類T必須提供一個初始化函數init來初始化一個客戶連接，順便我們直接使用connfd來索引一個處理對象，加速程序
                    users[connfd].init( m_epollfd, connfd, client_address );
                }
            }
            //如果接受到的是信號而不是連接請求
            else if( ( sockfd == sig_pipefd[0] ) && ( events[i].events & EPOLLIN ) )
            {
                int sig;
                char signals[1024];
                //TCP的recv接受sig_pipefd[0]的內容，保存在signals中
                ret = recv( sig_pipefd[0], signals, sizeof( signals ), 0 );
                if( ret <= 0 )
                {
                    continue;
                }
                else
                {
                    
                    for( int i = 0; i < ret; ++i )
                    {
                        //判斷信號類型，使用不同的信號處理方式
                        switch( signals[i] )
                        {
                            //當子進程退出時，會向父進程發送SIGCHLD信號,父進程在沒有收到這個信號的情況下需要等，否則子進程會變成殭屍進程
                            case SIGCHLD:
                            {
                                pid_t pid;
                                int stat;
                                //表示對任意進程進行等待，以非阻塞方式加輪循，應對同一時間多個子進程退出
                                while ( ( pid = waitpid( -1, &stat, WNOHANG ) ) > 0 )
                                {
                                    continue;
                                }
                                break;
                            }
                            case SIGTERM:
                            //進程退出
                            case SIGINT:
                            {
                                m_stop = true;
                                break;
                            }
                            default:
                            {
                                break;
                            }
                        }
                    }
                }
            }
            //如果是其他處理數據，那必然是客戶端請求到來，調用邏輯對象的process方法來處理
            //前面說到了，所有邏輯單元的事情都交給模板類來處理，實現模板類很重要
            else if( events[i].events & EPOLLIN )
            {
                 users[sockfd].process();
            }
            else
            {
                continue;
            }
        }
    }

    delete [] users;
    users = NULL;
    close( pipefd );
    //close( m_listenfd );//對象由哪個函數創建，就應該由哪個函數銷燬
    close( m_epollfd );

}
//父進程需要完成的工作
template< typename T >
void processpool< T >::run_parent()
{   //同樣的，也需要統一事件源
    setup_sig_pipe();
    
    //向epoll事件表註冊m_listenfd的事件
    addfd( m_epollfd, m_listenfd );
    //epoll事件
    epoll_event events[ MAX_EVENT_NUMBER ];
    //子進程個數
    int sub_process_counter = 0;
    int new_conn = 1;
    int number = 0;
    int ret = -1;

    while( ! m_stop )
    {
        //內核事件表中的就緒事件
        number = epoll_wait( m_epollfd, events, MAX_EVENT_NUMBER, -1 );
        if ( ( number < 0 ) && ( errno != EINTR ) )
        {
            printf( "epoll failure\n" );
            break;
        }

        for ( int i = 0; i < number; i++ )
        {
            //得到有就緒事件的描述符
            int sockfd = events[i].data.fd;
            //如果是父進程監聽的socket有新客戶到來，就採用Round Robin方式將其分配給子進程處理
            if( sockfd == m_listenfd )
            {
                //Round Robin，輪詢方式選擇處理他的子進程
                int i =  sub_process_counter;
                do
                {
                    if( m_sub_process[i].m_pid != -1 )
                    {
                        break;
                    }
                    i = (i+1)%m_process_number;
                }
                while( i != sub_process_counter );
                //如果子進程不存在
                if( m_sub_process[i].m_pid == -1 )
                {
                    m_stop = true;
                    break;
                }
                
                sub_process_counter = (i+1)%m_process_number;
                //send( m_sub_process[sub_process_counter++].m_pipefd[0], ( char* )&new_conn, sizeof( new_conn ), 0 );
                //找好子進程之後，需要將這個請求事件通知給子進程，使用父子進程的管道即可
                send( m_sub_process[i].m_pipefd[0], ( char* )&new_conn, sizeof( new_conn ), 0 );
                printf( "send request to child %d\n", i );
                //sub_process_counter %= m_process_number;
            }
            //如果是信號,父進程需要處理之
            else if( ( sockfd == sig_pipefd[0] ) && ( events[i].events & EPOLLIN ) )
            {
                int sig;
                char signals[1024];
                ret = recv( sig_pipefd[0], signals, sizeof( signals ), 0 );
                if( ret <= 0 )
                {
                    continue;
                }
                else
                {
                    for( int i = 0; i < ret; ++i )
                    {
                        switch( signals[i] )
                        {
                            //如果有子進程退出
                            case SIGCHLD:
                            {
                                pid_t pid;
                                int stat;
                                while ( ( pid = waitpid( -1, &stat, WNOHANG ) ) > 0 )
                                {
                                    for( int i = 0; i < m_process_number; ++i )
                                    {
                                        //如果進程池中第i個子進程退出了，則主進程關閉相應的通信管道，並設置相應的m_pid爲-1，標記該子進程已經退出。
                                        if( m_sub_process[i].m_pid == pid )
                                        {
                                            printf( "child %d join\n", i );
                                            close( m_sub_process[i].m_pipefd[0] );
                                            m_sub_process[i].m_pid = -1;
                                        }
                                    }
                                }
                                //如果所有子進程都退出，父進程纔可以退出，防止殭屍進程造成內存泄漏
                                m_stop = true;
                                for( int i = 0; i < m_process_number; ++i )
                                {
                                    if( m_sub_process[i].m_pid != -1 )
                                    {
                                        m_stop = false;
                                    }
                                }
                                break;
                            }
                            case SIGTERM:
                            //停止命令，也是需要停止所有子進程之後才能停止父進程
                            case SIGINT:
                            {
                                printf( "kill all the clild now\n" );
                                for( int i = 0; i < m_process_number; ++i )
                                {
                                    int pid = m_sub_process[i].m_pid;
                                    if( pid != -1 )
                                    {
                                        kill( pid, SIGTERM );//kill命令其實是一個發送信號的函數
                                    }
                                }
                                break;
                            }
                            default:
                            {
                                break;
                            }
                        }
                    }
                }
            }
            else
            {
                continue;
            }
        }
    }

    //close( m_listenfd );
    close( m_epollfd );
}