serverengine 2.0.0pre1-x86-mingw32

data/lib/serverengine/socket_manager_unix.rb

@@ -0,0 +1,98 @@
+#
+# ServerEngine
+#
+# Copyright (C) 2012-2013 Sadayuki Furuhashi
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+#
+require 'socket'
+
+module ServerEngine
+  module SocketManagerUnix
+
+    module ClientModule
+      private
+
+      def connect_peer(path)
+        return UNIXSocket.new(path)
+      end
+
+      def recv_tcp(peer, sent)
+        return peer.recv_io(TCPServer)
+      end
+
+      def recv_udp(peer, sent)
+        return peer.recv_io(UDPSocket)
+      end
+    end
+
+    module ServerModule
+      private
+
+      def listen_tcp_new(bind_ip, port)
+        sock = TCPServer.new(bind_ip.to_s, port)
+        sock.listen(Socket::SOMAXCONN)  # TODO make backlog configurable if necessary
+        return sock
+      end
+
+      def listen_udp_new(bind_ip, port)
+        if bind_ip.ipv6?
+          sock = UDPSocket.new(Socket::AF_INET6)
+        else
+          sock = UDPSocket.new
+        end
+        sock.bind(bind_ip.to_s, port)
+        return sock
+      end
+
+      def start_server(path)
+        # return absolute path so that client can connect to this path
+        # when client changed working directory
+        path = File.expand_path(path)
+
+        @server = UNIXServer.new(path)
+
+        @thread = Thread.new do
+          begin
+            while peer = @server.accept
+              Thread.new(peer, &method(:process_peer))  # process_peer calls send_socket
+            end
+          rescue => e
+            unless @server.closed?
+              ServerEngine.dump_uncaught_error(e)
+            end
+          end
+        end
+
+        return path
+      end
+
+      def stop_server
+        @tcp_sockets.reject! {|key,lsock| lsock.close; true }
+        @udp_sockets.reject! {|key,usock| usock.close; true }
+        @server.close unless @server.closed?
+        # It cause dead lock and can't finish when joining thread using Ruby 2.1 on linux.
+        @thread.join if RUBY_VERSION >= "2.2"
+      end
+
+      def send_socket(peer, pid, method, bind, port)
+        sock = send(method, bind, port)  # calls listen_tcp or listen_udp
+
+        SocketManager.send_peer(peer, nil)
+
+        peer.send_io sock
+      end
+    end
+
+  end
+end

data/lib/serverengine/socket_manager_win.rb

