pio 0.25.0 → 0.26.0

data/lib/pio/open_flow10/set_ether_address.rb

@@ -6,13 +6,13 @@ module Pio
   # An action to modify the source/destination Ethernet address of a packet.
   class SetEtherAddress
     # rubocop:disable MethodLength
-    def self.def_format(action_type)
+    def self.action_type(action_type)
       str = %(
         class Format < BinData::Record
           endian :big
 
-          uint16 :type, value: #{action_type}
-          uint16 :message_length, value: 16
+          uint16 :action_type, value: #{action_type}
+          uint16 :action_length, value: 16
           mac_address :mac_address
           uint48 :padding
           hide :padding
@@ -31,7 +31,8 @@ module Pio
 
     extend Forwardable
 
-    def_delegators :@format, :message_length
+    def_delegators :@format, :action_type
+    def_delegator :@format, :action_length, :length
     def_delegators :@format, :mac_address
     def_delegator :@format, :to_binary_s, :to_binary
 
@@ -41,12 +42,12 @@ module Pio
   end
 
   # An action to modify the source Ethernet address of a packet.
-  class SetEtherSourceAddr < SetEtherAddress
-    def_format 4
+  class SetEtherSourceAddress < SetEtherAddress
+    action_type 4
   end
 
   # An action to modify the destination Ethernet address of a packet.
-  class SetEtherDestinationAddr < SetEtherAddress
-    def_format 5
+  class SetEtherDestinationAddress < SetEtherAddress
+    action_type 5
   end
 end

data/lib/pio/open_flow10/set_ip_address.rb

@@ -10,8 +10,8 @@ module Pio
         class Format < BinData::Record
           endian :big
 
-          uint16 :type, value: #{action_type}
-          uint16 :message_length, value: 8
+          uint16 :action_type, value: #{action_type}
+          uint16 :action_length, value: 8
           ip_address :ip_address
         end
       )
@@ -27,8 +27,8 @@ module Pio
 
     extend Forwardable
 
-    def_delegators :@format, :type
-    def_delegators :@format, :message_length
+    def_delegators :@format, :action_type
+    def_delegator :@format, :action_length, :length
     def_delegators :@format, :ip_address
     def_delegator :@format, :to_binary_s, :to_binary
 

data/lib/pio/open_flow10/set_ip_tos.rb

@@ -9,8 +9,8 @@ module Pio
     class Format < BinData::Record
       endian :big
 
-      uint16 :type, value: 8
-      uint16 :message_length, value: 8
+      uint16 :action_type, value: 8
+      uint16 :action_length, value: 8
       uint8 :type_of_service
       uint24 :padding
       hide :padding
@@ -24,8 +24,8 @@ module Pio
 
     extend Forwardable
 
-    def_delegators :@format, :type
-    def_delegators :@format, :message_length
+    def_delegators :@format, :action_type
+    def_delegator :@format, :action_length, :length
     def_delegators :@format, :type_of_service
     def_delegator :@format, :to_binary_s, :to_binary
 

data/lib/pio/open_flow10/set_transport_port.rb

@@ -6,14 +6,14 @@ module Pio
   # An action to modify the source/destination TCP/UDP port of a packet.
   class SetTransportPort
     # rubocop:disable MethodLength
