基于半同步半异步模式的进程池

基于半同步/半异步模式的进程池

半同步/半异步模式：

进程池流程图：

代码实现：

// processpool.h
// Created by ldk on 9/19/25.
//

#ifndef PROCESSPOOL_H
#define PROCESSPOOL_H

#include <sys/types.h>
#include <sys/socket.h>
#include <sys/epoll.h>
#include <netinet/in.h>
#include <arpa/inet.h>
#include <cassert>
#include <cstdio>
#include <unistd.h>
#include <error.h>
#include <cstring>
#include <fcntl.h>
#include <cstdlib>
#include <csignal>
#include <sys/wait.h>
#include <sys/stat.h>
#include <cerrno>

class process {
public:
    process() : m_pid(-1) {
    }

public:
    pid_t m_pid;
    int m_pipefd[2]; /* 父，子进程通信用的管道 */
};

/* 进程池类，需要实现单例模式，模板参数T是处理逻辑任务的类 */
template<typename T>
class processpool {
private:
    processpool(int listenfd, int process_number = 8);

public:
    static processpool<T> *creat(int listenfd, int process_number = 8) {
        if (!m_instance) {
            m_instance = new processpool<T>(listenfd, process_number);
        }
        return m_instance;
    }

    ~processpool() {
        delete[] m_sub_process;
    }

    /* 启动进程池 */
    void run();

private:
    void setup_sig_pipe();

    void run_parent();

    void run_child();

private:
    static const int MAX_PROCESS_NUMBER; /* 进程池允许的最大子进程的数量 */
    static const int USER_PRE_PROCESS = 65536; /* 每个子进程最多能处理的客户数量 */
    static const int MAX_EVENT_NUMBER = 10000; /* epoll最多能处理的事件数 */
    int m_process_number; /* 进程中的进程总数 */
    int m_idx; /* 子进程在池中的序号，从0开始 */
    int m_epollfd; /* 每个进程都有一个epoll内核事件表，用m_epollfd表示 */
    int m_listenfd; /* 监听socket */
    int m_stop; /* 子进程通过m_stop来决定是否运行 */
    process *m_sub_process; /* 保存所有子进程的描述信息 */
    static processpool<T> *m_instance; /* 进程池静态实例 */
};

template<typename T>
processpool<T> *processpool<T>::m_instance = nullptr;

/* 用于处理信号的管道，以实现统一事件源。
 * 后面称之为信号管道
 * sig_pipefd[0]用于读取，sig_pipefd[1]用于写入*/
static int sig_pipefd[2];

/* 设置文件描述符fd为非阻塞 */
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;
}

/* 将fd添加到内核事件表epollfd中 */
static void addfd(const int epollfd, const int fd) {
    epoll_event event{};
    event.data.fd = fd;
    event.events = EPOLLIN | EPOLLET;
    epoll_ctl(epollfd, EPOLL_CTL_ADD, fd, 0);
    setnonblocking(fd);
}

/* 从epollfd标识的epoll内核事件表中删除fd上的所有注册事件 */
static void removefd(int epollfd, int fd) {
    epoll_ctl(epollfd, EPOLL_CTL_DEL, fd, nullptr);
    close(fd);
}

/* 信号处理函数 */
static void sig_handler(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 (handler)(int), bool restart = true) {
    struct sigaction sa = {};
    sa.sa_handler = handler;
    if (restart) {
        sa.sa_flags |= SA_RESTART;
    }
    sigfillset(&sa.sa_mask);
    assert(sigaction(sig, &sa, nullptr) != -1);
}

/* 进程池构造函数，参数listenfd是监听socket，必须在创建进程池之前被创建，否则子进程无法直接引用它。 */
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 <= this->MAX_PROCESS_NUMBER));

    m_sub_process = new process[process_number];
    assert(m_sub_process);

    /* 创建process_number个子进程，并建立它们和父进程之前的管道 */
    for (int i = 0; i < process_number; ++i) {
        const int ret = socketpair(PF_UNIX, SOCK_STREAM, 0, m_sub_process[i].m_pipefd);
        assert(ret == 0); /* socketpair执行成功返回0，失败返回-1 */

        m_sub_process[i].m_pid = fork();
        assert(m_sub_process[i].m_pid >= 0);
        if (m_sub_process[i].m_pid > 0) {
            close(m_sub_process[i].m_pipefd[1]); // 父进程关闭m_pipefd[1](读取端)
            continue;
        } else {
            close(m_sub_process[i].m_pipefd[0]); // 子进程关闭m_pipefd[0](写入端)
            m_idx = i;
            break; // 子进程跳出循环，避免子进程继续fork()
        }
    }
}

/* 统一事件源 */
template<typename T>
void processpool<T>::setup_sig_pipe() {
    /* 创建epoll事件监听表 */
    m_epollfd = epoll_create(5);
    assert(m_epollfd != -1);

    /* 创建信号管道 */
    const int ret = socketpair(PF_UNIX, SOCK_STREAM, 0, sig_pipefd);
    assert(ret != -1);

    setnonblocking(sig_pipefd[1]);
    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_idx != -1) {
        run_child();
        return;
    }
    run_parent();
}

