pio 0.27.2 → 0.28.0

data/features/udp.feature

@@ -18,8 +18,8 @@ Feature: Pio::Udp
     | ip_ttl                 |               250 |
     | ip_protocol            |                17 |
     | ip_header_checksum     |              6027 |
-    | ip_source_address      |           0.0.0.0 |
-    | ip_destination_address |   255.255.255.255 |
+    | source_ip_address      |           0.0.0.0 |
+    | destination_ip_address |   255.255.255.255 |
     | ip_option              |                   |
     | udp_source_port        |                68 |
     | udp_destination_port   |                67 |

data/lib/pio/arp/format.rb

@@ -31,15 +31,15 @@ module Pio
       def to_exact_match(in_port)
         match_options = {
           in_port: in_port,
-          ether_source_address: source_mac,
-          ether_destination_address: destination_mac,
+          source_mac_address: source_mac,
+          destination_mac_address: destination_mac,
           vlan_vid: vlan_vid,
           vlan_priority: vlan_pcp,
           ether_type: ether_type,
-          ip_tos: 0,
+          tos: 0,
           ip_protocol: operation,
-          ip_source_address: sender_protocol_address,
-          ip_destination_address: target_protocol_address,
+          source_ip_address: sender_protocol_address,
+          destination_ip_address: target_protocol_address,
           transport_source_port: 0,
           transport_destination_port: 0
         }

data/lib/pio/dhcp/boot_reply_options.rb

@@ -11,8 +11,8 @@ module Pio
 
       mandatory_option :source_mac
       mandatory_option :destination_mac
-      mandatory_option :ip_source_address
-      mandatory_option :ip_destination_address
+      mandatory_option :source_ip_address
+      mandatory_option :destination_ip_address
       mandatory_option :type
       option :subnet_mask
       option :renewal_time_value
