openflow-controller 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99acd8cee866cea479b4d67a120f30ff34a8d37c
-  data.tar.gz: 235d1054c24087989ab7e8376cd87ce2888ab358
+  metadata.gz: 21f97d89fd5cca91d616a17cc08cb2923bc04752
+  data.tar.gz: f1025ee07213791f7d3472d8b76026a0ac9ba00f
 SHA512:
-  metadata.gz: 64908187a2d746e6847e8f3c0d0fe1c0da44631f419573dee622822a08474a053c5ba2ca2a01b1b4384d11ad05a499f4bd3b3fb82bfad2c440fed3a25a5d5e9b
-  data.tar.gz: 85f1531795e99ef97a2e38e92c0c63d2163243e9011a4afb91e9eeedddb69688b8566dd985de656faab6058a94e65d731328f8dc3e9618e1dce31cf04c0ba9f2
+  metadata.gz: 38f589db1750a5395e5b32efa14a249d06b0530c178fcf649a9c5933ae63cba3f1ce9f3b482f996fc979b6e38e017d4c75d5aa551f82aee3ef201c270fa795c0
+  data.tar.gz: 6ed5c77459538dd5a16fabe2689886a1a6360b41512998f62d284fe2b19f43ea9b843649ea4d3ea2544c2c3a97954be8be898562d85d680692678ae51fe39545

data/bin/ofctl

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
 require 'cri'
 require 'readline'
-require_relative '../lib/controller'
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'openflow-controller'
 
 PROMPT = '> '
 BYE_MSG = 'Bye!'
@@ -27,7 +28,7 @@ command = Cri::Command.define do
 
     debug = opts[:debug] || false
 
-    ctl = OFController.create(debug)
+    ctl = OpenFlow::Controller::Controller.create(debug)
 
     init_form = ctl.logger.formatter
     ctl.logger.formatter = proc do |severity, datetime, progname, msg|
@@ -37,8 +38,8 @@ command = Cri::Command.define do
       buf
     end
 
-    ip   = opts[:ip]   || OFController::DEFAULT_IP_ADDRESS
-    port = opts[:port] || OFController::DEFAULT_TCP_PORT
+    ip   = opts[:ip]   || OpenFlow::Controller::Controller::DEFAULT_IP_ADDRESS
+    port = opts[:port] || OpenFlow::Controller::Controller::DEFAULT_TCP_PORT
 
     Thread.abort_on_exception = true
     Thread.new do

data/lib/openflow-controller.rb

@@ -1 +1,2 @@
-require_relative 'controller'
+require 'openflow-controller/version'
+require 'openflow-controller/controller'

data/lib/openflow-controller/controller.rb

