openflow-protocol 0.1.7 → 0.1.8

data/lib/messages/parser.rb

@@ -1,22 +0,0 @@
-require 'stringio'
-
-Dir[File.expand_path '*.rb', __dir__].each do |file|
-  require_relative file
-end
-
-class OFParser
-  def self.read(io)
-    io = StringIO.new(io) if io.is_a?(String)
-
-    header = io.readpartial(OFMessage::HEADER_LENGTH)
-
-    type       = OFMessage::TYPES[header[1].unpack('C')[0].to_i]
-    klass_name = 'OF' + type.to_s.split('_').map(&:capitalize).join
-    klass      = Object.const_get(klass_name)
-    length     = header[2..3].unpack('S>')[0].to_i
-
-    body = io.readpartial(length - OFMessage::HEADER_LENGTH)
-
-    klass.read(header + body)
-  end
-end

data/lib/messages/port_mod.rb

@@ -1,15 +0,0 @@
-require_relative 'message'
-
-class OFPortMod < OFMessage
-  of_port_number :port_number
-  mac_address :hardware_address
-  flags32 :config, list: OFPhysicalPort::CONFIG
-  flags32 :mask, list: OFPhysicalPort::CONFIG
-  flags32 :advertise, list: OFPhysicalPort::FEATURES
-  uint32 :padding
-  hide :padding
-
-  def body_length
-    24
-  end
-end

data/lib/messages/port_status.rb

@@ -1,14 +0,0 @@
-require_relative 'message'
-
-class OFPortStatus < OFMessage
-  REASONS = [:add, :delete, :modify]
-
-  enum8 :reason, list: REASONS
-  uint56 :padding
-  hide :padding
-  of_physical_port :desc
-
-  def body_length
-    56
-  end
-end

data/lib/messages/queue_get_config_reply.rb

@@ -1,14 +0,0 @@
-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

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

data/lib/messages/set_config.rb

@@ -1,3 +0,0 @@
-require_relative 'get_config_reply'
-
-class OFSetConfig < OFGetConfigReply; end

data/lib/messages/statistics.rb

@@ -1,24 +0,0 @@
-require_relative 'message'
-
-class OFStatistics < OFMessage
-  STATISTICS_TYPES = [
-    :description,
-    :flow,
-    :aggregate,
-    :table,
-    :port,
-    :queue
-  ]
-  STATISTICS_TYPES[0xffff] = :vendor
-
-  def flags_list
-    self.class.const_get(:FLAGS)
-  end
-
-  enum16 :statistic_type, list: STATISTICS_TYPES
-  flags16 :flags, list: -> { flags_list }
-
-  def body_length
-    4 + statistics.to_binary_s.length
-  end
-end

data/lib/messages/statistics/aggregate_statistics_reply.rb

@@ -1,10 +0,0 @@
-require 'bindata'
-
-class OFAggregateStatisticsReply < BinData::Record
-  endian :big
-  uint64 :packet_count, initial_value: 0
-  uint64 :byte_count, initial_value: 0
-  uint32 :flow_count, initial_value: 0
-  uint32 :padding
-  hide :padding
-end

data/lib/messages/statistics/aggregate_statistics_request.rb

@@ -1,3 +0,0 @@
-require_relative 'flow_statistics_request'
-
-class OFAggregateStatisticsRequest < OFFlowStatisticsRequest; end

data/lib/messages/statistics/description_statistics.rb

@@ -1,28 +0,0 @@
-require 'bindata'
-
-class OFDescriptionStatistics < BinData::Record
-  DESCRIPTION_LENGTH = 256
-  SERIAL_NUMBER_LENGTH = 32
-
-  endian :big
-  string :manufacturer_description,
-         length: DESCRIPTION_LENGTH,
-         trim_padding: true,
-         initial_value: ''
-  string :hardware_description,
-         length: DESCRIPTION_LENGTH,
-         trim_padding: true,
-         initial_value: ''
-  string :software_description,
-         length: DESCRIPTION_LENGTH,
-         trim_padding: true,
-         initial_value: ''
-  string :serial_number,
-         length: SERIAL_NUMBER_LENGTH,
-         trim_padding: true,
-         initial_value: ''
-  string :datapath_description,
-         length: DESCRIPTION_LENGTH,
-         trim_padding: true,
-         initial_value: ''
-end

