pylon 0.1.1

data/lib/pylon.rb

@@ -0,0 +1,19 @@
+# Author:: AJ Christensen (<aj@junglist.gen.nz>)
+# Copyright:: Copyright (c) 2011 AJ Christensen
+# License:: Apache License, Version 2.0
+#
+# 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.
+
+class Pylon
+  VERSION = "0.1.1"
+end

data/lib/pylon/application.rb

@@ -0,0 +1,161 @@
+#
+# Author:: AJ Christensen (<aj@junglist.gen.nz>)
+# Copyright:: Copyright (c) 2011 AJ Christensen
+# License:: Apache License, Version 2.0
+#
+# 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 "mixlib/cli"
+require_relative "config"
+require_relative "log"
+require_relative "daemon"
+require_relative "elector"
+
+class Pylon
+  class Application
+    class << self
+      def fatal! message, error_code = -1
+        Pylon::Log.fatal message
+        Process.exit error_code
+      end
+
+    end
+
+    include Mixlib::CLI
+
+    def configure_logging
+      Pylon::Log.init(Pylon::Config[:log_location])
+      if ( Pylon::Config[:log_location] != STDOUT ) && STDOUT.tty? && (!Pylon::Config[:daemonize])
+        stdout_logger = Logger.new(STDOUT)
+        STDOUT.sync = true
+        stdout_logger.formatter = Pylon::Log.logger.formatter
+        Pylon::Log.loggers <<  stdout_logger
+      end
+      Pylon::Log.level = Pylon::Config[:log_level]
+    end
+
+    def run argv=ARGV
+      parse_options(argv)
+      Pylon::Config.merge!(config)
+      configure_logging
+      Pylon::Log.info "Pylon #{Pylon::VERSION} warming up"
+
+      Pylon::Daemon.change_privilege
+      Pylon::Daemon.daemonize "pylon" if Pylon::Config[:daemonize]
+
+      elector = Pylon::Elector.new
+    end
+
+    def initialize
+      super
+      trap("TERM") do
+        Pylon::Application.fatal!("SIGTERM received, stopping", 1)
+      end
+
+      trap("INT") do
+        Pylon::Application.fatal!("SIGINT received, stopping", 2)
+      end
+
+      unless RUBY_PLATFORM =~ /mswin|mingw32|windows/
+        trap("QUIT") do
+          Pylon::Log.info("SIGQUIT received, call stack:\n  " + caller.join("\n  "))
+        end
+
+        trap("HUP") do
+          Pylon::Log.info("SIGHUP received, reconfiguring")
+          # reconfigure
+        end
+      end
+    end
+
+    option :config_file,
+    :short => "-c CONFIG",
+    :long  => "--config CONFIG",
+    :default => 'config.rb',
+    :description => "The configuration file to use"
+
+    option :log_level,
+    :short => "-l LEVEL",
+    :long  => "--log_level LEVEL",
+    :description => "Set the log level (debug, info, warn, error, fatal)",
+    :required => true,
+    :proc => Proc.new { |l| l.to_sym }
+
+    option :help,
+    :short => "-h",
+    :long => "--help",
+    :description => "Show this message",
+    :on => :tail,
+    :boolean => true,
+    :show_options => true,
+    :exit => 0
+
+    option :daemonize,
+    :short => "-d",
+    :long => "--daemonize",
+    :description => "send pylon to the background",
+    :proc => lambda { |p| true }
+
+    option :user,
+    :short => "-u USER",
+    :long => "--user USER",
+    :description => "User to set privilege to",
+    :proc => nil
+
+    option :group,
+    :short => "-g GROUP",
+    :long => "--group GROUP",
+    :description => "Group to set privilege to",
+    :proc => nil
+
+    option :multicast_address,
+    :short => "-a ADDRESS",
+    :long => "--multicast-address ADDRESS",
+    :description => "Address to use for UDP multicast"
+
+    option :multicast_port,
+    :short => "-p PORT",
+    :long => "--multicast-port PORT",
+    :description => "Port to use for UDP multicast"
+
+    option :multicast_loopback,
+    :short => "-L",
+    :long => "--multicast-loopback",
+    :description => "Enable multicast over loopback interfaces",
+    :proc => lambda { |loop| true }
+
+    option :interface,
+    :short => "-i INTERFACE",
+    :long => "--interface INTERFACE",
+    :description => "Interface to use to send multicast over"
+
+    option :tcp_address,
+    :short => "-t TCPADDRESS",
+    :long => "--tcp-address TCPADDRESS",
+    :description => "Interface to use to bind request socket to"
+    
+    option :tcp_port,
+    :short => "-P TCPPORT",
+    :long => "--tcp-port TCPPORT",
+    :description => "Port to bind request socket to"
+
+    option :minimum_master_nodes,
+    :short => "-m NODES",
+    :long => "--minimum-master-nodes NODES",
+    :description => "How many nodes to wait for before starting master election",
+    :proc => lambda { |nodes| nodes.to_i }
+
+  end
+end
+

