openflow-protocol 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0efcfc19372c5ff81c76eef6c74912c9ddfccaf
-  data.tar.gz: 02a45e643b2ea6c53f877dfac8cffcdc680c1711
+  metadata.gz: b787a021c7be6ba96d78b7f71f9d93676c709bd7
+  data.tar.gz: 80ea8bef3b0e8fbd6783d8fdb35fb278032c9d0e
 SHA512:
-  metadata.gz: 77b3a36050c5e976899c07f2a9a8ff4917f8b8e4c5cbce3070ea02b262990f9ba67b2324095edba3b83e160fdcb4bfa7c0c6d171abc0d8cff852f4accbacc1cb
-  data.tar.gz: de3deb39ea4a6e6ca09c0fd3a5eeca3769ab1c62d97945990cca0131f6c9db2c0f27eca5f98da8678f2f78bc4f75a1331077a259c50c6f53a09719f33f89168d
+  metadata.gz: 842cbdc2c9b75e80d1dbb53d853fa6c578bbc8ec05d3db6bb8450fd7be2017fb8586c1ba435410b717979e6fe95171fb8d776677c9b9a8c4a59e65e4f79ec0dc
+  data.tar.gz: b1139123757191b1c60e00866e8543c423e324f70f49ea23e4ee8ee02fbc2ed72b13c1ae891255e6487e4c9c8cf8137028235956fed6baaf3f8dd76a5c44e47d

data/lib/actions/actions.rb

@@ -2,27 +2,4 @@ Dir[File.expand_path 'action_*.rb', __dir__].each do |file|
   require file
 end
 
-class OFActions < BinData::Primitive
-  default_parameter length: 0
-  endian :big
-  string :binary, read_length: :length
-
-  def get
-    actions = []
-    tmp = binary
-    until tmp.empty?
-      type_index = BinData::Uint16be.read(tmp)
-      type_str = OFAction::TYPES.fetch(type_index)
-      class_name = 'OFAction' + type_str.to_s.split('_').map(&:capitalize).join
-      klass = Object.const_get class_name
-      action = klass.read(tmp)
-      actions << action
-      tmp = tmp[action.len..-1]
-    end
-    actions
-  end
-
-  def set(value)
-    self.binary = value.map(&:to_binary_s).join
-  end
-end
+class OFActions < ArrayOfSubclasses; end

data/lib/helpers/array_of_subclasses.rb

@@ -0,0 +1,38 @@
+require 'bindata'
+
+class ArrayOfSubclasses < BinData::Primitive
+  default_parameter length: 0
+  endian :big
+  string :binary, read_length: :length
+
+  def get
+    items = []
+    tmp = binary
+    until tmp.empty?
+      type_index = BinData::Uint16be.read(tmp)
+      type_str = types.fetch(type_index)
+      class_name = name + type_str.to_s.split('_').map(&:capitalize).join
+      klass = Object.const_get class_name
+      item = klass.read(tmp)
+      items << item
+      tmp = tmp[item.len..-1]
+    end
+    items
+  end
+
+  def set(value)
+    self.binary = value.map(&:to_binary_s).join
+  end
+
+  private
+
+  def name
+    plural = self.class.to_s
+    return plural[0..-4] + 'y' if plural[-3..-1] == 'ies'
+    plural[0..-2]
+  end
+
+  def types
+    Object.const_get(name + '::TYPES')
+  end
+end

data/lib/helpers/superclass_base.rb

@@ -10,6 +10,8 @@ class SuperclassBase < BinData::Record
     super
     if self.class.name[2..7] == 'Action'
       name = self.class.name[8..-1]
+    elsif self.class.name[2..14] == 'QueueProperty'
+      name = self.class.name[15..-1]
     else
       name = self.class.name[2..-1]
     end

data/lib/messages/features_reply.rb

@@ -31,8 +31,8 @@ class OFFeaturesReply < OFMessage
     :enqueue
   ]
   array :ports,
-        type: :of_physical_port,
-        initial_length: -> { (len - ports.rel_offset) / 48 }
+    type: :of_physical_port,
+    initial_length: -> { (len - ports.rel_offset) / 48 }
 
   def body_length
     24 + ports.to_binary_s.length

data/lib/messages/message.rb

@@ -1,7 +1,7 @@
 (Dir[File.expand_path '../helpers/**/*.rb', __dir__] +
  Dir[File.expand_path '../structs/**/*.rb', __dir__] +
  Dir[File.expand_path '../actions/**/*.rb', __dir__] +
- Dir[File.expand_path '../statistics/**/*.rb', __dir__]).each do |file|
+ Dir[File.expand_path 'statistics/**/*.rb', __dir__]).each do |file|
   require file
 end
 

