pio 0.25.0 → 0.26.0

data/lib/pio/open_flow10/enqueue.rb

@@ -1,7 +1,7 @@
 require 'bindata'
 require 'forwardable'
 require 'pio/monkey_patch/integer'
-require 'pio/open_flow/port_number'
+require 'pio/open_flow10/port16'
 
 module Pio
   # An action to enqueue the packet on the specified queue attached to
@@ -11,9 +11,9 @@ module Pio
     class Format < BinData::Record
       endian :big
 
-      uint16 :type, value: 11
-      uint16 :message_length, value: 16
-      port_number :port_number
+      uint16 :action_type, value: 11
+      uint16 :action_length, value: 16
+      port16 :port
       uint48 :padding
       hide :padding
       uint32 :queue_id
@@ -27,28 +27,28 @@ module Pio
 
     extend Forwardable
 
-    def_delegators :@format, :type
-    def_delegators :@format, :message_length
-    def_delegators :@format, :port_number
+    def_delegators :@format, :action_type
+    def_delegator :@format, :action_length, :length
+    def_delegators :@format, :port
     def_delegators :@format, :queue_id
     def_delegator :@format, :to_binary_s, :to_binary
 
     def initialize(user_options)
-      validate_port_number user_options
+      validate_port user_options
       validate_queue_id user_options
       @format = Format.new(user_options)
     end
 
     private
 
-    def validate_port_number(user_options)
-      port_number = user_options.fetch(:port_number)
-      if port_number.is_a?(Symbol) && port_number != :in_port
+    def validate_port(user_options)
+      port = user_options.fetch(:port)
+      if port.is_a?(Symbol) && port != :in_port
         fail(ArgumentError,
-             ':port_number must be a valid physical port or :in_port')
+             ':port must be a valid physical port or :in_port')
       end
     rescue KeyError
-      raise ArgumentError, ':port_number is a mandatory option'
+      raise ArgumentError, ':port is a mandatory option'
     end
 
     def validate_queue_id(user_options)

data/lib/pio/open_flow10/error.rb

@@ -0,0 +1,28 @@
+require 'pio/open_flow10/error/error_type10'
+
+module Pio
+  module OpenFlow10
+    # Error message parser
+    module Error
+      # 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

@@ -0,0 +1,66 @@
+require 'bindata'
+require 'pio/open_flow/format'
+require 'pio/open_flow/message'
+require 'pio/open_flow10/error/error_type10'
+
+module Pio
+  module OpenFlow10
+    module Error
+      # Bad request error.
+      class BadRequest < OpenFlow::Message
+        # Bad request error format.
+        class Format < BinData::Record
+          # Bad request error body.
+          class Body < BinData::Record
+            # 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
+
+            endian :big
+
+            error_type10 :error_type, value: -> { :bad_request }
+            bad_request_code :error_code
+            rest :raw_data
+
+            def length
+              4 + raw_data.length
+            end
+          end
+
+          extend OpenFlow::Format
+
+          header version: 1, message_type: 1
+          body :body
+
+          def length
+            8 + body.length
+          end
+        end
+
+        body_option :raw_data
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module Pio
+  module OpenFlow10
+    # enum ofp_error_type
+    class ErrorType10 < BinData::Primitive
+      ERROR_TYPES = {
+        hello_failed: 0,
+        bad_request: 1,
+        bad_action: 2,
+        flow_mod_failed: 3,
+        port_mod_failed: 4,
+        queue_operation_failed: 5
+      }
+
+      endian :big
+      uint16 :error_type
+
+      def get
+        ERROR_TYPES.invert.fetch(error_type)
+      end
+
+      def set(value)
+        self.error_type = ERROR_TYPES.fetch(value)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+require 'pio/open_flow/format'
+require 'pio/open_flow/hello_failed_code'
+require 'pio/open_flow/message'
+require 'pio/open_flow10/error/error_type10'
+
+module Pio
+  module OpenFlow10
+    module Error
+      # Hello failed error.
+      class HelloFailed < OpenFlow::Message
+        # Hello Failed error format.
+        class Format < BinData::Record
+          # Hello Failed error body.
+          class Body < BinData::Record
+            endian :big
+
+            error_type10 :error_type
+            hello_failed_code :error_code
+            rest :description
+
+            def length
+              4 + description.length
+            end
+          end
+
+          extend OpenFlow::Format
+
+          header version: 1, message_type: 1
+          body :body
+
+          def length
+            8 + body.length
+          end
+        end
+
+        body_option :error_code
+        body_option :description
+      end
+    end
+  end
+end

