pio 0.22.0 → 0.23.0

data/lib/pio/open_flow13/apply.rb

@@ -1,48 +1,10 @@
 require 'bindata'
 require 'forwardable'
+require 'pio/open_flow13/actions'
 
 module Pio
   # An instruction to apply a list of actions to a packet in-order.
   class Apply
-    # Actions not yet implemented.
-    class UnsupportedAction < BinData::Record
-      endian :big
-
-      uint16 :action_type
-      uint16 :action_length
-    end
-
-    # Actions list of actions-apply instruction.
-    class Actions < BinData::Primitive
-      mandatory_parameter :length
-
-      endian :big
-
-      string :binary, read_length: :length
-
-      def set(value)
-        self.binary = [value].flatten.map(&:to_binary).join
-      end
-
-      # rubocop:disable MethodLength
-      def get
-        actions = []
-        tmp = binary
-        while tmp.length > 0
-          action = case BinData::Uint16be.read(tmp)
-                   when 0
-                     SendOutPort.read(tmp)
-                   else
-                     UnsupportedAction.read(tmp)
-                   end
-          tmp = tmp[action.action_length..-1]
-          actions << action
-        end
-        actions
-      end
-      # rubocop:enable MethodLength
-    end
-
     # OpenFlow 1.3.4 OFPIT_APPLY_ACTIONS instruction format.
     class Format < BinData::Record
       endian :big

data/lib/pio/open_flow13/buffer_id.rb

@@ -0,0 +1,17 @@
+module Pio
+  # Buffered packet to apply to, or :no_buffer.
+  class BufferId < BinData::Primitive
+    NO_BUFFER = 0xffffffff
+
+    endian :big
+    uint32 :buffer_id, initial_value: NO_BUFFER
+
+    def get
+      (buffer_id == NO_BUFFER) ? :no_buffer : buffer_id
+    end
+
+    def set(value)
+      self.buffer_id = (value == :no_buffer ? NO_BUFFER : value)
+    end
+  end
+end

data/lib/pio/open_flow13/flow_mod.rb

@@ -1,5 +1,6 @@
 require 'forwardable'
 require 'pio/open_flow'
+require 'pio/open_flow13/buffer_id'
 require 'pio/open_flow13/match'
 
 # Base module.
@@ -29,22 +30,6 @@ module Pio
       end
     end
 
-    # Buffered packet to apply to, or :no_buffer.
-    class BufferId < BinData::Primitive
-      NO_BUFFER = 0xffffffff
-
-      endian :big
-      uint32 :buffer_id, initial_value: NO_BUFFER
-
-      def get
-        (buffer_id == NO_BUFFER) ? :no_buffer : buffer_id
-      end
-
-      def set(value)
-        self.buffer_id = (value == :no_buffer ? NO_BUFFER : value)
-      end
-    end
-
     # For delete commands, require matching entries to include this as
     # an output port.
     class OutPort < BinData::Primitive

data/lib/pio/open_flow13/match.rb

@@ -348,6 +348,125 @@ module Pio
         end
       end
 
+      # The value of OXM_OF_ARP_OP
+      class ArpOp < BinData::Record
+        OXM_FIELD = 21
+
+        endian :big
+
+        uint16 :arp_op
+
+        def length
+          2
+        end
+      end
+
+      # The value of OXM_OF_ARP_SPA
+      class ArpSenderProtocolAddress < BinData::Record
+        OXM_FIELD = 22
+
+        endian :big
+
+        ip_address :arp_sender_protocol_address
+
+        def length
+          4
+        end
+      end
+
+      # The value of masked OXM_OF_ARP_SPA
+      class MaskedArpSenderProtocolAddress < BinData::Record
+        OXM_FIELD = 22
+
+        endian :big
+        ip_address :arp_sender_protocol_address
+        ip_address :arp_sender_protocol_address_mask
+
+        def length
+          8
+        end
+      end
+
+      # The value of OXM_OF_ARP_TPA
+      class ArpTargetProtocolAddress < BinData::Record
+        OXM_FIELD = 23
+
+        endian :big
+
+        ip_address :arp_target_protocol_address
+
+        def length
+          4
+        end
+      end
+
+      # The value of masked OXM_OF_ARP_TPA
+      class MaskedArpTargetProtocolAddress < BinData::Record
+        OXM_FIELD = 23
+
+        endian :big
+        ip_address :arp_target_protocol_address
+        ip_address :arp_target_protocol_address_mask
+
+        def length
+          8
+        end
+      end
+
+      # The value of OXM_OF_ARP_SHA match field.
+      class ArpSenderHardwareAddress < BinData::Record
+        OXM_FIELD = 24
+
+        endian :big
+
+        mac_address :arp_sender_hardware_address
+
+        def length
+          6
+        end
+      end
+
+      # Masked OXM_OF_ARP_SHA match field.
+      class MaskedArpSenderHardwareAddress < BinData::Record
+        OXM_FIELD = 24
+
+        endian :big
+
+        mac_address :arp_sender_hardware_address
+        mac_address :arp_sender_hardware_address_mask
+
+        def length
+          12
+        end
+      end
+
+      # The value of OXM_OF_ARP_THA match field.
+      class ArpTargetHardwareAddress < BinData::Record
+        OXM_FIELD = 25
+
+        endian :big
+
+        mac_address :arp_target_hardware_address
+
+        def length
+          6
+        end
+      end
+
+      # Masked OXM_OF_ARP_THA match field.
+      class MaskedArpTargetHardwareAddress < BinData::Record
+        OXM_FIELD = 25
+
+        endian :big
+
+        mac_address :arp_target_hardware_address
+        mac_address :arp_target_hardware_address_mask
+
+        def length
+          12
+        end
+      end
+
       # The value of OXM_OF_IPV6_SRC
       class Ipv6SourceAddress < BinData::Record
         OXM_FIELD = 26
