pio 0.23.1 → 0.24.0

data/lib/pio.rb

@@ -5,5 +5,5 @@ require 'pio/dhcp'
 require 'pio/icmp'
 require 'pio/lldp'
 require 'pio/mac'
-require 'pio/open_flow10'
+require 'pio/open_flow'
 require 'pio/udp'

data/lib/pio/monkey_patch/integer/ranges.rb

@@ -14,6 +14,10 @@ module MonkeyPatch
         _within_range? 32
       end
 
+      def unsigned_64bit?
+        _within_range? 64
+      end
+
       def _within_range?(nbit)
         (0 <= self) && (self < 2**nbit)
       end

data/lib/pio/open_flow.rb

@@ -1,20 +1,58 @@
-module Pio
-  # OpenFlow specific types.
-  module OpenFlow
-    # OFPT_* constants.
-    HELLO = 0
-    ECHO_REQUEST = 2
-    ECHO_REPLY = 3
-    FEATURES_REQUEST = 5
-    FEATURES_REPLY = 6
-    PACKET_IN = 10
-    PORT_STATUS = 12
-    PACKET_OUT = 13
-    FLOW_MOD = 14
-  end
-end
-
+require 'pio/open_flow/datapath_id'
 require 'pio/open_flow/flags'
+require 'pio/open_flow/format'
+require 'pio/open_flow/message'
 require 'pio/open_flow/open_flow_header'
 require 'pio/open_flow/phy_port'
 require 'pio/open_flow/port_number'
+require 'pio/open_flow10'
+require 'pio/open_flow13'
+
+module Pio
+  # Common OpenFlow modules/classes.
+  module OpenFlow
+    def self.version
+      fail unless @version
+      @version
+    end
+
+    def self.switch_version(version)
+      [:Barrier, :Echo, :Features, :FlowMod, :Hello, :Match,
+       :PacketIn, :PacketOut, :SendOutPort, :PortStatus].each do |each|
+        set_message_class_name each, version
+        @version = version.to_s
+      end
+    end
+
+    # rubocop:disable MethodLength
+    def self.read(binary)
+      parser = {
+        0 => Pio::Hello,
+        2 => Pio::Echo::Request,
+        3 => Pio::Echo::Reply,
+        5 => Pio::Features::Request,
+        6 => Pio::Features::Reply,
+        10 => Pio::PacketIn,
+        12 => Pio::PortStatus
+      }
+      header = OpenFlowHeaderParser.read(binary)
+      parser.fetch(header.message_type).read(binary)
+    rescue
+      raise "Unknown message type #{header.message_type}"
+    end
+    # rubocop:enable MethodLength
+
+    def self.set_message_class_name(klass_name, version)
+      open_flow_module = Pio.const_get(version)
+      return unless open_flow_module.const_defined?(klass_name)
+      Pio.__send__ :remove_const, klass_name if Pio.const_defined?(klass_name)
+      Pio.const_set(klass_name, open_flow_module.const_get(klass_name))
+    rescue NameError
+      raise "#{version} is not supported yet."
+    end
+    private_class_method :set_message_class_name
+
+    # The default OpenFlow version is 1.0
+    switch_version 'OpenFlow10'
+  end
+end

data/lib/pio/open_flow/datapath_id.rb

@@ -0,0 +1,26 @@
+require 'bindata'
+require 'pio/monkey_patch/integer'
+
+module Pio
+  module OpenFlow
+    # Datapath unique ID. The lower 48-bits are for a MAC address,
+    # while the upper 16-bits are implementer-defined.
+    class DatapathId < BinData::Primitive
+      endian :big
+
+      uint64 :datapath_id
+
+      def set(value)
+        unless value.unsigned_64bit?
+          fail(ArgumentError,
+               'Datapath ID should be an unsigned 64-bit integer.')
+        end
+        self.datapath_id = value
+      end
+
+      def get
+        datapath_id
+      end
+    end
+  end
+end

data/lib/pio/open_flow/echo.rb

@@ -0,0 +1,44 @@
+require 'pio/open_flow/format'
+require 'pio/open_flow/message'
+
+module Pio
+  module OpenFlow
+    # Base class of Echo Request and Reply.
+    class Echo < OpenFlow::Message
+      # rubocop:disable MethodLength
+      def self.inherited(child)
+        child.module_eval <<-EOS
+          class Format < BinData::Record
+            extend OpenFlow::Format
+
+            header version: :of_version,
+                   message_type: :of_message_type
+            string :body, read_length: -> { message_length - header_length }
+
+            def user_data
+              body
+            end
+          end
+        EOS
+      end
+      # rubocop:enable MethodLength
+
+      def self.version(version)
+        const_get(:Format).tap do |klass|
+          klass.__send__(:define_method, :of_version) { version }
+          klass.class_eval { private :of_version }
+        end
+      end
+
+      def self.message_type(message_type)
+        const_get(:Format).tap do |klass|
+          klass.__send__(:define_method, :of_message_type) { message_type }
+          klass.class_eval { private :of_message_type }
+        end
+      end
+
+      body_option :body
+      body_option :user_data
+    end
+  end
+end

