pio 0.23.1 → 0.24.0

data/lib/pio/open_flow10/packet_in.rb

@@ -1,4 +1,3 @@
-require 'bindata'
 require 'pio/ethernet_header'
 require 'pio/ipv4_header'
 require 'pio/open_flow'
@@ -7,67 +6,74 @@ require 'pio/parser'
 
 # Base module.
 module Pio
-  # OpenFlow 1.0 Packet-In message
-  class PacketIn
-    # Why is this packet being sent to the controller?
-    # (enum ofp_packet_in_reason)
-    class Reason < BinData::Primitive
-      REASONS = { no_match: 0, action: 1 }
+  module OpenFlow10
+    # OpenFlow 1.0 Packet-In message
+    class PacketIn < OpenFlow::Message
+      # Why is this packet being sent to the controller?
+      # (enum ofp_packet_in_reason)
+      class Reason < BinData::Primitive
+        REASONS = { no_match: 0, action: 1 }
 
-      uint8 :reason
+        uint8 :reason
 
-      def get
-        REASONS.invert.fetch(reason)
-      end
+        def get
+          REASONS.invert.fetch(reason)
+        end
 
-      def set(value)
-        self.reason = REASONS.fetch(value)
+        def set(value)
+          self.reason = REASONS.fetch(value)
+        end
       end
-    end
 
-    # Message body of Packet-In.
-    class Body < BinData::Record
-      endian :big
+      # Message body of Packet-In.
+      class Body < BinData::Record
+        endian :big
 
-      uint32 :buffer_id
-      uint16 :total_len, value: -> { raw_data.length }
-      uint16 :in_port
-      reason :reason
-      uint8 :padding
-      hide :padding
-      string :raw_data, read_length: :total_len
+        uint32 :buffer_id
+        uint16 :total_len, value: -> { raw_data.length }
+        uint16 :in_port
+        reason :reason
+        uint8 :padding
+        hide :padding
+        string :raw_data, read_length: :total_len
 
-      def empty?
-        false
-      end
+        def data
+          @data ||= Pio::Parser.read(raw_data)
+        end
 
-      def length
-        10 + raw_data.length
-      end
-    end
-  end
+        def empty?
+          false
+        end
 
-  OpenFlow::Message.factory(PacketIn, OpenFlow::PACKET_IN) do
-    def_delegators :body, :buffer_id
-    def_delegators :body, :total_len
-    def_delegators :body, :in_port
-    def_delegators :body, :reason
-    def_delegators :body, :raw_data
+        def length
+          10 + raw_data.length
+        end
 
-    attr_accessor :datapath_id
-    alias_method :dpid, :datapath_id
-    alias_method :dpid=, :datapath_id=
+        def lldp?
+          data.is_a? Lldp
+        end
 
-    def data
-      @data ||= Pio::Parser.read(raw_data)
-    end
+        def method_missing(method, *args)
+          data.__send__(method, *args).snapshot
+        end
+      end
 
-    def lldp?
-      data.is_a? Lldp
-    end
+      # OpenFlow 1.0 Flow Mod message format.
+      class Format < BinData::Record
+        extend OpenFlow::Format
+
+        header version: 1, message_type: 10
+        body :body
+      end
+
+      attr_accessor :datapath_id
+      alias_method :dpid, :datapath_id
+      alias_method :dpid=, :datapath_id=
 
-    def method_missing(method, *args)
-      data.__send__(method, *args).snapshot
+      body_option :buffer_id
+      body_option :in_port
+      body_option :reason
+      body_option :raw_data
     end
   end
 end

data/lib/pio/open_flow10/packet_out.rb

@@ -1,35 +1,42 @@
-require 'bindata'
 require 'pio/open_flow'
+require 'pio/open_flow10/actions'
 
 # Base module.
 module Pio
-  # OpenFlow 1.0 Packet-Out message
-  class PacketOut
-    # Message body of Packet-Out
-    class Body < BinData::Record
-      endian :big
+  module OpenFlow10
+    # OpenFlow 1.0 Packet-Out message
+    class PacketOut < OpenFlow::Message
+      # OpenFlow 1.0 Flow Mod message format.
+      class Format < BinData::Record
+        # Message body of Packet-Out
+        class Body < BinData::Record
+          endian :big
 
-      uint32 :buffer_id
-      uint16 :in_port
-      uint16 :actions_len, initial_value: -> { actions.binary.length }
-      actions :actions, length: -> { actions_len }
-      rest :raw_data
+          uint32 :buffer_id
+          uint16 :in_port
+          uint16 :actions_len, initial_value: -> { actions.binary.length }
+          actions :actions, length: -> { actions_len }
+          rest :raw_data
 
-      def empty?
-        false
-      end
+          def empty?
+            false
+          end
+
+          def length
+            8 + actions_len + raw_data.length
+          end
+        end
+
+        extend OpenFlow::Format
 
