pio 0.19.0 → 0.20.0

data/lib/pio/{features.rb → open_flow10/features.rb}

@@ -1,3 +1,4 @@
+require 'forwardable'
 require 'pio/open_flow'
 
 module Pio
@@ -30,13 +31,13 @@ module Pio
                      :set_vlan_vid,
                      :set_vlan_pcp,
                      :strip_vlan,
-                     :set_dl_src,
-                     :set_dl_dst,
-                     :set_nw_src,
-                     :set_nw_dst,
-                     :set_nw_tos,
-                     :set_tp_src,
-                     :set_tp_dst,
+                     :set_ether_source_address,
+                     :set_ether_destination_address,
+                     :set_ip_source_address,
+                     :set_ip_destination_address,
+                     :set_ip_tos,
+                     :set_transport_source_port,
+                     :set_transport_destination_port,
                      :enqueue]
 
         endian :big

data/lib/pio/{flow_mod.rb → open_flow10/flow_mod.rb}

@@ -1,5 +1,5 @@
-require 'pio/match'
 require 'pio/open_flow'
+require 'pio/open_flow10/match'
 
 # Base module.
 module Pio

data/lib/pio/{match.rb → open_flow10/match.rb}

@@ -11,32 +11,32 @@ module Pio
     class Wildcards < BinData::Primitive
       BITS = {
         in_port: 1 << 0,
-        dl_vlan: 1 << 1,
-        dl_src: 1 << 2,
-        dl_dst: 1 << 3,
-        dl_type: 1 << 4,
-        nw_proto: 1 << 5,
-        tp_src: 1 << 6,
-        tp_dst: 1 << 7,
-        nw_src: 0,
-        nw_src0: 1 << 8,
-        nw_src1: 1 << 9,
-        nw_src2: 1 << 10,
-        nw_src3: 1 << 11,
-        nw_src4: 1 << 12,
-        nw_src_all: 1 << 13,
-        nw_dst: 0,
-        nw_dst0: 1 << 14,
-        nw_dst1: 1 << 15,
-        nw_dst2: 1 << 16,
-        nw_dst3: 1 << 17,
-        nw_dst4: 1 << 18,
-        nw_dst_all: 1 << 19,
-        dl_vlan_pcp: 1 << 20,
-        nw_tos: 1 << 21
+        vlan_vid: 1 << 1,
+        ether_source_address: 1 << 2,
+        ether_destination_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,
+        vlan_priority: 1 << 20,
+        ip_tos: 1 << 21
       }
