システムプログラム(第7週): select()による複数のクライアントに対するサービスの同時提供

                                       筑波大学 システム情報工学研究科 
                                       コンピュータサイエンス専攻, 電子・情報工学系
                                       新城 靖
                                       <yas@is.tsukuba.ac.jp>

このページは、次の URL にあります。
http://www.coins.tsukuba.ac.jp/~syspro/2007/No7_files/echo-server-select.html
あるいは、次のページから手繰っていくこともできます。
http://www.coins.tsukuba.ac.jp/~syspro/2007/
http://www.coins.tsukuba.ac.jp/~yas/

echo-server-select

fork版 では、クライアントから接続要 求を受け付けるたびに、新しいプロセスを作っていた。以下の echo-server-select.cでは、1つのプロセスで実行している。
   1:	
   2:	/*
   3:	        echo-server-select.c -- 受け取った文字列をそのまま返すサーバ(select版)
   4:	        ~yas/syspro/ipc/echo-server-select.c
   5:	        Created on 1997/06/09 19:53:33
   6:	*/
   7:	#include <stdio.h>
   8:	#include <stdlib.h>     /* exit() */
   9:	#include <sys/types.h>  /* socket(), time(), select() */
  10:	#include <sys/socket.h> /* socket() */
  11:	#include <netinet/in.h> /* struct sockaddr_in */
  12:	#include <sys/time.h>   /* select() */
  13:	#include <unistd.h>     /* select() */
  14:	#include <netdb.h>      /* getnameinfo() */
  15:	#include <string.h>     /* memset() */
  16:	
  17:	extern  void echo_server( int portno );
  18:	extern  void echo_reply_select( int com );
  19:	extern  int  find_maxfds( fd_set *fds );
  20:	extern  int  echo_reply_once( int com );
  21:	extern  void print_my_host_port( int portno );
  22:	extern  void tcp_peeraddr_print( int com );
  23:	extern  void sockaddr_print( struct sockaddr *addrp, socklen_t addr_len );
  24:	extern  tcp_acc_port( int portno );
  25:	extern  ssize_t writen(int fd, const void *vptr, size_t n);
  26:	extern  ssize_t readline(int fd, void *vptr, size_t maxlen);
  27:	
  28:	main( int argc, char *argv[] )
  29:	{
  30:	    int portno ;
  31:	        if( argc >= 3 )
  32:	        {
  33:	            fprintf( stdout,"Usage: %s [portno] \n",argv[0] );
  34:	            exit( -1 );
  35:	        }
  36:	        if( argc == 2 )
  37:	            portno = strtol( argv[1],0,10 );
  38:	        else
  39:	            portno = getuid();
  40:	        echo_reply_select( portno );
  41:	}
  42:	

main() 関数の部分は、fork版 とほと んど同じである。
  43:	void
  44:	echo_reply_select( int portno )
  45:	{
  46:	    int acc,com ;
  47:	    fd_set readfds,readfds_save ;
  48:	    int i,n, maxfds, next_maxfds ;
  49:	
  50:	        acc = tcp_acc_port( portno );
  51:	        if( acc<0 )
  52:	            exit( -1 );
  53:	        print_my_host_port( portno );
  54:	
  55:	        FD_ZERO( &readfds_save );
  56:	        FD_SET( acc,&readfds_save );
  57:	        maxfds = next_maxfds = acc + 1;
  58:	        while( 1 )
  59:	        {
  60:	            readfds = readfds_save ;
  61:	            n = select( maxfds,&readfds,0,0,0 );
  62:	            if( n <= 0 )
  63:	            {
  64:	                perror("select");
  65:	                exit( 1 );
  66:	            }
  67:	            if( FD_ISSET(acc,&readfds) )
  68:	            {
  69:	                FD_CLR( acc,&readfds );
  70:	                if( (com = accept( acc,0,0 )) < 0 )
  71:	                {
  72:	                    perror("accept");
  73:	                    exit( -1 );
  74:	                }
  75:	                FD_SET( com, &readfds_save );
  76:	                if( com+1 > maxfds )
  77:	                {
  78:	                    next_maxfds = com+1;
  79:	                }
  80:	                tcp_peeraddr_print( com );
  81:	            }
  82:	            for( i=0 ; i<maxfds ; i++ )
  83:	            {
  84:	                if( FD_ISSET(i,&readfds) )
  85:	                {
  86:	                    if( echo_reply_once( i )<=0 )
  87:	                    {
  88:	                        printf("[%d] connection (fd==%d) closed.\n",getpid(),i );
  89:	                        close( i );
  90:	                        FD_CLR( i,&readfds_save );
  91:	                        if( maxfds == i+1 )
  92:	                        {
  93:	                            next_maxfds = find_maxfds( &readfds_save );
  94:	                        }
  95:	                    }
  96:	                }
  97:	            }
  98:	            maxfds = next_maxfds ;
  99:	        }
 100:	}
 101:	