-      def length
-        8 + actions_len + raw_data.length
+        header version: 1, message_type: 13
+        body :body
       end
-    end
-  end
 
-  OpenFlow::Message.factory(PacketOut, OpenFlow::PACKET_OUT) do
-    def_delegators :body, :buffer_id
-    def_delegators :body, :in_port
-    def_delegators :body, :actions_len
-    def_delegators :body, :actions
-    def_delegators :body, :raw_data
+      body_option :buffer_id
+      body_option :in_port
+      body_option :actions
+      body_option :raw_data
+    end
   end
 end

data/lib/pio/open_flow10/port_status.rb

@@ -2,43 +2,70 @@ require 'pio/open_flow'
 
 # Base module.
 module Pio
-  # OpenFlow 1.0 Port Status message
-  class PortStatus
-    # What changed about the physical port
-    class Reason < BinData::Primitive
-      REASONS = { add: 0, delete: 1, modify: 2 }
+  # OpenFlow 1.0 messages
+  module OpenFlow10
+    # OpenFlow 1.0 Port Status message
+    class PortStatus < OpenFlow::Message
+      # What changed about the physical port
+      class Reason < BinData::Primitive
+        REASONS = { add: 0, delete: 1, modify: 2 }
 
-      uint8 :reason
+        uint8 :reason
 
-      def get
-        REASONS.invert.fetch(reason)
+        def get
+          REASONS.invert.fetch(reason)
+        end
+
+        def set(value)
+          self.reason = REASONS.fetch(value)
+        end
       end
 
-      def set(value)
-        self.reason = REASONS.fetch(value)
+      # Message body of Port Status
+      class Body < BinData::Record
+        endian :big
+
+        reason :reason
+        uint56 :padding
+        hide :padding
+        phy_port :desc
       end
-    end
 
-    # Message body of Port Status
-    class Body < BinData::Record
-      endian :big
+      # OpenFlow 1.0 Flow Mod message format.
+      class Format < BinData::Record
+        extend OpenFlow::Format
 
-      reason :reason
-      uint56 :padding
-      hide :padding
-      phy_port :desc
-    end
-  end
+        header version: 1, message_type: 12
+        body :body
 
-  OpenFlow::Message.factory(PortStatus, OpenFlow::PORT_STATUS) do
-    def_delegators :body, :reason
+        def reason
+          body.reason.to_sym
+        end
+      end
+
+      attr_writer :datapath_id
 
-    attr_writer :datapath_id
+      def desc
+        @desc ||= @format.body.desc.snapshot
+        @desc.instance_variable_set :@datapath_id, @datapath_id
+        @desc
+      end
 
-    def desc
-      @desc ||= @format.body.desc.snapshot
-      @desc.instance_variable_set :@datapath_id, @datapath_id
-      @desc
+      # rubocop:disable MethodLength
+      def initialize(user_options = {})
+        header_options = parse_header_options(user_options)
+        body_options = if user_options.respond_to?(:fetch)
+                         user_options.delete :transaction_id
+                         user_options.delete :xid
+                         dpid = user_options[:dpid]
+                         user_options[:datapath_id] = dpid if dpid
+                         user_options
+                       else
+                         ''
+                       end
+        @format = Format.new(header: header_options, body: body_options)
+      end
+      # rubocop:enable MethodLength
     end
   end
 end

data/lib/pio/open_flow10/send_out_port.rb

@@ -4,77 +4,79 @@ require 'pio/monkey_patch/integer'
 require 'pio/open_flow/port_number'
 
 module Pio
-  # An action to output a packet to a port.
-  class SendOutPort
-    # OpenFlow 1.0 OFPAT_OUTPUT action format.
-    class Format < BinData::Record
-      endian :big
+  module OpenFlow10
+    # An action to output a packet to a port.
+    class SendOutPort
+      # OpenFlow 1.0 OFPAT_OUTPUT action format.
+      class Format < BinData::Record
+        endian :big
 
-      uint16 :type, value: 0
-      uint16 :message_length, value: 8
-      port_number :port_number
-      uint16 :max_len, initial_value: 2**16 - 1
-    end
+        uint16 :type, value: 0
+        uint16 :message_length, value: 8
+        port_number :port_number
+        uint16 :max_len, initial_value: 2**16 - 1
+      end
 
-    def self.read(raw_data)
-      send_out_port = allocate
-      send_out_port.instance_variable_set :@format, Format.read(raw_data)
-      send_out_port
-    end
+      def self.read(raw_data)
+        send_out_port = allocate
+        send_out_port.instance_variable_set :@format, Format.read(raw_data)
+        send_out_port
+      end
 
-    extend Forwardable
+      extend Forwardable
 
