pio 0.30.0 → 0.30.1

data/lib/pio/open_flow/nicira_resubmit.rb

@@ -1,18 +1,20 @@
 require 'pio/open_flow/nicira_action'
-require 'pio/open_flow10/port16'
 
 module Pio
-  # NXAST_RESUBMIT action
-  class NiciraResubmit < OpenFlow::NiciraAction
-    nicira_action_header action_type: 0xffff,
-                         action_length: 16,
-                         subtype: 1
-    port16 :in_port
-    string :padding, length: 4
-    hide :padding
+  module OpenFlow
+    # NXAST_RESUBMIT action
+    class NiciraResubmit < OpenFlow::NiciraAction
+      nicira_action_header action_type: 0xffff,
+                           action_length: 16,
+                           subtype: 1
+      uint16 :in_port
+      string :padding, length: 4
+      hide :padding
 
-    def initialize(port_number)
-      super(in_port: port_number)
+      def initialize(port_number)
+        super(in_port: port_number)
+      end
     end
   end
+  NiciraResubmit = OpenFlow::NiciraResubmit
 end

data/lib/pio/open_flow/nicira_resubmit_table.rb

@@ -1,15 +1,22 @@
 require 'pio/open_flow/nicira_action'
-require 'pio/open_flow10/port16'
 
 module Pio
-  # NXAST_RESUBMIT_TABLE action
-  class NiciraResubmitTable < OpenFlow::NiciraAction
-    nicira_action_header action_type: 0xffff,
-                         action_length: 16,
-                         subtype: 14
-    port16 :in_port
-    uint8 :table, initial_value: 0xff
-    string :padding, length: 3
-    hide :padding
+  module OpenFlow
+    # NXAST_RESUBMIT_TABLE action
+    class NiciraResubmitTable < OpenFlow::NiciraAction
+      nicira_action_header action_type: 0xffff,
+                           action_length: 16,
+                           subtype: 14
+      uint16 :in_port
+      uint8 :table, initial_value: 0xff
+      string :padding, length: 3
+      hide :padding
+
+      def initialize(options)
+        raise ':in_port option is a mandatory' unless options.key?(:in_port)
+        super options
+      end
+    end
   end
+  NiciraResubmitTable = OpenFlow::NiciraResubmitTable
 end

data/lib/pio/open_flow/parser.rb

@@ -0,0 +1,19 @@
+require 'pio/open_flow10'
+require 'pio/open_flow13'
+
+module Pio
+  module OpenFlow
+    # Collection class of OpenFlow message parser class
+    class Parser
+      def self.find_by_type!(type)
+        message_class = [Hello, Error, Echo::Request, Echo::Reply,
+                         Features::Request, Features::Reply, PacketIn,
+                         PacketOut, FlowMod, PortStatus, Stats::Request,
+                         Stats::Reply, Barrier::Request, Barrier::Reply]
+        message_class.each_with_object({}) do |each, hash|
+          hash[each.type] = each
+        end.fetch(type)
+      end
+    end
+  end
+end

data/lib/pio/open_flow/port.rb

@@ -57,9 +57,9 @@ module Pio
           self.port = reserved_port_number(port)
         else
           port_num = port.to_i
-          fail ArgumentError, 'The port should be > 0' if port_num < 1
+          raise ArgumentError, 'The port should be > 0' if port_num < 1
           if port_num >= max
-            fail ArgumentError, "The port should be < #{max.to_hex}"
+            raise ArgumentError, "The port should be < #{max.to_hex}"
           end
           self.port = port_num
         end

data/lib/pio/open_flow/transaction_id.rb

@@ -11,8 +11,8 @@ module Pio
 
       def set(value)
         unless value.unsigned_32bit?
-          fail(ArgumentError,
-               'Transaction ID should be an unsigned 32-bit integer.')
+          raise(ArgumentError,
+                'Transaction ID should be an unsigned 32-bit integer.')
         end
         self.xid = value
       end

data/lib/pio/open_flow/version.rb

@@ -0,0 +1,22 @@
+module Pio
+  module OpenFlow
+    # OpenFlow version
+    class Version < BinData::Primitive
+      VERSIONS = { 1 => :OpenFlow10, 4 => :OpenFlow13 }.freeze
+
+      uint8 :version
+
+      def get
+        VERSIONS.fetch(version)
+      end
+
+      def set(value)
+        self.version = VERSIONS.invert.fetch(value)
+      end
+
+      def to_bytes
+        version.to_hex
+      end
+    end
+  end
+end

data/lib/pio/open_flow10/actions.rb

@@ -15,22 +15,22 @@ require 'pio/open_flow10/vendor_action'
 module Pio
   module OpenFlow
     # Actions list.
