pio 0.30.0 → 0.30.2

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow/message'
 
 module Pio
@@ -6,10 +8,10 @@ module Pio
     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 }
+        open_flow_header version: 1, type: 2
+        string :body, read_length: -> { length - header_length }
 
-        alias_method :user_data, :body
+        alias user_data body
       end
     end
   end

data/lib/pio/open_flow10/enqueue.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/monkey_patch/integer'
 require 'pio/open_flow/action'
 require 'pio/open_flow10/port16'
@@ -24,8 +26,8 @@ module Pio
       def validate_port(user_options)
         port = user_options.fetch(:port)
         if port.is_a?(Symbol) && port != :in_port
-          fail(ArgumentError,
-               ':port must be a valid physical port or :in_port')
+          raise(ArgumentError,
+                ':port must be a valid physical port or :in_port')
         end
       rescue KeyError
         raise ArgumentError, ':port is a mandatory option'
@@ -33,7 +35,7 @@ module Pio
 
       def validate_queue_id(user_options)
         unless user_options.fetch(:queue_id).unsigned_32bit?
-          fail ArgumentError, ':queue_id must be an unsigned 32-bit integer'
+          raise ArgumentError, ':queue_id must be an unsigned 32-bit integer'
         end
       rescue KeyError
         raise ArgumentError, ':queue_id is a mandatory option'

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'bindata'
+
+module Pio
+  module OpenFlow10
+    module Error
+      class BadRequest < OpenFlow::Message
+        # 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
+          }.freeze
+
+          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
+      end
+    end
+  end
+end

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

@@ -1,4 +1,8 @@
+# frozen_string_literal: true
+
+require 'pio/open_flow/error_message'
 require 'pio/open_flow/message'
+require 'pio/open_flow10/error/bad_request/bad_request_code'
 require 'pio/open_flow10/error/error_type10'
 
 module Pio
@@ -6,38 +10,12 @@ module Pio
     module Error
       # Bad request error.
       class BadRequest < OpenFlow::Message
-        # 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
-
         open_flow_header version: 1,
-                         message_type: 1,
-                         message_length: -> { 12 + raw_data.length }
+                         type: OpenFlow::ErrorMessage.type,
+                         length: -> { header_length + 4 + raw_data.length }
         error_type10 :error_type, value: -> { :bad_request }
         bad_request_code :error_code
-        rest :raw_data
+        string :raw_data, read_length: -> { length - header_length - 4 }
       end
     end
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pio
   module OpenFlow10
     module Error
@@ -10,7 +12,7 @@ module Pio
           flow_mod_failed: 3,
           port_mod_failed: 4,
           queue_operation_failed: 5
-        }
+        }.freeze
 
         endian :big
         uint16 :error_type

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+require 'pio/open_flow/error_message'
 require 'pio/open_flow/hello_failed_code'
 require 'pio/open_flow/message'
 require 'pio/open_flow10/error/error_type10'
@@ -8,11 +11,12 @@ module Pio
       # Hello failed error.
       class HelloFailed < OpenFlow::Message
         open_flow_header version: 1,
-                         message_type: 1,
-                         message_length: -> { 12 + description.length }
-        error_type10 :error_type
+                         type: OpenFlow::ErrorMessage.type,
+                         length: -> { header_length + 4 + description.length }
+
+        error_type10 :error_type, value: -> { :hello_failed }
         hello_failed_code :error_code
-        rest :description
+        string :description, read_length: -> { length - header_length - 4 }
       end
     end
   end

data/lib/pio/open_flow10/error.rb

@@ -1,28 +1,20 @@
+# frozen_string_literal: true
+
+require 'pio/open_flow/error_message'
 require 'pio/open_flow10/error/error_type10'
 
 module Pio
   module OpenFlow10
     # Error message parser
     module Error
+      extend OpenFlow::ErrorMessage
+
       # Error message body parser.
       class BodyParser < BinData::Record
         endian :big
         error_type10 :error_type
         uint16 :error_code
       end