@@ -0,0 +1,195 @@
+require 'socket'
+require 'logger'
+require 'openflow-controller/switch'
+
+class Numeric
+  def sec; self end
+end
+
+module OpenFlow
+  module Controller
+    class Controller
+      include Protocol
+
+      DEFAULT_IP_ADDRESS = '0.0.0.0'
+      DEFAULT_TCP_PORT   = 6633
+
+      def self.inherited(subclass)
+        @controller_class = subclass
+      end
+
+      def self.create(*args)
+        (@controller_class || self).new(*args)
+      end
+
+      def self.timer_event(handler, options)
+        @timer_handlers ||= {}
+        @timer_handlers[handler] = options.fetch(:interval)
+      end
+
+      def self.timer_handlers
+        @timer_handlers || {}
+      end
+
+      attr_reader :logger
+
+      def initialize(debug = false)
+        @switches = {}
+        @messages = {}
+        @logger = Logger.new($stdout).tap do |logger|
+          logger.formatter = proc do |severity, datetime, _progname, msg|
+            "#{datetime} (#{severity}) -- #{msg}\n"
+          end
+          logger.level = debug ? Logger::DEBUG : Logger::INFO
+        end
+      end
+
+      def eval(input)
+        binding.eval(input)
+      end
+
+      def run(ip = DEFAULT_IP_ADDRESS, port = DEFAULT_TCP_PORT, *args)
+        maybe_send_handler :start, *args
+        socket = TCPServer.open(ip, port)
+        socket.setsockopt(:SOCKET, :REUSEADDR, true)
+        logger.info "Controller running on #{ip}:#{port}."
+        start_timers
+        loop { start_switch_thread socket.accept }
+      end
+
+      def datapath_ids
+        @switches.keys.map(&:to_i)
+      end
+
+      def switches
+        @switches.values
+      end
+
+      def send_message(datapath_id, msg = nil)
+        if msg.nil?
+          msg         = datapath_id
+          datapath_id = datapath_ids.first
+        end
+        @switches.fetch(datapath_id.to_s).send(msg)
+      end
+
+      def broadcast(msg)
+        datapath_ids.each { |did| send_message did, msg }
+      end
+
+      def messages_for(datapath_id)
+        @messages.fetch(datapath_id.to_s)
+      end
+
+      def last_message_for(datapath_id)
+        messages_for(datapath_id).last
+      end
+
+      def messages
+        messages_for datapath_ids.first
+      end
+
+      def last_message
+        messages.last
+      end
+
+      def start(*_args) end
+      def switch_ready(_datapath_id) end
+      def message_received(_datapath_id, _msg) end
+      def error(_datapath_id, _msg) end
+      def echo_request(datapath_id, msg)
+        send_message datapath_id, EchoReply.new(xid: msg.xid)
+      end
+      def packet_in(_datapath_id, _msg) end
+      def port_add(_datapath_id, _msg) end
+      def port_delete(_datapath_id, _msg) end
+      def port_modify(_datapath_id, _msg) end
+      def flow_removed(_datapath_id, _msg) end
+
+      private
+
+      def maybe_send_handler(handler, *args)
+        @handler_mutex ||= Mutex.new
+        @handler_mutex.synchronize do
+          __send__(handler, *args) if respond_to?(handler)
+        end
+      end
+
+      def start_timers
+        self.class.timer_handlers.each do |handler, interval|
+          Thread.new do
+            loop do
+              maybe_send_handler handler
+              sleep interval
+            end
+          end
+        end
+      end
+
+      def start_switch_thread(socket)
+        logger.debug 'Socket accepted.'
+        Thread.new do
+          switch = create_and_register_new_switch(socket)
+          start_switch_main(switch.datapath_id)
+        end
+      end
+
+      def create_and_register_new_switch(socket)
+        switch = Switch.new(self, socket)
+        @messages[switch.datapath_id.to_s] = []
+        @switches[switch.datapath_id.to_s] = switch
+      end
+
+      def start_switch_main(datapath_id)
+        logger.info "Switch #{datapath_id} is ready."
+        maybe_send_handler :switch_ready, datapath_id
+        loop { handle_openflow_message(datapath_id) }
+      rescue => exception
+        logger.debug "Switch #{datapath_id} error: #{exception}."
+        logger.debug exception.backtrace
+        unregister_switch(datapath_id)
+      end
+
+      def unregister_switch(datapath_id)
+        @messages.delete(datapath_id.to_s)
+        @switches.delete(datapath_id.to_s)
+        logger.info "Switch #{datapath_id} is disconnected."
+        maybe_send_handler :switch_disconnected, datapath_id
+      end
+
+      def handle_openflow_message(datapath_id)
+        msg = @switches.fetch(datapath_id.to_s).receive
+
+        unless msg.class == EchoRequest
+          logger.debug "Switch #{datapath_id} received #{msg.type} message."
+          @messages[datapath_id.to_s] << msg
+          maybe_send_handler :message_received, datapath_id, msg
+        end
+
+        case msg
+        when Error
+          maybe_send_handler :error, datapath_id, msg
+        when EchoRequest
+          maybe_send_handler :echo_request, datapath_id, msg
+        when FeaturesReply
+          maybe_send_handler :features_reply, datapath_id, msg
+        when PacketIn
+          maybe_send_handler :packet_in, datapath_id, msg
+        when PortStatus
+          case msg.reason
+          when :add
+            maybe_send_handler :port_add, datapath_id, msg
+          when :delete
+            maybe_send_handler :port_delete, datapath_id, msg
+          when :modify
+            maybe_send_handler :port_modify, datapath_id, msg
+          # else
+          end
+        when FlowRemoved
+          maybe_send_handler :flow_removed, datapath_id, msg
+        # else
+        end
+      end
+    end
+  end
+end