-    class Actions < BinData::Primitive
+    class Actions10 < BinData::Primitive
       ACTION_CLASS = {
-        0 => Pio::OpenFlow10::SendOutPort,
-        1 => Pio::OpenFlow10::SetVlanVid,
-        2 => Pio::OpenFlow10::SetVlanPriority,
-        3 => Pio::OpenFlow10::StripVlanHeader,
-        4 => Pio::OpenFlow10::SetSourceMacAddress,
-        5 => Pio::OpenFlow10::SetDestinationMacAddress,
-        6 => Pio::OpenFlow10::SetSourceIpAddress,
-        7 => Pio::OpenFlow10::SetDestinationIpAddress,
-        8 => Pio::OpenFlow10::SetTos,
-        9 => Pio::OpenFlow10::SetTransportSourcePort,
-        10 => Pio::OpenFlow10::SetTransportDestinationPort,
-        11 => Pio::OpenFlow10::Enqueue,
-        0xffff => Pio::VendorAction
-      }
+        0 => OpenFlow10::SendOutPort,
+        1 => OpenFlow10::SetVlanVid,
+        2 => OpenFlow10::SetVlanPriority,
+        3 => OpenFlow10::StripVlanHeader,
+        4 => OpenFlow10::SetSourceMacAddress,
+        5 => OpenFlow10::SetDestinationMacAddress,
+        6 => OpenFlow10::SetSourceIpAddress,
+        7 => OpenFlow10::SetDestinationIpAddress,
+        8 => OpenFlow10::SetTos,
+        9 => OpenFlow10::SetTransportSourcePort,
+        10 => OpenFlow10::SetTransportDestinationPort,
+        11 => OpenFlow10::Enqueue,
+        0xffff => OpenFlow10::VendorAction
+      }.freeze
 
       mandatory_parameter :length
 
@@ -47,7 +47,7 @@ module Pio
       def get
         actions = []
         tmp = binary
-        while tmp.length > 0
+        until tmp.empty?
           type = BinData::Uint16be.read(tmp)
           begin
             action = ACTION_CLASS.fetch(type).read(tmp)

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

@@ -1,3 +1,4 @@
+require 'pio/open_flow/message'
 require 'pio/open_flow10/stats_type'
 
 module Pio
@@ -6,7 +7,7 @@ module Pio
     module AggregateStats
       # Aggregate Stats Reply message
       class Reply < OpenFlow::Message
-        open_flow_header version: 1, message_type: 17, message_length: 32
+        open_flow_header version: 1, type: 17, length: 32
         stats_type :stats_type, value: -> { :aggregate }
         uint16 :flags
         uint64 :packet_count

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

@@ -9,9 +9,7 @@ module Pio
     module AggregateStats
       # OpenFlow 1.0 Aggregate 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: -> { :aggregate }
         uint16 :flags
         match10 :match

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

@@ -6,7 +6,7 @@ module Pio
     module Barrier
       # OpenFlow 1.0 Barrier Request message
       class Reply < OpenFlow::Message
-        open_flow_header version: 1, message_type: 19
+        open_flow_header version: 1, type: 19
         string :body, value: ''
       end
     end

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

@@ -6,7 +6,7 @@ module Pio
     module Barrier
       # OpenFlow 1.0 Barrier Request message
       class Request < OpenFlow::Message
-        open_flow_header version: 1, message_type: 18
+        open_flow_header version: 1, type: 18
         string :body, value: ''
       end
     end

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

@@ -6,7 +6,7 @@ module Pio
     module DescriptionStats
       # OpenFlow 1.0 Description Stats Reply message
       class Reply < OpenFlow::Message
-        open_flow_header version: 1, message_type: 17, message_length: 1068
+        open_flow_header version: 1, type: 17, length: 1068
         stats_type :stats_type, value: -> { :description }
         uint16 :flags
 

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

@@ -7,9 +7,7 @@ module Pio
     module DescriptionStats
       # OpenFlow 1.0 Description Stats Request message
       class Request < OpenFlow::Message
-        open_flow_header version: 1,
-                         message_type: 16,
-                         message_length: 12
+        open_flow_header version: 1, type: 16, length: 12
         stats_type :stats_type, value: -> { :description }
         uint16 :flags
         string :body, value: ''

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

@@ -6,10 +6,10 @@ module Pio
     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 }
+        open_flow_header version: 1, type: 3
+        string :body, read_length: -> { length - header_length }
 
-        alias_method :user_data, :body
+        alias user_data body
       end
     end
   end

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

@@ -6,10 +6,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

@@ -24,8 +24,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 +33,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.rb

@@ -1,28 +1,18 @@
+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/error/bad_request.rb

@@ -1,4 +1,6 @@
+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 +8,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/bad_request/bad_request_code.rb

@@ -0,0 +1,35 @@
+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/error_type10.rb

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