openflow-protocol 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b787a021c7be6ba96d78b7f71f9d93676c709bd7
-  data.tar.gz: 80ea8bef3b0e8fbd6783d8fdb35fb278032c9d0e
+  metadata.gz: b01ffc73397a6ba7679ac349cf7f32d7a9a790f0
+  data.tar.gz: 51c39851e3ee81bf59879c4dfa76b4260144b2bf
 SHA512:
-  metadata.gz: 842cbdc2c9b75e80d1dbb53d853fa6c578bbc8ec05d3db6bb8450fd7be2017fb8586c1ba435410b717979e6fe95171fb8d776677c9b9a8c4a59e65e4f79ec0dc
-  data.tar.gz: b1139123757191b1c60e00866e8543c423e324f70f49ea23e4ee8ee02fbc2ed72b13c1ae891255e6487e4c9c8cf8137028235956fed6baaf3f8dd76a5c44e47d
+  metadata.gz: 51bc3a9d20999dab830ad19ed61a1c76be940eddea2fd11edcfef446f34e8ad3ab5ed8c3eacd9b8569c032527603d245ee6e08d82699e844f157407731e580f5
+  data.tar.gz: 4395f5da25e3339799305a8d791f84fb842fbbadfb06a5a075bf9fe08b11144e6b48166ce750cee13fa7251bf527f8619129e4120107ffc6b3bf3ad0cfad558b

data/lib/openflow-protocol.rb

@@ -1 +1,2 @@
-require_relative 'messages/parser'
+require 'openflow-protocol/version'
+require 'openflow-protocol/messages/parser'

data/lib/openflow-protocol/actions/action.rb

@@ -0,0 +1,30 @@
+(Dir[File.expand_path '../../helpers/**/*.rb', __FILE__] +
+ Dir[File.expand_path '../../structs/**/*.rb', __FILE__]).each do |file|
+  require file
+end
+
+module OpenFlow
+  module Protocol
+    class Action < 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
+  end
+end

data/lib/openflow-protocol/actions/action_enqueue.rb

@@ -0,0 +1,16 @@
+require 'openflow-protocol/actions/action'
+
+module OpenFlow
+  module Protocol
+    class ActionEnqueue < Action
+      port_number :port
+      uint48 :padding
+      hide :padding
+      uint32 :queue_id, initial_value: 0
+
+      def body_length
+        12
+      end
+    end
+  end
+end

data/lib/openflow-protocol/actions/action_output.rb

@@ -0,0 +1,14 @@
+require 'openflow-protocol/actions/action'
+
+module OpenFlow
+  module Protocol
+    class ActionOutput < Action
+      port_number :port
+      uint16 :max_length, initial_value: 0xffff
+
+      def body_length
+        4
+      end
+    end
+  end
+end

data/lib/openflow-protocol/actions/action_set_destination_port.rb

@@ -0,0 +1,7 @@
+require 'openflow-protocol/actions/action_set_source_port'
+
+module OpenFlow
+  module Protocol
+    class ActionSetDestinationPort < ActionSetSourcePort; end
+  end
+end

data/lib/openflow-protocol/actions/action_set_ip_destination.rb

@@ -0,0 +1,7 @@
+require 'openflow-protocol/actions/action_set_ip_source'
+
+module OpenFlow
+  module Protocol
+    class ActionSetIpDestination < ActionSetIpSource; end
+  end
+end

data/lib/openflow-protocol/actions/action_set_ip_source.rb

@@ -0,0 +1,13 @@
+require 'openflow-protocol/actions/action'
+
+module OpenFlow
+  module Protocol
+    class ActionSetIpSource < Action
+      ipv4_address :ip_address
+
+      def body_length
+        4
+      end
+    end
+  end
+end

data/lib/openflow-protocol/actions/action_set_ip_tos.rb

@@ -0,0 +1,15 @@
+require 'openflow-protocol/actions/action'
+
+module OpenFlow
+  module Protocol
+    class ActionSetIpTos < Action
+      uint8 :tos
+      uint24 :padding
+      hide :padding
+
+      def body_length
+        4
+      end
+    end
+  end
+end

data/lib/openflow-protocol/actions/action_set_mac_destination.rb

@@ -0,0 +1,7 @@
+require 'openflow-protocol/actions/action_set_mac_source'
+
+module OpenFlow
+  module Protocol
+    class ActionSetMacDestination < ActionSetMacSource; end
+  end
+end

data/lib/openflow-protocol/actions/action_set_mac_source.rb

@@ -0,0 +1,15 @@
+require 'openflow-protocol/actions/action'
+
+module OpenFlow
+  module Protocol
+    class ActionSetMacSource < Action
+      mac_address :mac_address
+      uint48 :padding
+      hide :padding
+
+      def body_length
+        12
+      end
+    end
+  end
+end

data/lib/openflow-protocol/actions/action_set_source_port.rb

@@ -0,0 +1,15 @@
+require 'openflow-protocol/actions/action'
+
+module OpenFlow
+  module Protocol
+    class ActionSetSourcePort < Action
+      uint16 :port, initial_value: 0
+      uint16 :padding
+      hide :padding
+
+      def body_length
+        4
+      end
+    end
+  end
+end

data/lib/openflow-protocol/actions/action_set_vlan_id.rb

@@ -0,0 +1,15 @@
+require 'openflow-protocol/actions/action'
+
+module OpenFlow
+  module Protocol
+    class ActionSetVlanId < Action
+      uint16 :vlan_id, initial_value: 0
+      uint16 :padding
+      hide :padding
+
+      def body_length
+        4
+      end
+    end
+  end
+end