data/lib/pio/open_flow10/features.rb

@@ -1,12 +1,13 @@
 require 'pio/open_flow'
+require 'pio/open_flow10/phy_port16'
 
 module Pio
   module OpenFlow10
-    # OpenFlow 1.0 Features Request and Reply message.
+    # Features Request and Reply message.
     class Features
-      # OpenFlow 1.0 Features Request message.
+      # Features Request message.
       class Request < OpenFlow::Message
-        # OpenFlow 1.0 Features Request message
+        # Features Request message format.
         class Format < BinData::Record
           extend OpenFlow::Format
 
@@ -17,11 +18,6 @@ module Pio
             body
           end
         end
-
-        def initialize(user_options = {})
-          validate_user_options user_options
-          @format = Format.new(header: parse_header_options(user_options))
-        end
       end
 
       # OpenFlow 1.0 Features Reply message.
@@ -65,7 +61,7 @@ module Pio
           hide :padding
           capabilities :capabilities
           actions_flag :actions
-          array :ports, type: :phy_port, read_until: :eof
+          array :ports, type: :phy_port16, read_until: :eof
 
           def dpid
             datapath_id
@@ -96,7 +92,7 @@ module Pio
 
           def physical_ports
             ports.select do |each|
-              each.port_no <= PortNumber::MAX
+              each.port_no <= Port16::MAX
             end
           end
         end

data/lib/pio/open_flow10/flow_mod.rb

@@ -49,7 +49,7 @@ module Pio
         uint32 :buffer_id
         uint16 :out_port
         flags :flags
-        actions :actions, length: -> { header.message_length - 72 }
+        actions :actions, length: -> { header.length - 72 }
 
         def empty?
           false

data/lib/pio/open_flow10/flow_stats_request.rb

@@ -19,7 +19,7 @@ module Pio
           uint8 :table_id, initial_value: 0xff
           string :padding, length: 1
           hide :padding
-          port_number :out_port, initial_value: -> { :none }
+          port16 :out_port, initial_value: -> { :none }
         end
 
         # Message body of Flow Stats Request.

data/lib/pio/open_flow10/hello.rb

@@ -5,9 +5,9 @@ require 'pio/open_flow/message'
 module Pio
   # OpenFlow 1.0 messages
   module OpenFlow10
-    # OpenFlow 1.0 Hello message
+    # Hello message
     class Hello < OpenFlow::Message
-      # OpenFlow 1.0 Hello message format
+      # Hello message format
       class Format < BinData::Record
         extend OpenFlow::Format
 

data/lib/pio/open_flow10/match.rb

@@ -48,7 +48,7 @@ module Pio
           BITS.each_with_object(Hash.new(0)) do |(key, bit), memo|
             next if flags & bit == 0
             if /(ip_source_address|ip_destination_address)(\d)/=~ key
-              memo[$LAST_MATCH_INFO[1].intern] |= 1 << $LAST_MATCH_INFO[2].to_i
+              memo[$LAST_MATCH_INFO[1].to_sym] |= 1 << $LAST_MATCH_INFO[2].to_i
             else
               memo[key] = true
             end
@@ -141,7 +141,7 @@ module Pio
           if user_options.key?(each)
             memo[each] = 32 - IPv4Address.new(user_options[each]).prefixlen
           else
-            memo["#{each}_all".intern] = true
+            memo["#{each}_all".to_sym] = true
           end
         end
         @format = MatchFormat.new({ wildcards: flags }.merge user_options)

data/lib/pio/{open_flow/phy_port.rb → open_flow10/phy_port16.rb}

@@ -2,10 +2,10 @@ require 'bindata'
 require 'pio/type/mac_address'
 
 module Pio
-  module OpenFlow
+  module OpenFlow10
     # Description of a physical port
-    class PhyPort < BinData::Record
-      extend Flags
+    class PhyPort16 < BinData::Record
+      extend OpenFlow::Flags
 
       # enum ofp_port_config
       flags_32bit :port_config,
