pio 0.30.0 → 0.30.2

data/lib/pio/open_flow10/vendor_action.rb

@@ -1,33 +1,37 @@
+# frozen_string_literal: true
+
 require 'bindata'
 require 'forwardable'
 
 module Pio
-  # Vendor defined action
-  class VendorAction
-    # OpenFlow 1.0 OFPAT_VENDOR action format.
-    class Format < BinData::Record
-      endian :big
+  module OpenFlow10
+    # Vendor defined action
+    class VendorAction
+      # OpenFlow 1.0 OFPAT_VENDOR action format.
+      class Format < BinData::Record
+        endian :big
 
-      uint16 :action_type, value: 0xffff
-      uint16 :action_length, value: 8
-      uint32 :vendor
-    end
+        uint16 :action_type, value: 0xffff
+        uint16 :action_length, value: 8
+        uint32 :vendor
+      end
 
-    def self.read(raw_data)
-      allocate.tap do |strip_vlan|
-        strip_vlan.instance_variable_set :@format, Format.read(raw_data)
+      def self.read(raw_data)
+        allocate.tap do |strip_vlan|
+          strip_vlan.instance_variable_set :@format, Format.read(raw_data)
+        end
       end
-    end
 
-    extend Forwardable
+      extend Forwardable
 
-    def_delegators :@format, :action_type
-    def_delegator :@format, :action_length, :length
-    def_delegators :@format, :vendor
-    def_delegator :@format, :to_binary_s, :to_binary
+      def_delegators :@format, :action_type
+      def_delegator :@format, :action_length, :length
+      def_delegators :@format, :vendor
+      def_delegator :@format, :to_binary_s, :to_binary
 
-    def initialize(vendor)
-      @format = Format.new(vendor: vendor)
+      def initialize(vendor)
+        @format = Format.new(vendor: vendor)
+      end
     end
   end
 end

data/lib/pio/open_flow10.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Messages
 require 'pio/open_flow10/aggregate_stats/reply'
 require 'pio/open_flow10/aggregate_stats/request'

data/lib/pio/open_flow13/actions.rb

@@ -1,47 +1,51 @@
+# frozen_string_literal: true
+
 require 'bindata'
 
 module Pio
-  # Actions not yet implemented.
-  class UnsupportedAction < BinData::Record
-    endian :big
+  module OpenFlow13
+    # Actions not yet implemented.
+    class UnsupportedAction < BinData::Record
+      endian :big
 
-    uint16 :action_type
-    uint16 :action_length
-    string :body, length: -> { action_length - 4 }
+      uint16 :action_type
+      uint16 :action_length
+      string :body, length: -> { action_length - 4 }
 
-    def to_binary
-      to_binary_s
+      def to_binary
+        to_binary_s
+      end
     end
-  end
 
-  # Actions list of actions-apply instruction.
-  class Actions < BinData::Primitive
-    mandatory_parameter :length
+    # Actions list of actions-apply instruction.
+    class Actions13 < BinData::Primitive
+      mandatory_parameter :length
 
-    endian :big
+      endian :big
 
-    string :binary, read_length: :length
+      string :binary, read_length: :length
 
-    def set(actions)
-      self.binary = Array(actions).map(&:to_binary).join
-    end
+      def set(actions)
+        self.binary = Array(actions).map(&:to_binary).join
+      end
 
-    # rubocop:disable MethodLength
-    def get
-      actions = []
-      tmp = binary
-      while tmp.length > 0
-        action = case BinData::Uint16be.read(tmp)
-                 when 0
-                   SendOutPort.read(tmp)
-                 else
-                   UnsupportedAction.read(tmp)
-                 end
-        tmp = tmp[action.action_length..-1]
-        actions << action
+      # rubocop:disable MethodLength
+      def get
+        actions = []
+        tmp = binary
+        until tmp.empty?
+          action = case BinData::Uint16be.read(tmp)
+                   when 0
+                     OpenFlow13::SendOutPort.read(tmp)
+                   else
+                     UnsupportedAction.read(tmp)
+                   end
+          tmp = tmp[action.action_length..-1]
+          actions << action
+        end
+        actions
       end
-      actions
+      # rubocop:enable MethodLength
     end
-    # rubocop:enable MethodLength
   end
 end

data/lib/pio/open_flow13/apply.rb