data/lib/openflow-controller/switch.rb

@@ -0,0 +1,58 @@
+require 'openflow-protocol'
+
+module OpenFlow
+  module Controller
+    class Switch
+      include Protocol
+
+      attr_reader :controller, :features_reply
+
+      def initialize(controller, socket)
+        @controller = controller
+        @socket     = socket
+        begin
+          exchange_hello_messages
+          exchange_echo_messages
+          exchange_features_messages
+        rescue => exception
+          controller.logger.debug "Switch error: #{exception}."
+          raise exception
+        end
+      end
+
+      def send(msg)
+        @socket.write msg.to_binary_s
+      end
+
+      def receive
+        Parser.read @socket
+      end
+
+      def datapath_id
+        @features_reply.datapath_id
+      end
+
+      private
+
+      def exchange_hello_messages
+        controller.logger.debug 'Wait OFPT_HELLO.'
+        fail unless receive.is_a?(Hello)
+        send Hello.new
+      end
+
+      def exchange_echo_messages
+        send EchoRequest.new
+        controller.logger.debug 'Wait OFPT_ECHO_REPLY.'
+        fail unless receive.is_a?(EchoReply)
+      end
+
+      def exchange_features_messages
+        send FeaturesRequest.new
+        controller.logger.debug 'Wait OFPT_FEATURES_REPLY.'
+        @features_reply = receive
+        controller.logger.debug "OFPT_FEATURES_REPLY.datapath_id: #{datapath_id}."
+        fail unless @features_reply.is_a?(FeaturesReply)
+      end
+    end
+  end
+end

data/lib/openflow-controller/version.rb

@@ -1,5 +1,5 @@
 module OpenFlow
   module Controller
-    VERSION = '0.1.8'
+    VERSION = '0.1.9'
   end
 end

data/spec/controller_spec.rb

@@ -1,8 +1,6 @@
-require 'spec_helper'
-
-describe OFController do
+describe Controller do
   before(:all) do
-    class MyCtl < OFController
+    class MyCtl < Controller
       attr_reader :start_args
 
       def start(*args)
@@ -10,7 +8,7 @@ describe OFController do
       end
     end
 
-    @ctl = OFController.create
+    @ctl = Controller.create
     Thread.new { @ctl.run('127.0.0.1', 4242, 'Hello World!', 42) }
   end
 
@@ -27,20 +25,20 @@ describe OFController do
     socket = TCPSocket.new '127.0.0.1', 4242
 
     # Exchange Hello messages
-    socket.write OFHello.new.to_binary_s
-    msg = OFParser.read socket
-    expect(msg.class).to be(OFHello)
+    socket.write Hello.new.to_binary_s
+    sleep(0.001)
+    msg = Parser.read socket
+    expect(msg.class).to be(Hello)
 
     # Exchange Echo messages
-    msg = OFParser.read socket
-    expect(msg.class).to be(OFEchoRequest)
-    # socket.write msg.to_reply.to_binary_s
-    socket.write OFEchoReply.new.to_binary_s
+    msg = Parser.read socket
+    expect(msg.class).to be(EchoRequest)
+    socket.write msg.to_reply.to_binary_s
 
     # Exchange Features messages
-    msg = OFParser.read socket
-    expect(msg.class).to be(OFFeaturesRequest)
-    socket.write OFFeaturesReply.new(datapath_id: 1).to_binary_s
+    msg = Parser.read socket
+    expect(msg.class).to be(FeaturesRequest)
+    socket.write FeaturesReply.new(datapath_id: 1).to_binary_s
 
     sleep(0.001)
     expect(@ctl.switches.length).to eq(1)

