serverengine 1.5.0

data/lib/serverengine/config_loader.rb

@@ -0,0 +1,73 @@
+#
+# ServerEngine
+#
+# Copyright (C) 2012-2013 FURUHASHI Sadayuki
+#
+#    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.
+#
+module ServerEngine
+
+  module ConfigLoader
+    def initialize(load_config_proc={}, &block)
+      if block
+        @load_config_proc = block
+      else
+        if load_config_proc.is_a?(Hash)
+          @load_config_proc = lambda { load_config_proc }
+        else
+          @load_config_proc = load_config_proc
+        end
+      end
+    end
+
+    attr_reader :config
+    attr_accessor :logger
+
+    def reload_config
+      @config = @load_config_proc.call
+
+      @logger_class = @config[:logger_class] || DaemonLogger
+
+      case c = @config[:log]
+      when nil  # default
+        @log_dev = STDERR
+      when "-"
+        @log_dev = STDOUT
+      else
+        @log_dev = c
+      end
+
+      if @logger
+        if @log_dev.is_a?(String)
+          @logger.path = @log_dev
+        end
+
+        @logger.level = @config[:log_level] || 'debug'
+      end
+
+      nil
+    end
+
+    private
+
+    def create_logger
+      if logger = @config[:logger]
+        @logger = logger
+        return
+      end
+
+      @logger = @logger_class.new(@log_dev, @config)
+    end
+  end
+
+end

data/lib/serverengine/daemon.rb

@@ -0,0 +1,165 @@
+#
+# ServerEngine
+#
+# Copyright (C) 2012-2013 FURUHASHI Sadayuki
+#
+#    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.
+#
+module ServerEngine
+
+  require 'shellwords'
+
+  class Daemon
+    include ConfigLoader
+
+    def initialize(server_module, worker_module, load_config_proc={}, &block)
+      @server_module = server_module
+      @worker_module = worker_module
+
+      super(load_config_proc, &block)
+
+      reload_config
+
+      @daemonize = @config.fetch(:daemonize, false)
+
+      if @config.fetch(:supervisor, false)
+        @create_server_proc = lambda do |load_config_proc,logger|
+          s = Supervisor.new(server_module, worker_module, load_config_proc)
+          s.logger = logger
+          s
+        end
+      else
+        @create_server_proc = Supervisor.create_server_proc(server_module, worker_module, @config)
+      end
+
+      @daemon_process_name = @config[:daemon_process_name]
+
+      @pid_path = @config[:pid_path]
+      @chuser = @config[:chuser]
+      @chgroup = @config[:chgroup]
+      @chumask = @config[:chumask]
+    end
+
+    module Signals
+      GRACEFUL_STOP = :TERM
+      IMMEDIATE_STOP = :QUIT
+      GRACEFUL_RESTART = :USR1
+      IMMEDIATE_RESTART = :HUP
+      RELOAD = :USR2
+      DETACH = :INT
+      DUMP = :CONT
+    end
+
+    def self.change_privilege(user, group)
+      if group
+        chgid = group.to_i
+        if chgid.to_s != group
+          chgid = `id -g #{Shellwords.escape group}`.to_i
+          exit! 1 unless $?.success?
+        end
+        Process::GID.change_privilege(chgid)
+      end
+
+      if user
+        chuid = user.to_i
+        if chuid.to_s != user
+          chuid = `id -u #{Shellwords.escape user}`.to_i
+          exit! 1 unless $?.success?
+        end
+
+        user_groups = `id -G #{Shellwords.escape user}`.split.map(&:to_i)
+        exit! 1 unless $?.success?
+
+        Process.groups = Process.groups | user_groups
+        Process::UID.change_privilege(chuid)
+      end
+
+      nil
+    end
+
+    def run
+      begin
+        exit main
+      rescue
+        ServerEngine.dump_uncaught_error($!)
+        exit 1  # TODO exit code
+      end
+    end
+
+    def main
+      unless @daemonize
+        s = create_server(create_logger)
+        s.install_signal_handlers
+        s.main
+        return 0
+      end
+
+      rpipe, wpipe = IO.pipe
+      wpipe.sync = true
+
+      Process.fork do
+        begin
+          rpipe.close
+
+          Process.setsid
+          Process.fork do
+            $0 = @daemon_process_name if @daemon_process_name
+            wpipe.write "#{Process.pid}\n"
+
+            Daemon.change_privilege(@chumask, @chgroup)
+            File.umask(@chumask) if @chumask
+
+            s = create_server(create_logger)
+
+            STDIN.reopen("/dev/null")
+            STDOUT.reopen("/dev/null", "wb")
+            STDERR.reopen("/dev/null", "wb")
+
+            s.install_signal_handlers
+
+            wpipe.write "\n"
+            wpipe.close
+
+            s.main
+          end
+
+          exit 0
+        ensure
+          exit! 1  # TODO exit code
+        end
+      end
+
+      wpipe.close
+
+      pid = rpipe.gets.to_i
+      if @pid_path
+        File.open(@pid_path, "w") {|f|
+          f.write "#{pid}\n"
+        }
+      end
+
+      data = rpipe.read
+      if data != "\n"
+        return 1  # TODO exit code
+      end
+
+      return 0
+    end
+
+    private
+
+    def create_server(logger)
+      @create_server_proc.call(@load_config_proc, logger)
+    end
+  end
+end

data/lib/serverengine/daemon_logger.rb

