openflow-protocol 0.1.7 → 0.1.8

data/lib/openflow-protocol/messages/features_request.rb

@@ -0,0 +1,7 @@
+require 'openflow-protocol/messages/message'
+
+module OpenFlow
+  module Protocol
+    class FeaturesRequest < Message; end
+  end
+end

data/lib/openflow-protocol/messages/flow_mod.rb

@@ -0,0 +1,24 @@
+require 'openflow-protocol/messages/message'
+
+module OpenFlow
+  module Protocol
+    class FlowMod < Message
+      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
+      enum32 :buffer_id, list: {none: 0xffffffff}, initial_value: -> { :none }
+      port_number :out_port, initial_value: (lambda do
+        /^delete/ =~ command.to_s ? :none : 0
+      end)
+      flags16 :flags, list: [:send_flow_removed, :check_overlapping, :emergency]
+      actions :actions, length: -> { len - actions.rel_offset }
+
+      def body_length
+        64 + actions.to_binary_s.length
+      end
+    end
+  end
+end

data/lib/openflow-protocol/messages/flow_removed.rb

@@ -0,0 +1,27 @@
+require 'openflow-protocol/messages/message'
+
+module OpenFlow
+  module Protocol
+    class FlowRemoved < Message
+      REASONS = [:idle_timeout, :hard_timeout, :delete]
+
+      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
+  end
+end

data/lib/openflow-protocol/messages/get_config_reply.rb

@@ -0,0 +1,16 @@
+require 'openflow-protocol/messages/message'
+
+module OpenFlow
+  module Protocol
+    class GetConfigReply < Message
+      FLAGS = [:fragments_normal, :fragments_drop, :fragments_reassemble]
+
+      enum16 :flags, list: FLAGS
+      uint16 :miss_send_length, initial_value: 0
+
+      def body_length
+        4
+      end
+    end
+  end
+end

data/lib/openflow-protocol/messages/get_config_request.rb

@@ -0,0 +1,7 @@
+require 'openflow-protocol/messages/message'
+
+module OpenFlow
+  module Protocol
+    class GetConfigRequest < Message; end
+  end
+end

data/lib/openflow-protocol/messages/hello.rb

@@ -0,0 +1,7 @@
+require 'openflow-protocol/messages/message'
+
+module OpenFlow
+  module Protocol
+    class Hello < Message; end
+  end
+end

data/lib/openflow-protocol/messages/message.rb

@@ -0,0 +1,49 @@
+(Dir[File.expand_path '../../helpers/**/*.rb', __FILE__] +
+ Dir[File.expand_path '../../structs/**/*.rb', __FILE__] +
+ Dir[File.expand_path '../../actions/**/*.rb', __FILE__] +
+ Dir[File.expand_path '../statistics/**/*.rb', __FILE__]).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
+
+module OpenFlow
+  module Protocol
+    class Message < SuperclassBase
+      OFP_VERSION = 0x1
+      HEADER_LENGTH = 8
+      TYPES = [
+        :hello,
+        :error,
+        :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,
+        :queue_get_config_reply
+      ]
+
+      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
+  end
+end

data/lib/openflow-protocol/messages/packet_in.rb

@@ -0,0 +1,27 @@
+require 'packet-protocols'
+require 'openflow-protocol/messages/message'
+
+module OpenFlow
+  module Protocol
+    class PacketIn < Message
+      REASONS = [:no_match, :action]
+
+      enum32 :buffer_id, list: {none: 0xffffffff}, initial_value: -> { :none }
+      uint16 :total_length, value: -> { data.length }
+      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
+
+      def parsed_data
+        @parsed_data ||= Ethernet.read(data)
+        @parsed_data
+      end
+    end
+  end
+end

data/lib/openflow-protocol/messages/packet_out.rb

@@ -0,0 +1,17 @@
+require 'openflow-protocol/messages/message'
+
+module OpenFlow
+  module Protocol
+    class PacketOut < Message
+      enum32 :buffer_id, list: {none: 0xffffffff}, initial_value: -> { :none }
+      port_number :in_port
+      uint16 :actions_length, value: -> { actions.to_binary_s.length }
+      actions :actions, length: -> { actions_length }
+      string :data, read_length: -> { len - data.rel_offset }
+
+      def body_length
+        8 + actions_length + data.length
+      end
+    end
+  end
+end

data/lib/openflow-protocol/messages/parser.rb

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

data/lib/openflow-protocol/messages/port_mod.rb