data/lib/messages/port_mod.rb

@@ -6,6 +6,8 @@ class OFPortMod < OFMessage
   flags32 :config, list: OFPhysicalPort::CONFIG
   flags32 :mask, list: OFPhysicalPort::CONFIG
   flags32 :advertise, list: OFPhysicalPort::FEATURES
+  uint32 :padding
+  hide :padding
 
   def body_length
     24

data/lib/messages/queue_get_config_reply.rb

@@ -0,0 +1,14 @@
+require_relative 'message'
+
+class OFQueueGetConfigReply < OFMessage
+  of_port_number_strict :port
+  uint48 :padding
+  hide :padding
+  array :queues,
+    type: :of_packet_queue,
+    read_until: :eof
+
+  def body_length
+    8 + queues.to_binary_s.length
+  end
+end

data/lib/messages/queue_get_config_request.rb

@@ -0,0 +1,11 @@
+require_relative 'message'
+
+class OFQueueGetConfigRequest < OFMessage
+  of_port_number_strict :port
+  uint16 :padding
+  hide :padding
+
+  def body_length
+    4
+  end
+end

data/lib/{statistics → messages/statistics}/port_statistics_reply.rb

@@ -1,4 +1,4 @@
-require_relative '../structs/port_number'
+require_relative '../../structs/port_number'
 
 class OFPortStatisticsReply < BinData::Record
   endian :big

data/lib/{statistics → messages/statistics}/port_statistics_request.rb

@@ -1,4 +1,4 @@
-require_relative '../structs/port_number'
+require_relative '../../structs/port_number'
 
 class OFPortStatisticsRequest < BinData::Record
   endian :big

data/lib/{statistics → messages/statistics}/queue_statistics_reply.rb

@@ -1,4 +1,4 @@
-require_relative '../structs/port_number'
+require_relative '../../structs/port_number'
 
 class OFQueueStatisticsReply < BinData::Record
   endian :big

data/lib/{statistics → messages/statistics}/queue_statistics_request.rb

@@ -1,4 +1,4 @@
-require_relative '../structs/port_number'
+require_relative '../../structs/port_number'
 
 class OFQueueStatisticsRequest < BinData::Record
   endian :big

data/lib/{statistics → messages/statistics}/table_statistics.rb

@@ -1,4 +1,4 @@
-require_relative '../structs/match'
+require_relative '../../structs/match'
 
 class OFTableStatistics < BinData::Record
   TABLE_IDS = {emergency: 0xfe, all: 0xff}

data/lib/openflow-protocol/version.rb

@@ -1,5 +1,5 @@
 module OpenFlow
   module Protocol
-    VERSION = '0.1.6'
+    VERSION = '0.1.7'
   end
 end

data/lib/structs/packet_queue.rb

@@ -0,0 +1,10 @@
+require_relative 'queue_properties/queue_properties'
+
+class OFPacketQueue < BinData::Record
+  endian :big
+  uint32 :queue_id, initial_value: 0
+  uint16 :len, value: -> { 8 + properties.to_binary_s.length }
+  uint16 :padding
+  hide :padding
+  of_queue_properties :properties, length: -> { len - 8 }
+end

data/lib/structs/port_number.rb

@@ -1,5 +1,19 @@
 require 'bindata'
 