data/spec/spec_helper.rb

@@ -1 +1,3 @@
-require_relative '../lib/openflow-controller'
+require 'openflow-controller'
+include OpenFlow::Controller
+include OpenFlow::Protocol

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openflow-controller
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Jérémy Pagé
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.7
+        version: 0.1.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.7
+        version: 0.1.8
 - !ruby/object:Gem::Dependency
   name: colored
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -75,10 +89,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/ofctl
-- lib/controller.rb
 - lib/openflow-controller.rb
+- lib/openflow-controller/controller.rb
+- lib/openflow-controller/switch.rb
 - lib/openflow-controller/version.rb
-- lib/switch.rb
 - spec/controller_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/jejepage/openflow-controller

data/lib/controller.rb

@@ -1,189 +0,0 @@
-require 'socket'
-require 'logger'
-require_relative 'switch'
-
-class Numeric
-  def sec; self end
-end
-
-class OFController
-  DEFAULT_IP_ADDRESS = '0.0.0.0'
-  DEFAULT_TCP_PORT   = 6633
-
-  def self.inherited(subclass)
-    @controller_class = subclass
-  end
-
-  def self.create(*args)
-    (@controller_class || self).new(*args)
-  end
-
-  def self.timer_event(handler, options)
-    @timer_handlers ||= {}
-    @timer_handlers[handler] = options.fetch(:interval)
-  end
-
-  def self.timer_handlers
-    @timer_handlers || {}
-  end
-
-  attr_reader :logger
-
-  def initialize(debug = false)
-    @switches = {}
-    @messages = {}
-    @logger = Logger.new($stdout).tap do |logger|
-      logger.formatter = proc do |severity, datetime, _progname, msg|
-        "#{datetime} (#{severity}) -- #{msg}\n"
-      end
-      logger.level = debug ? Logger::DEBUG : Logger::INFO
-    end
-  end
-
-  def eval(input)
-    binding.eval(input)
-  end
-
-  def run(ip = DEFAULT_IP_ADDRESS, port = DEFAULT_TCP_PORT, *args)
-    maybe_send_handler :start, *args
-    socket = TCPServer.open(ip, port)
-    socket.setsockopt(:SOCKET, :REUSEADDR, true)
-    logger.info "Controller running on #{ip}:#{port}."
-    start_timers
-    loop { start_switch_thread socket.accept }
-  end
-
-  def datapath_ids
-    @switches.keys.map(&:to_i)
-  end
-
-  def switches
-    @switches.values
-  end
-
-  def send_message(datapath_id, msg = nil)
-    if msg.nil?
-      msg         = datapath_id
-      datapath_id = datapath_ids.first
-    end
-    @switches.fetch(datapath_id.to_s).send(msg)
-  end
-
-  def broadcast(msg)
-    datapath_ids.each { |did| send_message did, msg }
-  end
-
-  def messages_for(datapath_id)
-    @messages.fetch(datapath_id.to_s)
-  end
-
-  def last_message_for(datapath_id)
-    messages_for(datapath_id).last
-  end
-
-  def messages
-    messages_for datapath_ids.first
-  end
-
-  def last_message
-    messages.last
-  end
-
-  def start(*_args) end
-  def switch_ready(_datapath_id) end
-  def message_received(_datapath_id, _msg) end
-  def error(_datapath_id, _msg) end
-  def echo_request(datapath_id, msg)
-    send_message datapath_id, OFEchoReply.new(xid: msg.xid)
-  end
-  def packet_in(_datapath_id, _msg) end
-  def port_add(_datapath_id, _msg) end
-  def port_delete(_datapath_id, _msg) end
-  def port_modify(_datapath_id, _msg) end
-  def flow_removed(_datapath_id, _msg) end
-
-  private
-
-  def maybe_send_handler(handler, *args)
-    @handler_mutex ||= Mutex.new
-    @handler_mutex.synchronize do
-      __send__(handler, *args) if respond_to?(handler)
-    end
-  end
-
-  def start_timers
-    self.class.timer_handlers.each do |handler, interval|
-      Thread.new do
-        loop do
-          maybe_send_handler handler
-          sleep interval
-        end
-      end
-    end
-  end
-
-  def start_switch_thread(socket)
-    logger.debug 'Socket accepted.'
-    Thread.new do
-      switch = create_and_register_new_switch(socket)
-      start_switch_main(switch.datapath_id)
-    end
-  end
-
-  def create_and_register_new_switch(socket)
-    switch = OFSwitch.new(self, socket)
-    @messages[switch.datapath_id.to_s] = []
-    @switches[switch.datapath_id.to_s] = switch
-  end
-
-  def start_switch_main(datapath_id)
-    logger.info "Switch #{datapath_id} is ready."
-    maybe_send_handler :switch_ready, datapath_id
-    loop { handle_openflow_message(datapath_id) }
-  rescue => exception
-    logger.debug "Switch #{datapath_id} error: #{exception}."
-    logger.debug exception.backtrace
-    unregister_switch(datapath_id)
-  end
-
-  def unregister_switch(datapath_id)
-    @messages.delete(datapath_id.to_s)
-    @switches.delete(datapath_id.to_s)
-    logger.info "Switch #{datapath_id} is disconnected."
-    maybe_send_handler :switch_disconnected, datapath_id
-  end
-
-  def handle_openflow_message(datapath_id)
-    msg = @switches.fetch(datapath_id.to_s).receive
-
-    unless msg.class == OFEchoRequest
-      logger.debug "Switch #{datapath_id} received #{msg.type} message."
-      @messages[datapath_id.to_s] << msg
-      maybe_send_handler :message_received, datapath_id, msg
-    end
-
-    case msg
-    when OFError
-      maybe_send_handler :error, datapath_id, msg
-    when OFEchoRequest
-      maybe_send_handler :echo_request, datapath_id, msg
-    when OFFeaturesReply
-      maybe_send_handler :features_reply, datapath_id, msg
-    when OFPacketIn
-      maybe_send_handler :packet_in, datapath_id, msg
-    when OFPortStatus
-      case msg.reason
-      when :add
-        maybe_send_handler :port_add, datapath_id, msg
-      when :delete
-        maybe_send_handler :port_delete, datapath_id, msg
-      when :modify
-        maybe_send_handler :port_modify, datapath_id, msg
-      # else
-      end
-    when OFFlowRemoved
-      maybe_send_handler :flow_removed, datapath_id, msg
-    # else
-    end
-  end
-end