@@ -402,9 +521,35 @@ module Pio
         end
       end
 
+      # The value of OXM_OF_TUNNEL_ID match field
+      class TunnelId < BinData::Record
+        OXM_FIELD = 38
+
+        endian :big
+
+        uint64 :tunnel_id
+
+        def length
+          8
+        end
+      end
+
+      # Masked OXM_OF_TUNNEL_ID match field
+      class MaskedTunnelId < BinData::Record
+        endian :big
+
+        uint64 :tunnel_id
+        uint64 :tunnel_id_mask
+
+        def length
+          16
+        end
+      end
+
       # OXM format
       class Oxm < BinData::Record
         # OXM match field.
+        # rubocop:disable ClassLength
         class MatchField < BinData::Record
           endian :big
 
@@ -438,12 +583,23 @@ module Pio
             udp_destination_port UdpDestinationPort
             sctp_source_port SctpSourcePort
             sctp_destination_port SctpDestinationPort
+            arp_op ArpOp
+            arp_sender_protocol_address ArpSenderProtocolAddress
+            masked_arp_sender_protocol_address MaskedArpSenderProtocolAddress
+            arp_target_protocol_address ArpTargetProtocolAddress
+            masked_arp_target_protocol_address MaskedArpTargetProtocolAddress
+            arp_sender_hardware_address ArpSenderHardwareAddress
+            masked_arp_sender_hardware_address MaskedArpSenderHardwareAddress
+            arp_target_hardware_address ArpTargetHardwareAddress
+            masked_arp_target_hardware_address MaskedArpTargetHardwareAddress
             icmpv4_type Icmpv4Type
             icmpv4_code Icmpv4Code
             ipv6_source_address Ipv6SourceAddress
             masked_ipv6_source_address MaskedIpv6SourceAddress
             ipv6_destination_address Ipv6DestinationAddress
             masked_ipv6_destination_address MaskedIpv6DestinationAddress
+            tunnel_id TunnelId
+            masked_tunnel_id MaskedTunnelId
           end
 
           def length
@@ -506,10 +662,42 @@ module Pio
               Icmpv4Type
             when Icmpv4Code::OXM_FIELD
               Icmpv4Code
+            when ArpOp::OXM_FIELD
+              ArpOp
+            when ArpSenderProtocolAddress::OXM_FIELD
+              if masked?
+                MaskedArpSenderProtocolAddress
+              else
+                ArpSenderProtocolAddress
+              end
+            when ArpTargetProtocolAddress::OXM_FIELD
+              if masked?
+                MaskedArpTargetProtocolAddress
+              else
+                ArpTargetProtocolAddress
+              end
+            when ArpSenderHardwareAddress::OXM_FIELD
+              if masked?
+                MaskedArpSenderHardwareAddress
+              else
+                ArpSenderHardwareAddress
+              end
+            when ArpTargetHardwareAddress::OXM_FIELD
+              if masked?
+                MaskedArpTargetHardwareAddress
+              else
+                ArpTargetHardwareAddress
+              end
             when Ipv6SourceAddress::OXM_FIELD
