pio 0.27.2 → 0.28.0

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

@@ -27,11 +27,11 @@ module Pio
                      :set_vlan_vid,
                      :set_vlan_pcp,
                      :strip_vlan,
-                     :set_ether_source_address,
-                     :set_ether_destination_address,
-                     :set_ip_source_address,
-                     :set_ip_destination_address,
-                     :set_ip_tos,
+                     :set_source_mac_address,
+                     :set_destination_mac_address,
+                     :set_source_ip_address,
+                     :set_destination_ip_address,
+                     :set_tos,
                      :set_transport_source_port,
                      :set_transport_destination_port,
                      :enqueue]

data/lib/pio/open_flow10/flow_removed.rb

@@ -0,0 +1,40 @@
+require 'pio/open_flow/message'
+require 'pio/open_flow10/match10'
+
+module Pio
+  module OpenFlow10
+    # Flow Removed message
+    class FlowRemoved < OpenFlow::Message
+      # Why was this flow removed?
+      # (enum ofp_flow_removed_reason)
+      class Reason < BinData::Primitive
+        REASONS = { idle_timeout: 0, hard_timeout: 1, delete: 2 }
+
+        uint8 :reason
+
+        def get
+          REASONS.invert.fetch(reason)
+        end
+
+        def set(value)
+          self.reason = REASONS.fetch(value)
+        end
+      end
+
+      open_flow_header version: 1, message_type: 11, message_length: 88
+      match10 :match
+      uint64 :cookie
+      uint16 :priority
+      reason :reason
+      string :padding1, length: 1
+      hide :padding1
+      uint32 :duration_sec
+      uint32 :duration_nsec
+      uint16 :idle_timeout
+      string :padding2, length: 2
+      hide :padding2
+      uint64 :packet_count
+      uint64 :byte_count
+    end
+  end
+end

data/lib/pio/open_flow10/match.rb

@@ -12,31 +12,31 @@ module Pio
         BITS = {
           in_port: 1 << 0,
           vlan_vid: 1 << 1,
-          ether_source_address: 1 << 2,
-          ether_destination_address: 1 << 3,
+          source_mac_address: 1 << 2,
+          destination_mac_address: 1 << 3,
           ether_type: 1 << 4,
           ip_protocol: 1 << 5,
           transport_source_port: 1 << 6,
           transport_destination_port: 1 << 7,
-          ip_source_address: 0,
-          ip_source_address0: 1 << 8,
-          ip_source_address1: 1 << 9,
-          ip_source_address2: 1 << 10,
-          ip_source_address3: 1 << 11,
-          ip_source_address4: 1 << 12,
-          ip_source_address_all: 1 << 13,
-          ip_destination_address: 0,
-          ip_destination_address0: 1 << 14,
-          ip_destination_address1: 1 << 15,
-          ip_destination_address2: 1 << 16,
-          ip_destination_address3: 1 << 17,
-          ip_destination_address4: 1 << 18,
-          ip_destination_address_all: 1 << 19,
+          source_ip_address: 0,
+          source_ip_address0: 1 << 8,
+          source_ip_address1: 1 << 9,
+          source_ip_address2: 1 << 10,
+          source_ip_address3: 1 << 11,
+          source_ip_address4: 1 << 12,
+          source_ip_address_all: 1 << 13,
+          destination_ip_address: 0,
+          destination_ip_address0: 1 << 14,
+          destination_ip_address1: 1 << 15,
+          destination_ip_address2: 1 << 16,
+          destination_ip_address3: 1 << 17,
+          destination_ip_address4: 1 << 18,
+          destination_ip_address_all: 1 << 19,
           vlan_priority: 1 << 20,
-          ip_tos: 1 << 21
+          tos: 1 << 21
         }
-        NW_FLAGS = [:ip_source_address, :ip_destination_address]
-        FLAGS = BITS.keys.select { |each| !(/^ip_(source|destination)/=~ each) }
+        NW_FLAGS = [:source_ip_address, :destination_ip_address]
+        FLAGS = BITS.keys.select { |each| !(/^(source|destination)_ip/=~ each) }
 
         endian :big
 
@@ -46,7 +46,7 @@ module Pio
         def get
           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
+            if /(source_ip_address|destination_ip_address)(\d)/=~ key
               memo[$LAST_MATCH_INFO[1].to_sym] |= 1 << $LAST_MATCH_INFO[2].to_i
             else
               memo[key] = true
@@ -57,23 +57,23 @@ module Pio
         def set(params)
           self.flags = params.inject(0) do |memo, (key, val)|
             memo | case key
-                   when :ip_source_address, :ip_destination_address
+                   when :source_ip_address, :destination_ip_address
                      (params.fetch(key) & 31) <<
-                       (key == :ip_source_address ? 8 : 14)
+                       (key == :source_ip_address ? 8 : 14)
                    else
                      val ? BITS.fetch(key) : 0
                    end
           end
         end
 
-        def ip_source_address
-          get.fetch(:ip_source_address)
+        def source_ip_address
+          get.fetch(:source_ip_address)
         rescue KeyError
           0
         end
 