@@ -0,0 +1,154 @@
+#
+# ServerEngine
+#
+# Copyright (C) 2012-2013 Sadayuki Furuhashi
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+#
+require 'socket'
+require 'ipaddr'
+
+require_relative 'winsock'
+
+module ServerEngine
+  module SocketManagerWin
+
+    module ClientModule
+      private
+
+      def connect_peer(addr)
+        return TCPSocket.open("127.0.0.1", addr)
+      end
+
+      def recv_tcp(peer, sent)
+        proto = WinSock::WSAPROTOCOL_INFO.from_bin(sent)
+
+        handle = WinSock.WSASocketA(Socket::AF_INET, Socket::SOCK_STREAM, 0, proto, 0, 1)
+        if handle == WinSock::INVALID_SOCKET
+          RbWinSock.raise_last_error("WSASocketA(2)")
+        end
+
+        return RbWinSock.wrap_io_handle(TCPServer, handle, 0)
+      end
+
+      def recv_udp(peer, sent)
+        proto = WinSock::WSAPROTOCOL_INFO.from_bin(sent)
+
+        handle = WinSock.WSASocketA(Socket::AF_INET, Socket::SOCK_DGRAM, 0, proto, 0, 1)
+        if handle == WinSock::INVALID_SOCKET
+          RbWinSock.raise_last_error("WSASocketA(2)")
+        end
+
+        return RbWinSock.wrap_io_handle(UDPSocket, handle, 0)
+      end
+    end
+
+    module ServerModule
+      private
+
+      def listen_tcp_new(bind_ip, port)
+        sock_addr = Socket.pack_sockaddr_in(port, bind_ip.to_s)
+
+        handle = WinSock.WSASocketA(Socket::AF_INET, Socket::SOCK_STREAM, Socket::IPPROTO_TCP, nil, 0, 1)
+        if handle == WinSock::INVALID_SOCKET
+          RbWinSock.raise_last_error("WSASocketA(2)")
+        end
+
+        # wrap in TCPServer immediately so that its finalizer safely closes the handle
+        sock = RbWinSock.wrap_io_handle(TCPServer, handle, 0)
+
+        unless WinSock.bind(sock.handle, sock_addr, sock_addr.bytesize) == 0
+          RbWinSock.raise_last_error("bind(2)")
+        end
+        unless WinSock.listen(sock.handle, Socket::SOMAXCONN) == 0
+          RbWinSock.raise_last_error("listen(2)")
+        end
+
+        return sock
+      end
+
+      def listen_udp_new(bind_ip, port)
+        sock_addr = Socket.pack_sockaddr_in(port, bind_ip.to_s)
+
+        if IPAddr.new(IPSocket.getaddress(bind_ip.to_s)).ipv4?
+          handle = WinSock.WSASocketA(Socket::AF_INET, Socket::SOCK_DGRAM, Socket::IPPROTO_UDP, nil, 0, 1)
+        else
+          handle = WinSock.WSASocketA(Socket::AF_INET6, Socket::SOCK_DGRAM, Socket::IPPROTO_UDP, nil, 0, 1)
+        end
+
+        if handle == WinSock::INVALID_SOCKET
+          RbWinSock.raise_last_error("WSASocketA(2)")
+        end
+
+        # wrap in UDPSocket immediately so that its finalizer safely closes the handle
+        sock = RbWinSock.wrap_io_handle(UDPSocket, handle, 0)
+
+        unless WinSock.bind(sock.handle, sock_addr, sock_addr.bytesize) == 0
+          RbWinSock.raise_last_error("bind(2)")
+        end
+
+        return sock
+      end
+
+      def htons(h)
+        [h].pack("S").unpack("n")[0]
+      end
+
+      def start_server(addr)
+        # TODO: use TCPServer, but this is risky because using not conflict path is easy,
+        # but using not conflict port is difficult. Then We had better implement using NamedPipe.
+        @server = TCPServer.new("127.0.0.1", addr)
+        @thread = Thread.new do
+          begin
+            while peer = @server.accept
+              Thread.new(peer, &method(:process_peer))  # process_peer calls send_socket
+            end
+          rescue => e
+            unless @server.closed?
+              ServerEngine.dump_uncaught_error(e)
+            end
+          end
+        end
+
+        return path
+      end
+
+      def stop_server
+        @tcp_sockets.reject! {|key,lsock| lsock.close; true }
+        @udp_sockets.reject! {|key,usock| usock.close; true }
+        @server.close unless @server.closed?
+        @thread.join
+      end
+
+      def send_socket(peer, pid, method, bind, port)
+        case method
+        when :listen_tcp
+          sock = listen_tcp(bind, port)
+          type = Socket::SOCK_STREAM
+        when :listen_udp
+          sock = listen_udp(bind, port)
+          type = Socket::SOCK_DGRAM
+        else
+          raise ArgumentError, "Unknown method: #{method.inspect}"
+        end
+
+        proto = WinSock::WSAPROTOCOL_INFO.malloc
+        unless WinSock.WSADuplicateSocketA(sock.handle, pid, proto) == 0
+          RbWinSock.raise_last_error("WSADuplicateSocketA(3)")
+        end
+
+        SocketManager.send_peer(peer, proto.to_bin)
+      end
+    end
+  end
+end

data/lib/serverengine/supervisor.rb