data/lib/pio/open_flow/format.rb

@@ -0,0 +1,45 @@
+require 'pio/open_flow/open_flow_header'
+
+module Pio
+  module OpenFlow
+    # OpenFlow message definition macros.
+    module Format
+      include Forwardable
+
+      # rubocop:disable NestedMethodDefinition
+      def self.extended(base)
+        base.module_eval do
+          def header_length
+            8
+          end
+
+          def method_missing(method, *args, &block)
+            body.__send__ method, *args, &block
+          end
+        end
+      end
+      # rubocop:enable NestedMethodDefinition
+
+      # rubocop:disable MethodLength
+      def header(options)
+        module_eval do
+          endian :big
+
+          open_flow_header :header,
+                           ofp_version_value: options.fetch(:version),
+                           message_type_value: options.fetch(:message_type)
+
+          def_delegators :header, :snapshot
+          def_delegators :snapshot, :ofp_version
+          def_delegators :snapshot, :message_type
+          def_delegators :snapshot, :message_length
+          def_delegators :snapshot, :transaction_id
+          def_delegator :snapshot, :transaction_id, :xid
+
+          alias_method :to_binary, :to_binary_s
+        end
+      end
+      # rubocop:enable MethodLength
+    end
+  end
+end

data/lib/pio/open_flow/message.rb

@@ -0,0 +1,88 @@
+module Pio
+  module OpenFlow
+    # OpenFlow messages.
+    class Message
+      # rubocop:disable MethodLength
+      def self.inherited(child)
+        child.class_eval <<-EOS
+          def self.read(raw_data)
+            allocate.tap do |message|
+              format_klass = self.const_get(:Format)
+              message.instance_variable_set(:@format,
+                                            format_klass.read(raw_data))
+            end
+          rescue BinData::ValidityError
+            message_name = name.split('::')[1..-1].join(' ')
+            raise Pio::ParseError, "Invalid \#{message_name} message."
+          end
+        EOS
+      end
+      # rubocop:enable MethodLength
+
+      def self.body_option(name)
+        unless class_variable_defined?(:@@valid_body_options)
+          class_variable_set(:@@valid_body_options, [])
+        end
+        class_variable_set(:@@valid_body_options,
+                           class_variable_get(:@@valid_body_options) + [name])
+      end
+
+      def initialize(user_options = {})
+        validate_user_options user_options
+        @format = self.class.const_get(:Format).new(parse_options(user_options))
+      end
+
+      def method_missing(method, *args, &block)
+        @format.__send__ method, *args, &block
+      end
+
+      private
+
+      def validate_user_options(user_options)
+        unknown_options =
+          user_options.keys - valid_header_options - valid_body_options
+        return if unknown_options.empty?
+        fail "Unknown option: #{unknown_options.first}"
+      end
+
+      def parse_options(user_options)
+        if valid_body_options.empty?
+          { header: parse_header_options(user_options) }
+        else
+          { header: parse_header_options(user_options),
+            body: parse_body_options(user_options) }
+        end
+      end
+
+      def parse_header_options(user_options)
+        transaction_id =
+          user_options[:transaction_id] || user_options[:xid] || 0
+        { transaction_id: transaction_id }
+      end
+
+      def parse_body_options(user_options)
+        if valid_body_options.include?(:body)
+          return user_options[:body] || user_options[:user_data] || ''
+        end
+        options = user_options.dup
+        options.delete :transaction_id
+        options.delete :xid
+        dpid = options[:dpid]
+        options[:datapath_id] = dpid if dpid
+        options.empty? ? {} : options
+      end
+
+      def valid_header_options
+        [:transaction_id, :xid]
+      end
+
+      def valid_body_options
+        if self.class.class_variable_defined?(:@@valid_body_options)
+          self.class.class_variable_get(:@@valid_body_options)
+        else
+          []
+        end
+      end
+    end
+  end
+end

data/lib/pio/open_flow/open_flow_header.rb

@@ -22,19 +22,5 @@ module Pio
     virtual assert: -> { message_type == message_type_value }
     uint16 :message_length, initial_value: -> { 8 + body.length }
     transaction_id :transaction_id, initial_value: 0
