pio 0.27.1 → 0.27.2

data/lib/pio/open_flow/open_flow_header.rb

@@ -8,28 +8,24 @@ module Pio
 
     uint8 :ofp_version
     uint8 :message_type
-    uint16 :_length
+    uint16 :message_length
     transaction_id :transaction_id
     rest :body
-
-    def length
-      _length
-    end
   end
 
   # OpenFlow message header.
-  class OpenFlowHeader < BinData::Record
+  class OfpHeader < BinData::Record
     endian :big
 
-    uint8 :ofp_version, value: :ofp_version_value
-    virtual assert: -> { ofp_version == ofp_version_value }
+    uint8 :ofp_version, value: :version_value
+    virtual assert: -> { ofp_version == version_value }
     uint8 :message_type, value: :message_type_value
     virtual assert: -> { message_type == message_type_value }
-    uint16 :_length, initial_value: -> { 8 + body.length }
+    uint16 :message_length, initial_value: -> { length + body_length }
     transaction_id :transaction_id, initial_value: 0
 
     def length
-      _length
+      8
     end
   end
 end

data/lib/pio/open_flow10.rb

@@ -1,24 +1,29 @@
-require 'pio/open_flow10/aggregate_stats_reply.rb'
-require 'pio/open_flow10/aggregate_stats_request.rb'
-require 'pio/open_flow10/barrier_reply'
-require 'pio/open_flow10/barrier_request'
-require 'pio/open_flow10/description_stats_reply'
-require 'pio/open_flow10/description_stats_request'
-require 'pio/open_flow10/echo'
+# Messages
+require 'pio/open_flow10/stats_reply'
+require 'pio/open_flow10/aggregate_stats/reply'
+require 'pio/open_flow10/aggregate_stats/request'
+require 'pio/open_flow10/barrier/reply'
+require 'pio/open_flow10/barrier/request'
+require 'pio/open_flow10/description_stats/reply'
+require 'pio/open_flow10/description_stats/request'
+require 'pio/open_flow10/echo/reply'
+require 'pio/open_flow10/echo/request'
 require 'pio/open_flow10/error'
 require 'pio/open_flow10/error/bad_request'
 require 'pio/open_flow10/error/hello_failed'
-require 'pio/open_flow10/exact_match'
-require 'pio/open_flow10/features'
+require 'pio/open_flow10/features/reply'
+require 'pio/open_flow10/features/request'
 require 'pio/open_flow10/flow_mod'
-require 'pio/open_flow10/flow_stats_reply'
-require 'pio/open_flow10/flow_stats_request'
+require 'pio/open_flow10/flow_stats/reply'
+require 'pio/open_flow10/flow_stats/request'
 require 'pio/open_flow10/hello'
 require 'pio/open_flow10/packet_in'
 require 'pio/open_flow10/packet_out'
-require 'pio/open_flow10/phy_port16'
-require 'pio/open_flow10/port16'
 require 'pio/open_flow10/port_status'
-require 'pio/open_flow10/send_out_port'
-require 'pio/open_flow10/stats_reply'
 require 'pio/open_flow10/stats_request'
+
+# Actions
+require 'pio/open_flow10/send_out_port'
+
+# Misc.
+require 'pio/open_flow10/exact_match'

data/lib/pio/open_flow10/aggregate_stats/reply.rb

@@ -0,0 +1,20 @@
+require 'pio/open_flow10/stats_type'
+
+module Pio
+  module OpenFlow10
+    # Aggregate Stats messages
+    module AggregateStats
+      # Aggregate Stats Reply message
+      class Reply < OpenFlow::Message
+        open_flow_header version: 1, message_type: 17, message_length: 32
+        stats_type :stats_type, value: -> { :aggregate }
+        uint16 :flags
+        uint64 :packet_count
+        uint64 :byte_count
+        uint32 :flow_count
+        string :padding, length: 4
+        hide :padding
+      end
+    end
+  end
+end