@@ -1,36 +1,41 @@
+# frozen_string_literal: true
+
 require 'bindata'
 require 'forwardable'
+require 'pio/open_flow/instruction'
 require 'pio/open_flow13/actions'
 
 module Pio
-  # An instruction to apply a list of actions to a packet in-order.
-  class Apply
-    # OpenFlow 1.3.4 OFPIT_APPLY_ACTIONS instruction format.
-    class Format < BinData::Record
-      endian :big
+  module OpenFlow13
+    # An instruction to apply a list of actions to a packet in-order.
+    class Apply < OpenFlow::Instruction
+      # OpenFlow 1.3.4 OFPIT_APPLY_ACTIONS instruction format.
+      class Format < BinData::Record
+        endian :big
 
-      uint16 :instruction_type, value: 4
-      uint16 :instruction_length,
-             initial_value: -> { 8 + actions.binary.length }
-      string :padding, length: 4
-      actions :actions, length: -> { instruction_length - 8 }
-    end
+        uint16 :instruction_type, value: 4
+        uint16 :instruction_length,
+               initial_value: -> { 8 + actions.binary.length }
+        string :padding, length: 4
+        actions13 :actions, length: -> { instruction_length - 8 }
+      end
 
-    def self.read(raw_data)
-      allocate.tap do |apply|
-        apply.instance_variable_set :@format, Format.read(raw_data)
+      def self.read(raw_data)
+        allocate.tap do |apply|
+          apply.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, :actions
-    def_delegators :@format, :to_binary_s
+      def_delegators :@format, :instruction_type
+      def_delegators :@format, :instruction_length
+      def_delegators :@format, :actions
+      def_delegators :@format, :to_binary_s
 
-    def initialize(actions = [])
-      @format = Format.new(actions: actions)
+      def initialize(actions = [])
+        @format = Format.new(actions: actions)
+      end
     end
   end
 end

data/lib/pio/open_flow13/copy_ttl_inwards.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'pio/open_flow/action'
+
+module Pio
+  module OpenFlow13
+    # Copies TTL "inwards" -- from outermost to next-to-outermost
+    class CopyTtlInwards < OpenFlow::Action
+      action_header action_type: 12, action_length: 8
+      string :padding, length: 4
+
+      def initialize
+        super({})
+      end
+    end
+  end
+end

data/lib/pio/open_flow13/copy_ttl_outwards.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'pio/open_flow/action'
+
+module Pio
+  module OpenFlow13
+    # Copies TTL "outwards" -- from next-to-outermost to outermost
+    class CopyTtlOutwards < OpenFlow::Action
+      action_header action_type: 11, action_length: 8
+      string :padding, length: 4
+
+      def initialize
+        super({})
+      end
+    end
+  end
+end

data/lib/pio/open_flow13/decrement_ip_ttl.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'pio/open_flow/action'
+
+module Pio
+  module OpenFlow13
+    # Decrements IP TTL
+    class DecrementIpTtl < OpenFlow::Action
+      action_header action_type: 24, action_length: 8
+      string :padding, length: 4
+
+      def initialize
+        super({})
+      end
+    end
+  end
+end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow/message'
 
 module Pio
@@ -5,10 +7,10 @@ module Pio
     module Echo
       # OpenFlow 1.3 Echo Reply message.
       class Reply < OpenFlow::Message
-        open_flow_header version: 4, message_type: 3
-        string :body, read_length: -> { message_length - 8 }
+        open_flow_header version: 4, type: 3
+        string :body, read_length: -> { length - 8 }
 
-        alias_method :user_data, :body
+        alias user_data body
       end
     end
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow/message'
 
 module Pio
@@ -5,10 +7,10 @@ module Pio
     module Echo
       # OpenFlow 1.3 Echo Request message.
       class Request < OpenFlow::Message
-        open_flow_header version: 4, message_type: 2
-        string :body, read_length: -> { message_length - 8 }
+        open_flow_header version: 4, 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_flow13/error/bad_request.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+require 'pio/open_flow/error_message'
 require 'pio/open_flow/message'
 require 'pio/open_flow13/error/error_type13'
 
@@ -23,7 +26,7 @@ module Pio
             bad_port: 11,
             bad_packet: 12,
             multipart_buffer_overflow: 13
-          }
+          }.freeze
 
           endian :big
           uint16 :error_code
@@ -38,8 +41,8 @@ module Pio
         end
 
         open_flow_header version: 4,
