Event Poll (epoll) で複数のファイルディスクリプタを監視する

  1#include <stdio.h>
  2#include <stdlib.h>
  3#include <unistd.h>
  4#include <string.h>
  5#include <sys/epoll.h>
  6#include <arpa/inet.h>
  7
  8#define MAX_EVENTS 10      // 最大同時接続数
  9#define PORT 8080          // サーバーが待ち受けるポート番号
 10#define BUFFER_SIZE 1024   // バッファのサイズ（受信データを格納するため）
 11
 12int main() {
 13    int listen_fd, conn_fd, soval;
 14    struct sockaddr_in serv_addr, client_addr;
 15    socklen_t client_len = sizeof(client_addr);
 16
 17    // epoll_create: epollインスタンスの作成
 18    //   第１引数：サイズを指定する。通常、epollインスタンスの内部で使用されるデータ構造の初期サイズを示す。
 19    //             しかし、ほとんどの実装では、この引数は実際には無視され、1を指定することで
 20    //             必要な内部データ構造が適切に初期化される。
 21    //   戻り値　：イベント待機のためのデータ構造（epollインスタンス）を生成し、
 22    //             その識別子（ファイルディスクリプタ）を返す。
 23    int epfd = epoll_create(1);
 24    if (epfd == -1) {
 25        perror("epoll_create");  // エラーメッセージを出力
 26        return 1;  // エラー終了
 27    }
 28
 29    // socket: ソケットの作成
 30    //   第１引数：AF_INET(IPv4アドレスファミリー)を指定。
 31    //             これによりIPv4アドレスで通信するソケットが作成される。
 32    //   第２引数：SOCK_STREAM(ストリーム型ソケット)を指定。
 33    //             これはTCP接続を使用するソケットで、信頼性のあるデータストリームを提供する。
 34    //   第３引数：プロトコルを指定。0を指定することで、指定されたソケットタイプ（SOCK_STREAM）に最適な
 35    //             プロトコルが自動的に選択される。通常はTCPプロトコルが選ばれる。
 36    //   戻り値　：新しく作成されたソケットのファイルディスクリプタ
 37    listen_fd = socket(AF_INET, SOCK_STREAM, 0);
 38    if (listen_fd == -1) {
 39        perror("socket");
 40        return 1;
 41    }
 42
 43    // setsockopt: ソケットのオプション設定。ここではアドレスの再利用を有効にする。
 44    //   第１引数： socket関数で作成したソケットのファイルディスクリプタ。
 45    //   第２引数： SOL_SOCKET(ソケットレベルでのオプションを指定するための定数)を指定。
 46    //              これにより、ソケットの基本的な設定（例: 再利用可能なアドレス）を変更することができる。
 47    //   第３引数： SO_REUSEADDR(ソケットのアドレス再利用を許可するオプション)を指定。
 48    //              これにより、ソケットが閉じられた後すぐに同じポート番号を再利用することが可能になる。
 49    //              再起動時のソケットバインディングの問題を回避するために使用される。
 50    //   第４引数： 設定するオプションの値を指すポインタ。
 51    //              1は、SO_REUSEADDRオプションを有効にすることを意味する。
 52    //   第５引数： sovalのサイズをバイト単位で指定。
 53    //              これによりsetsockopt関数が正しいサイズのデータを処理できるようになる。
 54    soval = 1;
 55    if (setsockopt(listen_fd, SOL_SOCKET, SO_REUSEADDR, &soval, sizeof(soval)) == -1) {
 56        perror("setsockopt");
 57        return 1;
 58    }
 59
 60    // サーバーアドレス構造体の設定
 61    serv_addr.sin_family = AF_INET;  // インターネットアドレスファミリー
 62    serv_addr.sin_addr.s_addr = INADDR_ANY;  // 任意のIPアドレスからの接続を受け入れる
 63    serv_addr.sin_port = htons(PORT);  // ポート番号の設定（ネットワークバイト順）
 64
 65    // bind: ソケットにローカルアドレスとポートを関連付ける。
 66    //       これにより、ソケットが指定されたアドレスとポートでリッスンを開始できるようになる。
 67    //   第１引数：アドレスを関連付ける対象のソケットのファイルディスクリプタ。
 68    //             事前に socket 関数で作成されたソケットを指定する。
 69    //   第２引数：バインドするアドレスとポートの情報を格納した構造体へのポインタ。
 70    //   第３引数：バインドするアドレス構造体のバイト数。
 71    if (bind(listen_fd, (struct sockaddr*)&serv_addr, sizeof(serv_addr)) == -1) {
 72        perror("bind");
 73        return 1;
 74    }
 75
 76    // listen: 接続要求の待ち受けを開始（リスニング状態にする）
 77    //   第１引数：クライアントからの接続要求を受け入れるためにリスニング状態にするソケット。
 78    //             bind 関数でアドレスとポートにバインドされたソケット。
 79    //   第２引数：待機キューのサイズ。ソケットに対して待機する接続要求の最大数を指定する。
 80    //             キューがいっぱいになると、新しい接続要求は拒否されるか、接続の試行が失敗する。
 81    if (listen(listen_fd, 5) == -1) {
 82        perror("listen");
 83        return 1;
 84    }
 85
 86    // epollインスタンスにリスニングソケットを追加
 87    struct epoll_event ev;
 88    ev.events = EPOLLIN;  // 読み取りイベントを監視
 89    ev.data.fd = listen_fd;  // イベントに関連付けるファイルディスクリプタ
 90
 91    // epoll_ctl: epollインスタンスに対して、ファイルディスクリプタに関連する操作を行う
 92    //   第１引数：epoll_create関数によって作成されたepollインスタンスのファイルディスクリプタ。
 93    //             イベントの監視対象を管理するためのepollインスタンスを識別する。
 94    //   第２引数：epoll_ctlに渡す操作タイプを指定する。
 95    //             EPOLL_CTL_ADDは、新しいファイルディスクリプタをepollインスタンスに追加し、
 96    //             そのファイルディスクリプタに対するイベントの監視を開始することを示す。
 97    //             その他の操作には、EPOLL_CTL_MOD（既存のファイルディスクリプタの設定変更）や
 98    //             EPOLL_CTL_DEL（ファイルディスクリプタの削除）がある。
 99    //   第３引数：epoll_ctlで操作する対象のファイルディスクリプタ。
100    //             ここでは、リスニングソケットのファイルディスクリプタが指定している。
101    //             EPOLL_CTL_ADD操作を使って、このソケットをepollインスタンスに追加し、
102    //             イベントの監視対象とする。
103    //   第４引数：監視対象のファイルディスクリプタとそのイベント設定を格納したstruct epoll_event型の
104    //             構造体へのポインタ。struct epoll_eventには次のフィールドがある。
105    //               events: 監視するイベントの種類を指定。例えば、EPOLLINは読み取り可能な状態、
106    //                     EPOLLOUTは書き込み可能な状態を示す。
107    //               data: イベントに関連するデータ（ここではファイルディスクリプタ）を格納する。
108    //                     例えば、data.fdにリスニングソケットのファイルディスクリプタが格納して、
109    //                     どのソケットでイベントが発生したかを識別する。
110    if (epoll_ctl(epfd, EPOLL_CTL_ADD, listen_fd, &ev) == -1) {
111        perror("epoll_ctl");
112        return 1;
113    }
114
115    printf("Server listening on port %d\n", PORT);
116
117    struct epoll_event events[MAX_EVENTS];  // 発生したイベントを格納する配列
118    while (1) {
119        // epoll_wait: イベントが発生するまで待機
120        //   第１引数：epoll_create関数で作成したepollインスタンスのファイルディスクリプタ。
121        //             epoll_ctl関数で設定した監視対象のソケットイベントを待機するために使用される。
122        //   第２引数：発生したイベント情報(例えばどのファイルディスクリプタでイベントが発生したか)を格納する配列。
123        //   第３引数：events配列のサイズ。epoll_wait関数は、最大でMAX_EVENTS個のイベントを配列に格納する。
124        //             これにより、一度のepoll_wait呼び出しで処理する最大のイベント数を指定します。
125        //   第４引数：タイムアウトの指定。-1を指定することで無限に待機する。
126        //             つまり、イベントが発生するまで処理をブロックし続ける。
127        //             他の値を指定することで、指定したミリ秒数だけ待機することも可能。
128        //             0を指定すると、即時で戻される。
129        //   戻り値　：events配列に格納された発生したイベントの数
130        int nfds = epoll_wait(epfd, events, MAX_EVENTS, -1);
131        if (nfds == -1) {
132            perror("epoll_wait");
133            return 1;
134        }
135
136        // 発生したイベントを処理
137        for (int i = 0; i < nfds; ++i) {
138            if (events[i].data.fd == listen_fd) {
139                // 新しい接続要求がある場合
140
141                // accept: 接続要求を待機しているリスニングソケットに対する接続要求を受け入れ、
142                //         新しい接続用のソケットを作成する。
143                //   第１引数：接続要求を受け入れるため、接続要求を待機しているソケットのファイルディスクリプタ。
144                //   第２引数：接続要求を受け入れたクライアントのアドレス情報を格納するための構造体へのポインタ。
145                //             この構造体にクライアントのIPアドレスやポート番号が設定される。
146                //   第３引数：client_addr構造体のサイズを示す変数へのポインタ。
147                //             接続要求が受け入れられると、accept関数がこの変数に実際のアドレスサイズを設定する。
148                //             最初は、この変数にsizeof(client_addr)の値を設定しておく。
149                //             関数呼び出し後にこの変数には、実際に使われたサイズが格納される。
150                //   戻り値　：新しく作成された接続用ソケットのファイルディスクリプタを返す。
151                conn_fd = accept(listen_fd, (struct sockaddr*)&client_addr, &client_len);
152                if (conn_fd == -1) {
153                    perror("accept");
154                    continue;  // 次のイベント処理に進む
155                }
156                printf("Accepted connection from %s:%d\n",
157                       inet_ntoa(client_addr.sin_addr), ntohs(client_addr.sin_port));
158
159                // 新しいクライアントソケットをepollインスタンスに追加
160                ev.events = EPOLLIN;  // 読み取りイベントを監視
161                ev.data.fd = conn_fd;  // イベントに関連付けるファイルディスクリプタ
162                if (epoll_ctl(epfd, EPOLL_CTL_ADD, conn_fd, &ev) == -1) {
163                    perror("epoll_ctl");
164                    close(conn_fd);  // ソケットを閉じる
165                }
166            } else {
167                // 既存のクライアントソケットからのデータ受信
168
169                // recv: ソケットからデータを受信して指定されたバッファに格納する。
170                //   第１引数：データを受信する対象のソケットのファイルディスクリプタ。
171                //             epoll_wait関数でイベントが発生したソケットのファイルディスクリプタであり、
172                //             接続されたクライアントのソケットファイルディスクリプタである。
173                //             epollイベントのデータ部に格納されている。
174                //   第２引数：受信したデータを格納するためのバッファ。バッファサイズを超えてデータが送られることはない。
175                //   第３引数：bufferのサイズ。バッファサイズにより、一度に受信できるデータの最大量が決まる。
176                //   第４引数：フラグ引数で、受信の動作を制御する。例えば、MSG_OOB（アウトオブバンドデータ）、
177                //             MSG_PEEK（データを読み取ってもキューから削除しない）などを指定できる。
178                //             0を指定すると、デフォルトの受信動作が行われる。
179                //   戻り値　：成功時は受信したバイト数。
180                //             受信データが空の場合（例えば、クライアントが接続を閉じた場合）、0が返されることがある。
181                //             失敗時は-1。
182                char buffer[1024];
183                ssize_t bytes_received = recv(events[i].data.fd, buffer, sizeof(buffer), 0);
184                if (bytes_received <= 0) {
185                    // クライアントが切断した場合
186                    printf("Client disconnected\n");
187                    epoll_ctl(epfd, EPOLL_CTL_DEL, events[i].data.fd, NULL);  // epollインスタンスから削除
188                    close(events[i].data.fd);  // ソケットを閉じる
189                } else {
190                    // データを受信した場合（エコーする）
191
192                    // データをエコーバックする。HTTP/1.1 形式のレスポンスを作成する。
193                    //   (レスポンスヘッダーが未指定の場合、古いHTTP/0.9形式でレスポンスされることで、
194                    //    クライアント側のcurlコマンドでエラーとなることがある。)
195                    // テンプレートhttp_response_templateを元に、HTTPレスポンスをフォーマットして
196                    // http_response バッファに書き込む。テンプレート内のフォーマット指定子（%zu や %s）は、
197                    // 対応する引数 (bytes_received や buffer) に置き換えられる。
198                    buffer[bytes_received] = '\0'; // 受信データの終端
199                    char http_response[BUFFER_SIZE];
200                    const char *http_response_template =
201                        "HTTP/1.1 200 OK\r\n"
202                        "Content-Length: %zu\r\n"
203                        "Content-Type: text/plain\r\n"
204                        "Connection: close\r\n"
205                        "\r\n"
206                        "%s";
207                    snprintf(http_response, sizeof(http_response), http_response_template, bytes_received, buffer);
208
209                    // send: 指定されたソケットにデータを送信する。
210                    //   第１引数：データを送信する対象のソケットのファイルディスクリプタ。
211                    //             epoll_wait関数でイベントが発生したソケットのファイルディスクリプタであり、
212                    //             接続されたクライアントのソケットファイルディスクリプタである。
213                    //   第２引数：送信するデータが格納されているバッファ。
214                    //   第３引数：送信するデータのサイズ。
215                    //   第４引数：送信の動作を変更するためのフラグ（例えば、MSG_OOB（アウトオブバンドデータ）、
216                    //             MSG_NOSIGNAL（シグナルを送信しない）など）を指定する。
217                    //             0を指定すると、デフォルトの送信動作が行われる。
218                    send(events[i].data.fd, http_response, strlen(http_response), 0);
219                    //send(events[i].data.fd, buffer, bytes_received, 0);
220                }
221            }
222        }
223    }
224
225    // サーバーソケットを閉じる
226    close(listen_fd);
227    return 0;
228}

 1#include <stdio.h>
 2#include <stdlib.h>
 3#include <unistd.h>
 4#include <string.h>
 5#include <arpa/inet.h>
 6
 7#define PORT 8080               // サーバーがリッスンしているポート番号
 8#define SERVER_IP "127.0.0.1"  // サーバーのIPアドレス（ローカルホスト）
 9