data/lib/pio/open_flow10/aggregate_stats/request.rb

@@ -0,0 +1,25 @@
+require 'pio/open_flow/message'
+require 'pio/open_flow10/match10'
+require 'pio/open_flow10/port16'
+require 'pio/open_flow10/stats_type'
+
+module Pio
+  module OpenFlow10
+    # OpenFlow 1.0 Aggregate Stats messages
+    module AggregateStats
+      # OpenFlow 1.0 Aggregate Stats Request message
+      class Request < OpenFlow::Message
+        open_flow_header version: 1,
+                         message_type: 16,
+                         message_length: 56
+        stats_type :stats_type, value: -> { :aggregate }
+        uint16 :flags
+        match10 :match
+        uint8 :table_id, initial_value: 0xff
+        string :padding, length: 1
+        hide :padding
+        port16 :out_port, initial_value: -> { :none }
+      end
+    end
+  end
+end

data/lib/pio/open_flow10/barrier/reply.rb

@@ -0,0 +1,14 @@
+require 'pio/open_flow/message'
+
+module Pio
+  module OpenFlow10
+    # OpenFlow 1.0 Barrier messages
+    module Barrier
+      # OpenFlow 1.0 Barrier Request message
+      class Reply < OpenFlow::Message
+        open_flow_header version: 1, message_type: 19
+        string :body, value: ''
+      end
+    end
+  end
+end

data/lib/pio/open_flow10/barrier/request.rb

@@ -0,0 +1,14 @@
+require 'pio/open_flow/message'
+
+module Pio
+  module OpenFlow10
+    # OpenFlow 1.0 Barrier messages
+    module Barrier
+      # OpenFlow 1.0 Barrier Request message
+      class Request < OpenFlow::Message
+        open_flow_header version: 1, message_type: 18
+        string :body, value: ''
+      end
+    end
+  end
+end

data/lib/pio/open_flow10/description_stats/reply.rb

@@ -0,0 +1,21 @@
+require 'pio/open_flow10/stats_type'
+
+module Pio
+  module OpenFlow10
+    # OpenFlow 1.0 Description Stats messages
+    module DescriptionStats
+      # OpenFlow 1.0 Description Stats Reply message
+      class Reply < OpenFlow::Message
+        open_flow_header version: 1, message_type: 17, message_length: 1068
+        stats_type :stats_type, value: -> { :description }
+        uint16 :flags
+
+        stringz :manufacturer, length: 256
+        stringz :hardware, length: 256
+        stringz :software, length: 256
+        stringz :serial_number, length: 32
+        stringz :datapath, length: 256
+      end
+    end
+  end
+end

data/lib/pio/open_flow10/description_stats/request.rb

@@ -0,0 +1,19 @@
+require 'pio/open_flow10/stats_type'
+require 'pio/open_flow/message'
+
+module Pio
+  module OpenFlow10
+    # OpenFlow 1.0 Description Stats messages
+    module DescriptionStats
+      # OpenFlow 1.0 Description Stats Request message
+      class Request < OpenFlow::Message
+        open_flow_header version: 1,
+                         message_type: 16,
+                         message_length: 12
+        stats_type :stats_type, value: -> { :description }
+        uint16 :flags
+        string :body, value: ''
+      end
+    end
+  end
+end

data/lib/pio/open_flow10/echo/reply.rb

@@ -0,0 +1,16 @@
+require 'pio/open_flow/message'
+
+module Pio
+  module OpenFlow10
+    # OpenFlow 1.0 Echo Request and Reply message.
+    module Echo
+      # OpenFlow 1.0 Echo Reply message.
+      class Reply < OpenFlow::Message
+        open_flow_header version: 1, message_type: 3
+        string :body, read_length: -> { message_length - 8 }
+
+        alias_method :user_data, :body
+      end
+    end
+  end
+end

data/lib/pio/open_flow10/echo/request.rb