data/lib/messages/statistics/flow_statistics_reply.rb

@@ -1,21 +0,0 @@
-require_relative 'table_statistics'
-
-class OFFlowStatisticsReply < BinData::Record
-  endian :big
-  uint16 :len, initial_value: -> { 88 + actions.to_binary_s.length }
-  enum8 :table_id, list: OFTableStatistics::TABLE_IDS, initial_value: -> { :all }
-  uint8 :padding
-  hide :padding
-  of_match :match
-  uint32 :duration_seconds, initial_value: 0
-  uint32 :duration_nanoseconds, initial_value: 0
-  uint16 :priority, initial_value: 0
-  uint16 :idle_timeout, initial_value: 0
-  uint16 :hard_timeout, initial_value: 0
-  uint48 :padding2
-  hide :padding2
-  uint64 :cookie, initial_value: 0
-  uint64 :packet_count, initial_value: 0
-  uint64 :byte_count, initial_value: 0
-  of_actions :actions, length: -> { len - actions.rel_offset }
-end

data/lib/messages/statistics/flow_statistics_request.rb

@@ -1,10 +0,0 @@
-require_relative 'table_statistics'
-
-class OFFlowStatisticsRequest < BinData::Record
-  endian :big
-  of_match :match
-  enum8 :table_id, list: OFTableStatistics::TABLE_IDS, initial_value: -> { :all }
-  uint8 :padding
-  hide :padding
-  of_port_number :out_port, initial_value: -> { :none }
-end

data/lib/messages/statistics/port_statistics_reply.rb

@@ -1,20 +0,0 @@
-require_relative '../../structs/port_number'
-
-class OFPortStatisticsReply < BinData::Record
-  endian :big
-  of_port_number :port_number, initial_value: 0
-  uint48 :padding
-  hide :padding
-  uint64 :receive_packets, initial_value: 0
-  uint64 :transmit_packets, initial_value: 0
-  uint64 :receive_bytes, initial_value: 0
-  uint64 :transmit_bytes, initial_value: 0
-  uint64 :receive_dropped, initial_value: 0
-  uint64 :transmit_dropped, initial_value: 0
-  uint64 :receive_errors, initial_value: 0
-  uint64 :transmit_errors, initial_value: 0
-  uint64 :receive_frame_errors, initial_value: 0
-  uint64 :receive_overrun_errors, initial_value: 0
-  uint64 :receive_crc_errors, initial_value: 0
-  uint64 :collisions, initial_value: 0
-end

data/lib/messages/statistics/port_statistics_request.rb

@@ -1,8 +0,0 @@
-require_relative '../../structs/port_number'
-
-class OFPortStatisticsRequest < BinData::Record
-  endian :big
-  of_port_number :port_number, initial_value: -> { :none } # all ports
-  uint48 :padding
-  hide :padding
-end

data/lib/messages/statistics/queue_statistics_reply.rb

@@ -1,12 +0,0 @@
-require_relative '../../structs/port_number'
-
-class OFQueueStatisticsReply < BinData::Record
-  endian :big
-  of_port_number :port_number, initial_value: 0
-  uint16 :padding
-  hide :padding
-  uint32 :queue_id, initial_value: 0
-  uint64 :transmit_bytes, initial_value: 0
-  uint64 :transmit_packets, initial_value: 0
-  uint64 :transmit_errors, initial_value: 0
-end

data/lib/messages/statistics/queue_statistics_request.rb

@@ -1,9 +0,0 @@
-require_relative '../../structs/port_number'
-
-class OFQueueStatisticsRequest < BinData::Record
-  endian :big
-  of_port_number :port_number, initial_value: -> { :all }
-  uint16 :padding
-  hide :padding
-  enum32 :queue_id, list: {all: 0xffffffff}, initial_value: -> { :all }
-end