-                         message_type: 1,
-                         message_length: -> { 12 + raw_data.length }
+                         type: OpenFlow::ErrorMessage.type,
+                         length: -> { 12 + raw_data.length }
         error_type13 :error_type, value: -> { :bad_request }
         bad_request_code :error_code
         rest :raw_data

data/lib/pio/open_flow13/error/error_type13.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pio
   module OpenFlow13
     module Error
@@ -19,7 +21,7 @@ module Pio
           meter_mod_failed: 12,
           table_features_failed: 13,
           experimenter: 0xffff
-        }
+        }.freeze
 
         endian :big
         uint16 :error_type

data/lib/pio/open_flow13/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_flow13/error/error_type13'
@@ -8,8 +11,8 @@ module Pio
       # Hello Failed error message
       class HelloFailed < OpenFlow::Message
         open_flow_header version: 4,
-                         message_type: 1,
-                         message_length: -> { 12 + description.length }
+                         type: OpenFlow::ErrorMessage.type,
+                         length: -> { 12 + description.length }
         error_type13 :error_type
         hello_failed_code :error_code
         rest :description

data/lib/pio/open_flow13/error.rb

@@ -1,33 +1,24 @@
+# frozen_string_literal: true
+
+require 'pio/open_flow/error_message'
+require 'pio/open_flow13/error/bad_request'
 require 'pio/open_flow13/error/error_type13'
+require 'pio/open_flow13/error/hello_failed'
 
 module Pio
   module OpenFlow13
     # Error message parser
     module Error
+      mattr_reader(:type) { 1 }
+
+      extend OpenFlow::ErrorMessage
+
       # Error message body parser.
       class BodyParser < BinData::Record
         endian :big
         error_type13 :error_type
         uint16 :error_code
       end
-
-      # rubocop:disable MethodLength
-      def self.read(binary)
-        body = OpenFlowHeaderParser.read(binary).body
-        error = BodyParser.read(body).snapshot
-        klass = case error.error_type
-                when :hello_failed
-                  HelloFailed
-                when :bad_request
-                  BadRequest
-                else
-                  # Not implemented yet
-                  fail 'Unknown error message '\
-                       "(type=#{error.error_type}, code=#{error.error_code})"
-                end
-        klass.read binary
-      end
-      # rubocop:enable MethodLength
     end
   end
 end

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+require 'pio/open_flow/datapath_id'
 require 'pio/open_flow/message'
 
 module Pio
@@ -6,33 +9,25 @@ module Pio
     class Features
       # Features Reply message.
       class Reply < OpenFlow::Message
-        extend OpenFlow::Flags
-
-        flags_32bit(:capabilities,
-                    [:flow_stats,
-                     :table_stats,
-                     :port_stats,
-                     :group_stats,
-                     :NOT_USED,
-                     :ip_reasm,
-                     :queue_stats,
-                     :NOT_USED,
-                     :port_blocked])
-
-        open_flow_header version: 4, message_type: 6, message_length: 32
+        open_flow_header version: 4, type: 6, length: 32
         datapath_id :datapath_id
+        alias dpid datapath_id
         uint32 :n_buffers
         uint8 :n_tables
         uint8 :auxiliary_id
         uint16 :padding
         hide :padding
-        capabilities :capabilities
+        flags_32bit(:capabilities,
+                    %i[flow_stats
+                       table_stats
+                       port_stats
+                       group_stats
+                       NOT_USED
+                       ip_reasm
+                       queue_stats
+                       NOT_USED
+                       port_blocked])
         uint32 :reserved
-
-        def datapath_id
-          @format.datapath_id.to_i
-        end
-        alias_method :dpid, :datapath_id
       end
     end
   end

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

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

data/lib/pio/open_flow13/flow_mod.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 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 +16,7 @@ module Pio
           modify_strict: 2,
           delete: 3,
           delete_strict: 4
-        }
+        }.freeze
 
         uint8 :command
 
@@ -36,7 +38,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 +55,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 +78,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 +90,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 +104,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 +118,12 @@ module Pio
       buffer_id :buffer_id
       out_port :out_port
       out_group :out_group
-      flags :flags
+      flags_16bit :flags,
+                  %i[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,41 @@
+# frozen_string_literal: true
+
 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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow'
 
 module Pio
@@ -41,8 +43,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 +70,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