pio 0.30.0 → 0.30.2

data/lib/pio/open_flow/flags.rb

@@ -1,19 +1,25 @@
+# frozen_string_literal: true
+
 module Pio
   module OpenFlow
     # bitmap functions.
     # This class smells of :reek:DataClump
     module Flags
+      def define_flags_32bit(name, flags)
+        _define_flags name, 32, flags
+      end
+
       def flags_32bit(name, flags)
-        _def_flags name, 32, flags
+        _flags name, 32, flags
       end
 
       def flags_16bit(name, flags)
-        _def_flags name, 16, flags
+        _flags name, 16, flags
       end
 
       # rubocop:disable MethodLength
       # This method smells of :reek:TooManyStatements
-      def _def_flags(name, size, flags)
+      def _define_flags(name, size, flags)
         flag_value = case flags
                      when Array
                        shift = 0
@@ -29,7 +35,7 @@ module Pio
         klass_name = name.to_s.split('_').map(&:capitalize).join
         flags_hash = flag_value.inspect
 
-        code = %{
+        module_eval <<-end_eval, __FILE__, __LINE__
           class #{klass_name} < BinData::Primitive
             endian :big
 
@@ -53,8 +59,13 @@ module Pio
                              v.map { |each| list[each] }.inject(:|)
             end
           end
-        }
-        module_eval code
+        end_eval
+      end
+      # rubocop:enable MethodLength
+
+      def _flags(name, size, flags_)
+        _define_flags name, size, flags_
+        module_eval "#{name} :#{name}", __FILE__, __LINE__
       end
     end
   end

data/lib/pio/open_flow/flow_match.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'active_support/descendants_tracker'
+
+module Pio
+  module OpenFlow
+    # Flow match
+    class FlowMatch
+      extend ActiveSupport::DescendantsTracker
+    end
+  end
+end

data/lib/pio/open_flow/header.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'bindata'
+require 'pio/monkey_patch/uint'
+require 'pio/open_flow/transaction_id'
+require 'pio/open_flow/version'
+
+module Pio
+  module OpenFlow
+    # OpenFlow message header parser
+    class Header < BinData::Record
+      endian :big
+
+      version :version
+      uint8 :type
+      uint16 :message_length
+      transaction_id :transaction_id
+      rest :body
+
+      def to_bytes
+        [version,
+         type,
+         message_length,
+         transaction_id].map(&:to_bytes).join(', ')
+      end
+    end
+  end
+end

data/lib/pio/open_flow/hello_failed_code.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require 'bindata'
 
 module Pio
   module OpenFlow
     # enum ofp_hello_failed_code
     class HelloFailedCode < BinData::Primitive
-      ERROR_CODES = { incompatible: 0, permissions_error: 1 }
+      ERROR_CODES = { incompatible: 0, permissions_error: 1 }.freeze
 
       endian :big
       uint16 :error_code

data/lib/pio/open_flow/instruction.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'active_support/descendants_tracker'
+
+module Pio
+  module OpenFlow
+    # Flow instruction
+    class Instruction
+      extend ActiveSupport::DescendantsTracker
+    end
+  end
+end

data/lib/pio/open_flow/message.rb

@@ -1,15 +1,21 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/module/attribute_accessors'
+require 'active_support/descendants_tracker'
 require 'bindata'
+require 'pio/open_flow/flags'
+require 'pio/open_flow/header'
 require 'pio/parse_error'
-require 'pio/open_flow/open_flow_header'
+require 'pio/ruby_dumper'
 
 module Pio
   module OpenFlow
     # OpenFlow messages.
     class Message
-      def self.inherited(child_klass)
-        child_klass.const_set :Format, Class.new(BinData::Record)
-        child_klass.class_variable_set(:@@valid_options, [])
-      end
+      attr_reader :format
+
+      extend ActiveSupport::DescendantsTracker
+      extend OpenFlow::Flags
 
       def self.read(raw_data)
         allocate.tap do |message|