-
-      def self.read(binary)
-        body = OpenFlowHeaderParser.read(binary).body
-        klass = case BodyParser.read(body).snapshot.error_type
-                when :hello_failed
-                  HelloFailed
-                when :bad_request
-                  BadRequest
-                else
-                  fail 'Unknown error message.'
-                end
-        klass.read binary
-      end
     end
   end
 end

data/lib/pio/open_flow10/exact_match.rb

@@ -1,17 +1,21 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow10/match'
 
 module Pio
-  # OpenFlow 1.0 exact match
-  class ExactMatch
-    def initialize(packet_in)
-      @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
+  module OpenFlow10
+    # OpenFlow 1.0 exact match
+    class ExactMatch < OpenFlow::FlowMatch
+      def initialize(packet_in)
+        @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
 
-    def method_missing(method, *args, &block)
-      @match.__send__ method, *args, &block
+      def method_missing(method, *args, &block)
+        @match.__send__ method, *args, &block
+      end
     end
   end
 end

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

@@ -1,4 +1,7 @@
-require 'pio/open_flow'
+# frozen_string_literal: true
+
+require 'pio/open_flow/datapath_id'
+require 'pio/open_flow/message'
 require 'pio/open_flow10/phy_port16'
 require 'pio/open_flow10/port16'
 
@@ -8,64 +11,48 @@ module Pio
     class Features
       # OpenFlow 1.0 Features Reply message.
       class Reply < OpenFlow::Message
-        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_source_mac_address,
-                     :set_destination_mac_address,
-                     :set_source_ip_address,
-                     :set_destination_ip_address,
-                     :set_tos,
-                     :set_transport_source_port,
-                     :set_transport_destination_port,
-                     :enqueue]
-
-        open_flow_header version: 1,
-                         message_type: 6,
-                         message_length: -> { 32 + ports.to_binary_s.length }
+        open_flow_header(version: 1,
+                         type: 6,
+                         length: lambda do
+                           header_length + 24 + PhyPort16.length * ports.length
+                         end)
 
         datapath_id :datapath_id
+        alias dpid datapath_id
         uint32 :n_buffers
         uint8 :n_tables
-        uint24 :padding
+        string :padding, length: 3
         hide :padding
-        capabilities :capabilities
-        actions_flag :actions
+        flags_32bit :capabilities,
+                    %i[flow_stats
+                       table_stats
+                       port_stats
+                       stp
+                       reserved
+                       ip_reasm
+                       queue_stats
+                       arp_match_ip]
+        flags_32bit :actions,
+                    %i[output
+                       set_vlan_vid
+                       set_vlan_pcp
+                       strip_vlan
+                       set_source_mac_address
+                       set_destination_mac_address
+                       set_source_ip_address
+                       set_destination_ip_address
+                       set_tos
+                       set_transport_source_port
+                       set_transport_destination_port
+                       enqueue]
         array :ports, type: :phy_port16, read_until: :eof
 
-        def datapath_id
-          @format.datapath_id.to_i
-        end
-        alias_method :dpid, :datapath_id
-
         def ports
-          snapshot.ports.map do |each|
-            each.instance_variable_set :@datapath_id, datapath_id
+          super.map do |each|
+            each.datapath_id = datapath_id
             each
           end
         end
-
-        def physical_ports
-          ports.select do |each|
-            each.port_no <= OpenFlow10::Port16::MAX
-          end
-        end
       end
     end
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow/message'
 
 module Pio
@@ -6,10 +8,7 @@ module Pio
     class Features
       # Features Request message.
       class Request < OpenFlow::Message
-        open_flow_header version: 1, message_type: 5
-        string :body, length: 0
-
-        alias_method :user_data, :body
+        open_flow_header version: 1, type: 5
       end
     end
   end

data/lib/pio/open_flow10/features.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow10/features/reply'
 require 'pio/open_flow10/features/request'