+class OFPortNumberStrict < BinData::Primitive
+  endian :big
+  uint16 :port_number, initial_value: 0
+
+  def get
+    port_number
+  end
+
+  def set(value)
+    raise ArgumentError, 'Invalid port number.' unless (0..OFPortNumber::MAX).include? value
+    self.port_number = value
+  end
+end
+
 class OFPortNumber < BinData::Primitive
   NUMBERS = {
     in_port: 0xfff8,

data/lib/structs/queue_properties/queue_properties.rb

@@ -0,0 +1,5 @@
+Dir[File.expand_path 'queue_property_*.rb', __dir__].each do |file|
+  require file
+end
+
+class OFQueueProperties < ArrayOfSubclasses; end

data/lib/structs/queue_properties/queue_property.rb

@@ -0,0 +1,16 @@
+Dir[File.expand_path '../../helpers/**/*.rb', __dir__].each do |file|
+  require file
+end
+
+class OFQueueProperty < SuperclassBase
+  HEADER_LENGTH = 8
+  TYPES = [
+    :none,
+    :min_rate
+  ]
+
+  enum16 :type, list: TYPES, asserted_value: -> { type_str.to_sym }
+  uint16 :len, value: -> { HEADER_LENGTH + body_length }
+  uint32 :padding
+  hide :padding
+end

data/lib/structs/queue_properties/queue_property_min_rate.rb

@@ -0,0 +1,26 @@
+require_relative 'queue_property'
+
+class OFQueuePropertyMinRate < OFQueueProperty
+  class Rate < BinData::Primitive
+    endian :big
+    uint16 :rate, initial_value: 0
+
+    def get
+      return :disabled if rate > 1000
+      rate
+    end
+
+    def set(value)
+      value = 0xffff if value == :disabled
+      self.rate = value
+    end
+  end
+
+  rate :rate
+  uint48 :padding2
+  hide :padding2
+
+  def body_length
+    8
+  end
+end

data/lib/structs/queue_properties/queue_property_none.rb

@@ -0,0 +1,3 @@
+require_relative 'queue_property'
+
+class OFQueuePropertyNone < OFQueueProperty; end

data/spec/actions/actions_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe OFActionOutput do
+describe OFActions do
   it 'should read binary' do
     actions = OFActions.read [
       # output

data/spec/messages/barrier_reply_spec.rb

@@ -1,13 +1,19 @@
 require 'spec_helper'
 
 describe OFBarrierReply do
+  let(:data) { [1, 19, 0, 8, 0, 0, 0, 1].pack('C*') }
+
   it 'should read binary' do
-    msg = OFBarrierReply.read [1, 19, 0, 8, 0, 0, 0, 1].pack('C*')
+    msg = OFBarrierReply.read(data)
     expect(msg.version).to eq(OFMessage::OFP_VERSION)
     expect(msg.type).to eq(:barrier_reply)
     expect(msg.len).to eq(8)
     expect(msg.xid).to eq(1)
   end
+  it 'should be parsable' do
+    msg = OFParser.read(data)
+    expect(msg.class).to eq(OFBarrierReply)
+  end
   it 'should initialize with default values' do
     msg = OFBarrierReply.new
     expect(msg.version).to eq(OFMessage::OFP_VERSION)

data/spec/messages/barrier_request_spec.rb

@@ -1,13 +1,19 @@
 require 'spec_helper'
 
 describe OFBarrierRequest do
+  let(:data) { [1, 18, 0, 8, 0, 0, 0, 1].pack('C*') }
+
   it 'should read binary' do
-    msg = OFBarrierRequest.read [1, 18, 0, 8, 0, 0, 0, 1].pack('C*')
+    msg = OFBarrierRequest.read(data)
     expect(msg.version).to eq(OFMessage::OFP_VERSION)
     expect(msg.type).to eq(:barrier_request)
     expect(msg.len).to eq(8)
     expect(msg.xid).to eq(1)
   end
+  it 'should be parsable' do
+    msg = OFParser.read(data)
+    expect(msg.class).to eq(OFBarrierRequest)
+  end
   it 'should initialize with default values' do
     msg = OFBarrierRequest.new
     expect(msg.version).to eq(OFMessage::OFP_VERSION)

data/spec/messages/echo_reply_spec.rb

@@ -1,14 +1,20 @@
 require 'spec_helper'
 
 describe OFEchoReply do
+  let(:data) { [1, 3, 0, 8, 0, 0, 0, 1].pack('C*') }
+
   it 'should read binary' do
-    msg = OFEchoReply.read [1, 3, 0, 8, 0, 0, 0, 1].pack('C*')
+    msg = OFEchoReply.read(data)
     expect(msg.version).to eq(OFMessage::OFP_VERSION)
     expect(msg.type).to eq(:echo_reply)
     expect(msg.len).to eq(8)
     expect(msg.xid).to eq(1)
     expect(msg.data).to be_empty
   end
+  it 'should be parsable' do
+    msg = OFParser.read(data)
+    expect(msg.class).to eq(OFEchoReply)
+  end
   it 'should read binary with data' do
     msg = OFEchoReply.read [1, 3, 0, 10, 0, 0, 0, 1, 10, 20].pack('C*')
     expect(msg.version).to eq(OFMessage::OFP_VERSION)

data/spec/messages/echo_request_spec.rb

@@ -1,14 +1,20 @@
 require 'spec_helper'
 
 describe OFEchoRequest do
+  let(:data) { [1, 2, 0, 8, 0, 0, 0, 1].pack('C*') }
+
   it 'should read binary' do
-    msg = OFEchoRequest.read [1, 2, 0, 8, 0, 0, 0, 1].pack('C*')
+    msg = OFEchoRequest.read(data)
     expect(msg.version).to eq(OFMessage::OFP_VERSION)
     expect(msg.type).to eq(:echo_request)
     expect(msg.len).to eq(8)
     expect(msg.xid).to eq(1)
     expect(msg.data).to be_empty
   end
+  it 'should be parsable' do
+    msg = OFParser.read(data)
+    expect(msg.class).to eq(OFEchoRequest)
+  end
   it 'should read binary with data' do
     msg = OFEchoRequest.read [1, 2, 0, 10, 0, 0, 0, 1, 10, 20].pack('C*')
     expect(msg.version).to eq(OFMessage::OFP_VERSION)

data/spec/messages/error_spec.rb

@@ -1,13 +1,17 @@
 require 'spec_helper'
 
 describe OFError do
-  it 'should read binary' do
-    msg = OFError.read [
+  let(:data) {
+    [
       1, 1, 0, 16, 0, 0, 0, 1, # header
       0, 0,                    # type
       0, 0,                    # code
       1, 2, 3, 4               # data
     ].pack('C*')
+  }
+
+  it 'should read binary' do
+    msg = OFError.read(data)
     expect(msg.version).to eq(OFMessage::OFP_VERSION)
     expect(msg.type).to eq(:error)
     expect(msg.len).to eq(16)
@@ -16,6 +20,10 @@ describe OFError do
     expect(msg.error_code).to eq(:incompatible)
     expect(msg.data).to eq([1, 2, 3, 4].pack('C*'))
   end
+  it 'should be parsable' do
+    msg = OFParser.read(data)
+    expect(msg.class).to eq(OFError)
+  end
   it 'should read binary' do
     msg = OFError.read [
       1, 1, 0, 12, 0, 0, 0, 1, # header

data/spec/messages/features_reply_spec.rb

@@ -1,8 +1,8 @@
 require 'spec_helper'
 
 describe OFFeaturesReply do
-  it 'should read binary' do
-    msg = OFFeaturesReply.read [
+  let(:data) {
+    [
       1, 6, 0, 128, 0, 0, 0, 1, # header
       0, 0, 0, 0, 0, 0, 0, 42,  # datapath_id
       0, 0, 0, 10,              # n_buffers
@@ -37,43 +37,9 @@ describe OFFeaturesReply do
       0, 0, 0x0f, 0xff,   # supported_features
       0, 0, 0x0f, 0xff    # peer_features
     ].pack('C*')
-    expect(msg.version).to eq(OFMessage::OFP_VERSION)
-    expect(msg.type).to eq(:features_reply)
-    expect(msg.len).to eq(128)
-    expect(msg.xid).to eq(1)
-    expect(msg.datapath_id).to eq(42)
-    expect(msg.n_buffers).to eq(10)
-    expect(msg.n_tables).to eq(5)
-    expect(msg.capabilities).to eq([
-      :flow_stats,
-      :table_stats,
-      :port_stats,
-      :stp,
-      :reserved,
-      :ip_reasm,
-      :queue_stats,
-      :arp_match_ip
-    ])
-    expect(msg.actions).to eq([
-      :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
-    ])
-    expect(msg.ports.length).to eq(2)
-    expect(msg.ports[0].port_number).to eq(1)
-    expect(msg.ports[1].port_number).to eq(2)
-  end
-  it 'should read a real binary message' do
-    msg = OFFeaturesReply.read [
+  }
+  let(:real_data) {
+    [
       1, 6, 0, 176, 0, 0, 0, 0,
       0, 0, 0, 0, 0, 0, 0, 1,
       0, 0, 1, 0,
@@ -121,6 +87,51 @@ describe OFFeaturesReply do
       0, 0, 0, 0,
       0, 0, 0, 0
     ].pack('C*')
+  }
+
+  it 'should read binary' do
+    msg = OFFeaturesReply.read(data)
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:features_reply)
+    expect(msg.len).to eq(128)
+    expect(msg.xid).to eq(1)
+    expect(msg.datapath_id).to eq(42)
+    expect(msg.n_buffers).to eq(10)
+    expect(msg.n_tables).to eq(5)
+    expect(msg.capabilities).to eq([
+      :flow_stats,
+      :table_stats,
+      :port_stats,
+      :stp,
+      :reserved,
+      :ip_reasm,
+      :queue_stats,
+      :arp_match_ip
+    ])
+    expect(msg.actions).to eq([
+      :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
+    ])
+    expect(msg.ports.length).to eq(2)
+    expect(msg.ports[0].port_number).to eq(1)
+    expect(msg.ports[1].port_number).to eq(2)
+  end
+  it 'should be parsable' do
+    msg = OFParser.read(data)
+    expect(msg.class).to eq(OFFeaturesReply)
+  end
+  it 'should read a real binary message' do
+    msg = OFFeaturesReply.read(real_data)
     expect(msg.ports.length).to eq(3)
   end
   it 'should initialize with default values' do