@@ -29,8 +29,8 @@ module Pio
         {
           destination_mac: destination_mac,
           source_mac: source_mac,
-          ip_destination_address: ip_destination_address,
-          ip_source_address: ip_source_address,
+          destination_ip_address: destination_ip_address,
+          source_ip_address: source_ip_address,
           udp_source_port: BOOTPS,
           udp_destination_port: BOOTPC,
           dhcp: dhcp_data
@@ -44,7 +44,7 @@ module Pio
           message_type: BootReply::MESSAGE_TYPE,
           transaction_id: transaction_id,
           client_ip_address: QUAD_ZERO_IP_ADDRESS,
-          your_ip_address: ip_destination_address,
+          your_ip_address: destination_ip_address,
           next_server_ip_address: QUAD_ZERO_IP_ADDRESS,
           relay_agent_ip_address: QUAD_ZERO_IP_ADDRESS,
           client_mac_address: source_mac,
@@ -65,7 +65,7 @@ module Pio
 
       def server_identifier
         IPv4Address.new(
-          @options[:server_identifier] || ip_source_address
+          @options[:server_identifier] || source_ip_address
         )
       end
     end

data/lib/pio/dhcp/boot_request_options.rb

@@ -25,8 +25,8 @@ module Pio
         {
           destination_mac: destination_mac,
           source_mac: source_mac,
-          ip_source_address: QUAD_ZERO_IP_ADDRESS,
-          ip_destination_address: BROADCAST_IP_ADDRESS,
+          source_ip_address: QUAD_ZERO_IP_ADDRESS,
+          destination_ip_address: BROADCAST_IP_ADDRESS,
           udp_source_port: BOOTPC,
           udp_destination_port: BOOTPS,
           dhcp: dhcp_data

data/lib/pio/dhcp/common_options.rb

@@ -24,17 +24,17 @@ module Pio
         Mac.new(@options[:destination_mac] || BROADCAST_MAC_ADDRESS)
       end
 
-      def ip_source_address
-        IPv4Address.new(@options[:ip_source_address])
+      def source_ip_address
+        IPv4Address.new(@options[:source_ip_address])
       end
 
-      def ip_destination_address
-        IPv4Address.new(@options[:ip_destination_address])
+      def destination_ip_address
+        IPv4Address.new(@options[:destination_ip_address])
       end
 
       def server_identifier
         IPv4Address.new(
-          @options[:server_identifier] || ip_source_address
+          @options[:server_identifier] || source_ip_address
         )
       end
 

data/lib/pio/dhcp/message.rb

@@ -20,8 +20,8 @@ module Pio
       def_delegators :@frame, :ip_ttl
       def_delegators :@frame, :ip_protocol
       def_delegators :@frame, :ip_header_checksum
-      def_delegators :@frame, :ip_source_address
-      def_delegators :@frame, :ip_destination_address
+      def_delegators :@frame, :source_ip_address
+      def_delegators :@frame, :destination_ip_address
       def_delegators :@frame, :udp_source_port
       def_delegators :@frame, :udp_destination_port
       def_delegators :@frame, :udp_length

data/lib/pio/icmp/options.rb

@@ -9,8 +9,8 @@ module Pio
           icmp_type: @type,
           source_mac: @source_mac,
           destination_mac: @destination_mac,
-          ip_source_address: @ip_source_address,
-          ip_destination_address: @ip_destination_address,
+          source_ip_address: @source_ip_address,
+          destination_ip_address: @destination_ip_address,
           icmp_identifier: @identifier,
           icmp_sequence_number: @sequence_number,
           echo_data: @echo_data

data/lib/pio/icmp/reply.rb

@@ -13,8 +13,8 @@ module Pio
       class Options < Pio::Icmp::Options
         mandatory_option :source_mac
         mandatory_option :destination_mac
-        mandatory_option :ip_source_address
-        mandatory_option :ip_destination_address
+        mandatory_option :source_ip_address
+        mandatory_option :destination_ip_address
         mandatory_option :identifier
         mandatory_option :sequence_number
         option :echo_data
@@ -27,10 +27,10 @@ module Pio
 
           @source_mac = Mac.new(options[:source_mac]).freeze
           @destination_mac = Mac.new(options[:destination_mac]).freeze
-          @ip_source_address =
-            IPv4Address.new(options[:ip_source_address]).freeze
-          @ip_destination_address =
-            IPv4Address.new(options[:ip_destination_address]).freeze
+          @source_ip_address =
+            IPv4Address.new(options[:source_ip_address]).freeze
+          @destination_ip_address =
+            IPv4Address.new(options[:destination_ip_address]).freeze
           @identifier = options[:identifier]
           @sequence_number = options[:sequence_number]
           @echo_data = options[:echo_data] || ''

data/lib/pio/icmp/request.rb

@@ -16,8 +16,8 @@ module Pio
 
         mandatory_option :source_mac
         mandatory_option :destination_mac
-        mandatory_option :ip_source_address
-        mandatory_option :ip_destination_address
+        mandatory_option :source_ip_address
+        mandatory_option :destination_ip_address
         option :identifier
         option :sequence_number
         option :echo_data
@@ -30,10 +30,10 @@ module Pio
 
           @source_mac = Mac.new(options[:source_mac]).freeze
           @destination_mac = Mac.new(options[:destination_mac]).freeze
-          @ip_source_address =
-            IPv4Address.new(options[:ip_source_address]).freeze
-          @ip_destination_address =
-            IPv4Address.new(options[:ip_destination_address]).freeze
+          @source_ip_address =
+            IPv4Address.new(options[:source_ip_address]).freeze
+          @destination_ip_address =
+            IPv4Address.new(options[:destination_ip_address]).freeze
           @identifier =
             options[:icmp_identifier] ||
             options[:identifier] ||

data/lib/pio/ipv4_header.rb

@@ -26,8 +26,8 @@ module Pio
         uint8 :ip_ttl, initial_value: 128
         uint8 :ip_protocol, initial_value: options[:ip_protocol] || 0
         uint16be :ip_header_checksum, initial_value: :calculate_ip_checksum
-        ip_address :ip_source_address
-        ip_address :ip_destination_address
+        ip_address :source_ip_address
+        ip_address :destination_ip_address
         string :ip_option, read_length: :ip_option_length
       end
     end
@@ -37,15 +37,15 @@ module Pio
     def to_exact_match(in_port)
       match_options = {
         in_port: in_port,
-        ether_source_address: source_mac,
-        ether_destination_address: destination_mac,
+        source_mac_address: source_mac,
+        destination_mac_address: destination_mac,
         vlan_vid: vlan_vid,
         vlan_priority: vlan_pcp,
         ether_type: ether_type,
-        ip_tos: ip_type_of_service,
+        tos: ip_type_of_service,
         ip_protocol: ip_protocol,
-        ip_source_address: ip_source_address,
-        ip_destination_address: ip_destination_address,
+        source_ip_address: source_ip_address,
+        destination_ip_address: destination_ip_address,
         transport_source_port: transport_source_port,
         transport_destination_port: transport_destination_port
       }
@@ -66,10 +66,10 @@ module Pio
              ip_identifier,
              ip_flag << 13 | ip_fragment,
              ip_ttl << 8 | ip_protocol,
-             ip_source_address >> 16,
-             ip_source_address & 0xffff,
-             ip_destination_address >> 16,
-             ip_destination_address & 0xffff].reduce(:+)
+             source_ip_address >> 16,
+             source_ip_address & 0xffff,
+             destination_ip_address >> 16,
+             destination_ip_address & 0xffff].reduce(:+)
       ~((sum & 0xffff) + (sum >> 16)) & 0xffff
     end
     # rubocop:enable AbcSize

