openflow-protocol 0.1.7 → 0.1.8

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

@@ -0,0 +1,12 @@
+require 'openflow-protocol/structs/port_number'
+
+module OpenFlow
+  module Protocol
+    class PortStatisticsRequest < BinData::Record
+      endian :big
+      port_number :port_number, initial_value: -> { :none } # all ports
+      uint48 :padding
+      hide :padding
+    end
+  end
+end

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

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

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

@@ -0,0 +1,13 @@
+require 'openflow-protocol/structs/port_number'
+
+module OpenFlow
+  module Protocol
+    class QueueStatisticsRequest < BinData::Record
+      endian :big
+      port_number :port_number, initial_value: -> { :all }
+      uint16 :padding
+      hide :padding
+      enum32 :queue_id, list: {all: 0xffffffff}, initial_value: -> { :all }
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require 'openflow-protocol/structs/match'
+
+module OpenFlow
+  module Protocol
+    class TableStatistics < 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: Match::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
+  end
+end

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

@@ -0,0 +1,11 @@
+require 'bindata'
+
+module OpenFlow
+  module Protocol
+    class VendorStatistics < BinData::Record
+      endian :big
+      uint32 :vendor, initial_value: 0
+      rest :body
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+require 'openflow-protocol/messages/statistics'
+
+module OpenFlow
+  module Protocol
+    class StatisticsReply < Statistics
+      FLAGS = [:reply_more]
+
+      choice :statistics, selection: -> { statistic_type.to_s } do
+        description_statistics 'description'
+        flow_statistics_reply 'flow'
+        aggregate_statistics_reply 'aggregate'
+        array 'table',
+          type: :table_statistics,
+          initial_length: -> { (len - statistics.rel_offset) / 64 }
+        array 'port',
+          type: :port_statistics_reply,
+          initial_length: -> { (len - statistics.rel_offset) / 104 }
+        array 'queue',
+          type: :queue_statistics_reply,
+          initial_length: -> { (len - statistics.rel_offset) / 32 }
+        vendor_statistics 'vendor'
+        rest :default
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+require 'openflow-protocol/messages/statistics'
+
+module OpenFlow
+  module Protocol
+    class StatisticsRequest < Statistics
+      FLAGS = []
+
+      choice :statistics, selection: -> { statistic_type.to_s } do
+        flow_statistics_request 'flow'
+        aggregate_statistics_request 'aggregate'
+        port_statistics_request 'port'
+        queue_statistics_request 'queue'
+        vendor_statistics 'vendor'
+        rest :default
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+require 'openflow-protocol/messages/message'
+
+module OpenFlow
+  module Protocol
+    class Vendor < Message
+      uint32 :vendor, initial_value: 0
+      rest :data
+
+      def body_length
+        4 + data.length
+      end
+    end
+  end
+end

data/lib/openflow-protocol/structs/match.rb

@@ -0,0 +1,106 @@
+require 'English'
+require 'bindata-contrib'
+require 'openflow-protocol/structs/port_number'
+
+module OpenFlow
+  module Protocol
+    class Match < 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
+      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
+  end
+end

data/lib/openflow-protocol/structs/packet_queue.rb

@@ -0,0 +1,14 @@
+require 'openflow-protocol/structs/queue_properties/queue_properties'
+
+module OpenFlow
+  module Protocol
+    class PacketQueue < BinData::Record
+      endian :big
+      uint32 :queue_id, initial_value: 0
+      uint16 :len, value: -> { 8 + properties.to_binary_s.length }
+      uint16 :padding
+      hide :padding
+      queue_properties :properties, length: -> { len - 8 }
+    end
+  end
+end

data/lib/openflow-protocol/structs/physical_port.rb

@@ -0,0 +1,50 @@
+require 'bindata-contrib'
+require 'openflow-protocol/structs/port_number'
+
+module OpenFlow
+  module Protocol
+    class PhysicalPort < 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
+      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
+  end
+end

data/lib/openflow-protocol/structs/port_number.rb

@@ -0,0 +1,49 @@
+require 'bindata'
+
+module OpenFlow
+  module Protocol
+    class PortNumberStrict < 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..PortNumber::MAX).include? value
+        self.port_number = value
+      end
+    end
+
+    class PortNumber < 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
+  end
+end

data/lib/openflow-protocol/structs/queue_properties/queue_properties.rb

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

data/lib/openflow-protocol/structs/queue_properties/queue_property.rb

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

data/lib/openflow-protocol/structs/queue_properties/queue_property_min_rate.rb

@@ -0,0 +1,30 @@
+require 'openflow-protocol/structs/queue_properties/queue_property'
+
+module OpenFlow
+  module Protocol
+    class QueuePropertyMinRate < QueueProperty
+      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
+  end
+end

data/lib/openflow-protocol/structs/queue_properties/queue_property_none.rb

@@ -0,0 +1,7 @@
+require 'openflow-protocol/structs/queue_properties/queue_property'
+
+module OpenFlow
+  module Protocol
+    class QueuePropertyNone < QueueProperty; end
+  end
+end

data/lib/openflow-protocol/version.rb

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