data/lib/switch.rb

@@ -1,52 +0,0 @@
-require 'openflow-protocol'
-
-class OFSwitch
-  attr_reader :controller, :features_reply
-
-  def initialize(controller, socket)
-    @controller = controller
-    @socket     = socket
-    begin
-      exchange_hello_messages
-      exchange_echo_messages
-      exchange_features_messages
-    rescue => exception
-      controller.logger.debug "Switch error: #{exception}."
-      raise exception
-    end
-  end
-
-  def send(msg)
-    @socket.write msg.to_binary_s
-  end
-
-  def receive
-    OFParser.read @socket
-  end
-
-  def datapath_id
-    @features_reply.datapath_id
-  end
-
-  private
-
-  def exchange_hello_messages
-    controller.logger.debug 'Wait OFPT_HELLO.'
-    fail unless receive.is_a?(OFHello)
-    send OFHello.new
-  end
-
-  def exchange_echo_messages
-    send OFEchoRequest.new
-    controller.logger.debug 'Wait OFPT_ECHO_REPLY.'
-    fail unless receive.is_a?(OFEchoReply)
-  end
-
-  def exchange_features_messages
-    send OFFeaturesRequest.new
-    controller.logger.debug 'Wait OFPT_FEATURES_REPLY.'
-    @features_reply = receive
-    controller.logger.debug "OFPT_FEATURES_REPLY.datapath_id: #{datapath_id}."
-    fail unless @features_reply.is_a?(OFFeaturesReply)
-  end
-end