data/lib/pio/open_flow.rb

@@ -16,8 +16,10 @@ module Pio
 
     def self.switch_version(version)
       [:Barrier, :Echo, :Features, :FlowMod, :Hello, :Match,
-       :PacketIn, :PacketOut, :SendOutPort, :PortStatus, :Stats,
-       :FlowStats, :DescriptionStats, :AggregateStats, :Error].each do |each|
+       :PacketIn, :FlowRemoved, :PacketOut, :SendOutPort, :PortStatus,
+       :Stats, :FlowStats, :DescriptionStats, :AggregateStats,
+       :TableStats, :PortStats, :QueueStats, :Error, :NiciraResubmit,
+       :NiciraResubmitTable].each do |each|
         set_message_class_name each, version
         @version = version.to_s
       end
@@ -33,6 +35,7 @@ module Pio
         5 => Pio::Features::Request,
         6 => Pio::Features::Reply,
         10 => Pio::PacketIn,
+        11 => Pio::FlowRemoved,
         12 => Pio::PortStatus,
         13 => Pio::PacketOut,
         14 => Pio::FlowMod,

data/lib/pio/open_flow/action.rb

@@ -0,0 +1,41 @@
+require 'bindata'
+
+module Pio
+  module OpenFlow
+    # OpenFlow actions.
+    class Action
+      def self.inherited(child_klass)
+        child_klass.const_set :Format, Class.new(BinData::Record)
+      end
+
+      def self.action_header(options)
+        module_eval do
+          endian :big
+
+          uint16 :action_type, value: options.fetch(:action_type)
+          uint16 :action_length, value: options.fetch(:action_length)
+        end
+      end
+
+      def self.read(raw_data)
+        action = allocate
+        action.instance_variable_set :@format, const_get(:Format).read(raw_data)
+        action
+      end
+
+      def self.method_missing(method, *args, &block)
+        const_get(:Format).__send__ method, *args, &block
+        return if method == :endian || method == :virtual
+        define_method(args.first) { @format.__send__ args.first }
+      end
+
+      def initialize(user_options)
+        @format = self.class.const_get(:Format).new(user_options)
+      end
+
+      def to_binary
+        @format.to_binary_s
+      end
+    end
+  end
+end

data/lib/pio/open_flow/nicira_action.rb

@@ -0,0 +1,17 @@
+require 'pio/open_flow/action'
+
+module Pio
+  module OpenFlow
+    # NXAST_* actions
+    class NiciraAction < Action
+      def self.nicira_action_header(options)
+        module_eval do
+          action_header action_type: options.fetch(:action_type),
+                        action_length: options.fetch(:action_length)
+          uint32 :vendor, value: 0x2320
+          uint16 :subtype, value: options.fetch(:subtype)
+        end
+      end
+    end
+  end
+end

data/lib/pio/open_flow10.rb

@@ -1,5 +1,4 @@
 # Messages
-require 'pio/open_flow10/stats_reply'
 require 'pio/open_flow10/aggregate_stats/reply'
 require 'pio/open_flow10/aggregate_stats/request'
 require 'pio/open_flow10/barrier/reply'
@@ -14,16 +13,28 @@ require 'pio/open_flow10/error/hello_failed'
 require 'pio/open_flow10/features/reply'
 require 'pio/open_flow10/features/request'
 require 'pio/open_flow10/flow_mod'
+require 'pio/open_flow10/flow_removed'
 require 'pio/open_flow10/flow_stats/reply'
 require 'pio/open_flow10/flow_stats/request'
 require 'pio/open_flow10/hello'
 require 'pio/open_flow10/packet_in'
 require 'pio/open_flow10/packet_out'
+require 'pio/open_flow10/port_stats/request'
 require 'pio/open_flow10/port_status'
