pio 0.23.1 → 0.24.0

data/lib/pio/open_flow13/echo.rb

@@ -1,76 +1,19 @@
-require 'forwardable'
-require 'pio/open_flow'
+require 'pio/open_flow/echo'
 
 # Base module.
 module Pio
-  remove_const :Echo
-
-  module Echo
-    # Base class of Echo Request and Reply.
-    class Message
-      def self.message_name
-        name.split('::')[1..-1].map { |each| each.gsub(/\d+$/, '') }.join(' ')
-      end
-
-      def self.read(raw_data)
-        allocate.tap do |message|
-          message.instance_variable_set(:@format,
-                                        const_get(:Format).read(raw_data))
-        end
-      rescue BinData::ValidityError
-        raise Pio::ParseError, "Invalid #{message_name} 1.3 message."
-      end
-
-      def initialize(user_attrs = {})
-        unknown_attrs = user_attrs.keys - [:transaction_id, :xid, :body]
-        unless unknown_attrs.empty?
-          fail "Unknown keyword: #{unknown_attrs.first}"
-        end
-        header_options = OpenFlowHeader::Options.parse(user_attrs)
-        @format =
-          self.class.const_get(:Format).new(open_flow_header: header_options,
-                                            body: user_attrs[:body])
-      end
-
-      def method_missing(method, *args, &block)
-        @format.__send__ method, *args, &block
-      end
-    end
-
-    # Base class of Echo Request and Reply Format
-    class Format < BinData::Record
-      extend Forwardable
-
-      def_delegators :open_flow_header, :ofp_version
-      def_delegators :open_flow_header, :message_type
-      def_delegators :open_flow_header, :message_length
-      def_delegators :open_flow_header, :transaction_id
-      def_delegator :open_flow_header, :transaction_id, :xid
-
-      def to_binary
-        to_binary_s
+  module OpenFlow13
+    module Echo
+      # OpenFlow 1.3 Echo Request message.
+      class Request < OpenFlow::Echo
+        version 4
+        message_type 2
       end
-    end
-
-    # OpenFlow 1.3 Echo Request message.
-    class Request < Message
-      # OpenFlow 1.3 Echo Request message format.
-      class Format < Echo::Format
-        endian :big
-        open_flow_header :open_flow_header,
-                         ofp_version_value: 4, message_type_value: 2
-        string :body, read_length: -> { message_length - 8 }
-      end
-    end
 
-    # OpenFlow 1.3 Echo Reply message.
-    class Reply < Message
-      # OpenFlow 1.3 Echo Request message format.
-      class Format < Echo::Format
-        endian :big
-        open_flow_header :open_flow_header,
-                         ofp_version_value: 4, message_type_value: 3
-        string :body, read_length: -> { message_length - 8 }
+      # OpenFlow 1.3 Echo Reply message.
+      class Reply < OpenFlow::Echo
+        version 4
+        message_type 3
       end
     end
   end

data/lib/pio/open_flow13/features_reply.rb

@@ -1,90 +1,61 @@
-require 'forwardable'
 require 'pio/open_flow'
 
 # Base module.
 module Pio
-  # OpenFlow 1.3 Features Request and Reply message.
-  class Features
-    remove_const :Reply
-
-    # OpenFlow 1.3 Features Reply message.
-    class Reply
-      # OpenFlow 1.3 Features Reply message body.
-      class Body < BinData::Record
-        extend OpenFlow::Flags
-
-        flags_32bit(:capabilities,
-                    [:flow_stats,
-                     :table_stats,
-                     :port_stats,
-                     :group_stats,
-                     :NOT_USED,
-                     :ip_reasm,
-                     :queue_stats,
-                     :NOT_USED,
-                     :port_blocked])
-
-        endian :big
-
-        uint64 :datapath_id
-        uint32 :n_buffers
-        uint8 :n_tables
-        uint8 :auxiliary_id
-        uint16 :padding
-        hide :padding
-        capabilities :capabilities
-        uint32 :reserved
-
-        def length
-          24
+  # OpenFlow 1.3 messages
+  module OpenFlow13
+    # OpenFlow 1.3 Features Request and Reply message.
+    class Features
+      # OpenFlow 1.3 Features Reply message.
+      class Reply < OpenFlow::Message
+        # OpenFlow 1.3 Features Reply message body.
+        class Body < BinData::Record
+          extend OpenFlow::Flags
+
+          flags_32bit(:capabilities,
+                      [:flow_stats,
+                       :table_stats,
+                       :port_stats,
+                       :group_stats,
+                       :NOT_USED,
+                       :ip_reasm,
+                       :queue_stats,
+                       :NOT_USED,
+                       :port_blocked])
+
+          endian :big
+
+          datapath_id :datapath_id
+          uint32 :n_buffers
+          uint8 :n_tables
+          uint8 :auxiliary_id
+          uint16 :padding
+          hide :padding
+          capabilities :capabilities
+          uint32 :reserved
+
+          def length
+            24
+          end
         end