data/lib/pylon/config.rb

@@ -0,0 +1,61 @@
+#
+# Author:: AJ Christensen (<aj@junglist.gen.nz>)
+# Copyright:: Copyright (c) 2011 AJ Christensen
+# License:: Apache License, Version 2.0
+#
+# 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 "mixlib/config"
+
+class Pylon
+  class Config
+    extend Mixlib::Config
+
+    config_file "~/.pylon.rb"
+    log_level :info
+    log_location STDOUT
+    daemonize false
+    user nil
+    group nil
+    umask 0022
+
+    # Options for the multicast server
+    multicast true
+    multicast_address "225.4.5.6"
+    multicast_port "13336"
+    multicast_ttl 3
+    multicast_listen_address nil
+    multicast_loopback false
+    interface_address "127.0.0.1"
+
+    # TCP settings
+    tcp_address "*"
+    tcp_port "13335"
+    tcp_retries 10
+    tcp_timeout 5
+
+    # cluster settings
+    maximum_weight 1000
+    cluster_name "pylon"
+    Seed_tcp_endpoints []
+    master nil
+    minimum_master_nodes 1
+    sleep_after_announce 5
+
+    # TODO: not implemented
+    ping_interval 1
+    ping_timeout 30
+    ping_retries 3
+
+  end
+end

data/lib/pylon/daemon.rb

