pio 0.30.0 → 0.30.1

data/lib/pio/open_flow13/flow_mod.rb

@@ -1,5 +1,5 @@
 require 'pio/open_flow'
-require 'pio/open_flow13/buffer_id'
+require 'pio/open_flow/buffer_id'
 require 'pio/open_flow13/match'
 
 module Pio
@@ -14,7 +14,7 @@ module Pio
           modify_strict: 2,
           delete: 3,
           delete_strict: 4
-        }
+        }.freeze
 
         uint8 :command
 
@@ -36,7 +36,7 @@ module Pio
         uint32 :out_port, initial_value: ANY
 
         def get
-          (out_port == ANY) ? :any : out_port
+          out_port == ANY ? :any : out_port
         end
 
         def set(value)
@@ -53,7 +53,7 @@ module Pio
         uint32 :out_group, initial_value: ANY
 
         def get
-          (out_group == ANY) ? :any : out_group
+          out_group == ANY ? :any : out_group
         end
 
         def set(value)
@@ -76,7 +76,7 @@ module Pio
         def get
           list = []
           tmp = instructions
-          while tmp.length > 0
+          until tmp.empty?
             instruction_type = BinData::Uint16be.read(tmp)
             instruction = case instruction_type
                           when 1
@@ -88,7 +88,7 @@ module Pio
                           when 6
                             Meter.read(tmp)
                           else
-                            fail "Unsupported instruction #{instruction_type}"
+                            raise "Unsupported instruction #{instruction_type}"
                           end
             tmp = tmp[instruction.instruction_length..-1]
             list << instruction
@@ -102,18 +102,8 @@ module Pio
         end
       end
 
