pio 0.30.0 → 0.30.2

data/lib/pio/open_flow13/nicira_stack_pop.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'pio/open_flow/nicira_action'
+require 'pio/open_flow13/match'
+
+module Pio
+  module OpenFlow13
+    # NXAST_STACK_POP action
+    class NiciraStackPop < OpenFlow::NiciraAction
+      nicira_action_header action_type: 0xffff,
+                           action_length: 24,
+                           subtype: 28
+      uint16 :_offset
+      struct :field do
+        uint16 :oxm_class
+        bit7 :oxm_field
+        bit1 :oxm_hasmask, value: 0
+        uint8 :oxm_length
+      end
+      uint16 :_n_bits
+      string :padding, length: 6
+      hide :padding
+
+      def initialize(field, options = {})
+        @field = field
+        super(_offset: options[:offset] || 0,
+              _n_bits: (options[:n_bits] || oxm_length * 8) + 1,
+              field: { oxm_class: field_oxm_class.const_get(:OXM_CLASS),
+                       oxm_field: field_oxm_class.const_get(:OXM_FIELD),
+                       oxm_length: oxm_length })
+      end
+
+      attr_reader :field
+      alias offset _offset
+
+      def n_bits
+        _n_bits - 1
+      end
+
+      private
+
+      def oxm_length
+        field_oxm_class.new.length
+      end
+
+      def field_oxm_class
+        Match.const_get(@field.to_s.split('_').map(&:capitalize).join)
+      end
+    end
+  end
+end

data/lib/pio/open_flow13/nicira_stack_push.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'pio/open_flow/nicira_action'
+require 'pio/open_flow13/match'
+
+module Pio
+  module OpenFlow13
+    # NXAST_STACK_PUSH action
+    class NiciraStackPush < OpenFlow::NiciraAction
+      nicira_action_header action_type: 0xffff,
+                           action_length: 24,
+                           subtype: 27
+      uint16 :_offset
+      struct :field do
+        uint16 :oxm_class
+        bit7 :oxm_field
+        bit1 :oxm_hasmask, value: 0
+        uint8 :oxm_length
+      end
+      uint16 :_n_bits
+      string :padding, length: 6
+      hide :padding
+
+      def initialize(field, options = {})
+        @field = field
+        super(_offset: options[:offset] || 0,
+              _n_bits: (options[:n_bits] || oxm_length * 8) + 1,
+              field: { oxm_class: field_oxm_class.const_get(:OXM_CLASS),
+                       oxm_field: field_oxm_class.const_get(:OXM_FIELD),
+                       oxm_length: oxm_length })
+      end
+
+      attr_reader :field
+      alias offset _offset
+
+      def n_bits
+        _n_bits - 1
+      end
+
+      private
+
+      def oxm_length
+        field_oxm_class.new.length
+      end
+
+      def field_oxm_class
+        Match.const_get(@field.to_s.split('_').map(&:capitalize).join)
+      end
+    end
+  end
+end

data/lib/pio/open_flow13/packet_in.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/object/try'
 require 'pio/open_flow'
 require 'pio/open_flow13/match'
 require 'pio/parser'
@@ -8,8 +11,9 @@ module Pio
     class PacketIn < OpenFlow::Message
       # Why is this packet being sent to the controller?
       # (enum ofp_packet_in_reason)
+      # rubocop:disable LineLength
       class Reason < BinData::Primitive
-        REASONS = { no_match: 0, action: 1, invalid_ttl: 2 }
+        REASONS = { no_match: 0, action: 1, invalid_ttl: 2 }.freeze
 
         uint8 :reason
 
@@ -22,9 +26,8 @@ module Pio
         end
       end
 