tcp_acc_port() で、接続受付け用ポートに対応したソケットを 作り、print_my_host_port() (fork版 と同じ) で表示している。

ループに入る前に、fd_set 形の変数 readfds_save を初期化している。 fd_set は、ファイル記述子(file descriptor) の set (集合)を意味する。内 部的には、ビットの並びで実現されていることが多い。次のような操作がある。

FD_ZERO(&fds)
初期化する(集合を空にする)
FD_SET(fd,&fds)
fd を集合に加える(ビットを1にする)
FD_CLR(fd,&fds)
fd を集合から取り除く(ビットを0にする)
FD_ISSET(fd,&fds)
その fd が集合に含まれているかを調べる。
初期値は、tcp_acc_port() で作成した接続受付け用ポートに対応したソケッ トを入れる。

無限ループを含むのは、fork版と同じ である。

readfds = readfds_save は、select() の実行で壊されるので、保存してある。 「壊される」とは、プロセスからシステムへの方向に値を送るだけでなく、同 じ場所に、システムからプロセスの方向へ結果が返される(同じ場所に上書き される)ことを意味する。

select() は、引数で指定された集合が、入力可能かどうかを調べている。入 力可能でなければ、入力可能になるまで待つ。

第3引数以降を使えば、出力可能かを調べたり、無限に待つのではなくて、あ る指定された時間だけ待つこともできる。

もし、要求受付け用ポートに対応したソケット acc が入力可能ならば、 accept() すると止まらずに処理が進むことを意味する。処理とは、クライア ントとの間の通信用ポートに対応したソケットが作ることである。fork() 版 とは違い、この accept() の所で待つことはない。

accept() が成功したら、結果として返されたファイル記述子を、 readfds_save に加える。次のループから select() の監視の対象になる。

for 文で、残りのファイル記述子について調べる。一度に複数のファイル記 述子がセットされている可能性がある。

もしセットされているファイル記述子を見つけたら、echo_reply_once() を呼 び出す。普通は、0 より大きい数が返ってくる。そして次のセットされている ファイル記述子について echo_reply_once() の処理を続ける。

特殊な場合として、echo_reply_once() は、クライアントが接続を切った場合 には、0 以下の値を返す。その場合は、close() でファイル記述子を解放し、 readfds_save からも FD_CLR() で取り除く。

select() の第1引数には、最大の「ファイル記述子+1」を与える。 初期値は、acc+1 である。 accept() の時に、増える可能性があり、その場合は増やす。 close() の時に減る可能性があり、その場合は減らす。

select版では、fork版とは異なり、ゾンビ・プロセスは発生しない。

 102:	int
 103:	find_maxfds( fd_set *fds )
 104:	{
 105:	    int i, maxfds ;
 106:	        for( i=FD_SETSIZE; i>= 0; i-- )
 107:	        {
 108:	            if( FD_ISSET(i,fds) )
 109:	            {
 110:	                return( i+1 );
 111:	            }
 112:	        }
 113:	        return( 0 );
 114:	}
 115:	