@@ -21,31 +27,62 @@ module Pio
         raise Pio::ParseError, "Invalid #{message_name} message."
       end
 
+      # rubocop:disable MethodLength
+      # rubocop:disable AbcSize
       def self.method_missing(method, *args, &block)
-        const_get(:Format).__send__ method, *args, &block
+        begin
+          const_get(:Format).__send__ method, *args, &block
+        rescue NameError
+          klass = Class.new(BinData::Record)
+          const_set :Format, klass
+          klass.class_eval do
+            include RubyDumper
+            define_method(:header_length) { 8 }
+            define_method(:length) { _length }
+          end
+          class_variable_set(:@@valid_options, [])
+          retry
+        end
 
         return if method == :endian || method == :virtual
+
         define_method(args.first) do
-          @format.__send__ args.first
+          snapshot = @format.snapshot.__send__(args.first)
+          if snapshot.class == BinData::Struct::Snapshot
+            @format.__send__(args.first)
+          else
+            snapshot
+          end
         end
         class_variable_set(:@@valid_options,
                            class_variable_get(:@@valid_options) + [args.first])
       end
+      # rubocop:enable MethodLength
+      # rubocop:enable AbcSize
 
       # rubocop:disable AbcSize
       # rubocop:disable MethodLength
       def self.open_flow_header(opts)
         module_eval do
+          cattr_reader(:type) { opts.fetch(:type) }
+
           endian :big
 
-          uint8 :ofp_version, value: opts.fetch(:version)
-          virtual assert: -> { ofp_version == opts.fetch(:version) }
-          uint8 :message_type, value: opts.fetch(:message_type)
-          virtual assert: -> { message_type == opts.fetch(:message_type) }
-          uint16 :message_length,
-                 initial_value: opts[:message_length] || -> { 8 + body.length }
+          uint8 :version, value: opts.fetch(:version)
+          uint8 :type, value: opts.fetch(:type)
+          uint16(:_length,
+                 initial_value: opts[:length] || lambda do
+                   begin
+                     8 + body.length
+                   rescue
+                     8
+                   end
+                 end)
           transaction_id :transaction_id, initial_value: 0
 
+          virtual assert: -> { version == opts.fetch(:version) }
+          virtual assert: -> { type == opts.fetch(:type) }
+
           alias_method :xid, :transaction_id
         end
       end
@@ -71,7 +108,7 @@ module Pio
         unknown_options =
           user_options.keys - self.class.class_variable_get(:@@valid_options)
         return if unknown_options.empty?
-        fail "Unknown option: #{unknown_options.first}"
+        raise "Unknown option: #{unknown_options.first}"
       end
 
       def parse_options(user_options)

data/lib/pio/open_flow/nicira_action.rb

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

data/lib/pio/open_flow/nicira_resubmit.rb

@@ -1,18 +1,22 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow/nicira_action'
-require 'pio/open_flow10/port16'
 
 module Pio
-  # 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
+  module OpenFlow
+    # NXAST_RESUBMIT action
+    class NiciraResubmit < OpenFlow::NiciraAction
+      nicira_action_header action_type: 0xffff,
+                           action_length: 16,
+                           subtype: 1
+      uint16 :in_port
+      string :padding, length: 4
+      hide :padding
 
-    def initialize(port_number)
-      super(in_port: port_number)
+      def initialize(port_number)
+        super(in_port: port_number)
+      end
     end
   end
+  NiciraResubmit = OpenFlow::NiciraResubmit
 end

data/lib/pio/open_flow/nicira_resubmit_table.rb

@@ -1,15 +1,24 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow/nicira_action'
-require 'pio/open_flow10/port16'
 
 module Pio