data/lib/pio/open_flow10/flow_mod/command.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Pio
+  module OpenFlow10
+    # OpenFlow 1.0 Flow Mod message.
+    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
+        }.freeze
+
+        endian :big
+        uint16 :command
+
+        def get
+          COMMANDS.invert.fetch(command)
+        end
+
+        def set(value)
+          self.command = COMMANDS.fetch(value)
+        end
+      end
+    end
+  end
+end

data/lib/pio/open_flow10/flow_mod.rb

@@ -1,43 +1,17 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow'
 require 'pio/open_flow10/actions'
+require 'pio/open_flow10/flow_mod/command'
 require 'pio/open_flow10/match10'
 
 module Pio
   module OpenFlow10
     # OpenFlow 1.0 Flow Mod message.
     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
-        }
-
-        endian :big
-        uint16 :command
-
-        def get
-          COMMANDS.invert.fetch(command)
-        end
-
-        def set(value)
-          self.command = COMMANDS.fetch(value)
-        end
-      end
+      open_flow_header version: 1, type: 14,
+                       length: -> { 72 + actions.binary.length }
 
-      extend OpenFlow::Flags
-
-      flags_16bit :flags,
-                  [:send_flow_rem,
-                   :check_overwrap,
-                   :emerg]
-
-      open_flow_header version: 1,
-                       message_type: 14,
-                       message_length: -> { 72 + actions.binary.length }
       match10 :match
       uint64 :cookie
       command :command
@@ -46,8 +20,11 @@ module Pio
       uint16 :priority
       uint32 :buffer_id
       uint16 :out_port
-      flags :flags
-      actions :actions, length: -> { message_length - 72 }
+      flags_16bit :flags,
+                  %i[send_flow_rem
+                     check_overwrap
+                     emerg]
+      actions10 :actions, length: -> { length - 72 }
     end
   end
 end

data/lib/pio/open_flow10/flow_removed/reason.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Pio
+  module OpenFlow10
+    # Flow Removed message
+    class FlowRemoved < OpenFlow::Message
+      # Why was this flow removed?
+      # (enum ofp_flow_removed_reason)
+      class Reason < BinData::Primitive
+        REASONS = { idle_timeout: 0, hard_timeout: 1, delete: 2 }.freeze
+
+        uint8 :reason
+
+        def get
+          REASONS.invert.fetch(reason)
+        end
+
+        def set(value)
+          self.reason = REASONS.fetch(value)
+        end
+      end
+    end
+  end
+end

data/lib/pio/open_flow10/flow_removed.rb

@@ -1,27 +1,14 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow/message'
 require 'pio/open_flow10/match10'
+require 'pio/open_flow10/flow_removed/reason'
 
 module Pio
   module OpenFlow10
     # Flow Removed message
     class FlowRemoved < OpenFlow::Message
-      # Why was this flow removed?
-      # (enum ofp_flow_removed_reason)
-      class Reason < BinData::Primitive
-        REASONS = { idle_timeout: 0, hard_timeout: 1, delete: 2 }
-
-        uint8 :reason
-
-        def get
-          REASONS.invert.fetch(reason)
-        end
-
-        def set(value)
-          self.reason = REASONS.fetch(value)
-        end
-      end
-
-      open_flow_header version: 1, message_type: 11, message_length: 88
+      open_flow_header version: 1, type: 11, length: 88
       match10 :match
       uint64 :cookie
       uint16 :priority

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow10/actions'
 require 'pio/open_flow10/match10'
 require 'pio/open_flow10/stats_type'
@@ -27,12 +29,11 @@ module Pio
           uint64 :cookie
           uint64 :packet_count
           uint64 :byte_count
-          actions :actions, length: -> { entry_length - 88 }
+          actions10 :actions, length: -> { entry_length - 88 }
         end
 
-        open_flow_header version: 1,
-                         message_type: 17,
-                         message_length: -> { 12 + stats.to_binary_s.length }
+        open_flow_header version: 1, type: 17,
+                         length: -> { 12 + stats.to_binary_s.length }
 
         stats_type :stats_type, value: -> { :flow }
         uint16 :flags

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow/message'
 require 'pio/open_flow10/match10'
 require 'pio/open_flow10/stats_type'