-      end
-
-      # OpenFlow 1.3 Features Reply message format.
-      class Format < BinData::Record
-        extend Forwardable
 
-        endian :big
-        open_flow_header(:open_flow_header,
-                         ofp_version_value: 4, message_type_value: 6)
-        body :body
+        # OpenFlow 1.3 Features Reply message format.
+        class Format < BinData::Record
+          extend OpenFlow::Format
 
-        def_delegators :open_flow_header, :ofp_version
-        def_delegators :open_flow_header, :message_type
-        def_delegators :open_flow_header, :message_length
-        def_delegators :open_flow_header, :transaction_id
-        def_delegator :open_flow_header, :transaction_id, :xid
-        def_delegators :body, :datapath_id
-        def_delegators :body, :n_buffers
-        def_delegators :body, :n_tables
-        def_delegators :body, :auxiliary_id
-        def_delegators :body, :capabilities
-        def_delegators :body, :reserved
+          header version: 4, message_type: 6
+          body :body
 
-        def dpid
-          datapath_id
+          def dpid
+            datapath_id
+          end
         end
-      end
-
-      def self.read(raw_data)
-        allocate.tap do |message|
-          message.instance_variable_set(:@format, Format.read(raw_data))
-        end
-      rescue BinData::ValidityError
-        raise Pio::ParseError, 'Invalid Features Reply 1.3 message.'
-      end
-
-      def initialize(user_attrs = {})
-        header_options = OpenFlowHeader::Options.parse(user_attrs)
-        body_options = user_attrs.dup
-        body_options[:datapath_id] =
-          body_options[:dpid] || body_options[:datapath_id]
-        @format = Format.new(open_flow_header: header_options,
-                             body: body_options)
-      end
 
-      def method_missing(method, *args, &block)
-        @format.__send__ method, *args, &block
+        body_option :dpid
+        body_option :datapath_id
+        body_option :n_buffers
+        body_option :n_tables
+        body_option :capabilities
       end
     end
   end

data/lib/pio/open_flow13/features_request.rb

@@ -1,53 +1,24 @@
-require 'forwardable'
 require 'pio/open_flow'
 
 # Base module.
 module Pio
-  # OpenFlow 1.3 Features Request and Reply message.
-  class Features
-    remove_const :Request
-
-    # OpenFlow 1.3 Features Request message.
-    class Request
-      # OpenFlow 1.3 Features Request message format.
-      class Format < BinData::Record
-        extend Forwardable
-
-        endian :big
-        open_flow_header(:open_flow_header,
-                         ofp_version_value: 4, message_type_value: 5)
-        string :body, value: ''
-
-        def_delegators :open_flow_header, :ofp_version
-        def_delegators :open_flow_header, :message_type
-        def_delegators :open_flow_header, :message_length
-        def_delegators :open_flow_header, :transaction_id
-        def_delegator :open_flow_header, :transaction_id, :xid
-
-        def to_binary
-          to_binary_s
-        end
-      end
-
-      def self.read(raw_data)
-        allocate.tap do |message|
-          message.instance_variable_set(:@format, Format.read(raw_data))
-        end
-      rescue BinData::ValidityError
-        raise Pio::ParseError, 'Invalid Features Request 1.3 message.'
-      end
-
-      def initialize(user_attrs = {})
-        unknown_attrs = user_attrs.keys - [:transaction_id, :xid]
-        unless unknown_attrs.empty?
-          fail "Unknown keyword: #{unknown_attrs.first}"
+  # OpenFlow 1.3 messages
+  module OpenFlow13
+    # OpenFlow 1.3 Features Request and Reply message.
+    class Features
+      # OpenFlow 1.3 Features Request message.
+      class Request < OpenFlow::Message
+        # OpenFlow 1.3 Features Request message format.
+        class Format < BinData::Record
+          extend OpenFlow::Format
+
+          header version: 4, message_type: 5
+          string :body, value: ''
+
+          def user_data
+            body
+          end
         end