-        def ip_destination_address
-          get.fetch(:ip_destination_address)
+        def destination_ip_address
+          get.fetch(:destination_ip_address)
         rescue KeyError
           0
         end
@@ -106,21 +106,21 @@ module Pio
 
         wildcards :wildcards
         uint16 :in_port
-        mac_address :ether_source_address
-        mac_address :ether_destination_address
+        mac_address :source_mac_address
+        mac_address :destination_mac_address
         uint16 :vlan_vid
         uint8 :vlan_priority
         uint8 :padding1
         hide :padding1
         uint16 :ether_type
-        uint8 :ip_tos
+        uint8 :tos
         uint8 :ip_protocol
         uint16 :padding2
         hide :padding2
-        match_ip_address :ip_source_address,
-                         bitcount: -> { wildcards.ip_source_address }
-        match_ip_address :ip_destination_address,
-                         bitcount: -> { wildcards.ip_destination_address }
+        match_ip_address :source_ip_address,
+                         bitcount: -> { wildcards.source_ip_address }
+        match_ip_address :destination_ip_address,
+                         bitcount: -> { wildcards.destination_ip_address }
         uint16 :transport_source_port
         uint16 :transport_destination_port
       end

data/lib/pio/open_flow10/nicira_resubmit.rb

@@ -0,0 +1,20 @@
+require 'pio/open_flow/nicira_action'
+require 'pio/open_flow10/port16'
+
+module Pio
+  module OpenFlow10
+    # 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
+
+      def initialize(port_number)
+        super(in_port: port_number)
+      end
+    end
+  end
+end

data/lib/pio/open_flow10/nicira_resubmit_table.rb

@@ -0,0 +1,17 @@
+require 'pio/open_flow/nicira_action'
+require 'pio/open_flow10/port16'
+
+module Pio
+  module OpenFlow10
+    # 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
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+require 'pio/open_flow/message'
+
+module Pio
+  module OpenFlow10
+    # Port Stats messages
+    class PortStats
+      # Port Stats Request message
+      class Request < OpenFlow::Message
+        open_flow_header version: 1,
+                         message_type: 16,
+                         message_length: 20
+
+        stats_type :stats_type, value: -> { :port }
+        uint16 :flags
+        port16 :port
+        string :padding, length: 6
+        hide :padding
+
+        def initialize(port, user_options = {})
+          super({ port: port }.merge user_options)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+require 'pio/open_flow/message'
+
+module Pio
+  module OpenFlow10
+    # Queue Stats messages
+    class QueueStats
+      # Queue Stats Request message
+      class Request < OpenFlow::Message
+        open_flow_header version: 1,
+                         message_type: 16,
+                         message_length: 20
+
+        stats_type :stats_type, value: -> { :queue }
+        uint16 :flags
+        port16 :port
+        string :padding, length: 2
+        hide :padding
+        uint32 :queue_id
+      end
+    end
+  end
+end

data/lib/pio/open_flow10/send_out_port.rb

@@ -1,35 +1,14 @@
-require 'bindata'
-require 'forwardable'
 require 'pio/monkey_patch/integer'
+require 'pio/open_flow/action'
 require 'pio/open_flow10/port16'
 
 module Pio
   module OpenFlow10
     # An action to output a packet to a port.
-    class SendOutPort
-      # OpenFlow 1.0 OFPAT_OUTPUT action format.
-      class Format < BinData::Record
-        endian :big
-
-        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)
-        send_out_port = allocate
-        send_out_port.instance_variable_set :@format, Format.read(raw_data)
-        send_out_port
-      end
-
-      extend Forwardable
-
-      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
+    class SendOutPort < OpenFlow::Action
+      action_header action_type: 0, action_length: 8
+      port16 :port
+      uint16 :max_length, initial_value: 2**16 - 1
 
       # rubocop:disable MethodLength
       def initialize(user_options)
@@ -45,7 +24,7 @@ module Pio
           fail(ArgumentError,
                'The max_length should be an unsigned 16bit integer.')
         end
-        @format = Format.new(options)
+        super(options)
       end
       # rubocop:enable MethodLength
 

data/lib/pio/open_flow10/set_destination_ip_address.rb

@@ -0,0 +1,16 @@
+require 'pio/open_flow/action'
+require 'pio/type/ip_address'
+
+module Pio
+  module OpenFlow10
+    # An action to modify the IPv4 source address of a packet.
+    class SetDestinationIpAddress < OpenFlow::Action
+      action_header action_type: 7, action_length: 8
+      ip_address :ip_address
+
+      def initialize(ip_address)
+        super ip_address: ip_address
+      end
+    end
+  end
+end

data/lib/pio/open_flow10/set_destination_mac_address.rb

@@ -0,0 +1,18 @@
+require 'pio/open_flow/action'
+require 'pio/type/mac_address'
+
+module Pio
+  module OpenFlow10
+    # An action to modify the destination Ethernet address of a packet.
+    class SetDestinationMacAddress < OpenFlow::Action
+      action_header action_type: 5, action_length: 16
+      mac_address :mac_address
+      string :padding, length: 6
+      hide :padding
+
+      def initialize(mac_address)
+        super mac_address: mac_address
+      end
+    end
+  end
+end