find_maxfds() は、select() の第1引数に与える最大の「ファイル記述子+ 1」を探す関数である。引数の fd_set を、FD_SETSIZE から 0 に向かって探 している。

 116:	#define BUFFERSIZE      1024
 117:	
 118:	int
 119:	echo_reply_once( int com )
 120:	{
 121:	    char line[BUFFERSIZE] ;
 122:	    int rcount ;
 123:	    int wcount ;
 124:	
 125:	        if( (rcount=readline(com,line,BUFFERSIZE)) > 0 )
 126:	        {
 127:	            printf("[%d] read(%d,,) %d bytes, %s",getpid(),com,rcount,line );
 128:	            fflush( stdout );
 129:	            if( (wcount=writen(com,line,rcount))!= rcount )
 130:	            {
 131:	                 perror("write");
 132:	                 exit( 1 );
 133:	            }
 134:	        }
 135:	        return( rcount );
 136:	}
 137:	
データを読込む時には、readline() を使っている。これは、fgets() と同様 に\n 記号が現れるまでを一区切りとして、読込むものである。引数は fgets() とは異なり、ファイル記述子である。readline() は、バッファサイ ズ以上は、読込まない。また、最後に文字列の終端の 0 を付ける。(read() システムコールでは、付けてくれない。)

このプログラムでは、write() システムコールの変りに writen() 関数(ソー ス・プログラムは同じファイルの下の方にある)を使っている。TCP/IP の通 信では、write(fd,buf,100) としても、100バイト送られずに、50 バイトしか 送られないことがある。残りの 50 バイトも送る必要があれば、ループして全 部送るようにする。システム・コール write() は、今は送る必要がない(後 で送ってもよい)場合、送らなくてもよい場合にも対応できるようになってい る。しかし、一般には送る方は全部送り終わるまでループして待った方がよい 場合が多い。writen() は、このような目的のための関数である。

echo_reply_once() は、readline() の結果(多くの場合は、読込んだバイト数) をそのまま返す。0 以下の数を返した時にもそのまま返す。

以下の関数は、fork() 版と同じである。

 139:	print_my_host_port( int portno )
 148:	tcp_peeraddr_print( int com )
 164:	sockaddr_print( struct sockaddr *addrp, socklen_t addr_len )
 174:	tcp_acc_port( int portno )
 206:	/* 
 207:	W.リチャード・スティーブンス著、篠田陽一訳:
 208:	"UNIXネットワークプログラミング第2版 Vol.1 ネットワークAPI:ソケットとXTI",
 209:	ピアソン・エデュケーション, 1999年. ISBN 4-98471-205-9
 210:	  3.9節 readn, writen, および readline 関数 (p.76)
 211:	
 212:	Richard Stevens: "UNIX Network Programming, Volume 1, Second Edition:
 213:	Networking APIs: Sockets and XTI", Prentice Hall, 1998.
 214:	ISBN 0-13-490012-X.  
 215:	    Section 3.9 readn, writen, and readline Functions (p.77)
 216:	
 217:	http://www.kohala.com/start/ (http://www.kohala.com/~rstevens/)
 218:	http://www.kohala.com/start/unpv12e/unpv12e.tar.gz
 219:	
 220:	*/
 221:	
 222:	/* include writen */
 223:	/*#include      "unp.h"*/
 224:	#include <errno.h>
 225:	
 226:	ssize_t                 /* Write "n" bytes to a descriptor. */
 227:	writen(int fd, const void *vptr, size_t n)
 228:	{
 229:	        size_t          nleft;
 230:	        ssize_t         nwritten;
 231:	        const char      *ptr;
 232:	
 233:	        ptr = vptr;
 234:	        nleft = n;
 235:	        while (nleft > 0) {
 236:	                if ( (nwritten = write(fd, ptr, nleft)) <= 0) {
 237:	                        if (errno == EINTR)
 238:	                                nwritten = 0;           /* and call write() again */
 239:	                        else
 240:	                                return(-1);                     /* error */
 241:	                }
 242:	
 243:	                nleft -= nwritten;
 244:	                ptr   += nwritten;
 245:	        }
 246:	        return(n);
 247:	}
 248:	
 249:	/* include readline */
 250:	/*#include      "unp.h"*/
 251:	
 252:	ssize_t
 253:	readline(int fd, void *vptr, size_t maxlen)
 254:	{
 255:	        ssize_t n, rc;
 256:	        char    c, *ptr;
 257:	
 258:	        ptr = vptr;
 259:	        for (n = 1; n < maxlen; n++) {
 260:	again:
 261:	                if ( (rc = read(fd, &c, 1)) == 1) {
 262:	                        *ptr++ = c;
 263:	                        if (c == '\n')
 264:	                                break;  /* newline is stored, like fgets() */
 265:	                } else if (rc == 0) {
 266:	                        if (n == 1)
 267:	                                return(0);      /* EOF, no data read */
 268:	                        else
 269:	                                break;          /* EOF, some data was read */
 270:	                } else {
 271:	                        if (errno == EINTR)
 272:	                                goto again;
 273:	                        return(-1);             /* error, errno set by read() */
 274:	                }
 275:	        }
 276:	
 277:	        *ptr = 0;       /* null terminate like fgets() */
 278:	        return(n);
 279:	}
 280:	/* end readline */