data/lib/messages/statistics/table_statistics.rb

@@ -1,16 +0,0 @@
-require_relative '../../structs/match'
-
-class OFTableStatistics < BinData::Record
-  TABLE_IDS = {emergency: 0xfe, all: 0xff}
-
-  endian :big
-  enum8 :table_id, list: TABLE_IDS, initial_value: 0
-  uint24 :padding
-  hide :padding
-  string :name, length: 32, trim_padding: true, initial_value: ''
-  flags32 :wildcards, list: OFMatch::Wildcards::FLAGS
-  uint32 :max_entries, initial_value: 0
-  uint32 :active_count, initial_value: 0
-  uint64 :lookup_count, initial_value: 0
-  uint64 :matched_count, initial_value: 0
-end

data/lib/messages/statistics/vendor_statistics.rb

@@ -1,7 +0,0 @@
-require 'bindata'
-
-class OFVendorStatistics < BinData::Record
-  endian :big
-  uint32 :vendor, initial_value: 0
-  rest :body
-end

data/lib/messages/statistics_reply.rb

@@ -1,22 +0,0 @@
-require_relative 'statistics'
-
-class OFStatisticsReply < OFStatistics
-  FLAGS = [:reply_more]
-
-  choice :statistics, selection: -> { statistic_type.to_s } do
-    of_description_statistics 'description'
-    of_flow_statistics_reply 'flow'
-    of_aggregate_statistics_reply 'aggregate'
-    array 'table',
-      type: :of_table_statistics,
-      initial_length: -> { (len - statistics.rel_offset) / 64 }
-    array 'port',
-      type: :of_port_statistics_reply,
-      initial_length: -> { (len - statistics.rel_offset) / 104 }
-    array 'queue',
-      type: :of_queue_statistics_reply,
-      initial_length: -> { (len - statistics.rel_offset) / 32 }
-    of_vendor_statistics 'vendor'
-    rest :default
-  end
-end

data/lib/messages/statistics_request.rb

@@ -1,14 +0,0 @@
-require_relative 'statistics'
-
-class OFStatisticsRequest < OFStatistics
-  FLAGS = []
-
-  choice :statistics, selection: -> { statistic_type.to_s } do
-    of_flow_statistics_request 'flow'
-    of_aggregate_statistics_request 'aggregate'
-    of_port_statistics_request 'port'
-    of_queue_statistics_request 'queue'
-    of_vendor_statistics 'vendor'
-    rest :default
-  end
-end

data/lib/messages/vendor.rb

@@ -1,10 +0,0 @@
-require_relative 'message'
-
-class OFVendor < OFMessage
-  uint32 :vendor, initial_value: 0
-  rest :data
-
-  def body_length
-    4 + data.length
-  end
-end

data/lib/structs/match.rb