-
-    # parse header options
-    class Options
-      def self.parse(options)
-        xid = if options.respond_to?(:to_i)
-                options.to_i
-              elsif options.respond_to?(:fetch)
-                options[:transaction_id] || options[:xid] || 0
-              else
-                fail TypeError
-              end
-        { transaction_id: xid }
-      end
-    end
   end
 end

data/lib/pio/open_flow10.rb

@@ -1,11 +1,5 @@
-module Pio
-  # OpenFlow specific types.
-  module OpenFlow
-    VERSION = 1
-  end
-end
-
-require 'pio/open_flow10/actions'
+require 'pio/open_flow10/barrier_reply'
+require 'pio/open_flow10/barrier_request'
 require 'pio/open_flow10/echo'
 require 'pio/open_flow10/exact_match'
 require 'pio/open_flow10/features'
@@ -14,3 +8,4 @@ require 'pio/open_flow10/hello'
 require 'pio/open_flow10/packet_in'
 require 'pio/open_flow10/packet_out'
 require 'pio/open_flow10/port_status'
+require 'pio/open_flow10/send_out_port'

data/lib/pio/open_flow10/actions.rb

@@ -14,7 +14,7 @@ module Pio
     # Actions list.
     class Actions < BinData::Primitive
       ACTION_CLASS = {
-        0 => Pio::SendOutPort,
+        0 => Pio::OpenFlow10::SendOutPort,
         1 => Pio::SetVlanVid,
         2 => Pio::SetVlanPriority,
         3 => Pio::StripVlanHeader,

data/lib/pio/open_flow10/barrier_reply.rb

@@ -0,0 +1,21 @@
+require 'pio/open_flow/format'
+require 'pio/open_flow/message'
+
+module Pio
+  # OpenFlow 1.0 messages
+  module OpenFlow10
+    # OpenFlow 1.0 Barrier messages
+    module Barrier
+      # OpenFlow 1.0 Barrier Request message
+      class Reply < OpenFlow::Message
+        # OpenFlow 1.0 Barrier Request message format
+        class Format < BinData::Record
+          extend OpenFlow::Format
+
+          header version: 1, message_type: 19
+          string :body, value: ''
+        end
+      end
+    end
+  end
+end

data/lib/pio/open_flow10/barrier_request.rb

@@ -0,0 +1,22 @@
+require 'pio/open_flow/format'
+require 'pio/open_flow/message'
+
+# Base module.
+module Pio
+  # OpenFlow 1.0 messages
+  module OpenFlow10
+    # OpenFlow 1.0 Barrier messages
+    module Barrier
+      # OpenFlow 1.0 Barrier Request message
+      class Request < OpenFlow::Message
+        # OpenFlow 1.0 Barrier Request message format
+        class Format < BinData::Record
+          extend OpenFlow::Format
+
+          header version: 1, message_type: 18
+          string :body, value: ''
+        end
+      end
+    end
+  end
+end

data/lib/pio/open_flow10/echo.rb

@@ -1,16 +1,20 @@
-require 'forwardable'
-require 'pio/open_flow'
-require 'pio/open_flow10/message'
+require 'pio/open_flow/echo'
 
 module Pio
-  # OpenFlow 1.0 Echo Request and Reply message.
-  module Echo
-    # OpenFlow 1.0 Echo Request message.
-    class Request; end
-    OpenFlow::Message.factory(Request, OpenFlow::ECHO_REQUEST)
+  module OpenFlow10
+    # OpenFlow 1.0 Echo Request and Reply message.
+    module Echo
+      # OpenFlow 1.0 Echo Request message.
+      class Request < OpenFlow::Echo
+        version 1
+        message_type 2
+      end
 
-    # OpenFlow 1.0 Echo Reply message.
-    class Reply; end
-    OpenFlow::Message.factory(Reply, OpenFlow::ECHO_REPLY)
+      # OpenFlow 1.0 Echo Reply message.
+      class Reply < OpenFlow::Echo
+        version 1
+        message_type 3
+      end
+    end
   end
 end

data/lib/pio/open_flow10/features.rb

@@ -1,85 +1,113 @@
-require 'forwardable'
 require 'pio/open_flow'
 
 module Pio
-  # OpenFlow 1.0 Features Request and Reply message.
-  class Features
-    # OpenFlow 1.0 Features Request message.
-    class Request; end
-    OpenFlow::Message.factory(Request, OpenFlow::FEATURES_REQUEST)
-
-    # OpenFlow 1.0 Features Reply message.
-    class Reply
-      # Message body of features reply.
-      class Body < BinData::Record
-        extend OpenFlow::Flags
-
-        # enum ofp_capabilities
-        flags_32bit :capabilities,
-                    [:flow_stats,
-                     :table_stats,
-                     :port_stats,
-                     :stp,
-                     :reserved,
-                     :ip_reasm,
-                     :queue_stats,
-                     :arp_match_ip]
-
-        # enum ofp_action_type
-        flags_32bit :actions_flag,
-                    [:output,
-                     :set_vlan_vid,
-                     :set_vlan_pcp,
-                     :strip_vlan,
-                     :set_ether_source_address,
-                     :set_ether_destination_address,
-                     :set_ip_source_address,
-                     :set_ip_destination_address,
-                     :set_ip_tos,
-                     :set_transport_source_port,
-                     :set_transport_destination_port,
-                     :enqueue]
-
-        endian :big
-
-        uint64 :datapath_id
-        uint32 :n_buffers
-        uint8 :n_tables
-        uint24 :padding
-        hide :padding
-        capabilities :capabilities
-        actions_flag :actions
-        array :ports, type: :phy_port, read_until: :eof
-
-        def empty?
-          false
+  module OpenFlow10
+    # OpenFlow 1.0 Features Request and Reply message.
+    class Features
+      # OpenFlow 1.0 Features Request message.
+      class Request < OpenFlow::Message
+        # OpenFlow 1.0 Features Request message
+        class Format < BinData::Record
+          extend OpenFlow::Format
+
+          header version: 1, message_type: 5
+          string :body, value: ''
+
+          def user_data
+            body
+          end
         end
 
-        def length
-          24 + ports.to_binary_s.length
+        def initialize(user_options = {})
+          validate_user_options user_options
+          @format = Format.new(header: parse_header_options(user_options))
         end
       end
-    end
 
-    OpenFlow::Message.factory(Reply, OpenFlow::FEATURES_REPLY) do
-      def_delegators :body, :datapath_id
-      def_delegator :body, :datapath_id, :dpid
-      def_delegators :body, :n_buffers
-      def_delegators :body, :n_tables
-      def_delegators :body, :capabilities
-      def_delegators :body, :actions
-
-      def ports
-        @format.snapshot.body.ports.map do |each|
-          each.instance_variable_set :@datapath_id, datapath_id
-          each
+      # OpenFlow 1.0 Features Reply message.
+      class Reply < OpenFlow::Message
+        # Message body of features reply.
+        class Body < BinData::Record
+          extend OpenFlow::Flags
+
+          # enum ofp_capabilities
+          flags_32bit :capabilities,
+                      [:flow_stats,
+                       :table_stats,
+                       :port_stats,
+                       :stp,
+                       :reserved,
+                       :ip_reasm,
+                       :queue_stats,
+                       :arp_match_ip]
+
+          # enum ofp_action_type
+          flags_32bit :actions_flag,
+                      [:output,
+                       :set_vlan_vid,
+                       :set_vlan_pcp,
+                       :strip_vlan,
+                       :set_ether_source_address,
+                       :set_ether_destination_address,
+                       :set_ip_source_address,
+                       :set_ip_destination_address,
+                       :set_ip_tos,
+                       :set_transport_source_port,
+                       :set_transport_destination_port,
+                       :enqueue]
+
+          endian :big
+
+          datapath_id :datapath_id
+          uint32 :n_buffers
+          uint8 :n_tables
+          uint24 :padding
+          hide :padding
+          capabilities :capabilities
+          actions_flag :actions
+          array :ports, type: :phy_port, read_until: :eof
+
+          def dpid
+            datapath_id
+          end
+
+          def empty?
+            false
+          end
+
+          def length
+            24 + ports.to_binary_s.length
+          end
         end
-      end
 
-      def physical_ports
-        ports.select do |each|
-          each.port_no <= PortNumber::MAX
+        # OpenFlow 1.0 Features Reply message
+        class Format < BinData::Record
+          extend OpenFlow::Format
+
+          header version: 1, message_type: 6
+          body :body
+
+          def ports
+            body.snapshot.ports.map do |each|
+              each.instance_variable_set :@datapath_id, datapath_id
+              each
+            end
+          end
+
+          def physical_ports
+            ports.select do |each|
+              each.port_no <= PortNumber::MAX
+            end
+          end
         end
+
+        body_option :dpid
+        body_option :datapath_id
+        body_option :n_buffers
+        body_option :n_tables
+        body_option :capabilities
+        body_option :actions
+        body_option :ports
       end
     end
   end