@@ -0,0 +1,171 @@
+#
+# Author:: AJ Christensen (<aj@junglist.gen.nz>)
+# Copyright:: Copyright (c) 2011 AJ Christensen
+# License:: Apache License, Version 2.0
+#
+# 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 "etc"
+require_relative "application"
+require_relative "config" 
+ 
+class Pylon
+  class Daemon
+    class << self
+      attr_accessor :name
+ 
+      # Daemonize the current process, managing pidfiles and process uid/gid
+      #
+      # === Parameters
+      # name<String>:: The name to be used for the pid file
+      #
+      def daemonize(name)
+        @name = name
+        pid = pid_from_file
+        unless running?
+          remove_pid_file()
+          Pylon::Log.info("Daemonizing..")
+          begin
+            exit if fork
+            Process.setsid
+            exit if fork
+            Pylon::Log.info("Forked, in #{Process.pid}. Priveleges: #{Process.euid} #{Process.egid}")
+            File.umask Pylon::Config[:umask]
+            $stdin.reopen("/dev/null")
+            $stdout.reopen("/dev/null", "a")
+            $stderr.reopen($stdout)
+            save_pid_file
+            at_exit { remove_pid_file }
+          rescue NotImplementedError => e
+            Pylon::Application.fatal!("There is no fork: #{e.message}")
+          end
+        else
+          Pylon::Application.fatal!("Pylon is already running pid #{pid}")
+        end
+      end
+   
+      # Check if Pylon is running based on the pid_file
+      # ==== Returns
+      # Boolean::
+      # True if Pylon is running
+      # False if Pylon is not running
+      #
+      def running?
+        if pid_from_file.nil?
+          false
+        else
+          Process.kill(0, pid_from_file)
+          true
+        end
+      rescue Errno::ESRCH, Errno::ENOENT
+        false
+      rescue Errno::EACCES => e
+        Pylon::Application.fatal!("You don't have access to the PID file at #{pid_file}: #{e.message}")
+      end
+       
+      # Gets the pid file for @name
+      # ==== Returns
+      # String::
+      #   Location of the pid file for @name
+      def pid_file
+         Pylon::Config[:pid_file] or "/tmp/#{@name}.pid"
+      end
+       
+      # Suck the pid out of pid_file
+      # ==== Returns
+      # Integer::
+      #   The PID from pid_file
+      # nil::
+      #   Returned if the pid_file does not exist.
+      #
+      def pid_from_file
+        File.read(pid_file).chomp.to_i
+      rescue Errno::ENOENT, Errno::EACCES
+        nil
+      end
+     
+      # Store the PID on the filesystem
+      # This uses the Pylon::Config[:pid_file] option, or "/tmp/name.pid" otherwise
+      #
+      def save_pid_file
+        file = pid_file
+        begin
+          FileUtils.mkdir_p(File.dirname(file))
+        rescue Errno::EACCES => e
+          Pylon::Application.fatal!("Failed store pid in #{File.dirname(file)}, permission denied: #{e.message}")
+        end
+       
+        begin
+          File.open(file, "w") { |f| f.write(Process.pid.to_s) }
+        rescue Errno::EACCES => e
+          Pylon::Application.fatal!("Couldn't write to pidfile #{file}, permission denied: #{e.message}")
+        end
+      end
+     
+      # Delete the PID from the filesystem
+      def remove_pid_file
+        FileUtils.rm(pid_file) if File.exists?(pid_file)
+      end
+            
+      # Change process user/group to those specified in Pylon::Config
+      #
+      def change_privilege
+        Dir.chdir("/")
+ 
+        if Pylon::Config[:user] and Pylon::Config[:group]
+          Pylon::Log.info("About to change privilege to #{Pylon::Config[:user]}:#{Pylon::Config[:group]}")
+          _change_privilege(Pylon::Config[:user], Pylon::Config[:group])
+        elsif Pylon::Config[:user]
+          Pylon::Log.info("About to change privilege to #{Pylon::Config[:user]}")
+          _change_privilege(Pylon::Config[:user])
+        end
+      end
+     
+      # Change privileges of the process to be the specified user and group
+      #
+      # ==== Parameters
+      # user<String>:: The user to change the process to.
+      # group<String>:: The group to change the process to.
+      #
+      # ==== Alternatives
+      # If group is left out, the user will be used (changing to user:user)
+      #
+      def _change_privilege(user, group=user)
+        uid, gid = Process.euid, Process.egid
+ 
+        begin
+          target_uid = Etc.getpwnam(user).uid
+        rescue ArgumentError => e
+          Pylon::Application.fatal!("Failed to get UID for user #{user}, does it exist? #{e.message}")
+          return false
+        end
+    
+        begin
+          target_gid = Etc.getgrnam(group).gid
+        rescue ArgumentError => e
+          Pylon::Application.fatal!("Failed to get GID for group #{group}, does it exist? #{e.message}")
+          return false
+        end
+       
+        if (uid != target_uid) or (gid != target_gid)
+          Process.initgroups(user, target_gid)
+          Process::GID.change_privilege(target_gid)
+          Process::UID.change_privilege(target_uid)
+        end
+        true
+      rescue Errno::EPERM => e
+        Pylon::Application.fatal!("Permission denied when trying to change #{uid}:#{gid} to #{target_uid}:#{target_gid}. #{e.message}")
+      end
+    end
+  end
+end

data/lib/pylon/elector.rb