@@ -0,0 +1,16 @@
+require 'pio/open_flow/message'
+
+module Pio
+  module OpenFlow10
+    # OpenFlow 1.0 Echo Request and Reply message.
+    module Echo
+      # OpenFlow 1.0 Echo Request message.
+      class Request < OpenFlow::Message
+        open_flow_header version: 1, message_type: 2
+        string :body, read_length: -> { message_length - 8 }
+
+        alias_method :user_data, :body
+      end
+    end
+  end
+end

data/lib/pio/open_flow10/error/bad_request.rb

@@ -1,5 +1,3 @@
-require 'bindata'
-require 'pio/open_flow/format'
 require 'pio/open_flow/message'
 require 'pio/open_flow10/error/error_type10'
 
@@ -8,58 +6,38 @@ module Pio
     module Error
       # Bad request error.
       class BadRequest < OpenFlow::Message
-        # Bad request error format.
-        class Format < BinData::Record
-          # Bad request error body.
-          class Body < BinData::Record
-            # enum ofp_bad_request_code
-            class BadRequestCode < BinData::Primitive
-              ERROR_CODES = {
-                bad_version: 0,
-                bad_type: 1,
-                bad_stats: 2,
-                bad_vendor: 3,
-                bad_subtype: 4,
-                permissions_error: 5,
-                bad_length: 6,
-                buffer_empty: 7,
-                buffer_unknown: 8
-              }
-
-              endian :big
-              uint16 :error_code
-
-              def get
-                ERROR_CODES.invert.fetch(error_code)
-              end
-
-              def set(value)
-                self.error_code = ERROR_CODES.fetch(value)
-              end
-            end
-
-            endian :big
-
-            error_type10 :error_type, value: -> { :bad_request }
-            bad_request_code :error_code
-            rest :raw_data
-
-            def length
-              4 + raw_data.length
-            end
+        # enum ofp_bad_request_code
+        class BadRequestCode < BinData::Primitive
+          ERROR_CODES = {
+            bad_version: 0,
+            bad_type: 1,
+            bad_stats: 2,
+            bad_vendor: 3,
+            bad_subtype: 4,
+            permissions_error: 5,
+            bad_length: 6,
+            buffer_empty: 7,
+            buffer_unknown: 8
+          }
+
+          endian :big
+          uint16 :error_code
+
+          def get
+            ERROR_CODES.invert.fetch(error_code)
           end
 
-          extend OpenFlow::Format
-
-          header version: 1, message_type: 1
-          body :body
-
-          def length
-            8 + body.length
+          def set(value)
+            self.error_code = ERROR_CODES.fetch(value)
           end
         end
 
-        body_option :raw_data
+        open_flow_header version: 1,
+                         message_type: 1,
+                         message_length: -> { 12 + raw_data.length }
+        error_type10 :error_type, value: -> { :bad_request }
+        bad_request_code :error_code
+        rest :raw_data
       end
     end
   end

data/lib/pio/open_flow10/error/hello_failed.rb

@@ -1,4 +1,3 @@
-require 'pio/open_flow/format'
 require 'pio/open_flow/hello_failed_code'
 require 'pio/open_flow/message'
 require 'pio/open_flow10/error/error_type10'
@@ -8,33 +7,12 @@ module Pio
     module Error
       # Hello failed error.
       class HelloFailed < OpenFlow::Message
-        # Hello Failed error format.
-        class Format < BinData::Record
-          # Hello Failed error body.
-          class Body < BinData::Record
-            endian :big
-
-            error_type10 :error_type
-            hello_failed_code :error_code
-            rest :description
-
-            def length
-              4 + description.length
-            end
-          end
-
-          extend OpenFlow::Format
-
-          header version: 1, message_type: 1
-          body :body
-
-          def length
-            8 + body.length
-          end
-        end
-
-        body_option :error_code
-        body_option :description
+        open_flow_header version: 1,
+                         message_type: 1,
+                         message_length: -> { 12 + description.length }
+        error_type10 :error_type
+        hello_failed_code :error_code
+        rest :description
       end
     end
   end