10int main() {
11    int sock_fd;                     // ソケットディスクリプタ
12    struct sockaddr_in serv_addr;   // サーバーのアドレス情報
13    char buffer[1024] = "Hello, Server!";  // サーバーに送信するメッセージ
14
15    // ソケットの作成
16    sock_fd = socket(AF_INET, SOCK_STREAM, 0);
17    if (sock_fd < 0) {
18        perror("socket");          // ソケット作成エラーの表示
19        return 1;
20    }
21
22    // サーバーのアドレス情報の設定
23    serv_addr.sin_family = AF_INET;               // アドレスファミリーをIPv4に設定
24    serv_addr.sin_port = htons(PORT);             // ポート番号を設定（ネットワークバイトオーダーに変換）
25
26    // IPアドレスをテキストからバイナリ形式に変換
27    if (inet_pton(AF_INET, SERVER_IP, &serv_addr.sin_addr) <= 0) {
28        perror("inet_pton");     // IPアドレス変換エラーの表示
29        close(sock_fd);          // ソケットを閉じる
30        return 1;
31    }
32
33    // サーバーに接続
34    if (connect(sock_fd, (struct sockaddr*)&serv_addr, sizeof(serv_addr)) < 0) {
35        perror("connect");      // 接続エラーの表示
36        close(sock_fd);         // ソケットを閉じる
37        return 1;
38    }
39
40    // サーバーにデータを送信
41    send(sock_fd, buffer, strlen(buffer), 0);
42    printf("Message sent to server\n");
43
44    // サーバーからの応答を受信
45    ssize_t bytes_received = recv(sock_fd, buffer, sizeof(buffer) - 1, 0);
46    if (bytes_received > 0) {
47        buffer[bytes_received] = '\0';  // 受信したデータの終端にヌル文字を追加
48        printf("Received from server: %s\n", buffer);  // サーバーからの応答を表示
49    } else if (bytes_received == 0) {
50        printf("Server closed the connection\n");  // サーバーが接続を閉じた場合のメッセージ
51    } else {
52        perror("recv");  // 受信エラーの表示
53    }
54
55    // ソケットを閉じる
56    close(sock_fd);
57
58    return 0;
59}