+require 'pio/open_flow10/queue_stats/request'
+require 'pio/open_flow10/stats_reply'
 require 'pio/open_flow10/stats_request'
+require 'pio/open_flow10/table_stats/request'
 
 # Actions
+require 'pio/open_flow10/nicira_resubmit'
+require 'pio/open_flow10/nicira_resubmit_table'
 require 'pio/open_flow10/send_out_port'
+require 'pio/open_flow10/set_destination_mac_address'
+require 'pio/open_flow10/set_source_mac_address'
+require 'pio/open_flow10/set_tos'
+require 'pio/open_flow10/set_vlan_priority'
+require 'pio/open_flow10/set_vlan_vid'
 
 # Misc.
 require 'pio/open_flow10/exact_match'

data/lib/pio/open_flow10/actions.rb

@@ -1,9 +1,11 @@
 require 'bindata'
 require 'pio/open_flow10/enqueue'
 require 'pio/open_flow10/send_out_port'
-require 'pio/open_flow10/set_ether_address'
-require 'pio/open_flow10/set_ip_address'
-require 'pio/open_flow10/set_ip_tos'
+require 'pio/open_flow10/set_destination_ip_address'
+require 'pio/open_flow10/set_destination_mac_address'
+require 'pio/open_flow10/set_source_ip_address'
+require 'pio/open_flow10/set_source_mac_address'
+require 'pio/open_flow10/set_tos'
 require 'pio/open_flow10/set_transport_port'
 require 'pio/open_flow10/set_vlan_priority'
 require 'pio/open_flow10/set_vlan_vid'
@@ -16,17 +18,17 @@ module Pio
     class Actions < BinData::Primitive
       ACTION_CLASS = {
         0 => Pio::OpenFlow10::SendOutPort,
-        1 => Pio::SetVlanVid,
-        2 => Pio::SetVlanPriority,
-        3 => Pio::StripVlanHeader,
-        4 => Pio::SetEtherSourceAddress,
-        5 => Pio::SetEtherDestinationAddress,
-        6 => Pio::SetIpSourceAddress,
-        7 => Pio::SetIpDestinationAddress,
-        8 => Pio::SetIpTos,
-        9 => Pio::SetTransportSourcePort,
-        10 => Pio::SetTransportDestinationPort,
-        11 => Pio::Enqueue,
+        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
       }
 
@@ -49,7 +51,7 @@ module Pio
           type = BinData::Uint16be.read(tmp)
           begin
             action = ACTION_CLASS.fetch(type).read(tmp)
-            tmp = tmp[action.length..-1]
+            tmp = tmp[action.action_length..-1]
             actions << action
           rescue KeyError
             raise "action type #{type} is not supported."

data/lib/pio/open_flow10/enqueue.rb

@@ -1,62 +1,43 @@
-require 'bindata'
-require 'forwardable'
 require 'pio/monkey_patch/integer'
+require 'pio/open_flow/action'
 require 'pio/open_flow10/port16'
 
 module Pio
-  # An action to enqueue the packet on the specified queue attached to
-  # a port.
-  class Enqueue
-    # OpenFlow 1.0 OFPAT_ENQUEUE action format.
-    class Format < BinData::Record
-      endian :big
-
-      uint16 :action_type, value: 11
-      uint16 :action_length, value: 16
+  module OpenFlow10
+    # An action to enqueue the packet on the specified queue attached
+    # to a port.
+    class Enqueue < OpenFlow::Action
+      action_header action_type: 11, action_length: 16
       port16 :port
-      uint48 :padding
+      string :padding, length: 6
       hide :padding
       uint32 :queue_id
-    end
-
-    def self.read(raw_data)
-      enqueue = allocate
-      enqueue.instance_variable_set :@format, Format.read(raw_data)
-      enqueue
-    end
-
-    extend Forwardable
 
-    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 user_options
-      validate_queue_id user_options
-      @format = Format.new(user_options)
-    end
+      def initialize(user_options)
+        validate_port user_options
+        validate_queue_id user_options
+        super(user_options)
+      end
 
-    private
+      private
 
-    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')
+      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')
+        end
+      rescue KeyError
+        raise ArgumentError, ':port is a mandatory option'
       end
-    rescue KeyError
-      raise ArgumentError, ':port is a mandatory option'
-    end
 
-    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'
+      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'
+        end
+      rescue KeyError
+        raise ArgumentError, ':queue_id is a mandatory option'
       end
-    rescue KeyError
-      raise ArgumentError, ':queue_id is a mandatory option'
     end
   end
 end