-              masked? ? MaskedIpv6SourceAddress : Ipv6SourceAddress
+              if masked?
+                MaskedIpv6SourceAddress
+              else
+                Ipv6SourceAddress
+              end
             when Ipv6DestinationAddress::OXM_FIELD
               masked? ? MaskedIpv6DestinationAddress : Ipv6DestinationAddress
+            when TunnelId::OXM_FIELD
+              masked? ? MaskedTunnelId : TunnelId
             else
               fail "Unknown OXM field value: #{oxm_field}"
             end
@@ -519,6 +707,7 @@ module Pio
           # rubocop:enable PerceivedComplexity
           # rubocop:enable AbcSize
         end
+        # rubocop:enable MethodLength
 
         endian :big
 
@@ -571,8 +760,9 @@ module Pio
 
           [:in_port, :ether_type, :ip_protocol, :vlan_vid, :vlan_pcp,
            :ip_dscp, :ip_ecn, :tcp_source_port, :tcp_destination_port,
-           :udp_source_port, :udp_destination_port, :sctp_source_port,
-           :sctp_destination_port, :icmpv4_type, :icmpv4_code].each do |each|
+           :udp_source_port, :udp_destination_port,
+           :sctp_source_port, :sctp_destination_port,
+           :icmpv4_type, :icmpv4_code, :arp_op].each do |each|
             next unless user_attrs.key?(each)
             klass = Match.const_get(each.to_s.split('_').map(&:capitalize).join)
             @match_fields << { oxm_field: klass.const_get(:OXM_FIELD),
@@ -581,7 +771,10 @@ module Pio
 
           [:metadata, :ether_destination_address, :ether_source_address,
            :ipv4_source_address, :ipv4_destination_address,
-           :ipv6_source_address, :ipv6_destination_address].each do |each|
+           :arp_sender_protocol_address, :arp_target_protocol_address,
+           :arp_sender_hardware_address, :arp_target_hardware_address,
+           :ipv6_source_address, :ipv6_destination_address,
+           :tunnel_id].each do |each|
             next unless user_attrs.key?(each)
             klass = Match.const_get(each.to_s.split('_').map(&:capitalize).join)
             mask_key = "#{each}_mask".to_sym

data/lib/pio/open_flow13/packet_out.rb

@@ -0,0 +1,90 @@
+require 'bindata'
+require 'pio/open_flow13/actions'
+require 'pio/open_flow13/buffer_id'
+
+# Base module.
+module Pio
+  remove_const :PacketOut
+
+  # OpenFlow 1.3 PacketOut message parser and generator
+  class PacketOut
+    # Packet's input port or :controller
+    class InPort < BinData::Primitive
+      CONTROLLER = 0xfffffffd
+
+      endian :big
+      uint32 :in_port
+
+      def get
+        (in_port == CONTROLLER) ? :controller : in_port
+      end
+
+      def set(value)
+        self.in_port = (value == :controller ? NO_CONTROLLER : value)
+      end
+    end
+
+    # OpenFlow 1.3 PacketOut message body
+    class Body < BinData::Record
+      endian :big
+
+      buffer_id :buffer_id
+      in_port :in_port
+      uint16 :actions_length, initial_value: -> { actions.binary.length }
+      string :padding, length: 6
+      actions :actions, length: :actions_length
+      string :raw_data, read_length: -> { message_length - 24 - actions_length }
+
+      def length
+        10 + padding.length + actions_length + raw_data.length
+      end
+
+      def data
+        @data ||= Pio::Parser.read(raw_data)
+      end
+
+      def method_missing(method, *args)
+        data.__send__(method, *args).snapshot
+      end
+    end
+
+    # OpenFlow 1.3 PacketOut message body
+    class Format < BinData::Record
+      extend Forwardable
+
+      endian :big
+
+      open_flow_header :open_flow_header,
+                       ofp_version_value: 4, message_type_value: 13
+      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 method_missing(method, *args, &block)
+        body.__send__ method, *args, &block
+      end
+    end
+
+    def self.read(raw_data)
+      allocate.tap do |message|
+        message.instance_variable_set(:@format, Format.read(raw_data))
+      end
+    end
+
+    def initialize(user_attrs = {})
+      header_attrs = OpenFlowHeader::Options.parse(user_attrs)
+      body_attrs = { actions: user_attrs[:actions],
+                     raw_data: user_attrs[:raw_data] }
+      @format = Format.new(open_flow_header: header_attrs,
+                           body: body_attrs)
+    end
+
+    def method_missing(method, *args, &block)
+      @format.__send__ method, *args, &block
+    end
+  end
+end