多程式、共享記憶體的網路聊天室

好久沒寫網路聊天室了，去年暑假可以說寫了一暑假，最近複習這些，又因為我一直偏向於多執行緒，就用多程式複習一下。

下面給出昨天寫的基於多程式、共享記憶體的網路聊天室程式碼。每個程式負責一個連線，多個程式之間僅共享讀，不共享寫，因此無需訊號量來同步。分配的一段記憶體中，以陣列的方式，分配給每個client一段buffer，每個clilent對應的buffer的索引就是connfd。當一個子程式收到客戶端資料後，通過每客戶端管道傳送自己的pid給主程式，主程式通知除了該子程式的其他程式將該片記憶體寫好的資料轉發給其他客戶端（sub_proess[pid]=connd）。

程式碼如下：

#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 <stdlib.h>
#include <sys/epoll.h>
#include <signal.h>
#include <sys/wait.h>
#include <sys/mman.h>
#include <sys/stat.h>
#include <fcntl.h>

const int USER_LIMIT = 3;
const int BUFFER_SIZE = 1024;
const int FD_LIMIT = 65545;
const int MAX_EVENT_NUMBER = 1024;
const int PROCESS_LIMIT = 65536;

//封裝每個客戶端連線資料
struct client_data {
  sockaddr_in address;       
    int         connfd;
    pid_t       pid;       //負責該客戶端子程式的pid
    int         pipefd[2];   //每個子程式pipe
};

static const char* shm_name = "/my_shm";   //共享記憶體的名字
int sig_pipefd[2];  //用來統一事件源
int epollfd;
int listenfd;
int shmfd;  

char* share_mem = NULL;  //共享記憶體起始地址
//客戶端連線陣列，程式用客戶連線的編號來索引這個陣列，即可取得相關的客戶連線資料
client_data* users = NULL;   
//子程式和客戶連線的關係對映表，用子程式的pid來索引這個陣列，即可取得該程式處理的客戶連線的編號
int* sub_process = 0;
int user_count = 0; //客戶連線下標，這個名字有點誤導，總之user_count>=USER_LIMIT即連線過多
bool stop_child = false;   //停止一個子程式，這個是全部變數，每個子程式都有自己拷貝的一份

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;
}

void addfd(int epfd, int fd)
{
    epoll_event event;
    event.data.fd = fd;
    event.events = EPOLLIN | EPOLLET;
    epoll_ctl(epfd, EPOLL_CTL_ADD, fd, &event);
    setnonblocking(fd);
}

void sig_handler(int sig)
{
  int save_errno = errno;
    int msg = sig;
    send(sig_pipefd[1], (char*)&msg, 1, 0);
    errno = save_errno;
}

void addsig(int sig, void(*handler)(int), bool restart = true)
{
    struct sigaction sa;
    memset(&sa, '\0', sizeof(sa));
    sa.sa_handler = handler;
    if(restart)
        sa.sa_flags |= SA_RESTART;
    sigfillset(&sa.sa_mask);
    assert(sigaction(sig, &sa, NULL) != -1);
}

void del_resource()
{
   close(sig_pipefd[0]);
    close(sig_pipefd[1]);
    close(listenfd);
    close(epollfd);
    shm_unlink(shm_name);
}

//子程式的訊號處理函式，停止一個子程式
void child_term_handler(int sig)
{
    stop_child = true;
}