1$ gcc server.c -o server
2$ ./server
3Server listening on port 8080

 1$ gcc client.c -o client
 2$ ./client
 3Message sent to server
 4Received from server: HTTP/1.1 200 OK
 5Content-Length: 14
 6Content-Type: text/plain
 7Connection: close
 8
 9Hello, Server!
10$

1$ ./server
2Server listening on port 8080
3Accepted connection from 127.0.0.1:35810
4Client disconnected

 1$ curl -X POST -d $'Hello, Server!\n' http://127.0.0.1:8080
 2POST / HTTP/1.1
 3Host: 127.0.0.1:8080
 4User-Agent: curl/7.76.1
 5Accept: */*
 6Content-Length: 15
 7Content-Type: application/x-www-form-urlencoded
 8
 9Hello, Server!
10$

 1#define MAX_EVENTS 10
 2struct epoll_event ev, events[MAX_EVENTS];
 3int listen_sock, conn_sock, nfds, epollfd;
 4
 5/* Code to set up listening socket, 'listen_sock',
 6   (socket(), bind(), listen()) omitted. */
 7
 8epollfd = epoll_create1(0);
 9if (epollfd == -1) {
10    perror("epoll_create1");
11    exit(EXIT_FAILURE);
12}
13
14ev.events = EPOLLIN;
15ev.data.fd = listen_sock;
16if (epoll_ctl(epollfd, EPOLL_CTL_ADD, listen_sock, &ev) == -1) {
17    perror("epoll_ctl: listen_sock");
18    exit(EXIT_FAILURE);
19}
20
21for (;;) {
22    nfds = epoll_wait(epollfd, events, MAX_EVENTS, -1);
23    if (nfds == -1) {
24        perror("epoll_wait");
25        exit(EXIT_FAILURE);
26    }
27
28    for (n = 0; n < nfds; ++n) {
29        if (events[n].data.fd == listen_sock) {
30            conn_sock = accept(listen_sock,
31                               (struct sockaddr *) &addr, &addrlen);
32            if (conn_sock == -1) {
33                perror("accept");
34                exit(EXIT_FAILURE);
35            }
36            setnonblocking(conn_sock);
37            ev.events = EPOLLIN | EPOLLET;
38            ev.data.fd = conn_sock;
39            if (epoll_ctl(epollfd, EPOLL_CTL_ADD, conn_sock,
40                        &ev) == -1) {
41                perror("epoll_ctl: conn_sock");
42                exit(EXIT_FAILURE);
43            }
44        } else {
45            do_use_fd(events[n].data.fd);
46        }
47    }
48}