-      open_flow_header(version: 4,
-                       message_type: 10,
-                       message_length: lambda do
+      open_flow_header(version: 4, type: 10,
+                       length: lambda do
                          24 + match.length + padding.length + raw_data.length
                        end)
       uint32 :buffer_id
@@ -35,11 +38,11 @@ module Pio
       oxm :match
       string :padding, length: 2
       hide :padding
-      string :raw_data, read_length: :total_len
+      string :raw_data, read_length: -> { length - header_length - (16 + match.length + 2) }
 
       attr_accessor :datapath_id
-      alias_method :dpid, :datapath_id
-      alias_method :dpid=, :datapath_id=
+      alias dpid datapath_id
+      alias dpid= datapath_id=
 
       def data
         @data ||= Pio::Parser.read(raw_data)
@@ -50,8 +53,10 @@ module Pio
       end
 
       def method_missing(method, *args)
-        data.__send__(method, *args).snapshot
+        bindata_value = data.__send__(method, *args)
+        bindata_value.try(:snapshot) || bindata_value
       end
+      # rubocop:enable LineLength
     end
   end
 end

data/lib/pio/open_flow13/packet_out.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/object/try'
 require 'pio/open_flow'
+require 'pio/open_flow/buffer_id'
 require 'pio/open_flow13/actions'
-require 'pio/open_flow13/buffer_id'
 
 module Pio
   module OpenFlow13
@@ -14,7 +17,7 @@ module Pio
         uint32 :in_port
 
         def get
-          (in_port == CONTROLLER) ? :controller : in_port
+          in_port == CONTROLLER ? :controller : in_port
         end
 
         def set(value)
@@ -22,24 +25,24 @@ module Pio
         end
       end
 
-      open_flow_header(version: 4,
-                       message_type: 13,
-                       message_length: lambda do
+      open_flow_header(version: 4, type: 13,
+                       length: lambda do
                          24 + actions_length + raw_data.length
                        end)
       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 }
+      actions13 :actions, length: :actions_length
+      string :raw_data, read_length: -> { length - 24 - actions_length }
 
       def data
         @data ||= Pio::Parser.read(raw_data)
       end
 
       def method_missing(method, *args)
-        data.__send__(method, *args).snapshot
+        bindata_value = data.__send__(method, *args)
+        bindata_value.try(:snapshot) || bindata_value
       end
     end
   end

data/lib/pio/open_flow13/port32.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow/port'
 
 module Pio

data/lib/pio/open_flow13/send_out_port.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow/action'
 require 'pio/open_flow13/port32'
 

data/lib/pio/open_flow13/set_arp_operation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow/action'
 require 'pio/open_flow13/match'
 

data/lib/pio/open_flow13/set_arp_sender_hardware_address.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow/action'
 require 'pio/open_flow13/match'
 

data/lib/pio/open_flow13/set_arp_sender_protocol_address.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow/action'
 require 'pio/open_flow13/match'
 

data/lib/pio/open_flow13/set_destination_mac_address.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow/action'
 require 'pio/open_flow13/match'
 

data/lib/pio/open_flow13/set_ip_ttl.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'pio/open_flow/action'
+
+module Pio
+  module OpenFlow13
+    # Sets IP TTL
+    class SetIpTtl < OpenFlow::Action
+      action_header action_type: 23, action_length: 8
+      uint8 :ttl
+      string :padding, length: 3
+
+      def initialize(ttl)
+        super(ttl: ttl)
+      end
+    end
+  end
+end

data/lib/pio/open_flow13/set_metadata.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow/action'
 require 'pio/open_flow13/match'
 

data/lib/pio/open_flow13/set_source_mac_address.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow/action'
 require 'pio/open_flow13/match'
 

data/lib/pio/open_flow13/stats_request.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow'
 
 module Pio
@@ -6,13 +8,13 @@ module Pio
     class StatsRequest < OpenFlow::Message
       # Request type of Stats Request message
       class StatsType < BinData::Primitive
-        TYPES = [:description,
-                 :flow,
-                 :aggregate,
-                 :table,
-                 :port,
-                 :queue,
-                 :vendor]
+        TYPES = %i[description
+                   flow
+                   aggregate
+                   table
+                   port
+                   queue
+                   vendor].freeze
 
         endian :big
 
@@ -27,9 +29,7 @@ module Pio
         end
       end
 
-      open_flow_header version: 4,
-                       message_type: 16,
-                       message_length: 12
+      open_flow_header version: 4, type: 16, length: 12
       stats_type :stats_type
       uint16 :stats_flags
     end

data/lib/pio/open_flow13/write_metadata.rb

@@ -1,52 +1,56 @@
+# frozen_string_literal: true
+
 require 'forwardable'
+require 'pio/open_flow/action'
 
-# Base module.
 module Pio
-  # Write metadata
-  class WriteMetadata
-    # OpenFlow 1.3.4 OFPIT_WRITE_METADATA instruction format
-    class Format < BinData::Record
-      endian :big
-
-      uint16 :instruction_type, value: 2
-      uint16 :instruction_length, value: 24
-      uint32 :padding
-      uint64 :metadata
-      uint64 :metadata_mask
-    end
+  module OpenFlow13
+    # Write metadata
+    class WriteMetadata < OpenFlow::Action
+      # OpenFlow 1.3.4 OFPIT_WRITE_METADATA instruction format
+      class Format < BinData::Record
+        endian :big
+
+        uint16 :instruction_type, value: 2
+        uint16 :instruction_length, value: 24
+        uint32 :padding
+        uint64 :metadata
+        uint64 :metadata_mask
+      end
 
-    def self.read(raw_data)
-      allocate.tap do |write_metadata|
-        write_metadata.instance_variable_set :@format, Format.read(raw_data)
+      def self.read(raw_data)
+        allocate.tap do |write_metadata|
+          write_metadata.instance_variable_set :@format, Format.read(raw_data)
+        end
       end
-    end
 
-    extend Forwardable
+      extend Forwardable
 
-    def_delegators :@format, :instruction_type
-    def_delegators :@format, :instruction_length
-    def_delegators :@format, :metadata
-    def_delegators :@format, :metadata_mask
-    def_delegators :@format, :to_binary_s
+      def_delegators :@format, :instruction_type
+      def_delegators :@format, :instruction_length
+      def_delegators :@format, :metadata
+      def_delegators :@format, :metadata_mask
+      def_delegators :@format, :to_binary_s
 
-    def initialize(user_options)
-      @options = user_options
-      @format = Format.new(options)
-    end
+      def initialize(user_options)
+        @options = user_options
+        @format = Format.new(options)
+      end
 
-    def options
-      {
-        metadata: metadata_option,
-        metadata_mask: metadata_mask_option
-      }
-    end
+      def options
+        {
+          metadata: metadata_option,
+          metadata_mask: metadata_mask_option
+        }
+      end
 
-    def metadata_option
-      @options[:metadata]
-    end
+      def metadata_option
+        @options[:metadata]
+      end
 
-    def metadata_mask_option
-      @options[:metadata_mask]
+      def metadata_mask_option
+        @options[:metadata_mask]
+      end
     end
   end
 end

data/lib/pio/open_flow13.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Messages
 require 'pio/open_flow13/echo/reply'
 require 'pio/open_flow13/echo/request'
@@ -15,14 +17,21 @@ require 'pio/open_flow13/stats_request'
 # Actions
 require 'pio/open_flow/nicira_resubmit'
 require 'pio/open_flow/nicira_resubmit_table'
+require 'pio/open_flow13/copy_ttl_inwards'
+require 'pio/open_flow13/copy_ttl_outwards'
+require 'pio/open_flow13/decrement_ip_ttl'
 require 'pio/open_flow13/nicira_reg_load'
 require 'pio/open_flow13/nicira_reg_move'
 require 'pio/open_flow13/nicira_send_out_port'
+require 'pio/open_flow13/nicira_stack_pop'
+require 'pio/open_flow13/nicira_stack_push'
+require 'pio/open_flow13/nicira_conjunction'
 require 'pio/open_flow13/send_out_port'
 require 'pio/open_flow13/set_arp_operation'
 require 'pio/open_flow13/set_arp_sender_hardware_address'
 require 'pio/open_flow13/set_arp_sender_protocol_address'
 require 'pio/open_flow13/set_destination_mac_address'
+require 'pio/open_flow13/set_ip_ttl'
 require 'pio/open_flow13/set_metadata'
 require 'pio/open_flow13/set_source_mac_address'
 

data/lib/pio/options.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pio
   # User options utility.
   class Options
@@ -14,6 +16,11 @@ module Pio
       const_get(:OPTIONS) << name
     end
 
+    def initialize(options)
+      validate options
+      @options = options
+    end
+
     private
 
     def validate(user_options)
@@ -42,7 +49,7 @@ module Pio
     def check_unknown(user_options)
       valid_options = mandatory_options + options
       user_options.keys.each do |each|
-        fail "Unknown option: #{each}." unless valid_options.include?(each)
+        raise "Unknown option: #{each}." unless valid_options.include?(each)
       end
     end
 
@@ -54,10 +61,10 @@ module Pio
 
     def check_existence(user_options, key)
       value = user_options.fetch(key) do |missing_key|
-        fail ArgumentError, "The #{missing_key} option should be passed."
+        raise ArgumentError, "The #{missing_key} option should be passed."
       end
       return if value
-      fail(ArgumentError, "The #{key} option shouldn't be #{value.inspect}.")
+      raise(ArgumentError, "The #{key} option shouldn't be #{value.inspect}.")
     end
   end
 end

data/lib/pio/parse_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pio
   # Raised when the packet data is in wrong format.
   class ParseError < StandardError; end

data/lib/pio/parser.rb

@@ -1,27 +1,20 @@
+# frozen_string_literal: true
+
+require 'pio/ethernet_frame'
 require 'pio/ethernet_header'
 require 'pio/ipv4_header'
 
 module Pio
   # Raw data parser.
   class Parser
-    # Ethernet header parser
-    class EthernetFrame < BinData::Record
-      endian :big
-
-      mac_address :destination_mac
-      mac_address :source_mac
-      uint16 :ether_type
-      rest :rest
-    end
-
     # IPv4 packet parser
     class IPv4Packet < BinData::Record
-      include EthernetHeader
-      include IPv4Header
+      include Ethernet
+      include IPv4
 
       endian :big
 
-      ethernet_header ether_type: EtherType::IPV4
+      ethernet_header ether_type: Ethernet::Type::IPV4
       ipv4_header
 
       uint16 :transport_source_port
@@ -33,11 +26,11 @@ module Pio
     def self.read(raw_data)
       ethernet_frame = EthernetFrame.read(raw_data)
       case ethernet_frame.ether_type
-      when EthernetHeader::EtherType::IPV4, EthernetHeader::EtherType::VLAN
+      when Ethernet::Type::IPV4, Ethernet::Type::VLAN
         IPv4Packet.read raw_data
-      when EthernetHeader::EtherType::ARP
+      when Ethernet::Type::ARP
         Pio::Arp.read raw_data
-      when EthernetHeader::EtherType::LLDP
+      when Ethernet::Type::LLDP
         Pio::Lldp.read raw_data
       else
         ethernet_frame

data/lib/pio/payload.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pio
   # Get payload fields.
   module Payload

data/lib/pio/pcap.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bindata'
 
 module Pio

data/lib/pio/ruby_dumper.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: false
+
+module Pio
+  # defines to_ruby method
+  module RubyDumper
+    # Returns a Ruby code representation of this packet, such that
+    # it can be eval'ed and sent later.
+    #
+    # rubocop:disable AbcSize
+    # rubocop:disable MethodLength
+    # rubocop:disable CyclomaticComplexity
+    # rubocop:disable PerceivedComplexity
+    def to_ruby
+      pack_template = ''
+      bytes = ''
+      bit = false
+      bit_names = []
+      total_bit_length = 0
+      field_names.each do |each|
+        next unless __send__("#{each}?")
+        if /Bit(\d+)$/ =~ __send__(each).class.to_s
+          bit_length = Regexp.last_match(1).to_i
+          total_bit_length += bit_length
+          if bit
+            bit_names << each
+            bytes << format("_%0#{bit_length}b", __send__(each))
+          else
+            bit_names = [each]
+            bytes << format("  0b%0#{bit_length}b", __send__(each))
+          end
+          bit = true
+        else
+          if bit
+            bytes << ", # #{bit_names.join(', ')}\n"
+            if total_bit_length == 8
+              pack_template << 'C'
+            elsif total_bit_length == 16
+              pack_template << 'n'
+            else
+              raise
+            end
+            total_bit_length = 0
+            bit_names = []
+            bit = false
+          end
+          list = (@format || self).__send__(each).to_bytes
+          next if list.empty?
+          bytes << "  #{list}, # #{each}\n"
+          pack_template << 'C' * (list.count(',') + 1)
+        end
+      end.compact
+
+      template = ''
+      until pack_template.empty?
+        if /^(.)(\1+)/ =~ pack_template
+          pack_template.sub!(/^(.)(\1+)/, '')
+          template <<
+            "#{Regexp.last_match(1)}#{Regexp.last_match(2).length + 1}"
+        else
+          pack_template.sub!(/^(.)/, '')
+          template << Regexp.last_match(1)
+        end
+      end
+      "[\n#{bytes}].pack('#{template}')"
+    end
+    # rubocop:enable AbcSize
+    # rubocop:enable MethodLength
+    # rubocop:enable CyclomaticComplexity
+    # rubocop:enable PerceivedComplexity
+  end
+end

data/lib/pio/type/ether_type.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'bindata'
+
+module Pio
+  module Type
+    # Ether type
+    class EtherType < BinData::Primitive
+      endian :big
+
+      uint16 :ether_type
+
+      def set(value)
+        self.ether_type = value
+      end
+
+      def get
+        ether_type
+      end
+
+      # This method smells of :reek:UncommunicativeVariableName
+      def to_bytes
+        byte1 = format('%02x', (self & 0xff00) >> 8)
+        byte2 = format('%02x', self & 0xff)
+        "0x#{byte1}, 0x#{byte2}"
+      end
+
+      def inspect
+        Kernel.format '0x%04x', self
+      end
+    end
+  end
+end