@@ -0,0 +1,313 @@
+#
+# ServerEngine
+#
+# Copyright (C) 2012-2013 Sadayuki Furuhashi
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+#
+require 'serverengine/config_loader'
+require 'serverengine/blocking_flag'
+require 'serverengine/process_manager'
+require 'serverengine/command_sender'
+require 'serverengine/signals'
+
+require 'serverengine/embedded_server'
+require 'serverengine/multi_process_server'
+require 'serverengine/multi_thread_server'
+require 'serverengine/multi_spawn_server'
+
+module ServerEngine
+
+  class Supervisor
+    include ConfigLoader
+
+    def initialize(server_module, worker_module, load_config_proc={}, &block)
+      @server_module = server_module
+      @worker_module = worker_module
+
+      @detach_flag = BlockingFlag.new
+      @stop = false
+
+      @pm = ProcessManager.new(
+        auto_tick: false,
+        graceful_kill_signal: Signals::GRACEFUL_STOP,
+        immediate_kill_signal: Signals::IMMEDIATE_STOP,
+        enable_heartbeat: true,
+        auto_heartbeat: true,
+      )
+
+      super(load_config_proc, &block)
+
+      @create_server_proc = Supervisor.create_server_proc(server_module, worker_module, @config)
+      @server_process_name = @config[:server_process_name]
+
+      @restart_server_process = !!@config[:restart_server_process]
+      @unrecoverable_exit_codes = @config.fetch(:unrecoverable_exit_codes, [])
+      @enable_detach = !!@config[:enable_detach]
+      @exit_on_detach = !!@config[:exit_on_detach]
+      @disable_reload = !!@config[:disable_reload]
+
+      @command_pipe = @config.fetch(:command_pipe, nil)
+
+      @command_sender = @config.fetch(:command_sender, ServerEngine.windows? ? "pipe" : "signal")
+      if @command_sender == "pipe"
+        extend CommandSender::Pipe
+      else
+        extend CommandSender::Signal
+      end
+    end
+
+    # server is available after start_server() call.
+    attr_reader :server
+
+    def reload_config
+      super
+
+      @server_detach_wait = @config[:server_detach_wait] || 10.0
+      @server_restart_wait = @config[:server_restart_wait] || 1.0
+
+      @pm.configure(@config, prefix: 'server_')
+
+      nil
+    end
+
+    module ServerInitializer
+      def initialize
+        reload_config
+      end
+    end
+
+    def self.create_server_proc(server_module, worker_module, config)
+      wt = config[:worker_type] || 'embedded'
+      case wt
+      when 'embedded'
+        server_class = EmbeddedServer
+      when 'process'
+        server_class = MultiProcessServer
+      when 'thread'
+        server_class = MultiThreadServer
+      when 'spawn'
+        server_class = MultiSpawnServer
+      else
+        raise ArgumentError, "unexpected :worker_type option #{wt}"
+      end
+
+      lambda {|load_config_proc,logger|
+        s = server_class.new(worker_module, load_config_proc)
+        s.logger = logger
+        s.extend(ServerInitializer)
+        s.extend(server_module) if server_module
+        s.instance_eval { initialize }
+        s
+      }
+    end
+
+    def create_server(logger)
+      @server = @create_server_proc.call(@load_config_proc, logger)
+    end
+
+    def stop(stop_graceful)
+      @stop = true
+      _stop(stop_graceful)
+    end
+
+    def restart(stop_graceful)
+      reload_config
+      @logger.reopen! if @logger
+      if @restart_server_process
+        _stop(stop_graceful)
+      else
+        _restart(stop_graceful)
+      end
+    end
+
+    def reload
+      unless @disable_reload
+        reload_config
+      end
+      @logger.reopen! if @logger
+      _reload
+    end
+
+    def detach(stop_graceful)
+      if @enable_detach
+        @detach_flag.set!
+        _stop(stop_graceful)
+      else
+        stop(stop_graceful)
+      end
+    end
+
+    def install_signal_handlers
+      s = self
+      if @command_pipe
+        Thread.new do
+          until @command_pipe.closed?
+            case @command_pipe.gets.chomp
+            when "GRACEFUL_STOP"
+              s.stop(true)
+            when "IMMEDIATE_STOP"
+              s.stop(false)
+            when "GRACEFUL_RESTART"
+              s.restart(true)
+            when "IMMEDIATE_RESTART"
+              s.restart(false)
+            when "RELOAD"
+              s.reload
+            when "DETACH"
+              s.detach(true)
+            when "DUMP"
+              Sigdump.dump
+            end
+          end
+        end
+      else
+        SignalThread.new do |st|
+          st.trap(Signals::GRACEFUL_STOP) { s.stop(true) }
+          st.trap(Signals::IMMEDIATE_STOP) { s.stop(false) }
+          st.trap(Signals::GRACEFUL_RESTART) { s.restart(true) }
+          st.trap(Signals::IMMEDIATE_RESTART) { s.restart(false) }
+          st.trap(Signals::RELOAD) { s.reload }
+          st.trap(Signals::DETACH) { s.detach(true) }
+          st.trap(Signals::DUMP) { Sigdump.dump }
+        end
+      end
+    end
+
+    def main
+      # just in case Supervisor is not created by Daemon
+      create_logger unless @logger
+
+      @pmon = start_server
+
+      while true
+        # keep the child process alive in this loop
+        until @detach_flag.wait(0.5)
+          if try_join
+            return if @stop   # supervisor stoppped explicitly
+            if @stop_status # set exit code told by server
+              raise SystemExit.new(@stop_status)
+            end
+
+            # child process died unexpectedly.
+            # sleep @server_detach_wait sec and reboot process
+            @pmon = reboot_server
+          end
+        end
+
+        wait_until = Time.now + @server_detach_wait
+        while (w = wait_until - Time.now) > 0
+          break if try_join
+          sleep [0.5, w].min
+        end
+
+        return if @exit_on_detach
+
+        @detach_flag.reset!
+      end
+    end
+
+    def logger=(logger)
+      super
+      @pm.logger = @logger
+    end
+
+    private
+
+    def send_signal(sig)
+      @pmon.send_signal(sig) if @pmon
+      nil
+    end
+
+    def try_join
+      if stat = @pmon.try_join
+        @logger.info "Server finished#{@stop ? '' : ' unexpectedly'} with #{ServerEngine.format_join_status(stat)}"
+        if !@stop && stat.is_a?(Process::Status) && stat.exited? && @unrecoverable_exit_codes.include?(stat.exitstatus)
+          @stop_status = stat.exitstatus
+        end
+        @pmon = nil
+        return stat
+      else
+        @pm.tick
+        return false
+      end
+    end
+
+    def start_server
+      if @command_sender == "pipe"
+        inpipe, @command_sender_pipe = IO.pipe
+      end
+
+      unless ServerEngine.windows?
+        s = create_server(logger)
+        @last_start_time = Time.now
+
+        begin
+          m = @pm.fork do
+            $0 = @server_process_name if @server_process_name
+            if @command_sender == "pipe"
+              @command_sender_pipe.close
+              s.instance_variable_set(:@command_pipe, inpipe)
+            end
+            s.install_signal_handlers
+
+            begin
+              s.main
+            rescue SystemExit => e
+              @logger.info "Server is exitting with code #{e.status}"
+              exit! e.status
+            end
+          end
+          if @command_sender == "pipe"
+            inpipe.close
+          end
+
+          return m
+        ensure
+          s.after_start
+        end
+      else # if ServerEngine.windows?
+        exconfig = {}
+        if @command_sender == "pipe"
+          exconfig[:in] = inpipe
+        end
+        @last_start_time = Time.now
+        m = @pm.spawn(*Array(config[:windows_daemon_cmdline]), exconfig)
+        if @command_sender == "pipe"
+          inpipe.close
+        end
+
+        return m
+      end
+    end
+
+    def reboot_server
+      # try reboot for ever until @detach_flag is set
+      while true
+        wait = @server_restart_wait - (Time.now - @last_start_time)
+        if @detach_flag.wait(wait > 0 ? wait : 0.1)
+          break
+        end
+
+        begin
+          return start_server
+        rescue
+          ServerEngine.dump_uncaught_error($!)
+        end
+      end
+
+      return nil
+    end
+  end
+
+end