@@ -0,0 +1,164 @@
+#
+# Author:: AJ Christensen (<aj@junglist.gen.nz>)
+# Copyright:: Copyright (c) 2011 AJ Christensen
+# License:: Apache License, Version 2.0
+#
+# 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 "uuidtools"
+require "ffi-rzmq"
+require "thread"
+require "json"
+require_relative "node"
+
+class Pylon
+  class Elector
+
+    attr_accessor :cluster_name, :context, :multicast_endpoint, :node, :nodes, :multicast_announcer_thread, :multicast_listener_thread, :tcp_listener_thread, :master
+
+    def initialize
+      @cluster_name = Pylon::Config[:cluster_name]
+      @context = ZMQ::Context.new(1)
+
+      @node = Pylon::Node.new
+      @nodes = Array(@node)
+      @master = Pylon::Config[:master]
+
+      Pylon::Log.info "elector[#{cluster_name}] initialized, starting pub/sub sockets on #{multicast_endpoint} and tcp listener socket on #{node.unicast_endpoint}"
+
+      Thread.abort_on_exception = true
+      
+      scheduler = Thread.new do
+        @unicast_announcer_thread = node.unicast_announcer
+        @multicast_announcer_thread = node.multicast_announcer
+        @multicast_listener_thread = multicast_listener
+
+        @multicast_listener_thread.join
+        @unicast_announcer_thread.join
+        @multicast_announcer_thread.join
+      end
+      scheduler.join
+
+      # join listeners
+      # @unicast_announcer_thread.join
+      # @tcp_listener_thread.join
+      # sleep 5
+      # @multicast_announcer_thread.join
+
+      at_exit do
+        Log.debug "cleaning up zeromq context"
+        @context.terminate
+      end
+    end
+
+    def stop_announcer
+      @multicast_announcer_thread.stop
+    end
+
+    def run_announcer
+      @multicast_announcer.thread.run
+    end
+
+    def pause_listeners
+      @tcp_listener_thread.stop
+      @multicast_listener_thread.stop
+    end
+
+    def run_listeners
+      @tcp_listener_thread.run
+      @multicst_listener_thread.run
+    end
+
+    def unicast_endpoint
+      @unicast_endpoint ||= "tcp://#{Pylon::Config[:tcp_address]}:#{Pylon::Config[:tcp_port]}"
+    end
+
+    def multicast_endpoint
+      @multicast_endpoint ||= "epgm://#{Pylon::Config[:interface]};#{Pylon::Config[:multicast_address]}:#{Pylon::Config[:multicast_port]}"
+    end
+
+    def add_node node
+      @nodes << node unless @nodes.include? node
+    end
+
+    def multicast_listener
+      Thread.new do
+        Log.debug "multicast_listener: zeromq sub socket starting up on #{@multicast_endpoint}"
+        sub_socket = context.socket ZMQ::SUB
+        sub_socket.setsockopt ZMQ::IDENTITY, "node"
+        sub_socket.setsockopt ZMQ::SUBSCRIBE, ""
+        sub_socket.setsockopt ZMQ::RATE, 1000
+        sub_socket.setsockopt ZMQ::MCAST_LOOP, Pylon::Config[:multicast_loopback]
+        sub_socket.connect multicast_endpoint
+        loop do
+          uuid = sub_socket.recv_string
+          Log.debug "multicast_listener: handling announce from #{uuid}"
+          handle_announce sub_socket.recv_string if sub_socket.more_parts?
+        end
+      end
+    end
+
+    def allocate_master
+      if node.uuid == nodes.sort.first.uuid
+        @master = true
+        Log.info "allocate_master: master allocated"
+        nodes.each do |node|
+          connect_node node.uuid.to_s, node.unicast_endpoint
+        end
+      else
+        Log.info "allocate_master: someone else is the master, getting ready for work"
+        @master = false
+      end
+    end
+
+    def handle_announce recv_string
+      Log.info "handle_announce: got string #{recv_string}"
+      node = JSON.parse(recv_string)
+      Log.info "handle_anounce: got announce from #{node}"
+      if master
+        Log.info "handle_announce: I am the master: updating #{node} of leadership status"
+        connect_node(node.uuid.to_s, node.unicast_endpoint)
+      elsif nodes.length < Pylon::Config[:minimum_master_nodes]
+        if nodes.include? node
+          Log.info "handle_announce: skipping node #{node}, already known"
+          Log.debug "handle_announce: nodes: #{nodes}"
+        else
+          Log.info "handle_announce: subscribing for #{node} on endpoint: #{node.unicast_endpoint}"
+          connect_node(node.uuid.to_s, node.unicast_endpoint)
+        end
+      else
+        allocate_master
+      end
+    end
+
+    def connect_node uuid, endpoint
+      Log.debug "connect_node: subscribe socket connecting to #{endpoint}"
+      sub_socket = context.socket ZMQ::SUB
+      sub_socket.setsockopt ZMQ::IDENTITY, uuid
+      sub_socket.setsockopt ZMQ::SUBSCRIBE, uuid
+      sub_socket.connect endpoint
+      uuid = sub_socket.recv_string
+      Log.debug "connect_node: got uuid on sub socket, parsing node"
+      new_node = JSON.parse(sub_socket.recv_string) if sub_socket.more_parts?
+      Log.debug "connect_node: node: #{new_node}"
+      if nodes.include? new_node
+        Log.info "connect_node: skipping node #{new_node}, already in local list, sleeping for 60 secs"
+        Log.debug "connect_node: nodes: #{nodes}"
+        sleep 60
+      else
+        Log.info "connect_node: connected to node #{new_node}, adding to local list"
+        add_node new_node
+      end
+    end
+  end
+end