template<typename T>
void processpool<T>::run_child() {
    setup_sig_pipe();

    /* 每个子进程都通过其在进程池中的序号值m_idx找到父进程通信的管道 */
    const int pipefd = m_sub_process[m_idx].m_pipefd[1];
    /* 子进程需要监听管道文件描述符sockfd，因为父进程将通过它来通知子进程accept新连接 */
    addfd(m_epollfd, pipefd);

    epoll_event events[MAX_EVENT_NUMBER];
    T *users = new T[USER_PRE_PROCESS];
    assert(users);
    int number = 0;
    int ret = 0;

    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;
            if ((sockfd == pipefd) && events[i].events & EPOLLIN) {
                int client = 0;
                /* 从父子进程之间的管道读取数据，并将结果保存在变量client中。
                 * 如果读取成功，表示有新客户连接到来 */
                ret = recv(sockfd, (char *) &client, sizeof(client), 0);
                if (((ret < 0) && (errno != EAGAIN)) || ret == 0) {
                    continue;
                } else {
                    sockaddr_in client_address;
                    socklen_t client_addrlength = sizeof(client_address);
                    int connfd = accept(m_listenfd, reinterpret_cast<sockaddr *>(&client_address), &client_addrlength);
                    if (connfd < 0) {
                        printf("errno is: %d\n", errno);
                    }
                    addfd(m_epollfd, connfd);
                    /* 模板类T必须实现init方法，以初始化一个客户端连接。
                     * 我们直接使用connfd来索引逻辑处理对象(T类型的对象), 以提高程序效率 */
                    users[connfd].init(m_epollfd, connfd, client_address);
                }
            }
            /* 下面处理子进程收到的信号 */
            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 j = 0; j < ret; ++j) {
                        switch (signals[j]) {
                            case SIGCHLD: {
                                pid_t pid;
                                int stat;
                                // 循环调用waitpid等待子进程结束
                                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(); // 模板类T中应该实现的process方法：处理客户端请求
            } else {
                continue;
            }
        }
    }
    delete[] users;
    users = nullptr;
    close(pipefd);
    /* m_listenfd不应该在这里关闭。应该由m_listenfd的创建者关闭这个文件描述符。
     * 即：对象由哪个函数创建，就应该由哪个函数销毁 */
    // close(m_listenfd);
    close(m_epollfd);
}

template<typename T>
void processpool<T>::run_parent() {
    setup_sig_pipe();

    /* 父进程监听m_listenfd */
    addfd(m_epollfd, m_listenfd);

    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;
            if (sockfd == m_listenfd) {
                /* 如果有新连接到来，就采用Round Robin方式将其分配给一个子进程处理 */
                int m = sub_process_counter;
                do {
                    if (m_sub_process[m].m_pid != -1) {
                        break;
                    }
                    m = (m + 1) % m_process_number;
                } while (m != sub_process_counter);
                if (m_sub_process[m].m_pid == -1) {
                    m_stop = true;
                    break;
                }
                sub_process_counter = (m + 1) % m_process_number;
                send(m_sub_process[m].m_pipefd[0], (char *) &new_conn, sizeof(new_conn), 0);
                printf("send request to child %d\n", m);
            }
            /* 处理父进程接收到的信号 */
            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 j = 0; j < ret; ++j) {
                        switch (signals[j]) {
                            case SIGCHLD: {
                                pid_t pid;
                                int stat;
                                // 循环回收所有已经终止的子进程
                                while ((pid = waitpid(-1, &stat, WNOHANG)) > 0) {
                                    for (int k = 0; k < m_process_number; ++k) {
                                        /* 如果进程池中第i个子进程退出了，则主进程关闭对应的通信管道，
                                         * 并设置相应的m_pid为-1, 以标记该子进程已经退出 */
                                        if (m_sub_process[k].m_pid == pid) {
                                            printf("child %d join\n", k);
                                            close(m_sub_process[k].m_pipefd[0]);
                                            m_sub_process[k].m_pid = -1;
                                        }
                                    }
                                }
                                /* 如果所有子进程都已经退出了，则父进程也退出 */
                                m_stop = true;
                                for (int k = 0; k < m_process_number; ++k) {
                                    if (m_sub_process[k].m_pid != -1) {
                                        m_stop = false;
                                    }
                                }
                                break;
                            }
                            case SIGTERM:
                            case SIGINT: {
                                /* 如果父进程接收到终止信号，那么就杀死所有子进程，并等待它们全部结束。
                                 * 当然，通知子进程结束的更好方法是向父、子进程之间的通信管道发送特殊数据。 */
                                printf("kill all the child now\n");
                                for (int k = 0; k < m_process_number; ++k) {
                                    int pid = m_sub_process[k].m_pid;
                                    if (pid != -1) {
                                        kill(pid, SIGTERM);
                                    }
                                }
                                break;
                            }
                            default: {
                                break;
                            }
                        }
                    }
                }
            } else {
                continue;
            }
        }
    }
    // close(m_listenfd); /* 应该由创建者关闭这个文件描述符 */
    close(m_epollfd);
}

#endif // PROCESSPOOL_H