-  # 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
+  module OpenFlow
+    # NXAST_RESUBMIT_TABLE action
+    class NiciraResubmitTable < OpenFlow::NiciraAction
+      nicira_action_header action_type: 0xffff,
+                           action_length: 16,
+                           subtype: 14
+      uint16 :in_port
+      uint8 :table, initial_value: 0xff
+      string :padding, length: 3
+      hide :padding
+
+      def initialize(options)
+        raise ':in_port option is a mandatory' unless options.key?(:in_port)
+        super options
+      end
+    end
   end
+  NiciraResubmitTable = OpenFlow::NiciraResubmitTable
 end

data/lib/pio/open_flow/parser.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'pio/open_flow10'
+require 'pio/open_flow13'
+
+module Pio
+  module OpenFlow
+    # Collection class of OpenFlow message parser class
+    class Parser
+      def self.find_by_type!(type)
+        message_class = [Hello, Error, Echo::Request, Echo::Reply,
+                         Features::Request, Features::Reply, PacketIn,
+                         PacketOut, FlowMod, PortStatus, Stats::Request,
+                         Stats::Reply, Barrier::Request, Barrier::Reply]
+        message_class.each_with_object({}) do |each, hash|
+          hash[each.type] = each
+        end.fetch(type)
+      end
+    end
+  end
+end

data/lib/pio/open_flow/port.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pio
   module OpenFlow
     # Port numbering.
@@ -57,9 +59,9 @@ module Pio
           self.port = reserved_port_number(port)
         else
           port_num = port.to_i
-          fail ArgumentError, 'The port should be > 0' if port_num < 1
+          raise ArgumentError, 'The port should be > 0' if port_num < 1
           if port_num >= max
-            fail ArgumentError, "The port should be < #{max.to_hex}"
+            raise ArgumentError, "The port should be < #{max.to_hex}"
           end
           self.port = port_num
         end

data/lib/pio/open_flow/transaction_id.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bindata'
 require 'pio/monkey_patch/integer'
 
@@ -11,8 +13,8 @@ module Pio
 
       def set(value)
         unless value.unsigned_32bit?
-          fail(ArgumentError,
-               'Transaction ID should be an unsigned 32-bit integer.')
+          raise(ArgumentError,
+                'Transaction ID should be an unsigned 32-bit integer.')
         end
         self.xid = value
       end

data/lib/pio/open_flow/version.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Pio
+  module OpenFlow
+    # OpenFlow version
+    class Version < BinData::Primitive
+      VERSIONS = { 1 => :OpenFlow10, 4 => :OpenFlow13 }.freeze
+
+      uint8 :version
+
+      def get
+        VERSIONS.fetch(version)
+      end
+
+      def set(value)
+        self.version = VERSIONS.invert.fetch(value)
+      end
+
+      def to_bytes
+        version.to_hex
+      end
+    end
+  end
+end

data/lib/pio/open_flow.rb

@@ -1,67 +1,55 @@
-require 'pio/open_flow/datapath_id'
-require 'pio/open_flow/error'
-require 'pio/open_flow/flags'
-require 'pio/open_flow/message'
-require 'pio/open_flow/open_flow_header'
-require 'pio/open_flow10'
-require 'pio/open_flow13'
+# frozen_string_literal: true
+
+require 'active_support/core_ext/array/access'
+require 'active_support/core_ext/module/attribute_accessors'
+require 'active_support/core_ext/module/introspection'
+require 'pio/open_flow/header'
+require 'pio/open_flow/parser'
 
 module Pio
   # Common OpenFlow modules/classes.
   module OpenFlow
-    def self.version
-      fail unless @version
-      @version
-    end
+    mattr_reader :version, instance_reader: false
 