-        header_options = OpenFlowHeader::Options.parse(user_attrs)
-        @format = Format.new(open_flow_header: header_options)
-      end
-
-      def method_missing(method, *args, &block)
-        @format.__send__ method, *args, &block
       end
     end
   end

data/lib/pio/open_flow13/flow_mod.rb

@@ -1,182 +1,159 @@
-require 'forwardable'
 require 'pio/open_flow'
 require 'pio/open_flow13/buffer_id'
 require 'pio/open_flow13/match'
 
 # Base module.
 module Pio
-  remove_const :FlowMod if const_defined?(:FlowMod)
-
-  # OpenFlow 1.3 FlowMod message parser and generator
-  class FlowMod
-    # enum ofp_flow_mod_command
-    class Command < BinData::Primitive
-      COMMANDS = {
-        add: 0,
-        modify: 1,
-        modify_strict: 2,
-        delete: 3,
-        delete_strict: 4
-      }
-
-      uint8 :command
-
-      def get
-        COMMANDS.invert.fetch(command)
-      end
+  module OpenFlow13
+    # OpenFlow 1.3 FlowMod message parser and generator
+    class FlowMod < OpenFlow::Message
+      # enum ofp_flow_mod_command
+      class Command < BinData::Primitive
+        COMMANDS = {
+          add: 0,
+          modify: 1,
+          modify_strict: 2,
+          delete: 3,
+          delete_strict: 4
+        }
+
+        uint8 :command
+
+        def get
+          COMMANDS.invert.fetch(command)
+        end
 
-      def set(value)
-        self.command = COMMANDS.fetch(value)
+        def set(value)
+          self.command = COMMANDS.fetch(value)
+        end
       end
-    end
 
-    # For delete commands, require matching entries to include this as
-    # an output port.
-    class OutPort < BinData::Primitive
-      ANY = 0xffffffff
+      # For delete commands, require matching entries to include this as
+      # an output port.
+      class OutPort < BinData::Primitive
+        ANY = 0xffffffff
 
-      endian :big
-      uint32 :out_port, initial_value: ANY
+        endian :big
+        uint32 :out_port, initial_value: ANY
 
-      def get
-        (out_port == ANY) ? :any : out_port
-      end
+        def get
+          (out_port == ANY) ? :any : out_port
+        end
 
-      def set(value)
-        self.out_port = (value == :any ? ANY : value)
+        def set(value)
+          self.out_port = (value == :any ? ANY : value)
+        end
       end
-    end
 
-    # For delete commands, require matching entries to include this as
-    # an output group.
-    class OutGroup < BinData::Primitive
-      ANY = 0xffffffff
+      # For delete commands, require matching entries to include this as
+      # an output group.
+      class OutGroup < BinData::Primitive
+        ANY = 0xffffffff
 
-      endian :big
-      uint32 :out_group, initial_value: ANY
+        endian :big
+        uint32 :out_group, initial_value: ANY
 
-      def get
-        (out_group == ANY) ? :any : out_group
-      end
+        def get
+          (out_group == ANY) ? :any : out_group
+        end
 
-      def set(value)
-        self.out_group = (value == :any ? ANY : value)
+        def set(value)
+          self.out_group = (value == :any ? ANY : value)
+        end
       end
-    end
 
-    # OpenFlow 1.3 instructions
-    class Instructions < BinData::Primitive
-      endian :big
+      # OpenFlow 1.3 instructions
+      class Instructions < BinData::Primitive
+        endian :big
 
-      count_bytes_remaining :instructions_length
-      string :instructions, read_length: :instructions_length
+        count_bytes_remaining :instructions_length
+        string :instructions, read_length: :instructions_length
 
-      def set(object)
-        self.instructions = [object].flatten.map(&:to_binary_s).join
-      end
+        def set(object)
+          self.instructions = [object].flatten.map(&:to_binary_s).join
+        end
 