@@ -0,0 +1,19 @@
+require 'openflow-protocol/messages/message'
+
+module OpenFlow
+  module Protocol
+    class PortMod < Message
+      port_number :port_number
+      mac_address :hardware_address
+      flags32 :config, list: PhysicalPort::CONFIG
+      flags32 :mask, list: PhysicalPort::CONFIG
+      flags32 :advertise, list: PhysicalPort::FEATURES
+      uint32 :padding
+      hide :padding
+
+      def body_length
+        24
+      end
+    end
+  end
+end

data/lib/openflow-protocol/messages/port_status.rb

@@ -0,0 +1,18 @@
+require 'openflow-protocol/messages/message'
+
+module OpenFlow
+  module Protocol
+    class PortStatus < Message
+      REASONS = [:add, :delete, :modify]
+
+      enum8 :reason, list: REASONS
+      uint56 :padding
+      hide :padding
+      physical_port :desc
+
+      def body_length
+        56
+      end
+    end
+  end
+end

data/lib/openflow-protocol/messages/queue_get_config_reply.rb

@@ -0,0 +1,18 @@
+require 'openflow-protocol/messages/message'
+
+module OpenFlow
+  module Protocol
+    class QueueGetConfigReply < Message
+      port_number_strict :port
+      uint48 :padding
+      hide :padding
+      array :queues,
+        type: :packet_queue,
+        read_until: :eof
+
+      def body_length
+        8 + queues.to_binary_s.length
+      end
+    end
+  end
+end

data/lib/openflow-protocol/messages/queue_get_config_request.rb

@@ -0,0 +1,15 @@
+require 'openflow-protocol/messages/message'
+
+module OpenFlow
+  module Protocol
+    class QueueGetConfigRequest < Message
+      port_number_strict :port
+      uint16 :padding
+      hide :padding
+
+      def body_length
+        4
+      end
+    end
+  end
+end

data/lib/openflow-protocol/messages/set_config.rb

@@ -0,0 +1,7 @@
+require 'openflow-protocol/messages/get_config_reply'
+
+module OpenFlow
+  module Protocol
+    class SetConfig < GetConfigReply; end
+  end
+end

data/lib/openflow-protocol/messages/statistics.rb

@@ -0,0 +1,28 @@
+require 'openflow-protocol/messages/message'
+
+module OpenFlow
+  module Protocol
+    class Statistics < Message
+      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
+  end
+end

data/lib/openflow-protocol/messages/statistics/aggregate_statistics_reply.rb

@@ -0,0 +1,14 @@
+require 'bindata'
+
+module OpenFlow
+  module Protocol
+    class AggregateStatisticsReply < 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
+  end
+end

data/lib/openflow-protocol/messages/statistics/aggregate_statistics_request.rb

@@ -0,0 +1,7 @@
+require 'openflow-protocol/messages/statistics/flow_statistics_request'
+
+module OpenFlow
+  module Protocol
+    class AggregateStatisticsRequest < FlowStatisticsRequest; end
+  end
+end

data/lib/openflow-protocol/messages/statistics/description_statistics.rb

@@ -0,0 +1,32 @@
+require 'bindata'
+
+module OpenFlow
+  module Protocol
+    class DescriptionStatistics < 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
+  end
+end

data/lib/openflow-protocol/messages/statistics/flow_statistics_reply.rb

@@ -0,0 +1,25 @@
+require 'openflow-protocol/messages/statistics/table_statistics'
+
+module OpenFlow
+  module Protocol
+    class FlowStatisticsReply < BinData::Record
+      endian :big
+      uint16 :len, initial_value: -> { 88 + actions.to_binary_s.length }
+      enum8 :table_id, list: TableStatistics::TABLE_IDS, initial_value: -> { :all }
+      uint8 :padding
+      hide :padding
+      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
+      actions :actions, length: -> { len - actions.rel_offset }
+    end
+  end
+end

data/lib/openflow-protocol/messages/statistics/flow_statistics_request.rb

@@ -0,0 +1,14 @@
+require 'openflow-protocol/messages/statistics/table_statistics'
+
+module OpenFlow
+  module Protocol
+    class FlowStatisticsRequest < BinData::Record
+      endian :big
+      match :match
+      enum8 :table_id, list: TableStatistics::TABLE_IDS, initial_value: -> { :all }
+      uint8 :padding
+      hide :padding
+      port_number :out_port, initial_value: -> { :none }
+    end
+  end
+end

data/lib/openflow-protocol/messages/statistics/port_statistics_reply.rb

@@ -0,0 +1,24 @@
+require 'openflow-protocol/structs/port_number'
+
+module OpenFlow
+  module Protocol
+    class PortStatisticsReply < BinData::Record
+      endian :big
+      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
+  end
+end