@@ -1,102 +0,0 @@
-require 'English'
-require 'bindata-contrib'
-require_relative 'port_number'
-
-class OFMatch < BinData::Record
-  class Wildcards < BinData::Primitive
-    FLAGS = {
-      in_port:            1 <<  0,
-      vlan_id:            1 <<  1,
-      mac_source:         1 <<  2,
-      mac_destination:    1 <<  3,
-      mac_protocol:       1 <<  4,
-      ip_protocol:        1 <<  5,
-      source_port:        1 <<  6,
-      destination_port:   1 <<  7,
-      ip_source0:         1 <<  8,
-      ip_source1:         1 <<  9,
-      ip_source2:         1 << 10,
-      ip_source3:         1 << 11,
-      ip_source4:         1 << 12,
-      ip_source_all:      1 << 13,
-      ip_destination0:    1 << 14,
-      ip_destination1:    1 << 15,
-      ip_destination2:    1 << 16,
-      ip_destination3:    1 << 17,
-      ip_destination4:    1 << 18,
-      ip_destination_all: 1 << 19,
-      vlan_pcp:           1 << 20,
-      ip_tos:             1 << 21
-    }
-    ALL_FLAGS = Hash[
-      FLAGS.keys.select { |key| /^ip_(source|destination)\d$/ !~ key }
-        .map { |key| [key, true] }
-    ]
-
-    endian :big
-    uint32 :flags, initial_value: 0x003820ff # all
-
-    def get
-      FLAGS.each_with_object(Hash.new(0)) do |(key, bit), memo|
-        next if flags & bit == 0
-        if /^(ip_source|ip_destination)(\d)/ =~ key
-          memo[$LAST_MATCH_INFO[1].to_sym] |= 1 << $LAST_MATCH_INFO[2].to_i
-        else
-          memo[key] = true
-        end
-      end
-    end
-
-    def set(value)
-      value = Hash[value.map { |v| [v, true] }] if value.is_a?(Array)
-      self.flags = value.inject(0) do |memo, (key, val)|
-        memo |
-          case key
-          when :ip_source, :ip_destination
-            (val & 31) << (key == :ip_source ? 8 : 14)
-          else
-            val ? FLAGS.fetch(key) : 0
-          end
-      end
-    end
-  end
-
-  def self.create(options = {})
-    unless options[:wildcards]
-      options[:wildcards] = {}
-      %i(in_port vlan_id mac_source mac_destination mac_protocol ip_protocol source_port destination_port ip_source ip_destination vlan_pcp ip_tos).each do |flag|
-        wild_flag = flag
-        wild_flag = "#{flag}_all".to_sym if %i(ip_source ip_destination).include? flag
-        options[:wildcards][wild_flag] = true unless options[flag]
-      end
-    end
-    self.new options
-  end
-
-  endian :big
-  wildcards :wildcards
-  of_port_number :in_port, initial_value: 0
-  mac_address :mac_source
-  mac_address :mac_destination
-  uint16 :vlan_id, initial_value: 0xffff
-  uint8 :vlan_pcp, initial_value: 0
-  uint8 :padding
-  hide :padding
-  enum16 :mac_protocol, list: {
-    ipv4: 0x0800,
-    arp: 0x0806,
-    vlan: 0x8100
-  }, initial_value: 0
-  uint8 :ip_tos, initial_value: 0
-  enum8 :ip_protocol, list: {
-    icmp: 1,
-    tcp: 6,
-    udp: 17
-  }, initial_value: 0
-  uint16 :padding2
-  hide :padding2
-  ipv4_address :ip_source
-  ipv4_address :ip_destination
-  uint16 :source_port, initial_value: 0
-  uint16 :destination_port, initial_value: 0
-end

data/lib/structs/packet_queue.rb

@@ -1,10 +0,0 @@
-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/physical_port.rb

@@ -1,46 +0,0 @@
-require 'bindata-contrib'
-require_relative 'port_number'
-
-class OFPhysicalPort < BinData::Record
-  CONFIG = [
-    :port_down,
-    :no_spanning_tree,
-    :no_receive,
-    :no_receive_spanning_tree,
-    :no_flood,
-    :no_forward,
-    :no_packet_in
-  ]
-  STATE = {
-    link_down:             1 << 0,
-    spanning_tree_listen:  0 << 8,
-    spanning_tree_learn:   1 << 8,
-    spanning_tree_forward: 2 << 8,
-    spanning_tree_block:   3 << 8
-  }
-  FEATURES = [
-    :port_10mb_half_duplex,
-    :port_10mb_full_duplex,
-    :port_100mb_half_duplex,
-    :port_100mb_full_duplex,
-    :port_1gb_half_duplex,
-    :port_1gb_full_duplex,
-    :port_10gb_full_duplex,
-    :port_copper,
-    :port_fiber,
-    :port_auto_negotiation,
-    :port_pause,
-    :port_pause_asymmetric
-  ]
-
-  endian :big
-  of_port_number :port_number, initial_value: 0
-  mac_address :hardware_address
-  string :name, length: 16, trim_padding: true, initial_value: ''
-  flags32 :config, list: CONFIG
-  flags32 :state, list: STATE
-  flags32 :current_features, list: FEATURES
-  flags32 :advertised_features, list: FEATURES
-  flags32 :supported_features, list: FEATURES
-  flags32 :peer_features, list: FEATURES
-end