openflow-protocol 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1fc576ecfced9806622867b9ec63625e0547bd50
+  data.tar.gz: ed90aa37d49475ab047c38ae85863ba1f3b8d850
+SHA512:
+  metadata.gz: 679d1d48ba8ee8f06b36d03a2bc0b626b38f8d203c22bdcadc38c34964171011c734427caab89e71d3dfdeaa63d75cda72cfa623b2b22a9ec418183664d7b97c
+  data.tar.gz: 942c5502894b36f8de79c5b5866d129e25587657dbf6102337616dc242534e78432199323ad5df1249ff56c0aea28dba7489a8f7039e77847cb49c91ce069fc2

data/lib/actions/action.rb

@@ -0,0 +1,26 @@
+(Dir[File.expand_path '../helpers/**/*.rb', __dir__] +
+ Dir[File.expand_path '../structs/**/*.rb', __dir__]).each do |file|
+  require file
+end
+
+class OFAction < SuperclassBase
+  HEADER_LENGTH = 4
+  TYPES = [
+    :output,
+    :set_vlan_id,
+    :set_vlan_pcp,
+    :strip_vlan,
+    :set_mac_source,       # set_dl_src
+    :set_mac_destination,  # set_dl_dst
+    :set_ip_source,        # set_nw_src
+    :set_ip_destination,   # set_nw_dst
+    :set_ip_tos,           # set_nw_tos
+    :set_source_port,      # set_tp_src
+    :set_destination_port, # set_tp_dst
+    :enqueue
+  ]
+  TYPES[0xffff] = :vendor
+
+  enum16 :type, list: TYPES, asserted_value: -> { type_str.to_sym }
+  uint16 :len, value: -> { HEADER_LENGTH + body_length }
+end

data/lib/actions/action_enqueue.rb

@@ -0,0 +1,12 @@
+require_relative 'action'
+
+class OFActionEnqueue < OFAction
+  of_port_number :port
+  uint48 :padding
+  hide :padding
+  uint32 :queue_id, initial_value: 0
+
+  def body_length
+    12
+  end
+end

data/lib/actions/action_output.rb

@@ -0,0 +1,10 @@
+require_relative 'action'
+
+class OFActionOutput < OFAction
+  of_port_number :port
+  uint16 :max_length, initial_value: 0xffff
+
+  def body_length
+    4
+  end
+end

data/lib/actions/action_set_destination_port.rb

@@ -0,0 +1,3 @@
+require_relative 'action_set_source_port'
+
+class OFActionSetDestinationPort < OFActionSetSourcePort; end

data/lib/actions/action_set_ip_destination.rb

@@ -0,0 +1,3 @@
+require_relative 'action_set_ip_source'
+
+class OFActionSetIpDestination < OFActionSetIpSource; end

data/lib/actions/action_set_ip_source.rb

@@ -0,0 +1,9 @@
+require_relative 'action'
+
+class OFActionSetIpSource < OFAction
+  ip_address :ip_address
+
+  def body_length
+    4
+  end
+end

data/lib/actions/action_set_ip_tos.rb

@@ -0,0 +1,11 @@
+require_relative 'action'
+
+class OFActionSetIpTos < OFAction
+  uint8 :tos
+  uint24 :padding
+  hide :padding
+
+  def body_length
+    4
+  end
+end

data/lib/actions/action_set_mac_destination.rb

@@ -0,0 +1,3 @@
+require_relative 'action_set_mac_source'
+
+class OFActionSetMacDestination < OFActionSetMacSource; end

data/lib/actions/action_set_mac_source.rb

@@ -0,0 +1,11 @@
+require_relative 'action'
+
+class OFActionSetMacSource < OFAction
+  mac_address :mac_address
+  uint48 :padding
+  hide :padding
+
+  def body_length
+    12
+  end
+end

data/lib/actions/action_set_source_port.rb

@@ -0,0 +1,11 @@
+require_relative 'action'
+
+class OFActionSetSourcePort < OFAction
+  uint16 :port, initial_value: 0
+  uint16 :padding
+  hide :padding
+
+  def body_length
+    4
+  end
+end

data/lib/actions/action_set_vlan_id.rb