data/lib/pio/open_flow10/exact_match.rb

@@ -1,49 +1,14 @@
 require 'pio/open_flow10/match'
-require 'pio/parser'
 
 module Pio
   # OpenFlow 1.0 exact match
   class ExactMatch
-    # rubocop:disable MethodLength
-    # rubocop:disable AbcSize
     def initialize(packet_in)
-      data = packet_in.data
-      case data
-      when Pio::Parser::IPv4Packet
-        options = {
-          in_port: packet_in.in_port,
-          ether_source_address: packet_in.source_mac,
-          ether_destination_address: packet_in.destination_mac,
-          vlan_vid: data.vlan_vid,
-          vlan_priority: data.vlan_pcp,
-          ether_type: data.ether_type,
-          ip_tos: data.ip_type_of_service,
-          ip_protocol: data.ip_protocol,
-          ip_source_address: data.ip_source_address,
-          ip_destination_address: data.ip_destination_address,
-          transport_source_port: data.transport_source_port,
-          transport_destination_port: data.transport_destination_port
-        }
-      when Arp::Request
-        options = {
-          in_port: packet_in.in_port,
-          ether_source_address: packet_in.source_mac,
-          ether_destination_address: packet_in.destination_mac,
-          vlan_vid: data.vlan_vid,
-          vlan_priority: data.vlan_pcp,
-          ether_type: data.ether_type,
-          ip_tos: 0,
-          ip_protocol: data.operation,
-          ip_source_address: data.sender_protocol_address,
-          ip_destination_address: data.target_protocol_address,
-          transport_source_port: 0,
-          transport_destination_port: 0
-        }
-      end
-      @match = Pio::Match.new(options)
+      @match = packet_in.data.to_exact_match(packet_in.in_port)
+    rescue NoMethodError
+      raise NotImplementedError,
+            "#{packet_in.data.class} is not yet supported by ExactMatch."
     end
-    # rubocop:enable MethodLength
-    # rubocop:enable AbcSize
 
     def method_missing(method, *args, &block)
       @match.__send__ method, *args, &block

data/lib/pio/open_flow10/features/reply.rb

@@ -1,5 +1,6 @@
 require 'pio/open_flow'
 require 'pio/open_flow10/phy_port16'
+require 'pio/open_flow10/port16'
 
 module Pio
   module OpenFlow10
@@ -7,89 +8,64 @@ module Pio
     class Features
       # OpenFlow 1.0 Features Reply message.
       class Reply < OpenFlow::Message
-        # Message body of features reply.
-        class Body < BinData::Record
-          extend OpenFlow::Flags
+        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_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]
+        # 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
+        open_flow_header version: 1,
+                         message_type: 6,
+                         message_length: -> { 32 + ports.to_binary_s.length }
 
-          datapath_id :datapath_id
-          uint32 :n_buffers
-          uint8 :n_tables
-          uint24 :padding
-          hide :padding
-          capabilities :capabilities
-          actions_flag :actions
-          array :ports, type: :phy_port16, read_until: :eof
+        datapath_id :datapath_id
+        uint32 :n_buffers
+        uint8 :n_tables
+        uint24 :padding
+        hide :padding
+        capabilities :capabilities
+        actions_flag :actions
+        array :ports, type: :phy_port16, read_until: :eof
 
-          def empty?
-            false
-          end
-
-          def length
-            24 + ports.to_binary_s.length
-          end
+        def datapath_id
+          @format.datapath_id.to_i
         end
+        alias_method :dpid, :datapath_id
 
-        # 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 <= Port16::MAX
-            end
+        def ports
+          snapshot.ports.map do |each|
+            each.instance_variable_set :@datapath_id, datapath_id
+            each
           end
+        end
 
-          def datapath_id
-            body.datapath_id.to_i
+        def physical_ports
+          ports.select do |each|
+            each.port_no <= OpenFlow10::Port16::MAX
           end
-          alias_method :dpid, :datapath_id
         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