@@ -8,9 +10,7 @@ module Pio
     module FlowStats
       # OpenFlow 1.0 Flow Stats Request message
       class Request < OpenFlow::Message
-        open_flow_header version: 1,
-                         message_type: 16,
-                         message_length: 56
+        open_flow_header version: 1, type: 16, length: 56
 
         stats_type :stats_type, value: -> { :flow }
         uint16 :flags

data/lib/pio/open_flow10/hello.rb

@@ -1,13 +1,12 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow/message'
 
 module Pio
   module OpenFlow10
     # Hello message
     class Hello < OpenFlow::Message
-      open_flow_header version: 1, message_type: 0
-      string :body, length: 0
-
-      alias_method :user_data, :body
+      open_flow_header version: 1, type: 0
     end
   end
 end

data/lib/pio/open_flow10/match.rb

@@ -1,12 +1,15 @@
+# frozen_string_literal: true
+
 require 'English'
 require 'bindata'
+require 'pio/open_flow/flow_match'
 require 'pio/type/ip_address'
 require 'pio/type/mac_address'
 
 module Pio
   module OpenFlow10
     # Fields to match against flows
-    class Match
+    class Match < OpenFlow::FlowMatch
       # Flow wildcards
       class Wildcards < BinData::Primitive
         BITS = {
@@ -34,9 +37,9 @@ module Pio
           destination_ip_address_all: 1 << 19,
           vlan_priority: 1 << 20,
           tos: 1 << 21
-        }
-        NW_FLAGS = [:source_ip_address, :destination_ip_address]
-        FLAGS = BITS.keys.select { |each| !(/^(source|destination)_ip/=~ each) }
+        }.freeze
+        NW_FLAGS = %i[source_ip_address destination_ip_address].freeze
+        FLAGS = BITS.keys.reject { |each| (/^(source|destination)_ip/=~ each) }
 
         endian :big
 
@@ -45,7 +48,7 @@ module Pio
         # This method smells of :reek:FeatureEnvy
         def get
           BITS.each_with_object(Hash.new(0)) do |(key, bit), memo|
-            next if flags & bit == 0
+            next if (flags & bit).zero?
             if /(source_ip_address|destination_ip_address)(\d)/=~ key
               memo[$LAST_MATCH_INFO[1].to_sym] |= 1 << $LAST_MATCH_INFO[2].to_i
             else
@@ -56,13 +59,13 @@ module Pio
 
         def set(params)
           self.flags = params.inject(0) do |memo, (key, val)|
-            memo | case key
-                   when :source_ip_address, :destination_ip_address
-                     (params.fetch(key) & 31) <<
-                       (key == :source_ip_address ? 8 : 14)
-                   else
-                     val ? BITS.fetch(key) : 0
-                   end
+            memo |
+              case key
+              when :source_ip_address, :destination_ip_address
+                (params.fetch(key) & 31) << (key == :source_ip_address ? 8 : 14)
+              else
+                val ? BITS.fetch(key) : 0
+              end
           end
         end
 
@@ -143,7 +146,7 @@ module Pio
             memo["#{each}_all".to_sym] = true
           end
         end
-        @format = MatchFormat.new({ wildcards: flags }.merge user_options)
+        @format = MatchFormat.new({ wildcards: flags }.merge(user_options))
       end
       # rubocop:enable MethodLength
 

data/lib/pio/open_flow10/match10.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow10/match'
 
 module Pio

data/lib/pio/open_flow10/packet_in/reason.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Pio
+  module OpenFlow10
+    class PacketIn < OpenFlow::Message
+      # Why is this packet being sent to the controller?
+      # (enum ofp_packet_in_reason)
+      class Reason < BinData::Primitive
+        REASONS = { no_match: 0, action: 1 }.freeze
+
+        uint8 :reason
+
+        def get
+          REASONS.invert.fetch(reason)
+        end
+
+        def set(value)
+          self.reason = REASONS.fetch(value)
+        end
+
+        def to_bytes
+          reason.to_hex
+        end
+      end
+    end
+  end
+end