@@ -0,0 +1,11 @@
+require_relative 'action'
+
+class OFActionSetVlanId < OFAction
+  uint16 :vlan_id, initial_value: 0
+  uint16 :padding
+  hide :padding
+
+  def body_length
+    4
+  end
+end

data/lib/actions/action_set_vlan_pcp.rb

@@ -0,0 +1,11 @@
+require_relative 'action'
+
+class OFActionSetVlanPcp < OFAction
+  uint8 :vlan_pcp, initial_value: 0
+  uint24 :padding
+  hide :padding
+
+  def body_length
+    4
+  end
+end

data/lib/actions/action_strip_vlan.rb

@@ -0,0 +1,10 @@
+require_relative 'action'
+
+class OFActionStripVlan < OFAction
+  uint32 :padding
+  hide :padding
+
+  def body_length
+    4
+  end
+end

data/lib/actions/action_vendor.rb

@@ -0,0 +1,9 @@
+require_relative 'action'
+
+class OFActionVendor < OFAction
+  uint32 :vendor, initial_value: 0
+
+  def body_length
+    4
+  end
+end

data/lib/actions/actions.rb

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

data/lib/helpers/enum.rb

@@ -0,0 +1,45 @@
+require 'bindata'
+
+def _def_enum(size)
+  eval %(
+    class Enum#{size} < BinData::Primitive
+      mandatory_parameter :list
+
+      endian :big
+      uint#{size} :enum, initial_value: 0
+
+      def get
+        list.invert.fetch(enum)
+      rescue KeyError
+        enum
+      end
+
+      def set(value)
+        self.enum = list.fetch(value)
+      rescue KeyError
+        self.enum = value
+      end
+
+      private
+
+      def list
+        list = eval_parameter(:list)
+        case list
+        when Array
+          shift = 0
+          list.each_with_object({}) do |each, result|
+            result[each] = shift
+            shift += 1
+            result
+          end
+        when Hash
+          list
+        end
+      end
+    end
+  )
+end
+
+_def_enum 8
+_def_enum 16
+_def_enum 32

data/lib/helpers/flags.rb

@@ -0,0 +1,49 @@
+require 'bindata'
+
+def _def_flags(size)
+  eval %(
+    class Flags#{size} < BinData::Primitive
+      mandatory_parameter :list
+
+      endian :big
+      uint#{size} :flags, initial_value: 0
+
+      def get
+        list.each_with_object([]) do |(key, value), result|
+          result << key if (flags & value != 0) || (flags == value)
+          result
+        end
+      end
+
+      def set(value)
+        value.each do |each|
+          fail "Invalid flag: \#{value}" unless list.keys.include?(each)
+        end
+        self.flags = value.empty? ?
+                     0 :
+                     value.map { |each| list[each] }.inject(:|)
+      end
+
+      private
+
+      def list
+        list = eval_parameter(:list)
+        case list
+        when Array
+          shift = 0
+          list.each_with_object({}) do |each, result|
+            result[each] = 1 << shift
+            shift += 1
+            result
+          end
+        when Hash
+          list
+        end
+      end
+    end
+  )
+end
+
+_def_flags 8
+_def_flags 16
+_def_flags 32

data/lib/helpers/ip_address.rb

@@ -0,0 +1,14 @@
+require 'bindata'
+
+class IpAddress < BinData::Primitive
+  endian :big
+  array :octets, type: :uint8, initial_length: 4
+
+  def get
+    octets.map(&:to_s).join('.')
+  end
+
+  def set(value)
+    self.octets = value.split('.').map(&:to_i)
+  end
+end

data/lib/helpers/mac_address.rb

@@ -0,0 +1,14 @@
+require 'bindata'
+
+class MacAddress < BinData::Primitive
+  endian :big
+  array :octets, type: :uint8, initial_length: 6
+
+  def get
+    octets.map { |octet| format('%02x', octet) }.join(':')
+  end
+
+  def set(value)
+    self.octets = value.split(':').map(&:hex)
+  end
+end

data/lib/helpers/superclass_base.rb