-      extend OpenFlow::Flags
-
-      flags_16bit :flags,
-                  [:send_flow_rem,
-                   :check_overwrap,
-                   :reset_counts,
-                   :no_packet_counts,
-                   :no_byte_counts]
-
-      open_flow_header(version: 4,
-                       message_type: 14,
-                       message_length: lambda do
+      open_flow_header(version: 4, type: 14,
+                       length: lambda do
                          48 + match.length + instructions.length
                        end)
       uint64 :cookie
@@ -126,7 +116,12 @@ module Pio
       buffer_id :buffer_id
       out_port :out_port
       out_group :out_group
-      flags :flags
+      flags_16bit :flags,
+                  [:send_flow_rem,
+                   :check_overwrap,
+                   :reset_counts,
+                   :no_packet_counts,
+                   :no_byte_counts]
       string :padding, length: 2
       hide :padding
       oxm :match

data/lib/pio/open_flow13/goto_table.rb

@@ -1,37 +1,39 @@
 require 'bindata'
 require 'forwardable'
+require 'pio/open_flow/instruction'
 
-# Base module.
 module Pio
-  # Resubmit to the table_id
-  class GotoTable
-    # OpenFlow 1.3.4 OFPIT_GOTO_TABLE instruction format
-    class Format < BinData::Record
-      endian :big
+  module OpenFlow13
+    # Resubmit to the table_id
+    class GotoTable < OpenFlow::Instruction
+      # OpenFlow 1.3.4 OFPIT_GOTO_TABLE instruction format
+      class Format < BinData::Record
+        endian :big
 
-      uint16 :instruction_type, value: 1
-      uint16 :instruction_length, value: 8
-      uint8 :table_id
-      bit24 :padding
-      hide :padding
-    end
+        uint16 :instruction_type, value: 1
+        uint16 :instruction_length, value: 8
+        uint8 :table_id
+        bit24 :padding
+        hide :padding
+      end
 
-    def self.read(raw_data)
-      allocate.tap do |goto_table|
-        goto_table.instance_variable_set :@format, Format.read(raw_data)
+      def self.read(raw_data)
+        allocate.tap do |goto_table|
+          goto_table.instance_variable_set :@format, Format.read(raw_data)
+        end
       end
-    end
 
-    extend Forwardable
+      extend Forwardable
 
-    def_delegators :@format, :instruction_type
-    def_delegators :@format, :instruction_length
-    def_delegators :@format, :table_id
-    def_delegators :@format, :to_binary_s
-    def_delegator :@format, :to_binary_s, :to_binary
+      def_delegators :@format, :instruction_type
+      def_delegators :@format, :instruction_length
+      def_delegators :@format, :table_id
+      def_delegators :@format, :to_binary_s
+      def_delegator :@format, :to_binary_s, :to_binary
 
-    def initialize(table_id)
-      @format = Format.new(table_id: table_id)
+      def initialize(table_id)
+        @format = Format.new(table_id: table_id)
+      end
     end
   end
 end

data/lib/pio/open_flow13/hello.rb

@@ -41,8 +41,8 @@ module Pio
         end
       end
 
-      open_flow_header version: 4, message_type: 0
-      body :body
+      open_flow_header version: 4, type: 0
+      body :body, read_length: -> { length - header_length }
 
       def elements
         body.elements
@@ -68,11 +68,10 @@ module Pio
       end
 
       def initialize(user_options = {})
-        validate_user_options user_options
         body_options = { elements: [{ element_type: VERSION_BITMAP,
                                       element_length: 8,
                                       element_value: 0b10000 }] }
-        @format = Format.new(user_options.merge(body: body_options))
+        super user_options.merge(body: body_options)
       end
     end
   end

data/lib/pio/open_flow13/match.rb

@@ -1,4 +1,5 @@
 require 'bindata'
+require 'pio/open_flow/flow_match'
 require 'pio/type/ip_address'
 require 'pio/type/ipv6_address'
 require 'pio/type/mac_address'
@@ -11,7 +12,7 @@ module Pio
     MATCH_TYPE_OXM = 1
 
     # OpenFlow eXtensible Match (OXM)
-    class Match
+    class Match < OpenFlow::FlowMatch
       # OFPXMC_NXM_1 TLV value
       class NiciraMatchExtensionValue < BinData::Record
         OXM_CLASS = 0x1
@@ -22,6 +23,11 @@ module Pio
         OXM_CLASS = 0x8000
       end
 
+      # OFPXMC_PACKET_REGS TLV value
+      class PacketRegistersValue < BinData::Record
+        OXM_CLASS = 0x8001
+      end
+
       # OFPXMC_EXPERIMENTER TLV value
       class ExperimenterValue < BinData::Record
         OXM_CLASS = 0xFFFF
@@ -759,6 +765,105 @@ module Pio
         end
       end
 
+      # OXM_PACKET_REG0 match field
+      class PacketReg0 < PacketRegistersValue
+        OXM_FIELD = 0
+
+        endian :big
+
+        uint64 :packet_reg0
+
+        def length
+          8
+        end
+      end
+
+      # Masked OXM_PACKET_REG0 match field
+      class MaskedPacketReg0 < PacketRegistersValue
+        endian :big
+
+        uint64 :packet_reg0
+        uint64 :packet_reg0_mask
+
+        def length
+          16
+        end
+      end
+      # OXM_PACKET_REG1 match field
+      class PacketReg1 < PacketRegistersValue
+        OXM_FIELD = 1
+
+        endian :big
+
+        uint64 :packet_reg1
+
+        def length
+          8
+        end
+      end
+
+      # Masked OXM_PACKET_REG1 match field
+      class MaskedPacketReg1 < PacketRegistersValue
+        endian :big
+
+        uint64 :packet_reg1
+        uint64 :packet_reg1_mask
+
+        def length
+          16
+        end
+      end
+
+      # OXM_PACKET_REG2 match field
+      class PacketReg2 < PacketRegistersValue
+        OXM_FIELD = 2
+
+        endian :big
+
+        uint64 :packet_reg2
+
+        def length
+          8
+        end
+      end
+
+      # Masked OXM_PACKET_REG2 match field
+      class MaskedPacketReg2 < PacketRegistersValue
+        endian :big
+
+        uint64 :packet_reg2
+        uint64 :packet_reg2_mask
+
+        def length
+          16
+        end
+      end
+
+      # OXM_PACKET_REG3 match field
+      class PacketReg3 < PacketRegistersValue
+        OXM_FIELD = 3
+
+        endian :big
+
+        uint64 :packet_reg3
+
+        def length
+          8
+        end
+      end
+
+      # Masked OXM_PACKET_REG3 match field
+      class MaskedPacketReg3 < PacketRegistersValue
+        endian :big
+
+        uint64 :packet_reg3
+        uint64 :packet_reg3_mask
+
+        def length
+          16
+        end
+      end
+
       # OXM format
       class Oxm < BinData::Record
         # Experimenter part, data will use oxm_length
@@ -840,7 +945,7 @@ module Pio
             when Reg7::OXM_FIELD
               masked? ? MaskedReg7 : Reg7
             else
-              fail "Unknown OXM field value: #{oxm_field}"
+              raise "Unknown OXM field value: #{oxm_field}"
             end
           end
           # rubocop:enable AbcSize
@@ -998,7 +1103,7 @@ module Pio
             when TunnelId::OXM_FIELD
               masked? ? MaskedTunnelId : TunnelId
             else
-              fail "Unknown OXM field value: #{oxm_field}"
+              raise "Unknown OXM field value: #{oxm_field}"
             end
           end
           # rubocop:enable MethodLength
@@ -1008,6 +1113,58 @@ module Pio
         end
         # rubocop:enable MethodLength
 
+        # Packet Register match field.
+        class PacketRegisters < BinData::Record
+          endian :big
+
+          bit7 :oxm_field
+          bit1 :oxm_hasmask
+          uint8 :oxm_length, value: -> { tlv_value.length }
+          choice :tlv_value, selection: :choose_tlv_value do
+            packet_reg0 PacketReg0
+            masked_packet_reg0 MaskedPacketReg0
+            packet_reg1 PacketReg1
+            masked_packet_reg1 MaskedPacketReg1
+            packet_reg2 PacketReg2
+            masked_packet_reg2 MaskedPacketReg2
+            packet_reg3 PacketReg3
+            masked_packet_reg3 MaskedPacketReg3
+          end
+
+          def length
+            tlv_value.length + 2
+          end
+
+          def masked?
+            oxm_hasmask == 1
+          end
+
+          def method_missing(method, *args, &block)
+            tlv_value.__send__ method, *args, &block
+          end
+
+          private
+
+          # rubocop:disable CyclomaticComplexity
+          # rubocop:disable MethodLength
+          def choose_tlv_value
+            case oxm_field
+            when PacketReg0::OXM_FIELD
+              masked? ? MaskedPacketReg0 : PacketReg0
+            when PacketReg1::OXM_FIELD
+              masked? ? MaskedPacketReg1 : PacketReg1
+            when PacketReg2::OXM_FIELD
+              masked? ? MaskedPacketReg2 : PacketReg2
+            when PacketReg3::OXM_FIELD
+              masked? ? MaskedPacketReg3 : PacketReg3
+            else
+              raise "Unknown OXM field value: #{oxm_field}"
+            end
+          end
+          # rubocop:enable CyclomaticComplexity
+          # rubocop:enable MethodLength
+        end
+
         # OXM match field.
         class MatchField < BinData::Record
           endian :big
@@ -1017,6 +1174,7 @@ module Pio
             NiciraMatchExtension NiciraMatchExtensionValue::OXM_CLASS
             OpenflowBasic OpenFlowBasicValue::OXM_CLASS
             Experimenter ExperimenterValue::OXM_CLASS
+            PacketRegisters PacketRegistersValue::OXM_CLASS
           end
 
           def oxm_field
@@ -1041,8 +1199,10 @@ module Pio
               return class_payload.tlv_value.__send__(method, *args, &block)
             when ExperimenterValue::OXM_CLASS
               return class_payload.__send__(method, *args, &block)
+            when PacketRegistersValue::OXM_CLASS
+              return class_payload.__send__(method, *args, &block)
             else
-              fail NoMethodError, method.to_s
+              raise NoMethodError, method.to_s
             end
           end
         end
@@ -1062,18 +1222,21 @@ module Pio
           match_length + padding_length
         end
 
+        # rubocop:disable AbcSize
         # rubocop:disable Next
         # rubocop:disable LineLength
         def method_missing(method, *args, &block)
           match_fields.each do |each|
-            if each.oxm_class == OpenFlowBasicValue::OXM_CLASS || each.oxm_class == NiciraMatchExtensionValue::OXM_CLASS
+            if each.oxm_class == OpenFlowBasicValue::OXM_CLASS || each.oxm_class == NiciraMatchExtensionValue::OXM_CLASS || each.oxm_class == PacketRegistersValue::OXM_CLASS
               next unless each.class_payload.tlv_value.respond_to?(method)
               return each.class_payload.tlv_value.__send__(
-                method, *args, &block)
+                method, *args, &block
+              )
             end
           end