@@ -0,0 +1,110 @@
+#
+# ServerEngine
+#
+# Copyright (C) 2012 FURUHASHI Sadayuki
+#
+#    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.
+#
+module ServerEngine
+
+  require 'logger'
+
+  class DaemonLogger < Logger
+    def initialize(dev, config={})
+      @hook_stdout = config.fetch(:log_stdout, true)
+      @hook_stderr = config.fetch(:log_stderr, true)
+      rotate_age = config[:log_rotate_age] || 5
+      rotate_size = config[:log_rotate_size] || 1048576
+
+      if dev.is_a?(String)
+        @path = dev
+        @io = File.open(@path, "a")
+        @io.sync = true
+      else
+        @io = dev
+      end
+
+      hook_stdout! if @hook_stdout
+      hook_stderr! if @hook_stderr
+
+      super(@io, rotate_age, rotate_size)
+
+      self.level = config[:level] || 'debug'
+    end
+
+    attr_accessor :path
+
+    def level=(expr)
+      case expr.to_s
+      when 'fatal', Logger::FATAL.to_s
+        e = Logger::FATAL
+      when 'error', Logger::ERROR.to_s
+        e = Logger::ERROR
+      when 'warn', Logger::WARN.to_s
+        e = Logger::WARN
+      when 'info', Logger::INFO.to_s
+        e = Logger::INFO
+      when 'debug', Logger::DEBUG.to_s
+        e = Logger::DEBUG
+      else
+        raise ArgumentError, "invalid log level: #{expr}"
+      end
+
+      super(e)
+    end
+
+    def hook_stdout!
+      STDOUT.sync = true
+      @hook_stdout = true
+
+      STDOUT.reopen(@io) if @io != STDOUT
+      self
+    end
+
+    def hook_stderr!
+      STDERR.sync = true
+      @hook_stderr = true
+
+      STDERR.reopen(@io) if @io != STDERR
+      self
+    end
+
+    def reopen!
+      if @path
+        @io.reopen(@path, "a")
+        @io.sync = true
+        hook_stdout! if @hook_stdout
+        hook_stderr! if @hook_stderr
+      end
+      nil
+    end
+
+    def reopen
+      begin
+        reopen!
+        return true
+      rescue
+        # TODO log?
+        return false
+      end
+    end
+
+    def close
+      if @path
+        @io.close unless @io.closed?
+      end
+      nil
+    end
+  end
+
+end

data/lib/serverengine/embedded_server.rb

@@ -0,0 +1,47 @@
+#
+# ServerEngine
+#
+# Copyright (C) 2012-2013 FURUHASHI Sadayuki
+#
+#    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.
+#
+module ServerEngine
+
+  class EmbeddedServer < Server
+    def run
+      @worker = create_worker(0)
+      until @stop
+        @worker.main
+      end
+    end
+
+    def stop(stop_graceful)
+      super
+      Thread.new { @worker.stop }
+      nil
+    end
+
+    def restart(stop_graceful)
+      super
+      Thread.new { @worker.stop }
+      nil
+    end
+
+    def reload
+      super
+      Thread.new { @worker.reload }
+      nil
+    end
+  end
+
+end

data/lib/serverengine/multi_process_server.rb

@@ -0,0 +1,132 @@
+#
+# ServerEngine
+#
+# Copyright (C) 2012-2013 FURUHASHI Sadayuki
+#
+#    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.
+#
+module ServerEngine
+
+  class MultiProcessServer < MultiWorkerServer
+    def initialize(worker_module, load_config_proc={}, &block)
+      @pm = ProcessManager.new(
+        auto_tick: false,
+        graceful_kill_signal: Daemon::Signals::GRACEFUL_STOP,
+        auto_heartbeat: true,
+        abort_on_heartbeat_error: Proc.new do
+          @logger.fatal "parent process unexpectedly terminated"
+          exit! 1
+        end
+      )
+
+      super(worker_module, load_config_proc, &block)
+
+      @worker_process_name = @config[:worker_process_name]
+    end
+
+    def run
+      super
+    ensure
+      @pm.close
+    end
+
+    def logger=(logger)
+      super
+      @pm.logger = logger
+    end
+
+    private
+
+    def reload_config
+      super
+
+      @chuser = @config[:worker_chuser]
+      @chgroup = @config[:worker_chgroup]
+      @chumask = @config[:worker_chumask]
+
+      @pm.configure(@config, prefix: 'worker_')
+
+      nil
+    end
+
+    def start_worker(wid)
+      w = create_worker(wid)
+
+      w.before_fork
+      begin
+        pmon = @pm.fork do |t|
+          $0 = @worker_process_name % [wid] if @worker_process_name
+          w.install_signal_handlers
+
+          Daemon.change_privilege(@chumask, @chgroup)
+          File.umask(@chumask) if @chumask
+
+          ## recreate the logger created at Server#main
+          #create_logger
+
+          w.main
+        end
+
+      ensure
+        w.close
+      end
+
+      return WorkerMonitor.new(w, wid, pmon)
+    end
+
+    def wait_tick
+      @pm.tick(0.5)
+    end
+
+    class WorkerMonitor
+      def initialize(worker, wid, pmon)
+        @worker = worker
+        @wid = wid
+        @pmon = pmon
+      end
+
+      def send_stop(stop_graceful)
+        @stop = true
+        if stop_graceful
+          @pmon.start_graceful_stop! if @pmon
+        else
+          @pmon.start_immediate_stop! if @pmon
+        end
+        nil
+      end
+
+      def send_reload
+        @pmon.send_signal(Daemon::Signals::RELOAD) if @pmon
+        nil
+      end
+
+      #def join
+      #  @pmon.join if @pmon
+      #  nil
+      #end
+
+      def alive?
+        return false unless @pmon
+
+        if stat = @pmon.try_join
+          @worker.logger.info "Worker #{@wid} finished#{@stop ? '' : ' unexpectedly'} with #{ProcessManager.format_join_status(stat)}"
+          @pmon = nil
+          return false
+        else
+          return true
+        end
+      end
+    end
+  end
+
+end