@@ -0,0 +1,21 @@
+require 'bindata'
+
+class SuperclassBase < BinData::Record
+  attr_reader :type_str
+
+  endian :big
+
+  def initialize_instance
+    super
+    if self.class.name[2..7] == 'Action'
+      name = self.class.name[8..-1]
+    else
+      name = self.class.name[2..-1]
+    end
+    @type_str = name.gsub(/([A-Z])/, '_\1')[1..-1].downcase
+  end
+
+  def body_length
+    0
+  end
+end

data/lib/messages/barrier_reply.rb

@@ -0,0 +1,3 @@
+require_relative 'message'
+
+class OFBarrierReply < OFMessage; end

data/lib/messages/barrier_request.rb

@@ -0,0 +1,3 @@
+require_relative 'message'
+
+class OFBarrierRequest < OFMessage; end

data/lib/messages/echo_reply.rb

@@ -0,0 +1,3 @@
+require_relative 'echo_request'
+
+class OFEchoReply < OFEchoRequest; end

data/lib/messages/echo_request.rb

@@ -0,0 +1,9 @@
+require_relative 'message'
+
+class OFEchoRequest < OFMessage
+  rest :data
+
+  def body_length
+    data.length
+  end
+end

data/lib/messages/features_reply.rb

@@ -0,0 +1,40 @@
+require_relative 'message'
+
+class OFFeaturesReply < OFMessage
+  uint64 :datapath_id, initial_value: 0
+  uint32 :n_buffers, initial_value: 0
+  uint8 :n_tables, initial_value: 0
+  uint24 :padding
+  hide :padding
+  flags32 :capabilities, list: [
+    :flow_stats,
+    :table_stats,
+    :port_stats,
+    :stp,
+    :reserved,
+    :ip_reasm,
+    :queue_stats,
+    :arp_match_ip
+  ]
+  flags32 :actions, list: [
+    :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
+  ]
+  array :ports,
+        type: :of_physical_port,
+        initial_length: -> { (len - ports.rel_offset) / 48 }
+
+  def body_length
+    24 + ports.to_binary_s.length
+  end
+end

data/lib/messages/features_request.rb

@@ -0,0 +1,3 @@
+require_relative 'message'
+
+class OFFeaturesRequest < OFMessage; end

data/lib/messages/flow_mod.rb

@@ -0,0 +1,20 @@
+require_relative 'message'
+
+class OFFlowMod < OFMessage
+  of_match :match
+  uint64 :cookie, initial_value: 0
+  enum16 :command, list: [:add, :modify, :modify_strict, :delete, :delete_strict]
+  uint16 :idle_timeout, initial_value: 0
+  uint16 :hard_timeout, initial_value: 0
+  uint16 :priority, initial_value: 0
+  uint32 :buffer_id, initial_value: 0xffffffff
+  of_port_number :out_port, initial_value: (lambda do
+    /^delete/ =~ command.to_s ? :none : 0
+  end)
+  flags16 :flags, list: [:send_flow_removed, :check_overlapping, :emergency]
+  of_actions :actions, length: -> { len - actions.rel_offset }
+
+  def body_length
+    64 + actions.to_binary_s.length
+  end
+end

data/lib/messages/flow_removed.rb

@@ -0,0 +1,23 @@
+require_relative 'message'
+
+class OFFlowRemoved < OFMessage
+  REASONS = [:idle_timeout, :hard_timeout, :delete]
+
+  of_match :match
+  uint64 :cookie, initial_value: 0
+  uint16 :priority, initial_value: 0
+  enum8 :reason, list: REASONS
+  uint8 :padding
+  hide :padding
+  uint32 :duration_seconds, initial_value: 0
+  uint32 :duration_nanoseconds, initial_value: 0
+  uint16 :idle_timeout, initial_value: 0
+  uint16 :padding2
+  hide :padding2
+  uint64 :packet_count, initial_value: 0
+  uint64 :byte_count, initial_value: 0
+
+  def body_length
+    80
+  end
+end

data/lib/messages/get_config_reply.rb

@@ -0,0 +1,12 @@
+require_relative 'message'
+
+class OFGetConfigReply < OFMessage
+  FLAGS = [:fragments_normal, :fragments_drop, :fragments_reassemble]
+
+  enum16 :flags, list: FLAGS
+  uint16 :miss_send_length, initial_value: 0
+
+  def body_length
+    4
+  end
+end

data/lib/messages/get_config_request.rb