-    def self.switch_version(version)
-      [:Barrier, :Echo, :Features, :FlowMod, :Hello, :Match,
-       :PacketIn, :FlowRemoved, :PacketOut, :SendOutPort,
-       :SetSourceMacAddress, :SetDestinationMacAddress, :PortStatus, :Stats,
-       :FlowStats, :DescriptionStats, :AggregateStats, :TableStats, :PortStats,
-       :QueueStats, :Error, :SetArpOperation, :SetArpSenderProtocolAddress,
-       :SetArpSenderHardwareAddress, :NiciraRegMove, :SetMetadata,
-       :NiciraRegLoad, :NiciraSendOutPort].each do |each|
-        set_message_class_name each, version
-        @version = version.to_s
+    def self.version=(version)
+      return if OpenFlow.version == version.to_sym
+      find_all_class_by_version(version).each do |each|
+        alias_open_flow_class each
       end
+      @@version = version.to_sym # rubocop:disable ClassVars
+    rescue NameError
+      raise "#{version} is not supported yet."
     end
 
-    # rubocop:disable MethodLength
     def self.read(binary)
-      parser = {
-        0 => Pio::Hello,
-        1 => Pio::OpenFlow::Error,
-        2 => Pio::Echo::Request,
-        3 => Pio::Echo::Reply,
-        5 => Pio::Features::Request,
-        6 => Pio::Features::Reply,
-        10 => Pio::PacketIn,
-        11 => Pio::FlowRemoved,
-        12 => Pio::PortStatus,
-        13 => Pio::PacketOut,
-        14 => Pio::FlowMod,
-        16 => Pio::Stats::Request,
-        17 => Pio::Stats::Reply,
-        18 => Pio::Barrier::Request,
-        19 => Pio::Barrier::Reply
-      }
-      header = OpenFlowHeaderParser.read(binary)
-      parser.fetch(header.message_type).read(binary)
+      header = OpenFlow::Header.read(binary)
+      self.version = header.version
+      Parser.find_by_type!(header.type).read(binary)
     end
-    # rubocop:enable MethodLength
 
-    def self.set_message_class_name(klass_name, version)
-      open_flow_module = Pio.const_get(version)
-      return unless open_flow_module.const_defined?(klass_name)
-      Pio.__send__ :remove_const, klass_name if Pio.const_defined?(klass_name)
-      Pio.const_set(klass_name, open_flow_module.const_get(klass_name))
-    rescue NameError
-      raise "#{version} is not supported yet."
+    def self.find_all_class_by_version(version)
+      all_class = [Message, Instruction, Action, FlowMatch].
+                  inject([]) do |result, each|
+        result + each.descendants
+      end
+      all_class.select do |each|
+        each.parents.include?(Class.const_get("Pio::#{version}"))
+      end
     end
-    private_class_method :set_message_class_name
+    private_class_method :find_all_class_by_version
 
-    # The default OpenFlow version is 1.0
-    switch_version 'OpenFlow10'
+    # Pio::OpenFlow10::Hello -> Pio::Hello
+    def self.alias_open_flow_class(klass)
+      version = klass.name.split('::').second
+      class_name = klass.name.split('::').third
+      if Pio.const_defined?(class_name)
+        Pio.module_eval { remove_const class_name }
+      end
+      Pio.const_set(class_name, "Pio::#{version}::#{class_name}".constantize)
+    end
+    private_class_method :alias_open_flow_class
   end
 end
+
+# The default OpenFlow version is 1.0
+Pio::OpenFlow.version = :OpenFlow10

data/lib/pio/open_flow10/actions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bindata'
 require 'pio/open_flow10/enqueue'
 require 'pio/open_flow10/send_out_port'
@@ -15,22 +17,22 @@ require 'pio/open_flow10/vendor_action'
 module Pio
   module OpenFlow
     # Actions list.
