pio 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ddcd50819881ef3e84f8efe948b846b346527afc
-  data.tar.gz: 8e66cab7abcc66b81908bc278fc4a0ac3b91519f
+  metadata.gz: 8b5745888688705d7d5a5cf305072b022821e9c2
+  data.tar.gz: 565161541fb6cf0090bce51b060478c455c3cc2b
 SHA512:
-  metadata.gz: f12db68f58ac7b90230f5fd4fb190ec0d939ad9c2895305393066b08e37d8ad5aa3604558f179fc5d29f8b5c25beb26faa4697b3ecfdb8cda2c856d718ba9cb6
-  data.tar.gz: 969ee297aa80eb58ad0e5f3a3aff999f49aea84eb2ef88db78058bc77aed050154faaa43eeb78530641bd336024efed1044589b8c8e7a12771c0d5be5bcd5b84
+  metadata.gz: 4af67cdf203efe01f2a6c6c1128adc142ca72015bbb2fb5d5d3448c1ea4700bb5eb30fb7ec5329ab3bef2f9bb0b0e678438825c75c6b31f0e0467b21966be9e6
+  data.tar.gz: 0b12f27bd5eed509ff5471cd4c0ea6d72b193fdfe9a645c979b5bf6b0910d290233988fb2fef0a9aa86dab0e7c9b0540d848ef1e638c8830ffc1ca7abc0dface

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.10.0 (1/6/2015)
+
+### New features
+* [#103](https://github.com/trema/pio/pull/103): Added new class `Pio::PacketOut`.
+
+
 ## 0.9.0 (12/22/2014)
 
 ### New features

data/README.md

@@ -22,6 +22,7 @@ supports the following packet formats:
     -   Echo
     -   Features
     -   Packet-In
+    -   Packet-Out
 -   (…currently there are just a few formats supported but I'm sure this list will grow)
 
 ## Features Overview
@@ -284,6 +285,41 @@ like below:
                 )
     packet_in.to_binary  # => Packet-In message in binary format.
 
+### Packet-Out
+
+To parse an OpenFlow 1.0 Packet-Out message, use the API
+`Pio::PacketOut.read` and you can access each field of the parsed
+Packet-Out message.
+
+    require 'pio'
+
+    packet_out = Pio::PacketOut.read(binary_data)
+    packet_out.actions.length # => 1
+    packet_out.actions[0] # => Pio::SendOutPort
+    packet_out.actions[0].port_number # => 2
+
+Also you can use `Pio::PacketOut#new` to generate a Packet-Out message
+like below:
+
+    require 'pio'
+
+    data_dump = [
+      0x01, 0x80, 0xc2, 0x00, 0x00, 0x0e, 0x01, 0x02, 0x03, 0x04,
+      0x05, 0x06, 0x88, 0xcc, 0x02, 0x09, 0x07, 0x00, 0x00, 0x00,
+      0x00, 0x00, 0x00, 0x01, 0x23, 0x04, 0x05, 0x07, 0x00, 0x00,
+      0x00, 0x0c, 0x06, 0x02, 0x00, 0x78, 0x00, 0x00, 0x00, 0x00,
+      0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+      0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+      0x00, 0x00, 0x00, 0x00
+    ].pack('C*')
+
+    packet_out = Pio::PacketOut.new(transaction_id: 0x16,
+                                    buffer_id: 0xffffffff,
+                                    in_port: 0xffff,
+                                    actions: Pio::SendOutPort.new(2),
+                                    data: data_dump)
+    packet_out.to_binary  # => Packet-Out message in binary format.
+
 ## Installation
 
 The simplest way to install Pio is to use [Bundler](http://gembundler.com/).

data/examples/packet_out_new.rb

@@ -0,0 +1,18 @@
+require 'pio'
+
+data_dump = [
+  0x01, 0x80, 0xc2, 0x00, 0x00, 0x0e, 0x01, 0x02, 0x03, 0x04,
+  0x05, 0x06, 0x88, 0xcc, 0x02, 0x09, 0x07, 0x00, 0x00, 0x00,
+  0x00, 0x00, 0x00, 0x01, 0x23, 0x04, 0x05, 0x07, 0x00, 0x00,
+  0x00, 0x0c, 0x06, 0x02, 0x00, 0x78, 0x00, 0x00, 0x00, 0x00,
+  0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+  0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+  0x00, 0x00, 0x00, 0x00
+].pack('C*')
+
+packet_out = Pio::PacketOut.new(transaction_id: 0x16,
+                                buffer_id: 0xffffffff,
+                                in_port: 0xffff,
+                                actions: Pio::SendOutPort.new(2),
+                                data: data_dump)
+packet_out.to_binary  # => Packet-Out message in binary format.

data/examples/packet_out_read.rb

@@ -0,0 +1,6 @@
+require 'pio'
+
+packet_out = Pio::PacketOut.read(binary_data)
+packet_out.actions.length # => 1
+packet_out.actions[0] # => Pio::SendOutPort
+packet_out.actions[0].port_number # => 2

data/features/packet_out_read.feature

@@ -0,0 +1,5 @@
+Feature: Pio::PacketOut.read
+  Scenario: packet_out.raw
+    Given a packet data file "packet_out.raw"
+    When I try to parse the file with "PacketOut" class
+    Then it should finish successfully

data/lib/pio.rb

@@ -9,3 +9,4 @@ require 'pio/icmp'
 require 'pio/lldp'
 require 'pio/mac'
 require 'pio/packet_in'
+require 'pio/packet_out'

data/lib/pio/echo.rb

@@ -1,15 +1,14 @@
-require 'pio/echo/format'
 require 'pio/echo/reply'
 require 'pio/echo/request'
-require 'pio/message_type_selector'
 require 'pio/open_flow'
+require 'pio/open_flow/parser'
 
 module Pio
-  # OpenFlow Echo Request and Reply message parser.
+  # OpenFlow 1.0 Echo Request and Reply message parser.
   class Echo
-    extend MessageTypeSelector
+    KLASS = { Pio::OpenFlow::Type::ECHO_REQUEST => Pio::Echo::Request,
+              Pio::OpenFlow::Type::ECHO_REPLY => Pio::Echo::Reply }
 
-    message_type Pio::OpenFlow::Type::ECHO_REQUEST => Request,
-                 Pio::OpenFlow::Type::ECHO_REPLY => Reply
+    extend Pio::OpenFlow::Parser
   end
 end

data/lib/pio/echo/message.rb

@@ -1,23 +1,49 @@
+require 'pio/open_flow'
+
 module Pio
   class Echo
     # Base class of Echo request and reply.
     class Message < Pio::OpenFlow::Message
-      # @reek This method smells of :reek:FeatureEnvy
-      # rubocop:disable Metrics/MethodLength
+      # Message body of Echo
+      class Body < BinData::Record
+        endian :big
+
+        string :body
+
+        def length
+          body.length
+        end
+
+        def empty?
+          length == 0
+        end
+
+        def ==(other)
+          body == other
+        end
+      end
+
+      # rubocop:disable MethodLength
+      # rubocop:disable AbcSize
+      # This method smells of :reek:FeatureEnvy
       def initialize(user_options = {})
-        options = if user_options.respond_to?(:to_i)
-                    { open_flow_header: { transaction_id: user_options.to_i } }
-                  elsif user_options.respond_to?(:fetch)
-                    transaction_id =
-                      user_options[:transaction_id] || user_options[:xid] || 0
-                    { open_flow_header: { transaction_id: transaction_id },
-                      body: user_options[:user_data] }
-                  else
-                    fail TypeError
-                  end
+        if user_options.respond_to?(:to_i)
+          options = { open_flow_header: { transaction_id: user_options.to_i } }
+        elsif user_options.respond_to?(:fetch)
+          header_options = { transaction_id: user_options[:transaction_id] ||
+                                             user_options[:xid] || 0 }
+          options = { open_flow_header: header_options,
+                      body: { body: user_options[:user_data] } }
+        else
+          fail TypeError
+        end
+        if options[:open_flow_header][:transaction_id] >= 2**32
+          fail ArgumentError, 'Transaction ID >= 2**32'
+        end
         @format = self.class.const_get(:Format).new(options)
       end
-      # rubocop:enable Metrics/MethodLength
+      # rubocop:enable AbcSize
+      # rubocop:enable MethodLength
     end
   end
 end

data/lib/pio/echo/reply.rb

@@ -1,5 +1,3 @@
-require 'forwardable'
-require 'pio/echo/format'
 require 'pio/echo/message'
 require 'pio/open_flow'
 
@@ -7,10 +5,7 @@ module Pio
   class Echo
     # OpenFlow 1.0 Echo Reply message generator.
     class Reply < Message
-      # OpenFlow 1.0 Echo reply message generator.
-      class Format < Pio::Echo::Format
-        default_parameters message_type_value: Pio::OpenFlow::Type::ECHO_REPLY
-      end
+      def_format Pio::OpenFlow::Type::ECHO_REPLY
 
       # Creates an EchoReply OpenFlow message. This message can be
       # used to measure the bandwidth of a controller/switch

data/lib/pio/echo/request.rb

@@ -1,4 +1,3 @@
-require 'pio/echo/format'
 require 'pio/echo/message'
 require 'pio/open_flow'
 
@@ -6,10 +5,7 @@ module Pio
   class Echo
     # OpenFlow 1.0 Echo Request message.
     class Request < Message
-      # OpenFlow 1.0 Echo request message generator.
-      class Format < Pio::Echo::Format
-        default_parameters message_type_value: Pio::OpenFlow::Type::ECHO_REQUEST
-      end
+      def_format Pio::OpenFlow::Type::ECHO_REQUEST
 
       # Creates an EchoRequest OpenFlow message. This message can be
       # used to measure the bandwidth of a controller/switch
@@ -40,6 +36,8 @@ module Pio
       #     timestamp to check latency, various lengths to measure
       #     bandwidth or zero-size(nil) to verify liveness between the
       #     switch and controller.
+      #
+      # rubocop:disable MethodLength
     end
   end
 end

data/lib/pio/enqueue.rb

@@ -0,0 +1,62 @@
+require 'bindata'
+require 'forwardable'
+require 'pio/monkey_patch/integer'
+require 'pio/open_flow'
+
+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 :type, value: 11
+      uint16 :message_length, value: 16
+      port_number :port_number
+      uint48 :padding
+      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, :type
+    def_delegators :@format, :message_length
+    def_delegators :@format, :port_number
+    def_delegators :@format, :queue_id
+    def_delegator :@format, :to_binary_s, :to_binary
+
+    def initialize(user_options)
+      validate_port_number user_options
+      validate_queue_id user_options
+      @format = Format.new(user_options)
+    end
+
+    private
+
+    def validate_port_number(user_options)
+      port_number = user_options.fetch(:port_number)
+      if port_number.is_a?(Symbol) && port_number != :in_port
+        fail(ArgumentError,
+             ':port_number must be a valid physical port or :in_port')
+      end
+    rescue KeyError
+      raise ArgumentError, ':port_number 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'
+      end
+    rescue KeyError
+      raise ArgumentError, ':queue_id is a mandatory option'
+    end
+  end
+end

data/lib/pio/features.rb

@@ -1,24 +1,14 @@
 require 'pio/features/reply'
 require 'pio/features/request'
 require 'pio/open_flow'
-require 'pio/parse_error'
+require 'pio/open_flow/parser'
 
 module Pio
-  # OpenFlow 1.0 Features messages
+  # OpenFlow 1.0 Features Request and Reply message parser.
   class Features
-    include Pio::OpenFlow::Type
+    KLASS = { Pio::OpenFlow::Type::FEATURES_REQUEST => Pio::Features::Request,
+              Pio::OpenFlow::Type::FEATURES_REPLY => Pio::Features::Reply }
 
-    # @reek This method smells of :reek:TooManyStatements
-    def self.read(raw_data)
-      header = Pio::Type::OpenFlow::OpenFlowHeader.read(raw_data)
-      klass = { FEATURES_REQUEST => Request,
-                FEATURES_REPLY => Reply }.fetch(header.message_type)
-      format = klass.const_get(:Format).read(raw_data)
-      message = klass.allocate
-      message.instance_variable_set :@format, format
-      message
-    rescue KeyError
-      raise Pio::ParseError, 'Invalid features request/reply message.'
-    end
+    extend Pio::OpenFlow::Parser
   end
 end

data/lib/pio/features/reply.rb

@@ -6,46 +6,36 @@ module Pio
   class Features
     # OpenFlow 1.0 Features Reply message
     class Reply < Pio::OpenFlow::Message
-      # enum ofp_capabilities
-      class Capabilities < BinData::Primitive
-        extend Flags
-
-        endian :big
-
-        flags :capabilities,
-              flow_stats: 1 << 0,
-              table_stats: 1 << 1,
-              port_stats: 1 << 2,
-              stp: 1 << 3,
-              reserved: 1 << 4,
-              ip_reasm: 1 << 5,
-              queue_stats: 1 << 6,
-              arp_match_ip: 1 << 7
-      end
-
-      # enum ofp_action_type
-      class Actions < BinData::Primitive
+      # Message body of features reply.
+      class Body < BinData::Record
         extend Flags
 
-        endian :big
-
-        flags :actions,
-              output: 1 << 0,
-              set_vlan_vid: 1 << 1,
-              set_vlan_pcp: 1 << 2,
-              strip_vlan: 1 << 3,
-              set_dl_src: 1 << 4,
-              set_dl_dst: 1 << 5,
-              set_nw_src: 1 << 6,
-              set_nw_dst: 1 << 7,
-              set_nw_tos: 1 << 8,
-              set_tp_src: 1 << 9,
-              set_tp_dst: 1 << 10,
-              enqueue: 1 << 11
-      end
+        # enum ofp_capabilities
+        def_flags :capabilities,
+                  [:flow_stats,
+                   :table_stats,
+                   :port_stats,
+                   :stp,
+                   :reserved,
+                   :ip_reasm,
+                   :queue_stats,
+                   :arp_match_ip]
+
+        # enum ofp_action_type
+        def_flags :actions,
+                  [:output,
+                   :set_vlan_vid,
+                   :set_vlan_pcp,
+                   :strip_vlan,
+                   :set_dl_src,
+                   :set_dl_dst,
+                   :set_nw_src,
+                   :set_nw_dst,
+                   :set_nw_tos,
+                   :set_tp_src,
+                   :set_tp_dst,
+                   :enqueue]
 
-      # Message body of features reply.
-      class Body < BinData::Record
         endian :big
 
         uint64 :datapath_id
@@ -66,17 +56,7 @@ module Pio
         end
       end
 
-      # OpenFlow 1.0 Features request message.
-      class Format < BinData::Record
-        include Pio::OpenFlow::Type
-
-        endian :big
-
-        open_flow_header :open_flow_header, message_type_value: FEATURES_REPLY
-        virtual assert: -> { open_flow_header.message_type == FEATURES_REPLY }
-
-        body :body
-      end
+      def_format Pio::OpenFlow::Type::FEATURES_REPLY
 
       def datapath_id
         @format.body.datapath_id

data/lib/pio/features/request.rb

@@ -6,20 +6,23 @@ module Pio
   class Features
     # OpenFlow 1.0 Features Request message
     class Request < Pio::OpenFlow::Message
-      # OpenFlow 1.0 Features Request format
-      class Format < BinData::Record
-        include Pio::OpenFlow::Type
-
+      # Message body of Features Request
+      class Body < BinData::Record
         endian :big
 
-        open_flow_header :open_flow_header, message_type_value: FEATURES_REQUEST
-        virtual assert: -> { open_flow_header.message_type == FEATURES_REQUEST }
+        string :body # ignored
+
+        def length
+          0
+        end
 
-        def body
-          ''
+        def empty?
+          true
         end
       end
 
+      def_format Pio::OpenFlow::Type::FEATURES_REQUEST
+
       # Creates a Features Request OpenFlow message.
       #
       # @overload initialize()