サーバソケットの多重化（select()）（Pythonによるネットワークプログラミング）

本記事は、Pythonによるネットワークプログラミングについての学習メモとなります。

参考書籍としてLinuxネットワークプログラミングバイブルを用い、同書の内容に沿ったかたちで、Pythonに書き直しをしていきます。

今回は、サーバソケットのマルチクライアント化（多重化）の方法として、select()を利用した方法について学んでいきます。

ネットワークプログラミングについて
多重化とは
select()によるマルチクライアント化
サーバプログラムの作成
動作確認
最後に
参考書籍

ネットワークプログラミングについて

ネットワークプログラミングの目的はデータの送受信をすることで、そのためにソケットというインターフェースを利用します。

このソケットは、TCP/IPの誕生時にBSD Uinux上に実装されたものですが、非常に使い勝手が良かったため、WindowsなどのUnix系以外のOSでも利用されています。

Pythonで実装する際の手順やオプションの設定なども、概ねそのままプログラミングすることができます。

多重化とは

通常のサーバソケットでは、accept()（もしくはrecv()）を呼び出した後、それ以降の処理をブロックしてしまいます（ブロッキングIO）。

そのため、他のコネクションが確立したソケットは、その処理が完了するまで待機させられ、クライアントごとの同時接続ができない使い勝手の悪いアプリケーションになってしまいます。

これらの問題を解決するためには、多重化と呼ばれる技術を使い、マルチクライアント化に対応する必要があります。

select()によるマルチクライアント化

select()では引数として渡したディスクリプタの集合から、読み込み可能になるまで処理を一時停止し、利用可能になったものの情報を返します。

なお、前回学んだfcntl()を使いソケットディスクリプタ（ファイルディスクリプタ）をノンブロッキングIOにすることでもマルチクライアント化には対応できますが、ソケットを継続的にポーリングしなければならないため、CPUリソースを無駄に消費してしまいます。

サーバプログラムの作成

今回は前回作成したサーバプログラムにselect()によるマルチクライアント機能を実装していきます。

以下がソースコードになります。

# server_multi_select.py
import socket
import sys
import fcntl
import os
import errno
import select

MAX_CHILD = 20

def server_socket(portnum):
  try:
    for res in socket.getaddrinfo(None, portnum, socket.AF_INET, socket.SOCK_STREAM, socket.IPPROTO_TCP, socket.AI_PASSIVE):
      af, socktype, proto, canonname, sa = res
      break
  except socket.gaieor as e:
    print("getaddrinfo():{}".format(e))
    sys.exit(1)

  try:
    nbuf, sbuf = socket.getnameinfo(sa, socket.AI_PASSIVE)
  except socket.gaieor as e:
    print("getnameinfo():{}".format(e))
    sys.exit(1)

  print("port={}".format(sbuf))

  try:
    soc = socket.socket(af, socktype, proto)
  except OSError as e:
    print("socket:{}".format(e))
    sys.exit(1)

  try:
    soc.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
  except OSError as e:
    print("setsockopt:{}".format(e))
    sys.exit(1)

  try:
    soc.bind(sa)
  except OSError as e:
    print("bind:{}".format(e))
    soc.close()
    sys.exit(1)

  try:
    soc.listen(socket.SOMAXCONN)
  except OSError as e:
    print("listen:{}".format(e))
    soc.close()
    sys.exit(1)

  return soc

def accept_loop(soc):
  child = [0 for i in range(MAX_CHILD)]
  child_no = 0
  while True:
    try:
      fd_set = set()
      fd_set.add(soc)
      width = soc.fileno() + 1
      count = 0
      for i in range(child_no):
        if child[i] != 0:
          fd_set.add(child[i])
          if child[i].fileno() +1 > width:
            width = child[i].fileno() + 1
            count += 1
      print("<<child count:{}>>".format(count))
      try:
        r, w, x = select.select(list(fd_set), [], [], 10)
      except OSError as e:
        print(e)
        continue
      if len(r) == 0:
          print("select:timeout")
      else:
        if soc in r:
          acc, addr = soc.accept()

          hbuf, sbuf = socket.getnameinfo(addr, socket.NI_NUMERICHOST | socket.NI_NUMERICSERV)
          print("accept:{}:{}".format(hbuf, sbuf))
          pos = -1
          for i in range(child_no):
            if child[i] == 0:
              pos = i
              break
          if pos == -1:
            if child_no + 1 >= MAX_CHILD:
              print("child is full: cannot accept")
              acc.close()
            else:
              child_no += 1
              pos = child_no - 1
          if pos != -1:
            child[pos] = acc
        for i in range(child_no):
            if child[i] != 0:
              if child[i] in r:
                if send_recv(child[i], i) == -1:
                  child[i].close()
                  child[i] = 0
    except InterruptedError as e:
      if e.errno != errno.EINTR:
        print("accept:{}".format(e))

def send_recv(acc, child_no):
  buf_size = 512
  try:
    data = acc.recv(buf_size)
  except InterruptedError as e:
    print("recv:{}".format(e))
    return -1

  if (len(data) == 0):
    # EOF
    print("[child{}]recv:EOF".format(child_no))
    return -1

  data = data.rstrip()
  try:
    print("[child{}]{}".format(child_no, data.decode('utf-8')))
  except UnicodeDecodeError:
    pass
  try:
    acc.send(data + b':OK\r\n')
  except InterruptedError as e:
    print("send:{}".format(e))
    return -1
  return 0

if __name__ == '__main__':
  if (len(sys.argv) != 2):
    print("Usage: {} <server port="">".format(sys.argv[0]))
    sys.exit(1)

  soc = server_socket(sys.argv[1])

  print("ready for accept")

  try:
    accept_loop(soc)
    soc.close()
  except KeyboardInterrupt:
    soc.close()
    sys.exit(1)

動作確認

それでは、上記プログラムを実行してみます。

 > python3 server_multi_select.py 8888
 port=8888
 ready for accept
 <<child count:0=>>      
 accept:127.0.0.1:53554    # クライアント１接続
 <<child count:1>>
 [child0]ok
 <<child count:1>>        
 accept:127.0.0.1:53555    # クライアント2接続
 <<child count:2>>
 [child1]ok
 <<child count:2>>
 [child1]recv:EOF          # クライアント2切断
 <<child count:1>>
 [child0]recv:EOF          # クライアント1切断
 <<child count:0>>