@@ -80,7 +80,7 @@ module Pio
           end
 
           def ss.local?
-            port_no == PortNumber::NUMBERS[:local]
+            port_no == OpenFlow10::Port16.reserved_port_number(:local)
           end
         end
       end

data/lib/pio/open_flow10/port16.rb

@@ -0,0 +1,21 @@
+require 'pio/open_flow/port'
+
+module Pio
+  module OpenFlow10
+    # Port numbering (16bit).
+    class Port16 < OpenFlow::Port
+      port_size_in_bytes 16
+
+      max_port_number 0xff00
+
+      reserved_ports(in_port: 0xfff8,
+                     table: 0xfff9,
+                     normal: 0xfffa,
+                     flood: 0xfffb,
+                     all: 0xfffc,
+                     controller: 0xfffd,
+                     local: 0xfffe,
+                     none: 0xffff)
+    end
+  end
+end

data/lib/pio/open_flow10/port_status.rb

@@ -28,7 +28,7 @@ module Pio
         reason :reason
         uint56 :padding
         hide :padding
-        phy_port :desc
+        phy_port16 :desc
       end
 
       # OpenFlow 1.0 Flow Mod message format.

data/lib/pio/open_flow10/send_out_port.rb

@@ -1,7 +1,7 @@
 require 'bindata'
 require 'forwardable'
 require 'pio/monkey_patch/integer'
-require 'pio/open_flow/port_number'
+require 'pio/open_flow10/port16'
 
 module Pio
   module OpenFlow10
@@ -11,10 +11,10 @@ module Pio
       class Format < BinData::Record
         endian :big
 
-        uint16 :type, value: 0
-        uint16 :message_length, value: 8
-        port_number :port_number
-        uint16 :max_len, initial_value: 2**16 - 1
+        uint16 :action_type, value: 0
+        uint16 :action_length, value: 8
+        port16 :port
+        uint16 :max_length, initial_value: 2**16 - 1
       end
 
       def self.read(raw_data)
@@ -25,49 +25,25 @@ module Pio
 
       extend Forwardable
 
-      def_delegators :@format, :message_length
-      def_delegators :@format, :port_number
-      def_delegators :@format, :max_len
+      def_delegators :@format, :action_type
+      def_delegator :@format, :action_length, :length
+      def_delegators :@format, :port
+      def_delegators :@format, :max_length
       def_delegator :@format, :to_binary_s, :to_binary
 
-      # Creates an action to output a packet to a port.
-      #
-      # @example
-      #   SendOutPort.new(1)
-      #   SendOutPort.new(port_number: 1)
-      #   SendOutPort.new(port_number: :controller, max_len: 256)
-      #
-      # @param [Integer|Hash] user_options
-      #   the port number or the options hash to create this action
-      #   class instance with.
-      #
-      # @option user_options [Number] :port_number
-      #   port number an index into switch's physical port list. There
-      #   are also fake output ports. For example a port number set to
-      #   +:flood+ would output packets to all physical ports except
-      #   input port and ports disabled by STP.
-      # @option user_options [Number] :max_len
-      #   the maximum number of bytes from a packet to send to
-      #   controller when port is set to +:controller+. A zero length
-      #   means no bytes of the packet should be sent. It defaults to
-      #   64K.
-      #
-      # @raise [ArgumentError] if +:port_number+ is not an unsigned
-      #                        16-bit integer.
-      # @raise [ArgumentError] if +:max_len+ is not an unsigned 16-bit integer.
-      #
       # rubocop:disable MethodLength
       def initialize(user_options)
         options = if user_options.respond_to?(:to_i)
-                    { port_number: user_options.to_i }
-                  elsif PortNumber::NUMBERS.key?(user_options)
-                    { port_number: user_options }
+                    { port: user_options.to_i }
+                  elsif Port16.reserved_port_name?(user_options)
+                    { port: user_options }
                   else
                     user_options
                   end
-        max_len = options[:max_len]
-        if max_len && !max_len.unsigned_16bit?
-          fail ArgumentError, 'The max_len should be an unsigned 16bit integer.'
+        max_length = options[:max_length]
+        if max_length && !max_length.unsigned_16bit?
+          fail(ArgumentError,
+               'The max_length should be an unsigned 16bit integer.')
         end
         @format = Format.new(options)
       end