-      NW_FLAGS = [:nw_src, :nw_dst]
-      FLAGS = BITS.keys.select { |each| !(/^nw_(src|dst)/=~ each) }
+      NW_FLAGS = [:ip_source_address, :ip_destination_address]
+      FLAGS = BITS.keys.select { |each| !(/^ip_(source|destination)/=~ 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 /(nw_src|nw_dst)(\d)/=~ key
+          if /(ip_source_address|ip_destination_address)(\d)/=~ key
             memo[$LAST_MATCH_INFO[1].intern] |= 1 << $LAST_MATCH_INFO[2].to_i
           else
             memo[key] = true
@@ -57,22 +57,23 @@ module Pio
       def set(params)
         self.flags = params.inject(0) do |memo, (key, val)|
           memo | case key
-                 when :nw_src, :nw_dst
-                   (params.fetch(key) & 31) << (key == :nw_src ? 8 : 14)
+                 when :ip_source_address, :ip_destination_address
+                   (params.fetch(key) & 31) <<
+                     (key == :ip_source_address ? 8 : 14)
                  else
                    val ? BITS.fetch(key) : 0
                  end
         end
       end
 
-      def nw_src
-        get.fetch(:nw_src)
+      def ip_source_address
+        get.fetch(:ip_source_address)
       rescue KeyError
         0
       end
 
-      def nw_dst
-        get.fetch(:nw_dst)
+      def ip_destination_address
+        get.fetch(:ip_destination_address)
       rescue KeyError
         0
       end
@@ -105,21 +106,23 @@ module Pio
 
       wildcards :wildcards
       uint16 :in_port
-      mac_address :dl_src
-      mac_address :dl_dst
-      uint16 :dl_vlan
-      uint8 :dl_vlan_pcp
+      mac_address :ether_source_address
+      mac_address :ether_destination_address
+      uint16 :vlan_vid
+      uint8 :vlan_priority
       uint8 :padding1
       hide :padding1
-      uint16 :dl_type
-      uint8 :nw_tos
-      uint8 :nw_proto
+      uint16 :ether_type
+      uint8 :ip_tos
+      uint8 :ip_protocol
       uint16 :padding2
       hide :padding2
-      match_ip_address :nw_src, bitcount: -> { wildcards.nw_src }
-      match_ip_address :nw_dst, bitcount: -> { wildcards.nw_dst }
-      uint16 :tp_src
-      uint16 :tp_dst
+      match_ip_address :ip_source_address,
+                       bitcount: -> { wildcards.ip_source_address }
+      match_ip_address :ip_destination_address,
+                       bitcount: -> { wildcards.ip_destination_address }
+      uint16 :transport_source_port
+      uint16 :transport_destination_port
     end
 
     def self.read(binary)

data/lib/pio/open_flow13.rb

@@ -0,0 +1,12 @@
+module Pio
+  # OpenFlow specific types.
+  module OpenFlow
+    remove_const :VERSION
+    VERSION = 4
+  end
+end
+
+require 'pio/open_flow13/echo'
+require 'pio/open_flow13/features_reply'
+require 'pio/open_flow13/features_request'
+require 'pio/open_flow13/hello'

data/lib/pio/{echo.rb → open_flow13/echo.rb}

@@ -1,19 +1,11 @@
 require 'forwardable'
 require 'pio/open_flow'
 
+# Base module.
 module Pio
-  # OpenFlow 1.0 Echo Request and Reply message.
-  module Echo
-    # OpenFlow 1.0 Echo Request message.
-    class Request; end
-    OpenFlow::Message.factory(Request, OpenFlow::ECHO_REQUEST)
-
-    # OpenFlow 1.0 Echo Reply message.
-    class Reply; end
-    OpenFlow::Message.factory(Reply, OpenFlow::ECHO_REPLY)
-  end
+  remove_const :Echo
 
-  module Echo13
+  module Echo
     # Base class of Echo Request and Reply.
     class Message
       def self.message_name
@@ -54,12 +46,16 @@ module Pio
       def_delegators :open_flow_header, :message_length
       def_delegators :open_flow_header, :transaction_id
       def_delegator :open_flow_header, :transaction_id, :xid
+
+      def to_binary
+        to_binary_s
+      end
     end
 
     # OpenFlow 1.3 Echo Request message.
     class Request < Message
       # OpenFlow 1.3 Echo Request message format.
-      class Format < Echo13::Format
+      class Format < Echo::Format
         endian :big
         open_flow_header :open_flow_header,
                          ofp_version_value: 4, message_type_value: 2
@@ -70,7 +66,7 @@ module Pio
     # OpenFlow 1.3 Echo Reply message.
     class Reply < Message
       # OpenFlow 1.3 Echo Request message format.
-      class Format < Echo13::Format
+      class Format < Echo::Format
         endian :big
         open_flow_header :open_flow_header,
                          ofp_version_value: 4, message_type_value: 3

data/lib/pio/open_flow13/features_reply.rb

@@ -0,0 +1,91 @@
+require 'forwardable'
+require 'pio/open_flow'
+
+# Base module.
+module Pio
+  # OpenFlow 1.3 Features Request and Reply message.
+  class Features
+    remove_const :Reply
+
+    # OpenFlow 1.3 Features Reply message.
+    class Reply
+      # OpenFlow 1.3 Features Reply message body.
+      class Body < BinData::Record
+        extend OpenFlow::Flags
+
+        flags_32bit(:capabilities,
+                    [:flow_stats,
+                     :table_stats,
+                     :port_stats,
+                     :group_stats,
+                     :NOT_USED,
+                     :ip_reasm,
+                     :queue_stats,
+                     :NOT_USED,
+                     :port_blocked])
+
+        endian :big
+
+        uint64 :datapath_id
+        uint32 :n_buffers
+        uint8 :n_tables
+        uint8 :auxiliary_id
+        uint16 :padding
+        hide :padding
+        capabilities :capabilities
+        uint32 :reserved
+
+        def length
+          24
+        end
+      end
+
+      # OpenFlow 1.3 Features Reply message format.
+      class Format < BinData::Record
+        extend Forwardable
+
+        endian :big
+        open_flow_header(:open_flow_header,
+                         ofp_version_value: 4, message_type_value: 6)
+        body :body
+
+        def_delegators :open_flow_header, :ofp_version
+        def_delegators :open_flow_header, :message_type
+        def_delegators :open_flow_header, :message_length
+        def_delegators :open_flow_header, :transaction_id
+        def_delegator :open_flow_header, :transaction_id, :xid
+        def_delegators :body, :datapath_id
+        def_delegators :body, :n_buffers
+        def_delegators :body, :n_tables
+        def_delegators :body, :auxiliary_id
+        def_delegators :body, :capabilities
+        def_delegators :body, :reserved
+
+        def dpid
+          datapath_id
+        end
+      end
+
+      def self.read(raw_data)
+        allocate.tap do |message|
+          message.instance_variable_set(:@format, Format.read(raw_data))
+        end
+      rescue BinData::ValidityError
+        raise Pio::ParseError, 'Invalid Features Reply 1.3 message.'
+      end
+
+      def initialize(user_attrs = {})
+        header_options = OpenFlowHeader::Options.parse(user_attrs)
+        body_options = user_attrs.dup
+        body_options[:datapath_id] =
+          body_options[:dpid] || body_options[:datapath_id]
+        @format = Format.new(open_flow_header: header_options,
+                             body: body_options)
+      end
+
+      def method_missing(method, *args, &block)
+        @format.__send__ method, *args, &block
+      end
+    end
+  end
+end

data/lib/pio/open_flow13/features_request.rb

@@ -0,0 +1,54 @@
+require 'forwardable'
+require 'pio/open_flow'
+
+# Base module.
+module Pio
+  # OpenFlow 1.3 Features Request and Reply message.
+  class Features
+    remove_const :Request
+
+    # OpenFlow 1.3 Features Request message.
+    class Request
+      # OpenFlow 1.3 Features Request message format.
+      class Format < BinData::Record
+        extend Forwardable
+
+        endian :big
+        open_flow_header(:open_flow_header,
+                         ofp_version_value: 4, message_type_value: 5)
+        string :body, value: ''
+
+        def_delegators :open_flow_header, :ofp_version
+        def_delegators :open_flow_header, :message_type
+        def_delegators :open_flow_header, :message_length
+        def_delegators :open_flow_header, :transaction_id
+        def_delegator :open_flow_header, :transaction_id, :xid
+
+        def to_binary
+          to_binary_s
+        end
+      end
+
+      def self.read(raw_data)
+        allocate.tap do |message|
+          message.instance_variable_set(:@format, Format.read(raw_data))
+        end
+      rescue BinData::ValidityError
+        raise Pio::ParseError, 'Invalid Features Request 1.3 message.'
+      end
+
+      def initialize(user_attrs = {})
+        unknown_attrs = user_attrs.keys - [:transaction_id, :xid]
+        unless unknown_attrs.empty?
+          fail "Unknown keyword: #{unknown_attrs.first}"
+        end
+        header_options = OpenFlowHeader::Options.parse(user_attrs)
+        @format = Format.new(open_flow_header: header_options)
+      end
+
+      def method_missing(method, *args, &block)
+        @format.__send__ method, *args, &block
+      end
+    end
+  end
+end

data/lib/pio/{hello13.rb → open_flow13/hello.rb}

@@ -3,9 +3,12 @@ require 'forwardable'
 require 'pio/open_flow'
 require 'pio/parse_error'
 
+# Base module.
 module Pio
+  remove_const :Hello
+
   # OpenFlow 1.3 Hello message parser and generator
-  class Hello13
+  class Hello
     # ofp_hello_elem_header and value
     class Element < BinData::Record
       VERSION_BITMAP = 1

data/lib/pio/{set_eth_addr.rb → set_ether_address.rb}

@@ -4,7 +4,7 @@ require 'pio/type/mac_address'
 
 module Pio
   # An action to modify the source/destination Ethernet address of a packet.
-  class SetEthAddr
+  class SetEtherAddress
     # rubocop:disable MethodLength
     def self.def_format(action_type)
       str = %(
@@ -23,10 +23,10 @@ module Pio
     # rubocop:enable MethodLength
 
     def self.read(raw_data)
-      set_eth_addr = allocate
-      set_eth_addr.instance_variable_set(:@format,
-                                         const_get(:Format).read(raw_data))
-      set_eth_addr
+      set_ether_address = allocate
+      set_ether_address.instance_variable_set(:@format,
+                                              const_get(:Format).read(raw_data))
+      set_ether_address
     end
 
     extend Forwardable
@@ -41,12 +41,12 @@ module Pio
   end
 
   # An action to modify the source Ethernet address of a packet.
-  class SetEthSrcAddr < SetEthAddr
+  class SetEtherSourceAddr < SetEtherAddress
     def_format 4
   end
 
   # An action to modify the destination Ethernet address of a packet.
-  class SetEthDstAddr < SetEthAddr
+  class SetEtherDestinationAddr < SetEtherAddress
     def_format 5
   end
 end

data/lib/pio/{set_ip_addr.rb → set_ip_address.rb}

@@ -4,7 +4,7 @@ require 'pio/type/ip_address'
 
 module Pio
   # An action to modify the IPv4 source/destination address of a packet.
-  class SetIpAddr
+  class SetIpAddress
     def self.def_format(action_type)
       str = %(
         class Format < BinData::Record
@@ -19,10 +19,10 @@ module Pio
     end
 
     def self.read(raw_data)
-      set_ip_addr = allocate
-      set_ip_addr.instance_variable_set(:@format,
-                                        const_get(:Format).read(raw_data))
-      set_ip_addr
+      set_ip_address = allocate
+      set_ip_address.instance_variable_set(:@format,
+                                           const_get(:Format).read(raw_data))
+      set_ip_address
     end
 
     extend Forwardable
@@ -38,12 +38,12 @@ module Pio
   end
 
   # An action to modify the IPv4 source address of a packet.
-  class SetIpSrcAddr < SetIpAddr
+  class SetIpSourceAddress < SetIpAddress
     def_format 6
   end
 
   # An action to modify the IPv4 source address of a packet.
-  class SetIpDstAddr < SetIpAddr
+  class SetIpDestinationAddress < SetIpAddress
     def_format 7
   end
 end