@@ -0,0 +1,3 @@
+require_relative 'message'
+
+class OFGetConfigRequest < OFMessage; end

data/lib/messages/hello.rb

@@ -0,0 +1,3 @@
+require_relative 'message'
+
+class OFHello < OFMessage; end

data/lib/messages/message.rb

@@ -0,0 +1,45 @@
+(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|
+  require file
+end
+
+# TODO: use OFPT_, OFPP_, OFPQ_, ... in place of Symbols?
+#   check: https://github.com/noxrepo/pox/blob/carp/pox/openflow/libopenflow_01.py
+#   -> see decorators
+#   ruby decorators: https://github.com/fredwu/ruby_decorators
+
+class OFMessage < SuperclassBase
+  OFP_VERSION = 0x1
+  HEADER_LENGTH = 8
+  TYPES = [
+    :hello,
+    :error, # TODO
+    :echo_request,
+    :echo_reply,
+    :vendor,
+    :features_request,
+    :features_reply,
+    :get_config_request,
+    :get_config_reply,
+    :set_config,
+    :packet_in,
+    :flow_removed,
+    :port_status,
+    :packet_out,
+    :flow_mod,
+    :port_mod,
+    :statistics_request,
+    :statistics_reply,
+    :barrier_request,
+    :barrier_reply,
+    :queue_get_config_request, # TODO
+    :queue_get_config_reply # TODO
+  ]
+
+  uint8 :version, asserted_value: OFP_VERSION
+  enum8 :type, list: TYPES, asserted_value: -> { type_str.to_sym }
+  uint16 :len, value: -> { HEADER_LENGTH + body_length }
+  uint32 :xid, initial_value: 0
+end

data/lib/messages/packet_in.rb

@@ -0,0 +1,17 @@
+require_relative 'message'
+
+class OFPacketIn < OFMessage
+  REASONS = [:no_match, :action]
+
+  enum32 :buffer_id, list: {none: 0xffffffff}, initial_value: -> { :none }
+  uint16 :total_length, value: -> { data.length }
+  of_port_number :in_port
+  enum8 :reason, list: REASONS
+  uint8 :padding
+  hide :padding
+  string :data, read_length: :total_length
+
+  def body_length
+    10 + data.length
+  end
+end

data/lib/messages/packet_out.rb

@@ -0,0 +1,13 @@
+require_relative 'message'
+
+class OFPacketOut < OFMessage
+  enum32 :buffer_id, list: {none: 0xffffffff}, initial_value: -> { :none }
+  of_port_number :in_port
+  uint16 :actions_length, value: -> { actions.to_binary_s.length }
+  of_actions :actions, length: -> { actions_length }
+  string :data, read_length: -> { len - data.rel_offset }
+
+  def body_length
+    8 + actions_length + data.length
+  end
+end

data/lib/messages/port_mod.rb

@@ -0,0 +1,13 @@
+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
+
+  def body_length
+    24
+  end
+end

data/lib/messages/port_status.rb

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

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

data/lib/messages/statistics.rb

@@ -0,0 +1,24 @@
+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_reply.rb

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

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

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

data/lib/openflow-protocol.rb

@@ -0,0 +1,3 @@
+Dir[File.expand_path 'messages/**/*.rb', __dir__].each do |file|
+  require file
+end

data/lib/statistics/aggregate_statistics_reply.rb

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

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

data/lib/statistics/description_statistics.rb

@@ -0,0 +1,28 @@
+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/statistics/flow_statistics_reply.rb

@@ -0,0 +1,21 @@
+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/statistics/flow_statistics_request.rb

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

@@ -0,0 +1,20 @@
+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/statistics/port_statistics_request.rb

@@ -0,0 +1,8 @@
+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/statistics/queue_statistics_reply.rb

@@ -0,0 +1,12 @@
+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/statistics/queue_statistics_request.rb

@@ -0,0 +1,9 @@
+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/statistics/table_statistics.rb

@@ -0,0 +1,17 @@
+require_relative '../structs/match'
+require_relative '../helpers/flags'
+
+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/statistics/vendor_statistics.rb

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

data/lib/structs/match.rb

@@ -0,0 +1,91 @@
+require 'English'
+require_relative '../helpers/enum'
+require_relative '../helpers/mac_address'
+require_relative '../helpers/ip_address'
+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)
+      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
+
+  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: {
+    ip: 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
+  ip_address :ip_source
+  ip_address :ip_destination
+  uint16 :source_port, initial_value: 0
+  uint16 :destination_port, initial_value: 0
+end

data/lib/structs/physical_port.rb

@@ -0,0 +1,46 @@
+require_relative 'port_number'
+require_relative '../helpers/mac_address'
+
+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

data/lib/structs/port_number.rb

@@ -0,0 +1,31 @@
+require 'bindata'
+
+class OFPortNumber < BinData::Primitive
+  NUMBERS = {
+    in_port: 0xfff8,
+    table: 0xfff9,
+    normal: 0xfffa,
+    flood: 0xfffb,
+    all: 0xfffc,
+    controller: 0xfffd,
+    local: 0xfffe,
+    none: 0xffff
+  }
+  MAX = 0xff00
+
+  endian :big
+  uint16 :port_number, initial_value: NUMBERS[:none]
+
+  def get
+    NUMBERS.invert.fetch(port_number)
+  rescue KeyError
+    port_number
+  end
+
+  def set(value)
+    self.port_number = NUMBERS.fetch(value)
+  rescue KeyError
+    raise ArgumentError, 'Invalid port number.' unless (0..MAX).include? value
+    self.port_number = value
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: openflow-protocol
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jeremy Page
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-08 00:00:00.000000000 Z
+dependencies: []
+description: An OpenFlow Parser/Serializer.
+email:
+- jeremy@jeremypage.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/actions/action.rb
+- lib/actions/action_enqueue.rb
+- lib/actions/action_output.rb
+- lib/actions/action_set_destination_port.rb
+- lib/actions/action_set_ip_destination.rb
+- lib/actions/action_set_ip_source.rb
+- lib/actions/action_set_ip_tos.rb
+- lib/actions/action_set_mac_destination.rb
+- lib/actions/action_set_mac_source.rb
+- lib/actions/action_set_source_port.rb
+- lib/actions/action_set_vlan_id.rb
+- lib/actions/action_set_vlan_pcp.rb
+- lib/actions/action_strip_vlan.rb
+- lib/actions/action_vendor.rb
+- lib/actions/actions.rb
+- lib/helpers/enum.rb
+- lib/helpers/flags.rb
+- lib/helpers/ip_address.rb
+- lib/helpers/mac_address.rb
+- lib/helpers/superclass_base.rb
+- lib/messages/barrier_reply.rb
+- lib/messages/barrier_request.rb
+- lib/messages/echo_reply.rb
+- lib/messages/echo_request.rb
+- lib/messages/features_reply.rb
+- lib/messages/features_request.rb
+- lib/messages/flow_mod.rb
+- lib/messages/flow_removed.rb
+- lib/messages/get_config_reply.rb
+- lib/messages/get_config_request.rb
+- lib/messages/hello.rb
+- lib/messages/message.rb
+- lib/messages/packet_in.rb
+- lib/messages/packet_out.rb
+- lib/messages/port_mod.rb
+- lib/messages/port_status.rb
+- lib/messages/set_config.rb
+- lib/messages/statistics.rb
+- lib/messages/statistics_reply.rb
+- lib/messages/statistics_request.rb
+- lib/messages/vendor.rb
+- lib/openflow-protocol.rb
+- lib/statistics/aggregate_statistics_reply.rb
+- lib/statistics/aggregate_statistics_request.rb
+- lib/statistics/description_statistics.rb
+- lib/statistics/flow_statistics_reply.rb
+- lib/statistics/flow_statistics_request.rb
+- lib/statistics/port_statistics_reply.rb
+- lib/statistics/port_statistics_request.rb
+- lib/statistics/queue_statistics_reply.rb
+- lib/statistics/queue_statistics_request.rb
+- lib/statistics/table_statistics.rb
+- lib/statistics/vendor_statistics.rb
+- lib/structs/match.rb
+- lib/structs/physical_port.rb
+- lib/structs/port_number.rb
+homepage: https://github.com/jejepage/openflow-protocol
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: OpenFlow Protocol
+test_files: []