-    def_delegators :@format, :message_length
-    def_delegators :@format, :port_number
-    def_delegators :@format, :max_len
-    def_delegator :@format, :to_binary_s, :to_binary
+      def_delegators :@format, :message_length
+      def_delegators :@format, :port_number
+      def_delegators :@format, :max_len
+      def_delegator :@format, :to_binary_s, :to_binary
 
-    # Creates an action to output a packet to a port.
-    #
-    # @example
-    #   SendOutPort.new(1)
-    #   SendOutPort.new(port_number: 1)
-    #   SendOutPort.new(port_number: :controller, max_len: 256)
-    #
-    # @param [Integer|Hash] user_options
-    #   the port number or the options hash to create this action
-    #   class instance with.
-    #
-    # @option user_options [Number] :port_number
-    #   port number an index into switch's physical port list. There
-    #   are also fake output ports. For example a port number set to
-    #   +:flood+ would output packets to all physical ports except
-    #   input port and ports disabled by STP.
-    # @option user_options [Number] :max_len
-    #   the maximum number of bytes from a packet to send to
-    #   controller when port is set to +:controller+. A zero length
-    #   means no bytes of the packet should be sent. It defaults to
-    #   64K.
-    #
-    # @raise [ArgumentError] if +:port_number+ is not an unsigned
-    #                        16-bit integer.
-    # @raise [ArgumentError] if +:max_len+ is not an unsigned 16-bit integer.
-    #
-    # rubocop:disable MethodLength
-    def initialize(user_options)
-      options = if user_options.respond_to?(:to_i)
-                  { port_number: user_options.to_i }
-                elsif PortNumber::NUMBERS.key?(user_options)
-                  { port_number: user_options }
-                else
-                  user_options
-                end
-      max_len = options[:max_len]
-      if max_len && !max_len.unsigned_16bit?
-        fail ArgumentError, 'The max_len should be an unsigned 16bit integer.'
+      # Creates an action to output a packet to a port.
+      #
+      # @example
+      #   SendOutPort.new(1)
+      #   SendOutPort.new(port_number: 1)
+      #   SendOutPort.new(port_number: :controller, max_len: 256)
+      #
+      # @param [Integer|Hash] user_options
+      #   the port number or the options hash to create this action
+      #   class instance with.
+      #
+      # @option user_options [Number] :port_number
+      #   port number an index into switch's physical port list. There
+      #   are also fake output ports. For example a port number set to
+      #   +:flood+ would output packets to all physical ports except
+      #   input port and ports disabled by STP.
+      # @option user_options [Number] :max_len
+      #   the maximum number of bytes from a packet to send to
+      #   controller when port is set to +:controller+. A zero length
+      #   means no bytes of the packet should be sent. It defaults to
+      #   64K.
+      #
+      # @raise [ArgumentError] if +:port_number+ is not an unsigned
+      #                        16-bit integer.
+      # @raise [ArgumentError] if +:max_len+ is not an unsigned 16-bit integer.
+      #
+      # rubocop:disable MethodLength
+      def initialize(user_options)
+        options = if user_options.respond_to?(:to_i)
+                    { port_number: user_options.to_i }
+                  elsif PortNumber::NUMBERS.key?(user_options)
+                    { port_number: user_options }
+                  else
+                    user_options
+                  end
+        max_len = options[:max_len]
+        if max_len && !max_len.unsigned_16bit?
+          fail ArgumentError, 'The max_len should be an unsigned 16bit integer.'
+        end
+        @format = Format.new(options)
       end
-      @format = Format.new(options)
-    end
-    # rubocop:enable MethodLength
+      # rubocop:enable MethodLength
 
-    def ==(other)
-      return false unless other
-      to_binary == other.to_binary
+      def ==(other)
+        return false unless other
+        to_binary == other.to_binary
+      end
     end
   end
 end

data/lib/pio/open_flow13.rb

@@ -1,11 +1,3 @@
-module Pio
-  # OpenFlow specific types.
-  module OpenFlow
-    remove_const :VERSION
-    VERSION = 4
-  end
-end
-
 require 'pio/open_flow13/apply'
 require 'pio/open_flow13/echo'
 require 'pio/open_flow13/features_reply'
@@ -13,15 +5,8 @@ require 'pio/open_flow13/features_request'
 require 'pio/open_flow13/flow_mod'
 require 'pio/open_flow13/goto_table'
 require 'pio/open_flow13/hello'
-require 'pio/open_flow13/match'
 require 'pio/open_flow13/meter'
 require 'pio/open_flow13/packet_in'
 require 'pio/open_flow13/packet_out'
 require 'pio/open_flow13/send_out_port'
 require 'pio/open_flow13/write_metadata'
-
-# Base module.
-module Pio
-  remove_const :Match
-  Match = OpenFlow13::Match
-end