readline() は、\n 記号が現れるまでを一区切りとして、読込む。fgets() と 同様に、最後に終端の 0 を付けてくれる。 このプログラムは、1バイトずつ読み込んでいるので、性能が悪い。上記の教 科書では、高速版やマルチスレッドで動作するプログラムも示してある。

実行例。

サーバ側。サーバは、終了しないので、最後に、^C を押して、割り 込みを掛けて終了させる。

注意:同じホストで複数人がポート番号 1231 を使うと動作しない。

% ./echo-server-select 1231 [←]
run telnet azalea20.coins.tsukuba.ac.jp 1231 
[17721] connection (fd==4) from 130.158.86.40:55988
[17721] read(4,,) 5 bytes, 012
[17721] connection (fd==5) from 130.158.86.50:52806
[17721] read(5,,) 5 bytes, abc
[17721] read(5,,) 5 bytes, def
[17721] connection (fd==5) closed.
[17721] read(4,,) 5 bytes, 345
[17721] connection (fd==4) closed.
^C
% []
クライアント側(その1)。
% telnet azalea20.coins.tsukuba.ac.jp 1231  [←]
Trying 130.158.86.40...
Connected to azalea20.coins.tsukuba.ac.jp.
Escape character is '^]'.
012[←]
012
345[←]
345
^]
telnet> quit
Connection closed.
% []
クライアント側(その2)。
% telnet azalea20.coins.tsukuba.ac.jp 1231 [←]
Trying 130.158.86.40...
Connected to azalea20.coins.tsukuba.ac.jp.
Escape character is '^]'.
abc[←]
abc
def[←]
def
^]
telnet> quit[←]
Connection closed.
% []

図1 複数のクライアントが接続した時(select())

図1 複数のクライアントが接続した時(select())

echo-server-selectに対するDoS攻撃

このプログラムでは、readline() を使っているので、クライアントから \nが 送られてこないと、サーバ全体の処理が停止してしまう。select() の結果、 本来ならブロックしないはずであるが、\n が来たらブロックしてしまう。

readline() の代りにread() を使えば、そのような問題は生じない。しかし、 行単位で何か処理を行うようなサーバを作るには、「クライアントごとに」、 少なくとも1行をためるためのバッファを設ける必要がある。

クライアントが意図的に '\n' を送らないことがある。これも、DoS 攻撃 (Denial of Service攻撃、サービス運用妨害攻撃)の一種である。 その他に、writen() に対して、クライアントが read() しないという攻撃も ある。

echo-server-fork.c では、クライアントご とにプロセス(スレッド)が存在するので、安全に readline() を使うことが できる。ただし、プロセスをコピーする処理が重たいので、過剰な connect() による接続要求による DoS 攻撃には弱くなる。(fork() の処理ばかりして、 通常の業務ができなくなる。)

サーバ・プログラムを作成する時には、DoS 攻撃に強いものを作成するように 気をつける。


Last updated: 2007/05/29 18:08:29
Yasushi Shinjo / <yas@is.tsukuba.ac.jp>