data/lib/openflow-protocol/actions/action_set_vlan_pcp.rb

@@ -0,0 +1,15 @@
+require 'openflow-protocol/actions/action'
+
+module OpenFlow
+  module Protocol
+    class ActionSetVlanPcp < Action
+      uint8 :vlan_pcp, initial_value: 0
+      uint24 :padding
+      hide :padding
+
+      def body_length
+        4
+      end
+    end
+  end
+end

data/lib/openflow-protocol/actions/action_strip_vlan.rb

@@ -0,0 +1,14 @@
+require 'openflow-protocol/actions/action'
+
+module OpenFlow
+  module Protocol
+    class ActionStripVlan < Action
+      uint32 :padding
+      hide :padding
+
+      def body_length
+        4
+      end
+    end
+  end
+end

data/lib/openflow-protocol/actions/action_vendor.rb

@@ -0,0 +1,13 @@
+require 'openflow-protocol/actions/action'
+
+module OpenFlow
+  module Protocol
+    class ActionVendor < Action
+      uint32 :vendor, initial_value: 0
+
+      def body_length
+        4
+      end
+    end
+  end
+end

data/lib/openflow-protocol/actions/actions.rb

@@ -0,0 +1,9 @@
+Dir[File.expand_path '../action_*.rb', __FILE__].each do |file|
+  require file
+end
+
+module OpenFlow
+  module Protocol
+    class Actions < ArrayOfSubclasses; end
+  end
+end

data/lib/openflow-protocol/helpers/array_of_subclasses.rb

@@ -0,0 +1,42 @@
+require 'bindata'
+
+module OpenFlow
+  module Protocol
+    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 = OpenFlow::Protocol.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
+        OpenFlow::Protocol.const_get(name + '::TYPES')
+      end
+    end
+  end
+end

data/lib/openflow-protocol/helpers/superclass_base.rb

@@ -0,0 +1,26 @@
+require 'bindata-contrib'
+
+module OpenFlow
+  module Protocol
+    class SuperclassBase < BinData::Record
+      attr_reader :type_str
+
+      endian :big
+
+      def initialize_instance
+        super
+        name = self.class.name.split('::').last
+        if name[0..5] == 'Action'
+          name = name[6..-1]
+        elsif name[0..12] == 'QueueProperty'
+          name = name[13..-1]
+        end
+        @type_str = name.gsub(/([A-Z])/, '_\1')[1..-1].downcase
+      end
+
+      def body_length
+        0
+      end
+    end
+  end
+end

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

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

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

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

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

@@ -0,0 +1,13 @@
+require 'openflow-protocol/messages/echo_request'
+
+module OpenFlow
+  module Protocol
+    class EchoReply < EchoRequest; end
+
+    class EchoRequest
+      def to_reply
+        EchoReply.new(xid: xid, data: data.dup)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+require 'openflow-protocol/messages/message'
+
+module OpenFlow
+  module Protocol
+    class EchoRequest < Message
+      rest :data
+
+      def body_length
+        data.length
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+require 'openflow-protocol/messages/message'
+
+module OpenFlow
+  module Protocol
+    class Error < Message
+      TYPES = [
+        :hello_failed,
+        :bad_request,
+        :bad_action,
+        :flow_mod_failed,
+        :port_mod_failed,
+        :queue_op_failed
+      ]
+      HELLO_FAILED_CODES = [:incompatible, :eperm]
+      BAD_REQUEST_CODES = [
+        :bad_version,
+        :bad_type,
+        :bad_stat,
+        :bad_vendor,
+        :bad_sub_type,
+        :eperm,
+        :bad_length,
+        :buffer_empty,
+        :buffer_unknown
+      ]
+      BAD_ACTION_CODES = [
+        :bad_type,
+        :bad_length,
+        :bad_vendor,
+        :bad_vendor_type,
+        :bad_out_port,
+        :bad_argument,
+        :eperm,
+        :too_many,
+        :bad_queue
+      ]
+      FLOW_MOD_FAILED_CODES = [
+        :all_tables_full,
+        :overlap,
+        :eperm,
+        :bad_emerg_timeout,
+        :bad_command,
+        :unsupported
+      ]
+      PORT_MOD_FAILED_CODES = [:bad_port, :bad_hardware_address]
+      QUEUE_OP_FAILED_CODES = [:bad_port, :bad_queue, :eperm]
+
+      enum16 :error_type, list: TYPES
+      choice :error_code, selection: -> { error_type.to_s } do
+        enum16 'hello_failed',    list: HELLO_FAILED_CODES
+        enum16 'bad_request',     list: BAD_REQUEST_CODES
+        enum16 'bad_action',      list: BAD_ACTION_CODES
+        enum16 'flow_mod_failed', list: FLOW_MOD_FAILED_CODES
+        enum16 'port_mod_failed', list: PORT_MOD_FAILED_CODES
+        enum16 'queue_op_failed', list: QUEUE_OP_FAILED_CODES
+        uint16 :default
+      end
+      rest :data
+
+      def body_length
+        4 + data.length
+      end
+
+      def parsed_data
+        Parser.read data.to_s
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+require 'openflow-protocol/messages/message'
+
+module OpenFlow
+  module Protocol
+    class FeaturesReply < Message
+      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: :physical_port,
+        initial_length: -> { (len - ports.rel_offset) / 48 }
+
+      def body_length
+        24 + ports.to_binary_s.length
+      end
+    end
+  end
+end