pio 0.30.0 → 0.30.1

data/lib/pio/open_flow10/exact_match.rb

@@ -1,17 +1,19 @@
 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,5 @@
-require 'pio/open_flow'
+require 'pio/open_flow/datapath_id'
+require 'pio/open_flow/message'
 require 'pio/open_flow10/phy_port16'
 require 'pio/open_flow10/port16'
 
@@ -8,9 +9,18 @@ module Pio
     class Features
       # OpenFlow 1.0 Features Reply message.
       class Reply < OpenFlow::Message
-        extend OpenFlow::Flags
+        open_flow_header(version: 1,
+                         type: 6,
+                         length: lambda do
+                           header_length + 24 + PhyPort16.length * ports.length
+                         end)
 
-        # enum ofp_capabilities
+        datapath_id :datapath_id
+        alias dpid datapath_id
+        uint32 :n_buffers
+        uint8 :n_tables
+        string :padding, length: 3
+        hide :padding
         flags_32bit :capabilities,
                     [:flow_stats,
                      :table_stats,
@@ -20,9 +30,7 @@ module Pio
                      :ip_reasm,
                      :queue_stats,
                      :arp_match_ip]
-
-        # enum ofp_action_type
-        flags_32bit :actions_flag,
+        flags_32bit :actions,
                     [:output,
                      :set_vlan_vid,
                      :set_vlan_pcp,
@@ -35,37 +43,14 @@ module Pio
                      :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 }
-
-        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 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

@@ -6,10 +6,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/flow_mod.rb

@@ -1,43 +1,15 @@
 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
-        }
+      open_flow_header version: 1, type: 14,
+                       length: -> { 72 + actions.binary.length }
 
-        endian :big
-        uint16 :command
-
-        def get
-          COMMANDS.invert.fetch(command)
-        end
-
-        def set(value)
-          self.command = COMMANDS.fetch(value)
-        end
-      end
-
-      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 +18,11 @@ module Pio
       uint16 :priority
       uint32 :buffer_id
       uint16 :out_port
-      flags :flags
-      actions :actions, length: -> { message_length - 72 }
+      flags_16bit :flags,
+                  [:send_flow_rem,
+                   :check_overwrap,
+                   :emerg]
+      actions10 :actions, length: -> { length - 72 }
     end
   end
 end

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

@@ -0,0 +1,28 @@
+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_removed.rb

@@ -1,27 +1,12 @@
 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_removed/reason.rb

@@ -0,0 +1,22 @@
+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_stats/reply.rb

@@ -27,12 +27,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

@@ -8,9 +8,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

@@ -4,10 +4,7 @@ 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,13 @@
 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,8 +35,8 @@ module Pio
           destination_ip_address_all: 1 << 19,
           vlan_priority: 1 << 20,
           tos: 1 << 21
-        }
-        NW_FLAGS = [:source_ip_address, :destination_ip_address]
+        }.freeze
+        NW_FLAGS = [:source_ip_address, :destination_ip_address].freeze
         FLAGS = BITS.keys.select { |each| !(/^(source|destination)_ip/=~ each) }
 
         endian :big
@@ -45,7 +46,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 +57,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 +144,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/packet_in.rb

@@ -1,39 +1,21 @@
-require 'pio/ethernet_header'
-require 'pio/ipv4_header'
-require 'pio/open_flow'
-require 'pio/parse_error'
+require 'active_support/core_ext/object/try'
+require 'pio/open_flow/message'
+require 'pio/open_flow10/packet_in/reason'
 require 'pio/parser'
 
 module Pio
   module OpenFlow10
     # OpenFlow 1.0 Packet-In message
     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 }
-
-        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: 10,
-                       message_length: -> { 18 + raw_data.length }
+                       type: 10,
+                       length: -> { header_length + 10 + raw_data.length }
       uint32 :buffer_id
-      uint16 :total_len, value: -> { raw_data.length }
+      uint16 :total_length, initial_value: -> { raw_data.length }
       uint16 :in_port
       reason :reason
       uint8 :padding
-      hide :padding
-      string :raw_data, read_length: :total_len
+      string :raw_data, read_length: -> { length - header_length - 10 }
 
       def data
         @data ||= Pio::Parser.read(raw_data)
@@ -43,13 +25,35 @@ module Pio
         data.is_a? Lldp
       end
 
+      def to_ruby
+        @format.to_ruby
+      end
+
+      # rubocop:disable LineLength
+      def self.inspect
+        'PacketIn(open_flow_version: uint8, message_type: uint8, message_length: uint16, transaction_id: uint32, buffer_id: uint32, total_length: uint16, in_port: uint16, reason: symbol, raw_data: string)'
+      end
+      # rubocop:enable LineLength
+
+      # rubocop:disable LineLength
+      def inspect
+        data_inspection = if raw_data.empty?
+                            %(raw_data: "")
+                          else
+                            %(data: #{data.inspect})
+                          end
+        %(#<PacketIn open_flow_version: #{version}, message_type: #{type}, message_length: #{_length}, transaction_id: #{Kernel.format('0x%x', transaction_id)}, buffer_id: #{Kernel.format('0x%x', buffer_id)}, total_length: #{total_length}, in_port: #{in_port}, reason: :#{reason}, #{data_inspection}>)
+      end
+      # rubocop:enable LineLength
+
       def method_missing(method, *args)
-        data.__send__(method, *args).snapshot
+        bindata_value = data.__send__(method, *args)
+        bindata_value.try(:snapshot) || bindata_value
       end
 
       attr_accessor :datapath_id
-      alias_method :dpid, :datapath_id
-      alias_method :dpid=, :datapath_id=
+      alias dpid datapath_id
+      alias dpid= datapath_id=
     end
   end
 end