//子程式執行的函式，引數inx指出該子程式處理的客戶連線的編號，users是儲存所有客戶連線資料的陣列，引數share_mem指出共享記憶體的起始地址
int run_child(int idx, client_data* users, char* share_mem)
{
    epoll_event events[MAX_EVENT_NUMBER];
    //每個子程式使用I/O服用同時監聽客戶連線socket和與父程式通訊的pipe描述符
    int child_epollfd = epoll_create(5);
    assert(child_epollfd != -1);
    int connfd = users[idx].connfd;
    addfd(child_epollfd, connfd);

    int pipefd = users[idx].pipefd[1];
    addfd(child_epollfd, pipefd);
    int ret;

    //子程式需要設定自己的訊號處理函式，因為fork會繼承父程式訊號處理函式
    addsig(SIGTERM, child_term_handler, false);

    while(!stop_child){
        int number = epoll_wait(child_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 == connfd && (events[i].events & EPOLLIN)){
                //清零該客戶對應的緩衝區
                memset(share_mem+idx*BUFFER_SIZE, '\0', BUFFER_SIZE);
                //將客戶資料讀取到對應的讀快取中，該讀快取是共享記憶體的一段，它開始於idx*BUFFER_SIZE處，長度為BUFFER_SIZE位元組，因此每個客戶連線是共享的
                ret = recv(connfd, share_mem+idx*BUFFER_SIZE, BUFFER_SIZE-1, 0);  //留一個位元組為'\0'間隔
                if(ret < 0){
       if(errno != EAGAIN)
                        stop_child = true;
                }
                else if(ret == 0)
                    stop_child = true;
                else
                    //成功讀取客戶資料後就通知主程式，讓主程式吩咐其他程式轉發
                    send(pipefd, (char*)&idx, sizeof(idx), 0);
            }
            //主程式通過管道通知本程式需要轉發第client個客戶端的資料到本程式負責的客戶
            else if(sockfd == pipefd && (events[i].events & EPOLLIN)){
                int client = 0;
                //接受主程式發來的資料，即客戶的編號，用來索引buffer
                ret = recv(sockfd, (char *)&client, sizeof(client), 0);
                if(ret < 0){
                    if(errno != EAGAIN)
                        stop_child = true;
                }
                else if(ret == 0)
                    stop_child = true;
                else
                    //轉發給自己的客戶
                    send(connfd, share_mem+client*BUFFER_SIZE, BUFFER_SIZE, 0);
            }
     else
                continue;
        }
    }

    close(connfd);
    close(pipefd);
    close(child_epollfd);
    return 0;
}