data/lib/pio/open_flow10/set_source_ip_address.rb

@@ -0,0 +1,16 @@
+require 'pio/open_flow/action'
+require 'pio/type/ip_address'
+
+module Pio
+  module OpenFlow10
+    # An action to modify the IPv4 source address of a packet.
+    class SetSourceIpAddress < OpenFlow::Action
+      action_header action_type: 6, action_length: 8
+      ip_address :ip_address
+
+      def initialize(ip_address)
+        super ip_address: ip_address
+      end
+    end
+  end
+end

data/lib/pio/open_flow10/set_source_mac_address.rb

@@ -0,0 +1,18 @@
+require 'pio/open_flow/action'
+require 'pio/type/mac_address'
+
+module Pio
+  module OpenFlow10
+    # An action to modify the source Ethernet address of a packet.
+    class SetSourceMacAddress < OpenFlow::Action
+      action_header action_type: 4, action_length: 16
+      mac_address :mac_address
+      string :padding, length: 6
+      hide :padding
+
+      def initialize(mac_address)
+        super mac_address: mac_address
+      end
+    end
+  end
+end

data/lib/pio/open_flow10/set_tos.rb

@@ -0,0 +1,24 @@
+require 'pio/monkey_patch/integer'
+require 'pio/open_flow/action'
+
+module Pio
+  module OpenFlow10
+    # An action to modify the IP ToS/DSCP field of a packet.
+    class SetTos < OpenFlow::Action
+      action_header action_type: 8, action_length: 8
+      uint8 :type_of_service
+      string :padding, length: 3
+      hide :padding
+
+      def initialize(type_of_service)
+        # tos (IP ToS) value consists of 8 bits, of which only the
+        # 6 high-order bits belong to DSCP, the 2 low-order bits must
+        # be zero.
+        unless type_of_service.unsigned_8bit? && type_of_service % 4 == 0
+          fail ArgumentError, 'Invalid type_of_service (ToS) value.'
+        end
+        super(type_of_service: type_of_service)
+      end
+    end
+  end
+end

data/lib/pio/open_flow10/set_transport_port.rb

@@ -1,58 +1,42 @@
-require 'bindata'
-require 'forwardable'
 require 'pio/monkey_patch/integer'
+require 'pio/open_flow/action'
 
 module Pio
-  # An action to modify the source/destination TCP/UDP port of a packet.
-  class SetTransportPort
-    # rubocop:disable MethodLength
-    def self.action_type(action_type)
-      str = %(
-        class Format < BinData::Record
-          endian :big
-
-          uint16 :action_type, value: #{action_type}
-          uint16 :action_length, value: 8
-          uint16 :port
-          uint16 :padding
-          hide :padding
+  module OpenFlow10
+    # An action to modify the source TCP/UDP port of a packet.
+    class SetTransportSourcePort < OpenFlow::Action
+      action_header action_type: 9, action_length: 8
+      uint16 :port
+      string :padding, length: 2
+      hide :padding
+
+      def initialize(number)
+        port = number.to_i
+        unless port.unsigned_16bit?
+          fail ArgumentError, 'TCP/UDP port must be an unsigned 16-bit integer.'
         end
-      )
-      module_eval str
-    end
-    # rubocop:enable MethodLength
-
-    def self.read(raw_data)
-      action = allocate
-      action.instance_variable_set(:@format, const_get(:Format).read(raw_data))
-      action
+        super(port: port)
+      rescue NoMethodError
+        raise TypeError, 'TCP/UDP port must be an unsigned 16-bit integer.'
+      end
     end
 
-    extend Forwardable
-
-    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.to_i
-      unless port.unsigned_16bit?
-        fail ArgumentError, 'TCP/UDP port must be an unsigned 16-bit integer.'
+    # An action to modify the source TCP/UDP port of a packet.
+    class SetTransportDestinationPort < OpenFlow::Action
+      action_header action_type: 10, action_length: 8
+      uint16 :port
+      string :padding, length: 2
+      hide :padding
+
+      def initialize(number)
+        port = number.to_i
+        unless port.unsigned_16bit?
+          fail ArgumentError, 'TCP/UDP port must be an unsigned 16-bit integer.'
+        end
+        super(port: port)
+      rescue NoMethodError
+        raise TypeError, 'TCP/UDP port must be an unsigned 16-bit integer.'
       end
-      @format = self.class.const_get(:Format).new(port: port)
-    rescue NoMethodError
-      raise TypeError, 'TCP/UDP port must be an unsigned 16-bit integer.'
     end
   end
-
-  # An action to modify the source TCP/UDP port of a packet.
-  class SetTransportSourcePort < SetTransportPort
-    action_type 9
-  end
-
-  # An action to modify the source TCP/UDP port of a packet.
-  class SetTransportDestinationPort < SetTransportPort
-    action_type 10
-  end
 end