-          fail NoMethodError, method.to_s
+          raise NoMethodError, method.to_s
         end
+        # rubocop:enable AbcSize
         # rubocop:enable Next
         # rubocop:enable LineLength
 
@@ -1084,7 +1247,7 @@ module Pio
         end
 
         def tlv_total_length
-          if match_fields.size > 0
+          if !match_fields.empty?
             match_fields.map(&:length).inject(&:+)
           else
             0
@@ -1121,7 +1284,8 @@ module Pio
            :arp_sender_protocol_address, :arp_target_protocol_address,
            :arp_sender_hardware_address, :arp_target_hardware_address,
            :ipv6_source_address, :ipv6_destination_address, :tunnel_id,
-           :reg0, :reg1, :reg2, :reg3, :reg4, :reg5, :reg6, :reg7].each do |each|
+           :reg0, :reg1, :reg2, :reg3, :reg4, :reg5, :reg6, :reg7,
+           :packet_reg0, :packet_reg1, :packet_reg2, :packet_reg3].each do |each|
             next unless user_attrs.key?(each)
             klass = Match.const_get(each.to_s.split('_').map(&:capitalize).join)
             mask_key = "#{each}_mask".to_sym

data/lib/pio/open_flow13/meter.rb

@@ -1,33 +1,36 @@
 require 'forwardable'