int main(int argc, char** argv)
{
    if( argc <= 2 )
    {
        printf( "usage: %s ip_address port_number\n", basename( argv[0] ) );
        return 1;
    }
    const char* ip = argv[1];
 int port = atoi( argv[2] );

    int ret = 0;
    struct sockaddr_in address;
    bzero(&address, sizeof(address));
    address.sin_family = AF_INET;
    inet_pton(AF_INET, ip, &address.sin_addr);
    address.sin_port = htons(port);

    int listenfd = socket(PF_INET, SOCK_STREAM, 0);
    assert(listenfd >= 0);

    int on = 1;
    ret = setsockopt(listenfd, SOL_SOCKET, SO_REUSEADDR, &on, sizeof(on));
    assert(ret != -1);

    ret = bind(listenfd, (struct sockaddr*)&address, sizeof(address));
    assert(ret != -1);

    ret = listen(listenfd, 5);
    assert(ret != -1);

/////////////////////////////////////////////////////////////
    user_count = 0;
    users = new client_data[USER_LIMIT];
    sub_process = new int [PROCESS_LIMIT];
    for(int i=0; i<PROCESS_LIMIT; ++i)
        sub_process[i] = -1;
////////////////////////////////////////////////////////////

    epoll_event events[MAX_EVENT_NUMBER];
    epollfd = epoll_create(5);
    assert(epollfd != -1);
    addfd(epollfd, listenfd);

    //socketpair是全雙工的，所以父子程式通訊無需向pipe一樣需要兩個pipe[2]
    //fork完畢socketpair可以雙向通訊
    ret = socketpair(PF_UNIX, SOCK_STREAM, 0, sig_pipefd);
    assert(ret != -1);
    setnonblocking( sig_pipefd[1] );
    addfd(epollfd, sig_pipefd[0]);

    // add all the interesting signals here
    addsig(SIGCHLD, sig_handler);
    addsig(SIGTERM, sig_handler);
    addsig(SIGINT, sig_handler);
  addsig(SIGPIPE, SIG_IGN);
    bool stop_server = false;
    bool terminate = false;

///////////////////////////////////////////////////////////////
    //建立共享記憶體，作為所有客戶連線的讀快取
    shmfd = shm_open(shm_name, O_CREAT | O_RDWR, 0666);
    assert(shmfd != -1);
    //清空且resize檔案大小為USER_LIMIT*BUFFER_SIZE
    ret = ftruncate(shmfd, USER_LIMIT*BUFFER_SIZE);
    assert(ret != -1);
    //通過上面生成的一定大小的檔案來使用mmap對映共享記憶體
    //這是共享記憶體的一種方式，另外一種使用SystemV的shmat
    share_mem = (char *)mmap(NULL, USER_LIMIT*BUFFER_SIZE, PROT_WRITE | PROT_READ,
                             MAP_SHARED, shmfd, 0);
    assert(share_mem != MAP_FAILED);
    close(shmfd);   //close shmfd is ok
//////////////////////////////////////////////////////////////

    while(!stop_server){
        int number = epoll_wait(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 == listenfd){
                struct sockaddr_in client_address;
                socklen_t len = sizeof(client_address);
                int connfd = accept(listenfd, (struct sockaddr*)&client_address, &len);
                if(connfd < 0){
                    printf("errno is: %d\n", errno);
                    continue;
                }

                if(user_count >= USER_LIMIT){   //limit
                    const char* info = "too many users\n";
                    printf("%s", info);
                    send(connfd, info, strlen(info), 0);
                    close(connfd);
                    continue;
                }
                //儲存第user_count個客戶連線的資料
                users[user_count].address = client_address;
                users[user_count].connfd = connfd;
                //在子程式和父程式間建立管道，以傳遞必要的資料
                ret = socketpair(PF_UNIX, SOCK_STREAM, 0, users[user_count].pipefd);
                assert(ret != -1);

                pid_t pid = fork();
                if(pid < 0){
                    close(connfd);
                    continue;     //!!!!!!!
                }
                else if(pid == 0){  //in child
                    close(epollfd);
                    close(listenfd);
                    close(users[user_count].pipefd[0]);  //子程式關掉一端，子程式給父程式發資料使用pipefd[1]
                    close(sig_pipefd[0]);
                    close(sig_pipefd[1]);
                    run_child(user_count, users, share_mem);
                    munmap((void*)share_mem, USER_LIMIT*BUFFER_SIZE);
                    exit(0);
                }
                else{
                    close(connfd);
                    close(users[user_count].pipefd[1]); //同理
                    addfd(epollfd, users[user_count].pipefd[0]);
                    //記錄新的客戶連線在陣列users中的索引值，建立程式pid和索引值的對映關係 
                    users[user_count].pid = pid;
                    sub_process[pid] = user_count;
                    user_count++;
                }
            }
            //handle signal
            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 == -1)
                    continue;
                else 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){
                                    //用子程式的pid取得被關閉客戶連線的編號
                                    int del_user = sub_process[pid];
                                    sub_process[pid] = -1;
                                    if(del_user < 0 || del_user > USER_LIMIT)
                                        continue;
                                    //清除資料
                                    epoll_ctl(epollfd, EPOLL_CTL_DEL, users[del_user].pipefd[0], 0);
                                    close(users[del_user].pipefd[0]);
                                    //用最後一個user替換該位置
                                    users[del_user] = users[--user_count];
                                    sub_process[users[del_user].pid] = del_user;   //修正sub_process對應的值，也就是修正最後一個客戶端pid對應的客戶編號
                                }
                                if(terminate && user_count == 0)
                                    stop_server = true;
                                break;
                            }
                            case SIGTERM:
                            case SIGINT:  //結束伺服器程式
                            {
                                printf("kill all the child new\n");
                                if(user_count == 0){
                                    stop_server = true;
                                    break;
                                }

                                for(int i=0; i<user_count; ++i){
                                    int pid = users[i].pid;
         kill(pid, SIGTERM);  //kill每個子程式
                                }
                                terminate = true;
                                break;
                            }
                            default:
                                break;
                        }
                    }
                }
            }
            //某個子程式收到資料，向父程式通知
            else if(events[i].events & EPOLLIN){
                int child = 0;
                //讀取管道資料，收到的資料時child變數記錄了哪個客戶連線有資料到達
                ret =recv(sockfd, (char*)&child, sizeof(child), 0);
                if(ret == -1)
                    continue;
                else if(ret == 0)
                    continue;
                else{
                    //向除負責第child個客戶的子程式之外的子程式傳送訊息，通知他們有客戶資料要寫
                    for(int j=0; j<user_count; ++j){
                        if(users[j].pipefd[0] != sockfd){
  printf("send data to child accross pipe\n");
                            send(users[j].pipefd[0], (char*)&child, sizeof(child), 0);
                        }
                    }
                }
            }
        }
    }
    del_resource();
    return 0;
}