-      # rubocop:disable MethodLength
-      def get
-        list = []
-        tmp = instructions
-        while tmp.length > 0
-          instruction_type = BinData::Uint16be.read(tmp)
-          instruction = case instruction_type
-                        when 1
-                          GotoTable.read(tmp)
-                        when 2
-                          WriteMetadata.read(tmp)
-                        when 4
-                          Apply.read(tmp)
-                        when 6
-                          Meter.read(tmp)
-                        else
-                          fail "Unsupported instruction #{instruction_type}"
-                        end
-          tmp = tmp[instruction.instruction_length..-1]
-          list << instruction
+        # rubocop:disable MethodLength
+        def get
+          list = []
+          tmp = instructions
+          while tmp.length > 0
+            instruction_type = BinData::Uint16be.read(tmp)
+            instruction = case instruction_type
+                          when 1
+                            GotoTable.read(tmp)
+                          when 2
+                            WriteMetadata.read(tmp)
+                          when 4
+                            Apply.read(tmp)
+                          when 6
+                            Meter.read(tmp)
+                          else
+                            fail "Unsupported instruction #{instruction_type}"
+                          end
+            tmp = tmp[instruction.instruction_length..-1]
+            list << instruction
+          end
+          list
         end
-        list
-      end
-      # rubocop:enable MethodLength
+        # rubocop:enable MethodLength
 
-      def length
-        instructions.length
+        def length
+          instructions.length
+        end
       end
-    end
 
-    # OpenFlow 1.3 FlowMod message body
-    class Body < BinData::Record
-      extend OpenFlow::Flags
-      flags_16bit :flags,
-                  [:send_flow_rem,
-                   :check_overwrap,
-                   :reset_counts,
-                   :no_packet_counts,
-                   :no_byte_counts]
-
-      endian :big
-
-      uint64 :cookie
-      uint64 :cookie_mask
-      uint8 :table_id
-      command :command
-      uint16 :idle_timeout
-      uint16 :hard_timeout
-      uint16 :priority, initial_value: 0xffff
-      buffer_id :buffer_id
-      out_port :out_port
-      out_group :out_group
-      flags :flags
-      string :padding, length: 2
-      hide :padding
-      oxm :match
-      instructions :instructions
-
-      def length
-        40 + match.length + instructions.length
+      # OpenFlow 1.3 FlowMod message body
+      class Body < BinData::Record
+        extend OpenFlow::Flags
+        flags_16bit :flags,
+                    [:send_flow_rem,
+                     :check_overwrap,
+                     :reset_counts,
+                     :no_packet_counts,
+                     :no_byte_counts]
+
+        endian :big
+
+        uint64 :cookie
+        uint64 :cookie_mask
+        uint8 :table_id
+        command :command
+        uint16 :idle_timeout
+        uint16 :hard_timeout
+        uint16 :priority, initial_value: 0xffff
+        buffer_id :buffer_id
+        out_port :out_port
+        out_group :out_group
+        flags :flags
+        string :padding, length: 2
+        hide :padding
+        oxm :match
+        instructions :instructions
+
+        def length
+          40 + match.length + instructions.length
+        end
       end
-    end
-
-    # OpenFlow 1.3 FlowMod message format
-    class Format < BinData::Record
-      extend Forwardable
-
-      endian :big
-
-      open_flow_header :open_flow_header,
-                       ofp_version_value: 4,
-                       message_type_value: OpenFlow::FLOW_MOD
-      body :body
 
-      def_delegators :open_flow_header, :ofp_version
-      def_delegators :open_flow_header, :message_type
-      def_delegators :open_flow_header, :message_length
-      def_delegators :open_flow_header, :transaction_id
-      def_delegator :open_flow_header, :transaction_id, :xid
+      # OpenFlow 1.3 FlowMod message format
+      class Format < BinData::Record
+        extend OpenFlow::Format
 
-      alias_method :to_binary, :to_binary_s
-
-      def method_missing(method, *args, &block)
-        body.__send__ method, *args, &block
-      end
-    end
-
-    def self.read(raw_data)
-      allocate.tap do |message|
-        message.instance_variable_set(:@format, Format.read(raw_data))
+        header version: 4, message_type: 14
+        body :body
       end
-    end
-
-    def initialize(user_attrs = {})
-      header_attrs = OpenFlowHeader::Options.parse(user_attrs)
-      body_attrs = { match: user_attrs[:match],
-                     instructions: user_attrs[:instructions] }
-      @format = Format.new(open_flow_header: header_attrs, body: body_attrs)
-    end
 
-    def method_missing(method, *args, &block)
-      @format.__send__ method, *args, &block
+      body_option :actions
+      body_option :buffer_id
+      body_option :command
+      body_option :flags
+      body_option :hard_timeout
+      body_option :idle_timeout
+      body_option :instructions
+      body_option :match
+      body_option :priority
+      body_option :table_id
     end
   end
 end