-    def self.def_format(action_type)
+    def self.action_type(action_type)
       str = %(
         class Format < BinData::Record
           endian :big
 
-          uint16 :type, value: #{action_type}
-          uint16 :message_length, value: 8
-          uint16 :port_number
+          uint16 :action_type, value: #{action_type}
+          uint16 :action_length, value: 8
+          uint16 :port
           uint16 :padding
           hide :padding
         end
@@ -30,17 +30,17 @@ 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_delegator :@format, :to_binary_s, :to_binary
 
     def initialize(number)
-      port_number = number.to_i
-      unless port_number.unsigned_16bit?
+      port = number.to_i
+      unless port.unsigned_16bit?
         fail ArgumentError, 'TCP/UDP port must be an unsigned 16-bit integer.'
       end
-      @format = self.class.const_get(:Format).new(port_number: port_number)
+      @format = self.class.const_get(:Format).new(port: port)
     rescue NoMethodError
       raise TypeError, 'TCP/UDP port must be an unsigned 16-bit integer.'
     end
@@ -48,11 +48,11 @@ module Pio
 
   # An action to modify the source TCP/UDP port of a packet.
   class SetTransportSourcePort < SetTransportPort
-    def_format 9
+    action_type 9
   end
 
   # An action to modify the source TCP/UDP port of a packet.
   class SetTransportDestinationPort < SetTransportPort
-    def_format 10
+    action_type 10
   end
 end

data/lib/pio/open_flow10/set_vlan.rb

@@ -12,8 +12,8 @@ module Pio
         class Format < BinData::Record
           endian :big
 
-          uint16 :type, value: #{action_type}
-          uint16 :message_length, value: 8
+          uint16 :action_type, value: #{action_type}
+          uint16 :action_length, value: 8
           uint16 :#{field_name}
           uint16 :padding
           hide :padding
@@ -30,8 +30,8 @@ module Pio
       set_vlan
     end
 
-    def_delegators :@format, :type
-    def_delegators :@format, :message_length
+    def_delegators :@format, :action_type
+    def_delegator :@format, :action_length, :length
     def_delegator :@format, :to_binary_s, :to_binary
   end
 end

data/lib/pio/open_flow10/set_vlan_vid.rb

@@ -5,18 +5,6 @@ module Pio
   class SetVlanVid < SetVlan
     def_format :vlan_id, 1
 
-    # Creates an action to modify the VLAN ID of a packet. The VLAN ID
-    # is 16-bits long but the actual VID (VLAN Identifier) of the IEEE
-    # 802.1Q frame is 12-bits.
-    #
-    # @example
-    #   ActionSetVlanVid.new(number)
-    #
-    # @param [Integer] number
-    #   the VLAN ID to set to. Only the lower 12-bits are used.
-    #
-    # @raise [ArgumentError] if vlan_id not within 1 and 4095 inclusive.
-    # @raise [TypeError] if vlan_id is not an Integer.
     def initialize(number)
       vlan_id = number.to_i
       unless vlan_id >= 1 && vlan_id <= 4095

data/lib/pio/open_flow10/strip_vlan_header.rb

@@ -8,22 +8,22 @@ module Pio
     class Format < BinData::Record
       endian :big
 
-      uint16 :type, value: 3
-      uint16 :message_length, value: 8
+      uint16 :action_type, value: 3
+      uint16 :action_length, value: 8
       uint32 :padding
       hide :padding
     end
 
     def self.read(raw_data)
-      strip_vlan = allocate
-      strip_vlan.instance_variable_set :@format, Format.read(raw_data)
-      strip_vlan
+      allocate.tap do |strip_vlan|
+        strip_vlan.instance_variable_set :@format, Format.read(raw_data)
+      end
     end
 
     extend Forwardable
 
-    def_delegators :@format, :type
-    def_delegators :@format, :message_length
+    def_delegators :@format, :action_type
+    def_delegator :@format, :action_length, :length
     def_delegator :@format, :to_binary_s, :to_binary
 
     def initialize

data/lib/pio/open_flow10/vendor_action.rb

@@ -0,0 +1,33 @@
+require 'bindata'
+require 'forwardable'
+
+module Pio
+  # 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
+
+    def self.read(raw_data)
+      allocate.tap do |strip_vlan|
+        strip_vlan.instance_variable_set :@format, Format.read(raw_data)
+      end
+    end
+
+    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 initialize(vendor)
+      @format = Format.new(vendor: vendor)
+    end
+  end
+end

data/lib/pio/open_flow13.rb

@@ -1,5 +1,8 @@
 require 'pio/open_flow13/apply'
 require 'pio/open_flow13/echo'
+require 'pio/open_flow13/error'
+require 'pio/open_flow13/error/bad_request'
+require 'pio/open_flow13/error/hello_failed'
 require 'pio/open_flow13/features_reply'
 require 'pio/open_flow13/features_request'
 require 'pio/open_flow13/flow_mod'

data/lib/pio/open_flow13/actions.rb

@@ -17,8 +17,8 @@ module Pio
 
     string :binary, read_length: :length
 
-    def set(value)
-      self.binary = [value].flatten.map(&:to_binary).join
+    def set(actions)
+      self.binary = Array(actions).map(&:to_binary).join
     end
 
     # rubocop:disable MethodLength
@@ -32,7 +32,7 @@ module Pio
                  else
                    UnsupportedAction.read(tmp)
                  end
-        tmp = tmp[action.action_length..-1]
+        tmp = tmp[action.length..-1]
         actions << action
       end
       actions

data/lib/pio/open_flow13/error.rb

@@ -0,0 +1,28 @@
+require 'pio/open_flow13/error/error_type13'
+
+module Pio
+  module OpenFlow13
+    # Error message parser
+    module Error
+      # Error message body parser.
+      class BodyParser < BinData::Record
+        endian :big
+        error_type13 :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_flow13/error/bad_request.rb

@@ -0,0 +1,66 @@
+require 'pio/open_flow/format'
+require 'pio/open_flow/message'
+require 'pio/open_flow13/error/error_type13'
+
+module Pio
+  module OpenFlow13
+    module Error
+      # Bad request error.
+      class BadRequest < OpenFlow::Message
+        # Bad request error format.
+        class Format < BinData::Record
+          # enum ofp_bad_request_code
+          class BadRequestCode < BinData::Primitive
+            ERROR_CODES = {
+              bad_version: 0,
+              bad_type: 1,
+              bad_multipart: 2,
+              bad_experimenter: 3,
+              bad_experimenter_type: 4,
+              permissions_error: 5,
+              bad_length: 6,
+              buffer_empty: 7,
+              buffer_unknown: 8,
+              bad_table_id: 9,
+              controller_is_slave: 10,
+              bad_port: 11,
+              bad_packet: 12,
+              multipart_buffer_overflow: 13
+            }
+
+            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
+
+          # Bad request error body.
+          class Body < BinData::Record
+            endian :big
+
+            error_type13 :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: 4, message_type: 1
+          body :body
+        end
+
+        body_option :raw_data
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+module Pio
+  module OpenFlow13
+    module Error
+      # enum ofp_error_type
+      class ErrorType13 < BinData::Primitive
+        ERROR_TYPES = {
+          hello_failed: 0,
+          bad_request: 1,
+          bad_action: 2,
+          bad_instruction: 3,
+          bad_match: 4,
+          flow_mod_failed: 5,
+          group_mod_failed: 6,
+          port_mod_failed: 7,
+          table_mod_failed: 8,
+          queue_operation_failed: 9,
+          switch_config_failed: 10,
+          role_request_failed: 11,
+          meter_mod_failed: 12,
+          table_features_failed: 13,
+          experimenter: 0xffff
+        }
+
+        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
+end

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

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