这是游双大大的《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 );
}