+require 'pio/open_flow/instruction'
 
 # Base module.
 module Pio
-  # Apply meter (rate limiter)
-  class Meter
-    # OpenFlow 1.3.4 OFPIT_METER instruction format
-    class Format < BinData::Record
-      endian :big
+  module OpenFlow13
+    # Apply meter (rate limiter)
+    class Meter < OpenFlow::Instruction
+      # OpenFlow 1.3.4 OFPIT_METER instruction format
+      class Format < BinData::Record
+        endian :big
 
-      uint16 :instruction_type, value: 6
-      uint16 :instruction_length, value: 8
-      uint32 :meter_id
-    end
+        uint16 :instruction_type, value: 6
+        uint16 :instruction_length, value: 8
+        uint32 :meter_id
+      end
 
-    def self.read(raw_data)
-      allocate.tap do |meter|
-        meter.instance_variable_set :@format, Format.read(raw_data)
+      def self.read(raw_data)
+        allocate.tap do |meter|
+          meter.instance_variable_set :@format, Format.read(raw_data)
+        end
       end
-    end
 
-    extend Forwardable
+      extend Forwardable
 
-    def_delegators :@format, :instruction_type
-    def_delegators :@format, :instruction_length
-    def_delegators :@format, :meter_id
-    def_delegators :@format, :to_binary_s
+      def_delegators :@format, :instruction_type
+      def_delegators :@format, :instruction_length
+      def_delegators :@format, :meter_id
+      def_delegators :@format, :to_binary_s
 
-    def initialize(meter_id)
-      @format = Format.new(meter_id: meter_id)
+      def initialize(meter_id)
+        @format = Format.new(meter_id: meter_id)
+      end
     end
   end
 end