-    class Actions < BinData::Primitive
+    class Actions10 < BinData::Primitive
       ACTION_CLASS = {
-        0 => Pio::OpenFlow10::SendOutPort,
-        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
-      }
+        0 => OpenFlow10::SendOutPort,
+        1 => OpenFlow10::SetVlanVid,
+        2 => OpenFlow10::SetVlanPriority,
+        3 => OpenFlow10::StripVlanHeader,
+        4 => OpenFlow10::SetSourceMacAddress,
+        5 => OpenFlow10::SetDestinationMacAddress,
+        6 => OpenFlow10::SetSourceIpAddress,
+        7 => OpenFlow10::SetDestinationIpAddress,
+        8 => OpenFlow10::SetTos,
+        9 => OpenFlow10::SetTransportSourcePort,
+        10 => OpenFlow10::SetTransportDestinationPort,
+        11 => OpenFlow10::Enqueue,
+        0xffff => OpenFlow10::VendorAction
+      }.freeze
 
       mandatory_parameter :length
 
@@ -47,7 +49,7 @@ module Pio
       def get
         actions = []
         tmp = binary
-        while tmp.length > 0
+        until tmp.empty?
           type = BinData::Uint16be.read(tmp)
           begin
             action = ACTION_CLASS.fetch(type).read(tmp)

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+require 'pio/open_flow/message'
 require 'pio/open_flow10/stats_type'
 
 module Pio
@@ -6,7 +9,7 @@ module Pio
     module AggregateStats
       # Aggregate Stats Reply message
       class Reply < OpenFlow::Message
-        open_flow_header version: 1, message_type: 17, message_length: 32
+        open_flow_header version: 1, type: 17, length: 32
         stats_type :stats_type, value: -> { :aggregate }
         uint16 :flags
         uint64 :packet_count

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow/message'
 require 'pio/open_flow10/match10'
 require 'pio/open_flow10/port16'
@@ -9,9 +11,7 @@ module Pio
     module AggregateStats
       # OpenFlow 1.0 Aggregate Stats Request message
       class Request < OpenFlow::Message
-        open_flow_header version: 1,
-                         message_type: 16,
-                         message_length: 56
+        open_flow_header version: 1, type: 16, length: 56
         stats_type :stats_type, value: -> { :aggregate }
         uint16 :flags
         match10 :match

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow/message'
 
 module Pio
@@ -6,7 +8,7 @@ module Pio
     module Barrier
       # OpenFlow 1.0 Barrier Request message
       class Reply < OpenFlow::Message
-        open_flow_header version: 1, message_type: 19
+        open_flow_header version: 1, type: 19
         string :body, value: ''
       end
     end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow/message'
 
 module Pio
@@ -6,7 +8,7 @@ module Pio
     module Barrier
       # OpenFlow 1.0 Barrier Request message
       class Request < OpenFlow::Message
-        open_flow_header version: 1, message_type: 18
+        open_flow_header version: 1, type: 18
         string :body, value: ''
       end
     end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow10/stats_type'
 
 module Pio
@@ -6,7 +8,7 @@ module Pio
     module DescriptionStats
       # OpenFlow 1.0 Description Stats Reply message
       class Reply < OpenFlow::Message
-        open_flow_header version: 1, message_type: 17, message_length: 1068
+        open_flow_header version: 1, type: 17, length: 1068
         stats_type :stats_type, value: -> { :description }
         uint16 :flags
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow10/stats_type'
 require 'pio/open_flow/message'
 
@@ -7,9 +9,7 @@ module Pio
     module DescriptionStats
       # OpenFlow 1.0 Description Stats Request message
       class Request < OpenFlow::Message
-        open_flow_header version: 1,
-                         message_type: 16,
-                         message_length: 12
+        open_flow_header version: 1, type: 16, length: 12
         stats_type :stats_type, value: -> { :description }
         uint16 :flags
         string :body, value: ''

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow/message'
 
 module Pio
@@ -6,10 +8,10 @@ module Pio
     module Echo
       # OpenFlow 1.0 Echo Reply message.
       class Reply < OpenFlow::Message
-        open_flow_header version: 1, message_type: 3
-        string :body, read_length: -> { message_length - 8 }
+        open_flow_header version: 1, type: 3
+        string :body, read_length: -> { length - header_length }
 
-        alias_method :user_data, :body
+        alias user_data body
       end
     end
   end